xref: /linux/fs/ceph/snap.c (revision 4dc7ccf7e9d9bca1989b840be9e8e84911387cf2)
1 #include "ceph_debug.h"
2 
3 #include <linux/sort.h>
4 #include <linux/slab.h>
5 
6 #include "super.h"
7 #include "decode.h"
8 
9 /*
10  * Snapshots in ceph are driven in large part by cooperation from the
11  * client.  In contrast to local file systems or file servers that
12  * implement snapshots at a single point in the system, ceph's
13  * distributed access to storage requires clients to help decide
14  * whether a write logically occurs before or after a recently created
15  * snapshot.
16  *
17  * This provides a perfect instantanous client-wide snapshot.  Between
18  * clients, however, snapshots may appear to be applied at slightly
19  * different points in time, depending on delays in delivering the
20  * snapshot notification.
21  *
22  * Snapshots are _not_ file system-wide.  Instead, each snapshot
23  * applies to the subdirectory nested beneath some directory.  This
24  * effectively divides the hierarchy into multiple "realms," where all
25  * of the files contained by each realm share the same set of
26  * snapshots.  An individual realm's snap set contains snapshots
27  * explicitly created on that realm, as well as any snaps in its
28  * parent's snap set _after_ the point at which the parent became it's
29  * parent (due to, say, a rename).  Similarly, snaps from prior parents
30  * during the time intervals during which they were the parent are included.
31  *
32  * The client is spared most of this detail, fortunately... it must only
33  * maintains a hierarchy of realms reflecting the current parent/child
34  * realm relationship, and for each realm has an explicit list of snaps
35  * inherited from prior parents.
36  *
37  * A snap_realm struct is maintained for realms containing every inode
38  * with an open cap in the system.  (The needed snap realm information is
39  * provided by the MDS whenever a cap is issued, i.e., on open.)  A 'seq'
40  * version number is used to ensure that as realm parameters change (new
41  * snapshot, new parent, etc.) the client's realm hierarchy is updated.
42  *
43  * The realm hierarchy drives the generation of a 'snap context' for each
44  * realm, which simply lists the resulting set of snaps for the realm.  This
45  * is attached to any writes sent to OSDs.
46  */
47 /*
48  * Unfortunately error handling is a bit mixed here.  If we get a snap
49  * update, but don't have enough memory to update our realm hierarchy,
50  * it's not clear what we can do about it (besides complaining to the
51  * console).
52  */
53 
54 
55 /*
56  * increase ref count for the realm
57  *
58  * caller must hold snap_rwsem for write.
59  */
60 void ceph_get_snap_realm(struct ceph_mds_client *mdsc,
61 			 struct ceph_snap_realm *realm)
62 {
63 	dout("get_realm %p %d -> %d\n", realm,
64 	     atomic_read(&realm->nref), atomic_read(&realm->nref)+1);
65 	/*
66 	 * since we _only_ increment realm refs or empty the empty
67 	 * list with snap_rwsem held, adjusting the empty list here is
68 	 * safe.  we do need to protect against concurrent empty list
69 	 * additions, however.
70 	 */
71 	if (atomic_read(&realm->nref) == 0) {
72 		spin_lock(&mdsc->snap_empty_lock);
73 		list_del_init(&realm->empty_item);
74 		spin_unlock(&mdsc->snap_empty_lock);
75 	}
76 
77 	atomic_inc(&realm->nref);
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, 0);    /* tree does not take a ref */
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->inodes_with_caps);
123 	spin_lock_init(&realm->inodes_with_caps_lock);
124 	__insert_snap_realm(&mdsc->snap_realms, realm);
125 	dout("create_snap_realm %llx %p\n", realm->ino, realm);
126 	return realm;
127 }
128 
129 /*
130  * lookup the realm rooted at @ino.
131  *
132  * caller must hold snap_rwsem for write.
133  */
134 struct ceph_snap_realm *ceph_lookup_snap_realm(struct ceph_mds_client *mdsc,
135 					       u64 ino)
136 {
137 	struct rb_node *n = mdsc->snap_realms.rb_node;
138 	struct ceph_snap_realm *r;
139 
140 	while (n) {
141 		r = rb_entry(n, struct ceph_snap_realm, node);
142 		if (ino < r->ino)
143 			n = n->rb_left;
144 		else if (ino > r->ino)
145 			n = n->rb_right;
146 		else {
147 			dout("lookup_snap_realm %llx %p\n", r->ino, r);
148 			return r;
149 		}
150 	}
151 	return NULL;
152 }
153 
154 static void __put_snap_realm(struct ceph_mds_client *mdsc,
155 			     struct ceph_snap_realm *realm);
156 
157 /*
158  * called with snap_rwsem (write)
159  */
160 static void __destroy_snap_realm(struct ceph_mds_client *mdsc,
161 				 struct ceph_snap_realm *realm)
162 {
163 	dout("__destroy_snap_realm %p %llx\n", realm, realm->ino);
164 
165 	rb_erase(&realm->node, &mdsc->snap_realms);
166 
167 	if (realm->parent) {
168 		list_del_init(&realm->child_item);
169 		__put_snap_realm(mdsc, realm->parent);
170 	}
171 
172 	kfree(realm->prior_parent_snaps);
173 	kfree(realm->snaps);
174 	ceph_put_snap_context(realm->cached_context);
175 	kfree(realm);
176 }
177 
178 /*
179  * caller holds snap_rwsem (write)
180  */
181 static void __put_snap_realm(struct ceph_mds_client *mdsc,
182 			     struct ceph_snap_realm *realm)
183 {
184 	dout("__put_snap_realm %llx %p %d -> %d\n", realm->ino, realm,
185 	     atomic_read(&realm->nref), atomic_read(&realm->nref)-1);
186 	if (atomic_dec_and_test(&realm->nref))
187 		__destroy_snap_realm(mdsc, realm);
188 }
189 
190 /*
191  * caller needn't hold any locks
192  */
193 void ceph_put_snap_realm(struct ceph_mds_client *mdsc,
194 			 struct ceph_snap_realm *realm)
195 {
196 	dout("put_snap_realm %llx %p %d -> %d\n", realm->ino, realm,
197 	     atomic_read(&realm->nref), atomic_read(&realm->nref)-1);
198 	if (!atomic_dec_and_test(&realm->nref))
199 		return;
200 
201 	if (down_write_trylock(&mdsc->snap_rwsem)) {
202 		__destroy_snap_realm(mdsc, realm);
203 		up_write(&mdsc->snap_rwsem);
204 	} else {
205 		spin_lock(&mdsc->snap_empty_lock);
206 		list_add(&mdsc->snap_empty, &realm->empty_item);
207 		spin_unlock(&mdsc->snap_empty_lock);
208 	}
209 }
210 
211 /*
212  * Clean up any realms whose ref counts have dropped to zero.  Note
213  * that this does not include realms who were created but not yet
214  * used.
215  *
216  * Called under snap_rwsem (write)
217  */
218 static void __cleanup_empty_realms(struct ceph_mds_client *mdsc)
219 {
220 	struct ceph_snap_realm *realm;
221 
222 	spin_lock(&mdsc->snap_empty_lock);
223 	while (!list_empty(&mdsc->snap_empty)) {
224 		realm = list_first_entry(&mdsc->snap_empty,
225 				   struct ceph_snap_realm, empty_item);
226 		list_del(&realm->empty_item);
227 		spin_unlock(&mdsc->snap_empty_lock);
228 		__destroy_snap_realm(mdsc, realm);
229 		spin_lock(&mdsc->snap_empty_lock);
230 	}
231 	spin_unlock(&mdsc->snap_empty_lock);
232 }
233 
234 void ceph_cleanup_empty_realms(struct ceph_mds_client *mdsc)
235 {
236 	down_write(&mdsc->snap_rwsem);
237 	__cleanup_empty_realms(mdsc);
238 	up_write(&mdsc->snap_rwsem);
239 }
240 
241 /*
242  * adjust the parent realm of a given @realm.  adjust child list, and parent
243  * pointers, and ref counts appropriately.
244  *
245  * return true if parent was changed, 0 if unchanged, <0 on error.
246  *
247  * caller must hold snap_rwsem for write.
248  */
249 static int adjust_snap_realm_parent(struct ceph_mds_client *mdsc,
250 				    struct ceph_snap_realm *realm,
251 				    u64 parentino)
252 {
253 	struct ceph_snap_realm *parent;
254 
255 	if (realm->parent_ino == parentino)
256 		return 0;
257 
258 	parent = ceph_lookup_snap_realm(mdsc, parentino);
259 	if (!parent) {
260 		parent = ceph_create_snap_realm(mdsc, parentino);
261 		if (IS_ERR(parent))
262 			return PTR_ERR(parent);
263 	}
264 	dout("adjust_snap_realm_parent %llx %p: %llx %p -> %llx %p\n",
265 	     realm->ino, realm, realm->parent_ino, realm->parent,
266 	     parentino, parent);
267 	if (realm->parent) {
268 		list_del_init(&realm->child_item);
269 		ceph_put_snap_realm(mdsc, realm->parent);
270 	}
271 	realm->parent_ino = parentino;
272 	realm->parent = parent;
273 	ceph_get_snap_realm(mdsc, parent);
274 	list_add(&realm->child_item, &parent->children);
275 	return 1;
276 }
277 
278 
279 static int cmpu64_rev(const void *a, const void *b)
280 {
281 	if (*(u64 *)a < *(u64 *)b)
282 		return 1;
283 	if (*(u64 *)a > *(u64 *)b)
284 		return -1;
285 	return 0;
286 }
287 
288 /*
289  * build the snap context for a given realm.
290  */
291 static int build_snap_context(struct ceph_snap_realm *realm)
292 {
293 	struct ceph_snap_realm *parent = realm->parent;
294 	struct ceph_snap_context *snapc;
295 	int err = 0;
296 	int i;
297 	int num = realm->num_prior_parent_snaps + realm->num_snaps;
298 
299 	/*
300 	 * build parent context, if it hasn't been built.
301 	 * conservatively estimate that all parent snaps might be
302 	 * included by us.
303 	 */
304 	if (parent) {
305 		if (!parent->cached_context) {
306 			err = build_snap_context(parent);
307 			if (err)
308 				goto fail;
309 		}
310 		num += parent->cached_context->num_snaps;
311 	}
312 
313 	/* do i actually need to update?  not if my context seq
314 	   matches realm seq, and my parents' does to.  (this works
315 	   because we rebuild_snap_realms() works _downward_ in
316 	   hierarchy after each update.) */
317 	if (realm->cached_context &&
318 	    realm->cached_context->seq == realm->seq &&
319 	    (!parent ||
320 	     realm->cached_context->seq >= parent->cached_context->seq)) {
321 		dout("build_snap_context %llx %p: %p seq %lld (%d snaps)"
322 		     " (unchanged)\n",
323 		     realm->ino, realm, realm->cached_context,
324 		     realm->cached_context->seq,
325 		     realm->cached_context->num_snaps);
326 		return 0;
327 	}
328 
329 	/* alloc new snap context */
330 	err = -ENOMEM;
331 	if (num > ULONG_MAX / sizeof(u64) - sizeof(*snapc))
332 		goto fail;
333 	snapc = kzalloc(sizeof(*snapc) + num*sizeof(u64), GFP_NOFS);
334 	if (!snapc)
335 		goto fail;
336 	atomic_set(&snapc->nref, 1);
337 
338 	/* build (reverse sorted) snap vector */
339 	num = 0;
340 	snapc->seq = realm->seq;
341 	if (parent) {
342 		/* include any of parent's snaps occuring _after_ my
343 		   parent became my parent */
344 		for (i = 0; i < parent->cached_context->num_snaps; i++)
345 			if (parent->cached_context->snaps[i] >=
346 			    realm->parent_since)
347 				snapc->snaps[num++] =
348 					parent->cached_context->snaps[i];
349 		if (parent->cached_context->seq > snapc->seq)
350 			snapc->seq = parent->cached_context->seq;
351 	}
352 	memcpy(snapc->snaps + num, realm->snaps,
353 	       sizeof(u64)*realm->num_snaps);
354 	num += realm->num_snaps;
355 	memcpy(snapc->snaps + num, realm->prior_parent_snaps,
356 	       sizeof(u64)*realm->num_prior_parent_snaps);
357 	num += realm->num_prior_parent_snaps;
358 
359 	sort(snapc->snaps, num, sizeof(u64), cmpu64_rev, NULL);
360 	snapc->num_snaps = num;
361 	dout("build_snap_context %llx %p: %p seq %lld (%d snaps)\n",
362 	     realm->ino, realm, snapc, snapc->seq, snapc->num_snaps);
363 
364 	if (realm->cached_context)
365 		ceph_put_snap_context(realm->cached_context);
366 	realm->cached_context = snapc;
367 	return 0;
368 
369 fail:
370 	/*
371 	 * if we fail, clear old (incorrect) cached_context... hopefully
372 	 * we'll have better luck building it later
373 	 */
374 	if (realm->cached_context) {
375 		ceph_put_snap_context(realm->cached_context);
376 		realm->cached_context = NULL;
377 	}
378 	pr_err("build_snap_context %llx %p fail %d\n", realm->ino,
379 	       realm, err);
380 	return err;
381 }
382 
383 /*
384  * rebuild snap context for the given realm and all of its children.
385  */
386 static void rebuild_snap_realms(struct ceph_snap_realm *realm)
387 {
388 	struct ceph_snap_realm *child;
389 
390 	dout("rebuild_snap_realms %llx %p\n", realm->ino, realm);
391 	build_snap_context(realm);
392 
393 	list_for_each_entry(child, &realm->children, child_item)
394 		rebuild_snap_realms(child);
395 }
396 
397 
398 /*
399  * helper to allocate and decode an array of snapids.  free prior
400  * instance, if any.
401  */
402 static int dup_array(u64 **dst, __le64 *src, int num)
403 {
404 	int i;
405 
406 	kfree(*dst);
407 	if (num) {
408 		*dst = kcalloc(num, sizeof(u64), GFP_NOFS);
409 		if (!*dst)
410 			return -ENOMEM;
411 		for (i = 0; i < num; i++)
412 			(*dst)[i] = get_unaligned_le64(src + i);
413 	} else {
414 		*dst = NULL;
415 	}
416 	return 0;
417 }
418 
419 
420 /*
421  * When a snapshot is applied, the size/mtime inode metadata is queued
422  * in a ceph_cap_snap (one for each snapshot) until writeback
423  * completes and the metadata can be flushed back to the MDS.
424  *
425  * However, if a (sync) write is currently in-progress when we apply
426  * the snapshot, we have to wait until the write succeeds or fails
427  * (and a final size/mtime is known).  In this case the
428  * cap_snap->writing = 1, and is said to be "pending."  When the write
429  * finishes, we __ceph_finish_cap_snap().
430  *
431  * Caller must hold snap_rwsem for read (i.e., the realm topology won't
432  * change).
433  */
434 void ceph_queue_cap_snap(struct ceph_inode_info *ci,
435 			 struct ceph_snap_context *snapc)
436 {
437 	struct inode *inode = &ci->vfs_inode;
438 	struct ceph_cap_snap *capsnap;
439 	int used;
440 
441 	capsnap = kzalloc(sizeof(*capsnap), GFP_NOFS);
442 	if (!capsnap) {
443 		pr_err("ENOMEM allocating ceph_cap_snap on %p\n", inode);
444 		return;
445 	}
446 
447 	spin_lock(&inode->i_lock);
448 	used = __ceph_caps_used(ci);
449 	if (__ceph_have_pending_cap_snap(ci)) {
450 		/* there is no point in queuing multiple "pending" cap_snaps,
451 		   as no new writes are allowed to start when pending, so any
452 		   writes in progress now were started before the previous
453 		   cap_snap.  lucky us. */
454 		dout("queue_cap_snap %p snapc %p seq %llu used %d"
455 		     " already pending\n", inode, snapc, snapc->seq, used);
456 		kfree(capsnap);
457 	} else if (ci->i_wrbuffer_ref_head || (used & CEPH_CAP_FILE_WR)) {
458 		igrab(inode);
459 
460 		atomic_set(&capsnap->nref, 1);
461 		capsnap->ci = ci;
462 		INIT_LIST_HEAD(&capsnap->ci_item);
463 		INIT_LIST_HEAD(&capsnap->flushing_item);
464 
465 		capsnap->follows = snapc->seq - 1;
466 		capsnap->context = ceph_get_snap_context(snapc);
467 		capsnap->issued = __ceph_caps_issued(ci, NULL);
468 		capsnap->dirty = __ceph_caps_dirty(ci);
469 
470 		capsnap->mode = inode->i_mode;
471 		capsnap->uid = inode->i_uid;
472 		capsnap->gid = inode->i_gid;
473 
474 		/* fixme? */
475 		capsnap->xattr_blob = NULL;
476 		capsnap->xattr_len = 0;
477 
478 		/* dirty page count moved from _head to this cap_snap;
479 		   all subsequent writes page dirties occur _after_ this
480 		   snapshot. */
481 		capsnap->dirty_pages = ci->i_wrbuffer_ref_head;
482 		ci->i_wrbuffer_ref_head = 0;
483 		ceph_put_snap_context(ci->i_head_snapc);
484 		ci->i_head_snapc = NULL;
485 		list_add_tail(&capsnap->ci_item, &ci->i_cap_snaps);
486 
487 		if (used & CEPH_CAP_FILE_WR) {
488 			dout("queue_cap_snap %p cap_snap %p snapc %p"
489 			     " seq %llu used WR, now pending\n", inode,
490 			     capsnap, snapc, snapc->seq);
491 			capsnap->writing = 1;
492 		} else {
493 			/* note mtime, size NOW. */
494 			__ceph_finish_cap_snap(ci, capsnap);
495 		}
496 	} else {
497 		dout("queue_cap_snap %p nothing dirty|writing\n", inode);
498 		kfree(capsnap);
499 	}
500 
501 	spin_unlock(&inode->i_lock);
502 }
503 
504 /*
505  * Finalize the size, mtime for a cap_snap.. that is, settle on final values
506  * to be used for the snapshot, to be flushed back to the mds.
507  *
508  * If capsnap can now be flushed, add to snap_flush list, and return 1.
509  *
510  * Caller must hold i_lock.
511  */
512 int __ceph_finish_cap_snap(struct ceph_inode_info *ci,
513 			    struct ceph_cap_snap *capsnap)
514 {
515 	struct inode *inode = &ci->vfs_inode;
516 	struct ceph_mds_client *mdsc = &ceph_client(inode->i_sb)->mdsc;
517 
518 	BUG_ON(capsnap->writing);
519 	capsnap->size = inode->i_size;
520 	capsnap->mtime = inode->i_mtime;
521 	capsnap->atime = inode->i_atime;
522 	capsnap->ctime = inode->i_ctime;
523 	capsnap->time_warp_seq = ci->i_time_warp_seq;
524 	if (capsnap->dirty_pages) {
525 		dout("finish_cap_snap %p cap_snap %p snapc %p %llu s=%llu "
526 		     "still has %d dirty pages\n", inode, capsnap,
527 		     capsnap->context, capsnap->context->seq,
528 		     capsnap->size, capsnap->dirty_pages);
529 		return 0;
530 	}
531 	dout("finish_cap_snap %p cap_snap %p snapc %p %llu s=%llu clean\n",
532 	     inode, capsnap, capsnap->context,
533 	     capsnap->context->seq, 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, realm->cached_context);
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 					    ci->i_snap_realm->cached_context);
829 
830 			iput(inode);
831 			continue;
832 
833 skip_inode:
834 			spin_unlock(&inode->i_lock);
835 			iput(inode);
836 		}
837 
838 		/* we may have taken some of the old realm's children. */
839 		for (i = 0; i < num_split_realms; i++) {
840 			struct ceph_snap_realm *child =
841 				ceph_lookup_snap_realm(mdsc,
842 					   le64_to_cpu(split_realms[i]));
843 			if (!child)
844 				continue;
845 			adjust_snap_realm_parent(mdsc, child, realm->ino);
846 		}
847 	}
848 
849 	/*
850 	 * update using the provided snap trace. if we are deleting a
851 	 * snap, we can avoid queueing cap_snaps.
852 	 */
853 	ceph_update_snap_trace(mdsc, p, e,
854 			       op == CEPH_SNAP_OP_DESTROY);
855 
856 	if (op == CEPH_SNAP_OP_SPLIT) {
857 		/*
858 		 * ok, _now_ add the inodes into the new realm.
859 		 */
860 		for (i = 0; i < num_split_inos; i++) {
861 			struct ceph_vino vino = {
862 				.ino = le64_to_cpu(split_inos[i]),
863 				.snap = CEPH_NOSNAP,
864 			};
865 			struct inode *inode = ceph_find_inode(sb, vino);
866 			struct ceph_inode_info *ci;
867 
868 			if (!inode)
869 				continue;
870 			ci = ceph_inode(inode);
871 			spin_lock(&inode->i_lock);
872 			if (!ci->i_snap_realm)
873 				goto split_skip_inode;
874 			ceph_put_snap_realm(mdsc, ci->i_snap_realm);
875 			spin_lock(&realm->inodes_with_caps_lock);
876 			list_add(&ci->i_snap_realm_item,
877 				 &realm->inodes_with_caps);
878 			ci->i_snap_realm = realm;
879 			spin_unlock(&realm->inodes_with_caps_lock);
880 			ceph_get_snap_realm(mdsc, realm);
881 split_skip_inode:
882 			spin_unlock(&inode->i_lock);
883 			iput(inode);
884 		}
885 
886 		/* we took a reference when we created the realm, above */
887 		ceph_put_snap_realm(mdsc, realm);
888 	}
889 
890 	__cleanup_empty_realms(mdsc);
891 
892 	up_write(&mdsc->snap_rwsem);
893 
894 	flush_snaps(mdsc);
895 	return;
896 
897 bad:
898 	pr_err("corrupt snap message from mds%d\n", mds);
899 	ceph_msg_dump(msg);
900 out:
901 	if (locked_rwsem)
902 		up_write(&mdsc->snap_rwsem);
903 	return;
904 }
905 
906 
907 
908