blob: 7e16bbcad95e631921b5fe5fe97d220dc10fa08a [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Amir Goldstein8ed5eec2017-07-12 14:17:16 +03002/*
3 * Overlayfs NFS export support.
4 *
5 * Amir Goldstein <amir73il@gmail.com>
6 *
7 * Copyright (C) 2017-2018 CTERA Networks. All Rights Reserved.
Amir Goldstein8ed5eec2017-07-12 14:17:16 +03008 */
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
Amir Goldstein2ca3c142018-01-30 13:31:09 +020019static int ovl_encode_maybe_copy_up(struct dentry *dentry)
20{
21 int err;
22
23 if (ovl_dentry_upper(dentry))
24 return 0;
25
Amir Goldstein162d0642023-07-20 12:51:21 +030026 err = ovl_copy_up(dentry);
Amir Goldstein2ca3c142018-01-30 13:31:09 +020027 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +080028 pr_warn_ratelimited("failed to copy up on encode (%pd2, err=%i)\n",
Amir Goldstein2ca3c142018-01-30 13:31:09 +020029 dentry, err);
30 }
31
32 return err;
33}
34
35/*
36 * Before encoding a non-upper directory file handle from real layer N, we need
37 * to check if it will be possible to reconnect an overlay dentry from the real
38 * lower decoded dentry. This is done by following the overlay ancestry up to a
39 * "layer N connected" ancestor and verifying that all parents along the way are
40 * "layer N connectable". If an ancestor that is NOT "layer N connectable" is
41 * found, we need to copy up an ancestor, which is "layer N connectable", thus
42 * making that ancestor "layer N connected". For example:
43 *
44 * layer 1: /a
45 * layer 2: /a/b/c
46 *
47 * The overlay dentry /a is NOT "layer 2 connectable", because if dir /a is
48 * copied up and renamed, upper dir /a will be indexed by lower dir /a from
49 * layer 1. The dir /a from layer 2 will never be indexed, so the algorithm (*)
50 * in ovl_lookup_real_ancestor() will not be able to lookup a connected overlay
51 * dentry from the connected lower dentry /a/b/c.
52 *
53 * To avoid this problem on decode time, we need to copy up an ancestor of
54 * /a/b/c, which is "layer 2 connectable", on encode time. That ancestor is
55 * /a/b. After copy up (and index) of /a/b, it will become "layer 2 connected"
56 * and when the time comes to decode the file handle from lower dentry /a/b/c,
57 * ovl_lookup_real_ancestor() will find the indexed ancestor /a/b and decoding
58 * a connected overlay dentry will be accomplished.
59 *
60 * (*) the algorithm in ovl_lookup_real_ancestor() can be improved to lookup an
61 * entry /a in the lower layers above layer N and find the indexed dir /a from
62 * layer 1. If that improvement is made, then the check for "layer N connected"
63 * will need to verify there are no redirects in lower layers above N. In the
64 * example above, /a will be "layer 2 connectable". However, if layer 2 dir /a
65 * is a target of a layer 1 redirect, then /a will NOT be "layer 2 connectable":
66 *
67 * layer 1: /A (redirect = /a)
68 * layer 2: /a/b/c
69 */
70
71/* Return the lowest layer for encoding a connectable file handle */
72static int ovl_connectable_layer(struct dentry *dentry)
73{
74 struct ovl_entry *oe = OVL_E(dentry);
75
76 /* We can get overlay root from root of any layer */
77 if (dentry == dentry->d_sb->s_root)
Amir Goldstein5522c9c2023-04-03 11:51:47 +030078 return ovl_numlower(oe);
Amir Goldstein2ca3c142018-01-30 13:31:09 +020079
80 /*
81 * If it's an unindexed merge dir, then it's not connectable with any
82 * lower layer
83 */
84 if (ovl_dentry_upper(dentry) &&
85 !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
86 return 0;
87
88 /* We can get upper/overlay path from indexed/lower dentry */
Amir Goldstein5522c9c2023-04-03 11:51:47 +030089 return ovl_lowerstack(oe)->layer->idx;
Amir Goldstein2ca3c142018-01-30 13:31:09 +020090}
91
92/*
93 * @dentry is "connected" if all ancestors up to root or a "connected" ancestor
94 * have the same uppermost lower layer as the origin's layer. We may need to
95 * copy up a "connectable" ancestor to make it "connected". A "connected" dentry
96 * cannot become non "connected", so cache positive result in dentry flags.
97 *
98 * Return the connected origin layer or < 0 on error.
99 */
100static int ovl_connect_layer(struct dentry *dentry)
101{
102 struct dentry *next, *parent = NULL;
Amir Goldstein5522c9c2023-04-03 11:51:47 +0300103 struct ovl_entry *oe = OVL_E(dentry);
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200104 int origin_layer;
105 int err = 0;
106
107 if (WARN_ON(dentry == dentry->d_sb->s_root) ||
108 WARN_ON(!ovl_dentry_lower(dentry)))
109 return -EIO;
110
Amir Goldstein5522c9c2023-04-03 11:51:47 +0300111 origin_layer = ovl_lowerstack(oe)->layer->idx;
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200112 if (ovl_dentry_test_flag(OVL_E_CONNECTED, dentry))
113 return origin_layer;
114
115 /* Find the topmost origin layer connectable ancestor of @dentry */
116 next = dget(dentry);
117 for (;;) {
118 parent = dget_parent(next);
119 if (WARN_ON(parent == next)) {
120 err = -EIO;
121 break;
122 }
123
124 /*
125 * If @parent is not origin layer connectable, then copy up
126 * @next which is origin layer connectable and we are done.
127 */
128 if (ovl_connectable_layer(parent) < origin_layer) {
129 err = ovl_encode_maybe_copy_up(next);
130 break;
131 }
132
133 /* If @parent is connected or indexed we are done */
134 if (ovl_dentry_test_flag(OVL_E_CONNECTED, parent) ||
135 ovl_test_flag(OVL_INDEX, d_inode(parent)))
136 break;
137
138 dput(next);
139 next = parent;
140 }
141
142 dput(parent);
143 dput(next);
144
145 if (!err)
146 ovl_dentry_set_flag(OVL_E_CONNECTED, dentry);
147
148 return err ?: origin_layer;
149}
150
Amir Goldsteinb305e842018-01-18 13:14:55 +0200151/*
152 * We only need to encode origin if there is a chance that the same object was
153 * encoded pre copy up and then we need to stay consistent with the same
154 * encoding also after copy up. If non-pure upper is not indexed, then it was
155 * copied up before NFS export was enabled. In that case we don't need to worry
156 * about staying consistent with pre copy up encoding and we encode an upper
157 * file handle. Overlay root dentry is a private case of non-indexed upper.
158 *
159 * The following table summarizes the different file handle encodings used for
160 * different overlay object types:
161 *
162 * Object type | Encoding
163 * --------------------------------
164 * Pure upper | U
165 * Non-indexed upper | U
Amir Goldstein05e1f112018-01-18 13:15:26 +0200166 * Indexed upper | L (*)
167 * Non-upper | L (*)
Amir Goldsteinb305e842018-01-18 13:14:55 +0200168 *
169 * U = upper file handle
170 * L = lower file handle
Amir Goldstein05e1f112018-01-18 13:15:26 +0200171 *
Amir Goldstein16aac5a2023-04-23 19:02:04 +0300172 * (*) Decoding a connected overlay dir from real lower dentry is not always
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200173 * possible when there are redirects in lower layers and non-indexed merge dirs.
174 * To mitigate those case, we may copy up the lower dir ancestor before encode
Amir Goldstein16aac5a2023-04-23 19:02:04 +0300175 * of a decodable file handle for non-upper dir.
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200176 *
177 * Return 0 for upper file handle, > 0 for lower file handle or < 0 on error.
Amir Goldsteinb305e842018-01-18 13:14:55 +0200178 */
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200179static int ovl_check_encode_origin(struct dentry *dentry)
Amir Goldsteinb305e842018-01-18 13:14:55 +0200180{
Andrea Righif01d0882023-05-21 10:28:12 +0200181 struct ovl_fs *ofs = OVL_FS(dentry->d_sb);
Amir Goldstein16aac5a2023-04-23 19:02:04 +0300182 bool decodable = ofs->config.nfs_export;
183
184 /* Lower file handle for non-upper non-decodable */
185 if (!ovl_dentry_upper(dentry) && !decodable)
Amir Goldsteinc7242a42023-10-03 09:21:27 +0300186 return 1;
Amir Goldstein05e1f112018-01-18 13:15:26 +0200187
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200188 /* Upper file handle for pure upper */
Amir Goldsteinb305e842018-01-18 13:14:55 +0200189 if (!ovl_dentry_lower(dentry))
Amir Goldstein05e1f112018-01-18 13:15:26 +0200190 return 0;
191
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200192 /*
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200193 * Root is never indexed, so if there's an upper layer, encode upper for
194 * root.
195 */
Amir Goldstein16aac5a2023-04-23 19:02:04 +0300196 if (dentry == dentry->d_sb->s_root)
197 return 0;
198
199 /*
200 * Upper decodable file handle for non-indexed upper.
201 */
202 if (ovl_dentry_upper(dentry) && decodable &&
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200203 !ovl_test_flag(OVL_INDEX, d_inode(dentry)))
204 return 0;
Amir Goldstein05e1f112018-01-18 13:15:26 +0200205
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200206 /*
207 * Decoding a merge dir, whose origin's ancestor is under a redirected
208 * lower dir or under a non-indexed upper is not always possible.
209 * ovl_connect_layer() will try to make origin's layer "connected" by
210 * copying up a "connectable" ancestor.
211 */
Amir Goldstein16aac5a2023-04-23 19:02:04 +0300212 if (d_is_dir(dentry) && ovl_upper_mnt(ofs) && decodable)
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200213 return ovl_connect_layer(dentry);
Amir Goldstein05e1f112018-01-18 13:15:26 +0200214
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200215 /* Lower file handle for indexed and non-upper dir/non-dir */
216 return 1;
Amir Goldstein05e1f112018-01-18 13:15:26 +0200217}
218
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300219static int ovl_dentry_to_fid(struct ovl_fs *ofs, struct dentry *dentry,
220 u32 *fid, int buflen)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300221{
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300222 struct ovl_fh *fh = NULL;
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200223 int err, enc_lower;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200224 int len;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300225
Amir Goldstein05e1f112018-01-18 13:15:26 +0200226 /*
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200227 * Check if we should encode a lower or upper file handle and maybe
228 * copy up an ancestor to make lower file handle connectable.
Amir Goldstein05e1f112018-01-18 13:15:26 +0200229 */
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200230 err = enc_lower = ovl_check_encode_origin(dentry);
231 if (enc_lower < 0)
232 goto fail;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300233
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200234 /* Encode an upper or lower file handle */
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300235 fh = ovl_encode_real_fh(ofs, enc_lower ? ovl_dentry_lower(dentry) :
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200236 ovl_dentry_upper(dentry), !enc_lower);
Amir Goldstein9b6faee2018-01-30 13:54:45 +0200237 if (IS_ERR(fh))
Ding Xiang97f024b2019-09-09 16:29:56 +0800238 return PTR_ERR(fh);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300239
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200240 len = OVL_FH_LEN(fh);
Lubos Dolezel144da232020-05-04 21:35:09 +0200241 if (len <= buflen)
242 memcpy(fid, fh, len);
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200243 err = len;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300244
245out:
246 kfree(fh);
247 return err;
248
249fail:
Lubos Dolezel144da232020-05-04 21:35:09 +0200250 pr_warn_ratelimited("failed to encode file handle (%pd2, err=%i)\n",
251 dentry, err);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300252 goto out;
253}
254
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200255static int ovl_encode_fh(struct inode *inode, u32 *fid, int *max_len,
256 struct inode *parent)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300257{
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300258 struct ovl_fs *ofs = OVL_FS(inode->i_sb);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300259 struct dentry *dentry;
Lubos Dolezel144da232020-05-04 21:35:09 +0200260 int bytes, buflen = *max_len << 2;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300261
262 /* TODO: encode connectable file handles */
263 if (parent)
264 return FILEID_INVALID;
265
266 dentry = d_find_any_alias(inode);
Jiachen Zhangdd524b72022-07-28 19:49:15 +0800267 if (!dentry)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300268 return FILEID_INVALID;
269
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300270 bytes = ovl_dentry_to_fid(ofs, dentry, fid, buflen);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300271 dput(dentry);
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200272 if (bytes <= 0)
273 return FILEID_INVALID;
274
275 *max_len = bytes >> 2;
Lubos Dolezel144da232020-05-04 21:35:09 +0200276 if (bytes > buflen)
277 return FILEID_INVALID;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200278
279 return OVL_FILEID_V1;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300280}
281
Amir Goldstein8556a422018-01-19 01:03:23 +0200282/*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200283 * Find or instantiate an overlay dentry from real dentries and index.
Amir Goldstein8556a422018-01-19 01:03:23 +0200284 */
285static struct dentry *ovl_obtain_alias(struct super_block *sb,
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200286 struct dentry *upper_alias,
287 struct ovl_path *lowerpath,
288 struct dentry *index)
Amir Goldstein8556a422018-01-19 01:03:23 +0200289{
Amir Goldsteinf9418662018-01-19 21:33:44 +0200290 struct dentry *lower = lowerpath ? lowerpath->dentry : NULL;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200291 struct dentry *upper = upper_alias ?: index;
Amir Goldstein8556a422018-01-19 01:03:23 +0200292 struct dentry *dentry;
Amir Goldstein0af950f2023-04-08 12:31:13 +0300293 struct inode *inode = NULL;
Amir Goldstein8556a422018-01-19 01:03:23 +0200294 struct ovl_entry *oe;
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400295 struct ovl_inode_params oip = {
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400296 .index = index,
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400297 };
Amir Goldstein8556a422018-01-19 01:03:23 +0200298
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200299 /* We get overlay directory dentries with ovl_lookup_real() */
300 if (d_is_dir(upper ?: lower))
Amir Goldstein8556a422018-01-19 01:03:23 +0200301 return ERR_PTR(-EIO);
302
Amir Goldstein0af950f2023-04-08 12:31:13 +0300303 oe = ovl_alloc_entry(!!lower);
304 if (!oe)
305 return ERR_PTR(-ENOMEM);
306
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400307 oip.upperdentry = dget(upper);
Amir Goldstein0af950f2023-04-08 12:31:13 +0300308 if (lower) {
309 ovl_lowerstack(oe)->dentry = dget(lower);
310 ovl_lowerstack(oe)->layer = lowerpath->layer;
311 }
312 oip.oe = oe;
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400313 inode = ovl_get_inode(sb, &oip);
Amir Goldstein8556a422018-01-19 01:03:23 +0200314 if (IS_ERR(inode)) {
Amir Goldstein0af950f2023-04-08 12:31:13 +0300315 ovl_free_entry(oe);
Amir Goldstein8556a422018-01-19 01:03:23 +0200316 dput(upper);
317 return ERR_CAST(inode);
318 }
319
Vivek Goyal9d3dfea2018-05-11 11:49:28 -0400320 if (upper)
321 ovl_set_flag(OVL_UPPERDATA, inode);
322
Amir Goldstein8556a422018-01-19 01:03:23 +0200323 dentry = d_find_any_alias(inode);
Al Viro504f3842019-10-24 02:06:45 +0100324 if (dentry)
325 goto out_iput;
Amir Goldstein8556a422018-01-19 01:03:23 +0200326
Al Viro504f3842019-10-24 02:06:45 +0100327 dentry = d_alloc_anon(inode->i_sb);
328 if (unlikely(!dentry))
329 goto nomem;
Al Viro504f3842019-10-24 02:06:45 +0100330
Al Viro504f3842019-10-24 02:06:45 +0100331 if (upper_alias)
332 ovl_dentry_set_upper_alias(dentry);
333
Amir Goldstein0af950f2023-04-08 12:31:13 +0300334 ovl_dentry_init_reval(dentry, upper, OVL_I_E(inode));
Amir Goldstein8556a422018-01-19 01:03:23 +0200335
336 return d_instantiate_anon(dentry, inode);
337
338nomem:
Amir Goldstein8556a422018-01-19 01:03:23 +0200339 dput(dentry);
Al Viro504f3842019-10-24 02:06:45 +0100340 dentry = ERR_PTR(-ENOMEM);
341out_iput:
342 iput(inode);
343 return dentry;
Amir Goldstein8556a422018-01-19 01:03:23 +0200344}
345
Jiangshan Yicdf5c9d2022-09-05 13:47:36 +0800346/* Get the upper or lower dentry in stack whose on layer @idx */
Amir Goldstein98892512018-01-17 22:32:44 +0200347static struct dentry *ovl_dentry_real_at(struct dentry *dentry, int idx)
348{
Amir Goldsteina6ff2bc2023-03-15 04:31:37 +0200349 struct ovl_entry *oe = OVL_E(dentry);
Amir Goldstein5522c9c2023-04-03 11:51:47 +0300350 struct ovl_path *lowerstack = ovl_lowerstack(oe);
Amir Goldstein98892512018-01-17 22:32:44 +0200351 int i;
352
353 if (!idx)
354 return ovl_dentry_upper(dentry);
355
Amir Goldstein5522c9c2023-04-03 11:51:47 +0300356 for (i = 0; i < ovl_numlower(oe); i++) {
357 if (lowerstack[i].layer->idx == idx)
358 return lowerstack[i].dentry;
Amir Goldstein98892512018-01-17 22:32:44 +0200359 }
360
361 return NULL;
362}
363
Amir Goldstein3985b702017-12-28 18:36:16 +0200364/*
365 * Lookup a child overlay dentry to get a connected overlay dentry whose real
366 * dentry is @real. If @real is on upper layer, we lookup a child overlay
367 * dentry with the same name as the real dentry. Otherwise, we need to consult
368 * index for lookup.
369 */
370static struct dentry *ovl_lookup_real_one(struct dentry *connected,
371 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100372 const struct ovl_layer *layer)
Amir Goldstein3985b702017-12-28 18:36:16 +0200373{
374 struct inode *dir = d_inode(connected);
375 struct dentry *this, *parent = NULL;
376 struct name_snapshot name;
377 int err;
378
Amir Goldstein3985b702017-12-28 18:36:16 +0200379 /*
380 * Lookup child overlay dentry by real name. The dir mutex protects us
381 * from racing with overlay rename. If the overlay dentry that is above
382 * real has already been moved to a parent that is not under the
383 * connected overlay dir, we return -ECHILD and restart the lookup of
384 * connected real path from the top.
385 */
386 inode_lock_nested(dir, I_MUTEX_PARENT);
387 err = -ECHILD;
388 parent = dget_parent(real);
Amir Goldstein98892512018-01-17 22:32:44 +0200389 if (ovl_dentry_real_at(connected, layer->idx) != parent)
Amir Goldstein3985b702017-12-28 18:36:16 +0200390 goto fail;
391
392 /*
393 * We also need to take a snapshot of real dentry name to protect us
394 * from racing with underlying layer rename. In this case, we don't
395 * care about returning ESTALE, only from dereferencing a free name
396 * pointer because we hold no lock on the real dentry.
397 */
398 take_dentry_name_snapshot(&name, real);
Christian Braunerba9ea772022-04-04 12:51:52 +0200399 /*
Christian Brauner4609e1f2023-01-13 12:49:22 +0100400 * No idmap handling here: it's an internal lookup. Could skip
401 * permission checking altogether, but for now just use non-idmap
Christian Braunerba9ea772022-04-04 12:51:52 +0200402 * transformed ids.
403 */
Al Viro230c6402019-04-26 13:07:27 -0400404 this = lookup_one_len(name.name.name, connected, name.name.len);
Miklos Szeredi580c6102021-08-06 10:03:12 +0200405 release_dentry_name_snapshot(&name);
Amir Goldstein3985b702017-12-28 18:36:16 +0200406 err = PTR_ERR(this);
407 if (IS_ERR(this)) {
408 goto fail;
409 } else if (!this || !this->d_inode) {
410 dput(this);
411 err = -ENOENT;
412 goto fail;
Amir Goldstein98892512018-01-17 22:32:44 +0200413 } else if (ovl_dentry_real_at(this, layer->idx) != real) {
Amir Goldstein3985b702017-12-28 18:36:16 +0200414 dput(this);
415 err = -ESTALE;
416 goto fail;
417 }
418
419out:
Amir Goldstein3985b702017-12-28 18:36:16 +0200420 dput(parent);
421 inode_unlock(dir);
422 return this;
423
424fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800425 pr_warn_ratelimited("failed to lookup one by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
Amir Goldstein3985b702017-12-28 18:36:16 +0200426 real, layer->idx, connected, err);
427 this = ERR_PTR(err);
428 goto out;
429}
430
Amir Goldstein06170152018-01-17 14:40:27 +0200431static struct dentry *ovl_lookup_real(struct super_block *sb,
432 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100433 const struct ovl_layer *layer);
Amir Goldstein06170152018-01-17 14:40:27 +0200434
Amir Goldstein3985b702017-12-28 18:36:16 +0200435/*
Amir Goldstein4b91c302018-01-18 16:39:13 +0200436 * Lookup an indexed or hashed overlay dentry by real inode.
437 */
438static struct dentry *ovl_lookup_real_inode(struct super_block *sb,
439 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100440 const struct ovl_layer *layer)
Amir Goldstein4b91c302018-01-18 16:39:13 +0200441{
Andrea Righif01d0882023-05-21 10:28:12 +0200442 struct ovl_fs *ofs = OVL_FS(sb);
Amir Goldstein06170152018-01-17 14:40:27 +0200443 struct dentry *index = NULL;
Amir Goldstein4b91c302018-01-18 16:39:13 +0200444 struct dentry *this = NULL;
445 struct inode *inode;
446
Amir Goldstein06170152018-01-17 14:40:27 +0200447 /*
448 * Decoding upper dir from index is expensive, so first try to lookup
449 * overlay dentry in inode/dcache.
450 */
Amir Goldstein4b91c302018-01-18 16:39:13 +0200451 inode = ovl_lookup_inode(sb, real, !layer->idx);
452 if (IS_ERR(inode))
453 return ERR_CAST(inode);
454 if (inode) {
455 this = d_find_any_alias(inode);
456 iput(inode);
457 }
458
Amir Goldstein06170152018-01-17 14:40:27 +0200459 /*
460 * For decoded lower dir file handle, lookup index by origin to check
461 * if lower dir was copied up and and/or removed.
462 */
463 if (!this && layer->idx && ofs->indexdir && !WARN_ON(!d_is_dir(real))) {
464 index = ovl_lookup_index(ofs, NULL, real, false);
465 if (IS_ERR(index))
466 return index;
467 }
468
469 /* Get connected upper overlay dir from index */
470 if (index) {
Amir Goldstein8ea28762022-10-04 13:34:32 +0300471 struct dentry *upper = ovl_index_upper(ofs, index, true);
Amir Goldstein06170152018-01-17 14:40:27 +0200472
473 dput(index);
474 if (IS_ERR_OR_NULL(upper))
475 return upper;
476
477 /*
478 * ovl_lookup_real() in lower layer may call recursively once to
479 * ovl_lookup_real() in upper layer. The first level call walks
480 * back lower parents to the topmost indexed parent. The second
481 * recursive call walks back from indexed upper to the topmost
482 * connected/hashed upper parent (or up to root).
483 */
Amir Goldstein94375f92019-11-15 14:12:40 +0200484 this = ovl_lookup_real(sb, upper, &ofs->layers[0]);
Amir Goldstein06170152018-01-17 14:40:27 +0200485 dput(upper);
486 }
487
Amir Goldstein71681792018-01-30 14:30:50 +0200488 if (IS_ERR_OR_NULL(this))
489 return this;
Amir Goldstein4b91c302018-01-18 16:39:13 +0200490
Amir Goldstein124c2de2020-06-17 09:57:11 +0300491 if (ovl_dentry_real_at(this, layer->idx) != real) {
Amir Goldstein4b91c302018-01-18 16:39:13 +0200492 dput(this);
493 this = ERR_PTR(-EIO);
494 }
495
496 return this;
497}
498
499/*
500 * Lookup an indexed or hashed overlay dentry, whose real dentry is an
501 * ancestor of @real.
502 */
503static struct dentry *ovl_lookup_real_ancestor(struct super_block *sb,
504 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100505 const struct ovl_layer *layer)
Amir Goldstein4b91c302018-01-18 16:39:13 +0200506{
507 struct dentry *next, *parent = NULL;
508 struct dentry *ancestor = ERR_PTR(-EIO);
509
510 if (real == layer->mnt->mnt_root)
511 return dget(sb->s_root);
512
513 /* Find the topmost indexed or hashed ancestor */
514 next = dget(real);
515 for (;;) {
516 parent = dget_parent(next);
517
518 /*
519 * Lookup a matching overlay dentry in inode/dentry
520 * cache or in index by real inode.
521 */
522 ancestor = ovl_lookup_real_inode(sb, next, layer);
523 if (ancestor)
524 break;
525
526 if (parent == layer->mnt->mnt_root) {
527 ancestor = dget(sb->s_root);
528 break;
529 }
530
531 /*
532 * If @real has been moved out of the layer root directory,
533 * we will eventully hit the real fs root. This cannot happen
534 * by legit overlay rename, so we return error in that case.
535 */
536 if (parent == next) {
537 ancestor = ERR_PTR(-EXDEV);
538 break;
539 }
540
541 dput(next);
542 next = parent;
543 }
544
545 dput(parent);
546 dput(next);
547
548 return ancestor;
549}
550
551/*
Amir Goldstein3985b702017-12-28 18:36:16 +0200552 * Lookup a connected overlay dentry whose real dentry is @real.
553 * If @real is on upper layer, we lookup a child overlay dentry with the same
554 * path the real dentry. Otherwise, we need to consult index for lookup.
555 */
556static struct dentry *ovl_lookup_real(struct super_block *sb,
557 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100558 const struct ovl_layer *layer)
Amir Goldstein3985b702017-12-28 18:36:16 +0200559{
560 struct dentry *connected;
561 int err = 0;
562
Amir Goldstein4b91c302018-01-18 16:39:13 +0200563 connected = ovl_lookup_real_ancestor(sb, real, layer);
564 if (IS_ERR(connected))
565 return connected;
Amir Goldstein3985b702017-12-28 18:36:16 +0200566
Amir Goldstein3985b702017-12-28 18:36:16 +0200567 while (!err) {
568 struct dentry *next, *this;
569 struct dentry *parent = NULL;
Amir Goldstein98892512018-01-17 22:32:44 +0200570 struct dentry *real_connected = ovl_dentry_real_at(connected,
571 layer->idx);
Amir Goldstein3985b702017-12-28 18:36:16 +0200572
573 if (real_connected == real)
574 break;
575
576 /* Find the topmost dentry not yet connected */
577 next = dget(real);
578 for (;;) {
579 parent = dget_parent(next);
580
581 if (parent == real_connected)
582 break;
583
584 /*
585 * If real has been moved out of 'real_connected',
586 * we will not find 'real_connected' and hit the layer
587 * root. In that case, we need to restart connecting.
588 * This game can go on forever in the worst case. We
589 * may want to consider taking s_vfs_rename_mutex if
590 * this happens more than once.
591 */
592 if (parent == layer->mnt->mnt_root) {
593 dput(connected);
594 connected = dget(sb->s_root);
595 break;
596 }
597
598 /*
599 * If real file has been moved out of the layer root
600 * directory, we will eventully hit the real fs root.
601 * This cannot happen by legit overlay rename, so we
602 * return error in that case.
603 */
604 if (parent == next) {
605 err = -EXDEV;
606 break;
607 }
608
609 dput(next);
610 next = parent;
611 }
612
613 if (!err) {
614 this = ovl_lookup_real_one(connected, next, layer);
615 if (IS_ERR(this))
616 err = PTR_ERR(this);
617
618 /*
619 * Lookup of child in overlay can fail when racing with
620 * overlay rename of child away from 'connected' parent.
621 * In this case, we need to restart the lookup from the
622 * top, because we cannot trust that 'real_connected' is
Amir Goldstein4b91c302018-01-18 16:39:13 +0200623 * still an ancestor of 'real'. There is a good chance
624 * that the renamed overlay ancestor is now in cache, so
625 * ovl_lookup_real_ancestor() will find it and we can
626 * continue to connect exactly from where lookup failed.
Amir Goldstein3985b702017-12-28 18:36:16 +0200627 */
628 if (err == -ECHILD) {
Amir Goldstein4b91c302018-01-18 16:39:13 +0200629 this = ovl_lookup_real_ancestor(sb, real,
630 layer);
Fengguang Wub5095f22018-02-06 00:25:16 +0800631 err = PTR_ERR_OR_ZERO(this);
Amir Goldstein3985b702017-12-28 18:36:16 +0200632 }
633 if (!err) {
634 dput(connected);
635 connected = this;
636 }
637 }
638
639 dput(parent);
640 dput(next);
641 }
642
643 if (err)
644 goto fail;
645
646 return connected;
647
648fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800649 pr_warn_ratelimited("failed to lookup by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
Amir Goldstein3985b702017-12-28 18:36:16 +0200650 real, layer->idx, connected, err);
651 dput(connected);
652 return ERR_PTR(err);
653}
654
655/*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200656 * Get an overlay dentry from upper/lower real dentries and index.
Amir Goldstein3985b702017-12-28 18:36:16 +0200657 */
658static struct dentry *ovl_get_dentry(struct super_block *sb,
659 struct dentry *upper,
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200660 struct ovl_path *lowerpath,
661 struct dentry *index)
Amir Goldstein3985b702017-12-28 18:36:16 +0200662{
Andrea Righif01d0882023-05-21 10:28:12 +0200663 struct ovl_fs *ofs = OVL_FS(sb);
Miklos Szeredi13464162020-01-24 09:46:45 +0100664 const struct ovl_layer *layer = upper ? &ofs->layers[0] : lowerpath->layer;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200665 struct dentry *real = upper ?: (index ?: lowerpath->dentry);
Amir Goldstein3985b702017-12-28 18:36:16 +0200666
Amir Goldsteinf9418662018-01-19 21:33:44 +0200667 /*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200668 * Obtain a disconnected overlay dentry from a non-dir real dentry
669 * and index.
Amir Goldsteinf9418662018-01-19 21:33:44 +0200670 */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200671 if (!d_is_dir(real))
672 return ovl_obtain_alias(sb, upper, lowerpath, index);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200673
Amir Goldstein3985b702017-12-28 18:36:16 +0200674 /* Removed empty directory? */
Amir Goldstein98892512018-01-17 22:32:44 +0200675 if ((real->d_flags & DCACHE_DISCONNECTED) || d_unhashed(real))
Amir Goldstein3985b702017-12-28 18:36:16 +0200676 return ERR_PTR(-ENOENT);
677
678 /*
Amir Goldstein98892512018-01-17 22:32:44 +0200679 * If real dentry is connected and hashed, get a connected overlay
680 * dentry whose real dentry is @real.
Amir Goldstein3985b702017-12-28 18:36:16 +0200681 */
Amir Goldstein98892512018-01-17 22:32:44 +0200682 return ovl_lookup_real(sb, real, layer);
Amir Goldstein3985b702017-12-28 18:36:16 +0200683}
684
Amir Goldstein8556a422018-01-19 01:03:23 +0200685static struct dentry *ovl_upper_fh_to_d(struct super_block *sb,
686 struct ovl_fh *fh)
687{
Andrea Righif01d0882023-05-21 10:28:12 +0200688 struct ovl_fs *ofs = OVL_FS(sb);
Amir Goldstein8556a422018-01-19 01:03:23 +0200689 struct dentry *dentry;
690 struct dentry *upper;
691
Miklos Szeredi08f4c7c2020-06-04 10:48:19 +0200692 if (!ovl_upper_mnt(ofs))
Amir Goldstein8556a422018-01-19 01:03:23 +0200693 return ERR_PTR(-EACCES);
694
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300695 upper = ovl_decode_real_fh(ofs, fh, ovl_upper_mnt(ofs), true);
Amir Goldstein8556a422018-01-19 01:03:23 +0200696 if (IS_ERR_OR_NULL(upper))
697 return upper;
698
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200699 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
Amir Goldstein8556a422018-01-19 01:03:23 +0200700 dput(upper);
701
702 return dentry;
703}
704
Amir Goldsteinf9418662018-01-19 21:33:44 +0200705static struct dentry *ovl_lower_fh_to_d(struct super_block *sb,
706 struct ovl_fh *fh)
707{
Andrea Righif01d0882023-05-21 10:28:12 +0200708 struct ovl_fs *ofs = OVL_FS(sb);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200709 struct ovl_path origin = { };
710 struct ovl_path *stack = &origin;
711 struct dentry *dentry = NULL;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200712 struct dentry *index = NULL;
Amir Goldstein8b589242018-03-09 17:05:55 +0200713 struct inode *inode;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200714 int err;
715
Amir Goldstein8b589242018-03-09 17:05:55 +0200716 /* First lookup overlay inode in inode cache by origin fh */
717 err = ovl_check_origin_fh(ofs, fh, false, NULL, &stack);
718 if (err)
719 return ERR_PTR(err);
720
721 if (!d_is_dir(origin.dentry) ||
722 !(origin.dentry->d_flags & DCACHE_DISCONNECTED)) {
723 inode = ovl_lookup_inode(sb, origin.dentry, false);
724 err = PTR_ERR(inode);
725 if (IS_ERR(inode))
726 goto out_err;
727 if (inode) {
728 dentry = d_find_any_alias(inode);
729 iput(inode);
730 if (dentry)
731 goto out;
732 }
733 }
734
735 /* Then lookup indexed upper/whiteout by origin fh */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200736 if (ofs->indexdir) {
737 index = ovl_get_index_fh(ofs, fh);
738 err = PTR_ERR(index);
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200739 if (IS_ERR(index)) {
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200740 index = NULL;
Amir Goldstein8b589242018-03-09 17:05:55 +0200741 goto out_err;
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200742 }
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200743 }
744
Amir Goldstein8b589242018-03-09 17:05:55 +0200745 /* Then try to get a connected upper dir by index */
Amir Goldstein3b0bfc62017-12-24 18:42:16 +0200746 if (index && d_is_dir(index)) {
Amir Goldstein8ea28762022-10-04 13:34:32 +0300747 struct dentry *upper = ovl_index_upper(ofs, index, true);
Amir Goldstein3b0bfc62017-12-24 18:42:16 +0200748
749 err = PTR_ERR(upper);
750 if (IS_ERR_OR_NULL(upper))
751 goto out_err;
752
753 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
754 dput(upper);
755 goto out;
756 }
757
Amir Goldstein155b8a02018-11-05 07:50:10 +0200758 /* Find origin.dentry again with ovl_acceptable() layer check */
759 if (d_is_dir(origin.dentry)) {
Amir Goldstein8b589242018-03-09 17:05:55 +0200760 dput(origin.dentry);
761 origin.dentry = NULL;
762 err = ovl_check_origin_fh(ofs, fh, true, NULL, &stack);
763 if (err)
764 goto out_err;
765 }
766 if (index) {
Miklos Szeredi610afc02020-09-02 10:58:49 +0200767 err = ovl_verify_origin(ofs, index, origin.dentry, false);
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200768 if (err)
769 goto out_err;
770 }
Amir Goldsteinf9418662018-01-19 21:33:44 +0200771
Amir Goldstein155b8a02018-11-05 07:50:10 +0200772 /* Get a connected non-upper dir or disconnected non-dir */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200773 dentry = ovl_get_dentry(sb, NULL, &origin, index);
774
775out:
Amir Goldsteinf9418662018-01-19 21:33:44 +0200776 dput(origin.dentry);
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200777 dput(index);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200778 return dentry;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200779
780out_err:
781 dentry = ERR_PTR(err);
782 goto out;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200783}
784
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200785static struct ovl_fh *ovl_fid_to_fh(struct fid *fid, int buflen, int fh_type)
786{
787 struct ovl_fh *fh;
788
789 /* If on-wire inner fid is aligned - nothing to do */
790 if (fh_type == OVL_FILEID_V1)
791 return (struct ovl_fh *)fid;
792
793 if (fh_type != OVL_FILEID_V0)
794 return ERR_PTR(-EINVAL);
795
Dan Carpenter9aafc1b2020-05-05 21:33:31 +0300796 if (buflen <= OVL_FH_WIRE_OFFSET)
797 return ERR_PTR(-EINVAL);
798
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200799 fh = kzalloc(buflen, GFP_KERNEL);
800 if (!fh)
801 return ERR_PTR(-ENOMEM);
802
803 /* Copy unaligned inner fh into aligned buffer */
Kees Cookcf8aa9b2022-09-24 00:33:15 -0700804 memcpy(fh->buf, fid, buflen - OVL_FH_WIRE_OFFSET);
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200805 return fh;
806}
807
Amir Goldstein8556a422018-01-19 01:03:23 +0200808static struct dentry *ovl_fh_to_dentry(struct super_block *sb, struct fid *fid,
809 int fh_len, int fh_type)
810{
811 struct dentry *dentry = NULL;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200812 struct ovl_fh *fh = NULL;
Amir Goldstein8556a422018-01-19 01:03:23 +0200813 int len = fh_len << 2;
814 unsigned int flags = 0;
815 int err;
816
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200817 fh = ovl_fid_to_fh(fid, len, fh_type);
818 err = PTR_ERR(fh);
819 if (IS_ERR(fh))
Amir Goldstein8556a422018-01-19 01:03:23 +0200820 goto out_err;
821
822 err = ovl_check_fh_len(fh, len);
823 if (err)
824 goto out_err;
825
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200826 flags = fh->fb.flags;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200827 dentry = (flags & OVL_FH_FLAG_PATH_UPPER) ?
828 ovl_upper_fh_to_d(sb, fh) :
829 ovl_lower_fh_to_d(sb, fh);
Amir Goldstein8556a422018-01-19 01:03:23 +0200830 err = PTR_ERR(dentry);
831 if (IS_ERR(dentry) && err != -ESTALE)
832 goto out_err;
833
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200834out:
835 /* We may have needed to re-align OVL_FILEID_V0 */
836 if (!IS_ERR_OR_NULL(fh) && fh != (void *)fid)
837 kfree(fh);
838
Amir Goldstein8556a422018-01-19 01:03:23 +0200839 return dentry;
840
841out_err:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800842 pr_warn_ratelimited("failed to decode file handle (len=%d, type=%d, flags=%x, err=%i)\n",
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200843 fh_len, fh_type, flags, err);
844 dentry = ERR_PTR(err);
845 goto out;
Amir Goldstein8556a422018-01-19 01:03:23 +0200846}
847
Amir Goldstein3985b702017-12-28 18:36:16 +0200848static struct dentry *ovl_fh_to_parent(struct super_block *sb, struct fid *fid,
849 int fh_len, int fh_type)
850{
lijiazi1bd0a3a2019-12-16 19:12:32 +0800851 pr_warn_ratelimited("connectable file handles not supported; use 'no_subtree_check' exportfs option.\n");
Amir Goldstein3985b702017-12-28 18:36:16 +0200852 return ERR_PTR(-EACCES);
853}
854
855static int ovl_get_name(struct dentry *parent, char *name,
856 struct dentry *child)
857{
858 /*
859 * ovl_fh_to_dentry() returns connected dir overlay dentries and
860 * ovl_fh_to_parent() is not implemented, so we should not get here.
861 */
862 WARN_ON_ONCE(1);
863 return -EIO;
864}
865
866static struct dentry *ovl_get_parent(struct dentry *dentry)
867{
868 /*
869 * ovl_fh_to_dentry() returns connected dir overlay dentries, so we
870 * should not get here.
871 */
872 WARN_ON_ONCE(1);
873 return ERR_PTR(-EIO);
874}
875
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300876const struct export_operations ovl_export_operations = {
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200877 .encode_fh = ovl_encode_fh,
Amir Goldstein8556a422018-01-19 01:03:23 +0200878 .fh_to_dentry = ovl_fh_to_dentry,
Amir Goldstein3985b702017-12-28 18:36:16 +0200879 .fh_to_parent = ovl_fh_to_parent,
880 .get_name = ovl_get_name,
881 .get_parent = ovl_get_parent,
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300882};
Amir Goldstein16aac5a2023-04-23 19:02:04 +0300883
884/* encode_fh() encodes non-decodable file handles with nfs_export=off */
885const struct export_operations ovl_export_fid_operations = {
886 .encode_fh = ovl_encode_fh,
887};