]> git.ipfire.org Git - thirdparty/kernel/linux.git/blame - fs/overlayfs/super.c
ovl: make use of ->layers safe in rcu pathwalk
[thirdparty/kernel/linux.git] / fs / overlayfs / super.c
CommitLineData
d2912cb1 1// SPDX-License-Identifier: GPL-2.0-only
e9be9d5e
MS
2/*
3 *
4 * Copyright (C) 2011 Novell Inc.
e9be9d5e
MS
5 */
6
5b825c3a 7#include <uapi/linux/magic.h>
e9be9d5e
MS
8#include <linux/fs.h>
9#include <linux/namei.h>
10#include <linux/xattr.h>
e9be9d5e 11#include <linux/mount.h>
e9be9d5e
MS
12#include <linux/parser.h>
13#include <linux/module.h>
cc259639 14#include <linux/statfs.h>
f45827e8 15#include <linux/seq_file.h>
d837a49b 16#include <linux/posix_acl_xattr.h>
e487d889 17#include <linux/exportfs.h>
2b1a7746 18#include <linux/file.h>
1784fbc2 19#include <linux/fs_context.h>
dcb399de 20#include <linux/fs_parser.h>
e9be9d5e 21#include "overlayfs.h"
7fb7998b 22#include "params.h"
e9be9d5e
MS
23
24MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
25MODULE_DESCRIPTION("Overlay filesystem");
26MODULE_LICENSE("GPL");
27
e9be9d5e
MS
28
29struct ovl_dir_cache;
30
2d902671 31static struct dentry *ovl_d_real(struct dentry *dentry,
fb16043b 32 const struct inode *inode)
d101a125 33{
cef4cbff 34 struct dentry *real = NULL, *lower;
184996e9 35 int err;
d101a125 36
e8c985ba
MS
37 /* It's an overlay file */
38 if (inode && d_inode(dentry) == inode)
39 return dentry;
40
ca4c8a3a 41 if (!d_is_reg(dentry)) {
d101a125
MS
42 if (!inode || inode == d_inode(dentry))
43 return dentry;
44 goto bug;
45 }
46
47 real = ovl_dentry_upper(dentry);
2c3d7358 48 if (real && (inode == d_inode(real)))
d101a125
MS
49 return real;
50
2c3d7358
VG
51 if (real && !inode && ovl_has_upperdata(d_inode(dentry)))
52 return real;
53
41665644 54 /*
42dd69ae 55 * Best effort lazy lookup of lowerdata for !inode case to return
41665644
AG
56 * the real lowerdata dentry. The only current caller of d_real() with
57 * NULL inode is d_real_inode() from trace_uprobe and this caller is
58 * likely going to be followed reading from the file, before placing
59 * uprobes on offset within the file, so lowerdata should be available
60 * when setting the uprobe.
61 */
184996e9
AL
62 err = ovl_verify_lowerdata(dentry);
63 if (err)
64 goto bug;
cef4cbff
MS
65 lower = ovl_dentry_lowerdata(dentry);
66 if (!lower)
d101a125 67 goto bug;
cef4cbff 68 real = lower;
d101a125 69
c4fcfc16 70 /* Handle recursion */
fb16043b 71 real = d_real(real, inode);
c4fcfc16 72
d101a125
MS
73 if (!inode || inode == d_inode(real))
74 return real;
d101a125 75bug:
cef4cbff
MS
76 WARN(1, "%s(%pd4, %s:%lu): real dentry (%p/%lu) not found\n",
77 __func__, dentry, inode ? inode->i_sb->s_id : "NULL",
78 inode ? inode->i_ino : 0, real,
79 real && d_inode(real) ? d_inode(real)->i_ino : 0);
d101a125
MS
80 return dentry;
81}
82
3bb7df92 83static int ovl_revalidate_real(struct dentry *d, unsigned int flags, bool weak)
7c03b5d4 84{
7c03b5d4
MS
85 int ret = 1;
86
41665644
AG
87 if (!d)
88 return 1;
89
3bb7df92
MS
90 if (weak) {
91 if (d->d_flags & DCACHE_OP_WEAK_REVALIDATE)
92 ret = d->d_op->d_weak_revalidate(d, flags);
93 } else if (d->d_flags & DCACHE_OP_REVALIDATE) {
94 ret = d->d_op->d_revalidate(d, flags);
95 if (!ret) {
96 if (!(flags & LOOKUP_RCU))
97 d_invalidate(d);
98 ret = -ESTALE;
7c03b5d4
MS
99 }
100 }
3bb7df92 101 return ret;
7c03b5d4
MS
102}
103
3bb7df92
MS
104static int ovl_dentry_revalidate_common(struct dentry *dentry,
105 unsigned int flags, bool weak)
7c03b5d4 106{
c54719c9
AV
107 struct ovl_entry *oe;
108 struct ovl_path *lowerstack;
672e4268 109 struct inode *inode = d_inode_rcu(dentry);
bccece1e 110 struct dentry *upper;
7c03b5d4
MS
111 unsigned int i;
112 int ret = 1;
113
672e4268
CZ
114 /* Careful in RCU mode */
115 if (!inode)
116 return -ECHILD;
117
c54719c9
AV
118 oe = OVL_I_E(inode);
119 lowerstack = ovl_lowerstack(oe);
672e4268 120 upper = ovl_i_dentry_upper(inode);
bccece1e
MS
121 if (upper)
122 ret = ovl_revalidate_real(upper, flags, weak);
123
5522c9c7
AG
124 for (i = 0; ret > 0 && i < ovl_numlower(oe); i++)
125 ret = ovl_revalidate_real(lowerstack[i].dentry, flags, weak);
126
7c03b5d4
MS
127 return ret;
128}
129
3bb7df92
MS
130static int ovl_dentry_revalidate(struct dentry *dentry, unsigned int flags)
131{
132 return ovl_dentry_revalidate_common(dentry, flags, false);
133}
134
135static int ovl_dentry_weak_revalidate(struct dentry *dentry, unsigned int flags)
136{
137 return ovl_dentry_revalidate_common(dentry, flags, true);
138}
139
e9be9d5e 140static const struct dentry_operations ovl_dentry_operations = {
d101a125 141 .d_real = ovl_d_real,
7c03b5d4
MS
142 .d_revalidate = ovl_dentry_revalidate,
143 .d_weak_revalidate = ovl_dentry_weak_revalidate,
144};
145
13cf199d
AG
146static struct kmem_cache *ovl_inode_cachep;
147
148static struct inode *ovl_alloc_inode(struct super_block *sb)
149{
fd60b288 150 struct ovl_inode *oi = alloc_inode_sb(sb, ovl_inode_cachep, GFP_KERNEL);
13cf199d 151
b3885bd6
HN
152 if (!oi)
153 return NULL;
154
04a01ac7 155 oi->cache = NULL;
cf31c463 156 oi->redirect = NULL;
04a01ac7 157 oi->version = 0;
13c72075 158 oi->flags = 0;
09d8b586 159 oi->__upperdentry = NULL;
2b21da92 160 oi->lowerdata_redirect = NULL;
0af950f5 161 oi->oe = NULL;
a015dafc 162 mutex_init(&oi->lock);
25b7713a 163
13cf199d
AG
164 return &oi->vfs_inode;
165}
166
0b269ded 167static void ovl_free_inode(struct inode *inode)
13cf199d 168{
0b269ded 169 struct ovl_inode *oi = OVL_I(inode);
13cf199d 170
0b269ded 171 kfree(oi->redirect);
d9e8319a 172 kfree(oi->oe);
0b269ded
AV
173 mutex_destroy(&oi->lock);
174 kmem_cache_free(ovl_inode_cachep, oi);
13cf199d
AG
175}
176
177static void ovl_destroy_inode(struct inode *inode)
178{
09d8b586
MS
179 struct ovl_inode *oi = OVL_I(inode);
180
181 dput(oi->__upperdentry);
d9e8319a 182 ovl_stack_put(ovl_lowerstack(oi->oe), ovl_numlower(oi->oe));
2664bd08
VG
183 if (S_ISDIR(inode->i_mode))
184 ovl_dir_cache_free(inode);
2b21da92
AG
185 else
186 kfree(oi->lowerdata_redirect);
13cf199d
AG
187}
188
a9075cdb
MS
189static void ovl_put_super(struct super_block *sb)
190{
f01d0889 191 struct ovl_fs *ofs = OVL_FS(sb);
a9075cdb 192
1784fbc2
CB
193 if (ofs)
194 ovl_free_fs(ofs);
a9075cdb
MS
195}
196
e8d4bfe3 197/* Sync real dirty inodes in upper filesystem (if it exists) */
e593b2bf
AG
198static int ovl_sync_fs(struct super_block *sb, int wait)
199{
f01d0889 200 struct ovl_fs *ofs = OVL_FS(sb);
e593b2bf
AG
201 struct super_block *upper_sb;
202 int ret;
203
335d3fc5
SD
204 ret = ovl_sync_status(ofs);
205 /*
206 * We have to always set the err, because the return value isn't
207 * checked in syncfs, and instead indirectly return an error via
208 * the sb's writeback errseq, which VFS inspects after this call.
209 */
210 if (ret < 0) {
211 errseq_set(&sb->s_wb_err, -EIO);
212 return -EIO;
213 }
214
215 if (!ret)
216 return ret;
e8d4bfe3
CX
217
218 /*
32b1924b
KK
219 * Not called for sync(2) call or an emergency sync (SB_I_SKIP_SYNC).
220 * All the super blocks will be iterated, including upper_sb.
e8d4bfe3
CX
221 *
222 * If this is a syncfs(2) call, then we do need to call
223 * sync_filesystem() on upper_sb, but enough if we do it when being
224 * called with wait == 1.
225 */
226 if (!wait)
e593b2bf
AG
227 return 0;
228
08f4c7c8 229 upper_sb = ovl_upper_mnt(ofs)->mnt_sb;
e8d4bfe3 230
e593b2bf 231 down_read(&upper_sb->s_umount);
e8d4bfe3 232 ret = sync_filesystem(upper_sb);
e593b2bf 233 up_read(&upper_sb->s_umount);
e8d4bfe3 234
e593b2bf
AG
235 return ret;
236}
237
cc259639
AW
238/**
239 * ovl_statfs
9c5dd803 240 * @dentry: The dentry to query
cc259639
AW
241 * @buf: The struct kstatfs to fill in with stats
242 *
243 * Get the filesystem statistics. As writes always target the upper layer
4ebc5818 244 * filesystem pass the statfs to the upper filesystem (if it exists)
cc259639
AW
245 */
246static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
247{
b0504bfe
AG
248 struct super_block *sb = dentry->d_sb;
249 struct ovl_fs *ofs = OVL_FS(sb);
250 struct dentry *root_dentry = sb->s_root;
cc259639
AW
251 struct path path;
252 int err;
253
4ebc5818 254 ovl_path_real(root_dentry, &path);
cc259639
AW
255
256 err = vfs_statfs(&path, buf);
257 if (!err) {
6b2d5fe4 258 buf->f_namelen = ofs->namelen;
cc259639 259 buf->f_type = OVERLAYFS_SUPER_MAGIC;
b0504bfe
AG
260 if (ovl_has_fsid(ofs))
261 buf->f_fsid = uuid_to_fsid(sb->s_uuid.b);
cc259639
AW
262 }
263
264 return err;
265}
266
e9be9d5e 267static const struct super_operations ovl_super_operations = {
13cf199d 268 .alloc_inode = ovl_alloc_inode,
0b269ded 269 .free_inode = ovl_free_inode,
13cf199d
AG
270 .destroy_inode = ovl_destroy_inode,
271 .drop_inode = generic_delete_inode,
e9be9d5e 272 .put_super = ovl_put_super,
e593b2bf 273 .sync_fs = ovl_sync_fs,
cc259639 274 .statfs = ovl_statfs,
f45827e8 275 .show_options = ovl_show_options,
e9be9d5e
MS
276};
277
e9be9d5e 278#define OVL_WORKDIR_NAME "work"
02bcd157 279#define OVL_INDEXDIR_NAME "index"
e9be9d5e 280
ad204488 281static struct dentry *ovl_workdir_create(struct ovl_fs *ofs,
6b8aa129 282 const char *name, bool persist)
e9be9d5e 283{
ad204488 284 struct inode *dir = ofs->workbasedir->d_inode;
08f4c7c8 285 struct vfsmount *mnt = ovl_upper_mnt(ofs);
e9be9d5e
MS
286 struct dentry *work;
287 int err;
288 bool retried = false;
289
5955102c 290 inode_lock_nested(dir, I_MUTEX_PARENT);
e9be9d5e 291retry:
22f289ce 292 work = ovl_lookup_upper(ofs, name, ofs->workbasedir, strlen(name));
e9be9d5e
MS
293
294 if (!IS_ERR(work)) {
c11b9fdd
MS
295 struct iattr attr = {
296 .ia_valid = ATTR_MODE,
32a3d848 297 .ia_mode = S_IFDIR | 0,
c11b9fdd 298 };
e9be9d5e
MS
299
300 if (work->d_inode) {
301 err = -EEXIST;
302 if (retried)
303 goto out_dput;
304
6b8aa129
AG
305 if (persist)
306 goto out_unlock;
307
e9be9d5e 308 retried = true;
576bb263 309 err = ovl_workdir_cleanup(ofs, dir, mnt, work, 0);
e9be9d5e 310 dput(work);
235ce9ed
AG
311 if (err == -EINVAL) {
312 work = ERR_PTR(err);
313 goto out_unlock;
314 }
e9be9d5e
MS
315 goto retry;
316 }
317
576bb263 318 err = ovl_mkdir_real(ofs, dir, &work, attr.ia_mode);
1f5573cf
MS
319 if (err)
320 goto out_dput;
321
322 /* Weird filesystem returning with hashed negative (kernfs)? */
323 err = -EINVAL;
324 if (d_really_is_negative(work))
325 goto out_dput;
c11b9fdd 326
cb348edb
MS
327 /*
328 * Try to remove POSIX ACL xattrs from workdir. We are good if:
329 *
330 * a) success (there was a POSIX ACL xattr and was removed)
331 * b) -ENODATA (there was no POSIX ACL xattr)
332 * c) -EOPNOTSUPP (POSIX ACL xattrs are not supported)
333 *
334 * There are various other error values that could effectively
335 * mean that the xattr doesn't exist (e.g. -ERANGE is returned
336 * if the xattr name is too long), but the set of filesystems
337 * allowed as upper are limited to "normal" ones, where checking
338 * for the above two errors is sufficient.
339 */
31acceb9 340 err = ovl_do_remove_acl(ofs, work, XATTR_NAME_POSIX_ACL_DEFAULT);
e1ff3dd1 341 if (err && err != -ENODATA && err != -EOPNOTSUPP)
c11b9fdd
MS
342 goto out_dput;
343
31acceb9 344 err = ovl_do_remove_acl(ofs, work, XATTR_NAME_POSIX_ACL_ACCESS);
e1ff3dd1 345 if (err && err != -ENODATA && err != -EOPNOTSUPP)
c11b9fdd
MS
346 goto out_dput;
347
348 /* Clear any inherited mode bits */
349 inode_lock(work->d_inode);
a15506ea 350 err = ovl_do_notify_change(ofs, work, &attr);
c11b9fdd
MS
351 inode_unlock(work->d_inode);
352 if (err)
353 goto out_dput;
6b8aa129
AG
354 } else {
355 err = PTR_ERR(work);
356 goto out_err;
e9be9d5e
MS
357 }
358out_unlock:
2068cf7d 359 inode_unlock(dir);
e9be9d5e
MS
360 return work;
361
362out_dput:
363 dput(work);
6b8aa129 364out_err:
1bd0a3ae 365 pr_warn("failed to create directory %s/%s (errno: %i); mounting read-only\n",
ad204488 366 ofs->config.workdir, name, -err);
6b8aa129 367 work = NULL;
e9be9d5e
MS
368 goto out_unlock;
369}
370
2d343087 371static int ovl_check_namelen(const struct path *path, struct ovl_fs *ofs,
6b2d5fe4 372 const char *name)
ab508822 373{
ab508822 374 struct kstatfs statfs;
6b2d5fe4
MS
375 int err = vfs_statfs(path, &statfs);
376
377 if (err)
1bd0a3ae 378 pr_err("statfs failed on '%s'\n", name);
6b2d5fe4
MS
379 else
380 ofs->namelen = max(ofs->namelen, statfs.f_namelen);
381
382 return err;
383}
384
385static int ovl_lower_dir(const char *name, struct path *path,
f4288844 386 struct ovl_fs *ofs, int *stack_depth)
6b2d5fe4 387{
e487d889 388 int fh_type;
6b2d5fe4 389 int err;
ab508822 390
6b2d5fe4
MS
391 err = ovl_check_namelen(path, ofs, name);
392 if (err)
b8e42a65 393 return err;
6b2d5fe4 394
ab508822
MS
395 *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
396
02bcd157 397 /*
f168f109
AG
398 * The inodes index feature and NFS export need to encode and decode
399 * file handles, so they require that all layers support them.
02bcd157 400 */
e487d889 401 fh_type = ovl_can_decode_fh(path->dentry->d_sb);
f168f109 402 if ((ofs->config.nfs_export ||
e487d889 403 (ofs->config.index && ofs->config.upperdir)) && !fh_type) {
02bcd157 404 ofs->config.index = false;
f168f109 405 ofs->config.nfs_export = false;
1bd0a3ae 406 pr_warn("fs on '%s' does not support file handles, falling back to index=off,nfs_export=off.\n",
f168f109 407 name);
02bcd157 408 }
16aac5ad 409 ofs->nofh |= !fh_type;
b0e0f697
AG
410 /*
411 * Decoding origin file handle is required for persistent st_ino.
412 * Without persistent st_ino, xino=auto falls back to xino=off.
413 */
414 if (ofs->config.xino == OVL_XINO_AUTO &&
415 ofs->config.upperdir && !fh_type) {
416 ofs->config.xino = OVL_XINO_OFF;
417 pr_warn("fs on '%s' does not support file handles, falling back to xino=off.\n",
418 name);
419 }
02bcd157 420
e487d889
AG
421 /* Check if lower fs has 32bit inode numbers */
422 if (fh_type != FILEID_INO32_GEN)
0f831ec8 423 ofs->xino_mode = -1;
e487d889 424
ab508822 425 return 0;
ab508822
MS
426}
427
e9be9d5e
MS
428/* Workdir should not be subdir of upperdir and vice versa */
429static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
430{
431 bool ok = false;
432
433 if (workdir != upperdir) {
434 ok = (lock_rename(workdir, upperdir) == NULL);
435 unlock_rename(workdir, upperdir);
436 }
437 return ok;
438}
439
0eb45fc3
AG
440static int ovl_own_xattr_get(const struct xattr_handler *handler,
441 struct dentry *dentry, struct inode *inode,
442 const char *name, void *buffer, size_t size)
443{
48fab5d7 444 return -EOPNOTSUPP;
0eb45fc3
AG
445}
446
d837a49b 447static int ovl_own_xattr_set(const struct xattr_handler *handler,
39f60c1c 448 struct mnt_idmap *idmap,
d837a49b
MS
449 struct dentry *dentry, struct inode *inode,
450 const char *name, const void *value,
451 size_t size, int flags)
452{
48fab5d7 453 return -EOPNOTSUPP;
d837a49b
MS
454}
455
0eb45fc3
AG
456static int ovl_other_xattr_get(const struct xattr_handler *handler,
457 struct dentry *dentry, struct inode *inode,
458 const char *name, void *buffer, size_t size)
459{
1d88f183 460 return ovl_xattr_get(dentry, inode, name, buffer, size);
0eb45fc3
AG
461}
462
0e585ccc 463static int ovl_other_xattr_set(const struct xattr_handler *handler,
39f60c1c 464 struct mnt_idmap *idmap,
0e585ccc
AG
465 struct dentry *dentry, struct inode *inode,
466 const char *name, const void *value,
467 size_t size, int flags)
468{
1d88f183 469 return ovl_xattr_set(dentry, inode, name, value, size, flags);
0e585ccc
AG
470}
471
2d2f2d73
MS
472static const struct xattr_handler ovl_own_trusted_xattr_handler = {
473 .prefix = OVL_XATTR_TRUSTED_PREFIX,
474 .get = ovl_own_xattr_get,
475 .set = ovl_own_xattr_set,
476};
477
478static const struct xattr_handler ovl_own_user_xattr_handler = {
479 .prefix = OVL_XATTR_USER_PREFIX,
0eb45fc3 480 .get = ovl_own_xattr_get,
d837a49b
MS
481 .set = ovl_own_xattr_set,
482};
483
484static const struct xattr_handler ovl_other_xattr_handler = {
485 .prefix = "", /* catch all */
0eb45fc3 486 .get = ovl_other_xattr_get,
d837a49b
MS
487 .set = ovl_other_xattr_set,
488};
489
2d2f2d73 490static const struct xattr_handler *ovl_trusted_xattr_handlers[] = {
2d2f2d73
MS
491 &ovl_own_trusted_xattr_handler,
492 &ovl_other_xattr_handler,
493 NULL
494};
495
496static const struct xattr_handler *ovl_user_xattr_handlers[] = {
2d2f2d73 497 &ovl_own_user_xattr_handler,
d837a49b
MS
498 &ovl_other_xattr_handler,
499 NULL
500};
501
146d62e5
AG
502static int ovl_setup_trap(struct super_block *sb, struct dentry *dir,
503 struct inode **ptrap, const char *name)
504{
505 struct inode *trap;
506 int err;
507
508 trap = ovl_get_trap_inode(sb, dir);
1dac6f5b
AB
509 err = PTR_ERR_OR_ZERO(trap);
510 if (err) {
146d62e5 511 if (err == -ELOOP)
1bd0a3ae 512 pr_err("conflicting %s path\n", name);
146d62e5
AG
513 return err;
514 }
515
516 *ptrap = trap;
517 return 0;
518}
519
0be0bfd2
AG
520/*
521 * Determine how we treat concurrent use of upperdir/workdir based on the
522 * index feature. This is papering over mount leaks of container runtimes,
523 * for example, an old overlay mount is leaked and now its upperdir is
524 * attempted to be used as a lower layer in a new overlay mount.
525 */
526static int ovl_report_in_use(struct ovl_fs *ofs, const char *name)
527{
528 if (ofs->config.index) {
1bd0a3ae 529 pr_err("%s is in-use as upperdir/workdir of another mount, mount with '-o index=off' to override exclusive upperdir protection.\n",
0be0bfd2
AG
530 name);
531 return -EBUSY;
532 } else {
1bd0a3ae 533 pr_warn("%s is in-use as upperdir/workdir of another mount, accessing files from both mounts will result in undefined behavior.\n",
0be0bfd2
AG
534 name);
535 return 0;
536 }
537}
538
146d62e5 539static int ovl_get_upper(struct super_block *sb, struct ovl_fs *ofs,
b36a5780
CB
540 struct ovl_layer *upper_layer,
541 const struct path *upperpath)
6ee8acf0 542{
5064975e 543 struct vfsmount *upper_mnt;
6ee8acf0
MS
544 int err;
545
e21a6c57
AG
546 /* Upperdir path should not be r/o */
547 if (__mnt_is_readonly(upperpath->mnt)) {
1bd0a3ae 548 pr_err("upper fs is r/o, try multi-lower layers mount\n");
6ee8acf0
MS
549 err = -EINVAL;
550 goto out;
551 }
552
ad204488 553 err = ovl_check_namelen(upperpath, ofs, ofs->config.upperdir);
6ee8acf0
MS
554 if (err)
555 goto out;
556
b8e42a65 557 err = ovl_setup_trap(sb, upperpath->dentry, &upper_layer->trap,
146d62e5
AG
558 "upperdir");
559 if (err)
560 goto out;
561
5064975e
MS
562 upper_mnt = clone_private_mount(upperpath);
563 err = PTR_ERR(upper_mnt);
564 if (IS_ERR(upper_mnt)) {
1bd0a3ae 565 pr_err("failed to clone upperpath\n");
5064975e
MS
566 goto out;
567 }
568
569 /* Don't inherit atime flags */
570 upper_mnt->mnt_flags &= ~(MNT_NOATIME | MNT_NODIRATIME | MNT_RELATIME);
b8e42a65
MS
571 upper_layer->mnt = upper_mnt;
572 upper_layer->idx = 0;
573 upper_layer->fsid = 0;
8c25741a 574
654255fa
JX
575 /*
576 * Inherit SB_NOSEC flag from upperdir.
577 *
578 * This optimization changes behavior when a security related attribute
579 * (suid/sgid/security.*) is changed on an underlying layer. This is
580 * okay because we don't yet have guarantees in that case, but it will
581 * need careful treatment once we want to honour changes to underlying
582 * filesystems.
583 */
584 if (upper_mnt->mnt_sb->s_flags & SB_NOSEC)
585 sb->s_flags |= SB_NOSEC;
586
08f4c7c8 587 if (ovl_inuse_trylock(ovl_upper_mnt(ofs)->mnt_root)) {
8c25741a 588 ofs->upperdir_locked = true;
8c25741a 589 } else {
0be0bfd2
AG
590 err = ovl_report_in_use(ofs, "upperdir");
591 if (err)
592 goto out;
8c25741a
MS
593 }
594
6ee8acf0
MS
595 err = 0;
596out:
597 return err;
598}
599
cad218ab
AG
600/*
601 * Returns 1 if RENAME_WHITEOUT is supported, 0 if not supported and
602 * negative values if error is encountered.
603 */
576bb263 604static int ovl_check_rename_whiteout(struct ovl_fs *ofs)
cad218ab 605{
576bb263 606 struct dentry *workdir = ofs->workdir;
cad218ab
AG
607 struct inode *dir = d_inode(workdir);
608 struct dentry *temp;
609 struct dentry *dest;
610 struct dentry *whiteout;
611 struct name_snapshot name;
612 int err;
613
614 inode_lock_nested(dir, I_MUTEX_PARENT);
615
576bb263 616 temp = ovl_create_temp(ofs, workdir, OVL_CATTR(S_IFREG | 0));
cad218ab
AG
617 err = PTR_ERR(temp);
618 if (IS_ERR(temp))
619 goto out_unlock;
620
576bb263 621 dest = ovl_lookup_temp(ofs, workdir);
cad218ab
AG
622 err = PTR_ERR(dest);
623 if (IS_ERR(dest)) {
624 dput(temp);
625 goto out_unlock;
626 }
627
628 /* Name is inline and stable - using snapshot as a copy helper */
629 take_dentry_name_snapshot(&name, temp);
576bb263 630 err = ovl_do_rename(ofs, dir, temp, dir, dest, RENAME_WHITEOUT);
cad218ab
AG
631 if (err) {
632 if (err == -EINVAL)
633 err = 0;
634 goto cleanup_temp;
635 }
636
22f289ce 637 whiteout = ovl_lookup_upper(ofs, name.name.name, workdir, name.name.len);
cad218ab
AG
638 err = PTR_ERR(whiteout);
639 if (IS_ERR(whiteout))
640 goto cleanup_temp;
641
642 err = ovl_is_whiteout(whiteout);
643
644 /* Best effort cleanup of whiteout and temp file */
645 if (err)
576bb263 646 ovl_cleanup(ofs, dir, whiteout);
cad218ab
AG
647 dput(whiteout);
648
649cleanup_temp:
576bb263 650 ovl_cleanup(ofs, dir, temp);
cad218ab
AG
651 release_dentry_name_snapshot(&name);
652 dput(temp);
653 dput(dest);
654
655out_unlock:
656 inode_unlock(dir);
657
658 return err;
659}
660
576bb263
CB
661static struct dentry *ovl_lookup_or_create(struct ovl_fs *ofs,
662 struct dentry *parent,
c86243b0
VG
663 const char *name, umode_t mode)
664{
665 size_t len = strlen(name);
666 struct dentry *child;
667
668 inode_lock_nested(parent->d_inode, I_MUTEX_PARENT);
22f289ce 669 child = ovl_lookup_upper(ofs, name, parent, len);
c86243b0 670 if (!IS_ERR(child) && !child->d_inode)
576bb263 671 child = ovl_create_real(ofs, parent->d_inode, child,
c86243b0
VG
672 OVL_CATTR(mode));
673 inode_unlock(parent->d_inode);
674 dput(parent);
675
676 return child;
677}
678
679/*
680 * Creates $workdir/work/incompat/volatile/dirty file if it is not already
681 * present.
682 */
683static int ovl_create_volatile_dirty(struct ovl_fs *ofs)
684{
685 unsigned int ctr;
686 struct dentry *d = dget(ofs->workbasedir);
687 static const char *const volatile_path[] = {
688 OVL_WORKDIR_NAME, "incompat", "volatile", "dirty"
689 };
690 const char *const *name = volatile_path;
691
692 for (ctr = ARRAY_SIZE(volatile_path); ctr; ctr--, name++) {
576bb263 693 d = ovl_lookup_or_create(ofs, d, *name, ctr > 1 ? S_IFDIR : S_IFREG);
c86243b0
VG
694 if (IS_ERR(d))
695 return PTR_ERR(d);
696 }
697 dput(d);
698 return 0;
699}
700
146d62e5 701static int ovl_make_workdir(struct super_block *sb, struct ovl_fs *ofs,
2d343087 702 const struct path *workpath)
8ed61dc3 703{
08f4c7c8 704 struct vfsmount *mnt = ovl_upper_mnt(ofs);
2b1a7746
MS
705 struct dentry *workdir;
706 struct file *tmpfile;
d80172c2
AG
707 bool rename_whiteout;
708 bool d_type;
e487d889 709 int fh_type;
8ed61dc3
MS
710 int err;
711
2ba9d57e
AG
712 err = mnt_want_write(mnt);
713 if (err)
714 return err;
715
235ce9ed
AG
716 workdir = ovl_workdir_create(ofs, OVL_WORKDIR_NAME, false);
717 err = PTR_ERR(workdir);
718 if (IS_ERR_OR_NULL(workdir))
2ba9d57e 719 goto out;
8ed61dc3 720
235ce9ed
AG
721 ofs->workdir = workdir;
722
146d62e5
AG
723 err = ovl_setup_trap(sb, ofs->workdir, &ofs->workdir_trap, "workdir");
724 if (err)
725 goto out;
726
8ed61dc3
MS
727 /*
728 * Upper should support d_type, else whiteouts are visible. Given
729 * workdir and upper are on same fs, we can do iterate_dir() on
730 * workdir. This check requires successful creation of workdir in
731 * previous step.
732 */
733 err = ovl_check_d_type_supported(workpath);
734 if (err < 0)
2ba9d57e 735 goto out;
8ed61dc3 736
d80172c2
AG
737 d_type = err;
738 if (!d_type)
1bd0a3ae 739 pr_warn("upper fs needs to support d_type.\n");
8ed61dc3
MS
740
741 /* Check if upper/work fs supports O_TMPFILE */
2b1a7746
MS
742 tmpfile = ovl_do_tmpfile(ofs, ofs->workdir, S_IFREG | 0);
743 ofs->tmpfile = !IS_ERR(tmpfile);
ad204488 744 if (ofs->tmpfile)
2b1a7746 745 fput(tmpfile);
8ed61dc3 746 else
1bd0a3ae 747 pr_warn("upper fs does not support tmpfile.\n");
8ed61dc3 748
cad218ab
AG
749
750 /* Check if upper/work fs supports RENAME_WHITEOUT */
576bb263 751 err = ovl_check_rename_whiteout(ofs);
cad218ab
AG
752 if (err < 0)
753 goto out;
754
d80172c2
AG
755 rename_whiteout = err;
756 if (!rename_whiteout)
cad218ab
AG
757 pr_warn("upper fs does not support RENAME_WHITEOUT.\n");
758
8ed61dc3 759 /*
2d2f2d73 760 * Check if upper/work fs supports (trusted|user).overlay.* xattr
8ed61dc3 761 */
c914c0e2 762 err = ovl_setxattr(ofs, ofs->workdir, OVL_XATTR_OPAQUE, "0", 1);
8ed61dc3 763 if (err) {
b10b85fe 764 pr_warn("failed to set xattr on upper\n");
ad204488 765 ofs->noxattr = true;
af5f2396
AG
766 if (ovl_redirect_follow(ofs)) {
767 ofs->config.redirect_mode = OVL_REDIRECT_NOFOLLOW;
768 pr_warn("...falling back to redirect_dir=nofollow.\n");
769 }
770 if (ofs->config.metacopy) {
b0e0f697 771 ofs->config.metacopy = false;
af5f2396
AG
772 pr_warn("...falling back to metacopy=off.\n");
773 }
774 if (ofs->config.index) {
775 ofs->config.index = false;
776 pr_warn("...falling back to index=off.\n");
b0e0f697 777 }
d9544c1b
AG
778 if (ovl_has_fsid(ofs)) {
779 ofs->config.uuid = OVL_UUID_NULL;
780 pr_warn("...falling back to uuid=null.\n");
781 }
b0e0f697
AG
782 /*
783 * xattr support is required for persistent st_ino.
784 * Without persistent st_ino, xino=auto falls back to xino=off.
785 */
786 if (ofs->config.xino == OVL_XINO_AUTO) {
787 ofs->config.xino = OVL_XINO_OFF;
b10b85fe 788 pr_warn("...falling back to xino=off.\n");
b0e0f697 789 }
b10b85fe
MS
790 if (err == -EPERM && !ofs->config.userxattr)
791 pr_info("try mounting with 'userxattr' option\n");
2ba9d57e 792 err = 0;
8ed61dc3 793 } else {
c914c0e2 794 ovl_removexattr(ofs, ofs->workdir, OVL_XATTR_OPAQUE);
8ed61dc3
MS
795 }
796
d80172c2
AG
797 /*
798 * We allowed sub-optimal upper fs configuration and don't want to break
799 * users over kernel upgrade, but we never allowed remote upper fs, so
800 * we can enforce strict requirements for remote upper fs.
801 */
802 if (ovl_dentry_remote(ofs->workdir) &&
803 (!d_type || !rename_whiteout || ofs->noxattr)) {
804 pr_err("upper fs missing required features.\n");
805 err = -EINVAL;
806 goto out;
807 }
808
c86243b0
VG
809 /*
810 * For volatile mount, create a incompat/volatile/dirty file to keep
811 * track of it.
812 */
813 if (ofs->config.ovl_volatile) {
814 err = ovl_create_volatile_dirty(ofs);
815 if (err < 0) {
816 pr_err("Failed to create volatile/dirty file.\n");
817 goto out;
818 }
819 }
820
8ed61dc3 821 /* Check if upper/work fs supports file handles */
e487d889
AG
822 fh_type = ovl_can_decode_fh(ofs->workdir->d_sb);
823 if (ofs->config.index && !fh_type) {
ad204488 824 ofs->config.index = false;
1bd0a3ae 825 pr_warn("upper fs does not support file handles, falling back to index=off.\n");
8ed61dc3 826 }
16aac5ad 827 ofs->nofh |= !fh_type;
8ed61dc3 828
e487d889
AG
829 /* Check if upper fs has 32bit inode numbers */
830 if (fh_type != FILEID_INO32_GEN)
0f831ec8 831 ofs->xino_mode = -1;
e487d889 832
f168f109
AG
833 /* NFS export of r/w mount depends on index */
834 if (ofs->config.nfs_export && !ofs->config.index) {
1bd0a3ae 835 pr_warn("NFS export requires \"index=on\", falling back to nfs_export=off.\n");
f168f109
AG
836 ofs->config.nfs_export = false;
837 }
2ba9d57e
AG
838out:
839 mnt_drop_write(mnt);
840 return err;
8ed61dc3
MS
841}
842
146d62e5 843static int ovl_get_workdir(struct super_block *sb, struct ovl_fs *ofs,
b36a5780
CB
844 const struct path *upperpath,
845 const struct path *workpath)
520d7c86
MS
846{
847 int err;
520d7c86
MS
848
849 err = -EINVAL;
b36a5780 850 if (upperpath->mnt != workpath->mnt) {
1bd0a3ae 851 pr_err("workdir and upperdir must reside under the same mount\n");
b36a5780 852 return err;
520d7c86 853 }
b36a5780 854 if (!ovl_workdir_ok(workpath->dentry, upperpath->dentry)) {
1bd0a3ae 855 pr_err("workdir and upperdir must be separate subtrees\n");
b36a5780 856 return err;
520d7c86
MS
857 }
858
b36a5780 859 ofs->workbasedir = dget(workpath->dentry);
8c25741a 860
8c25741a 861 if (ovl_inuse_trylock(ofs->workbasedir)) {
ad204488 862 ofs->workdir_locked = true;
520d7c86 863 } else {
0be0bfd2
AG
864 err = ovl_report_in_use(ofs, "workdir");
865 if (err)
b36a5780 866 return err;
520d7c86
MS
867 }
868
0be0bfd2
AG
869 err = ovl_setup_trap(sb, ofs->workbasedir, &ofs->workbasedir_trap,
870 "workdir");
871 if (err)
b36a5780 872 return err;
bca44b52 873
b36a5780 874 return ovl_make_workdir(sb, ofs, workpath);
520d7c86
MS
875}
876
146d62e5 877static int ovl_get_indexdir(struct super_block *sb, struct ovl_fs *ofs,
2d343087 878 struct ovl_entry *oe, const struct path *upperpath)
f7e3a7d9 879{
08f4c7c8 880 struct vfsmount *mnt = ovl_upper_mnt(ofs);
235ce9ed 881 struct dentry *indexdir;
f7e3a7d9
MS
882 int err;
883
2ba9d57e
AG
884 err = mnt_want_write(mnt);
885 if (err)
886 return err;
887
f7e3a7d9 888 /* Verify lower root is upper root origin */
610afc0b 889 err = ovl_verify_origin(ofs, upperpath->dentry,
5522c9c7 890 ovl_lowerstack(oe)->dentry, true);
f7e3a7d9 891 if (err) {
1bd0a3ae 892 pr_err("failed to verify upper root origin\n");
f7e3a7d9
MS
893 goto out;
894 }
895
470c1563
AG
896 /* index dir will act also as workdir */
897 iput(ofs->workdir_trap);
898 ofs->workdir_trap = NULL;
899 dput(ofs->workdir);
900 ofs->workdir = NULL;
235ce9ed
AG
901 indexdir = ovl_workdir_create(ofs, OVL_INDEXDIR_NAME, true);
902 if (IS_ERR(indexdir)) {
903 err = PTR_ERR(indexdir);
904 } else if (indexdir) {
905 ofs->indexdir = indexdir;
906 ofs->workdir = dget(indexdir);
20396365 907
146d62e5
AG
908 err = ovl_setup_trap(sb, ofs->indexdir, &ofs->indexdir_trap,
909 "indexdir");
910 if (err)
911 goto out;
912
ad1d615c
AG
913 /*
914 * Verify upper root is exclusively associated with index dir.
2d2f2d73 915 * Older kernels stored upper fh in ".overlay.origin"
ad1d615c
AG
916 * xattr. If that xattr exists, verify that it is a match to
917 * upper dir file handle. In any case, verify or set xattr
2d2f2d73 918 * ".overlay.upper" to indicate that index may have
ad1d615c
AG
919 * directory entries.
920 */
610afc0b
MS
921 if (ovl_check_origin_xattr(ofs, ofs->indexdir)) {
922 err = ovl_verify_set_fh(ofs, ofs->indexdir,
923 OVL_XATTR_ORIGIN,
ad1d615c
AG
924 upperpath->dentry, true, false);
925 if (err)
1bd0a3ae 926 pr_err("failed to verify index dir 'origin' xattr\n");
ad1d615c 927 }
610afc0b
MS
928 err = ovl_verify_upper(ofs, ofs->indexdir, upperpath->dentry,
929 true);
f7e3a7d9 930 if (err)
1bd0a3ae 931 pr_err("failed to verify index dir 'upper' xattr\n");
f7e3a7d9
MS
932
933 /* Cleanup bad/stale/orphan index entries */
934 if (!err)
1eff1a1d 935 err = ovl_indexdir_cleanup(ofs);
f7e3a7d9 936 }
ad204488 937 if (err || !ofs->indexdir)
1bd0a3ae 938 pr_warn("try deleting index dir or mounting with '-o index=off' to disable inodes index.\n");
f7e3a7d9
MS
939
940out:
2ba9d57e 941 mnt_drop_write(mnt);
f7e3a7d9
MS
942 return err;
943}
944
9df085f3
AG
945static bool ovl_lower_uuid_ok(struct ovl_fs *ofs, const uuid_t *uuid)
946{
947 unsigned int i;
948
08f4c7c8 949 if (!ofs->config.nfs_export && !ovl_upper_mnt(ofs))
9df085f3
AG
950 return true;
951
a888db31
AG
952 /*
953 * We allow using single lower with null uuid for index and nfs_export
954 * for example to support those features with single lower squashfs.
955 * To avoid regressions in setups of overlay with re-formatted lower
956 * squashfs, do not allow decoding origin with lower null uuid unless
957 * user opted-in to one of the new features that require following the
958 * lower inode of non-dir upper.
959 */
ca45275c 960 if (ovl_allow_offline_changes(ofs) && uuid_is_null(uuid))
a888db31
AG
961 return false;
962
1b81dddd 963 for (i = 0; i < ofs->numfs; i++) {
9df085f3
AG
964 /*
965 * We use uuid to associate an overlay lower file handle with a
966 * lower layer, so we can accept lower fs with null uuid as long
967 * as all lower layers with null uuid are on the same fs.
7e63c87f
AG
968 * if we detect multiple lower fs with the same uuid, we
969 * disable lower file handle decoding on all of them.
9df085f3 970 */
1b81dddd
AG
971 if (ofs->fs[i].is_lower &&
972 uuid_equal(&ofs->fs[i].sb->s_uuid, uuid)) {
07f1e596 973 ofs->fs[i].bad_uuid = true;
9df085f3 974 return false;
7e63c87f 975 }
9df085f3
AG
976 }
977 return true;
978}
979
5148626b 980/* Get a unique fsid for the layer */
9df085f3 981static int ovl_get_fsid(struct ovl_fs *ofs, const struct path *path)
5148626b 982{
9df085f3 983 struct super_block *sb = path->mnt->mnt_sb;
5148626b
AG
984 unsigned int i;
985 dev_t dev;
986 int err;
7e63c87f 987 bool bad_uuid = false;
b0e0f697 988 bool warn = false;
5148626b 989
07f1e596
AG
990 for (i = 0; i < ofs->numfs; i++) {
991 if (ofs->fs[i].sb == sb)
992 return i;
5148626b
AG
993 }
994
9df085f3 995 if (!ovl_lower_uuid_ok(ofs, &sb->s_uuid)) {
7e63c87f 996 bad_uuid = true;
b0e0f697
AG
997 if (ofs->config.xino == OVL_XINO_AUTO) {
998 ofs->config.xino = OVL_XINO_OFF;
999 warn = true;
1000 }
7e63c87f
AG
1001 if (ofs->config.index || ofs->config.nfs_export) {
1002 ofs->config.index = false;
1003 ofs->config.nfs_export = false;
b0e0f697
AG
1004 warn = true;
1005 }
1006 if (warn) {
1007 pr_warn("%s uuid detected in lower fs '%pd2', falling back to xino=%s,index=off,nfs_export=off.\n",
7e63c87f
AG
1008 uuid_is_null(&sb->s_uuid) ? "null" :
1009 "conflicting",
dcb399de 1010 path->dentry, ovl_xino_mode(&ofs->config));
7e63c87f 1011 }
9df085f3
AG
1012 }
1013
5148626b
AG
1014 err = get_anon_bdev(&dev);
1015 if (err) {
1bd0a3ae 1016 pr_err("failed to get anonymous bdev for lowerpath\n");
5148626b
AG
1017 return err;
1018 }
1019
07f1e596
AG
1020 ofs->fs[ofs->numfs].sb = sb;
1021 ofs->fs[ofs->numfs].pseudo_dev = dev;
1022 ofs->fs[ofs->numfs].bad_uuid = bad_uuid;
5148626b 1023
07f1e596 1024 return ofs->numfs++;
5148626b
AG
1025}
1026
37ebf056
AG
1027/*
1028 * The fsid after the last lower fsid is used for the data layers.
1029 * It is a "null fs" with a null sb, null uuid, and no pseudo dev.
1030 */
1031static int ovl_get_data_fsid(struct ovl_fs *ofs)
1032{
1033 return ofs->numfs;
1034}
1035
1036
94375f9d 1037static int ovl_get_layers(struct super_block *sb, struct ovl_fs *ofs,
b36a5780 1038 struct ovl_fs_context *ctx, struct ovl_layer *layers)
520d7c86
MS
1039{
1040 int err;
1041 unsigned int i;
b36a5780 1042 size_t nr_merged_lower;
520d7c86 1043
b36a5780 1044 ofs->fs = kcalloc(ctx->nr + 2, sizeof(struct ovl_sb), GFP_KERNEL);
07f1e596 1045 if (ofs->fs == NULL)
9e88f905 1046 return -ENOMEM;
5148626b 1047
37ebf056
AG
1048 /*
1049 * idx/fsid 0 are reserved for upper fs even with lower only overlay
1050 * and the last fsid is reserved for "null fs" of the data layers.
1051 */
07f1e596
AG
1052 ofs->numfs++;
1053
07f1e596 1054 /*
b7bf9908
AG
1055 * All lower layers that share the same fs as upper layer, use the same
1056 * pseudo_dev as upper layer. Allocate fs[0].pseudo_dev even for lower
1057 * only overlay to simplify ovl_fs_free().
1b81dddd 1058 * is_lower will be set if upper fs is shared with a lower layer.
07f1e596 1059 */
b7bf9908
AG
1060 err = get_anon_bdev(&ofs->fs[0].pseudo_dev);
1061 if (err) {
1062 pr_err("failed to get anonymous bdev for upper fs\n");
9e88f905 1063 return err;
b7bf9908
AG
1064 }
1065
08f4c7c8
MS
1066 if (ovl_upper_mnt(ofs)) {
1067 ofs->fs[0].sb = ovl_upper_mnt(ofs)->mnt_sb;
1b81dddd 1068 ofs->fs[0].is_lower = false;
07f1e596
AG
1069 }
1070
b36a5780
CB
1071 nr_merged_lower = ctx->nr - ctx->nr_data;
1072 for (i = 0; i < ctx->nr; i++) {
1073 struct ovl_fs_context_layer *l = &ctx->lower[i];
520d7c86 1074 struct vfsmount *mnt;
146d62e5 1075 struct inode *trap;
5148626b 1076 int fsid;
520d7c86 1077
b36a5780
CB
1078 if (i < nr_merged_lower)
1079 fsid = ovl_get_fsid(ofs, &l->path);
37ebf056
AG
1080 else
1081 fsid = ovl_get_data_fsid(ofs);
9e88f905
AG
1082 if (fsid < 0)
1083 return fsid;
520d7c86 1084
24f14009 1085 /*
1086 * Check if lower root conflicts with this overlay layers before
1087 * checking if it is in-use as upperdir/workdir of "another"
1088 * mount, because we do not bother to check in ovl_is_inuse() if
1089 * the upperdir/workdir is in fact in-use by our
1090 * upperdir/workdir.
1091 */
b36a5780 1092 err = ovl_setup_trap(sb, l->path.dentry, &trap, "lowerdir");
146d62e5 1093 if (err)
9e88f905 1094 return err;
146d62e5 1095
b36a5780 1096 if (ovl_is_inuse(l->path.dentry)) {
0be0bfd2 1097 err = ovl_report_in_use(ofs, "lowerdir");
24f14009 1098 if (err) {
1099 iput(trap);
9e88f905 1100 return err;
24f14009 1101 }
0be0bfd2
AG
1102 }
1103
b36a5780 1104 mnt = clone_private_mount(&l->path);
520d7c86
MS
1105 err = PTR_ERR(mnt);
1106 if (IS_ERR(mnt)) {
1bd0a3ae 1107 pr_err("failed to clone lowerpath\n");
146d62e5 1108 iput(trap);
9e88f905 1109 return err;
520d7c86 1110 }
5148626b 1111
520d7c86
MS
1112 /*
1113 * Make lower layers R/O. That way fchmod/fchown on lower file
1114 * will fail instead of modifying lower fs.
1115 */
1116 mnt->mnt_flags |= MNT_READONLY | MNT_NOATIME;
1117
13464165
MS
1118 layers[ofs->numlayer].trap = trap;
1119 layers[ofs->numlayer].mnt = mnt;
1120 layers[ofs->numlayer].idx = ofs->numlayer;
1121 layers[ofs->numlayer].fsid = fsid;
1122 layers[ofs->numlayer].fs = &ofs->fs[fsid];
a535116d
AG
1123 /* Store for printing lowerdir=... in ovl_show_options() */
1124 ofs->config.lowerdirs[ofs->numlayer] = l->name;
b36a5780 1125 l->name = NULL;
94375f9d 1126 ofs->numlayer++;
1b81dddd 1127 ofs->fs[fsid].is_lower = true;
520d7c86 1128 }
e487d889 1129
795939a9
AG
1130 /*
1131 * When all layers on same fs, overlay can use real inode numbers.
926e94d7
AG
1132 * With mount option "xino=<on|auto>", mounter declares that there are
1133 * enough free high bits in underlying fs to hold the unique fsid.
795939a9
AG
1134 * If overlayfs does encounter underlying inodes using the high xino
1135 * bits reserved for fsid, it emits a warning and uses the original
dfe51d47
AG
1136 * inode number or a non persistent inode number allocated from a
1137 * dedicated range.
795939a9 1138 */
08f4c7c8 1139 if (ofs->numfs - !ovl_upper_mnt(ofs) == 1) {
0f831ec8
AG
1140 if (ofs->config.xino == OVL_XINO_ON)
1141 pr_info("\"xino=on\" is useless with all layers on same fs, ignore.\n");
1142 ofs->xino_mode = 0;
53afcd31
AG
1143 } else if (ofs->config.xino == OVL_XINO_OFF) {
1144 ofs->xino_mode = -1;
926e94d7 1145 } else if (ofs->xino_mode < 0) {
795939a9 1146 /*
07f1e596 1147 * This is a roundup of number of bits needed for encoding
dfe51d47
AG
1148 * fsid, where fsid 0 is reserved for upper fs (even with
1149 * lower only overlay) +1 extra bit is reserved for the non
1150 * persistent inode number range that is used for resolving
1151 * xino lower bits overflow.
795939a9 1152 */
dfe51d47
AG
1153 BUILD_BUG_ON(ilog2(OVL_MAX_STACK) > 30);
1154 ofs->xino_mode = ilog2(ofs->numfs - 1) + 2;
795939a9
AG
1155 }
1156
0f831ec8 1157 if (ofs->xino_mode > 0) {
1bd0a3ae 1158 pr_info("\"xino\" feature enabled using %d upper inode bits.\n",
0f831ec8 1159 ofs->xino_mode);
795939a9 1160 }
e487d889 1161
9e88f905 1162 return 0;
520d7c86
MS
1163}
1164
4155c10a 1165static struct ovl_entry *ovl_get_lowerstack(struct super_block *sb,
b36a5780
CB
1166 struct ovl_fs_context *ctx,
1167 struct ovl_fs *ofs,
1168 struct ovl_layer *layers)
53dbb0b4
MS
1169{
1170 int err;
b8e42a65 1171 unsigned int i;
b36a5780 1172 size_t nr_merged_lower;
4155c10a 1173 struct ovl_entry *oe;
b36a5780
CB
1174 struct ovl_path *lowerstack;
1175
1176 struct ovl_fs_context_layer *l;
53dbb0b4 1177
b36a5780 1178 if (!ofs->config.upperdir && ctx->nr == 1) {
1bd0a3ae 1179 pr_err("at least 2 lowerdir are needed while upperdir nonexistent\n");
b8e42a65 1180 return ERR_PTR(-EINVAL);
53dbb0b4
MS
1181 }
1182
b36a5780
CB
1183 err = -EINVAL;
1184 for (i = 0; i < ctx->nr; i++) {
1185 l = &ctx->lower[i];
53dbb0b4 1186
b36a5780 1187 err = ovl_lower_dir(l->name, &l->path, ofs, &sb->s_stack_depth);
53dbb0b4 1188 if (err)
b36a5780 1189 return ERR_PTR(err);
53dbb0b4
MS
1190 }
1191
1192 err = -EINVAL;
1193 sb->s_stack_depth++;
1194 if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
1bd0a3ae 1195 pr_err("maximum fs stacking depth exceeded\n");
b36a5780 1196 return ERR_PTR(err);
53dbb0b4
MS
1197 }
1198
b36a5780 1199 err = ovl_get_layers(sb, ofs, ctx, layers);
4155c10a 1200 if (err)
b36a5780 1201 return ERR_PTR(err);
4155c10a
MS
1202
1203 err = -ENOMEM;
37ebf056 1204 /* Data-only layers are not merged in root directory */
b36a5780
CB
1205 nr_merged_lower = ctx->nr - ctx->nr_data;
1206 oe = ovl_alloc_entry(nr_merged_lower);
4155c10a 1207 if (!oe)
b36a5780 1208 return ERR_PTR(err);
4155c10a 1209
5522c9c7 1210 lowerstack = ovl_lowerstack(oe);
b36a5780
CB
1211 for (i = 0; i < nr_merged_lower; i++) {
1212 l = &ctx->lower[i];
1213 lowerstack[i].dentry = dget(l->path.dentry);
1214 lowerstack[i].layer = &ofs->layers[i + 1];
4155c10a 1215 }
b36a5780 1216 ofs->numdatalayer = ctx->nr_data;
4155c10a
MS
1217
1218 return oe;
53dbb0b4
MS
1219}
1220
146d62e5
AG
1221/*
1222 * Check if this layer root is a descendant of:
1223 * - another layer of this overlayfs instance
1224 * - upper/work dir of any overlayfs instance
146d62e5 1225 */
0be0bfd2 1226static int ovl_check_layer(struct super_block *sb, struct ovl_fs *ofs,
708fa015
MS
1227 struct dentry *dentry, const char *name,
1228 bool is_lower)
146d62e5 1229{
9179c21d 1230 struct dentry *next = dentry, *parent;
146d62e5
AG
1231 int err = 0;
1232
9179c21d 1233 if (!dentry)
146d62e5
AG
1234 return 0;
1235
9179c21d
MS
1236 parent = dget_parent(next);
1237
1238 /* Walk back ancestors to root (inclusive) looking for traps */
1239 while (!err && parent != next) {
708fa015 1240 if (is_lower && ovl_lookup_trap_inode(sb, parent)) {
146d62e5 1241 err = -ELOOP;
1bd0a3ae 1242 pr_err("overlapping %s path\n", name);
0be0bfd2
AG
1243 } else if (ovl_is_inuse(parent)) {
1244 err = ovl_report_in_use(ofs, name);
146d62e5 1245 }
146d62e5 1246 next = parent;
9179c21d
MS
1247 parent = dget_parent(next);
1248 dput(next);
146d62e5
AG
1249 }
1250
9179c21d 1251 dput(parent);
146d62e5
AG
1252
1253 return err;
1254}
1255
1256/*
1257 * Check if any of the layers or work dirs overlap.
1258 */
1259static int ovl_check_overlapping_layers(struct super_block *sb,
1260 struct ovl_fs *ofs)
1261{
1262 int i, err;
1263
08f4c7c8
MS
1264 if (ovl_upper_mnt(ofs)) {
1265 err = ovl_check_layer(sb, ofs, ovl_upper_mnt(ofs)->mnt_root,
708fa015 1266 "upperdir", false);
146d62e5
AG
1267 if (err)
1268 return err;
1269
1270 /*
1271 * Checking workbasedir avoids hitting ovl_is_inuse(parent) of
1272 * this instance and covers overlapping work and index dirs,
1273 * unless work or index dir have been moved since created inside
1274 * workbasedir. In that case, we already have their traps in
1275 * inode cache and we will catch that case on lookup.
1276 */
708fa015
MS
1277 err = ovl_check_layer(sb, ofs, ofs->workbasedir, "workdir",
1278 false);
146d62e5
AG
1279 if (err)
1280 return err;
1281 }
1282
94375f9d 1283 for (i = 1; i < ofs->numlayer; i++) {
0be0bfd2 1284 err = ovl_check_layer(sb, ofs,
94375f9d 1285 ofs->layers[i].mnt->mnt_root,
708fa015 1286 "lowerdir", true);
146d62e5
AG
1287 if (err)
1288 return err;
1289 }
1290
1291 return 0;
1292}
1293
2effc5c2
AG
1294static struct dentry *ovl_get_root(struct super_block *sb,
1295 struct dentry *upperdentry,
1296 struct ovl_entry *oe)
1297{
1298 struct dentry *root;
5522c9c7 1299 struct ovl_path *lowerpath = ovl_lowerstack(oe);
62c832ed
AG
1300 unsigned long ino = d_inode(lowerpath->dentry)->i_ino;
1301 int fsid = lowerpath->layer->fsid;
1302 struct ovl_inode_params oip = {
1303 .upperdentry = upperdentry,
0af950f5 1304 .oe = oe,
62c832ed 1305 };
2effc5c2
AG
1306
1307 root = d_make_root(ovl_new_inode(sb, S_IFDIR, 0));
1308 if (!root)
1309 return NULL;
1310
2effc5c2 1311 if (upperdentry) {
62c832ed
AG
1312 /* Root inode uses upper st_ino/i_ino */
1313 ino = d_inode(upperdentry)->i_ino;
1314 fsid = 0;
2effc5c2 1315 ovl_dentry_set_upper_alias(root);
610afc0b 1316 if (ovl_is_impuredir(sb, upperdentry))
2effc5c2
AG
1317 ovl_set_flag(OVL_IMPURE, d_inode(root));
1318 }
1319
1320 /* Root is always merge -> can have whiteouts */
1321 ovl_set_flag(OVL_WHITEOUTS, d_inode(root));
1322 ovl_dentry_set_flag(OVL_E_CONNECTED, root);
1323 ovl_set_upperdata(d_inode(root));
62c832ed 1324 ovl_inode_init(d_inode(root), &oip, ino, fsid);
0af950f5 1325 ovl_dentry_init_flags(root, upperdentry, oe, DCACHE_OP_WEAK_REVALIDATE);
367d002d
AG
1326 /* root keeps a reference of upperdentry */
1327 dget(upperdentry);
2effc5c2
AG
1328
1329 return root;
1330}
1331
7fb7998b 1332int ovl_fill_super(struct super_block *sb, struct fs_context *fc)
e9be9d5e 1333{
1784fbc2
CB
1334 struct ovl_fs *ofs = sb->s_fs_info;
1335 struct ovl_fs_context *ctx = fc->fs_private;
e9be9d5e 1336 struct dentry *root_dentry;
4155c10a 1337 struct ovl_entry *oe;
b8e42a65 1338 struct ovl_layer *layers;
51f8f3c4 1339 struct cred *cred;
e9be9d5e
MS
1340 int err;
1341
9efb069d 1342 err = -EIO;
1784fbc2
CB
1343 if (WARN_ON(fc->user_ns != current_user_ns()))
1344 goto out_err;
9efb069d 1345
f4288844
MS
1346 sb->s_d_op = &ovl_dentry_operations;
1347
d7b49b10 1348 err = -ENOMEM;
ad204488 1349 ofs->creator_cred = cred = prepare_creds();
c6fe6254
MS
1350 if (!cred)
1351 goto out_err;
1352
1784fbc2 1353 err = ovl_fs_params_verify(ctx, &ofs->config);
f45827e8 1354 if (err)
a9075cdb 1355 goto out_err;
f45827e8 1356
e9be9d5e 1357 err = -EINVAL;
b36a5780 1358 if (ctx->nr == 0) {
1784fbc2 1359 if (!(fc->sb_flags & SB_SILENT))
1bd0a3ae 1360 pr_err("missing 'lowerdir'\n");
a9075cdb 1361 goto out_err;
e9be9d5e
MS
1362 }
1363
b8e42a65 1364 err = -ENOMEM;
b36a5780 1365 layers = kcalloc(ctx->nr + 1, sizeof(struct ovl_layer), GFP_KERNEL);
b8e42a65
MS
1366 if (!layers)
1367 goto out_err;
1368
a535116d
AG
1369 ofs->config.lowerdirs = kcalloc(ctx->nr + 1, sizeof(char *), GFP_KERNEL);
1370 if (!ofs->config.lowerdirs) {
1371 kfree(layers);
1372 goto out_err;
1373 }
b8e42a65 1374 ofs->layers = layers;
a535116d
AG
1375 /*
1376 * Layer 0 is reserved for upper even if there's no upper.
1377 * For consistency, config.lowerdirs[0] is NULL.
1378 */
b8e42a65
MS
1379 ofs->numlayer = 1;
1380
53a08cb9 1381 sb->s_stack_depth = 0;
cf9a6784 1382 sb->s_maxbytes = MAX_LFS_FILESIZE;
4d314f78 1383 atomic_long_set(&ofs->last_ino, 1);
4f119628 1384 /* Assume underlying fs uses 32bit inodes unless proven otherwise */
53afcd31 1385 if (ofs->config.xino != OVL_XINO_OFF) {
0f831ec8 1386 ofs->xino_mode = BITS_PER_LONG - 32;
53afcd31
AG
1387 if (!ofs->xino_mode) {
1388 pr_warn("xino not supported on 32bit kernel, falling back to xino=off.\n");
1389 ofs->config.xino = OVL_XINO_OFF;
1390 }
1391 }
795939a9 1392
146d62e5
AG
1393 /* alloc/destroy_inode needed for setting up traps in inode cache */
1394 sb->s_op = &ovl_super_operations;
1395
ad204488 1396 if (ofs->config.upperdir) {
335d3fc5
SD
1397 struct super_block *upper_sb;
1398
d7b49b10 1399 err = -EINVAL;
ad204488 1400 if (!ofs->config.workdir) {
1bd0a3ae 1401 pr_err("missing 'workdir'\n");
a9075cdb 1402 goto out_err;
53a08cb9 1403 }
e9be9d5e 1404
b36a5780 1405 err = ovl_get_upper(sb, ofs, &layers[0], &ctx->upper);
53a08cb9 1406 if (err)
a9075cdb 1407 goto out_err;
2cac0c00 1408
335d3fc5
SD
1409 upper_sb = ovl_upper_mnt(ofs)->mnt_sb;
1410 if (!ovl_should_sync(ofs)) {
1411 ofs->errseq = errseq_sample(&upper_sb->s_wb_err);
1412 if (errseq_check(&upper_sb->s_wb_err, ofs->errseq)) {
1413 err = -EIO;
1414 pr_err("Cannot mount volatile when upperdir has an unseen error. Sync upperdir fs to clear state.\n");
1415 goto out_err;
1416 }
1417 }
1418
b36a5780 1419 err = ovl_get_workdir(sb, ofs, &ctx->upper, &ctx->work);
8ed61dc3 1420 if (err)
a9075cdb 1421 goto out_err;
c6fe6254 1422
ad204488 1423 if (!ofs->workdir)
1751e8a6 1424 sb->s_flags |= SB_RDONLY;
6e88256e 1425
335d3fc5
SD
1426 sb->s_stack_depth = upper_sb->s_stack_depth;
1427 sb->s_time_gran = upper_sb->s_time_gran;
e9be9d5e 1428 }
b36a5780 1429 oe = ovl_get_lowerstack(sb, ctx, ofs, layers);
4155c10a
MS
1430 err = PTR_ERR(oe);
1431 if (IS_ERR(oe))
a9075cdb 1432 goto out_err;
e9be9d5e 1433
71cbad7e 1434 /* If the upper fs is nonexistent, we mark overlayfs r/o too */
08f4c7c8 1435 if (!ovl_upper_mnt(ofs))
1751e8a6 1436 sb->s_flags |= SB_RDONLY;
e9be9d5e 1437
b0504bfe
AG
1438 if (!ovl_origin_uuid(ofs) && ofs->numfs > 1) {
1439 pr_warn("The uuid=off requires a single fs for lower and upper, falling back to uuid=null.\n");
1440 ofs->config.uuid = OVL_UUID_NULL;
d9544c1b
AG
1441 } else if (ovl_has_fsid(ofs) && ovl_upper_mnt(ofs)) {
1442 /* Use per instance persistent uuid/fsid */
1443 ovl_init_uuid_xattr(sb, ofs, &ctx->upper);
5830fb6b
PT
1444 }
1445
470c1563 1446 if (!ovl_force_readonly(ofs) && ofs->config.index) {
b36a5780 1447 err = ovl_get_indexdir(sb, ofs, oe, &ctx->upper);
54fb347e 1448 if (err)
4155c10a 1449 goto out_free_oe;
6e88256e 1450
972d0093 1451 /* Force r/o mount with no index dir */
20396365 1452 if (!ofs->indexdir)
1751e8a6 1453 sb->s_flags |= SB_RDONLY;
02bcd157
AG
1454 }
1455
146d62e5
AG
1456 err = ovl_check_overlapping_layers(sb, ofs);
1457 if (err)
1458 goto out_free_oe;
1459
972d0093 1460 /* Show index=off in /proc/mounts for forced r/o mount */
f168f109 1461 if (!ofs->indexdir) {
ad204488 1462 ofs->config.index = false;
08f4c7c8 1463 if (ovl_upper_mnt(ofs) && ofs->config.nfs_export) {
1bd0a3ae 1464 pr_warn("NFS export requires an index dir, falling back to nfs_export=off.\n");
f168f109
AG
1465 ofs->config.nfs_export = false;
1466 }
1467 }
02bcd157 1468
d5791044 1469 if (ofs->config.metacopy && ofs->config.nfs_export) {
1bd0a3ae 1470 pr_warn("NFS export is not supported with metadata only copy up, falling back to nfs_export=off.\n");
d5791044
VG
1471 ofs->config.nfs_export = false;
1472 }
1473
16aac5ad
AG
1474 /*
1475 * Support encoding decodable file handles with nfs_export=on
1476 * and encoding non-decodable file handles with nfs_export=off
1477 * if all layers support file handles.
1478 */
8383f174
AG
1479 if (ofs->config.nfs_export)
1480 sb->s_export_op = &ovl_export_operations;
16aac5ad
AG
1481 else if (!ofs->nofh)
1482 sb->s_export_op = &ovl_export_fid_operations;
8383f174 1483
51f8f3c4
KK
1484 /* Never override disk quota limits or use reserved space */
1485 cap_lower(cred->cap_effective, CAP_SYS_RESOURCE);
1486
655042cc 1487 sb->s_magic = OVERLAYFS_SUPER_MAGIC;
2d2f2d73
MS
1488 sb->s_xattr = ofs->config.userxattr ? ovl_user_xattr_handlers :
1489 ovl_trusted_xattr_handlers;
ad204488 1490 sb->s_fs_info = ofs;
7c4d37c2 1491 sb->s_flags |= SB_POSIXACL;
18b44bc5 1492 sb->s_iflags |= SB_I_SKIP_SYNC | SB_I_IMA_UNVERIFIABLE_SIGNATURE;
655042cc 1493
c6fe6254 1494 err = -ENOMEM;
b36a5780 1495 root_dentry = ovl_get_root(sb, ctx->upper.dentry, oe);
e9be9d5e 1496 if (!root_dentry)
4155c10a 1497 goto out_free_oe;
e9be9d5e 1498
e9be9d5e 1499 sb->s_root = root_dentry;
e9be9d5e
MS
1500
1501 return 0;
1502
4155c10a 1503out_free_oe:
163db0da 1504 ovl_free_entry(oe);
4155c10a 1505out_err:
ad204488 1506 ovl_free_fs(ofs);
1784fbc2 1507 sb->s_fs_info = NULL;
e9be9d5e
MS
1508 return err;
1509}
1510
f01d0889 1511struct file_system_type ovl_fs_type = {
1784fbc2
CB
1512 .owner = THIS_MODULE,
1513 .name = "overlay",
1514 .init_fs_context = ovl_init_fs_context,
1515 .parameters = ovl_parameter_spec,
1516 .fs_flags = FS_USERNS_MOUNT,
1517 .kill_sb = kill_anon_super,
e9be9d5e 1518};
ef94b186 1519MODULE_ALIAS_FS("overlay");
e9be9d5e 1520
13cf199d
AG
1521static void ovl_inode_init_once(void *foo)
1522{
1523 struct ovl_inode *oi = foo;
1524
1525 inode_init_once(&oi->vfs_inode);
1526}
1527
e9be9d5e
MS
1528static int __init ovl_init(void)
1529{
13cf199d
AG
1530 int err;
1531
1532 ovl_inode_cachep = kmem_cache_create("ovl_inode",
1533 sizeof(struct ovl_inode), 0,
1534 (SLAB_RECLAIM_ACCOUNT|
1535 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
1536 ovl_inode_init_once);
1537 if (ovl_inode_cachep == NULL)
1538 return -ENOMEM;
1539
2406a307
JX
1540 err = ovl_aio_request_cache_init();
1541 if (!err) {
1542 err = register_filesystem(&ovl_fs_type);
1543 if (!err)
1544 return 0;
1545
1546 ovl_aio_request_cache_destroy();
1547 }
1548 kmem_cache_destroy(ovl_inode_cachep);
13cf199d
AG
1549
1550 return err;
e9be9d5e
MS
1551}
1552
1553static void __exit ovl_exit(void)
1554{
1555 unregister_filesystem(&ovl_fs_type);
13cf199d
AG
1556
1557 /*
1558 * Make sure all delayed rcu free inodes are flushed before we
1559 * destroy cache.
1560 */
1561 rcu_barrier();
1562 kmem_cache_destroy(ovl_inode_cachep);
2406a307 1563 ovl_aio_request_cache_destroy();
e9be9d5e
MS
1564}
1565
1566module_init(ovl_init);
1567module_exit(ovl_exit);