blob: ac013ed97a53ecae931a71e5b009c5146798bf70 [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 +0300320enum {
321 OVL_XINO_OFF,
322 OVL_XINO_AUTO,
323 OVL_XINO_ON,
324};
325
326static const char * const ovl_xino_str[] = {
327 "off",
328 "auto",
329 "on",
330};
331
332static inline int ovl_xino_def(void)
333{
334 return ovl_xino_auto_def ? OVL_XINO_AUTO : OVL_XINO_OFF;
335}
336
Erez Zadokf45827e82014-10-24 00:14:38 +0200337/**
338 * ovl_show_options
339 *
340 * Prints the mount options for a given superblock.
341 * Returns zero; does not fail.
342 */
343static int ovl_show_options(struct seq_file *m, struct dentry *dentry)
344{
345 struct super_block *sb = dentry->d_sb;
Miklos Szerediad204482017-11-10 09:39:16 +0100346 struct ovl_fs *ofs = sb->s_fs_info;
Erez Zadokf45827e82014-10-24 00:14:38 +0200347
Miklos Szerediad204482017-11-10 09:39:16 +0100348 seq_show_option(m, "lowerdir", ofs->config.lowerdir);
349 if (ofs->config.upperdir) {
350 seq_show_option(m, "upperdir", ofs->config.upperdir);
351 seq_show_option(m, "workdir", ofs->config.workdir);
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100352 }
Miklos Szerediad204482017-11-10 09:39:16 +0100353 if (ofs->config.default_permissions)
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200354 seq_puts(m, ",default_permissions");
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100355 if (strcmp(ofs->config.redirect_mode, ovl_redirect_mode_def()) != 0)
356 seq_printf(m, ",redirect_dir=%s", ofs->config.redirect_mode);
Miklos Szerediad204482017-11-10 09:39:16 +0100357 if (ofs->config.index != ovl_index_def)
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100358 seq_printf(m, ",index=%s", ofs->config.index ? "on" : "off");
Amir Goldsteinf168f102018-01-19 11:26:53 +0200359 if (ofs->config.nfs_export != ovl_nfs_export_def)
360 seq_printf(m, ",nfs_export=%s", ofs->config.nfs_export ?
361 "on" : "off");
Amir Goldstein0f831ec2019-11-16 18:14:41 +0200362 if (ofs->config.xino != ovl_xino_def() && !ovl_same_fs(sb))
Amir Goldstein795939a2018-03-29 09:08:18 +0300363 seq_printf(m, ",xino=%s", ovl_xino_str[ofs->config.xino]);
Vivek Goyald5791042018-05-11 11:49:27 -0400364 if (ofs->config.metacopy != ovl_metacopy_def)
365 seq_printf(m, ",metacopy=%s",
366 ofs->config.metacopy ? "on" : "off");
Erez Zadokf45827e82014-10-24 00:14:38 +0200367 return 0;
368}
369
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900370static int ovl_remount(struct super_block *sb, int *flags, char *data)
371{
Miklos Szerediad204482017-11-10 09:39:16 +0100372 struct ovl_fs *ofs = sb->s_fs_info;
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900373
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800374 if (!(*flags & SB_RDONLY) && ovl_force_readonly(ofs))
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900375 return -EROFS;
376
377 return 0;
378}
379
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200380static const struct super_operations ovl_super_operations = {
Amir Goldstein13cf1992017-06-12 09:54:40 +0300381 .alloc_inode = ovl_alloc_inode,
Al Viro0b269de2019-04-15 22:52:17 -0400382 .free_inode = ovl_free_inode,
Amir Goldstein13cf1992017-06-12 09:54:40 +0300383 .destroy_inode = ovl_destroy_inode,
384 .drop_inode = generic_delete_inode,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200385 .put_super = ovl_put_super,
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200386 .sync_fs = ovl_sync_fs,
Andy Whitcroftcc259632014-10-24 00:14:38 +0200387 .statfs = ovl_statfs,
Erez Zadokf45827e82014-10-24 00:14:38 +0200388 .show_options = ovl_show_options,
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900389 .remount_fs = ovl_remount,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200390};
391
392enum {
393 OPT_LOWERDIR,
394 OPT_UPPERDIR,
395 OPT_WORKDIR,
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200396 OPT_DEFAULT_PERMISSIONS,
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100397 OPT_REDIRECT_DIR,
Amir Goldstein02bcd152017-06-21 15:28:36 +0300398 OPT_INDEX_ON,
399 OPT_INDEX_OFF,
Amir Goldsteinf168f102018-01-19 11:26:53 +0200400 OPT_NFS_EXPORT_ON,
401 OPT_NFS_EXPORT_OFF,
Amir Goldstein795939a2018-03-29 09:08:18 +0300402 OPT_XINO_ON,
403 OPT_XINO_OFF,
404 OPT_XINO_AUTO,
Vivek Goyald5791042018-05-11 11:49:27 -0400405 OPT_METACOPY_ON,
406 OPT_METACOPY_OFF,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200407 OPT_ERR,
408};
409
410static const match_table_t ovl_tokens = {
411 {OPT_LOWERDIR, "lowerdir=%s"},
412 {OPT_UPPERDIR, "upperdir=%s"},
413 {OPT_WORKDIR, "workdir=%s"},
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200414 {OPT_DEFAULT_PERMISSIONS, "default_permissions"},
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100415 {OPT_REDIRECT_DIR, "redirect_dir=%s"},
Amir Goldstein02bcd152017-06-21 15:28:36 +0300416 {OPT_INDEX_ON, "index=on"},
417 {OPT_INDEX_OFF, "index=off"},
Amir Goldsteinf168f102018-01-19 11:26:53 +0200418 {OPT_NFS_EXPORT_ON, "nfs_export=on"},
419 {OPT_NFS_EXPORT_OFF, "nfs_export=off"},
Amir Goldstein795939a2018-03-29 09:08:18 +0300420 {OPT_XINO_ON, "xino=on"},
421 {OPT_XINO_OFF, "xino=off"},
422 {OPT_XINO_AUTO, "xino=auto"},
Vivek Goyald5791042018-05-11 11:49:27 -0400423 {OPT_METACOPY_ON, "metacopy=on"},
424 {OPT_METACOPY_OFF, "metacopy=off"},
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200425 {OPT_ERR, NULL}
426};
427
Miklos Szeredi91c77942014-11-20 16:40:00 +0100428static char *ovl_next_opt(char **s)
429{
430 char *sbegin = *s;
431 char *p;
432
433 if (sbegin == NULL)
434 return NULL;
435
436 for (p = sbegin; *p; p++) {
437 if (*p == '\\') {
438 p++;
439 if (!*p)
440 break;
441 } else if (*p == ',') {
442 *p = '\0';
443 *s = p + 1;
444 return sbegin;
445 }
446 }
447 *s = NULL;
448 return sbegin;
449}
450
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100451static int ovl_parse_redirect_mode(struct ovl_config *config, const char *mode)
452{
453 if (strcmp(mode, "on") == 0) {
454 config->redirect_dir = true;
455 /*
456 * Does not make sense to have redirect creation without
457 * redirect following.
458 */
459 config->redirect_follow = true;
460 } else if (strcmp(mode, "follow") == 0) {
461 config->redirect_follow = true;
462 } else if (strcmp(mode, "off") == 0) {
463 if (ovl_redirect_always_follow)
464 config->redirect_follow = true;
465 } else if (strcmp(mode, "nofollow") != 0) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800466 pr_err("bad mount option \"redirect_dir=%s\"\n",
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100467 mode);
468 return -EINVAL;
469 }
470
471 return 0;
472}
473
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200474static int ovl_parse_opt(char *opt, struct ovl_config *config)
475{
476 char *p;
Vivek Goyald5791042018-05-11 11:49:27 -0400477 int err;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100478 bool metacopy_opt = false, redirect_opt = false;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200479
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100480 config->redirect_mode = kstrdup(ovl_redirect_mode_def(), GFP_KERNEL);
481 if (!config->redirect_mode)
482 return -ENOMEM;
483
Miklos Szeredi91c77942014-11-20 16:40:00 +0100484 while ((p = ovl_next_opt(&opt)) != NULL) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200485 int token;
486 substring_t args[MAX_OPT_ARGS];
487
488 if (!*p)
489 continue;
490
491 token = match_token(p, ovl_tokens, args);
492 switch (token) {
493 case OPT_UPPERDIR:
494 kfree(config->upperdir);
495 config->upperdir = match_strdup(&args[0]);
496 if (!config->upperdir)
497 return -ENOMEM;
498 break;
499
500 case OPT_LOWERDIR:
501 kfree(config->lowerdir);
502 config->lowerdir = match_strdup(&args[0]);
503 if (!config->lowerdir)
504 return -ENOMEM;
505 break;
506
507 case OPT_WORKDIR:
508 kfree(config->workdir);
509 config->workdir = match_strdup(&args[0]);
510 if (!config->workdir)
511 return -ENOMEM;
512 break;
513
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200514 case OPT_DEFAULT_PERMISSIONS:
515 config->default_permissions = true;
516 break;
517
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100518 case OPT_REDIRECT_DIR:
519 kfree(config->redirect_mode);
520 config->redirect_mode = match_strdup(&args[0]);
521 if (!config->redirect_mode)
522 return -ENOMEM;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100523 redirect_opt = true;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100524 break;
525
Amir Goldstein02bcd152017-06-21 15:28:36 +0300526 case OPT_INDEX_ON:
527 config->index = true;
528 break;
529
530 case OPT_INDEX_OFF:
531 config->index = false;
532 break;
533
Amir Goldsteinf168f102018-01-19 11:26:53 +0200534 case OPT_NFS_EXPORT_ON:
535 config->nfs_export = true;
536 break;
537
538 case OPT_NFS_EXPORT_OFF:
539 config->nfs_export = false;
540 break;
541
Amir Goldstein795939a2018-03-29 09:08:18 +0300542 case OPT_XINO_ON:
543 config->xino = OVL_XINO_ON;
544 break;
545
546 case OPT_XINO_OFF:
547 config->xino = OVL_XINO_OFF;
548 break;
549
550 case OPT_XINO_AUTO:
551 config->xino = OVL_XINO_AUTO;
552 break;
553
Vivek Goyald5791042018-05-11 11:49:27 -0400554 case OPT_METACOPY_ON:
555 config->metacopy = true;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100556 metacopy_opt = true;
Vivek Goyald5791042018-05-11 11:49:27 -0400557 break;
558
559 case OPT_METACOPY_OFF:
560 config->metacopy = false;
561 break;
562
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200563 default:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800564 pr_err("unrecognized mount option \"%s\" or missing value\n",
565 p);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200566 return -EINVAL;
567 }
568 }
hujianyang71cbad72015-01-15 13:20:57 +0800569
570 /* Workdir is useless in non-upper mount */
571 if (!config->upperdir && config->workdir) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800572 pr_info("option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
hujianyang71cbad72015-01-15 13:20:57 +0800573 config->workdir);
574 kfree(config->workdir);
575 config->workdir = NULL;
576 }
577
Vivek Goyald5791042018-05-11 11:49:27 -0400578 err = ovl_parse_redirect_mode(config, config->redirect_mode);
579 if (err)
580 return err;
581
Miklos Szeredid47748e2018-11-01 21:31:39 +0100582 /*
583 * This is to make the logic below simpler. It doesn't make any other
584 * difference, since config->redirect_dir is only used for upper.
585 */
586 if (!config->upperdir && config->redirect_follow)
587 config->redirect_dir = true;
588
589 /* Resolve metacopy -> redirect_dir dependency */
590 if (config->metacopy && !config->redirect_dir) {
591 if (metacopy_opt && redirect_opt) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800592 pr_err("conflicting options: metacopy=on,redirect_dir=%s\n",
Miklos Szeredid47748e2018-11-01 21:31:39 +0100593 config->redirect_mode);
594 return -EINVAL;
595 }
596 if (redirect_opt) {
597 /*
598 * There was an explicit redirect_dir=... that resulted
599 * in this conflict.
600 */
lijiazi1bd0a3a2019-12-16 19:12:32 +0800601 pr_info("disabling metacopy due to redirect_dir=%s\n",
Miklos Szeredid47748e2018-11-01 21:31:39 +0100602 config->redirect_mode);
603 config->metacopy = false;
604 } else {
605 /* Automatically enable redirect otherwise. */
606 config->redirect_follow = config->redirect_dir = true;
607 }
Vivek Goyald5791042018-05-11 11:49:27 -0400608 }
609
610 return 0;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200611}
612
613#define OVL_WORKDIR_NAME "work"
Amir Goldstein02bcd152017-06-21 15:28:36 +0300614#define OVL_INDEXDIR_NAME "index"
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200615
Miklos Szerediad204482017-11-10 09:39:16 +0100616static struct dentry *ovl_workdir_create(struct ovl_fs *ofs,
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300617 const char *name, bool persist)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200618{
Miklos Szerediad204482017-11-10 09:39:16 +0100619 struct inode *dir = ofs->workbasedir->d_inode;
620 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200621 struct dentry *work;
622 int err;
623 bool retried = false;
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300624 bool locked = false;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200625
Al Viro59551022016-01-22 15:40:57 -0500626 inode_lock_nested(dir, I_MUTEX_PARENT);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300627 locked = true;
628
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200629retry:
Miklos Szerediad204482017-11-10 09:39:16 +0100630 work = lookup_one_len(name, ofs->workbasedir, strlen(name));
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200631
632 if (!IS_ERR(work)) {
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200633 struct iattr attr = {
634 .ia_valid = ATTR_MODE,
Al Viro32a3d842016-12-04 17:33:17 +0000635 .ia_mode = S_IFDIR | 0,
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200636 };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200637
638 if (work->d_inode) {
639 err = -EEXIST;
640 if (retried)
641 goto out_dput;
642
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300643 if (persist)
644 goto out_unlock;
645
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200646 retried = true;
Miklos Szeredieea2fb42016-09-01 11:11:59 +0200647 ovl_workdir_cleanup(dir, mnt, work, 0);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200648 dput(work);
649 goto retry;
650 }
651
Miklos Szeredi95a1c812018-05-16 17:51:25 +0300652 work = ovl_create_real(dir, work, OVL_CATTR(attr.ia_mode));
653 err = PTR_ERR(work);
654 if (IS_ERR(work))
655 goto out_err;
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200656
Miklos Szeredicb348ed2016-10-04 14:40:44 +0200657 /*
658 * Try to remove POSIX ACL xattrs from workdir. We are good if:
659 *
660 * a) success (there was a POSIX ACL xattr and was removed)
661 * b) -ENODATA (there was no POSIX ACL xattr)
662 * c) -EOPNOTSUPP (POSIX ACL xattrs are not supported)
663 *
664 * There are various other error values that could effectively
665 * mean that the xattr doesn't exist (e.g. -ERANGE is returned
666 * if the xattr name is too long), but the set of filesystems
667 * allowed as upper are limited to "normal" ones, where checking
668 * for the above two errors is sufficient.
669 */
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200670 err = vfs_removexattr(work, XATTR_NAME_POSIX_ACL_DEFAULT);
Miklos Szeredie1ff3dd2016-09-05 13:55:20 +0200671 if (err && err != -ENODATA && err != -EOPNOTSUPP)
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200672 goto out_dput;
673
674 err = vfs_removexattr(work, XATTR_NAME_POSIX_ACL_ACCESS);
Miklos Szeredie1ff3dd2016-09-05 13:55:20 +0200675 if (err && err != -ENODATA && err != -EOPNOTSUPP)
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200676 goto out_dput;
677
678 /* Clear any inherited mode bits */
679 inode_lock(work->d_inode);
680 err = notify_change(work, &attr, NULL);
681 inode_unlock(work->d_inode);
682 if (err)
683 goto out_dput;
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300684 } else {
685 err = PTR_ERR(work);
686 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200687 }
688out_unlock:
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300689 if (locked)
690 inode_unlock(dir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200691
692 return work;
693
694out_dput:
695 dput(work);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300696out_err:
lijiazi1bd0a3a2019-12-16 19:12:32 +0800697 pr_warn("failed to create directory %s/%s (errno: %i); mounting read-only\n",
Miklos Szerediad204482017-11-10 09:39:16 +0100698 ofs->config.workdir, name, -err);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300699 work = NULL;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200700 goto out_unlock;
701}
702
Miklos Szeredi91c77942014-11-20 16:40:00 +0100703static void ovl_unescape(char *s)
704{
705 char *d = s;
706
707 for (;; s++, d++) {
708 if (*s == '\\')
709 s++;
710 *d = *s;
711 if (!*s)
712 break;
713 }
714}
715
Miklos Szerediab508822014-12-13 00:59:49 +0100716static int ovl_mount_dir_noesc(const char *name, struct path *path)
717{
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100718 int err = -EINVAL;
Miklos Szerediab508822014-12-13 00:59:49 +0100719
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100720 if (!*name) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800721 pr_err("empty lowerdir\n");
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100722 goto out;
723 }
Miklos Szerediab508822014-12-13 00:59:49 +0100724 err = kern_path(name, LOOKUP_FOLLOW, path);
725 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800726 pr_err("failed to resolve '%s': %i\n", name, err);
Miklos Szerediab508822014-12-13 00:59:49 +0100727 goto out;
728 }
729 err = -EINVAL;
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200730 if (ovl_dentry_weird(path->dentry)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800731 pr_err("filesystem on '%s' not supported\n", name);
Miklos Szerediab508822014-12-13 00:59:49 +0100732 goto out_put;
733 }
Miklos Szeredi2b8c30e2016-12-16 11:02:56 +0100734 if (!d_is_dir(path->dentry)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +0800735 pr_err("'%s' not a directory\n", name);
Miklos Szerediab508822014-12-13 00:59:49 +0100736 goto out_put;
737 }
738 return 0;
739
740out_put:
Miklos Szeredi8aafcb52017-11-09 10:23:28 +0100741 path_put_init(path);
Miklos Szerediab508822014-12-13 00:59:49 +0100742out:
743 return err;
744}
745
746static int ovl_mount_dir(const char *name, struct path *path)
747{
748 int err = -ENOMEM;
749 char *tmp = kstrdup(name, GFP_KERNEL);
750
751 if (tmp) {
752 ovl_unescape(tmp);
753 err = ovl_mount_dir_noesc(tmp, path);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200754
Miklos Szeredibccece12020-03-17 15:04:22 +0100755 if (!err && path->dentry->d_flags & DCACHE_OP_REAL) {
Miklos Szeredi7925dad2020-03-17 15:04:22 +0100756 pr_err("filesystem on '%s' not supported as upperdir\n",
757 tmp);
758 path_put_init(path);
759 err = -EINVAL;
760 }
Miklos Szerediab508822014-12-13 00:59:49 +0100761 kfree(tmp);
762 }
763 return err;
764}
765
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100766static int ovl_check_namelen(struct path *path, struct ovl_fs *ofs,
767 const char *name)
768{
769 struct kstatfs statfs;
770 int err = vfs_statfs(path, &statfs);
771
772 if (err)
lijiazi1bd0a3a2019-12-16 19:12:32 +0800773 pr_err("statfs failed on '%s'\n", name);
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100774 else
775 ofs->namelen = max(ofs->namelen, statfs.f_namelen);
776
777 return err;
778}
779
780static int ovl_lower_dir(const char *name, struct path *path,
Miklos Szeredif4288842020-03-17 15:04:22 +0100781 struct ovl_fs *ofs, int *stack_depth)
Miklos Szerediab508822014-12-13 00:59:49 +0100782{
Amir Goldsteine487d882017-11-07 13:55:04 +0200783 int fh_type;
Miklos Szerediab508822014-12-13 00:59:49 +0100784 int err;
Miklos Szerediab508822014-12-13 00:59:49 +0100785
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100786 err = ovl_mount_dir_noesc(name, path);
Miklos Szerediab508822014-12-13 00:59:49 +0100787 if (err)
788 goto out;
789
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100790 err = ovl_check_namelen(path, ofs, name);
791 if (err)
Miklos Szerediab508822014-12-13 00:59:49 +0100792 goto out_put;
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100793
Miklos Szerediab508822014-12-13 00:59:49 +0100794 *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
795
Amir Goldstein02bcd152017-06-21 15:28:36 +0300796 /*
Amir Goldsteinf168f102018-01-19 11:26:53 +0200797 * The inodes index feature and NFS export need to encode and decode
798 * file handles, so they require that all layers support them.
Amir Goldstein02bcd152017-06-21 15:28:36 +0300799 */
Amir Goldsteine487d882017-11-07 13:55:04 +0200800 fh_type = ovl_can_decode_fh(path->dentry->d_sb);
Amir Goldsteinf168f102018-01-19 11:26:53 +0200801 if ((ofs->config.nfs_export ||
Amir Goldsteine487d882017-11-07 13:55:04 +0200802 (ofs->config.index && ofs->config.upperdir)) && !fh_type) {
Amir Goldstein02bcd152017-06-21 15:28:36 +0300803 ofs->config.index = false;
Amir Goldsteinf168f102018-01-19 11:26:53 +0200804 ofs->config.nfs_export = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +0800805 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 +0200806 name);
Amir Goldstein02bcd152017-06-21 15:28:36 +0300807 }
808
Amir Goldsteine487d882017-11-07 13:55:04 +0200809 /* Check if lower fs has 32bit inode numbers */
810 if (fh_type != FILEID_INO32_GEN)
Amir Goldstein0f831ec2019-11-16 18:14:41 +0200811 ofs->xino_mode = -1;
Amir Goldsteine487d882017-11-07 13:55:04 +0200812
Miklos Szerediab508822014-12-13 00:59:49 +0100813 return 0;
814
815out_put:
Miklos Szeredi8aafcb52017-11-09 10:23:28 +0100816 path_put_init(path);
Miklos Szerediab508822014-12-13 00:59:49 +0100817out:
818 return err;
819}
820
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200821/* Workdir should not be subdir of upperdir and vice versa */
822static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
823{
824 bool ok = false;
825
826 if (workdir != upperdir) {
827 ok = (lock_rename(workdir, upperdir) == NULL);
828 unlock_rename(workdir, upperdir);
829 }
830 return ok;
831}
832
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100833static unsigned int ovl_split_lowerdirs(char *str)
834{
835 unsigned int ctr = 1;
836 char *s, *d;
837
838 for (s = d = str;; s++, d++) {
839 if (*s == '\\') {
840 s++;
841 } else if (*s == ':') {
842 *d = '\0';
843 ctr++;
844 continue;
845 }
846 *d = *s;
847 if (!*s)
848 break;
849 }
850 return ctr;
851}
852
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200853static int __maybe_unused
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200854ovl_posix_acl_xattr_get(const struct xattr_handler *handler,
855 struct dentry *dentry, struct inode *inode,
856 const char *name, void *buffer, size_t size)
857{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200858 return ovl_xattr_get(dentry, inode, handler->name, buffer, size);
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200859}
860
861static int __maybe_unused
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200862ovl_posix_acl_xattr_set(const struct xattr_handler *handler,
863 struct dentry *dentry, struct inode *inode,
864 const char *name, const void *value,
865 size_t size, int flags)
Miklos Szeredid837a492016-07-29 12:05:24 +0200866{
867 struct dentry *workdir = ovl_workdir(dentry);
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200868 struct inode *realinode = ovl_inode_real(inode);
Miklos Szeredid837a492016-07-29 12:05:24 +0200869 struct posix_acl *acl = NULL;
870 int err;
871
872 /* Check that everything is OK before copy-up */
873 if (value) {
874 acl = posix_acl_from_xattr(&init_user_ns, value, size);
875 if (IS_ERR(acl))
876 return PTR_ERR(acl);
877 }
878 err = -EOPNOTSUPP;
879 if (!IS_POSIXACL(d_inode(workdir)))
880 goto out_acl_release;
881 if (!realinode->i_op->set_acl)
882 goto out_acl_release;
883 if (handler->flags == ACL_TYPE_DEFAULT && !S_ISDIR(inode->i_mode)) {
884 err = acl ? -EACCES : 0;
885 goto out_acl_release;
886 }
887 err = -EPERM;
888 if (!inode_owner_or_capable(inode))
889 goto out_acl_release;
890
891 posix_acl_release(acl);
892
Miklos Szeredifd3220d2016-10-31 14:42:14 +0100893 /*
894 * Check if sgid bit needs to be cleared (actual setacl operation will
895 * be done with mounter's capabilities and so that won't do it for us).
896 */
897 if (unlikely(inode->i_mode & S_ISGID) &&
898 handler->flags == ACL_TYPE_ACCESS &&
899 !in_group_p(inode->i_gid) &&
900 !capable_wrt_inode_uidgid(inode, CAP_FSETID)) {
901 struct iattr iattr = { .ia_valid = ATTR_KILL_SGID };
902
903 err = ovl_setattr(dentry, &iattr);
904 if (err)
905 return err;
906 }
907
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200908 err = ovl_xattr_set(dentry, inode, handler->name, value, size, flags);
Miklos Szeredice315132016-09-01 11:12:00 +0200909 if (!err)
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200910 ovl_copyattr(ovl_inode_real(inode), inode);
Miklos Szeredice315132016-09-01 11:12:00 +0200911
912 return err;
Miklos Szeredid837a492016-07-29 12:05:24 +0200913
914out_acl_release:
915 posix_acl_release(acl);
916 return err;
917}
918
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200919static int ovl_own_xattr_get(const struct xattr_handler *handler,
920 struct dentry *dentry, struct inode *inode,
921 const char *name, void *buffer, size_t size)
922{
Amir Goldstein48fab5d2016-11-16 11:22:39 +0200923 return -EOPNOTSUPP;
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200924}
925
Miklos Szeredid837a492016-07-29 12:05:24 +0200926static int ovl_own_xattr_set(const struct xattr_handler *handler,
927 struct dentry *dentry, struct inode *inode,
928 const char *name, const void *value,
929 size_t size, int flags)
930{
Amir Goldstein48fab5d2016-11-16 11:22:39 +0200931 return -EOPNOTSUPP;
Miklos Szeredid837a492016-07-29 12:05:24 +0200932}
933
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200934static int ovl_other_xattr_get(const struct xattr_handler *handler,
935 struct dentry *dentry, struct inode *inode,
936 const char *name, void *buffer, size_t size)
937{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200938 return ovl_xattr_get(dentry, inode, name, buffer, size);
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200939}
940
Andreas Gruenbacher0e585cc2016-08-22 17:22:11 +0200941static int ovl_other_xattr_set(const struct xattr_handler *handler,
942 struct dentry *dentry, struct inode *inode,
943 const char *name, const void *value,
944 size_t size, int flags)
945{
Miklos Szeredi1d88f182017-07-20 11:08:21 +0200946 return ovl_xattr_set(dentry, inode, name, value, size, flags);
Andreas Gruenbacher0e585cc2016-08-22 17:22:11 +0200947}
948
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200949static const struct xattr_handler __maybe_unused
950ovl_posix_acl_access_xattr_handler = {
Miklos Szeredid837a492016-07-29 12:05:24 +0200951 .name = XATTR_NAME_POSIX_ACL_ACCESS,
952 .flags = ACL_TYPE_ACCESS,
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200953 .get = ovl_posix_acl_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200954 .set = ovl_posix_acl_xattr_set,
955};
956
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200957static const struct xattr_handler __maybe_unused
958ovl_posix_acl_default_xattr_handler = {
Miklos Szeredid837a492016-07-29 12:05:24 +0200959 .name = XATTR_NAME_POSIX_ACL_DEFAULT,
960 .flags = ACL_TYPE_DEFAULT,
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200961 .get = ovl_posix_acl_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200962 .set = ovl_posix_acl_xattr_set,
963};
964
965static const struct xattr_handler ovl_own_xattr_handler = {
966 .prefix = OVL_XATTR_PREFIX,
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200967 .get = ovl_own_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200968 .set = ovl_own_xattr_set,
969};
970
971static const struct xattr_handler ovl_other_xattr_handler = {
972 .prefix = "", /* catch all */
Andreas Gruenbacher0eb45fc2016-08-22 17:52:55 +0200973 .get = ovl_other_xattr_get,
Miklos Szeredid837a492016-07-29 12:05:24 +0200974 .set = ovl_other_xattr_set,
975};
976
977static const struct xattr_handler *ovl_xattr_handlers[] = {
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200978#ifdef CONFIG_FS_POSIX_ACL
Miklos Szeredid837a492016-07-29 12:05:24 +0200979 &ovl_posix_acl_access_xattr_handler,
980 &ovl_posix_acl_default_xattr_handler,
Andreas Gruenbacher0c97be22016-08-22 16:36:49 +0200981#endif
Miklos Szeredid837a492016-07-29 12:05:24 +0200982 &ovl_own_xattr_handler,
983 &ovl_other_xattr_handler,
984 NULL
985};
986
Amir Goldstein146d62e2019-04-18 17:42:08 +0300987static int ovl_setup_trap(struct super_block *sb, struct dentry *dir,
988 struct inode **ptrap, const char *name)
989{
990 struct inode *trap;
991 int err;
992
993 trap = ovl_get_trap_inode(sb, dir);
Arnd Bergmann1dac6f5b2019-06-17 14:39:29 +0200994 err = PTR_ERR_OR_ZERO(trap);
995 if (err) {
Amir Goldstein146d62e2019-04-18 17:42:08 +0300996 if (err == -ELOOP)
lijiazi1bd0a3a2019-12-16 19:12:32 +0800997 pr_err("conflicting %s path\n", name);
Amir Goldstein146d62e2019-04-18 17:42:08 +0300998 return err;
999 }
1000
1001 *ptrap = trap;
1002 return 0;
1003}
1004
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001005/*
1006 * Determine how we treat concurrent use of upperdir/workdir based on the
1007 * index feature. This is papering over mount leaks of container runtimes,
1008 * for example, an old overlay mount is leaked and now its upperdir is
1009 * attempted to be used as a lower layer in a new overlay mount.
1010 */
1011static int ovl_report_in_use(struct ovl_fs *ofs, const char *name)
1012{
1013 if (ofs->config.index) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001014 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 +03001015 name);
1016 return -EBUSY;
1017 } else {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001018 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 +03001019 name);
1020 return 0;
1021 }
1022}
1023
Amir Goldstein146d62e2019-04-18 17:42:08 +03001024static int ovl_get_upper(struct super_block *sb, struct ovl_fs *ofs,
1025 struct path *upperpath)
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001026{
Miklos Szeredi50649752017-11-10 09:39:15 +01001027 struct vfsmount *upper_mnt;
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001028 int err;
1029
Miklos Szerediad204482017-11-10 09:39:16 +01001030 err = ovl_mount_dir(ofs->config.upperdir, upperpath);
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001031 if (err)
1032 goto out;
1033
1034 /* Upper fs should not be r/o */
1035 if (sb_rdonly(upperpath->mnt->mnt_sb)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001036 pr_err("upper fs is r/o, try multi-lower layers mount\n");
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001037 err = -EINVAL;
1038 goto out;
1039 }
1040
Miklos Szerediad204482017-11-10 09:39:16 +01001041 err = ovl_check_namelen(upperpath, ofs, ofs->config.upperdir);
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001042 if (err)
1043 goto out;
1044
Amir Goldstein146d62e2019-04-18 17:42:08 +03001045 err = ovl_setup_trap(sb, upperpath->dentry, &ofs->upperdir_trap,
1046 "upperdir");
1047 if (err)
1048 goto out;
1049
Miklos Szeredi50649752017-11-10 09:39:15 +01001050 upper_mnt = clone_private_mount(upperpath);
1051 err = PTR_ERR(upper_mnt);
1052 if (IS_ERR(upper_mnt)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001053 pr_err("failed to clone upperpath\n");
Miklos Szeredi50649752017-11-10 09:39:15 +01001054 goto out;
1055 }
1056
1057 /* Don't inherit atime flags */
1058 upper_mnt->mnt_flags &= ~(MNT_NOATIME | MNT_NODIRATIME | MNT_RELATIME);
Miklos Szerediad204482017-11-10 09:39:16 +01001059 ofs->upper_mnt = upper_mnt;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001060
Miklos Szeredi8c257412018-09-10 11:43:29 +02001061 if (ovl_inuse_trylock(ofs->upper_mnt->mnt_root)) {
1062 ofs->upperdir_locked = true;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001063 } else {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001064 err = ovl_report_in_use(ofs, "upperdir");
1065 if (err)
1066 goto out;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001067 }
1068
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001069 err = 0;
1070out:
1071 return err;
1072}
1073
Amir Goldsteincad218a2020-02-20 09:00:19 +02001074/*
1075 * Returns 1 if RENAME_WHITEOUT is supported, 0 if not supported and
1076 * negative values if error is encountered.
1077 */
1078static int ovl_check_rename_whiteout(struct dentry *workdir)
1079{
1080 struct inode *dir = d_inode(workdir);
1081 struct dentry *temp;
1082 struct dentry *dest;
1083 struct dentry *whiteout;
1084 struct name_snapshot name;
1085 int err;
1086
1087 inode_lock_nested(dir, I_MUTEX_PARENT);
1088
1089 temp = ovl_create_temp(workdir, OVL_CATTR(S_IFREG | 0));
1090 err = PTR_ERR(temp);
1091 if (IS_ERR(temp))
1092 goto out_unlock;
1093
1094 dest = ovl_lookup_temp(workdir);
1095 err = PTR_ERR(dest);
1096 if (IS_ERR(dest)) {
1097 dput(temp);
1098 goto out_unlock;
1099 }
1100
1101 /* Name is inline and stable - using snapshot as a copy helper */
1102 take_dentry_name_snapshot(&name, temp);
1103 err = ovl_do_rename(dir, temp, dir, dest, RENAME_WHITEOUT);
1104 if (err) {
1105 if (err == -EINVAL)
1106 err = 0;
1107 goto cleanup_temp;
1108 }
1109
1110 whiteout = lookup_one_len(name.name.name, workdir, name.name.len);
1111 err = PTR_ERR(whiteout);
1112 if (IS_ERR(whiteout))
1113 goto cleanup_temp;
1114
1115 err = ovl_is_whiteout(whiteout);
1116
1117 /* Best effort cleanup of whiteout and temp file */
1118 if (err)
1119 ovl_cleanup(dir, whiteout);
1120 dput(whiteout);
1121
1122cleanup_temp:
1123 ovl_cleanup(dir, temp);
1124 release_dentry_name_snapshot(&name);
1125 dput(temp);
1126 dput(dest);
1127
1128out_unlock:
1129 inode_unlock(dir);
1130
1131 return err;
1132}
1133
Amir Goldstein146d62e2019-04-18 17:42:08 +03001134static int ovl_make_workdir(struct super_block *sb, struct ovl_fs *ofs,
1135 struct path *workpath)
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001136{
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001137 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001138 struct dentry *temp;
Amir Goldsteind80172c2020-02-20 09:03:08 +02001139 bool rename_whiteout;
1140 bool d_type;
Amir Goldsteine487d882017-11-07 13:55:04 +02001141 int fh_type;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001142 int err;
1143
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001144 err = mnt_want_write(mnt);
1145 if (err)
1146 return err;
1147
Miklos Szerediad204482017-11-10 09:39:16 +01001148 ofs->workdir = ovl_workdir_create(ofs, OVL_WORKDIR_NAME, false);
1149 if (!ofs->workdir)
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001150 goto out;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001151
Amir Goldstein146d62e2019-04-18 17:42:08 +03001152 err = ovl_setup_trap(sb, ofs->workdir, &ofs->workdir_trap, "workdir");
1153 if (err)
1154 goto out;
1155
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001156 /*
1157 * Upper should support d_type, else whiteouts are visible. Given
1158 * workdir and upper are on same fs, we can do iterate_dir() on
1159 * workdir. This check requires successful creation of workdir in
1160 * previous step.
1161 */
1162 err = ovl_check_d_type_supported(workpath);
1163 if (err < 0)
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001164 goto out;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001165
Amir Goldsteind80172c2020-02-20 09:03:08 +02001166 d_type = err;
1167 if (!d_type)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001168 pr_warn("upper fs needs to support d_type.\n");
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001169
1170 /* Check if upper/work fs supports O_TMPFILE */
Miklos Szerediad204482017-11-10 09:39:16 +01001171 temp = ovl_do_tmpfile(ofs->workdir, S_IFREG | 0);
1172 ofs->tmpfile = !IS_ERR(temp);
1173 if (ofs->tmpfile)
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001174 dput(temp);
1175 else
lijiazi1bd0a3a2019-12-16 19:12:32 +08001176 pr_warn("upper fs does not support tmpfile.\n");
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001177
Amir Goldsteincad218a2020-02-20 09:00:19 +02001178
1179 /* Check if upper/work fs supports RENAME_WHITEOUT */
1180 err = ovl_check_rename_whiteout(ofs->workdir);
1181 if (err < 0)
1182 goto out;
1183
Amir Goldsteind80172c2020-02-20 09:03:08 +02001184 rename_whiteout = err;
1185 if (!rename_whiteout)
Amir Goldsteincad218a2020-02-20 09:00:19 +02001186 pr_warn("upper fs does not support RENAME_WHITEOUT.\n");
1187
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001188 /*
1189 * Check if upper/work fs supports trusted.overlay.* xattr
1190 */
Miklos Szerediad204482017-11-10 09:39:16 +01001191 err = ovl_do_setxattr(ofs->workdir, OVL_XATTR_OPAQUE, "0", 1, 0);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001192 if (err) {
Miklos Szerediad204482017-11-10 09:39:16 +01001193 ofs->noxattr = true;
Amir Goldsteina6837372017-09-19 12:14:18 +03001194 ofs->config.index = false;
Vivek Goyald5791042018-05-11 11:49:27 -04001195 ofs->config.metacopy = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001196 pr_warn("upper fs does not support xattr, falling back to index=off and metacopy=off.\n");
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001197 err = 0;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001198 } else {
Miklos Szerediad204482017-11-10 09:39:16 +01001199 vfs_removexattr(ofs->workdir, OVL_XATTR_OPAQUE);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001200 }
1201
Amir Goldsteind80172c2020-02-20 09:03:08 +02001202 /*
1203 * We allowed sub-optimal upper fs configuration and don't want to break
1204 * users over kernel upgrade, but we never allowed remote upper fs, so
1205 * we can enforce strict requirements for remote upper fs.
1206 */
1207 if (ovl_dentry_remote(ofs->workdir) &&
1208 (!d_type || !rename_whiteout || ofs->noxattr)) {
1209 pr_err("upper fs missing required features.\n");
1210 err = -EINVAL;
1211 goto out;
1212 }
1213
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001214 /* Check if upper/work fs supports file handles */
Amir Goldsteine487d882017-11-07 13:55:04 +02001215 fh_type = ovl_can_decode_fh(ofs->workdir->d_sb);
1216 if (ofs->config.index && !fh_type) {
Miklos Szerediad204482017-11-10 09:39:16 +01001217 ofs->config.index = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001218 pr_warn("upper fs does not support file handles, falling back to index=off.\n");
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001219 }
1220
Amir Goldsteine487d882017-11-07 13:55:04 +02001221 /* Check if upper fs has 32bit inode numbers */
1222 if (fh_type != FILEID_INO32_GEN)
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001223 ofs->xino_mode = -1;
Amir Goldsteine487d882017-11-07 13:55:04 +02001224
Amir Goldsteinf168f102018-01-19 11:26:53 +02001225 /* NFS export of r/w mount depends on index */
1226 if (ofs->config.nfs_export && !ofs->config.index) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001227 pr_warn("NFS export requires \"index=on\", falling back to nfs_export=off.\n");
Amir Goldsteinf168f102018-01-19 11:26:53 +02001228 ofs->config.nfs_export = false;
1229 }
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001230out:
1231 mnt_drop_write(mnt);
1232 return err;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001233}
1234
Amir Goldstein146d62e2019-04-18 17:42:08 +03001235static int ovl_get_workdir(struct super_block *sb, struct ovl_fs *ofs,
1236 struct path *upperpath)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001237{
1238 int err;
Miklos Szeredibca44b52017-11-10 09:39:15 +01001239 struct path workpath = { };
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001240
Miklos Szerediad204482017-11-10 09:39:16 +01001241 err = ovl_mount_dir(ofs->config.workdir, &workpath);
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001242 if (err)
1243 goto out;
1244
1245 err = -EINVAL;
Miklos Szeredibca44b52017-11-10 09:39:15 +01001246 if (upperpath->mnt != workpath.mnt) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001247 pr_err("workdir and upperdir must reside under the same mount\n");
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001248 goto out;
1249 }
Miklos Szeredibca44b52017-11-10 09:39:15 +01001250 if (!ovl_workdir_ok(workpath.dentry, upperpath->dentry)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001251 pr_err("workdir and upperdir must be separate subtrees\n");
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001252 goto out;
1253 }
1254
Miklos Szeredi8c257412018-09-10 11:43:29 +02001255 ofs->workbasedir = dget(workpath.dentry);
1256
Miklos Szeredi8c257412018-09-10 11:43:29 +02001257 if (ovl_inuse_trylock(ofs->workbasedir)) {
Miklos Szerediad204482017-11-10 09:39:16 +01001258 ofs->workdir_locked = true;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001259 } else {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001260 err = ovl_report_in_use(ofs, "workdir");
1261 if (err)
1262 goto out;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001263 }
1264
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001265 err = ovl_setup_trap(sb, ofs->workbasedir, &ofs->workbasedir_trap,
1266 "workdir");
1267 if (err)
1268 goto out;
1269
Amir Goldstein146d62e2019-04-18 17:42:08 +03001270 err = ovl_make_workdir(sb, ofs, &workpath);
Miklos Szeredibca44b52017-11-10 09:39:15 +01001271
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001272out:
Miklos Szeredibca44b52017-11-10 09:39:15 +01001273 path_put(&workpath);
1274
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001275 return err;
1276}
1277
Amir Goldstein146d62e2019-04-18 17:42:08 +03001278static int ovl_get_indexdir(struct super_block *sb, struct ovl_fs *ofs,
1279 struct ovl_entry *oe, struct path *upperpath)
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001280{
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001281 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001282 int err;
1283
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001284 err = mnt_want_write(mnt);
1285 if (err)
1286 return err;
1287
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001288 /* Verify lower root is upper root origin */
Amir Goldsteind9768072017-09-24 13:00:19 +03001289 err = ovl_verify_origin(upperpath->dentry, oe->lowerstack[0].dentry,
Amir Goldstein05122442018-01-11 08:25:32 +02001290 true);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001291 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001292 pr_err("failed to verify upper root origin\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001293 goto out;
1294 }
1295
Miklos Szerediad204482017-11-10 09:39:16 +01001296 ofs->indexdir = ovl_workdir_create(ofs, OVL_INDEXDIR_NAME, true);
1297 if (ofs->indexdir) {
Amir Goldstein146d62e2019-04-18 17:42:08 +03001298 err = ovl_setup_trap(sb, ofs->indexdir, &ofs->indexdir_trap,
1299 "indexdir");
1300 if (err)
1301 goto out;
1302
Amir Goldsteinad1d6152018-01-11 10:47:03 +02001303 /*
1304 * Verify upper root is exclusively associated with index dir.
1305 * Older kernels stored upper fh in "trusted.overlay.origin"
1306 * xattr. If that xattr exists, verify that it is a match to
1307 * upper dir file handle. In any case, verify or set xattr
1308 * "trusted.overlay.upper" to indicate that index may have
1309 * directory entries.
1310 */
1311 if (ovl_check_origin_xattr(ofs->indexdir)) {
1312 err = ovl_verify_set_fh(ofs->indexdir, OVL_XATTR_ORIGIN,
1313 upperpath->dentry, true, false);
1314 if (err)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001315 pr_err("failed to verify index dir 'origin' xattr\n");
Amir Goldsteinad1d6152018-01-11 10:47:03 +02001316 }
1317 err = ovl_verify_upper(ofs->indexdir, upperpath->dentry, true);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001318 if (err)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001319 pr_err("failed to verify index dir 'upper' xattr\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001320
1321 /* Cleanup bad/stale/orphan index entries */
1322 if (!err)
Amir Goldstein1eff1a12017-12-12 22:40:46 +02001323 err = ovl_indexdir_cleanup(ofs);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001324 }
Miklos Szerediad204482017-11-10 09:39:16 +01001325 if (err || !ofs->indexdir)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001326 pr_warn("try deleting index dir or mounting with '-o index=off' to disable inodes index.\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001327
1328out:
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001329 mnt_drop_write(mnt);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001330 return err;
1331}
1332
Amir Goldstein9df085f2018-09-03 09:12:09 +03001333static bool ovl_lower_uuid_ok(struct ovl_fs *ofs, const uuid_t *uuid)
Amir Goldstein51486262018-03-28 20:22:41 +03001334{
1335 unsigned int i;
Amir Goldstein9df085f2018-09-03 09:12:09 +03001336
Amir Goldstein7e63c872019-11-14 22:28:41 +02001337 if (!ofs->config.nfs_export && !ofs->upper_mnt)
Amir Goldstein9df085f2018-09-03 09:12:09 +03001338 return true;
1339
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001340 for (i = 0; i < ofs->numfs; i++) {
Amir Goldstein9df085f2018-09-03 09:12:09 +03001341 /*
1342 * We use uuid to associate an overlay lower file handle with a
1343 * lower layer, so we can accept lower fs with null uuid as long
1344 * as all lower layers with null uuid are on the same fs.
Amir Goldstein7e63c872019-11-14 22:28:41 +02001345 * if we detect multiple lower fs with the same uuid, we
1346 * disable lower file handle decoding on all of them.
Amir Goldstein9df085f2018-09-03 09:12:09 +03001347 */
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001348 if (ofs->fs[i].is_lower &&
1349 uuid_equal(&ofs->fs[i].sb->s_uuid, uuid)) {
Amir Goldstein07f1e592020-01-14 21:59:22 +02001350 ofs->fs[i].bad_uuid = true;
Amir Goldstein9df085f2018-09-03 09:12:09 +03001351 return false;
Amir Goldstein7e63c872019-11-14 22:28:41 +02001352 }
Amir Goldstein9df085f2018-09-03 09:12:09 +03001353 }
1354 return true;
1355}
1356
1357/* Get a unique fsid for the layer */
1358static int ovl_get_fsid(struct ovl_fs *ofs, const struct path *path)
1359{
1360 struct super_block *sb = path->mnt->mnt_sb;
1361 unsigned int i;
Amir Goldstein51486262018-03-28 20:22:41 +03001362 dev_t dev;
1363 int err;
Amir Goldstein7e63c872019-11-14 22:28:41 +02001364 bool bad_uuid = false;
Amir Goldstein51486262018-03-28 20:22:41 +03001365
Amir Goldstein07f1e592020-01-14 21:59:22 +02001366 for (i = 0; i < ofs->numfs; i++) {
1367 if (ofs->fs[i].sb == sb)
1368 return i;
Amir Goldstein51486262018-03-28 20:22:41 +03001369 }
1370
Amir Goldstein9df085f2018-09-03 09:12:09 +03001371 if (!ovl_lower_uuid_ok(ofs, &sb->s_uuid)) {
Amir Goldstein7e63c872019-11-14 22:28:41 +02001372 bad_uuid = true;
1373 if (ofs->config.index || ofs->config.nfs_export) {
1374 ofs->config.index = false;
1375 ofs->config.nfs_export = false;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001376 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 +02001377 uuid_is_null(&sb->s_uuid) ? "null" :
1378 "conflicting",
1379 path->dentry);
1380 }
Amir Goldstein9df085f2018-09-03 09:12:09 +03001381 }
1382
Amir Goldstein51486262018-03-28 20:22:41 +03001383 err = get_anon_bdev(&dev);
1384 if (err) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001385 pr_err("failed to get anonymous bdev for lowerpath\n");
Amir Goldstein51486262018-03-28 20:22:41 +03001386 return err;
1387 }
1388
Amir Goldstein07f1e592020-01-14 21:59:22 +02001389 ofs->fs[ofs->numfs].sb = sb;
1390 ofs->fs[ofs->numfs].pseudo_dev = dev;
1391 ofs->fs[ofs->numfs].bad_uuid = bad_uuid;
Amir Goldstein51486262018-03-28 20:22:41 +03001392
Amir Goldstein07f1e592020-01-14 21:59:22 +02001393 return ofs->numfs++;
Amir Goldstein51486262018-03-28 20:22:41 +03001394}
1395
Amir Goldstein94375f92019-11-15 14:12:40 +02001396static int ovl_get_layers(struct super_block *sb, struct ovl_fs *ofs,
1397 struct path *stack, unsigned int numlower)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001398{
1399 int err;
1400 unsigned int i;
Miklos Szeredi13464162020-01-24 09:46:45 +01001401 struct ovl_layer *layers;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001402
1403 err = -ENOMEM;
Miklos Szeredi13464162020-01-24 09:46:45 +01001404 layers = kcalloc(numlower + 1, sizeof(struct ovl_layer), GFP_KERNEL);
1405 if (!layers)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001406 goto out;
Miklos Szeredi13464162020-01-24 09:46:45 +01001407 ofs->layers = layers;
Amir Goldstein51486262018-03-28 20:22:41 +03001408
Amir Goldstein07f1e592020-01-14 21:59:22 +02001409 ofs->fs = kcalloc(numlower + 1, sizeof(struct ovl_sb), GFP_KERNEL);
1410 if (ofs->fs == NULL)
Amir Goldstein51486262018-03-28 20:22:41 +03001411 goto out;
1412
Amir Goldstein07f1e592020-01-14 21:59:22 +02001413 /* idx/fsid 0 are reserved for upper fs even with lower only overlay */
1414 ofs->numfs++;
1415
Miklos Szeredi13464162020-01-24 09:46:45 +01001416 layers[0].mnt = ofs->upper_mnt;
1417 layers[0].idx = 0;
1418 layers[0].fsid = 0;
Amir Goldstein94375f92019-11-15 14:12:40 +02001419 ofs->numlayer = 1;
1420
Amir Goldstein07f1e592020-01-14 21:59:22 +02001421 /*
Amir Goldsteinb7bf9902020-01-14 22:17:25 +02001422 * All lower layers that share the same fs as upper layer, use the same
1423 * pseudo_dev as upper layer. Allocate fs[0].pseudo_dev even for lower
1424 * only overlay to simplify ovl_fs_free().
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001425 * is_lower will be set if upper fs is shared with a lower layer.
Amir Goldstein07f1e592020-01-14 21:59:22 +02001426 */
Amir Goldsteinb7bf9902020-01-14 22:17:25 +02001427 err = get_anon_bdev(&ofs->fs[0].pseudo_dev);
1428 if (err) {
1429 pr_err("failed to get anonymous bdev for upper fs\n");
1430 goto out;
1431 }
1432
Amir Goldstein07f1e592020-01-14 21:59:22 +02001433 if (ofs->upper_mnt) {
1434 ofs->fs[0].sb = ofs->upper_mnt->mnt_sb;
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001435 ofs->fs[0].is_lower = false;
Amir Goldstein07f1e592020-01-14 21:59:22 +02001436 }
1437
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001438 for (i = 0; i < numlower; i++) {
1439 struct vfsmount *mnt;
Amir Goldstein146d62e2019-04-18 17:42:08 +03001440 struct inode *trap;
Amir Goldstein51486262018-03-28 20:22:41 +03001441 int fsid;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001442
Amir Goldstein9df085f2018-09-03 09:12:09 +03001443 err = fsid = ovl_get_fsid(ofs, &stack[i]);
Amir Goldstein51486262018-03-28 20:22:41 +03001444 if (err < 0)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001445 goto out;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001446
Amir Goldstein146d62e2019-04-18 17:42:08 +03001447 err = ovl_setup_trap(sb, stack[i].dentry, &trap, "lowerdir");
1448 if (err)
1449 goto out;
1450
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001451 if (ovl_is_inuse(stack[i].dentry)) {
1452 err = ovl_report_in_use(ofs, "lowerdir");
1453 if (err)
1454 goto out;
1455 }
1456
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001457 mnt = clone_private_mount(&stack[i]);
1458 err = PTR_ERR(mnt);
1459 if (IS_ERR(mnt)) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001460 pr_err("failed to clone lowerpath\n");
Amir Goldstein146d62e2019-04-18 17:42:08 +03001461 iput(trap);
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001462 goto out;
1463 }
Amir Goldstein51486262018-03-28 20:22:41 +03001464
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001465 /*
1466 * Make lower layers R/O. That way fchmod/fchown on lower file
1467 * will fail instead of modifying lower fs.
1468 */
1469 mnt->mnt_flags |= MNT_READONLY | MNT_NOATIME;
1470
Miklos Szeredi13464162020-01-24 09:46:45 +01001471 layers[ofs->numlayer].trap = trap;
1472 layers[ofs->numlayer].mnt = mnt;
1473 layers[ofs->numlayer].idx = ofs->numlayer;
1474 layers[ofs->numlayer].fsid = fsid;
1475 layers[ofs->numlayer].fs = &ofs->fs[fsid];
Amir Goldstein94375f92019-11-15 14:12:40 +02001476 ofs->numlayer++;
Amir Goldstein1b81ddd2019-11-16 18:52:20 +02001477 ofs->fs[fsid].is_lower = true;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001478 }
Amir Goldsteine487d882017-11-07 13:55:04 +02001479
Amir Goldstein795939a2018-03-29 09:08:18 +03001480 /*
1481 * When all layers on same fs, overlay can use real inode numbers.
1482 * With mount option "xino=on", mounter declares that there are enough
1483 * free high bits in underlying fs to hold the unique fsid.
1484 * If overlayfs does encounter underlying inodes using the high xino
1485 * bits reserved for fsid, it emits a warning and uses the original
1486 * inode number.
1487 */
Amir Goldstein07f1e592020-01-14 21:59:22 +02001488 if (ofs->numfs - !ofs->upper_mnt == 1) {
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001489 if (ofs->config.xino == OVL_XINO_ON)
1490 pr_info("\"xino=on\" is useless with all layers on same fs, ignore.\n");
1491 ofs->xino_mode = 0;
Amir Goldstein53afcd32020-02-21 16:34:42 +02001492 } else if (ofs->config.xino == OVL_XINO_OFF) {
1493 ofs->xino_mode = -1;
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001494 } else if (ofs->config.xino == OVL_XINO_ON && ofs->xino_mode < 0) {
Amir Goldstein795939a2018-03-29 09:08:18 +03001495 /*
Amir Goldstein07f1e592020-01-14 21:59:22 +02001496 * This is a roundup of number of bits needed for encoding
1497 * fsid, where fsid 0 is reserved for upper fs even with
1498 * lower only overlay.
Amir Goldstein795939a2018-03-29 09:08:18 +03001499 */
1500 BUILD_BUG_ON(ilog2(OVL_MAX_STACK) > 31);
Amir Goldstein07f1e592020-01-14 21:59:22 +02001501 ofs->xino_mode = ilog2(ofs->numfs - 1) + 1;
Amir Goldstein795939a2018-03-29 09:08:18 +03001502 }
1503
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001504 if (ofs->xino_mode > 0) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001505 pr_info("\"xino\" feature enabled using %d upper inode bits.\n",
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001506 ofs->xino_mode);
Amir Goldstein795939a2018-03-29 09:08:18 +03001507 }
Amir Goldsteine487d882017-11-07 13:55:04 +02001508
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001509 err = 0;
1510out:
1511 return err;
1512}
1513
Miklos Szeredi4155c102017-11-10 09:39:15 +01001514static struct ovl_entry *ovl_get_lowerstack(struct super_block *sb,
Miklos Szerediad204482017-11-10 09:39:16 +01001515 struct ovl_fs *ofs)
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001516{
1517 int err;
1518 char *lowertmp, *lower;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001519 struct path *stack = NULL;
1520 unsigned int stacklen, numlower = 0, i;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001521 struct ovl_entry *oe;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001522
1523 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001524 lowertmp = kstrdup(ofs->config.lowerdir, GFP_KERNEL);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001525 if (!lowertmp)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001526 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001527
1528 err = -EINVAL;
1529 stacklen = ovl_split_lowerdirs(lowertmp);
1530 if (stacklen > OVL_MAX_STACK) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001531 pr_err("too many lower directories, limit is %d\n",
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001532 OVL_MAX_STACK);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001533 goto out_err;
Miklos Szerediad204482017-11-10 09:39:16 +01001534 } else if (!ofs->config.upperdir && stacklen == 1) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001535 pr_err("at least 2 lowerdir are needed while upperdir nonexistent\n");
Miklos Szeredi4155c102017-11-10 09:39:15 +01001536 goto out_err;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001537 } else if (!ofs->config.upperdir && ofs->config.nfs_export &&
1538 ofs->config.redirect_follow) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001539 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 +02001540 ofs->config.nfs_export = false;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001541 }
1542
1543 err = -ENOMEM;
1544 stack = kcalloc(stacklen, sizeof(struct path), GFP_KERNEL);
1545 if (!stack)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001546 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001547
1548 err = -EINVAL;
1549 lower = lowertmp;
1550 for (numlower = 0; numlower < stacklen; numlower++) {
Miklos Szerediad204482017-11-10 09:39:16 +01001551 err = ovl_lower_dir(lower, &stack[numlower], ofs,
Miklos Szeredif4288842020-03-17 15:04:22 +01001552 &sb->s_stack_depth);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001553 if (err)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001554 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001555
1556 lower = strchr(lower, '\0') + 1;
1557 }
1558
1559 err = -EINVAL;
1560 sb->s_stack_depth++;
1561 if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001562 pr_err("maximum fs stacking depth exceeded\n");
Miklos Szeredi4155c102017-11-10 09:39:15 +01001563 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001564 }
1565
Amir Goldstein94375f92019-11-15 14:12:40 +02001566 err = ovl_get_layers(sb, ofs, stack, numlower);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001567 if (err)
1568 goto out_err;
1569
1570 err = -ENOMEM;
1571 oe = ovl_alloc_entry(numlower);
1572 if (!oe)
1573 goto out_err;
1574
1575 for (i = 0; i < numlower; i++) {
1576 oe->lowerstack[i].dentry = dget(stack[i].dentry);
Amir Goldstein94375f92019-11-15 14:12:40 +02001577 oe->lowerstack[i].layer = &ofs->layers[i+1];
Miklos Szeredi4155c102017-11-10 09:39:15 +01001578 }
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001579
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001580out:
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001581 for (i = 0; i < numlower; i++)
1582 path_put(&stack[i]);
1583 kfree(stack);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001584 kfree(lowertmp);
1585
1586 return oe;
1587
1588out_err:
1589 oe = ERR_PTR(err);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001590 goto out;
1591}
1592
Amir Goldstein146d62e2019-04-18 17:42:08 +03001593/*
1594 * Check if this layer root is a descendant of:
1595 * - another layer of this overlayfs instance
1596 * - upper/work dir of any overlayfs instance
Amir Goldstein146d62e2019-04-18 17:42:08 +03001597 */
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001598static int ovl_check_layer(struct super_block *sb, struct ovl_fs *ofs,
1599 struct dentry *dentry, const char *name)
Amir Goldstein146d62e2019-04-18 17:42:08 +03001600{
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001601 struct dentry *next = dentry, *parent;
Amir Goldstein146d62e2019-04-18 17:42:08 +03001602 int err = 0;
1603
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001604 if (!dentry)
Amir Goldstein146d62e2019-04-18 17:42:08 +03001605 return 0;
1606
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001607 parent = dget_parent(next);
1608
1609 /* Walk back ancestors to root (inclusive) looking for traps */
1610 while (!err && parent != next) {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001611 if (ovl_lookup_trap_inode(sb, parent)) {
Amir Goldstein146d62e2019-04-18 17:42:08 +03001612 err = -ELOOP;
lijiazi1bd0a3a2019-12-16 19:12:32 +08001613 pr_err("overlapping %s path\n", name);
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001614 } else if (ovl_is_inuse(parent)) {
1615 err = ovl_report_in_use(ofs, name);
Amir Goldstein146d62e2019-04-18 17:42:08 +03001616 }
Amir Goldstein146d62e2019-04-18 17:42:08 +03001617 next = parent;
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001618 parent = dget_parent(next);
1619 dput(next);
Amir Goldstein146d62e2019-04-18 17:42:08 +03001620 }
1621
Miklos Szeredi9179c21d2019-06-18 15:06:16 +02001622 dput(parent);
Amir Goldstein146d62e2019-04-18 17:42:08 +03001623
1624 return err;
1625}
1626
1627/*
1628 * Check if any of the layers or work dirs overlap.
1629 */
1630static int ovl_check_overlapping_layers(struct super_block *sb,
1631 struct ovl_fs *ofs)
1632{
1633 int i, err;
1634
1635 if (ofs->upper_mnt) {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001636 err = ovl_check_layer(sb, ofs, ofs->upper_mnt->mnt_root,
1637 "upperdir");
Amir Goldstein146d62e2019-04-18 17:42:08 +03001638 if (err)
1639 return err;
1640
1641 /*
1642 * Checking workbasedir avoids hitting ovl_is_inuse(parent) of
1643 * this instance and covers overlapping work and index dirs,
1644 * unless work or index dir have been moved since created inside
1645 * workbasedir. In that case, we already have their traps in
1646 * inode cache and we will catch that case on lookup.
1647 */
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001648 err = ovl_check_layer(sb, ofs, ofs->workbasedir, "workdir");
Amir Goldstein146d62e2019-04-18 17:42:08 +03001649 if (err)
1650 return err;
1651 }
1652
Amir Goldstein94375f92019-11-15 14:12:40 +02001653 for (i = 1; i < ofs->numlayer; i++) {
Amir Goldstein0be0bfd2019-07-12 15:24:34 +03001654 err = ovl_check_layer(sb, ofs,
Amir Goldstein94375f92019-11-15 14:12:40 +02001655 ofs->layers[i].mnt->mnt_root,
Amir Goldstein146d62e2019-04-18 17:42:08 +03001656 "lowerdir");
1657 if (err)
1658 return err;
1659 }
1660
1661 return 0;
1662}
1663
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001664static struct dentry *ovl_get_root(struct super_block *sb,
1665 struct dentry *upperdentry,
1666 struct ovl_entry *oe)
1667{
1668 struct dentry *root;
Amir Goldstein62c832e2019-11-19 15:31:46 +02001669 struct ovl_path *lowerpath = &oe->lowerstack[0];
1670 unsigned long ino = d_inode(lowerpath->dentry)->i_ino;
1671 int fsid = lowerpath->layer->fsid;
1672 struct ovl_inode_params oip = {
1673 .upperdentry = upperdentry,
1674 .lowerpath = lowerpath,
1675 };
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001676
1677 root = d_make_root(ovl_new_inode(sb, S_IFDIR, 0));
1678 if (!root)
1679 return NULL;
1680
1681 root->d_fsdata = oe;
1682
1683 if (upperdentry) {
Amir Goldstein62c832e2019-11-19 15:31:46 +02001684 /* Root inode uses upper st_ino/i_ino */
1685 ino = d_inode(upperdentry)->i_ino;
1686 fsid = 0;
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001687 ovl_dentry_set_upper_alias(root);
1688 if (ovl_is_impuredir(upperdentry))
1689 ovl_set_flag(OVL_IMPURE, d_inode(root));
1690 }
1691
1692 /* Root is always merge -> can have whiteouts */
1693 ovl_set_flag(OVL_WHITEOUTS, d_inode(root));
1694 ovl_dentry_set_flag(OVL_E_CONNECTED, root);
1695 ovl_set_upperdata(d_inode(root));
Amir Goldstein62c832e2019-11-19 15:31:46 +02001696 ovl_inode_init(d_inode(root), &oip, ino, fsid);
Miklos Szeredif4288842020-03-17 15:04:22 +01001697 ovl_dentry_update_reval(root, upperdentry, DCACHE_OP_WEAK_REVALIDATE);
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001698
1699 return root;
1700}
1701
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001702static int ovl_fill_super(struct super_block *sb, void *data, int silent)
1703{
Kees Cook33006cd2017-03-29 14:02:19 -07001704 struct path upperpath = { };
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001705 struct dentry *root_dentry;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001706 struct ovl_entry *oe;
Miklos Szerediad204482017-11-10 09:39:16 +01001707 struct ovl_fs *ofs;
Konstantin Khlebnikov51f8f3c2017-01-10 21:30:21 +03001708 struct cred *cred;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001709 int err;
1710
Miklos Szeredif4288842020-03-17 15:04:22 +01001711 sb->s_d_op = &ovl_dentry_operations;
1712
Erez Zadokf45827e82014-10-24 00:14:38 +02001713 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001714 ofs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
1715 if (!ofs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001716 goto out;
1717
Miklos Szerediad204482017-11-10 09:39:16 +01001718 ofs->creator_cred = cred = prepare_creds();
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001719 if (!cred)
1720 goto out_err;
1721
Miklos Szerediad204482017-11-10 09:39:16 +01001722 ofs->config.index = ovl_index_def;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001723 ofs->config.nfs_export = ovl_nfs_export_def;
Amir Goldstein795939a2018-03-29 09:08:18 +03001724 ofs->config.xino = ovl_xino_def();
Vivek Goyald5791042018-05-11 11:49:27 -04001725 ofs->config.metacopy = ovl_metacopy_def;
Miklos Szerediad204482017-11-10 09:39:16 +01001726 err = ovl_parse_opt((char *) data, &ofs->config);
Erez Zadokf45827e82014-10-24 00:14:38 +02001727 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001728 goto out_err;
Erez Zadokf45827e82014-10-24 00:14:38 +02001729
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001730 err = -EINVAL;
Miklos Szerediad204482017-11-10 09:39:16 +01001731 if (!ofs->config.lowerdir) {
Konstantin Khlebnikov07f2af72015-06-29 20:18:56 +03001732 if (!silent)
lijiazi1bd0a3a2019-12-16 19:12:32 +08001733 pr_err("missing 'lowerdir'\n");
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001734 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001735 }
1736
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001737 sb->s_stack_depth = 0;
Miklos Szeredicf9a6782015-12-11 16:30:49 +01001738 sb->s_maxbytes = MAX_LFS_FILESIZE;
Amir Goldsteine487d882017-11-07 13:55:04 +02001739 /* Assume underlaying fs uses 32bit inodes unless proven otherwise */
Amir Goldstein53afcd32020-02-21 16:34:42 +02001740 if (ofs->config.xino != OVL_XINO_OFF) {
Amir Goldstein0f831ec2019-11-16 18:14:41 +02001741 ofs->xino_mode = BITS_PER_LONG - 32;
Amir Goldstein53afcd32020-02-21 16:34:42 +02001742 if (!ofs->xino_mode) {
1743 pr_warn("xino not supported on 32bit kernel, falling back to xino=off.\n");
1744 ofs->config.xino = OVL_XINO_OFF;
1745 }
1746 }
Amir Goldstein795939a2018-03-29 09:08:18 +03001747
Amir Goldstein146d62e2019-04-18 17:42:08 +03001748 /* alloc/destroy_inode needed for setting up traps in inode cache */
1749 sb->s_op = &ovl_super_operations;
1750
Miklos Szerediad204482017-11-10 09:39:16 +01001751 if (ofs->config.upperdir) {
1752 if (!ofs->config.workdir) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001753 pr_err("missing 'workdir'\n");
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001754 goto out_err;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001755 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001756
Amir Goldstein146d62e2019-04-18 17:42:08 +03001757 err = ovl_get_upper(sb, ofs, &upperpath);
Miklos Szeredi21a3b312017-11-09 10:23:28 +01001758 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001759 goto out_err;
Miklos Szeredid719e8f2016-07-29 12:05:23 +02001760
Amir Goldstein146d62e2019-04-18 17:42:08 +03001761 err = ovl_get_workdir(sb, ofs, &upperpath);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001762 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001763 goto out_err;
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001764
Miklos Szerediad204482017-11-10 09:39:16 +01001765 if (!ofs->workdir)
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001766 sb->s_flags |= SB_RDONLY;
Miklos Szeredi6e882562017-11-10 09:39:15 +01001767
Miklos Szerediad204482017-11-10 09:39:16 +01001768 sb->s_stack_depth = ofs->upper_mnt->mnt_sb->s_stack_depth;
1769 sb->s_time_gran = ofs->upper_mnt->mnt_sb->s_time_gran;
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001770
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001771 }
Miklos Szerediad204482017-11-10 09:39:16 +01001772 oe = ovl_get_lowerstack(sb, ofs);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001773 err = PTR_ERR(oe);
1774 if (IS_ERR(oe))
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001775 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001776
hujianyang71cbad72015-01-15 13:20:57 +08001777 /* If the upper fs is nonexistent, we mark overlayfs r/o too */
Miklos Szerediad204482017-11-10 09:39:16 +01001778 if (!ofs->upper_mnt)
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001779 sb->s_flags |= SB_RDONLY;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001780
Miklos Szerediad204482017-11-10 09:39:16 +01001781 if (!(ovl_force_readonly(ofs)) && ofs->config.index) {
Amir Goldstein146d62e2019-04-18 17:42:08 +03001782 err = ovl_get_indexdir(sb, ofs, oe, &upperpath);
Amir Goldstein54fb3472017-06-21 15:28:38 +03001783 if (err)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001784 goto out_free_oe;
Miklos Szeredi6e882562017-11-10 09:39:15 +01001785
Amir Goldstein972d0092017-09-19 12:14:18 +03001786 /* Force r/o mount with no index dir */
1787 if (!ofs->indexdir) {
1788 dput(ofs->workdir);
1789 ofs->workdir = NULL;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001790 sb->s_flags |= SB_RDONLY;
Amir Goldstein972d0092017-09-19 12:14:18 +03001791 }
1792
Amir Goldstein02bcd152017-06-21 15:28:36 +03001793 }
1794
Amir Goldstein146d62e2019-04-18 17:42:08 +03001795 err = ovl_check_overlapping_layers(sb, ofs);
1796 if (err)
1797 goto out_free_oe;
1798
Amir Goldstein972d0092017-09-19 12:14:18 +03001799 /* Show index=off in /proc/mounts for forced r/o mount */
Amir Goldsteinf168f102018-01-19 11:26:53 +02001800 if (!ofs->indexdir) {
Miklos Szerediad204482017-11-10 09:39:16 +01001801 ofs->config.index = false;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001802 if (ofs->upper_mnt && ofs->config.nfs_export) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001803 pr_warn("NFS export requires an index dir, falling back to nfs_export=off.\n");
Amir Goldsteinf168f102018-01-19 11:26:53 +02001804 ofs->config.nfs_export = false;
1805 }
1806 }
Amir Goldstein02bcd152017-06-21 15:28:36 +03001807
Vivek Goyald5791042018-05-11 11:49:27 -04001808 if (ofs->config.metacopy && ofs->config.nfs_export) {
lijiazi1bd0a3a2019-12-16 19:12:32 +08001809 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 -04001810 ofs->config.nfs_export = false;
1811 }
1812
Amir Goldstein8383f172017-10-02 11:31:42 +03001813 if (ofs->config.nfs_export)
1814 sb->s_export_op = &ovl_export_operations;
1815
Konstantin Khlebnikov51f8f3c2017-01-10 21:30:21 +03001816 /* Never override disk quota limits or use reserved space */
1817 cap_lower(cred->cap_effective, CAP_SYS_RESOURCE);
1818
Vivek Goyal655042c2016-10-14 03:03:36 +02001819 sb->s_magic = OVERLAYFS_SUPER_MAGIC;
Vivek Goyal655042c2016-10-14 03:03:36 +02001820 sb->s_xattr = ovl_xattr_handlers;
Miklos Szerediad204482017-11-10 09:39:16 +01001821 sb->s_fs_info = ofs;
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001822 sb->s_flags |= SB_POSIXACL;
Vivek Goyal655042c2016-10-14 03:03:36 +02001823
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001824 err = -ENOMEM;
Amir Goldstein2effc5c2019-11-19 17:49:17 +02001825 root_dentry = ovl_get_root(sb, upperpath.dentry, oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001826 if (!root_dentry)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001827 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001828
1829 mntput(upperpath.mnt);
Miklos Szeredied06e062015-12-09 16:11:59 +01001830
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001831 sb->s_root = root_dentry;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001832
1833 return 0;
1834
Miklos Szeredi4155c102017-11-10 09:39:15 +01001835out_free_oe:
1836 ovl_entry_stack_free(oe);
Chandan Rajendrab9343632017-07-24 01:57:54 -05001837 kfree(oe);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001838out_err:
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001839 path_put(&upperpath);
Miklos Szerediad204482017-11-10 09:39:16 +01001840 ovl_free_fs(ofs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001841out:
1842 return err;
1843}
1844
1845static struct dentry *ovl_mount(struct file_system_type *fs_type, int flags,
1846 const char *dev_name, void *raw_data)
1847{
1848 return mount_nodev(fs_type, flags, raw_data, ovl_fill_super);
1849}
1850
1851static struct file_system_type ovl_fs_type = {
1852 .owner = THIS_MODULE,
Miklos Szeredief94b182014-11-20 16:39:59 +01001853 .name = "overlay",
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001854 .mount = ovl_mount,
1855 .kill_sb = kill_anon_super,
1856};
Miklos Szeredief94b182014-11-20 16:39:59 +01001857MODULE_ALIAS_FS("overlay");
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001858
Amir Goldstein13cf1992017-06-12 09:54:40 +03001859static void ovl_inode_init_once(void *foo)
1860{
1861 struct ovl_inode *oi = foo;
1862
1863 inode_init_once(&oi->vfs_inode);
1864}
1865
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001866static int __init ovl_init(void)
1867{
Amir Goldstein13cf1992017-06-12 09:54:40 +03001868 int err;
1869
1870 ovl_inode_cachep = kmem_cache_create("ovl_inode",
1871 sizeof(struct ovl_inode), 0,
1872 (SLAB_RECLAIM_ACCOUNT|
1873 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
1874 ovl_inode_init_once);
1875 if (ovl_inode_cachep == NULL)
1876 return -ENOMEM;
1877
Jiufei Xue2406a302019-11-20 17:45:26 +08001878 err = ovl_aio_request_cache_init();
1879 if (!err) {
1880 err = register_filesystem(&ovl_fs_type);
1881 if (!err)
1882 return 0;
1883
1884 ovl_aio_request_cache_destroy();
1885 }
1886 kmem_cache_destroy(ovl_inode_cachep);
Amir Goldstein13cf1992017-06-12 09:54:40 +03001887
1888 return err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001889}
1890
1891static void __exit ovl_exit(void)
1892{
1893 unregister_filesystem(&ovl_fs_type);
Amir Goldstein13cf1992017-06-12 09:54:40 +03001894
1895 /*
1896 * Make sure all delayed rcu free inodes are flushed before we
1897 * destroy cache.
1898 */
1899 rcu_barrier();
1900 kmem_cache_destroy(ovl_inode_cachep);
Jiufei Xue2406a302019-11-20 17:45:26 +08001901 ovl_aio_request_cache_destroy();
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001902}
1903
1904module_init(ovl_init);
1905module_exit(ovl_exit);