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
);
104 sk
->min_objectid
= sh
->objectid
;
105 sk
->min_type
= sh
->type
;
106 sk
->min_offset
= sh
->offset
;
108 if (sh
->objectid
> root_id
)
111 if (sh
->objectid
== root_id
&&
112 sh
->type
== BTRFS_ROOT_ITEM_KEY
) {
113 if (sh
->len
> 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
, sh
->len
);
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 (search_header
->offset
!= BTRFS_FS_TREE_OBJECTID
) {
286 sub_ret
= btrfs_subvolid_resolve_sub(fd
, path
, path_len
,
287 search_header
->offset
);
296 if (btrfs_stack_root_ref_dirid(backref_item
) !=
297 BTRFS_FIRST_FREE_OBJECTID
) {
300 memset(&ino_lookup_arg
, 0, sizeof(ino_lookup_arg
));
301 ino_lookup_arg
.treeid
= search_header
->offset
;
302 ino_lookup_arg
.objectid
=
303 btrfs_stack_root_ref_dirid(backref_item
);
304 ret
= ioctl(fd
, BTRFS_IOC_INO_LOOKUP
, &ino_lookup_arg
);
307 "ioctl(BTRFS_IOC_INO_LOOKUP) ret=%d, error: %s\n",
308 ret
, strerror(errno
));
312 len
= strlen(ino_lookup_arg
.name
);
315 strcat(path
, ino_lookup_arg
.name
);
319 if (*path_len
< btrfs_stack_root_ref_name_len(backref_item
))
321 strncat(path
, (char *)(backref_item
+ 1),
322 btrfs_stack_root_ref_name_len(backref_item
));
323 (*path_len
) -= btrfs_stack_root_ref_name_len(backref_item
);
327 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
328 static int count_bytes(void *buf
, int len
, char b
)
333 for (i
= 0; i
< len
; i
++) {
334 if (((char *)buf
)[i
] == b
)
340 void subvol_uuid_search_add(struct subvol_uuid_search
*s
,
341 struct subvol_info
*si
)
345 tree_insert(&s
->root_id_subvols
, si
, subvol_search_by_root_id
);
346 tree_insert(&s
->path_subvols
, si
, subvol_search_by_path
);
348 cnt
= count_bytes(si
->uuid
, BTRFS_UUID_SIZE
, 0);
349 if (cnt
!= BTRFS_UUID_SIZE
)
350 tree_insert(&s
->local_subvols
, si
, subvol_search_by_uuid
);
351 cnt
= count_bytes(si
->received_uuid
, BTRFS_UUID_SIZE
, 0);
352 if (cnt
!= BTRFS_UUID_SIZE
)
353 tree_insert(&s
->received_subvols
, si
,
354 subvol_search_by_received_uuid
);
357 static struct subvol_info
*tree_search(struct rb_root
*root
,
358 u64 root_id
, const u8
*uuid
,
359 u64 stransid
, const char *path
,
360 enum subvol_search_type type
)
362 struct rb_node
*n
= root
->rb_node
;
363 struct subvol_info
*entry
;
367 if (type
== subvol_search_by_received_uuid
) {
368 entry
= rb_entry(n
, struct subvol_info
,
370 comp
= memcmp(entry
->received_uuid
, uuid
,
373 if (entry
->stransid
< stransid
)
375 else if (entry
->stransid
> stransid
)
380 } else if (type
== subvol_search_by_uuid
) {
381 entry
= rb_entry(n
, struct subvol_info
, rb_local_node
);
382 comp
= memcmp(entry
->uuid
, uuid
, BTRFS_UUID_SIZE
);
383 } else if (type
== subvol_search_by_root_id
) {
384 entry
= rb_entry(n
, struct subvol_info
,
386 comp
= entry
->root_id
- root_id
;
387 } else if (type
== subvol_search_by_path
) {
388 entry
= rb_entry(n
, struct subvol_info
, rb_path_node
);
389 comp
= strcmp(entry
->path
, path
);
404 * this function will be only called if kernel dosen't support uuid tree.
406 static struct subvol_info
*subvol_uuid_search_old(struct subvol_uuid_search
*s
,
407 u64 root_id
, const u8
*uuid
, u64 transid
,
409 enum subvol_search_type type
)
411 struct rb_root
*root
;
412 if (type
== subvol_search_by_received_uuid
)
413 root
= &s
->received_subvols
;
414 else if (type
== subvol_search_by_uuid
)
415 root
= &s
->local_subvols
;
416 else if (type
== subvol_search_by_root_id
)
417 root
= &s
->root_id_subvols
;
418 else if (type
== subvol_search_by_path
)
419 root
= &s
->path_subvols
;
422 return tree_search(root
, root_id
, uuid
, transid
, path
, type
);
425 void subvol_uuid_search_add(struct subvol_uuid_search
*s
,
426 struct subvol_info
*si
)
435 struct subvol_info
*subvol_uuid_search(struct subvol_uuid_search
*s
,
436 u64 root_id
, const u8
*uuid
, u64 transid
,
438 enum subvol_search_type type
)
441 struct btrfs_root_item root_item
;
442 struct subvol_info
*info
= NULL
;
444 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
445 if (!s
->uuid_tree_existed
)
446 return subvol_uuid_search_old(s
, root_id
, uuid
, transid
,
450 case subvol_search_by_received_uuid
:
451 ret
= btrfs_lookup_uuid_received_subvol_item(s
->mnt_fd
, uuid
,
454 case subvol_search_by_uuid
:
455 ret
= btrfs_lookup_uuid_subvol_item(s
->mnt_fd
, uuid
, &root_id
);
457 case subvol_search_by_root_id
:
459 case subvol_search_by_path
:
460 ret
= btrfs_get_root_id_by_sub_path(s
->mnt_fd
, path
, &root_id
);
470 ret
= btrfs_read_root_item(s
->mnt_fd
, root_id
, &root_item
);
474 info
= calloc(1, sizeof(*info
));
475 info
->root_id
= root_id
;
476 memcpy(info
->uuid
, root_item
.uuid
, BTRFS_UUID_SIZE
);
477 memcpy(info
->received_uuid
, root_item
.received_uuid
, BTRFS_UUID_SIZE
);
478 memcpy(info
->parent_uuid
, root_item
.parent_uuid
, BTRFS_UUID_SIZE
);
479 info
->ctransid
= btrfs_root_ctransid(&root_item
);
480 info
->otransid
= btrfs_root_otransid(&root_item
);
481 info
->stransid
= btrfs_root_stransid(&root_item
);
482 info
->rtransid
= btrfs_root_rtransid(&root_item
);
483 if (type
== subvol_search_by_path
) {
484 info
->path
= strdup(path
);
486 info
->path
= malloc(PATH_MAX
);
487 ret
= btrfs_subvolid_resolve(s
->mnt_fd
, info
->path
,
501 #ifdef BTRFS_COMPAT_SEND_NO_UUID_TREE
502 static int is_uuid_tree_supported(int fd
)
505 struct btrfs_ioctl_search_args args
;
506 struct btrfs_ioctl_search_key
*sk
= &args
.key
;
508 memset(&args
, 0, sizeof(args
));
510 sk
->tree_id
= BTRFS_ROOT_TREE_OBJECTID
;
512 sk
->min_objectid
= BTRFS_UUID_TREE_OBJECTID
;
513 sk
->max_objectid
= BTRFS_UUID_TREE_OBJECTID
;
514 sk
->max_type
= BTRFS_ROOT_ITEM_KEY
;
515 sk
->min_type
= BTRFS_ROOT_ITEM_KEY
;
516 sk
->max_offset
= (u64
)-1;
517 sk
->max_transid
= (u64
)-1;
520 ret
= ioctl(fd
, BTRFS_IOC_TREE_SEARCH
, &args
);
524 /* the ioctl returns the number of item it found in nr_items */
525 if (sk
->nr_items
== 0)
532 * this function is mainly used to read all root items
533 * it will be only used when we use older kernel which uuid
534 * tree is not supported yet
536 int subvol_uuid_search_init(int mnt_fd
, struct subvol_uuid_search
*s
)
539 struct btrfs_ioctl_search_args args
;
540 struct btrfs_ioctl_search_key
*sk
= &args
.key
;
541 struct btrfs_ioctl_search_header
*sh
;
542 struct btrfs_root_item
*root_item_ptr
;
543 struct btrfs_root_item root_item
= {};
544 struct subvol_info
*si
= NULL
;
545 int root_item_valid
= 0;
546 unsigned long off
= 0;
553 s
->root_id_subvols
= RB_ROOT
;
554 s
->local_subvols
= RB_ROOT
;
555 s
->received_subvols
= RB_ROOT
;
556 s
->path_subvols
= RB_ROOT
;
558 ret
= is_uuid_tree_supported(mnt_fd
);
561 "ERROR: check if we support uuid tree fails - %s\n",
565 /* uuid tree is supported */
566 s
->uuid_tree_existed
= 1;
569 memset(&args
, 0, sizeof(args
));
571 sk
->tree_id
= BTRFS_ROOT_TREE_OBJECTID
;
573 sk
->max_objectid
= (u64
)-1;
574 sk
->max_offset
= (u64
)-1;
575 sk
->max_transid
= (u64
)-1;
576 sk
->min_type
= BTRFS_ROOT_ITEM_KEY
;
577 sk
->max_type
= BTRFS_ROOT_BACKREF_KEY
;
581 ret
= ioctl(mnt_fd
, BTRFS_IOC_TREE_SEARCH
, &args
);
584 fprintf(stderr
, "ERROR: can't perform the search - %s\n",
588 if (sk
->nr_items
== 0)
593 for (i
= 0; i
< sk
->nr_items
; i
++) {
594 sh
= (struct btrfs_ioctl_search_header
*)(args
.buf
+
598 if ((sh
->objectid
!= 5 &&
599 sh
->objectid
< BTRFS_FIRST_FREE_OBJECTID
) ||
600 sh
->objectid
> BTRFS_LAST_FREE_OBJECTID
)
603 if (sh
->type
== BTRFS_ROOT_ITEM_KEY
) {
604 /* older kernels don't have uuids+times */
605 if (sh
->len
< sizeof(root_item
)) {
609 root_item_ptr
= (struct btrfs_root_item
*)
611 memcpy(&root_item
, root_item_ptr
,
614 } else if (sh
->type
== BTRFS_ROOT_BACKREF_KEY
||
616 if (!root_item_valid
)
619 path
= btrfs_list_path_for_root(mnt_fd
,
625 fprintf(stderr
, "ERROR: unable to "
632 si
= calloc(1, sizeof(*si
));
633 si
->root_id
= sh
->objectid
;
634 memcpy(si
->uuid
, root_item
.uuid
,
636 memcpy(si
->parent_uuid
, root_item
.parent_uuid
,
638 memcpy(si
->received_uuid
,
639 root_item
.received_uuid
,
641 si
->ctransid
= btrfs_root_ctransid(&root_item
);
642 si
->otransid
= btrfs_root_otransid(&root_item
);
643 si
->stransid
= btrfs_root_stransid(&root_item
);
644 si
->rtransid
= btrfs_root_rtransid(&root_item
);
646 subvol_uuid_search_add(s
, si
);
656 * record the mins in sk so we can make sure the
657 * next search doesn't repeat this root
659 sk
->min_objectid
= sh
->objectid
;
660 sk
->min_offset
= sh
->offset
;
661 sk
->min_type
= sh
->type
;
664 if (sk
->min_offset
< (u64
)-1)
666 else if (sk
->min_objectid
< (u64
)-1) {
678 void subvol_uuid_search_finit(struct subvol_uuid_search
*s
)
680 struct rb_root
*root
= &s
->root_id_subvols
;
681 struct rb_node
*node
;
683 if (!s
->uuid_tree_existed
)
686 while ((node
= rb_first(root
))) {
687 struct subvol_info
*entry
=
688 rb_entry(node
, struct subvol_info
, rb_root_id_node
);
691 rb_erase(node
, root
);
695 s
->root_id_subvols
= RB_ROOT
;
696 s
->local_subvols
= RB_ROOT
;
697 s
->received_subvols
= RB_ROOT
;
698 s
->path_subvols
= RB_ROOT
;
701 int subvol_uuid_search_init(int mnt_fd
, struct subvol_uuid_search
*s
)
708 void subvol_uuid_search_finit(struct subvol_uuid_search
*s
)
713 int path_cat_out(char *out
, const char *p1
, const char *p2
)
715 int p1_len
= strlen(p1
);
716 int p2_len
= strlen(p2
);
718 if (p1_len
+ p2_len
+ 2 >= PATH_MAX
)
719 return -ENAMETOOLONG
;
721 if (p1_len
&& p1
[p1_len
- 1] == '/')
723 if (p2_len
&& p2
[p2_len
- 1] == '/')
725 sprintf(out
, "%.*s/%.*s", p1_len
, p1
, p2_len
, p2
);
730 __attribute__((deprecated
))
731 char *path_cat(const char *p1
, const char *p2
)
733 int p1_len
= strlen(p1
);
734 int p2_len
= strlen(p2
);
735 char *new = malloc(p1_len
+ p2_len
+ 2);
737 path_cat_out(new, p1
, p2
);
742 int path_cat3_out(char *out
, const char *p1
, const char *p2
, const char *p3
)
744 int p1_len
= strlen(p1
);
745 int p2_len
= strlen(p2
);
746 int p3_len
= strlen(p3
);
748 if (p1_len
+ p2_len
+ p3_len
+ 3 >= PATH_MAX
)
749 return -ENAMETOOLONG
;
751 if (p1_len
&& p1
[p1_len
- 1] == '/')
753 if (p2_len
&& p2
[p2_len
- 1] == '/')
755 if (p3_len
&& p3
[p3_len
- 1] == '/')
757 sprintf(out
, "%.*s/%.*s/%.*s", p1_len
, p1
, p2_len
, p2
, p3_len
, p3
);
762 __attribute__((deprecated
))
763 char *path_cat3(const char *p1
, const char *p2
, const char *p3
)
765 int p1_len
= strlen(p1
);
766 int p2_len
= strlen(p2
);
767 int p3_len
= strlen(p3
);
768 char *new = malloc(p1_len
+ p2_len
+ p3_len
+ 3);
770 path_cat3_out(new, p1
, p2
, p3
);