fs/ceph/snap.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/ceph/ceph_debug.h>
   3
   4 #include <linux/sort.h>
   5 #include <linux/slab.h>
   6 #include "super.h"
   7 #include "mds_client.h"
   8 #include <linux/ceph/decode.h>
   9
  10 /* unused map expires after 5 minutes */
  11 #define CEPH_SNAPID_MAP_TIMEOUT (5 * 60 * HZ)
  12
  13 /*
  14  * Snapshots in ceph are driven in large part by cooperation from the
  15  * client.  In contrast to local file systems or file servers that
  16  * implement snapshots at a single point in the system, ceph's
  17  * distributed access to storage requires clients to help decide
  18  * whether a write logically occurs before or after a recently created
  19  * snapshot.
  20  *
  21  * This provides a perfect instantanous client-wide snapshot.  Between
  22  * clients, however, snapshots may appear to be applied at slightly
  23  * different points in time, depending on delays in delivering the
  24  * snapshot notification.
  25  *
  26  * Snapshots are _not_ file system-wide.  Instead, each snapshot
  27  * applies to the subdirectory nested beneath some directory.  This
  28  * effectively divides the hierarchy into multiple "realms," where all
  29  * of the files contained by each realm share the same set of
  30  * snapshots.  An individual realm's snap set contains snapshots
  31  * explicitly created on that realm, as well as any snaps in its
  32  * parent's snap set _after_ the point at which the parent became it's
  33  * parent (due to, say, a rename).  Similarly, snaps from prior parents
  34  * during the time intervals during which they were the parent are included.
  35  *
  36  * The client is spared most of this detail, fortunately... it must only
  37  * maintains a hierarchy of realms reflecting the current parent/child
  38  * realm relationship, and for each realm has an explicit list of snaps
  39  * inherited from prior parents.
  40  *
  41  * A snap_realm struct is maintained for realms containing every inode
  42  * with an open cap in the system.  (The needed snap realm information is
  43  * provided by the MDS whenever a cap is issued, i.e., on open.)  A 'seq'
  44  * version number is used to ensure that as realm parameters change (new
  45  * snapshot, new parent, etc.) the client's realm hierarchy is updated.
  46  *
  47  * The realm hierarchy drives the generation of a 'snap context' for each
  48  * realm, which simply lists the resulting set of snaps for the realm.  This
  49  * is attached to any writes sent to OSDs.
  50  */
  51 /*
  52  * Unfortunately error handling is a bit mixed here.  If we get a snap
  53  * update, but don't have enough memory to update our realm hierarchy,
  54  * it's not clear what we can do about it (besides complaining to the
  55  * console).
  56  */
  57
  58
  59 /*
  60  * increase ref count for the realm
  61  *
  62  * caller must hold snap_rwsem for write.
  63  */
  64 void ceph_get_snap_realm(struct ceph_mds_client *mdsc,
  65                          struct ceph_snap_realm *realm)
  66 {
  67         dout("get_realm %p %d -> %d\n", realm,
  68              atomic_read(&realm->nref), atomic_read(&realm->nref)+1);
  69         /*
  70          * since we _only_ increment realm refs or empty the empty
  71          * list with snap_rwsem held, adjusting the empty list here is
  72          * safe.  we do need to protect against concurrent empty list
  73          * additions, however.
  74          */
  75         if (atomic_inc_return(&realm->nref) == 1) {
  76                 spin_lock(&mdsc->snap_empty_lock);
  77                 list_del_init(&realm->empty_item);
  78                 spin_unlock(&mdsc->snap_empty_lock);
  79         }
  80 }
  81
  82 static void __insert_snap_realm(struct rb_root *root,
  83                                 struct ceph_snap_realm *new)
  84 {
  85         struct rb_node **p = &root->rb_node;
  86         struct rb_node *parent = NULL;
  87         struct ceph_snap_realm *r = NULL;
  88
  89         while (*p) {
  90                 parent = *p;
  91                 r = rb_entry(parent, struct ceph_snap_realm, node);
  92                 if (new->ino < r->ino)
  93                         p = &(*p)->rb_left;
  94                 else if (new->ino > r->ino)
  95                         p = &(*p)->rb_right;
  96                 else
  97                         BUG();
  98         }
  99
 100         rb_link_node(&new->node, parent, p);
 101         rb_insert_color(&new->node, root);
 102 }
 103
 104 /*
 105  * create and get the realm rooted at @ino and bump its ref count.
 106  *
 107  * caller must hold snap_rwsem for write.
 108  */
 109 static struct ceph_snap_realm *ceph_create_snap_realm(
 110         struct ceph_mds_client *mdsc,
 111         u64 ino)
 112 {
 113         struct ceph_snap_realm *realm;
 114
 115         realm = kzalloc(sizeof(*realm), GFP_NOFS);
 116         if (!realm)
 117                 return ERR_PTR(-ENOMEM);
 118
 119         atomic_set(&realm->nref, 1);    /* for caller */
 120         realm->ino = ino;
 121         INIT_LIST_HEAD(&realm->children);
 122         INIT_LIST_HEAD(&realm->child_item);
 123         INIT_LIST_HEAD(&realm->empty_item);
 124         INIT_LIST_HEAD(&realm->dirty_item);
 125         INIT_LIST_HEAD(&realm->inodes_with_caps);
 126         spin_lock_init(&realm->inodes_with_caps_lock);
 127         __insert_snap_realm(&mdsc->snap_realms, realm);
 128         mdsc->num_snap_realms++;
 129
 130         dout("create_snap_realm %llx %p\n", realm->ino, realm);
 131         return realm;
 132 }
 133
 134 /*
 135  * lookup the realm rooted at @ino.
 136  *
 137  * caller must hold snap_rwsem for write.
 138  */
 139 static struct ceph_snap_realm *__lookup_snap_realm(struct ceph_mds_client *mdsc,
 140                                                    u64 ino)
 141 {
 142         struct rb_node *n = mdsc->snap_realms.rb_node;
 143         struct ceph_snap_realm *r;
 144
 145         while (n) {
 146                 r = rb_entry(n, struct ceph_snap_realm, node);
 147                 if (ino < r->ino)
 148                         n = n->rb_left;
 149                 else if (ino > r->ino)
 150                         n = n->rb_right;
 151                 else {
 152                         dout("lookup_snap_realm %llx %p\n", r->ino, r);
 153                         return r;
 154                 }
 155         }
 156         return NULL;
 157 }
 158
 159 struct ceph_snap_realm *ceph_lookup_snap_realm(struct ceph_mds_client *mdsc,
 160                                                u64 ino)
 161 {
 162         struct ceph_snap_realm *r;
 163         r = __lookup_snap_realm(mdsc, ino);
 164         if (r)
 165                 ceph_get_snap_realm(mdsc, r);
 166         return r;
 167 }
 168
 169 static void __put_snap_realm(struct ceph_mds_client *mdsc,
 170                              struct ceph_snap_realm *realm);
 171
 172 /*
 173  * called with snap_rwsem (write)
 174  */
 175 static void __destroy_snap_realm(struct ceph_mds_client *mdsc,
 176                                  struct ceph_snap_realm *realm)
 177 {
 178         dout("__destroy_snap_realm %p %llx\n", realm, realm->ino);
 179
 180         rb_erase(&realm->node, &mdsc->snap_realms);
 181         mdsc->num_snap_realms--;
 182
 183         if (realm->parent) {
 184                 list_del_init(&realm->child_item);
 185                 __put_snap_realm(mdsc, realm->parent);
 186         }
 187
 188         kfree(realm->prior_parent_snaps);
 189         kfree(realm->snaps);
 190         ceph_put_snap_context(realm->cached_context);
 191         kfree(realm);
 192 }
 193
 194 /*
 195  * caller holds snap_rwsem (write)
 196  */
 197 static void __put_snap_realm(struct ceph_mds_client *mdsc,
 198                              struct ceph_snap_realm *realm)
 199 {
 200         dout("__put_snap_realm %llx %p %d -> %d\n", realm->ino, realm,
 201              atomic_read(&realm->nref), atomic_read(&realm->nref)-1);
 202         if (atomic_dec_and_test(&realm->nref))
 203                 __destroy_snap_realm(mdsc, realm);
 204 }
 205
 206 /*
 207  * caller needn't hold any locks
 208  */
 209 void ceph_put_snap_realm(struct ceph_mds_client *mdsc,
 210                          struct ceph_snap_realm *realm)
 211 {
 212         dout("put_snap_realm %llx %p %d -> %d\n", realm->ino, realm,
 213              atomic_read(&realm->nref), atomic_read(&realm->nref)-1);
 214         if (!atomic_dec_and_test(&realm->nref))
 215                 return;
 216
 217         if (down_write_trylock(&mdsc->snap_rwsem)) {
 218                 __destroy_snap_realm(mdsc, realm);
 219                 up_write(&mdsc->snap_rwsem);
 220         } else {
 221                 spin_lock(&mdsc->snap_empty_lock);
 222                 list_add(&realm->empty_item, &mdsc->snap_empty);
 223                 spin_unlock(&mdsc->snap_empty_lock);
 224         }
 225 }
 226
 227 /*
 228  * Clean up any realms whose ref counts have dropped to zero.  Note
 229  * that this does not include realms who were created but not yet
 230  * used.
 231  *
 232  * Called under snap_rwsem (write)
 233  */
 234 static void __cleanup_empty_realms(struct ceph_mds_client *mdsc)
 235 {
 236         struct ceph_snap_realm *realm;
 237
 238         spin_lock(&mdsc->snap_empty_lock);
 239         while (!list_empty(&mdsc->snap_empty)) {
 240                 realm = list_first_entry(&mdsc->snap_empty,
 241                                    struct ceph_snap_realm, empty_item);
 242                 list_del(&realm->empty_item);
 243                 spin_unlock(&mdsc->snap_empty_lock);
 244                 __destroy_snap_realm(mdsc, realm);
 245                 spin_lock(&mdsc->snap_empty_lock);
 246         }
 247         spin_unlock(&mdsc->snap_empty_lock);
 248 }
 249
 250 void ceph_cleanup_empty_realms(struct ceph_mds_client *mdsc)
 251 {
 252         down_write(&mdsc->snap_rwsem);
 253         __cleanup_empty_realms(mdsc);
 254         up_write(&mdsc->snap_rwsem);
 255 }
 256
 257 /*
 258  * adjust the parent realm of a given @realm.  adjust child list, and parent
 259  * pointers, and ref counts appropriately.
 260  *
 261  * return true if parent was changed, 0 if unchanged, <0 on error.
 262  *
 263  * caller must hold snap_rwsem for write.
 264  */
 265 static int adjust_snap_realm_parent(struct ceph_mds_client *mdsc,
 266                                     struct ceph_snap_realm *realm,
 267                                     u64 parentino)
 268 {
 269         struct ceph_snap_realm *parent;
 270
 271         if (realm->parent_ino == parentino)
 272                 return 0;
 273
 274         parent = ceph_lookup_snap_realm(mdsc, parentino);
 275         if (!parent) {
 276                 parent = ceph_create_snap_realm(mdsc, parentino);
 277                 if (IS_ERR(parent))
 278                         return PTR_ERR(parent);
 279         }
 280         dout("adjust_snap_realm_parent %llx %p: %llx %p -> %llx %p\n",
 281              realm->ino, realm, realm->parent_ino, realm->parent,
 282              parentino, parent);
 283         if (realm->parent) {
 284                 list_del_init(&realm->child_item);
 285                 ceph_put_snap_realm(mdsc, realm->parent);
 286         }
 287         realm->parent_ino = parentino;
 288         realm->parent = parent;
 289         list_add(&realm->child_item, &parent->children);
 290         return 1;
 291 }
 292
 293
 294 static int cmpu64_rev(const void *a, const void *b)
 295 {
 296         if (*(u64 *)a < *(u64 *)b)
 297                 return 1;
 298         if (*(u64 *)a > *(u64 *)b)
 299                 return -1;
 300         return 0;
 301 }
 302
 303
 304 /*
 305  * build the snap context for a given realm.
 306  */
 307 static int build_snap_context(struct ceph_snap_realm *realm,
 308                               struct list_head* dirty_realms)
 309 {
 310         struct ceph_snap_realm *parent = realm->parent;
 311         struct ceph_snap_context *snapc;
 312         int err = 0;
 313         u32 num = realm->num_prior_parent_snaps + realm->num_snaps;
 314
 315         /*
 316          * build parent context, if it hasn't been built.
 317          * conservatively estimate that all parent snaps might be
 318          * included by us.
 319          */
 320         if (parent) {
 321                 if (!parent->cached_context) {
 322                         err = build_snap_context(parent, dirty_realms);
 323                         if (err)
 324                                 goto fail;
 325                 }
 326                 num += parent->cached_context->num_snaps;
 327         }
 328
 329         /* do i actually need to update?  not if my context seq
 330            matches realm seq, and my parents' does to.  (this works
 331            because we rebuild_snap_realms() works _downward_ in
 332            hierarchy after each update.) */
 333         if (realm->cached_context &&
 334             realm->cached_context->seq == realm->seq &&
 335             (!parent ||
 336              realm->cached_context->seq >= parent->cached_context->seq)) {
 337                 dout("build_snap_context %llx %p: %p seq %lld (%u snaps)"
 338                      " (unchanged)\n",
 339                      realm->ino, realm, realm->cached_context,
 340                      realm->cached_context->seq,
 341                      (unsigned int)realm->cached_context->num_snaps);
 342                 return 0;
 343         }
 344
 345         /* alloc new snap context */
 346         err = -ENOMEM;
 347         if (num > (SIZE_MAX - sizeof(*snapc)) / sizeof(u64))
 348                 goto fail;
 349         snapc = ceph_create_snap_context(num, GFP_NOFS);
 350         if (!snapc)
 351                 goto fail;
 352
 353         /* build (reverse sorted) snap vector */
 354         num = 0;
 355         snapc->seq = realm->seq;
 356         if (parent) {
 357                 u32 i;
 358
 359                 /* include any of parent's snaps occurring _after_ my
 360                    parent became my parent */
 361                 for (i = 0; i < parent->cached_context->num_snaps; i++)
 362                         if (parent->cached_context->snaps[i] >=
 363                             realm->parent_since)
 364                                 snapc->snaps[num++] =
 365                                         parent->cached_context->snaps[i];
 366                 if (parent->cached_context->seq > snapc->seq)
 367                         snapc->seq = parent->cached_context->seq;
 368         }
 369         memcpy(snapc->snaps + num, realm->snaps,
 370                sizeof(u64)*realm->num_snaps);
 371         num += realm->num_snaps;
 372         memcpy(snapc->snaps + num, realm->prior_parent_snaps,
 373                sizeof(u64)*realm->num_prior_parent_snaps);
 374         num += realm->num_prior_parent_snaps;
 375
 376         sort(snapc->snaps, num, sizeof(u64), cmpu64_rev, NULL);
 377         snapc->num_snaps = num;
 378         dout("build_snap_context %llx %p: %p seq %lld (%u snaps)\n",
 379              realm->ino, realm, snapc, snapc->seq,
 380              (unsigned int) snapc->num_snaps);
 381
 382         ceph_put_snap_context(realm->cached_context);
 383         realm->cached_context = snapc;
 384         /* queue realm for cap_snap creation */
 385         list_add_tail(&realm->dirty_item, dirty_realms);
 386         return 0;
 387
 388 fail:
 389         /*
 390          * if we fail, clear old (incorrect) cached_context... hopefully
 391          * we'll have better luck building it later
 392          */
 393         if (realm->cached_context) {
 394                 ceph_put_snap_context(realm->cached_context);
 395                 realm->cached_context = NULL;
 396         }
 397         pr_err("build_snap_context %llx %p fail %d\n", realm->ino,
 398                realm, err);
 399         return err;
 400 }
 401
 402 /*
 403  * rebuild snap context for the given realm and all of its children.
 404  */
 405 static void rebuild_snap_realms(struct ceph_snap_realm *realm,
 406                                 struct list_head *dirty_realms)
 407 {
 408         struct ceph_snap_realm *child;
 409
 410         dout("rebuild_snap_realms %llx %p\n", realm->ino, realm);
 411         build_snap_context(realm, dirty_realms);
 412
 413         list_for_each_entry(child, &realm->children, child_item)
 414                 rebuild_snap_realms(child, dirty_realms);
 415 }
 416
 417
 418 /*
 419  * helper to allocate and decode an array of snapids.  free prior
 420  * instance, if any.
 421  */
 422 static int dup_array(u64 **dst, __le64 *src, u32 num)
 423 {
 424         u32 i;
 425
 426         kfree(*dst);
 427         if (num) {
 428                 *dst = kcalloc(num, sizeof(u64), GFP_NOFS);
 429                 if (!*dst)
 430                         return -ENOMEM;
 431                 for (i = 0; i < num; i++)
 432                         (*dst)[i] = get_unaligned_le64(src + i);
 433         } else {
 434                 *dst = NULL;
 435         }
 436         return 0;
 437 }
 438
 439 static bool has_new_snaps(struct ceph_snap_context *o,
 440                           struct ceph_snap_context *n)
 441 {
 442         if (n->num_snaps == 0)
 443                 return false;
 444         /* snaps are in descending order */
 445         return n->snaps[0] > o->seq;
 446 }
 447
 448 /*
 449  * When a snapshot is applied, the size/mtime inode metadata is queued
 450  * in a ceph_cap_snap (one for each snapshot) until writeback
 451  * completes and the metadata can be flushed back to the MDS.
 452  *
 453  * However, if a (sync) write is currently in-progress when we apply
 454  * the snapshot, we have to wait until the write succeeds or fails
 455  * (and a final size/mtime is known).  In this case the
 456  * cap_snap->writing = 1, and is said to be "pending."  When the write
 457  * finishes, we __ceph_finish_cap_snap().
 458  *
 459  * Caller must hold snap_rwsem for read (i.e., the realm topology won't
 460  * change).
 461  */
 462 void ceph_queue_cap_snap(struct ceph_inode_info *ci)
 463 {
 464         struct inode *inode = &ci->vfs_inode;
 465         struct ceph_cap_snap *capsnap;
 466         struct ceph_snap_context *old_snapc, *new_snapc;
 467         int used, dirty;
 468
 469         capsnap = kzalloc(sizeof(*capsnap), GFP_NOFS);
 470         if (!capsnap) {
 471                 pr_err("ENOMEM allocating ceph_cap_snap on %p\n", inode);
 472                 return;
 473         }
 474
 475         spin_lock(&ci->i_ceph_lock);
 476         used = __ceph_caps_used(ci);
 477         dirty = __ceph_caps_dirty(ci);
 478
 479         old_snapc = ci->i_head_snapc;
 480         new_snapc = ci->i_snap_realm->cached_context;
 481
 482         /*
 483          * If there is a write in progress, treat that as a dirty Fw,
 484          * even though it hasn't completed yet; by the time we finish
 485          * up this capsnap it will be.
 486          */
 487         if (used & CEPH_CAP_FILE_WR)
 488                 dirty |= CEPH_CAP_FILE_WR;
 489
 490         if (__ceph_have_pending_cap_snap(ci)) {
 491                 /* there is no point in queuing multiple "pending" cap_snaps,
 492                    as no new writes are allowed to start when pending, so any
 493                    writes in progress now were started before the previous
 494                    cap_snap.  lucky us. */
 495                 dout("queue_cap_snap %p already pending\n", inode);
 496                 goto update_snapc;
 497         }
 498         if (ci->i_wrbuffer_ref_head == 0 &&
 499             !(dirty & (CEPH_CAP_ANY_EXCL|CEPH_CAP_FILE_WR))) {
 500                 dout("queue_cap_snap %p nothing dirty|writing\n", inode);
 501                 goto update_snapc;
 502         }
 503
 504         BUG_ON(!old_snapc);
 505
 506         /*
 507          * There is no need to send FLUSHSNAP message to MDS if there is
 508          * no new snapshot. But when there is dirty pages or on-going
 509          * writes, we still need to create cap_snap. cap_snap is needed
 510          * by the write path and page writeback path.
 511          *
 512          * also see ceph_try_drop_cap_snap()
 513          */
 514         if (has_new_snaps(old_snapc, new_snapc)) {
 515                 if (dirty & (CEPH_CAP_ANY_EXCL|CEPH_CAP_FILE_WR))
 516                         capsnap->need_flush = true;
 517         } else {
 518                 if (!(used & CEPH_CAP_FILE_WR) &&
 519                     ci->i_wrbuffer_ref_head == 0) {
 520                         dout("queue_cap_snap %p "
 521                              "no new_snap|dirty_page|writing\n", inode);
 522                         goto update_snapc;
 523                 }
 524         }
 525
 526         dout("queue_cap_snap %p cap_snap %p queuing under %p %s %s\n",
 527              inode, capsnap, old_snapc, ceph_cap_string(dirty),
 528              capsnap->need_flush ? "" : "no_flush");
 529         ihold(inode);
 530
 531         refcount_set(&capsnap->nref, 1);
 532         INIT_LIST_HEAD(&capsnap->ci_item);
 533
 534         capsnap->follows = old_snapc->seq;
 535         capsnap->issued = __ceph_caps_issued(ci, NULL);
 536         capsnap->dirty = dirty;
 537
 538         capsnap->mode = inode->i_mode;
 539         capsnap->uid = inode->i_uid;
 540         capsnap->gid = inode->i_gid;
 541
 542         if (dirty & CEPH_CAP_XATTR_EXCL) {
 543                 __ceph_build_xattrs_blob(ci);
 544                 capsnap->xattr_blob =
 545                         ceph_buffer_get(ci->i_xattrs.blob);
 546                 capsnap->xattr_version = ci->i_xattrs.version;
 547         } else {
 548                 capsnap->xattr_blob = NULL;
 549                 capsnap->xattr_version = 0;
 550         }
 551
 552         capsnap->inline_data = ci->i_inline_version != CEPH_INLINE_NONE;
 553
 554         /* dirty page count moved from _head to this cap_snap;
 555            all subsequent writes page dirties occur _after_ this
 556            snapshot. */
 557         capsnap->dirty_pages = ci->i_wrbuffer_ref_head;
 558         ci->i_wrbuffer_ref_head = 0;
 559         capsnap->context = old_snapc;
 560         list_add_tail(&capsnap->ci_item, &ci->i_cap_snaps);
 561
 562         if (used & CEPH_CAP_FILE_WR) {
 563                 dout("queue_cap_snap %p cap_snap %p snapc %p"
 564                      " seq %llu used WR, now pending\n", inode,
 565                      capsnap, old_snapc, old_snapc->seq);
 566                 capsnap->writing = 1;
 567         } else {
 568                 /* note mtime, size NOW. */
 569                 __ceph_finish_cap_snap(ci, capsnap);
 570         }
 571         capsnap = NULL;
 572         old_snapc = NULL;
 573
 574 update_snapc:
 575         if (ci->i_head_snapc) {
 576                 ci->i_head_snapc = ceph_get_snap_context(new_snapc);
 577                 dout(" new snapc is %p\n", new_snapc);
 578         }
 579         spin_unlock(&ci->i_ceph_lock);
 580
 581         kfree(capsnap);
 582         ceph_put_snap_context(old_snapc);
 583 }
 584
 585 /*
 586  * Finalize the size, mtime for a cap_snap.. that is, settle on final values
 587  * to be used for the snapshot, to be flushed back to the mds.
 588  *
 589  * If capsnap can now be flushed, add to snap_flush list, and return 1.
 590  *
 591  * Caller must hold i_ceph_lock.
 592  */
 593 int __ceph_finish_cap_snap(struct ceph_inode_info *ci,
 594                             struct ceph_cap_snap *capsnap)
 595 {
 596         struct inode *inode = &ci->vfs_inode;
 597         struct ceph_mds_client *mdsc = ceph_sb_to_client(inode->i_sb)->mdsc;
 598
 599         BUG_ON(capsnap->writing);
 600         capsnap->size = inode->i_size;
 601         capsnap->mtime = inode->i_mtime;
 602         capsnap->atime = inode->i_atime;
 603         capsnap->ctime = inode->i_ctime;
 604         capsnap->time_warp_seq = ci->i_time_warp_seq;
 605         capsnap->truncate_size = ci->i_truncate_size;
 606         capsnap->truncate_seq = ci->i_truncate_seq;
 607         if (capsnap->dirty_pages) {
 608                 dout("finish_cap_snap %p cap_snap %p snapc %p %llu %s s=%llu "
 609                      "still has %d dirty pages\n", inode, capsnap,
 610                      capsnap->context, capsnap->context->seq,
 611                      ceph_cap_string(capsnap->dirty), capsnap->size,
 612                      capsnap->dirty_pages);
 613                 return 0;
 614         }
 615
 616         ci->i_ceph_flags |= CEPH_I_FLUSH_SNAPS;
 617         dout("finish_cap_snap %p cap_snap %p snapc %p %llu %s s=%llu\n",
 618              inode, capsnap, capsnap->context,
 619              capsnap->context->seq, ceph_cap_string(capsnap->dirty),
 620              capsnap->size);
 621
 622         spin_lock(&mdsc->snap_flush_lock);
 623         if (list_empty(&ci->i_snap_flush_item))
 624                 list_add_tail(&ci->i_snap_flush_item, &mdsc->snap_flush_list);
 625         spin_unlock(&mdsc->snap_flush_lock);
 626         return 1;  /* caller may want to ceph_flush_snaps */
 627 }
 628
 629 /*
 630  * Queue cap_snaps for snap writeback for this realm and its children.
 631  * Called under snap_rwsem, so realm topology won't change.
 632  */
 633 static void queue_realm_cap_snaps(struct ceph_snap_realm *realm)
 634 {
 635         struct ceph_inode_info *ci;
 636         struct inode *lastinode = NULL;
 637
 638         dout("queue_realm_cap_snaps %p %llx inodes\n", realm, realm->ino);
 639
 640         spin_lock(&realm->inodes_with_caps_lock);
 641         list_for_each_entry(ci, &realm->inodes_with_caps, i_snap_realm_item) {
 642                 struct inode *inode = igrab(&ci->vfs_inode);
 643                 if (!inode)
 644                         continue;
 645                 spin_unlock(&realm->inodes_with_caps_lock);
 646                 iput(lastinode);
 647                 lastinode = inode;
 648                 ceph_queue_cap_snap(ci);
 649                 spin_lock(&realm->inodes_with_caps_lock);
 650         }
 651         spin_unlock(&realm->inodes_with_caps_lock);
 652         iput(lastinode);
 653
 654         dout("queue_realm_cap_snaps %p %llx done\n", realm, realm->ino);
 655 }
 656
 657 /*
 658  * Parse and apply a snapblob "snap trace" from the MDS.  This specifies
 659  * the snap realm parameters from a given realm and all of its ancestors,
 660  * up to the root.
 661  *
 662  * Caller must hold snap_rwsem for write.
 663  */
 664 int ceph_update_snap_trace(struct ceph_mds_client *mdsc,
 665                            void *p, void *e, bool deletion,
 666                            struct ceph_snap_realm **realm_ret)
 667 {
 668         struct ceph_mds_snap_realm *ri;    /* encoded */
 669         __le64 *snaps;                     /* encoded */
 670         __le64 *prior_parent_snaps;        /* encoded */
 671         struct ceph_snap_realm *realm = NULL;
 672         struct ceph_snap_realm *first_realm = NULL;
 673         int invalidate = 0;
 674         int err = -ENOMEM;
 675         LIST_HEAD(dirty_realms);
 676
 677         dout("update_snap_trace deletion=%d\n", deletion);
 678 more:
 679         ceph_decode_need(&p, e, sizeof(*ri), bad);
 680         ri = p;
 681         p += sizeof(*ri);
 682         ceph_decode_need(&p, e, sizeof(u64)*(le32_to_cpu(ri->num_snaps) +
 683                             le32_to_cpu(ri->num_prior_parent_snaps)), bad);
 684         snaps = p;
 685         p += sizeof(u64) * le32_to_cpu(ri->num_snaps);
 686         prior_parent_snaps = p;
 687         p += sizeof(u64) * le32_to_cpu(ri->num_prior_parent_snaps);
 688
 689         realm = ceph_lookup_snap_realm(mdsc, le64_to_cpu(ri->ino));
 690         if (!realm) {
 691                 realm = ceph_create_snap_realm(mdsc, le64_to_cpu(ri->ino));
 692                 if (IS_ERR(realm)) {
 693                         err = PTR_ERR(realm);
 694                         goto fail;
 695                 }
 696         }
 697
 698         /* ensure the parent is correct */
 699         err = adjust_snap_realm_parent(mdsc, realm, le64_to_cpu(ri->parent));
 700         if (err < 0)
 701                 goto fail;
 702         invalidate += err;
 703
 704         if (le64_to_cpu(ri->seq) > realm->seq) {
 705                 dout("update_snap_trace updating %llx %p %lld -> %lld\n",
 706                      realm->ino, realm, realm->seq, le64_to_cpu(ri->seq));
 707                 /* update realm parameters, snap lists */
 708                 realm->seq = le64_to_cpu(ri->seq);
 709                 realm->created = le64_to_cpu(ri->created);
 710                 realm->parent_since = le64_to_cpu(ri->parent_since);
 711
 712                 realm->num_snaps = le32_to_cpu(ri->num_snaps);
 713                 err = dup_array(&realm->snaps, snaps, realm->num_snaps);
 714                 if (err < 0)
 715                         goto fail;
 716
 717                 realm->num_prior_parent_snaps =
 718                         le32_to_cpu(ri->num_prior_parent_snaps);
 719                 err = dup_array(&realm->prior_parent_snaps, prior_parent_snaps,
 720                                 realm->num_prior_parent_snaps);
 721                 if (err < 0)
 722                         goto fail;
 723
 724                 if (realm->seq > mdsc->last_snap_seq)
 725                         mdsc->last_snap_seq = realm->seq;
 726
 727                 invalidate = 1;
 728         } else if (!realm->cached_context) {
 729                 dout("update_snap_trace %llx %p seq %lld new\n",
 730                      realm->ino, realm, realm->seq);
 731                 invalidate = 1;
 732         } else {
 733                 dout("update_snap_trace %llx %p seq %lld unchanged\n",
 734                      realm->ino, realm, realm->seq);
 735         }
 736
 737         dout("done with %llx %p, invalidated=%d, %p %p\n", realm->ino,
 738              realm, invalidate, p, e);
 739
 740         /* invalidate when we reach the _end_ (root) of the trace */
 741         if (invalidate && p >= e)
 742                 rebuild_snap_realms(realm, &dirty_realms);
 743
 744         if (!first_realm)
 745                 first_realm = realm;
 746         else
 747                 ceph_put_snap_realm(mdsc, realm);
 748
 749         if (p < e)
 750                 goto more;
 751
 752         /*
 753          * queue cap snaps _after_ we've built the new snap contexts,
 754          * so that i_head_snapc can be set appropriately.
 755          */
 756         while (!list_empty(&dirty_realms)) {
 757                 realm = list_first_entry(&dirty_realms, struct ceph_snap_realm,
 758                                          dirty_item);
 759                 list_del_init(&realm->dirty_item);
 760                 queue_realm_cap_snaps(realm);
 761         }
 762
 763         if (realm_ret)
 764                 *realm_ret = first_realm;
 765         else
 766                 ceph_put_snap_realm(mdsc, first_realm);
 767
 768         __cleanup_empty_realms(mdsc);
 769         return 0;
 770
 771 bad:
 772         err = -EINVAL;
 773 fail:
 774         if (realm && !IS_ERR(realm))
 775                 ceph_put_snap_realm(mdsc, realm);
 776         if (first_realm)
 777                 ceph_put_snap_realm(mdsc, first_realm);
 778         pr_err("update_snap_trace error %d\n", err);
 779         return err;
 780 }
 781
 782
 783 /*
 784  * Send any cap_snaps that are queued for flush.  Try to carry
 785  * s_mutex across multiple snap flushes to avoid locking overhead.
 786  *
 787  * Caller holds no locks.
 788  */
 789 static void flush_snaps(struct ceph_mds_client *mdsc)
 790 {
 791         struct ceph_inode_info *ci;
 792         struct inode *inode;
 793         struct ceph_mds_session *session = NULL;
 794
 795         dout("flush_snaps\n");
 796         spin_lock(&mdsc->snap_flush_lock);
 797         while (!list_empty(&mdsc->snap_flush_list)) {
 798                 ci = list_first_entry(&mdsc->snap_flush_list,
 799                                 struct ceph_inode_info, i_snap_flush_item);
 800                 inode = &ci->vfs_inode;
 801                 ihold(inode);
 802                 spin_unlock(&mdsc->snap_flush_lock);
 803                 ceph_flush_snaps(ci, &session);
 804                 iput(inode);
 805                 spin_lock(&mdsc->snap_flush_lock);
 806         }
 807         spin_unlock(&mdsc->snap_flush_lock);
 808
 809         if (session) {
 810                 mutex_unlock(&session->s_mutex);
 811                 ceph_put_mds_session(session);
 812         }
 813         dout("flush_snaps done\n");
 814 }
 815
 816
 817 /*
 818  * Handle a snap notification from the MDS.
 819  *
 820  * This can take two basic forms: the simplest is just a snap creation
 821  * or deletion notification on an existing realm.  This should update the
 822  * realm and its children.
 823  *
 824  * The more difficult case is realm creation, due to snap creation at a
 825  * new point in the file hierarchy, or due to a rename that moves a file or
 826  * directory into another realm.
 827  */
 828 void ceph_handle_snap(struct ceph_mds_client *mdsc,
 829                       struct ceph_mds_session *session,
 830                       struct ceph_msg *msg)
 831 {
 832         struct super_block *sb = mdsc->fsc->sb;
 833         int mds = session->s_mds;
 834         u64 split;
 835         int op;
 836         int trace_len;
 837         struct ceph_snap_realm *realm = NULL;
 838         void *p = msg->front.iov_base;
 839         void *e = p + msg->front.iov_len;
 840         struct ceph_mds_snap_head *h;
 841         int num_split_inos, num_split_realms;
 842         __le64 *split_inos = NULL, *split_realms = NULL;
 843         int i;
 844         int locked_rwsem = 0;
 845
 846         /* decode */
 847         if (msg->front.iov_len < sizeof(*h))
 848                 goto bad;
 849         h = p;
 850         op = le32_to_cpu(h->op);
 851         split = le64_to_cpu(h->split);   /* non-zero if we are splitting an
 852                                           * existing realm */
 853         num_split_inos = le32_to_cpu(h->num_split_inos);
 854         num_split_realms = le32_to_cpu(h->num_split_realms);
 855         trace_len = le32_to_cpu(h->trace_len);
 856         p += sizeof(*h);
 857
 858         dout("handle_snap from mds%d op %s split %llx tracelen %d\n", mds,
 859              ceph_snap_op_name(op), split, trace_len);
 860
 861         mutex_lock(&session->s_mutex);
 862         session->s_seq++;
 863         mutex_unlock(&session->s_mutex);
 864
 865         down_write(&mdsc->snap_rwsem);
 866         locked_rwsem = 1;
 867
 868         if (op == CEPH_SNAP_OP_SPLIT) {
 869                 struct ceph_mds_snap_realm *ri;
 870
 871                 /*
 872                  * A "split" breaks part of an existing realm off into
 873                  * a new realm.  The MDS provides a list of inodes
 874                  * (with caps) and child realms that belong to the new
 875                  * child.
 876                  */
 877                 split_inos = p;
 878                 p += sizeof(u64) * num_split_inos;
 879                 split_realms = p;
 880                 p += sizeof(u64) * num_split_realms;
 881                 ceph_decode_need(&p, e, sizeof(*ri), bad);
 882                 /* we will peek at realm info here, but will _not_
 883                  * advance p, as the realm update will occur below in
 884                  * ceph_update_snap_trace. */
 885                 ri = p;
 886
 887                 realm = ceph_lookup_snap_realm(mdsc, split);
 888                 if (!realm) {
 889                         realm = ceph_create_snap_realm(mdsc, split);
 890                         if (IS_ERR(realm))
 891                                 goto out;
 892                 }
 893
 894                 dout("splitting snap_realm %llx %p\n", realm->ino, realm);
 895                 for (i = 0; i < num_split_inos; i++) {
 896                         struct ceph_vino vino = {
 897                                 .ino = le64_to_cpu(split_inos[i]),
 898                                 .snap = CEPH_NOSNAP,
 899                         };
 900                         struct inode *inode = ceph_find_inode(sb, vino);
 901                         struct ceph_inode_info *ci;
 902                         struct ceph_snap_realm *oldrealm;
 903
 904                         if (!inode)
 905                                 continue;
 906                         ci = ceph_inode(inode);
 907
 908                         spin_lock(&ci->i_ceph_lock);
 909                         if (!ci->i_snap_realm)
 910                                 goto skip_inode;
 911                         /*
 912                          * If this inode belongs to a realm that was
 913                          * created after our new realm, we experienced
 914                          * a race (due to another split notifications
 915                          * arriving from a different MDS).  So skip
 916                          * this inode.
 917                          */
 918                         if (ci->i_snap_realm->created >
 919                             le64_to_cpu(ri->created)) {
 920                                 dout(" leaving %p in newer realm %llx %p\n",
 921                                      inode, ci->i_snap_realm->ino,
 922                                      ci->i_snap_realm);
 923                                 goto skip_inode;
 924                         }
 925                         dout(" will move %p to split realm %llx %p\n",
 926                              inode, realm->ino, realm);
 927                         /*
 928                          * Move the inode to the new realm
 929                          */
 930                         oldrealm = ci->i_snap_realm;
 931                         spin_lock(&oldrealm->inodes_with_caps_lock);
 932                         list_del_init(&ci->i_snap_realm_item);
 933                         spin_unlock(&oldrealm->inodes_with_caps_lock);
 934
 935                         spin_lock(&realm->inodes_with_caps_lock);
 936                         list_add(&ci->i_snap_realm_item,
 937                                  &realm->inodes_with_caps);
 938                         ci->i_snap_realm = realm;
 939                         if (realm->ino == ci->i_vino.ino)
 940                                 realm->inode = inode;
 941                         spin_unlock(&realm->inodes_with_caps_lock);
 942
 943                         spin_unlock(&ci->i_ceph_lock);
 944
 945                         ceph_get_snap_realm(mdsc, realm);
 946                         ceph_put_snap_realm(mdsc, oldrealm);
 947
 948                         iput(inode);
 949                         continue;
 950
 951 skip_inode:
 952                         spin_unlock(&ci->i_ceph_lock);
 953                         iput(inode);
 954                 }
 955
 956                 /* we may have taken some of the old realm's children. */
 957                 for (i = 0; i < num_split_realms; i++) {
 958                         struct ceph_snap_realm *child =
 959                                 __lookup_snap_realm(mdsc,
 960                                            le64_to_cpu(split_realms[i]));
 961                         if (!child)
 962                                 continue;
 963                         adjust_snap_realm_parent(mdsc, child, realm->ino);
 964                 }
 965         }
 966
 967         /*
 968          * update using the provided snap trace. if we are deleting a
 969          * snap, we can avoid queueing cap_snaps.
 970          */
 971         ceph_update_snap_trace(mdsc, p, e,
 972                                op == CEPH_SNAP_OP_DESTROY, NULL);
 973
 974         if (op == CEPH_SNAP_OP_SPLIT)
 975                 /* we took a reference when we created the realm, above */
 976                 ceph_put_snap_realm(mdsc, realm);
 977
 978         __cleanup_empty_realms(mdsc);
 979
 980         up_write(&mdsc->snap_rwsem);
 981
 982         flush_snaps(mdsc);
 983         return;
 984
 985 bad:
 986         pr_err("corrupt snap message from mds%d\n", mds);
 987         ceph_msg_dump(msg);
 988 out:
 989         if (locked_rwsem)
 990                 up_write(&mdsc->snap_rwsem);
 991         return;
 992 }
 993
 994 struct ceph_snapid_map* ceph_get_snapid_map(struct ceph_mds_client *mdsc,
 995                                             u64 snap)
 996 {
 997         struct ceph_snapid_map *sm, *exist;
 998         struct rb_node **p, *parent;
 999         int ret;
1000
1001         exist = NULL;
1002         spin_lock(&mdsc->snapid_map_lock);
1003         p = &mdsc->snapid_map_tree.rb_node;
1004         while (*p) {
1005                 exist = rb_entry(*p, struct ceph_snapid_map, node);
1006                 if (snap > exist->snap) {
1007                         p = &(*p)->rb_left;
1008                 } else if (snap < exist->snap) {
1009                         p = &(*p)->rb_right;
1010                 } else {
1011                         if (atomic_inc_return(&exist->ref) == 1)
1012                                 list_del_init(&exist->lru);
1013                         break;
1014                 }
1015                 exist = NULL;
1016         }
1017         spin_unlock(&mdsc->snapid_map_lock);
1018         if (exist) {
1019                 dout("found snapid map %llx -> %x\n", exist->snap, exist->dev);
1020                 return exist;
1021         }
1022
1023         sm = kmalloc(sizeof(*sm), GFP_NOFS);
1024         if (!sm)
1025                 return NULL;
1026
1027         ret = get_anon_bdev(&sm->dev);
1028         if (ret < 0) {
1029                 kfree(sm);
1030                 return NULL;
1031         }
1032
1033         INIT_LIST_HEAD(&sm->lru);
1034         atomic_set(&sm->ref, 1);
1035         sm->snap = snap;
1036
1037         exist = NULL;
1038         parent = NULL;
1039         p = &mdsc->snapid_map_tree.rb_node;
1040         spin_lock(&mdsc->snapid_map_lock);
1041         while (*p) {
1042                 parent = *p;
1043                 exist = rb_entry(*p, struct ceph_snapid_map, node);
1044                 if (snap > exist->snap)
1045                         p = &(*p)->rb_left;
1046                 else if (snap < exist->snap)
1047                         p = &(*p)->rb_right;
1048                 else
1049                         break;
1050                 exist = NULL;
1051         }
1052         if (exist) {
1053                 if (atomic_inc_return(&exist->ref) == 1)
1054                         list_del_init(&exist->lru);
1055         } else {
1056                 rb_link_node(&sm->node, parent, p);
1057                 rb_insert_color(&sm->node, &mdsc->snapid_map_tree);
1058         }
1059         spin_unlock(&mdsc->snapid_map_lock);
1060         if (exist) {
1061                 free_anon_bdev(sm->dev);
1062                 kfree(sm);
1063                 dout("found snapid map %llx -> %x\n", exist->snap, exist->dev);
1064                 return exist;
1065         }
1066
1067         dout("create snapid map %llx -> %x\n", sm->snap, sm->dev);
1068         return sm;
1069 }
1070
1071 void ceph_put_snapid_map(struct ceph_mds_client* mdsc,
1072                          struct ceph_snapid_map *sm)
1073 {
1074         if (!sm)
1075                 return;
1076         if (atomic_dec_and_lock(&sm->ref, &mdsc->snapid_map_lock)) {
1077                 if (!RB_EMPTY_NODE(&sm->node)) {
1078                         sm->last_used = jiffies;
1079                         list_add_tail(&sm->lru, &mdsc->snapid_map_lru);
1080                         spin_unlock(&mdsc->snapid_map_lock);
1081                 } else {
1082                         /* already cleaned up by
1083                          * ceph_cleanup_snapid_map() */
1084                         spin_unlock(&mdsc->snapid_map_lock);
1085                         kfree(sm);
1086                 }
1087         }
1088 }
1089
1090 void ceph_trim_snapid_map(struct ceph_mds_client *mdsc)
1091 {
1092         struct ceph_snapid_map *sm;
1093         unsigned long now;
1094         LIST_HEAD(to_free);
1095
1096         spin_lock(&mdsc->snapid_map_lock);
1097         now = jiffies;
1098
1099         while (!list_empty(&mdsc->snapid_map_lru)) {
1100                 sm = list_first_entry(&mdsc->snapid_map_lru,
1101                                       struct ceph_snapid_map, lru);
1102                 if (time_after(sm->last_used + CEPH_SNAPID_MAP_TIMEOUT, now))
1103                         break;
1104
1105                 rb_erase(&sm->node, &mdsc->snapid_map_tree);
1106                 list_move(&sm->lru, &to_free);
1107         }
1108         spin_unlock(&mdsc->snapid_map_lock);
1109
1110         while (!list_empty(&to_free)) {
1111                 sm = list_first_entry(&to_free, struct ceph_snapid_map, lru);
1112                 list_del(&sm->lru);
1113                 dout("trim snapid map %llx -> %x\n", sm->snap, sm->dev);
1114                 free_anon_bdev(sm->dev);
1115                 kfree(sm);
1116         }
1117 }
1118
1119 void ceph_cleanup_snapid_map(struct ceph_mds_client *mdsc)
1120 {
1121         struct ceph_snapid_map *sm;
1122         struct rb_node *p;
1123         LIST_HEAD(to_free);
1124
1125         spin_lock(&mdsc->snapid_map_lock);
1126         while ((p = rb_first(&mdsc->snapid_map_tree))) {
1127                 sm = rb_entry(p, struct ceph_snapid_map, node);
1128                 rb_erase(p, &mdsc->snapid_map_tree);
1129                 RB_CLEAR_NODE(p);
1130                 list_move(&sm->lru, &to_free);
1131         }
1132         spin_unlock(&mdsc->snapid_map_lock);
1133
1134         while (!list_empty(&to_free)) {
1135                 sm = list_first_entry(&to_free, struct ceph_snapid_map, lru);
1136                 list_del(&sm->lru);
1137                 free_anon_bdev(sm->dev);
1138                 if (WARN_ON_ONCE(atomic_read(&sm->ref))) {
1139                         pr_err("snapid map %llx -> %x still in use\n",
1140                                sm->snap, sm->dev);
1141                 }
1142         }
1143 }