1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2012 Alexander Block. All rights reserved.
6 #include <linux/bsearch.h>
8 #include <linux/file.h>
9 #include <linux/sort.h>
10 #include <linux/mount.h>
11 #include <linux/xattr.h>
12 #include <linux/posix_acl_xattr.h>
13 #include <linux/radix-tree.h>
14 #include <linux/vmalloc.h>
15 #include <linux/string.h>
16 #include <linux/compat.h>
17 #include <linux/crc32c.h>
23 #include "btrfs_inode.h"
24 #include "transaction.h"
25 #include "compression.h"
29 * Maximum number of references an extent can have in order for us to attempt to
30 * issue clone operations instead of write operations. This currently exists to
31 * avoid hitting limitations of the backreference walking code (taking a lot of
32 * time and using too much memory for extents with large number of references).
34 #define SEND_MAX_EXTENT_REFS 64
37 * A fs_path is a helper to dynamically build path names with unknown size.
38 * It reallocates the internal buffer on demand.
39 * It allows fast adding of path elements on the right side (normal path) and
40 * fast adding to the left side (reversed path). A reversed path can also be
41 * unreversed if needed.
50 unsigned short buf_len:15;
51 unsigned short reversed:1;
55 * Average path length does not exceed 200 bytes, we'll have
56 * better packing in the slab and higher chance to satisfy
57 * a allocation later during send.
62 #define FS_PATH_INLINE_SIZE \
63 (sizeof(struct fs_path) - offsetof(struct fs_path, inline_buf))
66 /* reused for each extent */
68 struct btrfs_root *root;
75 #define SEND_CTX_MAX_NAME_CACHE_SIZE 128
76 #define SEND_CTX_NAME_CACHE_CLEAN_SIZE (SEND_CTX_MAX_NAME_CACHE_SIZE * 2)
79 struct file *send_filp;
85 u64 cmd_send_size[BTRFS_SEND_C_MAX + 1];
86 u64 flags; /* 'flags' member of btrfs_ioctl_send_args is u64 */
88 struct btrfs_root *send_root;
89 struct btrfs_root *parent_root;
90 struct clone_root *clone_roots;
93 /* current state of the compare_tree call */
94 struct btrfs_path *left_path;
95 struct btrfs_path *right_path;
96 struct btrfs_key *cmp_key;
99 * infos of the currently processed inode. In case of deleted inodes,
100 * these are the values from the deleted inode.
105 int cur_inode_new_gen;
106 int cur_inode_deleted;
110 u64 cur_inode_last_extent;
111 u64 cur_inode_next_write_offset;
112 bool ignore_cur_inode;
116 struct list_head new_refs;
117 struct list_head deleted_refs;
119 struct radix_tree_root name_cache;
120 struct list_head name_cache_list;
123 struct file_ra_state ra;
126 * We process inodes by their increasing order, so if before an
127 * incremental send we reverse the parent/child relationship of
128 * directories such that a directory with a lower inode number was
129 * the parent of a directory with a higher inode number, and the one
130 * becoming the new parent got renamed too, we can't rename/move the
131 * directory with lower inode number when we finish processing it - we
132 * must process the directory with higher inode number first, then
133 * rename/move it and then rename/move the directory with lower inode
134 * number. Example follows.
136 * Tree state when the first send was performed:
148 * Tree state when the second (incremental) send is performed:
157 * The sequence of steps that lead to the second state was:
159 * mv /a/b/c/d /a/b/c2/d2
160 * mv /a/b/c /a/b/c2/d2/cc
162 * "c" has lower inode number, but we can't move it (2nd mv operation)
163 * before we move "d", which has higher inode number.
165 * So we just memorize which move/rename operations must be performed
166 * later when their respective parent is processed and moved/renamed.
169 /* Indexed by parent directory inode number. */
170 struct rb_root pending_dir_moves;
173 * Reverse index, indexed by the inode number of a directory that
174 * is waiting for the move/rename of its immediate parent before its
175 * own move/rename can be performed.
177 struct rb_root waiting_dir_moves;
180 * A directory that is going to be rm'ed might have a child directory
181 * which is in the pending directory moves index above. In this case,
182 * the directory can only be removed after the move/rename of its child
183 * is performed. Example:
203 * Sequence of steps that lead to the send snapshot:
204 * rm -f /a/b/c/foo.txt
206 * mv /a/b/c/x /a/b/YY
209 * When the child is processed, its move/rename is delayed until its
210 * parent is processed (as explained above), but all other operations
211 * like update utimes, chown, chgrp, etc, are performed and the paths
212 * that it uses for those operations must use the orphanized name of
213 * its parent (the directory we're going to rm later), so we need to
214 * memorize that name.
216 * Indexed by the inode number of the directory to be deleted.
218 struct rb_root orphan_dirs;
221 struct pending_dir_move {
223 struct list_head list;
227 struct list_head update_refs;
230 struct waiting_dir_move {
234 * There might be some directory that could not be removed because it
235 * was waiting for this directory inode to be moved first. Therefore
236 * after this directory is moved, we can try to rmdir the ino rmdir_ino.
243 struct orphan_dir_info {
247 u64 last_dir_index_offset;
250 struct name_cache_entry {
251 struct list_head list;
253 * radix_tree has only 32bit entries but we need to handle 64bit inums.
254 * We use the lower 32bit of the 64bit inum to store it in the tree. If
255 * more then one inum would fall into the same entry, we use radix_list
256 * to store the additional entries. radix_list is also used to store
257 * entries where two entries have the same inum but different
260 struct list_head radix_list;
266 int need_later_update;
272 #define ADVANCE_ONLY_NEXT -1
274 enum btrfs_compare_tree_result {
275 BTRFS_COMPARE_TREE_NEW,
276 BTRFS_COMPARE_TREE_DELETED,
277 BTRFS_COMPARE_TREE_CHANGED,
278 BTRFS_COMPARE_TREE_SAME,
282 static void inconsistent_snapshot_error(struct send_ctx *sctx,
283 enum btrfs_compare_tree_result result,
286 const char *result_string;
289 case BTRFS_COMPARE_TREE_NEW:
290 result_string = "new";
292 case BTRFS_COMPARE_TREE_DELETED:
293 result_string = "deleted";
295 case BTRFS_COMPARE_TREE_CHANGED:
296 result_string = "updated";
298 case BTRFS_COMPARE_TREE_SAME:
300 result_string = "unchanged";
304 result_string = "unexpected";
307 btrfs_err(sctx->send_root->fs_info,
308 "Send: inconsistent snapshot, found %s %s for inode %llu without updated inode item, send root is %llu, parent root is %llu",
309 result_string, what, sctx->cmp_key->objectid,
310 sctx->send_root->root_key.objectid,
312 sctx->parent_root->root_key.objectid : 0));
315 static int is_waiting_for_move(struct send_ctx *sctx, u64 ino);
317 static struct waiting_dir_move *
318 get_waiting_dir_move(struct send_ctx *sctx, u64 ino);
320 static int is_waiting_for_rm(struct send_ctx *sctx, u64 dir_ino, u64 gen);
322 static int need_send_hole(struct send_ctx *sctx)
324 return (sctx->parent_root && !sctx->cur_inode_new &&
325 !sctx->cur_inode_new_gen && !sctx->cur_inode_deleted &&
326 S_ISREG(sctx->cur_inode_mode));
329 static void fs_path_reset(struct fs_path *p)
332 p->start = p->buf + p->buf_len - 1;
342 static struct fs_path *fs_path_alloc(void)
346 p = kmalloc(sizeof(*p), GFP_KERNEL);
350 p->buf = p->inline_buf;
351 p->buf_len = FS_PATH_INLINE_SIZE;
356 static struct fs_path *fs_path_alloc_reversed(void)
368 static void fs_path_free(struct fs_path *p)
372 if (p->buf != p->inline_buf)
377 static int fs_path_len(struct fs_path *p)
379 return p->end - p->start;
382 static int fs_path_ensure_buf(struct fs_path *p, int len)
390 if (p->buf_len >= len)
393 if (len > PATH_MAX) {
398 path_len = p->end - p->start;
399 old_buf_len = p->buf_len;
402 * First time the inline_buf does not suffice
404 if (p->buf == p->inline_buf) {
405 tmp_buf = kmalloc(len, GFP_KERNEL);
407 memcpy(tmp_buf, p->buf, old_buf_len);
409 tmp_buf = krealloc(p->buf, len, GFP_KERNEL);
415 * The real size of the buffer is bigger, this will let the fast path
416 * happen most of the time
418 p->buf_len = ksize(p->buf);
421 tmp_buf = p->buf + old_buf_len - path_len - 1;
422 p->end = p->buf + p->buf_len - 1;
423 p->start = p->end - path_len;
424 memmove(p->start, tmp_buf, path_len + 1);
427 p->end = p->start + path_len;
432 static int fs_path_prepare_for_add(struct fs_path *p, int name_len,
438 new_len = p->end - p->start + name_len;
439 if (p->start != p->end)
441 ret = fs_path_ensure_buf(p, new_len);
446 if (p->start != p->end)
448 p->start -= name_len;
449 *prepared = p->start;
451 if (p->start != p->end)
462 static int fs_path_add(struct fs_path *p, const char *name, int name_len)
467 ret = fs_path_prepare_for_add(p, name_len, &prepared);
470 memcpy(prepared, name, name_len);
476 static int fs_path_add_path(struct fs_path *p, struct fs_path *p2)
481 ret = fs_path_prepare_for_add(p, p2->end - p2->start, &prepared);
484 memcpy(prepared, p2->start, p2->end - p2->start);
490 static int fs_path_add_from_extent_buffer(struct fs_path *p,
491 struct extent_buffer *eb,
492 unsigned long off, int len)
497 ret = fs_path_prepare_for_add(p, len, &prepared);
501 read_extent_buffer(eb, prepared, off, len);
507 static int fs_path_copy(struct fs_path *p, struct fs_path *from)
511 p->reversed = from->reversed;
514 ret = fs_path_add_path(p, from);
520 static void fs_path_unreverse(struct fs_path *p)
529 len = p->end - p->start;
531 p->end = p->start + len;
532 memmove(p->start, tmp, len + 1);
536 static struct btrfs_path *alloc_path_for_send(void)
538 struct btrfs_path *path;
540 path = btrfs_alloc_path();
543 path->search_commit_root = 1;
544 path->skip_locking = 1;
545 path->need_commit_sem = 1;
549 static int write_buf(struct file *filp, const void *buf, u32 len, loff_t *off)
555 ret = kernel_write(filp, buf + pos, len - pos, off);
556 /* TODO handle that correctly */
557 /*if (ret == -ERESTARTSYS) {
571 static int tlv_put(struct send_ctx *sctx, u16 attr, const void *data, int len)
573 struct btrfs_tlv_header *hdr;
574 int total_len = sizeof(*hdr) + len;
575 int left = sctx->send_max_size - sctx->send_size;
577 if (unlikely(left < total_len))
580 hdr = (struct btrfs_tlv_header *) (sctx->send_buf + sctx->send_size);
581 put_unaligned_le16(attr, &hdr->tlv_type);
582 put_unaligned_le16(len, &hdr->tlv_len);
583 memcpy(hdr + 1, data, len);
584 sctx->send_size += total_len;
589 #define TLV_PUT_DEFINE_INT(bits) \
590 static int tlv_put_u##bits(struct send_ctx *sctx, \
591 u##bits attr, u##bits value) \
593 __le##bits __tmp = cpu_to_le##bits(value); \
594 return tlv_put(sctx, attr, &__tmp, sizeof(__tmp)); \
597 TLV_PUT_DEFINE_INT(64)
599 static int tlv_put_string(struct send_ctx *sctx, u16 attr,
600 const char *str, int len)
604 return tlv_put(sctx, attr, str, len);
607 static int tlv_put_uuid(struct send_ctx *sctx, u16 attr,
610 return tlv_put(sctx, attr, uuid, BTRFS_UUID_SIZE);
613 static int tlv_put_btrfs_timespec(struct send_ctx *sctx, u16 attr,
614 struct extent_buffer *eb,
615 struct btrfs_timespec *ts)
617 struct btrfs_timespec bts;
618 read_extent_buffer(eb, &bts, (unsigned long)ts, sizeof(bts));
619 return tlv_put(sctx, attr, &bts, sizeof(bts));
623 #define TLV_PUT(sctx, attrtype, data, attrlen) \
625 ret = tlv_put(sctx, attrtype, data, attrlen); \
627 goto tlv_put_failure; \
630 #define TLV_PUT_INT(sctx, attrtype, bits, value) \
632 ret = tlv_put_u##bits(sctx, attrtype, value); \
634 goto tlv_put_failure; \
637 #define TLV_PUT_U8(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 8, data)
638 #define TLV_PUT_U16(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 16, data)
639 #define TLV_PUT_U32(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 32, data)
640 #define TLV_PUT_U64(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 64, data)
641 #define TLV_PUT_STRING(sctx, attrtype, str, len) \
643 ret = tlv_put_string(sctx, attrtype, str, len); \
645 goto tlv_put_failure; \
647 #define TLV_PUT_PATH(sctx, attrtype, p) \
649 ret = tlv_put_string(sctx, attrtype, p->start, \
650 p->end - p->start); \
652 goto tlv_put_failure; \
654 #define TLV_PUT_UUID(sctx, attrtype, uuid) \
656 ret = tlv_put_uuid(sctx, attrtype, uuid); \
658 goto tlv_put_failure; \
660 #define TLV_PUT_BTRFS_TIMESPEC(sctx, attrtype, eb, ts) \
662 ret = tlv_put_btrfs_timespec(sctx, attrtype, eb, ts); \
664 goto tlv_put_failure; \
667 static int send_header(struct send_ctx *sctx)
669 struct btrfs_stream_header hdr;
671 strcpy(hdr.magic, BTRFS_SEND_STREAM_MAGIC);
672 hdr.version = cpu_to_le32(BTRFS_SEND_STREAM_VERSION);
674 return write_buf(sctx->send_filp, &hdr, sizeof(hdr),
679 * For each command/item we want to send to userspace, we call this function.
681 static int begin_cmd(struct send_ctx *sctx, int cmd)
683 struct btrfs_cmd_header *hdr;
685 if (WARN_ON(!sctx->send_buf))
688 BUG_ON(sctx->send_size);
690 sctx->send_size += sizeof(*hdr);
691 hdr = (struct btrfs_cmd_header *)sctx->send_buf;
692 put_unaligned_le16(cmd, &hdr->cmd);
697 static int send_cmd(struct send_ctx *sctx)
700 struct btrfs_cmd_header *hdr;
703 hdr = (struct btrfs_cmd_header *)sctx->send_buf;
704 put_unaligned_le32(sctx->send_size - sizeof(*hdr), &hdr->len);
705 put_unaligned_le32(0, &hdr->crc);
707 crc = btrfs_crc32c(0, (unsigned char *)sctx->send_buf, sctx->send_size);
708 put_unaligned_le32(crc, &hdr->crc);
710 ret = write_buf(sctx->send_filp, sctx->send_buf, sctx->send_size,
713 sctx->total_send_size += sctx->send_size;
714 sctx->cmd_send_size[get_unaligned_le16(&hdr->cmd)] += sctx->send_size;
721 * Sends a move instruction to user space
723 static int send_rename(struct send_ctx *sctx,
724 struct fs_path *from, struct fs_path *to)
726 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
729 btrfs_debug(fs_info, "send_rename %s -> %s", from->start, to->start);
731 ret = begin_cmd(sctx, BTRFS_SEND_C_RENAME);
735 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, from);
736 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH_TO, to);
738 ret = send_cmd(sctx);
746 * Sends a link instruction to user space
748 static int send_link(struct send_ctx *sctx,
749 struct fs_path *path, struct fs_path *lnk)
751 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
754 btrfs_debug(fs_info, "send_link %s -> %s", path->start, lnk->start);
756 ret = begin_cmd(sctx, BTRFS_SEND_C_LINK);
760 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
761 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH_LINK, lnk);
763 ret = send_cmd(sctx);
771 * Sends an unlink instruction to user space
773 static int send_unlink(struct send_ctx *sctx, struct fs_path *path)
775 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
778 btrfs_debug(fs_info, "send_unlink %s", path->start);
780 ret = begin_cmd(sctx, BTRFS_SEND_C_UNLINK);
784 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
786 ret = send_cmd(sctx);
794 * Sends a rmdir instruction to user space
796 static int send_rmdir(struct send_ctx *sctx, struct fs_path *path)
798 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
801 btrfs_debug(fs_info, "send_rmdir %s", path->start);
803 ret = begin_cmd(sctx, BTRFS_SEND_C_RMDIR);
807 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
809 ret = send_cmd(sctx);
817 * Helper function to retrieve some fields from an inode item.
819 static int __get_inode_info(struct btrfs_root *root, struct btrfs_path *path,
820 u64 ino, u64 *size, u64 *gen, u64 *mode, u64 *uid,
824 struct btrfs_inode_item *ii;
825 struct btrfs_key key;
828 key.type = BTRFS_INODE_ITEM_KEY;
830 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
837 ii = btrfs_item_ptr(path->nodes[0], path->slots[0],
838 struct btrfs_inode_item);
840 *size = btrfs_inode_size(path->nodes[0], ii);
842 *gen = btrfs_inode_generation(path->nodes[0], ii);
844 *mode = btrfs_inode_mode(path->nodes[0], ii);
846 *uid = btrfs_inode_uid(path->nodes[0], ii);
848 *gid = btrfs_inode_gid(path->nodes[0], ii);
850 *rdev = btrfs_inode_rdev(path->nodes[0], ii);
855 static int get_inode_info(struct btrfs_root *root,
856 u64 ino, u64 *size, u64 *gen,
857 u64 *mode, u64 *uid, u64 *gid,
860 struct btrfs_path *path;
863 path = alloc_path_for_send();
866 ret = __get_inode_info(root, path, ino, size, gen, mode, uid, gid,
868 btrfs_free_path(path);
872 typedef int (*iterate_inode_ref_t)(int num, u64 dir, int index,
877 * Helper function to iterate the entries in ONE btrfs_inode_ref or
878 * btrfs_inode_extref.
879 * The iterate callback may return a non zero value to stop iteration. This can
880 * be a negative value for error codes or 1 to simply stop it.
882 * path must point to the INODE_REF or INODE_EXTREF when called.
884 static int iterate_inode_ref(struct btrfs_root *root, struct btrfs_path *path,
885 struct btrfs_key *found_key, int resolve,
886 iterate_inode_ref_t iterate, void *ctx)
888 struct extent_buffer *eb = path->nodes[0];
889 struct btrfs_item *item;
890 struct btrfs_inode_ref *iref;
891 struct btrfs_inode_extref *extref;
892 struct btrfs_path *tmp_path;
896 int slot = path->slots[0];
903 unsigned long name_off;
904 unsigned long elem_size;
907 p = fs_path_alloc_reversed();
911 tmp_path = alloc_path_for_send();
918 if (found_key->type == BTRFS_INODE_REF_KEY) {
919 ptr = (unsigned long)btrfs_item_ptr(eb, slot,
920 struct btrfs_inode_ref);
921 item = btrfs_item_nr(slot);
922 total = btrfs_item_size(eb, item);
923 elem_size = sizeof(*iref);
925 ptr = btrfs_item_ptr_offset(eb, slot);
926 total = btrfs_item_size_nr(eb, slot);
927 elem_size = sizeof(*extref);
930 while (cur < total) {
933 if (found_key->type == BTRFS_INODE_REF_KEY) {
934 iref = (struct btrfs_inode_ref *)(ptr + cur);
935 name_len = btrfs_inode_ref_name_len(eb, iref);
936 name_off = (unsigned long)(iref + 1);
937 index = btrfs_inode_ref_index(eb, iref);
938 dir = found_key->offset;
940 extref = (struct btrfs_inode_extref *)(ptr + cur);
941 name_len = btrfs_inode_extref_name_len(eb, extref);
942 name_off = (unsigned long)&extref->name;
943 index = btrfs_inode_extref_index(eb, extref);
944 dir = btrfs_inode_extref_parent(eb, extref);
948 start = btrfs_ref_to_path(root, tmp_path, name_len,
952 ret = PTR_ERR(start);
955 if (start < p->buf) {
956 /* overflow , try again with larger buffer */
957 ret = fs_path_ensure_buf(p,
958 p->buf_len + p->buf - start);
961 start = btrfs_ref_to_path(root, tmp_path,
966 ret = PTR_ERR(start);
969 BUG_ON(start < p->buf);
973 ret = fs_path_add_from_extent_buffer(p, eb, name_off,
979 cur += elem_size + name_len;
980 ret = iterate(num, dir, index, p, ctx);
987 btrfs_free_path(tmp_path);
992 typedef int (*iterate_dir_item_t)(int num, struct btrfs_key *di_key,
993 const char *name, int name_len,
994 const char *data, int data_len,
998 * Helper function to iterate the entries in ONE btrfs_dir_item.
999 * The iterate callback may return a non zero value to stop iteration. This can
1000 * be a negative value for error codes or 1 to simply stop it.
1002 * path must point to the dir item when called.
1004 static int iterate_dir_item(struct btrfs_root *root, struct btrfs_path *path,
1005 iterate_dir_item_t iterate, void *ctx)
1008 struct extent_buffer *eb;
1009 struct btrfs_item *item;
1010 struct btrfs_dir_item *di;
1011 struct btrfs_key di_key;
1024 * Start with a small buffer (1 page). If later we end up needing more
1025 * space, which can happen for xattrs on a fs with a leaf size greater
1026 * then the page size, attempt to increase the buffer. Typically xattr
1030 buf = kmalloc(buf_len, GFP_KERNEL);
1036 eb = path->nodes[0];
1037 slot = path->slots[0];
1038 item = btrfs_item_nr(slot);
1039 di = btrfs_item_ptr(eb, slot, struct btrfs_dir_item);
1042 total = btrfs_item_size(eb, item);
1045 while (cur < total) {
1046 name_len = btrfs_dir_name_len(eb, di);
1047 data_len = btrfs_dir_data_len(eb, di);
1048 type = btrfs_dir_type(eb, di);
1049 btrfs_dir_item_key_to_cpu(eb, di, &di_key);
1051 if (type == BTRFS_FT_XATTR) {
1052 if (name_len > XATTR_NAME_MAX) {
1053 ret = -ENAMETOOLONG;
1056 if (name_len + data_len >
1057 BTRFS_MAX_XATTR_SIZE(root->fs_info)) {
1065 if (name_len + data_len > PATH_MAX) {
1066 ret = -ENAMETOOLONG;
1071 if (name_len + data_len > buf_len) {
1072 buf_len = name_len + data_len;
1073 if (is_vmalloc_addr(buf)) {
1077 char *tmp = krealloc(buf, buf_len,
1078 GFP_KERNEL | __GFP_NOWARN);
1085 buf = kvmalloc(buf_len, GFP_KERNEL);
1093 read_extent_buffer(eb, buf, (unsigned long)(di + 1),
1094 name_len + data_len);
1096 len = sizeof(*di) + name_len + data_len;
1097 di = (struct btrfs_dir_item *)((char *)di + len);
1100 ret = iterate(num, &di_key, buf, name_len, buf + name_len,
1101 data_len, type, ctx);
1117 static int __copy_first_ref(int num, u64 dir, int index,
1118 struct fs_path *p, void *ctx)
1121 struct fs_path *pt = ctx;
1123 ret = fs_path_copy(pt, p);
1127 /* we want the first only */
1132 * Retrieve the first path of an inode. If an inode has more then one
1133 * ref/hardlink, this is ignored.
1135 static int get_inode_path(struct btrfs_root *root,
1136 u64 ino, struct fs_path *path)
1139 struct btrfs_key key, found_key;
1140 struct btrfs_path *p;
1142 p = alloc_path_for_send();
1146 fs_path_reset(path);
1149 key.type = BTRFS_INODE_REF_KEY;
1152 ret = btrfs_search_slot_for_read(root, &key, p, 1, 0);
1159 btrfs_item_key_to_cpu(p->nodes[0], &found_key, p->slots[0]);
1160 if (found_key.objectid != ino ||
1161 (found_key.type != BTRFS_INODE_REF_KEY &&
1162 found_key.type != BTRFS_INODE_EXTREF_KEY)) {
1167 ret = iterate_inode_ref(root, p, &found_key, 1,
1168 __copy_first_ref, path);
1178 struct backref_ctx {
1179 struct send_ctx *sctx;
1181 /* number of total found references */
1185 * used for clones found in send_root. clones found behind cur_objectid
1186 * and cur_offset are not considered as allowed clones.
1191 /* may be truncated in case it's the last extent in a file */
1194 /* Just to check for bugs in backref resolving */
1198 static int __clone_root_cmp_bsearch(const void *key, const void *elt)
1200 u64 root = (u64)(uintptr_t)key;
1201 struct clone_root *cr = (struct clone_root *)elt;
1203 if (root < cr->root->root_key.objectid)
1205 if (root > cr->root->root_key.objectid)
1210 static int __clone_root_cmp_sort(const void *e1, const void *e2)
1212 struct clone_root *cr1 = (struct clone_root *)e1;
1213 struct clone_root *cr2 = (struct clone_root *)e2;
1215 if (cr1->root->root_key.objectid < cr2->root->root_key.objectid)
1217 if (cr1->root->root_key.objectid > cr2->root->root_key.objectid)
1223 * Called for every backref that is found for the current extent.
1224 * Results are collected in sctx->clone_roots->ino/offset/found_refs
1226 static int __iterate_backrefs(u64 ino, u64 offset, u64 root, void *ctx_)
1228 struct backref_ctx *bctx = ctx_;
1229 struct clone_root *found;
1231 /* First check if the root is in the list of accepted clone sources */
1232 found = bsearch((void *)(uintptr_t)root, bctx->sctx->clone_roots,
1233 bctx->sctx->clone_roots_cnt,
1234 sizeof(struct clone_root),
1235 __clone_root_cmp_bsearch);
1239 if (found->root == bctx->sctx->send_root &&
1240 ino == bctx->cur_objectid &&
1241 offset == bctx->cur_offset) {
1242 bctx->found_itself = 1;
1246 * Make sure we don't consider clones from send_root that are
1247 * behind the current inode/offset.
1249 if (found->root == bctx->sctx->send_root) {
1251 * If the source inode was not yet processed we can't issue a
1252 * clone operation, as the source extent does not exist yet at
1253 * the destination of the stream.
1255 if (ino > bctx->cur_objectid)
1258 * We clone from the inode currently being sent as long as the
1259 * source extent is already processed, otherwise we could try
1260 * to clone from an extent that does not exist yet at the
1261 * destination of the stream.
1263 if (ino == bctx->cur_objectid &&
1264 offset + bctx->extent_len >
1265 bctx->sctx->cur_inode_next_write_offset)
1270 found->found_refs++;
1271 if (ino < found->ino) {
1273 found->offset = offset;
1274 } else if (found->ino == ino) {
1276 * same extent found more then once in the same file.
1278 if (found->offset > offset + bctx->extent_len)
1279 found->offset = offset;
1286 * Given an inode, offset and extent item, it finds a good clone for a clone
1287 * instruction. Returns -ENOENT when none could be found. The function makes
1288 * sure that the returned clone is usable at the point where sending is at the
1289 * moment. This means, that no clones are accepted which lie behind the current
1292 * path must point to the extent item when called.
1294 static int find_extent_clone(struct send_ctx *sctx,
1295 struct btrfs_path *path,
1296 u64 ino, u64 data_offset,
1298 struct clone_root **found)
1300 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
1306 u64 extent_item_pos;
1308 struct btrfs_file_extent_item *fi;
1309 struct extent_buffer *eb = path->nodes[0];
1310 struct backref_ctx *backref_ctx = NULL;
1311 struct clone_root *cur_clone_root;
1312 struct btrfs_key found_key;
1313 struct btrfs_path *tmp_path;
1314 struct btrfs_extent_item *ei;
1318 tmp_path = alloc_path_for_send();
1322 /* We only use this path under the commit sem */
1323 tmp_path->need_commit_sem = 0;
1325 backref_ctx = kmalloc(sizeof(*backref_ctx), GFP_KERNEL);
1331 if (data_offset >= ino_size) {
1333 * There may be extents that lie behind the file's size.
1334 * I at least had this in combination with snapshotting while
1335 * writing large files.
1341 fi = btrfs_item_ptr(eb, path->slots[0],
1342 struct btrfs_file_extent_item);
1343 extent_type = btrfs_file_extent_type(eb, fi);
1344 if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
1348 compressed = btrfs_file_extent_compression(eb, fi);
1350 num_bytes = btrfs_file_extent_num_bytes(eb, fi);
1351 disk_byte = btrfs_file_extent_disk_bytenr(eb, fi);
1352 if (disk_byte == 0) {
1356 logical = disk_byte + btrfs_file_extent_offset(eb, fi);
1358 down_read(&fs_info->commit_root_sem);
1359 ret = extent_from_logical(fs_info, disk_byte, tmp_path,
1360 &found_key, &flags);
1361 up_read(&fs_info->commit_root_sem);
1365 if (flags & BTRFS_EXTENT_FLAG_TREE_BLOCK) {
1370 ei = btrfs_item_ptr(tmp_path->nodes[0], tmp_path->slots[0],
1371 struct btrfs_extent_item);
1373 * Backreference walking (iterate_extent_inodes() below) is currently
1374 * too expensive when an extent has a large number of references, both
1375 * in time spent and used memory. So for now just fallback to write
1376 * operations instead of clone operations when an extent has more than
1377 * a certain amount of references.
1379 if (btrfs_extent_refs(tmp_path->nodes[0], ei) > SEND_MAX_EXTENT_REFS) {
1383 btrfs_release_path(tmp_path);
1386 * Setup the clone roots.
1388 for (i = 0; i < sctx->clone_roots_cnt; i++) {
1389 cur_clone_root = sctx->clone_roots + i;
1390 cur_clone_root->ino = (u64)-1;
1391 cur_clone_root->offset = 0;
1392 cur_clone_root->found_refs = 0;
1395 backref_ctx->sctx = sctx;
1396 backref_ctx->found = 0;
1397 backref_ctx->cur_objectid = ino;
1398 backref_ctx->cur_offset = data_offset;
1399 backref_ctx->found_itself = 0;
1400 backref_ctx->extent_len = num_bytes;
1403 * The last extent of a file may be too large due to page alignment.
1404 * We need to adjust extent_len in this case so that the checks in
1405 * __iterate_backrefs work.
1407 if (data_offset + num_bytes >= ino_size)
1408 backref_ctx->extent_len = ino_size - data_offset;
1411 * Now collect all backrefs.
1413 if (compressed == BTRFS_COMPRESS_NONE)
1414 extent_item_pos = logical - found_key.objectid;
1416 extent_item_pos = 0;
1417 ret = iterate_extent_inodes(fs_info, found_key.objectid,
1418 extent_item_pos, 1, __iterate_backrefs,
1419 backref_ctx, false);
1424 if (!backref_ctx->found_itself) {
1425 /* found a bug in backref code? */
1428 "did not find backref in send_root. inode=%llu, offset=%llu, disk_byte=%llu found extent=%llu",
1429 ino, data_offset, disk_byte, found_key.objectid);
1433 btrfs_debug(fs_info,
1434 "find_extent_clone: data_offset=%llu, ino=%llu, num_bytes=%llu, logical=%llu",
1435 data_offset, ino, num_bytes, logical);
1437 if (!backref_ctx->found)
1438 btrfs_debug(fs_info, "no clones found");
1440 cur_clone_root = NULL;
1441 for (i = 0; i < sctx->clone_roots_cnt; i++) {
1442 if (sctx->clone_roots[i].found_refs) {
1443 if (!cur_clone_root)
1444 cur_clone_root = sctx->clone_roots + i;
1445 else if (sctx->clone_roots[i].root == sctx->send_root)
1446 /* prefer clones from send_root over others */
1447 cur_clone_root = sctx->clone_roots + i;
1452 if (cur_clone_root) {
1453 *found = cur_clone_root;
1460 btrfs_free_path(tmp_path);
1465 static int read_symlink(struct btrfs_root *root,
1467 struct fs_path *dest)
1470 struct btrfs_path *path;
1471 struct btrfs_key key;
1472 struct btrfs_file_extent_item *ei;
1478 path = alloc_path_for_send();
1483 key.type = BTRFS_EXTENT_DATA_KEY;
1485 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
1490 * An empty symlink inode. Can happen in rare error paths when
1491 * creating a symlink (transaction committed before the inode
1492 * eviction handler removed the symlink inode items and a crash
1493 * happened in between or the subvol was snapshoted in between).
1494 * Print an informative message to dmesg/syslog so that the user
1495 * can delete the symlink.
1497 btrfs_err(root->fs_info,
1498 "Found empty symlink inode %llu at root %llu",
1499 ino, root->root_key.objectid);
1504 ei = btrfs_item_ptr(path->nodes[0], path->slots[0],
1505 struct btrfs_file_extent_item);
1506 type = btrfs_file_extent_type(path->nodes[0], ei);
1507 compression = btrfs_file_extent_compression(path->nodes[0], ei);
1508 BUG_ON(type != BTRFS_FILE_EXTENT_INLINE);
1509 BUG_ON(compression);
1511 off = btrfs_file_extent_inline_start(ei);
1512 len = btrfs_file_extent_ram_bytes(path->nodes[0], ei);
1514 ret = fs_path_add_from_extent_buffer(dest, path->nodes[0], off, len);
1517 btrfs_free_path(path);
1522 * Helper function to generate a file name that is unique in the root of
1523 * send_root and parent_root. This is used to generate names for orphan inodes.
1525 static int gen_unique_name(struct send_ctx *sctx,
1527 struct fs_path *dest)
1530 struct btrfs_path *path;
1531 struct btrfs_dir_item *di;
1536 path = alloc_path_for_send();
1541 len = snprintf(tmp, sizeof(tmp), "o%llu-%llu-%llu",
1543 ASSERT(len < sizeof(tmp));
1545 di = btrfs_lookup_dir_item(NULL, sctx->send_root,
1546 path, BTRFS_FIRST_FREE_OBJECTID,
1547 tmp, strlen(tmp), 0);
1548 btrfs_release_path(path);
1554 /* not unique, try again */
1559 if (!sctx->parent_root) {
1565 di = btrfs_lookup_dir_item(NULL, sctx->parent_root,
1566 path, BTRFS_FIRST_FREE_OBJECTID,
1567 tmp, strlen(tmp), 0);
1568 btrfs_release_path(path);
1574 /* not unique, try again */
1582 ret = fs_path_add(dest, tmp, strlen(tmp));
1585 btrfs_free_path(path);
1590 inode_state_no_change,
1591 inode_state_will_create,
1592 inode_state_did_create,
1593 inode_state_will_delete,
1594 inode_state_did_delete,
1597 static int get_cur_inode_state(struct send_ctx *sctx, u64 ino, u64 gen)
1605 ret = get_inode_info(sctx->send_root, ino, NULL, &left_gen, NULL, NULL,
1607 if (ret < 0 && ret != -ENOENT)
1611 if (!sctx->parent_root) {
1612 right_ret = -ENOENT;
1614 ret = get_inode_info(sctx->parent_root, ino, NULL, &right_gen,
1615 NULL, NULL, NULL, NULL);
1616 if (ret < 0 && ret != -ENOENT)
1621 if (!left_ret && !right_ret) {
1622 if (left_gen == gen && right_gen == gen) {
1623 ret = inode_state_no_change;
1624 } else if (left_gen == gen) {
1625 if (ino < sctx->send_progress)
1626 ret = inode_state_did_create;
1628 ret = inode_state_will_create;
1629 } else if (right_gen == gen) {
1630 if (ino < sctx->send_progress)
1631 ret = inode_state_did_delete;
1633 ret = inode_state_will_delete;
1637 } else if (!left_ret) {
1638 if (left_gen == gen) {
1639 if (ino < sctx->send_progress)
1640 ret = inode_state_did_create;
1642 ret = inode_state_will_create;
1646 } else if (!right_ret) {
1647 if (right_gen == gen) {
1648 if (ino < sctx->send_progress)
1649 ret = inode_state_did_delete;
1651 ret = inode_state_will_delete;
1663 static int is_inode_existent(struct send_ctx *sctx, u64 ino, u64 gen)
1667 if (ino == BTRFS_FIRST_FREE_OBJECTID)
1670 ret = get_cur_inode_state(sctx, ino, gen);
1674 if (ret == inode_state_no_change ||
1675 ret == inode_state_did_create ||
1676 ret == inode_state_will_delete)
1686 * Helper function to lookup a dir item in a dir.
1688 static int lookup_dir_item_inode(struct btrfs_root *root,
1689 u64 dir, const char *name, int name_len,
1694 struct btrfs_dir_item *di;
1695 struct btrfs_key key;
1696 struct btrfs_path *path;
1698 path = alloc_path_for_send();
1702 di = btrfs_lookup_dir_item(NULL, root, path,
1703 dir, name, name_len, 0);
1704 if (IS_ERR_OR_NULL(di)) {
1705 ret = di ? PTR_ERR(di) : -ENOENT;
1708 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &key);
1709 if (key.type == BTRFS_ROOT_ITEM_KEY) {
1713 *found_inode = key.objectid;
1714 *found_type = btrfs_dir_type(path->nodes[0], di);
1717 btrfs_free_path(path);
1722 * Looks up the first btrfs_inode_ref of a given ino. It returns the parent dir,
1723 * generation of the parent dir and the name of the dir entry.
1725 static int get_first_ref(struct btrfs_root *root, u64 ino,
1726 u64 *dir, u64 *dir_gen, struct fs_path *name)
1729 struct btrfs_key key;
1730 struct btrfs_key found_key;
1731 struct btrfs_path *path;
1735 path = alloc_path_for_send();
1740 key.type = BTRFS_INODE_REF_KEY;
1743 ret = btrfs_search_slot_for_read(root, &key, path, 1, 0);
1747 btrfs_item_key_to_cpu(path->nodes[0], &found_key,
1749 if (ret || found_key.objectid != ino ||
1750 (found_key.type != BTRFS_INODE_REF_KEY &&
1751 found_key.type != BTRFS_INODE_EXTREF_KEY)) {
1756 if (found_key.type == BTRFS_INODE_REF_KEY) {
1757 struct btrfs_inode_ref *iref;
1758 iref = btrfs_item_ptr(path->nodes[0], path->slots[0],
1759 struct btrfs_inode_ref);
1760 len = btrfs_inode_ref_name_len(path->nodes[0], iref);
1761 ret = fs_path_add_from_extent_buffer(name, path->nodes[0],
1762 (unsigned long)(iref + 1),
1764 parent_dir = found_key.offset;
1766 struct btrfs_inode_extref *extref;
1767 extref = btrfs_item_ptr(path->nodes[0], path->slots[0],
1768 struct btrfs_inode_extref);
1769 len = btrfs_inode_extref_name_len(path->nodes[0], extref);
1770 ret = fs_path_add_from_extent_buffer(name, path->nodes[0],
1771 (unsigned long)&extref->name, len);
1772 parent_dir = btrfs_inode_extref_parent(path->nodes[0], extref);
1776 btrfs_release_path(path);
1779 ret = get_inode_info(root, parent_dir, NULL, dir_gen, NULL,
1788 btrfs_free_path(path);
1792 static int is_first_ref(struct btrfs_root *root,
1794 const char *name, int name_len)
1797 struct fs_path *tmp_name;
1800 tmp_name = fs_path_alloc();
1804 ret = get_first_ref(root, ino, &tmp_dir, NULL, tmp_name);
1808 if (dir != tmp_dir || name_len != fs_path_len(tmp_name)) {
1813 ret = !memcmp(tmp_name->start, name, name_len);
1816 fs_path_free(tmp_name);
1821 * Used by process_recorded_refs to determine if a new ref would overwrite an
1822 * already existing ref. In case it detects an overwrite, it returns the
1823 * inode/gen in who_ino/who_gen.
1824 * When an overwrite is detected, process_recorded_refs does proper orphanizing
1825 * to make sure later references to the overwritten inode are possible.
1826 * Orphanizing is however only required for the first ref of an inode.
1827 * process_recorded_refs does an additional is_first_ref check to see if
1828 * orphanizing is really required.
1830 static int will_overwrite_ref(struct send_ctx *sctx, u64 dir, u64 dir_gen,
1831 const char *name, int name_len,
1832 u64 *who_ino, u64 *who_gen, u64 *who_mode)
1836 u64 other_inode = 0;
1839 if (!sctx->parent_root)
1842 ret = is_inode_existent(sctx, dir, dir_gen);
1847 * If we have a parent root we need to verify that the parent dir was
1848 * not deleted and then re-created, if it was then we have no overwrite
1849 * and we can just unlink this entry.
1851 if (sctx->parent_root && dir != BTRFS_FIRST_FREE_OBJECTID) {
1852 ret = get_inode_info(sctx->parent_root, dir, NULL, &gen, NULL,
1854 if (ret < 0 && ret != -ENOENT)
1864 ret = lookup_dir_item_inode(sctx->parent_root, dir, name, name_len,
1865 &other_inode, &other_type);
1866 if (ret < 0 && ret != -ENOENT)
1874 * Check if the overwritten ref was already processed. If yes, the ref
1875 * was already unlinked/moved, so we can safely assume that we will not
1876 * overwrite anything at this point in time.
1878 if (other_inode > sctx->send_progress ||
1879 is_waiting_for_move(sctx, other_inode)) {
1880 ret = get_inode_info(sctx->parent_root, other_inode, NULL,
1881 who_gen, who_mode, NULL, NULL, NULL);
1886 *who_ino = other_inode;
1896 * Checks if the ref was overwritten by an already processed inode. This is
1897 * used by __get_cur_name_and_parent to find out if the ref was orphanized and
1898 * thus the orphan name needs be used.
1899 * process_recorded_refs also uses it to avoid unlinking of refs that were
1902 static int did_overwrite_ref(struct send_ctx *sctx,
1903 u64 dir, u64 dir_gen,
1904 u64 ino, u64 ino_gen,
1905 const char *name, int name_len)
1912 if (!sctx->parent_root)
1915 ret = is_inode_existent(sctx, dir, dir_gen);
1919 if (dir != BTRFS_FIRST_FREE_OBJECTID) {
1920 ret = get_inode_info(sctx->send_root, dir, NULL, &gen, NULL,
1922 if (ret < 0 && ret != -ENOENT)
1932 /* check if the ref was overwritten by another ref */
1933 ret = lookup_dir_item_inode(sctx->send_root, dir, name, name_len,
1934 &ow_inode, &other_type);
1935 if (ret < 0 && ret != -ENOENT)
1938 /* was never and will never be overwritten */
1943 ret = get_inode_info(sctx->send_root, ow_inode, NULL, &gen, NULL, NULL,
1948 if (ow_inode == ino && gen == ino_gen) {
1954 * We know that it is or will be overwritten. Check this now.
1955 * The current inode being processed might have been the one that caused
1956 * inode 'ino' to be orphanized, therefore check if ow_inode matches
1957 * the current inode being processed.
1959 if ((ow_inode < sctx->send_progress) ||
1960 (ino != sctx->cur_ino && ow_inode == sctx->cur_ino &&
1961 gen == sctx->cur_inode_gen))
1971 * Same as did_overwrite_ref, but also checks if it is the first ref of an inode
1972 * that got overwritten. This is used by process_recorded_refs to determine
1973 * if it has to use the path as returned by get_cur_path or the orphan name.
1975 static int did_overwrite_first_ref(struct send_ctx *sctx, u64 ino, u64 gen)
1978 struct fs_path *name = NULL;
1982 if (!sctx->parent_root)
1985 name = fs_path_alloc();
1989 ret = get_first_ref(sctx->parent_root, ino, &dir, &dir_gen, name);
1993 ret = did_overwrite_ref(sctx, dir, dir_gen, ino, gen,
1994 name->start, fs_path_len(name));
2002 * Insert a name cache entry. On 32bit kernels the radix tree index is 32bit,
2003 * so we need to do some special handling in case we have clashes. This function
2004 * takes care of this with the help of name_cache_entry::radix_list.
2005 * In case of error, nce is kfreed.
2007 static int name_cache_insert(struct send_ctx *sctx,
2008 struct name_cache_entry *nce)
2011 struct list_head *nce_head;
2013 nce_head = radix_tree_lookup(&sctx->name_cache,
2014 (unsigned long)nce->ino);
2016 nce_head = kmalloc(sizeof(*nce_head), GFP_KERNEL);
2021 INIT_LIST_HEAD(nce_head);
2023 ret = radix_tree_insert(&sctx->name_cache, nce->ino, nce_head);
2030 list_add_tail(&nce->radix_list, nce_head);
2031 list_add_tail(&nce->list, &sctx->name_cache_list);
2032 sctx->name_cache_size++;
2037 static void name_cache_delete(struct send_ctx *sctx,
2038 struct name_cache_entry *nce)
2040 struct list_head *nce_head;
2042 nce_head = radix_tree_lookup(&sctx->name_cache,
2043 (unsigned long)nce->ino);
2045 btrfs_err(sctx->send_root->fs_info,
2046 "name_cache_delete lookup failed ino %llu cache size %d, leaking memory",
2047 nce->ino, sctx->name_cache_size);
2050 list_del(&nce->radix_list);
2051 list_del(&nce->list);
2052 sctx->name_cache_size--;
2055 * We may not get to the final release of nce_head if the lookup fails
2057 if (nce_head && list_empty(nce_head)) {
2058 radix_tree_delete(&sctx->name_cache, (unsigned long)nce->ino);
2063 static struct name_cache_entry *name_cache_search(struct send_ctx *sctx,
2066 struct list_head *nce_head;
2067 struct name_cache_entry *cur;
2069 nce_head = radix_tree_lookup(&sctx->name_cache, (unsigned long)ino);
2073 list_for_each_entry(cur, nce_head, radix_list) {
2074 if (cur->ino == ino && cur->gen == gen)
2081 * Removes the entry from the list and adds it back to the end. This marks the
2082 * entry as recently used so that name_cache_clean_unused does not remove it.
2084 static void name_cache_used(struct send_ctx *sctx, struct name_cache_entry *nce)
2086 list_del(&nce->list);
2087 list_add_tail(&nce->list, &sctx->name_cache_list);
2091 * Remove some entries from the beginning of name_cache_list.
2093 static void name_cache_clean_unused(struct send_ctx *sctx)
2095 struct name_cache_entry *nce;
2097 if (sctx->name_cache_size < SEND_CTX_NAME_CACHE_CLEAN_SIZE)
2100 while (sctx->name_cache_size > SEND_CTX_MAX_NAME_CACHE_SIZE) {
2101 nce = list_entry(sctx->name_cache_list.next,
2102 struct name_cache_entry, list);
2103 name_cache_delete(sctx, nce);
2108 static void name_cache_free(struct send_ctx *sctx)
2110 struct name_cache_entry *nce;
2112 while (!list_empty(&sctx->name_cache_list)) {
2113 nce = list_entry(sctx->name_cache_list.next,
2114 struct name_cache_entry, list);
2115 name_cache_delete(sctx, nce);
2121 * Used by get_cur_path for each ref up to the root.
2122 * Returns 0 if it succeeded.
2123 * Returns 1 if the inode is not existent or got overwritten. In that case, the
2124 * name is an orphan name. This instructs get_cur_path to stop iterating. If 1
2125 * is returned, parent_ino/parent_gen are not guaranteed to be valid.
2126 * Returns <0 in case of error.
2128 static int __get_cur_name_and_parent(struct send_ctx *sctx,
2132 struct fs_path *dest)
2136 struct name_cache_entry *nce = NULL;
2139 * First check if we already did a call to this function with the same
2140 * ino/gen. If yes, check if the cache entry is still up-to-date. If yes
2141 * return the cached result.
2143 nce = name_cache_search(sctx, ino, gen);
2145 if (ino < sctx->send_progress && nce->need_later_update) {
2146 name_cache_delete(sctx, nce);
2150 name_cache_used(sctx, nce);
2151 *parent_ino = nce->parent_ino;
2152 *parent_gen = nce->parent_gen;
2153 ret = fs_path_add(dest, nce->name, nce->name_len);
2162 * If the inode is not existent yet, add the orphan name and return 1.
2163 * This should only happen for the parent dir that we determine in
2166 ret = is_inode_existent(sctx, ino, gen);
2171 ret = gen_unique_name(sctx, ino, gen, dest);
2179 * Depending on whether the inode was already processed or not, use
2180 * send_root or parent_root for ref lookup.
2182 if (ino < sctx->send_progress)
2183 ret = get_first_ref(sctx->send_root, ino,
2184 parent_ino, parent_gen, dest);
2186 ret = get_first_ref(sctx->parent_root, ino,
2187 parent_ino, parent_gen, dest);
2192 * Check if the ref was overwritten by an inode's ref that was processed
2193 * earlier. If yes, treat as orphan and return 1.
2195 ret = did_overwrite_ref(sctx, *parent_ino, *parent_gen, ino, gen,
2196 dest->start, dest->end - dest->start);
2200 fs_path_reset(dest);
2201 ret = gen_unique_name(sctx, ino, gen, dest);
2209 * Store the result of the lookup in the name cache.
2211 nce = kmalloc(sizeof(*nce) + fs_path_len(dest) + 1, GFP_KERNEL);
2219 nce->parent_ino = *parent_ino;
2220 nce->parent_gen = *parent_gen;
2221 nce->name_len = fs_path_len(dest);
2223 strcpy(nce->name, dest->start);
2225 if (ino < sctx->send_progress)
2226 nce->need_later_update = 0;
2228 nce->need_later_update = 1;
2230 nce_ret = name_cache_insert(sctx, nce);
2233 name_cache_clean_unused(sctx);
2240 * Magic happens here. This function returns the first ref to an inode as it
2241 * would look like while receiving the stream at this point in time.
2242 * We walk the path up to the root. For every inode in between, we check if it
2243 * was already processed/sent. If yes, we continue with the parent as found
2244 * in send_root. If not, we continue with the parent as found in parent_root.
2245 * If we encounter an inode that was deleted at this point in time, we use the
2246 * inodes "orphan" name instead of the real name and stop. Same with new inodes
2247 * that were not created yet and overwritten inodes/refs.
2249 * When do we have orphan inodes:
2250 * 1. When an inode is freshly created and thus no valid refs are available yet
2251 * 2. When a directory lost all it's refs (deleted) but still has dir items
2252 * inside which were not processed yet (pending for move/delete). If anyone
2253 * tried to get the path to the dir items, it would get a path inside that
2255 * 3. When an inode is moved around or gets new links, it may overwrite the ref
2256 * of an unprocessed inode. If in that case the first ref would be
2257 * overwritten, the overwritten inode gets "orphanized". Later when we
2258 * process this overwritten inode, it is restored at a new place by moving
2261 * sctx->send_progress tells this function at which point in time receiving
2264 static int get_cur_path(struct send_ctx *sctx, u64 ino, u64 gen,
2265 struct fs_path *dest)
2268 struct fs_path *name = NULL;
2269 u64 parent_inode = 0;
2273 name = fs_path_alloc();
2280 fs_path_reset(dest);
2282 while (!stop && ino != BTRFS_FIRST_FREE_OBJECTID) {
2283 struct waiting_dir_move *wdm;
2285 fs_path_reset(name);
2287 if (is_waiting_for_rm(sctx, ino, gen)) {
2288 ret = gen_unique_name(sctx, ino, gen, name);
2291 ret = fs_path_add_path(dest, name);
2295 wdm = get_waiting_dir_move(sctx, ino);
2296 if (wdm && wdm->orphanized) {
2297 ret = gen_unique_name(sctx, ino, gen, name);
2300 ret = get_first_ref(sctx->parent_root, ino,
2301 &parent_inode, &parent_gen, name);
2303 ret = __get_cur_name_and_parent(sctx, ino, gen,
2313 ret = fs_path_add_path(dest, name);
2324 fs_path_unreverse(dest);
2329 * Sends a BTRFS_SEND_C_SUBVOL command/item to userspace
2331 static int send_subvol_begin(struct send_ctx *sctx)
2334 struct btrfs_root *send_root = sctx->send_root;
2335 struct btrfs_root *parent_root = sctx->parent_root;
2336 struct btrfs_path *path;
2337 struct btrfs_key key;
2338 struct btrfs_root_ref *ref;
2339 struct extent_buffer *leaf;
2343 path = btrfs_alloc_path();
2347 name = kmalloc(BTRFS_PATH_NAME_MAX, GFP_KERNEL);
2349 btrfs_free_path(path);
2353 key.objectid = send_root->root_key.objectid;
2354 key.type = BTRFS_ROOT_BACKREF_KEY;
2357 ret = btrfs_search_slot_for_read(send_root->fs_info->tree_root,
2366 leaf = path->nodes[0];
2367 btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
2368 if (key.type != BTRFS_ROOT_BACKREF_KEY ||
2369 key.objectid != send_root->root_key.objectid) {
2373 ref = btrfs_item_ptr(leaf, path->slots[0], struct btrfs_root_ref);
2374 namelen = btrfs_root_ref_name_len(leaf, ref);
2375 read_extent_buffer(leaf, name, (unsigned long)(ref + 1), namelen);
2376 btrfs_release_path(path);
2379 ret = begin_cmd(sctx, BTRFS_SEND_C_SNAPSHOT);
2383 ret = begin_cmd(sctx, BTRFS_SEND_C_SUBVOL);
2388 TLV_PUT_STRING(sctx, BTRFS_SEND_A_PATH, name, namelen);
2390 if (!btrfs_is_empty_uuid(sctx->send_root->root_item.received_uuid))
2391 TLV_PUT_UUID(sctx, BTRFS_SEND_A_UUID,
2392 sctx->send_root->root_item.received_uuid);
2394 TLV_PUT_UUID(sctx, BTRFS_SEND_A_UUID,
2395 sctx->send_root->root_item.uuid);
2397 TLV_PUT_U64(sctx, BTRFS_SEND_A_CTRANSID,
2398 btrfs_root_ctransid(&sctx->send_root->root_item));
2400 if (!btrfs_is_empty_uuid(parent_root->root_item.received_uuid))
2401 TLV_PUT_UUID(sctx, BTRFS_SEND_A_CLONE_UUID,
2402 parent_root->root_item.received_uuid);
2404 TLV_PUT_UUID(sctx, BTRFS_SEND_A_CLONE_UUID,
2405 parent_root->root_item.uuid);
2406 TLV_PUT_U64(sctx, BTRFS_SEND_A_CLONE_CTRANSID,
2407 btrfs_root_ctransid(&sctx->parent_root->root_item));
2410 ret = send_cmd(sctx);
2414 btrfs_free_path(path);
2419 static int send_truncate(struct send_ctx *sctx, u64 ino, u64 gen, u64 size)
2421 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2425 btrfs_debug(fs_info, "send_truncate %llu size=%llu", ino, size);
2427 p = fs_path_alloc();
2431 ret = begin_cmd(sctx, BTRFS_SEND_C_TRUNCATE);
2435 ret = get_cur_path(sctx, ino, gen, p);
2438 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2439 TLV_PUT_U64(sctx, BTRFS_SEND_A_SIZE, size);
2441 ret = send_cmd(sctx);
2449 static int send_chmod(struct send_ctx *sctx, u64 ino, u64 gen, u64 mode)
2451 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2455 btrfs_debug(fs_info, "send_chmod %llu mode=%llu", ino, mode);
2457 p = fs_path_alloc();
2461 ret = begin_cmd(sctx, BTRFS_SEND_C_CHMOD);
2465 ret = get_cur_path(sctx, ino, gen, p);
2468 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2469 TLV_PUT_U64(sctx, BTRFS_SEND_A_MODE, mode & 07777);
2471 ret = send_cmd(sctx);
2479 static int send_chown(struct send_ctx *sctx, u64 ino, u64 gen, u64 uid, u64 gid)
2481 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2485 btrfs_debug(fs_info, "send_chown %llu uid=%llu, gid=%llu",
2488 p = fs_path_alloc();
2492 ret = begin_cmd(sctx, BTRFS_SEND_C_CHOWN);
2496 ret = get_cur_path(sctx, ino, gen, p);
2499 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2500 TLV_PUT_U64(sctx, BTRFS_SEND_A_UID, uid);
2501 TLV_PUT_U64(sctx, BTRFS_SEND_A_GID, gid);
2503 ret = send_cmd(sctx);
2511 static int send_utimes(struct send_ctx *sctx, u64 ino, u64 gen)
2513 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2515 struct fs_path *p = NULL;
2516 struct btrfs_inode_item *ii;
2517 struct btrfs_path *path = NULL;
2518 struct extent_buffer *eb;
2519 struct btrfs_key key;
2522 btrfs_debug(fs_info, "send_utimes %llu", ino);
2524 p = fs_path_alloc();
2528 path = alloc_path_for_send();
2535 key.type = BTRFS_INODE_ITEM_KEY;
2537 ret = btrfs_search_slot(NULL, sctx->send_root, &key, path, 0, 0);
2543 eb = path->nodes[0];
2544 slot = path->slots[0];
2545 ii = btrfs_item_ptr(eb, slot, struct btrfs_inode_item);
2547 ret = begin_cmd(sctx, BTRFS_SEND_C_UTIMES);
2551 ret = get_cur_path(sctx, ino, gen, p);
2554 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2555 TLV_PUT_BTRFS_TIMESPEC(sctx, BTRFS_SEND_A_ATIME, eb, &ii->atime);
2556 TLV_PUT_BTRFS_TIMESPEC(sctx, BTRFS_SEND_A_MTIME, eb, &ii->mtime);
2557 TLV_PUT_BTRFS_TIMESPEC(sctx, BTRFS_SEND_A_CTIME, eb, &ii->ctime);
2558 /* TODO Add otime support when the otime patches get into upstream */
2560 ret = send_cmd(sctx);
2565 btrfs_free_path(path);
2570 * Sends a BTRFS_SEND_C_MKXXX or SYMLINK command to user space. We don't have
2571 * a valid path yet because we did not process the refs yet. So, the inode
2572 * is created as orphan.
2574 static int send_create_inode(struct send_ctx *sctx, u64 ino)
2576 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2584 btrfs_debug(fs_info, "send_create_inode %llu", ino);
2586 p = fs_path_alloc();
2590 if (ino != sctx->cur_ino) {
2591 ret = get_inode_info(sctx->send_root, ino, NULL, &gen, &mode,
2596 gen = sctx->cur_inode_gen;
2597 mode = sctx->cur_inode_mode;
2598 rdev = sctx->cur_inode_rdev;
2601 if (S_ISREG(mode)) {
2602 cmd = BTRFS_SEND_C_MKFILE;
2603 } else if (S_ISDIR(mode)) {
2604 cmd = BTRFS_SEND_C_MKDIR;
2605 } else if (S_ISLNK(mode)) {
2606 cmd = BTRFS_SEND_C_SYMLINK;
2607 } else if (S_ISCHR(mode) || S_ISBLK(mode)) {
2608 cmd = BTRFS_SEND_C_MKNOD;
2609 } else if (S_ISFIFO(mode)) {
2610 cmd = BTRFS_SEND_C_MKFIFO;
2611 } else if (S_ISSOCK(mode)) {
2612 cmd = BTRFS_SEND_C_MKSOCK;
2614 btrfs_warn(sctx->send_root->fs_info, "unexpected inode type %o",
2615 (int)(mode & S_IFMT));
2620 ret = begin_cmd(sctx, cmd);
2624 ret = gen_unique_name(sctx, ino, gen, p);
2628 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2629 TLV_PUT_U64(sctx, BTRFS_SEND_A_INO, ino);
2631 if (S_ISLNK(mode)) {
2633 ret = read_symlink(sctx->send_root, ino, p);
2636 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH_LINK, p);
2637 } else if (S_ISCHR(mode) || S_ISBLK(mode) ||
2638 S_ISFIFO(mode) || S_ISSOCK(mode)) {
2639 TLV_PUT_U64(sctx, BTRFS_SEND_A_RDEV, new_encode_dev(rdev));
2640 TLV_PUT_U64(sctx, BTRFS_SEND_A_MODE, mode);
2643 ret = send_cmd(sctx);
2655 * We need some special handling for inodes that get processed before the parent
2656 * directory got created. See process_recorded_refs for details.
2657 * This function does the check if we already created the dir out of order.
2659 static int did_create_dir(struct send_ctx *sctx, u64 dir)
2662 struct btrfs_path *path = NULL;
2663 struct btrfs_key key;
2664 struct btrfs_key found_key;
2665 struct btrfs_key di_key;
2666 struct extent_buffer *eb;
2667 struct btrfs_dir_item *di;
2670 path = alloc_path_for_send();
2677 key.type = BTRFS_DIR_INDEX_KEY;
2679 ret = btrfs_search_slot(NULL, sctx->send_root, &key, path, 0, 0);
2684 eb = path->nodes[0];
2685 slot = path->slots[0];
2686 if (slot >= btrfs_header_nritems(eb)) {
2687 ret = btrfs_next_leaf(sctx->send_root, path);
2690 } else if (ret > 0) {
2697 btrfs_item_key_to_cpu(eb, &found_key, slot);
2698 if (found_key.objectid != key.objectid ||
2699 found_key.type != key.type) {
2704 di = btrfs_item_ptr(eb, slot, struct btrfs_dir_item);
2705 btrfs_dir_item_key_to_cpu(eb, di, &di_key);
2707 if (di_key.type != BTRFS_ROOT_ITEM_KEY &&
2708 di_key.objectid < sctx->send_progress) {
2717 btrfs_free_path(path);
2722 * Only creates the inode if it is:
2723 * 1. Not a directory
2724 * 2. Or a directory which was not created already due to out of order
2725 * directories. See did_create_dir and process_recorded_refs for details.
2727 static int send_create_inode_if_needed(struct send_ctx *sctx)
2731 if (S_ISDIR(sctx->cur_inode_mode)) {
2732 ret = did_create_dir(sctx, sctx->cur_ino);
2741 ret = send_create_inode(sctx, sctx->cur_ino);
2749 struct recorded_ref {
2750 struct list_head list;
2752 struct fs_path *full_path;
2758 static void set_ref_path(struct recorded_ref *ref, struct fs_path *path)
2760 ref->full_path = path;
2761 ref->name = (char *)kbasename(ref->full_path->start);
2762 ref->name_len = ref->full_path->end - ref->name;
2766 * We need to process new refs before deleted refs, but compare_tree gives us
2767 * everything mixed. So we first record all refs and later process them.
2768 * This function is a helper to record one ref.
2770 static int __record_ref(struct list_head *head, u64 dir,
2771 u64 dir_gen, struct fs_path *path)
2773 struct recorded_ref *ref;
2775 ref = kmalloc(sizeof(*ref), GFP_KERNEL);
2780 ref->dir_gen = dir_gen;
2781 set_ref_path(ref, path);
2782 list_add_tail(&ref->list, head);
2786 static int dup_ref(struct recorded_ref *ref, struct list_head *list)
2788 struct recorded_ref *new;
2790 new = kmalloc(sizeof(*ref), GFP_KERNEL);
2794 new->dir = ref->dir;
2795 new->dir_gen = ref->dir_gen;
2796 new->full_path = NULL;
2797 INIT_LIST_HEAD(&new->list);
2798 list_add_tail(&new->list, list);
2802 static void __free_recorded_refs(struct list_head *head)
2804 struct recorded_ref *cur;
2806 while (!list_empty(head)) {
2807 cur = list_entry(head->next, struct recorded_ref, list);
2808 fs_path_free(cur->full_path);
2809 list_del(&cur->list);
2814 static void free_recorded_refs(struct send_ctx *sctx)
2816 __free_recorded_refs(&sctx->new_refs);
2817 __free_recorded_refs(&sctx->deleted_refs);
2821 * Renames/moves a file/dir to its orphan name. Used when the first
2822 * ref of an unprocessed inode gets overwritten and for all non empty
2825 static int orphanize_inode(struct send_ctx *sctx, u64 ino, u64 gen,
2826 struct fs_path *path)
2829 struct fs_path *orphan;
2831 orphan = fs_path_alloc();
2835 ret = gen_unique_name(sctx, ino, gen, orphan);
2839 ret = send_rename(sctx, path, orphan);
2842 fs_path_free(orphan);
2846 static struct orphan_dir_info *add_orphan_dir_info(struct send_ctx *sctx,
2847 u64 dir_ino, u64 dir_gen)
2849 struct rb_node **p = &sctx->orphan_dirs.rb_node;
2850 struct rb_node *parent = NULL;
2851 struct orphan_dir_info *entry, *odi;
2855 entry = rb_entry(parent, struct orphan_dir_info, node);
2856 if (dir_ino < entry->ino)
2858 else if (dir_ino > entry->ino)
2859 p = &(*p)->rb_right;
2860 else if (dir_gen < entry->gen)
2862 else if (dir_gen > entry->gen)
2863 p = &(*p)->rb_right;
2868 odi = kmalloc(sizeof(*odi), GFP_KERNEL);
2870 return ERR_PTR(-ENOMEM);
2873 odi->last_dir_index_offset = 0;
2875 rb_link_node(&odi->node, parent, p);
2876 rb_insert_color(&odi->node, &sctx->orphan_dirs);
2880 static struct orphan_dir_info *get_orphan_dir_info(struct send_ctx *sctx,
2881 u64 dir_ino, u64 gen)
2883 struct rb_node *n = sctx->orphan_dirs.rb_node;
2884 struct orphan_dir_info *entry;
2887 entry = rb_entry(n, struct orphan_dir_info, node);
2888 if (dir_ino < entry->ino)
2890 else if (dir_ino > entry->ino)
2892 else if (gen < entry->gen)
2894 else if (gen > entry->gen)
2902 static int is_waiting_for_rm(struct send_ctx *sctx, u64 dir_ino, u64 gen)
2904 struct orphan_dir_info *odi = get_orphan_dir_info(sctx, dir_ino, gen);
2909 static void free_orphan_dir_info(struct send_ctx *sctx,
2910 struct orphan_dir_info *odi)
2914 rb_erase(&odi->node, &sctx->orphan_dirs);
2919 * Returns 1 if a directory can be removed at this point in time.
2920 * We check this by iterating all dir items and checking if the inode behind
2921 * the dir item was already processed.
2923 static int can_rmdir(struct send_ctx *sctx, u64 dir, u64 dir_gen,
2927 struct btrfs_root *root = sctx->parent_root;
2928 struct btrfs_path *path;
2929 struct btrfs_key key;
2930 struct btrfs_key found_key;
2931 struct btrfs_key loc;
2932 struct btrfs_dir_item *di;
2933 struct orphan_dir_info *odi = NULL;
2936 * Don't try to rmdir the top/root subvolume dir.
2938 if (dir == BTRFS_FIRST_FREE_OBJECTID)
2941 path = alloc_path_for_send();
2946 key.type = BTRFS_DIR_INDEX_KEY;
2949 odi = get_orphan_dir_info(sctx, dir, dir_gen);
2951 key.offset = odi->last_dir_index_offset;
2953 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
2958 struct waiting_dir_move *dm;
2960 if (path->slots[0] >= btrfs_header_nritems(path->nodes[0])) {
2961 ret = btrfs_next_leaf(root, path);
2968 btrfs_item_key_to_cpu(path->nodes[0], &found_key,
2970 if (found_key.objectid != key.objectid ||
2971 found_key.type != key.type)
2974 di = btrfs_item_ptr(path->nodes[0], path->slots[0],
2975 struct btrfs_dir_item);
2976 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &loc);
2978 dm = get_waiting_dir_move(sctx, loc.objectid);
2980 odi = add_orphan_dir_info(sctx, dir, dir_gen);
2986 odi->last_dir_index_offset = found_key.offset;
2987 dm->rmdir_ino = dir;
2988 dm->rmdir_gen = dir_gen;
2993 if (loc.objectid > send_progress) {
2994 odi = add_orphan_dir_info(sctx, dir, dir_gen);
3000 odi->last_dir_index_offset = found_key.offset;
3007 free_orphan_dir_info(sctx, odi);
3012 btrfs_free_path(path);
3016 static int is_waiting_for_move(struct send_ctx *sctx, u64 ino)
3018 struct waiting_dir_move *entry = get_waiting_dir_move(sctx, ino);
3020 return entry != NULL;
3023 static int add_waiting_dir_move(struct send_ctx *sctx, u64 ino, bool orphanized)
3025 struct rb_node **p = &sctx->waiting_dir_moves.rb_node;
3026 struct rb_node *parent = NULL;
3027 struct waiting_dir_move *entry, *dm;
3029 dm = kmalloc(sizeof(*dm), GFP_KERNEL);
3035 dm->orphanized = orphanized;
3039 entry = rb_entry(parent, struct waiting_dir_move, node);
3040 if (ino < entry->ino) {
3042 } else if (ino > entry->ino) {
3043 p = &(*p)->rb_right;
3050 rb_link_node(&dm->node, parent, p);
3051 rb_insert_color(&dm->node, &sctx->waiting_dir_moves);
3055 static struct waiting_dir_move *
3056 get_waiting_dir_move(struct send_ctx *sctx, u64 ino)
3058 struct rb_node *n = sctx->waiting_dir_moves.rb_node;
3059 struct waiting_dir_move *entry;
3062 entry = rb_entry(n, struct waiting_dir_move, node);
3063 if (ino < entry->ino)
3065 else if (ino > entry->ino)
3073 static void free_waiting_dir_move(struct send_ctx *sctx,
3074 struct waiting_dir_move *dm)
3078 rb_erase(&dm->node, &sctx->waiting_dir_moves);
3082 static int add_pending_dir_move(struct send_ctx *sctx,
3086 struct list_head *new_refs,
3087 struct list_head *deleted_refs,
3088 const bool is_orphan)
3090 struct rb_node **p = &sctx->pending_dir_moves.rb_node;
3091 struct rb_node *parent = NULL;
3092 struct pending_dir_move *entry = NULL, *pm;
3093 struct recorded_ref *cur;
3097 pm = kmalloc(sizeof(*pm), GFP_KERNEL);
3100 pm->parent_ino = parent_ino;
3103 INIT_LIST_HEAD(&pm->list);
3104 INIT_LIST_HEAD(&pm->update_refs);
3105 RB_CLEAR_NODE(&pm->node);
3109 entry = rb_entry(parent, struct pending_dir_move, node);
3110 if (parent_ino < entry->parent_ino) {
3112 } else if (parent_ino > entry->parent_ino) {
3113 p = &(*p)->rb_right;
3120 list_for_each_entry(cur, deleted_refs, list) {
3121 ret = dup_ref(cur, &pm->update_refs);
3125 list_for_each_entry(cur, new_refs, list) {
3126 ret = dup_ref(cur, &pm->update_refs);
3131 ret = add_waiting_dir_move(sctx, pm->ino, is_orphan);
3136 list_add_tail(&pm->list, &entry->list);
3138 rb_link_node(&pm->node, parent, p);
3139 rb_insert_color(&pm->node, &sctx->pending_dir_moves);
3144 __free_recorded_refs(&pm->update_refs);
3150 static struct pending_dir_move *get_pending_dir_moves(struct send_ctx *sctx,
3153 struct rb_node *n = sctx->pending_dir_moves.rb_node;
3154 struct pending_dir_move *entry;
3157 entry = rb_entry(n, struct pending_dir_move, node);
3158 if (parent_ino < entry->parent_ino)
3160 else if (parent_ino > entry->parent_ino)
3168 static int path_loop(struct send_ctx *sctx, struct fs_path *name,
3169 u64 ino, u64 gen, u64 *ancestor_ino)
3172 u64 parent_inode = 0;
3174 u64 start_ino = ino;
3177 while (ino != BTRFS_FIRST_FREE_OBJECTID) {
3178 fs_path_reset(name);
3180 if (is_waiting_for_rm(sctx, ino, gen))
3182 if (is_waiting_for_move(sctx, ino)) {
3183 if (*ancestor_ino == 0)
3184 *ancestor_ino = ino;
3185 ret = get_first_ref(sctx->parent_root, ino,
3186 &parent_inode, &parent_gen, name);
3188 ret = __get_cur_name_and_parent(sctx, ino, gen,
3198 if (parent_inode == start_ino) {
3200 if (*ancestor_ino == 0)
3201 *ancestor_ino = ino;
3210 static int apply_dir_move(struct send_ctx *sctx, struct pending_dir_move *pm)
3212 struct fs_path *from_path = NULL;
3213 struct fs_path *to_path = NULL;
3214 struct fs_path *name = NULL;
3215 u64 orig_progress = sctx->send_progress;
3216 struct recorded_ref *cur;
3217 u64 parent_ino, parent_gen;
3218 struct waiting_dir_move *dm = NULL;
3225 name = fs_path_alloc();
3226 from_path = fs_path_alloc();
3227 if (!name || !from_path) {
3232 dm = get_waiting_dir_move(sctx, pm->ino);
3234 rmdir_ino = dm->rmdir_ino;
3235 rmdir_gen = dm->rmdir_gen;
3236 is_orphan = dm->orphanized;
3237 free_waiting_dir_move(sctx, dm);
3240 ret = gen_unique_name(sctx, pm->ino,
3241 pm->gen, from_path);
3243 ret = get_first_ref(sctx->parent_root, pm->ino,
3244 &parent_ino, &parent_gen, name);
3247 ret = get_cur_path(sctx, parent_ino, parent_gen,
3251 ret = fs_path_add_path(from_path, name);
3256 sctx->send_progress = sctx->cur_ino + 1;
3257 ret = path_loop(sctx, name, pm->ino, pm->gen, &ancestor);
3261 LIST_HEAD(deleted_refs);
3262 ASSERT(ancestor > BTRFS_FIRST_FREE_OBJECTID);
3263 ret = add_pending_dir_move(sctx, pm->ino, pm->gen, ancestor,
3264 &pm->update_refs, &deleted_refs,
3269 dm = get_waiting_dir_move(sctx, pm->ino);
3271 dm->rmdir_ino = rmdir_ino;
3272 dm->rmdir_gen = rmdir_gen;
3276 fs_path_reset(name);
3279 ret = get_cur_path(sctx, pm->ino, pm->gen, to_path);
3283 ret = send_rename(sctx, from_path, to_path);
3288 struct orphan_dir_info *odi;
3291 odi = get_orphan_dir_info(sctx, rmdir_ino, rmdir_gen);
3293 /* already deleted */
3298 ret = can_rmdir(sctx, rmdir_ino, gen, sctx->cur_ino);
3304 name = fs_path_alloc();
3309 ret = get_cur_path(sctx, rmdir_ino, gen, name);
3312 ret = send_rmdir(sctx, name);
3318 ret = send_utimes(sctx, pm->ino, pm->gen);
3323 * After rename/move, need to update the utimes of both new parent(s)
3324 * and old parent(s).
3326 list_for_each_entry(cur, &pm->update_refs, list) {
3328 * The parent inode might have been deleted in the send snapshot
3330 ret = get_inode_info(sctx->send_root, cur->dir, NULL,
3331 NULL, NULL, NULL, NULL, NULL);
3332 if (ret == -ENOENT) {
3339 ret = send_utimes(sctx, cur->dir, cur->dir_gen);
3346 fs_path_free(from_path);
3347 fs_path_free(to_path);
3348 sctx->send_progress = orig_progress;
3353 static void free_pending_move(struct send_ctx *sctx, struct pending_dir_move *m)
3355 if (!list_empty(&m->list))
3357 if (!RB_EMPTY_NODE(&m->node))
3358 rb_erase(&m->node, &sctx->pending_dir_moves);
3359 __free_recorded_refs(&m->update_refs);
3363 static void tail_append_pending_moves(struct send_ctx *sctx,
3364 struct pending_dir_move *moves,
3365 struct list_head *stack)
3367 if (list_empty(&moves->list)) {
3368 list_add_tail(&moves->list, stack);
3371 list_splice_init(&moves->list, &list);
3372 list_add_tail(&moves->list, stack);
3373 list_splice_tail(&list, stack);
3375 if (!RB_EMPTY_NODE(&moves->node)) {
3376 rb_erase(&moves->node, &sctx->pending_dir_moves);
3377 RB_CLEAR_NODE(&moves->node);
3381 static int apply_children_dir_moves(struct send_ctx *sctx)
3383 struct pending_dir_move *pm;
3384 struct list_head stack;
3385 u64 parent_ino = sctx->cur_ino;
3388 pm = get_pending_dir_moves(sctx, parent_ino);
3392 INIT_LIST_HEAD(&stack);
3393 tail_append_pending_moves(sctx, pm, &stack);
3395 while (!list_empty(&stack)) {
3396 pm = list_first_entry(&stack, struct pending_dir_move, list);
3397 parent_ino = pm->ino;
3398 ret = apply_dir_move(sctx, pm);
3399 free_pending_move(sctx, pm);
3402 pm = get_pending_dir_moves(sctx, parent_ino);
3404 tail_append_pending_moves(sctx, pm, &stack);
3409 while (!list_empty(&stack)) {
3410 pm = list_first_entry(&stack, struct pending_dir_move, list);
3411 free_pending_move(sctx, pm);
3417 * We might need to delay a directory rename even when no ancestor directory
3418 * (in the send root) with a higher inode number than ours (sctx->cur_ino) was
3419 * renamed. This happens when we rename a directory to the old name (the name
3420 * in the parent root) of some other unrelated directory that got its rename
3421 * delayed due to some ancestor with higher number that got renamed.
3427 * |---- a/ (ino 257)
3428 * | |---- file (ino 260)
3430 * |---- b/ (ino 258)
3431 * |---- c/ (ino 259)
3435 * |---- a/ (ino 258)
3436 * |---- x/ (ino 259)
3437 * |---- y/ (ino 257)
3438 * |----- file (ino 260)
3440 * Here we can not rename 258 from 'b' to 'a' without the rename of inode 257
3441 * from 'a' to 'x/y' happening first, which in turn depends on the rename of
3442 * inode 259 from 'c' to 'x'. So the order of rename commands the send stream
3445 * 1 - rename 259 from 'c' to 'x'
3446 * 2 - rename 257 from 'a' to 'x/y'
3447 * 3 - rename 258 from 'b' to 'a'
3449 * Returns 1 if the rename of sctx->cur_ino needs to be delayed, 0 if it can
3450 * be done right away and < 0 on error.
3452 static int wait_for_dest_dir_move(struct send_ctx *sctx,
3453 struct recorded_ref *parent_ref,
3454 const bool is_orphan)
3456 struct btrfs_fs_info *fs_info = sctx->parent_root->fs_info;
3457 struct btrfs_path *path;
3458 struct btrfs_key key;
3459 struct btrfs_key di_key;
3460 struct btrfs_dir_item *di;
3464 struct waiting_dir_move *wdm;
3466 if (RB_EMPTY_ROOT(&sctx->waiting_dir_moves))
3469 path = alloc_path_for_send();
3473 key.objectid = parent_ref->dir;
3474 key.type = BTRFS_DIR_ITEM_KEY;
3475 key.offset = btrfs_name_hash(parent_ref->name, parent_ref->name_len);
3477 ret = btrfs_search_slot(NULL, sctx->parent_root, &key, path, 0, 0);
3480 } else if (ret > 0) {
3485 di = btrfs_match_dir_item_name(fs_info, path, parent_ref->name,
3486 parent_ref->name_len);
3492 * di_key.objectid has the number of the inode that has a dentry in the
3493 * parent directory with the same name that sctx->cur_ino is being
3494 * renamed to. We need to check if that inode is in the send root as
3495 * well and if it is currently marked as an inode with a pending rename,
3496 * if it is, we need to delay the rename of sctx->cur_ino as well, so
3497 * that it happens after that other inode is renamed.
3499 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &di_key);
3500 if (di_key.type != BTRFS_INODE_ITEM_KEY) {
3505 ret = get_inode_info(sctx->parent_root, di_key.objectid, NULL,
3506 &left_gen, NULL, NULL, NULL, NULL);
3509 ret = get_inode_info(sctx->send_root, di_key.objectid, NULL,
3510 &right_gen, NULL, NULL, NULL, NULL);
3517 /* Different inode, no need to delay the rename of sctx->cur_ino */
3518 if (right_gen != left_gen) {
3523 wdm = get_waiting_dir_move(sctx, di_key.objectid);
3524 if (wdm && !wdm->orphanized) {
3525 ret = add_pending_dir_move(sctx,
3527 sctx->cur_inode_gen,
3530 &sctx->deleted_refs,
3536 btrfs_free_path(path);
3541 * Check if inode ino2, or any of its ancestors, is inode ino1.
3542 * Return 1 if true, 0 if false and < 0 on error.
3544 static int check_ino_in_path(struct btrfs_root *root,
3549 struct fs_path *fs_path)
3554 return ino1_gen == ino2_gen;
3556 while (ino > BTRFS_FIRST_FREE_OBJECTID) {
3561 fs_path_reset(fs_path);
3562 ret = get_first_ref(root, ino, &parent, &parent_gen, fs_path);
3566 return parent_gen == ino1_gen;
3573 * Check if ino ino1 is an ancestor of inode ino2 in the given root for any
3574 * possible path (in case ino2 is not a directory and has multiple hard links).
3575 * Return 1 if true, 0 if false and < 0 on error.
3577 static int is_ancestor(struct btrfs_root *root,
3581 struct fs_path *fs_path)
3583 bool free_fs_path = false;
3585 struct btrfs_path *path = NULL;
3586 struct btrfs_key key;
3589 fs_path = fs_path_alloc();
3592 free_fs_path = true;
3595 path = alloc_path_for_send();
3601 key.objectid = ino2;
3602 key.type = BTRFS_INODE_REF_KEY;
3605 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
3610 struct extent_buffer *leaf = path->nodes[0];
3611 int slot = path->slots[0];
3615 if (slot >= btrfs_header_nritems(leaf)) {
3616 ret = btrfs_next_leaf(root, path);
3624 btrfs_item_key_to_cpu(leaf, &key, slot);
3625 if (key.objectid != ino2)
3627 if (key.type != BTRFS_INODE_REF_KEY &&
3628 key.type != BTRFS_INODE_EXTREF_KEY)
3631 item_size = btrfs_item_size_nr(leaf, slot);
3632 while (cur_offset < item_size) {
3636 if (key.type == BTRFS_INODE_EXTREF_KEY) {
3638 struct btrfs_inode_extref *extref;
3640 ptr = btrfs_item_ptr_offset(leaf, slot);
3641 extref = (struct btrfs_inode_extref *)
3643 parent = btrfs_inode_extref_parent(leaf,
3645 cur_offset += sizeof(*extref);
3646 cur_offset += btrfs_inode_extref_name_len(leaf,
3649 parent = key.offset;
3650 cur_offset = item_size;
3653 ret = get_inode_info(root, parent, NULL, &parent_gen,
3654 NULL, NULL, NULL, NULL);
3657 ret = check_ino_in_path(root, ino1, ino1_gen,
3658 parent, parent_gen, fs_path);
3666 btrfs_free_path(path);
3668 fs_path_free(fs_path);
3672 static int wait_for_parent_move(struct send_ctx *sctx,
3673 struct recorded_ref *parent_ref,
3674 const bool is_orphan)
3677 u64 ino = parent_ref->dir;
3678 u64 ino_gen = parent_ref->dir_gen;
3679 u64 parent_ino_before, parent_ino_after;
3680 struct fs_path *path_before = NULL;
3681 struct fs_path *path_after = NULL;
3684 path_after = fs_path_alloc();
3685 path_before = fs_path_alloc();
3686 if (!path_after || !path_before) {
3692 * Our current directory inode may not yet be renamed/moved because some
3693 * ancestor (immediate or not) has to be renamed/moved first. So find if
3694 * such ancestor exists and make sure our own rename/move happens after
3695 * that ancestor is processed to avoid path build infinite loops (done
3696 * at get_cur_path()).
3698 while (ino > BTRFS_FIRST_FREE_OBJECTID) {
3699 u64 parent_ino_after_gen;
3701 if (is_waiting_for_move(sctx, ino)) {
3703 * If the current inode is an ancestor of ino in the
3704 * parent root, we need to delay the rename of the
3705 * current inode, otherwise don't delayed the rename
3706 * because we can end up with a circular dependency
3707 * of renames, resulting in some directories never
3708 * getting the respective rename operations issued in
3709 * the send stream or getting into infinite path build
3712 ret = is_ancestor(sctx->parent_root,
3713 sctx->cur_ino, sctx->cur_inode_gen,
3719 fs_path_reset(path_before);
3720 fs_path_reset(path_after);
3722 ret = get_first_ref(sctx->send_root, ino, &parent_ino_after,
3723 &parent_ino_after_gen, path_after);
3726 ret = get_first_ref(sctx->parent_root, ino, &parent_ino_before,
3728 if (ret < 0 && ret != -ENOENT) {
3730 } else if (ret == -ENOENT) {
3735 len1 = fs_path_len(path_before);
3736 len2 = fs_path_len(path_after);
3737 if (ino > sctx->cur_ino &&
3738 (parent_ino_before != parent_ino_after || len1 != len2 ||
3739 memcmp(path_before->start, path_after->start, len1))) {
3742 ret = get_inode_info(sctx->parent_root, ino, NULL,
3743 &parent_ino_gen, NULL, NULL, NULL,
3747 if (ino_gen == parent_ino_gen) {
3752 ino = parent_ino_after;
3753 ino_gen = parent_ino_after_gen;
3757 fs_path_free(path_before);
3758 fs_path_free(path_after);
3761 ret = add_pending_dir_move(sctx,
3763 sctx->cur_inode_gen,
3766 &sctx->deleted_refs,
3775 static int update_ref_path(struct send_ctx *sctx, struct recorded_ref *ref)
3778 struct fs_path *new_path;
3781 * Our reference's name member points to its full_path member string, so
3782 * we use here a new path.
3784 new_path = fs_path_alloc();
3788 ret = get_cur_path(sctx, ref->dir, ref->dir_gen, new_path);
3790 fs_path_free(new_path);
3793 ret = fs_path_add(new_path, ref->name, ref->name_len);
3795 fs_path_free(new_path);
3799 fs_path_free(ref->full_path);
3800 set_ref_path(ref, new_path);
3806 * When processing the new references for an inode we may orphanize an existing
3807 * directory inode because its old name conflicts with one of the new references
3808 * of the current inode. Later, when processing another new reference of our
3809 * inode, we might need to orphanize another inode, but the path we have in the
3810 * reference reflects the pre-orphanization name of the directory we previously
3811 * orphanized. For example:
3813 * parent snapshot looks like:
3816 * |----- f1 (ino 257)
3817 * |----- f2 (ino 258)
3818 * |----- d1/ (ino 259)
3819 * |----- d2/ (ino 260)
3821 * send snapshot looks like:
3824 * |----- d1 (ino 258)
3825 * |----- f2/ (ino 259)
3826 * |----- f2_link/ (ino 260)
3827 * | |----- f1 (ino 257)
3829 * |----- d2 (ino 258)
3831 * When processing inode 257 we compute the name for inode 259 as "d1", and we
3832 * cache it in the name cache. Later when we start processing inode 258, when
3833 * collecting all its new references we set a full path of "d1/d2" for its new
3834 * reference with name "d2". When we start processing the new references we
3835 * start by processing the new reference with name "d1", and this results in
3836 * orphanizing inode 259, since its old reference causes a conflict. Then we
3837 * move on the next new reference, with name "d2", and we find out we must
3838 * orphanize inode 260, as its old reference conflicts with ours - but for the
3839 * orphanization we use a source path corresponding to the path we stored in the
3840 * new reference, which is "d1/d2" and not "o259-6-0/d2" - this makes the
3841 * receiver fail since the path component "d1/" no longer exists, it was renamed
3842 * to "o259-6-0/" when processing the previous new reference. So in this case we
3843 * must recompute the path in the new reference and use it for the new
3844 * orphanization operation.
3846 static int refresh_ref_path(struct send_ctx *sctx, struct recorded_ref *ref)
3851 name = kmemdup(ref->name, ref->name_len, GFP_KERNEL);
3855 fs_path_reset(ref->full_path);
3856 ret = get_cur_path(sctx, ref->dir, ref->dir_gen, ref->full_path);
3860 ret = fs_path_add(ref->full_path, name, ref->name_len);
3864 /* Update the reference's base name pointer. */
3865 set_ref_path(ref, ref->full_path);
3872 * This does all the move/link/unlink/rmdir magic.
3874 static int process_recorded_refs(struct send_ctx *sctx, int *pending_move)
3876 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
3878 struct recorded_ref *cur;
3879 struct recorded_ref *cur2;
3880 struct list_head check_dirs;
3881 struct fs_path *valid_path = NULL;
3885 int did_overwrite = 0;
3887 u64 last_dir_ino_rm = 0;
3888 bool can_rename = true;
3889 bool orphanized_dir = false;
3890 bool orphanized_ancestor = false;
3892 btrfs_debug(fs_info, "process_recorded_refs %llu", sctx->cur_ino);
3895 * This should never happen as the root dir always has the same ref
3896 * which is always '..'
3898 BUG_ON(sctx->cur_ino <= BTRFS_FIRST_FREE_OBJECTID);
3899 INIT_LIST_HEAD(&check_dirs);
3901 valid_path = fs_path_alloc();
3908 * First, check if the first ref of the current inode was overwritten
3909 * before. If yes, we know that the current inode was already orphanized
3910 * and thus use the orphan name. If not, we can use get_cur_path to
3911 * get the path of the first ref as it would like while receiving at
3912 * this point in time.
3913 * New inodes are always orphan at the beginning, so force to use the
3914 * orphan name in this case.
3915 * The first ref is stored in valid_path and will be updated if it
3916 * gets moved around.
3918 if (!sctx->cur_inode_new) {
3919 ret = did_overwrite_first_ref(sctx, sctx->cur_ino,
3920 sctx->cur_inode_gen);
3926 if (sctx->cur_inode_new || did_overwrite) {
3927 ret = gen_unique_name(sctx, sctx->cur_ino,
3928 sctx->cur_inode_gen, valid_path);
3933 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen,
3940 * Before doing any rename and link operations, do a first pass on the
3941 * new references to orphanize any unprocessed inodes that may have a
3942 * reference that conflicts with one of the new references of the current
3943 * inode. This needs to happen first because a new reference may conflict
3944 * with the old reference of a parent directory, so we must make sure
3945 * that the path used for link and rename commands don't use an
3946 * orphanized name when an ancestor was not yet orphanized.
3953 * |----- testdir/ (ino 259)
3954 * | |----- a (ino 257)
3956 * |----- b (ino 258)
3961 * |----- testdir_2/ (ino 259)
3962 * | |----- a (ino 260)
3964 * |----- testdir (ino 257)
3965 * |----- b (ino 257)
3966 * |----- b2 (ino 258)
3968 * Processing the new reference for inode 257 with name "b" may happen
3969 * before processing the new reference with name "testdir". If so, we
3970 * must make sure that by the time we send a link command to create the
3971 * hard link "b", inode 259 was already orphanized, since the generated
3972 * path in "valid_path" already contains the orphanized name for 259.
3973 * We are processing inode 257, so only later when processing 259 we do
3974 * the rename operation to change its temporary (orphanized) name to
3977 list_for_each_entry(cur, &sctx->new_refs, list) {
3978 ret = get_cur_inode_state(sctx, cur->dir, cur->dir_gen);
3981 if (ret == inode_state_will_create)
3985 * Check if this new ref would overwrite the first ref of another
3986 * unprocessed inode. If yes, orphanize the overwritten inode.
3987 * If we find an overwritten ref that is not the first ref,
3990 ret = will_overwrite_ref(sctx, cur->dir, cur->dir_gen,
3991 cur->name, cur->name_len,
3992 &ow_inode, &ow_gen, &ow_mode);
3996 ret = is_first_ref(sctx->parent_root,
3997 ow_inode, cur->dir, cur->name,
4002 struct name_cache_entry *nce;
4003 struct waiting_dir_move *wdm;
4005 if (orphanized_dir) {
4006 ret = refresh_ref_path(sctx, cur);
4011 ret = orphanize_inode(sctx, ow_inode, ow_gen,
4015 if (S_ISDIR(ow_mode))
4016 orphanized_dir = true;
4019 * If ow_inode has its rename operation delayed
4020 * make sure that its orphanized name is used in
4021 * the source path when performing its rename
4024 if (is_waiting_for_move(sctx, ow_inode)) {
4025 wdm = get_waiting_dir_move(sctx,
4028 wdm->orphanized = true;
4032 * Make sure we clear our orphanized inode's
4033 * name from the name cache. This is because the
4034 * inode ow_inode might be an ancestor of some
4035 * other inode that will be orphanized as well
4036 * later and has an inode number greater than
4037 * sctx->send_progress. We need to prevent
4038 * future name lookups from using the old name
4039 * and get instead the orphan name.
4041 nce = name_cache_search(sctx, ow_inode, ow_gen);
4043 name_cache_delete(sctx, nce);
4048 * ow_inode might currently be an ancestor of
4049 * cur_ino, therefore compute valid_path (the
4050 * current path of cur_ino) again because it
4051 * might contain the pre-orphanization name of
4052 * ow_inode, which is no longer valid.
4054 ret = is_ancestor(sctx->parent_root,
4056 sctx->cur_ino, NULL);
4058 orphanized_ancestor = true;
4059 fs_path_reset(valid_path);
4060 ret = get_cur_path(sctx, sctx->cur_ino,
4061 sctx->cur_inode_gen,
4067 ret = send_unlink(sctx, cur->full_path);
4075 list_for_each_entry(cur, &sctx->new_refs, list) {
4077 * We may have refs where the parent directory does not exist
4078 * yet. This happens if the parent directories inum is higher
4079 * than the current inum. To handle this case, we create the
4080 * parent directory out of order. But we need to check if this
4081 * did already happen before due to other refs in the same dir.
4083 ret = get_cur_inode_state(sctx, cur->dir, cur->dir_gen);
4086 if (ret == inode_state_will_create) {
4089 * First check if any of the current inodes refs did
4090 * already create the dir.
4092 list_for_each_entry(cur2, &sctx->new_refs, list) {
4095 if (cur2->dir == cur->dir) {
4102 * If that did not happen, check if a previous inode
4103 * did already create the dir.
4106 ret = did_create_dir(sctx, cur->dir);
4110 ret = send_create_inode(sctx, cur->dir);
4116 if (S_ISDIR(sctx->cur_inode_mode) && sctx->parent_root) {
4117 ret = wait_for_dest_dir_move(sctx, cur, is_orphan);
4126 if (S_ISDIR(sctx->cur_inode_mode) && sctx->parent_root &&
4128 ret = wait_for_parent_move(sctx, cur, is_orphan);
4138 * link/move the ref to the new place. If we have an orphan
4139 * inode, move it and update valid_path. If not, link or move
4140 * it depending on the inode mode.
4142 if (is_orphan && can_rename) {
4143 ret = send_rename(sctx, valid_path, cur->full_path);
4147 ret = fs_path_copy(valid_path, cur->full_path);
4150 } else if (can_rename) {
4151 if (S_ISDIR(sctx->cur_inode_mode)) {
4153 * Dirs can't be linked, so move it. For moved
4154 * dirs, we always have one new and one deleted
4155 * ref. The deleted ref is ignored later.
4157 ret = send_rename(sctx, valid_path,
4160 ret = fs_path_copy(valid_path,
4166 * We might have previously orphanized an inode
4167 * which is an ancestor of our current inode,
4168 * so our reference's full path, which was
4169 * computed before any such orphanizations, must
4172 if (orphanized_dir) {
4173 ret = update_ref_path(sctx, cur);
4177 ret = send_link(sctx, cur->full_path,
4183 ret = dup_ref(cur, &check_dirs);
4188 if (S_ISDIR(sctx->cur_inode_mode) && sctx->cur_inode_deleted) {
4190 * Check if we can already rmdir the directory. If not,
4191 * orphanize it. For every dir item inside that gets deleted
4192 * later, we do this check again and rmdir it then if possible.
4193 * See the use of check_dirs for more details.
4195 ret = can_rmdir(sctx, sctx->cur_ino, sctx->cur_inode_gen,
4200 ret = send_rmdir(sctx, valid_path);
4203 } else if (!is_orphan) {
4204 ret = orphanize_inode(sctx, sctx->cur_ino,
4205 sctx->cur_inode_gen, valid_path);
4211 list_for_each_entry(cur, &sctx->deleted_refs, list) {
4212 ret = dup_ref(cur, &check_dirs);
4216 } else if (S_ISDIR(sctx->cur_inode_mode) &&
4217 !list_empty(&sctx->deleted_refs)) {
4219 * We have a moved dir. Add the old parent to check_dirs
4221 cur = list_entry(sctx->deleted_refs.next, struct recorded_ref,
4223 ret = dup_ref(cur, &check_dirs);
4226 } else if (!S_ISDIR(sctx->cur_inode_mode)) {
4228 * We have a non dir inode. Go through all deleted refs and
4229 * unlink them if they were not already overwritten by other
4232 list_for_each_entry(cur, &sctx->deleted_refs, list) {
4233 ret = did_overwrite_ref(sctx, cur->dir, cur->dir_gen,
4234 sctx->cur_ino, sctx->cur_inode_gen,
4235 cur->name, cur->name_len);
4240 * If we orphanized any ancestor before, we need
4241 * to recompute the full path for deleted names,
4242 * since any such path was computed before we
4243 * processed any references and orphanized any
4246 if (orphanized_ancestor) {
4247 ret = update_ref_path(sctx, cur);
4251 ret = send_unlink(sctx, cur->full_path);
4255 ret = dup_ref(cur, &check_dirs);
4260 * If the inode is still orphan, unlink the orphan. This may
4261 * happen when a previous inode did overwrite the first ref
4262 * of this inode and no new refs were added for the current
4263 * inode. Unlinking does not mean that the inode is deleted in
4264 * all cases. There may still be links to this inode in other
4268 ret = send_unlink(sctx, valid_path);
4275 * We did collect all parent dirs where cur_inode was once located. We
4276 * now go through all these dirs and check if they are pending for
4277 * deletion and if it's finally possible to perform the rmdir now.
4278 * We also update the inode stats of the parent dirs here.
4280 list_for_each_entry(cur, &check_dirs, list) {
4282 * In case we had refs into dirs that were not processed yet,
4283 * we don't need to do the utime and rmdir logic for these dirs.
4284 * The dir will be processed later.
4286 if (cur->dir > sctx->cur_ino)
4289 ret = get_cur_inode_state(sctx, cur->dir, cur->dir_gen);
4293 if (ret == inode_state_did_create ||
4294 ret == inode_state_no_change) {
4295 /* TODO delayed utimes */
4296 ret = send_utimes(sctx, cur->dir, cur->dir_gen);
4299 } else if (ret == inode_state_did_delete &&
4300 cur->dir != last_dir_ino_rm) {
4301 ret = can_rmdir(sctx, cur->dir, cur->dir_gen,
4306 ret = get_cur_path(sctx, cur->dir,
4307 cur->dir_gen, valid_path);
4310 ret = send_rmdir(sctx, valid_path);
4313 last_dir_ino_rm = cur->dir;
4321 __free_recorded_refs(&check_dirs);
4322 free_recorded_refs(sctx);
4323 fs_path_free(valid_path);
4327 static int record_ref(struct btrfs_root *root, u64 dir, struct fs_path *name,
4328 void *ctx, struct list_head *refs)
4331 struct send_ctx *sctx = ctx;
4335 p = fs_path_alloc();
4339 ret = get_inode_info(root, dir, NULL, &gen, NULL, NULL,
4344 ret = get_cur_path(sctx, dir, gen, p);
4347 ret = fs_path_add_path(p, name);
4351 ret = __record_ref(refs, dir, gen, p);
4359 static int __record_new_ref(int num, u64 dir, int index,
4360 struct fs_path *name,
4363 struct send_ctx *sctx = ctx;
4364 return record_ref(sctx->send_root, dir, name, ctx, &sctx->new_refs);
4368 static int __record_deleted_ref(int num, u64 dir, int index,
4369 struct fs_path *name,
4372 struct send_ctx *sctx = ctx;
4373 return record_ref(sctx->parent_root, dir, name, ctx,
4374 &sctx->deleted_refs);
4377 static int record_new_ref(struct send_ctx *sctx)
4381 ret = iterate_inode_ref(sctx->send_root, sctx->left_path,
4382 sctx->cmp_key, 0, __record_new_ref, sctx);
4391 static int record_deleted_ref(struct send_ctx *sctx)
4395 ret = iterate_inode_ref(sctx->parent_root, sctx->right_path,
4396 sctx->cmp_key, 0, __record_deleted_ref, sctx);
4405 struct find_ref_ctx {
4408 struct btrfs_root *root;
4409 struct fs_path *name;
4413 static int __find_iref(int num, u64 dir, int index,
4414 struct fs_path *name,
4417 struct find_ref_ctx *ctx = ctx_;
4421 if (dir == ctx->dir && fs_path_len(name) == fs_path_len(ctx->name) &&
4422 strncmp(name->start, ctx->name->start, fs_path_len(name)) == 0) {
4424 * To avoid doing extra lookups we'll only do this if everything
4427 ret = get_inode_info(ctx->root, dir, NULL, &dir_gen, NULL,
4431 if (dir_gen != ctx->dir_gen)
4433 ctx->found_idx = num;
4439 static int find_iref(struct btrfs_root *root,
4440 struct btrfs_path *path,
4441 struct btrfs_key *key,
4442 u64 dir, u64 dir_gen, struct fs_path *name)
4445 struct find_ref_ctx ctx;
4449 ctx.dir_gen = dir_gen;
4453 ret = iterate_inode_ref(root, path, key, 0, __find_iref, &ctx);
4457 if (ctx.found_idx == -1)
4460 return ctx.found_idx;
4463 static int __record_changed_new_ref(int num, u64 dir, int index,
4464 struct fs_path *name,
4469 struct send_ctx *sctx = ctx;
4471 ret = get_inode_info(sctx->send_root, dir, NULL, &dir_gen, NULL,
4476 ret = find_iref(sctx->parent_root, sctx->right_path,
4477 sctx->cmp_key, dir, dir_gen, name);
4479 ret = __record_new_ref(num, dir, index, name, sctx);
4486 static int __record_changed_deleted_ref(int num, u64 dir, int index,
4487 struct fs_path *name,
4492 struct send_ctx *sctx = ctx;
4494 ret = get_inode_info(sctx->parent_root, dir, NULL, &dir_gen, NULL,
4499 ret = find_iref(sctx->send_root, sctx->left_path, sctx->cmp_key,
4500 dir, dir_gen, name);
4502 ret = __record_deleted_ref(num, dir, index, name, sctx);
4509 static int record_changed_ref(struct send_ctx *sctx)
4513 ret = iterate_inode_ref(sctx->send_root, sctx->left_path,
4514 sctx->cmp_key, 0, __record_changed_new_ref, sctx);
4517 ret = iterate_inode_ref(sctx->parent_root, sctx->right_path,
4518 sctx->cmp_key, 0, __record_changed_deleted_ref, sctx);
4528 * Record and process all refs at once. Needed when an inode changes the
4529 * generation number, which means that it was deleted and recreated.
4531 static int process_all_refs(struct send_ctx *sctx,
4532 enum btrfs_compare_tree_result cmd)
4535 struct btrfs_root *root;
4536 struct btrfs_path *path;
4537 struct btrfs_key key;
4538 struct btrfs_key found_key;
4539 struct extent_buffer *eb;
4541 iterate_inode_ref_t cb;
4542 int pending_move = 0;
4544 path = alloc_path_for_send();
4548 if (cmd == BTRFS_COMPARE_TREE_NEW) {
4549 root = sctx->send_root;
4550 cb = __record_new_ref;
4551 } else if (cmd == BTRFS_COMPARE_TREE_DELETED) {
4552 root = sctx->parent_root;
4553 cb = __record_deleted_ref;
4555 btrfs_err(sctx->send_root->fs_info,
4556 "Wrong command %d in process_all_refs", cmd);
4561 key.objectid = sctx->cmp_key->objectid;
4562 key.type = BTRFS_INODE_REF_KEY;
4564 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
4569 eb = path->nodes[0];
4570 slot = path->slots[0];
4571 if (slot >= btrfs_header_nritems(eb)) {
4572 ret = btrfs_next_leaf(root, path);
4580 btrfs_item_key_to_cpu(eb, &found_key, slot);
4582 if (found_key.objectid != key.objectid ||
4583 (found_key.type != BTRFS_INODE_REF_KEY &&
4584 found_key.type != BTRFS_INODE_EXTREF_KEY))
4587 ret = iterate_inode_ref(root, path, &found_key, 0, cb, sctx);
4593 btrfs_release_path(path);
4596 * We don't actually care about pending_move as we are simply
4597 * re-creating this inode and will be rename'ing it into place once we
4598 * rename the parent directory.
4600 ret = process_recorded_refs(sctx, &pending_move);
4602 btrfs_free_path(path);
4606 static int send_set_xattr(struct send_ctx *sctx,
4607 struct fs_path *path,
4608 const char *name, int name_len,
4609 const char *data, int data_len)
4613 ret = begin_cmd(sctx, BTRFS_SEND_C_SET_XATTR);
4617 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
4618 TLV_PUT_STRING(sctx, BTRFS_SEND_A_XATTR_NAME, name, name_len);
4619 TLV_PUT(sctx, BTRFS_SEND_A_XATTR_DATA, data, data_len);
4621 ret = send_cmd(sctx);
4628 static int send_remove_xattr(struct send_ctx *sctx,
4629 struct fs_path *path,
4630 const char *name, int name_len)
4634 ret = begin_cmd(sctx, BTRFS_SEND_C_REMOVE_XATTR);
4638 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
4639 TLV_PUT_STRING(sctx, BTRFS_SEND_A_XATTR_NAME, name, name_len);
4641 ret = send_cmd(sctx);
4648 static int __process_new_xattr(int num, struct btrfs_key *di_key,
4649 const char *name, int name_len,
4650 const char *data, int data_len,
4654 struct send_ctx *sctx = ctx;
4656 struct posix_acl_xattr_header dummy_acl;
4658 /* Capabilities are emitted by finish_inode_if_needed */
4659 if (!strncmp(name, XATTR_NAME_CAPS, name_len))
4662 p = fs_path_alloc();
4667 * This hack is needed because empty acls are stored as zero byte
4668 * data in xattrs. Problem with that is, that receiving these zero byte
4669 * acls will fail later. To fix this, we send a dummy acl list that
4670 * only contains the version number and no entries.
4672 if (!strncmp(name, XATTR_NAME_POSIX_ACL_ACCESS, name_len) ||
4673 !strncmp(name, XATTR_NAME_POSIX_ACL_DEFAULT, name_len)) {
4674 if (data_len == 0) {
4675 dummy_acl.a_version =
4676 cpu_to_le32(POSIX_ACL_XATTR_VERSION);
4677 data = (char *)&dummy_acl;
4678 data_len = sizeof(dummy_acl);
4682 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, p);
4686 ret = send_set_xattr(sctx, p, name, name_len, data, data_len);
4693 static int __process_deleted_xattr(int num, struct btrfs_key *di_key,
4694 const char *name, int name_len,
4695 const char *data, int data_len,
4699 struct send_ctx *sctx = ctx;
4702 p = fs_path_alloc();
4706 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, p);
4710 ret = send_remove_xattr(sctx, p, name, name_len);
4717 static int process_new_xattr(struct send_ctx *sctx)
4721 ret = iterate_dir_item(sctx->send_root, sctx->left_path,
4722 __process_new_xattr, sctx);
4727 static int process_deleted_xattr(struct send_ctx *sctx)
4729 return iterate_dir_item(sctx->parent_root, sctx->right_path,
4730 __process_deleted_xattr, sctx);
4733 struct find_xattr_ctx {
4741 static int __find_xattr(int num, struct btrfs_key *di_key,
4742 const char *name, int name_len,
4743 const char *data, int data_len,
4744 u8 type, void *vctx)
4746 struct find_xattr_ctx *ctx = vctx;
4748 if (name_len == ctx->name_len &&
4749 strncmp(name, ctx->name, name_len) == 0) {
4750 ctx->found_idx = num;
4751 ctx->found_data_len = data_len;
4752 ctx->found_data = kmemdup(data, data_len, GFP_KERNEL);
4753 if (!ctx->found_data)
4760 static int find_xattr(struct btrfs_root *root,
4761 struct btrfs_path *path,
4762 struct btrfs_key *key,
4763 const char *name, int name_len,
4764 char **data, int *data_len)
4767 struct find_xattr_ctx ctx;
4770 ctx.name_len = name_len;
4772 ctx.found_data = NULL;
4773 ctx.found_data_len = 0;
4775 ret = iterate_dir_item(root, path, __find_xattr, &ctx);
4779 if (ctx.found_idx == -1)
4782 *data = ctx.found_data;
4783 *data_len = ctx.found_data_len;
4785 kfree(ctx.found_data);
4787 return ctx.found_idx;
4791 static int __process_changed_new_xattr(int num, struct btrfs_key *di_key,
4792 const char *name, int name_len,
4793 const char *data, int data_len,
4797 struct send_ctx *sctx = ctx;
4798 char *found_data = NULL;
4799 int found_data_len = 0;
4801 ret = find_xattr(sctx->parent_root, sctx->right_path,
4802 sctx->cmp_key, name, name_len, &found_data,
4804 if (ret == -ENOENT) {
4805 ret = __process_new_xattr(num, di_key, name, name_len, data,
4806 data_len, type, ctx);
4807 } else if (ret >= 0) {
4808 if (data_len != found_data_len ||
4809 memcmp(data, found_data, data_len)) {
4810 ret = __process_new_xattr(num, di_key, name, name_len,
4811 data, data_len, type, ctx);
4821 static int __process_changed_deleted_xattr(int num, struct btrfs_key *di_key,
4822 const char *name, int name_len,
4823 const char *data, int data_len,
4827 struct send_ctx *sctx = ctx;
4829 ret = find_xattr(sctx->send_root, sctx->left_path, sctx->cmp_key,
4830 name, name_len, NULL, NULL);
4832 ret = __process_deleted_xattr(num, di_key, name, name_len, data,
4833 data_len, type, ctx);
4840 static int process_changed_xattr(struct send_ctx *sctx)
4844 ret = iterate_dir_item(sctx->send_root, sctx->left_path,
4845 __process_changed_new_xattr, sctx);
4848 ret = iterate_dir_item(sctx->parent_root, sctx->right_path,
4849 __process_changed_deleted_xattr, sctx);
4855 static int process_all_new_xattrs(struct send_ctx *sctx)
4858 struct btrfs_root *root;
4859 struct btrfs_path *path;
4860 struct btrfs_key key;
4861 struct btrfs_key found_key;
4862 struct extent_buffer *eb;
4865 path = alloc_path_for_send();
4869 root = sctx->send_root;
4871 key.objectid = sctx->cmp_key->objectid;
4872 key.type = BTRFS_XATTR_ITEM_KEY;
4874 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
4879 eb = path->nodes[0];
4880 slot = path->slots[0];
4881 if (slot >= btrfs_header_nritems(eb)) {
4882 ret = btrfs_next_leaf(root, path);
4885 } else if (ret > 0) {
4892 btrfs_item_key_to_cpu(eb, &found_key, slot);
4893 if (found_key.objectid != key.objectid ||
4894 found_key.type != key.type) {
4899 ret = iterate_dir_item(root, path, __process_new_xattr, sctx);
4907 btrfs_free_path(path);
4911 static inline u64 max_send_read_size(const struct send_ctx *sctx)
4913 return sctx->send_max_size - SZ_16K;
4916 static int put_data_header(struct send_ctx *sctx, u32 len)
4918 struct btrfs_tlv_header *hdr;
4920 if (sctx->send_max_size - sctx->send_size < sizeof(*hdr) + len)
4922 hdr = (struct btrfs_tlv_header *)(sctx->send_buf + sctx->send_size);
4923 put_unaligned_le16(BTRFS_SEND_A_DATA, &hdr->tlv_type);
4924 put_unaligned_le16(len, &hdr->tlv_len);
4925 sctx->send_size += sizeof(*hdr);
4929 static int put_file_data(struct send_ctx *sctx, u64 offset, u32 len)
4931 struct btrfs_root *root = sctx->send_root;
4932 struct btrfs_fs_info *fs_info = root->fs_info;
4933 struct inode *inode;
4936 pgoff_t index = offset >> PAGE_SHIFT;
4938 unsigned pg_offset = offset_in_page(offset);
4941 ret = put_data_header(sctx, len);
4945 inode = btrfs_iget(fs_info->sb, sctx->cur_ino, root);
4947 return PTR_ERR(inode);
4949 last_index = (offset + len - 1) >> PAGE_SHIFT;
4951 /* initial readahead */
4952 memset(&sctx->ra, 0, sizeof(struct file_ra_state));
4953 file_ra_state_init(&sctx->ra, inode->i_mapping);
4955 while (index <= last_index) {
4956 unsigned cur_len = min_t(unsigned, len,
4957 PAGE_SIZE - pg_offset);
4959 page = find_lock_page(inode->i_mapping, index);
4961 page_cache_sync_readahead(inode->i_mapping, &sctx->ra,
4962 NULL, index, last_index + 1 - index);
4964 page = find_or_create_page(inode->i_mapping, index,
4972 if (PageReadahead(page)) {
4973 page_cache_async_readahead(inode->i_mapping, &sctx->ra,
4974 NULL, page, index, last_index + 1 - index);
4977 if (!PageUptodate(page)) {
4978 btrfs_readpage(NULL, page);
4980 if (!PageUptodate(page)) {
4989 memcpy(sctx->send_buf + sctx->send_size, addr + pg_offset,
4997 sctx->send_size += cur_len;
5004 * Read some bytes from the current inode/file and send a write command to
5007 static int send_write(struct send_ctx *sctx, u64 offset, u32 len)
5009 struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
5013 p = fs_path_alloc();
5017 btrfs_debug(fs_info, "send_write offset=%llu, len=%d", offset, len);
5019 ret = begin_cmd(sctx, BTRFS_SEND_C_WRITE);
5023 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, p);
5027 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
5028 TLV_PUT_U64(sctx, BTRFS_SEND_A_FILE_OFFSET, offset);
5029 ret = put_file_data(sctx, offset, len);
5033 ret = send_cmd(sctx);
5042 * Send a clone command to user space.
5044 static int send_clone(struct send_ctx *sctx,
5045 u64 offset, u32 len,
5046 struct clone_root *clone_root)
5052 btrfs_debug(sctx->send_root->fs_info,
5053 "send_clone offset=%llu, len=%d, clone_root=%llu, clone_inode=%llu, clone_offset=%llu",
5054 offset, len, clone_root->root->root_key.objectid,
5055 clone_root->ino, clone_root->offset);
5057 p = fs_path_alloc();
5061 ret = begin_cmd(sctx, BTRFS_SEND_C_CLONE);
5065 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, p);
5069 TLV_PUT_U64(sctx, BTRFS_SEND_A_FILE_OFFSET, offset);
5070 TLV_PUT_U64(sctx, BTRFS_SEND_A_CLONE_LEN, len);
5071 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
5073 if (clone_root->root == sctx->send_root) {
5074 ret = get_inode_info(sctx->send_root, clone_root->ino, NULL,
5075 &gen, NULL, NULL, NULL, NULL);
5078 ret = get_cur_path(sctx, clone_root->ino, gen, p);
5080 ret = get_inode_path(clone_root->root, clone_root->ino, p);
5086 * If the parent we're using has a received_uuid set then use that as
5087 * our clone source as that is what we will look for when doing a
5090 * This covers the case that we create a snapshot off of a received
5091 * subvolume and then use that as the parent and try to receive on a
5094 if (!btrfs_is_empty_uuid(clone_root->root->root_item.received_uuid))
5095 TLV_PUT_UUID(sctx, BTRFS_SEND_A_CLONE_UUID,
5096 clone_root->root->root_item.received_uuid);
5098 TLV_PUT_UUID(sctx, BTRFS_SEND_A_CLONE_UUID,
5099 clone_root->root->root_item.uuid);
5100 TLV_PUT_U64(sctx, BTRFS_SEND_A_CLONE_CTRANSID,
5101 btrfs_root_ctransid(&clone_root->root->root_item));
5102 TLV_PUT_PATH(sctx, BTRFS_SEND_A_CLONE_PATH, p);
5103 TLV_PUT_U64(sctx, BTRFS_SEND_A_CLONE_OFFSET,
5104 clone_root->offset);
5106 ret = send_cmd(sctx);
5115 * Send an update extent command to user space.
5117 static int send_update_extent(struct send_ctx *sctx,
5118 u64 offset, u32 len)
5123 p = fs_path_alloc();
5127 ret = begin_cmd(sctx, BTRFS_SEND_C_UPDATE_EXTENT);
5131 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, p);
5135 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
5136 TLV_PUT_U64(sctx, BTRFS_SEND_A_FILE_OFFSET, offset);
5137 TLV_PUT_U64(sctx, BTRFS_SEND_A_SIZE, len);
5139 ret = send_cmd(sctx);
5147 static int send_hole(struct send_ctx *sctx, u64 end)
5149 struct fs_path *p = NULL;
5150 u64 read_size = max_send_read_size(sctx);
5151 u64 offset = sctx->cur_inode_last_extent;
5155 * A hole that starts at EOF or beyond it. Since we do not yet support
5156 * fallocate (for extent preallocation and hole punching), sending a
5157 * write of zeroes starting at EOF or beyond would later require issuing
5158 * a truncate operation which would undo the write and achieve nothing.
5160 if (offset >= sctx->cur_inode_size)
5164 * Don't go beyond the inode's i_size due to prealloc extents that start
5167 end = min_t(u64, end, sctx->cur_inode_size);
5169 if (sctx->flags & BTRFS_SEND_FLAG_NO_FILE_DATA)
5170 return send_update_extent(sctx, offset, end - offset);
5172 p = fs_path_alloc();
5175 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, p);
5177 goto tlv_put_failure;
5178 while (offset < end) {
5179 u64 len = min(end - offset, read_size);
5181 ret = begin_cmd(sctx, BTRFS_SEND_C_WRITE);
5184 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
5185 TLV_PUT_U64(sctx, BTRFS_SEND_A_FILE_OFFSET, offset);
5186 ret = put_data_header(sctx, len);
5189 memset(sctx->send_buf + sctx->send_size, 0, len);
5190 sctx->send_size += len;
5191 ret = send_cmd(sctx);
5196 sctx->cur_inode_next_write_offset = offset;
5202 static int send_extent_data(struct send_ctx *sctx,
5206 u64 read_size = max_send_read_size(sctx);
5209 if (sctx->flags & BTRFS_SEND_FLAG_NO_FILE_DATA)
5210 return send_update_extent(sctx, offset, len);
5212 while (sent < len) {
5213 u64 size = min(len - sent, read_size);
5216 ret = send_write(sctx, offset + sent, size);
5225 * Search for a capability xattr related to sctx->cur_ino. If the capability is
5226 * found, call send_set_xattr function to emit it.
5228 * Return 0 if there isn't a capability, or when the capability was emitted
5229 * successfully, or < 0 if an error occurred.
5231 static int send_capabilities(struct send_ctx *sctx)
5233 struct fs_path *fspath = NULL;
5234 struct btrfs_path *path;
5235 struct btrfs_dir_item *di;
5236 struct extent_buffer *leaf;
5237 unsigned long data_ptr;
5242 path = alloc_path_for_send();
5246 di = btrfs_lookup_xattr(NULL, sctx->send_root, path, sctx->cur_ino,
5247 XATTR_NAME_CAPS, strlen(XATTR_NAME_CAPS), 0);
5249 /* There is no xattr for this inode */
5251 } else if (IS_ERR(di)) {
5256 leaf = path->nodes[0];
5257 buf_len = btrfs_dir_data_len(leaf, di);
5259 fspath = fs_path_alloc();
5260 buf = kmalloc(buf_len, GFP_KERNEL);
5261 if (!fspath || !buf) {
5266 ret = get_cur_path(sctx, sctx->cur_ino, sctx->cur_inode_gen, fspath);
5270 data_ptr = (unsigned long)(di + 1) + btrfs_dir_name_len(leaf, di);
5271 read_extent_buffer(leaf, buf, data_ptr, buf_len);
5273 ret = send_set_xattr(sctx, fspath, XATTR_NAME_CAPS,
5274 strlen(XATTR_NAME_CAPS), buf, buf_len);
5277 fs_path_free(fspath);
5278 btrfs_free_path(path);
5282 static int clone_range(struct send_ctx *sctx,
5283 struct clone_root *clone_root,
5284 const u64 disk_byte,
5289 struct btrfs_path *path;
5290 struct btrfs_key key;
5292 u64 clone_src_i_size = 0;
5295 * Prevent cloning from a zero offset with a length matching the sector
5296 * size because in some scenarios this will make the receiver fail.
5298 * For example, if in the source filesystem the extent at offset 0
5299 * has a length of sectorsize and it was written using direct IO, then
5300 * it can never be an inline extent (even if compression is enabled).
5301 * Then this extent can be cloned in the original filesystem to a non
5302 * zero file offset, but it may not be possible to clone in the
5303 * destination filesystem because it can be inlined due to compression
5304 * on the destination filesystem (as the receiver's write operations are
5305 * always done using buffered IO). The same happens when the original
5306 * filesystem does not have compression enabled but the destination
5309 if (clone_root->offset == 0 &&
5310 len == sctx->send_root->fs_info->sectorsize)
5311 return send_extent_data(sctx, offset, len);
5313 path = alloc_path_for_send();
5318 * There are inodes that have extents that lie behind its i_size. Don't
5319 * accept clones from these extents.
5321 ret = __get_inode_info(clone_root->root, path, clone_root->ino,
5322 &clone_src_i_size, NULL, NULL, NULL, NULL, NULL);
5323 btrfs_release_path(path);
5328 * We can't send a clone operation for the entire range if we find
5329 * extent items in the respective range in the source file that
5330 * refer to different extents or if we find holes.
5331 * So check for that and do a mix of clone and regular write/copy
5332 * operations if needed.
5336 * mkfs.btrfs -f /dev/sda
5337 * mount /dev/sda /mnt
5338 * xfs_io -f -c "pwrite -S 0xaa 0K 100K" /mnt/foo
5339 * cp --reflink=always /mnt/foo /mnt/bar
5340 * xfs_io -c "pwrite -S 0xbb 50K 50K" /mnt/foo
5341 * btrfs subvolume snapshot -r /mnt /mnt/snap
5343 * If when we send the snapshot and we are processing file bar (which
5344 * has a higher inode number than foo) we blindly send a clone operation
5345 * for the [0, 100K[ range from foo to bar, the receiver ends up getting
5346 * a file bar that matches the content of file foo - iow, doesn't match
5347 * the content from bar in the original filesystem.
5349 key.objectid = clone_root->ino;
5350 key.type = BTRFS_EXTENT_DATA_KEY;
5351 key.offset = clone_root->offset;
5352 ret = btrfs_search_slot(NULL, clone_root->root, &key, path, 0, 0);
5355 if (ret > 0 && path->slots[0] > 0) {
5356 btrfs_item_key_to_cpu(path->nodes[0], &key, path->slots[0] - 1);
5357 if (key.objectid == clone_root->ino &&
5358 key.type == BTRFS_EXTENT_DATA_KEY)
5363 struct extent_buffer *leaf = path->nodes[0];
5364 int slot = path->slots[0];
5365 struct btrfs_file_extent_item *ei;
5369 u64 clone_data_offset;
5371 if (slot >= btrfs_header_nritems(leaf)) {
5372 ret = btrfs_next_leaf(clone_root->root, path);
5380 btrfs_item_key_to_cpu(leaf, &key, slot);
5383 * We might have an implicit trailing hole (NO_HOLES feature
5384 * enabled). We deal with it after leaving this loop.
5386 if (key.objectid != clone_root->ino ||
5387 key.type != BTRFS_EXTENT_DATA_KEY)
5390 ei = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
5391 type = btrfs_file_extent_type(leaf, ei);
5392 if (type == BTRFS_FILE_EXTENT_INLINE) {
5393 ext_len = btrfs_file_extent_ram_bytes(leaf, ei);
5394 ext_len = PAGE_ALIGN(ext_len);
5396 ext_len = btrfs_file_extent_num_bytes(leaf, ei);
5399 if (key.offset + ext_len <= clone_root->offset)
5402 if (key.offset > clone_root->offset) {
5403 /* Implicit hole, NO_HOLES feature enabled. */
5404 u64 hole_len = key.offset - clone_root->offset;
5408 ret = send_extent_data(sctx, offset, hole_len);
5416 clone_root->offset += hole_len;
5417 data_offset += hole_len;
5420 if (key.offset >= clone_root->offset + len)
5423 if (key.offset >= clone_src_i_size)
5426 if (key.offset + ext_len > clone_src_i_size)
5427 ext_len = clone_src_i_size - key.offset;
5429 clone_data_offset = btrfs_file_extent_offset(leaf, ei);
5430 if (btrfs_file_extent_disk_bytenr(leaf, ei) == disk_byte) {
5431 clone_root->offset = key.offset;
5432 if (clone_data_offset < data_offset &&
5433 clone_data_offset + ext_len > data_offset) {
5436 extent_offset = data_offset - clone_data_offset;
5437 ext_len -= extent_offset;
5438 clone_data_offset += extent_offset;
5439 clone_root->offset += extent_offset;
5443 clone_len = min_t(u64, ext_len, len);
5445 if (btrfs_file_extent_disk_bytenr(leaf, ei) == disk_byte &&
5446 clone_data_offset == data_offset) {
5447 const u64 src_end = clone_root->offset + clone_len;
5448 const u64 sectorsize = SZ_64K;
5451 * We can't clone the last block, when its size is not
5452 * sector size aligned, into the middle of a file. If we
5453 * do so, the receiver will get a failure (-EINVAL) when
5454 * trying to clone or will silently corrupt the data in
5455 * the destination file if it's on a kernel without the
5456 * fix introduced by commit ac765f83f1397646
5457 * ("Btrfs: fix data corruption due to cloning of eof
5460 * So issue a clone of the aligned down range plus a
5461 * regular write for the eof block, if we hit that case.
5463 * Also, we use the maximum possible sector size, 64K,
5464 * because we don't know what's the sector size of the
5465 * filesystem that receives the stream, so we have to
5466 * assume the largest possible sector size.
5468 if (src_end == clone_src_i_size &&
5469 !IS_ALIGNED(src_end, sectorsize) &&
5470 offset + clone_len < sctx->cur_inode_size) {
5473 slen = ALIGN_DOWN(src_end - clone_root->offset,
5476 ret = send_clone(sctx, offset, slen,
5481 ret = send_extent_data(sctx, offset + slen,
5484 ret = send_clone(sctx, offset, clone_len,
5488 ret = send_extent_data(sctx, offset, clone_len);
5497 offset += clone_len;
5498 clone_root->offset += clone_len;
5501 * If we are cloning from the file we are currently processing,
5502 * and using the send root as the clone root, we must stop once
5503 * the current clone offset reaches the current eof of the file
5504 * at the receiver, otherwise we would issue an invalid clone
5505 * operation (source range going beyond eof) and cause the
5506 * receiver to fail. So if we reach the current eof, bail out
5507 * and fallback to a regular write.
5509 if (clone_root->root == sctx->send_root &&
5510 clone_root->ino == sctx->cur_ino &&
5511 clone_root->offset >= sctx->cur_inode_next_write_offset)
5514 data_offset += clone_len;
5520 ret = send_extent_data(sctx, offset, len);
5524 btrfs_free_path(path);
5528 static int send_write_or_clone(struct send_ctx *sctx,
5529 struct btrfs_path *path,
5530 struct btrfs_key *key,
5531 struct clone_root *clone_root)
5534 u64 offset = key->offset;
5536 u64 bs = sctx->send_root->fs_info->sb->s_blocksize;
5538 end = min_t(u64, btrfs_file_extent_end(path), sctx->cur_inode_size);
5542 if (clone_root && IS_ALIGNED(end, bs)) {
5543 struct btrfs_file_extent_item *ei;
5547 ei = btrfs_item_ptr(path->nodes[0], path->slots[0],
5548 struct btrfs_file_extent_item);
5549 disk_byte = btrfs_file_extent_disk_bytenr(path->nodes[0], ei);
5550 data_offset = btrfs_file_extent_offset(path->nodes[0], ei);
5551 ret = clone_range(sctx, clone_root, disk_byte, data_offset,
5552 offset, end - offset);
5554 ret = send_extent_data(sctx, offset, end - offset);
5556 sctx->cur_inode_next_write_offset = end;
5560 static int is_extent_unchanged(struct send_ctx *sctx,
5561 struct btrfs_path *left_path,
5562 struct btrfs_key *ekey)
5565 struct btrfs_key key;
5566 struct btrfs_path *path = NULL;
5567 struct extent_buffer *eb;
5569 struct btrfs_key found_key;
5570 struct btrfs_file_extent_item *ei;
5575 u64 left_offset_fixed;
5583 path = alloc_path_for_send();
5587 eb = left_path->nodes[0];
5588 slot = left_path->slots[0];
5589 ei = btrfs_item_ptr(eb, slot, struct btrfs_file_extent_item);
5590 left_type = btrfs_file_extent_type(eb, ei);
5592 if (left_type != BTRFS_FILE_EXTENT_REG) {
5596 left_disknr = btrfs_file_extent_disk_bytenr(eb, ei);
5597 left_len = btrfs_file_extent_num_bytes(eb, ei);
5598 left_offset = btrfs_file_extent_offset(eb, ei);
5599 left_gen = btrfs_file_extent_generation(eb, ei);
5602 * Following comments will refer to these graphics. L is the left
5603 * extents which we are checking at the moment. 1-8 are the right
5604 * extents that we iterate.
5607 * |-1-|-2a-|-3-|-4-|-5-|-6-|
5610 * |--1--|-2b-|...(same as above)
5612 * Alternative situation. Happens on files where extents got split.
5614 * |-----------7-----------|-6-|
5616 * Alternative situation. Happens on files which got larger.
5619 * Nothing follows after 8.
5622 key.objectid = ekey->objectid;
5623 key.type = BTRFS_EXTENT_DATA_KEY;
5624 key.offset = ekey->offset;
5625 ret = btrfs_search_slot_for_read(sctx->parent_root, &key, path, 0, 0);
5634 * Handle special case where the right side has no extents at all.
5636 eb = path->nodes[0];
5637 slot = path->slots[0];
5638 btrfs_item_key_to_cpu(eb, &found_key, slot);
5639 if (found_key.objectid != key.objectid ||
5640 found_key.type != key.type) {
5641 /* If we're a hole then just pretend nothing changed */
5642 ret = (left_disknr) ? 0 : 1;
5647 * We're now on 2a, 2b or 7.
5650 while (key.offset < ekey->offset + left_len) {
5651 ei = btrfs_item_ptr(eb, slot, struct btrfs_file_extent_item);
5652 right_type = btrfs_file_extent_type(eb, ei);
5653 if (right_type != BTRFS_FILE_EXTENT_REG &&
5654 right_type != BTRFS_FILE_EXTENT_INLINE) {
5659 if (right_type == BTRFS_FILE_EXTENT_INLINE) {
5660 right_len = btrfs_file_extent_ram_bytes(eb, ei);
5661 right_len = PAGE_ALIGN(right_len);
5663 right_len = btrfs_file_extent_num_bytes(eb, ei);
5667 * Are we at extent 8? If yes, we know the extent is changed.
5668 * This may only happen on the first iteration.
5670 if (found_key.offset + right_len <= ekey->offset) {
5671 /* If we're a hole just pretend nothing changed */
5672 ret = (left_disknr) ? 0 : 1;
5677 * We just wanted to see if when we have an inline extent, what
5678 * follows it is a regular extent (wanted to check the above
5679 * condition for inline extents too). This should normally not
5680 * happen but it's possible for example when we have an inline
5681 * compressed extent representing data with a size matching
5682 * the page size (currently the same as sector size).
5684 if (right_type == BTRFS_FILE_EXTENT_INLINE) {
5689 right_disknr = btrfs_file_extent_disk_bytenr(eb, ei);
5690 right_offset = btrfs_file_extent_offset(eb, ei);
5691 right_gen = btrfs_file_extent_generation(eb, ei);
5693 left_offset_fixed = left_offset;
5694 if (key.offset < ekey->offset) {
5695 /* Fix the right offset for 2a and 7. */
5696 right_offset += ekey->offset - key.offset;
5698 /* Fix the left offset for all behind 2a and 2b */
5699 left_offset_fixed += key.offset - ekey->offset;
5703 * Check if we have the same extent.
5705 if (left_disknr != right_disknr ||
5706 left_offset_fixed != right_offset ||
5707 left_gen != right_gen) {
5713 * Go to the next extent.
5715 ret = btrfs_next_item(sctx->parent_root, path);
5719 eb = path->nodes[0];
5720 slot = path->slots[0];
5721 btrfs_item_key_to_cpu(eb, &found_key, slot);
5723 if (ret || found_key.objectid != key.objectid ||
5724 found_key.type != key.type) {
5725 key.offset += right_len;
5728 if (found_key.offset != key.offset + right_len) {
5736 * We're now behind the left extent (treat as unchanged) or at the end
5737 * of the right side (treat as changed).
5739 if (key.offset >= ekey->offset + left_len)
5746 btrfs_free_path(path);
5750 static int get_last_extent(struct send_ctx *sctx, u64 offset)
5752 struct btrfs_path *path;
5753 struct btrfs_root *root = sctx->send_root;
5754 struct btrfs_key key;
5757 path = alloc_path_for_send();
5761 sctx->cur_inode_last_extent = 0;
5763 key.objectid = sctx->cur_ino;
5764 key.type = BTRFS_EXTENT_DATA_KEY;
5765 key.offset = offset;
5766 ret = btrfs_search_slot_for_read(root, &key, path, 0, 1);
5770 btrfs_item_key_to_cpu(path->nodes[0], &key, path->slots[0]);
5771 if (key.objectid != sctx->cur_ino || key.type != BTRFS_EXTENT_DATA_KEY)
5774 sctx->cur_inode_last_extent = btrfs_file_extent_end(path);
5776 btrfs_free_path(path);
5780 static int range_is_hole_in_parent(struct send_ctx *sctx,
5784 struct btrfs_path *path;
5785 struct btrfs_key key;
5786 struct btrfs_root *root = sctx->parent_root;
5787 u64 search_start = start;
5790 path = alloc_path_for_send();
5794 key.objectid = sctx->cur_ino;
5795 key.type = BTRFS_EXTENT_DATA_KEY;
5796 key.offset = search_start;
5797 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
5800 if (ret > 0 && path->slots[0] > 0)
5803 while (search_start < end) {
5804 struct extent_buffer *leaf = path->nodes[0];
5805 int slot = path->slots[0];
5806 struct btrfs_file_extent_item *fi;
5809 if (slot >= btrfs_header_nritems(leaf)) {
5810 ret = btrfs_next_leaf(root, path);
5818 btrfs_item_key_to_cpu(leaf, &key, slot);
5819 if (key.objectid < sctx->cur_ino ||
5820 key.type < BTRFS_EXTENT_DATA_KEY)
5822 if (key.objectid > sctx->cur_ino ||
5823 key.type > BTRFS_EXTENT_DATA_KEY ||
5827 fi = btrfs_item_ptr(leaf, slot, struct btrfs_file_extent_item);
5828 extent_end = btrfs_file_extent_end(path);
5829 if (extent_end <= start)
5831 if (btrfs_file_extent_disk_bytenr(leaf, fi) == 0) {
5832 search_start = extent_end;
5842 btrfs_free_path(path);
5846 static int maybe_send_hole(struct send_ctx *sctx, struct btrfs_path *path,
5847 struct btrfs_key *key)
5851 if (sctx->cur_ino != key->objectid || !need_send_hole(sctx))
5854 if (sctx->cur_inode_last_extent == (u64)-1) {
5855 ret = get_last_extent(sctx, key->offset - 1);
5860 if (path->slots[0] == 0 &&
5861 sctx->cur_inode_last_extent < key->offset) {
5863 * We might have skipped entire leafs that contained only
5864 * file extent items for our current inode. These leafs have
5865 * a generation number smaller (older) than the one in the
5866 * current leaf and the leaf our last extent came from, and
5867 * are located between these 2 leafs.
5869 ret = get_last_extent(sctx, key->offset - 1);
5874 if (sctx->cur_inode_last_extent < key->offset) {
5875 ret = range_is_hole_in_parent(sctx,
5876 sctx->cur_inode_last_extent,
5881 ret = send_hole(sctx, key->offset);
5885 sctx->cur_inode_last_extent = btrfs_file_extent_end(path);
5889 static int process_extent(struct send_ctx *sctx,
5890 struct btrfs_path *path,
5891 struct btrfs_key *key)
5893 struct clone_root *found_clone = NULL;
5896 if (S_ISLNK(sctx->cur_inode_mode))
5899 if (sctx->parent_root && !sctx->cur_inode_new) {
5900 ret = is_extent_unchanged(sctx, path, key);
5908 struct btrfs_file_extent_item *ei;
5911 ei = btrfs_item_ptr(path->nodes[0], path->slots[0],
5912 struct btrfs_file_extent_item);
5913 type = btrfs_file_extent_type(path->nodes[0], ei);
5914 if (type == BTRFS_FILE_EXTENT_PREALLOC ||
5915 type == BTRFS_FILE_EXTENT_REG) {
5917 * The send spec does not have a prealloc command yet,
5918 * so just leave a hole for prealloc'ed extents until
5919 * we have enough commands queued up to justify rev'ing
5922 if (type == BTRFS_FILE_EXTENT_PREALLOC) {
5927 /* Have a hole, just skip it. */
5928 if (btrfs_file_extent_disk_bytenr(path->nodes[0], ei) == 0) {
5935 ret = find_extent_clone(sctx, path, key->objectid, key->offset,
5936 sctx->cur_inode_size, &found_clone);
5937 if (ret != -ENOENT && ret < 0)
5940 ret = send_write_or_clone(sctx, path, key, found_clone);
5944 ret = maybe_send_hole(sctx, path, key);
5949 static int process_all_extents(struct send_ctx *sctx)
5952 struct btrfs_root *root;
5953 struct btrfs_path *path;
5954 struct btrfs_key key;
5955 struct btrfs_key found_key;
5956 struct extent_buffer *eb;
5959 root = sctx->send_root;
5960 path = alloc_path_for_send();
5964 key.objectid = sctx->cmp_key->objectid;
5965 key.type = BTRFS_EXTENT_DATA_KEY;
5967 ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
5972 eb = path->nodes[0];
5973 slot = path->slots[0];
5975 if (slot >= btrfs_header_nritems(eb)) {
5976 ret = btrfs_next_leaf(root, path);
5979 } else if (ret > 0) {
5986 btrfs_item_key_to_cpu(eb, &found_key, slot);
5988 if (found_key.objectid != key.objectid ||
5989 found_key.type != key.type) {
5994 ret = process_extent(sctx, path, &found_key);
6002 btrfs_free_path(path);
6006 static int process_recorded_refs_if_needed(struct send_ctx *sctx, int at_end,
6008 int *refs_processed)
6012 if (sctx->cur_ino == 0)
6014 if (!at_end && sctx->cur_ino == sctx->cmp_key->objectid &&
6015 sctx->cmp_key->type <= BTRFS_INODE_EXTREF_KEY)
6017 if (list_empty(&sctx->new_refs) && list_empty(&sctx->deleted_refs))
6020 ret = process_recorded_refs(sctx, pending_move);
6024 *refs_processed = 1;
6029 static int finish_inode_if_needed(struct send_ctx *sctx, int at_end)
6040 int need_truncate = 1;
6041 int pending_move = 0;
6042 int refs_processed = 0;
6044 if (sctx->ignore_cur_inode)
6047 ret = process_recorded_refs_if_needed(sctx, at_end, &pending_move,
6053 * We have processed the refs and thus need to advance send_progress.
6054 * Now, calls to get_cur_xxx will take the updated refs of the current
6055 * inode into account.
6057 * On the other hand, if our current inode is a directory and couldn't
6058 * be moved/renamed because its parent was renamed/moved too and it has
6059 * a higher inode number, we can only move/rename our current inode
6060 * after we moved/renamed its parent. Therefore in this case operate on
6061 * the old path (pre move/rename) of our current inode, and the
6062 * move/rename will be performed later.
6064 if (refs_processed && !pending_move)
6065 sctx->send_progress = sctx->cur_ino + 1;
6067 if (sctx->cur_ino == 0 || sctx->cur_inode_deleted)
6069 if (!at_end && sctx->cmp_key->objectid == sctx->cur_ino)
6072 ret = get_inode_info(sctx->send_root, sctx->cur_ino, NULL, NULL,
6073 &left_mode, &left_uid, &left_gid, NULL);
6077 if (!sctx->parent_root || sctx->cur_inode_new) {
6079 if (!S_ISLNK(sctx->cur_inode_mode))
6081 if (sctx->cur_inode_next_write_offset == sctx->cur_inode_size)
6086 ret = get_inode_info(sctx->parent_root, sctx->cur_ino,
6087 &old_size, NULL, &right_mode, &right_uid,
6092 if (left_uid != right_uid || left_gid != right_gid)
6094 if (!S_ISLNK(sctx->cur_inode_mode) && left_mode != right_mode)
6096 if ((old_size == sctx->cur_inode_size) ||
6097 (sctx->cur_inode_size > old_size &&
6098 sctx->cur_inode_next_write_offset == sctx->cur_inode_size))
6102 if (S_ISREG(sctx->cur_inode_mode)) {
6103 if (need_send_hole(sctx)) {
6104 if (sctx->cur_inode_last_extent == (u64)-1 ||
6105 sctx->cur_inode_last_extent <
6106 sctx->cur_inode_size) {
6107 ret = get_last_extent(sctx, (u64)-1);
6111 if (sctx->cur_inode_last_extent <
6112 sctx->cur_inode_size) {
6113 ret = send_hole(sctx, sctx->cur_inode_size);
6118 if (need_truncate) {
6119 ret = send_truncate(sctx, sctx->cur_ino,
6120 sctx->cur_inode_gen,
6121 sctx->cur_inode_size);
6128 ret = send_chown(sctx, sctx->cur_ino, sctx->cur_inode_gen,
6129 left_uid, left_gid);
6134 ret = send_chmod(sctx, sctx->cur_ino, sctx->cur_inode_gen,
6140 ret = send_capabilities(sctx);
6145 * If other directory inodes depended on our current directory
6146 * inode's move/rename, now do their move/rename operations.
6148 if (!is_waiting_for_move(sctx, sctx->cur_ino)) {
6149 ret = apply_children_dir_moves(sctx);
6153 * Need to send that every time, no matter if it actually
6154 * changed between the two trees as we have done changes to
6155 * the inode before. If our inode is a directory and it's
6156 * waiting to be moved/renamed, we will send its utimes when
6157 * it's moved/renamed, therefore we don't need to do it here.
6159 sctx->send_progress = sctx->cur_ino + 1;
6160 ret = send_utimes(sctx, sctx->cur_ino, sctx->cur_inode_gen);
6169 struct parent_paths_ctx {
6170 struct list_head *refs;
6171 struct send_ctx *sctx;
6174 static int record_parent_ref(int num, u64 dir, int index, struct fs_path *name,
6177 struct parent_paths_ctx *ppctx = ctx;
6179 return record_ref(ppctx->sctx->parent_root, dir, name, ppctx->sctx,
6184 * Issue unlink operations for all paths of the current inode found in the
6187 static int btrfs_unlink_all_paths(struct send_ctx *sctx)
6189 LIST_HEAD(deleted_refs);
6190 struct btrfs_path *path;
6191 struct btrfs_key key;
6192 struct parent_paths_ctx ctx;
6195 path = alloc_path_for_send();
6199 key.objectid = sctx->cur_ino;
6200 key.type = BTRFS_INODE_REF_KEY;
6202 ret = btrfs_search_slot(NULL, sctx->parent_root, &key, path, 0, 0);
6206 ctx.refs = &deleted_refs;
6210 struct extent_buffer *eb = path->nodes[0];
6211 int slot = path->slots[0];
6213 if (slot >= btrfs_header_nritems(eb)) {
6214 ret = btrfs_next_leaf(sctx->parent_root, path);
6222 btrfs_item_key_to_cpu(eb, &key, slot);
6223 if (key.objectid != sctx->cur_ino)
6225 if (key.type != BTRFS_INODE_REF_KEY &&
6226 key.type != BTRFS_INODE_EXTREF_KEY)
6229 ret = iterate_inode_ref(sctx->parent_root, path, &key, 1,
6230 record_parent_ref, &ctx);
6237 while (!list_empty(&deleted_refs)) {
6238 struct recorded_ref *ref;
6240 ref = list_first_entry(&deleted_refs, struct recorded_ref, list);
6241 ret = send_unlink(sctx, ref->full_path);
6244 fs_path_free(ref->full_path);
6245 list_del(&ref->list);
6250 btrfs_free_path(path);
6252 __free_recorded_refs(&deleted_refs);
6256 static int changed_inode(struct send_ctx *sctx,
6257 enum btrfs_compare_tree_result result)
6260 struct btrfs_key *key = sctx->cmp_key;
6261 struct btrfs_inode_item *left_ii = NULL;
6262 struct btrfs_inode_item *right_ii = NULL;
6266 sctx->cur_ino = key->objectid;
6267 sctx->cur_inode_new_gen = 0;
6268 sctx->cur_inode_last_extent = (u64)-1;
6269 sctx->cur_inode_next_write_offset = 0;
6270 sctx->ignore_cur_inode = false;
6273 * Set send_progress to current inode. This will tell all get_cur_xxx
6274 * functions that the current inode's refs are not updated yet. Later,
6275 * when process_recorded_refs is finished, it is set to cur_ino + 1.
6277 sctx->send_progress = sctx->cur_ino;
6279 if (result == BTRFS_COMPARE_TREE_NEW ||
6280 result == BTRFS_COMPARE_TREE_CHANGED) {
6281 left_ii = btrfs_item_ptr(sctx->left_path->nodes[0],
6282 sctx->left_path->slots[0],
6283 struct btrfs_inode_item);
6284 left_gen = btrfs_inode_generation(sctx->left_path->nodes[0],
6287 right_ii = btrfs_item_ptr(sctx->right_path->nodes[0],
6288 sctx->right_path->slots[0],
6289 struct btrfs_inode_item);
6290 right_gen = btrfs_inode_generation(sctx->right_path->nodes[0],
6293 if (result == BTRFS_COMPARE_TREE_CHANGED) {
6294 right_ii = btrfs_item_ptr(sctx->right_path->nodes[0],
6295 sctx->right_path->slots[0],
6296 struct btrfs_inode_item);
6298 right_gen = btrfs_inode_generation(sctx->right_path->nodes[0],
6302 * The cur_ino = root dir case is special here. We can't treat
6303 * the inode as deleted+reused because it would generate a
6304 * stream that tries to delete/mkdir the root dir.
6306 if (left_gen != right_gen &&
6307 sctx->cur_ino != BTRFS_FIRST_FREE_OBJECTID)
6308 sctx->cur_inode_new_gen = 1;
6312 * Normally we do not find inodes with a link count of zero (orphans)
6313 * because the most common case is to create a snapshot and use it
6314 * for a send operation. However other less common use cases involve
6315 * using a subvolume and send it after turning it to RO mode just
6316 * after deleting all hard links of a file while holding an open
6317 * file descriptor against it or turning a RO snapshot into RW mode,
6318 * keep an open file descriptor against a file, delete it and then
6319 * turn the snapshot back to RO mode before using it for a send
6320 * operation. So if we find such cases, ignore the inode and all its
6321 * items completely if it's a new inode, or if it's a changed inode
6322 * make sure all its previous paths (from the parent snapshot) are all
6323 * unlinked and all other the inode items are ignored.
6325 if (result == BTRFS_COMPARE_TREE_NEW ||
6326 result == BTRFS_COMPARE_TREE_CHANGED) {
6329 nlinks = btrfs_inode_nlink(sctx->left_path->nodes[0], left_ii);
6331 sctx->ignore_cur_inode = true;
6332 if (result == BTRFS_COMPARE_TREE_CHANGED)
6333 ret = btrfs_unlink_all_paths(sctx);
6338 if (result == BTRFS_COMPARE_TREE_NEW) {
6339 sctx->cur_inode_gen = left_gen;
6340 sctx->cur_inode_new = 1;
6341 sctx->cur_inode_deleted = 0;
6342 sctx->cur_inode_size = btrfs_inode_size(
6343 sctx->left_path->nodes[0], left_ii);
6344 sctx->cur_inode_mode = btrfs_inode_mode(
6345 sctx->left_path->nodes[0], left_ii);
6346 sctx->cur_inode_rdev = btrfs_inode_rdev(
6347 sctx->left_path->nodes[0], left_ii);
6348 if (sctx->cur_ino != BTRFS_FIRST_FREE_OBJECTID)
6349 ret = send_create_inode_if_needed(sctx);
6350 } else if (result == BTRFS_COMPARE_TREE_DELETED) {
6351 sctx->cur_inode_gen = right_gen;
6352 sctx->cur_inode_new = 0;
6353 sctx->cur_inode_deleted = 1;
6354 sctx->cur_inode_size = btrfs_inode_size(
6355 sctx->right_path->nodes[0], right_ii);
6356 sctx->cur_inode_mode = btrfs_inode_mode(
6357 sctx->right_path->nodes[0], right_ii);
6358 } else if (result == BTRFS_COMPARE_TREE_CHANGED) {
6360 * We need to do some special handling in case the inode was
6361 * reported as changed with a changed generation number. This
6362 * means that the original inode was deleted and new inode
6363 * reused the same inum. So we have to treat the old inode as
6364 * deleted and the new one as new.
6366 if (sctx->cur_inode_new_gen) {
6368 * First, process the inode as if it was deleted.
6370 sctx->cur_inode_gen = right_gen;
6371 sctx->cur_inode_new = 0;
6372 sctx->cur_inode_deleted = 1;
6373 sctx->cur_inode_size = btrfs_inode_size(
6374 sctx->right_path->nodes[0], right_ii);
6375 sctx->cur_inode_mode = btrfs_inode_mode(
6376 sctx->right_path->nodes[0], right_ii);
6377 ret = process_all_refs(sctx,
6378 BTRFS_COMPARE_TREE_DELETED);
6383 * Now process the inode as if it was new.
6385 sctx->cur_inode_gen = left_gen;
6386 sctx->cur_inode_new = 1;
6387 sctx->cur_inode_deleted = 0;
6388 sctx->cur_inode_size = btrfs_inode_size(
6389 sctx->left_path->nodes[0], left_ii);
6390 sctx->cur_inode_mode = btrfs_inode_mode(
6391 sctx->left_path->nodes[0], left_ii);
6392 sctx->cur_inode_rdev = btrfs_inode_rdev(
6393 sctx->left_path->nodes[0], left_ii);
6394 ret = send_create_inode_if_needed(sctx);
6398 ret = process_all_refs(sctx, BTRFS_COMPARE_TREE_NEW);
6402 * Advance send_progress now as we did not get into
6403 * process_recorded_refs_if_needed in the new_gen case.
6405 sctx->send_progress = sctx->cur_ino + 1;
6408 * Now process all extents and xattrs of the inode as if
6409 * they were all new.
6411 ret = process_all_extents(sctx);
6414 ret = process_all_new_xattrs(sctx);
6418 sctx->cur_inode_gen = left_gen;
6419 sctx->cur_inode_new = 0;
6420 sctx->cur_inode_new_gen = 0;
6421 sctx->cur_inode_deleted = 0;
6422 sctx->cur_inode_size = btrfs_inode_size(
6423 sctx->left_path->nodes[0], left_ii);
6424 sctx->cur_inode_mode = btrfs_inode_mode(
6425 sctx->left_path->nodes[0], left_ii);
6434 * We have to process new refs before deleted refs, but compare_trees gives us
6435 * the new and deleted refs mixed. To fix this, we record the new/deleted refs
6436 * first and later process them in process_recorded_refs.
6437 * For the cur_inode_new_gen case, we skip recording completely because
6438 * changed_inode did already initiate processing of refs. The reason for this is
6439 * that in this case, compare_tree actually compares the refs of 2 different
6440 * inodes. To fix this, process_all_refs is used in changed_inode to handle all
6441 * refs of the right tree as deleted and all refs of the left tree as new.
6443 static int changed_ref(struct send_ctx *sctx,
6444 enum btrfs_compare_tree_result result)
6448 if (sctx->cur_ino != sctx->cmp_key->objectid) {
6449 inconsistent_snapshot_error(sctx, result, "reference");
6453 if (!sctx->cur_inode_new_gen &&
6454 sctx->cur_ino != BTRFS_FIRST_FREE_OBJECTID) {
6455 if (result == BTRFS_COMPARE_TREE_NEW)
6456 ret = record_new_ref(sctx);
6457 else if (result == BTRFS_COMPARE_TREE_DELETED)
6458 ret = record_deleted_ref(sctx);
6459 else if (result == BTRFS_COMPARE_TREE_CHANGED)
6460 ret = record_changed_ref(sctx);
6467 * Process new/deleted/changed xattrs. We skip processing in the
6468 * cur_inode_new_gen case because changed_inode did already initiate processing
6469 * of xattrs. The reason is the same as in changed_ref
6471 static int changed_xattr(struct send_ctx *sctx,
6472 enum btrfs_compare_tree_result result)
6476 if (sctx->cur_ino != sctx->cmp_key->objectid) {
6477 inconsistent_snapshot_error(sctx, result, "xattr");
6481 if (!sctx->cur_inode_new_gen && !sctx->cur_inode_deleted) {
6482 if (result == BTRFS_COMPARE_TREE_NEW)
6483 ret = process_new_xattr(sctx);
6484 else if (result == BTRFS_COMPARE_TREE_DELETED)
6485 ret = process_deleted_xattr(sctx);
6486 else if (result == BTRFS_COMPARE_TREE_CHANGED)
6487 ret = process_changed_xattr(sctx);
6494 * Process new/deleted/changed extents. We skip processing in the
6495 * cur_inode_new_gen case because changed_inode did already initiate processing
6496 * of extents. The reason is the same as in changed_ref
6498 static int changed_extent(struct send_ctx *sctx,
6499 enum btrfs_compare_tree_result result)
6504 * We have found an extent item that changed without the inode item
6505 * having changed. This can happen either after relocation (where the
6506 * disk_bytenr of an extent item is replaced at
6507 * relocation.c:replace_file_extents()) or after deduplication into a
6508 * file in both the parent and send snapshots (where an extent item can
6509 * get modified or replaced with a new one). Note that deduplication
6510 * updates the inode item, but it only changes the iversion (sequence
6511 * field in the inode item) of the inode, so if a file is deduplicated
6512 * the same amount of times in both the parent and send snapshots, its
6513 * iversion becames the same in both snapshots, whence the inode item is
6514 * the same on both snapshots.
6516 if (sctx->cur_ino != sctx->cmp_key->objectid)
6519 if (!sctx->cur_inode_new_gen && !sctx->cur_inode_deleted) {
6520 if (result != BTRFS_COMPARE_TREE_DELETED)
6521 ret = process_extent(sctx, sctx->left_path,
6528 static int dir_changed(struct send_ctx *sctx, u64 dir)
6530 u64 orig_gen, new_gen;
6533 ret = get_inode_info(sctx->send_root, dir, NULL, &new_gen, NULL, NULL,
6538 ret = get_inode_info(sctx->parent_root, dir, NULL, &orig_gen, NULL,
6543 return (orig_gen != new_gen) ? 1 : 0;
6546 static int compare_refs(struct send_ctx *sctx, struct btrfs_path *path,
6547 struct btrfs_key *key)
6549 struct btrfs_inode_extref *extref;
6550 struct extent_buffer *leaf;
6551 u64 dirid = 0, last_dirid = 0;
6558 /* Easy case, just check this one dirid */
6559 if (key->type == BTRFS_INODE_REF_KEY) {
6560 dirid = key->offset;
6562 ret = dir_changed(sctx, dirid);
6566 leaf = path->nodes[0];
6567 item_size = btrfs_item_size_nr(leaf, path->slots[0]);
6568 ptr = btrfs_item_ptr_offset(leaf, path->slots[0]);
6569 while (cur_offset < item_size) {
6570 extref = (struct btrfs_inode_extref *)(ptr +
6572 dirid = btrfs_inode_extref_parent(leaf, extref);
6573 ref_name_len = btrfs_inode_extref_name_len(leaf, extref);
6574 cur_offset += ref_name_len + sizeof(*extref);
6575 if (dirid == last_dirid)
6577 ret = dir_changed(sctx, dirid);
6587 * Updates compare related fields in sctx and simply forwards to the actual
6588 * changed_xxx functions.
6590 static int changed_cb(struct btrfs_path *left_path,
6591 struct btrfs_path *right_path,
6592 struct btrfs_key *key,
6593 enum btrfs_compare_tree_result result,
6594 struct send_ctx *sctx)
6598 if (result == BTRFS_COMPARE_TREE_SAME) {
6599 if (key->type == BTRFS_INODE_REF_KEY ||
6600 key->type == BTRFS_INODE_EXTREF_KEY) {
6601 ret = compare_refs(sctx, left_path, key);
6606 } else if (key->type == BTRFS_EXTENT_DATA_KEY) {
6607 return maybe_send_hole(sctx, left_path, key);
6611 result = BTRFS_COMPARE_TREE_CHANGED;
6615 sctx->left_path = left_path;
6616 sctx->right_path = right_path;
6617 sctx->cmp_key = key;
6619 ret = finish_inode_if_needed(sctx, 0);
6623 /* Ignore non-FS objects */
6624 if (key->objectid == BTRFS_FREE_INO_OBJECTID ||
6625 key->objectid == BTRFS_FREE_SPACE_OBJECTID)
6628 if (key->type == BTRFS_INODE_ITEM_KEY) {
6629 ret = changed_inode(sctx, result);
6630 } else if (!sctx->ignore_cur_inode) {
6631 if (key->type == BTRFS_INODE_REF_KEY ||
6632 key->type == BTRFS_INODE_EXTREF_KEY)
6633 ret = changed_ref(sctx, result);
6634 else if (key->type == BTRFS_XATTR_ITEM_KEY)
6635 ret = changed_xattr(sctx, result);
6636 else if (key->type == BTRFS_EXTENT_DATA_KEY)
6637 ret = changed_extent(sctx, result);
6644 static int full_send_tree(struct send_ctx *sctx)
6647 struct btrfs_root *send_root = sctx->send_root;
6648 struct btrfs_key key;
6649 struct btrfs_path *path;
6650 struct extent_buffer *eb;
6653 path = alloc_path_for_send();
6657 key.objectid = BTRFS_FIRST_FREE_OBJECTID;
6658 key.type = BTRFS_INODE_ITEM_KEY;
6661 ret = btrfs_search_slot_for_read(send_root, &key, path, 1, 0);
6668 eb = path->nodes[0];
6669 slot = path->slots[0];
6670 btrfs_item_key_to_cpu(eb, &key, slot);
6672 ret = changed_cb(path, NULL, &key,
6673 BTRFS_COMPARE_TREE_NEW, sctx);
6677 ret = btrfs_next_item(send_root, path);
6687 ret = finish_inode_if_needed(sctx, 1);
6690 btrfs_free_path(path);
6694 static int tree_move_down(struct btrfs_path *path, int *level)
6696 struct extent_buffer *eb;
6698 BUG_ON(*level == 0);
6699 eb = btrfs_read_node_slot(path->nodes[*level], path->slots[*level]);
6703 path->nodes[*level - 1] = eb;
6704 path->slots[*level - 1] = 0;
6709 static int tree_move_next_or_upnext(struct btrfs_path *path,
6710 int *level, int root_level)
6714 nritems = btrfs_header_nritems(path->nodes[*level]);
6716 path->slots[*level]++;
6718 while (path->slots[*level] >= nritems) {
6719 if (*level == root_level)
6723 path->slots[*level] = 0;
6724 free_extent_buffer(path->nodes[*level]);
6725 path->nodes[*level] = NULL;
6727 path->slots[*level]++;
6729 nritems = btrfs_header_nritems(path->nodes[*level]);
6736 * Returns 1 if it had to move up and next. 0 is returned if it moved only next
6739 static int tree_advance(struct btrfs_path *path,
6740 int *level, int root_level,
6742 struct btrfs_key *key)
6746 if (*level == 0 || !allow_down) {
6747 ret = tree_move_next_or_upnext(path, level, root_level);
6749 ret = tree_move_down(path, level);
6753 btrfs_item_key_to_cpu(path->nodes[*level], key,
6754 path->slots[*level]);
6756 btrfs_node_key_to_cpu(path->nodes[*level], key,
6757 path->slots[*level]);
6762 static int tree_compare_item(struct btrfs_path *left_path,
6763 struct btrfs_path *right_path,
6768 unsigned long off1, off2;
6770 len1 = btrfs_item_size_nr(left_path->nodes[0], left_path->slots[0]);
6771 len2 = btrfs_item_size_nr(right_path->nodes[0], right_path->slots[0]);
6775 off1 = btrfs_item_ptr_offset(left_path->nodes[0], left_path->slots[0]);
6776 off2 = btrfs_item_ptr_offset(right_path->nodes[0],
6777 right_path->slots[0]);
6779 read_extent_buffer(left_path->nodes[0], tmp_buf, off1, len1);
6781 cmp = memcmp_extent_buffer(right_path->nodes[0], tmp_buf, off2, len1);
6788 * This function compares two trees and calls the provided callback for
6789 * every changed/new/deleted item it finds.
6790 * If shared tree blocks are encountered, whole subtrees are skipped, making
6791 * the compare pretty fast on snapshotted subvolumes.
6793 * This currently works on commit roots only. As commit roots are read only,
6794 * we don't do any locking. The commit roots are protected with transactions.
6795 * Transactions are ended and rejoined when a commit is tried in between.
6797 * This function checks for modifications done to the trees while comparing.
6798 * If it detects a change, it aborts immediately.
6800 static int btrfs_compare_trees(struct btrfs_root *left_root,
6801 struct btrfs_root *right_root, struct send_ctx *sctx)
6803 struct btrfs_fs_info *fs_info = left_root->fs_info;
6806 struct btrfs_path *left_path = NULL;
6807 struct btrfs_path *right_path = NULL;
6808 struct btrfs_key left_key;
6809 struct btrfs_key right_key;
6810 char *tmp_buf = NULL;
6811 int left_root_level;
6812 int right_root_level;
6815 int left_end_reached;
6816 int right_end_reached;
6824 left_path = btrfs_alloc_path();
6829 right_path = btrfs_alloc_path();
6835 tmp_buf = kvmalloc(fs_info->nodesize, GFP_KERNEL);
6841 left_path->search_commit_root = 1;
6842 left_path->skip_locking = 1;
6843 right_path->search_commit_root = 1;
6844 right_path->skip_locking = 1;
6847 * Strategy: Go to the first items of both trees. Then do
6849 * If both trees are at level 0
6850 * Compare keys of current items
6851 * If left < right treat left item as new, advance left tree
6853 * If left > right treat right item as deleted, advance right tree
6855 * If left == right do deep compare of items, treat as changed if
6856 * needed, advance both trees and repeat
6857 * If both trees are at the same level but not at level 0
6858 * Compare keys of current nodes/leafs
6859 * If left < right advance left tree and repeat
6860 * If left > right advance right tree and repeat
6861 * If left == right compare blockptrs of the next nodes/leafs
6862 * If they match advance both trees but stay at the same level
6864 * If they don't match advance both trees while allowing to go
6866 * If tree levels are different
6867 * Advance the tree that needs it and repeat
6869 * Advancing a tree means:
6870 * If we are at level 0, try to go to the next slot. If that's not
6871 * possible, go one level up and repeat. Stop when we found a level
6872 * where we could go to the next slot. We may at this point be on a
6875 * If we are not at level 0 and not on shared tree blocks, go one
6878 * If we are not at level 0 and on shared tree blocks, go one slot to
6879 * the right if possible or go up and right.
6882 down_read(&fs_info->commit_root_sem);
6883 left_level = btrfs_header_level(left_root->commit_root);
6884 left_root_level = left_level;
6885 left_path->nodes[left_level] =
6886 btrfs_clone_extent_buffer(left_root->commit_root);
6887 if (!left_path->nodes[left_level]) {
6888 up_read(&fs_info->commit_root_sem);
6893 right_level = btrfs_header_level(right_root->commit_root);
6894 right_root_level = right_level;
6895 right_path->nodes[right_level] =
6896 btrfs_clone_extent_buffer(right_root->commit_root);
6897 if (!right_path->nodes[right_level]) {
6898 up_read(&fs_info->commit_root_sem);
6902 up_read(&fs_info->commit_root_sem);
6904 if (left_level == 0)
6905 btrfs_item_key_to_cpu(left_path->nodes[left_level],
6906 &left_key, left_path->slots[left_level]);
6908 btrfs_node_key_to_cpu(left_path->nodes[left_level],
6909 &left_key, left_path->slots[left_level]);
6910 if (right_level == 0)
6911 btrfs_item_key_to_cpu(right_path->nodes[right_level],
6912 &right_key, right_path->slots[right_level]);
6914 btrfs_node_key_to_cpu(right_path->nodes[right_level],
6915 &right_key, right_path->slots[right_level]);
6917 left_end_reached = right_end_reached = 0;
6918 advance_left = advance_right = 0;
6922 if (advance_left && !left_end_reached) {
6923 ret = tree_advance(left_path, &left_level,
6925 advance_left != ADVANCE_ONLY_NEXT,
6928 left_end_reached = ADVANCE;
6933 if (advance_right && !right_end_reached) {
6934 ret = tree_advance(right_path, &right_level,
6936 advance_right != ADVANCE_ONLY_NEXT,
6939 right_end_reached = ADVANCE;
6945 if (left_end_reached && right_end_reached) {
6948 } else if (left_end_reached) {
6949 if (right_level == 0) {
6950 ret = changed_cb(left_path, right_path,
6952 BTRFS_COMPARE_TREE_DELETED,
6957 advance_right = ADVANCE;
6959 } else if (right_end_reached) {
6960 if (left_level == 0) {
6961 ret = changed_cb(left_path, right_path,
6963 BTRFS_COMPARE_TREE_NEW,
6968 advance_left = ADVANCE;
6972 if (left_level == 0 && right_level == 0) {
6973 cmp = btrfs_comp_cpu_keys(&left_key, &right_key);
6975 ret = changed_cb(left_path, right_path,
6977 BTRFS_COMPARE_TREE_NEW,
6981 advance_left = ADVANCE;
6982 } else if (cmp > 0) {
6983 ret = changed_cb(left_path, right_path,
6985 BTRFS_COMPARE_TREE_DELETED,
6989 advance_right = ADVANCE;
6991 enum btrfs_compare_tree_result result;
6993 WARN_ON(!extent_buffer_uptodate(left_path->nodes[0]));
6994 ret = tree_compare_item(left_path, right_path,
6997 result = BTRFS_COMPARE_TREE_CHANGED;
6999 result = BTRFS_COMPARE_TREE_SAME;
7000 ret = changed_cb(left_path, right_path,
7001 &left_key, result, sctx);
7004 advance_left = ADVANCE;
7005 advance_right = ADVANCE;
7007 } else if (left_level == right_level) {
7008 cmp = btrfs_comp_cpu_keys(&left_key, &right_key);
7010 advance_left = ADVANCE;
7011 } else if (cmp > 0) {
7012 advance_right = ADVANCE;
7014 left_blockptr = btrfs_node_blockptr(
7015 left_path->nodes[left_level],
7016 left_path->slots[left_level]);
7017 right_blockptr = btrfs_node_blockptr(
7018 right_path->nodes[right_level],
7019 right_path->slots[right_level]);
7020 left_gen = btrfs_node_ptr_generation(
7021 left_path->nodes[left_level],
7022 left_path->slots[left_level]);
7023 right_gen = btrfs_node_ptr_generation(
7024 right_path->nodes[right_level],
7025 right_path->slots[right_level]);
7026 if (left_blockptr == right_blockptr &&
7027 left_gen == right_gen) {
7029 * As we're on a shared block, don't
7030 * allow to go deeper.
7032 advance_left = ADVANCE_ONLY_NEXT;
7033 advance_right = ADVANCE_ONLY_NEXT;
7035 advance_left = ADVANCE;
7036 advance_right = ADVANCE;
7039 } else if (left_level < right_level) {
7040 advance_right = ADVANCE;
7042 advance_left = ADVANCE;
7047 btrfs_free_path(left_path);
7048 btrfs_free_path(right_path);
7053 static int send_subvol(struct send_ctx *sctx)
7057 if (!(sctx->flags & BTRFS_SEND_FLAG_OMIT_STREAM_HEADER)) {
7058 ret = send_header(sctx);
7063 ret = send_subvol_begin(sctx);
7067 if (sctx->parent_root) {
7068 ret = btrfs_compare_trees(sctx->send_root, sctx->parent_root, sctx);
7071 ret = finish_inode_if_needed(sctx, 1);
7075 ret = full_send_tree(sctx);
7081 free_recorded_refs(sctx);
7086 * If orphan cleanup did remove any orphans from a root, it means the tree
7087 * was modified and therefore the commit root is not the same as the current
7088 * root anymore. This is a problem, because send uses the commit root and
7089 * therefore can see inode items that don't exist in the current root anymore,
7090 * and for example make calls to btrfs_iget, which will do tree lookups based
7091 * on the current root and not on the commit root. Those lookups will fail,
7092 * returning a -ESTALE error, and making send fail with that error. So make
7093 * sure a send does not see any orphans we have just removed, and that it will
7094 * see the same inodes regardless of whether a transaction commit happened
7095 * before it started (meaning that the commit root will be the same as the
7096 * current root) or not.
7098 static int ensure_commit_roots_uptodate(struct send_ctx *sctx)
7101 struct btrfs_trans_handle *trans = NULL;
7104 if (sctx->parent_root &&
7105 sctx->parent_root->node != sctx->parent_root->commit_root)
7108 for (i = 0; i < sctx->clone_roots_cnt; i++)
7109 if (sctx->clone_roots[i].root->node !=
7110 sctx->clone_roots[i].root->commit_root)
7114 return btrfs_end_transaction(trans);
7119 /* Use any root, all fs roots will get their commit roots updated. */
7121 trans = btrfs_join_transaction(sctx->send_root);
7123 return PTR_ERR(trans);
7127 return btrfs_commit_transaction(trans);
7131 * Make sure any existing dellaloc is flushed for any root used by a send
7132 * operation so that we do not miss any data and we do not race with writeback
7133 * finishing and changing a tree while send is using the tree. This could
7134 * happen if a subvolume is in RW mode, has delalloc, is turned to RO mode and
7135 * a send operation then uses the subvolume.
7136 * After flushing delalloc ensure_commit_roots_uptodate() must be called.
7138 static int flush_delalloc_roots(struct send_ctx *sctx)
7140 struct btrfs_root *root = sctx->parent_root;
7145 ret = btrfs_start_delalloc_snapshot(root);
7148 btrfs_wait_ordered_extents(root, U64_MAX, 0, U64_MAX);
7151 for (i = 0; i < sctx->clone_roots_cnt; i++) {
7152 root = sctx->clone_roots[i].root;
7153 ret = btrfs_start_delalloc_snapshot(root);
7156 btrfs_wait_ordered_extents(root, U64_MAX, 0, U64_MAX);
7162 static void btrfs_root_dec_send_in_progress(struct btrfs_root* root)
7164 spin_lock(&root->root_item_lock);
7165 root->send_in_progress--;
7167 * Not much left to do, we don't know why it's unbalanced and
7168 * can't blindly reset it to 0.
7170 if (root->send_in_progress < 0)
7171 btrfs_err(root->fs_info,
7172 "send_in_progress unbalanced %d root %llu",
7173 root->send_in_progress, root->root_key.objectid);
7174 spin_unlock(&root->root_item_lock);
7177 static void dedupe_in_progress_warn(const struct btrfs_root *root)
7179 btrfs_warn_rl(root->fs_info,
7180 "cannot use root %llu for send while deduplications on it are in progress (%d in progress)",
7181 root->root_key.objectid, root->dedupe_in_progress);
7184 long btrfs_ioctl_send(struct file *mnt_file, struct btrfs_ioctl_send_args *arg)
7187 struct btrfs_root *send_root = BTRFS_I(file_inode(mnt_file))->root;
7188 struct btrfs_fs_info *fs_info = send_root->fs_info;
7189 struct btrfs_root *clone_root;
7190 struct send_ctx *sctx = NULL;
7192 u64 *clone_sources_tmp = NULL;
7193 int clone_sources_to_rollback = 0;
7195 int sort_clone_roots = 0;
7197 if (!capable(CAP_SYS_ADMIN))
7201 * The subvolume must remain read-only during send, protect against
7202 * making it RW. This also protects against deletion.
7204 spin_lock(&send_root->root_item_lock);
7205 if (btrfs_root_readonly(send_root) && send_root->dedupe_in_progress) {
7206 dedupe_in_progress_warn(send_root);
7207 spin_unlock(&send_root->root_item_lock);
7210 send_root->send_in_progress++;
7211 spin_unlock(&send_root->root_item_lock);
7214 * Userspace tools do the checks and warn the user if it's
7217 if (!btrfs_root_readonly(send_root)) {
7223 * Check that we don't overflow at later allocations, we request
7224 * clone_sources_count + 1 items, and compare to unsigned long inside
7227 if (arg->clone_sources_count >
7228 ULONG_MAX / sizeof(struct clone_root) - 1) {
7233 if (arg->flags & ~BTRFS_SEND_FLAG_MASK) {
7238 sctx = kzalloc(sizeof(struct send_ctx), GFP_KERNEL);
7244 INIT_LIST_HEAD(&sctx->new_refs);
7245 INIT_LIST_HEAD(&sctx->deleted_refs);
7246 INIT_RADIX_TREE(&sctx->name_cache, GFP_KERNEL);
7247 INIT_LIST_HEAD(&sctx->name_cache_list);
7249 sctx->flags = arg->flags;
7251 sctx->send_filp = fget(arg->send_fd);
7252 if (!sctx->send_filp) {
7257 sctx->send_root = send_root;
7259 * Unlikely but possible, if the subvolume is marked for deletion but
7260 * is slow to remove the directory entry, send can still be started
7262 if (btrfs_root_dead(sctx->send_root)) {
7267 sctx->clone_roots_cnt = arg->clone_sources_count;
7269 sctx->send_max_size = BTRFS_SEND_BUF_SIZE;
7270 sctx->send_buf = kvmalloc(sctx->send_max_size, GFP_KERNEL);
7271 if (!sctx->send_buf) {
7276 sctx->pending_dir_moves = RB_ROOT;
7277 sctx->waiting_dir_moves = RB_ROOT;
7278 sctx->orphan_dirs = RB_ROOT;
7280 sctx->clone_roots = kvcalloc(sizeof(*sctx->clone_roots),
7281 arg->clone_sources_count + 1,
7283 if (!sctx->clone_roots) {
7288 alloc_size = array_size(sizeof(*arg->clone_sources),
7289 arg->clone_sources_count);
7291 if (arg->clone_sources_count) {
7292 clone_sources_tmp = kvmalloc(alloc_size, GFP_KERNEL);
7293 if (!clone_sources_tmp) {
7298 ret = copy_from_user(clone_sources_tmp, arg->clone_sources,
7305 for (i = 0; i < arg->clone_sources_count; i++) {
7306 clone_root = btrfs_get_fs_root(fs_info,
7307 clone_sources_tmp[i], true);
7308 if (IS_ERR(clone_root)) {
7309 ret = PTR_ERR(clone_root);
7312 spin_lock(&clone_root->root_item_lock);
7313 if (!btrfs_root_readonly(clone_root) ||
7314 btrfs_root_dead(clone_root)) {
7315 spin_unlock(&clone_root->root_item_lock);
7316 btrfs_put_root(clone_root);
7320 if (clone_root->dedupe_in_progress) {
7321 dedupe_in_progress_warn(clone_root);
7322 spin_unlock(&clone_root->root_item_lock);
7323 btrfs_put_root(clone_root);
7327 clone_root->send_in_progress++;
7328 spin_unlock(&clone_root->root_item_lock);
7330 sctx->clone_roots[i].root = clone_root;
7331 clone_sources_to_rollback = i + 1;
7333 kvfree(clone_sources_tmp);
7334 clone_sources_tmp = NULL;
7337 if (arg->parent_root) {
7338 sctx->parent_root = btrfs_get_fs_root(fs_info, arg->parent_root,
7340 if (IS_ERR(sctx->parent_root)) {
7341 ret = PTR_ERR(sctx->parent_root);
7345 spin_lock(&sctx->parent_root->root_item_lock);
7346 sctx->parent_root->send_in_progress++;
7347 if (!btrfs_root_readonly(sctx->parent_root) ||
7348 btrfs_root_dead(sctx->parent_root)) {
7349 spin_unlock(&sctx->parent_root->root_item_lock);
7353 if (sctx->parent_root->dedupe_in_progress) {
7354 dedupe_in_progress_warn(sctx->parent_root);
7355 spin_unlock(&sctx->parent_root->root_item_lock);
7359 spin_unlock(&sctx->parent_root->root_item_lock);
7363 * Clones from send_root are allowed, but only if the clone source
7364 * is behind the current send position. This is checked while searching
7365 * for possible clone sources.
7367 sctx->clone_roots[sctx->clone_roots_cnt++].root =
7368 btrfs_grab_root(sctx->send_root);
7370 /* We do a bsearch later */
7371 sort(sctx->clone_roots, sctx->clone_roots_cnt,
7372 sizeof(*sctx->clone_roots), __clone_root_cmp_sort,
7374 sort_clone_roots = 1;
7376 ret = flush_delalloc_roots(sctx);
7380 ret = ensure_commit_roots_uptodate(sctx);
7384 mutex_lock(&fs_info->balance_mutex);
7385 if (test_bit(BTRFS_FS_BALANCE_RUNNING, &fs_info->flags)) {
7386 mutex_unlock(&fs_info->balance_mutex);
7387 btrfs_warn_rl(fs_info,
7388 "cannot run send because a balance operation is in progress");
7392 fs_info->send_in_progress++;
7393 mutex_unlock(&fs_info->balance_mutex);
7395 current->journal_info = BTRFS_SEND_TRANS_STUB;
7396 ret = send_subvol(sctx);
7397 current->journal_info = NULL;
7398 mutex_lock(&fs_info->balance_mutex);
7399 fs_info->send_in_progress--;
7400 mutex_unlock(&fs_info->balance_mutex);
7404 if (!(sctx->flags & BTRFS_SEND_FLAG_OMIT_END_CMD)) {
7405 ret = begin_cmd(sctx, BTRFS_SEND_C_END);
7408 ret = send_cmd(sctx);
7414 WARN_ON(sctx && !ret && !RB_EMPTY_ROOT(&sctx->pending_dir_moves));
7415 while (sctx && !RB_EMPTY_ROOT(&sctx->pending_dir_moves)) {
7417 struct pending_dir_move *pm;
7419 n = rb_first(&sctx->pending_dir_moves);
7420 pm = rb_entry(n, struct pending_dir_move, node);
7421 while (!list_empty(&pm->list)) {
7422 struct pending_dir_move *pm2;
7424 pm2 = list_first_entry(&pm->list,
7425 struct pending_dir_move, list);
7426 free_pending_move(sctx, pm2);
7428 free_pending_move(sctx, pm);
7431 WARN_ON(sctx && !ret && !RB_EMPTY_ROOT(&sctx->waiting_dir_moves));
7432 while (sctx && !RB_EMPTY_ROOT(&sctx->waiting_dir_moves)) {
7434 struct waiting_dir_move *dm;
7436 n = rb_first(&sctx->waiting_dir_moves);
7437 dm = rb_entry(n, struct waiting_dir_move, node);
7438 rb_erase(&dm->node, &sctx->waiting_dir_moves);
7442 WARN_ON(sctx && !ret && !RB_EMPTY_ROOT(&sctx->orphan_dirs));
7443 while (sctx && !RB_EMPTY_ROOT(&sctx->orphan_dirs)) {
7445 struct orphan_dir_info *odi;
7447 n = rb_first(&sctx->orphan_dirs);
7448 odi = rb_entry(n, struct orphan_dir_info, node);
7449 free_orphan_dir_info(sctx, odi);
7452 if (sort_clone_roots) {
7453 for (i = 0; i < sctx->clone_roots_cnt; i++) {
7454 btrfs_root_dec_send_in_progress(
7455 sctx->clone_roots[i].root);
7456 btrfs_put_root(sctx->clone_roots[i].root);
7459 for (i = 0; sctx && i < clone_sources_to_rollback; i++) {
7460 btrfs_root_dec_send_in_progress(
7461 sctx->clone_roots[i].root);
7462 btrfs_put_root(sctx->clone_roots[i].root);
7465 btrfs_root_dec_send_in_progress(send_root);
7467 if (sctx && !IS_ERR_OR_NULL(sctx->parent_root)) {
7468 btrfs_root_dec_send_in_progress(sctx->parent_root);
7469 btrfs_put_root(sctx->parent_root);
7472 kvfree(clone_sources_tmp);
7475 if (sctx->send_filp)
7476 fput(sctx->send_filp);
7478 kvfree(sctx->clone_roots);
7479 kvfree(sctx->send_buf);
7481 name_cache_free(sctx);