1 // SPDX-License-Identifier: GPL-2.0-only
3 * Overlayfs NFS export support.
5 * Amir Goldstein <amir73il@gmail.com>
7 * Copyright (C) 2017-2018 CTERA Networks. All Rights Reserved.
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"
19 static int ovl_encode_maybe_copy_up(struct dentry *dentry)
23 if (ovl_dentry_upper(dentry))
26 err = ovl_want_write(dentry);
28 err = ovl_copy_up(dentry);
29 ovl_drop_write(dentry);
33 pr_warn_ratelimited("failed to copy up on encode (%pd2, err=%i)\n",
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:
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.
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.
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":
72 * layer 1: /A (redirect = /a)
76 /* Return the lowest layer for encoding a connectable file handle */
77 static int ovl_connectable_layer(struct dentry *dentry)
79 struct ovl_entry *oe = OVL_E(dentry);
81 /* We can get overlay root from root of any layer */
82 if (dentry == dentry->d_sb->s_root)
86 * If it's an unindexed merge dir, then it's not connectable with any
89 if (ovl_dentry_upper(dentry) &&
90 !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
93 /* We can get upper/overlay path from indexed/lower dentry */
94 return oe->lowerstack[0].layer->idx;
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.
103 * Return the connected origin layer or < 0 on error.
105 static int ovl_connect_layer(struct dentry *dentry)
107 struct dentry *next, *parent = NULL;
111 if (WARN_ON(dentry == dentry->d_sb->s_root) ||
112 WARN_ON(!ovl_dentry_lower(dentry)))
115 origin_layer = OVL_E(dentry)->lowerstack[0].layer->idx;
116 if (ovl_dentry_test_flag(OVL_E_CONNECTED, dentry))
119 /* Find the topmost origin layer connectable ancestor of @dentry */
122 parent = dget_parent(next);
123 if (WARN_ON(parent == next)) {
129 * If @parent is not origin layer connectable, then copy up
130 * @next which is origin layer connectable and we are done.
132 if (ovl_connectable_layer(parent) < origin_layer) {
133 err = ovl_encode_maybe_copy_up(next);
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)))
150 ovl_dentry_set_flag(OVL_E_CONNECTED, dentry);
152 return err ?: origin_layer;
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.
163 * The following table summarizes the different file handle encodings used for
164 * different overlay object types:
166 * Object type | Encoding
167 * --------------------------------
169 * Non-indexed upper | U
170 * Indexed upper | L (*)
173 * U = upper file handle
174 * L = lower file handle
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.
181 * Return 0 for upper file handle, > 0 for lower file handle or < 0 on error.
183 static int ovl_check_encode_origin(struct dentry *dentry)
185 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
187 /* Upper file handle for pure upper */
188 if (!ovl_dentry_lower(dentry))
192 * Upper file handle for non-indexed upper.
194 * Root is never indexed, so if there's an upper layer, encode upper for
197 if (ovl_dentry_upper(dentry) &&
198 !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
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.
207 if (d_is_dir(dentry) && ovl_upper_mnt(ofs))
208 return ovl_connect_layer(dentry);
210 /* Lower file handle for indexed and non-upper dir/non-dir */
214 static int ovl_dentry_to_fid(struct ovl_fs *ofs, struct dentry *dentry,
215 u32 *fid, int buflen)
217 struct ovl_fh *fh = NULL;
222 * Check if we should encode a lower or upper file handle and maybe
223 * copy up an ancestor to make lower file handle connectable.
225 err = enc_lower = ovl_check_encode_origin(dentry);
229 /* Encode an upper or lower file handle */
230 fh = ovl_encode_real_fh(ofs, enc_lower ? ovl_dentry_lower(dentry) :
231 ovl_dentry_upper(dentry), !enc_lower);
235 len = OVL_FH_LEN(fh);
237 memcpy(fid, fh, len);
245 pr_warn_ratelimited("failed to encode file handle (%pd2, err=%i)\n",
250 static int ovl_encode_fh(struct inode *inode, u32 *fid, int *max_len,
251 struct inode *parent)
253 struct ovl_fs *ofs = OVL_FS(inode->i_sb);
254 struct dentry *dentry;
255 int bytes, buflen = *max_len << 2;
257 /* TODO: encode connectable file handles */
259 return FILEID_INVALID;
261 dentry = d_find_any_alias(inode);
263 return FILEID_INVALID;
265 bytes = ovl_dentry_to_fid(ofs, dentry, fid, buflen);
268 return FILEID_INVALID;
270 *max_len = bytes >> 2;
272 return FILEID_INVALID;
274 return OVL_FILEID_V1;
278 * Find or instantiate an overlay dentry from real dentries and index.
280 static struct dentry *ovl_obtain_alias(struct super_block *sb,
281 struct dentry *upper_alias,
282 struct ovl_path *lowerpath,
283 struct dentry *index)
285 struct dentry *lower = lowerpath ? lowerpath->dentry : NULL;
286 struct dentry *upper = upper_alias ?: index;
287 struct dentry *dentry;
289 struct ovl_entry *oe;
290 struct ovl_inode_params oip = {
291 .lowerpath = lowerpath,
296 /* We get overlay directory dentries with ovl_lookup_real() */
297 if (d_is_dir(upper ?: lower))
298 return ERR_PTR(-EIO);
300 oip.upperdentry = dget(upper);
301 inode = ovl_get_inode(sb, &oip);
304 return ERR_CAST(inode);
308 ovl_set_flag(OVL_UPPERDATA, inode);
310 dentry = d_find_any_alias(inode);
314 dentry = d_alloc_anon(inode->i_sb);
315 if (unlikely(!dentry))
317 oe = ovl_alloc_entry(lower ? 1 : 0);
322 oe->lowerstack->dentry = dget(lower);
323 oe->lowerstack->layer = lowerpath->layer;
325 dentry->d_fsdata = oe;
327 ovl_dentry_set_upper_alias(dentry);
329 ovl_dentry_init_reval(dentry, upper);
331 return d_instantiate_anon(dentry, inode);
335 dentry = ERR_PTR(-ENOMEM);
341 /* Get the upper or lower dentry in stach whose on layer @idx */
342 static struct dentry *ovl_dentry_real_at(struct dentry *dentry, int idx)
344 struct ovl_entry *oe = dentry->d_fsdata;
348 return ovl_dentry_upper(dentry);
350 for (i = 0; i < oe->numlower; i++) {
351 if (oe->lowerstack[i].layer->idx == idx)
352 return oe->lowerstack[i].dentry;
359 * Lookup a child overlay dentry to get a connected overlay dentry whose real
360 * dentry is @real. If @real is on upper layer, we lookup a child overlay
361 * dentry with the same name as the real dentry. Otherwise, we need to consult
364 static struct dentry *ovl_lookup_real_one(struct dentry *connected,
366 const struct ovl_layer *layer)
368 struct inode *dir = d_inode(connected);
369 struct dentry *this, *parent = NULL;
370 struct name_snapshot name;
374 * Lookup child overlay dentry by real name. The dir mutex protects us
375 * from racing with overlay rename. If the overlay dentry that is above
376 * real has already been moved to a parent that is not under the
377 * connected overlay dir, we return -ECHILD and restart the lookup of
378 * connected real path from the top.
380 inode_lock_nested(dir, I_MUTEX_PARENT);
382 parent = dget_parent(real);
383 if (ovl_dentry_real_at(connected, layer->idx) != parent)
387 * We also need to take a snapshot of real dentry name to protect us
388 * from racing with underlying layer rename. In this case, we don't
389 * care about returning ESTALE, only from dereferencing a free name
390 * pointer because we hold no lock on the real dentry.
392 take_dentry_name_snapshot(&name, real);
393 this = lookup_one_len(name.name.name, connected, name.name.len);
394 release_dentry_name_snapshot(&name);
398 } else if (!this || !this->d_inode) {
402 } else if (ovl_dentry_real_at(this, layer->idx) != real) {
414 pr_warn_ratelimited("failed to lookup one by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
415 real, layer->idx, connected, err);
420 static struct dentry *ovl_lookup_real(struct super_block *sb,
422 const struct ovl_layer *layer);
425 * Lookup an indexed or hashed overlay dentry by real inode.
427 static struct dentry *ovl_lookup_real_inode(struct super_block *sb,
429 const struct ovl_layer *layer)
431 struct ovl_fs *ofs = sb->s_fs_info;
432 struct dentry *index = NULL;
433 struct dentry *this = NULL;
437 * Decoding upper dir from index is expensive, so first try to lookup
438 * overlay dentry in inode/dcache.
440 inode = ovl_lookup_inode(sb, real, !layer->idx);
442 return ERR_CAST(inode);
444 this = d_find_any_alias(inode);
449 * For decoded lower dir file handle, lookup index by origin to check
450 * if lower dir was copied up and and/or removed.
452 if (!this && layer->idx && ofs->indexdir && !WARN_ON(!d_is_dir(real))) {
453 index = ovl_lookup_index(ofs, NULL, real, false);
458 /* Get connected upper overlay dir from index */
460 struct dentry *upper = ovl_index_upper(ofs, index);
463 if (IS_ERR_OR_NULL(upper))
467 * ovl_lookup_real() in lower layer may call recursively once to
468 * ovl_lookup_real() in upper layer. The first level call walks
469 * back lower parents to the topmost indexed parent. The second
470 * recursive call walks back from indexed upper to the topmost
471 * connected/hashed upper parent (or up to root).
473 this = ovl_lookup_real(sb, upper, &ofs->layers[0]);
477 if (IS_ERR_OR_NULL(this))
480 if (ovl_dentry_real_at(this, layer->idx) != real) {
482 this = ERR_PTR(-EIO);
489 * Lookup an indexed or hashed overlay dentry, whose real dentry is an
492 static struct dentry *ovl_lookup_real_ancestor(struct super_block *sb,
494 const struct ovl_layer *layer)
496 struct dentry *next, *parent = NULL;
497 struct dentry *ancestor = ERR_PTR(-EIO);
499 if (real == layer->mnt->mnt_root)
500 return dget(sb->s_root);
502 /* Find the topmost indexed or hashed ancestor */
505 parent = dget_parent(next);
508 * Lookup a matching overlay dentry in inode/dentry
509 * cache or in index by real inode.
511 ancestor = ovl_lookup_real_inode(sb, next, layer);
515 if (parent == layer->mnt->mnt_root) {
516 ancestor = dget(sb->s_root);
521 * If @real has been moved out of the layer root directory,
522 * we will eventully hit the real fs root. This cannot happen
523 * by legit overlay rename, so we return error in that case.
525 if (parent == next) {
526 ancestor = ERR_PTR(-EXDEV);
541 * Lookup a connected overlay dentry whose real dentry is @real.
542 * If @real is on upper layer, we lookup a child overlay dentry with the same
543 * path the real dentry. Otherwise, we need to consult index for lookup.
545 static struct dentry *ovl_lookup_real(struct super_block *sb,
547 const struct ovl_layer *layer)
549 struct dentry *connected;
552 connected = ovl_lookup_real_ancestor(sb, real, layer);
553 if (IS_ERR(connected))
557 struct dentry *next, *this;
558 struct dentry *parent = NULL;
559 struct dentry *real_connected = ovl_dentry_real_at(connected,
562 if (real_connected == real)
565 /* Find the topmost dentry not yet connected */
568 parent = dget_parent(next);
570 if (parent == real_connected)
574 * If real has been moved out of 'real_connected',
575 * we will not find 'real_connected' and hit the layer
576 * root. In that case, we need to restart connecting.
577 * This game can go on forever in the worst case. We
578 * may want to consider taking s_vfs_rename_mutex if
579 * this happens more than once.
581 if (parent == layer->mnt->mnt_root) {
583 connected = dget(sb->s_root);
588 * If real file has been moved out of the layer root
589 * directory, we will eventully hit the real fs root.
590 * This cannot happen by legit overlay rename, so we
591 * return error in that case.
593 if (parent == next) {
603 this = ovl_lookup_real_one(connected, next, layer);
608 * Lookup of child in overlay can fail when racing with
609 * overlay rename of child away from 'connected' parent.
610 * In this case, we need to restart the lookup from the
611 * top, because we cannot trust that 'real_connected' is
612 * still an ancestor of 'real'. There is a good chance
613 * that the renamed overlay ancestor is now in cache, so
614 * ovl_lookup_real_ancestor() will find it and we can
615 * continue to connect exactly from where lookup failed.
617 if (err == -ECHILD) {
618 this = ovl_lookup_real_ancestor(sb, real,
620 err = PTR_ERR_OR_ZERO(this);
638 pr_warn_ratelimited("failed to lookup by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
639 real, layer->idx, connected, err);
645 * Get an overlay dentry from upper/lower real dentries and index.
647 static struct dentry *ovl_get_dentry(struct super_block *sb,
648 struct dentry *upper,
649 struct ovl_path *lowerpath,
650 struct dentry *index)
652 struct ovl_fs *ofs = sb->s_fs_info;
653 const struct ovl_layer *layer = upper ? &ofs->layers[0] : lowerpath->layer;
654 struct dentry *real = upper ?: (index ?: lowerpath->dentry);
657 * Obtain a disconnected overlay dentry from a non-dir real dentry
661 return ovl_obtain_alias(sb, upper, lowerpath, index);
663 /* Removed empty directory? */
664 if ((real->d_flags & DCACHE_DISCONNECTED) || d_unhashed(real))
665 return ERR_PTR(-ENOENT);
668 * If real dentry is connected and hashed, get a connected overlay
669 * dentry whose real dentry is @real.
671 return ovl_lookup_real(sb, real, layer);
674 static struct dentry *ovl_upper_fh_to_d(struct super_block *sb,
677 struct ovl_fs *ofs = sb->s_fs_info;
678 struct dentry *dentry;
679 struct dentry *upper;
681 if (!ovl_upper_mnt(ofs))
682 return ERR_PTR(-EACCES);
684 upper = ovl_decode_real_fh(ofs, fh, ovl_upper_mnt(ofs), true);
685 if (IS_ERR_OR_NULL(upper))
688 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
694 static struct dentry *ovl_lower_fh_to_d(struct super_block *sb,
697 struct ovl_fs *ofs = sb->s_fs_info;
698 struct ovl_path origin = { };
699 struct ovl_path *stack = &origin;
700 struct dentry *dentry = NULL;
701 struct dentry *index = NULL;
705 /* First lookup overlay inode in inode cache by origin fh */
706 err = ovl_check_origin_fh(ofs, fh, false, NULL, &stack);
710 if (!d_is_dir(origin.dentry) ||
711 !(origin.dentry->d_flags & DCACHE_DISCONNECTED)) {
712 inode = ovl_lookup_inode(sb, origin.dentry, false);
713 err = PTR_ERR(inode);
717 dentry = d_find_any_alias(inode);
724 /* Then lookup indexed upper/whiteout by origin fh */
726 index = ovl_get_index_fh(ofs, fh);
727 err = PTR_ERR(index);
734 /* Then try to get a connected upper dir by index */
735 if (index && d_is_dir(index)) {
736 struct dentry *upper = ovl_index_upper(ofs, index);
738 err = PTR_ERR(upper);
739 if (IS_ERR_OR_NULL(upper))
742 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
747 /* Find origin.dentry again with ovl_acceptable() layer check */
748 if (d_is_dir(origin.dentry)) {
750 origin.dentry = NULL;
751 err = ovl_check_origin_fh(ofs, fh, true, NULL, &stack);
756 err = ovl_verify_origin(ofs, index, origin.dentry, false);
761 /* Get a connected non-upper dir or disconnected non-dir */
762 dentry = ovl_get_dentry(sb, NULL, &origin, index);
770 dentry = ERR_PTR(err);
774 static struct ovl_fh *ovl_fid_to_fh(struct fid *fid, int buflen, int fh_type)
778 /* If on-wire inner fid is aligned - nothing to do */
779 if (fh_type == OVL_FILEID_V1)
780 return (struct ovl_fh *)fid;
782 if (fh_type != OVL_FILEID_V0)
783 return ERR_PTR(-EINVAL);
785 if (buflen <= OVL_FH_WIRE_OFFSET)
786 return ERR_PTR(-EINVAL);
788 fh = kzalloc(buflen, GFP_KERNEL);
790 return ERR_PTR(-ENOMEM);
792 /* Copy unaligned inner fh into aligned buffer */
793 memcpy(fh->buf, fid, buflen - OVL_FH_WIRE_OFFSET);
797 static struct dentry *ovl_fh_to_dentry(struct super_block *sb, struct fid *fid,
798 int fh_len, int fh_type)
800 struct dentry *dentry = NULL;
801 struct ovl_fh *fh = NULL;
802 int len = fh_len << 2;
803 unsigned int flags = 0;
806 fh = ovl_fid_to_fh(fid, len, fh_type);
811 err = ovl_check_fh_len(fh, len);
815 flags = fh->fb.flags;
816 dentry = (flags & OVL_FH_FLAG_PATH_UPPER) ?
817 ovl_upper_fh_to_d(sb, fh) :
818 ovl_lower_fh_to_d(sb, fh);
819 err = PTR_ERR(dentry);
820 if (IS_ERR(dentry) && err != -ESTALE)
824 /* We may have needed to re-align OVL_FILEID_V0 */
825 if (!IS_ERR_OR_NULL(fh) && fh != (void *)fid)
831 pr_warn_ratelimited("failed to decode file handle (len=%d, type=%d, flags=%x, err=%i)\n",
832 fh_len, fh_type, flags, err);
833 dentry = ERR_PTR(err);
837 static struct dentry *ovl_fh_to_parent(struct super_block *sb, struct fid *fid,
838 int fh_len, int fh_type)
840 pr_warn_ratelimited("connectable file handles not supported; use 'no_subtree_check' exportfs option.\n");
841 return ERR_PTR(-EACCES);
844 static int ovl_get_name(struct dentry *parent, char *name,
845 struct dentry *child)
848 * ovl_fh_to_dentry() returns connected dir overlay dentries and
849 * ovl_fh_to_parent() is not implemented, so we should not get here.
855 static struct dentry *ovl_get_parent(struct dentry *dentry)
858 * ovl_fh_to_dentry() returns connected dir overlay dentries, so we
859 * should not get here.
862 return ERR_PTR(-EIO);
865 const struct export_operations ovl_export_operations = {
866 .encode_fh = ovl_encode_fh,
867 .fh_to_dentry = ovl_fh_to_dentry,
868 .fh_to_parent = ovl_fh_to_parent,
869 .get_name = ovl_get_name,
870 .get_parent = ovl_get_parent,