fs/btrfs/send.c

   1 /*
   2  * Copyright (C) 2012 Alexander Block.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18
  19 #include <linux/bsearch.h>
  20 #include <linux/fs.h>
  21 #include <linux/file.h>
  22 #include <linux/sort.h>
  23 #include <linux/mount.h>
  24 #include <linux/xattr.h>
  25 #include <linux/posix_acl_xattr.h>
  26 #include <linux/radix-tree.h>
  27 #include <linux/vmalloc.h>
  28 #include <linux/string.h>
  29 #include <linux/compat.h>
  30
  31 #include "send.h"
  32 #include "backref.h"
  33 #include "hash.h"
  34 #include "locking.h"
  35 #include "disk-io.h"
  36 #include "btrfs_inode.h"
  37 #include "transaction.h"
  38 #include "compression.h"
  39
  40 /*
  41  * A fs_path is a helper to dynamically build path names with unknown size.
  42  * It reallocates the internal buffer on demand.
  43  * It allows fast adding of path elements on the right side (normal path) and
  44  * fast adding to the left side (reversed path). A reversed path can also be
  45  * unreversed if needed.
  46  */
  47 struct fs_path {
  48         union {
  49                 struct {
  50                         char *start;
  51                         char *end;
  52
  53                         char *buf;
  54                         unsigned short buf_len:15;
  55                         unsigned short reversed:1;
  56                         char inline_buf[];
  57                 };
  58                 /*
  59                  * Average path length does not exceed 200 bytes, we'll have
  60                  * better packing in the slab and higher chance to satisfy
  61                  * a allocation later during send.
  62                  */
  63                 char pad[256];
  64         };
  65 };
  66 #define FS_PATH_INLINE_SIZE \
  67         (sizeof(struct fs_path) - offsetof(struct fs_path, inline_buf))
  68
  69
  70 /* reused for each extent */
  71 struct clone_root {
  72         struct btrfs_root *root;
  73         u64 ino;
  74         u64 offset;
  75
  76         u64 found_refs;
  77 };
  78
  79 #define SEND_CTX_MAX_NAME_CACHE_SIZE 128
  80 #define SEND_CTX_NAME_CACHE_CLEAN_SIZE (SEND_CTX_MAX_NAME_CACHE_SIZE * 2)
  81
  82 struct send_ctx {
  83         struct file *send_filp;
  84         loff_t send_off;
  85         char *send_buf;
  86         u32 send_size;
  87         u32 send_max_size;
  88         u64 total_send_size;
  89         u64 cmd_send_size[BTRFS_SEND_C_MAX + 1];
  90         u64 flags;      /* 'flags' member of btrfs_ioctl_send_args is u64 */
  91
  92         struct btrfs_root *send_root;
  93         struct btrfs_root *parent_root;
  94         struct clone_root *clone_roots;
  95         int clone_roots_cnt;
  96
  97         /* current state of the compare_tree call */
  98         struct btrfs_path *left_path;
  99         struct btrfs_path *right_path;
 100         struct btrfs_key *cmp_key;
 101
 102         /*
 103          * infos of the currently processed inode. In case of deleted inodes,
 104          * these are the values from the deleted inode.
 105          */
 106         u64 cur_ino;
 107         u64 cur_inode_gen;
 108         int cur_inode_new;
 109         int cur_inode_new_gen;
 110         int cur_inode_deleted;
 111         u64 cur_inode_size;
 112         u64 cur_inode_mode;
 113         u64 cur_inode_rdev;
 114         u64 cur_inode_last_extent;
 115
 116         u64 send_progress;
 117
 118         struct list_head new_refs;
 119         struct list_head deleted_refs;
 120
 121         struct radix_tree_root name_cache;
 122         struct list_head name_cache_list;
 123         int name_cache_size;
 124
 125         struct file_ra_state ra;
 126
 127         char *read_buf;
 128
 129         /*
 130          * We process inodes by their increasing order, so if before an
 131          * incremental send we reverse the parent/child relationship of
 132          * directories such that a directory with a lower inode number was
 133          * the parent of a directory with a higher inode number, and the one
 134          * becoming the new parent got renamed too, we can't rename/move the
 135          * directory with lower inode number when we finish processing it - we
 136          * must process the directory with higher inode number first, then
 137          * rename/move it and then rename/move the directory with lower inode
 138          * number. Example follows.
 139          *
 140          * Tree state when the first send was performed:
 141          *
 142          * .
 143          * |-- a                   (ino 257)
 144          *     |-- b               (ino 258)
 145          *         |
 146          *         |
 147          *         |-- c           (ino 259)
 148          *         |   |-- d       (ino 260)
 149          *         |
 150          *         |-- c2          (ino 261)
 151          *
 152          * Tree state when the second (incremental) send is performed:
 153          *
 154          * .
 155          * |-- a                   (ino 257)
 156          *     |-- b               (ino 258)
 157          *         |-- c2          (ino 261)
 158          *             |-- d2      (ino 260)
 159          *                 |-- cc  (ino 259)
 160          *
 161          * The sequence of steps that lead to the second state was:
 162          *
 163          * mv /a/b/c/d /a/b/c2/d2
 164          * mv /a/b/c /a/b/c2/d2/cc
 165          *
 166          * "c" has lower inode number, but we can't move it (2nd mv operation)
 167          * before we move "d", which has higher inode number.
 168          *
 169          * So we just memorize which move/rename operations must be performed
 170          * later when their respective parent is processed and moved/renamed.
 171          */
 172
 173         /* Indexed by parent directory inode number. */
 174         struct rb_root pending_dir_moves;
 175
 176         /*
 177          * Reverse index, indexed by the inode number of a directory that
 178          * is waiting for the move/rename of its immediate parent before its
 179          * own move/rename can be performed.
 180          */
 181         struct rb_root waiting_dir_moves;
 182
 183         /*
 184          * A directory that is going to be rm'ed might have a child directory
 185          * which is in the pending directory moves index above. In this case,
 186          * the directory can only be removed after the move/rename of its child
 187          * is performed. Example:
 188          *
 189          * Parent snapshot:
 190          *
 191          * .                        (ino 256)
 192          * |-- a/                   (ino 257)
 193          *     |-- b/               (ino 258)
 194          *         |-- c/           (ino 259)
 195          *         |   |-- x/       (ino 260)
 196          *         |
 197          *         |-- y/           (ino 261)
 198          *
 199          * Send snapshot:
 200          *
 201          * .                        (ino 256)
 202          * |-- a/                   (ino 257)
 203          *     |-- b/               (ino 258)
 204          *         |-- YY/          (ino 261)
 205          *              |-- x/      (ino 260)
 206          *
 207          * Sequence of steps that lead to the send snapshot:
 208          * rm -f /a/b/c/foo.txt
 209          * mv /a/b/y /a/b/YY
 210          * mv /a/b/c/x /a/b/YY
 211          * rmdir /a/b/c
 212          *
 213          * When the child is processed, its move/rename is delayed until its
 214          * parent is processed (as explained above), but all other operations
 215          * like update utimes, chown, chgrp, etc, are performed and the paths
 216          * that it uses for those operations must use the orphanized name of
 217          * its parent (the directory we're going to rm later), so we need to
 218          * memorize that name.
 219          *
 220          * Indexed by the inode number of the directory to be deleted.
 221          */
 222         struct rb_root orphan_dirs;
 223 };
 224
 225 struct pending_dir_move {
 226         struct rb_node node;
 227         struct list_head list;
 228         u64 parent_ino;
 229         u64 ino;
 230         u64 gen;
 231         struct list_head update_refs;
 232 };
 233
 234 struct waiting_dir_move {
 235         struct rb_node node;
 236         u64 ino;
 237         /*
 238          * There might be some directory that could not be removed because it
 239          * was waiting for this directory inode to be moved first. Therefore
 240          * after this directory is moved, we can try to rmdir the ino rmdir_ino.
 241          */
 242         u64 rmdir_ino;
 243         bool orphanized;
 244 };
 245
 246 struct orphan_dir_info {
 247         struct rb_node node;
 248         u64 ino;
 249         u64 gen;
 250 };
 251
 252 struct name_cache_entry {
 253         struct list_head list;
 254         /*
 255          * radix_tree has only 32bit entries but we need to handle 64bit inums.
 256          * We use the lower 32bit of the 64bit inum to store it in the tree. If
 257          * more then one inum would fall into the same entry, we use radix_list
 258          * to store the additional entries. radix_list is also used to store
 259          * entries where two entries have the same inum but different
 260          * generations.
 261          */
 262         struct list_head radix_list;
 263         u64 ino;
 264         u64 gen;
 265         u64 parent_ino;
 266         u64 parent_gen;
 267         int ret;
 268         int need_later_update;
 269         int name_len;
 270         char name[];
 271 };
 272
 273 static void inconsistent_snapshot_error(struct send_ctx *sctx,
 274                                         enum btrfs_compare_tree_result result,
 275                                         const char *what)
 276 {
 277         const char *result_string;
 278
 279         switch (result) {
 280         case BTRFS_COMPARE_TREE_NEW:
 281                 result_string = "new";
 282                 break;
 283         case BTRFS_COMPARE_TREE_DELETED:
 284                 result_string = "deleted";
 285                 break;
 286         case BTRFS_COMPARE_TREE_CHANGED:
 287                 result_string = "updated";
 288                 break;
 289         case BTRFS_COMPARE_TREE_SAME:
 290                 ASSERT(0);
 291                 result_string = "unchanged";
 292                 break;
 293         default:
 294                 ASSERT(0);
 295                 result_string = "unexpected";
 296         }
 297
 298         btrfs_err(sctx->send_root->fs_info,
 299                   "Send: inconsistent snapshot, found %s %s for inode %llu without updated inode item, send root is %llu, parent root is %llu",
 300                   result_string, what, sctx->cmp_key->objectid,
 301                   sctx->send_root->root_key.objectid,
 302                   (sctx->parent_root ?
 303                    sctx->parent_root->root_key.objectid : 0));
 304 }
 305
 306 static int is_waiting_for_move(struct send_ctx *sctx, u64 ino);
 307
 308 static struct waiting_dir_move *
 309 get_waiting_dir_move(struct send_ctx *sctx, u64 ino);
 310
 311 static int is_waiting_for_rm(struct send_ctx *sctx, u64 dir_ino);
 312
 313 static int need_send_hole(struct send_ctx *sctx)
 314 {
 315         return (sctx->parent_root && !sctx->cur_inode_new &&
 316                 !sctx->cur_inode_new_gen && !sctx->cur_inode_deleted &&
 317                 S_ISREG(sctx->cur_inode_mode));
 318 }
 319
 320 static void fs_path_reset(struct fs_path *p)
 321 {
 322         if (p->reversed) {
 323                 p->start = p->buf + p->buf_len - 1;
 324                 p->end = p->start;
 325                 *p->start = 0;
 326         } else {
 327                 p->start = p->buf;
 328                 p->end = p->start;
 329                 *p->start = 0;
 330         }
 331 }
 332
 333 static struct fs_path *fs_path_alloc(void)
 334 {
 335         struct fs_path *p;
 336
 337         p = kmalloc(sizeof(*p), GFP_KERNEL);
 338         if (!p)
 339                 return NULL;
 340         p->reversed = 0;
 341         p->buf = p->inline_buf;
 342         p->buf_len = FS_PATH_INLINE_SIZE;
 343         fs_path_reset(p);
 344         return p;
 345 }
 346
 347 static struct fs_path *fs_path_alloc_reversed(void)
 348 {
 349         struct fs_path *p;
 350
 351         p = fs_path_alloc();
 352         if (!p)
 353                 return NULL;
 354         p->reversed = 1;
 355         fs_path_reset(p);
 356         return p;
 357 }
 358
 359 static void fs_path_free(struct fs_path *p)
 360 {
 361         if (!p)
 362                 return;
 363         if (p->buf != p->inline_buf)
 364                 kfree(p->buf);
 365         kfree(p);
 366 }
 367
 368 static int fs_path_len(struct fs_path *p)
 369 {
 370         return p->end - p->start;
 371 }
 372
 373 static int fs_path_ensure_buf(struct fs_path *p, int len)
 374 {
 375         char *tmp_buf;
 376         int path_len;
 377         int old_buf_len;
 378
 379         len++;
 380
 381         if (p->buf_len >= len)
 382                 return 0;
 383
 384         if (len > PATH_MAX) {
 385                 WARN_ON(1);
 386                 return -ENOMEM;
 387         }
 388
 389         path_len = p->end - p->start;
 390         old_buf_len = p->buf_len;
 391
 392         /*
 393          * First time the inline_buf does not suffice
 394          */
 395         if (p->buf == p->inline_buf) {
 396                 tmp_buf = kmalloc(len, GFP_KERNEL);
 397                 if (tmp_buf)
 398                         memcpy(tmp_buf, p->buf, old_buf_len);
 399         } else {
 400                 tmp_buf = krealloc(p->buf, len, GFP_KERNEL);
 401         }
 402         if (!tmp_buf)
 403                 return -ENOMEM;
 404         p->buf = tmp_buf;
 405         /*
 406          * The real size of the buffer is bigger, this will let the fast path
 407          * happen most of the time
 408          */
 409         p->buf_len = ksize(p->buf);
 410
 411         if (p->reversed) {
 412                 tmp_buf = p->buf + old_buf_len - path_len - 1;
 413                 p->end = p->buf + p->buf_len - 1;
 414                 p->start = p->end - path_len;
 415                 memmove(p->start, tmp_buf, path_len + 1);
 416         } else {
 417                 p->start = p->buf;
 418                 p->end = p->start + path_len;
 419         }
 420         return 0;
 421 }
 422
 423 static int fs_path_prepare_for_add(struct fs_path *p, int name_len,
 424                                    char **prepared)
 425 {
 426         int ret;
 427         int new_len;
 428
 429         new_len = p->end - p->start + name_len;
 430         if (p->start != p->end)
 431                 new_len++;
 432         ret = fs_path_ensure_buf(p, new_len);
 433         if (ret < 0)
 434                 goto out;
 435
 436         if (p->reversed) {
 437                 if (p->start != p->end)
 438                         *--p->start = '/';
 439                 p->start -= name_len;
 440                 *prepared = p->start;
 441         } else {
 442                 if (p->start != p->end)
 443                         *p->end++ = '/';
 444                 *prepared = p->end;
 445                 p->end += name_len;
 446                 *p->end = 0;
 447         }
 448
 449 out:
 450         return ret;
 451 }
 452
 453 static int fs_path_add(struct fs_path *p, const char *name, int name_len)
 454 {
 455         int ret;
 456         char *prepared;
 457
 458         ret = fs_path_prepare_for_add(p, name_len, &prepared);
 459         if (ret < 0)
 460                 goto out;
 461         memcpy(prepared, name, name_len);
 462
 463 out:
 464         return ret;
 465 }
 466
 467 static int fs_path_add_path(struct fs_path *p, struct fs_path *p2)
 468 {
 469         int ret;
 470         char *prepared;
 471
 472         ret = fs_path_prepare_for_add(p, p2->end - p2->start, &prepared);
 473         if (ret < 0)
 474                 goto out;
 475         memcpy(prepared, p2->start, p2->end - p2->start);
 476
 477 out:
 478         return ret;
 479 }
 480
 481 static int fs_path_add_from_extent_buffer(struct fs_path *p,
 482                                           struct extent_buffer *eb,
 483                                           unsigned long off, int len)
 484 {
 485         int ret;
 486         char *prepared;
 487
 488         ret = fs_path_prepare_for_add(p, len, &prepared);
 489         if (ret < 0)
 490                 goto out;
 491
 492         read_extent_buffer(eb, prepared, off, len);
 493
 494 out:
 495         return ret;
 496 }
 497
 498 static int fs_path_copy(struct fs_path *p, struct fs_path *from)
 499 {
 500         int ret;
 501
 502         p->reversed = from->reversed;
 503         fs_path_reset(p);
 504
 505         ret = fs_path_add_path(p, from);
 506
 507         return ret;
 508 }
 509
 510
 511 static void fs_path_unreverse(struct fs_path *p)
 512 {
 513         char *tmp;
 514         int len;
 515
 516         if (!p->reversed)
 517                 return;
 518
 519         tmp = p->start;
 520         len = p->end - p->start;
 521         p->start = p->buf;
 522         p->end = p->start + len;
 523         memmove(p->start, tmp, len + 1);
 524         p->reversed = 0;
 525 }
 526
 527 static struct btrfs_path *alloc_path_for_send(void)
 528 {
 529         struct btrfs_path *path;
 530
 531         path = btrfs_alloc_path();
 532         if (!path)
 533                 return NULL;
 534         path->search_commit_root = 1;
 535         path->skip_locking = 1;
 536         path->need_commit_sem = 1;
 537         return path;
 538 }
 539
 540 static int write_buf(struct file *filp, const void *buf, u32 len, loff_t *off)
 541 {
 542         int ret;
 543         u32 pos = 0;
 544
 545         while (pos < len) {
 546                 ret = kernel_write(filp, buf + pos, len - pos, off);
 547                 /* TODO handle that correctly */
 548                 /*if (ret == -ERESTARTSYS) {
 549                         continue;
 550                 }*/
 551                 if (ret < 0)
 552                         return ret;
 553                 if (ret == 0) {
 554                         return -EIO;
 555                 }
 556                 pos += ret;
 557         }
 558
 559         return 0;
 560 }
 561
 562 static int tlv_put(struct send_ctx *sctx, u16 attr, const void *data, int len)
 563 {
 564         struct btrfs_tlv_header *hdr;
 565         int total_len = sizeof(*hdr) + len;
 566         int left = sctx->send_max_size - sctx->send_size;
 567
 568         if (unlikely(left < total_len))
 569                 return -EOVERFLOW;
 570
 571         hdr = (struct btrfs_tlv_header *) (sctx->send_buf + sctx->send_size);
 572         hdr->tlv_type = cpu_to_le16(attr);
 573         hdr->tlv_len = cpu_to_le16(len);
 574         memcpy(hdr + 1, data, len);
 575         sctx->send_size += total_len;
 576
 577         return 0;
 578 }
 579
 580 #define TLV_PUT_DEFINE_INT(bits) \
 581         static int tlv_put_u##bits(struct send_ctx *sctx,               \
 582                         u##bits attr, u##bits value)                    \
 583         {                                                               \
 584                 __le##bits __tmp = cpu_to_le##bits(value);              \
 585                 return tlv_put(sctx, attr, &__tmp, sizeof(__tmp));      \
 586         }
 587
 588 TLV_PUT_DEFINE_INT(64)
 589
 590 static int tlv_put_string(struct send_ctx *sctx, u16 attr,
 591                           const char *str, int len)
 592 {
 593         if (len == -1)
 594                 len = strlen(str);
 595         return tlv_put(sctx, attr, str, len);
 596 }
 597
 598 static int tlv_put_uuid(struct send_ctx *sctx, u16 attr,
 599                         const u8 *uuid)
 600 {
 601         return tlv_put(sctx, attr, uuid, BTRFS_UUID_SIZE);
 602 }
 603
 604 static int tlv_put_btrfs_timespec(struct send_ctx *sctx, u16 attr,
 605                                   struct extent_buffer *eb,
 606                                   struct btrfs_timespec *ts)
 607 {
 608         struct btrfs_timespec bts;
 609         read_extent_buffer(eb, &bts, (unsigned long)ts, sizeof(bts));
 610         return tlv_put(sctx, attr, &bts, sizeof(bts));
 611 }
 612
 613
 614 #define TLV_PUT(sctx, attrtype, attrlen, data) \
 615         do { \
 616                 ret = tlv_put(sctx, attrtype, attrlen, data); \
 617                 if (ret < 0) \
 618                         goto tlv_put_failure; \
 619         } while (0)
 620
 621 #define TLV_PUT_INT(sctx, attrtype, bits, value) \
 622         do { \
 623                 ret = tlv_put_u##bits(sctx, attrtype, value); \
 624                 if (ret < 0) \
 625                         goto tlv_put_failure; \
 626         } while (0)
 627
 628 #define TLV_PUT_U8(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 8, data)
 629 #define TLV_PUT_U16(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 16, data)
 630 #define TLV_PUT_U32(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 32, data)
 631 #define TLV_PUT_U64(sctx, attrtype, data) TLV_PUT_INT(sctx, attrtype, 64, data)
 632 #define TLV_PUT_STRING(sctx, attrtype, str, len) \
 633         do { \
 634                 ret = tlv_put_string(sctx, attrtype, str, len); \
 635                 if (ret < 0) \
 636                         goto tlv_put_failure; \
 637         } while (0)
 638 #define TLV_PUT_PATH(sctx, attrtype, p) \
 639         do { \
 640                 ret = tlv_put_string(sctx, attrtype, p->start, \
 641                         p->end - p->start); \
 642                 if (ret < 0) \
 643                         goto tlv_put_failure; \
 644         } while(0)
 645 #define TLV_PUT_UUID(sctx, attrtype, uuid) \
 646         do { \
 647                 ret = tlv_put_uuid(sctx, attrtype, uuid); \
 648                 if (ret < 0) \
 649                         goto tlv_put_failure; \
 650         } while (0)
 651 #define TLV_PUT_BTRFS_TIMESPEC(sctx, attrtype, eb, ts) \
 652         do { \
 653                 ret = tlv_put_btrfs_timespec(sctx, attrtype, eb, ts); \
 654                 if (ret < 0) \
 655                         goto tlv_put_failure; \
 656         } while (0)
 657
 658 static int send_header(struct send_ctx *sctx)
 659 {
 660         struct btrfs_stream_header hdr;
 661
 662         strcpy(hdr.magic, BTRFS_SEND_STREAM_MAGIC);
 663         hdr.version = cpu_to_le32(BTRFS_SEND_STREAM_VERSION);
 664
 665         return write_buf(sctx->send_filp, &hdr, sizeof(hdr),
 666                                         &sctx->send_off);
 667 }
 668
 669 /*
 670  * For each command/item we want to send to userspace, we call this function.
 671  */
 672 static int begin_cmd(struct send_ctx *sctx, int cmd)
 673 {
 674         struct btrfs_cmd_header *hdr;
 675
 676         if (WARN_ON(!sctx->send_buf))
 677                 return -EINVAL;
 678
 679         BUG_ON(sctx->send_size);
 680
 681         sctx->send_size += sizeof(*hdr);
 682         hdr = (struct btrfs_cmd_header *)sctx->send_buf;
 683         hdr->cmd = cpu_to_le16(cmd);
 684
 685         return 0;
 686 }
 687
 688 static int send_cmd(struct send_ctx *sctx)
 689 {
 690         int ret;
 691         struct btrfs_cmd_header *hdr;
 692         u32 crc;
 693
 694         hdr = (struct btrfs_cmd_header *)sctx->send_buf;
 695         hdr->len = cpu_to_le32(sctx->send_size - sizeof(*hdr));
 696         hdr->crc = 0;
 697
 698         crc = btrfs_crc32c(0, (unsigned char *)sctx->send_buf, sctx->send_size);
 699         hdr->crc = cpu_to_le32(crc);
 700
 701         ret = write_buf(sctx->send_filp, sctx->send_buf, sctx->send_size,
 702                                         &sctx->send_off);
 703
 704         sctx->total_send_size += sctx->send_size;
 705         sctx->cmd_send_size[le16_to_cpu(hdr->cmd)] += sctx->send_size;
 706         sctx->send_size = 0;
 707
 708         return ret;
 709 }
 710
 711 /*
 712  * Sends a move instruction to user space
 713  */
 714 static int send_rename(struct send_ctx *sctx,
 715                      struct fs_path *from, struct fs_path *to)
 716 {
 717         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
 718         int ret;
 719
 720         btrfs_debug(fs_info, "send_rename %s -> %s", from->start, to->start);
 721
 722         ret = begin_cmd(sctx, BTRFS_SEND_C_RENAME);
 723         if (ret < 0)
 724                 goto out;
 725
 726         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, from);
 727         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH_TO, to);
 728
 729         ret = send_cmd(sctx);
 730
 731 tlv_put_failure:
 732 out:
 733         return ret;
 734 }
 735
 736 /*
 737  * Sends a link instruction to user space
 738  */
 739 static int send_link(struct send_ctx *sctx,
 740                      struct fs_path *path, struct fs_path *lnk)
 741 {
 742         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
 743         int ret;
 744
 745         btrfs_debug(fs_info, "send_link %s -> %s", path->start, lnk->start);
 746
 747         ret = begin_cmd(sctx, BTRFS_SEND_C_LINK);
 748         if (ret < 0)
 749                 goto out;
 750
 751         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
 752         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH_LINK, lnk);
 753
 754         ret = send_cmd(sctx);
 755
 756 tlv_put_failure:
 757 out:
 758         return ret;
 759 }
 760
 761 /*
 762  * Sends an unlink instruction to user space
 763  */
 764 static int send_unlink(struct send_ctx *sctx, struct fs_path *path)
 765 {
 766         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
 767         int ret;
 768
 769         btrfs_debug(fs_info, "send_unlink %s", path->start);
 770
 771         ret = begin_cmd(sctx, BTRFS_SEND_C_UNLINK);
 772         if (ret < 0)
 773                 goto out;
 774
 775         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
 776
 777         ret = send_cmd(sctx);
 778
 779 tlv_put_failure:
 780 out:
 781         return ret;
 782 }
 783
 784 /*
 785  * Sends a rmdir instruction to user space
 786  */
 787 static int send_rmdir(struct send_ctx *sctx, struct fs_path *path)
 788 {
 789         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
 790         int ret;
 791
 792         btrfs_debug(fs_info, "send_rmdir %s", path->start);
 793
 794         ret = begin_cmd(sctx, BTRFS_SEND_C_RMDIR);
 795         if (ret < 0)
 796                 goto out;
 797
 798         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, path);
 799
 800         ret = send_cmd(sctx);
 801
 802 tlv_put_failure:
 803 out:
 804         return ret;
 805 }
 806
 807 /*
 808  * Helper function to retrieve some fields from an inode item.
 809  */
 810 static int __get_inode_info(struct btrfs_root *root, struct btrfs_path *path,
 811                           u64 ino, u64 *size, u64 *gen, u64 *mode, u64 *uid,
 812                           u64 *gid, u64 *rdev)
 813 {
 814         int ret;
 815         struct btrfs_inode_item *ii;
 816         struct btrfs_key key;
 817
 818         key.objectid = ino;
 819         key.type = BTRFS_INODE_ITEM_KEY;
 820         key.offset = 0;
 821         ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
 822         if (ret) {
 823                 if (ret > 0)
 824                         ret = -ENOENT;
 825                 return ret;
 826         }
 827
 828         ii = btrfs_item_ptr(path->nodes[0], path->slots[0],
 829                         struct btrfs_inode_item);
 830         if (size)
 831                 *size = btrfs_inode_size(path->nodes[0], ii);
 832         if (gen)
 833                 *gen = btrfs_inode_generation(path->nodes[0], ii);
 834         if (mode)
 835                 *mode = btrfs_inode_mode(path->nodes[0], ii);
 836         if (uid)
 837                 *uid = btrfs_inode_uid(path->nodes[0], ii);
 838         if (gid)
 839                 *gid = btrfs_inode_gid(path->nodes[0], ii);
 840         if (rdev)
 841                 *rdev = btrfs_inode_rdev(path->nodes[0], ii);
 842
 843         return ret;
 844 }
 845
 846 static int get_inode_info(struct btrfs_root *root,
 847                           u64 ino, u64 *size, u64 *gen,
 848                           u64 *mode, u64 *uid, u64 *gid,
 849                           u64 *rdev)
 850 {
 851         struct btrfs_path *path;
 852         int ret;
 853
 854         path = alloc_path_for_send();
 855         if (!path)
 856                 return -ENOMEM;
 857         ret = __get_inode_info(root, path, ino, size, gen, mode, uid, gid,
 858                                rdev);
 859         btrfs_free_path(path);
 860         return ret;
 861 }
 862
 863 typedef int (*iterate_inode_ref_t)(int num, u64 dir, int index,
 864                                    struct fs_path *p,
 865                                    void *ctx);
 866
 867 /*
 868  * Helper function to iterate the entries in ONE btrfs_inode_ref or
 869  * btrfs_inode_extref.
 870  * The iterate callback may return a non zero value to stop iteration. This can
 871  * be a negative value for error codes or 1 to simply stop it.
 872  *
 873  * path must point to the INODE_REF or INODE_EXTREF when called.
 874  */
 875 static int iterate_inode_ref(struct btrfs_root *root, struct btrfs_path *path,
 876                              struct btrfs_key *found_key, int resolve,
 877                              iterate_inode_ref_t iterate, void *ctx)
 878 {
 879         struct extent_buffer *eb = path->nodes[0];
 880         struct btrfs_item *item;
 881         struct btrfs_inode_ref *iref;
 882         struct btrfs_inode_extref *extref;
 883         struct btrfs_path *tmp_path;
 884         struct fs_path *p;
 885         u32 cur = 0;
 886         u32 total;
 887         int slot = path->slots[0];
 888         u32 name_len;
 889         char *start;
 890         int ret = 0;
 891         int num = 0;
 892         int index;
 893         u64 dir;
 894         unsigned long name_off;
 895         unsigned long elem_size;
 896         unsigned long ptr;
 897
 898         p = fs_path_alloc_reversed();
 899         if (!p)
 900                 return -ENOMEM;
 901
 902         tmp_path = alloc_path_for_send();
 903         if (!tmp_path) {
 904                 fs_path_free(p);
 905                 return -ENOMEM;
 906         }
 907
 908
 909         if (found_key->type == BTRFS_INODE_REF_KEY) {
 910                 ptr = (unsigned long)btrfs_item_ptr(eb, slot,
 911                                                     struct btrfs_inode_ref);
 912                 item = btrfs_item_nr(slot);
 913                 total = btrfs_item_size(eb, item);
 914                 elem_size = sizeof(*iref);
 915         } else {
 916                 ptr = btrfs_item_ptr_offset(eb, slot);
 917                 total = btrfs_item_size_nr(eb, slot);
 918                 elem_size = sizeof(*extref);
 919         }
 920
 921         while (cur < total) {
 922                 fs_path_reset(p);
 923
 924                 if (found_key->type == BTRFS_INODE_REF_KEY) {
 925                         iref = (struct btrfs_inode_ref *)(ptr + cur);
 926                         name_len = btrfs_inode_ref_name_len(eb, iref);
 927                         name_off = (unsigned long)(iref + 1);
 928                         index = btrfs_inode_ref_index(eb, iref);
 929                         dir = found_key->offset;
 930                 } else {
 931                         extref = (struct btrfs_inode_extref *)(ptr + cur);
 932                         name_len = btrfs_inode_extref_name_len(eb, extref);
 933                         name_off = (unsigned long)&extref->name;
 934                         index = btrfs_inode_extref_index(eb, extref);
 935                         dir = btrfs_inode_extref_parent(eb, extref);
 936                 }
 937
 938                 if (resolve) {
 939                         start = btrfs_ref_to_path(root, tmp_path, name_len,
 940                                                   name_off, eb, dir,
 941                                                   p->buf, p->buf_len);
 942                         if (IS_ERR(start)) {
 943                                 ret = PTR_ERR(start);
 944                                 goto out;
 945                         }
 946                         if (start < p->buf) {
 947                                 /* overflow , try again with larger buffer */
 948                                 ret = fs_path_ensure_buf(p,
 949                                                 p->buf_len + p->buf - start);
 950                                 if (ret < 0)
 951                                         goto out;
 952                                 start = btrfs_ref_to_path(root, tmp_path,
 953                                                           name_len, name_off,
 954                                                           eb, dir,
 955                                                           p->buf, p->buf_len);
 956                                 if (IS_ERR(start)) {
 957                                         ret = PTR_ERR(start);
 958                                         goto out;
 959                                 }
 960                                 BUG_ON(start < p->buf);
 961                         }
 962                         p->start = start;
 963                 } else {
 964                         ret = fs_path_add_from_extent_buffer(p, eb, name_off,
 965                                                              name_len);
 966                         if (ret < 0)
 967                                 goto out;
 968                 }
 969
 970                 cur += elem_size + name_len;
 971                 ret = iterate(num, dir, index, p, ctx);
 972                 if (ret)
 973                         goto out;
 974                 num++;
 975         }
 976
 977 out:
 978         btrfs_free_path(tmp_path);
 979         fs_path_free(p);
 980         return ret;
 981 }
 982
 983 typedef int (*iterate_dir_item_t)(int num, struct btrfs_key *di_key,
 984                                   const char *name, int name_len,
 985                                   const char *data, int data_len,
 986                                   u8 type, void *ctx);
 987
 988 /*
 989  * Helper function to iterate the entries in ONE btrfs_dir_item.
 990  * The iterate callback may return a non zero value to stop iteration. This can
 991  * be a negative value for error codes or 1 to simply stop it.
 992  *
 993  * path must point to the dir item when called.
 994  */
 995 static int iterate_dir_item(struct btrfs_root *root, struct btrfs_path *path,
 996                             iterate_dir_item_t iterate, void *ctx)
 997 {
 998         int ret = 0;
 999         struct extent_buffer *eb;
1000         struct btrfs_item *item;
1001         struct btrfs_dir_item *di;
1002         struct btrfs_key di_key;
1003         char *buf = NULL;
1004         int buf_len;
1005         u32 name_len;
1006         u32 data_len;
1007         u32 cur;
1008         u32 len;
1009         u32 total;
1010         int slot;
1011         int num;
1012         u8 type;
1013
1014         /*
1015          * Start with a small buffer (1 page). If later we end up needing more
1016          * space, which can happen for xattrs on a fs with a leaf size greater
1017          * then the page size, attempt to increase the buffer. Typically xattr
1018          * values are small.
1019          */
1020         buf_len = PATH_MAX;
1021         buf = kmalloc(buf_len, GFP_KERNEL);
1022         if (!buf) {
1023                 ret = -ENOMEM;
1024                 goto out;
1025         }
1026
1027         eb = path->nodes[0];
1028         slot = path->slots[0];
1029         item = btrfs_item_nr(slot);
1030         di = btrfs_item_ptr(eb, slot, struct btrfs_dir_item);
1031         cur = 0;
1032         len = 0;
1033         total = btrfs_item_size(eb, item);
1034
1035         num = 0;
1036         while (cur < total) {
1037                 name_len = btrfs_dir_name_len(eb, di);
1038                 data_len = btrfs_dir_data_len(eb, di);
1039                 type = btrfs_dir_type(eb, di);
1040                 btrfs_dir_item_key_to_cpu(eb, di, &di_key);
1041
1042                 if (type == BTRFS_FT_XATTR) {
1043                         if (name_len > XATTR_NAME_MAX) {
1044                                 ret = -ENAMETOOLONG;
1045                                 goto out;
1046                         }
1047                         if (name_len + data_len >
1048                                         BTRFS_MAX_XATTR_SIZE(root->fs_info)) {
1049                                 ret = -E2BIG;
1050                                 goto out;
1051                         }
1052                 } else {
1053                         /*
1054                          * Path too long
1055                          */
1056                         if (name_len + data_len > PATH_MAX) {
1057                                 ret = -ENAMETOOLONG;
1058                                 goto out;
1059                         }
1060                 }
1061
1062                 ret = btrfs_is_name_len_valid(eb, path->slots[0],
1063                           (unsigned long)(di + 1), name_len + data_len);
1064                 if (!ret) {
1065                         ret = -EIO;
1066                         goto out;
1067                 }
1068                 if (name_len + data_len > buf_len) {
1069                         buf_len = name_len + data_len;
1070                         if (is_vmalloc_addr(buf)) {
1071                                 vfree(buf);
1072                                 buf = NULL;
1073                         } else {
1074                                 char *tmp = krealloc(buf, buf_len,
1075                                                 GFP_KERNEL | __GFP_NOWARN);
1076
1077                                 if (!tmp)
1078                                         kfree(buf);
1079                                 buf = tmp;
1080                         }
1081                         if (!buf) {
1082                                 buf = kvmalloc(buf_len, GFP_KERNEL);
1083                                 if (!buf) {
1084                                         ret = -ENOMEM;
1085                                         goto out;
1086                                 }
1087                         }
1088                 }
1089
1090                 read_extent_buffer(eb, buf, (unsigned long)(di + 1),
1091                                 name_len + data_len);
1092
1093                 len = sizeof(*di) + name_len + data_len;
1094                 di = (struct btrfs_dir_item *)((char *)di + len);
1095                 cur += len;
1096
1097                 ret = iterate(num, &di_key, buf, name_len, buf + name_len,
1098                                 data_len, type, ctx);
1099                 if (ret < 0)
1100                         goto out;
1101                 if (ret) {
1102                         ret = 0;
1103                         goto out;
1104                 }
1105
1106                 num++;
1107         }
1108
1109 out:
1110         kvfree(buf);
1111         return ret;
1112 }
1113
1114 static int __copy_first_ref(int num, u64 dir, int index,
1115                             struct fs_path *p, void *ctx)
1116 {
1117         int ret;
1118         struct fs_path *pt = ctx;
1119
1120         ret = fs_path_copy(pt, p);
1121         if (ret < 0)
1122                 return ret;
1123
1124         /* we want the first only */
1125         return 1;
1126 }
1127
1128 /*
1129  * Retrieve the first path of an inode. If an inode has more then one
1130  * ref/hardlink, this is ignored.
1131  */
1132 static int get_inode_path(struct btrfs_root *root,
1133                           u64 ino, struct fs_path *path)
1134 {
1135         int ret;
1136         struct btrfs_key key, found_key;
1137         struct btrfs_path *p;
1138
1139         p = alloc_path_for_send();
1140         if (!p)
1141                 return -ENOMEM;
1142
1143         fs_path_reset(path);
1144
1145         key.objectid = ino;
1146         key.type = BTRFS_INODE_REF_KEY;
1147         key.offset = 0;
1148
1149         ret = btrfs_search_slot_for_read(root, &key, p, 1, 0);
1150         if (ret < 0)
1151                 goto out;
1152         if (ret) {
1153                 ret = 1;
1154                 goto out;
1155         }
1156         btrfs_item_key_to_cpu(p->nodes[0], &found_key, p->slots[0]);
1157         if (found_key.objectid != ino ||
1158             (found_key.type != BTRFS_INODE_REF_KEY &&
1159              found_key.type != BTRFS_INODE_EXTREF_KEY)) {
1160                 ret = -ENOENT;
1161                 goto out;
1162         }
1163
1164         ret = iterate_inode_ref(root, p, &found_key, 1,
1165                                 __copy_first_ref, path);
1166         if (ret < 0)
1167                 goto out;
1168         ret = 0;
1169
1170 out:
1171         btrfs_free_path(p);
1172         return ret;
1173 }
1174
1175 struct backref_ctx {
1176         struct send_ctx *sctx;
1177
1178         struct btrfs_path *path;
1179         /* number of total found references */
1180         u64 found;
1181
1182         /*
1183          * used for clones found in send_root. clones found behind cur_objectid
1184          * and cur_offset are not considered as allowed clones.
1185          */
1186         u64 cur_objectid;
1187         u64 cur_offset;
1188
1189         /* may be truncated in case it's the last extent in a file */
1190         u64 extent_len;
1191
1192         /* data offset in the file extent item */
1193         u64 data_offset;
1194
1195         /* Just to check for bugs in backref resolving */
1196         int found_itself;
1197 };
1198
1199 static int __clone_root_cmp_bsearch(const void *key, const void *elt)
1200 {
1201         u64 root = (u64)(uintptr_t)key;
1202         struct clone_root *cr = (struct clone_root *)elt;
1203
1204         if (root < cr->root->objectid)
1205                 return -1;
1206         if (root > cr->root->objectid)
1207                 return 1;
1208         return 0;
1209 }
1210
1211 static int __clone_root_cmp_sort(const void *e1, const void *e2)
1212 {
1213         struct clone_root *cr1 = (struct clone_root *)e1;
1214         struct clone_root *cr2 = (struct clone_root *)e2;
1215
1216         if (cr1->root->objectid < cr2->root->objectid)
1217                 return -1;
1218         if (cr1->root->objectid > cr2->root->objectid)
1219                 return 1;
1220         return 0;
1221 }
1222
1223 /*
1224  * Called for every backref that is found for the current extent.
1225  * Results are collected in sctx->clone_roots->ino/offset/found_refs
1226  */
1227 static int __iterate_backrefs(u64 ino, u64 offset, u64 root, void *ctx_)
1228 {
1229         struct backref_ctx *bctx = ctx_;
1230         struct clone_root *found;
1231         int ret;
1232         u64 i_size;
1233
1234         /* First check if the root is in the list of accepted clone sources */
1235         found = bsearch((void *)(uintptr_t)root, bctx->sctx->clone_roots,
1236                         bctx->sctx->clone_roots_cnt,
1237                         sizeof(struct clone_root),
1238                         __clone_root_cmp_bsearch);
1239         if (!found)
1240                 return 0;
1241
1242         if (found->root == bctx->sctx->send_root &&
1243             ino == bctx->cur_objectid &&
1244             offset == bctx->cur_offset) {
1245                 bctx->found_itself = 1;
1246         }
1247
1248         /*
1249          * There are inodes that have extents that lie behind its i_size. Don't
1250          * accept clones from these extents.
1251          */
1252         ret = __get_inode_info(found->root, bctx->path, ino, &i_size, NULL, NULL,
1253                                NULL, NULL, NULL);
1254         btrfs_release_path(bctx->path);
1255         if (ret < 0)
1256                 return ret;
1257
1258         if (offset + bctx->data_offset + bctx->extent_len > i_size)
1259                 return 0;
1260
1261         /*
1262          * Make sure we don't consider clones from send_root that are
1263          * behind the current inode/offset.
1264          */
1265         if (found->root == bctx->sctx->send_root) {
1266                 /*
1267                  * TODO for the moment we don't accept clones from the inode
1268                  * that is currently send. We may change this when
1269                  * BTRFS_IOC_CLONE_RANGE supports cloning from and to the same
1270                  * file.
1271                  */
1272                 if (ino >= bctx->cur_objectid)
1273                         return 0;
1274         }
1275
1276         bctx->found++;
1277         found->found_refs++;
1278         if (ino < found->ino) {
1279                 found->ino = ino;
1280                 found->offset = offset;
1281         } else if (found->ino == ino) {
1282                 /*
1283                  * same extent found more then once in the same file.
1284                  */
1285                 if (found->offset > offset + bctx->extent_len)
1286                         found->offset = offset;
1287         }
1288
1289         return 0;
1290 }
1291
1292 /*
1293  * Given an inode, offset and extent item, it finds a good clone for a clone
1294  * instruction. Returns -ENOENT when none could be found. The function makes
1295  * sure that the returned clone is usable at the point where sending is at the
1296  * moment. This means, that no clones are accepted which lie behind the current
1297  * inode+offset.
1298  *
1299  * path must point to the extent item when called.
1300  */
1301 static int find_extent_clone(struct send_ctx *sctx,
1302                              struct btrfs_path *path,
1303                              u64 ino, u64 data_offset,
1304                              u64 ino_size,
1305                              struct clone_root **found)
1306 {
1307         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
1308         int ret;
1309         int extent_type;
1310         u64 logical;
1311         u64 disk_byte;
1312         u64 num_bytes;
1313         u64 extent_item_pos;
1314         u64 flags = 0;
1315         struct btrfs_file_extent_item *fi;
1316         struct extent_buffer *eb = path->nodes[0];
1317         struct backref_ctx *backref_ctx = NULL;
1318         struct clone_root *cur_clone_root;
1319         struct btrfs_key found_key;
1320         struct btrfs_path *tmp_path;
1321         int compressed;
1322         u32 i;
1323
1324         tmp_path = alloc_path_for_send();
1325         if (!tmp_path)
1326                 return -ENOMEM;
1327
1328         /* We only use this path under the commit sem */
1329         tmp_path->need_commit_sem = 0;
1330
1331         backref_ctx = kmalloc(sizeof(*backref_ctx), GFP_KERNEL);
1332         if (!backref_ctx) {
1333                 ret = -ENOMEM;
1334                 goto out;
1335         }
1336
1337         backref_ctx->path = tmp_path;
1338
1339         if (data_offset >= ino_size) {
1340                 /*
1341                  * There may be extents that lie behind the file's size.
1342                  * I at least had this in combination with snapshotting while
1343                  * writing large files.
1344                  */
1345                 ret = 0;
1346                 goto out;
1347         }
1348
1349         fi = btrfs_item_ptr(eb, path->slots[0],
1350                         struct btrfs_file_extent_item);
1351         extent_type = btrfs_file_extent_type(eb, fi);
1352         if (extent_type == BTRFS_FILE_EXTENT_INLINE) {
1353                 ret = -ENOENT;
1354                 goto out;
1355         }
1356         compressed = btrfs_file_extent_compression(eb, fi);
1357
1358         num_bytes = btrfs_file_extent_num_bytes(eb, fi);
1359         disk_byte = btrfs_file_extent_disk_bytenr(eb, fi);
1360         if (disk_byte == 0) {
1361                 ret = -ENOENT;
1362                 goto out;
1363         }
1364         logical = disk_byte + btrfs_file_extent_offset(eb, fi);
1365
1366         down_read(&fs_info->commit_root_sem);
1367         ret = extent_from_logical(fs_info, disk_byte, tmp_path,
1368                                   &found_key, &flags);
1369         up_read(&fs_info->commit_root_sem);
1370         btrfs_release_path(tmp_path);
1371
1372         if (ret < 0)
1373                 goto out;
1374         if (flags & BTRFS_EXTENT_FLAG_TREE_BLOCK) {
1375                 ret = -EIO;
1376                 goto out;
1377         }
1378
1379         /*
1380          * Setup the clone roots.
1381          */
1382         for (i = 0; i < sctx->clone_roots_cnt; i++) {
1383                 cur_clone_root = sctx->clone_roots + i;
1384                 cur_clone_root->ino = (u64)-1;
1385                 cur_clone_root->offset = 0;
1386                 cur_clone_root->found_refs = 0;
1387         }
1388
1389         backref_ctx->sctx = sctx;
1390         backref_ctx->found = 0;
1391         backref_ctx->cur_objectid = ino;
1392         backref_ctx->cur_offset = data_offset;
1393         backref_ctx->found_itself = 0;
1394         backref_ctx->extent_len = num_bytes;
1395         /*
1396          * For non-compressed extents iterate_extent_inodes() gives us extent
1397          * offsets that already take into account the data offset, but not for
1398          * compressed extents, since the offset is logical and not relative to
1399          * the physical extent locations. We must take this into account to
1400          * avoid sending clone offsets that go beyond the source file's size,
1401          * which would result in the clone ioctl failing with -EINVAL on the
1402          * receiving end.
1403          */
1404         if (compressed == BTRFS_COMPRESS_NONE)
1405                 backref_ctx->data_offset = 0;
1406         else
1407                 backref_ctx->data_offset = btrfs_file_extent_offset(eb, fi);
1408
1409         /*
1410          * The last extent of a file may be too large due to page alignment.
1411          * We need to adjust extent_len in this case so that the checks in
1412          * __iterate_backrefs work.
1413          */
1414         if (data_offset + num_bytes >= ino_size)
1415                 backref_ctx->extent_len = ino_size - data_offset;
1416
1417         /*
1418          * Now collect all backrefs.
1419          */
1420         if (compressed == BTRFS_COMPRESS_NONE)
1421                 extent_item_pos = logical - found_key.objectid;
1422         else
1423                 extent_item_pos = 0;
1424         ret = iterate_extent_inodes(fs_info, found_key.objectid,
1425                                     extent_item_pos, 1, __iterate_backrefs,
1426                                     backref_ctx);
1427
1428         if (ret < 0)
1429                 goto out;
1430
1431         if (!backref_ctx->found_itself) {
1432                 /* found a bug in backref code? */
1433                 ret = -EIO;
1434                 btrfs_err(fs_info,
1435                           "did not find backref in send_root. inode=%llu, offset=%llu, disk_byte=%llu found extent=%llu",
1436                           ino, data_offset, disk_byte, found_key.objectid);
1437                 goto out;
1438         }
1439
1440         btrfs_debug(fs_info,
1441                     "find_extent_clone: data_offset=%llu, ino=%llu, num_bytes=%llu, logical=%llu",
1442                     data_offset, ino, num_bytes, logical);
1443
1444         if (!backref_ctx->found)
1445                 btrfs_debug(fs_info, "no clones found");
1446
1447         cur_clone_root = NULL;
1448         for (i = 0; i < sctx->clone_roots_cnt; i++) {
1449                 if (sctx->clone_roots[i].found_refs) {
1450                         if (!cur_clone_root)
1451                                 cur_clone_root = sctx->clone_roots + i;
1452                         else if (sctx->clone_roots[i].root == sctx->send_root)
1453                                 /* prefer clones from send_root over others */
1454                                 cur_clone_root = sctx->clone_roots + i;
1455                 }
1456
1457         }
1458
1459         if (cur_clone_root) {
1460                 *found = cur_clone_root;
1461                 ret = 0;
1462         } else {
1463                 ret = -ENOENT;
1464         }
1465
1466 out:
1467         btrfs_free_path(tmp_path);
1468         kfree(backref_ctx);
1469         return ret;
1470 }
1471
1472 static int read_symlink(struct btrfs_root *root,
1473                         u64 ino,
1474                         struct fs_path *dest)
1475 {
1476         int ret;
1477         struct btrfs_path *path;
1478         struct btrfs_key key;
1479         struct btrfs_file_extent_item *ei;
1480         u8 type;
1481         u8 compression;
1482         unsigned long off;
1483         int len;
1484
1485         path = alloc_path_for_send();
1486         if (!path)
1487                 return -ENOMEM;
1488
1489         key.objectid = ino;
1490         key.type = BTRFS_EXTENT_DATA_KEY;
1491         key.offset = 0;
1492         ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
1493         if (ret < 0)
1494                 goto out;
1495         if (ret) {
1496                 /*
1497                  * An empty symlink inode. Can happen in rare error paths when
1498                  * creating a symlink (transaction committed before the inode
1499                  * eviction handler removed the symlink inode items and a crash
1500                  * happened in between or the subvol was snapshoted in between).
1501                  * Print an informative message to dmesg/syslog so that the user
1502                  * can delete the symlink.
1503                  */
1504                 btrfs_err(root->fs_info,
1505                           "Found empty symlink inode %llu at root %llu",
1506                           ino, root->root_key.objectid);
1507                 ret = -EIO;
1508                 goto out;
1509         }
1510
1511         ei = btrfs_item_ptr(path->nodes[0], path->slots[0],
1512                         struct btrfs_file_extent_item);
1513         type = btrfs_file_extent_type(path->nodes[0], ei);
1514         compression = btrfs_file_extent_compression(path->nodes[0], ei);
1515         BUG_ON(type != BTRFS_FILE_EXTENT_INLINE);
1516         BUG_ON(compression);
1517
1518         off = btrfs_file_extent_inline_start(ei);
1519         len = btrfs_file_extent_inline_len(path->nodes[0], path->slots[0], ei);
1520
1521         ret = fs_path_add_from_extent_buffer(dest, path->nodes[0], off, len);
1522
1523 out:
1524         btrfs_free_path(path);
1525         return ret;
1526 }
1527
1528 /*
1529  * Helper function to generate a file name that is unique in the root of
1530  * send_root and parent_root. This is used to generate names for orphan inodes.
1531  */
1532 static int gen_unique_name(struct send_ctx *sctx,
1533                            u64 ino, u64 gen,
1534                            struct fs_path *dest)
1535 {
1536         int ret = 0;
1537         struct btrfs_path *path;
1538         struct btrfs_dir_item *di;
1539         char tmp[64];
1540         int len;
1541         u64 idx = 0;
1542
1543         path = alloc_path_for_send();
1544         if (!path)
1545                 return -ENOMEM;
1546
1547         while (1) {
1548                 len = snprintf(tmp, sizeof(tmp), "o%llu-%llu-%llu",
1549                                 ino, gen, idx);
1550                 ASSERT(len < sizeof(tmp));
1551
1552                 di = btrfs_lookup_dir_item(NULL, sctx->send_root,
1553                                 path, BTRFS_FIRST_FREE_OBJECTID,
1554                                 tmp, strlen(tmp), 0);
1555                 btrfs_release_path(path);
1556                 if (IS_ERR(di)) {
1557                         ret = PTR_ERR(di);
1558                         goto out;
1559                 }
1560                 if (di) {
1561                         /* not unique, try again */
1562                         idx++;
1563                         continue;
1564                 }
1565
1566                 if (!sctx->parent_root) {
1567                         /* unique */
1568                         ret = 0;
1569                         break;
1570                 }
1571
1572                 di = btrfs_lookup_dir_item(NULL, sctx->parent_root,
1573                                 path, BTRFS_FIRST_FREE_OBJECTID,
1574                                 tmp, strlen(tmp), 0);
1575                 btrfs_release_path(path);
1576                 if (IS_ERR(di)) {
1577                         ret = PTR_ERR(di);
1578                         goto out;
1579                 }
1580                 if (di) {
1581                         /* not unique, try again */
1582                         idx++;
1583                         continue;
1584                 }
1585                 /* unique */
1586                 break;
1587         }
1588
1589         ret = fs_path_add(dest, tmp, strlen(tmp));
1590
1591 out:
1592         btrfs_free_path(path);
1593         return ret;
1594 }
1595
1596 enum inode_state {
1597         inode_state_no_change,
1598         inode_state_will_create,
1599         inode_state_did_create,
1600         inode_state_will_delete,
1601         inode_state_did_delete,
1602 };
1603
1604 static int get_cur_inode_state(struct send_ctx *sctx, u64 ino, u64 gen)
1605 {
1606         int ret;
1607         int left_ret;
1608         int right_ret;
1609         u64 left_gen;
1610         u64 right_gen;
1611
1612         ret = get_inode_info(sctx->send_root, ino, NULL, &left_gen, NULL, NULL,
1613                         NULL, NULL);
1614         if (ret < 0 && ret != -ENOENT)
1615                 goto out;
1616         left_ret = ret;
1617
1618         if (!sctx->parent_root) {
1619                 right_ret = -ENOENT;
1620         } else {
1621                 ret = get_inode_info(sctx->parent_root, ino, NULL, &right_gen,
1622                                 NULL, NULL, NULL, NULL);
1623                 if (ret < 0 && ret != -ENOENT)
1624                         goto out;
1625                 right_ret = ret;
1626         }
1627
1628         if (!left_ret && !right_ret) {
1629                 if (left_gen == gen && right_gen == gen) {
1630                         ret = inode_state_no_change;
1631                 } else if (left_gen == gen) {
1632                         if (ino < sctx->send_progress)
1633                                 ret = inode_state_did_create;
1634                         else
1635                                 ret = inode_state_will_create;
1636                 } else if (right_gen == gen) {
1637                         if (ino < sctx->send_progress)
1638                                 ret = inode_state_did_delete;
1639                         else
1640                                 ret = inode_state_will_delete;
1641                 } else  {
1642                         ret = -ENOENT;
1643                 }
1644         } else if (!left_ret) {
1645                 if (left_gen == gen) {
1646                         if (ino < sctx->send_progress)
1647                                 ret = inode_state_did_create;
1648                         else
1649                                 ret = inode_state_will_create;
1650                 } else {
1651                         ret = -ENOENT;
1652                 }
1653         } else if (!right_ret) {
1654                 if (right_gen == gen) {
1655                         if (ino < sctx->send_progress)
1656                                 ret = inode_state_did_delete;
1657                         else
1658                                 ret = inode_state_will_delete;
1659                 } else {
1660                         ret = -ENOENT;
1661                 }
1662         } else {
1663                 ret = -ENOENT;
1664         }
1665
1666 out:
1667         return ret;
1668 }
1669
1670 static int is_inode_existent(struct send_ctx *sctx, u64 ino, u64 gen)
1671 {
1672         int ret;
1673
1674         if (ino == BTRFS_FIRST_FREE_OBJECTID)
1675                 return 1;
1676
1677         ret = get_cur_inode_state(sctx, ino, gen);
1678         if (ret < 0)
1679                 goto out;
1680
1681         if (ret == inode_state_no_change ||
1682             ret == inode_state_did_create ||
1683             ret == inode_state_will_delete)
1684                 ret = 1;
1685         else
1686                 ret = 0;
1687
1688 out:
1689         return ret;
1690 }
1691
1692 /*
1693  * Helper function to lookup a dir item in a dir.
1694  */
1695 static int lookup_dir_item_inode(struct btrfs_root *root,
1696                                  u64 dir, const char *name, int name_len,
1697                                  u64 *found_inode,
1698                                  u8 *found_type)
1699 {
1700         int ret = 0;
1701         struct btrfs_dir_item *di;
1702         struct btrfs_key key;
1703         struct btrfs_path *path;
1704
1705         path = alloc_path_for_send();
1706         if (!path)
1707                 return -ENOMEM;
1708
1709         di = btrfs_lookup_dir_item(NULL, root, path,
1710                         dir, name, name_len, 0);
1711         if (!di) {
1712                 ret = -ENOENT;
1713                 goto out;
1714         }
1715         if (IS_ERR(di)) {
1716                 ret = PTR_ERR(di);
1717                 goto out;
1718         }
1719         btrfs_dir_item_key_to_cpu(path->nodes[0], di, &key);
1720         if (key.type == BTRFS_ROOT_ITEM_KEY) {
1721                 ret = -ENOENT;
1722                 goto out;
1723         }
1724         *found_inode = key.objectid;
1725         *found_type = btrfs_dir_type(path->nodes[0], di);
1726
1727 out:
1728         btrfs_free_path(path);
1729         return ret;
1730 }
1731
1732 /*
1733  * Looks up the first btrfs_inode_ref of a given ino. It returns the parent dir,
1734  * generation of the parent dir and the name of the dir entry.
1735  */
1736 static int get_first_ref(struct btrfs_root *root, u64 ino,
1737                          u64 *dir, u64 *dir_gen, struct fs_path *name)
1738 {
1739         int ret;
1740         struct btrfs_key key;
1741         struct btrfs_key found_key;
1742         struct btrfs_path *path;
1743         int len;
1744         u64 parent_dir;
1745
1746         path = alloc_path_for_send();
1747         if (!path)
1748                 return -ENOMEM;
1749
1750         key.objectid = ino;
1751         key.type = BTRFS_INODE_REF_KEY;
1752         key.offset = 0;
1753
1754         ret = btrfs_search_slot_for_read(root, &key, path, 1, 0);
1755         if (ret < 0)
1756                 goto out;
1757         if (!ret)
1758                 btrfs_item_key_to_cpu(path->nodes[0], &found_key,
1759                                 path->slots[0]);
1760         if (ret || found_key.objectid != ino ||
1761             (found_key.type != BTRFS_INODE_REF_KEY &&
1762              found_key.type != BTRFS_INODE_EXTREF_KEY)) {
1763                 ret = -ENOENT;
1764                 goto out;
1765         }
1766
1767         if (found_key.type == BTRFS_INODE_REF_KEY) {
1768                 struct btrfs_inode_ref *iref;
1769                 iref = btrfs_item_ptr(path->nodes[0], path->slots[0],
1770                                       struct btrfs_inode_ref);
1771                 len = btrfs_inode_ref_name_len(path->nodes[0], iref);
1772                 ret = fs_path_add_from_extent_buffer(name, path->nodes[0],
1773                                                      (unsigned long)(iref + 1),
1774                                                      len);
1775                 parent_dir = found_key.offset;
1776         } else {
1777                 struct btrfs_inode_extref *extref;
1778                 extref = btrfs_item_ptr(path->nodes[0], path->slots[0],
1779                                         struct btrfs_inode_extref);
1780                 len = btrfs_inode_extref_name_len(path->nodes[0], extref);
1781                 ret = fs_path_add_from_extent_buffer(name, path->nodes[0],
1782                                         (unsigned long)&extref->name, len);
1783                 parent_dir = btrfs_inode_extref_parent(path->nodes[0], extref);
1784         }
1785         if (ret < 0)
1786                 goto out;
1787         btrfs_release_path(path);
1788
1789         if (dir_gen) {
1790                 ret = get_inode_info(root, parent_dir, NULL, dir_gen, NULL,
1791                                      NULL, NULL, NULL);
1792                 if (ret < 0)
1793                         goto out;
1794         }
1795
1796         *dir = parent_dir;
1797
1798 out:
1799         btrfs_free_path(path);
1800         return ret;
1801 }
1802
1803 static int is_first_ref(struct btrfs_root *root,
1804                         u64 ino, u64 dir,
1805                         const char *name, int name_len)
1806 {
1807         int ret;
1808         struct fs_path *tmp_name;
1809         u64 tmp_dir;
1810
1811         tmp_name = fs_path_alloc();
1812         if (!tmp_name)
1813                 return -ENOMEM;
1814
1815         ret = get_first_ref(root, ino, &tmp_dir, NULL, tmp_name);
1816         if (ret < 0)
1817                 goto out;
1818
1819         if (dir != tmp_dir || name_len != fs_path_len(tmp_name)) {
1820                 ret = 0;
1821                 goto out;
1822         }
1823
1824         ret = !memcmp(tmp_name->start, name, name_len);
1825
1826 out:
1827         fs_path_free(tmp_name);
1828         return ret;
1829 }
1830
1831 /*
1832  * Used by process_recorded_refs to determine if a new ref would overwrite an
1833  * already existing ref. In case it detects an overwrite, it returns the
1834  * inode/gen in who_ino/who_gen.
1835  * When an overwrite is detected, process_recorded_refs does proper orphanizing
1836  * to make sure later references to the overwritten inode are possible.
1837  * Orphanizing is however only required for the first ref of an inode.
1838  * process_recorded_refs does an additional is_first_ref check to see if
1839  * orphanizing is really required.
1840  */
1841 static int will_overwrite_ref(struct send_ctx *sctx, u64 dir, u64 dir_gen,
1842                               const char *name, int name_len,
1843                               u64 *who_ino, u64 *who_gen, u64 *who_mode)
1844 {
1845         int ret = 0;
1846         u64 gen;
1847         u64 other_inode = 0;
1848         u8 other_type = 0;
1849
1850         if (!sctx->parent_root)
1851                 goto out;
1852
1853         ret = is_inode_existent(sctx, dir, dir_gen);
1854         if (ret <= 0)
1855                 goto out;
1856
1857         /*
1858          * If we have a parent root we need to verify that the parent dir was
1859          * not deleted and then re-created, if it was then we have no overwrite
1860          * and we can just unlink this entry.
1861          */
1862         if (sctx->parent_root && dir != BTRFS_FIRST_FREE_OBJECTID) {
1863                 ret = get_inode_info(sctx->parent_root, dir, NULL, &gen, NULL,
1864                                      NULL, NULL, NULL);
1865                 if (ret < 0 && ret != -ENOENT)
1866                         goto out;
1867                 if (ret) {
1868                         ret = 0;
1869                         goto out;
1870                 }
1871                 if (gen != dir_gen)
1872                         goto out;
1873         }
1874
1875         ret = lookup_dir_item_inode(sctx->parent_root, dir, name, name_len,
1876                         &other_inode, &other_type);
1877         if (ret < 0 && ret != -ENOENT)
1878                 goto out;
1879         if (ret) {
1880                 ret = 0;
1881                 goto out;
1882         }
1883
1884         /*
1885          * Check if the overwritten ref was already processed. If yes, the ref
1886          * was already unlinked/moved, so we can safely assume that we will not
1887          * overwrite anything at this point in time.
1888          */
1889         if (other_inode > sctx->send_progress ||
1890             is_waiting_for_move(sctx, other_inode)) {
1891                 ret = get_inode_info(sctx->parent_root, other_inode, NULL,
1892                                 who_gen, who_mode, NULL, NULL, NULL);
1893                 if (ret < 0)
1894                         goto out;
1895
1896                 ret = 1;
1897                 *who_ino = other_inode;
1898         } else {
1899                 ret = 0;
1900         }
1901
1902 out:
1903         return ret;
1904 }
1905
1906 /*
1907  * Checks if the ref was overwritten by an already processed inode. This is
1908  * used by __get_cur_name_and_parent to find out if the ref was orphanized and
1909  * thus the orphan name needs be used.
1910  * process_recorded_refs also uses it to avoid unlinking of refs that were
1911  * overwritten.
1912  */
1913 static int did_overwrite_ref(struct send_ctx *sctx,
1914                             u64 dir, u64 dir_gen,
1915                             u64 ino, u64 ino_gen,
1916                             const char *name, int name_len)
1917 {
1918         int ret = 0;
1919         u64 gen;
1920         u64 ow_inode;
1921         u8 other_type;
1922
1923         if (!sctx->parent_root)
1924                 goto out;
1925
1926         ret = is_inode_existent(sctx, dir, dir_gen);
1927         if (ret <= 0)
1928                 goto out;
1929
1930         if (dir != BTRFS_FIRST_FREE_OBJECTID) {
1931                 ret = get_inode_info(sctx->send_root, dir, NULL, &gen, NULL,
1932                                      NULL, NULL, NULL);
1933                 if (ret < 0 && ret != -ENOENT)
1934                         goto out;
1935                 if (ret) {
1936                         ret = 0;
1937                         goto out;
1938                 }
1939                 if (gen != dir_gen)
1940                         goto out;
1941         }
1942
1943         /* check if the ref was overwritten by another ref */
1944         ret = lookup_dir_item_inode(sctx->send_root, dir, name, name_len,
1945                         &ow_inode, &other_type);
1946         if (ret < 0 && ret != -ENOENT)
1947                 goto out;
1948         if (ret) {
1949                 /* was never and will never be overwritten */
1950                 ret = 0;
1951                 goto out;
1952         }
1953
1954         ret = get_inode_info(sctx->send_root, ow_inode, NULL, &gen, NULL, NULL,
1955                         NULL, NULL);
1956         if (ret < 0)
1957                 goto out;
1958
1959         if (ow_inode == ino && gen == ino_gen) {
1960                 ret = 0;
1961                 goto out;
1962         }
1963
1964         /*
1965          * We know that it is or will be overwritten. Check this now.
1966          * The current inode being processed might have been the one that caused
1967          * inode 'ino' to be orphanized, therefore check if ow_inode matches
1968          * the current inode being processed.
1969          */
1970         if ((ow_inode < sctx->send_progress) ||
1971             (ino != sctx->cur_ino && ow_inode == sctx->cur_ino &&
1972              gen == sctx->cur_inode_gen))
1973                 ret = 1;
1974         else
1975                 ret = 0;
1976
1977 out:
1978         return ret;
1979 }
1980
1981 /*
1982  * Same as did_overwrite_ref, but also checks if it is the first ref of an inode
1983  * that got overwritten. This is used by process_recorded_refs to determine
1984  * if it has to use the path as returned by get_cur_path or the orphan name.
1985  */
1986 static int did_overwrite_first_ref(struct send_ctx *sctx, u64 ino, u64 gen)
1987 {
1988         int ret = 0;
1989         struct fs_path *name = NULL;
1990         u64 dir;
1991         u64 dir_gen;
1992
1993         if (!sctx->parent_root)
1994                 goto out;
1995
1996         name = fs_path_alloc();
1997         if (!name)
1998                 return -ENOMEM;
1999
2000         ret = get_first_ref(sctx->parent_root, ino, &dir, &dir_gen, name);
2001         if (ret < 0)
2002                 goto out;
2003
2004         ret = did_overwrite_ref(sctx, dir, dir_gen, ino, gen,
2005                         name->start, fs_path_len(name));
2006
2007 out:
2008         fs_path_free(name);
2009         return ret;
2010 }
2011
2012 /*
2013  * Insert a name cache entry. On 32bit kernels the radix tree index is 32bit,
2014  * so we need to do some special handling in case we have clashes. This function
2015  * takes care of this with the help of name_cache_entry::radix_list.
2016  * In case of error, nce is kfreed.
2017  */
2018 static int name_cache_insert(struct send_ctx *sctx,
2019                              struct name_cache_entry *nce)
2020 {
2021         int ret = 0;
2022         struct list_head *nce_head;
2023
2024         nce_head = radix_tree_lookup(&sctx->name_cache,
2025                         (unsigned long)nce->ino);
2026         if (!nce_head) {
2027                 nce_head = kmalloc(sizeof(*nce_head), GFP_KERNEL);
2028                 if (!nce_head) {
2029                         kfree(nce);
2030                         return -ENOMEM;
2031                 }
2032                 INIT_LIST_HEAD(nce_head);
2033
2034                 ret = radix_tree_insert(&sctx->name_cache, nce->ino, nce_head);
2035                 if (ret < 0) {
2036                         kfree(nce_head);
2037                         kfree(nce);
2038                         return ret;
2039                 }
2040         }
2041         list_add_tail(&nce->radix_list, nce_head);
2042         list_add_tail(&nce->list, &sctx->name_cache_list);
2043         sctx->name_cache_size++;
2044
2045         return ret;
2046 }
2047
2048 static void name_cache_delete(struct send_ctx *sctx,
2049                               struct name_cache_entry *nce)
2050 {
2051         struct list_head *nce_head;
2052
2053         nce_head = radix_tree_lookup(&sctx->name_cache,
2054                         (unsigned long)nce->ino);
2055         if (!nce_head) {
2056                 btrfs_err(sctx->send_root->fs_info,
2057               "name_cache_delete lookup failed ino %llu cache size %d, leaking memory",
2058                         nce->ino, sctx->name_cache_size);
2059         }
2060
2061         list_del(&nce->radix_list);
2062         list_del(&nce->list);
2063         sctx->name_cache_size--;
2064
2065         /*
2066          * We may not get to the final release of nce_head if the lookup fails
2067          */
2068         if (nce_head && list_empty(nce_head)) {
2069                 radix_tree_delete(&sctx->name_cache, (unsigned long)nce->ino);
2070                 kfree(nce_head);
2071         }
2072 }
2073
2074 static struct name_cache_entry *name_cache_search(struct send_ctx *sctx,
2075                                                     u64 ino, u64 gen)
2076 {
2077         struct list_head *nce_head;
2078         struct name_cache_entry *cur;
2079
2080         nce_head = radix_tree_lookup(&sctx->name_cache, (unsigned long)ino);
2081         if (!nce_head)
2082                 return NULL;
2083
2084         list_for_each_entry(cur, nce_head, radix_list) {
2085                 if (cur->ino == ino && cur->gen == gen)
2086                         return cur;
2087         }
2088         return NULL;
2089 }
2090
2091 /*
2092  * Removes the entry from the list and adds it back to the end. This marks the
2093  * entry as recently used so that name_cache_clean_unused does not remove it.
2094  */
2095 static void name_cache_used(struct send_ctx *sctx, struct name_cache_entry *nce)
2096 {
2097         list_del(&nce->list);
2098         list_add_tail(&nce->list, &sctx->name_cache_list);
2099 }
2100
2101 /*
2102  * Remove some entries from the beginning of name_cache_list.
2103  */
2104 static void name_cache_clean_unused(struct send_ctx *sctx)
2105 {
2106         struct name_cache_entry *nce;
2107
2108         if (sctx->name_cache_size < SEND_CTX_NAME_CACHE_CLEAN_SIZE)
2109                 return;
2110
2111         while (sctx->name_cache_size > SEND_CTX_MAX_NAME_CACHE_SIZE) {
2112                 nce = list_entry(sctx->name_cache_list.next,
2113                                 struct name_cache_entry, list);
2114                 name_cache_delete(sctx, nce);
2115                 kfree(nce);
2116         }
2117 }
2118
2119 static void name_cache_free(struct send_ctx *sctx)
2120 {
2121         struct name_cache_entry *nce;
2122
2123         while (!list_empty(&sctx->name_cache_list)) {
2124                 nce = list_entry(sctx->name_cache_list.next,
2125                                 struct name_cache_entry, list);
2126                 name_cache_delete(sctx, nce);
2127                 kfree(nce);
2128         }
2129 }
2130
2131 /*
2132  * Used by get_cur_path for each ref up to the root.
2133  * Returns 0 if it succeeded.
2134  * Returns 1 if the inode is not existent or got overwritten. In that case, the
2135  * name is an orphan name. This instructs get_cur_path to stop iterating. If 1
2136  * is returned, parent_ino/parent_gen are not guaranteed to be valid.
2137  * Returns <0 in case of error.
2138  */
2139 static int __get_cur_name_and_parent(struct send_ctx *sctx,
2140                                      u64 ino, u64 gen,
2141                                      u64 *parent_ino,
2142                                      u64 *parent_gen,
2143                                      struct fs_path *dest)
2144 {
2145         int ret;
2146         int nce_ret;
2147         struct name_cache_entry *nce = NULL;
2148
2149         /*
2150          * First check if we already did a call to this function with the same
2151          * ino/gen. If yes, check if the cache entry is still up-to-date. If yes
2152          * return the cached result.
2153          */
2154         nce = name_cache_search(sctx, ino, gen);
2155         if (nce) {
2156                 if (ino < sctx->send_progress && nce->need_later_update) {
2157                         name_cache_delete(sctx, nce);
2158                         kfree(nce);
2159                         nce = NULL;
2160                 } else {
2161                         name_cache_used(sctx, nce);
2162                         *parent_ino = nce->parent_ino;
2163                         *parent_gen = nce->parent_gen;
2164                         ret = fs_path_add(dest, nce->name, nce->name_len);
2165                         if (ret < 0)
2166                                 goto out;
2167                         ret = nce->ret;
2168                         goto out;
2169                 }
2170         }
2171
2172         /*
2173          * If the inode is not existent yet, add the orphan name and return 1.
2174          * This should only happen for the parent dir that we determine in
2175          * __record_new_ref
2176          */
2177         ret = is_inode_existent(sctx, ino, gen);
2178         if (ret < 0)
2179                 goto out;
2180
2181         if (!ret) {
2182                 ret = gen_unique_name(sctx, ino, gen, dest);
2183                 if (ret < 0)
2184                         goto out;
2185                 ret = 1;
2186                 goto out_cache;
2187         }
2188
2189         /*
2190          * Depending on whether the inode was already processed or not, use
2191          * send_root or parent_root for ref lookup.
2192          */
2193         if (ino < sctx->send_progress)
2194                 ret = get_first_ref(sctx->send_root, ino,
2195                                     parent_ino, parent_gen, dest);
2196         else
2197                 ret = get_first_ref(sctx->parent_root, ino,
2198                                     parent_ino, parent_gen, dest);
2199         if (ret < 0)
2200                 goto out;
2201
2202         /*
2203          * Check if the ref was overwritten by an inode's ref that was processed
2204          * earlier. If yes, treat as orphan and return 1.
2205          */
2206         ret = did_overwrite_ref(sctx, *parent_ino, *parent_gen, ino, gen,
2207                         dest->start, dest->end - dest->start);
2208         if (ret < 0)
2209                 goto out;
2210         if (ret) {
2211                 fs_path_reset(dest);
2212                 ret = gen_unique_name(sctx, ino, gen, dest);
2213                 if (ret < 0)
2214                         goto out;
2215                 ret = 1;
2216         }
2217
2218 out_cache:
2219         /*
2220          * Store the result of the lookup in the name cache.
2221          */
2222         nce = kmalloc(sizeof(*nce) + fs_path_len(dest) + 1, GFP_KERNEL);
2223         if (!nce) {
2224                 ret = -ENOMEM;
2225                 goto out;
2226         }
2227
2228         nce->ino = ino;
2229         nce->gen = gen;
2230         nce->parent_ino = *parent_ino;
2231         nce->parent_gen = *parent_gen;
2232         nce->name_len = fs_path_len(dest);
2233         nce->ret = ret;
2234         strcpy(nce->name, dest->start);
2235
2236         if (ino < sctx->send_progress)
2237                 nce->need_later_update = 0;
2238         else
2239                 nce->need_later_update = 1;
2240
2241         nce_ret = name_cache_insert(sctx, nce);
2242         if (nce_ret < 0)
2243                 ret = nce_ret;
2244         name_cache_clean_unused(sctx);
2245
2246 out:
2247         return ret;
2248 }
2249
2250 /*
2251  * Magic happens here. This function returns the first ref to an inode as it
2252  * would look like while receiving the stream at this point in time.
2253  * We walk the path up to the root. For every inode in between, we check if it
2254  * was already processed/sent. If yes, we continue with the parent as found
2255  * in send_root. If not, we continue with the parent as found in parent_root.
2256  * If we encounter an inode that was deleted at this point in time, we use the
2257  * inodes "orphan" name instead of the real name and stop. Same with new inodes
2258  * that were not created yet and overwritten inodes/refs.
2259  *
2260  * When do we have have orphan inodes:
2261  * 1. When an inode is freshly created and thus no valid refs are available yet
2262  * 2. When a directory lost all it's refs (deleted) but still has dir items
2263  *    inside which were not processed yet (pending for move/delete). If anyone
2264  *    tried to get the path to the dir items, it would get a path inside that
2265  *    orphan directory.
2266  * 3. When an inode is moved around or gets new links, it may overwrite the ref
2267  *    of an unprocessed inode. If in that case the first ref would be
2268  *    overwritten, the overwritten inode gets "orphanized". Later when we
2269  *    process this overwritten inode, it is restored at a new place by moving
2270  *    the orphan inode.
2271  *
2272  * sctx->send_progress tells this function at which point in time receiving
2273  * would be.
2274  */
2275 static int get_cur_path(struct send_ctx *sctx, u64 ino, u64 gen,
2276                         struct fs_path *dest)
2277 {
2278         int ret = 0;
2279         struct fs_path *name = NULL;
2280         u64 parent_inode = 0;
2281         u64 parent_gen = 0;
2282         int stop = 0;
2283
2284         name = fs_path_alloc();
2285         if (!name) {
2286                 ret = -ENOMEM;
2287                 goto out;
2288         }
2289
2290         dest->reversed = 1;
2291         fs_path_reset(dest);
2292
2293         while (!stop && ino != BTRFS_FIRST_FREE_OBJECTID) {
2294                 struct waiting_dir_move *wdm;
2295
2296                 fs_path_reset(name);
2297
2298                 if (is_waiting_for_rm(sctx, ino)) {
2299                         ret = gen_unique_name(sctx, ino, gen, name);
2300                         if (ret < 0)
2301                                 goto out;
2302                         ret = fs_path_add_path(dest, name);
2303                         break;
2304                 }
2305
2306                 wdm = get_waiting_dir_move(sctx, ino);
2307                 if (wdm && wdm->orphanized) {
2308                         ret = gen_unique_name(sctx, ino, gen, name);
2309                         stop = 1;
2310                 } else if (wdm) {
2311                         ret = get_first_ref(sctx->parent_root, ino,
2312                                             &parent_inode, &parent_gen, name);
2313                 } else {
2314                         ret = __get_cur_name_and_parent(sctx, ino, gen,
2315                                                         &parent_inode,
2316                                                         &parent_gen, name);
2317                         if (ret)
2318                                 stop = 1;
2319                 }
2320
2321                 if (ret < 0)
2322                         goto out;
2323
2324                 ret = fs_path_add_path(dest, name);
2325                 if (ret < 0)
2326                         goto out;
2327
2328                 ino = parent_inode;
2329                 gen = parent_gen;
2330         }
2331
2332 out:
2333         fs_path_free(name);
2334         if (!ret)
2335                 fs_path_unreverse(dest);
2336         return ret;
2337 }
2338
2339 /*
2340  * Sends a BTRFS_SEND_C_SUBVOL command/item to userspace
2341  */
2342 static int send_subvol_begin(struct send_ctx *sctx)
2343 {
2344         int ret;
2345         struct btrfs_root *send_root = sctx->send_root;
2346         struct btrfs_root *parent_root = sctx->parent_root;
2347         struct btrfs_path *path;
2348         struct btrfs_key key;
2349         struct btrfs_root_ref *ref;
2350         struct extent_buffer *leaf;
2351         char *name = NULL;
2352         int namelen;
2353
2354         path = btrfs_alloc_path();
2355         if (!path)
2356                 return -ENOMEM;
2357
2358         name = kmalloc(BTRFS_PATH_NAME_MAX, GFP_KERNEL);
2359         if (!name) {
2360                 btrfs_free_path(path);
2361                 return -ENOMEM;
2362         }
2363
2364         key.objectid = send_root->objectid;
2365         key.type = BTRFS_ROOT_BACKREF_KEY;
2366         key.offset = 0;
2367
2368         ret = btrfs_search_slot_for_read(send_root->fs_info->tree_root,
2369                                 &key, path, 1, 0);
2370         if (ret < 0)
2371                 goto out;
2372         if (ret) {
2373                 ret = -ENOENT;
2374                 goto out;
2375         }
2376
2377         leaf = path->nodes[0];
2378         btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
2379         if (key.type != BTRFS_ROOT_BACKREF_KEY ||
2380             key.objectid != send_root->objectid) {
2381                 ret = -ENOENT;
2382                 goto out;
2383         }
2384         ref = btrfs_item_ptr(leaf, path->slots[0], struct btrfs_root_ref);
2385         namelen = btrfs_root_ref_name_len(leaf, ref);
2386         read_extent_buffer(leaf, name, (unsigned long)(ref + 1), namelen);
2387         btrfs_release_path(path);
2388
2389         if (parent_root) {
2390                 ret = begin_cmd(sctx, BTRFS_SEND_C_SNAPSHOT);
2391                 if (ret < 0)
2392                         goto out;
2393         } else {
2394                 ret = begin_cmd(sctx, BTRFS_SEND_C_SUBVOL);
2395                 if (ret < 0)
2396                         goto out;
2397         }
2398
2399         TLV_PUT_STRING(sctx, BTRFS_SEND_A_PATH, name, namelen);
2400
2401         if (!btrfs_is_empty_uuid(sctx->send_root->root_item.received_uuid))
2402                 TLV_PUT_UUID(sctx, BTRFS_SEND_A_UUID,
2403                             sctx->send_root->root_item.received_uuid);
2404         else
2405                 TLV_PUT_UUID(sctx, BTRFS_SEND_A_UUID,
2406                             sctx->send_root->root_item.uuid);
2407
2408         TLV_PUT_U64(sctx, BTRFS_SEND_A_CTRANSID,
2409                     le64_to_cpu(sctx->send_root->root_item.ctransid));
2410         if (parent_root) {
2411                 if (!btrfs_is_empty_uuid(parent_root->root_item.received_uuid))
2412                         TLV_PUT_UUID(sctx, BTRFS_SEND_A_CLONE_UUID,
2413                                      parent_root->root_item.received_uuid);
2414                 else
2415                         TLV_PUT_UUID(sctx, BTRFS_SEND_A_CLONE_UUID,
2416                                      parent_root->root_item.uuid);
2417                 TLV_PUT_U64(sctx, BTRFS_SEND_A_CLONE_CTRANSID,
2418                             le64_to_cpu(sctx->parent_root->root_item.ctransid));
2419         }
2420
2421         ret = send_cmd(sctx);
2422
2423 tlv_put_failure:
2424 out:
2425         btrfs_free_path(path);
2426         kfree(name);
2427         return ret;
2428 }
2429
2430 static int send_truncate(struct send_ctx *sctx, u64 ino, u64 gen, u64 size)
2431 {
2432         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2433         int ret = 0;
2434         struct fs_path *p;
2435
2436         btrfs_debug(fs_info, "send_truncate %llu size=%llu", ino, size);
2437
2438         p = fs_path_alloc();
2439         if (!p)
2440                 return -ENOMEM;
2441
2442         ret = begin_cmd(sctx, BTRFS_SEND_C_TRUNCATE);
2443         if (ret < 0)
2444                 goto out;
2445
2446         ret = get_cur_path(sctx, ino, gen, p);
2447         if (ret < 0)
2448                 goto out;
2449         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2450         TLV_PUT_U64(sctx, BTRFS_SEND_A_SIZE, size);
2451
2452         ret = send_cmd(sctx);
2453
2454 tlv_put_failure:
2455 out:
2456         fs_path_free(p);
2457         return ret;
2458 }
2459
2460 static int send_chmod(struct send_ctx *sctx, u64 ino, u64 gen, u64 mode)
2461 {
2462         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2463         int ret = 0;
2464         struct fs_path *p;
2465
2466         btrfs_debug(fs_info, "send_chmod %llu mode=%llu", ino, mode);
2467
2468         p = fs_path_alloc();
2469         if (!p)
2470                 return -ENOMEM;
2471
2472         ret = begin_cmd(sctx, BTRFS_SEND_C_CHMOD);
2473         if (ret < 0)
2474                 goto out;
2475
2476         ret = get_cur_path(sctx, ino, gen, p);
2477         if (ret < 0)
2478                 goto out;
2479         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2480         TLV_PUT_U64(sctx, BTRFS_SEND_A_MODE, mode & 07777);
2481
2482         ret = send_cmd(sctx);
2483
2484 tlv_put_failure:
2485 out:
2486         fs_path_free(p);
2487         return ret;
2488 }
2489
2490 static int send_chown(struct send_ctx *sctx, u64 ino, u64 gen, u64 uid, u64 gid)
2491 {
2492         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2493         int ret = 0;
2494         struct fs_path *p;
2495
2496         btrfs_debug(fs_info, "send_chown %llu uid=%llu, gid=%llu",
2497                     ino, uid, gid);
2498
2499         p = fs_path_alloc();
2500         if (!p)
2501                 return -ENOMEM;
2502
2503         ret = begin_cmd(sctx, BTRFS_SEND_C_CHOWN);
2504         if (ret < 0)
2505                 goto out;
2506
2507         ret = get_cur_path(sctx, ino, gen, p);
2508         if (ret < 0)
2509                 goto out;
2510         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2511         TLV_PUT_U64(sctx, BTRFS_SEND_A_UID, uid);
2512         TLV_PUT_U64(sctx, BTRFS_SEND_A_GID, gid);
2513
2514         ret = send_cmd(sctx);
2515
2516 tlv_put_failure:
2517 out:
2518         fs_path_free(p);
2519         return ret;
2520 }
2521
2522 static int send_utimes(struct send_ctx *sctx, u64 ino, u64 gen)
2523 {
2524         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2525         int ret = 0;
2526         struct fs_path *p = NULL;
2527         struct btrfs_inode_item *ii;
2528         struct btrfs_path *path = NULL;
2529         struct extent_buffer *eb;
2530         struct btrfs_key key;
2531         int slot;
2532
2533         btrfs_debug(fs_info, "send_utimes %llu", ino);
2534
2535         p = fs_path_alloc();
2536         if (!p)
2537                 return -ENOMEM;
2538
2539         path = alloc_path_for_send();
2540         if (!path) {
2541                 ret = -ENOMEM;
2542                 goto out;
2543         }
2544
2545         key.objectid = ino;
2546         key.type = BTRFS_INODE_ITEM_KEY;
2547         key.offset = 0;
2548         ret = btrfs_search_slot(NULL, sctx->send_root, &key, path, 0, 0);
2549         if (ret > 0)
2550                 ret = -ENOENT;
2551         if (ret < 0)
2552                 goto out;
2553
2554         eb = path->nodes[0];
2555         slot = path->slots[0];
2556         ii = btrfs_item_ptr(eb, slot, struct btrfs_inode_item);
2557
2558         ret = begin_cmd(sctx, BTRFS_SEND_C_UTIMES);
2559         if (ret < 0)
2560                 goto out;
2561
2562         ret = get_cur_path(sctx, ino, gen, p);
2563         if (ret < 0)
2564                 goto out;
2565         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2566         TLV_PUT_BTRFS_TIMESPEC(sctx, BTRFS_SEND_A_ATIME, eb, &ii->atime);
2567         TLV_PUT_BTRFS_TIMESPEC(sctx, BTRFS_SEND_A_MTIME, eb, &ii->mtime);
2568         TLV_PUT_BTRFS_TIMESPEC(sctx, BTRFS_SEND_A_CTIME, eb, &ii->ctime);
2569         /* TODO Add otime support when the otime patches get into upstream */
2570
2571         ret = send_cmd(sctx);
2572
2573 tlv_put_failure:
2574 out:
2575         fs_path_free(p);
2576         btrfs_free_path(path);
2577         return ret;
2578 }
2579
2580 /*
2581  * Sends a BTRFS_SEND_C_MKXXX or SYMLINK command to user space. We don't have
2582  * a valid path yet because we did not process the refs yet. So, the inode
2583  * is created as orphan.
2584  */
2585 static int send_create_inode(struct send_ctx *sctx, u64 ino)
2586 {
2587         struct btrfs_fs_info *fs_info = sctx->send_root->fs_info;
2588         int ret = 0;
2589         struct fs_path *p;
2590         int cmd;
2591         u64 gen;
2592         u64 mode;
2593         u64 rdev;
2594
2595         btrfs_debug(fs_info, "send_create_inode %llu", ino);
2596
2597         p = fs_path_alloc();
2598         if (!p)
2599                 return -ENOMEM;
2600
2601         if (ino != sctx->cur_ino) {
2602                 ret = get_inode_info(sctx->send_root, ino, NULL, &gen, &mode,
2603                                      NULL, NULL, &rdev);
2604                 if (ret < 0)
2605                         goto out;
2606         } else {
2607                 gen = sctx->cur_inode_gen;
2608                 mode = sctx->cur_inode_mode;
2609                 rdev = sctx->cur_inode_rdev;
2610         }
2611
2612         if (S_ISREG(mode)) {
2613                 cmd = BTRFS_SEND_C_MKFILE;
2614         } else if (S_ISDIR(mode)) {
2615                 cmd = BTRFS_SEND_C_MKDIR;
2616         } else if (S_ISLNK(mode)) {
2617                 cmd = BTRFS_SEND_C_SYMLINK;
2618         } else if (S_ISCHR(mode) || S_ISBLK(mode)) {
2619                 cmd = BTRFS_SEND_C_MKNOD;
2620         } else if (S_ISFIFO(mode)) {
2621                 cmd = BTRFS_SEND_C_MKFIFO;
2622         } else if (S_ISSOCK(mode)) {
2623                 cmd = BTRFS_SEND_C_MKSOCK;
2624         } else {
2625                 btrfs_warn(sctx->send_root->fs_info, "unexpected inode type %o",
2626                                 (int)(mode & S_IFMT));
2627                 ret = -EOPNOTSUPP;
2628                 goto out;
2629         }
2630
2631         ret = begin_cmd(sctx, cmd);
2632         if (ret < 0)
2633                 goto out;
2634
2635         ret = gen_unique_name(sctx, ino, gen, p);
2636         if (ret < 0)
2637                 goto out;
2638
2639         TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH, p);
2640         TLV_PUT_U64(sctx, BTRFS_SEND_A_INO, ino);
2641
2642         if (S_ISLNK(mode)) {
2643                 fs_path_reset(p);
2644                 ret = read_symlink(sctx->send_root, ino, p);
2645                 if (ret < 0)
2646                         goto out;
2647                 TLV_PUT_PATH(sctx, BTRFS_SEND_A_PATH_LINK, p);
2648         } else if (S_ISCHR(mode) || S_ISBLK(mode) ||
2649                    S_ISFIFO(mode) || S_ISSOCK(mode)) {
2650                 TLV_PUT_U64(sctx, BTRFS_SEND_A_RDEV, new_encode_dev(rdev));
2651                 TLV_PUT_U64(sctx, BTRFS_SEND_A_MODE, mode);
2652         }
2653
2654         ret = send_cmd(sctx);
2655         if (ret < 0)
2656                 goto out;
2657
2658
2659 tlv_put_failure:
2660 out:
2661         fs_path_free(p);
2662         return ret;
2663 }
2664
2665 /*
2666  * We need some special handling for inodes that get processed before the parent
2667  * directory got created. See process_recorded_refs for details.
2668  * This function does the check if we already created the dir out of order.
2669  */
2670 static int did_create_dir(struct send_ctx *sctx, u64 dir)
2671 {
2672         int ret = 0;
2673         struct btrfs_path *path = NULL;
2674         struct btrfs_key key;
2675         struct btrfs_key found_key;
2676         struct btrfs_key di_key;
2677         struct extent_buffer *eb;
2678         struct btrfs_dir_item *di;
2679         int slot;
2680
2681         path = alloc_path_for_send();
2682         if (!path) {
2683                 ret = -ENOMEM;
2684                 goto out;
2685         }
2686
2687         key.objectid = dir;
2688         key.type = BTRFS_DIR_INDEX_KEY;
2689         key.offset = 0;
2690         ret = btrfs_search_slot(NULL, sctx->send_root, &key, path, 0, 0);
2691         if (ret < 0)
2692                 goto out;
2693
2694         while (1) {
2695                 eb = path->nodes[0];
2696                 slot = path->slots[0];
2697                 if (slot >= btrfs_header_nritems(eb)) {
2698                         ret = btrfs_next_leaf(sctx->send_root, path);
2699                         if (ret < 0) {
2700                                 goto out;
2701                         } else if (ret > 0) {
2702                                 ret = 0;
2703                                 break;
2704                         }
2705                         continue;
2706                 }
2707
2708                 btrfs_item_key_to_cpu(eb, &found_key, slot);
2709                 if (found_key.objectid != key.objectid ||
2710                     found_key.type != key.type) {
2711                         ret = 0;
2712                         goto out;
2713                 }
2714
2715                 di = btrfs_item_ptr(eb, slot, struct btrfs_dir_item);
2716                 btrfs_dir_item_key_to_cpu(eb, di, &di_key);
2717
2718                 if (di_key.type != BTRFS_ROOT_ITEM_KEY &&
2719                     di_key.objectid < sctx->send_progress) {
2720                         ret = 1;
2721                         goto out;
2722                 }
2723
2724                 path->slots[0]++;
2725         }
2726
2727 out:
2728         btrfs_free_path(path);
2729         return ret;
2730 }
2731
2732 /*
2733  * Only creates the inode if it is:
2734  * 1. Not a directory
2735  * 2. Or a directory which was not created already due to out of order
2736  *    directories. See did_create_dir and process_recorded_refs for details.
2737  */
2738 static int send_create_inode_if_needed(struct send_ctx *sctx)
2739 {
2740         int ret;
2741
2742         if (S_ISDIR(sctx->cur_inode_mode)) {
2743                 ret = did_create_dir(sctx, sctx->cur_ino);
2744                 if (ret < 0)
2745                         goto out;
2746                 if (ret) {
2747                         ret = 0;
2748                         goto out;
2749                 }
2750         }
2751
2752         ret = send_create_inode(sctx, sctx->cur_ino);
2753         if (ret < 0)
2754                 goto out;
2755
2756 out:
2757         return ret;
2758 }
2759
2760 struct recorded_ref {
2761         struct list_head list;
2762         char *name;
2763         struct fs_path *full_path;
2764         u64 dir;
2765         u64 dir_gen;
2766         int name_len;
2767 };
2768
2769 static void set_ref_path(struct recorded_ref *ref, struct fs_path *path)
2770 {
2771         ref->full_path = path;
2772         ref->name = (char *)kbasename(ref->full_path->start);
2773         ref->name_len = ref->full_path->end - ref->name;
2774 }
2775
2776 /*
2777  * We need to process new refs before deleted refs, but compare_tree gives us
2778  * everything mixed. So we first record all refs and later process them.
2779  * This function is a helper to record one ref.
2780  */
2781 static int __record_ref(struct list_head *head, u64 dir,
2782                       u64 dir_gen, struct fs_path *path)
2783 {
2784         struct recorded_ref *ref;
2785
2786         ref = kmalloc(sizeof(*ref), GFP_KERNEL);
2787         if (!ref)
2788                 return -ENOMEM;
2789
2790         ref->dir = dir;
2791         ref->dir_gen = dir_gen;
2792         set_ref_path(ref, path);
2793         list_add_tail(&ref->list, head);
2794         return 0;
2795 }
2796
2797 static int dup_ref(struct recorded_ref *ref, struct list_head *list)
2798 {
2799         struct recorded_ref *new;
2800
2801         new = kmalloc(sizeof(*ref), GFP_KERNEL);
2802         if (!new)
2803                 return -ENOMEM;
2804
2805         new->dir = ref->dir;
2806         new->dir_gen = ref->dir_gen;
2807         new->full_path = NULL;
2808         INIT_LIST_HEAD(&new->list);
2809         list_add_tail(&new->list, list);
2810         return 0;
2811 }
2812
2813 static void __free_recorded_refs(struct list_head *head)
2814 {
2815         struct recorded_ref *cur;
2816
2817         while (!list_empty(head)) {
2818                 cur = list_entry(head->next, struct recorded_ref, list);
2819                 fs_path_free(cur->full_path);
2820                 list_del(&cur->list);
2821                 kfree(cur);
2822         }
2823 }
2824
2825 static void free_recorded_refs(struct send_ctx *sctx)
2826 {
2827         __free_recorded_refs(&sctx->new_refs);
2828         __free_recorded_refs(&sctx->deleted_refs);
2829 }
2830
2831 /*
2832  * Renames/moves a file/dir to its orphan name. Used when the first
2833  * ref of an unprocessed inode gets overwritten and for all non empty
2834  * directories.
2835  */
2836 static int orphanize_inode(struct send_ctx *sctx, u64 ino, u64 gen,
2837                           struct fs_path *path)
2838 {
2839         int ret;
2840         struct fs_path *orphan;
2841
2842         orphan = fs_path_alloc();
2843         if (!orphan)
2844                 return -ENOMEM;
2845
2846         ret = gen_unique_name(sctx, ino, gen, orphan);
2847         if (ret < 0)
2848                 goto out;
2849
2850         ret = send_rename(sctx, path, orphan);
2851
2852 out:
2853         fs_path_free(orphan);
2854         return ret;
2855 }
2856
2857 static struct orphan_dir_info *
2858 add_orphan_dir_info(struct send_ctx *sctx, u64 dir_ino)
2859 {
2860         struct rb_node **p = &sctx->orphan_dirs.rb_node;
2861         struct rb_node *parent = NULL;
2862         struct orphan_dir_info *entry, *odi;
2863
2864         odi = kmalloc(sizeof(*odi), GFP_KERNEL);
2865         if (!odi)
2866                 return ERR_PTR(-ENOMEM);
2867         odi->ino = dir_ino;
2868         odi->gen = 0;
2869
2870         while (*p) {
2871                 parent = *p;
2872                 entry = rb_entry(parent, struct orphan_dir_info, node);
2873                 if (dir_ino < entry->ino) {
2874                         p = &(*p)->rb_left;
2875                 } else if (dir_ino > entry->ino) {
2876                         p = &(*p)->rb_right;
2877                 } else {
2878                         kfree(odi);
2879                         return entry;
2880                 }
2881         }
2882
2883         rb_link_node(&odi->node, parent, p);
2884         rb_insert_color(&odi->node, &sctx->orphan_dirs);
2885         return odi;
2886 }
2887
2888 static struct orphan_dir_info *
2889 get_orphan_dir_info(struct send_ctx *sctx, u64 dir_ino)
2890 {
2891         struct rb_node *n = sctx->orphan_dirs.rb_node;
2892         struct orphan_dir_info *entry;
2893
2894         while (n) {
2895                 entry = rb_entry(n, struct orphan_dir_info, node);
2896                 if (dir_ino < entry->ino)
2897                         n = n->rb_left;
2898                 else if (dir_ino > entry->ino)
2899                         n = n->rb_right;
2900                 else
2901                         return entry;
2902         }
2903         return NULL;
2904 }
2905
2906 static int is_waiting_for_rm(struct send_ctx *sctx, u64 dir_ino)
2907 {
2908         struct orphan_dir_info *odi = get_orphan_dir_info(sctx, dir_ino);
2909
2910         return odi != NULL;
2911 }
2912
2913 static void free_orphan_dir_info(struct send_ctx *sctx,
2914                                  struct orphan_dir_info *odi)
2915 {
2916         if (!odi)
2917                 return;
2918         rb_erase(&odi->node, &sctx->orphan_dirs);
2919         kfree(odi);
2920 }
2921
2922 /*
2923  * Returns 1 if a directory can be removed at this point in time.
2924  * We check this by iterating all dir items and checking if the inode behind
2925  * the dir item was already processed.
2926  */
2927 static int can_rmdir(struct send_ctx *sctx, u64 dir, u64 dir_gen,
2928                      u64 send_progress)
2929 {
2930         int ret = 0;
2931         struct btrfs_root *root = sctx->parent_root;
2932         struct btrfs_path *path;
2933         struct btrfs_key key;
2934         struct btrfs_key found_key;
2935         struct btrfs_key loc;
2936         struct btrfs_dir_item *di;
2937
2938         /*
2939          * Don't try to rmdir the top/root subvolume dir.
2940          */
2941         if (dir == BTRFS_FIRST_FREE_OBJECTID)
2942                 return 0;
2943
2944         path = alloc_path_for_send();
2945         if (!path)
2946                 return -ENOMEM;
2947
2948         key.objectid = dir;
2949         key.type = BTRFS_DIR_INDEX_KEY;
2950         key.offset = 0;
2951         ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
2952         if (ret < 0)
2953                 goto out;
2954
2955         while (1) {
2956                 struct waiting_dir_move *dm;
2957
2958                 if (path->slots[0] >= btrfs_header_nritems(path->nodes[0])) {
2959                         ret = btrfs_next_leaf(root, path);
2960                         if (ret < 0)
2961                                 goto out;
2962                         else if (ret > 0)
2963                                 break;
2964                         continue;
2965                 }
2966                 btrfs_item_key_to_cpu(path->nodes[0], &found_key,
2967                                       path->slots[0]);
2968                 if (found_key.objectid != key.objectid ||
2969                     found_key.type != key.type)
2970                         break;
2971
2972                 di = btrfs_item_ptr(path->nodes[0], path->slots[0],
2973                                 struct btrfs_dir_item);
2974                 btrfs_dir_item_key_to_cpu(path->nodes[0], di, &loc);
2975
2976                 dm = get_waiting_dir_move(sctx, loc.objectid);
2977                 if (dm) {
2978                         struct orphan_dir_info *odi;
2979
2980                         odi = add_orphan_dir_info(sctx, dir);
2981                         if (IS_ERR(odi)) {
2982                                 ret = PTR_ERR(odi);
2983                                 goto out;
2984                         }
2985                         odi->gen = dir_gen;
2986                         dm->rmdir_ino = dir;
2987                         ret = 0;
2988                         goto out;
2989                 }
2990
2991                 if (loc.objectid > send_progress) {
2992                         struct orphan_dir_info *odi;
2993
2994                         odi = get_orphan_dir_info(sctx, dir);
2995                         free_orphan_dir_info(sctx, odi);
2996                         ret = 0;
2997                         goto out;
2998                 }
2999
3000                 path->slots[0]++;
3001         }
3002
3003         ret = 1;
3004
3005 out:
3006         btrfs_free_path(path);
3007         return ret;
3008 }
3009
3010 static int is_waiting_for_move(struct send_ctx *sctx, u64 ino)
3011 {
3012         struct waiting_dir_move *entry = get_waiting_dir_move(sctx, ino);
3013
3014         return entry != NULL;
3015 }
3016
3017 static int add_waiting_dir_move(struct send_ctx *sctx, u64 ino, bool orphanized)
3018 {
3019         struct rb_node **p = &sctx->waiting_dir_moves.rb_node;
3020         struct rb_node *parent = NULL;
3021         struct waiting_dir_move *entry, *dm;
3022
3023         dm = kmalloc(sizeof(*dm), GFP_KERNEL);
3024         if (!dm)
3025                 return -ENOMEM;
3026         dm->ino = ino;
3027         dm->rmdir_ino = 0;
3028         dm->orphanized = orphanized;
3029
3030         while (*p) {
3031                 parent = *p;
3032                 entry = rb_entry(parent, struct waiting_dir_move, node);
3033                 if (ino < entry->ino) {
3034                         p = &(*p)->rb_left;
3035                 } else if (ino > entry->ino) {
3036                         p = &(*p)->rb_right;
3037                 } else {
3038                         kfree(dm);
3039                         return -EEXIST;
3040                 }
3041         }
3042
3043         rb_link_node(&dm->node, parent, p);
3044         rb_insert_color(&dm->node, &sctx->waiting_dir_moves);
3045         return 0;
3046 }
3047
3048 static struct waiting_dir_move *
3049 get_waiting_dir_move(struct send_ctx *sctx, u64 ino)
3050 {
3051         struct rb_node *n = sctx->waiting_dir_moves.rb_node;
3052         struct waiting_dir_move *entry;
3053
3054         while (n) {
3055                 entry = rb_entry(n, struct waiting_dir_move, node);
3056                 if (ino < entry->ino)
3057                         n = n->rb_left;
3058                 else if (ino > entry->ino)
3059                         n = n->rb_right;
3060                 else
3061                         return entry;
3062         }
3063         return NULL;
3064 }
3065
3066 static void free_waiting_dir_move(struct send_ctx *sctx,
3067                                   struct waiting_dir_move *dm)
3068 {
3069         if (!dm)
3070                 return;
3071         rb_erase(&dm->node, &sctx->waiting_dir_moves);
3072         kfree(dm);
3073 }
3074
3075 static int add_pending_dir_move(struct send_ctx *sctx,
3076                                 u64 ino,
3077                                 u64 ino_gen,
3078                                 u64 parent_ino,
3079                                 struct list_head *new_refs,
3080                                 struct list_head *deleted_refs,
3081                                 const bool is_orphan)
3082 {
3083         struct rb_node **p = &sctx->pending_dir_moves.rb_node;
3084         struct rb_node *parent = NULL;
3085         struct pending_dir_move *entry = NULL, *pm;
3086         struct recorded_ref *cur;
3087         int exists = 0;
3088         int ret;
3089
3090         pm = kmalloc(sizeof(*pm), GFP_KERNEL);
3091         if (!pm)
3092                 return -ENOMEM;
3093         pm->parent_ino = parent_ino;
3094         pm->ino = ino;
3095         pm->gen = ino_gen;
3096         INIT_LIST_HEAD(&pm->list);
3097         INIT_LIST_HEAD(&pm->update_refs);
3098         RB_CLEAR_NODE(&pm->node);
3099
3100         while (*p) {
3101                 parent = *p;
3102                 entry = rb_entry(parent, struct pending_dir_move, node);
3103                 if (parent_ino < entry->parent_ino) {
3104                         p = &(*p)->rb_left;
3105                 } else if (parent_ino > entry->parent_ino) {
3106                         p = &(*p)->rb_right;
3107                 } else {
3108                         exists = 1;
3109                         break;
3110                 }
3111         }
3112
3113         list_for_each_entry(cur, deleted_refs, list) {
3114                 ret = dup_ref(cur, &pm->update_refs);
3115                 if (ret < 0)
3116                         goto out;
3117         }
3118         list_for_each_entry(cur, new_refs, list) {
3119                 ret = dup_ref(cur, &pm->update_refs);
3120                 if (ret < 0)
3121                         goto out;
3122         }
3123
3124         ret = add_waiting_dir_move(sctx, pm->ino, is_orphan);
3125         if (ret)
3126                 goto out;
3127
3128         if (exists) {
3129                 list_add_tail(&pm->list, &entry->list);
3130         } else {
3131                 rb_link_node(&pm->node, parent, p);
3132                 rb_insert_color(&pm->node, &sctx->pending_dir_moves);
3133         }
3134         ret = 0;
3135 out:
3136         if (ret) {
3137                 __free_recorded_refs(&pm->update_refs);
3138                 kfree(pm);
3139         }
3140         return ret;
3141 }
3142
3143 static struct pending_dir_move *get_pending_dir_moves(struct send_ctx *sctx,
3144                                                       u64 parent_ino)
3145 {
3146         struct rb_node *n = sctx->pending_dir_moves.rb_node;
3147         struct pending_dir_move *entry;
3148
3149         while (n) {
3150                 entry = rb_entry(n, struct pending_dir_move, node);
3151                 if (parent_ino < entry->parent_ino)
3152                         n = n->rb_left;
3153                 else if (parent_ino > entry->parent_ino)
3154                         n = n->rb_right;
3155                 else
3156                         return entry;
3157         }
3158         return NULL;
3159 }
3160
3161 static int path_loop(struct send_ctx *sctx, struct fs_path *name,
3162                      u64 ino, u64 gen, u64 *ancestor_ino)
3163 {
3164         int ret = 0;
3165         u64 parent_inode = 0;
3166         u64 parent_gen = 0;
3167         u64 start_ino = ino;
3168
3169         *ancestor_ino = 0;
3170         while (ino != BTRFS_FIRST_FREE_OBJECTID) {
3171                 fs_path_reset(name);
3172
3173                 if (is_waiting_for_rm(sctx, ino))
3174                         break;
3175                 if (is_waiting_for_move(sctx, ino)) {
3176                         if (*ancestor_ino == 0)
3177                                 *ancestor_ino = ino;
3178                         ret = get_first_ref(sctx->parent_root, ino,
3179                                             &parent_inode, &parent_gen, name);
3180                 } else {
3181                         ret = __get_cur_name_and_parent(sctx, ino, gen,
3182                                                         &parent_inode,
3183                                                         &parent_gen, name);
3184                         if (ret > 0) {
3185                                 ret = 0;
3186                                 break;
3187                         }
3188                 }
3189                 if (ret < 0)
3190                         break;
3191                 if (parent_inode == start_ino) {
3192                         ret = 1;
3193                         if (*ancestor_ino == 0)
3194                                 *ancestor_ino = ino;
3195                         break;
3196                 }
3197                 ino = parent_inode;
3198                 gen = parent_gen;
3199         }
3200         return ret;
3201 }
3202
3203 static int apply_dir_move(struct send_ctx *sctx, struct pending_dir_move *pm)
3204 {
3205         struct fs_path *from_path = NULL;
3206         struct fs_path *to_path = NULL;
3207         struct fs_path *name = NULL;
3208         u64 orig_progress = sctx->send_progress;
3209         struct recorded_ref *cur;
3210         u64 parent_ino, parent_gen;
3211         struct waiting_dir_move *dm = NULL;
3212         u64 rmdir_ino = 0;
3213         u64 ancestor;
3214         bool is_orphan;
3215         int ret;
3216
3217         name = fs_path_alloc();
3218         from_path = fs_path_alloc();
3219         if (!name || !from_path) {
3220                 ret = -ENOMEM;
3221                 goto out;
3222         }
3223
3224         dm = get_waiting_dir_move(sctx, pm->ino);
3225         ASSERT(dm);
3226         rmdir_ino = dm->rmdir_ino;
3227         is_orphan = dm->orphanized;
3228         free_waiting_dir_move(sctx, dm);
3229
3230         if (is_orphan) {
3231                 ret = gen_unique_name(sctx, pm->ino,
3232                                       pm->gen, from_path);
3233         } else {
3234                 ret = get_first_ref(sctx->parent_root, pm->ino,
3235                                     &parent_ino, &parent_gen, name);
3236                 if (ret < 0)
3237                         goto out;
3238                 ret = get_cur_path(sctx, parent_ino, parent_gen,
3239                                    from_path);
3240                 if (ret < 0)
3241                         goto out;
3242                 ret = fs_path_add_path(from_path, name);
3243         }
3244         if (ret < 0)
3245                 goto out;
3246
3247         sctx->send_progress = sctx->cur_ino + 1;
3248         ret = path_loop(sctx, name, pm->ino, pm->gen, &ancestor);
3249         if (ret < 0)
3250                 goto out;
3251         if (ret) {
3252                 LIST_HEAD(deleted_refs);
3253                 ASSERT(ancestor > BTRFS_FIRST_FREE_OBJECTID);
3254                 ret = add_pending_dir_move(sctx, pm->ino, pm->gen, ancestor,
3255                                            &pm->update_refs, &deleted_refs,
3256                                            is_orphan);
3257                 if (ret < 0)
3258                         goto out;
3259                 if (rmdir_ino) {
3260                         dm = get_waiting_dir_move(sctx, pm->ino);
3261                         ASSERT(dm);
3262                         dm->rmdir_ino = rmdir_ino;
3263                 }
3264                 goto out;
3265         }
3266         fs_path_reset(name);
3267         to_path = name;
3268         name = NULL;
3269         ret = get_cur_path(sctx, pm->ino, pm->gen, to_path);
3270         if (ret < 0)
3271                 goto out;
3272
3273         ret = send_rename(sctx, from_path, to_path);
3274         if (ret < 0)
3275                 goto out;
3276
3277         if (rmdir_ino) {
3278                 struct orphan_dir_info *odi;
3279
3280                 odi = get_orphan_dir_info(sctx, rmdir_ino);
3281                 if (!odi) {
3282                         /* already deleted */
3283                         goto finish;
3284                 }
3285                 ret = can_rmdir(sctx, rmdir_ino, odi->gen, sctx->cur_ino);
3286                 if (ret < 0)
3287                         goto out;
3288                 if (!ret)
3289                         goto finish;
3290
3291                 name = fs_path_alloc();
3292                 if (!name) {
3293                         ret = -ENOMEM;
3294                         goto out;
3295                 }
3296                 ret = get_cur_path(sctx, rmdir_ino, odi->gen, name);
3297                 if (ret < 0)
3298                         goto out;
3299                 ret = send_rmdir(sctx, name);
3300                 if (ret < 0)
3301                         goto out;
3302                 free_orphan_dir_info(sctx, odi);
3303         }
3304
3305 finish:
3306         ret = send_utimes(sctx, pm->ino, pm->gen);
3307         if (ret < 0)
3308                 goto out;
3309
3310         /*
3311          * After rename/move, need to update the utimes of both new parent(s)
3312          * and old parent(s).
3313          */
3314         list_for_each_entry(cur, &pm->update_refs, list) {
3315                 /*
3316                  * The parent inode might have been deleted in the send snapshot
3317                  */
3318                 ret = get_inode_info(sctx->send_root, cur->dir, NULL,
3319                                      NULL, NULL, NULL, NULL, NULL);
3320                 if (ret == -ENOENT) {
3321                         ret = 0;
3322                         continue;
3323                 }
3324                 if (ret < 0)
3325                         goto out;
3326
3327                 ret = send_utimes(sctx, cur->dir, cur->dir_gen);
3328                 if (ret < 0)