2 * Copyright (C) 2011 Red Hat. All rights reserved.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
19 #define _XOPEN_SOURCE 500
22 #include "kerncompat.h"
34 #include "print-tree.h"
35 #include "transaction.h"
42 static char path_name[4096];
43 static int get_snaps = 0;
44 static int verbose = 0;
45 static int ignore_errors = 0;
46 static int overwrite = 0;
48 static int decompress(char *inbuf, char *outbuf, u64 compress_len,
54 memset(&strm, 0, sizeof(strm));
55 ret = inflateInit(&strm);
57 fprintf(stderr, "inflate init returnd %d\n", ret);
61 strm.avail_in = compress_len;
62 strm.next_in = (unsigned char *)inbuf;
63 strm.avail_out = decompress_len;
64 strm.next_out = (unsigned char *)outbuf;
65 ret = inflate(&strm, Z_NO_FLUSH);
66 if (ret != Z_STREAM_END) {
67 (void)inflateEnd(&strm);
68 fprintf(stderr, "ret is %d\n", ret);
72 (void)inflateEnd(&strm);
76 int next_leaf(struct btrfs_root *root, struct btrfs_path *path)
80 struct extent_buffer *c;
81 struct extent_buffer *next = NULL;
83 for (; level < BTRFS_MAX_LEVEL; level++) {
84 if (path->nodes[level])
88 if (level == BTRFS_MAX_LEVEL)
91 slot = path->slots[level] + 1;
93 while(level < BTRFS_MAX_LEVEL) {
94 if (!path->nodes[level])
97 slot = path->slots[level] + 1;
98 c = path->nodes[level];
99 if (slot >= btrfs_header_nritems(c)) {
101 if (level == BTRFS_MAX_LEVEL)
107 reada_for_search(root, path, level, slot, 0);
109 next = read_node_slot(root, c, slot);
112 path->slots[level] = slot;
115 c = path->nodes[level];
116 free_extent_buffer(c);
117 path->nodes[level] = next;
118 path->slots[level] = 0;
122 reada_for_search(root, path, level, 0, 0);
123 next = read_node_slot(root, next, 0);
128 static int copy_one_inline(int fd, struct btrfs_path *path, u64 pos)
130 struct extent_buffer *leaf = path->nodes[0];
131 struct btrfs_file_extent_item *fi;
141 fi = btrfs_item_ptr(leaf, path->slots[0],
142 struct btrfs_file_extent_item);
143 ptr = btrfs_file_extent_inline_start(fi);
144 len = btrfs_file_extent_inline_item_len(leaf,
145 btrfs_item_nr(leaf, path->slots[0]));
146 read_extent_buffer(leaf, buf, ptr, len);
148 compress = btrfs_file_extent_compression(leaf, fi);
149 if (compress == BTRFS_COMPRESS_NONE) {
150 done = pwrite(fd, buf, len, pos);
152 fprintf(stderr, "Short inline write, wanted %d, did "
153 "%zd: %d\n", len, done, errno);
159 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
160 outbuf = malloc(ram_size);
162 fprintf(stderr, "No memory\n");
166 ret = decompress(buf, outbuf, len, ram_size);
172 done = pwrite(fd, outbuf, ram_size, pos);
174 if (done < ram_size) {
175 fprintf(stderr, "Short compressed inline write, wanted %d, "
176 "did %zd: %d\n", ram_size, done, errno);
183 static int copy_one_extent(struct btrfs_root *root, int fd,
184 struct extent_buffer *leaf,
185 struct btrfs_file_extent_item *fi, u64 pos)
187 struct btrfs_multi_bio *multi = NULL;
188 struct btrfs_device *device;
189 char *inbuf, *outbuf = NULL;
190 ssize_t done, total = 0;
202 compress = btrfs_file_extent_compression(leaf, fi);
203 bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
204 disk_size = btrfs_file_extent_disk_num_bytes(leaf, fi);
205 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
206 size_left = disk_size;
208 /* we found a hole */
212 inbuf = malloc(disk_size);
214 fprintf(stderr, "No memory\n");
218 if (compress != BTRFS_COMPRESS_NONE) {
219 outbuf = malloc(ram_size);
221 fprintf(stderr, "No memory\n");
228 ret = btrfs_map_block(&root->fs_info->mapping_tree, READ,
229 bytenr, &length, &multi, 0, NULL);
233 fprintf(stderr, "Error mapping block %d\n", ret);
236 device = multi->stripes[0].dev;
239 dev_bytenr = multi->stripes[0].physical;
242 if (size_left < length)
246 done = pread(dev_fd, inbuf+count, length, dev_bytenr);
250 fprintf(stderr, "Short read %d\n", errno);
260 if (compress == BTRFS_COMPRESS_NONE) {
261 while (total < ram_size) {
262 done = pwrite(fd, inbuf+total, ram_size-total,
266 fprintf(stderr, "Error writing: %d %s\n", errno, strerror(errno));
275 ret = decompress(inbuf, outbuf, disk_size, ram_size);
282 while (total < ram_size) {
283 done = pwrite(fd, outbuf+total, ram_size-total, pos+total);
286 fprintf(stderr, "Error writing: %d %s\n", errno, strerror(errno));
296 static int ask_to_continue(const char *file)
301 printf("We seem to be looping a lot on %s, do you want to keep going "
302 "on ? (y/N): ", file);
304 ret = fgets(buf, 2, stdin);
305 if (*ret == '\n' || tolower(*ret) == 'n')
307 if (tolower(*ret) != 'y') {
308 printf("Please enter either 'y' or 'n': ");
316 static int copy_file(struct btrfs_root *root, int fd, struct btrfs_key *key,
319 struct extent_buffer *leaf;
320 struct btrfs_path *path;
321 struct btrfs_file_extent_item *fi;
322 struct btrfs_inode_item *inode_item;
323 struct btrfs_key found_key;
330 path = btrfs_alloc_path();
332 fprintf(stderr, "Ran out of memory\n");
335 path->skip_locking = 1;
337 ret = btrfs_lookup_inode(NULL, root, path, key, 0);
339 inode_item = btrfs_item_ptr(path->nodes[0], path->slots[0],
340 struct btrfs_inode_item);
341 found_size = btrfs_inode_size(path->nodes[0], inode_item);
343 btrfs_release_path(root, path);
346 key->type = BTRFS_EXTENT_DATA_KEY;
348 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
350 fprintf(stderr, "Error searching %d\n", ret);
351 btrfs_free_path(path);
355 leaf = path->nodes[0];
357 ret = next_leaf(root, path);
359 fprintf(stderr, "Error getting next leaf %d\n",
361 btrfs_free_path(path);
363 } else if (ret > 0) {
364 /* No more leaves to search */
365 btrfs_free_path(path);
368 leaf = path->nodes[0];
372 if (loops++ >= 1024) {
373 ret = ask_to_continue(file);
378 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
380 ret = next_leaf(root, path);
382 fprintf(stderr, "Error searching %d\n", ret);
383 btrfs_free_path(path);
386 /* No more leaves to search */
387 btrfs_free_path(path);
390 leaf = path->nodes[0];
394 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
395 if (found_key.objectid != key->objectid)
397 if (found_key.type != key->type)
399 fi = btrfs_item_ptr(leaf, path->slots[0],
400 struct btrfs_file_extent_item);
401 extent_type = btrfs_file_extent_type(leaf, fi);
402 compression = btrfs_file_extent_compression(leaf, fi);
403 if (compression >= BTRFS_COMPRESS_LAST) {
404 fprintf(stderr, "Don't support compression yet %d\n",
406 btrfs_free_path(path);
410 if (extent_type == BTRFS_FILE_EXTENT_PREALLOC)
412 if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
413 ret = copy_one_inline(fd, path, found_key.offset);
415 btrfs_free_path(path);
418 } else if (extent_type == BTRFS_FILE_EXTENT_REG) {
419 ret = copy_one_extent(root, fd, leaf, fi,
422 btrfs_free_path(path);
426 printf("Weird extent type %d\n", extent_type);
432 btrfs_free_path(path);
435 ret = ftruncate(fd, (loff_t)found_size);
442 static int search_dir(struct btrfs_root *root, struct btrfs_key *key,
445 struct btrfs_path *path;
446 struct extent_buffer *leaf;
447 struct btrfs_dir_item *dir_item;
448 struct btrfs_key found_key, location;
449 char filename[BTRFS_NAME_LEN + 1];
450 unsigned long name_ptr;
457 path = btrfs_alloc_path();
459 fprintf(stderr, "Ran out of memory\n");
462 path->skip_locking = 1;
465 key->type = BTRFS_DIR_INDEX_KEY;
467 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
469 fprintf(stderr, "Error searching %d\n", ret);
470 btrfs_free_path(path);
474 leaf = path->nodes[0];
477 printf("No leaf after search, looking for the next "
479 ret = next_leaf(root, path);
481 fprintf(stderr, "Error getting next leaf %d\n",
483 btrfs_free_path(path);
485 } else if (ret > 0) {
486 /* No more leaves to search */
488 printf("Reached the end of the tree looking "
489 "for the directory\n");
490 btrfs_free_path(path);
493 leaf = path->nodes[0];
497 if (loops++ >= 1024) {
498 printf("We have looped trying to restore files in %s "
499 "too many times to be making progress, "
504 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
506 ret = next_leaf(root, path);
508 fprintf(stderr, "Error searching %d\n",
510 btrfs_free_path(path);
512 } else if (ret > 0) {
513 /* No more leaves to search */
515 printf("Reached the end of "
516 "the tree searching the"
518 btrfs_free_path(path);
521 leaf = path->nodes[0];
525 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
526 if (found_key.objectid != key->objectid) {
528 printf("Found objectid=%Lu, key=%Lu\n",
529 found_key.objectid, key->objectid);
532 if (found_key.type != key->type) {
534 printf("Found type=%u, want=%u\n",
535 found_key.type, key->type);
538 dir_item = btrfs_item_ptr(leaf, path->slots[0],
539 struct btrfs_dir_item);
540 name_ptr = (unsigned long)(dir_item + 1);
541 name_len = btrfs_dir_name_len(leaf, dir_item);
542 read_extent_buffer(leaf, filename, name_ptr, name_len);
543 filename[name_len] = '\0';
544 type = btrfs_dir_type(leaf, dir_item);
545 btrfs_dir_item_key_to_cpu(leaf, dir_item, &location);
547 snprintf(path_name, 4096, "%s/%s", dir, filename);
551 * At this point we're only going to restore directories and
552 * files, no symlinks or anything else.
554 if (type == BTRFS_FT_REG_FILE) {
559 ret = stat(path_name, &st);
562 if (verbose || !warn)
563 printf("Skipping existing file"
567 printf("If you wish to overwrite use "
568 "the -o option to overwrite\n");
575 printf("Restoring %s\n", path_name);
576 fd = open(path_name, O_CREAT|O_WRONLY, 0644);
578 fprintf(stderr, "Error creating %s: %d\n",
582 btrfs_free_path(path);
586 ret = copy_file(root, fd, &location, path_name);
591 btrfs_free_path(path);
594 } else if (type == BTRFS_FT_DIR) {
595 struct btrfs_root *search_root = root;
596 char *dir = strdup(path_name);
599 fprintf(stderr, "Ran out of memory\n");
600 btrfs_free_path(path);
604 if (location.type == BTRFS_ROOT_ITEM_KEY) {
606 * If we are a snapshot and this is the index
607 * object to ourselves just skip it.
609 if (location.objectid ==
610 root->root_key.objectid) {
615 search_root = btrfs_read_fs_root(root->fs_info,
617 if (IS_ERR(search_root)) {
619 fprintf(stderr, "Error reading "
620 "subvolume %s: %lu\n",
622 PTR_ERR(search_root));
625 btrfs_free_path(path);
626 return PTR_ERR(search_root);
630 * A subvolume will have a key.offset of 0, a
631 * snapshot will have key.offset of a transid.
633 if (search_root->root_key.offset != 0 &&
636 printf("Skipping snapshot %s\n",
640 location.objectid = BTRFS_FIRST_FREE_OBJECTID;
644 printf("Restoring %s\n", path_name);
647 ret = mkdir(path_name, 0755);
648 if (ret && errno != EEXIST) {
650 fprintf(stderr, "Error mkdiring %s: %d\n",
654 btrfs_free_path(path);
658 ret = search_dir(search_root, &location, dir);
663 btrfs_free_path(path);
672 printf("Done searching %s\n", dir);
673 btrfs_free_path(path);
677 static struct btrfs_root *open_fs(const char *dev, u64 root_location, int super_mirror)
679 struct btrfs_root *root;
683 for (i = super_mirror; i < BTRFS_SUPER_MIRROR_MAX; i++) {
684 bytenr = btrfs_sb_offset(i);
685 root = open_ctree_recovery(dev, bytenr, root_location);
688 fprintf(stderr, "Could not open root, trying backup super\n");
694 static int find_first_dir(struct btrfs_root *root, u64 *objectid)
696 struct btrfs_path *path;
697 struct btrfs_key found_key;
698 struct btrfs_key key;
703 key.type = BTRFS_DIR_INDEX_KEY;
706 path = btrfs_alloc_path();
708 fprintf(stderr, "Ran out of memory\n");
712 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
714 fprintf(stderr, "Error searching %d\n", ret);
718 if (!path->nodes[0]) {
719 fprintf(stderr, "No leaf!\n");
723 for (i = path->slots[0];
724 i < btrfs_header_nritems(path->nodes[0]); i++) {
725 btrfs_item_key_to_cpu(path->nodes[0], &found_key, i);
726 if (found_key.type != key.type)
729 printf("Using objectid %Lu for first dir\n",
731 *objectid = found_key.objectid;
736 ret = next_leaf(root, path);
738 fprintf(stderr, "Error getting next leaf %d\n",
741 } else if (ret > 0) {
742 fprintf(stderr, "No more leaves\n");
745 } while (!path->nodes[0]);
748 printf("Couldn't find a dir index item\n");
750 btrfs_free_path(path);
754 const char * const cmd_restore_usage[] = {
755 "btrfs restore [options] <device>",
756 "Try to restore files from a damaged filesystem (unmounted)",
763 "-f <offset> filesystem location",
764 "-u <block> super mirror",
769 int cmd_restore(int argc, char **argv)
771 struct btrfs_root *root;
772 struct btrfs_key key;
774 u64 tree_location = 0;
779 int super_mirror = 0;
782 while ((opt = getopt(argc, argv, "sviot:u:df:")) != -1) {
798 tree_location = (u64)strtoll(optarg, NULL, 10);
800 fprintf(stderr, "Tree location not valid\n");
806 fs_location = (u64)strtoll(optarg, NULL, 10);
808 fprintf(stderr, "Fs location not valid\n");
814 super_mirror = (int)strtol(optarg, NULL, 10);
816 super_mirror >= BTRFS_SUPER_MIRROR_MAX) {
817 fprintf(stderr, "Super mirror not "
826 usage(cmd_restore_usage);
830 if (optind + 1 >= argc)
831 usage(cmd_restore_usage);
833 if ((ret = check_mounted(argv[optind])) < 0) {
834 fprintf(stderr, "Could not check mount status: %s\n",
838 fprintf(stderr, "%s is currently mounted. Aborting.\n", argv[optind]);
842 root = open_fs(argv[optind], tree_location, super_mirror);
846 if (fs_location != 0) {
847 free_extent_buffer(root->node);
848 root->node = read_tree_block(root, fs_location, 4096, 0);
850 fprintf(stderr, "Failed to read fs location\n");
855 printf("Root objectid is %Lu\n", root->objectid);
857 memset(path_name, 0, 4096);
859 strncpy(dir_name, argv[optind + 1], sizeof dir_name);
860 dir_name[sizeof dir_name - 1] = 0;
862 /* Strip the trailing / on the dir name */
863 len = strlen(dir_name);
864 while (len && dir_name[--len] == '/') {
865 dir_name[len] = '\0';
869 ret = find_first_dir(root, &key.objectid);
873 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
876 ret = search_dir(root->fs_info->fs_root, &key, dir_name);