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