blob: 732ad5495c9219c5ef43939bd92ce9a4cf65f251 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001// SPDX-License-Identifier: GPL-2.0-only
Miklos Szeredie9be9d52014-10-24 00:14:38 +02002/*
3 *
4 * Copyright (C) 2011 Novell Inc.
Miklos Szeredie9be9d52014-10-24 00:14:38 +02005 */
6
Ingo Molnar5b825c32017-02-02 17:54:15 +01007#include <uapi/linux/magic.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +02008#include <linux/fs.h>
9#include <linux/namei.h>
10#include <linux/xattr.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020011#include <linux/mount.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020012#include <linux/parser.h>
13#include <linux/module.h>
Andy Whitcroftcc259632014-10-24 00:14:38 +020014#include <linux/statfs.h>
Erez Zadokf45827e82014-10-24 00:14:38 +020015#include <linux/seq_file.h>
Miklos Szeredid837a492016-07-29 12:05:24 +020016#include <linux/posix_acl_xattr.h>
Amir Goldsteine487d882017-11-07 13:55:04 +020017#include <linux/exportfs.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020018#include "overlayfs.h"
19
20MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
21MODULE_DESCRIPTION("Overlay filesystem");
22MODULE_LICENSE("GPL");
23
Miklos Szeredie9be9d52014-10-24 00:14:38 +020024
25struct ovl_dir_cache;
26
Miklos Szeredia78d9f02014-12-13 00:59:52 +010027#define OVL_MAX_STACK 500
28
Miklos Szeredi688ea0e2016-12-16 11:02:57 +010029static bool ovl_redirect_dir_def = IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_DIR);
30module_param_named(redirect_dir, ovl_redirect_dir_def, bool, 0644);
Nicolas Schier253e7482019-06-17 09:39:00 +020031MODULE_PARM_DESC(redirect_dir,
Miklos Szeredi688ea0e2016-12-16 11:02:57 +010032 "Default to on or off for the redirect_dir feature");
Miklos Szeredie9be9d52014-10-24 00:14:38 +020033
Miklos Szeredi438c84c2017-12-11 11:28:10 +010034static bool ovl_redirect_always_follow =
35 IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW);
36module_param_named(redirect_always_follow, ovl_redirect_always_follow,
37 bool, 0644);
Nicolas Schier253e7482019-06-17 09:39:00 +020038MODULE_PARM_DESC(redirect_always_follow,
Miklos Szeredi438c84c2017-12-11 11:28:10 +010039 "Follow redirects even if redirect_dir feature is turned off");
40
Amir Goldstein02bcd152017-06-21 15:28:36 +030041static bool ovl_index_def = IS_ENABLED(CONFIG_OVERLAY_FS_INDEX);
42module_param_named(index, ovl_index_def, bool, 0644);
Nicolas Schier253e7482019-06-17 09:39:00 +020043MODULE_PARM_DESC(index,
Amir Goldstein02bcd152017-06-21 15:28:36 +030044 "Default to on or off for the inodes index feature");
45
Amir Goldsteinf168f102018-01-19 11:26:53 +020046static bool ovl_nfs_export_def = IS_ENABLED(CONFIG_OVERLAY_FS_NFS_EXPORT);
47module_param_named(nfs_export, ovl_nfs_export_def, bool, 0644);
Nicolas Schier253e7482019-06-17 09:39:00 +020048MODULE_PARM_DESC(nfs_export,
Amir Goldsteinf168f102018-01-19 11:26:53 +020049 "Default to on or off for the NFS export feature");
50
Amir Goldstein795939a2018-03-29 09:08:18 +030051static bool ovl_xino_auto_def = IS_ENABLED(CONFIG_OVERLAY_FS_XINO_AUTO);
52module_param_named(xino_auto, ovl_xino_auto_def, bool, 0644);
Nicolas Schier253e7482019-06-17 09:39:00 +020053MODULE_PARM_DESC(xino_auto,
Amir Goldstein795939a2018-03-29 09:08:18 +030054 "Auto enable xino feature");
55
Miklos Szeredi4155c102017-11-10 09:39:15 +010056static void ovl_entry_stack_free(struct ovl_entry *oe)
57{
58 unsigned int i;
59
60 for (i = 0; i < oe->numlower; i++)
61 dput(oe->lowerstack[i].dentry);
62}
63
Vivek Goyald5791042018-05-11 11:49:27 -040064static bool ovl_metacopy_def = IS_ENABLED(CONFIG_OVERLAY_FS_METACOPY);
65module_param_named(metacopy, ovl_metacopy_def, bool, 0644);
Nicolas Schier253e7482019-06-17 09:39:00 +020066MODULE_PARM_DESC(metacopy,
Vivek Goyald5791042018-05-11 11:49:27 -040067 "Default to on or off for the metadata only copy up feature");
68
Miklos Szeredie9be9d52014-10-24 00:14:38 +020069static void ovl_dentry_release(struct dentry *dentry)
70{
71 struct ovl_entry *oe = dentry->d_fsdata;
72
73 if (oe) {
Miklos Szeredi4155c102017-11-10 09:39:15 +010074 ovl_entry_stack_free(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +020075 kfree_rcu(oe, rcu);
76 }
77}
78
Miklos Szeredi2d902672016-06-30 08:53:27 +020079static struct dentry *ovl_d_real(struct dentry *dentry,
Miklos Szeredifb160432018-07-18 15:44:44 +020080 const struct inode *inode)
Miklos Szeredid101a122016-03-26 16:14:37 -040081{
82 struct dentry *real;
83
Miklos Szeredie8c985b2018-07-18 15:44:41 +020084 /* It's an overlay file */
85 if (inode && d_inode(dentry) == inode)
86 return dentry;
87
Miklos Szeredica4c8a32016-12-16 11:02:55 +010088 if (!d_is_reg(dentry)) {
Miklos Szeredid101a122016-03-26 16:14:37 -040089 if (!inode || inode == d_inode(dentry))
90 return dentry;
91 goto bug;
92 }
93
94 real = ovl_dentry_upper(dentry);
Vivek Goyal2c3d7352018-05-11 11:49:31 -040095 if (real && (inode == d_inode(real)))
Miklos Szeredid101a122016-03-26 16:14:37 -040096 return real;
97
Vivek Goyal2c3d7352018-05-11 11:49:31 -040098 if (real && !inode && ovl_has_upperdata(d_inode(dentry)))
99 return real;
100
101 real = ovl_dentry_lowerdata(dentry);
Miklos Szeredid101a122016-03-26 16:14:37 -0400102 if (!real)
103 goto bug;
104
Miklos Szeredic4fcfc12016-11-29 10:20:24 +0100105 /* Handle recursion */
Miklos Szeredifb160432018-07-18 15:44:44 +0200106 real = d_real(real, inode);
Miklos Szeredic4fcfc12016-11-29 10:20:24 +0100107
Miklos Szeredid101a122016-03-26 16:14:37 -0400108 if (!inode || inode == d_inode(real))
109 return real;
Miklos Szeredid101a122016-03-26 16:14:37 -0400110bug:
Miklos Szeredi656189d2016-07-29 12:05:24 +0200111 WARN(1, "ovl_d_real(%pd4, %s:%lu): real dentry not found\n", dentry,
Miklos Szeredid101a122016-03-26 16:14:37 -0400112 inode ? inode->i_sb->s_id : "NULL", inode ? inode->i_ino : 0);
113 return dentry;
114}
115
Miklos Szeredi3bb7df92020-03-17 15:04:22 +0100116static int ovl_revalidate_real(struct dentry *d, unsigned int flags, bool weak)
117{
118 int ret = 1;
119
120 if (weak) {
121 if (d->d_flags & DCACHE_OP_WEAK_REVALIDATE)
122 ret = d->d_op->d_weak_revalidate(d, flags);
123 } else if (d->d_flags & DCACHE_OP_REVALIDATE) {
124 ret = d->d_op->d_revalidate(d, flags);
125 if (!ret) {
126 if (!(flags & LOOKUP_RCU))
127 d_invalidate(d);
128 ret = -ESTALE;
129 }
130 }
131 return ret;
132}
133
134static int ovl_dentry_revalidate_common(struct dentry *dentry,
135 unsigned int flags, bool weak)
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200136{
137 struct ovl_entry *oe = dentry->d_fsdata;
Miklos Szeredibccece12020-03-17 15:04:22 +0100138 struct dentry *upper;
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200139 unsigned int i;
140 int ret = 1;
141
Miklos Szeredibccece12020-03-17 15:04:22 +0100142 upper = ovl_dentry_upper(dentry);
143 if (upper)
144 ret = ovl_revalidate_real(upper, flags, weak);
145
Miklos Szeredi3bb7df92020-03-17 15:04:22 +0100146 for (i = 0; ret > 0 && i < oe->numlower; i++) {
147 ret = ovl_revalidate_real(oe->lowerstack[i].dentry, flags,
148 weak);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200149 }
Miklos Szeredi3bb7df92020-03-17 15:04:22 +0100150 return ret;
151}
152
153static int ovl_dentry_revalidate(struct dentry *dentry, unsigned int flags)
154{
155 return ovl_dentry_revalidate_common(dentry, flags, false);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200156}
157
158static int ovl_dentry_weak_revalidate(struct dentry *dentry, unsigned int flags)
159{
Miklos Szeredi3bb7df92020-03-17 15:04:22 +0100160 return ovl_dentry_revalidate_common(dentry, flags, true);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200161}
162
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200163static const struct dentry_operations ovl_dentry_operations = {
164 .d_release = ovl_dentry_release,
Miklos Szeredid101a122016-03-26 16:14:37 -0400165 .d_real = ovl_d_real,
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200166 .d_revalidate = ovl_dentry_revalidate,
167 .d_weak_revalidate = ovl_dentry_weak_revalidate,
168};
169
Amir Goldstein13cf1992017-06-12 09:54:40 +0300170static struct kmem_cache *ovl_inode_cachep;
171
172static struct inode *ovl_alloc_inode(struct super_block *sb)
173{
174 struct ovl_inode *oi = kmem_cache_alloc(ovl_inode_cachep, GFP_KERNEL);
175
Hirofumi Nakagawab3885bd2017-09-26 03:09:53 +0900176 if (!oi)
177 return NULL;
178
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200179 oi->cache = NULL;
Miklos Szeredicf31c462017-07-04 22:03:16 +0200180 oi->redirect = NULL;
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200181 oi->version = 0;
Miklos Szeredi13c72072017-07-04 22:03:16 +0200182 oi->flags = 0;
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200183 oi->__upperdentry = NULL;
Miklos Szeredi25b77132017-07-04 22:03:16 +0200184 oi->lower = NULL;
Vivek Goyal2664bd02018-05-11 11:49:30 -0400185 oi->lowerdata = NULL;
Amir Goldsteina015daf2017-06-21 15:28:51 +0300186 mutex_init(&oi->lock);
Miklos Szeredi25b77132017-07-04 22:03:16 +0200187
Amir Goldstein13cf1992017-06-12 09:54:40 +0300188 return &oi->vfs_inode;
189}
190
Al Viro0b269de2019-04-15 22:52:17 -0400191static void ovl_free_inode(struct inode *inode)
Amir Goldstein13cf1992017-06-12 09:54:40 +0300192{
Al Viro0b269de2019-04-15 22:52:17 -0400193 struct ovl_inode *oi = OVL_I(inode);
Amir Goldstein13cf1992017-06-12 09:54:40 +0300194
Al Viro0b269de2019-04-15 22:52:17 -0400195 kfree(oi->redirect);
196 mutex_destroy(&oi->lock);
197 kmem_cache_free(ovl_inode_cachep, oi);
Amir Goldstein13cf1992017-06-12 09:54:40 +0300198}
199
200static void ovl_destroy_inode(struct inode *inode)
201{
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200202 struct ovl_inode *oi = OVL_I(inode);
203
204 dput(oi->__upperdentry);
Amir Goldstein31747ed2018-01-14 18:35:40 +0200205 iput(oi->lower);
Vivek Goyal2664bd02018-05-11 11:49:30 -0400206 if (S_ISDIR(inode->i_mode))
207 ovl_dir_cache_free(inode);
208 else
209 iput(oi->lowerdata);
Amir Goldstein13cf1992017-06-12 09:54:40 +0300210}
211
Miklos Szerediad204482017-11-10 09:39:16 +0100212static void ovl_free_fs(struct ovl_fs *ofs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200213{
Miklos Szeredidd662662014-12-13 00:59:43 +0100214 unsigned i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200215
Amir Goldstein0be0bfd2019-07-12 15:24:34 +0300216 iput(ofs->workbasedir_trap);
Amir Goldstein146d62e2019-04-18 17:42:08 +0300217 iput(ofs->indexdir_trap);
218 iput(ofs->workdir_trap);
219 iput(ofs->upperdir_trap);
Miklos Szerediad204482017-11-10 09:39:16 +0100220 dput(ofs->indexdir);
221 dput(ofs->workdir);
222 if (ofs->workdir_locked)
223 ovl_inuse_unlock(ofs->workbasedir);
224 dput(ofs->workbasedir);
225 if (ofs->upperdir_locked)
226 ovl_inuse_unlock(ofs->upper_mnt->mnt_root);
227 mntput(ofs->upper_mnt);
Amir Goldstein94375f92019-11-15 14:12:40 +0200228 for (i = 1; i < ofs->numlayer; i++) {
229 iput(ofs->layers[i].trap);
230 mntput(ofs->layers[i].mnt);
Amir Goldstein146d62e2019-04-18 17:42:08 +0300231 }
Amir Goldstein94375f92019-11-15 14:12:40 +0200232 kfree(ofs->layers);
Amir Goldsteinb7bf9902020-01-14 22:17:25 +0200233 for (i = 0; i < ofs->numfs; i++)
Amir Goldstein07f1e592020-01-14 21:59:22 +0200234 free_anon_bdev(ofs->fs[i].pseudo_dev);
235 kfree(ofs->fs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200236
Miklos Szerediad204482017-11-10 09:39:16 +0100237 kfree(ofs->config.lowerdir);
238 kfree(ofs->config.upperdir);
239 kfree(ofs->config.workdir);
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100240 kfree(ofs->config.redirect_mode);
Miklos Szerediad204482017-11-10 09:39:16 +0100241 if (ofs->creator_cred)
242 put_cred(ofs->creator_cred);
243 kfree(ofs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200244}
245
Miklos Szeredia9075cd2017-11-10 09:39:15 +0100246static void ovl_put_super(struct super_block *sb)
247{
248 struct ovl_fs *ofs = sb->s_fs_info;
249
250 ovl_free_fs(ofs);
251}
252
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800253/* Sync real dirty inodes in upper filesystem (if it exists) */
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200254static int ovl_sync_fs(struct super_block *sb, int wait)
255{
Miklos Szerediad204482017-11-10 09:39:16 +0100256 struct ovl_fs *ofs = sb->s_fs_info;
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200257 struct super_block *upper_sb;
258 int ret;
259
Miklos Szerediad204482017-11-10 09:39:16 +0100260 if (!ofs->upper_mnt)
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200261 return 0;
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800262
263 /*
264 * If this is a sync(2) call or an emergency sync, all the super blocks
265 * will be iterated, including upper_sb, so no need to do anything.
266 *
267 * If this is a syncfs(2) call, then we do need to call
268 * sync_filesystem() on upper_sb, but enough if we do it when being
269 * called with wait == 1.
270 */
271 if (!wait)
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200272 return 0;
273
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800274 upper_sb = ofs->upper_mnt->mnt_sb;
275
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200276 down_read(&upper_sb->s_umount);
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800277 ret = sync_filesystem(upper_sb);
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200278 up_read(&upper_sb->s_umount);
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800279
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200280 return ret;
281}
282
Andy Whitcroftcc259632014-10-24 00:14:38 +0200283/**
284 * ovl_statfs
285 * @sb: The overlayfs super block
286 * @buf: The struct kstatfs to fill in with stats
287 *
288 * Get the filesystem statistics. As writes always target the upper layer
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100289 * filesystem pass the statfs to the upper filesystem (if it exists)
Andy Whitcroftcc259632014-10-24 00:14:38 +0200290 */
291static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
292{
293 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
294 struct dentry *root_dentry = dentry->d_sb->s_root;
295 struct path path;
296 int err;
297
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100298 ovl_path_real(root_dentry, &path);
Andy Whitcroftcc259632014-10-24 00:14:38 +0200299
300 err = vfs_statfs(&path, buf);
301 if (!err) {
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100302 buf->f_namelen = ofs->namelen;
Andy Whitcroftcc259632014-10-24 00:14:38 +0200303 buf->f_type = OVERLAYFS_SUPER_MAGIC;
304 }
305
306 return err;
307}
308
Amir Goldstein02bcd152017-06-21 15:28:36 +0300309/* Will this overlay be forced to mount/remount ro? */
Miklos Szerediad204482017-11-10 09:39:16 +0100310static bool ovl_force_readonly(struct ovl_fs *ofs)
Amir Goldstein02bcd152017-06-21 15:28:36 +0300311{
Miklos Szerediad204482017-11-10 09:39:16 +0100312 return (!ofs->upper_mnt || !ofs->workdir);
Amir Goldstein02bcd152017-06-21 15:28:36 +0300313}
314
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100315static const char *ovl_redirect_mode_def(void)
316{
317 return ovl_redirect_dir_def ? "on" : "off";
318}
319
Amir Goldstein795939a2018-03-29 09:08:18 +0300320static const char * const ovl_xino_str[] = {
321 "off",
322 "auto",
323 "on",
324};
325
326static inline int ovl_xino_def(void)
327{
328 return ovl_xino_auto_def ? OVL_XINO_AUTO : OVL_XINO_OFF;
329}
330
Erez Zadokf45827e82014-10-24 00:14:38 +0200331/**
332 * ovl_show_options
333 *
334 * Prints the mount options for a given superblock.
335 * Returns zero; does not fail.
336 */
337static int ovl_show_options(struct seq_file *m, struct dentry *dentry)
338{
339 struct super_block *sb = dentry->d_sb;
Miklos Szerediad204482017-11-10 09:39:16 +0100340 struct ovl_fs *ofs = sb->s_fs_info;
Erez Zadokf45827e82014-10-24 00:14:38 +0200341
Miklos Szerediad204482017-11-10 09:39:16 +0100342 seq_show_option(m, "lowerdir", ofs->config.lowerdir);
343 if (ofs->config.upperdir) {
344 seq_show_option(m, "upperdir", ofs->config.upperdir);
345 seq_show_option(m, "workdir", ofs->config.workdir);
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100346 }
Miklos Szerediad204482017-11-10 09:39:16 +0100347 if (ofs->config.default_permissions)
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200348 seq_puts(m, ",default_permissions");
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100349 if (strcmp(ofs->config.redirect_mode, ovl_redirect_mode_def()) != 0)
350 seq_printf(m, ",redirect_dir=%s", ofs->config.redirect_mode);
Miklos Szerediad204482017-11-10 09:39:16 +0100351 if (ofs->config.index != ovl_index_def)
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100352 seq_printf(m, ",index=%s", ofs->config.index ? "on" : "off");
Amir Goldsteinf168f102018-01-19 11:26:53 +0200353 if (ofs->config.nfs_export != ovl_nfs_export_def)
354 seq_printf(m, ",nfs_export=%s", ofs->config.nfs_export ?
355 "on" : "off");
Amir Goldstein0f831ec2019-11-16 18:14:41 +0200356 if (ofs->config.xino != ovl_xino_def() && !ovl_same_fs(sb))
Amir Goldstein795939a2018-03-29 09:08:18 +0300357 seq_printf(m, ",xino=%s", ovl_xino_str[ofs->config.xino]);
Vivek Goyald5791042018-05-11 11:49:27 -0400358 if (ofs->config.metacopy != ovl_metacopy_def)
359 seq_printf(m, ",metacopy=%s",
360 ofs->config.metacopy ? "on" : "off");
Erez Zadokf45827e82014-10-24 00:14:38 +0200361 return 0;
362}
363
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900364static int ovl_remount(struct super_block *sb, int *flags, char *data)
365{
Miklos Szerediad204482017-11-10 09:39:16 +0100366 struct ovl_fs *ofs = sb->s_fs_info;
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900367
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800368 if (!(*flags & SB_RDONLY) && ovl_force_readonly(ofs))
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900369 return -EROFS;
370
371 return 0;
372}
373
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200374static const struct super_operations ovl_super_operations = {
Amir Goldstein13cf1992017-06-12 09:54:40 +0300375 .alloc_inode = ovl_alloc_inode,
Al Viro0b269de2019-04-15 22:52:17 -0400376 .free_inode = ovl_free_inode,
Amir Goldstein13cf1992017-06-12 09:54:40 +0300377 .destroy_inode = ovl_destroy_inode,
378 .drop_inode = generic_delete_inode,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200379 .put_super = ovl_put_super,
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200380 .sync_fs = ovl_sync_fs,
Andy Whitcroftcc259632014-10-24 00:14:38 +0200381 .statfs = ovl_statfs,
Erez Zadokf45827e82014-10-24 00:14:38 +0200382 .show_options = ovl_show_options,
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900383 .remount_fs = ovl_remount,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200384};
385
386enum {
387 OPT_LOWERDIR,
388 OPT_UPPERDIR,
389 OPT_WORKDIR,
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200390 OPT_DEFAULT_PERMISSIONS,
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100391 OPT_REDIRECT_DIR,
Amir Goldstein02bcd152017-06-21 15:28:36 +0300392 OPT_INDEX_ON,
393 OPT_INDEX_OFF,
Amir Goldsteinf168f102018-01-19 11:26:53 +0200394 OPT_NFS_EXPORT_ON,
395 OPT_NFS_EXPORT_OFF,
Amir Goldstein795939a2018-03-29 09:08:18 +0300396 OPT_XINO_ON,
397 OPT_XINO_OFF,
398 OPT_XINO_AUTO,
Vivek Goyald5791042018-05-11 11:49:27 -0400399 OPT_METACOPY_ON,
400 OPT_METACOPY_OFF,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200401 OPT_ERR,
402};
403
404static const match_table_t ovl_tokens = {
405 {OPT_LOWERDIR, "lowerdir=%s"},
406 {OPT_UPPERDIR, "upperdir=%s"},
407 {OPT_WORKDIR, "workdir=%s"},
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200408 {OPT_DEFAULT_PERMISSIONS, "default_permissions"},
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100409 {OPT_REDIRECT_DIR, "redirect_dir=%s"},
Amir Goldstein02bcd152017-06-21 15:28:36 +0300410 {OPT_INDEX_ON, "index=on"},
411 {OPT_INDEX_OFF, "index=off"},
Amir Goldsteinf168f102018-01-19 11:26:53 +0200412 {OPT_NFS_EXPORT_ON, "nfs_export=on"},
413 {OPT_NFS_EXPORT_OFF, "nfs_export=off"},
Amir Goldstein795939a2018-03-29 09:08:18 +0300414 {OPT_XINO_ON, "xino=on"},
415 {OPT_XINO_OFF, "xino=off"},
416 {OPT_XINO_AUTO, "xino=auto"},
Vivek Goyald5791042018-05-11 11:49:27 -0400417 {OPT_METACOPY_ON, "metacopy=on"},
418 {OPT_METACOPY_OFF, "metacopy=off"},
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200419 {OPT_ERR, NULL}
420};
421
Miklos Szeredi91c77942014-11-20 16:40:00 +0100422static char *ovl_next_opt(char **s)
423{
424 char *sbegin = *s;
425 char *p;
426
427 if (sbegin == NULL)
428 return NULL;
429
430 for (p = sbegin; *p; p++) {
431 if (*p == '\\') {
432 p++;
433 if (!*p)
434 break;
435 } else if (*p == ',') {
436 *p = '\0';
437 *s = p + 1;
438 return sbegin;
439 }
440 }
441 *s = NULL;
442 return sbegin;
443}
444
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100445static int ovl_parse_redirect_mode(struct ovl_config *config, const char *mode)
446{
447 if (strcmp(mode, "on") == 0) {
448 config->redirect_dir = true;
449 /*
450 * Does not make sense to have redirect creation without
451 * redirect following.
452 */
453 config->redirect_follow = true;
454 } else if (strcmp(mode, "follow") == 0) {
455 config->redirect_follow = true;
456 } else if (strcmp(mode, "off") == 0) {
457 if (ovl_redirect_always_follow)
458 config->redirect_follow = true;
459 } else if (strcmp(mode, "nofollow") != 0) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800460 pr_err("bad mount option \"redirect_dir=%s\"\n",
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100461 mode);
462 return -EINVAL;
463 }
464
465 return 0;
466}
467
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200468static int ovl_parse_opt(char *opt, struct ovl_config *config)
469{
470 char *p;
Vivek Goyald5791042018-05-11 11:49:27 -0400471 int err;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100472 bool metacopy_opt = false, redirect_opt = false;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200473
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100474 config->redirect_mode = kstrdup(ovl_redirect_mode_def(), GFP_KERNEL);
475 if (!config->redirect_mode)
476 return -ENOMEM;
477
Miklos Szeredi91c77942014-11-20 16:40:00 +0100478 while ((p = ovl_next_opt(&opt)) != NULL) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200479 int token;
480 substring_t args[MAX_OPT_ARGS];
481
482 if (!*p)
483 continue;
484
485 token = match_token(p, ovl_tokens, args);
486 switch (token) {
487 case OPT_UPPERDIR:
488 kfree(config->upperdir);
489 config->upperdir = match_strdup(&args[0]);
490 if (!config->upperdir)
491 return -ENOMEM;
492 break;
493
494 case OPT_LOWERDIR:
495 kfree(config->lowerdir);
496 config->lowerdir = match_strdup(&args[0]);
497 if (!config->lowerdir)
498 return -ENOMEM;
499 break;
500
501 case OPT_WORKDIR:
502 kfree(config->workdir);
503 config->workdir = match_strdup(&args[0]);
504 if (!config->workdir)
505 return -ENOMEM;
506 break;
507
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200508 case OPT_DEFAULT_PERMISSIONS:
509 config->default_permissions = true;
510 break;
511
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100512 case OPT_REDIRECT_DIR:
513 kfree(config->redirect_mode);
514 config->redirect_mode = match_strdup(&args[0]);
515 if (!config->redirect_mode)
516 return -ENOMEM;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100517 redirect_opt = true;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100518 break;
519
Amir Goldstein02bcd152017-06-21 15:28:36 +0300520 case OPT_INDEX_ON:
521 config->index = true;
522 break;
523
524 case OPT_INDEX_OFF:
525 config->index = false;
526 break;
527
Amir Goldsteinf168f102018-01-19 11:26:53 +0200528 case OPT_NFS_EXPORT_ON:
529 config->nfs_export = true;
530 break;
531
532 case OPT_NFS_EXPORT_OFF:
533 config->nfs_export = false;
534 break;
535
Amir Goldstein795939a2018-03-29 09:08:18 +0300536 case OPT_XINO_ON:
537 config->xino = OVL_XINO_ON;
538 break;
539
540 case OPT_XINO_OFF:
541 config->xino = OVL_XINO_OFF;
542 break;
543
544 case OPT_XINO_AUTO:
545 config->xino = OVL_XINO_AUTO;
546 break;
547
Vivek Goyald5791042018-05-11 11:49:27 -0400548 case OPT_METACOPY_ON:
549 config->metacopy = true;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100550 metacopy_opt = true;
Vivek Goyald5791042018-05-11 11:49:27 -0400551 break;
552
553 case OPT_METACOPY_OFF:
554 config->metacopy = false;
555 break;
556
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200557 default:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800558 pr_err("unrecognized mount option \"%s\" or missing value\n",
559 p);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200560 return -EINVAL;
561 }
562 }
hujianyang71cbad72015-01-15 13:20:57 +0800563
564 /* Workdir is useless in non-upper mount */
565 if (!config->upperdir && config->workdir) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800566 pr_info("option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
hujianyang71cbad72015-01-15 13:20:57 +0800567 config->workdir);
568 kfree(config->workdir);
569 config->workdir = NULL;
570 }
571
Vivek Goyald5791042018-05-11 11:49:27 -0400572 err = ovl_parse_redirect_mode(config, config->redirect_mode);
573 if (err)
574 return err;
575
Miklos Szeredid47748e2018-11-01 21:31:39 +0100576 /*
577 * This is to make the logic below simpler. It doesn't make any other
578 * difference, since config->redirect_dir is only used for upper.
579 */
580 if (!config->upperdir && config->redirect_follow)
581 config->redirect_dir = true;
582
583 /* Resolve metacopy -> redirect_dir dependency */
584 if (config->metacopy && !config->redirect_dir) {
585 if (metacopy_opt && redirect_opt) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800586 pr_err("conflicting options: metacopy=on,redirect_dir=%s\n",
Miklos Szeredid47748e2018-11-01 21:31:39 +0100587 config->redirect_mode);
588 return -EINVAL;
589 }
590 if (redirect_opt) {
591 /*
592 * There was an explicit redirect_dir=... that resulted
593 * in this conflict.
594 */
lijiazi1bd0a3a2019-12-16 19:12:32 +0800595 pr_info("disabling metacopy due to redirect_dir=%s\n",
Miklos Szeredid47748e2018-11-01 21:31:39 +0100596 config->redirect_mode);
597 config->metacopy = false;
598 } else {
599 /* Automatically enable redirect otherwise. */
600 config->redirect_follow = config->redirect_dir = true;
601 }
Vivek Goyald5791042018-05-11 11:49:27 -0400602 }
603
604 return 0;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200605}
606
607#define OVL_WORKDIR_NAME "work"
Amir Goldstein02bcd152017-06-21 15:28:36 +0300608#define OVL_INDEXDIR_NAME "index"
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200609
Miklos Szerediad204482017-11-10 09:39:16 +0100610static struct dentry *ovl_workdir_create(struct ovl_fs *ofs,
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300611 const char *name, bool persist)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200612{
Miklos Szerediad204482017-11-10 09:39:16 +0100613 struct inode *dir = ofs->workbasedir->d_inode;
614 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200615 struct dentry *work;
616 int err;
617 bool retried = false;
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300618 bool locked = false;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200619
Al Viro59551022016-01-22 15:40:57 -0500620 inode_lock_nested(dir, I_MUTEX_PARENT);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300621 locked = true;
622
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200623retry:
Miklos Szerediad204482017-11-10 09:39:16 +0100624 work = lookup_one_len(name, ofs->workbasedir, strlen(name));
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200625
626 if (!IS_ERR(work)) {
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200627 struct iattr attr = {
628 .ia_valid = ATTR_MODE,
Al Viro32a3d842016-12-04 17:33:17 +0000629 .ia_mode = S_IFDIR | 0,
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200630 };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200631
632 if (work->d_inode) {
633 err = -EEXIST;
634 if (retried)
635 goto out_dput;
636
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300637 if (persist)
638 goto out_unlock;
639
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200640 retried = true;
Miklos Szeredieea2fb42016-09-01 11:11:59 +0200641 ovl_workdir_cleanup(dir, mnt, work, 0);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200642 dput(work);
643 goto retry;
644 }
645
Miklos Szeredi95a1c812018-05-16 17:51:25 +0300646 work = ovl_create_real(dir, work, OVL_CATTR(attr.ia_mode));
647 err = PTR_ERR(work);
648 if (IS_ERR(work))
649 goto out_err;
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200650
Miklos Szeredicb348ed2016-10-04 14:40:44 +0200651 /*
652 * Try to remove POSIX ACL xattrs from workdir. We are good if:
653 *
654 * a) success (there was a POSIX ACL xattr and was removed)
655 * b) -ENODATA (there was no POSIX ACL xattr)
656 * c) -EOPNOTSUPP (POSIX ACL xattrs are not supported)
657 *
658 * There are various other error values that could effectively
659 * mean that the xattr doesn't exist (e.g. -ERANGE is returned
660 * if the xattr name is too long), but the set of filesystems
661 * allowed as upper are limited to "normal" ones, where checking
662 * for the above two errors is sufficient.
663 */
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200664 err = vfs_removexattr(work, XATTR_NAME_POSIX_ACL_DEFAULT);
Miklos Szeredie1ff3dd2016-09-05 13:55:20 +0200665 if (err && err != -ENODATA && err != -EOPNOTSUPP)
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200666 goto out_dput;
667
668 err = vfs_removexattr(work, XATTR_NAME_POSIX_ACL_ACCESS);
Miklos Szeredie1ff3dd2016-09-05 13:55:20 +0200669 if (err && err != -ENODATA && err != -EOPNOTSUPP)
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200670 goto out_dput;
671
672 /* Clear any inherited mode bits */
673 inode_lock(work->d_inode);
674 err = notify_change(work, &attr, NULL);
675 inode_unlock(work->d_inode);
676 if (err)
677 goto out_dput;
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300678 } else {
679 err = PTR_ERR(work);
680 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200681 }
682out_unlock:
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300683 if (locked)
684 inode_unlock(dir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200685
686 return work;
687
688out_dput:
689 dput(work);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300690out_err:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800691 pr_warn("failed to create directory %s/%s (errno: %i); mounting read-only\n",
Miklos Szerediad204482017-11-10 09:39:16 +0100692 ofs->config.workdir, name, -err);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300693 work = NULL;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200694 goto out_unlock;
695}
696
Miklos Szeredi91c77942014-11-20 16:40:00 +0100697static void ovl_unescape(char *s)
698{
699 char *d = s;
700
701 for (;; s++, d++) {
702 if (*s == '\\')
703 s++;
704 *d = *s;
705 if (!*s)
706 break;
707 }
708}
709
Miklos Szerediab508822014-12-13 00:59:49 +0100710static int ovl_mount_dir_noesc(const char *name, struct path *path)
711{
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100712 int err = -EINVAL;
Miklos Szerediab508822014-12-13 00:59:49 +0100713
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100714 if (!*name) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800715 pr_err("empty lowerdir\n");
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100716 goto out;
717 }
Miklos Szerediab508822014-12-13 00:59:49 +0100718 err = kern_path(name, LOOKUP_FOLLOW, path);
719 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800720 pr_err("failed to resolve '%s': %i\n", name, err);
Miklos Szerediab508822014-12-13 00:59:49 +0100721 goto out;
722 }
723 err = -EINVAL;
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200724 if (ovl_dentry_weird(path->dentry)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800725 pr_err("filesystem on '%s' not supported\n", name);
Miklos Szerediab508822014-12-13 00:59:49 +0100726 goto out_put;
727 }
Miklos Szeredi2b8c30e2016-12-16 11:02:56 +0100728 if (!d_is_dir(path->dentry)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800729 pr_err("'%s' not a directory\n", name);
Miklos Szerediab508822014-12-13 00:59:49 +0100730 goto out_put;
731 }
732 return 0;
733
734out_put:
Miklos Szeredi8aafcb52017-11-09 10:23:28 +0100735 path_put_init(path);
Miklos Szerediab508822014-12-13 00:59:49 +0100736out:
737 return err;
738}
739
740static int ovl_mount_dir(const char *name, struct path *path)
741{
742 int err = -ENOMEM;
743 char *tmp = kstrdup(name, GFP_KERNEL);
744
745 if (tmp) {
746 ovl_unescape(tmp);
747 err = ovl_mount_dir_noesc(tmp, path);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200748
Miklos Szeredibccece12020-03-17 15:04:22 +0100749 if (!err && path->dentry->d_flags & DCACHE_OP_REAL) {
Miklos Szeredi7925dad2020-03-17 15:04:22 +0100750 pr_err("filesystem on '%s' not supported as upperdir\n",
751 tmp);
752 path_put_init(path);
753 err = -EINVAL;
754 }
Miklos Szerediab508822014-12-13 00:59:49 +0100755 kfree(tmp);
756 }
757 return err;
758}
759
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100760static int ovl_check_namelen(struct path *path, struct ovl_fs *ofs,
761 const char *name)
762{
763 struct kstatfs statfs;
764 int err = vfs_statfs(path, &statfs);
765
766 if (err)
lijiazi1bd0a3a2019-12-16 19:12:32 +0800767 pr_err("statfs failed on '%s'\n", name);
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100768 else
769 ofs->namelen = max(ofs->namelen, statfs.f_namelen);
770
771 return err;
772}
773
774static int ovl_lower_dir(const char *name, struct path *path,
Miklos Szeredif4288842020-03-17 15:04:22 +0100775 struct ovl_fs *ofs, int *stack_depth)
Miklos Szerediab508822014-12-13 00:59:49 +0100776{
Amir Goldsteine487d882017-11-07 13:55:04 +0200777 int fh_type;
Miklos Szerediab508822014-12-13 00:59:49 +0100778 int err;
Miklos Szerediab508822014-12-13 00:59:49 +0100779
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100780 err = ovl_mount_dir_noesc(name, path);
Miklos Szerediab508822014-12-13 00:59:49 +0100781 if (err)
782 goto out;
783
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100784 err = ovl_check_namelen(path, ofs, name);
785 if (err)
Miklos Szerediab508822014-12-13 00:59:49 +0100786 goto out_put;
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100787
Miklos Szerediab508822014-12-13 00:59:49 +0100788 *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
789
Amir Goldstein02bcd152017-06-21 15:28:36 +0300790 /*
Amir Goldsteinf168f102018-01-19 11:26:53 +0200791 * The inodes index feature and NFS export need to encode and decode
792 * file handles, so they require that all layers support them.
Amir Goldstein02bcd152017-06-21 15:28:36 +0300793 */
Amir Goldsteine487d882017-11-07 13:55:04 +0200794 fh_type = ovl_can_decode_fh(path->dentry->d_sb);
Amir Goldsteinf168f102018-01-19 11:26:53 +0200795 if ((ofs->config.nfs_export ||
Amir Goldsteine487d882017-11-07 13:55:04 +0200796 (ofs->config.index && ofs->config.upperdir)) && !fh_type) {
Amir Goldstein02bcd152017-06-21 15:28:36 +0300797 ofs->config.index = false;
Amir Goldsteinf168f102018-01-19 11:26:53 +0200798 ofs->config.nfs_export = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +0800799 pr_warn("fs on '%s' does not support file handles, falling back to index=off,nfs_export=off.\n",
Amir Goldsteinf168f102018-01-19 11:26:53 +0200800 name);
Amir Goldstein02bcd152017-06-21 15:28:36 +0300801 }
802
Amir Goldsteine487d882017-11-07 13:55:04 +0200803 /* Check if lower fs has 32bit inode numbers */
804 if (fh_type != FILEID_INO32_GEN)
Amir Goldstein0f831ec2019-11-16 18:14:41 +0200805 ofs->xino_mode = -1;
Amir Goldsteine487d882017-11-07 13:55:04 +0200806
Miklos Szerediab508822014-12-13 00:59:49 +0100807 return 0;
808
809out_put:
Miklos Szeredi8aafcb52017-11-09 10:23:28 +0100810 path_put_init(path);
Miklos Szerediab508822014-12-13 00:59:49 +0100811out:
812 return err;
813}
814
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200815/* Workdir should not be subdir of upperdir and vice versa */
816static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
817{
818 bool ok = false;
819
820 if (workdir != upperdir) {
821 ok = (lock_rename(workdir, upperdir) == NULL);
822 unlock_rename(workdir, upperdir);
823 }
824 return ok;
825}
826
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100827static unsigned int ovl_split_lowerdirs(char *str)
828{
829 unsigned int ctr = 1;
830 char *s, *d;
831
832 for (s = d = str;; s++, d++) {
833 if (*s == '\\') {
834 s++;
835 } else if (*s == ':') {
836 *d = '\0';
837 ctr++;
838 continue;
839 }
840 *d = *s;
841 if (!*s)
842 break;
843 }
844 return ctr;
845}
846
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200847static int __maybe_unused
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200848ovl_posix_acl_xattr_get(const struct xattr_handler *handler,
849 struct dentry *dentry, struct inode *inode,
850 const char *name, void *buffer, size_t size)
851{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200852 return ovl_xattr_get(dentry, inode, handler->name, buffer, size);
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200853}
854
855static int __maybe_unused
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200856ovl_posix_acl_xattr_set(const struct xattr_handler *handler,
857 struct dentry *dentry, struct inode *inode,
858 const char *name, const void *value,
859 size_t size, int flags)
Miklos Szeredid837a492016-07-29 12:05:24 +0200860{
861 struct dentry *workdir = ovl_workdir(dentry);
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200862 struct inode *realinode = ovl_inode_real(inode);
Miklos Szeredid837a492016-07-29 12:05:24 +0200863 struct posix_acl *acl = NULL;
864 int err;
865
866 /* Check that everything is OK before copy-up */
867 if (value) {
868 acl = posix_acl_from_xattr(&init_user_ns, value, size);
869 if (IS_ERR(acl))
870 return PTR_ERR(acl);
871 }
872 err = -EOPNOTSUPP;
873 if (!IS_POSIXACL(d_inode(workdir)))
874 goto out_acl_release;
875 if (!realinode->i_op->set_acl)
876 goto out_acl_release;
877 if (handler->flags == ACL_TYPE_DEFAULT && !S_ISDIR(inode->i_mode)) {
878 err = acl ? -EACCES : 0;
879 goto out_acl_release;
880 }
881 err = -EPERM;
882 if (!inode_owner_or_capable(inode))
883 goto out_acl_release;
884
885 posix_acl_release(acl);
886
Miklos Szeredifd3220d2016-10-31 14:42:14 +0100887 /*
888 * Check if sgid bit needs to be cleared (actual setacl operation will
889 * be done with mounter's capabilities and so that won't do it for us).
890 */
891 if (unlikely(inode->i_mode & S_ISGID) &&
892 handler->flags == ACL_TYPE_ACCESS &&
893 !in_group_p(inode->i_gid) &&
894 !capable_wrt_inode_uidgid(inode, CAP_FSETID)) {
895 struct iattr iattr = { .ia_valid = ATTR_KILL_SGID };
896
897 err = ovl_setattr(dentry, &iattr);
898 if (err)
899 return err;
900 }
901
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200902 err = ovl_xattr_set(dentry, inode, handler->name, value, size, flags);
Miklos Szeredice315132016-09-01 11:12:00 +0200903 if (!err)
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200904 ovl_copyattr(ovl_inode_real(inode), inode);
Miklos Szeredice315132016-09-01 11:12:00 +0200905
906 return err;
Miklos Szeredid837a492016-07-29 12:05:24 +0200907
908out_acl_release:
909 posix_acl_release(acl);
910 return err;
911}
912
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200913static int ovl_own_xattr_get(const struct xattr_handler *handler,
914 struct dentry *dentry, struct inode *inode,
915 const char *name, void *buffer, size_t size)
916{
Amir Goldstein48fab5d2016-11-16 11:22:39 +0200917 return -EOPNOTSUPP;
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200918}
919
Miklos Szeredid837a492016-07-29 12:05:24 +0200920static int ovl_own_xattr_set(const struct xattr_handler *handler,
921 struct dentry *dentry, struct inode *inode,
922 const char *name, const void *value,
923 size_t size, int flags)
924{
Amir Goldstein48fab5d2016-11-16 11:22:39 +0200925 return -EOPNOTSUPP;
Miklos Szeredid837a492016-07-29 12:05:24 +0200926}
927
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200928static int ovl_other_xattr_get(const struct xattr_handler *handler,
929 struct dentry *dentry, struct inode *inode,
930 const char *name, void *buffer, size_t size)
931{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200932 return ovl_xattr_get(dentry, inode, name, buffer, size);
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200933}
934
Andreas Gruenbacher0e585cc2016-08-22 17:22:11 +0200935static int ovl_other_xattr_set(const struct xattr_handler *handler,
936 struct dentry *dentry, struct inode *inode,
937 const char *name, const void *value,
938 size_t size, int flags)
939{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200940 return ovl_xattr_set(dentry, inode, name, value, size, flags);
Andreas Gruenbacher0e585cc2016-08-22 17:22:11 +0200941}
942
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200943static const struct xattr_handler __maybe_unused
944ovl_posix_acl_access_xattr_handler = {
Miklos Szeredid837a492016-07-29 12:05:24 +0200945 .name = XATTR_NAME_POSIX_ACL_ACCESS,
946 .flags = ACL_TYPE_ACCESS,
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200947 .get = ovl_posix_acl_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200948 .set = ovl_posix_acl_xattr_set,
949};
950
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200951static const struct xattr_handler __maybe_unused
952ovl_posix_acl_default_xattr_handler = {
Miklos Szeredid837a492016-07-29 12:05:24 +0200953 .name = XATTR_NAME_POSIX_ACL_DEFAULT,
954 .flags = ACL_TYPE_DEFAULT,
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200955 .get = ovl_posix_acl_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200956 .set = ovl_posix_acl_xattr_set,
957};
958
959static const struct xattr_handler ovl_own_xattr_handler = {
960 .prefix = OVL_XATTR_PREFIX,
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200961 .get = ovl_own_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200962 .set = ovl_own_xattr_set,
963};
964
965static const struct xattr_handler ovl_other_xattr_handler = {
966 .prefix = "", /* catch all */
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200967 .get = ovl_other_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200968 .set = ovl_other_xattr_set,
969};
970
971static const struct xattr_handler *ovl_xattr_handlers[] = {
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200972#ifdef CONFIG_FS_POSIX_ACL
Miklos Szeredid837a492016-07-29 12:05:24 +0200973 &ovl_posix_acl_access_xattr_handler,
974 &ovl_posix_acl_default_xattr_handler,
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200975#endif
Miklos Szeredid837a492016-07-29 12:05:24 +0200976 &ovl_own_xattr_handler,
977 &ovl_other_xattr_handler,
978 NULL
979};
980
Amir Goldstein146d62e2019-04-18 17:42:08 +0300981static int ovl_setup_trap(struct super_block *sb, struct dentry *dir,
982 struct inode **ptrap, const char *name)
983{
984 struct inode *trap;
985 int err;
986
987 trap = ovl_get_trap_inode(sb, dir);
Arnd Bergmann1dac6f5b2019-06-17 14:39:29 +0200988 err = PTR_ERR_OR_ZERO(trap);
989 if (err) {
Amir Goldstein146d62e2019-04-18 17:42:08 +0300990 if (err == -ELOOP)
lijiazi1bd0a3a2019-12-16 19:12:32 +0800991 pr_err("conflicting %s path\n", name);
Amir Goldstein146d62e2019-04-18 17:42:08 +0300992 return err;
993 }
994
995 *ptrap = trap;
996 return 0;
997}
998
Amir Goldstein0be0bfd2019-07-12 15:24:34 +0300999/*
1000 * Determine how we treat concurrent use of upperdir/workdir based on the
1001 * index feature. This is papering over mount leaks of container runtimes,
1002 * for example, an old overlay mount is leaked and now its upperdir is
1003 * attempted to be used as a lower layer in a new overlay mount.
1004 */
1005static int ovl_report_in_use(struct ovl_fs *ofs, const char *name)
1006{
1007 if (ofs->config.index) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001008 pr_err("%s is in-use as upperdir/workdir of another mount, mount with '-o index=off' to override exclusive upperdir protection.\n",
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001009 name);
1010 return -EBUSY;
1011 } else {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001012 pr_warn("%s is in-use as upperdir/workdir of another mount, accessing files from both mounts will result in undefined behavior.\n",
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001013 name);
1014 return 0;
1015 }
1016}
1017
Amir Goldstein146d62e2019-04-18 17:42:08 +03001018static int ovl_get_upper(struct super_block *sb, struct ovl_fs *ofs,
1019 struct path *upperpath)
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001020{
Miklos Szeredi50649752017-11-10 09:39:15 +01001021 struct vfsmount *upper_mnt;
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001022 int err;
1023
Miklos Szerediad204482017-11-10 09:39:16 +01001024 err = ovl_mount_dir(ofs->config.upperdir, upperpath);
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001025 if (err)
1026 goto out;
1027
1028 /* Upper fs should not be r/o */
1029 if (sb_rdonly(upperpath->mnt->mnt_sb)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001030 pr_err("upper fs is r/o, try multi-lower layers mount\n");
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001031 err = -EINVAL;
1032 goto out;
1033 }
1034
Miklos Szerediad204482017-11-10 09:39:16 +01001035 err = ovl_check_namelen(upperpath, ofs, ofs->config.upperdir);
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001036 if (err)
1037 goto out;
1038
Amir Goldstein146d62e2019-04-18 17:42:08 +03001039 err = ovl_setup_trap(sb, upperpath->dentry, &ofs->upperdir_trap,
1040 "upperdir");
1041 if (err)
1042 goto out;
1043
Miklos Szeredi50649752017-11-10 09:39:15 +01001044 upper_mnt = clone_private_mount(upperpath);
1045 err = PTR_ERR(upper_mnt);
1046 if (IS_ERR(upper_mnt)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001047 pr_err("failed to clone upperpath\n");
Miklos Szeredi50649752017-11-10 09:39:15 +01001048 goto out;
1049 }
1050
1051 /* Don't inherit atime flags */
1052 upper_mnt->mnt_flags &= ~(MNT_NOATIME | MNT_NODIRATIME | MNT_RELATIME);
Miklos Szerediad204482017-11-10 09:39:16 +01001053 ofs->upper_mnt = upper_mnt;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001054
Miklos Szeredi8c257412018-09-10 11:43:29 +02001055 if (ovl_inuse_trylock(ofs->upper_mnt->mnt_root)) {
1056 ofs->upperdir_locked = true;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001057 } else {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001058 err = ovl_report_in_use(ofs, "upperdir");
1059 if (err)
1060 goto out;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001061 }
1062
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001063 err = 0;
1064out:
1065 return err;
1066}
1067
Amir Goldsteincad218a2020-02-20 09:00:19 +02001068/*
1069 * Returns 1 if RENAME_WHITEOUT is supported, 0 if not supported and
1070 * negative values if error is encountered.
1071 */
1072static int ovl_check_rename_whiteout(struct dentry *workdir)
1073{
1074 struct inode *dir = d_inode(workdir);
1075 struct dentry *temp;
1076 struct dentry *dest;
1077 struct dentry *whiteout;
1078 struct name_snapshot name;
1079 int err;
1080
1081 inode_lock_nested(dir, I_MUTEX_PARENT);
1082
1083 temp = ovl_create_temp(workdir, OVL_CATTR(S_IFREG | 0));
1084 err = PTR_ERR(temp);
1085 if (IS_ERR(temp))
1086 goto out_unlock;
1087
1088 dest = ovl_lookup_temp(workdir);
1089 err = PTR_ERR(dest);
1090 if (IS_ERR(dest)) {
1091 dput(temp);
1092 goto out_unlock;
1093 }
1094
1095 /* Name is inline and stable - using snapshot as a copy helper */
1096 take_dentry_name_snapshot(&name, temp);
1097 err = ovl_do_rename(dir, temp, dir, dest, RENAME_WHITEOUT);
1098 if (err) {
1099 if (err == -EINVAL)
1100 err = 0;
1101 goto cleanup_temp;
1102 }
1103
1104 whiteout = lookup_one_len(name.name.name, workdir, name.name.len);
1105 err = PTR_ERR(whiteout);
1106 if (IS_ERR(whiteout))
1107 goto cleanup_temp;
1108
1109 err = ovl_is_whiteout(whiteout);
1110
1111 /* Best effort cleanup of whiteout and temp file */
1112 if (err)
1113 ovl_cleanup(dir, whiteout);
1114 dput(whiteout);
1115
1116cleanup_temp:
1117 ovl_cleanup(dir, temp);
1118 release_dentry_name_snapshot(&name);
1119 dput(temp);
1120 dput(dest);
1121
1122out_unlock:
1123 inode_unlock(dir);
1124
1125 return err;
1126}
1127
Amir Goldstein146d62e2019-04-18 17:42:08 +03001128static int ovl_make_workdir(struct super_block *sb, struct ovl_fs *ofs,
1129 struct path *workpath)
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001130{
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001131 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001132 struct dentry *temp;
Amir Goldsteind80172c2020-02-20 09:03:08 +02001133 bool rename_whiteout;
1134 bool d_type;
Amir Goldsteine487d882017-11-07 13:55:04 +02001135 int fh_type;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001136 int err;
1137
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001138 err = mnt_want_write(mnt);
1139 if (err)
1140 return err;
1141
Miklos Szerediad204482017-11-10 09:39:16 +01001142 ofs->workdir = ovl_workdir_create(ofs, OVL_WORKDIR_NAME, false);
1143 if (!ofs->workdir)
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001144 goto out;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001145
Amir Goldstein146d62e2019-04-18 17:42:08 +03001146 err = ovl_setup_trap(sb, ofs->workdir, &ofs->workdir_trap, "workdir");
1147 if (err)
1148 goto out;
1149
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001150 /*
1151 * Upper should support d_type, else whiteouts are visible. Given
1152 * workdir and upper are on same fs, we can do iterate_dir() on
1153 * workdir. This check requires successful creation of workdir in
1154 * previous step.
1155 */
1156 err = ovl_check_d_type_supported(workpath);
1157 if (err < 0)
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001158 goto out;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001159
Amir Goldsteind80172c2020-02-20 09:03:08 +02001160 d_type = err;
1161 if (!d_type)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001162 pr_warn("upper fs needs to support d_type.\n");
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001163
1164 /* Check if upper/work fs supports O_TMPFILE */
Miklos Szerediad204482017-11-10 09:39:16 +01001165 temp = ovl_do_tmpfile(ofs->workdir, S_IFREG | 0);
1166 ofs->tmpfile = !IS_ERR(temp);
1167 if (ofs->tmpfile)
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001168 dput(temp);
1169 else
lijiazi1bd0a3a2019-12-16 19:12:32 +08001170 pr_warn("upper fs does not support tmpfile.\n");
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001171
Amir Goldsteincad218a2020-02-20 09:00:19 +02001172
1173 /* Check if upper/work fs supports RENAME_WHITEOUT */
1174 err = ovl_check_rename_whiteout(ofs->workdir);
1175 if (err < 0)
1176 goto out;
1177
Amir Goldsteind80172c2020-02-20 09:03:08 +02001178 rename_whiteout = err;
1179 if (!rename_whiteout)
Amir Goldsteincad218a2020-02-20 09:00:19 +02001180 pr_warn("upper fs does not support RENAME_WHITEOUT.\n");
1181
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001182 /*
1183 * Check if upper/work fs supports trusted.overlay.* xattr
1184 */
Miklos Szerediad204482017-11-10 09:39:16 +01001185 err = ovl_do_setxattr(ofs->workdir, OVL_XATTR_OPAQUE, "0", 1, 0);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001186 if (err) {
Miklos Szerediad204482017-11-10 09:39:16 +01001187 ofs->noxattr = true;
Amir Goldsteina6837372017-09-19 12:14:18 +03001188 ofs->config.index = false;
Vivek Goyald5791042018-05-11 11:49:27 -04001189 ofs->config.metacopy = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001190 pr_warn("upper fs does not support xattr, falling back to index=off and metacopy=off.\n");
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001191 err = 0;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001192 } else {
Miklos Szerediad204482017-11-10 09:39:16 +01001193 vfs_removexattr(ofs->workdir, OVL_XATTR_OPAQUE);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001194 }
1195
Amir Goldsteind80172c2020-02-20 09:03:08 +02001196 /*
1197 * We allowed sub-optimal upper fs configuration and don't want to break
1198 * users over kernel upgrade, but we never allowed remote upper fs, so
1199 * we can enforce strict requirements for remote upper fs.
1200 */
1201 if (ovl_dentry_remote(ofs->workdir) &&
1202 (!d_type || !rename_whiteout || ofs->noxattr)) {
1203 pr_err("upper fs missing required features.\n");
1204 err = -EINVAL;
1205 goto out;
1206 }
1207
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001208 /* Check if upper/work fs supports file handles */
Amir Goldsteine487d882017-11-07 13:55:04 +02001209 fh_type = ovl_can_decode_fh(ofs->workdir->d_sb);
1210 if (ofs->config.index && !fh_type) {
Miklos Szerediad204482017-11-10 09:39:16 +01001211 ofs->config.index = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001212 pr_warn("upper fs does not support file handles, falling back to index=off.\n");
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001213 }
1214
Amir Goldsteine487d882017-11-07 13:55:04 +02001215 /* Check if upper fs has 32bit inode numbers */
1216 if (fh_type != FILEID_INO32_GEN)
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001217 ofs->xino_mode = -1;
Amir Goldsteine487d882017-11-07 13:55:04 +02001218
Amir Goldsteinf168f102018-01-19 11:26:53 +02001219 /* NFS export of r/w mount depends on index */
1220 if (ofs->config.nfs_export && !ofs->config.index) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001221 pr_warn("NFS export requires \"index=on\", falling back to nfs_export=off.\n");
Amir Goldsteinf168f102018-01-19 11:26:53 +02001222 ofs->config.nfs_export = false;
1223 }
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001224out:
1225 mnt_drop_write(mnt);
1226 return err;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001227}
1228
Amir Goldstein146d62e2019-04-18 17:42:08 +03001229static int ovl_get_workdir(struct super_block *sb, struct ovl_fs *ofs,
1230 struct path *upperpath)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001231{
1232 int err;
Miklos Szeredibca44b52017-11-10 09:39:15 +01001233 struct path workpath = { };
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001234
Miklos Szerediad204482017-11-10 09:39:16 +01001235 err = ovl_mount_dir(ofs->config.workdir, &workpath);
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001236 if (err)
1237 goto out;
1238
1239 err = -EINVAL;
Miklos Szeredibca44b52017-11-10 09:39:15 +01001240 if (upperpath->mnt != workpath.mnt) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001241 pr_err("workdir and upperdir must reside under the same mount\n");
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001242 goto out;
1243 }
Miklos Szeredibca44b52017-11-10 09:39:15 +01001244 if (!ovl_workdir_ok(workpath.dentry, upperpath->dentry)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001245 pr_err("workdir and upperdir must be separate subtrees\n");
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001246 goto out;
1247 }
1248
Miklos Szeredi8c257412018-09-10 11:43:29 +02001249 ofs->workbasedir = dget(workpath.dentry);
1250
Miklos Szeredi8c257412018-09-10 11:43:29 +02001251 if (ovl_inuse_trylock(ofs->workbasedir)) {
Miklos Szerediad204482017-11-10 09:39:16 +01001252 ofs->workdir_locked = true;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001253 } else {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001254 err = ovl_report_in_use(ofs, "workdir");
1255 if (err)
1256 goto out;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001257 }
1258
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001259 err = ovl_setup_trap(sb, ofs->workbasedir, &ofs->workbasedir_trap,
1260 "workdir");
1261 if (err)
1262 goto out;
1263
Amir Goldstein146d62e2019-04-18 17:42:08 +03001264 err = ovl_make_workdir(sb, ofs, &workpath);
Miklos Szeredibca44b52017-11-10 09:39:15 +01001265
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001266out:
Miklos Szeredibca44b52017-11-10 09:39:15 +01001267 path_put(&workpath);
1268
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001269 return err;
1270}
1271
Amir Goldstein146d62e2019-04-18 17:42:08 +03001272static int ovl_get_indexdir(struct super_block *sb, struct ovl_fs *ofs,
1273 struct ovl_entry *oe, struct path *upperpath)
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001274{
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001275 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001276 int err;
1277
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001278 err = mnt_want_write(mnt);
1279 if (err)
1280 return err;
1281
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001282 /* Verify lower root is upper root origin */
Amir Goldsteind9768072017-09-24 13:00:19 +03001283 err = ovl_verify_origin(upperpath->dentry, oe->lowerstack[0].dentry,
Amir Goldstein05122442018-01-11 08:25:32 +02001284 true);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001285 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001286 pr_err("failed to verify upper root origin\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001287 goto out;
1288 }
1289
Miklos Szerediad204482017-11-10 09:39:16 +01001290 ofs->indexdir = ovl_workdir_create(ofs, OVL_INDEXDIR_NAME, true);
1291 if (ofs->indexdir) {
Amir Goldstein146d62e2019-04-18 17:42:08 +03001292 err = ovl_setup_trap(sb, ofs->indexdir, &ofs->indexdir_trap,
1293 "indexdir");
1294 if (err)
1295 goto out;
1296
Amir Goldsteinad1d6152018-01-11 10:47:03 +02001297 /*
1298 * Verify upper root is exclusively associated with index dir.
1299 * Older kernels stored upper fh in "trusted.overlay.origin"
1300 * xattr. If that xattr exists, verify that it is a match to
1301 * upper dir file handle. In any case, verify or set xattr
1302 * "trusted.overlay.upper" to indicate that index may have
1303 * directory entries.
1304 */
1305 if (ovl_check_origin_xattr(ofs->indexdir)) {
1306 err = ovl_verify_set_fh(ofs->indexdir, OVL_XATTR_ORIGIN,
1307 upperpath->dentry, true, false);
1308 if (err)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001309 pr_err("failed to verify index dir 'origin' xattr\n");
Amir Goldsteinad1d6152018-01-11 10:47:03 +02001310 }
1311 err = ovl_verify_upper(ofs->indexdir, upperpath->dentry, true);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001312 if (err)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001313 pr_err("failed to verify index dir 'upper' xattr\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001314
1315 /* Cleanup bad/stale/orphan index entries */
1316 if (!err)
Amir Goldstein1eff1a12017-12-12 22:40:46 +02001317 err = ovl_indexdir_cleanup(ofs);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001318 }
Miklos Szerediad204482017-11-10 09:39:16 +01001319 if (err || !ofs->indexdir)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001320 pr_warn("try deleting index dir or mounting with '-o index=off' to disable inodes index.\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001321
1322out:
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001323 mnt_drop_write(mnt);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001324 return err;
1325}
1326
Amir Goldstein9df085f2018-09-03 09:12:09 +03001327static bool ovl_lower_uuid_ok(struct ovl_fs *ofs, const uuid_t *uuid)
Amir Goldstein51486262018-03-28 20:22:41 +03001328{
1329 unsigned int i;
Amir Goldstein9df085f2018-09-03 09:12:09 +03001330
Amir Goldstein7e63c872019-11-14 22:28:41 +02001331 if (!ofs->config.nfs_export && !ofs->upper_mnt)
Amir Goldstein9df085f2018-09-03 09:12:09 +03001332 return true;
1333
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001334 for (i = 0; i < ofs->numfs; i++) {
Amir Goldstein9df085f2018-09-03 09:12:09 +03001335 /*
1336 * We use uuid to associate an overlay lower file handle with a
1337 * lower layer, so we can accept lower fs with null uuid as long
1338 * as all lower layers with null uuid are on the same fs.
Amir Goldstein7e63c872019-11-14 22:28:41 +02001339 * if we detect multiple lower fs with the same uuid, we
1340 * disable lower file handle decoding on all of them.
Amir Goldstein9df085f2018-09-03 09:12:09 +03001341 */
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001342 if (ofs->fs[i].is_lower &&
1343 uuid_equal(&ofs->fs[i].sb->s_uuid, uuid)) {
Amir Goldstein07f1e592020-01-14 21:59:22 +02001344 ofs->fs[i].bad_uuid = true;
Amir Goldstein9df085f2018-09-03 09:12:09 +03001345 return false;
Amir Goldstein7e63c872019-11-14 22:28:41 +02001346 }
Amir Goldstein9df085f2018-09-03 09:12:09 +03001347 }
1348 return true;
1349}
1350
1351/* Get a unique fsid for the layer */
1352static int ovl_get_fsid(struct ovl_fs *ofs, const struct path *path)
1353{
1354 struct super_block *sb = path->mnt->mnt_sb;
1355 unsigned int i;
Amir Goldstein51486262018-03-28 20:22:41 +03001356 dev_t dev;
1357 int err;
Amir Goldstein7e63c872019-11-14 22:28:41 +02001358 bool bad_uuid = false;
Amir Goldstein51486262018-03-28 20:22:41 +03001359
Amir Goldstein07f1e592020-01-14 21:59:22 +02001360 for (i = 0; i < ofs->numfs; i++) {
1361 if (ofs->fs[i].sb == sb)
1362 return i;
Amir Goldstein51486262018-03-28 20:22:41 +03001363 }
1364
Amir Goldstein9df085f2018-09-03 09:12:09 +03001365 if (!ovl_lower_uuid_ok(ofs, &sb->s_uuid)) {
Amir Goldstein7e63c872019-11-14 22:28:41 +02001366 bad_uuid = true;
1367 if (ofs->config.index || ofs->config.nfs_export) {
1368 ofs->config.index = false;
1369 ofs->config.nfs_export = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001370 pr_warn("%s uuid detected in lower fs '%pd2', falling back to index=off,nfs_export=off.\n",
Amir Goldstein7e63c872019-11-14 22:28:41 +02001371 uuid_is_null(&sb->s_uuid) ? "null" :
1372 "conflicting",
1373 path->dentry);
1374 }
Amir Goldstein9df085f2018-09-03 09:12:09 +03001375 }
1376
Amir Goldstein51486262018-03-28 20:22:41 +03001377 err = get_anon_bdev(&dev);
1378 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001379 pr_err("failed to get anonymous bdev for lowerpath\n");
Amir Goldstein51486262018-03-28 20:22:41 +03001380 return err;
1381 }
1382
Amir Goldstein07f1e592020-01-14 21:59:22 +02001383 ofs->fs[ofs->numfs].sb = sb;
1384 ofs->fs[ofs->numfs].pseudo_dev = dev;
1385 ofs->fs[ofs->numfs].bad_uuid = bad_uuid;
Amir Goldstein51486262018-03-28 20:22:41 +03001386
Amir Goldstein07f1e592020-01-14 21:59:22 +02001387 return ofs->numfs++;
Amir Goldstein51486262018-03-28 20:22:41 +03001388}
1389
Amir Goldstein94375f92019-11-15 14:12:40 +02001390static int ovl_get_layers(struct super_block *sb, struct ovl_fs *ofs,
1391 struct path *stack, unsigned int numlower)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001392{
1393 int err;
1394 unsigned int i;
Miklos Szeredi13464162020-01-24 09:46:45 +01001395 struct ovl_layer *layers;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001396
1397 err = -ENOMEM;
Miklos Szeredi13464162020-01-24 09:46:45 +01001398 layers = kcalloc(numlower + 1, sizeof(struct ovl_layer), GFP_KERNEL);
1399 if (!layers)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001400 goto out;
Miklos Szeredi13464162020-01-24 09:46:45 +01001401 ofs->layers = layers;
Amir Goldstein51486262018-03-28 20:22:41 +03001402
Amir Goldstein07f1e592020-01-14 21:59:22 +02001403 ofs->fs = kcalloc(numlower + 1, sizeof(struct ovl_sb), GFP_KERNEL);
1404 if (ofs->fs == NULL)
Amir Goldstein51486262018-03-28 20:22:41 +03001405 goto out;
1406
Amir Goldstein07f1e592020-01-14 21:59:22 +02001407 /* idx/fsid 0 are reserved for upper fs even with lower only overlay */
1408 ofs->numfs++;
1409
Miklos Szeredi13464162020-01-24 09:46:45 +01001410 layers[0].mnt = ofs->upper_mnt;
1411 layers[0].idx = 0;
1412 layers[0].fsid = 0;
Amir Goldstein94375f92019-11-15 14:12:40 +02001413 ofs->numlayer = 1;
1414
Amir Goldstein07f1e592020-01-14 21:59:22 +02001415 /*
Amir Goldsteinb7bf9902020-01-14 22:17:25 +02001416 * All lower layers that share the same fs as upper layer, use the same
1417 * pseudo_dev as upper layer. Allocate fs[0].pseudo_dev even for lower
1418 * only overlay to simplify ovl_fs_free().
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001419 * is_lower will be set if upper fs is shared with a lower layer.
Amir Goldstein07f1e592020-01-14 21:59:22 +02001420 */
Amir Goldsteinb7bf9902020-01-14 22:17:25 +02001421 err = get_anon_bdev(&ofs->fs[0].pseudo_dev);
1422 if (err) {
1423 pr_err("failed to get anonymous bdev for upper fs\n");
1424 goto out;
1425 }
1426
Amir Goldstein07f1e592020-01-14 21:59:22 +02001427 if (ofs->upper_mnt) {
1428 ofs->fs[0].sb = ofs->upper_mnt->mnt_sb;
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001429 ofs->fs[0].is_lower = false;
Amir Goldstein07f1e592020-01-14 21:59:22 +02001430 }
1431
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001432 for (i = 0; i < numlower; i++) {
1433 struct vfsmount *mnt;
Amir Goldstein146d62e2019-04-18 17:42:08 +03001434 struct inode *trap;
Amir Goldstein51486262018-03-28 20:22:41 +03001435 int fsid;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001436
Amir Goldstein9df085f2018-09-03 09:12:09 +03001437 err = fsid = ovl_get_fsid(ofs, &stack[i]);
Amir Goldstein51486262018-03-28 20:22:41 +03001438 if (err < 0)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001439 goto out;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001440
Amir Goldstein146d62e2019-04-18 17:42:08 +03001441 err = ovl_setup_trap(sb, stack[i].dentry, &trap, "lowerdir");
1442 if (err)
1443 goto out;
1444
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001445 if (ovl_is_inuse(stack[i].dentry)) {
1446 err = ovl_report_in_use(ofs, "lowerdir");
1447 if (err)
1448 goto out;
1449 }
1450
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001451 mnt = clone_private_mount(&stack[i]);
1452 err = PTR_ERR(mnt);
1453 if (IS_ERR(mnt)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001454 pr_err("failed to clone lowerpath\n");
Amir Goldstein146d62e2019-04-18 17:42:08 +03001455 iput(trap);
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001456 goto out;
1457 }
Amir Goldstein51486262018-03-28 20:22:41 +03001458
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001459 /*
1460 * Make lower layers R/O. That way fchmod/fchown on lower file
1461 * will fail instead of modifying lower fs.
1462 */
1463 mnt->mnt_flags |= MNT_READONLY | MNT_NOATIME;
1464
Miklos Szeredi13464162020-01-24 09:46:45 +01001465 layers[ofs->numlayer].trap = trap;
1466 layers[ofs->numlayer].mnt = mnt;
1467 layers[ofs->numlayer].idx = ofs->numlayer;
1468 layers[ofs->numlayer].fsid = fsid;
1469 layers[ofs->numlayer].fs = &ofs->fs[fsid];
Amir Goldstein94375f92019-11-15 14:12:40 +02001470 ofs->numlayer++;
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001471 ofs->fs[fsid].is_lower = true;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001472 }
Amir Goldsteine487d882017-11-07 13:55:04 +02001473
Amir Goldstein795939a2018-03-29 09:08:18 +03001474 /*
1475 * When all layers on same fs, overlay can use real inode numbers.
Amir Goldstein926e94d2020-02-21 16:34:45 +02001476 * With mount option "xino=<on|auto>", mounter declares that there are
1477 * enough free high bits in underlying fs to hold the unique fsid.
Amir Goldstein795939a2018-03-29 09:08:18 +03001478 * If overlayfs does encounter underlying inodes using the high xino
1479 * bits reserved for fsid, it emits a warning and uses the original
Amir Goldsteindfe51d42020-02-21 16:34:44 +02001480 * inode number or a non persistent inode number allocated from a
1481 * dedicated range.
Amir Goldstein795939a2018-03-29 09:08:18 +03001482 */
Amir Goldstein07f1e592020-01-14 21:59:22 +02001483 if (ofs->numfs - !ofs->upper_mnt == 1) {
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001484 if (ofs->config.xino == OVL_XINO_ON)
1485 pr_info("\"xino=on\" is useless with all layers on same fs, ignore.\n");
1486 ofs->xino_mode = 0;
Amir Goldstein53afcd32020-02-21 16:34:42 +02001487 } else if (ofs->config.xino == OVL_XINO_OFF) {
1488 ofs->xino_mode = -1;
Amir Goldstein926e94d2020-02-21 16:34:45 +02001489 } else if (ofs->xino_mode < 0) {
Amir Goldstein795939a2018-03-29 09:08:18 +03001490 /*
Amir Goldstein07f1e592020-01-14 21:59:22 +02001491 * This is a roundup of number of bits needed for encoding
Amir Goldsteindfe51d42020-02-21 16:34:44 +02001492 * fsid, where fsid 0 is reserved for upper fs (even with
1493 * lower only overlay) +1 extra bit is reserved for the non
1494 * persistent inode number range that is used for resolving
1495 * xino lower bits overflow.
Amir Goldstein795939a2018-03-29 09:08:18 +03001496 */
Amir Goldsteindfe51d42020-02-21 16:34:44 +02001497 BUILD_BUG_ON(ilog2(OVL_MAX_STACK) > 30);
1498 ofs->xino_mode = ilog2(ofs->numfs - 1) + 2;
Amir Goldstein795939a2018-03-29 09:08:18 +03001499 }
1500
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001501 if (ofs->xino_mode > 0) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001502 pr_info("\"xino\" feature enabled using %d upper inode bits.\n",
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001503 ofs->xino_mode);
Amir Goldstein795939a2018-03-29 09:08:18 +03001504 }
Amir Goldsteine487d882017-11-07 13:55:04 +02001505
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001506 err = 0;
1507out:
1508 return err;
1509}
1510
Miklos Szeredi4155c102017-11-10 09:39:15 +01001511static struct ovl_entry *ovl_get_lowerstack(struct super_block *sb,
Miklos Szerediad204482017-11-10 09:39:16 +01001512 struct ovl_fs *ofs)
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001513{
1514 int err;
1515 char *lowertmp, *lower;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001516 struct path *stack = NULL;
1517 unsigned int stacklen, numlower = 0, i;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001518 struct ovl_entry *oe;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001519
1520 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001521 lowertmp = kstrdup(ofs->config.lowerdir, GFP_KERNEL);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001522 if (!lowertmp)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001523 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001524
1525 err = -EINVAL;
1526 stacklen = ovl_split_lowerdirs(lowertmp);
1527 if (stacklen > OVL_MAX_STACK) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001528 pr_err("too many lower directories, limit is %d\n",
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001529 OVL_MAX_STACK);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001530 goto out_err;
Miklos Szerediad204482017-11-10 09:39:16 +01001531 } else if (!ofs->config.upperdir && stacklen == 1) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001532 pr_err("at least 2 lowerdir are needed while upperdir nonexistent\n");
Miklos Szeredi4155c102017-11-10 09:39:15 +01001533 goto out_err;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001534 } else if (!ofs->config.upperdir && ofs->config.nfs_export &&
1535 ofs->config.redirect_follow) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001536 pr_warn("NFS export requires \"redirect_dir=nofollow\" on non-upper mount, falling back to nfs_export=off.\n");
Amir Goldsteinf168f102018-01-19 11:26:53 +02001537 ofs->config.nfs_export = false;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001538 }
1539
1540 err = -ENOMEM;
1541 stack = kcalloc(stacklen, sizeof(struct path), GFP_KERNEL);
1542 if (!stack)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001543 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001544
1545 err = -EINVAL;
1546 lower = lowertmp;
1547 for (numlower = 0; numlower < stacklen; numlower++) {
Miklos Szerediad204482017-11-10 09:39:16 +01001548 err = ovl_lower_dir(lower, &stack[numlower], ofs,
Miklos Szeredif4288842020-03-17 15:04:22 +01001549 &sb->s_stack_depth);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001550 if (err)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001551 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001552
1553 lower = strchr(lower, '\0') + 1;
1554 }
1555
1556 err = -EINVAL;
1557 sb->s_stack_depth++;
1558 if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001559 pr_err("maximum fs stacking depth exceeded\n");
Miklos Szeredi4155c102017-11-10 09:39:15 +01001560 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001561 }
1562
Amir Goldstein94375f92019-11-15 14:12:40 +02001563 err = ovl_get_layers(sb, ofs, stack, numlower);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001564 if (err)
1565 goto out_err;
1566
1567 err = -ENOMEM;
1568 oe = ovl_alloc_entry(numlower);
1569 if (!oe)
1570 goto out_err;
1571
1572 for (i = 0; i < numlower; i++) {
1573 oe->lowerstack[i].dentry = dget(stack[i].dentry);
Amir Goldstein94375f92019-11-15 14:12:40 +02001574 oe->lowerstack[i].layer = &ofs->layers[i+1];
Miklos Szeredi4155c102017-11-10 09:39:15 +01001575 }
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001576
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001577out:
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001578 for (i = 0; i < numlower; i++)
1579 path_put(&stack[i]);
1580 kfree(stack);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001581 kfree(lowertmp);
1582
1583 return oe;
1584
1585out_err:
1586 oe = ERR_PTR(err);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001587 goto out;
1588}
1589
Amir Goldstein146d62e2019-04-18 17:42:08 +03001590/*
1591 * Check if this layer root is a descendant of:
1592 * - another layer of this overlayfs instance
1593 * - upper/work dir of any overlayfs instance
Amir Goldstein146d62e2019-04-18 17:42:08 +03001594 */
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001595static int ovl_check_layer(struct super_block *sb, struct ovl_fs *ofs,
1596 struct dentry *dentry, const char *name)
Amir Goldstein146d62e2019-04-18 17:42:08 +03001597{
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001598 struct dentry *next = dentry, *parent;
Amir Goldstein146d62e2019-04-18 17:42:08 +03001599 int err = 0;
1600
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001601 if (!dentry)
Amir Goldstein146d62e2019-04-18 17:42:08 +03001602 return 0;
1603
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001604 parent = dget_parent(next);
1605
1606 /* Walk back ancestors to root (inclusive) looking for traps */
1607 while (!err && parent != next) {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001608 if (ovl_lookup_trap_inode(sb, parent)) {
Amir Goldstein146d62e2019-04-18 17:42:08 +03001609 err = -ELOOP;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001610 pr_err("overlapping %s path\n", name);
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001611 } else if (ovl_is_inuse(parent)) {
1612 err = ovl_report_in_use(ofs, name);
Amir Goldstein146d62e2019-04-18 17:42:08 +03001613 }
Amir Goldstein146d62e2019-04-18 17:42:08 +03001614 next = parent;
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001615 parent = dget_parent(next);
1616 dput(next);
Amir Goldstein146d62e2019-04-18 17:42:08 +03001617 }
1618
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001619 dput(parent);
Amir Goldstein146d62e2019-04-18 17:42:08 +03001620
1621 return err;
1622}
1623
1624/*
1625 * Check if any of the layers or work dirs overlap.
1626 */
1627static int ovl_check_overlapping_layers(struct super_block *sb,
1628 struct ovl_fs *ofs)
1629{
1630 int i, err;
1631
1632 if (ofs->upper_mnt) {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001633 err = ovl_check_layer(sb, ofs, ofs->upper_mnt->mnt_root,
1634 "upperdir");
Amir Goldstein146d62e2019-04-18 17:42:08 +03001635 if (err)
1636 return err;
1637
1638 /*
1639 * Checking workbasedir avoids hitting ovl_is_inuse(parent) of
1640 * this instance and covers overlapping work and index dirs,
1641 * unless work or index dir have been moved since created inside
1642 * workbasedir. In that case, we already have their traps in
1643 * inode cache and we will catch that case on lookup.
1644 */
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001645 err = ovl_check_layer(sb, ofs, ofs->workbasedir, "workdir");
Amir Goldstein146d62e2019-04-18 17:42:08 +03001646 if (err)
1647 return err;
1648 }
1649
Amir Goldstein94375f92019-11-15 14:12:40 +02001650 for (i = 1; i < ofs->numlayer; i++) {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001651 err = ovl_check_layer(sb, ofs,
Amir Goldstein94375f92019-11-15 14:12:40 +02001652 ofs->layers[i].mnt->mnt_root,
Amir Goldstein146d62e2019-04-18 17:42:08 +03001653 "lowerdir");
1654 if (err)
1655 return err;
1656 }
1657
1658 return 0;
1659}
1660
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001661static struct dentry *ovl_get_root(struct super_block *sb,
1662 struct dentry *upperdentry,
1663 struct ovl_entry *oe)
1664{
1665 struct dentry *root;
Amir Goldstein62c832e2019-11-19 15:31:46 +02001666 struct ovl_path *lowerpath = &oe->lowerstack[0];
1667 unsigned long ino = d_inode(lowerpath->dentry)->i_ino;
1668 int fsid = lowerpath->layer->fsid;
1669 struct ovl_inode_params oip = {
1670 .upperdentry = upperdentry,
1671 .lowerpath = lowerpath,
1672 };
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001673
1674 root = d_make_root(ovl_new_inode(sb, S_IFDIR, 0));
1675 if (!root)
1676 return NULL;
1677
1678 root->d_fsdata = oe;
1679
1680 if (upperdentry) {
Amir Goldstein62c832e2019-11-19 15:31:46 +02001681 /* Root inode uses upper st_ino/i_ino */
1682 ino = d_inode(upperdentry)->i_ino;
1683 fsid = 0;
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001684 ovl_dentry_set_upper_alias(root);
1685 if (ovl_is_impuredir(upperdentry))
1686 ovl_set_flag(OVL_IMPURE, d_inode(root));
1687 }
1688
1689 /* Root is always merge -> can have whiteouts */
1690 ovl_set_flag(OVL_WHITEOUTS, d_inode(root));
1691 ovl_dentry_set_flag(OVL_E_CONNECTED, root);
1692 ovl_set_upperdata(d_inode(root));
Amir Goldstein62c832e2019-11-19 15:31:46 +02001693 ovl_inode_init(d_inode(root), &oip, ino, fsid);
Miklos Szeredif4288842020-03-17 15:04:22 +01001694 ovl_dentry_update_reval(root, upperdentry, DCACHE_OP_WEAK_REVALIDATE);
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001695
1696 return root;
1697}
1698
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001699static int ovl_fill_super(struct super_block *sb, void *data, int silent)
1700{
Kees Cook33006cd2017-03-29 14:02:19 -07001701 struct path upperpath = { };
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001702 struct dentry *root_dentry;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001703 struct ovl_entry *oe;
Miklos Szerediad204482017-11-10 09:39:16 +01001704 struct ovl_fs *ofs;
Konstantin Khlebnikov51f8f3c2017-01-10 21:30:21 +03001705 struct cred *cred;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001706 int err;
1707
Miklos Szeredif4288842020-03-17 15:04:22 +01001708 sb->s_d_op = &ovl_dentry_operations;
1709
Erez Zadokf45827e82014-10-24 00:14:38 +02001710 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001711 ofs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
1712 if (!ofs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001713 goto out;
1714
Miklos Szerediad204482017-11-10 09:39:16 +01001715 ofs->creator_cred = cred = prepare_creds();
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001716 if (!cred)
1717 goto out_err;
1718
Miklos Szerediad204482017-11-10 09:39:16 +01001719 ofs->config.index = ovl_index_def;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001720 ofs->config.nfs_export = ovl_nfs_export_def;
Amir Goldstein795939a2018-03-29 09:08:18 +03001721 ofs->config.xino = ovl_xino_def();
Vivek Goyald5791042018-05-11 11:49:27 -04001722 ofs->config.metacopy = ovl_metacopy_def;
Miklos Szerediad204482017-11-10 09:39:16 +01001723 err = ovl_parse_opt((char *) data, &ofs->config);
Erez Zadokf45827e82014-10-24 00:14:38 +02001724 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001725 goto out_err;
Erez Zadokf45827e82014-10-24 00:14:38 +02001726
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001727 err = -EINVAL;
Miklos Szerediad204482017-11-10 09:39:16 +01001728 if (!ofs->config.lowerdir) {
Konstantin Khlebnikov07f2af72015-06-29 20:18:56 +03001729 if (!silent)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001730 pr_err("missing 'lowerdir'\n");
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001731 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001732 }
1733
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001734 sb->s_stack_depth = 0;
Miklos Szeredicf9a6782015-12-11 16:30:49 +01001735 sb->s_maxbytes = MAX_LFS_FILESIZE;
Amir Goldstein4d314f72020-02-21 16:34:43 +02001736 atomic_long_set(&ofs->last_ino, 1);
Amir Goldsteine487d882017-11-07 13:55:04 +02001737 /* Assume underlaying fs uses 32bit inodes unless proven otherwise */
Amir Goldstein53afcd32020-02-21 16:34:42 +02001738 if (ofs->config.xino != OVL_XINO_OFF) {
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001739 ofs->xino_mode = BITS_PER_LONG - 32;
Amir Goldstein53afcd32020-02-21 16:34:42 +02001740 if (!ofs->xino_mode) {
1741 pr_warn("xino not supported on 32bit kernel, falling back to xino=off.\n");
1742 ofs->config.xino = OVL_XINO_OFF;
1743 }
1744 }
Amir Goldstein795939a2018-03-29 09:08:18 +03001745
Amir Goldstein146d62e2019-04-18 17:42:08 +03001746 /* alloc/destroy_inode needed for setting up traps in inode cache */
1747 sb->s_op = &ovl_super_operations;
1748
Miklos Szerediad204482017-11-10 09:39:16 +01001749 if (ofs->config.upperdir) {
1750 if (!ofs->config.workdir) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001751 pr_err("missing 'workdir'\n");
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001752 goto out_err;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001753 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001754
Amir Goldstein146d62e2019-04-18 17:42:08 +03001755 err = ovl_get_upper(sb, ofs, &upperpath);
Miklos Szeredi21a3b312017-11-09 10:23:28 +01001756 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001757 goto out_err;
Miklos Szeredid719e8f2016-07-29 12:05:23 +02001758
Amir Goldstein146d62e2019-04-18 17:42:08 +03001759 err = ovl_get_workdir(sb, ofs, &upperpath);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001760 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001761 goto out_err;
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001762
Miklos Szerediad204482017-11-10 09:39:16 +01001763 if (!ofs->workdir)
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001764 sb->s_flags |= SB_RDONLY;
Miklos Szeredi6e882562017-11-10 09:39:15 +01001765
Miklos Szerediad204482017-11-10 09:39:16 +01001766 sb->s_stack_depth = ofs->upper_mnt->mnt_sb->s_stack_depth;
1767 sb->s_time_gran = ofs->upper_mnt->mnt_sb->s_time_gran;
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001768
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001769 }
Miklos Szerediad204482017-11-10 09:39:16 +01001770 oe = ovl_get_lowerstack(sb, ofs);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001771 err = PTR_ERR(oe);
1772 if (IS_ERR(oe))
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001773 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001774
hujianyang71cbad72015-01-15 13:20:57 +08001775 /* If the upper fs is nonexistent, we mark overlayfs r/o too */
Miklos Szerediad204482017-11-10 09:39:16 +01001776 if (!ofs->upper_mnt)
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001777 sb->s_flags |= SB_RDONLY;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001778
Miklos Szerediad204482017-11-10 09:39:16 +01001779 if (!(ovl_force_readonly(ofs)) && ofs->config.index) {
Amir Goldstein146d62e2019-04-18 17:42:08 +03001780 err = ovl_get_indexdir(sb, ofs, oe, &upperpath);
Amir Goldstein54fb3472017-06-21 15:28:38 +03001781 if (err)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001782 goto out_free_oe;
Miklos Szeredi6e882562017-11-10 09:39:15 +01001783
Amir Goldstein972d0092017-09-19 12:14:18 +03001784 /* Force r/o mount with no index dir */
1785 if (!ofs->indexdir) {
1786 dput(ofs->workdir);
1787 ofs->workdir = NULL;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001788 sb->s_flags |= SB_RDONLY;
Amir Goldstein972d0092017-09-19 12:14:18 +03001789 }
1790
Amir Goldstein02bcd152017-06-21 15:28:36 +03001791 }
1792
Amir Goldstein146d62e2019-04-18 17:42:08 +03001793 err = ovl_check_overlapping_layers(sb, ofs);
1794 if (err)
1795 goto out_free_oe;
1796
Amir Goldstein972d0092017-09-19 12:14:18 +03001797 /* Show index=off in /proc/mounts for forced r/o mount */
Amir Goldsteinf168f102018-01-19 11:26:53 +02001798 if (!ofs->indexdir) {
Miklos Szerediad204482017-11-10 09:39:16 +01001799 ofs->config.index = false;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001800 if (ofs->upper_mnt && ofs->config.nfs_export) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001801 pr_warn("NFS export requires an index dir, falling back to nfs_export=off.\n");
Amir Goldsteinf168f102018-01-19 11:26:53 +02001802 ofs->config.nfs_export = false;
1803 }
1804 }
Amir Goldstein02bcd152017-06-21 15:28:36 +03001805
Vivek Goyald5791042018-05-11 11:49:27 -04001806 if (ofs->config.metacopy && ofs->config.nfs_export) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001807 pr_warn("NFS export is not supported with metadata only copy up, falling back to nfs_export=off.\n");
Vivek Goyald5791042018-05-11 11:49:27 -04001808 ofs->config.nfs_export = false;
1809 }
1810
Amir Goldstein8383f172017-10-02 11:31:42 +03001811 if (ofs->config.nfs_export)
1812 sb->s_export_op = &ovl_export_operations;
1813
Konstantin Khlebnikov51f8f3c2017-01-10 21:30:21 +03001814 /* Never override disk quota limits or use reserved space */
1815 cap_lower(cred->cap_effective, CAP_SYS_RESOURCE);
1816
Vivek Goyal655042c2016-10-14 03:03:36 +02001817 sb->s_magic = OVERLAYFS_SUPER_MAGIC;
Vivek Goyal655042c2016-10-14 03:03:36 +02001818 sb->s_xattr = ovl_xattr_handlers;
Miklos Szerediad204482017-11-10 09:39:16 +01001819 sb->s_fs_info = ofs;
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001820 sb->s_flags |= SB_POSIXACL;
Vivek Goyal655042c2016-10-14 03:03:36 +02001821
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001822 err = -ENOMEM;
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001823 root_dentry = ovl_get_root(sb, upperpath.dentry, oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001824 if (!root_dentry)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001825 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001826
1827 mntput(upperpath.mnt);
Miklos Szeredied06e062015-12-09 16:11:59 +01001828
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001829 sb->s_root = root_dentry;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001830
1831 return 0;
1832
Miklos Szeredi4155c102017-11-10 09:39:15 +01001833out_free_oe:
1834 ovl_entry_stack_free(oe);
Chandan Rajendrab9343632017-07-24 01:57:54 -05001835 kfree(oe);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001836out_err:
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001837 path_put(&upperpath);
Miklos Szerediad204482017-11-10 09:39:16 +01001838 ovl_free_fs(ofs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001839out:
1840 return err;
1841}
1842
1843static struct dentry *ovl_mount(struct file_system_type *fs_type, int flags,
1844 const char *dev_name, void *raw_data)
1845{
1846 return mount_nodev(fs_type, flags, raw_data, ovl_fill_super);
1847}
1848
1849static struct file_system_type ovl_fs_type = {
1850 .owner = THIS_MODULE,
Miklos Szeredief94b182014-11-20 16:39:59 +01001851 .name = "overlay",
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001852 .mount = ovl_mount,
1853 .kill_sb = kill_anon_super,
1854};
Miklos Szeredief94b182014-11-20 16:39:59 +01001855MODULE_ALIAS_FS("overlay");
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001856
Amir Goldstein13cf1992017-06-12 09:54:40 +03001857static void ovl_inode_init_once(void *foo)
1858{
1859 struct ovl_inode *oi = foo;
1860
1861 inode_init_once(&oi->vfs_inode);
1862}
1863
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001864static int __init ovl_init(void)
1865{
Amir Goldstein13cf1992017-06-12 09:54:40 +03001866 int err;
1867
1868 ovl_inode_cachep = kmem_cache_create("ovl_inode",
1869 sizeof(struct ovl_inode), 0,
1870 (SLAB_RECLAIM_ACCOUNT|
1871 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
1872 ovl_inode_init_once);
1873 if (ovl_inode_cachep == NULL)
1874 return -ENOMEM;
1875
Jiufei Xue2406a302019-11-20 17:45:26 +08001876 err = ovl_aio_request_cache_init();
1877 if (!err) {
1878 err = register_filesystem(&ovl_fs_type);
1879 if (!err)
1880 return 0;
1881
1882 ovl_aio_request_cache_destroy();
1883 }
1884 kmem_cache_destroy(ovl_inode_cachep);
Amir Goldstein13cf1992017-06-12 09:54:40 +03001885
1886 return err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001887}
1888
1889static void __exit ovl_exit(void)
1890{
1891 unregister_filesystem(&ovl_fs_type);
Amir Goldstein13cf1992017-06-12 09:54:40 +03001892
1893 /*
1894 * Make sure all delayed rcu free inodes are flushed before we
1895 * destroy cache.
1896 */
1897 rcu_barrier();
1898 kmem_cache_destroy(ovl_inode_cachep);
Jiufei Xue2406a302019-11-20 17:45:26 +08001899 ovl_aio_request_cache_destroy();
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001900}
1901
1902module_init(ovl_init);
1903module_exit(ovl_exit);