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