1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Overlayfs NFS export support.
4  *
5  * Amir Goldstein <amir73il@gmail.com>
6  *
7  * Copyright (C) 2017-2018 CTERA Networks. All Rights Reserved.
8  */
9 
10 #include <linux/fs.h>
11 #include <linux/cred.h>
12 #include <linux/mount.h>
13 #include <linux/namei.h>
14 #include <linux/xattr.h>
15 #include <linux/exportfs.h>
16 #include <linux/ratelimit.h>
17 #include "overlayfs.h"
18 
ovl_encode_maybe_copy_up(struct dentry *dentry)19 static int ovl_encode_maybe_copy_up(struct dentry *dentry)
20 {
21 	int err;
22 
23 	if (ovl_dentry_upper(dentry))
24 		return 0;
25 
26 	err = ovl_want_write(dentry);
27 	if (!err) {
28 		err = ovl_copy_up(dentry);
29 		ovl_drop_write(dentry);
30 	}
31 
32 	if (err) {
33 		pr_warn_ratelimited("failed to copy up on encode (%pd2, err=%i)\n",
34 				    dentry, err);
35 	}
36 
37 	return err;
38 }
39 
40 /*
41  * Before encoding a non-upper directory file handle from real layer N, we need
42  * to check if it will be possible to reconnect an overlay dentry from the real
43  * lower decoded dentry. This is done by following the overlay ancestry up to a
44  * "layer N connected" ancestor and verifying that all parents along the way are
45  * "layer N connectable". If an ancestor that is NOT "layer N connectable" is
46  * found, we need to copy up an ancestor, which is "layer N connectable", thus
47  * making that ancestor "layer N connected". For example:
48  *
49  * layer 1: /a
50  * layer 2: /a/b/c
51  *
52  * The overlay dentry /a is NOT "layer 2 connectable", because if dir /a is
53  * copied up and renamed, upper dir /a will be indexed by lower dir /a from
54  * layer 1. The dir /a from layer 2 will never be indexed, so the algorithm (*)
55  * in ovl_lookup_real_ancestor() will not be able to lookup a connected overlay
56  * dentry from the connected lower dentry /a/b/c.
57  *
58  * To avoid this problem on decode time, we need to copy up an ancestor of
59  * /a/b/c, which is "layer 2 connectable", on encode time. That ancestor is
60  * /a/b. After copy up (and index) of /a/b, it will become "layer 2 connected"
61  * and when the time comes to decode the file handle from lower dentry /a/b/c,
62  * ovl_lookup_real_ancestor() will find the indexed ancestor /a/b and decoding
63  * a connected overlay dentry will be accomplished.
64  *
65  * (*) the algorithm in ovl_lookup_real_ancestor() can be improved to lookup an
66  * entry /a in the lower layers above layer N and find the indexed dir /a from
67  * layer 1. If that improvement is made, then the check for "layer N connected"
68  * will need to verify there are no redirects in lower layers above N. In the
69  * example above, /a will be "layer 2 connectable". However, if layer 2 dir /a
70  * is a target of a layer 1 redirect, then /a will NOT be "layer 2 connectable":
71  *
72  * layer 1: /A (redirect = /a)
73  * layer 2: /a/b/c
74  */
75 
76 /* Return the lowest layer for encoding a connectable file handle */
ovl_connectable_layer(struct dentry *dentry)77 static int ovl_connectable_layer(struct dentry *dentry)
78 {
79 	struct ovl_entry *oe = OVL_E(dentry);
80 
81 	/* We can get overlay root from root of any layer */
82 	if (dentry == dentry->d_sb->s_root)
83 		return oe->numlower;
84 
85 	/*
86 	 * If it's an unindexed merge dir, then it's not connectable with any
87 	 * lower layer
88 	 */
89 	if (ovl_dentry_upper(dentry) &&
90 	    !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
91 		return 0;
92 
93 	/* We can get upper/overlay path from indexed/lower dentry */
94 	return oe->lowerstack[0].layer->idx;
95 }
96 
97 /*
98  * @dentry is "connected" if all ancestors up to root or a "connected" ancestor
99  * have the same uppermost lower layer as the origin's layer. We may need to
100  * copy up a "connectable" ancestor to make it "connected". A "connected" dentry
101  * cannot become non "connected", so cache positive result in dentry flags.
102  *
103  * Return the connected origin layer or < 0 on error.
104  */
ovl_connect_layer(struct dentry *dentry)105 static int ovl_connect_layer(struct dentry *dentry)
106 {
107 	struct dentry *next, *parent = NULL;
108 	int origin_layer;
109 	int err = 0;
110 
111 	if (WARN_ON(dentry == dentry->d_sb->s_root) ||
112 	    WARN_ON(!ovl_dentry_lower(dentry)))
113 		return -EIO;
114 
115 	origin_layer = OVL_E(dentry)->lowerstack[0].layer->idx;
116 	if (ovl_dentry_test_flag(OVL_E_CONNECTED, dentry))
117 		return origin_layer;
118 
119 	/* Find the topmost origin layer connectable ancestor of @dentry */
120 	next = dget(dentry);
121 	for (;;) {
122 		parent = dget_parent(next);
123 		if (WARN_ON(parent == next)) {
124 			err = -EIO;
125 			break;
126 		}
127 
128 		/*
129 		 * If @parent is not origin layer connectable, then copy up
130 		 * @next which is origin layer connectable and we are done.
131 		 */
132 		if (ovl_connectable_layer(parent) < origin_layer) {
133 			err = ovl_encode_maybe_copy_up(next);
134 			break;
135 		}
136 
137 		/* If @parent is connected or indexed we are done */
138 		if (ovl_dentry_test_flag(OVL_E_CONNECTED, parent) ||
139 		    ovl_test_flag(OVL_INDEX, d_inode(parent)))
140 			break;
141 
142 		dput(next);
143 		next = parent;
144 	}
145 
146 	dput(parent);
147 	dput(next);
148 
149 	if (!err)
150 		ovl_dentry_set_flag(OVL_E_CONNECTED, dentry);
151 
152 	return err ?: origin_layer;
153 }
154 
155 /*
156  * We only need to encode origin if there is a chance that the same object was
157  * encoded pre copy up and then we need to stay consistent with the same
158  * encoding also after copy up. If non-pure upper is not indexed, then it was
159  * copied up before NFS export was enabled. In that case we don't need to worry
160  * about staying consistent with pre copy up encoding and we encode an upper
161  * file handle. Overlay root dentry is a private case of non-indexed upper.
162  *
163  * The following table summarizes the different file handle encodings used for
164  * different overlay object types:
165  *
166  *  Object type		| Encoding
167  * --------------------------------
168  *  Pure upper		| U
169  *  Non-indexed upper	| U
170  *  Indexed upper	| L (*)
171  *  Non-upper		| L (*)
172  *
173  * U = upper file handle
174  * L = lower file handle
175  *
176  * (*) Connecting an overlay dir from real lower dentry is not always
177  * possible when there are redirects in lower layers and non-indexed merge dirs.
178  * To mitigate those case, we may copy up the lower dir ancestor before encode
179  * a lower dir file handle.
180  *
181  * Return 0 for upper file handle, > 0 for lower file handle or < 0 on error.
182  */
ovl_check_encode_origin(struct dentry *dentry)183 static int ovl_check_encode_origin(struct dentry *dentry)
184 {
185 	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
186 
187 	/* Upper file handle for pure upper */
188 	if (!ovl_dentry_lower(dentry))
189 		return 0;
190 
191 	/*
192 	 * Upper file handle for non-indexed upper.
193 	 *
194 	 * Root is never indexed, so if there's an upper layer, encode upper for
195 	 * root.
196 	 */
197 	if (ovl_dentry_upper(dentry) &&
198 	    !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
199 		return 0;
200 
201 	/*
202 	 * Decoding a merge dir, whose origin's ancestor is under a redirected
203 	 * lower dir or under a non-indexed upper is not always possible.
204 	 * ovl_connect_layer() will try to make origin's layer "connected" by
205 	 * copying up a "connectable" ancestor.
206 	 */
207 	if (d_is_dir(dentry) && ovl_upper_mnt(ofs))
208 		return ovl_connect_layer(dentry);
209 
210 	/* Lower file handle for indexed and non-upper dir/non-dir */
211 	return 1;
212 }
213 
ovl_dentry_to_fid(struct dentry *dentry, u32 *fid, int buflen)214 static int ovl_dentry_to_fid(struct dentry *dentry, u32 *fid, int buflen)
215 {
216 	struct ovl_fh *fh = NULL;
217 	int err, enc_lower;
218 	int len;
219 
220 	/*
221 	 * Check if we should encode a lower or upper file handle and maybe
222 	 * copy up an ancestor to make lower file handle connectable.
223 	 */
224 	err = enc_lower = ovl_check_encode_origin(dentry);
225 	if (enc_lower < 0)
226 		goto fail;
227 
228 	/* Encode an upper or lower file handle */
229 	fh = ovl_encode_real_fh(enc_lower ? ovl_dentry_lower(dentry) :
230 				ovl_dentry_upper(dentry), !enc_lower);
231 	if (IS_ERR(fh))
232 		return PTR_ERR(fh);
233 
234 	len = OVL_FH_LEN(fh);
235 	if (len <= buflen)
236 		memcpy(fid, fh, len);
237 	err = len;
238 
239 out:
240 	kfree(fh);
241 	return err;
242 
243 fail:
244 	pr_warn_ratelimited("failed to encode file handle (%pd2, err=%i)\n",
245 			    dentry, err);
246 	goto out;
247 }
248 
ovl_encode_fh(struct inode *inode, u32 *fid, int *max_len, struct inode *parent)249 static int ovl_encode_fh(struct inode *inode, u32 *fid, int *max_len,
250 			 struct inode *parent)
251 {
252 	struct dentry *dentry;
253 	int bytes, buflen = *max_len << 2;
254 
255 	/* TODO: encode connectable file handles */
256 	if (parent)
257 		return FILEID_INVALID;
258 
259 	dentry = d_find_any_alias(inode);
260 	if (!dentry)
261 		return FILEID_INVALID;
262 
263 	bytes = ovl_dentry_to_fid(dentry, fid, buflen);
264 	dput(dentry);
265 	if (bytes <= 0)
266 		return FILEID_INVALID;
267 
268 	*max_len = bytes >> 2;
269 	if (bytes > buflen)
270 		return FILEID_INVALID;
271 
272 	return OVL_FILEID_V1;
273 }
274 
275 /*
276  * Find or instantiate an overlay dentry from real dentries and index.
277  */
ovl_obtain_alias(struct super_block *sb, struct dentry *upper_alias, struct ovl_path *lowerpath, struct dentry *index)278 static struct dentry *ovl_obtain_alias(struct super_block *sb,
279 				       struct dentry *upper_alias,
280 				       struct ovl_path *lowerpath,
281 				       struct dentry *index)
282 {
283 	struct dentry *lower = lowerpath ? lowerpath->dentry : NULL;
284 	struct dentry *upper = upper_alias ?: index;
285 	struct dentry *dentry;
286 	struct inode *inode;
287 	struct ovl_entry *oe;
288 	struct ovl_inode_params oip = {
289 		.lowerpath = lowerpath,
290 		.index = index,
291 		.numlower = !!lower
292 	};
293 
294 	/* We get overlay directory dentries with ovl_lookup_real() */
295 	if (d_is_dir(upper ?: lower))
296 		return ERR_PTR(-EIO);
297 
298 	oip.upperdentry = dget(upper);
299 	inode = ovl_get_inode(sb, &oip);
300 	if (IS_ERR(inode)) {
301 		dput(upper);
302 		return ERR_CAST(inode);
303 	}
304 
305 	if (upper)
306 		ovl_set_flag(OVL_UPPERDATA, inode);
307 
308 	dentry = d_find_any_alias(inode);
309 	if (dentry)
310 		goto out_iput;
311 
312 	dentry = d_alloc_anon(inode->i_sb);
313 	if (unlikely(!dentry))
314 		goto nomem;
315 	oe = ovl_alloc_entry(lower ? 1 : 0);
316 	if (!oe)
317 		goto nomem;
318 
319 	if (lower) {
320 		oe->lowerstack->dentry = dget(lower);
321 		oe->lowerstack->layer = lowerpath->layer;
322 	}
323 	dentry->d_fsdata = oe;
324 	if (upper_alias)
325 		ovl_dentry_set_upper_alias(dentry);
326 
327 	ovl_dentry_init_reval(dentry, upper);
328 
329 	return d_instantiate_anon(dentry, inode);
330 
331 nomem:
332 	dput(dentry);
333 	dentry = ERR_PTR(-ENOMEM);
334 out_iput:
335 	iput(inode);
336 	return dentry;
337 }
338 
339 /* Get the upper or lower dentry in stach whose on layer @idx */
ovl_dentry_real_at(struct dentry *dentry, int idx)340 static struct dentry *ovl_dentry_real_at(struct dentry *dentry, int idx)
341 {
342 	struct ovl_entry *oe = dentry->d_fsdata;
343 	int i;
344 
345 	if (!idx)
346 		return ovl_dentry_upper(dentry);
347 
348 	for (i = 0; i < oe->numlower; i++) {
349 		if (oe->lowerstack[i].layer->idx == idx)
350 			return oe->lowerstack[i].dentry;
351 	}
352 
353 	return NULL;
354 }
355 
356 /*
357  * Lookup a child overlay dentry to get a connected overlay dentry whose real
358  * dentry is @real. If @real is on upper layer, we lookup a child overlay
359  * dentry with the same name as the real dentry. Otherwise, we need to consult
360  * index for lookup.
361  */
ovl_lookup_real_one(struct dentry *connected, struct dentry *real, const struct ovl_layer *layer)362 static struct dentry *ovl_lookup_real_one(struct dentry *connected,
363 					  struct dentry *real,
364 					  const struct ovl_layer *layer)
365 {
366 	struct inode *dir = d_inode(connected);
367 	struct dentry *this, *parent = NULL;
368 	struct name_snapshot name;
369 	int err;
370 
371 	/*
372 	 * Lookup child overlay dentry by real name. The dir mutex protects us
373 	 * from racing with overlay rename. If the overlay dentry that is above
374 	 * real has already been moved to a parent that is not under the
375 	 * connected overlay dir, we return -ECHILD and restart the lookup of
376 	 * connected real path from the top.
377 	 */
378 	inode_lock_nested(dir, I_MUTEX_PARENT);
379 	err = -ECHILD;
380 	parent = dget_parent(real);
381 	if (ovl_dentry_real_at(connected, layer->idx) != parent)
382 		goto fail;
383 
384 	/*
385 	 * We also need to take a snapshot of real dentry name to protect us
386 	 * from racing with underlying layer rename. In this case, we don't
387 	 * care about returning ESTALE, only from dereferencing a free name
388 	 * pointer because we hold no lock on the real dentry.
389 	 */
390 	take_dentry_name_snapshot(&name, real);
391 	this = lookup_one_len(name.name.name, connected, name.name.len);
392 	release_dentry_name_snapshot(&name);
393 	err = PTR_ERR(this);
394 	if (IS_ERR(this)) {
395 		goto fail;
396 	} else if (!this || !this->d_inode) {
397 		dput(this);
398 		err = -ENOENT;
399 		goto fail;
400 	} else if (ovl_dentry_real_at(this, layer->idx) != real) {
401 		dput(this);
402 		err = -ESTALE;
403 		goto fail;
404 	}
405 
406 out:
407 	dput(parent);
408 	inode_unlock(dir);
409 	return this;
410 
411 fail:
412 	pr_warn_ratelimited("failed to lookup one by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
413 			    real, layer->idx, connected, err);
414 	this = ERR_PTR(err);
415 	goto out;
416 }
417 
418 static struct dentry *ovl_lookup_real(struct super_block *sb,
419 				      struct dentry *real,
420 				      const struct ovl_layer *layer);
421 
422 /*
423  * Lookup an indexed or hashed overlay dentry by real inode.
424  */
ovl_lookup_real_inode(struct super_block *sb, struct dentry *real, const struct ovl_layer *layer)425 static struct dentry *ovl_lookup_real_inode(struct super_block *sb,
426 					    struct dentry *real,
427 					    const struct ovl_layer *layer)
428 {
429 	struct ovl_fs *ofs = sb->s_fs_info;
430 	struct dentry *index = NULL;
431 	struct dentry *this = NULL;
432 	struct inode *inode;
433 
434 	/*
435 	 * Decoding upper dir from index is expensive, so first try to lookup
436 	 * overlay dentry in inode/dcache.
437 	 */
438 	inode = ovl_lookup_inode(sb, real, !layer->idx);
439 	if (IS_ERR(inode))
440 		return ERR_CAST(inode);
441 	if (inode) {
442 		this = d_find_any_alias(inode);
443 		iput(inode);
444 	}
445 
446 	/*
447 	 * For decoded lower dir file handle, lookup index by origin to check
448 	 * if lower dir was copied up and and/or removed.
449 	 */
450 	if (!this && layer->idx && ofs->indexdir && !WARN_ON(!d_is_dir(real))) {
451 		index = ovl_lookup_index(ofs, NULL, real, false);
452 		if (IS_ERR(index))
453 			return index;
454 	}
455 
456 	/* Get connected upper overlay dir from index */
457 	if (index) {
458 		struct dentry *upper = ovl_index_upper(ofs, index);
459 
460 		dput(index);
461 		if (IS_ERR_OR_NULL(upper))
462 			return upper;
463 
464 		/*
465 		 * ovl_lookup_real() in lower layer may call recursively once to
466 		 * ovl_lookup_real() in upper layer. The first level call walks
467 		 * back lower parents to the topmost indexed parent. The second
468 		 * recursive call walks back from indexed upper to the topmost
469 		 * connected/hashed upper parent (or up to root).
470 		 */
471 		this = ovl_lookup_real(sb, upper, &ofs->layers[0]);
472 		dput(upper);
473 	}
474 
475 	if (IS_ERR_OR_NULL(this))
476 		return this;
477 
478 	if (ovl_dentry_real_at(this, layer->idx) != real) {
479 		dput(this);
480 		this = ERR_PTR(-EIO);
481 	}
482 
483 	return this;
484 }
485 
486 /*
487  * Lookup an indexed or hashed overlay dentry, whose real dentry is an
488  * ancestor of @real.
489  */
ovl_lookup_real_ancestor(struct super_block *sb, struct dentry *real, const struct ovl_layer *layer)490 static struct dentry *ovl_lookup_real_ancestor(struct super_block *sb,
491 					       struct dentry *real,
492 					       const struct ovl_layer *layer)
493 {
494 	struct dentry *next, *parent = NULL;
495 	struct dentry *ancestor = ERR_PTR(-EIO);
496 
497 	if (real == layer->mnt->mnt_root)
498 		return dget(sb->s_root);
499 
500 	/* Find the topmost indexed or hashed ancestor */
501 	next = dget(real);
502 	for (;;) {
503 		parent = dget_parent(next);
504 
505 		/*
506 		 * Lookup a matching overlay dentry in inode/dentry
507 		 * cache or in index by real inode.
508 		 */
509 		ancestor = ovl_lookup_real_inode(sb, next, layer);
510 		if (ancestor)
511 			break;
512 
513 		if (parent == layer->mnt->mnt_root) {
514 			ancestor = dget(sb->s_root);
515 			break;
516 		}
517 
518 		/*
519 		 * If @real has been moved out of the layer root directory,
520 		 * we will eventully hit the real fs root. This cannot happen
521 		 * by legit overlay rename, so we return error in that case.
522 		 */
523 		if (parent == next) {
524 			ancestor = ERR_PTR(-EXDEV);
525 			break;
526 		}
527 
528 		dput(next);
529 		next = parent;
530 	}
531 
532 	dput(parent);
533 	dput(next);
534 
535 	return ancestor;
536 }
537 
538 /*
539  * Lookup a connected overlay dentry whose real dentry is @real.
540  * If @real is on upper layer, we lookup a child overlay dentry with the same
541  * path the real dentry. Otherwise, we need to consult index for lookup.
542  */
ovl_lookup_real(struct super_block *sb, struct dentry *real, const struct ovl_layer *layer)543 static struct dentry *ovl_lookup_real(struct super_block *sb,
544 				      struct dentry *real,
545 				      const struct ovl_layer *layer)
546 {
547 	struct dentry *connected;
548 	int err = 0;
549 
550 	connected = ovl_lookup_real_ancestor(sb, real, layer);
551 	if (IS_ERR(connected))
552 		return connected;
553 
554 	while (!err) {
555 		struct dentry *next, *this;
556 		struct dentry *parent = NULL;
557 		struct dentry *real_connected = ovl_dentry_real_at(connected,
558 								   layer->idx);
559 
560 		if (real_connected == real)
561 			break;
562 
563 		/* Find the topmost dentry not yet connected */
564 		next = dget(real);
565 		for (;;) {
566 			parent = dget_parent(next);
567 
568 			if (parent == real_connected)
569 				break;
570 
571 			/*
572 			 * If real has been moved out of 'real_connected',
573 			 * we will not find 'real_connected' and hit the layer
574 			 * root. In that case, we need to restart connecting.
575 			 * This game can go on forever in the worst case. We
576 			 * may want to consider taking s_vfs_rename_mutex if
577 			 * this happens more than once.
578 			 */
579 			if (parent == layer->mnt->mnt_root) {
580 				dput(connected);
581 				connected = dget(sb->s_root);
582 				break;
583 			}
584 
585 			/*
586 			 * If real file has been moved out of the layer root
587 			 * directory, we will eventully hit the real fs root.
588 			 * This cannot happen by legit overlay rename, so we
589 			 * return error in that case.
590 			 */
591 			if (parent == next) {
592 				err = -EXDEV;
593 				break;
594 			}
595 
596 			dput(next);
597 			next = parent;
598 		}
599 
600 		if (!err) {
601 			this = ovl_lookup_real_one(connected, next, layer);
602 			if (IS_ERR(this))
603 				err = PTR_ERR(this);
604 
605 			/*
606 			 * Lookup of child in overlay can fail when racing with
607 			 * overlay rename of child away from 'connected' parent.
608 			 * In this case, we need to restart the lookup from the
609 			 * top, because we cannot trust that 'real_connected' is
610 			 * still an ancestor of 'real'. There is a good chance
611 			 * that the renamed overlay ancestor is now in cache, so
612 			 * ovl_lookup_real_ancestor() will find it and we can
613 			 * continue to connect exactly from where lookup failed.
614 			 */
615 			if (err == -ECHILD) {
616 				this = ovl_lookup_real_ancestor(sb, real,
617 								layer);
618 				err = PTR_ERR_OR_ZERO(this);
619 			}
620 			if (!err) {
621 				dput(connected);
622 				connected = this;
623 			}
624 		}
625 
626 		dput(parent);
627 		dput(next);
628 	}
629 
630 	if (err)
631 		goto fail;
632 
633 	return connected;
634 
635 fail:
636 	pr_warn_ratelimited("failed to lookup by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
637 			    real, layer->idx, connected, err);
638 	dput(connected);
639 	return ERR_PTR(err);
640 }
641 
642 /*
643  * Get an overlay dentry from upper/lower real dentries and index.
644  */
ovl_get_dentry(struct super_block *sb, struct dentry *upper, struct ovl_path *lowerpath, struct dentry *index)645 static struct dentry *ovl_get_dentry(struct super_block *sb,
646 				     struct dentry *upper,
647 				     struct ovl_path *lowerpath,
648 				     struct dentry *index)
649 {
650 	struct ovl_fs *ofs = sb->s_fs_info;
651 	const struct ovl_layer *layer = upper ? &ofs->layers[0] : lowerpath->layer;
652 	struct dentry *real = upper ?: (index ?: lowerpath->dentry);
653 
654 	/*
655 	 * Obtain a disconnected overlay dentry from a non-dir real dentry
656 	 * and index.
657 	 */
658 	if (!d_is_dir(real))
659 		return ovl_obtain_alias(sb, upper, lowerpath, index);
660 
661 	/* Removed empty directory? */
662 	if ((real->d_flags & DCACHE_DISCONNECTED) || d_unhashed(real))
663 		return ERR_PTR(-ENOENT);
664 
665 	/*
666 	 * If real dentry is connected and hashed, get a connected overlay
667 	 * dentry whose real dentry is @real.
668 	 */
669 	return ovl_lookup_real(sb, real, layer);
670 }
671 
ovl_upper_fh_to_d(struct super_block *sb, struct ovl_fh *fh)672 static struct dentry *ovl_upper_fh_to_d(struct super_block *sb,
673 					struct ovl_fh *fh)
674 {
675 	struct ovl_fs *ofs = sb->s_fs_info;
676 	struct dentry *dentry;
677 	struct dentry *upper;
678 
679 	if (!ovl_upper_mnt(ofs))
680 		return ERR_PTR(-EACCES);
681 
682 	upper = ovl_decode_real_fh(fh, ovl_upper_mnt(ofs), true);
683 	if (IS_ERR_OR_NULL(upper))
684 		return upper;
685 
686 	dentry = ovl_get_dentry(sb, upper, NULL, NULL);
687 	dput(upper);
688 
689 	return dentry;
690 }
691 
ovl_lower_fh_to_d(struct super_block *sb, struct ovl_fh *fh)692 static struct dentry *ovl_lower_fh_to_d(struct super_block *sb,
693 					struct ovl_fh *fh)
694 {
695 	struct ovl_fs *ofs = sb->s_fs_info;
696 	struct ovl_path origin = { };
697 	struct ovl_path *stack = &origin;
698 	struct dentry *dentry = NULL;
699 	struct dentry *index = NULL;
700 	struct inode *inode;
701 	int err;
702 
703 	/* First lookup overlay inode in inode cache by origin fh */
704 	err = ovl_check_origin_fh(ofs, fh, false, NULL, &stack);
705 	if (err)
706 		return ERR_PTR(err);
707 
708 	if (!d_is_dir(origin.dentry) ||
709 	    !(origin.dentry->d_flags & DCACHE_DISCONNECTED)) {
710 		inode = ovl_lookup_inode(sb, origin.dentry, false);
711 		err = PTR_ERR(inode);
712 		if (IS_ERR(inode))
713 			goto out_err;
714 		if (inode) {
715 			dentry = d_find_any_alias(inode);
716 			iput(inode);
717 			if (dentry)
718 				goto out;
719 		}
720 	}
721 
722 	/* Then lookup indexed upper/whiteout by origin fh */
723 	if (ofs->indexdir) {
724 		index = ovl_get_index_fh(ofs, fh);
725 		err = PTR_ERR(index);
726 		if (IS_ERR(index)) {
727 			index = NULL;
728 			goto out_err;
729 		}
730 	}
731 
732 	/* Then try to get a connected upper dir by index */
733 	if (index && d_is_dir(index)) {
734 		struct dentry *upper = ovl_index_upper(ofs, index);
735 
736 		err = PTR_ERR(upper);
737 		if (IS_ERR_OR_NULL(upper))
738 			goto out_err;
739 
740 		dentry = ovl_get_dentry(sb, upper, NULL, NULL);
741 		dput(upper);
742 		goto out;
743 	}
744 
745 	/* Find origin.dentry again with ovl_acceptable() layer check */
746 	if (d_is_dir(origin.dentry)) {
747 		dput(origin.dentry);
748 		origin.dentry = NULL;
749 		err = ovl_check_origin_fh(ofs, fh, true, NULL, &stack);
750 		if (err)
751 			goto out_err;
752 	}
753 	if (index) {
754 		err = ovl_verify_origin(ofs, index, origin.dentry, false);
755 		if (err)
756 			goto out_err;
757 	}
758 
759 	/* Get a connected non-upper dir or disconnected non-dir */
760 	dentry = ovl_get_dentry(sb, NULL, &origin, index);
761 
762 out:
763 	dput(origin.dentry);
764 	dput(index);
765 	return dentry;
766 
767 out_err:
768 	dentry = ERR_PTR(err);
769 	goto out;
770 }
771 
ovl_fid_to_fh(struct fid *fid, int buflen, int fh_type)772 static struct ovl_fh *ovl_fid_to_fh(struct fid *fid, int buflen, int fh_type)
773 {
774 	struct ovl_fh *fh;
775 
776 	/* If on-wire inner fid is aligned - nothing to do */
777 	if (fh_type == OVL_FILEID_V1)
778 		return (struct ovl_fh *)fid;
779 
780 	if (fh_type != OVL_FILEID_V0)
781 		return ERR_PTR(-EINVAL);
782 
783 	if (buflen <= OVL_FH_WIRE_OFFSET)
784 		return ERR_PTR(-EINVAL);
785 
786 	fh = kzalloc(buflen, GFP_KERNEL);
787 	if (!fh)
788 		return ERR_PTR(-ENOMEM);
789 
790 	/* Copy unaligned inner fh into aligned buffer */
791 	memcpy(&fh->fb, fid, buflen - OVL_FH_WIRE_OFFSET);
792 	return fh;
793 }
794 
ovl_fh_to_dentry(struct super_block *sb, struct fid *fid, int fh_len, int fh_type)795 static struct dentry *ovl_fh_to_dentry(struct super_block *sb, struct fid *fid,
796 				       int fh_len, int fh_type)
797 {
798 	struct dentry *dentry = NULL;
799 	struct ovl_fh *fh = NULL;
800 	int len = fh_len << 2;
801 	unsigned int flags = 0;
802 	int err;
803 
804 	fh = ovl_fid_to_fh(fid, len, fh_type);
805 	err = PTR_ERR(fh);
806 	if (IS_ERR(fh))
807 		goto out_err;
808 
809 	err = ovl_check_fh_len(fh, len);
810 	if (err)
811 		goto out_err;
812 
813 	flags = fh->fb.flags;
814 	dentry = (flags & OVL_FH_FLAG_PATH_UPPER) ?
815 		 ovl_upper_fh_to_d(sb, fh) :
816 		 ovl_lower_fh_to_d(sb, fh);
817 	err = PTR_ERR(dentry);
818 	if (IS_ERR(dentry) && err != -ESTALE)
819 		goto out_err;
820 
821 out:
822 	/* We may have needed to re-align OVL_FILEID_V0 */
823 	if (!IS_ERR_OR_NULL(fh) && fh != (void *)fid)
824 		kfree(fh);
825 
826 	return dentry;
827 
828 out_err:
829 	pr_warn_ratelimited("failed to decode file handle (len=%d, type=%d, flags=%x, err=%i)\n",
830 			    fh_len, fh_type, flags, err);
831 	dentry = ERR_PTR(err);
832 	goto out;
833 }
834 
ovl_fh_to_parent(struct super_block *sb, struct fid *fid, int fh_len, int fh_type)835 static struct dentry *ovl_fh_to_parent(struct super_block *sb, struct fid *fid,
836 				       int fh_len, int fh_type)
837 {
838 	pr_warn_ratelimited("connectable file handles not supported; use 'no_subtree_check' exportfs option.\n");
839 	return ERR_PTR(-EACCES);
840 }
841 
ovl_get_name(struct dentry *parent, char *name, struct dentry *child)842 static int ovl_get_name(struct dentry *parent, char *name,
843 			struct dentry *child)
844 {
845 	/*
846 	 * ovl_fh_to_dentry() returns connected dir overlay dentries and
847 	 * ovl_fh_to_parent() is not implemented, so we should not get here.
848 	 */
849 	WARN_ON_ONCE(1);
850 	return -EIO;
851 }
852 
ovl_get_parent(struct dentry *dentry)853 static struct dentry *ovl_get_parent(struct dentry *dentry)
854 {
855 	/*
856 	 * ovl_fh_to_dentry() returns connected dir overlay dentries, so we
857 	 * should not get here.
858 	 */
859 	WARN_ON_ONCE(1);
860 	return ERR_PTR(-EIO);
861 }
862 
863 const struct export_operations ovl_export_operations = {
864 	.encode_fh	= ovl_encode_fh,
865 	.fh_to_dentry	= ovl_fh_to_dentry,
866 	.fh_to_parent	= ovl_fh_to_parent,
867 	.get_name	= ovl_get_name,
868 	.get_parent	= ovl_get_parent,
869 };
870