btrfs-progs: init uninitialized output buf for btrfs-restore
[platform/upstream/btrfs-progs.git] / cmds-restore.c
1 /*
2  * Copyright (C) 2011 Red Hat.  All rights reserved.
3  *
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.
7  *
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.
12  *
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.
17  */
18
19 #define _XOPEN_SOURCE 500
20 #define _GNU_SOURCE 1
21
22 #include "kerncompat.h"
23
24 #include <ctype.h>
25 #include <stdio.h>
26 #include <stdlib.h>
27 #include <unistd.h>
28 #include <fcntl.h>
29 #include <sys/stat.h>
30 #include <sys/types.h>
31 #include <lzo/lzoconf.h>
32 #include <lzo/lzo1x.h>
33 #include <zlib.h>
34 #include <regex.h>
35 #include <getopt.h>
36 #include <sys/types.h>
37 #include <sys/xattr.h>
38
39 #include "ctree.h"
40 #include "disk-io.h"
41 #include "print-tree.h"
42 #include "transaction.h"
43 #include "list.h"
44 #include "version.h"
45 #include "volumes.h"
46 #include "utils.h"
47 #include "commands.h"
48
49 static char fs_name[4096];
50 static char path_name[4096];
51 static int get_snaps = 0;
52 static int verbose = 0;
53 static int ignore_errors = 0;
54 static int overwrite = 0;
55 static int get_xattrs = 0;
56 static int dry_run = 0;
57
58 #define LZO_LEN 4
59 #define PAGE_CACHE_SIZE 4096
60 #define lzo1x_worst_compress(x) ((x) + ((x) / 16) + 64 + 3)
61
62 static int decompress_zlib(char *inbuf, char *outbuf, u64 compress_len,
63                            u64 decompress_len)
64 {
65         z_stream strm;
66         int ret;
67
68         memset(&strm, 0, sizeof(strm));
69         ret = inflateInit(&strm);
70         if (ret != Z_OK) {
71                 fprintf(stderr, "inflate init returnd %d\n", ret);
72                 return -1;
73         }
74
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                 fprintf(stderr, "failed to inflate: %d\n", ret);
83                 return -1;
84         }
85
86         (void)inflateEnd(&strm);
87         return 0;
88 }
89 static inline size_t read_compress_length(unsigned char *buf)
90 {
91         __le32 dlen;
92         memcpy(&dlen, buf, LZO_LEN);
93         return le32_to_cpu(dlen);
94 }
95
96 static int decompress_lzo(unsigned char *inbuf, char *outbuf, u64 compress_len,
97                           u64 *decompress_len)
98 {
99         size_t new_len;
100         size_t in_len;
101         size_t out_len = 0;
102         size_t tot_len;
103         size_t tot_in;
104         int ret;
105
106         ret = lzo_init();
107         if (ret != LZO_E_OK) {
108                 fprintf(stderr, "lzo init returned %d\n", ret);
109                 return -1;
110         }
111
112         tot_len = read_compress_length(inbuf);
113         inbuf += LZO_LEN;
114         tot_in = LZO_LEN;
115
116         while (tot_in < tot_len) {
117                 in_len = read_compress_length(inbuf);
118
119                 if ((tot_in + LZO_LEN + in_len) > tot_len) {
120                         fprintf(stderr, "bad compress length %lu\n",
121                                 (unsigned long)in_len);
122                         return -1;
123                 }
124
125                 inbuf += LZO_LEN;
126                 tot_in += LZO_LEN;
127
128                 new_len = lzo1x_worst_compress(PAGE_CACHE_SIZE);
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                         fprintf(stderr, "failed to inflate: %d\n", ret);
134                         return -1;
135                 }
136                 out_len += new_len;
137                 outbuf += new_len;
138                 inbuf += in_len;
139                 tot_in += in_len;
140         }
141
142         *decompress_len = out_len;
143
144         return 0;
145 }
146
147 static int decompress(char *inbuf, char *outbuf, u64 compress_len,
148                       u64 *decompress_len, int compress)
149 {
150         switch (compress) {
151         case BTRFS_COMPRESS_ZLIB:
152                 return decompress_zlib(inbuf, outbuf, compress_len,
153                                        *decompress_len);
154         case BTRFS_COMPRESS_LZO:
155                 return decompress_lzo((unsigned char *)inbuf, outbuf, compress_len,
156                                       decompress_len);
157         default:
158                 break;
159         }
160
161         fprintf(stderr, "invalid compression type: %d\n", compress);
162         return -1;
163 }
164
165 static int next_leaf(struct btrfs_root *root, struct btrfs_path *path)
166 {
167         int slot;
168         int level = 1;
169         int offset = 1;
170         struct extent_buffer *c;
171         struct extent_buffer *next = NULL;
172
173 again:
174         for (; level < BTRFS_MAX_LEVEL; level++) {
175                 if (path->nodes[level])
176                         break;
177         }
178
179         if (level == BTRFS_MAX_LEVEL)
180                 return 1;
181
182         slot = path->slots[level] + 1;
183
184         while(level < BTRFS_MAX_LEVEL) {
185                 if (!path->nodes[level])
186                         return 1;
187
188                 slot = path->slots[level] + offset;
189                 c = path->nodes[level];
190                 if (slot >= btrfs_header_nritems(c)) {
191                         level++;
192                         if (level == BTRFS_MAX_LEVEL)
193                                 return 1;
194                         continue;
195                 }
196
197                 if (path->reada)
198                         reada_for_search(root, path, level, slot, 0);
199
200                 next = read_node_slot(root, c, slot);
201                 if (next)
202                         break;
203                 offset++;
204         }
205         path->slots[level] = slot;
206         while(1) {
207                 level--;
208                 c = path->nodes[level];
209                 free_extent_buffer(c);
210                 path->nodes[level] = next;
211                 path->slots[level] = 0;
212                 if (!level)
213                         break;
214                 if (path->reada)
215                         reada_for_search(root, path, level, 0, 0);
216                 next = read_node_slot(root, next, 0);
217                 if (!next)
218                         goto again;
219         }
220         return 0;
221 }
222
223 static int copy_one_inline(int fd, struct btrfs_path *path, u64 pos)
224 {
225         struct extent_buffer *leaf = path->nodes[0];
226         struct btrfs_file_extent_item *fi;
227         char buf[4096];
228         char *outbuf;
229         u64 ram_size;
230         ssize_t done;
231         unsigned long ptr;
232         int ret;
233         int len;
234         int compress;
235
236         fi = btrfs_item_ptr(leaf, path->slots[0],
237                             struct btrfs_file_extent_item);
238         ptr = btrfs_file_extent_inline_start(fi);
239         len = btrfs_file_extent_inline_len(leaf, path->slots[0], fi);
240         read_extent_buffer(leaf, buf, ptr, len);
241
242         compress = btrfs_file_extent_compression(leaf, fi);
243         if (compress == BTRFS_COMPRESS_NONE) {
244                 done = pwrite(fd, buf, len, pos);
245                 if (done < len) {
246                         fprintf(stderr, "Short inline write, wanted %d, did "
247                                 "%zd: %d\n", len, done, errno);
248                         return -1;
249                 }
250                 return 0;
251         }
252
253         ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
254         outbuf = calloc(1, ram_size);
255         if (!outbuf) {
256                 fprintf(stderr, "No memory\n");
257                 return -ENOMEM;
258         }
259
260         ret = decompress(buf, outbuf, len, &ram_size, compress);
261         if (ret) {
262                 free(outbuf);
263                 return ret;
264         }
265
266         done = pwrite(fd, outbuf, ram_size, pos);
267         free(outbuf);
268         if (done < ram_size) {
269                 fprintf(stderr, "Short compressed inline write, wanted %Lu, "
270                         "did %zd: %d\n", ram_size, done, errno);
271                 return -1;
272         }
273
274         return 0;
275 }
276
277 static int copy_one_extent(struct btrfs_root *root, int fd,
278                            struct extent_buffer *leaf,
279                            struct btrfs_file_extent_item *fi, u64 pos)
280 {
281         struct btrfs_multi_bio *multi = NULL;
282         struct btrfs_device *device;
283         char *inbuf, *outbuf = NULL;
284         ssize_t done, total = 0;
285         u64 bytenr;
286         u64 ram_size;
287         u64 disk_size;
288         u64 num_bytes;
289         u64 length;
290         u64 size_left;
291         u64 dev_bytenr;
292         u64 offset;
293         u64 count = 0;
294         int compress;
295         int ret;
296         int dev_fd;
297         int mirror_num = 1;
298         int num_copies;
299
300         compress = btrfs_file_extent_compression(leaf, fi);
301         bytenr = btrfs_file_extent_disk_bytenr(leaf, fi);
302         disk_size = btrfs_file_extent_disk_num_bytes(leaf, fi);
303         ram_size = btrfs_file_extent_ram_bytes(leaf, fi);
304         offset = btrfs_file_extent_offset(leaf, fi);
305         num_bytes = btrfs_file_extent_num_bytes(leaf, fi);
306         size_left = disk_size;
307         if (compress == BTRFS_COMPRESS_NONE)
308                 bytenr += offset;
309
310         if (verbose && offset)
311                 printf("offset is %Lu\n", offset);
312         /* we found a hole */
313         if (disk_size == 0)
314                 return 0;
315
316         inbuf = malloc(size_left);
317         if (!inbuf) {
318                 fprintf(stderr, "No memory\n");
319                 return -ENOMEM;
320         }
321
322         if (compress != BTRFS_COMPRESS_NONE) {
323                 outbuf = calloc(1, ram_size);
324                 if (!outbuf) {
325                         fprintf(stderr, "No memory\n");
326                         free(inbuf);
327                         return -ENOMEM;
328                 }
329         }
330 again:
331         length = size_left;
332         ret = btrfs_map_block(&root->fs_info->mapping_tree, READ,
333                               bytenr, &length, &multi, mirror_num, NULL);
334         if (ret) {
335                 fprintf(stderr, "Error mapping block %d\n", ret);
336                 goto out;
337         }
338         device = multi->stripes[0].dev;
339         dev_fd = device->fd;
340         device->total_ios++;
341         dev_bytenr = multi->stripes[0].physical;
342         kfree(multi);
343
344         if (size_left < length)
345                 length = size_left;
346
347         done = pread(dev_fd, inbuf+count, length, dev_bytenr);
348         /* Need both checks, or we miss negative values due to u64 conversion */
349         if (done < 0 || done < length) {
350                 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
351                                               bytenr, length);
352                 mirror_num++;
353                 /* mirror_num is 1-indexed, so num_copies is a valid mirror. */
354                 if (mirror_num > num_copies) {
355                         ret = -1;
356                         fprintf(stderr, "Exhausted mirrors trying to read\n");
357                         goto out;
358                 }
359                 fprintf(stderr, "Trying another mirror\n");
360                 goto again;
361         }
362
363         mirror_num = 1;
364         size_left -= length;
365         count += length;
366         bytenr += length;
367         if (size_left)
368                 goto again;
369
370         if (compress == BTRFS_COMPRESS_NONE) {
371                 while (total < num_bytes) {
372                         done = pwrite(fd, inbuf+total, num_bytes-total,
373                                       pos+total);
374                         if (done < 0) {
375                                 ret = -1;
376                                 fprintf(stderr, "Error writing: %d %s\n", errno, strerror(errno));
377                                 goto out;
378                         }
379                         total += done;
380                 }
381                 ret = 0;
382                 goto out;
383         }
384
385         ret = decompress(inbuf, outbuf, disk_size, &ram_size, compress);
386         if (ret) {
387                 num_copies = btrfs_num_copies(&root->fs_info->mapping_tree,
388                                               bytenr, length);
389                 mirror_num++;
390                 if (mirror_num >= num_copies) {
391                         ret = -1;
392                         goto out;
393                 }
394                 fprintf(stderr, "Trying another mirror\n");
395                 goto again;
396         }
397
398         while (total < num_bytes) {
399                 done = pwrite(fd, outbuf + offset + total,
400                               num_bytes - total,
401                               pos + total);
402                 if (done < 0) {
403                         ret = -1;
404                         goto out;
405                 }
406                 total += done;
407         }
408 out:
409         free(inbuf);
410         free(outbuf);
411         return ret;
412 }
413
414 enum loop_response {
415         LOOP_STOP,
416         LOOP_CONTINUE,
417         LOOP_DONTASK
418 };
419
420 static enum loop_response ask_to_continue(const char *file)
421 {
422         char buf[2];
423         char *ret;
424
425         printf("We seem to be looping a lot on %s, do you want to keep going "
426                "on ? (y/N/a): ", file);
427 again:
428         ret = fgets(buf, 2, stdin);
429         if (*ret == '\n' || tolower(*ret) == 'n')
430                 return LOOP_STOP;
431         if (tolower(*ret) == 'a')
432                 return LOOP_DONTASK;
433         if (tolower(*ret) != 'y') {
434                 printf("Please enter one of 'y', 'n', or 'a': ");
435                 goto again;
436         }
437
438         return LOOP_CONTINUE;
439 }
440
441
442 static int set_file_xattrs(struct btrfs_root *root, u64 inode,
443                            int fd, const char *file_name)
444 {
445         struct btrfs_key key;
446         struct btrfs_path *path;
447         struct extent_buffer *leaf;
448         struct btrfs_dir_item *di;
449         u32 name_len = 0;
450         u32 data_len = 0;
451         u32 len = 0;
452         u32 cur, total_len;
453         char *name = NULL;
454         char *data = NULL;
455         int ret = 0;
456
457         key.objectid = inode;
458         key.type = BTRFS_XATTR_ITEM_KEY;
459         key.offset = 0;
460
461         path = btrfs_alloc_path();
462         if (!path)
463                 return -ENOMEM;
464
465         ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
466         if (ret < 0)
467                 goto out;
468
469         leaf = path->nodes[0];
470         while (1) {
471                 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
472                         do {
473                                 ret = next_leaf(root, path);
474                                 if (ret < 0) {
475                                         fprintf(stderr,
476                                                 "Error searching for extended attributes: %d\n",
477                                                 ret);
478                                         goto out;
479                                 } else if (ret) {
480                                         /* No more leaves to search */
481                                         ret = 0;
482                                         goto out;
483                                 }
484                                 leaf = path->nodes[0];
485                         } while (!leaf);
486                         continue;
487                 }
488
489                 btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
490                 if (key.type != BTRFS_XATTR_ITEM_KEY || key.objectid != inode)
491                         break;
492                 cur = 0;
493                 total_len = btrfs_item_size_nr(leaf, path->slots[0]);
494                 di = btrfs_item_ptr(leaf, path->slots[0],
495                                     struct btrfs_dir_item);
496
497                 while (cur < total_len) {
498                         len = btrfs_dir_name_len(leaf, di);
499                         if (len > name_len) {
500                                 free(name);
501                                 name = (char *) malloc(len + 1);
502                                 if (!name) {
503                                         ret = -ENOMEM;
504                                         goto out;
505                                 }
506                         }
507                         read_extent_buffer(leaf, name,
508                                            (unsigned long)(di + 1), len);
509                         name[len] = '\0';
510                         name_len = len;
511
512                         len = btrfs_dir_data_len(leaf, di);
513                         if (len > data_len) {
514                                 free(data);
515                                 data = (char *) malloc(len);
516                                 if (!data) {
517                                         ret = -ENOMEM;
518                                         goto out;
519                                 }
520                         }
521                         read_extent_buffer(leaf, data,
522                                            (unsigned long)(di + 1) + name_len,
523                                            len);
524                         data_len = len;
525
526                         if (fsetxattr(fd, name, data, data_len, 0)) {
527                                 int err = errno;
528
529                                 fprintf(stderr,
530                                         "Error setting extended attribute %s on file %s: %s\n",
531                                         name, file_name, strerror(err));
532                         }
533
534                         len = sizeof(*di) + name_len + data_len;
535                         cur += len;
536                         di = (struct btrfs_dir_item *)((char *)di + len);
537                 }
538                 path->slots[0]++;
539         }
540         ret = 0;
541 out:
542         btrfs_free_path(path);
543         free(name);
544         free(data);
545
546         return ret;
547 }
548
549
550 static int copy_file(struct btrfs_root *root, int fd, struct btrfs_key *key,
551                      const char *file)
552 {
553         struct extent_buffer *leaf;
554         struct btrfs_path *path;
555         struct btrfs_file_extent_item *fi;
556         struct btrfs_inode_item *inode_item;
557         struct btrfs_key found_key;
558         int ret;
559         int extent_type;
560         int compression;
561         int loops = 0;
562         u64 found_size = 0;
563
564         path = btrfs_alloc_path();
565         if (!path) {
566                 fprintf(stderr, "Ran out of memory\n");
567                 return -ENOMEM;
568         }
569
570         ret = btrfs_lookup_inode(NULL, root, path, key, 0);
571         if (ret == 0) {
572                 inode_item = btrfs_item_ptr(path->nodes[0], path->slots[0],
573                                     struct btrfs_inode_item);
574                 found_size = btrfs_inode_size(path->nodes[0], inode_item);
575         }
576         btrfs_release_path(path);
577
578         key->offset = 0;
579         key->type = BTRFS_EXTENT_DATA_KEY;
580
581         ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
582         if (ret < 0) {
583                 fprintf(stderr, "Error searching %d\n", ret);
584                 btrfs_free_path(path);
585                 return ret;
586         }
587
588         leaf = path->nodes[0];
589         while (!leaf) {
590                 ret = next_leaf(root, path);
591                 if (ret < 0) {
592                         fprintf(stderr, "Error getting next leaf %d\n",
593                                 ret);
594                         btrfs_free_path(path);
595                         return ret;
596                 } else if (ret > 0) {
597                         /* No more leaves to search */
598                         btrfs_free_path(path);
599                         return 0;
600                 }
601                 leaf = path->nodes[0];
602         }
603
604         while (1) {
605                 if (loops >= 0 && loops++ >= 1024) {
606                         enum loop_response resp;
607
608                         resp = ask_to_continue(file);
609                         if (resp == LOOP_STOP)
610                                 break;
611                         else if (resp == LOOP_CONTINUE)
612                                 loops = 0;
613                         else if (resp == LOOP_DONTASK)
614                                 loops = -1;
615                 }
616                 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
617                         do {
618                                 ret = next_leaf(root, path);
619                                 if (ret < 0) {
620                                         fprintf(stderr, "Error searching %d\n", ret);
621                                         btrfs_free_path(path);
622                                         return ret;
623                                 } else if (ret) {
624                                         /* No more leaves to search */
625                                         btrfs_free_path(path);
626                                         goto set_size;
627                                 }
628                                 leaf = path->nodes[0];
629                         } while (!leaf);
630                         continue;
631                 }
632                 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
633                 if (found_key.objectid != key->objectid)
634                         break;
635                 if (found_key.type != key->type)
636                         break;
637                 fi = btrfs_item_ptr(leaf, path->slots[0],
638                                     struct btrfs_file_extent_item);
639                 extent_type = btrfs_file_extent_type(leaf, fi);
640                 compression = btrfs_file_extent_compression(leaf, fi);
641                 if (compression >= BTRFS_COMPRESS_LAST) {
642                         fprintf(stderr, "Don't support compression yet %d\n",
643                                 compression);
644                         btrfs_free_path(path);
645                         return -1;
646                 }
647
648                 if (extent_type == BTRFS_FILE_EXTENT_PREALLOC)
649                         goto next;
650                 if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
651                         ret = copy_one_inline(fd, path, found_key.offset);
652                         if (ret) {
653                                 btrfs_free_path(path);
654                                 return -1;
655                         }
656                 } else if (extent_type == BTRFS_FILE_EXTENT_REG) {
657                         ret = copy_one_extent(root, fd, leaf, fi,
658                                               found_key.offset);
659                         if (ret) {
660                                 btrfs_free_path(path);
661                                 return ret;
662                         }
663                 } else {
664                         printf("Weird extent type %d\n", extent_type);
665                 }
666 next:
667                 path->slots[0]++;
668         }
669
670         btrfs_free_path(path);
671 set_size:
672         if (found_size) {
673                 ret = ftruncate(fd, (loff_t)found_size);
674                 if (ret)
675                         return ret;
676         }
677         if (get_xattrs) {
678                 ret = set_file_xattrs(root, key->objectid, fd, file);
679                 if (ret)
680                         return ret;
681         }
682         return 0;
683 }
684
685 static int search_dir(struct btrfs_root *root, struct btrfs_key *key,
686                       const char *output_rootdir, const char *in_dir,
687                       const regex_t *mreg)
688 {
689         struct btrfs_path *path;
690         struct extent_buffer *leaf;
691         struct btrfs_dir_item *dir_item;
692         struct btrfs_key found_key, location;
693         char filename[BTRFS_NAME_LEN + 1];
694         unsigned long name_ptr;
695         int name_len;
696         int ret;
697         int fd;
698         int loops = 0;
699         u8 type;
700
701         path = btrfs_alloc_path();
702         if (!path) {
703                 fprintf(stderr, "Ran out of memory\n");
704                 return -ENOMEM;
705         }
706
707         key->offset = 0;
708         key->type = BTRFS_DIR_INDEX_KEY;
709
710         ret = btrfs_search_slot(NULL, root, key, path, 0, 0);
711         if (ret < 0) {
712                 fprintf(stderr, "Error searching %d\n", ret);
713                 btrfs_free_path(path);
714                 return ret;
715         }
716
717         leaf = path->nodes[0];
718         while (!leaf) {
719                 if (verbose > 1)
720                         printf("No leaf after search, looking for the next "
721                                "leaf\n");
722                 ret = next_leaf(root, path);
723                 if (ret < 0) {
724                         fprintf(stderr, "Error getting next leaf %d\n",
725                                 ret);
726                         btrfs_free_path(path);
727                         return ret;
728                 } else if (ret > 0) {
729                         /* No more leaves to search */
730                         if (verbose)
731                                 printf("Reached the end of the tree looking "
732                                        "for the directory\n");
733                         btrfs_free_path(path);
734                         return 0;
735                 }
736                 leaf = path->nodes[0];
737         }
738
739         while (leaf) {
740                 if (loops++ >= 1024) {
741                         printf("We have looped trying to restore files in %s "
742                                "too many times to be making progress, "
743                                "stopping\n", in_dir);
744                         break;
745                 }
746
747                 if (path->slots[0] >= btrfs_header_nritems(leaf)) {
748                         do {
749                                 ret = next_leaf(root, path);
750                                 if (ret < 0) {
751                                         fprintf(stderr, "Error searching %d\n",
752                                                 ret);
753                                         btrfs_free_path(path);
754                                         return ret;
755                                 } else if (ret > 0) {
756                                         /* No more leaves to search */
757                                         if (verbose)
758                                                 printf("Reached the end of "
759                                                        "the tree searching the"
760                                                        " directory\n");
761                                         btrfs_free_path(path);
762                                         return 0;
763                                 }
764                                 leaf = path->nodes[0];
765                         } while (!leaf);
766                         continue;
767                 }
768                 btrfs_item_key_to_cpu(leaf, &found_key, path->slots[0]);
769                 if (found_key.objectid != key->objectid) {
770                         if (verbose > 1)
771                                 printf("Found objectid=%Lu, key=%Lu\n",
772                                        found_key.objectid, key->objectid);
773                         break;
774                 }
775                 if (found_key.type != key->type) {
776                         if (verbose > 1)
777                                 printf("Found type=%u, want=%u\n",
778                                        found_key.type, key->type);
779                         break;
780                 }
781                 dir_item = btrfs_item_ptr(leaf, path->slots[0],
782                                           struct btrfs_dir_item);
783                 name_ptr = (unsigned long)(dir_item + 1);
784                 name_len = btrfs_dir_name_len(leaf, dir_item);
785                 read_extent_buffer(leaf, filename, name_ptr, name_len);
786                 filename[name_len] = '\0';
787                 type = btrfs_dir_type(leaf, dir_item);
788                 btrfs_dir_item_key_to_cpu(leaf, dir_item, &location);
789
790                 /* full path from root of btrfs being restored */
791                 snprintf(fs_name, 4096, "%s/%s", in_dir, filename);
792
793                 if (mreg && REG_NOMATCH == regexec(mreg, fs_name, 0, NULL, 0))
794                         goto next;
795
796                 /* full path from system root */
797                 snprintf(path_name, 4096, "%s%s", output_rootdir, fs_name);
798
799                 /*
800                  * At this point we're only going to restore directories and
801                  * files, no symlinks or anything else.
802                  */
803                 if (type == BTRFS_FT_REG_FILE) {
804                         if (!overwrite) {
805                                 static int warn = 0;
806                                 struct stat st;
807
808                                 ret = stat(path_name, &st);
809                                 if (!ret) {
810                                         loops = 0;
811                                         if (verbose || !warn)
812                                                 printf("Skipping existing file"
813                                                        " %s\n", path_name);
814                                         if (warn)
815                                                 goto next;
816                                         printf("If you wish to overwrite use "
817                                                "the -o option to overwrite\n");
818                                         warn = 1;
819                                         goto next;
820                                 }
821                                 ret = 0;
822                         }
823                         if (verbose)
824                                 printf("Restoring %s\n", path_name);
825                         if (dry_run)
826                                 goto next;
827                         fd = open(path_name, O_CREAT|O_WRONLY, 0644);
828                         if (fd < 0) {
829                                 fprintf(stderr, "Error creating %s: %d\n",
830                                         path_name, errno);
831                                 if (ignore_errors)
832                                         goto next;
833                                 btrfs_free_path(path);
834                                 return -1;
835                         }
836                         loops = 0;
837                         ret = copy_file(root, fd, &location, path_name);
838                         close(fd);
839                         if (ret) {
840                                 if (ignore_errors)
841                                         goto next;
842                                 btrfs_free_path(path);
843                                 return ret;
844                         }
845                 } else if (type == BTRFS_FT_DIR) {
846                         struct btrfs_root *search_root = root;
847                         char *dir = strdup(fs_name);
848
849                         if (!dir) {
850                                 fprintf(stderr, "Ran out of memory\n");
851                                 btrfs_free_path(path);
852                                 return -ENOMEM;
853                         }
854
855                         if (location.type == BTRFS_ROOT_ITEM_KEY) {
856                                 /*
857                                  * If we are a snapshot and this is the index
858                                  * object to ourselves just skip it.
859                                  */
860                                 if (location.objectid ==
861                                     root->root_key.objectid) {
862                                         free(dir);
863                                         goto next;
864                                 }
865
866                                 location.offset = (u64)-1;
867                                 search_root = btrfs_read_fs_root(root->fs_info,
868                                                                  &location);
869                                 if (IS_ERR(search_root)) {
870                                         free(dir);
871                                         fprintf(stderr, "Error reading "
872                                                 "subvolume %s: %lu\n",
873                                                 path_name,
874                                                 PTR_ERR(search_root));
875                                         if (ignore_errors)
876                                                 goto next;
877                                         btrfs_free_path(path);
878                                         return PTR_ERR(search_root);
879                                 }
880
881                                 /*
882                                  * A subvolume will have a key.offset of 0, a
883                                  * snapshot will have key.offset of a transid.
884                                  */
885                                 if (search_root->root_key.offset != 0 &&
886                                     get_snaps == 0) {
887                                         free(dir);
888                                         printf("Skipping snapshot %s\n",
889                                                filename);
890                                         goto next;
891                                 }
892                                 location.objectid = BTRFS_FIRST_FREE_OBJECTID;
893                         }
894
895                         if (verbose)
896                                 printf("Restoring %s\n", path_name);
897
898                         errno = 0;
899                         if (dry_run)
900                                 ret = 0;
901                         else
902                                 ret = mkdir(path_name, 0755);
903                         if (ret && errno != EEXIST) {
904                                 free(dir);
905                                 fprintf(stderr, "Error mkdiring %s: %d\n",
906                                         path_name, errno);
907                                 if (ignore_errors)
908                                         goto next;
909                                 btrfs_free_path(path);
910                                 return -1;
911                         }
912                         loops = 0;
913                         ret = search_dir(search_root, &location,
914                                          output_rootdir, dir, mreg);
915                         free(dir);
916                         if (ret) {
917                                 if (ignore_errors)
918                                         goto next;
919                                 btrfs_free_path(path);
920                                 return ret;
921                         }
922                 }
923 next:
924                 path->slots[0]++;
925         }
926
927         if (verbose)
928                 printf("Done searching %s\n", in_dir);
929         btrfs_free_path(path);
930         return 0;
931 }
932
933 static int do_list_roots(struct btrfs_root *root)
934 {
935         struct btrfs_key key;
936         struct btrfs_key found_key;
937         struct btrfs_disk_key disk_key;
938         struct btrfs_path *path;
939         struct extent_buffer *leaf;
940         struct btrfs_root_item ri;
941         unsigned long offset;
942         int slot;
943         int ret;
944
945         root = root->fs_info->tree_root;
946         path = btrfs_alloc_path();
947         if (!path) {
948                 fprintf(stderr, "Failed to alloc path\n");
949                 return -ENOMEM;
950         }
951
952         key.offset = 0;
953         key.objectid = 0;
954         key.type = BTRFS_ROOT_ITEM_KEY;
955
956         ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
957         if (ret < 0) {
958                 fprintf(stderr, "Failed to do search %d\n", ret);
959                 btrfs_free_path(path);
960                 return -1;
961         }
962
963         while (1) {
964                 leaf = path->nodes[0];
965                 slot = path->slots[0];
966                 if (slot >= btrfs_header_nritems(leaf)) {
967                         ret = btrfs_next_leaf(root, path);
968                         if (ret)
969                                 break;
970                         leaf = path->nodes[0];
971                         slot = path->slots[0];
972                 }
973                 btrfs_item_key(leaf, &disk_key, slot);
974                 btrfs_disk_key_to_cpu(&found_key, &disk_key);
975                 if (btrfs_key_type(&found_key) != BTRFS_ROOT_ITEM_KEY) {
976                         path->slots[0]++;
977                         continue;
978                 }
979
980                 offset = btrfs_item_ptr_offset(leaf, slot);
981                 read_extent_buffer(leaf, &ri, offset, sizeof(ri));
982                 printf(" tree ");
983                 btrfs_print_key(&disk_key);
984                 printf(" %Lu level %d\n", btrfs_root_bytenr(&ri),
985                        btrfs_root_level(&ri));
986                 path->slots[0]++;
987         }
988         btrfs_free_path(path);
989
990         return 0;
991 }
992
993 static struct btrfs_root *open_fs(const char *dev, u64 root_location,
994                                   int super_mirror, int list_roots)
995 {
996         struct btrfs_fs_info *fs_info = NULL;
997         struct btrfs_root *root = NULL;
998         u64 bytenr;
999         int i;
1000
1001         for (i = super_mirror; i < BTRFS_SUPER_MIRROR_MAX; i++) {
1002                 bytenr = btrfs_sb_offset(i);
1003                 fs_info = open_ctree_fs_info(dev, bytenr, root_location,
1004                                              OPEN_CTREE_PARTIAL);
1005                 if (fs_info)
1006                         break;
1007                 fprintf(stderr, "Could not open root, trying backup super\n");
1008         }
1009
1010         if (!fs_info)
1011                 return NULL;
1012
1013         /*
1014          * All we really need to succeed is reading the chunk tree, everything
1015          * else we can do by hand, since we only need to read the tree root and
1016          * the fs_root.
1017          */
1018         if (!extent_buffer_uptodate(fs_info->tree_root->node)) {
1019                 u64 generation;
1020
1021                 root = fs_info->tree_root;
1022                 if (!root_location)
1023                         root_location = btrfs_super_root(fs_info->super_copy);
1024                 generation = btrfs_super_generation(fs_info->super_copy);
1025                 root->node = read_tree_block(root, root_location,
1026                                              root->leafsize, generation);
1027                 if (!extent_buffer_uptodate(root->node)) {
1028                         fprintf(stderr, "Error opening tree root\n");
1029                         close_ctree(root);
1030                         return NULL;
1031                 }
1032         }
1033
1034         if (!list_roots && !fs_info->fs_root) {
1035                 struct btrfs_key key;
1036
1037                 key.objectid = BTRFS_FS_TREE_OBJECTID;
1038                 key.type = BTRFS_ROOT_ITEM_KEY;
1039                 key.offset = (u64)-1;
1040                 fs_info->fs_root = btrfs_read_fs_root_no_cache(fs_info, &key);
1041                 if (IS_ERR(fs_info->fs_root)) {
1042                         fprintf(stderr, "Couldn't read fs root: %ld\n",
1043                                 PTR_ERR(fs_info->fs_root));
1044                         close_ctree(fs_info->tree_root);
1045                         return NULL;
1046                 }
1047         }
1048
1049         if (list_roots && do_list_roots(fs_info->tree_root)) {
1050                 close_ctree(fs_info->tree_root);
1051                 return NULL;
1052         }
1053
1054         return fs_info->fs_root;
1055 }
1056
1057 static int find_first_dir(struct btrfs_root *root, u64 *objectid)
1058 {
1059         struct btrfs_path *path;
1060         struct btrfs_key found_key;
1061         struct btrfs_key key;
1062         int ret = -1;
1063         int i;
1064
1065         key.objectid = 0;
1066         key.type = BTRFS_DIR_INDEX_KEY;
1067         key.offset = 0;
1068
1069         path = btrfs_alloc_path();
1070         if (!path) {
1071                 fprintf(stderr, "Ran out of memory\n");
1072                 return ret;
1073         }
1074
1075         ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
1076         if (ret < 0) {
1077                 fprintf(stderr, "Error searching %d\n", ret);
1078                 goto out;
1079         }
1080
1081         if (!path->nodes[0]) {
1082                 fprintf(stderr, "No leaf!\n");
1083                 goto out;
1084         }
1085 again:
1086         for (i = path->slots[0];
1087              i < btrfs_header_nritems(path->nodes[0]); i++) {
1088                 btrfs_item_key_to_cpu(path->nodes[0], &found_key, i);
1089                 if (found_key.type != key.type)
1090                         continue;
1091
1092                 printf("Using objectid %Lu for first dir\n",
1093                        found_key.objectid);
1094                 *objectid = found_key.objectid;
1095                 ret = 0;
1096                 goto out;
1097         }
1098         do {
1099                 ret = next_leaf(root, path);
1100                 if (ret < 0) {
1101                         fprintf(stderr, "Error getting next leaf %d\n",
1102                                 ret);
1103                         goto out;
1104                 } else if (ret > 0) {
1105                         fprintf(stderr, "No more leaves\n");
1106                         goto out;
1107                 }
1108         } while (!path->nodes[0]);
1109         if (path->nodes[0])
1110                 goto again;
1111         printf("Couldn't find a dir index item\n");
1112 out:
1113         btrfs_free_path(path);
1114         return ret;
1115 }
1116
1117 static struct option long_options[] = {
1118         { "path-regex", 1, NULL, 256},
1119         { "dry-run", 0, NULL, 'D'},
1120         { NULL, 0, NULL, 0}
1121 };
1122
1123 const char * const cmd_restore_usage[] = {
1124         "btrfs restore [options] <device> <path> | -l <device>",
1125         "Try to restore files from a damaged filesystem (unmounted)",
1126         "",
1127         "-s              get snapshots",
1128         "-x              get extended attributes",
1129         "-v              verbose",
1130         "-i              ignore errors",
1131         "-o              overwrite",
1132         "-t <bytenr>     tree location",
1133         "-f <bytenr>     filesystem location",
1134         "-u <mirror>     super mirror",
1135         "-r <rootid>     root objectid",
1136         "-d              find dir",
1137         "-l              list tree roots",
1138         "-D|--dry-run    dry run (only list files that would be recovered)",
1139         "--path-regex <regex>",
1140         "                restore only filenames matching regex,",
1141         "                you have to use following syntax (possibly quoted):",
1142         "                ^/(|home(|/username(|/Desktop(|/.*))))$",
1143         "-c              ignore case (--path-regrex only)",
1144         NULL
1145 };
1146
1147 int cmd_restore(int argc, char **argv)
1148 {
1149         struct btrfs_root *root;
1150         struct btrfs_key key;
1151         char dir_name[128];
1152         u64 tree_location = 0;
1153         u64 fs_location = 0;
1154         u64 root_objectid = 0;
1155         int len;
1156         int ret;
1157         int opt;
1158         int option_index = 0;
1159         int super_mirror = 0;
1160         int find_dir = 0;
1161         int list_roots = 0;
1162         const char *match_regstr = NULL;
1163         int match_cflags = REG_EXTENDED | REG_NOSUB | REG_NEWLINE;
1164         regex_t match_reg, *mreg = NULL;
1165         char reg_err[256];
1166
1167         while ((opt = getopt_long(argc, argv, "sxviot:u:df:r:lDc", long_options,
1168                                         &option_index)) != -1) {
1169
1170                 switch (opt) {
1171                         case 's':
1172                                 get_snaps = 1;
1173                                 break;
1174                         case 'v':
1175                                 verbose++;
1176                                 break;
1177                         case 'i':
1178                                 ignore_errors = 1;
1179                                 break;
1180                         case 'o':
1181                                 overwrite = 1;
1182                                 break;
1183                         case 't':
1184                                 tree_location = arg_strtou64(optarg);
1185                                 break;
1186                         case 'f':
1187                                 fs_location = arg_strtou64(optarg);
1188                                 break;
1189                         case 'u':
1190                                 super_mirror = arg_strtou64(optarg);
1191                                 if (super_mirror >= BTRFS_SUPER_MIRROR_MAX) {
1192                                         fprintf(stderr, "Super mirror not "
1193                                                 "valid\n");
1194                                         exit(1);
1195                                 }
1196                                 break;
1197                         case 'd':
1198                                 find_dir = 1;
1199                                 break;
1200                         case 'r':
1201                                 root_objectid = arg_strtou64(optarg);
1202                                 if (!is_fstree(root_objectid)) {
1203                                         fprintf(stderr, "objectid %llu is not a valid fs/file tree\n",
1204                                                         root_objectid);
1205                                         exit(1);
1206                                 }
1207                                 break;
1208                         case 'l':
1209                                 list_roots = 1;
1210                                 break;
1211                         case 'D':
1212                                 dry_run = 1;
1213                                 break;
1214                         case 'c':
1215                                 match_cflags |= REG_ICASE;
1216                                 break;
1217                         /* long option without single letter alternative */
1218                         case 256:
1219                                 match_regstr = optarg;
1220                                 break;
1221                         case 'x':
1222                                 get_xattrs = 1;
1223                                 break;
1224                         default:
1225                                 usage(cmd_restore_usage);
1226                 }
1227         }
1228
1229         set_argv0(argv);
1230         if (!list_roots && check_argc_min(argc - optind, 2))
1231                 usage(cmd_restore_usage);
1232         else if (list_roots && check_argc_min(argc - optind, 1))
1233                 usage(cmd_restore_usage);
1234
1235         if (fs_location && root_objectid) {
1236                 fprintf(stderr, "don't use -f and -r at the same time.\n");
1237                 return 1;
1238         }
1239
1240         if ((ret = check_mounted(argv[optind])) < 0) {
1241                 fprintf(stderr, "Could not check mount status: %s\n",
1242                         strerror(-ret));
1243                 return 1;
1244         } else if (ret) {
1245                 fprintf(stderr, "%s is currently mounted.  Aborting.\n", argv[optind]);
1246                 return 1;
1247         }
1248
1249         root = open_fs(argv[optind], tree_location, super_mirror, list_roots);
1250         if (root == NULL)
1251                 return 1;
1252
1253         if (list_roots)
1254                 goto out;
1255
1256         if (fs_location != 0) {
1257                 free_extent_buffer(root->node);
1258                 root->node = read_tree_block(root, fs_location, root->leafsize, 0);
1259                 if (!root->node) {
1260                         fprintf(stderr, "Failed to read fs location\n");
1261                         ret = 1;
1262                         goto out;
1263                 }
1264         }
1265
1266         memset(path_name, 0, 4096);
1267
1268         strncpy(dir_name, argv[optind + 1], sizeof dir_name);
1269         dir_name[sizeof dir_name - 1] = 0;
1270
1271         /* Strip the trailing / on the dir name */
1272         len = strlen(dir_name);
1273         while (len && dir_name[--len] == '/') {
1274                 dir_name[len] = '\0';
1275         }
1276
1277         if (root_objectid != 0) {
1278                 struct btrfs_root *orig_root = root;
1279
1280                 key.objectid = root_objectid;
1281                 key.type = BTRFS_ROOT_ITEM_KEY;
1282                 key.offset = (u64)-1;
1283                 root = btrfs_read_fs_root(orig_root->fs_info, &key);
1284                 if (IS_ERR(root)) {
1285                         fprintf(stderr, "fail to read root %llu: %s\n",
1286                                         root_objectid, strerror(-PTR_ERR(root)));
1287                         root = orig_root;
1288                         ret = 1;
1289                         goto out;
1290                 }
1291                 key.type = 0;
1292                 key.offset = 0;
1293         }
1294
1295         if (find_dir) {
1296                 ret = find_first_dir(root, &key.objectid);
1297                 if (ret)
1298                         goto out;
1299         } else {
1300                 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
1301         }
1302
1303         if (match_regstr) {
1304                 ret = regcomp(&match_reg, match_regstr, match_cflags);
1305                 if (ret) {
1306                         regerror(ret, &match_reg, reg_err, sizeof(reg_err));
1307                         fprintf(stderr, "Regex compile failed: %s\n", reg_err);
1308                         goto out;
1309                 }
1310                 mreg = &match_reg;
1311         }
1312
1313         if (dry_run)
1314                 printf("This is a dry-run, no files are going to be restored\n");
1315
1316         ret = search_dir(root, &key, dir_name, "", mreg);
1317
1318 out:
1319         if (mreg)
1320                 regfree(mreg);
1321         close_ctree(root);
1322         return !!ret;
1323 }