2 * Copyright (C) 2012 Alexander Block. 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 <uuid/uuid.h>
27 #include "send-utils.h"
29 #include "btrfs-list.h"
31 static int btrfs_subvolid_resolve_sub(int fd, char *path, size_t *path_len,
34 static int btrfs_get_root_id_by_sub_path(int mnt_fd, const char *sub_path,
40 subvol_fd = openat(mnt_fd, sub_path, O_RDONLY);
43 fprintf(stderr, "ERROR: open %s failed. %s\n", sub_path,
48 ret = btrfs_list_get_path_rootid(subvol_fd, root_id);
53 static int btrfs_read_root_item_raw(int mnt_fd, u64 root_id, size_t buf_len,
54 u32 *read_len, void *buf)
57 struct btrfs_ioctl_search_args args;
58 struct btrfs_ioctl_search_key *sk = &args.key;
59 struct btrfs_ioctl_search_header *sh;
60 unsigned long off = 0;
65 memset(&args, 0, sizeof(args));
67 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
70 * there may be more than one ROOT_ITEM key if there are
71 * snapshots pending deletion, we have to loop through
74 sk->min_objectid = root_id;
75 sk->max_objectid = root_id;
76 sk->max_type = BTRFS_ROOT_ITEM_KEY;
77 sk->min_type = BTRFS_ROOT_ITEM_KEY;
78 sk->max_offset = (u64)-1;
79 sk->max_transid = (u64)-1;
83 ret = ioctl(mnt_fd, BTRFS_IOC_TREE_SEARCH, &args);
86 "ERROR: can't perform the search - %s\n",
90 /* the ioctl returns the number of item it found in nr_items */
91 if (sk->nr_items == 0)
95 for (i = 0; i < sk->nr_items; i++) {
96 struct btrfs_root_item *item;
97 sh = (struct btrfs_ioctl_search_header *)(args.buf +
101 item = (struct btrfs_root_item *)(args.buf + off);
102 off += btrfs_search_header_len(sh);
104 sk->min_objectid = btrfs_search_header_objectid(sh);
105 sk->min_type = btrfs_search_header_type(sh);
106 sk->min_offset = btrfs_search_header_offset(sh);
108 if (btrfs_search_header_objectid(sh) > root_id)
111 if (btrfs_search_header_objectid(sh) == root_id &&
112 btrfs_search_header_type(sh) == BTRFS_ROOT_ITEM_KEY) {
113 if (btrfs_search_header_len(sh) > buf_len) {
114 /* btrfs-progs is too old for kernel */
116 "ERROR: buf for read_root_item_raw() is too small, get newer btrfs tools!\n");
119 memcpy(buf, item, btrfs_search_header_len(sh));
120 *read_len = btrfs_search_header_len(sh);
124 if (sk->min_offset < (u64)-1)
129 if (sk->min_type != BTRFS_ROOT_ITEM_KEY ||
130 sk->min_objectid != root_id)
134 return found ? 0 : -ENOENT;
138 * Read a root item from the tree. In case we detect a root item smaller then
139 * sizeof(root_item), we know it's an old version of the root structure and
140 * initialize all new fields to zero. The same happens if we detect mismatching
141 * generation numbers as then we know the root was once mounted with an older
142 * kernel that was not aware of the root item structure change.
144 static int btrfs_read_root_item(int mnt_fd, u64 root_id,
145 struct btrfs_root_item *item)
150 ret = btrfs_read_root_item_raw(mnt_fd, root_id, sizeof(*item),
155 if (read_len < sizeof(*item) ||
156 btrfs_root_generation(item) != btrfs_root_generation_v2(item))
157 memset(&item->generation_v2, 0,
158 sizeof(*item) - offsetof(struct btrfs_root_item,
164 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
165 static struct rb_node *tree_insert(struct rb_root *root,
166 struct subvol_info *si,
167 enum subvol_search_type type)
169 struct rb_node **p = &root->rb_node;
170 struct rb_node *parent = NULL;
171 struct subvol_info *entry;
176 if (type == subvol_search_by_received_uuid) {
177 entry = rb_entry(parent, struct subvol_info,
180 comp = memcmp(entry->received_uuid, si->received_uuid,
183 if (entry->stransid < si->stransid)
185 else if (entry->stransid > si->stransid)
190 } else if (type == subvol_search_by_uuid) {
191 entry = rb_entry(parent, struct subvol_info,
193 comp = memcmp(entry->uuid, si->uuid, BTRFS_UUID_SIZE);
194 } else if (type == subvol_search_by_root_id) {
195 entry = rb_entry(parent, struct subvol_info,
197 comp = entry->root_id - si->root_id;
198 } else if (type == subvol_search_by_path) {
199 entry = rb_entry(parent, struct subvol_info,
201 comp = strcmp(entry->path, si->path);
214 if (type == subvol_search_by_received_uuid) {
215 rb_link_node(&si->rb_received_node, parent, p);
216 rb_insert_color(&si->rb_received_node, root);
217 } else if (type == subvol_search_by_uuid) {
218 rb_link_node(&si->rb_local_node, parent, p);
219 rb_insert_color(&si->rb_local_node, root);
220 } else if (type == subvol_search_by_root_id) {
221 rb_link_node(&si->rb_root_id_node, parent, p);
222 rb_insert_color(&si->rb_root_id_node, root);
223 } else if (type == subvol_search_by_path) {
224 rb_link_node(&si->rb_path_node, parent, p);
225 rb_insert_color(&si->rb_path_node, root);
231 int btrfs_subvolid_resolve(int fd, char *path, size_t path_len, u64 subvol_id)
237 path[path_len] = '\0';
238 return btrfs_subvolid_resolve_sub(fd, path, &path_len, subvol_id);
241 static int btrfs_subvolid_resolve_sub(int fd, char *path, size_t *path_len,
245 struct btrfs_ioctl_search_args search_arg;
246 struct btrfs_ioctl_ino_lookup_args ino_lookup_arg;
247 struct btrfs_ioctl_search_header *search_header;
248 struct btrfs_root_ref *backref_item;
250 if (subvol_id == BTRFS_FS_TREE_OBJECTID) {
258 memset(&search_arg, 0, sizeof(search_arg));
259 search_arg.key.tree_id = BTRFS_ROOT_TREE_OBJECTID;
260 search_arg.key.min_objectid = subvol_id;
261 search_arg.key.max_objectid = subvol_id;
262 search_arg.key.min_type = BTRFS_ROOT_BACKREF_KEY;
263 search_arg.key.max_type = BTRFS_ROOT_BACKREF_KEY;
264 search_arg.key.max_offset = (u64)-1;
265 search_arg.key.max_transid = (u64)-1;
266 search_arg.key.nr_items = 1;
267 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &search_arg);
270 "ioctl(BTRFS_IOC_TREE_SEARCH, subvol_id %llu) ret=%d, error: %s\n",
271 (unsigned long long)subvol_id, ret, strerror(errno));
275 if (search_arg.key.nr_items < 1) {
277 "failed to lookup subvol_id %llu!\n",
278 (unsigned long long)subvol_id);
281 search_header = (struct btrfs_ioctl_search_header *)search_arg.buf;
282 backref_item = (struct btrfs_root_ref *)(search_header + 1);
283 if (btrfs_search_header_offset(search_header)
284 != BTRFS_FS_TREE_OBJECTID) {
287 sub_ret = btrfs_subvolid_resolve_sub(fd, path, path_len,
288 btrfs_search_header_offset(search_header));
297 if (btrfs_stack_root_ref_dirid(backref_item) !=
298 BTRFS_FIRST_FREE_OBJECTID) {
301 memset(&ino_lookup_arg, 0, sizeof(ino_lookup_arg));
302 ino_lookup_arg.treeid =
303 btrfs_search_header_offset(search_header);
304 ino_lookup_arg.objectid =
305 btrfs_stack_root_ref_dirid(backref_item);
306 ret = ioctl(fd, BTRFS_IOC_INO_LOOKUP, &ino_lookup_arg);
309 "ioctl(BTRFS_IOC_INO_LOOKUP) ret=%d, error: %s\n",
310 ret, strerror(errno));
314 len = strlen(ino_lookup_arg.name);
317 strcat(path, ino_lookup_arg.name);
321 if (*path_len < btrfs_stack_root_ref_name_len(backref_item))
323 strncat(path, (char *)(backref_item + 1),
324 btrfs_stack_root_ref_name_len(backref_item));
325 (*path_len) -= btrfs_stack_root_ref_name_len(backref_item);
329 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
330 static int count_bytes(void *buf, int len, char b)
335 for (i = 0; i < len; i++) {
336 if (((char *)buf)[i] == b)
342 void subvol_uuid_search_add(struct subvol_uuid_search *s,
343 struct subvol_info *si)
347 tree_insert(&s->root_id_subvols, si, subvol_search_by_root_id);
348 tree_insert(&s->path_subvols, si, subvol_search_by_path);
350 cnt = count_bytes(si->uuid, BTRFS_UUID_SIZE, 0);
351 if (cnt != BTRFS_UUID_SIZE)
352 tree_insert(&s->local_subvols, si, subvol_search_by_uuid);
353 cnt = count_bytes(si->received_uuid, BTRFS_UUID_SIZE, 0);
354 if (cnt != BTRFS_UUID_SIZE)
355 tree_insert(&s->received_subvols, si,
356 subvol_search_by_received_uuid);
359 static struct subvol_info *tree_search(struct rb_root *root,
360 u64 root_id, const u8 *uuid,
361 u64 stransid, const char *path,
362 enum subvol_search_type type)
364 struct rb_node *n = root->rb_node;
365 struct subvol_info *entry;
369 if (type == subvol_search_by_received_uuid) {
370 entry = rb_entry(n, struct subvol_info,
372 comp = memcmp(entry->received_uuid, uuid,
375 if (entry->stransid < stransid)
377 else if (entry->stransid > stransid)
382 } else if (type == subvol_search_by_uuid) {
383 entry = rb_entry(n, struct subvol_info, rb_local_node);
384 comp = memcmp(entry->uuid, uuid, BTRFS_UUID_SIZE);
385 } else if (type == subvol_search_by_root_id) {
386 entry = rb_entry(n, struct subvol_info,
388 comp = entry->root_id - root_id;
389 } else if (type == subvol_search_by_path) {
390 entry = rb_entry(n, struct subvol_info, rb_path_node);
391 comp = strcmp(entry->path, path);
406 * this function will be only called if kernel doesn't support uuid tree.
408 static struct subvol_info *subvol_uuid_search_old(struct subvol_uuid_search *s,
409 u64 root_id, const u8 *uuid, u64 transid,
411 enum subvol_search_type type)
413 struct rb_root *root;
414 if (type == subvol_search_by_received_uuid)
415 root = &s->received_subvols;
416 else if (type == subvol_search_by_uuid)
417 root = &s->local_subvols;
418 else if (type == subvol_search_by_root_id)
419 root = &s->root_id_subvols;
420 else if (type == subvol_search_by_path)
421 root = &s->path_subvols;
424 return tree_search(root, root_id, uuid, transid, path, type);
427 void subvol_uuid_search_add(struct subvol_uuid_search *s,
428 struct subvol_info *si)
437 struct subvol_info *subvol_uuid_search(struct subvol_uuid_search *s,
438 u64 root_id, const u8 *uuid, u64 transid,
440 enum subvol_search_type type)
442 struct subvol_info *si;
444 si = subvol_uuid_search2(s, root_id, uuid, transid, path, type);
450 struct subvol_info *subvol_uuid_search2(struct subvol_uuid_search *s,
451 u64 root_id, const u8 *uuid, u64 transid,
453 enum subvol_search_type type)
456 struct btrfs_root_item root_item;
457 struct subvol_info *info = NULL;
459 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
460 if (!s->uuid_tree_existed)
461 return subvol_uuid_search_old(s, root_id, uuid, transid,
465 case subvol_search_by_received_uuid:
466 ret = btrfs_lookup_uuid_received_subvol_item(s->mnt_fd, uuid,
469 case subvol_search_by_uuid:
470 ret = btrfs_lookup_uuid_subvol_item(s->mnt_fd, uuid, &root_id);
472 case subvol_search_by_root_id:
474 case subvol_search_by_path:
475 ret = btrfs_get_root_id_by_sub_path(s->mnt_fd, path, &root_id);
485 ret = btrfs_read_root_item(s->mnt_fd, root_id, &root_item);
489 info = calloc(1, sizeof(*info));
494 info->root_id = root_id;
495 memcpy(info->uuid, root_item.uuid, BTRFS_UUID_SIZE);
496 memcpy(info->received_uuid, root_item.received_uuid, BTRFS_UUID_SIZE);
497 memcpy(info->parent_uuid, root_item.parent_uuid, BTRFS_UUID_SIZE);
498 info->ctransid = btrfs_root_ctransid(&root_item);
499 info->otransid = btrfs_root_otransid(&root_item);
500 info->stransid = btrfs_root_stransid(&root_item);
501 info->rtransid = btrfs_root_rtransid(&root_item);
502 if (type == subvol_search_by_path) {
503 info->path = strdup(path);
509 info->path = malloc(PATH_MAX);
514 ret = btrfs_subvolid_resolve(s->mnt_fd, info->path,
530 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
531 static int is_uuid_tree_supported(int fd)
534 struct btrfs_ioctl_search_args args;
535 struct btrfs_ioctl_search_key *sk = &args.key;
537 memset(&args, 0, sizeof(args));
539 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
541 sk->min_objectid = BTRFS_UUID_TREE_OBJECTID;
542 sk->max_objectid = BTRFS_UUID_TREE_OBJECTID;
543 sk->max_type = BTRFS_ROOT_ITEM_KEY;
544 sk->min_type = BTRFS_ROOT_ITEM_KEY;
545 sk->max_offset = (u64)-1;
546 sk->max_transid = (u64)-1;
549 ret = ioctl(fd, BTRFS_IOC_TREE_SEARCH, &args);
553 /* the ioctl returns the number of item it found in nr_items */
554 if (sk->nr_items == 0)
561 * this function is mainly used to read all root items
562 * it will be only used when we use older kernel which uuid
563 * tree is not supported yet
565 int subvol_uuid_search_init(int mnt_fd, struct subvol_uuid_search *s)
568 struct btrfs_ioctl_search_args args;
569 struct btrfs_ioctl_search_key *sk = &args.key;
570 struct btrfs_ioctl_search_header *sh;
571 struct btrfs_root_item *root_item_ptr;
572 struct btrfs_root_item root_item = {};
573 struct subvol_info *si = NULL;
574 int root_item_valid = 0;
575 unsigned long off = 0;
581 s->root_id_subvols = RB_ROOT;
582 s->local_subvols = RB_ROOT;
583 s->received_subvols = RB_ROOT;
584 s->path_subvols = RB_ROOT;
586 ret = is_uuid_tree_supported(mnt_fd);
589 "ERROR: check if we support uuid tree fails - %s\n",
593 /* uuid tree is supported */
594 s->uuid_tree_existed = 1;
597 memset(&args, 0, sizeof(args));
599 sk->tree_id = BTRFS_ROOT_TREE_OBJECTID;
601 sk->max_objectid = (u64)-1;
602 sk->max_offset = (u64)-1;
603 sk->max_transid = (u64)-1;
604 sk->min_type = BTRFS_ROOT_ITEM_KEY;
605 sk->max_type = BTRFS_ROOT_BACKREF_KEY;
609 ret = ioctl(mnt_fd, BTRFS_IOC_TREE_SEARCH, &args);
611 fprintf(stderr, "ERROR: can't perform the search - %s\n",
615 if (sk->nr_items == 0)
620 for (i = 0; i < sk->nr_items; i++) {
621 sh = (struct btrfs_ioctl_search_header *)(args.buf +
625 if ((btrfs_search_header_objectid(sh) != 5 &&
626 btrfs_search_header_objectid(sh)
627 < BTRFS_FIRST_FREE_OBJECTID) ||
628 btrfs_search_header_objectid(sh)
629 > BTRFS_LAST_FREE_OBJECTID) {
633 if (btrfs_search_header_type(sh)
634 == BTRFS_ROOT_ITEM_KEY) {
635 /* older kernels don't have uuids+times */
636 if (btrfs_search_header_len(sh)
637 < sizeof(root_item)) {
641 root_item_ptr = (struct btrfs_root_item *)
643 memcpy(&root_item, root_item_ptr,
646 } else if (btrfs_search_header_type(sh)
647 == BTRFS_ROOT_BACKREF_KEY ||
649 if (!root_item_valid)
652 path = btrfs_list_path_for_root(mnt_fd,
653 btrfs_search_header_objectid(sh));
658 fprintf(stderr, "ERROR: unable to "
661 btrfs_search_header_objectid(sh));
665 si = calloc(1, sizeof(*si));
666 si->root_id = btrfs_search_header_objectid(sh);
667 memcpy(si->uuid, root_item.uuid,
669 memcpy(si->parent_uuid, root_item.parent_uuid,
671 memcpy(si->received_uuid,
672 root_item.received_uuid,
674 si->ctransid = btrfs_root_ctransid(&root_item);
675 si->otransid = btrfs_root_otransid(&root_item);
676 si->stransid = btrfs_root_stransid(&root_item);
677 si->rtransid = btrfs_root_rtransid(&root_item);
679 subvol_uuid_search_add(s, si);
686 off += btrfs_search_header_len(sh);
689 * record the mins in sk so we can make sure the
690 * next search doesn't repeat this root
692 sk->min_objectid = btrfs_search_header_objectid(sh);
693 sk->min_offset = btrfs_search_header_offset(sh);
694 sk->min_type = btrfs_search_header_type(sh);
697 if (sk->min_offset < (u64)-1)
699 else if (sk->min_objectid < (u64)-1) {
711 void subvol_uuid_search_finit(struct subvol_uuid_search *s)
713 struct rb_root *root = &s->root_id_subvols;
714 struct rb_node *node;
716 if (!s->uuid_tree_existed)
719 while ((node = rb_first(root))) {
720 struct subvol_info *entry =
721 rb_entry(node, struct subvol_info, rb_root_id_node);
724 rb_erase(node, root);
728 s->root_id_subvols = RB_ROOT;
729 s->local_subvols = RB_ROOT;
730 s->received_subvols = RB_ROOT;
731 s->path_subvols = RB_ROOT;
734 int subvol_uuid_search_init(int mnt_fd, struct subvol_uuid_search *s)
741 void subvol_uuid_search_finit(struct subvol_uuid_search *s)
746 int path_cat_out(char *out, const char *p1, const char *p2)
748 int p1_len = strlen(p1);
749 int p2_len = strlen(p2);
751 if (p1_len + p2_len + 2 >= PATH_MAX)
752 return -ENAMETOOLONG;
754 if (p1_len && p1[p1_len - 1] == '/')
756 if (p2_len && p2[p2_len - 1] == '/')
758 sprintf(out, "%.*s/%.*s", p1_len, p1, p2_len, p2);
763 __attribute__((deprecated))
764 char *path_cat(const char *p1, const char *p2)
766 int p1_len = strlen(p1);
767 int p2_len = strlen(p2);
768 char *new = malloc(p1_len + p2_len + 2);
770 path_cat_out(new, p1, p2);
775 int path_cat3_out(char *out, const char *p1, const char *p2, const char *p3)
777 int p1_len = strlen(p1);
778 int p2_len = strlen(p2);
779 int p3_len = strlen(p3);
781 if (p1_len + p2_len + p3_len + 3 >= PATH_MAX)
782 return -ENAMETOOLONG;
784 if (p1_len && p1[p1_len - 1] == '/')
786 if (p2_len && p2[p2_len - 1] == '/')
788 if (p3_len && p3[p3_len - 1] == '/')
790 sprintf(out, "%.*s/%.*s/%.*s", p1_len, p1, p2_len, p2, p3_len, p3);
795 __attribute__((deprecated))
796 char *path_cat3(const char *p1, const char *p2, const char *p3)
798 int p1_len = strlen(p1);
799 int p2_len = strlen(p2);
800 int p3_len = strlen(p3);
801 char *new = malloc(p1_len + p2_len + p3_len + 3);
803 path_cat3_out(new, p1, p2, p3);