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 lzo1x_worst_compress(x) ((x) + ((x) / 16) + 64 + 3)
61 static int decompress_zlib(char *inbuf
, char *outbuf
, u64 compress_len
,
67 memset(&strm
, 0, sizeof(strm
));
68 ret
= inflateInit(&strm
);
70 error("zlib init returned %d", ret
);
74 strm
.avail_in
= compress_len
;
75 strm
.next_in
= (unsigned char *)inbuf
;
76 strm
.avail_out
= decompress_len
;
77 strm
.next_out
= (unsigned char *)outbuf
;
78 ret
= inflate(&strm
, Z_NO_FLUSH
);
79 if (ret
!= Z_STREAM_END
) {
80 (void)inflateEnd(&strm
);
81 error("zlib inflate failed: %d", ret
);
85 (void)inflateEnd(&strm
);
88 static inline size_t read_compress_length(unsigned char *buf
)
91 memcpy(&dlen
, buf
, LZO_LEN
);
92 return le32_to_cpu(dlen
);
95 static int decompress_lzo(struct btrfs_root
*root
, unsigned char *inbuf
,
96 char *outbuf
, u64 compress_len
, u64
*decompress_len
)
106 if (ret
!= LZO_E_OK
) {
107 error("lzo init returned %d", ret
);
111 tot_len
= read_compress_length(inbuf
);
115 while (tot_in
< tot_len
) {
118 in_len
= read_compress_length(inbuf
);
120 if ((tot_in
+ LZO_LEN
+ in_len
) > tot_len
) {
121 error("bad compress length %lu",
122 (unsigned long)in_len
);
128 new_len
= lzo1x_worst_compress(root
->sectorsize
);
129 ret
= lzo1x_decompress_safe((const unsigned char *)inbuf
, in_len
,
130 (unsigned char *)outbuf
,
131 (void *)&new_len
, NULL
);
132 if (ret
!= LZO_E_OK
) {
133 error("lzo decompress failed: %d", ret
);
142 * If the 4 byte header does not fit to the rest of the page we
143 * have to move to the next one, unless we read some garbage
145 mod_page
= tot_in
% root
->sectorsize
;
146 rem_page
= root
->sectorsize
- mod_page
;
147 if (rem_page
< LZO_LEN
) {
153 *decompress_len
= out_len
;
158 static int decompress(struct btrfs_root
*root
, char *inbuf
, char *outbuf
,
159 u64 compress_len
, u64
*decompress_len
, int compress
)
162 case BTRFS_COMPRESS_ZLIB
:
163 return decompress_zlib(inbuf
, outbuf
, compress_len
,
165 case BTRFS_COMPRESS_LZO
:
166 return decompress_lzo(root
, (unsigned char *)inbuf
, outbuf
,
167 compress_len
, decompress_len
);
172 error("invalid compression type: %d", compress
);
176 static int next_leaf(struct btrfs_root
*root
, struct btrfs_path
*path
)
181 struct extent_buffer
*c
;
182 struct extent_buffer
*next
= NULL
;
185 for (; level
< BTRFS_MAX_LEVEL
; level
++) {
186 if (path
->nodes
[level
])
190 if (level
>= BTRFS_MAX_LEVEL
)
193 slot
= path
->slots
[level
] + 1;
195 while(level
< BTRFS_MAX_LEVEL
) {
196 if (!path
->nodes
[level
])
199 slot
= path
->slots
[level
] + offset
;
200 c
= path
->nodes
[level
];
201 if (slot
>= btrfs_header_nritems(c
)) {
203 if (level
== BTRFS_MAX_LEVEL
)
210 reada_for_search(root
, path
, level
, slot
, 0);
212 next
= read_node_slot(root
, c
, slot
);
213 if (extent_buffer_uptodate(next
))
217 path
->slots
[level
] = slot
;
220 c
= path
->nodes
[level
];
221 free_extent_buffer(c
);
222 path
->nodes
[level
] = next
;
223 path
->slots
[level
] = 0;
227 reada_for_search(root
, path
, level
, 0, 0);
228 next
= read_node_slot(root
, next
, 0);
229 if (!extent_buffer_uptodate(next
))
235 static int copy_one_inline(struct btrfs_root
*root
, int fd
,
236 struct btrfs_path
*path
, u64 pos
)
238 struct extent_buffer
*leaf
= path
->nodes
[0];
239 struct btrfs_file_extent_item
*fi
;
250 fi
= btrfs_item_ptr(leaf
, path
->slots
[0],
251 struct btrfs_file_extent_item
);
252 ptr
= btrfs_file_extent_inline_start(fi
);
253 len
= btrfs_file_extent_inline_len(leaf
, path
->slots
[0], fi
);
254 inline_item_len
= btrfs_file_extent_inline_item_len(leaf
, btrfs_item_nr(path
->slots
[0]));
255 read_extent_buffer(leaf
, buf
, ptr
, inline_item_len
);
257 compress
= btrfs_file_extent_compression(leaf
, fi
);
258 if (compress
== BTRFS_COMPRESS_NONE
) {
259 done
= pwrite(fd
, buf
, len
, pos
);
261 fprintf(stderr
, "Short inline write, wanted %d, did "
262 "%zd: %d\n", len
, done
, errno
);
268 ram_size
= btrfs_file_extent_ram_bytes(leaf
, fi
);
269 outbuf
= calloc(1, ram_size
);
271 error("not enough memory");
275 ret
= decompress(root
, buf
, outbuf
, len
, &ram_size
, compress
);
281 done
= pwrite(fd
, outbuf
, ram_size
, pos
);
283 if (done
< ram_size
) {
284 fprintf(stderr
, "Short compressed inline write, wanted %Lu, "
285 "did %zd: %d\n", ram_size
, done
, errno
);
292 static int copy_one_extent(struct btrfs_root
*root
, int fd
,
293 struct extent_buffer
*leaf
,
294 struct btrfs_file_extent_item
*fi
, u64 pos
)
296 struct btrfs_multi_bio
*multi
= NULL
;
297 struct btrfs_device
*device
;
298 char *inbuf
, *outbuf
= NULL
;
299 ssize_t done
, total
= 0;
315 compress
= btrfs_file_extent_compression(leaf
, fi
);
316 bytenr
= btrfs_file_extent_disk_bytenr(leaf
, fi
);
317 disk_size
= btrfs_file_extent_disk_num_bytes(leaf
, fi
);
318 ram_size
= btrfs_file_extent_ram_bytes(leaf
, fi
);
319 offset
= btrfs_file_extent_offset(leaf
, fi
);
320 num_bytes
= btrfs_file_extent_num_bytes(leaf
, fi
);
321 size_left
= disk_size
;
322 if (compress
== BTRFS_COMPRESS_NONE
)
325 if (verbose
&& offset
)
326 printf("offset is %Lu\n", offset
);
327 /* we found a hole */
331 inbuf
= malloc(size_left
);
333 error("not enough memory\n");
337 if (compress
!= BTRFS_COMPRESS_NONE
) {
338 outbuf
= calloc(1, ram_size
);
340 error("not enough memory");
347 ret
= btrfs_map_block(&root
->fs_info
->mapping_tree
, READ
,
348 bytenr
, &length
, &multi
, mirror_num
, NULL
);
350 error("cannot map block logical %llu length %llu: %d",
351 (unsigned long long)bytenr
,
352 (unsigned long long)length
, ret
);
355 device
= multi
->stripes
[0].dev
;
358 dev_bytenr
= multi
->stripes
[0].physical
;
361 if (size_left
< length
)
364 done
= pread(dev_fd
, inbuf
+count
, length
, dev_bytenr
);
365 /* Need both checks, or we miss negative values due to u64 conversion */
366 if (done
< 0 || done
< length
) {
367 num_copies
= btrfs_num_copies(&root
->fs_info
->mapping_tree
,
370 /* mirror_num is 1-indexed, so num_copies is a valid mirror. */
371 if (mirror_num
> num_copies
) {
373 error("exhausted mirrors trying to read (%d > %d)",
374 mirror_num
, num_copies
);
377 fprintf(stderr
, "Trying another mirror\n");
388 if (compress
== BTRFS_COMPRESS_NONE
) {
389 while (total
< num_bytes
) {
390 done
= pwrite(fd
, inbuf
+total
, num_bytes
-total
,
394 error("cannot write data: %d %s", errno
, strerror(errno
));
403 ret
= decompress(root
, inbuf
, outbuf
, disk_size
, &ram_size
, compress
);
405 num_copies
= btrfs_num_copies(&root
->fs_info
->mapping_tree
,
408 if (mirror_num
>= num_copies
) {
412 fprintf(stderr
, "Trying another mirror\n");
416 while (total
< num_bytes
) {
417 done
= pwrite(fd
, outbuf
+ offset
+ total
,
438 static enum loop_response
ask_to_continue(const char *file
)
443 printf("We seem to be looping a lot on %s, do you want to keep going "
444 "on ? (y/N/a): ", file
);
446 ret
= fgets(buf
, 2, stdin
);
447 if (*ret
== '\n' || tolower(*ret
) == 'n')
449 if (tolower(*ret
) == 'a')
451 if (tolower(*ret
) != 'y') {
452 printf("Please enter one of 'y', 'n', or 'a': ");
456 return LOOP_CONTINUE
;
460 static int set_file_xattrs(struct btrfs_root
*root
, u64 inode
,
461 int fd
, const char *file_name
)
463 struct btrfs_key key
;
464 struct btrfs_path
*path
;
465 struct extent_buffer
*leaf
;
466 struct btrfs_dir_item
*di
;
475 key
.objectid
= inode
;
476 key
.type
= BTRFS_XATTR_ITEM_KEY
;
479 path
= btrfs_alloc_path();
483 ret
= btrfs_search_slot(NULL
, root
, &key
, path
, 0, 0);
487 leaf
= path
->nodes
[0];
489 if (path
->slots
[0] >= btrfs_header_nritems(leaf
)) {
491 ret
= next_leaf(root
, path
);
493 error("searching for extended attributes: %d\n",
497 /* No more leaves to search */
501 leaf
= path
->nodes
[0];
506 btrfs_item_key_to_cpu(leaf
, &key
, path
->slots
[0]);
507 if (key
.type
!= BTRFS_XATTR_ITEM_KEY
|| key
.objectid
!= inode
)
510 total_len
= btrfs_item_size_nr(leaf
, path
->slots
[0]);
511 di
= btrfs_item_ptr(leaf
, path
->slots
[0],
512 struct btrfs_dir_item
);
514 while (cur
< total_len
) {
515 len
= btrfs_dir_name_len(leaf
, di
);
516 if (len
> name_len
) {
518 name
= (char *) malloc(len
+ 1);
524 read_extent_buffer(leaf
, name
,
525 (unsigned long)(di
+ 1), len
);
529 len
= btrfs_dir_data_len(leaf
, di
);
530 if (len
> data_len
) {
532 data
= (char *) malloc(len
);
538 read_extent_buffer(leaf
, data
,
539 (unsigned long)(di
+ 1) + name_len
,
543 if (fsetxattr(fd
, name
, data
, data_len
, 0))
544 error("setting extended attribute %s on file %s: %s",
545 name
, file_name
, strerror(errno
));
547 len
= sizeof(*di
) + name_len
+ data_len
;
549 di
= (struct btrfs_dir_item
*)((char *)di
+ len
);
555 btrfs_free_path(path
);
562 static int copy_metadata(struct btrfs_root
*root
, int fd
,
563 struct btrfs_key
*key
)
565 struct btrfs_path
*path
;
566 struct btrfs_inode_item
*inode_item
;
569 path
= btrfs_alloc_path();
571 error("not enough memory");
575 ret
= btrfs_lookup_inode(NULL
, root
, path
, key
, 0);
577 struct btrfs_timespec
*bts
;
578 struct timespec times
[2];
580 inode_item
= btrfs_item_ptr(path
->nodes
[0], path
->slots
[0],
581 struct btrfs_inode_item
);
583 ret
= fchown(fd
, btrfs_inode_uid(path
->nodes
[0], inode_item
),
584 btrfs_inode_gid(path
->nodes
[0], inode_item
));
586 error("failed to change owner: %s", strerror(errno
));
590 ret
= fchmod(fd
, btrfs_inode_mode(path
->nodes
[0], inode_item
));
592 error("failed to change mode: %s", strerror(errno
));
596 bts
= btrfs_inode_atime(inode_item
);
597 times
[0].tv_sec
= btrfs_timespec_sec(path
->nodes
[0], bts
);
598 times
[0].tv_nsec
= btrfs_timespec_nsec(path
->nodes
[0], bts
);
600 bts
= btrfs_inode_mtime(inode_item
);
601 times
[1].tv_sec
= btrfs_timespec_sec(path
->nodes
[0], bts
);
602 times
[1].tv_nsec
= btrfs_timespec_nsec(path
->nodes
[0], bts
);
604 ret
= futimens(fd
, times
);
606 error("failed to set times: %s", strerror(errno
));
611 btrfs_free_path(path
);
615 static int copy_file(struct btrfs_root
*root
, int fd
, struct btrfs_key
*key
,
618 struct extent_buffer
*leaf
;
619 struct btrfs_path
*path
;
620 struct btrfs_file_extent_item
*fi
;
621 struct btrfs_inode_item
*inode_item
;
622 struct btrfs_timespec
*bts
;
623 struct btrfs_key found_key
;
629 struct timespec times
[2];
632 path
= btrfs_alloc_path();
634 error("not enough memory");
638 ret
= btrfs_lookup_inode(NULL
, root
, path
, key
, 0);
640 inode_item
= btrfs_item_ptr(path
->nodes
[0], path
->slots
[0],
641 struct btrfs_inode_item
);
642 found_size
= btrfs_inode_size(path
->nodes
[0], inode_item
);
644 if (restore_metadata
) {
646 * Change the ownership and mode now, set times when
647 * copyout is finished.
650 ret
= fchown(fd
, btrfs_inode_uid(path
->nodes
[0], inode_item
),
651 btrfs_inode_gid(path
->nodes
[0], inode_item
));
652 if (ret
&& !ignore_errors
)
655 ret
= fchmod(fd
, btrfs_inode_mode(path
->nodes
[0], inode_item
));
656 if (ret
&& !ignore_errors
)
659 bts
= btrfs_inode_atime(inode_item
);
660 times
[0].tv_sec
= btrfs_timespec_sec(path
->nodes
[0], bts
);
661 times
[0].tv_nsec
= btrfs_timespec_nsec(path
->nodes
[0], bts
);
663 bts
= btrfs_inode_mtime(inode_item
);
664 times
[1].tv_sec
= btrfs_timespec_sec(path
->nodes
[0], bts
);
665 times
[1].tv_nsec
= btrfs_timespec_nsec(path
->nodes
[0], bts
);
669 btrfs_release_path(path
);
672 key
->type
= BTRFS_EXTENT_DATA_KEY
;
674 ret
= btrfs_search_slot(NULL
, root
, key
, path
, 0, 0);
676 error("searching extent data returned %d", ret
);
680 leaf
= path
->nodes
[0];
682 ret
= next_leaf(root
, path
);
684 error("cannot get next leaf: %d", ret
);
686 } else if (ret
> 0) {
687 /* No more leaves to search */
691 leaf
= path
->nodes
[0];
695 if (loops
>= 0 && loops
++ >= 1024) {
696 enum loop_response resp
;
698 resp
= ask_to_continue(file
);
699 if (resp
== LOOP_STOP
)
701 else if (resp
== LOOP_CONTINUE
)
703 else if (resp
== LOOP_DONTASK
)
706 if (path
->slots
[0] >= btrfs_header_nritems(leaf
)) {
708 ret
= next_leaf(root
, path
);
710 fprintf(stderr
, "Error searching %d\n", ret
);
713 /* No more leaves to search */
714 btrfs_free_path(path
);
717 leaf
= path
->nodes
[0];
721 btrfs_item_key_to_cpu(leaf
, &found_key
, path
->slots
[0]);
722 if (found_key
.objectid
!= key
->objectid
)
724 if (found_key
.type
!= key
->type
)
726 fi
= btrfs_item_ptr(leaf
, path
->slots
[0],
727 struct btrfs_file_extent_item
);
728 extent_type
= btrfs_file_extent_type(leaf
, fi
);
729 compression
= btrfs_file_extent_compression(leaf
, fi
);
730 if (compression
>= BTRFS_COMPRESS_LAST
) {
731 warning("compression type %d not supported",
737 if (extent_type
== BTRFS_FILE_EXTENT_PREALLOC
)
739 if (extent_type
== BTRFS_FILE_EXTENT_INLINE
) {
740 ret
= copy_one_inline(root
, fd
, path
, found_key
.offset
);
743 } else if (extent_type
== BTRFS_FILE_EXTENT_REG
) {
744 ret
= copy_one_extent(root
, fd
, leaf
, fi
,
749 warning("weird extent type %d", extent_type
);
755 btrfs_free_path(path
);
758 ret
= ftruncate(fd
, (loff_t
)found_size
);
763 ret
= set_file_xattrs(root
, key
->objectid
, fd
, file
);
767 if (restore_metadata
&& times_ok
) {
768 ret
= futimens(fd
, times
);
775 btrfs_free_path(path
);
781 * 0 if the file exists and should be skipped.
782 * 1 if the file does NOT exist
783 * 2 if the file exists but is OK to overwrite
785 static int overwrite_ok(const char * path
)
791 /* don't be fooled by symlinks */
792 ret
= fstatat(-1, path_name
, &st
, AT_SYMLINK_NOFOLLOW
);
798 if (verbose
|| !warn
)
799 printf("Skipping existing file"
802 printf("If you wish to overwrite use -o\n");
809 static int copy_symlink(struct btrfs_root
*root
, struct btrfs_key
*key
,
812 struct btrfs_path
*path
;
813 struct extent_buffer
*leaf
;
814 struct btrfs_file_extent_item
*extent_item
;
815 struct btrfs_inode_item
*inode_item
;
819 struct btrfs_timespec
*bts
;
820 struct timespec times
[2];
822 ret
= overwrite_ok(path_name
);
824 return 0; /* skip this file */
826 /* symlink() can't overwrite, so unlink first */
828 ret
= unlink(path_name
);
830 fprintf(stderr
, "failed to unlink '%s' for overwrite\n",
836 key
->type
= BTRFS_EXTENT_DATA_KEY
;
839 path
= btrfs_alloc_path();
843 ret
= btrfs_search_slot(NULL
, root
, key
, path
, 0, 0);
847 leaf
= path
->nodes
[0];
849 fprintf(stderr
, "Error getting leaf for symlink '%s'\n", file
);
854 extent_item
= btrfs_item_ptr(leaf
, path
->slots
[0],
855 struct btrfs_file_extent_item
);
857 len
= btrfs_file_extent_inline_item_len(leaf
,
858 btrfs_item_nr(path
->slots
[0]));
859 if (len
>= PATH_MAX
) {
860 fprintf(stderr
, "Symlink '%s' target length %d is longer than PATH_MAX\n",
866 name_offset
= (unsigned long) extent_item
867 + offsetof(struct btrfs_file_extent_item
, disk_bytenr
);
868 read_extent_buffer(leaf
, symlink_target
, name_offset
, len
);
870 symlink_target
[len
] = 0;
873 ret
= symlink(symlink_target
, path_name
);
875 fprintf(stderr
, "Failed to restore symlink '%s': %s\n",
876 path_name
, strerror(errno
));
880 printf("SYMLINK: '%s' => '%s'\n", path_name
, symlink_target
);
883 if (!restore_metadata
)
887 * Symlink metadata operates differently than files/directories, so do
890 key
->type
= BTRFS_INODE_ITEM_KEY
;
893 btrfs_release_path(path
);
895 ret
= btrfs_lookup_inode(NULL
, root
, path
, key
, 0);
897 fprintf(stderr
, "Failed to lookup inode for '%s'\n", file
);
901 inode_item
= btrfs_item_ptr(path
->nodes
[0], path
->slots
[0],
902 struct btrfs_inode_item
);
904 ret
= fchownat(-1, file
, btrfs_inode_uid(path
->nodes
[0], inode_item
),
905 btrfs_inode_gid(path
->nodes
[0], inode_item
),
906 AT_SYMLINK_NOFOLLOW
);
908 fprintf(stderr
, "Failed to change owner: %s\n",
913 bts
= btrfs_inode_atime(inode_item
);
914 times
[0].tv_sec
= btrfs_timespec_sec(path
->nodes
[0], bts
);
915 times
[0].tv_nsec
= btrfs_timespec_nsec(path
->nodes
[0], bts
);
917 bts
= btrfs_inode_mtime(inode_item
);
918 times
[1].tv_sec
= btrfs_timespec_sec(path
->nodes
[0], bts
);
919 times
[1].tv_nsec
= btrfs_timespec_nsec(path
->nodes
[0], bts
);
921 ret
= utimensat(-1, file
, times
, AT_SYMLINK_NOFOLLOW
);
923 fprintf(stderr
, "Failed to set times: %s\n", strerror(errno
));
925 btrfs_free_path(path
);
929 static int search_dir(struct btrfs_root
*root
, struct btrfs_key
*key
,
930 const char *output_rootdir
, const char *in_dir
,
933 struct btrfs_path
*path
;
934 struct extent_buffer
*leaf
;
935 struct btrfs_dir_item
*dir_item
;
936 struct btrfs_key found_key
, location
;
937 char filename
[BTRFS_NAME_LEN
+ 1];
938 unsigned long name_ptr
;
945 path
= btrfs_alloc_path();
947 fprintf(stderr
, "Ran out of memory\n");
952 key
->type
= BTRFS_DIR_INDEX_KEY
;
954 ret
= btrfs_search_slot(NULL
, root
, key
, path
, 0, 0);
956 fprintf(stderr
, "Error searching %d\n", ret
);
962 leaf
= path
->nodes
[0];
965 printf("No leaf after search, looking for the next "
967 ret
= next_leaf(root
, path
);
969 fprintf(stderr
, "Error getting next leaf %d\n",
972 } else if (ret
> 0) {
973 /* No more leaves to search */
975 printf("Reached the end of the tree looking "
976 "for the directory\n");
980 leaf
= path
->nodes
[0];
984 if (loops
++ >= 1024) {
985 printf("We have looped trying to restore files in %s "
986 "too many times to be making progress, "
987 "stopping\n", in_dir
);
991 if (path
->slots
[0] >= btrfs_header_nritems(leaf
)) {
993 ret
= next_leaf(root
, path
);
995 fprintf(stderr
, "Error searching %d\n",
998 } else if (ret
> 0) {
999 /* No more leaves to search */
1001 printf("Reached the end of "
1002 "the tree searching the"
1007 leaf
= path
->nodes
[0];
1011 btrfs_item_key_to_cpu(leaf
, &found_key
, path
->slots
[0]);
1012 if (found_key
.objectid
!= key
->objectid
) {
1014 printf("Found objectid=%Lu, key=%Lu\n",
1015 found_key
.objectid
, key
->objectid
);
1018 if (found_key
.type
!= key
->type
) {
1020 printf("Found type=%u, want=%u\n",
1021 found_key
.type
, key
->type
);
1024 dir_item
= btrfs_item_ptr(leaf
, path
->slots
[0],
1025 struct btrfs_dir_item
);
1026 name_ptr
= (unsigned long)(dir_item
+ 1);
1027 name_len
= btrfs_dir_name_len(leaf
, dir_item
);
1028 read_extent_buffer(leaf
, filename
, name_ptr
, name_len
);
1029 filename
[name_len
] = '\0';
1030 type
= btrfs_dir_type(leaf
, dir_item
);
1031 btrfs_dir_item_key_to_cpu(leaf
, dir_item
, &location
);
1033 /* full path from root of btrfs being restored */
1034 snprintf(fs_name
, PATH_MAX
, "%s/%s", in_dir
, filename
);
1036 if (mreg
&& REG_NOMATCH
== regexec(mreg
, fs_name
, 0, NULL
, 0))
1039 /* full path from system root */
1040 snprintf(path_name
, PATH_MAX
, "%s%s", output_rootdir
, fs_name
);
1043 * Restore directories, files, symlinks and metadata.
1045 if (type
== BTRFS_FT_REG_FILE
) {
1046 if (!overwrite_ok(path_name
))
1050 printf("Restoring %s\n", path_name
);
1053 fd
= open(path_name
, O_CREAT
|O_WRONLY
, 0644);
1055 fprintf(stderr
, "Error creating %s: %d\n",
1063 ret
= copy_file(root
, fd
, &location
, path_name
);
1066 fprintf(stderr
, "Error copying data for %s\n",
1072 } else if (type
== BTRFS_FT_DIR
) {
1073 struct btrfs_root
*search_root
= root
;
1074 char *dir
= strdup(fs_name
);
1077 fprintf(stderr
, "Ran out of memory\n");
1082 if (location
.type
== BTRFS_ROOT_ITEM_KEY
) {
1084 * If we are a snapshot and this is the index
1085 * object to ourselves just skip it.
1087 if (location
.objectid
==
1088 root
->root_key
.objectid
) {
1093 location
.offset
= (u64
)-1;
1094 search_root
= btrfs_read_fs_root(root
->fs_info
,
1096 if (IS_ERR(search_root
)) {
1098 fprintf(stderr
, "Error reading "
1099 "subvolume %s: %lu\n",
1101 PTR_ERR(search_root
));
1104 ret
= PTR_ERR(search_root
);
1109 * A subvolume will have a key.offset of 0, a
1110 * snapshot will have key.offset of a transid.
1112 if (search_root
->root_key
.offset
!= 0 &&
1115 printf("Skipping snapshot %s\n",
1119 location
.objectid
= BTRFS_FIRST_FREE_OBJECTID
;
1123 printf("Restoring %s\n", path_name
);
1129 ret
= mkdir(path_name
, 0755);
1130 if (ret
&& errno
!= EEXIST
) {
1132 fprintf(stderr
, "Error mkdiring %s: %d\n",
1140 ret
= search_dir(search_root
, &location
,
1141 output_rootdir
, dir
, mreg
);
1144 fprintf(stderr
, "Error searching %s\n",
1150 } else if (type
== BTRFS_FT_SYMLINK
) {
1151 if (restore_symlinks
)
1152 ret
= copy_symlink(root
, &location
, path_name
);
1156 btrfs_free_path(path
);
1164 if (restore_metadata
) {
1165 snprintf(path_name
, PATH_MAX
, "%s%s", output_rootdir
, in_dir
);
1166 fd
= open(path_name
, O_RDONLY
);
1168 fprintf(stderr
, "ERROR: Failed to access %s to restore metadata\n",
1170 if (!ignore_errors
) {
1176 * Set owner/mode/time on the directory as well
1178 key
->type
= BTRFS_INODE_ITEM_KEY
;
1179 ret
= copy_metadata(root
, fd
, key
);
1181 if (ret
&& !ignore_errors
)
1187 printf("Done searching %s\n", in_dir
);
1189 btrfs_free_path(path
);
1193 static int do_list_roots(struct btrfs_root
*root
)
1195 struct btrfs_key key
;
1196 struct btrfs_key found_key
;
1197 struct btrfs_disk_key disk_key
;
1198 struct btrfs_path
*path
;
1199 struct extent_buffer
*leaf
;
1200 struct btrfs_root_item ri
;
1201 unsigned long offset
;
1205 root
= root
->fs_info
->tree_root
;
1206 path
= btrfs_alloc_path();
1208 fprintf(stderr
, "Failed to alloc path\n");
1214 key
.type
= BTRFS_ROOT_ITEM_KEY
;
1216 ret
= btrfs_search_slot(NULL
, root
, &key
, path
, 0, 0);
1218 fprintf(stderr
, "Failed to do search %d\n", ret
);
1219 btrfs_free_path(path
);
1223 leaf
= path
->nodes
[0];
1226 slot
= path
->slots
[0];
1227 if (slot
>= btrfs_header_nritems(leaf
)) {
1228 ret
= btrfs_next_leaf(root
, path
);
1231 leaf
= path
->nodes
[0];
1232 slot
= path
->slots
[0];
1234 btrfs_item_key(leaf
, &disk_key
, slot
);
1235 btrfs_disk_key_to_cpu(&found_key
, &disk_key
);
1236 if (btrfs_key_type(&found_key
) != BTRFS_ROOT_ITEM_KEY
) {
1241 offset
= btrfs_item_ptr_offset(leaf
, slot
);
1242 read_extent_buffer(leaf
, &ri
, offset
, sizeof(ri
));
1244 btrfs_print_key(&disk_key
);
1245 printf(" %Lu level %d\n", btrfs_root_bytenr(&ri
),
1246 btrfs_root_level(&ri
));
1249 btrfs_free_path(path
);
1254 static struct btrfs_root
*open_fs(const char *dev
, u64 root_location
,
1255 int super_mirror
, int list_roots
)
1257 struct btrfs_fs_info
*fs_info
= NULL
;
1258 struct btrfs_root
*root
= NULL
;
1262 for (i
= super_mirror
; i
< BTRFS_SUPER_MIRROR_MAX
; i
++) {
1263 bytenr
= btrfs_sb_offset(i
);
1264 fs_info
= open_ctree_fs_info(dev
, bytenr
, root_location
, 0,
1265 OPEN_CTREE_PARTIAL
);
1268 fprintf(stderr
, "Could not open root, trying backup super\n");
1275 * All we really need to succeed is reading the chunk tree, everything
1276 * else we can do by hand, since we only need to read the tree root and
1279 if (!extent_buffer_uptodate(fs_info
->tree_root
->node
)) {
1282 root
= fs_info
->tree_root
;
1284 root_location
= btrfs_super_root(fs_info
->super_copy
);
1285 generation
= btrfs_super_generation(fs_info
->super_copy
);
1286 root
->node
= read_tree_block(root
, root_location
,
1287 root
->nodesize
, generation
);
1288 if (!extent_buffer_uptodate(root
->node
)) {
1289 fprintf(stderr
, "Error opening tree root\n");
1295 if (!list_roots
&& !fs_info
->fs_root
) {
1296 struct btrfs_key key
;
1298 key
.objectid
= BTRFS_FS_TREE_OBJECTID
;
1299 key
.type
= BTRFS_ROOT_ITEM_KEY
;
1300 key
.offset
= (u64
)-1;
1301 fs_info
->fs_root
= btrfs_read_fs_root_no_cache(fs_info
, &key
);
1302 if (IS_ERR(fs_info
->fs_root
)) {
1303 fprintf(stderr
, "Couldn't read fs root: %ld\n",
1304 PTR_ERR(fs_info
->fs_root
));
1305 close_ctree(fs_info
->tree_root
);
1310 if (list_roots
&& do_list_roots(fs_info
->tree_root
)) {
1311 close_ctree(fs_info
->tree_root
);
1315 return fs_info
->fs_root
;
1318 static int find_first_dir(struct btrfs_root
*root
, u64
*objectid
)
1320 struct btrfs_path
*path
;
1321 struct btrfs_key found_key
;
1322 struct btrfs_key key
;
1327 key
.type
= BTRFS_DIR_INDEX_KEY
;
1330 path
= btrfs_alloc_path();
1332 fprintf(stderr
, "Ran out of memory\n");
1336 ret
= btrfs_search_slot(NULL
, root
, &key
, path
, 0, 0);
1338 fprintf(stderr
, "Error searching %d\n", ret
);
1342 if (!path
->nodes
[0]) {
1343 fprintf(stderr
, "No leaf!\n");
1347 for (i
= path
->slots
[0];
1348 i
< btrfs_header_nritems(path
->nodes
[0]); i
++) {
1349 btrfs_item_key_to_cpu(path
->nodes
[0], &found_key
, i
);
1350 if (found_key
.type
!= key
.type
)
1353 printf("Using objectid %Lu for first dir\n",
1354 found_key
.objectid
);
1355 *objectid
= found_key
.objectid
;
1360 ret
= next_leaf(root
, path
);
1362 fprintf(stderr
, "Error getting next leaf %d\n",
1365 } else if (ret
> 0) {
1366 fprintf(stderr
, "No more leaves\n");
1369 } while (!path
->nodes
[0]);
1372 printf("Couldn't find a dir index item\n");
1374 btrfs_free_path(path
);
1378 const char * const cmd_restore_usage
[] = {
1379 "btrfs restore [options] <device> <path> | -l <device>",
1380 "Try to restore files from a damaged filesystem (unmounted)",
1382 "-s|--snapshots get snapshots",
1383 "-x|--xattr get extended attributes",
1384 "-m|--metadata restore owner, mode and times",
1385 "-S|--symlinks restore symbolic links",
1386 "-v|--verbose verbose",
1387 "-i|--ignore-errors ignore errors",
1388 "-o|--overwrite overwrite",
1389 "-t <bytenr> tree location",
1390 "-f <bytenr> filesystem location",
1391 "-u|--super <mirror> super mirror",
1392 "-r|--root <rootid> root objectid",
1394 "-l|--list-roots list tree roots",
1395 "-D|--dry-run dry run (only list files that would be recovered)",
1396 "--path-regex <regex>",
1397 " restore only filenames matching regex,",
1398 " you have to use following syntax (possibly quoted):",
1399 " ^/(|home(|/username(|/Desktop(|/.*))))$",
1400 "-c ignore case (--path-regex only)",
1404 int cmd_restore(int argc
, char **argv
)
1406 struct btrfs_root
*root
;
1407 struct btrfs_key key
;
1408 char dir_name
[PATH_MAX
];
1409 u64 tree_location
= 0;
1410 u64 fs_location
= 0;
1411 u64 root_objectid
= 0;
1414 int super_mirror
= 0;
1417 const char *match_regstr
= NULL
;
1418 int match_cflags
= REG_EXTENDED
| REG_NOSUB
| REG_NEWLINE
;
1419 regex_t match_reg
, *mreg
= NULL
;
1424 static const struct option long_options
[] = {
1425 { "path-regex", required_argument
, NULL
, 256},
1426 { "dry-run", no_argument
, NULL
, 'D'},
1427 { "metadata", no_argument
, NULL
, 'm'},
1428 { "symlinks", no_argument
, NULL
, 'S'},
1429 { "snapshots", no_argument
, NULL
, 's'},
1430 { "xattr", no_argument
, NULL
, 'x'},
1431 { "verbose", no_argument
, NULL
, 'v'},
1432 { "ignore-errors", no_argument
, NULL
, 'i'},
1433 { "overwrite", no_argument
, NULL
, 'o'},
1434 { "super", required_argument
, NULL
, 'u'},
1435 { "root", required_argument
, NULL
, 'r'},
1436 { "list-roots", no_argument
, NULL
, 'l'},
1440 opt
= getopt_long(argc
, argv
, "sSxviot:u:dmf:r:lDc", long_options
,
1459 tree_location
= arg_strtou64(optarg
);
1462 fs_location
= arg_strtou64(optarg
);
1465 super_mirror
= arg_strtou64(optarg
);
1466 if (super_mirror
>= BTRFS_SUPER_MIRROR_MAX
) {
1467 fprintf(stderr
, "Super mirror not "
1476 root_objectid
= arg_strtou64(optarg
);
1477 if (!is_fstree(root_objectid
)) {
1478 fprintf(stderr
, "objectid %llu is not a valid fs/file tree\n",
1487 restore_metadata
= 1;
1490 restore_symlinks
= 1;
1496 match_cflags
|= REG_ICASE
;
1498 /* long option without single letter alternative */
1500 match_regstr
= optarg
;
1506 usage(cmd_restore_usage
);
1510 if (!list_roots
&& check_argc_min(argc
- optind
, 2))
1511 usage(cmd_restore_usage
);
1512 else if (list_roots
&& check_argc_min(argc
- optind
, 1))
1513 usage(cmd_restore_usage
);
1515 if (fs_location
&& root_objectid
) {
1516 fprintf(stderr
, "don't use -f and -r at the same time.\n");
1520 if ((ret
= check_mounted(argv
[optind
])) < 0) {
1521 fprintf(stderr
, "Could not check mount status: %s\n",
1525 fprintf(stderr
, "%s is currently mounted. Aborting.\n", argv
[optind
]);
1529 root
= open_fs(argv
[optind
], tree_location
, super_mirror
, list_roots
);
1536 if (fs_location
!= 0) {
1537 free_extent_buffer(root
->node
);
1538 root
->node
= read_tree_block(root
, fs_location
, root
->nodesize
, 0);
1539 if (!extent_buffer_uptodate(root
->node
)) {
1540 fprintf(stderr
, "Failed to read fs location\n");
1546 memset(path_name
, 0, PATH_MAX
);
1548 if (strlen(argv
[optind
+ 1]) >= PATH_MAX
) {
1549 fprintf(stderr
, "ERROR: path too long\n");
1553 strncpy(dir_name
, argv
[optind
+ 1], sizeof dir_name
);
1554 dir_name
[sizeof dir_name
- 1] = 0;
1556 /* Strip the trailing / on the dir name */
1557 len
= strlen(dir_name
);
1558 while (len
&& dir_name
[--len
] == '/') {
1559 dir_name
[len
] = '\0';
1562 if (root_objectid
!= 0) {
1563 struct btrfs_root
*orig_root
= root
;
1565 key
.objectid
= root_objectid
;
1566 key
.type
= BTRFS_ROOT_ITEM_KEY
;
1567 key
.offset
= (u64
)-1;
1568 root
= btrfs_read_fs_root(orig_root
->fs_info
, &key
);
1570 fprintf(stderr
, "fail to read root %llu: %s\n",
1571 root_objectid
, strerror(-PTR_ERR(root
)));
1581 ret
= find_first_dir(root
, &key
.objectid
);
1585 key
.objectid
= BTRFS_FIRST_FREE_OBJECTID
;
1589 ret
= regcomp(&match_reg
, match_regstr
, match_cflags
);
1591 regerror(ret
, &match_reg
, reg_err
, sizeof(reg_err
));
1592 fprintf(stderr
, "Regex compile failed: %s\n", reg_err
);
1599 printf("This is a dry-run, no files are going to be restored\n");
1601 ret
= search_dir(root
, &key
, dir_name
, "", mreg
);