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"
46 static char fs_name[PATH_MAX];
47 static char path_name[PATH_MAX];
48 static char symlink_target[PATH_MAX];
49 static int get_snaps = 0;
50 static int verbose = 0;
51 static int restore_metadata = 0;
52 static int restore_symlinks = 0;
53 static int ignore_errors = 0;
54 static int overwrite = 0;
55 static int get_xattrs = 0;
56 static int dry_run = 0;
59 #define PAGE_CACHE_SIZE 4096
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(unsigned char *inbuf, char *outbuf, u64 compress_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);
130 new_len = lzo1x_worst_compress(PAGE_CACHE_SIZE);
131 ret = lzo1x_decompress_safe((const unsigned char *)inbuf, in_len,
132 (unsigned char *)outbuf,
133 (void *)&new_len, NULL);
134 if (ret != LZO_E_OK) {
135 error("lzo decompress failed: %d", ret);
144 * If the 4 byte header does not fit to the rest of the page we
145 * have to move to the next one, unless we read some garbage
147 mod_page = tot_in % PAGE_CACHE_SIZE;
148 rem_page = PAGE_CACHE_SIZE - mod_page;
149 if (rem_page < LZO_LEN) {
155 *decompress_len = out_len;
160 static int decompress(char *inbuf, char *outbuf, u64 compress_len,
161 u64 *decompress_len, int compress)
164 case BTRFS_COMPRESS_ZLIB:
165 return decompress_zlib(inbuf, outbuf, compress_len,
167 case BTRFS_COMPRESS_LZO:
168 return decompress_lzo((unsigned char *)inbuf, outbuf, compress_len,
174 error("invalid compression type: %d", compress);
178 static int next_leaf(struct btrfs_root *root, struct btrfs_path *path)
183 struct extent_buffer *c;
184 struct extent_buffer *next = NULL;
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(root, 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(root, next, 0);
231 if (!extent_buffer_uptodate(next))
237 static int copy_one_inline(int fd, struct btrfs_path *path, u64 pos)
239 struct extent_buffer *leaf = path->nodes[0];
240 struct btrfs_file_extent_item *fi;
251 fi = btrfs_item_ptr(leaf, path->slots[0],
252 struct btrfs_file_extent_item);
253 ptr = btrfs_file_extent_inline_start(fi);
254 len = btrfs_file_extent_inline_len(leaf, path->slots[0], fi);
255 inline_item_len = btrfs_file_extent_inline_item_len(leaf, btrfs_item_nr(path->slots[0]));
256 read_extent_buffer(leaf, buf, ptr, inline_item_len);
258 compress = btrfs_file_extent_compression(leaf, fi);
259 if (compress == BTRFS_COMPRESS_NONE) {
260 done = pwrite(fd, buf, len, pos);
262 fprintf(stderr, "Short inline write, wanted %d, did "
263 "%zd: %d\n", len, done, errno);
269 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
270 outbuf = calloc(1, ram_size);
272 error("not enough memory");
276 ret = decompress(buf, outbuf, len, &ram_size, compress);
282 done = pwrite(fd, outbuf, ram_size, pos);
284 if (done < ram_size) {
285 fprintf(stderr, "Short compressed inline write, wanted %Lu, "
286 "did %zd: %d\n", ram_size, done, errno);
293 static int copy_one_extent(struct btrfs_root *root, int fd,
294 struct extent_buffer *leaf,
295 struct btrfs_file_extent_item *fi, u64 pos)
297 struct btrfs_multi_bio *multi = NULL;
298 struct btrfs_device *device;
299 char *inbuf, *outbuf = NULL;
300 ssize_t done, total = 0;
316 compress = btrfs_file_extent_compression(leaf, fi);
317 bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
318 disk_size = btrfs_file_extent_disk_num_bytes(leaf, fi);
319 ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
320 offset = btrfs_file_extent_offset(leaf, fi);
321 num_bytes = btrfs_file_extent_num_bytes(leaf, fi);
322 size_left = disk_size;
323 if (compress == BTRFS_COMPRESS_NONE)
326 if (verbose && offset)
327 printf("offset is %Lu\n", offset);
328 /* we found a hole */
332 inbuf = malloc(size_left);
334 error("not enough memory\n");
338 if (compress != BTRFS_COMPRESS_NONE) {
339 outbuf = calloc(1, ram_size);
341 error("not enough memory");
348 ret = btrfs_map_block(&root->fs_info->mapping_tree, READ,
349 bytenr, &length, &multi, mirror_num, NULL);
351 error("cannot map block logical %llu length %llu: %d",
352 (unsigned long long)bytenr,
353 (unsigned long long)length, ret);
356 device = multi->stripes[0].dev;
359 dev_bytenr = multi->stripes[0].physical;
362 if (size_left < length)
365 done = pread(dev_fd, inbuf+count, length, dev_bytenr);
366 /* Need both checks, or we miss negative values due to u64 conversion */
367 if (done < 0 || done < length) {
368 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
371 /* mirror_num is 1-indexed, so num_copies is a valid mirror. */
372 if (mirror_num > num_copies) {
374 error("exhausted mirrors trying to read (%d > %d)",
375 mirror_num, num_copies);
378 fprintf(stderr, "Trying another mirror\n");
389 if (compress == BTRFS_COMPRESS_NONE) {
390 while (total < num_bytes) {
391 done = pwrite(fd, inbuf+total, num_bytes-total,
395 error("cannot write data: %d %s", errno, strerror(errno));
404 ret = decompress(inbuf, outbuf, disk_size, &ram_size, compress);
406 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
409 if (mirror_num >= num_copies) {
413 fprintf(stderr, "Trying another mirror\n");
417 while (total < num_bytes) {
418 done = pwrite(fd, outbuf + offset + total,
439 static enum loop_response ask_to_continue(const char *file)
444 printf("We seem to be looping a lot on %s, do you want to keep going "
445 "on ? (y/N/a): ", file);
447 ret = fgets(buf, 2, stdin);
448 if (*ret == '\n' || tolower(*ret) == 'n')
450 if (tolower(*ret) == 'a')
452 if (tolower(*ret) != 'y') {
453 printf("Please enter one of 'y', 'n', or 'a': ");
457 return LOOP_CONTINUE;
461 static int set_file_xattrs(struct btrfs_root *root, u64 inode,
462 int fd, const char *file_name)
464 struct btrfs_key key;
465 struct btrfs_path *path;
466 struct extent_buffer *leaf;
467 struct btrfs_dir_item *di;
476 key.objectid = inode;
477 key.type = BTRFS_XATTR_ITEM_KEY;
480 path = btrfs_alloc_path();
484 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
488 leaf = path->nodes[0];
490 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
492 ret = next_leaf(root, path);
494 error("searching for extended attributes: %d\n",
498 /* No more leaves to search */
502 leaf = path->nodes[0];
507 btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
508 if (key.type != BTRFS_XATTR_ITEM_KEY || key.objectid != inode)
511 total_len = btrfs_item_size_nr(leaf, path->slots[0]);
512 di = btrfs_item_ptr(leaf, path->slots[0],
513 struct btrfs_dir_item);
515 while (cur < total_len) {
516 len = btrfs_dir_name_len(leaf, di);
517 if (len > name_len) {
519 name = (char *) malloc(len + 1);
525 read_extent_buffer(leaf, name,
526 (unsigned long)(di + 1), len);
530 len = btrfs_dir_data_len(leaf, di);
531 if (len > data_len) {
533 data = (char *) malloc(len);
539 read_extent_buffer(leaf, data,
540 (unsigned long)(di + 1) + name_len,
544 if (fsetxattr(fd, name, data, data_len, 0))
545 error("setting extended attribute %s on file %s: %s",
546 name, file_name, strerror(errno));
548 len = sizeof(*di) + name_len + data_len;
550 di = (struct btrfs_dir_item *)((char *)di + len);
556 btrfs_free_path(path);
563 static int copy_metadata(struct btrfs_root *root, int fd,
564 struct btrfs_key *key)
566 struct btrfs_path *path;
567 struct btrfs_inode_item *inode_item;
570 path = btrfs_alloc_path();
572 error("not enough memory");
576 ret = btrfs_lookup_inode(NULL, root, path, key, 0);
578 struct btrfs_timespec *bts;
579 struct timespec times[2];
581 inode_item = btrfs_item_ptr(path->nodes[0], path->slots[0],
582 struct btrfs_inode_item);
584 ret = fchown(fd, btrfs_inode_uid(path->nodes[0], inode_item),
585 btrfs_inode_gid(path->nodes[0], inode_item));
587 error("failed to change owner: %s", strerror(errno));
591 ret = fchmod(fd, btrfs_inode_mode(path->nodes[0], inode_item));
593 error("failed to change mode: %s", strerror(errno));
597 bts = btrfs_inode_atime(inode_item);
598 times[0].tv_sec = btrfs_timespec_sec(path->nodes[0], bts);
599 times[0].tv_nsec = btrfs_timespec_nsec(path->nodes[0], bts);
601 bts = btrfs_inode_mtime(inode_item);
602 times[1].tv_sec = btrfs_timespec_sec(path->nodes[0], bts);
603 times[1].tv_nsec = btrfs_timespec_nsec(path->nodes[0], bts);
605 ret = futimens(fd, times);
607 error("failed to set times: %s", strerror(errno));
612 btrfs_free_path(path);
616 static int copy_file(struct btrfs_root *root, int fd, struct btrfs_key *key,
619 struct extent_buffer *leaf;
620 struct btrfs_path *path;
621 struct btrfs_file_extent_item *fi;
622 struct btrfs_inode_item *inode_item;
623 struct btrfs_timespec *bts;
624 struct btrfs_key found_key;
630 struct timespec times[2];
633 path = btrfs_alloc_path();
635 error("not enough memory");
639 ret = btrfs_lookup_inode(NULL, root, path, key, 0);
641 inode_item = btrfs_item_ptr(path->nodes[0], path->slots[0],
642 struct btrfs_inode_item);
643 found_size = btrfs_inode_size(path->nodes[0], inode_item);
645 if (restore_metadata) {
647 * Change the ownership and mode now, set times when
648 * copyout is finished.
651 ret = fchown(fd, btrfs_inode_uid(path->nodes[0], inode_item),
652 btrfs_inode_gid(path->nodes[0], inode_item));
653 if (ret && !ignore_errors)
656 ret = fchmod(fd, btrfs_inode_mode(path->nodes[0], inode_item));
657 if (ret && !ignore_errors)
660 bts = btrfs_inode_atime(inode_item);
661 times[0].tv_sec = btrfs_timespec_sec(path->nodes[0], bts);
662 times[0].tv_nsec = btrfs_timespec_nsec(path->nodes[0], bts);
664 bts = btrfs_inode_mtime(inode_item);
665 times[1].tv_sec = btrfs_timespec_sec(path->nodes[0], bts);
666 times[1].tv_nsec = btrfs_timespec_nsec(path->nodes[0], bts);
670 btrfs_release_path(path);
673 key->type = BTRFS_EXTENT_DATA_KEY;
675 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
677 error("searching extent data returned %d", ret);
681 leaf = path->nodes[0];
683 ret = next_leaf(root, path);
685 error("cannot get next leaf: %d", ret);
687 } else if (ret > 0) {
688 /* No more leaves to search */
692 leaf = path->nodes[0];
696 if (loops >= 0 && loops++ >= 1024) {
697 enum loop_response resp;
699 resp = ask_to_continue(file);
700 if (resp == LOOP_STOP)
702 else if (resp == LOOP_CONTINUE)
704 else if (resp == LOOP_DONTASK)
707 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
709 ret = next_leaf(root, path);
711 fprintf(stderr, "Error searching %d\n", ret);
714 /* No more leaves to search */
715 btrfs_free_path(path);
718 leaf = path->nodes[0];
722 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
723 if (found_key.objectid != key->objectid)
725 if (found_key.type != key->type)
727 fi = btrfs_item_ptr(leaf, path->slots[0],
728 struct btrfs_file_extent_item);
729 extent_type = btrfs_file_extent_type(leaf, fi);
730 compression = btrfs_file_extent_compression(leaf, fi);
731 if (compression >= BTRFS_COMPRESS_LAST) {
732 warning("compression type %d not supported",
738 if (extent_type == BTRFS_FILE_EXTENT_PREALLOC)
740 if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
741 ret = copy_one_inline(fd, path, found_key.offset);
744 } else if (extent_type == BTRFS_FILE_EXTENT_REG) {
745 ret = copy_one_extent(root, fd, leaf, fi,
750 warning("weird extent type %d", extent_type);
756 btrfs_free_path(path);
759 ret = ftruncate(fd, (loff_t)found_size);
764 ret = set_file_xattrs(root, key->objectid, fd, file);
768 if (restore_metadata && times_ok) {
769 ret = futimens(fd, times);
776 btrfs_free_path(path);
782 * 0 if the file exists and should be skipped.
783 * 1 if the file does NOT exist
784 * 2 if the file exists but is OK to overwrite
786 static int overwrite_ok(const char * path)
792 /* don't be fooled by symlinks */
793 ret = fstatat(-1, path_name, &st, AT_SYMLINK_NOFOLLOW);
799 if (verbose || !warn)
800 printf("Skipping existing file"
803 printf("If you wish to overwrite use -o\n");
810 static int copy_symlink(struct btrfs_root *root, struct btrfs_key *key,
813 struct btrfs_path *path;
814 struct extent_buffer *leaf;
815 struct btrfs_file_extent_item *extent_item;
816 struct btrfs_inode_item *inode_item;
820 struct btrfs_timespec *bts;
821 struct timespec times[2];
823 ret = overwrite_ok(path_name);
825 return 0; /* skip this file */
827 /* symlink() can't overwrite, so unlink first */
829 ret = unlink(path_name);
831 fprintf(stderr, "failed to unlink '%s' for overwrite\n",
837 key->type = BTRFS_EXTENT_DATA_KEY;
840 path = btrfs_alloc_path();
844 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
848 leaf = path->nodes[0];
850 fprintf(stderr, "Error getting leaf for symlink '%s'\n", file);
855 extent_item = btrfs_item_ptr(leaf, path->slots[0],
856 struct btrfs_file_extent_item);
858 len = btrfs_file_extent_inline_item_len(leaf,
859 btrfs_item_nr(path->slots[0]));
860 if (len >= PATH_MAX) {
861 fprintf(stderr, "Symlink '%s' target length %d is longer than PATH_MAX\n",
867 name_offset = (unsigned long) extent_item
868 + offsetof(struct btrfs_file_extent_item, disk_bytenr);
869 read_extent_buffer(leaf, symlink_target, name_offset, len);
871 symlink_target[len] = 0;
874 ret = symlink(symlink_target, path_name);
876 fprintf(stderr, "Failed to restore symlink '%s': %s\n",
877 path_name, strerror(errno));
881 printf("SYMLINK: '%s' => '%s'\n", path_name, symlink_target);
884 if (!restore_metadata)
888 * Symlink metadata operates differently than files/directories, so do
891 key->type = BTRFS_INODE_ITEM_KEY;
894 btrfs_release_path(path);
896 ret = btrfs_lookup_inode(NULL, root, path, key, 0);
898 fprintf(stderr, "Failed to lookup inode for '%s'\n", file);
902 inode_item = btrfs_item_ptr(path->nodes[0], path->slots[0],
903 struct btrfs_inode_item);
905 ret = fchownat(-1, file, btrfs_inode_uid(path->nodes[0], inode_item),
906 btrfs_inode_gid(path->nodes[0], inode_item),
907 AT_SYMLINK_NOFOLLOW);
909 fprintf(stderr, "Failed to change owner: %s\n",
914 bts = btrfs_inode_atime(inode_item);
915 times[0].tv_sec = btrfs_timespec_sec(path->nodes[0], bts);
916 times[0].tv_nsec = btrfs_timespec_nsec(path->nodes[0], bts);
918 bts = btrfs_inode_mtime(inode_item);
919 times[1].tv_sec = btrfs_timespec_sec(path->nodes[0], bts);
920 times[1].tv_nsec = btrfs_timespec_nsec(path->nodes[0], bts);
922 ret = utimensat(-1, file, times, AT_SYMLINK_NOFOLLOW);
924 fprintf(stderr, "Failed to set times: %s\n", strerror(errno));
926 btrfs_free_path(path);
930 static int search_dir(struct btrfs_root *root, struct btrfs_key *key,
931 const char *output_rootdir, const char *in_dir,
934 struct btrfs_path *path;
935 struct extent_buffer *leaf;
936 struct btrfs_dir_item *dir_item;
937 struct btrfs_key found_key, location;
938 char filename[BTRFS_NAME_LEN + 1];
939 unsigned long name_ptr;
946 path = btrfs_alloc_path();
948 fprintf(stderr, "Ran out of memory\n");
953 key->type = BTRFS_DIR_INDEX_KEY;
955 ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
957 fprintf(stderr, "Error searching %d\n", ret);
963 leaf = path->nodes[0];
966 printf("No leaf after search, looking for the next "
968 ret = next_leaf(root, path);
970 fprintf(stderr, "Error getting next leaf %d\n",
973 } else if (ret > 0) {
974 /* No more leaves to search */
976 printf("Reached the end of the tree looking "
977 "for the directory\n");
981 leaf = path->nodes[0];
985 if (loops++ >= 1024) {
986 printf("We have looped trying to restore files in %s "
987 "too many times to be making progress, "
988 "stopping\n", in_dir);
992 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
994 ret = next_leaf(root, path);
996 fprintf(stderr, "Error searching %d\n",
999 } else if (ret > 0) {
1000 /* No more leaves to search */
1002 printf("Reached the end of "
1003 "the tree searching the"
1008 leaf = path->nodes[0];
1012 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
1013 if (found_key.objectid != key->objectid) {
1015 printf("Found objectid=%Lu, key=%Lu\n",
1016 found_key.objectid, key->objectid);
1019 if (found_key.type != key->type) {
1021 printf("Found type=%u, want=%u\n",
1022 found_key.type, key->type);
1025 dir_item = btrfs_item_ptr(leaf, path->slots[0],
1026 struct btrfs_dir_item);
1027 name_ptr = (unsigned long)(dir_item + 1);
1028 name_len = btrfs_dir_name_len(leaf, dir_item);
1029 read_extent_buffer(leaf, filename, name_ptr, name_len);
1030 filename[name_len] = '\0';
1031 type = btrfs_dir_type(leaf, dir_item);
1032 btrfs_dir_item_key_to_cpu(leaf, dir_item, &location);
1034 /* full path from root of btrfs being restored */
1035 snprintf(fs_name, PATH_MAX, "%s/%s", in_dir, filename);
1037 if (mreg && REG_NOMATCH == regexec(mreg, fs_name, 0, NULL, 0))
1040 /* full path from system root */
1041 snprintf(path_name, PATH_MAX, "%s%s", output_rootdir, fs_name);
1044 * Restore directories, files, symlinks and metadata.
1046 if (type == BTRFS_FT_REG_FILE) {
1047 if (!overwrite_ok(path_name))
1051 printf("Restoring %s\n", path_name);
1054 fd = open(path_name, O_CREAT|O_WRONLY, 0644);
1056 fprintf(stderr, "Error creating %s: %d\n",
1064 ret = copy_file(root, fd, &location, path_name);
1067 fprintf(stderr, "Error copying data for %s\n",
1073 } else if (type == BTRFS_FT_DIR) {
1074 struct btrfs_root *search_root = root;
1075 char *dir = strdup(fs_name);
1078 fprintf(stderr, "Ran out of memory\n");
1083 if (location.type == BTRFS_ROOT_ITEM_KEY) {
1085 * If we are a snapshot and this is the index
1086 * object to ourselves just skip it.
1088 if (location.objectid ==
1089 root->root_key.objectid) {
1094 location.offset = (u64)-1;
1095 search_root = btrfs_read_fs_root(root->fs_info,
1097 if (IS_ERR(search_root)) {
1099 fprintf(stderr, "Error reading "
1100 "subvolume %s: %lu\n",
1102 PTR_ERR(search_root));
1105 ret = PTR_ERR(search_root);
1110 * A subvolume will have a key.offset of 0, a
1111 * snapshot will have key.offset of a transid.
1113 if (search_root->root_key.offset != 0 &&
1116 printf("Skipping snapshot %s\n",
1120 location.objectid = BTRFS_FIRST_FREE_OBJECTID;
1124 printf("Restoring %s\n", path_name);
1130 ret = mkdir(path_name, 0755);
1131 if (ret && errno != EEXIST) {
1133 fprintf(stderr, "Error mkdiring %s: %d\n",
1141 ret = search_dir(search_root, &location,
1142 output_rootdir, dir, mreg);
1145 fprintf(stderr, "Error searching %s\n",
1151 } else if (type == BTRFS_FT_SYMLINK) {
1152 if (restore_symlinks)
1153 ret = copy_symlink(root, &location, path_name);
1157 btrfs_free_path(path);
1165 if (restore_metadata) {
1166 snprintf(path_name, PATH_MAX, "%s%s", output_rootdir, in_dir);
1167 fd = open(path_name, O_RDONLY);
1169 fprintf(stderr, "ERROR: Failed to access %s to restore metadata\n",
1171 if (!ignore_errors) {
1177 * Set owner/mode/time on the directory as well
1179 key->type = BTRFS_INODE_ITEM_KEY;
1180 ret = copy_metadata(root, fd, key);
1182 if (ret && !ignore_errors)
1188 printf("Done searching %s\n", in_dir);
1190 btrfs_free_path(path);
1194 static int do_list_roots(struct btrfs_root *root)
1196 struct btrfs_key key;
1197 struct btrfs_key found_key;
1198 struct btrfs_disk_key disk_key;
1199 struct btrfs_path *path;
1200 struct extent_buffer *leaf;
1201 struct btrfs_root_item ri;
1202 unsigned long offset;
1206 root = root->fs_info->tree_root;
1207 path = btrfs_alloc_path();
1209 fprintf(stderr, "Failed to alloc path\n");
1215 key.type = BTRFS_ROOT_ITEM_KEY;
1217 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
1219 fprintf(stderr, "Failed to do search %d\n", ret);
1220 btrfs_free_path(path);
1224 leaf = path->nodes[0];
1227 slot = path->slots[0];
1228 if (slot >= btrfs_header_nritems(leaf)) {
1229 ret = btrfs_next_leaf(root, path);
1232 leaf = path->nodes[0];
1233 slot = path->slots[0];
1235 btrfs_item_key(leaf, &disk_key, slot);
1236 btrfs_disk_key_to_cpu(&found_key, &disk_key);
1237 if (btrfs_key_type(&found_key) != BTRFS_ROOT_ITEM_KEY) {
1242 offset = btrfs_item_ptr_offset(leaf, slot);
1243 read_extent_buffer(leaf, &ri, offset, sizeof(ri));
1245 btrfs_print_key(&disk_key);
1246 printf(" %Lu level %d\n", btrfs_root_bytenr(&ri),
1247 btrfs_root_level(&ri));
1250 btrfs_free_path(path);
1255 static struct btrfs_root *open_fs(const char *dev, u64 root_location,
1256 int super_mirror, int list_roots)
1258 struct btrfs_fs_info *fs_info = NULL;
1259 struct btrfs_root *root = NULL;
1263 for (i = super_mirror; i < BTRFS_SUPER_MIRROR_MAX; i++) {
1264 bytenr = btrfs_sb_offset(i);
1265 fs_info = open_ctree_fs_info(dev, bytenr, root_location,
1266 OPEN_CTREE_PARTIAL);
1269 fprintf(stderr, "Could not open root, trying backup super\n");
1276 * All we really need to succeed is reading the chunk tree, everything
1277 * else we can do by hand, since we only need to read the tree root and
1280 if (!extent_buffer_uptodate(fs_info->tree_root->node)) {
1283 root = fs_info->tree_root;
1285 root_location = btrfs_super_root(fs_info->super_copy);
1286 generation = btrfs_super_generation(fs_info->super_copy);
1287 root->node = read_tree_block(root, root_location,
1288 root->leafsize, generation);
1289 if (!extent_buffer_uptodate(root->node)) {
1290 fprintf(stderr, "Error opening tree root\n");
1296 if (!list_roots && !fs_info->fs_root) {
1297 struct btrfs_key key;
1299 key.objectid = BTRFS_FS_TREE_OBJECTID;
1300 key.type = BTRFS_ROOT_ITEM_KEY;
1301 key.offset = (u64)-1;
1302 fs_info->fs_root = btrfs_read_fs_root_no_cache(fs_info, &key);
1303 if (IS_ERR(fs_info->fs_root)) {
1304 fprintf(stderr, "Couldn't read fs root: %ld\n",
1305 PTR_ERR(fs_info->fs_root));
1306 close_ctree(fs_info->tree_root);
1311 if (list_roots && do_list_roots(fs_info->tree_root)) {
1312 close_ctree(fs_info->tree_root);
1316 return fs_info->fs_root;
1319 static int find_first_dir(struct btrfs_root *root, u64 *objectid)
1321 struct btrfs_path *path;
1322 struct btrfs_key found_key;
1323 struct btrfs_key key;
1328 key.type = BTRFS_DIR_INDEX_KEY;
1331 path = btrfs_alloc_path();
1333 fprintf(stderr, "Ran out of memory\n");
1337 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
1339 fprintf(stderr, "Error searching %d\n", ret);
1343 if (!path->nodes[0]) {
1344 fprintf(stderr, "No leaf!\n");
1348 for (i = path->slots[0];
1349 i < btrfs_header_nritems(path->nodes[0]); i++) {
1350 btrfs_item_key_to_cpu(path->nodes[0], &found_key, i);
1351 if (found_key.type != key.type)
1354 printf("Using objectid %Lu for first dir\n",
1355 found_key.objectid);
1356 *objectid = found_key.objectid;
1361 ret = next_leaf(root, path);
1363 fprintf(stderr, "Error getting next leaf %d\n",
1366 } else if (ret > 0) {
1367 fprintf(stderr, "No more leaves\n");
1370 } while (!path->nodes[0]);
1373 printf("Couldn't find a dir index item\n");
1375 btrfs_free_path(path);
1379 const char * const cmd_restore_usage[] = {
1380 "btrfs restore [options] <device> <path> | -l <device>",
1381 "Try to restore files from a damaged filesystem (unmounted)",
1383 "-s|--snapshots get snapshots",
1384 "-x|--xattr get extended attributes",
1385 "-m|--metadata restore owner, mode and times",
1386 "-S|--symlinks restore symbolic links",
1387 "-v|--verbose verbose",
1388 "-i|--ignore-errors ignore errors",
1389 "-o|--overwrite overwrite",
1390 "-t <bytenr> tree location",
1391 "-f <bytenr> filesystem location",
1392 "-u|--super <mirror> super mirror",
1393 "-r|--root <rootid> root objectid",
1395 "-l|--list-roots list tree roots",
1396 "-D|--dry-run dry run (only list files that would be recovered)",
1397 "--path-regex <regex>",
1398 " restore only filenames matching regex,",
1399 " you have to use following syntax (possibly quoted):",
1400 " ^/(|home(|/username(|/Desktop(|/.*))))$",
1401 "-c ignore case (--path-regex only)",
1405 int cmd_restore(int argc, char **argv)
1407 struct btrfs_root *root;
1408 struct btrfs_key key;
1409 char dir_name[PATH_MAX];
1410 u64 tree_location = 0;
1411 u64 fs_location = 0;
1412 u64 root_objectid = 0;
1415 int super_mirror = 0;
1418 const char *match_regstr = NULL;
1419 int match_cflags = REG_EXTENDED | REG_NOSUB | REG_NEWLINE;
1420 regex_t match_reg, *mreg = NULL;
1425 static const struct option long_options[] = {
1426 { "path-regex", required_argument, NULL, 256},
1427 { "dry-run", no_argument, NULL, 'D'},
1428 { "metadata", no_argument, NULL, 'm'},
1429 { "symlinks", no_argument, NULL, 'S'},
1430 { "snapshots", no_argument, NULL, 's'},
1431 { "xattr", no_argument, NULL, 'x'},
1432 { "verbose", no_argument, NULL, 'v'},
1433 { "ignore-errors", no_argument, NULL, 'i'},
1434 { "overwrite", no_argument, NULL, 'o'},
1435 { "super", required_argument, NULL, 'u'},
1436 { "root", required_argument, NULL, 'r'},
1437 { "list-roots", no_argument, NULL, 'l'},
1441 opt = getopt_long(argc, argv, "sSxviot:u:dmf:r:lDc", long_options,
1460 tree_location = arg_strtou64(optarg);
1463 fs_location = arg_strtou64(optarg);
1466 super_mirror = arg_strtou64(optarg);
1467 if (super_mirror >= BTRFS_SUPER_MIRROR_MAX) {
1468 fprintf(stderr, "Super mirror not "
1477 root_objectid = arg_strtou64(optarg);
1478 if (!is_fstree(root_objectid)) {
1479 fprintf(stderr, "objectid %llu is not a valid fs/file tree\n",
1488 restore_metadata = 1;
1491 restore_symlinks = 1;
1497 match_cflags |= REG_ICASE;
1499 /* long option without single letter alternative */
1501 match_regstr = optarg;
1507 usage(cmd_restore_usage);
1511 if (!list_roots && check_argc_min(argc - optind, 2))
1512 usage(cmd_restore_usage);
1513 else if (list_roots && check_argc_min(argc - optind, 1))
1514 usage(cmd_restore_usage);
1516 if (fs_location && root_objectid) {
1517 fprintf(stderr, "don't use -f and -r at the same time.\n");
1521 if ((ret = check_mounted(argv[optind])) < 0) {
1522 fprintf(stderr, "Could not check mount status: %s\n",
1526 fprintf(stderr, "%s is currently mounted. Aborting.\n", argv[optind]);
1530 root = open_fs(argv[optind], tree_location, super_mirror, list_roots);
1537 if (fs_location != 0) {
1538 free_extent_buffer(root->node);
1539 root->node = read_tree_block(root, fs_location, root->leafsize, 0);
1540 if (!extent_buffer_uptodate(root->node)) {
1541 fprintf(stderr, "Failed to read fs location\n");
1547 memset(path_name, 0, PATH_MAX);
1549 if (strlen(argv[optind + 1]) >= PATH_MAX) {
1550 fprintf(stderr, "ERROR: path too long\n");
1554 strncpy(dir_name, argv[optind + 1], sizeof dir_name);
1555 dir_name[sizeof dir_name - 1] = 0;
1557 /* Strip the trailing / on the dir name */
1558 len = strlen(dir_name);
1559 while (len && dir_name[--len] == '/') {
1560 dir_name[len] = '\0';
1563 if (root_objectid != 0) {
1564 struct btrfs_root *orig_root = root;
1566 key.objectid = root_objectid;
1567 key.type = BTRFS_ROOT_ITEM_KEY;
1568 key.offset = (u64)-1;
1569 root = btrfs_read_fs_root(orig_root->fs_info, &key);
1571 fprintf(stderr, "fail to read root %llu: %s\n",
1572 root_objectid, strerror(-PTR_ERR(root)));
1582 ret = find_first_dir(root, &key.objectid);
1586 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
1590 ret = regcomp(&match_reg, match_regstr, match_cflags);
1592 regerror(ret, &match_reg, reg_err, sizeof(reg_err));
1593 fprintf(stderr, "Regex compile failed: %s\n", reg_err);
1600 printf("This is a dry-run, no files are going to be restored\n");
1602 ret = search_dir(root, &key, dir_name, "", mreg);