blob: ebde05c9cf62e8e5a69fc87fb62c6431c434b8dc [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
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) {
lijiazi1bd0a3a2019-12-16 19:12:32 +080033 pr_warn_ratelimited("failed to copy up on encode (%pd2, err=%i)\n",
Amir Goldstein2ca3c142018-01-30 13:31:09 +020034 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 */
77static 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 */
105static 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
Amir Goldsteinb305e842018-01-18 13:14:55 +0200155/*
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
Amir Goldstein05e1f112018-01-18 13:15:26 +0200170 * Indexed upper | L (*)
171 * Non-upper | L (*)
Amir Goldsteinb305e842018-01-18 13:14:55 +0200172 *
173 * U = upper file handle
174 * L = lower file handle
Amir Goldstein05e1f112018-01-18 13:15:26 +0200175 *
176 * (*) Connecting an overlay dir from real lower dentry is not always
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200177 * 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.
Amir Goldsteinb305e842018-01-18 13:14:55 +0200182 */
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200183static int ovl_check_encode_origin(struct dentry *dentry)
Amir Goldsteinb305e842018-01-18 13:14:55 +0200184{
Amir Goldstein05e1f112018-01-18 13:15:26 +0200185 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
186
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200187 /* Upper file handle for pure upper */
Amir Goldsteinb305e842018-01-18 13:14:55 +0200188 if (!ovl_dentry_lower(dentry))
Amir Goldstein05e1f112018-01-18 13:15:26 +0200189 return 0;
190
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200191 /*
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;
Amir Goldstein05e1f112018-01-18 13:15:26 +0200200
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200201 /*
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 */
Miklos Szeredi08f4c7c2020-06-04 10:48:19 +0200207 if (d_is_dir(dentry) && ovl_upper_mnt(ofs))
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200208 return ovl_connect_layer(dentry);
Amir Goldstein05e1f112018-01-18 13:15:26 +0200209
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200210 /* Lower file handle for indexed and non-upper dir/non-dir */
211 return 1;
Amir Goldstein05e1f112018-01-18 13:15:26 +0200212}
213
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300214static int ovl_dentry_to_fid(struct ovl_fs *ofs, struct dentry *dentry,
215 u32 *fid, int buflen)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300216{
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300217 struct ovl_fh *fh = NULL;
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200218 int err, enc_lower;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200219 int len;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300220
Amir Goldstein05e1f112018-01-18 13:15:26 +0200221 /*
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200222 * Check if we should encode a lower or upper file handle and maybe
223 * copy up an ancestor to make lower file handle connectable.
Amir Goldstein05e1f112018-01-18 13:15:26 +0200224 */
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200225 err = enc_lower = ovl_check_encode_origin(dentry);
226 if (enc_lower < 0)
227 goto fail;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300228
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200229 /* Encode an upper or lower file handle */
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300230 fh = ovl_encode_real_fh(ofs, enc_lower ? ovl_dentry_lower(dentry) :
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200231 ovl_dentry_upper(dentry), !enc_lower);
Amir Goldstein9b6faee2018-01-30 13:54:45 +0200232 if (IS_ERR(fh))
Ding Xiang97f024b2019-09-09 16:29:56 +0800233 return PTR_ERR(fh);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300234
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200235 len = OVL_FH_LEN(fh);
Lubos Dolezel144da232020-05-04 21:35:09 +0200236 if (len <= buflen)
237 memcpy(fid, fh, len);
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200238 err = len;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300239
240out:
241 kfree(fh);
242 return err;
243
244fail:
Lubos Dolezel144da232020-05-04 21:35:09 +0200245 pr_warn_ratelimited("failed to encode file handle (%pd2, err=%i)\n",
246 dentry, err);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300247 goto out;
248}
249
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200250static int ovl_encode_fh(struct inode *inode, u32 *fid, int *max_len,
251 struct inode *parent)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300252{
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300253 struct ovl_fs *ofs = OVL_FS(inode->i_sb);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300254 struct dentry *dentry;
Lubos Dolezel144da232020-05-04 21:35:09 +0200255 int bytes, buflen = *max_len << 2;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300256
257 /* TODO: encode connectable file handles */
258 if (parent)
259 return FILEID_INVALID;
260
261 dentry = d_find_any_alias(inode);
262 if (WARN_ON(!dentry))
263 return FILEID_INVALID;
264
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300265 bytes = ovl_dentry_to_fid(ofs, dentry, fid, buflen);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300266 dput(dentry);
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200267 if (bytes <= 0)
268 return FILEID_INVALID;
269
270 *max_len = bytes >> 2;
Lubos Dolezel144da232020-05-04 21:35:09 +0200271 if (bytes > buflen)
272 return FILEID_INVALID;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200273
274 return OVL_FILEID_V1;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300275}
276
Amir Goldstein8556a422018-01-19 01:03:23 +0200277/*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200278 * Find or instantiate an overlay dentry from real dentries and index.
Amir Goldstein8556a422018-01-19 01:03:23 +0200279 */
280static struct dentry *ovl_obtain_alias(struct super_block *sb,
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200281 struct dentry *upper_alias,
282 struct ovl_path *lowerpath,
283 struct dentry *index)
Amir Goldstein8556a422018-01-19 01:03:23 +0200284{
Amir Goldsteinf9418662018-01-19 21:33:44 +0200285 struct dentry *lower = lowerpath ? lowerpath->dentry : NULL;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200286 struct dentry *upper = upper_alias ?: index;
Amir Goldstein8556a422018-01-19 01:03:23 +0200287 struct dentry *dentry;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200288 struct inode *inode;
Amir Goldstein8556a422018-01-19 01:03:23 +0200289 struct ovl_entry *oe;
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400290 struct ovl_inode_params oip = {
291 .lowerpath = lowerpath,
292 .index = index,
293 .numlower = !!lower
294 };
Amir Goldstein8556a422018-01-19 01:03:23 +0200295
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200296 /* We get overlay directory dentries with ovl_lookup_real() */
297 if (d_is_dir(upper ?: lower))
Amir Goldstein8556a422018-01-19 01:03:23 +0200298 return ERR_PTR(-EIO);
299
Vivek Goyalac6a52e2018-05-08 09:27:21 -0400300 oip.upperdentry = dget(upper);
301 inode = ovl_get_inode(sb, &oip);
Amir Goldstein8556a422018-01-19 01:03:23 +0200302 if (IS_ERR(inode)) {
303 dput(upper);
304 return ERR_CAST(inode);
305 }
306
Vivek Goyal9d3dfea2018-05-11 11:49:28 -0400307 if (upper)
308 ovl_set_flag(OVL_UPPERDATA, inode);
309
Amir Goldstein8556a422018-01-19 01:03:23 +0200310 dentry = d_find_any_alias(inode);
Al Viro504f3842019-10-24 02:06:45 +0100311 if (dentry)
312 goto out_iput;
Amir Goldstein8556a422018-01-19 01:03:23 +0200313
Al Viro504f3842019-10-24 02:06:45 +0100314 dentry = d_alloc_anon(inode->i_sb);
315 if (unlikely(!dentry))
316 goto nomem;
317 oe = ovl_alloc_entry(lower ? 1 : 0);
318 if (!oe)
319 goto nomem;
320
321 if (lower) {
322 oe->lowerstack->dentry = dget(lower);
323 oe->lowerstack->layer = lowerpath->layer;
Amir Goldstein8556a422018-01-19 01:03:23 +0200324 }
Al Viro504f3842019-10-24 02:06:45 +0100325 dentry->d_fsdata = oe;
326 if (upper_alias)
327 ovl_dentry_set_upper_alias(dentry);
328
Miklos Szeredif4288842020-03-17 15:04:22 +0100329 ovl_dentry_update_reval(dentry, upper,
330 DCACHE_OP_REVALIDATE | DCACHE_OP_WEAK_REVALIDATE);
Amir Goldstein8556a422018-01-19 01:03:23 +0200331
332 return d_instantiate_anon(dentry, inode);
333
334nomem:
Amir Goldstein8556a422018-01-19 01:03:23 +0200335 dput(dentry);
Al Viro504f3842019-10-24 02:06:45 +0100336 dentry = ERR_PTR(-ENOMEM);
337out_iput:
338 iput(inode);
339 return dentry;
Amir Goldstein8556a422018-01-19 01:03:23 +0200340}
341
Amir Goldstein98892512018-01-17 22:32:44 +0200342/* Get the upper or lower dentry in stach whose on layer @idx */
343static struct dentry *ovl_dentry_real_at(struct dentry *dentry, int idx)
344{
345 struct ovl_entry *oe = dentry->d_fsdata;
346 int i;
347
348 if (!idx)
349 return ovl_dentry_upper(dentry);
350
351 for (i = 0; i < oe->numlower; i++) {
352 if (oe->lowerstack[i].layer->idx == idx)
353 return oe->lowerstack[i].dentry;
354 }
355
356 return NULL;
357}
358
Amir Goldstein3985b702017-12-28 18:36:16 +0200359/*
360 * Lookup a child overlay dentry to get a connected overlay dentry whose real
361 * dentry is @real. If @real is on upper layer, we lookup a child overlay
362 * dentry with the same name as the real dentry. Otherwise, we need to consult
363 * index for lookup.
364 */
365static struct dentry *ovl_lookup_real_one(struct dentry *connected,
366 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100367 const struct ovl_layer *layer)
Amir Goldstein3985b702017-12-28 18:36:16 +0200368{
369 struct inode *dir = d_inode(connected);
370 struct dentry *this, *parent = NULL;
371 struct name_snapshot name;
372 int err;
373
Amir Goldstein3985b702017-12-28 18:36:16 +0200374 /*
375 * Lookup child overlay dentry by real name. The dir mutex protects us
376 * from racing with overlay rename. If the overlay dentry that is above
377 * real has already been moved to a parent that is not under the
378 * connected overlay dir, we return -ECHILD and restart the lookup of
379 * connected real path from the top.
380 */
381 inode_lock_nested(dir, I_MUTEX_PARENT);
382 err = -ECHILD;
383 parent = dget_parent(real);
Amir Goldstein98892512018-01-17 22:32:44 +0200384 if (ovl_dentry_real_at(connected, layer->idx) != parent)
Amir Goldstein3985b702017-12-28 18:36:16 +0200385 goto fail;
386
387 /*
388 * We also need to take a snapshot of real dentry name to protect us
389 * from racing with underlying layer rename. In this case, we don't
390 * care about returning ESTALE, only from dereferencing a free name
391 * pointer because we hold no lock on the real dentry.
392 */
393 take_dentry_name_snapshot(&name, real);
Al Viro230c6402019-04-26 13:07:27 -0400394 this = lookup_one_len(name.name.name, connected, name.name.len);
Miklos Szeredi580c6102021-08-06 10:03:12 +0200395 release_dentry_name_snapshot(&name);
Amir Goldstein3985b702017-12-28 18:36:16 +0200396 err = PTR_ERR(this);
397 if (IS_ERR(this)) {
398 goto fail;
399 } else if (!this || !this->d_inode) {
400 dput(this);
401 err = -ENOENT;
402 goto fail;
Amir Goldstein98892512018-01-17 22:32:44 +0200403 } else if (ovl_dentry_real_at(this, layer->idx) != real) {
Amir Goldstein3985b702017-12-28 18:36:16 +0200404 dput(this);
405 err = -ESTALE;
406 goto fail;
407 }
408
409out:
Amir Goldstein3985b702017-12-28 18:36:16 +0200410 dput(parent);
411 inode_unlock(dir);
412 return this;
413
414fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800415 pr_warn_ratelimited("failed to lookup one by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
Amir Goldstein3985b702017-12-28 18:36:16 +0200416 real, layer->idx, connected, err);
417 this = ERR_PTR(err);
418 goto out;
419}
420
Amir Goldstein06170152018-01-17 14:40:27 +0200421static struct dentry *ovl_lookup_real(struct super_block *sb,
422 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100423 const struct ovl_layer *layer);
Amir Goldstein06170152018-01-17 14:40:27 +0200424
Amir Goldstein3985b702017-12-28 18:36:16 +0200425/*
Amir Goldstein4b91c302018-01-18 16:39:13 +0200426 * Lookup an indexed or hashed overlay dentry by real inode.
427 */
428static struct dentry *ovl_lookup_real_inode(struct super_block *sb,
429 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100430 const struct ovl_layer *layer)
Amir Goldstein4b91c302018-01-18 16:39:13 +0200431{
Amir Goldstein06170152018-01-17 14:40:27 +0200432 struct ovl_fs *ofs = sb->s_fs_info;
Amir Goldstein06170152018-01-17 14:40:27 +0200433 struct dentry *index = NULL;
Amir Goldstein4b91c302018-01-18 16:39:13 +0200434 struct dentry *this = NULL;
435 struct inode *inode;
436
Amir Goldstein06170152018-01-17 14:40:27 +0200437 /*
438 * Decoding upper dir from index is expensive, so first try to lookup
439 * overlay dentry in inode/dcache.
440 */
Amir Goldstein4b91c302018-01-18 16:39:13 +0200441 inode = ovl_lookup_inode(sb, real, !layer->idx);
442 if (IS_ERR(inode))
443 return ERR_CAST(inode);
444 if (inode) {
445 this = d_find_any_alias(inode);
446 iput(inode);
447 }
448
Amir Goldstein06170152018-01-17 14:40:27 +0200449 /*
450 * For decoded lower dir file handle, lookup index by origin to check
451 * if lower dir was copied up and and/or removed.
452 */
453 if (!this && layer->idx && ofs->indexdir && !WARN_ON(!d_is_dir(real))) {
454 index = ovl_lookup_index(ofs, NULL, real, false);
455 if (IS_ERR(index))
456 return index;
457 }
458
459 /* Get connected upper overlay dir from index */
460 if (index) {
461 struct dentry *upper = ovl_index_upper(ofs, index);
462
463 dput(index);
464 if (IS_ERR_OR_NULL(upper))
465 return upper;
466
467 /*
468 * ovl_lookup_real() in lower layer may call recursively once to
469 * ovl_lookup_real() in upper layer. The first level call walks
470 * back lower parents to the topmost indexed parent. The second
471 * recursive call walks back from indexed upper to the topmost
472 * connected/hashed upper parent (or up to root).
473 */
Amir Goldstein94375f92019-11-15 14:12:40 +0200474 this = ovl_lookup_real(sb, upper, &ofs->layers[0]);
Amir Goldstein06170152018-01-17 14:40:27 +0200475 dput(upper);
476 }
477
Amir Goldstein71681792018-01-30 14:30:50 +0200478 if (IS_ERR_OR_NULL(this))
479 return this;
Amir Goldstein4b91c302018-01-18 16:39:13 +0200480
Amir Goldstein124c2de2020-06-17 09:57:11 +0300481 if (ovl_dentry_real_at(this, layer->idx) != real) {
Amir Goldstein4b91c302018-01-18 16:39:13 +0200482 dput(this);
483 this = ERR_PTR(-EIO);
484 }
485
486 return this;
487}
488
489/*
490 * Lookup an indexed or hashed overlay dentry, whose real dentry is an
491 * ancestor of @real.
492 */
493static struct dentry *ovl_lookup_real_ancestor(struct super_block *sb,
494 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100495 const struct ovl_layer *layer)
Amir Goldstein4b91c302018-01-18 16:39:13 +0200496{
497 struct dentry *next, *parent = NULL;
498 struct dentry *ancestor = ERR_PTR(-EIO);
499
500 if (real == layer->mnt->mnt_root)
501 return dget(sb->s_root);
502
503 /* Find the topmost indexed or hashed ancestor */
504 next = dget(real);
505 for (;;) {
506 parent = dget_parent(next);
507
508 /*
509 * Lookup a matching overlay dentry in inode/dentry
510 * cache or in index by real inode.
511 */
512 ancestor = ovl_lookup_real_inode(sb, next, layer);
513 if (ancestor)
514 break;
515
516 if (parent == layer->mnt->mnt_root) {
517 ancestor = dget(sb->s_root);
518 break;
519 }
520
521 /*
522 * If @real has been moved out of the layer root directory,
523 * we will eventully hit the real fs root. This cannot happen
524 * by legit overlay rename, so we return error in that case.
525 */
526 if (parent == next) {
527 ancestor = ERR_PTR(-EXDEV);
528 break;
529 }
530
531 dput(next);
532 next = parent;
533 }
534
535 dput(parent);
536 dput(next);
537
538 return ancestor;
539}
540
541/*
Amir Goldstein3985b702017-12-28 18:36:16 +0200542 * Lookup a connected overlay dentry whose real dentry is @real.
543 * If @real is on upper layer, we lookup a child overlay dentry with the same
544 * path the real dentry. Otherwise, we need to consult index for lookup.
545 */
546static struct dentry *ovl_lookup_real(struct super_block *sb,
547 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100548 const struct ovl_layer *layer)
Amir Goldstein3985b702017-12-28 18:36:16 +0200549{
550 struct dentry *connected;
551 int err = 0;
552
Amir Goldstein4b91c302018-01-18 16:39:13 +0200553 connected = ovl_lookup_real_ancestor(sb, real, layer);
554 if (IS_ERR(connected))
555 return connected;
Amir Goldstein3985b702017-12-28 18:36:16 +0200556
Amir Goldstein3985b702017-12-28 18:36:16 +0200557 while (!err) {
558 struct dentry *next, *this;
559 struct dentry *parent = NULL;
Amir Goldstein98892512018-01-17 22:32:44 +0200560 struct dentry *real_connected = ovl_dentry_real_at(connected,
561 layer->idx);
Amir Goldstein3985b702017-12-28 18:36:16 +0200562
563 if (real_connected == real)
564 break;
565
566 /* Find the topmost dentry not yet connected */
567 next = dget(real);
568 for (;;) {
569 parent = dget_parent(next);
570
571 if (parent == real_connected)
572 break;
573
574 /*
575 * If real has been moved out of 'real_connected',
576 * we will not find 'real_connected' and hit the layer
577 * root. In that case, we need to restart connecting.
578 * This game can go on forever in the worst case. We
579 * may want to consider taking s_vfs_rename_mutex if
580 * this happens more than once.
581 */
582 if (parent == layer->mnt->mnt_root) {
583 dput(connected);
584 connected = dget(sb->s_root);
585 break;
586 }
587
588 /*
589 * If real file has been moved out of the layer root
590 * directory, we will eventully hit the real fs root.
591 * This cannot happen by legit overlay rename, so we
592 * return error in that case.
593 */
594 if (parent == next) {
595 err = -EXDEV;
596 break;
597 }
598
599 dput(next);
600 next = parent;
601 }
602
603 if (!err) {
604 this = ovl_lookup_real_one(connected, next, layer);
605 if (IS_ERR(this))
606 err = PTR_ERR(this);
607
608 /*
609 * Lookup of child in overlay can fail when racing with
610 * overlay rename of child away from 'connected' parent.
611 * In this case, we need to restart the lookup from the
612 * top, because we cannot trust that 'real_connected' is
Amir Goldstein4b91c302018-01-18 16:39:13 +0200613 * still an ancestor of 'real'. There is a good chance
614 * that the renamed overlay ancestor is now in cache, so
615 * ovl_lookup_real_ancestor() will find it and we can
616 * continue to connect exactly from where lookup failed.
Amir Goldstein3985b702017-12-28 18:36:16 +0200617 */
618 if (err == -ECHILD) {
Amir Goldstein4b91c302018-01-18 16:39:13 +0200619 this = ovl_lookup_real_ancestor(sb, real,
620 layer);
Fengguang Wub5095f22018-02-06 00:25:16 +0800621 err = PTR_ERR_OR_ZERO(this);
Amir Goldstein3985b702017-12-28 18:36:16 +0200622 }
623 if (!err) {
624 dput(connected);
625 connected = this;
626 }
627 }
628
629 dput(parent);
630 dput(next);
631 }
632
633 if (err)
634 goto fail;
635
636 return connected;
637
638fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800639 pr_warn_ratelimited("failed to lookup by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
Amir Goldstein3985b702017-12-28 18:36:16 +0200640 real, layer->idx, connected, err);
641 dput(connected);
642 return ERR_PTR(err);
643}
644
645/*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200646 * Get an overlay dentry from upper/lower real dentries and index.
Amir Goldstein3985b702017-12-28 18:36:16 +0200647 */
648static struct dentry *ovl_get_dentry(struct super_block *sb,
649 struct dentry *upper,
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200650 struct ovl_path *lowerpath,
651 struct dentry *index)
Amir Goldstein3985b702017-12-28 18:36:16 +0200652{
653 struct ovl_fs *ofs = sb->s_fs_info;
Miklos Szeredi13464162020-01-24 09:46:45 +0100654 const struct ovl_layer *layer = upper ? &ofs->layers[0] : lowerpath->layer;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200655 struct dentry *real = upper ?: (index ?: lowerpath->dentry);
Amir Goldstein3985b702017-12-28 18:36:16 +0200656
Amir Goldsteinf9418662018-01-19 21:33:44 +0200657 /*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200658 * Obtain a disconnected overlay dentry from a non-dir real dentry
659 * and index.
Amir Goldsteinf9418662018-01-19 21:33:44 +0200660 */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200661 if (!d_is_dir(real))
662 return ovl_obtain_alias(sb, upper, lowerpath, index);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200663
Amir Goldstein3985b702017-12-28 18:36:16 +0200664 /* Removed empty directory? */
Amir Goldstein98892512018-01-17 22:32:44 +0200665 if ((real->d_flags & DCACHE_DISCONNECTED) || d_unhashed(real))
Amir Goldstein3985b702017-12-28 18:36:16 +0200666 return ERR_PTR(-ENOENT);
667
668 /*
Amir Goldstein98892512018-01-17 22:32:44 +0200669 * If real dentry is connected and hashed, get a connected overlay
670 * dentry whose real dentry is @real.
Amir Goldstein3985b702017-12-28 18:36:16 +0200671 */
Amir Goldstein98892512018-01-17 22:32:44 +0200672 return ovl_lookup_real(sb, real, layer);
Amir Goldstein3985b702017-12-28 18:36:16 +0200673}
674
Amir Goldstein8556a422018-01-19 01:03:23 +0200675static struct dentry *ovl_upper_fh_to_d(struct super_block *sb,
676 struct ovl_fh *fh)
677{
678 struct ovl_fs *ofs = sb->s_fs_info;
679 struct dentry *dentry;
680 struct dentry *upper;
681
Miklos Szeredi08f4c7c2020-06-04 10:48:19 +0200682 if (!ovl_upper_mnt(ofs))
Amir Goldstein8556a422018-01-19 01:03:23 +0200683 return ERR_PTR(-EACCES);
684
Pavel Tikhomirov1cdb0cb2020-10-13 17:59:53 +0300685 upper = ovl_decode_real_fh(ofs, fh, ovl_upper_mnt(ofs), true);
Amir Goldstein8556a422018-01-19 01:03:23 +0200686 if (IS_ERR_OR_NULL(upper))
687 return upper;
688
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200689 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
Amir Goldstein8556a422018-01-19 01:03:23 +0200690 dput(upper);
691
692 return dentry;
693}
694
Amir Goldsteinf9418662018-01-19 21:33:44 +0200695static struct dentry *ovl_lower_fh_to_d(struct super_block *sb,
696 struct ovl_fh *fh)
697{
698 struct ovl_fs *ofs = sb->s_fs_info;
699 struct ovl_path origin = { };
700 struct ovl_path *stack = &origin;
701 struct dentry *dentry = NULL;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200702 struct dentry *index = NULL;
Amir Goldstein8b589242018-03-09 17:05:55 +0200703 struct inode *inode;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200704 int err;
705
Amir Goldstein8b589242018-03-09 17:05:55 +0200706 /* First lookup overlay inode in inode cache by origin fh */
707 err = ovl_check_origin_fh(ofs, fh, false, NULL, &stack);
708 if (err)
709 return ERR_PTR(err);
710
711 if (!d_is_dir(origin.dentry) ||
712 !(origin.dentry->d_flags & DCACHE_DISCONNECTED)) {
713 inode = ovl_lookup_inode(sb, origin.dentry, false);
714 err = PTR_ERR(inode);
715 if (IS_ERR(inode))
716 goto out_err;
717 if (inode) {
718 dentry = d_find_any_alias(inode);
719 iput(inode);
720 if (dentry)
721 goto out;
722 }
723 }
724
725 /* Then lookup indexed upper/whiteout by origin fh */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200726 if (ofs->indexdir) {
727 index = ovl_get_index_fh(ofs, fh);
728 err = PTR_ERR(index);
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200729 if (IS_ERR(index)) {
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200730 index = NULL;
Amir Goldstein8b589242018-03-09 17:05:55 +0200731 goto out_err;
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200732 }
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200733 }
734
Amir Goldstein8b589242018-03-09 17:05:55 +0200735 /* Then try to get a connected upper dir by index */
Amir Goldstein3b0bfc62017-12-24 18:42:16 +0200736 if (index && d_is_dir(index)) {
737 struct dentry *upper = ovl_index_upper(ofs, index);
738
739 err = PTR_ERR(upper);
740 if (IS_ERR_OR_NULL(upper))
741 goto out_err;
742
743 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
744 dput(upper);
745 goto out;
746 }
747
Amir Goldstein155b8a02018-11-05 07:50:10 +0200748 /* Find origin.dentry again with ovl_acceptable() layer check */
749 if (d_is_dir(origin.dentry)) {
Amir Goldstein8b589242018-03-09 17:05:55 +0200750 dput(origin.dentry);
751 origin.dentry = NULL;
752 err = ovl_check_origin_fh(ofs, fh, true, NULL, &stack);
753 if (err)
754 goto out_err;
755 }
756 if (index) {
Miklos Szeredi610afc02020-09-02 10:58:49 +0200757 err = ovl_verify_origin(ofs, index, origin.dentry, false);
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200758 if (err)
759 goto out_err;
760 }
Amir Goldsteinf9418662018-01-19 21:33:44 +0200761
Amir Goldstein155b8a02018-11-05 07:50:10 +0200762 /* Get a connected non-upper dir or disconnected non-dir */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200763 dentry = ovl_get_dentry(sb, NULL, &origin, index);
764
765out:
Amir Goldsteinf9418662018-01-19 21:33:44 +0200766 dput(origin.dentry);
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200767 dput(index);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200768 return dentry;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200769
770out_err:
771 dentry = ERR_PTR(err);
772 goto out;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200773}
774
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200775static struct ovl_fh *ovl_fid_to_fh(struct fid *fid, int buflen, int fh_type)
776{
777 struct ovl_fh *fh;
778
779 /* If on-wire inner fid is aligned - nothing to do */
780 if (fh_type == OVL_FILEID_V1)
781 return (struct ovl_fh *)fid;
782
783 if (fh_type != OVL_FILEID_V0)
784 return ERR_PTR(-EINVAL);
785
Dan Carpenter9aafc1b2020-05-05 21:33:31 +0300786 if (buflen <= OVL_FH_WIRE_OFFSET)
787 return ERR_PTR(-EINVAL);
788
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200789 fh = kzalloc(buflen, GFP_KERNEL);
790 if (!fh)
791 return ERR_PTR(-ENOMEM);
792
793 /* Copy unaligned inner fh into aligned buffer */
794 memcpy(&fh->fb, fid, buflen - OVL_FH_WIRE_OFFSET);
795 return fh;
796}
797
Amir Goldstein8556a422018-01-19 01:03:23 +0200798static struct dentry *ovl_fh_to_dentry(struct super_block *sb, struct fid *fid,
799 int fh_len, int fh_type)
800{
801 struct dentry *dentry = NULL;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200802 struct ovl_fh *fh = NULL;
Amir Goldstein8556a422018-01-19 01:03:23 +0200803 int len = fh_len << 2;
804 unsigned int flags = 0;
805 int err;
806
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200807 fh = ovl_fid_to_fh(fid, len, fh_type);
808 err = PTR_ERR(fh);
809 if (IS_ERR(fh))
Amir Goldstein8556a422018-01-19 01:03:23 +0200810 goto out_err;
811
812 err = ovl_check_fh_len(fh, len);
813 if (err)
814 goto out_err;
815
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200816 flags = fh->fb.flags;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200817 dentry = (flags & OVL_FH_FLAG_PATH_UPPER) ?
818 ovl_upper_fh_to_d(sb, fh) :
819 ovl_lower_fh_to_d(sb, fh);
Amir Goldstein8556a422018-01-19 01:03:23 +0200820 err = PTR_ERR(dentry);
821 if (IS_ERR(dentry) && err != -ESTALE)
822 goto out_err;
823
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200824out:
825 /* We may have needed to re-align OVL_FILEID_V0 */
826 if (!IS_ERR_OR_NULL(fh) && fh != (void *)fid)
827 kfree(fh);
828
Amir Goldstein8556a422018-01-19 01:03:23 +0200829 return dentry;
830
831out_err:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800832 pr_warn_ratelimited("failed to decode file handle (len=%d, type=%d, flags=%x, err=%i)\n",
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200833 fh_len, fh_type, flags, err);
834 dentry = ERR_PTR(err);
835 goto out;
Amir Goldstein8556a422018-01-19 01:03:23 +0200836}
837
Amir Goldstein3985b702017-12-28 18:36:16 +0200838static struct dentry *ovl_fh_to_parent(struct super_block *sb, struct fid *fid,
839 int fh_len, int fh_type)
840{
lijiazi1bd0a3a2019-12-16 19:12:32 +0800841 pr_warn_ratelimited("connectable file handles not supported; use 'no_subtree_check' exportfs option.\n");
Amir Goldstein3985b702017-12-28 18:36:16 +0200842 return ERR_PTR(-EACCES);
843}
844
845static int ovl_get_name(struct dentry *parent, char *name,
846 struct dentry *child)
847{
848 /*
849 * ovl_fh_to_dentry() returns connected dir overlay dentries and
850 * ovl_fh_to_parent() is not implemented, so we should not get here.
851 */
852 WARN_ON_ONCE(1);
853 return -EIO;
854}
855
856static struct dentry *ovl_get_parent(struct dentry *dentry)
857{
858 /*
859 * ovl_fh_to_dentry() returns connected dir overlay dentries, so we
860 * should not get here.
861 */
862 WARN_ON_ONCE(1);
863 return ERR_PTR(-EIO);
864}
865
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300866const struct export_operations ovl_export_operations = {
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200867 .encode_fh = ovl_encode_fh,
Amir Goldstein8556a422018-01-19 01:03:23 +0200868 .fh_to_dentry = ovl_fh_to_dentry,
Amir Goldstein3985b702017-12-28 18:36:16 +0200869 .fh_to_parent = ovl_fh_to_parent,
870 .get_name = ovl_get_name,
871 .get_parent = ovl_get_parent,
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300872};