blob: 0116735cc32147ca3972275e2baa8a52d296f63f [file] [log] [blame]
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001/*
2 *
3 * Copyright (C) 2011 Novell Inc.
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
8 */
9
Ingo Molnar5b825c32017-02-02 17:54:15 +010010#include <uapi/linux/magic.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020011#include <linux/fs.h>
12#include <linux/namei.h>
13#include <linux/xattr.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020014#include <linux/mount.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020015#include <linux/parser.h>
16#include <linux/module.h>
Andy Whitcroftcc259632014-10-24 00:14:38 +020017#include <linux/statfs.h>
Erez Zadokf45827e82014-10-24 00:14:38 +020018#include <linux/seq_file.h>
Miklos Szeredid837a492016-07-29 12:05:24 +020019#include <linux/posix_acl_xattr.h>
Amir Goldsteine487d882017-11-07 13:55:04 +020020#include <linux/exportfs.h>
Miklos Szeredie9be9d52014-10-24 00:14:38 +020021#include "overlayfs.h"
22
23MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
24MODULE_DESCRIPTION("Overlay filesystem");
25MODULE_LICENSE("GPL");
26
Miklos Szeredie9be9d52014-10-24 00:14:38 +020027
28struct ovl_dir_cache;
29
Miklos Szeredia78d9f02014-12-13 00:59:52 +010030#define OVL_MAX_STACK 500
31
Miklos Szeredi688ea0e2016-12-16 11:02:57 +010032static bool ovl_redirect_dir_def = IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_DIR);
33module_param_named(redirect_dir, ovl_redirect_dir_def, bool, 0644);
34MODULE_PARM_DESC(ovl_redirect_dir_def,
35 "Default to on or off for the redirect_dir feature");
Miklos Szeredie9be9d52014-10-24 00:14:38 +020036
Miklos Szeredi438c84c2017-12-11 11:28:10 +010037static bool ovl_redirect_always_follow =
38 IS_ENABLED(CONFIG_OVERLAY_FS_REDIRECT_ALWAYS_FOLLOW);
39module_param_named(redirect_always_follow, ovl_redirect_always_follow,
40 bool, 0644);
41MODULE_PARM_DESC(ovl_redirect_always_follow,
42 "Follow redirects even if redirect_dir feature is turned off");
43
Amir Goldstein02bcd152017-06-21 15:28:36 +030044static bool ovl_index_def = IS_ENABLED(CONFIG_OVERLAY_FS_INDEX);
45module_param_named(index, ovl_index_def, bool, 0644);
46MODULE_PARM_DESC(ovl_index_def,
47 "Default to on or off for the inodes index feature");
48
Amir Goldsteinf168f102018-01-19 11:26:53 +020049static bool ovl_nfs_export_def = IS_ENABLED(CONFIG_OVERLAY_FS_NFS_EXPORT);
50module_param_named(nfs_export, ovl_nfs_export_def, bool, 0644);
51MODULE_PARM_DESC(ovl_nfs_export_def,
52 "Default to on or off for the NFS export feature");
53
Amir Goldstein795939a2018-03-29 09:08:18 +030054static bool ovl_xino_auto_def = IS_ENABLED(CONFIG_OVERLAY_FS_XINO_AUTO);
55module_param_named(xino_auto, ovl_xino_auto_def, bool, 0644);
56MODULE_PARM_DESC(ovl_xino_auto_def,
57 "Auto enable xino feature");
58
Miklos Szeredi4155c102017-11-10 09:39:15 +010059static void ovl_entry_stack_free(struct ovl_entry *oe)
60{
61 unsigned int i;
62
63 for (i = 0; i < oe->numlower; i++)
64 dput(oe->lowerstack[i].dentry);
65}
66
Vivek Goyald5791042018-05-11 11:49:27 -040067static bool ovl_metacopy_def = IS_ENABLED(CONFIG_OVERLAY_FS_METACOPY);
68module_param_named(metacopy, ovl_metacopy_def, bool, 0644);
69MODULE_PARM_DESC(ovl_metacopy_def,
70 "Default to on or off for the metadata only copy up feature");
71
Miklos Szeredie9be9d52014-10-24 00:14:38 +020072static void ovl_dentry_release(struct dentry *dentry)
73{
74 struct ovl_entry *oe = dentry->d_fsdata;
75
76 if (oe) {
Miklos Szeredi4155c102017-11-10 09:39:15 +010077 ovl_entry_stack_free(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +020078 kfree_rcu(oe, rcu);
79 }
80}
81
Miklos Szeredi2d902672016-06-30 08:53:27 +020082static struct dentry *ovl_d_real(struct dentry *dentry,
Miklos Szeredifb160432018-07-18 15:44:44 +020083 const struct inode *inode)
Miklos Szeredid101a122016-03-26 16:14:37 -040084{
85 struct dentry *real;
86
Miklos Szeredie8c985b2018-07-18 15:44:41 +020087 /* It's an overlay file */
88 if (inode && d_inode(dentry) == inode)
89 return dentry;
90
Miklos Szeredica4c8a32016-12-16 11:02:55 +010091 if (!d_is_reg(dentry)) {
Miklos Szeredid101a122016-03-26 16:14:37 -040092 if (!inode || inode == d_inode(dentry))
93 return dentry;
94 goto bug;
95 }
96
97 real = ovl_dentry_upper(dentry);
Vivek Goyal2c3d7352018-05-11 11:49:31 -040098 if (real && (inode == d_inode(real)))
Miklos Szeredid101a122016-03-26 16:14:37 -040099 return real;
100
Vivek Goyal2c3d7352018-05-11 11:49:31 -0400101 if (real && !inode && ovl_has_upperdata(d_inode(dentry)))
102 return real;
103
104 real = ovl_dentry_lowerdata(dentry);
Miklos Szeredid101a122016-03-26 16:14:37 -0400105 if (!real)
106 goto bug;
107
Miklos Szeredic4fcfc12016-11-29 10:20:24 +0100108 /* Handle recursion */
Miklos Szeredifb160432018-07-18 15:44:44 +0200109 real = d_real(real, inode);
Miklos Szeredic4fcfc12016-11-29 10:20:24 +0100110
Miklos Szeredid101a122016-03-26 16:14:37 -0400111 if (!inode || inode == d_inode(real))
112 return real;
Miklos Szeredid101a122016-03-26 16:14:37 -0400113bug:
Miklos Szeredi656189d2016-07-29 12:05:24 +0200114 WARN(1, "ovl_d_real(%pd4, %s:%lu): real dentry not found\n", dentry,
Miklos Szeredid101a122016-03-26 16:14:37 -0400115 inode ? inode->i_sb->s_id : "NULL", inode ? inode->i_ino : 0);
116 return dentry;
117}
118
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200119static int ovl_dentry_revalidate(struct dentry *dentry, unsigned int flags)
120{
121 struct ovl_entry *oe = dentry->d_fsdata;
122 unsigned int i;
123 int ret = 1;
124
125 for (i = 0; i < oe->numlower; i++) {
126 struct dentry *d = oe->lowerstack[i].dentry;
127
128 if (d->d_flags & DCACHE_OP_REVALIDATE) {
129 ret = d->d_op->d_revalidate(d, flags);
130 if (ret < 0)
131 return ret;
132 if (!ret) {
133 if (!(flags & LOOKUP_RCU))
134 d_invalidate(d);
135 return -ESTALE;
136 }
137 }
138 }
139 return 1;
140}
141
142static int ovl_dentry_weak_revalidate(struct dentry *dentry, unsigned int flags)
143{
144 struct ovl_entry *oe = dentry->d_fsdata;
145 unsigned int i;
146 int ret = 1;
147
148 for (i = 0; i < oe->numlower; i++) {
149 struct dentry *d = oe->lowerstack[i].dentry;
150
151 if (d->d_flags & DCACHE_OP_WEAK_REVALIDATE) {
152 ret = d->d_op->d_weak_revalidate(d, flags);
153 if (ret <= 0)
154 break;
155 }
156 }
157 return ret;
158}
159
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200160static const struct dentry_operations ovl_dentry_operations = {
161 .d_release = ovl_dentry_release,
Miklos Szeredid101a122016-03-26 16:14:37 -0400162 .d_real = ovl_d_real,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200163};
164
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200165static const struct dentry_operations ovl_reval_dentry_operations = {
166 .d_release = ovl_dentry_release,
Miklos Szeredid101a122016-03-26 16:14:37 -0400167 .d_real = ovl_d_real,
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200168 .d_revalidate = ovl_dentry_revalidate,
169 .d_weak_revalidate = ovl_dentry_weak_revalidate,
170};
171
Amir Goldstein13cf1992017-06-12 09:54:40 +0300172static struct kmem_cache *ovl_inode_cachep;
173
174static struct inode *ovl_alloc_inode(struct super_block *sb)
175{
176 struct ovl_inode *oi = kmem_cache_alloc(ovl_inode_cachep, GFP_KERNEL);
177
Hirofumi Nakagawab3885bd2017-09-26 03:09:53 +0900178 if (!oi)
179 return NULL;
180
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200181 oi->cache = NULL;
Miklos Szeredicf31c462017-07-04 22:03:16 +0200182 oi->redirect = NULL;
Miklos Szeredi04a01ac2017-07-04 22:03:16 +0200183 oi->version = 0;
Miklos Szeredi13c72072017-07-04 22:03:16 +0200184 oi->flags = 0;
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200185 oi->__upperdentry = NULL;
Miklos Szeredi25b77132017-07-04 22:03:16 +0200186 oi->lower = NULL;
Vivek Goyal2664bd02018-05-11 11:49:30 -0400187 oi->lowerdata = NULL;
Amir Goldsteina015daf2017-06-21 15:28:51 +0300188 mutex_init(&oi->lock);
Miklos Szeredi25b77132017-07-04 22:03:16 +0200189
Amir Goldstein13cf1992017-06-12 09:54:40 +0300190 return &oi->vfs_inode;
191}
192
193static void ovl_i_callback(struct rcu_head *head)
194{
195 struct inode *inode = container_of(head, struct inode, i_rcu);
196
197 kmem_cache_free(ovl_inode_cachep, OVL_I(inode));
198}
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);
Miklos Szeredicf31c462017-07-04 22:03:16 +0200210 kfree(oi->redirect);
Amir Goldsteina015daf2017-06-21 15:28:51 +0300211 mutex_destroy(&oi->lock);
Miklos Szeredi09d8b582017-07-04 22:03:16 +0200212
Amir Goldstein13cf1992017-06-12 09:54:40 +0300213 call_rcu(&inode->i_rcu, ovl_i_callback);
214}
215
Miklos Szerediad204482017-11-10 09:39:16 +0100216static void ovl_free_fs(struct ovl_fs *ofs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200217{
Miklos Szeredidd662662014-12-13 00:59:43 +0100218 unsigned i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200219
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 Goldstein51486262018-03-28 20:22:41 +0300228 for (i = 0; i < ofs->numlower; i++)
Miklos Szerediad204482017-11-10 09:39:16 +0100229 mntput(ofs->lower_layers[i].mnt);
Amir Goldstein51486262018-03-28 20:22:41 +0300230 for (i = 0; i < ofs->numlowerfs; i++)
231 free_anon_bdev(ofs->lower_fs[i].pseudo_dev);
Miklos Szerediad204482017-11-10 09:39:16 +0100232 kfree(ofs->lower_layers);
Amir Goldstein51486262018-03-28 20:22:41 +0300233 kfree(ofs->lower_fs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200234
Miklos Szerediad204482017-11-10 09:39:16 +0100235 kfree(ofs->config.lowerdir);
236 kfree(ofs->config.upperdir);
237 kfree(ofs->config.workdir);
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100238 kfree(ofs->config.redirect_mode);
Miklos Szerediad204482017-11-10 09:39:16 +0100239 if (ofs->creator_cred)
240 put_cred(ofs->creator_cred);
241 kfree(ofs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200242}
243
Miklos Szeredia9075cd2017-11-10 09:39:15 +0100244static void ovl_put_super(struct super_block *sb)
245{
246 struct ovl_fs *ofs = sb->s_fs_info;
247
248 ovl_free_fs(ofs);
249}
250
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800251/* Sync real dirty inodes in upper filesystem (if it exists) */
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200252static int ovl_sync_fs(struct super_block *sb, int wait)
253{
Miklos Szerediad204482017-11-10 09:39:16 +0100254 struct ovl_fs *ofs = sb->s_fs_info;
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200255 struct super_block *upper_sb;
256 int ret;
257
Miklos Szerediad204482017-11-10 09:39:16 +0100258 if (!ofs->upper_mnt)
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200259 return 0;
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800260
261 /*
262 * If this is a sync(2) call or an emergency sync, all the super blocks
263 * will be iterated, including upper_sb, so no need to do anything.
264 *
265 * If this is a syncfs(2) call, then we do need to call
266 * sync_filesystem() on upper_sb, but enough if we do it when being
267 * called with wait == 1.
268 */
269 if (!wait)
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200270 return 0;
271
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800272 upper_sb = ofs->upper_mnt->mnt_sb;
273
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200274 down_read(&upper_sb->s_umount);
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800275 ret = sync_filesystem(upper_sb);
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200276 up_read(&upper_sb->s_umount);
Chengguang Xue8d4bfe2017-11-29 10:01:32 +0800277
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200278 return ret;
279}
280
Andy Whitcroftcc259632014-10-24 00:14:38 +0200281/**
282 * ovl_statfs
283 * @sb: The overlayfs super block
284 * @buf: The struct kstatfs to fill in with stats
285 *
286 * Get the filesystem statistics. As writes always target the upper layer
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100287 * filesystem pass the statfs to the upper filesystem (if it exists)
Andy Whitcroftcc259632014-10-24 00:14:38 +0200288 */
289static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
290{
291 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
292 struct dentry *root_dentry = dentry->d_sb->s_root;
293 struct path path;
294 int err;
295
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100296 ovl_path_real(root_dentry, &path);
Andy Whitcroftcc259632014-10-24 00:14:38 +0200297
298 err = vfs_statfs(&path, buf);
299 if (!err) {
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100300 buf->f_namelen = ofs->namelen;
Andy Whitcroftcc259632014-10-24 00:14:38 +0200301 buf->f_type = OVERLAYFS_SUPER_MAGIC;
302 }
303
304 return err;
305}
306
Amir Goldstein02bcd152017-06-21 15:28:36 +0300307/* Will this overlay be forced to mount/remount ro? */
Miklos Szerediad204482017-11-10 09:39:16 +0100308static bool ovl_force_readonly(struct ovl_fs *ofs)
Amir Goldstein02bcd152017-06-21 15:28:36 +0300309{
Miklos Szerediad204482017-11-10 09:39:16 +0100310 return (!ofs->upper_mnt || !ofs->workdir);
Amir Goldstein02bcd152017-06-21 15:28:36 +0300311}
312
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100313static const char *ovl_redirect_mode_def(void)
314{
315 return ovl_redirect_dir_def ? "on" : "off";
316}
317
Amir Goldstein795939a2018-03-29 09:08:18 +0300318enum {
319 OVL_XINO_OFF,
320 OVL_XINO_AUTO,
321 OVL_XINO_ON,
322};
323
324static const char * const ovl_xino_str[] = {
325 "off",
326 "auto",
327 "on",
328};
329
330static inline int ovl_xino_def(void)
331{
332 return ovl_xino_auto_def ? OVL_XINO_AUTO : OVL_XINO_OFF;
333}
334
Erez Zadokf45827e82014-10-24 00:14:38 +0200335/**
336 * ovl_show_options
337 *
338 * Prints the mount options for a given superblock.
339 * Returns zero; does not fail.
340 */
341static int ovl_show_options(struct seq_file *m, struct dentry *dentry)
342{
343 struct super_block *sb = dentry->d_sb;
Miklos Szerediad204482017-11-10 09:39:16 +0100344 struct ovl_fs *ofs = sb->s_fs_info;
Erez Zadokf45827e82014-10-24 00:14:38 +0200345
Miklos Szerediad204482017-11-10 09:39:16 +0100346 seq_show_option(m, "lowerdir", ofs->config.lowerdir);
347 if (ofs->config.upperdir) {
348 seq_show_option(m, "upperdir", ofs->config.upperdir);
349 seq_show_option(m, "workdir", ofs->config.workdir);
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100350 }
Miklos Szerediad204482017-11-10 09:39:16 +0100351 if (ofs->config.default_permissions)
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200352 seq_puts(m, ",default_permissions");
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100353 if (strcmp(ofs->config.redirect_mode, ovl_redirect_mode_def()) != 0)
354 seq_printf(m, ",redirect_dir=%s", ofs->config.redirect_mode);
Miklos Szerediad204482017-11-10 09:39:16 +0100355 if (ofs->config.index != ovl_index_def)
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100356 seq_printf(m, ",index=%s", ofs->config.index ? "on" : "off");
Amir Goldsteinf168f102018-01-19 11:26:53 +0200357 if (ofs->config.nfs_export != ovl_nfs_export_def)
358 seq_printf(m, ",nfs_export=%s", ofs->config.nfs_export ?
359 "on" : "off");
Amir Goldstein795939a2018-03-29 09:08:18 +0300360 if (ofs->config.xino != ovl_xino_def())
361 seq_printf(m, ",xino=%s", ovl_xino_str[ofs->config.xino]);
Vivek Goyald5791042018-05-11 11:49:27 -0400362 if (ofs->config.metacopy != ovl_metacopy_def)
363 seq_printf(m, ",metacopy=%s",
364 ofs->config.metacopy ? "on" : "off");
Erez Zadokf45827e82014-10-24 00:14:38 +0200365 return 0;
366}
367
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900368static int ovl_remount(struct super_block *sb, int *flags, char *data)
369{
Miklos Szerediad204482017-11-10 09:39:16 +0100370 struct ovl_fs *ofs = sb->s_fs_info;
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900371
Linus Torvalds1751e8a2017-11-27 13:05:09 -0800372 if (!(*flags & SB_RDONLY) && ovl_force_readonly(ofs))
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900373 return -EROFS;
374
375 return 0;
376}
377
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200378static const struct super_operations ovl_super_operations = {
Amir Goldstein13cf1992017-06-12 09:54:40 +0300379 .alloc_inode = ovl_alloc_inode,
380 .destroy_inode = ovl_destroy_inode,
381 .drop_inode = generic_delete_inode,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200382 .put_super = ovl_put_super,
Amir Goldsteine593b2b2017-01-23 14:32:21 +0200383 .sync_fs = ovl_sync_fs,
Andy Whitcroftcc259632014-10-24 00:14:38 +0200384 .statfs = ovl_statfs,
Erez Zadokf45827e82014-10-24 00:14:38 +0200385 .show_options = ovl_show_options,
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900386 .remount_fs = ovl_remount,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200387};
388
389enum {
390 OPT_LOWERDIR,
391 OPT_UPPERDIR,
392 OPT_WORKDIR,
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200393 OPT_DEFAULT_PERMISSIONS,
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100394 OPT_REDIRECT_DIR,
Amir Goldstein02bcd152017-06-21 15:28:36 +0300395 OPT_INDEX_ON,
396 OPT_INDEX_OFF,
Amir Goldsteinf168f102018-01-19 11:26:53 +0200397 OPT_NFS_EXPORT_ON,
398 OPT_NFS_EXPORT_OFF,
Amir Goldstein795939a2018-03-29 09:08:18 +0300399 OPT_XINO_ON,
400 OPT_XINO_OFF,
401 OPT_XINO_AUTO,
Vivek Goyald5791042018-05-11 11:49:27 -0400402 OPT_METACOPY_ON,
403 OPT_METACOPY_OFF,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200404 OPT_ERR,
405};
406
407static const match_table_t ovl_tokens = {
408 {OPT_LOWERDIR, "lowerdir=%s"},
409 {OPT_UPPERDIR, "upperdir=%s"},
410 {OPT_WORKDIR, "workdir=%s"},
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200411 {OPT_DEFAULT_PERMISSIONS, "default_permissions"},
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100412 {OPT_REDIRECT_DIR, "redirect_dir=%s"},
Amir Goldstein02bcd152017-06-21 15:28:36 +0300413 {OPT_INDEX_ON, "index=on"},
414 {OPT_INDEX_OFF, "index=off"},
Amir Goldsteinf168f102018-01-19 11:26:53 +0200415 {OPT_NFS_EXPORT_ON, "nfs_export=on"},
416 {OPT_NFS_EXPORT_OFF, "nfs_export=off"},
Amir Goldstein795939a2018-03-29 09:08:18 +0300417 {OPT_XINO_ON, "xino=on"},
418 {OPT_XINO_OFF, "xino=off"},
419 {OPT_XINO_AUTO, "xino=auto"},
Vivek Goyald5791042018-05-11 11:49:27 -0400420 {OPT_METACOPY_ON, "metacopy=on"},
421 {OPT_METACOPY_OFF, "metacopy=off"},
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200422 {OPT_ERR, NULL}
423};
424
Miklos Szeredi91c77942014-11-20 16:40:00 +0100425static char *ovl_next_opt(char **s)
426{
427 char *sbegin = *s;
428 char *p;
429
430 if (sbegin == NULL)
431 return NULL;
432
433 for (p = sbegin; *p; p++) {
434 if (*p == '\\') {
435 p++;
436 if (!*p)
437 break;
438 } else if (*p == ',') {
439 *p = '\0';
440 *s = p + 1;
441 return sbegin;
442 }
443 }
444 *s = NULL;
445 return sbegin;
446}
447
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100448static int ovl_parse_redirect_mode(struct ovl_config *config, const char *mode)
449{
450 if (strcmp(mode, "on") == 0) {
451 config->redirect_dir = true;
452 /*
453 * Does not make sense to have redirect creation without
454 * redirect following.
455 */
456 config->redirect_follow = true;
457 } else if (strcmp(mode, "follow") == 0) {
458 config->redirect_follow = true;
459 } else if (strcmp(mode, "off") == 0) {
460 if (ovl_redirect_always_follow)
461 config->redirect_follow = true;
462 } else if (strcmp(mode, "nofollow") != 0) {
463 pr_err("overlayfs: bad mount option \"redirect_dir=%s\"\n",
464 mode);
465 return -EINVAL;
466 }
467
468 return 0;
469}
470
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200471static int ovl_parse_opt(char *opt, struct ovl_config *config)
472{
473 char *p;
Vivek Goyald5791042018-05-11 11:49:27 -0400474 int err;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100475 bool metacopy_opt = false, redirect_opt = false;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200476
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100477 config->redirect_mode = kstrdup(ovl_redirect_mode_def(), GFP_KERNEL);
478 if (!config->redirect_mode)
479 return -ENOMEM;
480
Miklos Szeredi91c77942014-11-20 16:40:00 +0100481 while ((p = ovl_next_opt(&opt)) != NULL) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200482 int token;
483 substring_t args[MAX_OPT_ARGS];
484
485 if (!*p)
486 continue;
487
488 token = match_token(p, ovl_tokens, args);
489 switch (token) {
490 case OPT_UPPERDIR:
491 kfree(config->upperdir);
492 config->upperdir = match_strdup(&args[0]);
493 if (!config->upperdir)
494 return -ENOMEM;
495 break;
496
497 case OPT_LOWERDIR:
498 kfree(config->lowerdir);
499 config->lowerdir = match_strdup(&args[0]);
500 if (!config->lowerdir)
501 return -ENOMEM;
502 break;
503
504 case OPT_WORKDIR:
505 kfree(config->workdir);
506 config->workdir = match_strdup(&args[0]);
507 if (!config->workdir)
508 return -ENOMEM;
509 break;
510
Miklos Szeredi8d3095f2015-10-12 17:11:44 +0200511 case OPT_DEFAULT_PERMISSIONS:
512 config->default_permissions = true;
513 break;
514
Miklos Szeredi438c84c2017-12-11 11:28:10 +0100515 case OPT_REDIRECT_DIR:
516 kfree(config->redirect_mode);
517 config->redirect_mode = match_strdup(&args[0]);
518 if (!config->redirect_mode)
519 return -ENOMEM;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100520 redirect_opt = true;
Miklos Szeredia6c60652016-12-16 11:02:56 +0100521 break;
522
Amir Goldstein02bcd152017-06-21 15:28:36 +0300523 case OPT_INDEX_ON:
524 config->index = true;
525 break;
526
527 case OPT_INDEX_OFF:
528 config->index = false;
529 break;
530
Amir Goldsteinf168f102018-01-19 11:26:53 +0200531 case OPT_NFS_EXPORT_ON:
532 config->nfs_export = true;
533 break;
534
535 case OPT_NFS_EXPORT_OFF:
536 config->nfs_export = false;
537 break;
538
Amir Goldstein795939a2018-03-29 09:08:18 +0300539 case OPT_XINO_ON:
540 config->xino = OVL_XINO_ON;
541 break;
542
543 case OPT_XINO_OFF:
544 config->xino = OVL_XINO_OFF;
545 break;
546
547 case OPT_XINO_AUTO:
548 config->xino = OVL_XINO_AUTO;
549 break;
550
Vivek Goyald5791042018-05-11 11:49:27 -0400551 case OPT_METACOPY_ON:
552 config->metacopy = true;
Miklos Szeredid47748e2018-11-01 21:31:39 +0100553 metacopy_opt = true;
Vivek Goyald5791042018-05-11 11:49:27 -0400554 break;
555
556 case OPT_METACOPY_OFF:
557 config->metacopy = false;
558 break;
559
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200560 default:
hujianyangbead55e2015-01-15 13:17:36 +0800561 pr_err("overlayfs: unrecognized mount option \"%s\" or missing value\n", p);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200562 return -EINVAL;
563 }
564 }
hujianyang71cbad72015-01-15 13:20:57 +0800565
566 /* Workdir is useless in non-upper mount */
567 if (!config->upperdir && config->workdir) {
568 pr_info("overlayfs: option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
569 config->workdir);
570 kfree(config->workdir);
571 config->workdir = NULL;
572 }
573
Vivek Goyald5791042018-05-11 11:49:27 -0400574 err = ovl_parse_redirect_mode(config, config->redirect_mode);
575 if (err)
576 return err;
577
Miklos Szeredid47748e2018-11-01 21:31:39 +0100578 /*
579 * This is to make the logic below simpler. It doesn't make any other
580 * difference, since config->redirect_dir is only used for upper.
581 */
582 if (!config->upperdir && config->redirect_follow)
583 config->redirect_dir = true;
584
585 /* Resolve metacopy -> redirect_dir dependency */
586 if (config->metacopy && !config->redirect_dir) {
587 if (metacopy_opt && redirect_opt) {
588 pr_err("overlayfs: conflicting options: metacopy=on,redirect_dir=%s\n",
589 config->redirect_mode);
590 return -EINVAL;
591 }
592 if (redirect_opt) {
593 /*
594 * There was an explicit redirect_dir=... that resulted
595 * in this conflict.
596 */
597 pr_info("overlayfs: disabling metacopy due to redirect_dir=%s\n",
598 config->redirect_mode);
599 config->metacopy = false;
600 } else {
601 /* Automatically enable redirect otherwise. */
602 config->redirect_follow = config->redirect_dir = true;
603 }
Vivek Goyald5791042018-05-11 11:49:27 -0400604 }
605
606 return 0;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200607}
608
609#define OVL_WORKDIR_NAME "work"
Amir Goldstein02bcd152017-06-21 15:28:36 +0300610#define OVL_INDEXDIR_NAME "index"
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200611
Miklos Szerediad204482017-11-10 09:39:16 +0100612static struct dentry *ovl_workdir_create(struct ovl_fs *ofs,
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300613 const char *name, bool persist)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200614{
Miklos Szerediad204482017-11-10 09:39:16 +0100615 struct inode *dir = ofs->workbasedir->d_inode;
616 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200617 struct dentry *work;
618 int err;
619 bool retried = false;
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300620 bool locked = false;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200621
Al Viro59551022016-01-22 15:40:57 -0500622 inode_lock_nested(dir, I_MUTEX_PARENT);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300623 locked = true;
624
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200625retry:
Miklos Szerediad204482017-11-10 09:39:16 +0100626 work = lookup_one_len(name, ofs->workbasedir, strlen(name));
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200627
628 if (!IS_ERR(work)) {
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200629 struct iattr attr = {
630 .ia_valid = ATTR_MODE,
Al Viro32a3d842016-12-04 17:33:17 +0000631 .ia_mode = S_IFDIR | 0,
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200632 };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200633
634 if (work->d_inode) {
635 err = -EEXIST;
636 if (retried)
637 goto out_dput;
638
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300639 if (persist)
640 goto out_unlock;
641
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200642 retried = true;
Miklos Szeredieea2fb42016-09-01 11:11:59 +0200643 ovl_workdir_cleanup(dir, mnt, work, 0);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200644 dput(work);
645 goto retry;
646 }
647
Miklos Szeredi95a1c812018-05-16 17:51:25 +0300648 work = ovl_create_real(dir, work, OVL_CATTR(attr.ia_mode));
649 err = PTR_ERR(work);
650 if (IS_ERR(work))
651 goto out_err;
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200652
Miklos Szeredicb348ed2016-10-04 14:40:44 +0200653 /*
654 * Try to remove POSIX ACL xattrs from workdir. We are good if:
655 *
656 * a) success (there was a POSIX ACL xattr and was removed)
657 * b) -ENODATA (there was no POSIX ACL xattr)
658 * c) -EOPNOTSUPP (POSIX ACL xattrs are not supported)
659 *
660 * There are various other error values that could effectively
661 * mean that the xattr doesn't exist (e.g. -ERANGE is returned
662 * if the xattr name is too long), but the set of filesystems
663 * allowed as upper are limited to "normal" ones, where checking
664 * for the above two errors is sufficient.
665 */
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200666 err = vfs_removexattr(work, XATTR_NAME_POSIX_ACL_DEFAULT);
Miklos Szeredie1ff3dd2016-09-05 13:55:20 +0200667 if (err && err != -ENODATA && err != -EOPNOTSUPP)
Miklos Szeredic11b9fd2016-09-01 11:11:59 +0200668 goto out_dput;
669
670 err = vfs_removexattr(work, XATTR_NAME_POSIX_ACL_ACCESS);
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 /* Clear any inherited mode bits */
675 inode_lock(work->d_inode);
676 err = notify_change(work, &attr, NULL);
677 inode_unlock(work->d_inode);
678 if (err)
679 goto out_dput;
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300680 } else {
681 err = PTR_ERR(work);
682 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200683 }
684out_unlock:
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300685 if (locked)
686 inode_unlock(dir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200687
688 return work;
689
690out_dput:
691 dput(work);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300692out_err:
693 pr_warn("overlayfs: failed to create directory %s/%s (errno: %i); mounting read-only\n",
Miklos Szerediad204482017-11-10 09:39:16 +0100694 ofs->config.workdir, name, -err);
Amir Goldstein6b8aa122017-06-21 15:28:35 +0300695 work = NULL;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200696 goto out_unlock;
697}
698
Miklos Szeredi91c77942014-11-20 16:40:00 +0100699static void ovl_unescape(char *s)
700{
701 char *d = s;
702
703 for (;; s++, d++) {
704 if (*s == '\\')
705 s++;
706 *d = *s;
707 if (!*s)
708 break;
709 }
710}
711
Miklos Szerediab508822014-12-13 00:59:49 +0100712static int ovl_mount_dir_noesc(const char *name, struct path *path)
713{
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100714 int err = -EINVAL;
Miklos Szerediab508822014-12-13 00:59:49 +0100715
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100716 if (!*name) {
717 pr_err("overlayfs: empty lowerdir\n");
718 goto out;
719 }
Miklos Szerediab508822014-12-13 00:59:49 +0100720 err = kern_path(name, LOOKUP_FOLLOW, path);
721 if (err) {
722 pr_err("overlayfs: failed to resolve '%s': %i\n", name, err);
723 goto out;
724 }
725 err = -EINVAL;
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200726 if (ovl_dentry_weird(path->dentry)) {
Miklos Szerediab508822014-12-13 00:59:49 +0100727 pr_err("overlayfs: filesystem on '%s' not supported\n", name);
728 goto out_put;
729 }
Miklos Szeredi2b8c30e2016-12-16 11:02:56 +0100730 if (!d_is_dir(path->dentry)) {
Miklos Szerediab508822014-12-13 00:59:49 +0100731 pr_err("overlayfs: '%s' not a directory\n", name);
732 goto out_put;
733 }
734 return 0;
735
736out_put:
Miklos Szeredi8aafcb52017-11-09 10:23:28 +0100737 path_put_init(path);
Miklos Szerediab508822014-12-13 00:59:49 +0100738out:
739 return err;
740}
741
742static int ovl_mount_dir(const char *name, struct path *path)
743{
744 int err = -ENOMEM;
745 char *tmp = kstrdup(name, GFP_KERNEL);
746
747 if (tmp) {
748 ovl_unescape(tmp);
749 err = ovl_mount_dir_noesc(tmp, path);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200750
751 if (!err)
752 if (ovl_dentry_remote(path->dentry)) {
753 pr_err("overlayfs: filesystem on '%s' not supported as upperdir\n",
754 tmp);
Miklos Szeredi8aafcb52017-11-09 10:23:28 +0100755 path_put_init(path);
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200756 err = -EINVAL;
757 }
Miklos Szerediab508822014-12-13 00:59:49 +0100758 kfree(tmp);
759 }
760 return err;
761}
762
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100763static int ovl_check_namelen(struct path *path, struct ovl_fs *ofs,
764 const char *name)
765{
766 struct kstatfs statfs;
767 int err = vfs_statfs(path, &statfs);
768
769 if (err)
770 pr_err("overlayfs: statfs failed on '%s'\n", name);
771 else
772 ofs->namelen = max(ofs->namelen, statfs.f_namelen);
773
774 return err;
775}
776
777static int ovl_lower_dir(const char *name, struct path *path,
778 struct ovl_fs *ofs, int *stack_depth, bool *remote)
Miklos Szerediab508822014-12-13 00:59:49 +0100779{
Amir Goldsteine487d882017-11-07 13:55:04 +0200780 int fh_type;
Miklos Szerediab508822014-12-13 00:59:49 +0100781 int err;
Miklos Szerediab508822014-12-13 00:59:49 +0100782
Miklos Szeredia78d9f02014-12-13 00:59:52 +0100783 err = ovl_mount_dir_noesc(name, path);
Miklos Szerediab508822014-12-13 00:59:49 +0100784 if (err)
785 goto out;
786
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100787 err = ovl_check_namelen(path, ofs, name);
788 if (err)
Miklos Szerediab508822014-12-13 00:59:49 +0100789 goto out_put;
Miklos Szeredi6b2d5fe2016-12-16 11:02:56 +0100790
Miklos Szerediab508822014-12-13 00:59:49 +0100791 *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
792
Miklos Szeredi7c03b5d2015-06-22 13:53:48 +0200793 if (ovl_dentry_remote(path->dentry))
794 *remote = true;
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;
805 pr_warn("overlayfs: fs on '%s' does not support file handles, falling back to index=off,nfs_export=off.\n",
806 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)
811 ofs->xino_bits = 0;
812
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
Miklos Szerediad204482017-11-10 09:39:16 +0100987static int ovl_get_upper(struct ovl_fs *ofs, struct path *upperpath)
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +0100988{
Miklos Szeredi50649752017-11-10 09:39:15 +0100989 struct vfsmount *upper_mnt;
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +0100990 int err;
991
Miklos Szerediad204482017-11-10 09:39:16 +0100992 err = ovl_mount_dir(ofs->config.upperdir, upperpath);
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +0100993 if (err)
994 goto out;
995
996 /* Upper fs should not be r/o */
997 if (sb_rdonly(upperpath->mnt->mnt_sb)) {
998 pr_err("overlayfs: upper fs is r/o, try multi-lower layers mount\n");
999 err = -EINVAL;
1000 goto out;
1001 }
1002
Miklos Szerediad204482017-11-10 09:39:16 +01001003 err = ovl_check_namelen(upperpath, ofs, ofs->config.upperdir);
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001004 if (err)
1005 goto out;
1006
Miklos Szeredi50649752017-11-10 09:39:15 +01001007 upper_mnt = clone_private_mount(upperpath);
1008 err = PTR_ERR(upper_mnt);
1009 if (IS_ERR(upper_mnt)) {
1010 pr_err("overlayfs: failed to clone upperpath\n");
1011 goto out;
1012 }
1013
1014 /* Don't inherit atime flags */
1015 upper_mnt->mnt_flags &= ~(MNT_NOATIME | MNT_NODIRATIME | MNT_RELATIME);
Miklos Szerediad204482017-11-10 09:39:16 +01001016 ofs->upper_mnt = upper_mnt;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001017
1018 err = -EBUSY;
1019 if (ovl_inuse_trylock(ofs->upper_mnt->mnt_root)) {
1020 ofs->upperdir_locked = true;
1021 } else if (ofs->config.index) {
1022 pr_err("overlayfs: upperdir is in-use by another mount, mount with '-o index=off' to override exclusive upperdir protection.\n");
1023 goto out;
1024 } else {
1025 pr_warn("overlayfs: upperdir is in-use by another mount, accessing files from both mounts will result in undefined behavior.\n");
1026 }
1027
Miklos Szeredi6ee8acf2017-11-09 10:23:28 +01001028 err = 0;
1029out:
1030 return err;
1031}
1032
Miklos Szerediad204482017-11-10 09:39:16 +01001033static int ovl_make_workdir(struct ovl_fs *ofs, struct path *workpath)
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001034{
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001035 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001036 struct dentry *temp;
Amir Goldsteine487d882017-11-07 13:55:04 +02001037 int fh_type;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001038 int err;
1039
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001040 err = mnt_want_write(mnt);
1041 if (err)
1042 return err;
1043
Miklos Szerediad204482017-11-10 09:39:16 +01001044 ofs->workdir = ovl_workdir_create(ofs, OVL_WORKDIR_NAME, false);
1045 if (!ofs->workdir)
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001046 goto out;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001047
1048 /*
1049 * Upper should support d_type, else whiteouts are visible. Given
1050 * workdir and upper are on same fs, we can do iterate_dir() on
1051 * workdir. This check requires successful creation of workdir in
1052 * previous step.
1053 */
1054 err = ovl_check_d_type_supported(workpath);
1055 if (err < 0)
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001056 goto out;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001057
1058 /*
1059 * We allowed this configuration and don't want to break users over
1060 * kernel upgrade. So warn instead of erroring out.
1061 */
1062 if (!err)
1063 pr_warn("overlayfs: upper fs needs to support d_type.\n");
1064
1065 /* Check if upper/work fs supports O_TMPFILE */
Miklos Szerediad204482017-11-10 09:39:16 +01001066 temp = ovl_do_tmpfile(ofs->workdir, S_IFREG | 0);
1067 ofs->tmpfile = !IS_ERR(temp);
1068 if (ofs->tmpfile)
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001069 dput(temp);
1070 else
1071 pr_warn("overlayfs: upper fs does not support tmpfile.\n");
1072
1073 /*
1074 * Check if upper/work fs supports trusted.overlay.* xattr
1075 */
Miklos Szerediad204482017-11-10 09:39:16 +01001076 err = ovl_do_setxattr(ofs->workdir, OVL_XATTR_OPAQUE, "0", 1, 0);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001077 if (err) {
Miklos Szerediad204482017-11-10 09:39:16 +01001078 ofs->noxattr = true;
Amir Goldsteina6837372017-09-19 12:14:18 +03001079 ofs->config.index = false;
Vivek Goyald5791042018-05-11 11:49:27 -04001080 ofs->config.metacopy = false;
1081 pr_warn("overlayfs: upper fs does not support xattr, falling back to index=off and metacopy=off.\n");
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001082 err = 0;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001083 } else {
Miklos Szerediad204482017-11-10 09:39:16 +01001084 vfs_removexattr(ofs->workdir, OVL_XATTR_OPAQUE);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001085 }
1086
1087 /* Check if upper/work fs supports file handles */
Amir Goldsteine487d882017-11-07 13:55:04 +02001088 fh_type = ovl_can_decode_fh(ofs->workdir->d_sb);
1089 if (ofs->config.index && !fh_type) {
Miklos Szerediad204482017-11-10 09:39:16 +01001090 ofs->config.index = false;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001091 pr_warn("overlayfs: upper fs does not support file handles, falling back to index=off.\n");
1092 }
1093
Amir Goldsteine487d882017-11-07 13:55:04 +02001094 /* Check if upper fs has 32bit inode numbers */
1095 if (fh_type != FILEID_INO32_GEN)
1096 ofs->xino_bits = 0;
1097
Amir Goldsteinf168f102018-01-19 11:26:53 +02001098 /* NFS export of r/w mount depends on index */
1099 if (ofs->config.nfs_export && !ofs->config.index) {
1100 pr_warn("overlayfs: NFS export requires \"index=on\", falling back to nfs_export=off.\n");
1101 ofs->config.nfs_export = false;
1102 }
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001103out:
1104 mnt_drop_write(mnt);
1105 return err;
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001106}
1107
Miklos Szerediad204482017-11-10 09:39:16 +01001108static int ovl_get_workdir(struct ovl_fs *ofs, struct path *upperpath)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001109{
1110 int err;
Miklos Szeredibca44b52017-11-10 09:39:15 +01001111 struct path workpath = { };
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001112
Miklos Szerediad204482017-11-10 09:39:16 +01001113 err = ovl_mount_dir(ofs->config.workdir, &workpath);
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001114 if (err)
1115 goto out;
1116
1117 err = -EINVAL;
Miklos Szeredibca44b52017-11-10 09:39:15 +01001118 if (upperpath->mnt != workpath.mnt) {
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001119 pr_err("overlayfs: workdir and upperdir must reside under the same mount\n");
1120 goto out;
1121 }
Miklos Szeredibca44b52017-11-10 09:39:15 +01001122 if (!ovl_workdir_ok(workpath.dentry, upperpath->dentry)) {
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001123 pr_err("overlayfs: workdir and upperdir must be separate subtrees\n");
1124 goto out;
1125 }
1126
Miklos Szeredi8c257412018-09-10 11:43:29 +02001127 ofs->workbasedir = dget(workpath.dentry);
1128
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001129 err = -EBUSY;
Miklos Szeredi8c257412018-09-10 11:43:29 +02001130 if (ovl_inuse_trylock(ofs->workbasedir)) {
Miklos Szerediad204482017-11-10 09:39:16 +01001131 ofs->workdir_locked = true;
1132 } else if (ofs->config.index) {
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001133 pr_err("overlayfs: workdir is in-use by another mount, mount with '-o index=off' to override exclusive workdir protection.\n");
1134 goto out;
1135 } else {
1136 pr_warn("overlayfs: workdir is in-use by another mount, accessing files from both mounts will result in undefined behavior.\n");
1137 }
1138
Miklos Szerediad204482017-11-10 09:39:16 +01001139 err = ovl_make_workdir(ofs, &workpath);
Miklos Szeredibca44b52017-11-10 09:39:15 +01001140 if (err)
1141 goto out;
1142
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001143 err = 0;
1144out:
Miklos Szeredibca44b52017-11-10 09:39:15 +01001145 path_put(&workpath);
1146
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001147 return err;
1148}
1149
Miklos Szerediad204482017-11-10 09:39:16 +01001150static int ovl_get_indexdir(struct ovl_fs *ofs, struct ovl_entry *oe,
Miklos Szeredi95e6d412017-11-09 10:23:29 +01001151 struct path *upperpath)
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001152{
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001153 struct vfsmount *mnt = ofs->upper_mnt;
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001154 int err;
1155
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001156 err = mnt_want_write(mnt);
1157 if (err)
1158 return err;
1159
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001160 /* Verify lower root is upper root origin */
Amir Goldsteind9768072017-09-24 13:00:19 +03001161 err = ovl_verify_origin(upperpath->dentry, oe->lowerstack[0].dentry,
Amir Goldstein05122442018-01-11 08:25:32 +02001162 true);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001163 if (err) {
1164 pr_err("overlayfs: failed to verify upper root origin\n");
1165 goto out;
1166 }
1167
Miklos Szerediad204482017-11-10 09:39:16 +01001168 ofs->indexdir = ovl_workdir_create(ofs, OVL_INDEXDIR_NAME, true);
1169 if (ofs->indexdir) {
Amir Goldsteinad1d6152018-01-11 10:47:03 +02001170 /*
1171 * Verify upper root is exclusively associated with index dir.
1172 * Older kernels stored upper fh in "trusted.overlay.origin"
1173 * xattr. If that xattr exists, verify that it is a match to
1174 * upper dir file handle. In any case, verify or set xattr
1175 * "trusted.overlay.upper" to indicate that index may have
1176 * directory entries.
1177 */
1178 if (ovl_check_origin_xattr(ofs->indexdir)) {
1179 err = ovl_verify_set_fh(ofs->indexdir, OVL_XATTR_ORIGIN,
1180 upperpath->dentry, true, false);
1181 if (err)
1182 pr_err("overlayfs: failed to verify index dir 'origin' xattr\n");
1183 }
1184 err = ovl_verify_upper(ofs->indexdir, upperpath->dentry, true);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001185 if (err)
Amir Goldsteinad1d6152018-01-11 10:47:03 +02001186 pr_err("overlayfs: failed to verify index dir 'upper' xattr\n");
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001187
1188 /* Cleanup bad/stale/orphan index entries */
1189 if (!err)
Amir Goldstein1eff1a12017-12-12 22:40:46 +02001190 err = ovl_indexdir_cleanup(ofs);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001191 }
Miklos Szerediad204482017-11-10 09:39:16 +01001192 if (err || !ofs->indexdir)
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001193 pr_warn("overlayfs: try deleting index dir or mounting with '-o index=off' to disable inodes index.\n");
1194
1195out:
Amir Goldstein2ba9d572018-01-03 18:54:41 +02001196 mnt_drop_write(mnt);
Miklos Szeredif7e3a7d2017-11-09 10:23:28 +01001197 return err;
1198}
1199
Amir Goldstein9df085f2018-09-03 09:12:09 +03001200static bool ovl_lower_uuid_ok(struct ovl_fs *ofs, const uuid_t *uuid)
Amir Goldstein51486262018-03-28 20:22:41 +03001201{
1202 unsigned int i;
Amir Goldstein9df085f2018-09-03 09:12:09 +03001203
1204 if (!ofs->config.nfs_export && !(ofs->config.index && ofs->upper_mnt))
1205 return true;
1206
1207 for (i = 0; i < ofs->numlowerfs; i++) {
1208 /*
1209 * We use uuid to associate an overlay lower file handle with a
1210 * lower layer, so we can accept lower fs with null uuid as long
1211 * as all lower layers with null uuid are on the same fs.
1212 */
1213 if (uuid_equal(&ofs->lower_fs[i].sb->s_uuid, uuid))
1214 return false;
1215 }
1216 return true;
1217}
1218
1219/* Get a unique fsid for the layer */
1220static int ovl_get_fsid(struct ovl_fs *ofs, const struct path *path)
1221{
1222 struct super_block *sb = path->mnt->mnt_sb;
1223 unsigned int i;
Amir Goldstein51486262018-03-28 20:22:41 +03001224 dev_t dev;
1225 int err;
1226
1227 /* fsid 0 is reserved for upper fs even with non upper overlay */
1228 if (ofs->upper_mnt && ofs->upper_mnt->mnt_sb == sb)
1229 return 0;
1230
1231 for (i = 0; i < ofs->numlowerfs; i++) {
1232 if (ofs->lower_fs[i].sb == sb)
1233 return i + 1;
1234 }
1235
Amir Goldstein9df085f2018-09-03 09:12:09 +03001236 if (!ovl_lower_uuid_ok(ofs, &sb->s_uuid)) {
1237 ofs->config.index = false;
1238 ofs->config.nfs_export = false;
1239 pr_warn("overlayfs: %s uuid detected in lower fs '%pd2', falling back to index=off,nfs_export=off.\n",
1240 uuid_is_null(&sb->s_uuid) ? "null" : "conflicting",
1241 path->dentry);
1242 }
1243
Amir Goldstein51486262018-03-28 20:22:41 +03001244 err = get_anon_bdev(&dev);
1245 if (err) {
1246 pr_err("overlayfs: failed to get anonymous bdev for lowerpath\n");
1247 return err;
1248 }
1249
1250 ofs->lower_fs[ofs->numlowerfs].sb = sb;
1251 ofs->lower_fs[ofs->numlowerfs].pseudo_dev = dev;
1252 ofs->numlowerfs++;
1253
1254 return ofs->numlowerfs;
1255}
1256
Miklos Szerediad204482017-11-10 09:39:16 +01001257static int ovl_get_lower_layers(struct ovl_fs *ofs, struct path *stack,
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001258 unsigned int numlower)
1259{
1260 int err;
1261 unsigned int i;
1262
1263 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001264 ofs->lower_layers = kcalloc(numlower, sizeof(struct ovl_layer),
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001265 GFP_KERNEL);
Miklos Szerediad204482017-11-10 09:39:16 +01001266 if (ofs->lower_layers == NULL)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001267 goto out;
Amir Goldstein51486262018-03-28 20:22:41 +03001268
1269 ofs->lower_fs = kcalloc(numlower, sizeof(struct ovl_sb),
1270 GFP_KERNEL);
1271 if (ofs->lower_fs == NULL)
1272 goto out;
1273
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001274 for (i = 0; i < numlower; i++) {
1275 struct vfsmount *mnt;
Amir Goldstein51486262018-03-28 20:22:41 +03001276 int fsid;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001277
Amir Goldstein9df085f2018-09-03 09:12:09 +03001278 err = fsid = ovl_get_fsid(ofs, &stack[i]);
Amir Goldstein51486262018-03-28 20:22:41 +03001279 if (err < 0)
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001280 goto out;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001281
1282 mnt = clone_private_mount(&stack[i]);
1283 err = PTR_ERR(mnt);
1284 if (IS_ERR(mnt)) {
1285 pr_err("overlayfs: failed to clone lowerpath\n");
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001286 goto out;
1287 }
Amir Goldstein51486262018-03-28 20:22:41 +03001288
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001289 /*
1290 * Make lower layers R/O. That way fchmod/fchown on lower file
1291 * will fail instead of modifying lower fs.
1292 */
1293 mnt->mnt_flags |= MNT_READONLY | MNT_NOATIME;
1294
Miklos Szerediad204482017-11-10 09:39:16 +01001295 ofs->lower_layers[ofs->numlower].mnt = mnt;
Amir Goldsteind583ed72017-11-08 19:23:36 +02001296 ofs->lower_layers[ofs->numlower].idx = i + 1;
Amir Goldstein51486262018-03-28 20:22:41 +03001297 ofs->lower_layers[ofs->numlower].fsid = fsid;
1298 if (fsid) {
1299 ofs->lower_layers[ofs->numlower].fs =
1300 &ofs->lower_fs[fsid - 1];
1301 }
Miklos Szerediad204482017-11-10 09:39:16 +01001302 ofs->numlower++;
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001303 }
Amir Goldsteine487d882017-11-07 13:55:04 +02001304
Amir Goldstein795939a2018-03-29 09:08:18 +03001305 /*
1306 * When all layers on same fs, overlay can use real inode numbers.
1307 * With mount option "xino=on", mounter declares that there are enough
1308 * free high bits in underlying fs to hold the unique fsid.
1309 * If overlayfs does encounter underlying inodes using the high xino
1310 * bits reserved for fsid, it emits a warning and uses the original
1311 * inode number.
1312 */
1313 if (!ofs->numlowerfs || (ofs->numlowerfs == 1 && !ofs->upper_mnt)) {
Amir Goldsteine487d882017-11-07 13:55:04 +02001314 ofs->xino_bits = 0;
Amir Goldstein795939a2018-03-29 09:08:18 +03001315 ofs->config.xino = OVL_XINO_OFF;
1316 } else if (ofs->config.xino == OVL_XINO_ON && !ofs->xino_bits) {
1317 /*
1318 * This is a roundup of number of bits needed for numlowerfs+1
1319 * (i.e. ilog2(numlowerfs+1 - 1) + 1). fsid 0 is reserved for
1320 * upper fs even with non upper overlay.
1321 */
1322 BUILD_BUG_ON(ilog2(OVL_MAX_STACK) > 31);
1323 ofs->xino_bits = ilog2(ofs->numlowerfs) + 1;
1324 }
1325
1326 if (ofs->xino_bits) {
1327 pr_info("overlayfs: \"xino\" feature enabled using %d upper inode bits.\n",
1328 ofs->xino_bits);
1329 }
Amir Goldsteine487d882017-11-07 13:55:04 +02001330
Miklos Szeredi520d7c82017-11-10 09:39:15 +01001331 err = 0;
1332out:
1333 return err;
1334}
1335
Miklos Szeredi4155c102017-11-10 09:39:15 +01001336static struct ovl_entry *ovl_get_lowerstack(struct super_block *sb,
Miklos Szerediad204482017-11-10 09:39:16 +01001337 struct ovl_fs *ofs)
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001338{
1339 int err;
1340 char *lowertmp, *lower;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001341 struct path *stack = NULL;
1342 unsigned int stacklen, numlower = 0, i;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001343 bool remote = false;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001344 struct ovl_entry *oe;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001345
1346 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001347 lowertmp = kstrdup(ofs->config.lowerdir, GFP_KERNEL);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001348 if (!lowertmp)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001349 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001350
1351 err = -EINVAL;
1352 stacklen = ovl_split_lowerdirs(lowertmp);
1353 if (stacklen > OVL_MAX_STACK) {
1354 pr_err("overlayfs: too many lower directories, limit is %d\n",
1355 OVL_MAX_STACK);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001356 goto out_err;
Miklos Szerediad204482017-11-10 09:39:16 +01001357 } else if (!ofs->config.upperdir && stacklen == 1) {
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001358 pr_err("overlayfs: at least 2 lowerdir are needed while upperdir nonexistent\n");
Miklos Szeredi4155c102017-11-10 09:39:15 +01001359 goto out_err;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001360 } else if (!ofs->config.upperdir && ofs->config.nfs_export &&
1361 ofs->config.redirect_follow) {
1362 pr_warn("overlayfs: NFS export requires \"redirect_dir=nofollow\" on non-upper mount, falling back to nfs_export=off.\n");
1363 ofs->config.nfs_export = false;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001364 }
1365
1366 err = -ENOMEM;
1367 stack = kcalloc(stacklen, sizeof(struct path), GFP_KERNEL);
1368 if (!stack)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001369 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001370
1371 err = -EINVAL;
1372 lower = lowertmp;
1373 for (numlower = 0; numlower < stacklen; numlower++) {
Miklos Szerediad204482017-11-10 09:39:16 +01001374 err = ovl_lower_dir(lower, &stack[numlower], ofs,
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001375 &sb->s_stack_depth, &remote);
1376 if (err)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001377 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001378
1379 lower = strchr(lower, '\0') + 1;
1380 }
1381
1382 err = -EINVAL;
1383 sb->s_stack_depth++;
1384 if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
1385 pr_err("overlayfs: maximum fs stacking depth exceeded\n");
Miklos Szeredi4155c102017-11-10 09:39:15 +01001386 goto out_err;
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001387 }
1388
Miklos Szerediad204482017-11-10 09:39:16 +01001389 err = ovl_get_lower_layers(ofs, stack, numlower);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001390 if (err)
1391 goto out_err;
1392
1393 err = -ENOMEM;
1394 oe = ovl_alloc_entry(numlower);
1395 if (!oe)
1396 goto out_err;
1397
1398 for (i = 0; i < numlower; i++) {
1399 oe->lowerstack[i].dentry = dget(stack[i].dentry);
Miklos Szerediad204482017-11-10 09:39:16 +01001400 oe->lowerstack[i].layer = &ofs->lower_layers[i];
Miklos Szeredi4155c102017-11-10 09:39:15 +01001401 }
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001402
1403 if (remote)
1404 sb->s_d_op = &ovl_reval_dentry_operations;
1405 else
1406 sb->s_d_op = &ovl_dentry_operations;
1407
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001408out:
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001409 for (i = 0; i < numlower; i++)
1410 path_put(&stack[i]);
1411 kfree(stack);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001412 kfree(lowertmp);
1413
1414 return oe;
1415
1416out_err:
1417 oe = ERR_PTR(err);
Miklos Szeredi53dbb0b2017-11-09 10:23:28 +01001418 goto out;
1419}
1420
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001421static int ovl_fill_super(struct super_block *sb, void *data, int silent)
1422{
Kees Cook33006cd2017-03-29 14:02:19 -07001423 struct path upperpath = { };
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001424 struct dentry *root_dentry;
Miklos Szeredi4155c102017-11-10 09:39:15 +01001425 struct ovl_entry *oe;
Miklos Szerediad204482017-11-10 09:39:16 +01001426 struct ovl_fs *ofs;
Konstantin Khlebnikov51f8f3c2017-01-10 21:30:21 +03001427 struct cred *cred;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001428 int err;
1429
Erez Zadokf45827e82014-10-24 00:14:38 +02001430 err = -ENOMEM;
Miklos Szerediad204482017-11-10 09:39:16 +01001431 ofs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
1432 if (!ofs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001433 goto out;
1434
Miklos Szerediad204482017-11-10 09:39:16 +01001435 ofs->creator_cred = cred = prepare_creds();
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001436 if (!cred)
1437 goto out_err;
1438
Miklos Szerediad204482017-11-10 09:39:16 +01001439 ofs->config.index = ovl_index_def;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001440 ofs->config.nfs_export = ovl_nfs_export_def;
Amir Goldstein795939a2018-03-29 09:08:18 +03001441 ofs->config.xino = ovl_xino_def();
Vivek Goyald5791042018-05-11 11:49:27 -04001442 ofs->config.metacopy = ovl_metacopy_def;
Miklos Szerediad204482017-11-10 09:39:16 +01001443 err = ovl_parse_opt((char *) data, &ofs->config);
Erez Zadokf45827e82014-10-24 00:14:38 +02001444 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001445 goto out_err;
Erez Zadokf45827e82014-10-24 00:14:38 +02001446
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001447 err = -EINVAL;
Miklos Szerediad204482017-11-10 09:39:16 +01001448 if (!ofs->config.lowerdir) {
Konstantin Khlebnikov07f2af72015-06-29 20:18:56 +03001449 if (!silent)
1450 pr_err("overlayfs: missing 'lowerdir'\n");
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001451 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001452 }
1453
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001454 sb->s_stack_depth = 0;
Miklos Szeredicf9a6782015-12-11 16:30:49 +01001455 sb->s_maxbytes = MAX_LFS_FILESIZE;
Amir Goldsteine487d882017-11-07 13:55:04 +02001456 /* Assume underlaying fs uses 32bit inodes unless proven otherwise */
Amir Goldstein795939a2018-03-29 09:08:18 +03001457 if (ofs->config.xino != OVL_XINO_OFF)
1458 ofs->xino_bits = BITS_PER_LONG - 32;
1459
Miklos Szerediad204482017-11-10 09:39:16 +01001460 if (ofs->config.upperdir) {
1461 if (!ofs->config.workdir) {
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001462 pr_err("overlayfs: missing 'workdir'\n");
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001463 goto out_err;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +01001464 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001465
Miklos Szerediad204482017-11-10 09:39:16 +01001466 err = ovl_get_upper(ofs, &upperpath);
Miklos Szeredi21a3b312017-11-09 10:23:28 +01001467 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001468 goto out_err;
Miklos Szeredid719e8f2016-07-29 12:05:23 +02001469
Miklos Szerediad204482017-11-10 09:39:16 +01001470 err = ovl_get_workdir(ofs, &upperpath);
Miklos Szeredi8ed61dc2017-11-09 10:23:28 +01001471 if (err)
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001472 goto out_err;
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001473
Miklos Szerediad204482017-11-10 09:39:16 +01001474 if (!ofs->workdir)
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001475 sb->s_flags |= SB_RDONLY;
Miklos Szeredi6e882562017-11-10 09:39:15 +01001476
Miklos Szerediad204482017-11-10 09:39:16 +01001477 sb->s_stack_depth = ofs->upper_mnt->mnt_sb->s_stack_depth;
1478 sb->s_time_gran = ofs->upper_mnt->mnt_sb->s_time_gran;
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001479
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001480 }
Miklos Szerediad204482017-11-10 09:39:16 +01001481 oe = ovl_get_lowerstack(sb, ofs);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001482 err = PTR_ERR(oe);
1483 if (IS_ERR(oe))
Miklos Szeredia9075cd2017-11-10 09:39:15 +01001484 goto out_err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001485
hujianyang71cbad72015-01-15 13:20:57 +08001486 /* If the upper fs is nonexistent, we mark overlayfs r/o too */
Miklos Szerediad204482017-11-10 09:39:16 +01001487 if (!ofs->upper_mnt)
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001488 sb->s_flags |= SB_RDONLY;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001489
Miklos Szerediad204482017-11-10 09:39:16 +01001490 if (!(ovl_force_readonly(ofs)) && ofs->config.index) {
1491 err = ovl_get_indexdir(ofs, oe, &upperpath);
Amir Goldstein54fb3472017-06-21 15:28:38 +03001492 if (err)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001493 goto out_free_oe;
Miklos Szeredi6e882562017-11-10 09:39:15 +01001494
Amir Goldstein972d0092017-09-19 12:14:18 +03001495 /* Force r/o mount with no index dir */
1496 if (!ofs->indexdir) {
1497 dput(ofs->workdir);
1498 ofs->workdir = NULL;
Linus Torvalds1751e8a2017-11-27 13:05:09 -08001499 sb->s_flags |= SB_RDONLY;
Amir Goldstein972d0092017-09-19 12:14:18 +03001500 }
1501
Amir Goldstein02bcd152017-06-21 15:28:36 +03001502 }
1503
Amir Goldstein972d0092017-09-19 12:14:18 +03001504 /* Show index=off in /proc/mounts for forced r/o mount */
Amir Goldsteinf168f102018-01-19 11:26:53 +02001505 if (!ofs->indexdir) {
Miklos Szerediad204482017-11-10 09:39:16 +01001506 ofs->config.index = false;
Amir Goldsteinf168f102018-01-19 11:26:53 +02001507 if (ofs->upper_mnt && ofs->config.nfs_export) {
1508 pr_warn("overlayfs: NFS export requires an index dir, falling back to nfs_export=off.\n");
1509 ofs->config.nfs_export = false;
1510 }
1511 }
Amir Goldstein02bcd152017-06-21 15:28:36 +03001512
Vivek Goyald5791042018-05-11 11:49:27 -04001513 if (ofs->config.metacopy && ofs->config.nfs_export) {
1514 pr_warn("overlayfs: NFS export is not supported with metadata only copy up, falling back to nfs_export=off.\n");
1515 ofs->config.nfs_export = false;
1516 }
1517
Amir Goldstein8383f172017-10-02 11:31:42 +03001518 if (ofs->config.nfs_export)
1519 sb->s_export_op = &ovl_export_operations;
1520
Konstantin Khlebnikov51f8f3c2017-01-10 21:30:21 +03001521 /* Never override disk quota limits or use reserved space */
1522 cap_lower(cred->cap_effective, CAP_SYS_RESOURCE);
1523
Vivek Goyal655042c2016-10-14 03:03:36 +02001524 sb->s_magic = OVERLAYFS_SUPER_MAGIC;
1525 sb->s_op = &ovl_super_operations;
1526 sb->s_xattr = ovl_xattr_handlers;
Miklos Szerediad204482017-11-10 09:39:16 +01001527 sb->s_fs_info = ofs;
Miklos Szeredide2a4a52018-07-18 15:44:43 +02001528 sb->s_flags |= SB_POSIXACL;
Vivek Goyal655042c2016-10-14 03:03:36 +02001529
Miklos Szeredic6fe6252017-11-10 09:39:15 +01001530 err = -ENOMEM;
Miklos Szeredica4c8a32016-12-16 11:02:55 +01001531 root_dentry = d_make_root(ovl_new_inode(sb, S_IFDIR, 0));
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001532 if (!root_dentry)
Miklos Szeredi4155c102017-11-10 09:39:15 +01001533 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001534
Amir Goldsteinc62520a2018-01-14 19:25:31 +02001535 root_dentry->d_fsdata = oe;
1536
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001537 mntput(upperpath.mnt);
Amir Goldsteinf3a15682017-05-24 15:29:33 +03001538 if (upperpath.dentry) {
Amir Goldsteinc62520a2018-01-14 19:25:31 +02001539 ovl_dentry_set_upper_alias(root_dentry);
Miklos Szeredi13c72072017-07-04 22:03:16 +02001540 if (ovl_is_impuredir(upperpath.dentry))
1541 ovl_set_flag(OVL_IMPURE, d_inode(root_dentry));
Amir Goldsteinf3a15682017-05-24 15:29:33 +03001542 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001543
Amir Goldsteinb79e05a2017-06-25 16:37:17 +03001544 /* Root is always merge -> can have whiteouts */
1545 ovl_set_flag(OVL_WHITEOUTS, d_inode(root_dentry));
Amir Goldstein2ca3c142018-01-30 13:31:09 +02001546 ovl_dentry_set_flag(OVL_E_CONNECTED, root_dentry);
Vivek Goyal0c288872018-05-11 11:49:28 -04001547 ovl_set_upperdata(d_inode(root_dentry));
Miklos Szeredi09d8b582017-07-04 22:03:16 +02001548 ovl_inode_init(d_inode(root_dentry), upperpath.dentry,
Vivek Goyal2664bd02018-05-11 11:49:30 -04001549 ovl_dentry_lower(root_dentry), NULL);
Miklos Szeredied06e062015-12-09 16:11:59 +01001550
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001551 sb->s_root = root_dentry;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001552
1553 return 0;
1554
Miklos Szeredi4155c102017-11-10 09:39:15 +01001555out_free_oe:
1556 ovl_entry_stack_free(oe);
Chandan Rajendrab9343632017-07-24 01:57:54 -05001557 kfree(oe);
Miklos Szeredi4155c102017-11-10 09:39:15 +01001558out_err:
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001559 path_put(&upperpath);
Miklos Szerediad204482017-11-10 09:39:16 +01001560 ovl_free_fs(ofs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001561out:
1562 return err;
1563}
1564
1565static struct dentry *ovl_mount(struct file_system_type *fs_type, int flags,
1566 const char *dev_name, void *raw_data)
1567{
1568 return mount_nodev(fs_type, flags, raw_data, ovl_fill_super);
1569}
1570
1571static struct file_system_type ovl_fs_type = {
1572 .owner = THIS_MODULE,
Miklos Szeredief94b182014-11-20 16:39:59 +01001573 .name = "overlay",
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001574 .mount = ovl_mount,
1575 .kill_sb = kill_anon_super,
1576};
Miklos Szeredief94b182014-11-20 16:39:59 +01001577MODULE_ALIAS_FS("overlay");
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001578
Amir Goldstein13cf1992017-06-12 09:54:40 +03001579static void ovl_inode_init_once(void *foo)
1580{
1581 struct ovl_inode *oi = foo;
1582
1583 inode_init_once(&oi->vfs_inode);
1584}
1585
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001586static int __init ovl_init(void)
1587{
Amir Goldstein13cf1992017-06-12 09:54:40 +03001588 int err;
1589
1590 ovl_inode_cachep = kmem_cache_create("ovl_inode",
1591 sizeof(struct ovl_inode), 0,
1592 (SLAB_RECLAIM_ACCOUNT|
1593 SLAB_MEM_SPREAD|SLAB_ACCOUNT),
1594 ovl_inode_init_once);
1595 if (ovl_inode_cachep == NULL)
1596 return -ENOMEM;
1597
1598 err = register_filesystem(&ovl_fs_type);
1599 if (err)
1600 kmem_cache_destroy(ovl_inode_cachep);
1601
1602 return err;
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001603}
1604
1605static void __exit ovl_exit(void)
1606{
1607 unregister_filesystem(&ovl_fs_type);
Amir Goldstein13cf1992017-06-12 09:54:40 +03001608
1609 /*
1610 * Make sure all delayed rcu free inodes are flushed before we
1611 * destroy cache.
1612 */
1613 rcu_barrier();
1614 kmem_cache_destroy(ovl_inode_cachep);
1615
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001616}
1617
1618module_init(ovl_init);
1619module_exit(ovl_exit);