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, "failed to inflate: %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;
204 compress = btrfs_file_extent_compression(leaf, fi);
205 bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
206 disk_size = btrfs_file_extent_disk_num_bytes(leaf, fi);
207 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
208 size_left = disk_size;
210 /* we found a hole */
214 inbuf = malloc(disk_size);
216 fprintf(stderr, "No memory\n");
220 if (compress != BTRFS_COMPRESS_NONE) {
221 outbuf = malloc(ram_size);
223 fprintf(stderr, "No memory\n");
230 ret = btrfs_map_block(&root->fs_info->mapping_tree, READ,
231 bytenr, &length, &multi, mirror_num, 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);
248 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
251 if (mirror_num >= num_copies) {
253 fprintf(stderr, "Exhausted mirrors trying to read\n");
256 fprintf(stderr, "Trying another mirror\n");
265 if (compress == BTRFS_COMPRESS_NONE) {
266 while (total < ram_size) {
267 done = pwrite(fd, inbuf+total, ram_size-total,
271 fprintf(stderr, "Error writing: %d %s\n", errno, strerror(errno));
280 ret = decompress(inbuf, outbuf, disk_size, ram_size);
282 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
285 if (mirror_num >= num_copies) {
289 fprintf(stderr, "Trying another mirror\n");
293 while (total < ram_size) {
294 done = pwrite(fd, outbuf+total, ram_size-total, pos+total);
307 static int ask_to_continue(const char *file)
312 printf("We seem to be looping a lot on %s, do you want to keep going "
313 "on ? (y/N): ", file);
315 ret = fgets(buf, 2, stdin);
316 if (*ret == '\n' || tolower(*ret) == 'n')
318 if (tolower(*ret) != 'y') {
319 printf("Please enter either 'y' or 'n': ");
327 static int copy_file(struct btrfs_root *root, int fd, struct btrfs_key *key,
330 struct extent_buffer *leaf;
331 struct btrfs_path *path;
332 struct btrfs_file_extent_item *fi;
333 struct btrfs_inode_item *inode_item;
334 struct btrfs_key found_key;
341 path = btrfs_alloc_path();
343 fprintf(stderr, "Ran out of memory\n");
346 path->skip_locking = 1;
348 ret = btrfs_lookup_inode(NULL, root, path, key, 0);
350 inode_item = btrfs_item_ptr(path->nodes[0], path->slots[0],
351 struct btrfs_inode_item);
352 found_size = btrfs_inode_size(path->nodes[0], inode_item);
354 btrfs_release_path(root, path);
357 key->type = BTRFS_EXTENT_DATA_KEY;
359 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
361 fprintf(stderr, "Error searching %d\n", ret);
362 btrfs_free_path(path);
366 leaf = path->nodes[0];
368 ret = next_leaf(root, path);
370 fprintf(stderr, "Error getting next leaf %d\n",
372 btrfs_free_path(path);
374 } else if (ret > 0) {
375 /* No more leaves to search */
376 btrfs_free_path(path);
379 leaf = path->nodes[0];
383 if (loops++ >= 1024) {
384 ret = ask_to_continue(file);
389 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
391 ret = next_leaf(root, path);
393 fprintf(stderr, "Error searching %d\n", ret);
394 btrfs_free_path(path);
397 /* No more leaves to search */
398 btrfs_free_path(path);
401 leaf = path->nodes[0];
405 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
406 if (found_key.objectid != key->objectid)
408 if (found_key.type != key->type)
410 fi = btrfs_item_ptr(leaf, path->slots[0],
411 struct btrfs_file_extent_item);
412 extent_type = btrfs_file_extent_type(leaf, fi);
413 compression = btrfs_file_extent_compression(leaf, fi);
414 if (compression >= BTRFS_COMPRESS_LAST) {
415 fprintf(stderr, "Don't support compression yet %d\n",
417 btrfs_free_path(path);
421 if (extent_type == BTRFS_FILE_EXTENT_PREALLOC)
423 if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
424 ret = copy_one_inline(fd, path, found_key.offset);
426 btrfs_free_path(path);
429 } else if (extent_type == BTRFS_FILE_EXTENT_REG) {
430 ret = copy_one_extent(root, fd, leaf, fi,
433 btrfs_free_path(path);
437 printf("Weird extent type %d\n", extent_type);
443 btrfs_free_path(path);
446 ret = ftruncate(fd, (loff_t)found_size);
453 static int search_dir(struct btrfs_root *root, struct btrfs_key *key,
456 struct btrfs_path *path;
457 struct extent_buffer *leaf;
458 struct btrfs_dir_item *dir_item;
459 struct btrfs_key found_key, location;
460 char filename[BTRFS_NAME_LEN + 1];
461 unsigned long name_ptr;
468 path = btrfs_alloc_path();
470 fprintf(stderr, "Ran out of memory\n");
473 path->skip_locking = 1;
476 key->type = BTRFS_DIR_INDEX_KEY;
478 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
480 fprintf(stderr, "Error searching %d\n", ret);
481 btrfs_free_path(path);
485 leaf = path->nodes[0];
488 printf("No leaf after search, looking for the next "
490 ret = next_leaf(root, path);
492 fprintf(stderr, "Error getting next leaf %d\n",
494 btrfs_free_path(path);
496 } else if (ret > 0) {
497 /* No more leaves to search */
499 printf("Reached the end of the tree looking "
500 "for the directory\n");
501 btrfs_free_path(path);
504 leaf = path->nodes[0];
508 if (loops++ >= 1024) {
509 printf("We have looped trying to restore files in %s "
510 "too many times to be making progress, "
515 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
517 ret = next_leaf(root, path);
519 fprintf(stderr, "Error searching %d\n",
521 btrfs_free_path(path);
523 } else if (ret > 0) {
524 /* No more leaves to search */
526 printf("Reached the end of "
527 "the tree searching the"
529 btrfs_free_path(path);
532 leaf = path->nodes[0];
536 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
537 if (found_key.objectid != key->objectid) {
539 printf("Found objectid=%Lu, key=%Lu\n",
540 found_key.objectid, key->objectid);
543 if (found_key.type != key->type) {
545 printf("Found type=%u, want=%u\n",
546 found_key.type, key->type);
549 dir_item = btrfs_item_ptr(leaf, path->slots[0],
550 struct btrfs_dir_item);
551 name_ptr = (unsigned long)(dir_item + 1);
552 name_len = btrfs_dir_name_len(leaf, dir_item);
553 read_extent_buffer(leaf, filename, name_ptr, name_len);
554 filename[name_len] = '\0';
555 type = btrfs_dir_type(leaf, dir_item);
556 btrfs_dir_item_key_to_cpu(leaf, dir_item, &location);
558 snprintf(path_name, 4096, "%s/%s", dir, filename);
562 * At this point we're only going to restore directories and
563 * files, no symlinks or anything else.
565 if (type == BTRFS_FT_REG_FILE) {
570 ret = stat(path_name, &st);
573 if (verbose || !warn)
574 printf("Skipping existing file"
578 printf("If you wish to overwrite use "
579 "the -o option to overwrite\n");
586 printf("Restoring %s\n", path_name);
587 fd = open(path_name, O_CREAT|O_WRONLY, 0644);
589 fprintf(stderr, "Error creating %s: %d\n",
593 btrfs_free_path(path);
597 ret = copy_file(root, fd, &location, path_name);
602 btrfs_free_path(path);
605 } else if (type == BTRFS_FT_DIR) {
606 struct btrfs_root *search_root = root;
607 char *dir = strdup(path_name);
610 fprintf(stderr, "Ran out of memory\n");
611 btrfs_free_path(path);
615 if (location.type == BTRFS_ROOT_ITEM_KEY) {
617 * If we are a snapshot and this is the index
618 * object to ourselves just skip it.
620 if (location.objectid ==
621 root->root_key.objectid) {
626 search_root = btrfs_read_fs_root(root->fs_info,
628 if (IS_ERR(search_root)) {
630 fprintf(stderr, "Error reading "
631 "subvolume %s: %lu\n",
633 PTR_ERR(search_root));
636 btrfs_free_path(path);
637 return PTR_ERR(search_root);
641 * A subvolume will have a key.offset of 0, a
642 * snapshot will have key.offset of a transid.
644 if (search_root->root_key.offset != 0 &&
647 printf("Skipping snapshot %s\n",
651 location.objectid = BTRFS_FIRST_FREE_OBJECTID;
655 printf("Restoring %s\n", path_name);
658 ret = mkdir(path_name, 0755);
659 if (ret && errno != EEXIST) {
661 fprintf(stderr, "Error mkdiring %s: %d\n",
665 btrfs_free_path(path);
669 ret = search_dir(search_root, &location, dir);
674 btrfs_free_path(path);
683 printf("Done searching %s\n", dir);
684 btrfs_free_path(path);
688 static struct btrfs_root *open_fs(const char *dev, u64 root_location, int super_mirror)
690 struct btrfs_root *root;
694 for (i = super_mirror; i < BTRFS_SUPER_MIRROR_MAX; i++) {
695 bytenr = btrfs_sb_offset(i);
696 root = open_ctree_recovery(dev, bytenr, root_location);
699 fprintf(stderr, "Could not open root, trying backup super\n");
705 static int find_first_dir(struct btrfs_root *root, u64 *objectid)
707 struct btrfs_path *path;
708 struct btrfs_key found_key;
709 struct btrfs_key key;
714 key.type = BTRFS_DIR_INDEX_KEY;
717 path = btrfs_alloc_path();
719 fprintf(stderr, "Ran out of memory\n");
723 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
725 fprintf(stderr, "Error searching %d\n", ret);
729 if (!path->nodes[0]) {
730 fprintf(stderr, "No leaf!\n");
734 for (i = path->slots[0];
735 i < btrfs_header_nritems(path->nodes[0]); i++) {
736 btrfs_item_key_to_cpu(path->nodes[0], &found_key, i);
737 if (found_key.type != key.type)
740 printf("Using objectid %Lu for first dir\n",
742 *objectid = found_key.objectid;
747 ret = next_leaf(root, path);
749 fprintf(stderr, "Error getting next leaf %d\n",
752 } else if (ret > 0) {
753 fprintf(stderr, "No more leaves\n");
756 } while (!path->nodes[0]);
759 printf("Couldn't find a dir index item\n");
761 btrfs_free_path(path);
765 const char * const cmd_restore_usage[] = {
766 "btrfs restore [options] <device>",
767 "Try to restore files from a damaged filesystem (unmounted)",
774 "-f <offset> filesystem location",
775 "-u <block> super mirror",
780 int cmd_restore(int argc, char **argv)
782 struct btrfs_root *root;
783 struct btrfs_key key;
785 u64 tree_location = 0;
787 u64 root_objectid = 0;
791 int super_mirror = 0;
794 while ((opt = getopt(argc, argv, "sviot:u:df:r:")) != -1) {
810 tree_location = (u64)strtoll(optarg, NULL, 10);
812 fprintf(stderr, "Tree location not valid\n");
818 fs_location = (u64)strtoll(optarg, NULL, 10);
820 fprintf(stderr, "Fs location not valid\n");
826 super_mirror = (int)strtol(optarg, NULL, 10);
828 super_mirror >= BTRFS_SUPER_MIRROR_MAX) {
829 fprintf(stderr, "Super mirror not "
839 root_objectid = (u64)strtoll(optarg, NULL, 10);
841 fprintf(stderr, "Root objectid not valid\n");
846 usage(cmd_restore_usage);
850 if (optind + 1 >= argc)
851 usage(cmd_restore_usage);
853 if ((ret = check_mounted(argv[optind])) < 0) {
854 fprintf(stderr, "Could not check mount status: %s\n",
858 fprintf(stderr, "%s is currently mounted. Aborting.\n", argv[optind]);
862 root = open_fs(argv[optind], tree_location, super_mirror);
866 if (fs_location != 0) {
867 free_extent_buffer(root->node);
868 root->node = read_tree_block(root, fs_location, 4096, 0);
870 fprintf(stderr, "Failed to read fs location\n");
875 memset(path_name, 0, 4096);
877 strncpy(dir_name, argv[optind + 1], sizeof dir_name);
878 dir_name[sizeof dir_name - 1] = 0;
880 /* Strip the trailing / on the dir name */
881 len = strlen(dir_name);
882 while (len && dir_name[--len] == '/') {
883 dir_name[len] = '\0';
886 if (root_objectid != 0) {
887 struct btrfs_root *orig_root = root;
889 key.objectid = root_objectid;
890 key.type = BTRFS_ROOT_ITEM_KEY;
891 key.offset = (u64)-1;
892 root = btrfs_read_fs_root(orig_root->fs_info, &key);
894 fprintf(stderr, "Error reading root\n");
904 ret = find_first_dir(root, &key.objectid);
908 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
911 ret = search_dir(root, &key, dir_name);