2 * Copyright (C) 2010 Oracle. 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.
21 #include <sys/ioctl.h>
22 #include <sys/mount.h>
27 #include <sys/types.h>
33 #include "kerncompat.h"
35 #include "transaction.h"
38 /* we store all the roots we find in an rbtree so that we can
39 * search for them later.
46 * one of these for each root we find.
49 struct rb_node rb_node;
54 /* the id of the root that references this one */
57 /* the dir id we're in from ref_tree */
60 /* path from the subvol we live in to this root, including the
61 * root's name. This is null until we do the extra lookup ioctl.
65 /* the name of this root in the directory it lives in */
69 static void root_lookup_init(struct root_lookup *tree)
71 tree->root.rb_node = NULL;
74 static int comp_entry(struct root_info *entry, u64 root_id, u64 ref_tree)
76 if (entry->root_id > root_id)
78 if (entry->root_id < root_id)
80 if (entry->ref_tree > ref_tree)
82 if (entry->ref_tree < ref_tree)
88 * insert a new root into the tree. returns the existing root entry
89 * if one is already there. Both root_id and ref_tree are used
92 static struct rb_node *tree_insert(struct rb_root *root, u64 root_id,
93 u64 ref_tree, struct rb_node *node)
95 struct rb_node ** p = &root->rb_node;
96 struct rb_node * parent = NULL;
97 struct root_info *entry;
102 entry = rb_entry(parent, struct root_info, rb_node);
104 comp = comp_entry(entry, root_id, ref_tree);
114 entry = rb_entry(parent, struct root_info, rb_node);
115 rb_link_node(node, parent, p);
116 rb_insert_color(node, root);
121 * find a given root id in the tree. We return the smallest one,
122 * rb_next can be used to move forward looking for more if required
124 static struct root_info *tree_search(struct rb_root *root, u64 root_id)
126 struct rb_node * n = root->rb_node;
127 struct root_info *entry;
130 entry = rb_entry(n, struct root_info, rb_node);
132 if (entry->root_id < root_id)
134 else if (entry->root_id > root_id)
137 struct root_info *prev;
138 struct rb_node *prev_n;
143 prev = rb_entry(prev_n, struct root_info,
145 if (prev->root_id != root_id)
157 * this allocates a new root in the lookup tree.
159 * root_id should be the object id of the root
161 * ref_tree is the objectid of the referring root.
163 * dir_id is the directory in ref_tree where this root_id can be found.
165 * name is the name of root_id in that directory
167 * name_len is the length of name
169 static int add_root(struct root_lookup *root_lookup,
170 u64 root_id, u64 ref_tree, u64 dir_id, char *name,
173 struct root_info *ri;
175 ri = malloc(sizeof(*ri) + name_len + 1);
177 printf("memory allocation failed\n");
180 memset(ri, 0, sizeof(*ri) + name_len + 1);
183 ri->root_id = root_id;
184 ri->ref_tree = ref_tree;
185 strncpy(ri->name, name, name_len);
187 ret = tree_insert(&root_lookup->root, root_id, ref_tree, &ri->rb_node);
189 printf("failed to insert tree %llu\n", (unsigned long long)root_id);
196 * for a given root_info, search through the root_lookup tree to construct
197 * the full path name to it.
199 * This can't be called until all the root_info->path fields are filled
200 * in by lookup_ino_path
202 static int resolve_root(struct root_lookup *rl, struct root_info *ri,
203 u64 *parent_id, u64 *top_id, char **path)
205 char *full_path = NULL;
207 struct root_info *found;
210 * we go backwards from the root_info object and add pathnames
211 * from parent directories as we go.
218 int add_len = strlen(found->path);
220 /* room for / and for null */
221 tmp = malloc(add_len + 2 + len);
223 memcpy(tmp + add_len + 1, full_path, len);
225 memcpy(tmp, found->path, add_len);
226 tmp [add_len + len + 1] = '\0';
231 full_path = strdup(found->path);
235 next = found->ref_tree;
236 /* record the first parent */
240 /* if the ref_tree refers to ourselves, we're at the top */
241 if (next == found->root_id) {
247 * if the ref_tree wasn't in our tree of roots, we're
250 found = tree_search(&rl->root, next);
263 * for a single root_info, ask the kernel to give us a path name
264 * inside it's ref_root for the dir_id where it lives.
266 * This fills in root_info->path with the path to the directory and and
267 * appends this root's name.
269 static int lookup_ino_path(int fd, struct root_info *ri)
271 struct btrfs_ioctl_ino_lookup_args args;
277 memset(&args, 0, sizeof(args));
278 args.treeid = ri->ref_tree;
279 args.objectid = ri->dir_id;
281 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
284 fprintf(stderr, "ERROR: Failed to lookup path for root %llu - %s\n",
285 (unsigned long long)ri->ref_tree,
292 * we're in a subdirectory of ref_tree, the kernel ioctl
293 * puts a / in there for us
295 ri->path = malloc(strlen(ri->name) + strlen(args.name) + 1);
297 perror("malloc failed");
300 strcpy(ri->path, args.name);
301 strcat(ri->path, ri->name);
303 /* we're at the root of ref_tree */
304 ri->path = strdup(ri->name);
306 perror("strdup failed");
313 /* finding the generation for a given path is a two step process.
314 * First we use the inode loookup routine to find out the root id
316 * Then we use the tree search ioctl to scan all the root items for a
317 * given root id and spit out the latest generation we can find
319 static u64 find_root_gen(int fd)
321 struct btrfs_ioctl_ino_lookup_args ino_args;
323 struct btrfs_ioctl_search_args args;
324 struct btrfs_ioctl_search_key *sk = &args.key;
325 struct btrfs_ioctl_search_header *sh;
326 unsigned long off = 0;
331 memset(&ino_args, 0, sizeof(ino_args));
332 ino_args.objectid = BTRFS_FIRST_FREE_OBJECTID;
334 /* this ioctl fills in ino_args->treeid */
335 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &ino_args);
338 fprintf(stderr, "ERROR: Failed to lookup path for dirid %llu - %s\n",
339 (unsigned long long)BTRFS_FIRST_FREE_OBJECTID,
344 memset(&args, 0, sizeof(args));
349 * there may be more than one ROOT_ITEM key if there are
350 * snapshots pending deletion, we have to loop through
353 sk->min_objectid = ino_args.treeid;
354 sk->max_objectid = ino_args.treeid;
355 sk->max_type = BTRFS_ROOT_ITEM_KEY;
356 sk->min_type = BTRFS_ROOT_ITEM_KEY;
357 sk->max_offset = (u64)-1;
358 sk->max_transid = (u64)-1;
362 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
365 fprintf(stderr, "ERROR: can't perform the search - %s\n",
369 /* the ioctl returns the number of item it found in nr_items */
370 if (sk->nr_items == 0)
374 for (i = 0; i < sk->nr_items; i++) {
375 struct btrfs_root_item *item;
376 sh = (struct btrfs_ioctl_search_header *)(args.buf +
380 item = (struct btrfs_root_item *)(args.buf + off);
383 sk->min_objectid = sh->objectid;
384 sk->min_type = sh->type;
385 sk->min_offset = sh->offset;
387 if (sh->objectid > ino_args.treeid)
390 if (sh->objectid == ino_args.treeid &&
391 sh->type == BTRFS_ROOT_ITEM_KEY) {
392 max_found = max(max_found,
393 btrfs_root_generation(item));
396 if (sk->min_offset < (u64)-1)
401 if (sk->min_type != BTRFS_ROOT_ITEM_KEY)
403 if (sk->min_objectid != BTRFS_ROOT_ITEM_KEY)
409 /* pass in a directory id and this will return
410 * the full path of the parent directory inside its
413 * It may return NULL if it is in the root, or an ERR_PTR if things
416 static char *__ino_resolve(int fd, u64 dirid)
418 struct btrfs_ioctl_ino_lookup_args args;
423 memset(&args, 0, sizeof(args));
424 args.objectid = dirid;
426 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
429 fprintf(stderr, "ERROR: Failed to lookup path for dirid %llu - %s\n",
430 (unsigned long long)dirid, strerror(e) );
436 * we're in a subdirectory of ref_tree, the kernel ioctl
437 * puts a / in there for us
439 full = strdup(args.name);
441 perror("malloc failed");
442 return ERR_PTR(-ENOMEM);
445 /* we're at the root of ref_tree */
452 * simple string builder, returning a new string with both
455 char *build_name(char *dirid, char *name)
461 full = malloc(strlen(dirid) + strlen(name) + 1);
470 * given an inode number, this returns the full path name inside the subvolume
471 * to that file/directory. cache_dirid and cache_name are used to
472 * cache the results so we can avoid tree searches if a later call goes
473 * to the same directory or file name
475 static char *ino_resolve(int fd, u64 ino, u64 *cache_dirid, char **cache_name)
483 struct btrfs_ioctl_search_args args;
484 struct btrfs_ioctl_search_key *sk = &args.key;
485 struct btrfs_ioctl_search_header *sh;
486 unsigned long off = 0;
490 memset(&args, 0, sizeof(args));
495 * step one, we search for the inode back ref. We just use the first
498 sk->min_objectid = ino;
499 sk->max_objectid = ino;
500 sk->max_type = BTRFS_INODE_REF_KEY;
501 sk->max_offset = (u64)-1;
502 sk->min_type = BTRFS_INODE_REF_KEY;
503 sk->max_transid = (u64)-1;
506 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
509 fprintf(stderr, "ERROR: can't perform the search - %s\n",
513 /* the ioctl returns the number of item it found in nr_items */
514 if (sk->nr_items == 0)
518 sh = (struct btrfs_ioctl_search_header *)(args.buf + off);
520 if (sh->type == BTRFS_INODE_REF_KEY) {
521 struct btrfs_inode_ref *ref;
524 ref = (struct btrfs_inode_ref *)(sh + 1);
525 namelen = btrfs_stack_inode_ref_name_len(ref);
527 name = (char *)(ref + 1);
528 name = strndup(name, namelen);
530 /* use our cached value */
531 if (dirid == *cache_dirid && *cache_name) {
532 dirname = *cache_name;
539 * the inode backref gives us the file name and the parent directory id.
540 * From here we use __ino_resolve to get the path to the parent
542 dirname = __ino_resolve(fd, dirid);
544 full = build_name(dirname, name);
545 if (*cache_name && dirname != *cache_name)
548 *cache_name = dirname;
549 *cache_dirid = dirid;
555 static int __list_subvol_search(int fd, struct root_lookup *root_lookup)
558 struct btrfs_ioctl_search_args args;
559 struct btrfs_ioctl_search_key *sk = &args.key;
560 struct btrfs_ioctl_search_header *sh;
561 struct btrfs_root_ref *ref;
562 unsigned long off = 0;
568 root_lookup_init(root_lookup);
569 memset(&args, 0, sizeof(args));
571 /* search in the tree of tree roots */
575 * set the min and max to backref keys. The search will
576 * only send back this type of key now.
578 sk->max_type = BTRFS_ROOT_BACKREF_KEY;
579 sk->min_type = BTRFS_ROOT_BACKREF_KEY;
582 * set all the other params to the max, we'll take any objectid
585 sk->max_objectid = (u64)-1;
586 sk->max_offset = (u64)-1;
587 sk->max_transid = (u64)-1;
589 /* just a big number, doesn't matter much */
593 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
596 /* the ioctl returns the number of item it found in nr_items */
597 if (sk->nr_items == 0)
603 * for each item, pull the key out of the header and then
604 * read the root_ref item it contains
606 for (i = 0; i < sk->nr_items; i++) {
607 sh = (struct btrfs_ioctl_search_header *)(args.buf +
610 if (sh->type == BTRFS_ROOT_BACKREF_KEY) {
611 ref = (struct btrfs_root_ref *)(args.buf + off);
612 name_len = btrfs_stack_root_ref_name_len(ref);
613 name = (char *)(ref + 1);
614 dir_id = btrfs_stack_root_ref_dirid(ref);
616 add_root(root_lookup, sh->objectid, sh->offset,
617 dir_id, name, name_len);
623 * record the mins in sk so we can make sure the
624 * next search doesn't repeat this root
626 sk->min_objectid = sh->objectid;
627 sk->min_type = sh->type;
628 sk->min_offset = sh->offset;
631 /* this iteration is done, step forward one root for the next
634 if (sk->min_type < BTRFS_ROOT_BACKREF_KEY) {
635 sk->min_type = BTRFS_ROOT_BACKREF_KEY;
637 } else if (sk->min_objectid < (u64)-1) {
639 sk->min_type = BTRFS_ROOT_BACKREF_KEY;
648 static int __list_subvol_fill_paths(int fd, struct root_lookup *root_lookup)
652 n = rb_first(&root_lookup->root);
654 struct root_info *entry;
656 entry = rb_entry(n, struct root_info, rb_node);
657 ret = lookup_ino_path(fd, entry);
666 int list_subvols(int fd, int print_parent)
668 struct root_lookup root_lookup;
672 ret = __list_subvol_search(fd, &root_lookup);
674 fprintf(stderr, "ERROR: can't perform the search - %s\n",
680 * now we have an rbtree full of root_info objects, but we need to fill
681 * in their path names within the subvol that is referencing each one.
683 ret = __list_subvol_fill_paths(fd, &root_lookup);
687 /* now that we have all the subvol-relative paths filled in,
688 * we have to string the subvols together so that we can get
689 * a path all the way back to the FS root
691 n = rb_last(&root_lookup.root);
693 struct root_info *entry;
698 entry = rb_entry(n, struct root_info, rb_node);
699 resolve_root(&root_lookup, entry, &parent_id, &level, &path);
701 printf("ID %llu parent %llu top level %llu path %s\n",
702 (unsigned long long)entry->root_id,
703 (unsigned long long)parent_id,
704 (unsigned long long)level, path);
706 printf("ID %llu top level %llu path %s\n",
707 (unsigned long long)entry->root_id,
708 (unsigned long long)level, path);
718 static int print_one_extent(int fd, struct btrfs_ioctl_search_header *sh,
719 struct btrfs_file_extent_item *item,
720 u64 found_gen, u64 *cache_dirid,
721 char **cache_dir_name, u64 *cache_ino,
722 char **cache_full_name)
732 if (sh->objectid == *cache_ino) {
733 name = *cache_full_name;
734 } else if (*cache_full_name) {
735 free(*cache_full_name);
736 *cache_full_name = NULL;
739 name = ino_resolve(fd, sh->objectid, cache_dirid,
741 *cache_full_name = name;
742 *cache_ino = sh->objectid;
747 type = btrfs_stack_file_extent_type(item);
748 compressed = btrfs_stack_file_extent_compression(item);
750 if (type == BTRFS_FILE_EXTENT_REG ||
751 type == BTRFS_FILE_EXTENT_PREALLOC) {
752 disk_start = btrfs_stack_file_extent_disk_bytenr(item);
753 disk_offset = btrfs_stack_file_extent_offset(item);
754 len = btrfs_stack_file_extent_num_bytes(item);
755 } else if (type == BTRFS_FILE_EXTENT_INLINE) {
758 len = btrfs_stack_file_extent_ram_bytes(item);
760 printf("unhandled extent type %d for inode %llu "
761 "file offset %llu gen %llu\n",
763 (unsigned long long)sh->objectid,
764 (unsigned long long)sh->offset,
765 (unsigned long long)found_gen);
769 printf("inode %llu file offset %llu len %llu disk start %llu "
770 "offset %llu gen %llu flags ",
771 (unsigned long long)sh->objectid,
772 (unsigned long long)sh->offset,
773 (unsigned long long)len,
774 (unsigned long long)disk_start,
775 (unsigned long long)disk_offset,
776 (unsigned long long)found_gen);
782 if (type == BTRFS_FILE_EXTENT_PREALLOC) {
783 printf("%sPREALLOC", flags ? "|" : "");
786 if (type == BTRFS_FILE_EXTENT_INLINE) {
787 printf("%sINLINE", flags ? "|" : "");
793 printf(" %s\n", name);
797 int find_updated_files(int fd, u64 root_id, u64 oldest_gen)
800 struct btrfs_ioctl_search_args args;
801 struct btrfs_ioctl_search_key *sk = &args.key;
802 struct btrfs_ioctl_search_header *sh;
803 struct btrfs_file_extent_item *item;
804 unsigned long off = 0;
811 char *cache_dir_name = NULL;
812 char *cache_full_name = NULL;
813 struct btrfs_file_extent_item backup;
815 memset(&backup, 0, sizeof(backup));
816 memset(&args, 0, sizeof(args));
818 sk->tree_id = root_id;
821 * set all the other params to the max, we'll take any objectid
824 sk->max_objectid = (u64)-1;
825 sk->max_offset = (u64)-1;
826 sk->max_transid = (u64)-1;
827 sk->max_type = BTRFS_EXTENT_DATA_KEY;
828 sk->min_transid = oldest_gen;
829 /* just a big number, doesn't matter much */
832 max_found = find_root_gen(fd);
834 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
837 fprintf(stderr, "ERROR: can't perform the search- %s\n",
841 /* the ioctl returns the number of item it found in nr_items */
842 if (sk->nr_items == 0)
848 * for each item, pull the key out of the header and then
849 * read the root_ref item it contains
851 for (i = 0; i < sk->nr_items; i++) {
852 sh = (struct btrfs_ioctl_search_header *)(args.buf +
857 * just in case the item was too big, pass something other
863 item = (struct btrfs_file_extent_item *)(args.buf +
865 found_gen = btrfs_stack_file_extent_generation(item);
866 if (sh->type == BTRFS_EXTENT_DATA_KEY &&
867 found_gen >= oldest_gen) {
868 print_one_extent(fd, sh, item, found_gen,
869 &cache_dirid, &cache_dir_name,
870 &cache_ino, &cache_full_name);
875 * record the mins in sk so we can make sure the
876 * next search doesn't repeat this root
878 sk->min_objectid = sh->objectid;
879 sk->min_offset = sh->offset;
880 sk->min_type = sh->type;
883 if (sk->min_offset < (u64)-1)
885 else if (sk->min_objectid < (u64)-1) {
892 free(cache_dir_name);
893 free(cache_full_name);
894 printf("transid marker was %llu\n", (unsigned long long)max_found);
898 char *path_for_root(int fd, u64 root)
900 struct root_lookup root_lookup;
902 char *ret_path = NULL;
905 ret = __list_subvol_search(fd, &root_lookup);
909 ret = __list_subvol_fill_paths(fd, &root_lookup);
913 n = rb_last(&root_lookup.root);
915 struct root_info *entry;
920 entry = rb_entry(n, struct root_info, rb_node);
921 resolve_root(&root_lookup, entry, &parent_id, &level, &path);
922 if (entry->root_id == root)