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 void root_lookup_init(struct root_lookup *tree)
129 tree->root.rb_node = NULL;
132 static int comp_entry_with_rootid(struct root_info *entry1,
133 struct root_info *entry2,
138 if (entry1->root_id > entry2->root_id)
140 else if (entry1->root_id < entry2->root_id)
145 return is_descending ? -ret : ret;
148 static int comp_entry_with_gen(struct root_info *entry1,
149 struct root_info *entry2,
154 if (entry1->gen > entry2->gen)
156 else if (entry1->gen < entry2->gen)
161 return is_descending ? -ret : ret;
164 static int comp_entry_with_ogen(struct root_info *entry1,
165 struct root_info *entry2,
170 if (entry1->ogen > entry2->ogen)
172 else if (entry1->ogen < entry2->ogen)
177 return is_descending ? -ret : ret;
180 static int comp_entry_with_path(struct root_info *entry1,
181 struct root_info *entry2,
186 if (strcmp(entry1->full_path, entry2->full_path) > 0)
188 else if (strcmp(entry1->full_path, entry2->full_path) < 0)
193 return is_descending ? -ret : ret;
196 static btrfs_list_comp_func all_comp_funcs[] = {
197 [BTRFS_LIST_COMP_ROOTID] = comp_entry_with_rootid,
198 [BTRFS_LIST_COMP_OGEN] = comp_entry_with_ogen,
199 [BTRFS_LIST_COMP_GEN] = comp_entry_with_gen,
200 [BTRFS_LIST_COMP_PATH] = comp_entry_with_path,
203 static char *all_sort_items[] = {
204 [BTRFS_LIST_COMP_ROOTID] = "rootid",
205 [BTRFS_LIST_COMP_OGEN] = "ogen",
206 [BTRFS_LIST_COMP_GEN] = "gen",
207 [BTRFS_LIST_COMP_PATH] = "path",
208 [BTRFS_LIST_COMP_MAX] = NULL,
211 static int btrfs_list_get_sort_item(char *sort_name)
215 for (i = 0; i < BTRFS_LIST_COMP_MAX; i++) {
216 if (strcmp(sort_name, all_sort_items[i]) == 0)
222 struct btrfs_list_comparer_set *btrfs_list_alloc_comparer_set(void)
224 struct btrfs_list_comparer_set *set;
227 size = sizeof(struct btrfs_list_comparer_set) +
228 BTRFS_LIST_NCOMPS_INCREASE * sizeof(struct btrfs_list_comparer);
229 set = calloc(1, size);
231 fprintf(stderr, "memory allocation failed\n");
235 set->total = BTRFS_LIST_NCOMPS_INCREASE;
240 static int btrfs_list_setup_comparer(struct btrfs_list_comparer_set **comp_set,
241 enum btrfs_list_comp_enum comparer, int is_descending)
243 struct btrfs_list_comparer_set *set = *comp_set;
247 ASSERT(comparer < BTRFS_LIST_COMP_MAX);
248 ASSERT(set->ncomps <= set->total);
250 if (set->ncomps == set->total) {
253 size = set->total + BTRFS_LIST_NCOMPS_INCREASE;
254 size = sizeof(*set) + size * sizeof(struct btrfs_list_comparer);
256 set = realloc(set, size);
258 fprintf(stderr, "memory allocation failed\n");
263 memset(&set->comps[set->total], 0,
264 BTRFS_LIST_NCOMPS_INCREASE *
265 sizeof(struct btrfs_list_comparer));
266 set->total += BTRFS_LIST_NCOMPS_INCREASE;
270 ASSERT(set->comps[set->ncomps].comp_func == NULL);
272 set->comps[set->ncomps].comp_func = all_comp_funcs[comparer];
273 set->comps[set->ncomps].is_descending = is_descending;
278 static int sort_comp(struct root_info *entry1, struct root_info *entry2,
279 struct btrfs_list_comparer_set *set)
281 int rootid_compared = 0;
284 if (!set || !set->ncomps)
287 for (i = 0; i < set->ncomps; i++) {
288 if (!set->comps[i].comp_func)
291 ret = set->comps[i].comp_func(entry1, entry2,
292 set->comps[i].is_descending);
296 if (set->comps[i].comp_func == comp_entry_with_rootid)
300 if (!rootid_compared) {
302 ret = comp_entry_with_rootid(entry1, entry2, 0);
308 static int sort_tree_insert(struct root_lookup *sort_tree,
309 struct root_info *ins,
310 struct btrfs_list_comparer_set *comp_set)
312 struct rb_node **p = &sort_tree->root.rb_node;
313 struct rb_node *parent = NULL;
314 struct root_info *curr;
319 curr = rb_entry(parent, struct root_info, sort_node);
321 ret = sort_comp(ins, curr, comp_set);
330 rb_link_node(&ins->sort_node, parent, p);
331 rb_insert_color(&ins->sort_node, &sort_tree->root);
336 * insert a new root into the tree. returns the existing root entry
337 * if one is already there. Both root_id and ref_tree are used
340 static int root_tree_insert(struct root_lookup *root_tree,
341 struct root_info *ins)
343 struct rb_node **p = &root_tree->root.rb_node;
344 struct rb_node * parent = NULL;
345 struct root_info *curr;
350 curr = rb_entry(parent, struct root_info, rb_node);
352 ret = comp_entry_with_rootid(ins, curr, 0);
361 rb_link_node(&ins->rb_node, parent, p);
362 rb_insert_color(&ins->rb_node, &root_tree->root);
367 * find a given root id in the tree. We return the smallest one,
368 * rb_next can be used to move forward looking for more if required
370 static struct root_info *root_tree_search(struct root_lookup *root_tree,
373 struct rb_node *n = root_tree->root.rb_node;
374 struct root_info *entry;
375 struct root_info tmp;
378 tmp.root_id = root_id;
381 entry = rb_entry(n, struct root_info, rb_node);
383 ret = comp_entry_with_rootid(&tmp, entry, 0);
394 static int update_root(struct root_lookup *root_lookup,
395 u64 root_id, u64 ref_tree, u64 root_offset, u64 flags,
396 u64 dir_id, char *name, int name_len, u64 ogen, u64 gen,
397 time_t ot, void *uuid, void *puuid, void *ruuid)
399 struct root_info *ri;
401 ri = root_tree_search(root_lookup, root_id);
402 if (!ri || ri->root_id != root_id)
404 if (name && name_len > 0) {
407 ri->name = malloc(name_len + 1);
409 fprintf(stderr, "memory allocation failed\n");
412 strncpy(ri->name, name, name_len);
413 ri->name[name_len] = 0;
416 ri->ref_tree = ref_tree;
418 ri->root_offset = root_offset;
427 if (!ri->ogen && root_offset)
428 ri->ogen = root_offset;
432 memcpy(&ri->uuid, uuid, BTRFS_UUID_SIZE);
434 memcpy(&ri->puuid, puuid, BTRFS_UUID_SIZE);
436 memcpy(&ri->ruuid, ruuid, BTRFS_UUID_SIZE);
442 * add_root - update the existed root, or allocate a new root and insert it
443 * into the lookup tree.
444 * root_id: object id of the root
445 * ref_tree: object id of the referring root.
446 * root_offset: offset value of the root'key
447 * dir_id: inode id of the directory in ref_tree where this root can be found.
448 * name: the name of root_id in that directory
449 * name_len: the length of name
450 * ogen: the original generation of the root
451 * gen: the current generation of the root
452 * ot: the original time(create time) of the root
453 * uuid: uuid of the root
454 * puuid: uuid of the root parent if any
455 * ruuid: uuid of the received subvol, if any
457 static int add_root(struct root_lookup *root_lookup,
458 u64 root_id, u64 ref_tree, u64 root_offset, u64 flags,
459 u64 dir_id, char *name, int name_len, u64 ogen, u64 gen,
460 time_t ot, void *uuid, void *puuid, void *ruuid)
462 struct root_info *ri;
465 ret = update_root(root_lookup, root_id, ref_tree, root_offset, flags,
466 dir_id, name, name_len, ogen, gen, ot,
471 ri = calloc(1, sizeof(*ri));
473 printf("memory allocation failed\n");
476 ri->root_id = root_id;
478 if (name && name_len > 0) {
479 ri->name = malloc(name_len + 1);
481 fprintf(stderr, "memory allocation failed\n");
484 strncpy(ri->name, name, name_len);
485 ri->name[name_len] = 0;
488 ri->ref_tree = ref_tree;
492 ri->root_offset = root_offset;
499 if (!ri->ogen && root_offset)
500 ri->ogen = root_offset;
505 memcpy(&ri->uuid, uuid, BTRFS_UUID_SIZE);
508 memcpy(&ri->puuid, puuid, BTRFS_UUID_SIZE);
511 memcpy(&ri->ruuid, ruuid, BTRFS_UUID_SIZE);
513 ret = root_tree_insert(root_lookup, ri);
515 error("failed to insert tree %llu",
516 (unsigned long long)root_id);
522 static void free_root_info(struct rb_node *node)
524 struct root_info *ri;
526 ri = rb_entry(node, struct root_info, rb_node);
534 * for a given root_info, search through the root_lookup tree to construct
535 * the full path name to it.
537 * This can't be called until all the root_info->path fields are filled
538 * in by lookup_ino_path
540 static int resolve_root(struct root_lookup *rl, struct root_info *ri,
543 char *full_path = NULL;
545 struct root_info *found;
548 * we go backwards from the root_info object and add pathnames
549 * from parent directories as we go.
558 * ref_tree = 0 indicates the subvolume
561 if (!found->ref_tree) {
566 add_len = strlen(found->path);
569 /* room for / and for null */
570 tmp = malloc(add_len + 2 + len);
572 perror("malloc failed");
575 memcpy(tmp + add_len + 1, full_path, len);
577 memcpy(tmp, found->path, add_len);
578 tmp [add_len + len + 1] = '\0';
583 full_path = strdup(found->path);
587 ri->top_id = found->ref_tree;
589 next = found->ref_tree;
593 * if the ref_tree = BTRFS_FS_TREE_OBJECTID,
596 if (next == BTRFS_FS_TREE_OBJECTID)
599 * if the ref_tree wasn't in our tree of roots, the
600 * subvolume was deleted.
602 found = root_tree_search(rl, next);
609 ri->full_path = full_path;
615 * for a single root_info, ask the kernel to give us a path name
616 * inside it's ref_root for the dir_id where it lives.
618 * This fills in root_info->path with the path to the directory and and
619 * appends this root's name.
621 static int lookup_ino_path(int fd, struct root_info *ri)
623 struct btrfs_ioctl_ino_lookup_args args;
632 memset(&args, 0, sizeof(args));
633 args.treeid = ri->ref_tree;
634 args.objectid = ri->dir_id;
636 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
638 if (errno == ENOENT) {
642 error("failed to lookup path for root %llu: %s",
643 (unsigned long long)ri->ref_tree, strerror(errno));
649 * we're in a subdirectory of ref_tree, the kernel ioctl
650 * puts a / in there for us
652 ri->path = malloc(strlen(ri->name) + strlen(args.name) + 1);
654 perror("malloc failed");
657 strcpy(ri->path, args.name);
658 strcat(ri->path, ri->name);
660 /* we're at the root of ref_tree */
661 ri->path = strdup(ri->name);
663 perror("strdup failed");
670 /* finding the generation for a given path is a two step process.
671 * First we use the inode lookup routine to find out the root id
673 * Then we use the tree search ioctl to scan all the root items for a
674 * given root id and spit out the latest generation we can find
676 static u64 find_root_gen(int fd)
678 struct btrfs_ioctl_ino_lookup_args ino_args;
680 struct btrfs_ioctl_search_args args;
681 struct btrfs_ioctl_search_key *sk = &args.key;
682 struct btrfs_ioctl_search_header sh;
683 unsigned long off = 0;
687 memset(&ino_args, 0, sizeof(ino_args));
688 ino_args.objectid = BTRFS_FIRST_FREE_OBJECTID;
690 /* this ioctl fills in ino_args->treeid */
691 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &ino_args);
693 error("failed to lookup path for dirid %llu: %s",
694 (unsigned long long)BTRFS_FIRST_FREE_OBJECTID,
699 memset(&args, 0, sizeof(args));
701 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
704 * there may be more than one ROOT_ITEM key if there are
705 * snapshots pending deletion, we have to loop through
708 sk->min_objectid = ino_args.treeid;
709 sk->max_objectid = ino_args.treeid;
710 sk->max_type = BTRFS_ROOT_ITEM_KEY;
711 sk->min_type = BTRFS_ROOT_ITEM_KEY;
712 sk->max_offset = (u64)-1;
713 sk->max_transid = (u64)-1;
717 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
719 error("can't perform the search: %s", strerror(errno));
722 /* the ioctl returns the number of item it found in nr_items */
723 if (sk->nr_items == 0)
727 for (i = 0; i < sk->nr_items; i++) {
728 struct btrfs_root_item *item;
730 memcpy(&sh, args.buf + off, sizeof(sh));
732 item = (struct btrfs_root_item *)(args.buf + off);
735 sk->min_objectid = sh.objectid;
736 sk->min_type = sh.type;
737 sk->min_offset = sh.offset;
739 if (sh.objectid > ino_args.treeid)
742 if (sh.objectid == ino_args.treeid &&
743 sh.type == BTRFS_ROOT_ITEM_KEY) {
744 max_found = max(max_found,
745 btrfs_root_generation(item));
748 if (sk->min_offset < (u64)-1)
753 if (sk->min_type != BTRFS_ROOT_ITEM_KEY)
755 if (sk->min_objectid != ino_args.treeid)
761 /* pass in a directory id and this will return
762 * the full path of the parent directory inside its
765 * It may return NULL if it is in the root, or an ERR_PTR if things
768 static char *__ino_resolve(int fd, u64 dirid)
770 struct btrfs_ioctl_ino_lookup_args args;
774 memset(&args, 0, sizeof(args));
775 args.objectid = dirid;
777 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &args);
779 error("failed to lookup path for dirid %llu: %s",
780 (unsigned long long)dirid, strerror(errno));
786 * we're in a subdirectory of ref_tree, the kernel ioctl
787 * puts a / in there for us
789 full = strdup(args.name);
791 perror("malloc failed");
792 return ERR_PTR(-ENOMEM);
795 /* we're at the root of ref_tree */
802 * simple string builder, returning a new string with both
805 static char *build_name(const char *dirid, const char *name)
812 full = malloc(strlen(dirid) + strlen(name) + 1);
821 * given an inode number, this returns the full path name inside the subvolume
822 * to that file/directory. cache_dirid and cache_name are used to
823 * cache the results so we can avoid tree searches if a later call goes
824 * to the same directory or file name
826 static char *ino_resolve(int fd, u64 ino, u64 *cache_dirid, char **cache_name)
834 struct btrfs_ioctl_search_args args;
835 struct btrfs_ioctl_search_key *sk = &args.key;
836 struct btrfs_ioctl_search_header *sh;
837 unsigned long off = 0;
840 memset(&args, 0, sizeof(args));
845 * step one, we search for the inode back ref. We just use the first
848 sk->min_objectid = ino;
849 sk->max_objectid = ino;
850 sk->max_type = BTRFS_INODE_REF_KEY;
851 sk->max_offset = (u64)-1;
852 sk->min_type = BTRFS_INODE_REF_KEY;
853 sk->max_transid = (u64)-1;
856 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
858 error("can't perform the search: %s", strerror(errno));
861 /* the ioctl returns the number of item it found in nr_items */
862 if (sk->nr_items == 0)
866 sh = (struct btrfs_ioctl_search_header *)(args.buf + off);
868 if (btrfs_search_header_type(sh) == BTRFS_INODE_REF_KEY) {
869 struct btrfs_inode_ref *ref;
870 dirid = btrfs_search_header_offset(sh);
872 ref = (struct btrfs_inode_ref *)(sh + 1);
873 namelen = btrfs_stack_inode_ref_name_len(ref);
875 name = (char *)(ref + 1);
876 name = strndup(name, namelen);
878 /* use our cached value */
879 if (dirid == *cache_dirid && *cache_name) {
880 dirname = *cache_name;
887 * the inode backref gives us the file name and the parent directory id.
888 * From here we use __ino_resolve to get the path to the parent
890 dirname = __ino_resolve(fd, dirid);
892 full = build_name(dirname, name);
893 if (*cache_name && dirname != *cache_name)
896 *cache_name = dirname;
897 *cache_dirid = dirid;
903 int btrfs_list_get_default_subvolume(int fd, u64 *default_id)
905 struct btrfs_ioctl_search_args args;
906 struct btrfs_ioctl_search_key *sk = &args.key;
907 struct btrfs_ioctl_search_header *sh;
911 memset(&args, 0, sizeof(args));
914 * search for a dir item with a name 'default' in the tree of
915 * tree roots, it should point us to a default root
917 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
919 /* don't worry about ancient format and request only one item */
922 sk->max_objectid = BTRFS_ROOT_TREE_DIR_OBJECTID;
923 sk->min_objectid = BTRFS_ROOT_TREE_DIR_OBJECTID;
924 sk->max_type = BTRFS_DIR_ITEM_KEY;
925 sk->min_type = BTRFS_DIR_ITEM_KEY;
926 sk->max_offset = (u64)-1;
927 sk->max_transid = (u64)-1;
929 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
933 /* the ioctl returns the number of items it found in nr_items */
934 if (sk->nr_items == 0)
937 sh = (struct btrfs_ioctl_search_header *)args.buf;
939 if (btrfs_search_header_type(sh) == BTRFS_DIR_ITEM_KEY) {
940 struct btrfs_dir_item *di;
944 di = (struct btrfs_dir_item *)(sh + 1);
945 name_len = btrfs_stack_dir_name_len(di);
946 name = (char *)(di + 1);
948 if (!strncmp("default", name, name_len))
949 found = btrfs_disk_key_objectid(&di->location);
957 static int list_subvol_search(int fd, struct root_lookup *root_lookup)
960 struct btrfs_ioctl_search_args args;
961 struct btrfs_ioctl_search_key *sk = &args.key;
962 struct btrfs_ioctl_search_header sh;
963 struct btrfs_root_ref *ref;
964 struct btrfs_root_item *ri;
965 unsigned long off = 0;
974 u8 uuid[BTRFS_UUID_SIZE];
975 u8 puuid[BTRFS_UUID_SIZE];
976 u8 ruuid[BTRFS_UUID_SIZE];
978 root_lookup_init(root_lookup);
979 memset(&args, 0, sizeof(args));
981 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
982 /* Search both live and deleted subvolumes */
983 sk->max_type = BTRFS_ROOT_BACKREF_KEY;
984 sk->min_type = BTRFS_ROOT_ITEM_KEY;
986 sk->min_objectid = BTRFS_FIRST_FREE_OBJECTID;
988 sk->max_objectid = BTRFS_LAST_FREE_OBJECTID;
989 sk->max_offset = (u64)-1;
990 sk->max_transid = (u64)-1;
994 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
997 if (sk->nr_items == 0)
1003 * for each item, pull the key out of the header and then
1004 * read the root_ref item it contains
1006 for (i = 0; i < sk->nr_items; i++) {
1007 memcpy(&sh, args.buf + off, sizeof(sh));
1009 if (sh.type == BTRFS_ROOT_BACKREF_KEY) {
1010 ref = (struct btrfs_root_ref *)(args.buf + off);
1011 name_len = btrfs_stack_root_ref_name_len(ref);
1012 name = (char *)(ref + 1);
1013 dir_id = btrfs_stack_root_ref_dirid(ref);
1015 add_root(root_lookup, sh.objectid, sh.offset,
1016 0, 0, dir_id, name, name_len, 0, 0, 0,
1018 } else if (sh.type == BTRFS_ROOT_ITEM_KEY) {
1019 ri = (struct btrfs_root_item *)(args.buf + off);
1020 gen = btrfs_root_generation(ri);
1021 flags = btrfs_root_flags(ri);
1023 sizeof(struct btrfs_root_item_v0)) {
1024 t = btrfs_stack_timespec_sec(&ri->otime);
1025 ogen = btrfs_root_otransid(ri);
1026 memcpy(uuid, ri->uuid, BTRFS_UUID_SIZE);
1027 memcpy(puuid, ri->parent_uuid, BTRFS_UUID_SIZE);
1028 memcpy(ruuid, ri->received_uuid, BTRFS_UUID_SIZE);
1032 memset(uuid, 0, BTRFS_UUID_SIZE);
1033 memset(puuid, 0, BTRFS_UUID_SIZE);
1034 memset(ruuid, 0, BTRFS_UUID_SIZE);
1037 add_root(root_lookup, sh.objectid, 0,
1038 sh.offset, flags, 0, NULL, 0, ogen,
1039 gen, t, uuid, puuid, ruuid);
1044 sk->min_objectid = sh.objectid;
1045 sk->min_type = sh.type;
1046 sk->min_offset = sh.offset;
1048 sk->nr_items = 4096;
1050 if (!sk->min_offset)
1055 if (sk->min_type > BTRFS_ROOT_BACKREF_KEY) {
1056 sk->min_type = BTRFS_ROOT_ITEM_KEY;
1061 if (sk->min_objectid > sk->max_objectid)
1068 static int filter_by_rootid(struct root_info *ri, u64 data)
1070 return ri->root_id == data;
1073 static int filter_snapshot(struct root_info *ri, u64 data)
1075 return !!ri->root_offset;
1078 static int filter_flags(struct root_info *ri, u64 flags)
1080 return ri->flags & flags;
1083 static int filter_gen_more(struct root_info *ri, u64 data)
1085 return ri->gen >= data;
1088 static int filter_gen_less(struct root_info *ri, u64 data)
1090 return ri->gen <= data;
1093 static int filter_gen_equal(struct root_info *ri, u64 data)
1095 return ri->gen == data;
1098 static int filter_cgen_more(struct root_info *ri, u64 data)
1100 return ri->ogen >= data;
1103 static int filter_cgen_less(struct root_info *ri, u64 data)
1105 return ri->ogen <= data;
1108 static int filter_cgen_equal(struct root_info *ri, u64 data)
1110 return ri->ogen == data;
1113 static int filter_topid_equal(struct root_info *ri, u64 data)
1115 return ri->top_id == data;
1118 static int filter_full_path(struct root_info *ri, u64 data)
1120 if (ri->full_path && ri->top_id != data) {
1122 char p[] = "<FS_TREE>";
1123 int add_len = strlen(p);
1124 int len = strlen(ri->full_path);
1126 tmp = malloc(len + add_len + 2);
1128 fprintf(stderr, "memory allocation failed\n");
1131 memcpy(tmp + add_len + 1, ri->full_path, len);
1132 tmp[len + add_len + 1] = '\0';
1134 memcpy(tmp, p, add_len);
1135 free(ri->full_path);
1136 ri->full_path = tmp;
1141 static int filter_by_parent(struct root_info *ri, u64 data)
1143 return !uuid_compare(ri->puuid, (u8 *)(unsigned long)data);
1146 static int filter_deleted(struct root_info *ri, u64 data)
1151 static btrfs_list_filter_func all_filter_funcs[] = {
1152 [BTRFS_LIST_FILTER_ROOTID] = filter_by_rootid,
1153 [BTRFS_LIST_FILTER_SNAPSHOT_ONLY] = filter_snapshot,
1154 [BTRFS_LIST_FILTER_FLAGS] = filter_flags,
1155 [BTRFS_LIST_FILTER_GEN_MORE] = filter_gen_more,
1156 [BTRFS_LIST_FILTER_GEN_LESS] = filter_gen_less,
1157 [BTRFS_LIST_FILTER_GEN_EQUAL] = filter_gen_equal,
1158 [BTRFS_LIST_FILTER_CGEN_MORE] = filter_cgen_more,
1159 [BTRFS_LIST_FILTER_CGEN_LESS] = filter_cgen_less,
1160 [BTRFS_LIST_FILTER_CGEN_EQUAL] = filter_cgen_equal,
1161 [BTRFS_LIST_FILTER_TOPID_EQUAL] = filter_topid_equal,
1162 [BTRFS_LIST_FILTER_FULL_PATH] = filter_full_path,
1163 [BTRFS_LIST_FILTER_BY_PARENT] = filter_by_parent,
1164 [BTRFS_LIST_FILTER_DELETED] = filter_deleted,
1167 struct btrfs_list_filter_set *btrfs_list_alloc_filter_set(void)
1169 struct btrfs_list_filter_set *set;
1172 size = sizeof(struct btrfs_list_filter_set) +
1173 BTRFS_LIST_NFILTERS_INCREASE * sizeof(struct btrfs_list_filter);
1174 set = calloc(1, size);
1176 fprintf(stderr, "memory allocation failed\n");
1180 set->total = BTRFS_LIST_NFILTERS_INCREASE;
1186 * Setup list filters. Exit if there's not enough memory, as we can't continue
1187 * without the structures set up properly.
1189 void btrfs_list_setup_filter(struct btrfs_list_filter_set **filter_set,
1190 enum btrfs_list_filter_enum filter, u64 data)
1192 struct btrfs_list_filter_set *set = *filter_set;
1195 ASSERT(set != NULL);
1196 ASSERT(filter < BTRFS_LIST_FILTER_MAX);
1197 ASSERT(set->nfilters <= set->total);
1199 if (set->nfilters == set->total) {
1202 size = set->total + BTRFS_LIST_NFILTERS_INCREASE;
1203 size = sizeof(*set) + size * sizeof(struct btrfs_list_filter);
1205 set = realloc(set, size);
1207 fprintf(stderr, "memory allocation failed\n");
1212 memset(&set->filters[set->total], 0,
1213 BTRFS_LIST_NFILTERS_INCREASE *
1214 sizeof(struct btrfs_list_filter));
1215 set->total += BTRFS_LIST_NFILTERS_INCREASE;
1219 ASSERT(set->filters[set->nfilters].filter_func == NULL);
1221 if (filter == BTRFS_LIST_FILTER_DELETED)
1222 set->only_deleted = 1;
1224 set->filters[set->nfilters].filter_func = all_filter_funcs[filter];
1225 set->filters[set->nfilters].data = data;
1229 static int filter_root(struct root_info *ri,
1230 struct btrfs_list_filter_set *set)
1237 if (set->only_deleted && !ri->deleted)
1240 if (!set->only_deleted && ri->deleted)
1243 for (i = 0; i < set->nfilters; i++) {
1244 if (!set->filters[i].filter_func)
1246 ret = set->filters[i].filter_func(ri, set->filters[i].data);
1253 static void filter_and_sort_subvol(struct root_lookup *all_subvols,
1254 struct root_lookup *sort_tree,
1255 struct btrfs_list_filter_set *filter_set,
1256 struct btrfs_list_comparer_set *comp_set,
1260 struct root_info *entry;
1263 root_lookup_init(sort_tree);
1265 n = rb_last(&all_subvols->root);
1267 entry = rb_entry(n, struct root_info, rb_node);
1269 ret = resolve_root(all_subvols, entry, top_id);
1270 if (ret == -ENOENT) {
1271 entry->full_path = strdup("DELETED");
1274 ret = filter_root(entry, filter_set);
1276 sort_tree_insert(sort_tree, entry, comp_set);
1281 static int list_subvol_fill_paths(int fd, struct root_lookup *root_lookup)
1285 n = rb_first(&root_lookup->root);
1287 struct root_info *entry;
1289 entry = rb_entry(n, struct root_info, rb_node);
1290 ret = lookup_ino_path(fd, entry);
1291 if (ret && ret != -ENOENT)
1299 static void print_subvolume_column(struct root_info *subv,
1300 enum btrfs_list_column_enum column)
1303 char uuidparse[BTRFS_UUID_UNPARSED_SIZE];
1305 ASSERT(0 <= column && column < BTRFS_LIST_ALL);
1308 case BTRFS_LIST_OBJECTID:
1309 printf("%llu", subv->root_id);
1311 case BTRFS_LIST_GENERATION:
1312 printf("%llu", subv->gen);
1314 case BTRFS_LIST_OGENERATION:
1315 printf("%llu", subv->ogen);
1317 case BTRFS_LIST_PARENT:
1318 printf("%llu", subv->ref_tree);
1320 case BTRFS_LIST_TOP_LEVEL:
1321 printf("%llu", subv->top_id);
1323 case BTRFS_LIST_OTIME:
1327 localtime_r(&subv->otime, &tm);
1328 strftime(tstr, 256, "%Y-%m-%d %X", &tm);
1333 case BTRFS_LIST_UUID:
1334 if (uuid_is_null(subv->uuid))
1335 strcpy(uuidparse, "-");
1337 uuid_unparse(subv->uuid, uuidparse);
1338 printf("%s", uuidparse);
1340 case BTRFS_LIST_PUUID:
1341 if (uuid_is_null(subv->puuid))
1342 strcpy(uuidparse, "-");
1344 uuid_unparse(subv->puuid, uuidparse);
1345 printf("%s", uuidparse);
1347 case BTRFS_LIST_RUUID:
1348 if (uuid_is_null(subv->ruuid))
1349 strcpy(uuidparse, "-");
1351 uuid_unparse(subv->ruuid, uuidparse);
1352 printf("%s", uuidparse);
1354 case BTRFS_LIST_PATH:
1355 BUG_ON(!subv->full_path);
1356 printf("%s", subv->full_path);
1363 static void print_one_subvol_info_raw(struct root_info *subv,
1364 const char *raw_prefix)
1368 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1369 if (!btrfs_list_columns[i].need_print)
1373 printf("%s",raw_prefix);
1375 print_subvolume_column(subv, i);
1380 static void print_one_subvol_info_table(struct root_info *subv)
1384 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1385 if (!btrfs_list_columns[i].need_print)
1388 print_subvolume_column(subv, i);
1390 if (i != BTRFS_LIST_PATH)
1393 if (i == BTRFS_LIST_TOP_LEVEL)
1399 static void print_one_subvol_info_default(struct root_info *subv)
1403 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1404 if (!btrfs_list_columns[i].need_print)
1407 printf("%s ", btrfs_list_columns[i].name);
1408 print_subvolume_column(subv, i);
1410 if (i != BTRFS_LIST_PATH)
1416 static void print_all_subvol_info_tab_head(void)
1422 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1423 if (btrfs_list_columns[i].need_print)
1424 printf("%s\t", btrfs_list_columns[i].name);
1426 if (i == BTRFS_LIST_ALL-1)
1430 for (i = 0; i < BTRFS_LIST_ALL; i++) {
1431 memset(barrier, 0, sizeof(barrier));
1433 if (btrfs_list_columns[i].need_print) {
1434 len = strlen(btrfs_list_columns[i].name);
1436 strcat(barrier, "-");
1438 printf("%s\t", barrier);
1440 if (i == BTRFS_LIST_ALL-1)
1445 static void print_all_subvol_info(struct root_lookup *sorted_tree,
1446 enum btrfs_list_layout layout, const char *raw_prefix)
1449 struct root_info *entry;
1451 if (layout == BTRFS_LIST_LAYOUT_TABLE)
1452 print_all_subvol_info_tab_head();
1454 n = rb_first(&sorted_tree->root);
1456 entry = rb_entry(n, struct root_info, sort_node);
1458 case BTRFS_LIST_LAYOUT_DEFAULT:
1459 print_one_subvol_info_default(entry);
1461 case BTRFS_LIST_LAYOUT_TABLE:
1462 print_one_subvol_info_table(entry);
1464 case BTRFS_LIST_LAYOUT_RAW:
1465 print_one_subvol_info_raw(entry, raw_prefix);
1472 static int btrfs_list_subvols(int fd, struct root_lookup *root_lookup)
1476 ret = list_subvol_search(fd, root_lookup);
1478 error("can't perform the search: %s", strerror(errno));
1483 * now we have an rbtree full of root_info objects, but we need to fill
1484 * in their path names within the subvol that is referencing each one.
1486 ret = list_subvol_fill_paths(fd, root_lookup);
1490 int btrfs_list_subvols_print(int fd, struct btrfs_list_filter_set *filter_set,
1491 struct btrfs_list_comparer_set *comp_set,
1492 enum btrfs_list_layout layout, int full_path,
1493 const char *raw_prefix)
1495 struct root_lookup root_lookup;
1496 struct root_lookup root_sort;
1501 ret = btrfs_list_get_path_rootid(fd, &top_id);
1505 ret = btrfs_list_subvols(fd, &root_lookup);
1508 filter_and_sort_subvol(&root_lookup, &root_sort, filter_set,
1511 print_all_subvol_info(&root_sort, layout, raw_prefix);
1512 rb_free_nodes(&root_lookup.root, free_root_info);
1517 static char *strdup_or_null(const char *s)
1524 int btrfs_get_subvol(int fd, struct root_info *the_ri)
1527 struct root_lookup rl;
1528 struct rb_node *rbn;
1529 struct root_info *ri;
1532 ret = btrfs_list_get_path_rootid(fd, &root_id);
1536 ret = btrfs_list_subvols(fd, &rl);
1540 rbn = rb_first(&rl.root);
1542 ri = rb_entry(rbn, struct root_info, rb_node);
1543 rr = resolve_root(&rl, ri, root_id);
1544 if (rr == -ENOENT) {
1549 if (!comp_entry_with_rootid(the_ri, ri, 0)) {
1550 memcpy(the_ri, ri, offsetof(struct root_info, path));
1551 the_ri->path = strdup_or_null(ri->path);
1552 the_ri->name = strdup_or_null(ri->name);
1553 the_ri->full_path = strdup_or_null(ri->full_path);
1559 rb_free_nodes(&rl.root, free_root_info);
1563 static int print_one_extent(int fd, struct btrfs_ioctl_search_header *sh,
1564 struct btrfs_file_extent_item *item,
1565 u64 found_gen, u64 *cache_dirid,
1566 char **cache_dir_name, u64 *cache_ino,
1567 char **cache_full_name)
1571 u64 disk_offset = 0;
1577 if (btrfs_search_header_objectid(sh) == *cache_ino) {
1578 name = *cache_full_name;
1579 } else if (*cache_full_name) {
1580 free(*cache_full_name);
1581 *cache_full_name = NULL;
1584 name = ino_resolve(fd, btrfs_search_header_objectid(sh),
1587 *cache_full_name = name;
1588 *cache_ino = btrfs_search_header_objectid(sh);
1593 type = btrfs_stack_file_extent_type(item);
1594 compressed = btrfs_stack_file_extent_compression(item);
1596 if (type == BTRFS_FILE_EXTENT_REG ||
1597 type == BTRFS_FILE_EXTENT_PREALLOC) {
1598 disk_start = btrfs_stack_file_extent_disk_bytenr(item);
1599 disk_offset = btrfs_stack_file_extent_offset(item);
1600 len = btrfs_stack_file_extent_num_bytes(item);
1601 } else if (type == BTRFS_FILE_EXTENT_INLINE) {
1604 len = btrfs_stack_file_extent_ram_bytes(item);
1607 "unhandled extent type %d for inode %llu file offset %llu gen %llu",
1609 (unsigned long long)btrfs_search_header_objectid(sh),
1610 (unsigned long long)btrfs_search_header_offset(sh),
1611 (unsigned long long)found_gen);
1615 printf("inode %llu file offset %llu len %llu disk start %llu "
1616 "offset %llu gen %llu flags ",
1617 (unsigned long long)btrfs_search_header_objectid(sh),
1618 (unsigned long long)btrfs_search_header_offset(sh),
1619 (unsigned long long)len,
1620 (unsigned long long)disk_start,
1621 (unsigned long long)disk_offset,
1622 (unsigned long long)found_gen);
1628 if (type == BTRFS_FILE_EXTENT_PREALLOC) {
1629 printf("%sPREALLOC", flags ? "|" : "");
1632 if (type == BTRFS_FILE_EXTENT_INLINE) {
1633 printf("%sINLINE", flags ? "|" : "");
1639 printf(" %s\n", name);
1643 int btrfs_list_find_updated_files(int fd, u64 root_id, u64 oldest_gen)
1646 struct btrfs_ioctl_search_args args;
1647 struct btrfs_ioctl_search_key *sk = &args.key;
1648 struct btrfs_ioctl_search_header sh;
1649 struct btrfs_file_extent_item *item;
1650 unsigned long off = 0;
1654 u64 cache_dirid = 0;
1656 char *cache_dir_name = NULL;
1657 char *cache_full_name = NULL;
1658 struct btrfs_file_extent_item backup;
1660 memset(&backup, 0, sizeof(backup));
1661 memset(&args, 0, sizeof(args));
1663 sk->tree_id = root_id;
1666 * set all the other params to the max, we'll take any objectid
1669 sk->max_objectid = (u64)-1;
1670 sk->max_offset = (u64)-1;
1671 sk->max_transid = (u64)-1;
1672 sk->max_type = BTRFS_EXTENT_DATA_KEY;
1673 sk->min_transid = oldest_gen;
1674 /* just a big number, doesn't matter much */
1675 sk->nr_items = 4096;
1677 max_found = find_root_gen(fd);
1679 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
1681 error("can't perform the search: %s", strerror(errno));
1684 /* the ioctl returns the number of item it found in nr_items */
1685 if (sk->nr_items == 0)
1691 * for each item, pull the key out of the header and then
1692 * read the root_ref item it contains
1694 for (i = 0; i < sk->nr_items; i++) {
1695 memcpy(&sh, args.buf + off, sizeof(sh));
1699 * just in case the item was too big, pass something other
1705 item = (struct btrfs_file_extent_item *)(args.buf +
1707 found_gen = btrfs_stack_file_extent_generation(item);
1708 if (sh.type == BTRFS_EXTENT_DATA_KEY &&
1709 found_gen >= oldest_gen) {
1710 print_one_extent(fd, &sh, item, found_gen,
1711 &cache_dirid, &cache_dir_name,
1712 &cache_ino, &cache_full_name);
1717 * record the mins in sk so we can make sure the
1718 * next search doesn't repeat this root
1720 sk->min_objectid = sh.objectid;
1721 sk->min_offset = sh.offset;
1722 sk->min_type = sh.type;
1724 sk->nr_items = 4096;
1725 if (sk->min_offset < (u64)-1)
1727 else if (sk->min_objectid < (u64)-1) {
1734 free(cache_dir_name);
1735 free(cache_full_name);
1736 printf("transid marker was %llu\n", (unsigned long long)max_found);
1740 char *btrfs_list_path_for_root(int fd, u64 root)
1742 struct root_lookup root_lookup;
1744 char *ret_path = NULL;
1748 ret = btrfs_list_get_path_rootid(fd, &top_id);
1750 return ERR_PTR(ret);
1752 ret = list_subvol_search(fd, &root_lookup);
1754 return ERR_PTR(ret);
1756 ret = list_subvol_fill_paths(fd, &root_lookup);
1758 return ERR_PTR(ret);
1760 n = rb_last(&root_lookup.root);
1762 struct root_info *entry;
1764 entry = rb_entry(n, struct root_info, rb_node);
1765 ret = resolve_root(&root_lookup, entry, top_id);
1766 if (ret == -ENOENT && entry->root_id == root) {
1770 if (entry->root_id == root) {
1771 ret_path = entry->full_path;
1772 entry->full_path = NULL;
1777 rb_free_nodes(&root_lookup.root, free_root_info);
1782 int btrfs_list_parse_sort_string(char *opt_arg,
1783 struct btrfs_list_comparer_set **comps)
1791 while ((p = strtok(opt_arg, ",")) != NULL) {
1793 ptr_argv = all_sort_items;
1796 if (strcmp(*ptr_argv, p) == 0) {
1801 if (strcmp(*ptr_argv, p) == 0) {
1818 } else if (*p == '-') {
1824 what_to_sort = btrfs_list_get_sort_item(p);
1825 btrfs_list_setup_comparer(comps, what_to_sort, order);
1834 * This function is used to parse the argument of filter condition.
1836 * type is the filter object.
1838 int btrfs_list_parse_filter_string(char *opt_arg,
1839 struct btrfs_list_filter_set **filters,
1840 enum btrfs_list_filter_enum type)
1845 switch (*(opt_arg++)) {
1847 arg = arg_strtou64(opt_arg);
1850 btrfs_list_setup_filter(filters, type, arg);
1853 arg = arg_strtou64(opt_arg);
1856 btrfs_list_setup_filter(filters, type, arg);
1860 arg = arg_strtou64(opt_arg);
1862 btrfs_list_setup_filter(filters, type, arg);
1869 int btrfs_list_get_path_rootid(int fd, u64 *treeid)
1873 ret = lookup_path_rootid(fd, treeid);
1875 error("cannot resolve rootid for path: %s",