blob: bf8537c7f455207830046a50d67d394f86d37f4a [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
10#include <linux/fs.h>
11#include <linux/namei.h>
12#include <linux/xattr.h>
13#include <linux/security.h>
14#include <linux/mount.h>
15#include <linux/slab.h>
16#include <linux/parser.h>
17#include <linux/module.h>
18#include <linux/sched.h>
Andy Whitcroftcc259632014-10-24 00:14:38 +020019#include <linux/statfs.h>
Erez Zadokf45827e82014-10-24 00:14:38 +020020#include <linux/seq_file.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 Szeredief94b182014-11-20 16:39:59 +010027#define OVERLAYFS_SUPER_MAGIC 0x794c7630
Andy Whitcroftcc259632014-10-24 00:14:38 +020028
Erez Zadokf45827e82014-10-24 00:14:38 +020029struct ovl_config {
30 char *lowerdir;
31 char *upperdir;
32 char *workdir;
33};
34
Miklos Szeredie9be9d52014-10-24 00:14:38 +020035/* private information held for overlayfs's superblock */
36struct ovl_fs {
37 struct vfsmount *upper_mnt;
Miklos Szeredidd662662014-12-13 00:59:43 +010038 unsigned numlower;
39 struct vfsmount **lower_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020040 struct dentry *workdir;
Andy Whitcroftcc259632014-10-24 00:14:38 +020041 long lower_namelen;
Erez Zadokf45827e82014-10-24 00:14:38 +020042 /* pathnames of lower and upper dirs, for show_options */
43 struct ovl_config config;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020044};
45
46struct ovl_dir_cache;
47
48/* private information held for every overlayfs dentry */
49struct ovl_entry {
50 struct dentry *__upperdentry;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020051 struct ovl_dir_cache *cache;
52 union {
53 struct {
54 u64 version;
55 bool opaque;
56 };
57 struct rcu_head rcu;
58 };
Miklos Szeredidd662662014-12-13 00:59:43 +010059 unsigned numlower;
60 struct path lowerstack[];
Miklos Szeredie9be9d52014-10-24 00:14:38 +020061};
62
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +010063#define OVL_MAX_STACK 500
64
Miklos Szeredidd662662014-12-13 00:59:43 +010065static struct dentry *__ovl_dentry_lower(struct ovl_entry *oe)
66{
67 return oe->numlower ? oe->lowerstack[0].dentry : NULL;
68}
Miklos Szeredie9be9d52014-10-24 00:14:38 +020069
70enum ovl_path_type ovl_path_type(struct dentry *dentry)
71{
72 struct ovl_entry *oe = dentry->d_fsdata;
Miklos Szeredi1afaba12014-12-13 00:59:42 +010073 enum ovl_path_type type = 0;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020074
75 if (oe->__upperdentry) {
Miklos Szeredi1afaba12014-12-13 00:59:42 +010076 type = __OVL_PATH_UPPER;
77
Miklos Szeredidd662662014-12-13 00:59:43 +010078 if (oe->numlower) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +020079 if (S_ISDIR(dentry->d_inode->i_mode))
Miklos Szeredi1afaba12014-12-13 00:59:42 +010080 type |= __OVL_PATH_MERGE;
81 } else if (!oe->opaque) {
82 type |= __OVL_PATH_PURE;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020083 }
Miklos Szeredi9d7459d2014-12-13 00:59:44 +010084 } else {
85 if (oe->numlower > 1)
86 type |= __OVL_PATH_MERGE;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020087 }
Miklos Szeredi1afaba12014-12-13 00:59:42 +010088 return type;
Miklos Szeredie9be9d52014-10-24 00:14:38 +020089}
90
91static struct dentry *ovl_upperdentry_dereference(struct ovl_entry *oe)
92{
Miklos Szeredi71d50922014-11-20 16:40:01 +010093 return lockless_dereference(oe->__upperdentry);
Miklos Szeredie9be9d52014-10-24 00:14:38 +020094}
95
96void ovl_path_upper(struct dentry *dentry, struct path *path)
97{
98 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
99 struct ovl_entry *oe = dentry->d_fsdata;
100
101 path->mnt = ofs->upper_mnt;
102 path->dentry = ovl_upperdentry_dereference(oe);
103}
104
105enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path)
106{
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200107 enum ovl_path_type type = ovl_path_type(dentry);
108
Miklos Szeredi1afaba12014-12-13 00:59:42 +0100109 if (!OVL_TYPE_UPPER(type))
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200110 ovl_path_lower(dentry, path);
111 else
112 ovl_path_upper(dentry, path);
113
114 return type;
115}
116
117struct dentry *ovl_dentry_upper(struct dentry *dentry)
118{
119 struct ovl_entry *oe = dentry->d_fsdata;
120
121 return ovl_upperdentry_dereference(oe);
122}
123
124struct dentry *ovl_dentry_lower(struct dentry *dentry)
125{
126 struct ovl_entry *oe = dentry->d_fsdata;
127
Miklos Szeredidd662662014-12-13 00:59:43 +0100128 return __ovl_dentry_lower(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200129}
130
131struct dentry *ovl_dentry_real(struct dentry *dentry)
132{
133 struct ovl_entry *oe = dentry->d_fsdata;
134 struct dentry *realdentry;
135
136 realdentry = ovl_upperdentry_dereference(oe);
137 if (!realdentry)
Miklos Szeredidd662662014-12-13 00:59:43 +0100138 realdentry = __ovl_dentry_lower(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200139
140 return realdentry;
141}
142
143struct dentry *ovl_entry_real(struct ovl_entry *oe, bool *is_upper)
144{
145 struct dentry *realdentry;
146
147 realdentry = ovl_upperdentry_dereference(oe);
148 if (realdentry) {
149 *is_upper = true;
150 } else {
Miklos Szeredidd662662014-12-13 00:59:43 +0100151 realdentry = __ovl_dentry_lower(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200152 *is_upper = false;
153 }
154 return realdentry;
155}
156
157struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry)
158{
159 struct ovl_entry *oe = dentry->d_fsdata;
160
161 return oe->cache;
162}
163
164void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache)
165{
166 struct ovl_entry *oe = dentry->d_fsdata;
167
168 oe->cache = cache;
169}
170
171void ovl_path_lower(struct dentry *dentry, struct path *path)
172{
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200173 struct ovl_entry *oe = dentry->d_fsdata;
174
Miklos Szeredidd662662014-12-13 00:59:43 +0100175 *path = oe->numlower ? oe->lowerstack[0] : (struct path) { NULL, NULL };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200176}
177
178int ovl_want_write(struct dentry *dentry)
179{
180 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
181 return mnt_want_write(ofs->upper_mnt);
182}
183
184void ovl_drop_write(struct dentry *dentry)
185{
186 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
187 mnt_drop_write(ofs->upper_mnt);
188}
189
190struct dentry *ovl_workdir(struct dentry *dentry)
191{
192 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
193 return ofs->workdir;
194}
195
196bool ovl_dentry_is_opaque(struct dentry *dentry)
197{
198 struct ovl_entry *oe = dentry->d_fsdata;
199 return oe->opaque;
200}
201
202void ovl_dentry_set_opaque(struct dentry *dentry, bool opaque)
203{
204 struct ovl_entry *oe = dentry->d_fsdata;
205 oe->opaque = opaque;
206}
207
208void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry)
209{
210 struct ovl_entry *oe = dentry->d_fsdata;
211
212 WARN_ON(!mutex_is_locked(&upperdentry->d_parent->d_inode->i_mutex));
213 WARN_ON(oe->__upperdentry);
214 BUG_ON(!upperdentry->d_inode);
215 /*
216 * Make sure upperdentry is consistent before making it visible to
217 * ovl_upperdentry_dereference().
218 */
219 smp_wmb();
220 oe->__upperdentry = upperdentry;
221}
222
223void ovl_dentry_version_inc(struct dentry *dentry)
224{
225 struct ovl_entry *oe = dentry->d_fsdata;
226
227 WARN_ON(!mutex_is_locked(&dentry->d_inode->i_mutex));
228 oe->version++;
229}
230
231u64 ovl_dentry_version_get(struct dentry *dentry)
232{
233 struct ovl_entry *oe = dentry->d_fsdata;
234
235 WARN_ON(!mutex_is_locked(&dentry->d_inode->i_mutex));
236 return oe->version;
237}
238
239bool ovl_is_whiteout(struct dentry *dentry)
240{
241 struct inode *inode = dentry->d_inode;
242
243 return inode && IS_WHITEOUT(inode);
244}
245
246static bool ovl_is_opaquedir(struct dentry *dentry)
247{
248 int res;
249 char val;
250 struct inode *inode = dentry->d_inode;
251
252 if (!S_ISDIR(inode->i_mode) || !inode->i_op->getxattr)
253 return false;
254
hujianyangcead89b2014-11-24 18:25:21 +0800255 res = inode->i_op->getxattr(dentry, OVL_XATTR_OPAQUE, &val, 1);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200256 if (res == 1 && val == 'y')
257 return true;
258
259 return false;
260}
261
262static void ovl_dentry_release(struct dentry *dentry)
263{
264 struct ovl_entry *oe = dentry->d_fsdata;
265
266 if (oe) {
Miklos Szeredidd662662014-12-13 00:59:43 +0100267 unsigned int i;
268
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200269 dput(oe->__upperdentry);
Miklos Szeredidd662662014-12-13 00:59:43 +0100270 for (i = 0; i < oe->numlower; i++)
271 dput(oe->lowerstack[i].dentry);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200272 kfree_rcu(oe, rcu);
273 }
274}
275
276static const struct dentry_operations ovl_dentry_operations = {
277 .d_release = ovl_dentry_release,
278};
279
Miklos Szeredidd662662014-12-13 00:59:43 +0100280static struct ovl_entry *ovl_alloc_entry(unsigned int numlower)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200281{
Miklos Szeredidd662662014-12-13 00:59:43 +0100282 size_t size = offsetof(struct ovl_entry, lowerstack[numlower]);
283 struct ovl_entry *oe = kzalloc(size, GFP_KERNEL);
284
285 if (oe)
286 oe->numlower = numlower;
287
288 return oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200289}
290
291static inline struct dentry *ovl_lookup_real(struct dentry *dir,
292 struct qstr *name)
293{
294 struct dentry *dentry;
295
296 mutex_lock(&dir->d_inode->i_mutex);
297 dentry = lookup_one_len(name->name, dir, name->len);
298 mutex_unlock(&dir->d_inode->i_mutex);
299
300 if (IS_ERR(dentry)) {
301 if (PTR_ERR(dentry) == -ENOENT)
302 dentry = NULL;
303 } else if (!dentry->d_inode) {
304 dput(dentry);
305 dentry = NULL;
306 }
307 return dentry;
308}
309
Miklos Szeredi5ef88da2014-12-13 00:59:43 +0100310/*
311 * Returns next layer in stack starting from top.
312 * Returns -1 if this is the last layer.
313 */
314int ovl_path_next(int idx, struct dentry *dentry, struct path *path)
315{
316 struct ovl_entry *oe = dentry->d_fsdata;
317
318 BUG_ON(idx < 0);
319 if (idx == 0) {
320 ovl_path_upper(dentry, path);
321 if (path->dentry)
322 return oe->numlower ? 1 : -1;
323 idx++;
324 }
325 BUG_ON(idx > oe->numlower);
326 *path = oe->lowerstack[idx - 1];
327
328 return (idx < oe->numlower) ? idx + 1 : -1;
329}
330
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200331struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
332 unsigned int flags)
333{
334 struct ovl_entry *oe;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100335 struct ovl_entry *poe = dentry->d_parent->d_fsdata;
336 struct path *stack = NULL;
337 struct dentry *upperdir, *upperdentry = NULL;
338 unsigned int ctr = 0;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200339 struct inode *inode = NULL;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100340 bool upperopaque = false;
341 struct dentry *this, *prev = NULL;
342 unsigned int i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200343 int err;
344
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100345 upperdir = ovl_upperdentry_dereference(poe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200346 if (upperdir) {
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100347 this = ovl_lookup_real(upperdir, &dentry->d_name);
348 err = PTR_ERR(this);
349 if (IS_ERR(this))
350 goto out;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200351
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100352 if (this) {
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100353 if (ovl_is_whiteout(this)) {
354 dput(this);
355 this = NULL;
356 upperopaque = true;
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100357 } else if (poe->numlower && ovl_is_opaquedir(this)) {
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100358 upperopaque = true;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200359 }
360 }
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100361 upperdentry = prev = this;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200362 }
363
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100364 if (!upperopaque && poe->numlower) {
365 err = -ENOMEM;
366 stack = kcalloc(poe->numlower, sizeof(struct path), GFP_KERNEL);
367 if (!stack)
368 goto out_put_upper;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200369 }
370
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100371 for (i = 0; !upperopaque && i < poe->numlower; i++) {
372 bool opaque = false;
373 struct path lowerpath = poe->lowerstack[i];
374
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100375 this = ovl_lookup_real(lowerpath.dentry, &dentry->d_name);
376 err = PTR_ERR(this);
Miklos Szeredi09e10322014-12-13 00:59:45 +0100377 if (IS_ERR(this)) {
378 /*
379 * If it's positive, then treat ENAMETOOLONG as ENOENT.
380 */
381 if (err == -ENAMETOOLONG && (upperdentry || ctr))
382 continue;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100383 goto out_put;
Miklos Szeredi09e10322014-12-13 00:59:45 +0100384 }
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100385 if (!this)
386 continue;
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100387 if (ovl_is_whiteout(this)) {
388 dput(this);
389 break;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100390 }
391 /*
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100392 * Only makes sense to check opaque dir if this is not the
393 * lowermost layer.
394 */
395 if (i < poe->numlower - 1 && ovl_is_opaquedir(this))
396 opaque = true;
hujianyanga425c032015-01-06 16:10:01 +0800397
398 if (prev && (!S_ISDIR(prev->d_inode->i_mode) ||
399 !S_ISDIR(this->d_inode->i_mode))) {
400 /*
401 * FIXME: check for upper-opaqueness maybe better done
402 * in remove code.
403 */
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100404 if (prev == upperdentry)
405 upperopaque = true;
406 dput(this);
407 break;
408 }
hujianyanga425c032015-01-06 16:10:01 +0800409 /*
410 * If this is a non-directory then stop here.
411 */
412 if (!S_ISDIR(this->d_inode->i_mode))
413 opaque = true;
414
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100415 stack[ctr].dentry = this;
416 stack[ctr].mnt = lowerpath.mnt;
417 ctr++;
418 prev = this;
419 if (opaque)
420 break;
421 }
422
423 oe = ovl_alloc_entry(ctr);
424 err = -ENOMEM;
425 if (!oe)
426 goto out_put;
427
428 if (upperdentry || ctr) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200429 struct dentry *realdentry;
430
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100431 realdentry = upperdentry ? upperdentry : stack[0].dentry;
432
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200433 err = -ENOMEM;
434 inode = ovl_new_inode(dentry->d_sb, realdentry->d_inode->i_mode,
435 oe);
436 if (!inode)
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100437 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200438 ovl_copyattr(realdentry->d_inode, inode);
439 }
440
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100441 oe->opaque = upperopaque;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200442 oe->__upperdentry = upperdentry;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100443 memcpy(oe->lowerstack, stack, sizeof(struct path) * ctr);
444 kfree(stack);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200445 dentry->d_fsdata = oe;
446 d_add(dentry, inode);
447
448 return NULL;
449
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100450out_free_oe:
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200451 kfree(oe);
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100452out_put:
453 for (i = 0; i < ctr; i++)
454 dput(stack[i].dentry);
455 kfree(stack);
456out_put_upper:
457 dput(upperdentry);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200458out:
459 return ERR_PTR(err);
460}
461
462struct file *ovl_path_open(struct path *path, int flags)
463{
464 return dentry_open(path, flags, current_cred());
465}
466
467static void ovl_put_super(struct super_block *sb)
468{
469 struct ovl_fs *ufs = sb->s_fs_info;
Miklos Szeredidd662662014-12-13 00:59:43 +0100470 unsigned i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200471
472 dput(ufs->workdir);
473 mntput(ufs->upper_mnt);
Miklos Szeredidd662662014-12-13 00:59:43 +0100474 for (i = 0; i < ufs->numlower; i++)
475 mntput(ufs->lower_mnt[i]);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200476
Erez Zadokf45827e82014-10-24 00:14:38 +0200477 kfree(ufs->config.lowerdir);
478 kfree(ufs->config.upperdir);
479 kfree(ufs->config.workdir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200480 kfree(ufs);
481}
482
Andy Whitcroftcc259632014-10-24 00:14:38 +0200483/**
484 * ovl_statfs
485 * @sb: The overlayfs super block
486 * @buf: The struct kstatfs to fill in with stats
487 *
488 * Get the filesystem statistics. As writes always target the upper layer
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100489 * filesystem pass the statfs to the upper filesystem (if it exists)
Andy Whitcroftcc259632014-10-24 00:14:38 +0200490 */
491static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
492{
493 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
494 struct dentry *root_dentry = dentry->d_sb->s_root;
495 struct path path;
496 int err;
497
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100498 ovl_path_real(root_dentry, &path);
Andy Whitcroftcc259632014-10-24 00:14:38 +0200499
500 err = vfs_statfs(&path, buf);
501 if (!err) {
502 buf->f_namelen = max(buf->f_namelen, ofs->lower_namelen);
503 buf->f_type = OVERLAYFS_SUPER_MAGIC;
504 }
505
506 return err;
507}
508
Erez Zadokf45827e82014-10-24 00:14:38 +0200509/**
510 * ovl_show_options
511 *
512 * Prints the mount options for a given superblock.
513 * Returns zero; does not fail.
514 */
515static int ovl_show_options(struct seq_file *m, struct dentry *dentry)
516{
517 struct super_block *sb = dentry->d_sb;
518 struct ovl_fs *ufs = sb->s_fs_info;
519
520 seq_printf(m, ",lowerdir=%s", ufs->config.lowerdir);
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100521 if (ufs->config.upperdir) {
522 seq_printf(m, ",upperdir=%s", ufs->config.upperdir);
523 seq_printf(m, ",workdir=%s", ufs->config.workdir);
524 }
Erez Zadokf45827e82014-10-24 00:14:38 +0200525 return 0;
526}
527
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900528static int ovl_remount(struct super_block *sb, int *flags, char *data)
529{
530 struct ovl_fs *ufs = sb->s_fs_info;
531
Miklos Szeredicc6f67b2015-05-19 14:30:12 +0200532 if (!(*flags & MS_RDONLY) && (!ufs->upper_mnt || !ufs->workdir))
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900533 return -EROFS;
534
535 return 0;
536}
537
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200538static const struct super_operations ovl_super_operations = {
539 .put_super = ovl_put_super,
Andy Whitcroftcc259632014-10-24 00:14:38 +0200540 .statfs = ovl_statfs,
Erez Zadokf45827e82014-10-24 00:14:38 +0200541 .show_options = ovl_show_options,
Seunghun Lee3cdf6fe2015-01-03 02:26:49 +0900542 .remount_fs = ovl_remount,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200543};
544
545enum {
546 OPT_LOWERDIR,
547 OPT_UPPERDIR,
548 OPT_WORKDIR,
549 OPT_ERR,
550};
551
552static const match_table_t ovl_tokens = {
553 {OPT_LOWERDIR, "lowerdir=%s"},
554 {OPT_UPPERDIR, "upperdir=%s"},
555 {OPT_WORKDIR, "workdir=%s"},
556 {OPT_ERR, NULL}
557};
558
Miklos Szeredi91c77942014-11-20 16:40:00 +0100559static char *ovl_next_opt(char **s)
560{
561 char *sbegin = *s;
562 char *p;
563
564 if (sbegin == NULL)
565 return NULL;
566
567 for (p = sbegin; *p; p++) {
568 if (*p == '\\') {
569 p++;
570 if (!*p)
571 break;
572 } else if (*p == ',') {
573 *p = '\0';
574 *s = p + 1;
575 return sbegin;
576 }
577 }
578 *s = NULL;
579 return sbegin;
580}
581
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200582static int ovl_parse_opt(char *opt, struct ovl_config *config)
583{
584 char *p;
585
Miklos Szeredi91c77942014-11-20 16:40:00 +0100586 while ((p = ovl_next_opt(&opt)) != NULL) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200587 int token;
588 substring_t args[MAX_OPT_ARGS];
589
590 if (!*p)
591 continue;
592
593 token = match_token(p, ovl_tokens, args);
594 switch (token) {
595 case OPT_UPPERDIR:
596 kfree(config->upperdir);
597 config->upperdir = match_strdup(&args[0]);
598 if (!config->upperdir)
599 return -ENOMEM;
600 break;
601
602 case OPT_LOWERDIR:
603 kfree(config->lowerdir);
604 config->lowerdir = match_strdup(&args[0]);
605 if (!config->lowerdir)
606 return -ENOMEM;
607 break;
608
609 case OPT_WORKDIR:
610 kfree(config->workdir);
611 config->workdir = match_strdup(&args[0]);
612 if (!config->workdir)
613 return -ENOMEM;
614 break;
615
616 default:
hujianyangbead55e2015-01-15 13:17:36 +0800617 pr_err("overlayfs: unrecognized mount option \"%s\" or missing value\n", p);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200618 return -EINVAL;
619 }
620 }
hujianyang71cbad72015-01-15 13:20:57 +0800621
622 /* Workdir is useless in non-upper mount */
623 if (!config->upperdir && config->workdir) {
624 pr_info("overlayfs: option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
625 config->workdir);
626 kfree(config->workdir);
627 config->workdir = NULL;
628 }
629
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200630 return 0;
631}
632
633#define OVL_WORKDIR_NAME "work"
634
635static struct dentry *ovl_workdir_create(struct vfsmount *mnt,
636 struct dentry *dentry)
637{
638 struct inode *dir = dentry->d_inode;
639 struct dentry *work;
640 int err;
641 bool retried = false;
642
643 err = mnt_want_write(mnt);
644 if (err)
645 return ERR_PTR(err);
646
647 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
648retry:
649 work = lookup_one_len(OVL_WORKDIR_NAME, dentry,
650 strlen(OVL_WORKDIR_NAME));
651
652 if (!IS_ERR(work)) {
653 struct kstat stat = {
654 .mode = S_IFDIR | 0,
655 };
656
657 if (work->d_inode) {
658 err = -EEXIST;
659 if (retried)
660 goto out_dput;
661
662 retried = true;
663 ovl_cleanup(dir, work);
664 dput(work);
665 goto retry;
666 }
667
668 err = ovl_create_real(dir, work, &stat, NULL, NULL, true);
669 if (err)
670 goto out_dput;
671 }
672out_unlock:
673 mutex_unlock(&dir->i_mutex);
674 mnt_drop_write(mnt);
675
676 return work;
677
678out_dput:
679 dput(work);
680 work = ERR_PTR(err);
681 goto out_unlock;
682}
683
Miklos Szeredi91c77942014-11-20 16:40:00 +0100684static void ovl_unescape(char *s)
685{
686 char *d = s;
687
688 for (;; s++, d++) {
689 if (*s == '\\')
690 s++;
691 *d = *s;
692 if (!*s)
693 break;
694 }
695}
696
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200697static bool ovl_is_allowed_fs_type(struct dentry *root)
698{
699 const struct dentry_operations *dop = root->d_op;
700
701 /*
702 * We don't support:
703 * - automount filesystems
704 * - filesystems with revalidate (FIXME for lower layer)
705 * - filesystems with case insensitive names
706 */
707 if (dop &&
708 (dop->d_manage || dop->d_automount ||
709 dop->d_revalidate || dop->d_weak_revalidate ||
710 dop->d_compare || dop->d_hash)) {
711 return false;
712 }
713 return true;
714}
715
Miklos Szerediab508822014-12-13 00:59:49 +0100716static int ovl_mount_dir_noesc(const char *name, struct path *path)
717{
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100718 int err = -EINVAL;
Miklos Szerediab508822014-12-13 00:59:49 +0100719
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100720 if (!*name) {
721 pr_err("overlayfs: empty lowerdir\n");
722 goto out;
723 }
Miklos Szerediab508822014-12-13 00:59:49 +0100724 err = kern_path(name, LOOKUP_FOLLOW, path);
725 if (err) {
726 pr_err("overlayfs: failed to resolve '%s': %i\n", name, err);
727 goto out;
728 }
729 err = -EINVAL;
730 if (!ovl_is_allowed_fs_type(path->dentry)) {
731 pr_err("overlayfs: filesystem on '%s' not supported\n", name);
732 goto out_put;
733 }
734 if (!S_ISDIR(path->dentry->d_inode->i_mode)) {
735 pr_err("overlayfs: '%s' not a directory\n", name);
736 goto out_put;
737 }
738 return 0;
739
740out_put:
741 path_put(path);
742out:
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);
754 kfree(tmp);
755 }
756 return err;
757}
758
759static int ovl_lower_dir(const char *name, struct path *path, long *namelen,
760 int *stack_depth)
761{
762 int err;
763 struct kstatfs statfs;
764
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100765 err = ovl_mount_dir_noesc(name, path);
Miklos Szerediab508822014-12-13 00:59:49 +0100766 if (err)
767 goto out;
768
769 err = vfs_statfs(path, &statfs);
770 if (err) {
771 pr_err("overlayfs: statfs failed on '%s'\n", name);
772 goto out_put;
773 }
774 *namelen = max(*namelen, statfs.f_namelen);
775 *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
776
777 return 0;
778
779out_put:
780 path_put(path);
781out:
782 return err;
783}
784
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200785/* Workdir should not be subdir of upperdir and vice versa */
786static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
787{
788 bool ok = false;
789
790 if (workdir != upperdir) {
791 ok = (lock_rename(workdir, upperdir) == NULL);
792 unlock_rename(workdir, upperdir);
793 }
794 return ok;
795}
796
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100797static unsigned int ovl_split_lowerdirs(char *str)
798{
799 unsigned int ctr = 1;
800 char *s, *d;
801
802 for (s = d = str;; s++, d++) {
803 if (*s == '\\') {
804 s++;
805 } else if (*s == ':') {
806 *d = '\0';
807 ctr++;
808 continue;
809 }
810 *d = *s;
811 if (!*s)
812 break;
813 }
814 return ctr;
815}
816
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200817static int ovl_fill_super(struct super_block *sb, void *data, int silent)
818{
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100819 struct path upperpath = { NULL, NULL };
820 struct path workpath = { NULL, NULL };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200821 struct dentry *root_dentry;
822 struct ovl_entry *oe;
823 struct ovl_fs *ufs;
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100824 struct path *stack = NULL;
825 char *lowertmp;
826 char *lower;
827 unsigned int numlower;
828 unsigned int stacklen = 0;
Miklos Szeredidd662662014-12-13 00:59:43 +0100829 unsigned int i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200830 int err;
831
Erez Zadokf45827e82014-10-24 00:14:38 +0200832 err = -ENOMEM;
833 ufs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
834 if (!ufs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200835 goto out;
836
Erez Zadokf45827e82014-10-24 00:14:38 +0200837 err = ovl_parse_opt((char *) data, &ufs->config);
838 if (err)
839 goto out_free_config;
840
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200841 err = -EINVAL;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100842 if (!ufs->config.lowerdir) {
843 pr_err("overlayfs: missing 'lowerdir'\n");
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200844 goto out_free_config;
845 }
846
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100847 sb->s_stack_depth = 0;
848 if (ufs->config.upperdir) {
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100849 if (!ufs->config.workdir) {
850 pr_err("overlayfs: missing 'workdir'\n");
851 goto out_free_config;
852 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200853
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100854 err = ovl_mount_dir(ufs->config.upperdir, &upperpath);
855 if (err)
856 goto out_free_config;
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100857
hujianyang71cbad72015-01-15 13:20:57 +0800858 /* Upper fs should not be r/o */
859 if (upperpath.mnt->mnt_sb->s_flags & MS_RDONLY) {
860 pr_err("overlayfs: upper fs is r/o, try multi-lower layers mount\n");
861 err = -EINVAL;
862 goto out_put_upperpath;
863 }
864
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100865 err = ovl_mount_dir(ufs->config.workdir, &workpath);
866 if (err)
867 goto out_put_upperpath;
868
hujianyang2f83fd82015-01-06 12:52:13 +0800869 err = -EINVAL;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100870 if (upperpath.mnt != workpath.mnt) {
871 pr_err("overlayfs: workdir and upperdir must reside under the same mount\n");
872 goto out_put_workpath;
873 }
874 if (!ovl_workdir_ok(workpath.dentry, upperpath.dentry)) {
875 pr_err("overlayfs: workdir and upperdir must be separate subtrees\n");
876 goto out_put_workpath;
877 }
878 sb->s_stack_depth = upperpath.mnt->mnt_sb->s_stack_depth;
Miklos Szerediab508822014-12-13 00:59:49 +0100879 }
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100880 err = -ENOMEM;
881 lowertmp = kstrdup(ufs->config.lowerdir, GFP_KERNEL);
882 if (!lowertmp)
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100883 goto out_put_workpath;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200884
885 err = -EINVAL;
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100886 stacklen = ovl_split_lowerdirs(lowertmp);
hujianyang6be45062015-01-15 13:19:21 +0800887 if (stacklen > OVL_MAX_STACK) {
888 pr_err("overlayfs: too many lower directries, limit is %d\n",
889 OVL_MAX_STACK);
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100890 goto out_free_lowertmp;
hujianyang6be45062015-01-15 13:19:21 +0800891 } else if (!ufs->config.upperdir && stacklen == 1) {
892 pr_err("overlayfs: at least 2 lowerdir are needed while upperdir nonexistent\n");
893 goto out_free_lowertmp;
894 }
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100895
896 stack = kcalloc(stacklen, sizeof(struct path), GFP_KERNEL);
897 if (!stack)
898 goto out_free_lowertmp;
899
900 lower = lowertmp;
901 for (numlower = 0; numlower < stacklen; numlower++) {
902 err = ovl_lower_dir(lower, &stack[numlower],
903 &ufs->lower_namelen, &sb->s_stack_depth);
904 if (err)
905 goto out_put_lowerpath;
906
907 lower = strchr(lower, '\0') + 1;
908 }
909
910 err = -EINVAL;
Miklos Szerediab508822014-12-13 00:59:49 +0100911 sb->s_stack_depth++;
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200912 if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
913 pr_err("overlayfs: maximum fs stacking depth exceeded\n");
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100914 goto out_put_lowerpath;
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200915 }
916
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100917 if (ufs->config.upperdir) {
918 ufs->upper_mnt = clone_private_mount(&upperpath);
919 err = PTR_ERR(ufs->upper_mnt);
920 if (IS_ERR(ufs->upper_mnt)) {
921 pr_err("overlayfs: failed to clone upperpath\n");
922 goto out_put_lowerpath;
923 }
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100924
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100925 ufs->workdir = ovl_workdir_create(ufs->upper_mnt, workpath.dentry);
926 err = PTR_ERR(ufs->workdir);
927 if (IS_ERR(ufs->workdir)) {
Miklos Szeredicc6f67b2015-05-19 14:30:12 +0200928 pr_warn("overlayfs: failed to create directory %s/%s (errno: %i); mounting read-only\n",
929 ufs->config.workdir, OVL_WORKDIR_NAME, -err);
930 sb->s_flags |= MS_RDONLY;
931 ufs->workdir = NULL;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100932 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200933 }
934
hujianyang2f83fd82015-01-06 12:52:13 +0800935 err = -ENOMEM;
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100936 ufs->lower_mnt = kcalloc(numlower, sizeof(struct vfsmount *), GFP_KERNEL);
Miklos Szeredidd662662014-12-13 00:59:43 +0100937 if (ufs->lower_mnt == NULL)
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100938 goto out_put_workdir;
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100939 for (i = 0; i < numlower; i++) {
940 struct vfsmount *mnt = clone_private_mount(&stack[i]);
Miklos Szeredidd662662014-12-13 00:59:43 +0100941
hujianyang2f83fd82015-01-06 12:52:13 +0800942 err = PTR_ERR(mnt);
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100943 if (IS_ERR(mnt)) {
944 pr_err("overlayfs: failed to clone lowerpath\n");
945 goto out_put_lower_mnt;
946 }
947 /*
948 * Make lower_mnt R/O. That way fchmod/fchown on lower file
949 * will fail instead of modifying lower fs.
950 */
951 mnt->mnt_flags |= MNT_READONLY;
952
953 ufs->lower_mnt[ufs->numlower] = mnt;
954 ufs->numlower++;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200955 }
956
hujianyang71cbad72015-01-15 13:20:57 +0800957 /* If the upper fs is nonexistent, we mark overlayfs r/o too */
958 if (!ufs->upper_mnt)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200959 sb->s_flags |= MS_RDONLY;
960
961 sb->s_d_op = &ovl_dentry_operations;
962
963 err = -ENOMEM;
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100964 oe = ovl_alloc_entry(numlower);
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100965 if (!oe)
966 goto out_put_lower_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200967
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100968 root_dentry = d_make_root(ovl_new_inode(sb, S_IFDIR, oe));
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200969 if (!root_dentry)
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100970 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200971
972 mntput(upperpath.mnt);
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100973 for (i = 0; i < numlower; i++)
974 mntput(stack[i].mnt);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200975 path_put(&workpath);
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100976 kfree(lowertmp);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200977
978 oe->__upperdentry = upperpath.dentry;
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +0100979 for (i = 0; i < numlower; i++) {
980 oe->lowerstack[i].dentry = stack[i].dentry;
981 oe->lowerstack[i].mnt = ufs->lower_mnt[i];
982 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200983
984 root_dentry->d_fsdata = oe;
985
Andy Whitcroftcc259632014-10-24 00:14:38 +0200986 sb->s_magic = OVERLAYFS_SUPER_MAGIC;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200987 sb->s_op = &ovl_super_operations;
988 sb->s_root = root_dentry;
989 sb->s_fs_info = ufs;
990
991 return 0;
992
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100993out_free_oe:
994 kfree(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200995out_put_lower_mnt:
Miklos Szeredidd662662014-12-13 00:59:43 +0100996 for (i = 0; i < ufs->numlower; i++)
997 mntput(ufs->lower_mnt[i]);
998 kfree(ufs->lower_mnt);
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100999out_put_workdir:
1000 dput(ufs->workdir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001001 mntput(ufs->upper_mnt);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001002out_put_lowerpath:
Miklos Szeredia78d9f0d2014-12-13 00:59:52 +01001003 for (i = 0; i < numlower; i++)
1004 path_put(&stack[i]);
1005 kfree(stack);
1006out_free_lowertmp:
1007 kfree(lowertmp);
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +01001008out_put_workpath:
1009 path_put(&workpath);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001010out_put_upperpath:
1011 path_put(&upperpath);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001012out_free_config:
Erez Zadokf45827e82014-10-24 00:14:38 +02001013 kfree(ufs->config.lowerdir);
1014 kfree(ufs->config.upperdir);
1015 kfree(ufs->config.workdir);
1016 kfree(ufs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001017out:
1018 return err;
1019}
1020
1021static struct dentry *ovl_mount(struct file_system_type *fs_type, int flags,
1022 const char *dev_name, void *raw_data)
1023{
1024 return mount_nodev(fs_type, flags, raw_data, ovl_fill_super);
1025}
1026
1027static struct file_system_type ovl_fs_type = {
1028 .owner = THIS_MODULE,
Miklos Szeredief94b182014-11-20 16:39:59 +01001029 .name = "overlay",
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001030 .mount = ovl_mount,
1031 .kill_sb = kill_anon_super,
1032};
Miklos Szeredief94b182014-11-20 16:39:59 +01001033MODULE_ALIAS_FS("overlay");
Miklos Szeredie9be9d52014-10-24 00:14:38 +02001034
1035static int __init ovl_init(void)
1036{
1037 return register_filesystem(&ovl_fs_type);
1038}
1039
1040static void __exit ovl_exit(void)
1041{
1042 unregister_filesystem(&ovl_fs_type);
1043}
1044
1045module_init(ovl_init);
1046module_exit(ovl_exit);