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.
20 #include "kerncompat.h"
28 #include <sys/types.h>
29 #include <lzo/lzoconf.h>
30 #include <lzo/lzo1x.h>
34 #include <sys/types.h>
35 #include <sys/xattr.h>
39 #include "print-tree.h"
40 #include "transaction.h"
47 static char fs_name[PATH_MAX];
48 static char path_name[PATH_MAX];
49 static char symlink_target[PATH_MAX];
50 static int get_snaps = 0;
51 static int verbose = 0;
52 static int restore_metadata = 0;
53 static int restore_symlinks = 0;
54 static int ignore_errors = 0;
55 static int overwrite = 0;
56 static int get_xattrs = 0;
57 static int dry_run = 0;
60 #define lzo1x_worst_compress(x) ((x) + ((x) / 16) + 64 + 3)
62 static int decompress_zlib(char *inbuf, char *outbuf, u64 compress_len,
68 memset(&strm, 0, sizeof(strm));
69 ret = inflateInit(&strm);
71 error("zlib init returned %d", ret);
75 strm.avail_in = compress_len;
76 strm.next_in = (unsigned char *)inbuf;
77 strm.avail_out = decompress_len;
78 strm.next_out = (unsigned char *)outbuf;
79 ret = inflate(&strm, Z_NO_FLUSH);
80 if (ret != Z_STREAM_END) {
81 (void)inflateEnd(&strm);
82 error("zlib inflate failed: %d", ret);
86 (void)inflateEnd(&strm);
89 static inline size_t read_compress_length(unsigned char *buf)
92 memcpy(&dlen, buf, LZO_LEN);
93 return le32_to_cpu(dlen);
96 static int decompress_lzo(struct btrfs_root *root, unsigned char *inbuf,
97 char *outbuf, u64 compress_len, u64 *decompress_len)
107 if (ret != LZO_E_OK) {
108 error("lzo init returned %d", ret);
112 tot_len = read_compress_length(inbuf);
116 while (tot_in < tot_len) {
119 in_len = read_compress_length(inbuf);
121 if ((tot_in + LZO_LEN + in_len) > tot_len) {
122 error("bad compress length %lu",
123 (unsigned long)in_len);
129 new_len = lzo1x_worst_compress(root->fs_info->sectorsize);
130 ret = lzo1x_decompress_safe((const unsigned char *)inbuf, in_len,
131 (unsigned char *)outbuf,
132 (void *)&new_len, NULL);
133 if (ret != LZO_E_OK) {
134 error("lzo decompress failed: %d", ret);
143 * If the 4 byte header does not fit to the rest of the page we
144 * have to move to the next one, unless we read some garbage
146 mod_page = tot_in % root->fs_info->sectorsize;
147 rem_page = root->fs_info->sectorsize - mod_page;
148 if (rem_page < LZO_LEN) {
154 *decompress_len = out_len;
159 static int decompress(struct btrfs_root *root, char *inbuf, char *outbuf,
160 u64 compress_len, u64 *decompress_len, int compress)
163 case BTRFS_COMPRESS_ZLIB:
164 return decompress_zlib(inbuf, outbuf, compress_len,
166 case BTRFS_COMPRESS_LZO:
167 return decompress_lzo(root, (unsigned char *)inbuf, outbuf,
168 compress_len, decompress_len);
173 error("invalid compression type: %d", compress);
177 static int next_leaf(struct btrfs_root *root, struct btrfs_path *path)
182 struct extent_buffer *c;
183 struct extent_buffer *next = NULL;
184 struct btrfs_fs_info *fs_info = root->fs_info;
187 for (; level < BTRFS_MAX_LEVEL; level++) {
188 if (path->nodes[level])
192 if (level >= BTRFS_MAX_LEVEL)
195 slot = path->slots[level] + 1;
197 while(level < BTRFS_MAX_LEVEL) {
198 if (!path->nodes[level])
201 slot = path->slots[level] + offset;
202 c = path->nodes[level];
203 if (slot >= btrfs_header_nritems(c)) {
205 if (level == BTRFS_MAX_LEVEL)
212 reada_for_search(root, path, level, slot, 0);
214 next = read_node_slot(fs_info, c, slot);
215 if (extent_buffer_uptodate(next))
219 path->slots[level] = slot;
222 c = path->nodes[level];
223 free_extent_buffer(c);
224 path->nodes[level] = next;
225 path->slots[level] = 0;
229 reada_for_search(root, path, level, 0, 0);
230 next = read_node_slot(fs_info, next, 0);
231 if (!extent_buffer_uptodate(next))
237 static int copy_one_inline(struct btrfs_root *root, int fd,
238 struct btrfs_path *path, u64 pos)
240 struct extent_buffer *leaf = path->nodes[0];
241 struct btrfs_file_extent_item *fi;
252 fi = btrfs_item_ptr(leaf, path->slots[0],
253 struct btrfs_file_extent_item);
254 ptr = btrfs_file_extent_inline_start(fi);
255 len = btrfs_file_extent_inline_len(leaf, path->slots[0], fi);
256 inline_item_len = btrfs_file_extent_inline_item_len(leaf, btrfs_item_nr(path->slots[0]));
257 read_extent_buffer(leaf, buf, ptr, inline_item_len);
259 compress = btrfs_file_extent_compression(leaf, fi);
260 if (compress == BTRFS_COMPRESS_NONE) {
261 done = pwrite(fd, buf, len, pos);
263 fprintf(stderr, "Short inline write, wanted %d, did "
264 "%zd: %d\n", len, done, errno);
270 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
271 outbuf = calloc(1, ram_size);
273 error("not enough memory");
277 ret = decompress(root, buf, outbuf, len, &ram_size, compress);
283 done = pwrite(fd, outbuf, ram_size, pos);
285 if (done < ram_size) {
286 fprintf(stderr, "Short compressed inline write, wanted %Lu, "
287 "did %zd: %d\n", ram_size, done, errno);
294 static int copy_one_extent(struct btrfs_root *root, int fd,
295 struct extent_buffer *leaf,
296 struct btrfs_file_extent_item *fi, u64 pos)
298 struct btrfs_multi_bio *multi = NULL;
299 struct btrfs_device *device;
300 char *inbuf, *outbuf = NULL;
301 ssize_t done, total = 0;
317 compress = btrfs_file_extent_compression(leaf, fi);
318 bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
319 disk_size = btrfs_file_extent_disk_num_bytes(leaf, fi);
320 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
321 offset = btrfs_file_extent_offset(leaf, fi);
322 num_bytes = btrfs_file_extent_num_bytes(leaf, fi);
323 size_left = disk_size;
324 if (compress == BTRFS_COMPRESS_NONE)
327 if (verbose && offset)
328 printf("offset is %Lu\n", offset);
329 /* we found a hole */
333 inbuf = malloc(size_left);
335 error("not enough memory");
339 if (compress != BTRFS_COMPRESS_NONE) {
340 outbuf = calloc(1, ram_size);
342 error("not enough memory");
349 ret = btrfs_map_block(root->fs_info, READ, bytenr, &length, &multi,
352 error("cannot map block logical %llu length %llu: %d",
353 (unsigned long long)bytenr,
354 (unsigned long long)length, ret);
357 device = multi->stripes[0].dev;
360 dev_bytenr = multi->stripes[0].physical;
363 if (size_left < length)
366 done = pread(dev_fd, inbuf+count, length, dev_bytenr);
367 /* Need both checks, or we miss negative values due to u64 conversion */
368 if (done < 0 || done < length) {
369 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
372 /* mirror_num is 1-indexed, so num_copies is a valid mirror. */
373 if (mirror_num > num_copies) {
375 error("exhausted mirrors trying to read (%d > %d)",
376 mirror_num, num_copies);
379 fprintf(stderr, "Trying another mirror\n");
390 if (compress == BTRFS_COMPRESS_NONE) {
391 while (total < num_bytes) {
392 done = pwrite(fd, inbuf+total, num_bytes-total,
396 error("cannot write data: %d %s", errno, strerror(errno));
405 ret = decompress(root, inbuf, outbuf, disk_size, &ram_size, compress);
407 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
410 if (mirror_num >= num_copies) {
414 fprintf(stderr, "Trying another mirror\n");
418 while (total < num_bytes) {
419 done = pwrite(fd, outbuf + offset + total,
440 static enum loop_response ask_to_continue(const char *file)
445 printf("We seem to be looping a lot on %s, do you want to keep going "
446 "on ? (y/N/a): ", file);
448 ret = fgets(buf, 2, stdin);
449 if (*ret == '\n' || tolower(*ret) == 'n')
451 if (tolower(*ret) == 'a')
453 if (tolower(*ret) != 'y') {
454 printf("Please enter one of 'y', 'n', or 'a': ");
458 return LOOP_CONTINUE;
462 static int set_file_xattrs(struct btrfs_root *root, u64 inode,
463 int fd, const char *file_name)
465 struct btrfs_key key;
466 struct btrfs_path path;
467 struct extent_buffer *leaf;
468 struct btrfs_dir_item *di;
477 btrfs_init_path(&path);
478 key.objectid = inode;
479 key.type = BTRFS_XATTR_ITEM_KEY;
481 ret = btrfs_search_slot(NULL, root, &key, &path, 0, 0);
485 leaf = path.nodes[0];
487 if (path.slots[0] >= btrfs_header_nritems(leaf)) {
489 ret = next_leaf(root, &path);
491 error("searching for extended attributes: %d",
495 /* No more leaves to search */
499 leaf = path.nodes[0];
504 btrfs_item_key_to_cpu(leaf, &key, path.slots[0]);
505 if (key.type != BTRFS_XATTR_ITEM_KEY || key.objectid != inode)
508 total_len = btrfs_item_size_nr(leaf, path.slots[0]);
509 di = btrfs_item_ptr(leaf, path.slots[0],
510 struct btrfs_dir_item);
512 while (cur < total_len) {
513 len = btrfs_dir_name_len(leaf, di);
514 if (len > name_len) {
516 name = (char *) malloc(len + 1);
522 read_extent_buffer(leaf, name,
523 (unsigned long)(di + 1), len);
527 len = btrfs_dir_data_len(leaf, di);
528 if (len > data_len) {
530 data = (char *) malloc(len);
536 read_extent_buffer(leaf, data,
537 (unsigned long)(di + 1) + name_len,
541 if (fsetxattr(fd, name, data, data_len, 0))
542 error("setting extended attribute %s on file %s: %s",
543 name, file_name, strerror(errno));
545 len = sizeof(*di) + name_len + data_len;
547 di = (struct btrfs_dir_item *)((char *)di + len);
553 btrfs_release_path(&path);
560 static int copy_metadata(struct btrfs_root *root, int fd,
561 struct btrfs_key *key)
563 struct btrfs_path path;
564 struct btrfs_inode_item *inode_item;
567 btrfs_init_path(&path);
568 ret = btrfs_lookup_inode(NULL, root, &path, key, 0);
570 struct btrfs_timespec *bts;
571 struct timespec times[2];
573 inode_item = btrfs_item_ptr(path.nodes[0], path.slots[0],
574 struct btrfs_inode_item);
576 ret = fchown(fd, btrfs_inode_uid(path.nodes[0], inode_item),
577 btrfs_inode_gid(path.nodes[0], inode_item));
579 error("failed to change owner: %s", strerror(errno));
583 ret = fchmod(fd, btrfs_inode_mode(path.nodes[0], inode_item));
585 error("failed to change mode: %s", strerror(errno));
589 bts = btrfs_inode_atime(inode_item);
590 times[0].tv_sec = btrfs_timespec_sec(path.nodes[0], bts);
591 times[0].tv_nsec = btrfs_timespec_nsec(path.nodes[0], bts);
593 bts = btrfs_inode_mtime(inode_item);
594 times[1].tv_sec = btrfs_timespec_sec(path.nodes[0], bts);
595 times[1].tv_nsec = btrfs_timespec_nsec(path.nodes[0], bts);
597 ret = futimens(fd, times);
599 error("failed to set times: %s", strerror(errno));
604 btrfs_release_path(&path);
608 static int copy_file(struct btrfs_root *root, int fd, struct btrfs_key *key,
611 struct extent_buffer *leaf;
612 struct btrfs_path path;
613 struct btrfs_file_extent_item *fi;
614 struct btrfs_inode_item *inode_item;
615 struct btrfs_timespec *bts;
616 struct btrfs_key found_key;
622 struct timespec times[2];
625 btrfs_init_path(&path);
626 ret = btrfs_lookup_inode(NULL, root, &path, key, 0);
628 inode_item = btrfs_item_ptr(path.nodes[0], path.slots[0],
629 struct btrfs_inode_item);
630 found_size = btrfs_inode_size(path.nodes[0], inode_item);
632 if (restore_metadata) {
634 * Change the ownership and mode now, set times when
635 * copyout is finished.
638 ret = fchown(fd, btrfs_inode_uid(path.nodes[0], inode_item),
639 btrfs_inode_gid(path.nodes[0], inode_item));
640 if (ret && !ignore_errors)
643 ret = fchmod(fd, btrfs_inode_mode(path.nodes[0], inode_item));
644 if (ret && !ignore_errors)
647 bts = btrfs_inode_atime(inode_item);
648 times[0].tv_sec = btrfs_timespec_sec(path.nodes[0], bts);
649 times[0].tv_nsec = btrfs_timespec_nsec(path.nodes[0], bts);
651 bts = btrfs_inode_mtime(inode_item);
652 times[1].tv_sec = btrfs_timespec_sec(path.nodes[0], bts);
653 times[1].tv_nsec = btrfs_timespec_nsec(path.nodes[0], bts);
657 btrfs_release_path(&path);
660 key->type = BTRFS_EXTENT_DATA_KEY;
662 ret = btrfs_search_slot(NULL, root, key, &path, 0, 0);
664 error("searching extent data returned %d", ret);
668 leaf = path.nodes[0];
670 ret = next_leaf(root, &path);
672 error("cannot get next leaf: %d", ret);
674 } else if (ret > 0) {
675 /* No more leaves to search */
679 leaf = path.nodes[0];
683 if (loops >= 0 && loops++ >= 1024) {
684 enum loop_response resp;
686 resp = ask_to_continue(file);
687 if (resp == LOOP_STOP)
689 else if (resp == LOOP_CONTINUE)
691 else if (resp == LOOP_DONTASK)
694 if (path.slots[0] >= btrfs_header_nritems(leaf)) {
696 ret = next_leaf(root, &path);
698 fprintf(stderr, "Error searching %d\n", ret);
701 /* No more leaves to search */
702 btrfs_release_path(&path);
705 leaf = path.nodes[0];
709 btrfs_item_key_to_cpu(leaf, &found_key, path.slots[0]);
710 if (found_key.objectid != key->objectid)
712 if (found_key.type != key->type)
714 fi = btrfs_item_ptr(leaf, path.slots[0],
715 struct btrfs_file_extent_item);
716 extent_type = btrfs_file_extent_type(leaf, fi);
717 compression = btrfs_file_extent_compression(leaf, fi);
718 if (compression >= BTRFS_COMPRESS_LAST) {
719 warning("compression type %d not supported",
725 if (extent_type == BTRFS_FILE_EXTENT_PREALLOC)
727 if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
728 ret = copy_one_inline(root, fd, &path, found_key.offset);
731 } else if (extent_type == BTRFS_FILE_EXTENT_REG) {
732 ret = copy_one_extent(root, fd, leaf, fi,
737 warning("weird extent type %d", extent_type);
743 btrfs_release_path(&path);
746 ret = ftruncate(fd, (loff_t)found_size);
751 ret = set_file_xattrs(root, key->objectid, fd, file);
755 if (restore_metadata && times_ok) {
756 ret = futimens(fd, times);
763 btrfs_release_path(&path);
769 * 0 if the file exists and should be skipped.
770 * 1 if the file does NOT exist
771 * 2 if the file exists but is OK to overwrite
773 static int overwrite_ok(const char * path)
779 /* don't be fooled by symlinks */
780 ret = fstatat(-1, path_name, &st, AT_SYMLINK_NOFOLLOW);
786 if (verbose || !warn)
787 printf("Skipping existing file"
790 printf("If you wish to overwrite use -o\n");
797 static int copy_symlink(struct btrfs_root *root, struct btrfs_key *key,
800 struct btrfs_path path;
801 struct extent_buffer *leaf;
802 struct btrfs_file_extent_item *extent_item;
803 struct btrfs_inode_item *inode_item;
807 struct btrfs_timespec *bts;
808 struct timespec times[2];
810 ret = overwrite_ok(path_name);
812 return 0; /* skip this file */
814 /* symlink() can't overwrite, so unlink first */
816 ret = unlink(path_name);
818 fprintf(stderr, "failed to unlink '%s' for overwrite\n",
824 btrfs_init_path(&path);
825 key->type = BTRFS_EXTENT_DATA_KEY;
827 ret = btrfs_search_slot(NULL, root, key, &path, 0, 0);
831 leaf = path.nodes[0];
833 fprintf(stderr, "Error getting leaf for symlink '%s'\n", file);
838 extent_item = btrfs_item_ptr(leaf, path.slots[0],
839 struct btrfs_file_extent_item);
841 len = btrfs_file_extent_inline_item_len(leaf,
842 btrfs_item_nr(path.slots[0]));
843 if (len >= PATH_MAX) {
844 fprintf(stderr, "Symlink '%s' target length %d is longer than PATH_MAX\n",
850 name_offset = (unsigned long) extent_item
851 + offsetof(struct btrfs_file_extent_item, disk_bytenr);
852 read_extent_buffer(leaf, symlink_target, name_offset, len);
854 symlink_target[len] = 0;
857 ret = symlink(symlink_target, path_name);
859 fprintf(stderr, "Failed to restore symlink '%s': %s\n",
860 path_name, strerror(errno));
864 printf("SYMLINK: '%s' => '%s'\n", path_name, symlink_target);
867 if (!restore_metadata)
871 * Symlink metadata operates differently than files/directories, so do
874 key->type = BTRFS_INODE_ITEM_KEY;
877 btrfs_release_path(&path);
879 ret = btrfs_lookup_inode(NULL, root, &path, key, 0);
881 fprintf(stderr, "Failed to lookup inode for '%s'\n", file);
885 inode_item = btrfs_item_ptr(path.nodes[0], path.slots[0],
886 struct btrfs_inode_item);
888 ret = fchownat(-1, file, btrfs_inode_uid(path.nodes[0], inode_item),
889 btrfs_inode_gid(path.nodes[0], inode_item),
890 AT_SYMLINK_NOFOLLOW);
892 fprintf(stderr, "Failed to change owner: %s\n",
897 bts = btrfs_inode_atime(inode_item);
898 times[0].tv_sec = btrfs_timespec_sec(path.nodes[0], bts);
899 times[0].tv_nsec = btrfs_timespec_nsec(path.nodes[0], bts);
901 bts = btrfs_inode_mtime(inode_item);
902 times[1].tv_sec = btrfs_timespec_sec(path.nodes[0], bts);
903 times[1].tv_nsec = btrfs_timespec_nsec(path.nodes[0], bts);
905 ret = utimensat(-1, file, times, AT_SYMLINK_NOFOLLOW);
907 fprintf(stderr, "Failed to set times: %s\n", strerror(errno));
909 btrfs_release_path(&path);
913 static int search_dir(struct btrfs_root *root, struct btrfs_key *key,
914 const char *output_rootdir, const char *in_dir,
917 struct btrfs_path path;
918 struct extent_buffer *leaf;
919 struct btrfs_dir_item *dir_item;
920 struct btrfs_key found_key, location;
921 char filename[BTRFS_NAME_LEN + 1];
922 unsigned long name_ptr;
929 btrfs_init_path(&path);
931 key->type = BTRFS_DIR_INDEX_KEY;
932 ret = btrfs_search_slot(NULL, root, key, &path, 0, 0);
934 fprintf(stderr, "Error searching %d\n", ret);
940 leaf = path.nodes[0];
943 printf("No leaf after search, looking for the next "
945 ret = next_leaf(root, &path);
947 fprintf(stderr, "Error getting next leaf %d\n",
950 } else if (ret > 0) {
951 /* No more leaves to search */
953 printf("Reached the end of the tree looking "
954 "for the directory\n");
958 leaf = path.nodes[0];
962 if (loops++ >= 1024) {
963 printf("We have looped trying to restore files in %s "
964 "too many times to be making progress, "
965 "stopping\n", in_dir);
969 if (path.slots[0] >= btrfs_header_nritems(leaf)) {
971 ret = next_leaf(root, &path);
973 fprintf(stderr, "Error searching %d\n",
976 } else if (ret > 0) {
977 /* No more leaves to search */
979 printf("Reached the end of "
980 "the tree searching the"
985 leaf = path.nodes[0];
989 btrfs_item_key_to_cpu(leaf, &found_key, path.slots[0]);
990 if (found_key.objectid != key->objectid) {
992 printf("Found objectid=%Lu, key=%Lu\n",
993 found_key.objectid, key->objectid);
996 if (found_key.type != key->type) {
998 printf("Found type=%u, want=%u\n",
999 found_key.type, key->type);
1002 dir_item = btrfs_item_ptr(leaf, path.slots[0],
1003 struct btrfs_dir_item);
1004 name_ptr = (unsigned long)(dir_item + 1);
1005 name_len = btrfs_dir_name_len(leaf, dir_item);
1006 read_extent_buffer(leaf, filename, name_ptr, name_len);
1007 filename[name_len] = '\0';
1008 type = btrfs_dir_type(leaf, dir_item);
1009 btrfs_dir_item_key_to_cpu(leaf, dir_item, &location);
1011 /* full path from root of btrfs being restored */
1012 snprintf(fs_name, PATH_MAX, "%s/%s", in_dir, filename);
1014 if (mreg && REG_NOMATCH == regexec(mreg, fs_name, 0, NULL, 0))
1017 /* full path from system root */
1018 snprintf(path_name, PATH_MAX, "%s%s", output_rootdir, fs_name);
1021 * Restore directories, files, symlinks and metadata.
1023 if (type == BTRFS_FT_REG_FILE) {
1024 if (!overwrite_ok(path_name))
1028 printf("Restoring %s\n", path_name);
1031 fd = open(path_name, O_CREAT|O_WRONLY, 0644);
1033 fprintf(stderr, "Error creating %s: %d\n",
1041 ret = copy_file(root, fd, &location, path_name);
1044 fprintf(stderr, "Error copying data for %s\n",
1050 } else if (type == BTRFS_FT_DIR) {
1051 struct btrfs_root *search_root = root;
1052 char *dir = strdup(fs_name);
1055 fprintf(stderr, "Ran out of memory\n");
1060 if (location.type == BTRFS_ROOT_ITEM_KEY) {
1062 * If we are a snapshot and this is the index
1063 * object to ourselves just skip it.
1065 if (location.objectid ==
1066 root->root_key.objectid) {
1071 location.offset = (u64)-1;
1072 search_root = btrfs_read_fs_root(root->fs_info,
1074 if (IS_ERR(search_root)) {
1076 fprintf(stderr, "Error reading "
1077 "subvolume %s: %lu\n",
1079 PTR_ERR(search_root));
1082 ret = PTR_ERR(search_root);
1087 * A subvolume will have a key.offset of 0, a
1088 * snapshot will have key.offset of a transid.
1090 if (search_root->root_key.offset != 0 &&
1093 printf("Skipping snapshot %s\n",
1097 location.objectid = BTRFS_FIRST_FREE_OBJECTID;
1101 printf("Restoring %s\n", path_name);
1107 ret = mkdir(path_name, 0755);
1108 if (ret && errno != EEXIST) {
1110 fprintf(stderr, "Error mkdiring %s: %d\n",
1118 ret = search_dir(search_root, &location,
1119 output_rootdir, dir, mreg);
1122 fprintf(stderr, "Error searching %s\n",
1128 } else if (type == BTRFS_FT_SYMLINK) {
1129 if (restore_symlinks)
1130 ret = copy_symlink(root, &location, path_name);
1134 btrfs_release_path(&path);
1142 if (restore_metadata) {
1143 snprintf(path_name, PATH_MAX, "%s%s", output_rootdir, in_dir);
1144 fd = open(path_name, O_RDONLY);
1146 fprintf(stderr, "ERROR: Failed to access %s to restore metadata\n",
1148 if (!ignore_errors) {
1154 * Set owner/mode/time on the directory as well
1156 key->type = BTRFS_INODE_ITEM_KEY;
1157 ret = copy_metadata(root, fd, key);
1159 if (ret && !ignore_errors)
1165 printf("Done searching %s\n", in_dir);
1167 btrfs_release_path(&path);
1171 static int do_list_roots(struct btrfs_root *root)
1173 struct btrfs_key key;
1174 struct btrfs_key found_key;
1175 struct btrfs_disk_key disk_key;
1176 struct btrfs_path path;
1177 struct extent_buffer *leaf;
1178 struct btrfs_root_item ri;
1179 unsigned long offset;
1183 root = root->fs_info->tree_root;
1185 btrfs_init_path(&path);
1188 key.type = BTRFS_ROOT_ITEM_KEY;
1189 ret = btrfs_search_slot(NULL, root, &key, &path, 0, 0);
1191 fprintf(stderr, "Failed to do search %d\n", ret);
1192 btrfs_release_path(&path);
1196 leaf = path.nodes[0];
1199 slot = path.slots[0];
1200 if (slot >= btrfs_header_nritems(leaf)) {
1201 ret = btrfs_next_leaf(root, &path);
1204 leaf = path.nodes[0];
1205 slot = path.slots[0];
1207 btrfs_item_key(leaf, &disk_key, slot);
1208 btrfs_disk_key_to_cpu(&found_key, &disk_key);
1209 if (found_key.type != BTRFS_ROOT_ITEM_KEY) {
1214 offset = btrfs_item_ptr_offset(leaf, slot);
1215 read_extent_buffer(leaf, &ri, offset, sizeof(ri));
1217 btrfs_print_key(&disk_key);
1218 printf(" %Lu level %d\n", btrfs_root_bytenr(&ri),
1219 btrfs_root_level(&ri));
1222 btrfs_release_path(&path);
1227 static struct btrfs_root *open_fs(const char *dev, u64 root_location,
1228 int super_mirror, int list_roots)
1230 struct btrfs_fs_info *fs_info = NULL;
1231 struct btrfs_root *root = NULL;
1235 for (i = super_mirror; i < BTRFS_SUPER_MIRROR_MAX; i++) {
1236 bytenr = btrfs_sb_offset(i);
1237 fs_info = open_ctree_fs_info(dev, bytenr, root_location, 0,
1238 OPEN_CTREE_PARTIAL);
1241 fprintf(stderr, "Could not open root, trying backup super\n");
1248 * All we really need to succeed is reading the chunk tree, everything
1249 * else we can do by hand, since we only need to read the tree root and
1252 if (!extent_buffer_uptodate(fs_info->tree_root->node)) {
1255 root = fs_info->tree_root;
1257 root_location = btrfs_super_root(fs_info->super_copy);
1258 generation = btrfs_super_generation(fs_info->super_copy);
1259 root->node = read_tree_block(fs_info, root_location,
1260 fs_info->nodesize, generation);
1261 if (!extent_buffer_uptodate(root->node)) {
1262 fprintf(stderr, "Error opening tree root\n");
1268 if (!list_roots && !fs_info->fs_root) {
1269 struct btrfs_key key;
1271 key.objectid = BTRFS_FS_TREE_OBJECTID;
1272 key.type = BTRFS_ROOT_ITEM_KEY;
1273 key.offset = (u64)-1;
1274 fs_info->fs_root = btrfs_read_fs_root_no_cache(fs_info, &key);
1275 if (IS_ERR(fs_info->fs_root)) {
1276 fprintf(stderr, "Couldn't read fs root: %ld\n",
1277 PTR_ERR(fs_info->fs_root));
1278 close_ctree(fs_info->tree_root);
1283 if (list_roots && do_list_roots(fs_info->tree_root)) {
1284 close_ctree(fs_info->tree_root);
1288 return fs_info->fs_root;
1291 static int find_first_dir(struct btrfs_root *root, u64 *objectid)
1293 struct btrfs_path path;
1294 struct btrfs_key found_key;
1295 struct btrfs_key key;
1299 btrfs_init_path(&path);
1301 key.type = BTRFS_DIR_INDEX_KEY;
1303 ret = btrfs_search_slot(NULL, root, &key, &path, 0, 0);
1305 fprintf(stderr, "Error searching %d\n", ret);
1309 if (!path.nodes[0]) {
1310 fprintf(stderr, "No leaf!\n");
1314 for (i = path.slots[0];
1315 i < btrfs_header_nritems(path.nodes[0]); i++) {
1316 btrfs_item_key_to_cpu(path.nodes[0], &found_key, i);
1317 if (found_key.type != key.type)
1320 printf("Using objectid %Lu for first dir\n",
1321 found_key.objectid);
1322 *objectid = found_key.objectid;
1327 ret = next_leaf(root, &path);
1329 fprintf(stderr, "Error getting next leaf %d\n",
1332 } else if (ret > 0) {
1333 fprintf(stderr, "No more leaves\n");
1336 } while (!path.nodes[0]);
1339 printf("Couldn't find a dir index item\n");
1341 btrfs_release_path(&path);
1345 const char * const cmd_restore_usage[] = {
1346 "btrfs restore [options] <device> <path> | -l <device>",
1347 "Try to restore files from a damaged filesystem (unmounted)",
1349 "-s|--snapshots get snapshots",
1350 "-x|--xattr restore extended attributes",
1351 "-m|--metadata restore owner, mode and times",
1352 "-S|--symlink restore symbolic links",
1353 "-v|--verbose verbose",
1354 "-i|--ignore-errors ignore errors",
1355 "-o|--overwrite overwrite",
1356 "-t <bytenr> tree location",
1357 "-f <bytenr> filesystem location",
1358 "-u|--super <mirror> super mirror",
1359 "-r|--root <rootid> root objectid",
1361 "-l|--list-roots list tree roots",
1362 "-D|--dry-run dry run (only list files that would be recovered)",
1363 "--path-regex <regex>",
1364 " restore only filenames matching regex,",
1365 " you have to use following syntax (possibly quoted):",
1366 " ^/(|home(|/username(|/Desktop(|/.*))))$",
1367 "-c ignore case (--path-regex only)",
1371 int cmd_restore(int argc, char **argv)
1373 struct btrfs_root *root;
1374 struct btrfs_key key;
1375 char dir_name[PATH_MAX];
1376 u64 tree_location = 0;
1377 u64 fs_location = 0;
1378 u64 root_objectid = 0;
1381 int super_mirror = 0;
1384 const char *match_regstr = NULL;
1385 int match_cflags = REG_EXTENDED | REG_NOSUB | REG_NEWLINE;
1386 regex_t match_reg, *mreg = NULL;
1391 enum { GETOPT_VAL_PATH_REGEX = 256 };
1392 static const struct option long_options[] = {
1393 { "path-regex", required_argument, NULL,
1394 GETOPT_VAL_PATH_REGEX },
1395 { "dry-run", no_argument, NULL, 'D'},
1396 { "metadata", no_argument, NULL, 'm'},
1397 { "symlinks", no_argument, NULL, 'S'},
1398 { "snapshots", no_argument, NULL, 's'},
1399 { "xattr", no_argument, NULL, 'x'},
1400 { "verbose", no_argument, NULL, 'v'},
1401 { "ignore-errors", no_argument, NULL, 'i'},
1402 { "overwrite", no_argument, NULL, 'o'},
1403 { "super", required_argument, NULL, 'u'},
1404 { "root", required_argument, NULL, 'r'},
1405 { "list-roots", no_argument, NULL, 'l'},
1409 opt = getopt_long(argc, argv, "sSxviot:u:dmf:r:lDc", long_options,
1428 tree_location = arg_strtou64(optarg);
1431 fs_location = arg_strtou64(optarg);
1434 super_mirror = arg_strtou64(optarg);
1435 if (super_mirror >= BTRFS_SUPER_MIRROR_MAX) {
1436 fprintf(stderr, "Super mirror not "
1445 root_objectid = arg_strtou64(optarg);
1446 if (!is_fstree(root_objectid)) {
1447 fprintf(stderr, "objectid %llu is not a valid fs/file tree\n",
1456 restore_metadata = 1;
1459 restore_symlinks = 1;
1465 match_cflags |= REG_ICASE;
1467 case GETOPT_VAL_PATH_REGEX:
1468 match_regstr = optarg;
1474 usage(cmd_restore_usage);
1478 if (!list_roots && check_argc_min(argc - optind, 2))
1479 usage(cmd_restore_usage);
1480 else if (list_roots && check_argc_min(argc - optind, 1))
1481 usage(cmd_restore_usage);
1483 if (fs_location && root_objectid) {
1484 fprintf(stderr, "don't use -f and -r at the same time.\n");
1488 if ((ret = check_mounted(argv[optind])) < 0) {
1489 fprintf(stderr, "Could not check mount status: %s\n",
1493 fprintf(stderr, "%s is currently mounted. Aborting.\n", argv[optind]);
1497 root = open_fs(argv[optind], tree_location, super_mirror, list_roots);
1504 if (fs_location != 0) {
1505 free_extent_buffer(root->node);
1506 root->node = read_tree_block(root->fs_info, fs_location,
1507 root->fs_info->nodesize, 0);
1508 if (!extent_buffer_uptodate(root->node)) {
1509 fprintf(stderr, "Failed to read fs location\n");
1515 memset(path_name, 0, PATH_MAX);
1517 if (strlen(argv[optind + 1]) >= PATH_MAX) {
1518 fprintf(stderr, "ERROR: path too long\n");
1522 strncpy(dir_name, argv[optind + 1], sizeof dir_name);
1523 dir_name[sizeof dir_name - 1] = 0;
1525 /* Strip the trailing / on the dir name */
1526 len = strlen(dir_name);
1527 while (len && dir_name[--len] == '/') {
1528 dir_name[len] = '\0';
1531 if (root_objectid != 0) {
1532 struct btrfs_root *orig_root = root;
1534 key.objectid = root_objectid;
1535 key.type = BTRFS_ROOT_ITEM_KEY;
1536 key.offset = (u64)-1;
1537 root = btrfs_read_fs_root(orig_root->fs_info, &key);
1539 fprintf(stderr, "fail to read root %llu: %s\n",
1540 root_objectid, strerror(-PTR_ERR(root)));
1550 ret = find_first_dir(root, &key.objectid);
1554 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
1558 ret = regcomp(&match_reg, match_regstr, match_cflags);
1560 regerror(ret, &match_reg, reg_err, sizeof(reg_err));
1561 fprintf(stderr, "Regex compile failed: %s\n", reg_err);
1568 printf("This is a dry-run, no files are going to be restored\n");
1570 ret = search_dir(root, &key, dir_name, "", mreg);