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.
19 #include <sys/ioctl.h>
20 #include <sys/mount.h>
23 #include <sys/types.h>
30 #include "transaction.h"
33 #include <uuid/uuid.h>
34 #include "btrfs-list.h"
35 #include "rbtree-utils.h"
37 #define BTRFS_LIST_NFILTERS_INCREASE (2 * BTRFS_LIST_FILTER_MAX)
38 #define BTRFS_LIST_NCOMPS_INCREASE (2 * BTRFS_LIST_COMP_MAX)
40 /* we store all the roots we find in an rbtree so that we can
41 * search for them later.
51 } btrfs_list_columns[] = {
64 .column_name = "CGen",
69 .column_name = "Parent",
74 .column_name = "Top Level",
79 .column_name = "OTime",
83 .name = "parent_uuid",
84 .column_name = "Parent UUID",
88 .name = "received_uuid",
89 .column_name = "Received UUID",
94 .column_name = "UUID",
99 .column_name = "Path",
109 static btrfs_list_filter_func all_filter_funcs[];
110 static btrfs_list_comp_func all_comp_funcs[];
112 void btrfs_list_setup_print_column(enum btrfs_list_column_enum column)
116 ASSERT(0 <= column && column <= BTRFS_LIST_ALL);
118 if (column < BTRFS_LIST_ALL) {
119 btrfs_list_columns[column].need_print = 1;
123 for (i = 0; i < BTRFS_LIST_ALL; i++)
124 btrfs_list_columns[i].need_print = 1;
127 static int comp_entry_with_rootid(struct root_info *entry1,
128 struct root_info *entry2,
133 if (entry1->root_id > entry2->root_id)
135 else if (entry1->root_id < entry2->root_id)
140 return is_descending ? -ret : ret;
143 static int comp_entry_with_gen(struct root_info *entry1,
144 struct root_info *entry2,
149 if (entry1->gen > entry2->gen)
151 else if (entry1->gen < entry2->gen)
156 return is_descending ? -ret : ret;
159 static int comp_entry_with_ogen(struct root_info *entry1,
160 struct root_info *entry2,
165 if (entry1->ogen > entry2->ogen)
167 else if (entry1->ogen < entry2->ogen)
172 return is_descending ? -ret : ret;
175 static int comp_entry_with_path(struct root_info *entry1,
176 struct root_info *entry2,
181 if (strcmp(entry1->full_path, entry2->full_path) > 0)
183 else if (strcmp(entry1->full_path, entry2->full_path) < 0)
188 return is_descending ? -ret : ret;
191 static btrfs_list_comp_func all_comp_funcs[] = {
192 [BTRFS_LIST_COMP_ROOTID] = comp_entry_with_rootid,
193 [BTRFS_LIST_COMP_OGEN] = comp_entry_with_ogen,
194 [BTRFS_LIST_COMP_GEN] = comp_entry_with_gen,
195 [BTRFS_LIST_COMP_PATH] = comp_entry_with_path,
198 static char *all_sort_items[] = {
199 [BTRFS_LIST_COMP_ROOTID] = "rootid",
200 [BTRFS_LIST_COMP_OGEN] = "ogen",
201 [BTRFS_LIST_COMP_GEN] = "gen",
202 [BTRFS_LIST_COMP_PATH] = "path",
203 [BTRFS_LIST_COMP_MAX] = NULL,
206 static int btrfs_list_get_sort_item(char *sort_name)
210 for (i = 0; i < BTRFS_LIST_COMP_MAX; i++) {
211 if (strcmp(sort_name, all_sort_items[i]) == 0)
217 struct btrfs_list_comparer_set *btrfs_list_alloc_comparer_set(void)
219 struct btrfs_list_comparer_set *set;
222 size = sizeof(struct btrfs_list_comparer_set) +
223 BTRFS_LIST_NCOMPS_INCREASE * sizeof(struct btrfs_list_comparer);
224 set = calloc(1, size);
226 fprintf(stderr, "memory allocation failed\n");
230 set->total = BTRFS_LIST_NCOMPS_INCREASE;
235 static int btrfs_list_setup_comparer(struct btrfs_list_comparer_set **comp_set,
236 enum btrfs_list_comp_enum comparer, int is_descending)
238 struct btrfs_list_comparer_set *set = *comp_set;
242 ASSERT(comparer < BTRFS_LIST_COMP_MAX);
243 ASSERT(set->ncomps <= set->total);
245 if (set->ncomps == set->total) {
248 size = set->total + BTRFS_LIST_NCOMPS_INCREASE;
249 size = sizeof(*set) + size * sizeof(struct btrfs_list_comparer);
251 set = realloc(set, size);
253 fprintf(stderr, "memory allocation failed\n");
258 memset(&set->comps[set->total], 0,
259 BTRFS_LIST_NCOMPS_INCREASE *
260 sizeof(struct btrfs_list_comparer));
261 set->total += BTRFS_LIST_NCOMPS_INCREASE;
265 ASSERT(set->comps[set->ncomps].comp_func == NULL);
267 set->comps[set->ncomps].comp_func = all_comp_funcs[comparer];
268 set->comps[set->ncomps].is_descending = is_descending;
273 static int sort_comp(struct root_info *entry1, struct root_info *entry2,
274 struct btrfs_list_comparer_set *set)
276 int rootid_compared = 0;
279 if (!set || !set->ncomps)
282 for (i = 0; i < set->ncomps; i++) {
283 if (!set->comps[i].comp_func)
286 ret = set->comps[i].comp_func(entry1, entry2,
287 set->comps[i].is_descending);
291 if (set->comps[i].comp_func == comp_entry_with_rootid)
295 if (!rootid_compared) {
297 ret = comp_entry_with_rootid(entry1, entry2, 0);
303 static int sort_tree_insert(struct root_lookup *sort_tree,
304 struct root_info *ins,
305 struct btrfs_list_comparer_set *comp_set)
307 struct rb_node **p = &sort_tree->root.rb_node;
308 struct rb_node *parent = NULL;
309 struct root_info *curr;
314 curr = rb_entry(parent, struct root_info, sort_node);
316 ret = sort_comp(ins, curr, comp_set);
325 rb_link_node(&ins->sort_node, parent, p);
326 rb_insert_color(&ins->sort_node, &sort_tree->root);
331 * insert a new root into the tree. returns the existing root entry
332 * if one is already there. Both root_id and ref_tree are used
335 static int root_tree_insert(struct root_lookup *root_tree,
336 struct root_info *ins)
338 struct rb_node **p = &root_tree->root.rb_node;
339 struct rb_node * parent = NULL;
340 struct root_info *curr;
345 curr = rb_entry(parent, struct root_info, rb_node);
347 ret = comp_entry_with_rootid(ins, curr, 0);
356 rb_link_node(&ins->rb_node, parent, p);
357 rb_insert_color(&ins->rb_node, &root_tree->root);
362 * find a given root id in the tree. We return the smallest one,
363 * rb_next can be used to move forward looking for more if required
365 static struct root_info *root_tree_search(struct root_lookup *root_tree,
368 struct rb_node *n = root_tree->root.rb_node;
369 struct root_info *entry;
370 struct root_info tmp;
373 tmp.root_id = root_id;
376 entry = rb_entry(n, struct root_info, rb_node);
378 ret = comp_entry_with_rootid(&tmp, entry, 0);
389 static int update_root(struct root_lookup *root_lookup,
390 u64 root_id, u64 ref_tree, u64 root_offset, u64 flags,
391 u64 dir_id, char *name, int name_len, u64 ogen, u64 gen,
392 time_t otime, u8 *uuid, u8 *puuid, u8 *ruuid)
394 struct root_info *ri;
396 ri = root_tree_search(root_lookup, root_id);
397 if (!ri || ri->root_id != root_id)
399 if (name && name_len > 0) {
402 ri->name = malloc(name_len + 1);
404 fprintf(stderr, "memory allocation failed\n");
407 strncpy(ri->name, name, name_len);
408 ri->name[name_len] = 0;
411 ri->ref_tree = ref_tree;
413 ri->root_offset = root_offset;
422 if (!ri->ogen && root_offset)
423 ri->ogen = root_offset;
427 memcpy(&ri->uuid, uuid, BTRFS_UUID_SIZE);
429 memcpy(&ri->puuid, puuid, BTRFS_UUID_SIZE);
431 memcpy(&ri->ruuid, ruuid, BTRFS_UUID_SIZE);
437 * add_root - update the existed root, or allocate a new root and insert it
438 * into the lookup tree.
439 * root_id: object id of the root
440 * ref_tree: object id of the referring root.
441 * root_offset: offset value of the root'key
442 * dir_id: inode id of the directory in ref_tree where this root can be found.
443 * name: the name of root_id in that directory
444 * name_len: the length of name
445 * ogen: the original generation of the root
446 * gen: the current generation of the root
447 * otime: the original time (creation time) of the root
448 * uuid: uuid of the root
449 * puuid: uuid of the root parent if any
450 * ruuid: uuid of the received subvol, if any
452 static int add_root(struct root_lookup *root_lookup,
453 u64 root_id, u64 ref_tree, u64 root_offset, u64 flags,
454 u64 dir_id, char *name, int name_len, u64 ogen, u64 gen,
455 time_t otime, u8 *uuid, u8 *puuid, u8 *ruuid)
457 struct root_info *ri;
460 ret = update_root(root_lookup, root_id, ref_tree, root_offset, flags,
461 dir_id, name, name_len, ogen, gen, otime,
466 ri = calloc(1, sizeof(*ri));
468 printf("memory allocation failed\n");
471 ri->root_id = root_id;
473 if (name && name_len > 0) {
474 ri->name = malloc(name_len + 1);
476 fprintf(stderr, "memory allocation failed\n");
479 strncpy(ri->name, name, name_len);
480 ri->name[name_len] = 0;
483 ri->ref_tree = ref_tree;
487 ri->root_offset = root_offset;
494 if (!ri->ogen && root_offset)
495 ri->ogen = root_offset;
500 memcpy(&ri->uuid, uuid, BTRFS_UUID_SIZE);
503 memcpy(&ri->puuid, puuid, BTRFS_UUID_SIZE);
506 memcpy(&ri->ruuid, ruuid, BTRFS_UUID_SIZE);
508 ret = root_tree_insert(root_lookup, ri);
510 error("failed to insert tree %llu",
511 (unsigned long long)root_id);
518 * Simplified add_root for back references, omits the uuid and original info
519 * parameters, root offset and flags.
521 static int add_root_backref(struct root_lookup *root_lookup, u64 root_id,
522 u64 ref_tree, u64 dir_id, char *name, int name_len)
524 return add_root(root_lookup, root_id, ref_tree, 0, 0, dir_id, name,
525 name_len, 0, 0, 0, NULL, NULL, NULL);
529 static void free_root_info(struct rb_node *node)
531 struct root_info *ri;
533 ri = rb_entry(node, struct root_info, rb_node);
541 * for a given root_info, search through the root_lookup tree to construct
542 * the full path name to it.
544 * This can't be called until all the root_info->path fields are filled
545 * in by lookup_ino_path
547 static int resolve_root(struct root_lookup *rl, struct root_info *ri,
550 char *full_path = NULL;
552 struct root_info *found;
555 * we go backwards from the root_info object and add pathnames
556 * from parent directories as we go.
565 * ref_tree = 0 indicates the subvolume
568 if (!found->ref_tree) {
573 add_len = strlen(found->path);
576 /* room for / and for null */
577 tmp = malloc(add_len + 2 + len);
579 perror("malloc failed");
582 memcpy(tmp + add_len + 1, full_path, len);
584 memcpy(tmp, found->path, add_len);
585 tmp [add_len + len + 1] = '\0';
590 full_path = strdup(found->path);
594 ri->top_id = found->ref_tree;
596 next = found->ref_tree;
600 * if the ref_tree = BTRFS_FS_TREE_OBJECTID,
603 if (next == BTRFS_FS_TREE_OBJECTID)
606 * if the ref_tree wasn't in our tree of roots, the
607 * subvolume was deleted.
609 found = root_tree_search(rl, next);
616 ri->full_path = full_path;
622 * for a single root_info, ask the kernel to give us a path name
623 * inside it's ref_root for the dir_id where it lives.
625 * This fills in root_info->path with the path to the directory and and
626 * appends this root's name.
628 static int lookup_ino_path(int fd, struct root_info *ri)
630 struct btrfs_ioctl_ino_lookup_args args;
639 memset(&args, 0, sizeof(args));
640 args.treeid = ri->ref_tree;
641 args.objectid = ri->dir_id;
643 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
645 if (errno == ENOENT) {
649 error("failed to lookup path for root %llu: %s",
650 (unsigned long long)ri->ref_tree, strerror(errno));
656 * we're in a subdirectory of ref_tree, the kernel ioctl
657 * puts a / in there for us
659 ri->path = malloc(strlen(ri->name) + strlen(args.name) + 1);
661 perror("malloc failed");
664 strcpy(ri->path, args.name);
665 strcat(ri->path, ri->name);
667 /* we're at the root of ref_tree */
668 ri->path = strdup(ri->name);
670 perror("strdup failed");
677 /* finding the generation for a given path is a two step process.
678 * First we use the inode lookup routine to find out the root id
680 * Then we use the tree search ioctl to scan all the root items for a
681 * given root id and spit out the latest generation we can find
683 static u64 find_root_gen(int fd)
685 struct btrfs_ioctl_ino_lookup_args ino_args;
687 struct btrfs_ioctl_search_args args;
688 struct btrfs_ioctl_search_key *sk = &args.key;
689 struct btrfs_ioctl_search_header sh;
690 unsigned long off = 0;
694 memset(&ino_args, 0, sizeof(ino_args));
695 ino_args.objectid = BTRFS_FIRST_FREE_OBJECTID;
697 /* this ioctl fills in ino_args->treeid */
698 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &ino_args);
700 error("failed to lookup path for dirid %llu: %s",
701 (unsigned long long)BTRFS_FIRST_FREE_OBJECTID,
706 memset(&args, 0, sizeof(args));
708 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
711 * there may be more than one ROOT_ITEM key if there are
712 * snapshots pending deletion, we have to loop through
715 sk->min_objectid = ino_args.treeid;
716 sk->max_objectid = ino_args.treeid;
717 sk->max_type = BTRFS_ROOT_ITEM_KEY;
718 sk->min_type = BTRFS_ROOT_ITEM_KEY;
719 sk->max_offset = (u64)-1;
720 sk->max_transid = (u64)-1;
724 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
726 error("can't perform the search: %s", strerror(errno));
729 /* the ioctl returns the number of item it found in nr_items */
730 if (sk->nr_items == 0)
734 for (i = 0; i < sk->nr_items; i++) {
735 struct btrfs_root_item *item;
737 memcpy(&sh, args.buf + off, sizeof(sh));
739 item = (struct btrfs_root_item *)(args.buf + off);
742 sk->min_objectid = sh.objectid;
743 sk->min_type = sh.type;
744 sk->min_offset = sh.offset;
746 if (sh.objectid > ino_args.treeid)
749 if (sh.objectid == ino_args.treeid &&
750 sh.type == BTRFS_ROOT_ITEM_KEY) {
751 max_found = max(max_found,
752 btrfs_root_generation(item));
755 if (sk->min_offset < (u64)-1)
760 if (sk->min_type != BTRFS_ROOT_ITEM_KEY)
762 if (sk->min_objectid != ino_args.treeid)
768 /* pass in a directory id and this will return
769 * the full path of the parent directory inside its
772 * It may return NULL if it is in the root, or an ERR_PTR if things
775 static char *__ino_resolve(int fd, u64 dirid)
777 struct btrfs_ioctl_ino_lookup_args args;
781 memset(&args, 0, sizeof(args));
782 args.objectid = dirid;
784 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
786 error("failed to lookup path for dirid %llu: %s",
787 (unsigned long long)dirid, strerror(errno));
793 * we're in a subdirectory of ref_tree, the kernel ioctl
794 * puts a / in there for us
796 full = strdup(args.name);
798 perror("malloc failed");
799 return ERR_PTR(-ENOMEM);
802 /* we're at the root of ref_tree */
809 * simple string builder, returning a new string with both
812 static char *build_name(const char *dirid, const char *name)
819 full = malloc(strlen(dirid) + strlen(name) + 1);
828 * given an inode number, this returns the full path name inside the subvolume
829 * to that file/directory. cache_dirid and cache_name are used to
830 * cache the results so we can avoid tree searches if a later call goes
831 * to the same directory or file name
833 static char *ino_resolve(int fd, u64 ino, u64 *cache_dirid, char **cache_name)
841 struct btrfs_ioctl_search_args args;
842 struct btrfs_ioctl_search_key *sk = &args.key;
843 struct btrfs_ioctl_search_header *sh;
844 unsigned long off = 0;
847 memset(&args, 0, sizeof(args));
852 * step one, we search for the inode back ref. We just use the first
855 sk->min_objectid = ino;
856 sk->max_objectid = ino;
857 sk->max_type = BTRFS_INODE_REF_KEY;
858 sk->max_offset = (u64)-1;
859 sk->min_type = BTRFS_INODE_REF_KEY;
860 sk->max_transid = (u64)-1;
863 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
865 error("can't perform the search: %s", strerror(errno));
868 /* the ioctl returns the number of item it found in nr_items */
869 if (sk->nr_items == 0)
873 sh = (struct btrfs_ioctl_search_header *)(args.buf + off);
875 if (btrfs_search_header_type(sh) == BTRFS_INODE_REF_KEY) {
876 struct btrfs_inode_ref *ref;
877 dirid = btrfs_search_header_offset(sh);
879 ref = (struct btrfs_inode_ref *)(sh + 1);
880 namelen = btrfs_stack_inode_ref_name_len(ref);
882 name = (char *)(ref + 1);
883 name = strndup(name, namelen);
885 /* use our cached value */
886 if (dirid == *cache_dirid && *cache_name) {
887 dirname = *cache_name;
894 * the inode backref gives us the file name and the parent directory id.
895 * From here we use __ino_resolve to get the path to the parent
897 dirname = __ino_resolve(fd, dirid);
899 full = build_name(dirname, name);
900 if (*cache_name && dirname != *cache_name)
903 *cache_name = dirname;
904 *cache_dirid = dirid;
910 int btrfs_list_get_default_subvolume(int fd, u64 *default_id)
912 struct btrfs_ioctl_search_args args;
913 struct btrfs_ioctl_search_key *sk = &args.key;
914 struct btrfs_ioctl_search_header *sh;
918 memset(&args, 0, sizeof(args));
921 * search for a dir item with a name 'default' in the tree of
922 * tree roots, it should point us to a default root
924 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
926 /* don't worry about ancient format and request only one item */
929 sk->max_objectid = BTRFS_ROOT_TREE_DIR_OBJECTID;
930 sk->min_objectid = BTRFS_ROOT_TREE_DIR_OBJECTID;
931 sk->max_type = BTRFS_DIR_ITEM_KEY;
932 sk->min_type = BTRFS_DIR_ITEM_KEY;
933 sk->max_offset = (u64)-1;
934 sk->max_transid = (u64)-1;
936 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
940 /* the ioctl returns the number of items it found in nr_items */
941 if (sk->nr_items == 0)
944 sh = (struct btrfs_ioctl_search_header *)args.buf;
946 if (btrfs_search_header_type(sh) == BTRFS_DIR_ITEM_KEY) {
947 struct btrfs_dir_item *di;
951 di = (struct btrfs_dir_item *)(sh + 1);
952 name_len = btrfs_stack_dir_name_len(di);
953 name = (char *)(di + 1);
955 if (!strncmp("default", name, name_len))
956 found = btrfs_disk_key_objectid(&di->location);
964 static int list_subvol_search(int fd, struct root_lookup *root_lookup)
967 struct btrfs_ioctl_search_args args;
968 struct btrfs_ioctl_search_key *sk = &args.key;
969 struct btrfs_ioctl_search_header sh;
970 struct btrfs_root_ref *ref;
971 struct btrfs_root_item *ri;
981 root_lookup->root.rb_node = NULL;
982 memset(&args, 0, sizeof(args));
984 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
985 /* Search both live and deleted subvolumes */
986 sk->min_type = BTRFS_ROOT_ITEM_KEY;
987 sk->max_type = BTRFS_ROOT_BACKREF_KEY;
988 sk->min_objectid = BTRFS_FIRST_FREE_OBJECTID;
989 sk->max_objectid = BTRFS_LAST_FREE_OBJECTID;
990 sk->max_offset = (u64)-1;
991 sk->max_transid = (u64)-1;
995 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
998 if (sk->nr_items == 0)
1004 * for each item, pull the key out of the header and then
1005 * read the root_ref item it contains
1007 for (i = 0; i < sk->nr_items; i++) {
1008 memcpy(&sh, args.buf + off, sizeof(sh));
1010 if (sh.type == BTRFS_ROOT_BACKREF_KEY) {
1011 ref = (struct btrfs_root_ref *)(args.buf + off);
1012 name_len = btrfs_stack_root_ref_name_len(ref);
1013 name = (char *)(ref + 1);
1014 dir_id = btrfs_stack_root_ref_dirid(ref);
1016 add_root_backref(root_lookup, sh.objectid,
1017 sh.offset, dir_id, name,
1019 } else if (sh.type == BTRFS_ROOT_ITEM_KEY) {
1021 u8 uuid[BTRFS_UUID_SIZE];
1022 u8 puuid[BTRFS_UUID_SIZE];
1023 u8 ruuid[BTRFS_UUID_SIZE];
1025 ri = (struct btrfs_root_item *)(args.buf + off);
1026 gen = btrfs_root_generation(ri);
1027 flags = btrfs_root_flags(ri);
1029 sizeof(struct btrfs_root_item_v0)) {
1030 otime = btrfs_stack_timespec_sec(&ri->otime);
1031 ogen = btrfs_root_otransid(ri);
1032 memcpy(uuid, ri->uuid, BTRFS_UUID_SIZE);
1033 memcpy(puuid, ri->parent_uuid, BTRFS_UUID_SIZE);
1034 memcpy(ruuid, ri->received_uuid, BTRFS_UUID_SIZE);
1038 memset(uuid, 0, BTRFS_UUID_SIZE);
1039 memset(puuid, 0, BTRFS_UUID_SIZE);
1040 memset(ruuid, 0, BTRFS_UUID_SIZE);
1043 add_root(root_lookup, sh.objectid, 0,
1044 sh.offset, flags, 0, NULL, 0, ogen,
1045 gen, otime, uuid, puuid, ruuid);
1050 sk->min_objectid = sh.objectid;
1051 sk->min_type = sh.type;
1052 sk->min_offset = sh.offset;
1055 if (!sk->min_offset)
1060 if (sk->min_type > BTRFS_ROOT_BACKREF_KEY) {
1061 sk->min_type = BTRFS_ROOT_ITEM_KEY;
1066 if (sk->min_objectid > sk->max_objectid)
1073 static int filter_by_rootid(struct root_info *ri, u64 data)
1075 return ri->root_id == data;
1078 static int filter_snapshot(struct root_info *ri, u64 data)
1080 return !!ri->root_offset;
1083 static int filter_flags(struct root_info *ri, u64 flags)
1085 return ri->flags & flags;
1088 static int filter_gen_more(struct root_info *ri, u64 data)
1090 return ri->gen >= data;
1093 static int filter_gen_less(struct root_info *ri, u64 data)
1095 return ri->gen <= data;
1098 static int filter_gen_equal(struct root_info *ri, u64 data)
1100 return ri->gen == data;
1103 static int filter_cgen_more(struct root_info *ri, u64 data)
1105 return ri->ogen >= data;
1108 static int filter_cgen_less(struct root_info *ri, u64 data)
1110 return ri->ogen <= data;
1113 static int filter_cgen_equal(struct root_info *ri, u64 data)
1115 return ri->ogen == data;
1118 static int filter_topid_equal(struct root_info *ri, u64 data)
1120 return ri->top_id == data;
1123 static int filter_full_path(struct root_info *ri, u64 data)
1125 if (ri->full_path && ri->top_id != data) {
1127 char p[] = "<FS_TREE>";
1128 int add_len = strlen(p);
1129 int len = strlen(ri->full_path);
1131 tmp = malloc(len + add_len + 2);
1133 fprintf(stderr, "memory allocation failed\n");
1136 memcpy(tmp + add_len + 1, ri->full_path, len);
1137 tmp[len + add_len + 1] = '\0';
1139 memcpy(tmp, p, add_len);
1140 free(ri->full_path);
1141 ri->full_path = tmp;
1146 static int filter_by_parent(struct root_info *ri, u64 data)
1148 return !uuid_compare(ri->puuid, (u8 *)(unsigned long)data);
1151 static int filter_deleted(struct root_info *ri, u64 data)
1156 static btrfs_list_filter_func all_filter_funcs[] = {
1157 [BTRFS_LIST_FILTER_ROOTID] = filter_by_rootid,
1158 [BTRFS_LIST_FILTER_SNAPSHOT_ONLY] = filter_snapshot,
1159 [BTRFS_LIST_FILTER_FLAGS] = filter_flags,
1160 [BTRFS_LIST_FILTER_GEN_MORE] = filter_gen_more,
1161 [BTRFS_LIST_FILTER_GEN_LESS] = filter_gen_less,
1162 [BTRFS_LIST_FILTER_GEN_EQUAL] = filter_gen_equal,
1163 [BTRFS_LIST_FILTER_CGEN_MORE] = filter_cgen_more,
1164 [BTRFS_LIST_FILTER_CGEN_LESS] = filter_cgen_less,
1165 [BTRFS_LIST_FILTER_CGEN_EQUAL] = filter_cgen_equal,
1166 [BTRFS_LIST_FILTER_TOPID_EQUAL] = filter_topid_equal,
1167 [BTRFS_LIST_FILTER_FULL_PATH] = filter_full_path,
1168 [BTRFS_LIST_FILTER_BY_PARENT] = filter_by_parent,
1169 [BTRFS_LIST_FILTER_DELETED] = filter_deleted,
1172 struct btrfs_list_filter_set *btrfs_list_alloc_filter_set(void)
1174 struct btrfs_list_filter_set *set;
1177 size = sizeof(struct btrfs_list_filter_set) +
1178 BTRFS_LIST_NFILTERS_INCREASE * sizeof(struct btrfs_list_filter);
1179 set = calloc(1, size);
1181 fprintf(stderr, "memory allocation failed\n");
1185 set->total = BTRFS_LIST_NFILTERS_INCREASE;
1191 * Setup list filters. Exit if there's not enough memory, as we can't continue
1192 * without the structures set up properly.
1194 void btrfs_list_setup_filter(struct btrfs_list_filter_set **filter_set,
1195 enum btrfs_list_filter_enum filter, u64 data)
1197 struct btrfs_list_filter_set *set = *filter_set;
1200 ASSERT(set != NULL);
1201 ASSERT(filter < BTRFS_LIST_FILTER_MAX);
1202 ASSERT(set->nfilters <= set->total);
1204 if (set->nfilters == set->total) {
1207 size = set->total + BTRFS_LIST_NFILTERS_INCREASE;
1208 size = sizeof(*set) + size * sizeof(struct btrfs_list_filter);
1210 set = realloc(set, size);
1212 fprintf(stderr, "memory allocation failed\n");
1217 memset(&set->filters[set->total], 0,
1218 BTRFS_LIST_NFILTERS_INCREASE *
1219 sizeof(struct btrfs_list_filter));
1220 set->total += BTRFS_LIST_NFILTERS_INCREASE;
1224 ASSERT(set->filters[set->nfilters].filter_func == NULL);
1226 if (filter == BTRFS_LIST_FILTER_DELETED)
1227 set->only_deleted = 1;
1229 set->filters[set->nfilters].filter_func = all_filter_funcs[filter];
1230 set->filters[set->nfilters].data = data;
1234 static int filter_root(struct root_info *ri,
1235 struct btrfs_list_filter_set *set)
1242 if (set->only_deleted && !ri->deleted)
1245 if (!set->only_deleted && ri->deleted)
1248 for (i = 0; i < set->nfilters; i++) {
1249 if (!set->filters[i].filter_func)
1251 ret = set->filters[i].filter_func(ri, set->filters[i].data);
1258 static void filter_and_sort_subvol(struct root_lookup *all_subvols,
1259 struct root_lookup *sort_tree,
1260 struct btrfs_list_filter_set *filter_set,
1261 struct btrfs_list_comparer_set *comp_set,
1265 struct root_info *entry;
1268 sort_tree->root.rb_node = NULL;
1270 n = rb_last(&all_subvols->root);
1272 entry = rb_entry(n, struct root_info, rb_node);
1274 ret = resolve_root(all_subvols, entry, top_id);
1275 if (ret == -ENOENT) {
1276 entry->full_path = strdup("DELETED");
1279 ret = filter_root(entry, filter_set);
1281 sort_tree_insert(sort_tree, entry, comp_set);
1286 static int list_subvol_fill_paths(int fd, struct root_lookup *root_lookup)
1290 n = rb_first(&root_lookup->root);
1292 struct root_info *entry;
1294 entry = rb_entry(n, struct root_info, rb_node);
1295 ret = lookup_ino_path(fd, entry);
1296 if (ret && ret != -ENOENT)
1304 static void print_subvolume_column(struct root_info *subv,
1305 enum btrfs_list_column_enum column)
1308 char uuidparse[BTRFS_UUID_UNPARSED_SIZE];
1310 ASSERT(0 <= column && column < BTRFS_LIST_ALL);
1313 case BTRFS_LIST_OBJECTID:
1314 printf("%llu", subv->root_id);
1316 case BTRFS_LIST_GENERATION:
1317 printf("%llu", subv->gen);
1319 case BTRFS_LIST_OGENERATION:
1320 printf("%llu", subv->ogen);
1322 case BTRFS_LIST_PARENT:
1323 printf("%llu", subv->ref_tree);
1325 case BTRFS_LIST_TOP_LEVEL:
1326 printf("%llu", subv->top_id);
1328 case BTRFS_LIST_OTIME:
1332 localtime_r(&subv->otime, &tm);
1333 strftime(tstr, 256, "%Y-%m-%d %X", &tm);
1338 case BTRFS_LIST_UUID:
1339 if (uuid_is_null(subv->uuid))
1340 strcpy(uuidparse, "-");
1342 uuid_unparse(subv->uuid, uuidparse);
1343 printf("%s", uuidparse);
1345 case BTRFS_LIST_PUUID:
1346 if (uuid_is_null(subv->puuid))
1347 strcpy(uuidparse, "-");
1349 uuid_unparse(subv->puuid, uuidparse);
1350 printf("%s", uuidparse);
1352 case BTRFS_LIST_RUUID:
1353 if (uuid_is_null(subv->ruuid))
1354 strcpy(uuidparse, "-");
1356 uuid_unparse(subv->ruuid, uuidparse);
1357 printf("%s", uuidparse);
1359 case BTRFS_LIST_PATH:
1360 BUG_ON(!subv->full_path);
1361 printf("%s", subv->full_path);
1368 static void print_one_subvol_info_raw(struct root_info *subv,
1369 const char *raw_prefix)
1373 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1374 if (!btrfs_list_columns[i].need_print)
1378 printf("%s",raw_prefix);
1380 print_subvolume_column(subv, i);
1385 static void print_one_subvol_info_table(struct root_info *subv)
1389 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1390 if (!btrfs_list_columns[i].need_print)
1393 print_subvolume_column(subv, i);
1395 if (i != BTRFS_LIST_PATH)
1398 if (i == BTRFS_LIST_TOP_LEVEL)
1404 static void print_one_subvol_info_default(struct root_info *subv)
1408 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1409 if (!btrfs_list_columns[i].need_print)
1412 printf("%s ", btrfs_list_columns[i].name);
1413 print_subvolume_column(subv, i);
1415 if (i != BTRFS_LIST_PATH)
1421 static void print_all_subvol_info_tab_head(void)
1427 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1428 if (btrfs_list_columns[i].need_print)
1429 printf("%s\t", btrfs_list_columns[i].name);
1431 if (i == BTRFS_LIST_ALL-1)
1435 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1436 memset(barrier, 0, sizeof(barrier));
1438 if (btrfs_list_columns[i].need_print) {
1439 len = strlen(btrfs_list_columns[i].name);
1441 strcat(barrier, "-");
1443 printf("%s\t", barrier);
1445 if (i == BTRFS_LIST_ALL-1)
1450 static void print_all_subvol_info(struct root_lookup *sorted_tree,
1451 enum btrfs_list_layout layout, const char *raw_prefix)
1454 struct root_info *entry;
1456 if (layout == BTRFS_LIST_LAYOUT_TABLE)
1457 print_all_subvol_info_tab_head();
1459 n = rb_first(&sorted_tree->root);
1461 entry = rb_entry(n, struct root_info, sort_node);
1463 case BTRFS_LIST_LAYOUT_DEFAULT:
1464 print_one_subvol_info_default(entry);
1466 case BTRFS_LIST_LAYOUT_TABLE:
1467 print_one_subvol_info_table(entry);
1469 case BTRFS_LIST_LAYOUT_RAW:
1470 print_one_subvol_info_raw(entry, raw_prefix);
1477 static int btrfs_list_subvols(int fd, struct root_lookup *root_lookup)
1481 ret = list_subvol_search(fd, root_lookup);
1483 error("can't perform the search: %s", strerror(errno));
1488 * now we have an rbtree full of root_info objects, but we need to fill
1489 * in their path names within the subvol that is referencing each one.
1491 ret = list_subvol_fill_paths(fd, root_lookup);
1495 int btrfs_list_subvols_print(int fd, struct btrfs_list_filter_set *filter_set,
1496 struct btrfs_list_comparer_set *comp_set,
1497 enum btrfs_list_layout layout, int full_path,
1498 const char *raw_prefix)
1500 struct root_lookup root_lookup;
1501 struct root_lookup root_sort;
1506 ret = btrfs_list_get_path_rootid(fd, &top_id);
1510 ret = btrfs_list_subvols(fd, &root_lookup);
1513 filter_and_sort_subvol(&root_lookup, &root_sort, filter_set,
1516 print_all_subvol_info(&root_sort, layout, raw_prefix);
1517 rb_free_nodes(&root_lookup.root, free_root_info);
1522 static char *strdup_or_null(const char *s)
1529 int btrfs_get_subvol(int fd, struct root_info *the_ri)
1532 struct root_lookup rl;
1533 struct rb_node *rbn;
1534 struct root_info *ri;
1537 ret = btrfs_list_get_path_rootid(fd, &root_id);
1541 ret = btrfs_list_subvols(fd, &rl);
1545 rbn = rb_first(&rl.root);
1547 ri = rb_entry(rbn, struct root_info, rb_node);
1548 rr = resolve_root(&rl, ri, root_id);
1549 if (rr == -ENOENT) {
1554 if (!comp_entry_with_rootid(the_ri, ri, 0)) {
1555 memcpy(the_ri, ri, offsetof(struct root_info, path));
1556 the_ri->path = strdup_or_null(ri->path);
1557 the_ri->name = strdup_or_null(ri->name);
1558 the_ri->full_path = strdup_or_null(ri->full_path);
1564 rb_free_nodes(&rl.root, free_root_info);
1568 static int print_one_extent(int fd, struct btrfs_ioctl_search_header *sh,
1569 struct btrfs_file_extent_item *item,
1570 u64 found_gen, u64 *cache_dirid,
1571 char **cache_dir_name, u64 *cache_ino,
1572 char **cache_full_name)
1576 u64 disk_offset = 0;
1582 if (btrfs_search_header_objectid(sh) == *cache_ino) {
1583 name = *cache_full_name;
1584 } else if (*cache_full_name) {
1585 free(*cache_full_name);
1586 *cache_full_name = NULL;
1589 name = ino_resolve(fd, btrfs_search_header_objectid(sh),
1592 *cache_full_name = name;
1593 *cache_ino = btrfs_search_header_objectid(sh);
1598 type = btrfs_stack_file_extent_type(item);
1599 compressed = btrfs_stack_file_extent_compression(item);
1601 if (type == BTRFS_FILE_EXTENT_REG ||
1602 type == BTRFS_FILE_EXTENT_PREALLOC) {
1603 disk_start = btrfs_stack_file_extent_disk_bytenr(item);
1604 disk_offset = btrfs_stack_file_extent_offset(item);
1605 len = btrfs_stack_file_extent_num_bytes(item);
1606 } else if (type == BTRFS_FILE_EXTENT_INLINE) {
1609 len = btrfs_stack_file_extent_ram_bytes(item);
1612 "unhandled extent type %d for inode %llu file offset %llu gen %llu",
1614 (unsigned long long)btrfs_search_header_objectid(sh),
1615 (unsigned long long)btrfs_search_header_offset(sh),
1616 (unsigned long long)found_gen);
1620 printf("inode %llu file offset %llu len %llu disk start %llu "
1621 "offset %llu gen %llu flags ",
1622 (unsigned long long)btrfs_search_header_objectid(sh),
1623 (unsigned long long)btrfs_search_header_offset(sh),
1624 (unsigned long long)len,
1625 (unsigned long long)disk_start,
1626 (unsigned long long)disk_offset,
1627 (unsigned long long)found_gen);
1633 if (type == BTRFS_FILE_EXTENT_PREALLOC) {
1634 printf("%sPREALLOC", flags ? "|" : "");
1637 if (type == BTRFS_FILE_EXTENT_INLINE) {
1638 printf("%sINLINE", flags ? "|" : "");
1644 printf(" %s\n", name);
1648 int btrfs_list_find_updated_files(int fd, u64 root_id, u64 oldest_gen)
1651 struct btrfs_ioctl_search_args args;
1652 struct btrfs_ioctl_search_key *sk = &args.key;
1653 struct btrfs_ioctl_search_header sh;
1654 struct btrfs_file_extent_item *item;
1655 unsigned long off = 0;
1659 u64 cache_dirid = 0;
1661 char *cache_dir_name = NULL;
1662 char *cache_full_name = NULL;
1663 struct btrfs_file_extent_item backup;
1665 memset(&backup, 0, sizeof(backup));
1666 memset(&args, 0, sizeof(args));
1668 sk->tree_id = root_id;
1671 * set all the other params to the max, we'll take any objectid
1674 sk->max_objectid = (u64)-1;
1675 sk->max_offset = (u64)-1;
1676 sk->max_transid = (u64)-1;
1677 sk->max_type = BTRFS_EXTENT_DATA_KEY;
1678 sk->min_transid = oldest_gen;
1679 /* just a big number, doesn't matter much */
1680 sk->nr_items = 4096;
1682 max_found = find_root_gen(fd);
1684 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
1686 error("can't perform the search: %s", strerror(errno));
1689 /* the ioctl returns the number of item it found in nr_items */
1690 if (sk->nr_items == 0)
1696 * for each item, pull the key out of the header and then
1697 * read the root_ref item it contains
1699 for (i = 0; i < sk->nr_items; i++) {
1700 memcpy(&sh, args.buf + off, sizeof(sh));
1704 * just in case the item was too big, pass something other
1710 item = (struct btrfs_file_extent_item *)(args.buf +
1712 found_gen = btrfs_stack_file_extent_generation(item);
1713 if (sh.type == BTRFS_EXTENT_DATA_KEY &&
1714 found_gen >= oldest_gen) {
1715 print_one_extent(fd, &sh, item, found_gen,
1716 &cache_dirid, &cache_dir_name,
1717 &cache_ino, &cache_full_name);
1722 * record the mins in sk so we can make sure the
1723 * next search doesn't repeat this root
1725 sk->min_objectid = sh.objectid;
1726 sk->min_offset = sh.offset;
1727 sk->min_type = sh.type;
1729 sk->nr_items = 4096;
1730 if (sk->min_offset < (u64)-1)
1732 else if (sk->min_objectid < (u64)-1) {
1739 free(cache_dir_name);
1740 free(cache_full_name);
1741 printf("transid marker was %llu\n", (unsigned long long)max_found);
1745 char *btrfs_list_path_for_root(int fd, u64 root)
1747 struct root_lookup root_lookup;
1749 char *ret_path = NULL;
1753 ret = btrfs_list_get_path_rootid(fd, &top_id);
1755 return ERR_PTR(ret);
1757 ret = list_subvol_search(fd, &root_lookup);
1759 return ERR_PTR(ret);
1761 ret = list_subvol_fill_paths(fd, &root_lookup);
1763 return ERR_PTR(ret);
1765 n = rb_last(&root_lookup.root);
1767 struct root_info *entry;
1769 entry = rb_entry(n, struct root_info, rb_node);
1770 ret = resolve_root(&root_lookup, entry, top_id);
1771 if (ret == -ENOENT && entry->root_id == root) {
1775 if (entry->root_id == root) {
1776 ret_path = entry->full_path;
1777 entry->full_path = NULL;
1782 rb_free_nodes(&root_lookup.root, free_root_info);
1787 int btrfs_list_parse_sort_string(char *opt_arg,
1788 struct btrfs_list_comparer_set **comps)
1796 while ((p = strtok(opt_arg, ",")) != NULL) {
1798 ptr_argv = all_sort_items;
1801 if (strcmp(*ptr_argv, p) == 0) {
1806 if (strcmp(*ptr_argv, p) == 0) {
1823 } else if (*p == '-') {
1829 what_to_sort = btrfs_list_get_sort_item(p);
1830 btrfs_list_setup_comparer(comps, what_to_sort, order);
1839 * This function is used to parse the argument of filter condition.
1841 * type is the filter object.
1843 int btrfs_list_parse_filter_string(char *opt_arg,
1844 struct btrfs_list_filter_set **filters,
1845 enum btrfs_list_filter_enum type)
1850 switch (*(opt_arg++)) {
1852 arg = arg_strtou64(opt_arg);
1855 btrfs_list_setup_filter(filters, type, arg);
1858 arg = arg_strtou64(opt_arg);
1861 btrfs_list_setup_filter(filters, type, arg);
1865 arg = arg_strtou64(opt_arg);
1867 btrfs_list_setup_filter(filters, type, arg);
1874 int btrfs_list_get_path_rootid(int fd, u64 *treeid)
1878 ret = lookup_path_rootid(fd, treeid);
1880 error("cannot resolve rootid for path: %s",