blob: 6f54d70cef277f447583a229ca55a32a3aea2857 [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 */
207 if (d_is_dir(dentry) && ofs->upper_mnt)
208 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
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200214static int ovl_dentry_to_fid(struct dentry *dentry, u32 *fid, int buflen)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300215{
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300216 struct ovl_fh *fh = NULL;
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200217 int err, enc_lower;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200218 int len;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300219
Amir Goldstein05e1f112018-01-18 13:15:26 +0200220 /*
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200221 * Check if we should encode a lower or upper file handle and maybe
222 * copy up an ancestor to make lower file handle connectable.
Amir Goldstein05e1f112018-01-18 13:15:26 +0200223 */
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200224 err = enc_lower = ovl_check_encode_origin(dentry);
225 if (enc_lower < 0)
226 goto fail;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300227
Amir Goldstein2ca3c142018-01-30 13:31:09 +0200228 /* Encode an upper or lower file handle */
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200229 fh = ovl_encode_real_fh(enc_lower ? ovl_dentry_lower(dentry) :
230 ovl_dentry_upper(dentry), !enc_lower);
Amir Goldstein9b6faee2018-01-30 13:54:45 +0200231 if (IS_ERR(fh))
Ding Xiang97f024b2019-09-09 16:29:56 +0800232 return PTR_ERR(fh);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300233
234 err = -EOVERFLOW;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200235 len = OVL_FH_LEN(fh);
236 if (len > buflen)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300237 goto fail;
238
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200239 memcpy(fid, fh, len);
240 err = len;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300241
242out:
243 kfree(fh);
244 return err;
245
246fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800247 pr_warn_ratelimited("failed to encode file handle (%pd2, err=%i, buflen=%d, len=%d, type=%d)\n",
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200248 dentry, err, buflen, fh ? (int)fh->fb.len : 0,
249 fh ? fh->fb.type : 0);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300250 goto out;
251}
252
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200253static int ovl_encode_fh(struct inode *inode, u32 *fid, int *max_len,
254 struct inode *parent)
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300255{
256 struct dentry *dentry;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200257 int bytes = *max_len << 2;
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300258
259 /* TODO: encode connectable file handles */
260 if (parent)
261 return FILEID_INVALID;
262
263 dentry = d_find_any_alias(inode);
264 if (WARN_ON(!dentry))
265 return FILEID_INVALID;
266
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200267 bytes = ovl_dentry_to_fid(dentry, fid, bytes);
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300268 dput(dentry);
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200269 if (bytes <= 0)
270 return FILEID_INVALID;
271
272 *max_len = bytes >> 2;
273
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);
311 if (!dentry) {
312 dentry = d_alloc_anon(inode->i_sb);
313 if (!dentry)
314 goto nomem;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200315 oe = ovl_alloc_entry(lower ? 1 : 0);
Amir Goldstein8556a422018-01-19 01:03:23 +0200316 if (!oe)
317 goto nomem;
318
Amir Goldsteinf9418662018-01-19 21:33:44 +0200319 if (lower) {
320 oe->lowerstack->dentry = dget(lower);
321 oe->lowerstack->layer = lowerpath->layer;
322 }
Amir Goldstein8556a422018-01-19 01:03:23 +0200323 dentry->d_fsdata = oe;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200324 if (upper_alias)
Amir Goldsteinf9418662018-01-19 21:33:44 +0200325 ovl_dentry_set_upper_alias(dentry);
Amir Goldstein8556a422018-01-19 01:03:23 +0200326 }
327
328 return d_instantiate_anon(dentry, inode);
329
330nomem:
331 iput(inode);
332 dput(dentry);
333 return ERR_PTR(-ENOMEM);
334}
335
Amir Goldstein98892512018-01-17 22:32:44 +0200336/* Get the upper or lower dentry in stach whose on layer @idx */
337static struct dentry *ovl_dentry_real_at(struct dentry *dentry, int idx)
338{
339 struct ovl_entry *oe = dentry->d_fsdata;
340 int i;
341
342 if (!idx)
343 return ovl_dentry_upper(dentry);
344
345 for (i = 0; i < oe->numlower; i++) {
346 if (oe->lowerstack[i].layer->idx == idx)
347 return oe->lowerstack[i].dentry;
348 }
349
350 return NULL;
351}
352
Amir Goldstein3985b702017-12-28 18:36:16 +0200353/*
354 * Lookup a child overlay dentry to get a connected overlay dentry whose real
355 * dentry is @real. If @real is on upper layer, we lookup a child overlay
356 * dentry with the same name as the real dentry. Otherwise, we need to consult
357 * index for lookup.
358 */
359static struct dentry *ovl_lookup_real_one(struct dentry *connected,
360 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100361 const struct ovl_layer *layer)
Amir Goldstein3985b702017-12-28 18:36:16 +0200362{
363 struct inode *dir = d_inode(connected);
364 struct dentry *this, *parent = NULL;
365 struct name_snapshot name;
366 int err;
367
Amir Goldstein3985b702017-12-28 18:36:16 +0200368 /*
369 * Lookup child overlay dentry by real name. The dir mutex protects us
370 * from racing with overlay rename. If the overlay dentry that is above
371 * real has already been moved to a parent that is not under the
372 * connected overlay dir, we return -ECHILD and restart the lookup of
373 * connected real path from the top.
374 */
375 inode_lock_nested(dir, I_MUTEX_PARENT);
376 err = -ECHILD;
377 parent = dget_parent(real);
Amir Goldstein98892512018-01-17 22:32:44 +0200378 if (ovl_dentry_real_at(connected, layer->idx) != parent)
Amir Goldstein3985b702017-12-28 18:36:16 +0200379 goto fail;
380
381 /*
382 * We also need to take a snapshot of real dentry name to protect us
383 * from racing with underlying layer rename. In this case, we don't
384 * care about returning ESTALE, only from dereferencing a free name
385 * pointer because we hold no lock on the real dentry.
386 */
387 take_dentry_name_snapshot(&name, real);
Al Viro230c6402019-04-26 13:07:27 -0400388 this = lookup_one_len(name.name.name, connected, name.name.len);
Amir Goldstein3985b702017-12-28 18:36:16 +0200389 err = PTR_ERR(this);
390 if (IS_ERR(this)) {
391 goto fail;
392 } else if (!this || !this->d_inode) {
393 dput(this);
394 err = -ENOENT;
395 goto fail;
Amir Goldstein98892512018-01-17 22:32:44 +0200396 } else if (ovl_dentry_real_at(this, layer->idx) != real) {
Amir Goldstein3985b702017-12-28 18:36:16 +0200397 dput(this);
398 err = -ESTALE;
399 goto fail;
400 }
401
402out:
403 release_dentry_name_snapshot(&name);
404 dput(parent);
405 inode_unlock(dir);
406 return this;
407
408fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800409 pr_warn_ratelimited("failed to lookup one by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
Amir Goldstein3985b702017-12-28 18:36:16 +0200410 real, layer->idx, connected, err);
411 this = ERR_PTR(err);
412 goto out;
413}
414
Amir Goldstein06170152018-01-17 14:40:27 +0200415static struct dentry *ovl_lookup_real(struct super_block *sb,
416 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100417 const struct ovl_layer *layer);
Amir Goldstein06170152018-01-17 14:40:27 +0200418
Amir Goldstein3985b702017-12-28 18:36:16 +0200419/*
Amir Goldstein4b91c302018-01-18 16:39:13 +0200420 * Lookup an indexed or hashed overlay dentry by real inode.
421 */
422static struct dentry *ovl_lookup_real_inode(struct super_block *sb,
423 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100424 const struct ovl_layer *layer)
Amir Goldstein4b91c302018-01-18 16:39:13 +0200425{
Amir Goldstein06170152018-01-17 14:40:27 +0200426 struct ovl_fs *ofs = sb->s_fs_info;
Amir Goldstein06170152018-01-17 14:40:27 +0200427 struct dentry *index = NULL;
Amir Goldstein4b91c302018-01-18 16:39:13 +0200428 struct dentry *this = NULL;
429 struct inode *inode;
430
Amir Goldstein06170152018-01-17 14:40:27 +0200431 /*
432 * Decoding upper dir from index is expensive, so first try to lookup
433 * overlay dentry in inode/dcache.
434 */
Amir Goldstein4b91c302018-01-18 16:39:13 +0200435 inode = ovl_lookup_inode(sb, real, !layer->idx);
436 if (IS_ERR(inode))
437 return ERR_CAST(inode);
438 if (inode) {
439 this = d_find_any_alias(inode);
440 iput(inode);
441 }
442
Amir Goldstein06170152018-01-17 14:40:27 +0200443 /*
444 * For decoded lower dir file handle, lookup index by origin to check
445 * if lower dir was copied up and and/or removed.
446 */
447 if (!this && layer->idx && ofs->indexdir && !WARN_ON(!d_is_dir(real))) {
448 index = ovl_lookup_index(ofs, NULL, real, false);
449 if (IS_ERR(index))
450 return index;
451 }
452
453 /* Get connected upper overlay dir from index */
454 if (index) {
455 struct dentry *upper = ovl_index_upper(ofs, index);
456
457 dput(index);
458 if (IS_ERR_OR_NULL(upper))
459 return upper;
460
461 /*
462 * ovl_lookup_real() in lower layer may call recursively once to
463 * ovl_lookup_real() in upper layer. The first level call walks
464 * back lower parents to the topmost indexed parent. The second
465 * recursive call walks back from indexed upper to the topmost
466 * connected/hashed upper parent (or up to root).
467 */
Amir Goldstein94375f92019-11-15 14:12:40 +0200468 this = ovl_lookup_real(sb, upper, &ofs->layers[0]);
Amir Goldstein06170152018-01-17 14:40:27 +0200469 dput(upper);
470 }
471
Amir Goldstein71681792018-01-30 14:30:50 +0200472 if (IS_ERR_OR_NULL(this))
473 return this;
Amir Goldstein4b91c302018-01-18 16:39:13 +0200474
475 if (WARN_ON(ovl_dentry_real_at(this, layer->idx) != real)) {
476 dput(this);
477 this = ERR_PTR(-EIO);
478 }
479
480 return this;
481}
482
483/*
484 * Lookup an indexed or hashed overlay dentry, whose real dentry is an
485 * ancestor of @real.
486 */
487static struct dentry *ovl_lookup_real_ancestor(struct super_block *sb,
488 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100489 const struct ovl_layer *layer)
Amir Goldstein4b91c302018-01-18 16:39:13 +0200490{
491 struct dentry *next, *parent = NULL;
492 struct dentry *ancestor = ERR_PTR(-EIO);
493
494 if (real == layer->mnt->mnt_root)
495 return dget(sb->s_root);
496
497 /* Find the topmost indexed or hashed ancestor */
498 next = dget(real);
499 for (;;) {
500 parent = dget_parent(next);
501
502 /*
503 * Lookup a matching overlay dentry in inode/dentry
504 * cache or in index by real inode.
505 */
506 ancestor = ovl_lookup_real_inode(sb, next, layer);
507 if (ancestor)
508 break;
509
510 if (parent == layer->mnt->mnt_root) {
511 ancestor = dget(sb->s_root);
512 break;
513 }
514
515 /*
516 * If @real has been moved out of the layer root directory,
517 * we will eventully hit the real fs root. This cannot happen
518 * by legit overlay rename, so we return error in that case.
519 */
520 if (parent == next) {
521 ancestor = ERR_PTR(-EXDEV);
522 break;
523 }
524
525 dput(next);
526 next = parent;
527 }
528
529 dput(parent);
530 dput(next);
531
532 return ancestor;
533}
534
535/*
Amir Goldstein3985b702017-12-28 18:36:16 +0200536 * Lookup a connected overlay dentry whose real dentry is @real.
537 * If @real is on upper layer, we lookup a child overlay dentry with the same
538 * path the real dentry. Otherwise, we need to consult index for lookup.
539 */
540static struct dentry *ovl_lookup_real(struct super_block *sb,
541 struct dentry *real,
Miklos Szeredi13464162020-01-24 09:46:45 +0100542 const struct ovl_layer *layer)
Amir Goldstein3985b702017-12-28 18:36:16 +0200543{
544 struct dentry *connected;
545 int err = 0;
546
Amir Goldstein4b91c302018-01-18 16:39:13 +0200547 connected = ovl_lookup_real_ancestor(sb, real, layer);
548 if (IS_ERR(connected))
549 return connected;
Amir Goldstein3985b702017-12-28 18:36:16 +0200550
Amir Goldstein3985b702017-12-28 18:36:16 +0200551 while (!err) {
552 struct dentry *next, *this;
553 struct dentry *parent = NULL;
Amir Goldstein98892512018-01-17 22:32:44 +0200554 struct dentry *real_connected = ovl_dentry_real_at(connected,
555 layer->idx);
Amir Goldstein3985b702017-12-28 18:36:16 +0200556
557 if (real_connected == real)
558 break;
559
560 /* Find the topmost dentry not yet connected */
561 next = dget(real);
562 for (;;) {
563 parent = dget_parent(next);
564
565 if (parent == real_connected)
566 break;
567
568 /*
569 * If real has been moved out of 'real_connected',
570 * we will not find 'real_connected' and hit the layer
571 * root. In that case, we need to restart connecting.
572 * This game can go on forever in the worst case. We
573 * may want to consider taking s_vfs_rename_mutex if
574 * this happens more than once.
575 */
576 if (parent == layer->mnt->mnt_root) {
577 dput(connected);
578 connected = dget(sb->s_root);
579 break;
580 }
581
582 /*
583 * If real file has been moved out of the layer root
584 * directory, we will eventully hit the real fs root.
585 * This cannot happen by legit overlay rename, so we
586 * return error in that case.
587 */
588 if (parent == next) {
589 err = -EXDEV;
590 break;
591 }
592
593 dput(next);
594 next = parent;
595 }
596
597 if (!err) {
598 this = ovl_lookup_real_one(connected, next, layer);
599 if (IS_ERR(this))
600 err = PTR_ERR(this);
601
602 /*
603 * Lookup of child in overlay can fail when racing with
604 * overlay rename of child away from 'connected' parent.
605 * In this case, we need to restart the lookup from the
606 * top, because we cannot trust that 'real_connected' is
Amir Goldstein4b91c302018-01-18 16:39:13 +0200607 * still an ancestor of 'real'. There is a good chance
608 * that the renamed overlay ancestor is now in cache, so
609 * ovl_lookup_real_ancestor() will find it and we can
610 * continue to connect exactly from where lookup failed.
Amir Goldstein3985b702017-12-28 18:36:16 +0200611 */
612 if (err == -ECHILD) {
Amir Goldstein4b91c302018-01-18 16:39:13 +0200613 this = ovl_lookup_real_ancestor(sb, real,
614 layer);
Fengguang Wub5095f22018-02-06 00:25:16 +0800615 err = PTR_ERR_OR_ZERO(this);
Amir Goldstein3985b702017-12-28 18:36:16 +0200616 }
617 if (!err) {
618 dput(connected);
619 connected = this;
620 }
621 }
622
623 dput(parent);
624 dput(next);
625 }
626
627 if (err)
628 goto fail;
629
630 return connected;
631
632fail:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800633 pr_warn_ratelimited("failed to lookup by real (%pd2, layer=%d, connected=%pd2, err=%i)\n",
Amir Goldstein3985b702017-12-28 18:36:16 +0200634 real, layer->idx, connected, err);
635 dput(connected);
636 return ERR_PTR(err);
637}
638
639/*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200640 * Get an overlay dentry from upper/lower real dentries and index.
Amir Goldstein3985b702017-12-28 18:36:16 +0200641 */
642static struct dentry *ovl_get_dentry(struct super_block *sb,
643 struct dentry *upper,
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200644 struct ovl_path *lowerpath,
645 struct dentry *index)
Amir Goldstein3985b702017-12-28 18:36:16 +0200646{
647 struct ovl_fs *ofs = sb->s_fs_info;
Miklos Szeredi13464162020-01-24 09:46:45 +0100648 const struct ovl_layer *layer = upper ? &ofs->layers[0] : lowerpath->layer;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200649 struct dentry *real = upper ?: (index ?: lowerpath->dentry);
Amir Goldstein3985b702017-12-28 18:36:16 +0200650
Amir Goldsteinf9418662018-01-19 21:33:44 +0200651 /*
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200652 * Obtain a disconnected overlay dentry from a non-dir real dentry
653 * and index.
Amir Goldsteinf9418662018-01-19 21:33:44 +0200654 */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200655 if (!d_is_dir(real))
656 return ovl_obtain_alias(sb, upper, lowerpath, index);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200657
Amir Goldstein3985b702017-12-28 18:36:16 +0200658 /* Removed empty directory? */
Amir Goldstein98892512018-01-17 22:32:44 +0200659 if ((real->d_flags & DCACHE_DISCONNECTED) || d_unhashed(real))
Amir Goldstein3985b702017-12-28 18:36:16 +0200660 return ERR_PTR(-ENOENT);
661
662 /*
Amir Goldstein98892512018-01-17 22:32:44 +0200663 * If real dentry is connected and hashed, get a connected overlay
664 * dentry whose real dentry is @real.
Amir Goldstein3985b702017-12-28 18:36:16 +0200665 */
Amir Goldstein98892512018-01-17 22:32:44 +0200666 return ovl_lookup_real(sb, real, layer);
Amir Goldstein3985b702017-12-28 18:36:16 +0200667}
668
Amir Goldstein8556a422018-01-19 01:03:23 +0200669static struct dentry *ovl_upper_fh_to_d(struct super_block *sb,
670 struct ovl_fh *fh)
671{
672 struct ovl_fs *ofs = sb->s_fs_info;
673 struct dentry *dentry;
674 struct dentry *upper;
675
676 if (!ofs->upper_mnt)
677 return ERR_PTR(-EACCES);
678
Amir Goldstein8a22efa2018-03-09 15:51:02 +0200679 upper = ovl_decode_real_fh(fh, ofs->upper_mnt, true);
Amir Goldstein8556a422018-01-19 01:03:23 +0200680 if (IS_ERR_OR_NULL(upper))
681 return upper;
682
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200683 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
Amir Goldstein8556a422018-01-19 01:03:23 +0200684 dput(upper);
685
686 return dentry;
687}
688
Amir Goldsteinf9418662018-01-19 21:33:44 +0200689static struct dentry *ovl_lower_fh_to_d(struct super_block *sb,
690 struct ovl_fh *fh)
691{
692 struct ovl_fs *ofs = sb->s_fs_info;
693 struct ovl_path origin = { };
694 struct ovl_path *stack = &origin;
695 struct dentry *dentry = NULL;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200696 struct dentry *index = NULL;
Amir Goldstein8b589242018-03-09 17:05:55 +0200697 struct inode *inode;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200698 int err;
699
Amir Goldstein8b589242018-03-09 17:05:55 +0200700 /* First lookup overlay inode in inode cache by origin fh */
701 err = ovl_check_origin_fh(ofs, fh, false, NULL, &stack);
702 if (err)
703 return ERR_PTR(err);
704
705 if (!d_is_dir(origin.dentry) ||
706 !(origin.dentry->d_flags & DCACHE_DISCONNECTED)) {
707 inode = ovl_lookup_inode(sb, origin.dentry, false);
708 err = PTR_ERR(inode);
709 if (IS_ERR(inode))
710 goto out_err;
711 if (inode) {
712 dentry = d_find_any_alias(inode);
713 iput(inode);
714 if (dentry)
715 goto out;
716 }
717 }
718
719 /* Then lookup indexed upper/whiteout by origin fh */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200720 if (ofs->indexdir) {
721 index = ovl_get_index_fh(ofs, fh);
722 err = PTR_ERR(index);
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200723 if (IS_ERR(index)) {
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200724 index = NULL;
Amir Goldstein8b589242018-03-09 17:05:55 +0200725 goto out_err;
Amir Goldstein9436a1a2017-12-24 18:28:04 +0200726 }
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200727 }
728
Amir Goldstein8b589242018-03-09 17:05:55 +0200729 /* Then try to get a connected upper dir by index */
Amir Goldstein3b0bfc62017-12-24 18:42:16 +0200730 if (index && d_is_dir(index)) {
731 struct dentry *upper = ovl_index_upper(ofs, index);
732
733 err = PTR_ERR(upper);
734 if (IS_ERR_OR_NULL(upper))
735 goto out_err;
736
737 dentry = ovl_get_dentry(sb, upper, NULL, NULL);
738 dput(upper);
739 goto out;
740 }
741
Amir Goldstein155b8a02018-11-05 07:50:10 +0200742 /* Find origin.dentry again with ovl_acceptable() layer check */
743 if (d_is_dir(origin.dentry)) {
Amir Goldstein8b589242018-03-09 17:05:55 +0200744 dput(origin.dentry);
745 origin.dentry = NULL;
746 err = ovl_check_origin_fh(ofs, fh, true, NULL, &stack);
747 if (err)
748 goto out_err;
749 }
750 if (index) {
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200751 err = ovl_verify_origin(index, origin.dentry, false);
752 if (err)
753 goto out_err;
754 }
Amir Goldsteinf9418662018-01-19 21:33:44 +0200755
Amir Goldstein155b8a02018-11-05 07:50:10 +0200756 /* Get a connected non-upper dir or disconnected non-dir */
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200757 dentry = ovl_get_dentry(sb, NULL, &origin, index);
758
759out:
Amir Goldsteinf9418662018-01-19 21:33:44 +0200760 dput(origin.dentry);
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200761 dput(index);
Amir Goldsteinf9418662018-01-19 21:33:44 +0200762 return dentry;
Amir Goldsteinf71bd9c2018-01-19 21:36:20 +0200763
764out_err:
765 dentry = ERR_PTR(err);
766 goto out;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200767}
768
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200769static struct ovl_fh *ovl_fid_to_fh(struct fid *fid, int buflen, int fh_type)
770{
771 struct ovl_fh *fh;
772
773 /* If on-wire inner fid is aligned - nothing to do */
774 if (fh_type == OVL_FILEID_V1)
775 return (struct ovl_fh *)fid;
776
777 if (fh_type != OVL_FILEID_V0)
778 return ERR_PTR(-EINVAL);
779
780 fh = kzalloc(buflen, GFP_KERNEL);
781 if (!fh)
782 return ERR_PTR(-ENOMEM);
783
784 /* Copy unaligned inner fh into aligned buffer */
785 memcpy(&fh->fb, fid, buflen - OVL_FH_WIRE_OFFSET);
786 return fh;
787}
788
Amir Goldstein8556a422018-01-19 01:03:23 +0200789static struct dentry *ovl_fh_to_dentry(struct super_block *sb, struct fid *fid,
790 int fh_len, int fh_type)
791{
792 struct dentry *dentry = NULL;
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200793 struct ovl_fh *fh = NULL;
Amir Goldstein8556a422018-01-19 01:03:23 +0200794 int len = fh_len << 2;
795 unsigned int flags = 0;
796 int err;
797
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200798 fh = ovl_fid_to_fh(fid, len, fh_type);
799 err = PTR_ERR(fh);
800 if (IS_ERR(fh))
Amir Goldstein8556a422018-01-19 01:03:23 +0200801 goto out_err;
802
803 err = ovl_check_fh_len(fh, len);
804 if (err)
805 goto out_err;
806
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200807 flags = fh->fb.flags;
Amir Goldsteinf9418662018-01-19 21:33:44 +0200808 dentry = (flags & OVL_FH_FLAG_PATH_UPPER) ?
809 ovl_upper_fh_to_d(sb, fh) :
810 ovl_lower_fh_to_d(sb, fh);
Amir Goldstein8556a422018-01-19 01:03:23 +0200811 err = PTR_ERR(dentry);
812 if (IS_ERR(dentry) && err != -ESTALE)
813 goto out_err;
814
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200815out:
816 /* We may have needed to re-align OVL_FILEID_V0 */
817 if (!IS_ERR_OR_NULL(fh) && fh != (void *)fid)
818 kfree(fh);
819
Amir Goldstein8556a422018-01-19 01:03:23 +0200820 return dentry;
821
822out_err:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800823 pr_warn_ratelimited("failed to decode file handle (len=%d, type=%d, flags=%x, err=%i)\n",
Amir Goldsteincbe7fba2019-11-15 13:33:03 +0200824 fh_len, fh_type, flags, err);
825 dentry = ERR_PTR(err);
826 goto out;
Amir Goldstein8556a422018-01-19 01:03:23 +0200827}
828
Amir Goldstein3985b702017-12-28 18:36:16 +0200829static struct dentry *ovl_fh_to_parent(struct super_block *sb, struct fid *fid,
830 int fh_len, int fh_type)
831{
lijiazi1bd0a3a2019-12-16 19:12:32 +0800832 pr_warn_ratelimited("connectable file handles not supported; use 'no_subtree_check' exportfs option.\n");
Amir Goldstein3985b702017-12-28 18:36:16 +0200833 return ERR_PTR(-EACCES);
834}
835
836static int ovl_get_name(struct dentry *parent, char *name,
837 struct dentry *child)
838{
839 /*
840 * ovl_fh_to_dentry() returns connected dir overlay dentries and
841 * ovl_fh_to_parent() is not implemented, so we should not get here.
842 */
843 WARN_ON_ONCE(1);
844 return -EIO;
845}
846
847static struct dentry *ovl_get_parent(struct dentry *dentry)
848{
849 /*
850 * ovl_fh_to_dentry() returns connected dir overlay dentries, so we
851 * should not get here.
852 */
853 WARN_ON_ONCE(1);
854 return ERR_PTR(-EIO);
855}
856
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300857const struct export_operations ovl_export_operations = {
Amir Goldstein5b2cccd2018-02-02 10:42:03 +0200858 .encode_fh = ovl_encode_fh,
Amir Goldstein8556a422018-01-19 01:03:23 +0200859 .fh_to_dentry = ovl_fh_to_dentry,
Amir Goldstein3985b702017-12-28 18:36:16 +0200860 .fh_to_parent = ovl_fh_to_parent,
861 .get_name = ovl_get_name,
862 .get_parent = ovl_get_parent,
Amir Goldstein8ed5eec2017-07-12 14:17:16 +0300863};