blob: 35bb0adf10cfe8e041ca7fb8d7358a392e5b952c [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
63const char *ovl_opaque_xattr = "trusted.overlay.opaque";
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{
107
108 enum ovl_path_type type = ovl_path_type(dentry);
109
Miklos Szeredi1afaba12014-12-13 00:59:42 +0100110 if (!OVL_TYPE_UPPER(type))
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200111 ovl_path_lower(dentry, path);
112 else
113 ovl_path_upper(dentry, path);
114
115 return type;
116}
117
118struct dentry *ovl_dentry_upper(struct dentry *dentry)
119{
120 struct ovl_entry *oe = dentry->d_fsdata;
121
122 return ovl_upperdentry_dereference(oe);
123}
124
125struct dentry *ovl_dentry_lower(struct dentry *dentry)
126{
127 struct ovl_entry *oe = dentry->d_fsdata;
128
Miklos Szeredidd662662014-12-13 00:59:43 +0100129 return __ovl_dentry_lower(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200130}
131
132struct dentry *ovl_dentry_real(struct dentry *dentry)
133{
134 struct ovl_entry *oe = dentry->d_fsdata;
135 struct dentry *realdentry;
136
137 realdentry = ovl_upperdentry_dereference(oe);
138 if (!realdentry)
Miklos Szeredidd662662014-12-13 00:59:43 +0100139 realdentry = __ovl_dentry_lower(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200140
141 return realdentry;
142}
143
144struct dentry *ovl_entry_real(struct ovl_entry *oe, bool *is_upper)
145{
146 struct dentry *realdentry;
147
148 realdentry = ovl_upperdentry_dereference(oe);
149 if (realdentry) {
150 *is_upper = true;
151 } else {
Miklos Szeredidd662662014-12-13 00:59:43 +0100152 realdentry = __ovl_dentry_lower(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200153 *is_upper = false;
154 }
155 return realdentry;
156}
157
158struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry)
159{
160 struct ovl_entry *oe = dentry->d_fsdata;
161
162 return oe->cache;
163}
164
165void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache)
166{
167 struct ovl_entry *oe = dentry->d_fsdata;
168
169 oe->cache = cache;
170}
171
172void ovl_path_lower(struct dentry *dentry, struct path *path)
173{
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200174 struct ovl_entry *oe = dentry->d_fsdata;
175
Miklos Szeredidd662662014-12-13 00:59:43 +0100176 *path = oe->numlower ? oe->lowerstack[0] : (struct path) { NULL, NULL };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200177}
178
179int ovl_want_write(struct dentry *dentry)
180{
181 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
182 return mnt_want_write(ofs->upper_mnt);
183}
184
185void ovl_drop_write(struct dentry *dentry)
186{
187 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
188 mnt_drop_write(ofs->upper_mnt);
189}
190
191struct dentry *ovl_workdir(struct dentry *dentry)
192{
193 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
194 return ofs->workdir;
195}
196
197bool ovl_dentry_is_opaque(struct dentry *dentry)
198{
199 struct ovl_entry *oe = dentry->d_fsdata;
200 return oe->opaque;
201}
202
203void ovl_dentry_set_opaque(struct dentry *dentry, bool opaque)
204{
205 struct ovl_entry *oe = dentry->d_fsdata;
206 oe->opaque = opaque;
207}
208
209void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry)
210{
211 struct ovl_entry *oe = dentry->d_fsdata;
212
213 WARN_ON(!mutex_is_locked(&upperdentry->d_parent->d_inode->i_mutex));
214 WARN_ON(oe->__upperdentry);
215 BUG_ON(!upperdentry->d_inode);
216 /*
217 * Make sure upperdentry is consistent before making it visible to
218 * ovl_upperdentry_dereference().
219 */
220 smp_wmb();
221 oe->__upperdentry = upperdentry;
222}
223
224void ovl_dentry_version_inc(struct dentry *dentry)
225{
226 struct ovl_entry *oe = dentry->d_fsdata;
227
228 WARN_ON(!mutex_is_locked(&dentry->d_inode->i_mutex));
229 oe->version++;
230}
231
232u64 ovl_dentry_version_get(struct dentry *dentry)
233{
234 struct ovl_entry *oe = dentry->d_fsdata;
235
236 WARN_ON(!mutex_is_locked(&dentry->d_inode->i_mutex));
237 return oe->version;
238}
239
240bool ovl_is_whiteout(struct dentry *dentry)
241{
242 struct inode *inode = dentry->d_inode;
243
244 return inode && IS_WHITEOUT(inode);
245}
246
247static bool ovl_is_opaquedir(struct dentry *dentry)
248{
249 int res;
250 char val;
251 struct inode *inode = dentry->d_inode;
252
253 if (!S_ISDIR(inode->i_mode) || !inode->i_op->getxattr)
254 return false;
255
256 res = inode->i_op->getxattr(dentry, ovl_opaque_xattr, &val, 1);
257 if (res == 1 && val == 'y')
258 return true;
259
260 return false;
261}
262
263static void ovl_dentry_release(struct dentry *dentry)
264{
265 struct ovl_entry *oe = dentry->d_fsdata;
266
267 if (oe) {
Miklos Szeredidd662662014-12-13 00:59:43 +0100268 unsigned int i;
269
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200270 dput(oe->__upperdentry);
Miklos Szeredidd662662014-12-13 00:59:43 +0100271 for (i = 0; i < oe->numlower; i++)
272 dput(oe->lowerstack[i].dentry);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200273 kfree_rcu(oe, rcu);
274 }
275}
276
277static const struct dentry_operations ovl_dentry_operations = {
278 .d_release = ovl_dentry_release,
279};
280
Miklos Szeredidd662662014-12-13 00:59:43 +0100281static struct ovl_entry *ovl_alloc_entry(unsigned int numlower)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200282{
Miklos Szeredidd662662014-12-13 00:59:43 +0100283 size_t size = offsetof(struct ovl_entry, lowerstack[numlower]);
284 struct ovl_entry *oe = kzalloc(size, GFP_KERNEL);
285
286 if (oe)
287 oe->numlower = numlower;
288
289 return oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200290}
291
292static inline struct dentry *ovl_lookup_real(struct dentry *dir,
293 struct qstr *name)
294{
295 struct dentry *dentry;
296
297 mutex_lock(&dir->d_inode->i_mutex);
298 dentry = lookup_one_len(name->name, dir, name->len);
299 mutex_unlock(&dir->d_inode->i_mutex);
300
301 if (IS_ERR(dentry)) {
302 if (PTR_ERR(dentry) == -ENOENT)
303 dentry = NULL;
304 } else if (!dentry->d_inode) {
305 dput(dentry);
306 dentry = NULL;
307 }
308 return dentry;
309}
310
Miklos Szeredi5ef88da2014-12-13 00:59:43 +0100311/*
312 * Returns next layer in stack starting from top.
313 * Returns -1 if this is the last layer.
314 */
315int ovl_path_next(int idx, struct dentry *dentry, struct path *path)
316{
317 struct ovl_entry *oe = dentry->d_fsdata;
318
319 BUG_ON(idx < 0);
320 if (idx == 0) {
321 ovl_path_upper(dentry, path);
322 if (path->dentry)
323 return oe->numlower ? 1 : -1;
324 idx++;
325 }
326 BUG_ON(idx > oe->numlower);
327 *path = oe->lowerstack[idx - 1];
328
329 return (idx < oe->numlower) ? idx + 1 : -1;
330}
331
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200332struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
333 unsigned int flags)
334{
335 struct ovl_entry *oe;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100336 struct ovl_entry *poe = dentry->d_parent->d_fsdata;
337 struct path *stack = NULL;
338 struct dentry *upperdir, *upperdentry = NULL;
339 unsigned int ctr = 0;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200340 struct inode *inode = NULL;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100341 bool upperopaque = false;
342 struct dentry *this, *prev = NULL;
343 unsigned int i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200344 int err;
345
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100346 upperdir = ovl_upperdentry_dereference(poe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200347 if (upperdir) {
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100348 this = ovl_lookup_real(upperdir, &dentry->d_name);
349 err = PTR_ERR(this);
350 if (IS_ERR(this))
351 goto out;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200352
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100353 if (this) {
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100354 if (ovl_is_whiteout(this)) {
355 dput(this);
356 this = NULL;
357 upperopaque = true;
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100358 } else if (poe->numlower && ovl_is_opaquedir(this)) {
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100359 upperopaque = true;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200360 }
361 }
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100362 upperdentry = prev = this;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200363 }
364
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100365 if (!upperopaque && poe->numlower) {
366 err = -ENOMEM;
367 stack = kcalloc(poe->numlower, sizeof(struct path), GFP_KERNEL);
368 if (!stack)
369 goto out_put_upper;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200370 }
371
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100372 for (i = 0; !upperopaque && i < poe->numlower; i++) {
373 bool opaque = false;
374 struct path lowerpath = poe->lowerstack[i];
375
376 opaque = false;
377 this = ovl_lookup_real(lowerpath.dentry, &dentry->d_name);
378 err = PTR_ERR(this);
Miklos Szeredi09e10322014-12-13 00:59:45 +0100379 if (IS_ERR(this)) {
380 /*
381 * If it's positive, then treat ENAMETOOLONG as ENOENT.
382 */
383 if (err == -ENAMETOOLONG && (upperdentry || ctr))
384 continue;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100385 goto out_put;
Miklos Szeredi09e10322014-12-13 00:59:45 +0100386 }
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100387 if (!this)
388 continue;
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100389 if (ovl_is_whiteout(this)) {
390 dput(this);
391 break;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100392 }
393 /*
Miklos Szeredi3e01cee2014-12-13 00:59:45 +0100394 * Only makes sense to check opaque dir if this is not the
395 * lowermost layer.
396 */
397 if (i < poe->numlower - 1 && ovl_is_opaquedir(this))
398 opaque = true;
399 /*
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100400 * If this is a non-directory then stop here.
401 *
402 * FIXME: check for opaqueness maybe better done in remove code.
403 */
404 if (!S_ISDIR(this->d_inode->i_mode)) {
405 opaque = true;
406 } else if (prev && (!S_ISDIR(prev->d_inode->i_mode) ||
407 !S_ISDIR(this->d_inode->i_mode))) {
408 if (prev == upperdentry)
409 upperopaque = true;
410 dput(this);
411 break;
412 }
413 stack[ctr].dentry = this;
414 stack[ctr].mnt = lowerpath.mnt;
415 ctr++;
416 prev = this;
417 if (opaque)
418 break;
419 }
420
421 oe = ovl_alloc_entry(ctr);
422 err = -ENOMEM;
423 if (!oe)
424 goto out_put;
425
426 if (upperdentry || ctr) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200427 struct dentry *realdentry;
428
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100429 realdentry = upperdentry ? upperdentry : stack[0].dentry;
430
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200431 err = -ENOMEM;
432 inode = ovl_new_inode(dentry->d_sb, realdentry->d_inode->i_mode,
433 oe);
434 if (!inode)
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100435 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200436 ovl_copyattr(realdentry->d_inode, inode);
437 }
438
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100439 oe->opaque = upperopaque;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200440 oe->__upperdentry = upperdentry;
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100441 memcpy(oe->lowerstack, stack, sizeof(struct path) * ctr);
442 kfree(stack);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200443 dentry->d_fsdata = oe;
444 d_add(dentry, inode);
445
446 return NULL;
447
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100448out_free_oe:
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200449 kfree(oe);
Miklos Szeredi3d3c6b82014-12-13 00:59:44 +0100450out_put:
451 for (i = 0; i < ctr; i++)
452 dput(stack[i].dentry);
453 kfree(stack);
454out_put_upper:
455 dput(upperdentry);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200456out:
457 return ERR_PTR(err);
458}
459
460struct file *ovl_path_open(struct path *path, int flags)
461{
462 return dentry_open(path, flags, current_cred());
463}
464
465static void ovl_put_super(struct super_block *sb)
466{
467 struct ovl_fs *ufs = sb->s_fs_info;
Miklos Szeredidd662662014-12-13 00:59:43 +0100468 unsigned i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200469
470 dput(ufs->workdir);
471 mntput(ufs->upper_mnt);
Miklos Szeredidd662662014-12-13 00:59:43 +0100472 for (i = 0; i < ufs->numlower; i++)
473 mntput(ufs->lower_mnt[i]);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200474
Erez Zadokf45827e82014-10-24 00:14:38 +0200475 kfree(ufs->config.lowerdir);
476 kfree(ufs->config.upperdir);
477 kfree(ufs->config.workdir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200478 kfree(ufs);
479}
480
Andy Whitcroftcc259632014-10-24 00:14:38 +0200481/**
482 * ovl_statfs
483 * @sb: The overlayfs super block
484 * @buf: The struct kstatfs to fill in with stats
485 *
486 * Get the filesystem statistics. As writes always target the upper layer
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100487 * filesystem pass the statfs to the upper filesystem (if it exists)
Andy Whitcroftcc259632014-10-24 00:14:38 +0200488 */
489static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
490{
491 struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
492 struct dentry *root_dentry = dentry->d_sb->s_root;
493 struct path path;
494 int err;
495
Miklos Szeredi4ebc5812014-12-13 00:59:46 +0100496 ovl_path_real(root_dentry, &path);
Andy Whitcroftcc259632014-10-24 00:14:38 +0200497
498 err = vfs_statfs(&path, buf);
499 if (!err) {
500 buf->f_namelen = max(buf->f_namelen, ofs->lower_namelen);
501 buf->f_type = OVERLAYFS_SUPER_MAGIC;
502 }
503
504 return err;
505}
506
Erez Zadokf45827e82014-10-24 00:14:38 +0200507/**
508 * ovl_show_options
509 *
510 * Prints the mount options for a given superblock.
511 * Returns zero; does not fail.
512 */
513static int ovl_show_options(struct seq_file *m, struct dentry *dentry)
514{
515 struct super_block *sb = dentry->d_sb;
516 struct ovl_fs *ufs = sb->s_fs_info;
517
518 seq_printf(m, ",lowerdir=%s", ufs->config.lowerdir);
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100519 if (ufs->config.upperdir) {
520 seq_printf(m, ",upperdir=%s", ufs->config.upperdir);
521 seq_printf(m, ",workdir=%s", ufs->config.workdir);
522 }
Erez Zadokf45827e82014-10-24 00:14:38 +0200523 return 0;
524}
525
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200526static const struct super_operations ovl_super_operations = {
527 .put_super = ovl_put_super,
Andy Whitcroftcc259632014-10-24 00:14:38 +0200528 .statfs = ovl_statfs,
Erez Zadokf45827e82014-10-24 00:14:38 +0200529 .show_options = ovl_show_options,
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200530};
531
532enum {
533 OPT_LOWERDIR,
534 OPT_UPPERDIR,
535 OPT_WORKDIR,
536 OPT_ERR,
537};
538
539static const match_table_t ovl_tokens = {
540 {OPT_LOWERDIR, "lowerdir=%s"},
541 {OPT_UPPERDIR, "upperdir=%s"},
542 {OPT_WORKDIR, "workdir=%s"},
543 {OPT_ERR, NULL}
544};
545
Miklos Szeredi91c77942014-11-20 16:40:00 +0100546static char *ovl_next_opt(char **s)
547{
548 char *sbegin = *s;
549 char *p;
550
551 if (sbegin == NULL)
552 return NULL;
553
554 for (p = sbegin; *p; p++) {
555 if (*p == '\\') {
556 p++;
557 if (!*p)
558 break;
559 } else if (*p == ',') {
560 *p = '\0';
561 *s = p + 1;
562 return sbegin;
563 }
564 }
565 *s = NULL;
566 return sbegin;
567}
568
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200569static int ovl_parse_opt(char *opt, struct ovl_config *config)
570{
571 char *p;
572
Miklos Szeredi91c77942014-11-20 16:40:00 +0100573 while ((p = ovl_next_opt(&opt)) != NULL) {
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200574 int token;
575 substring_t args[MAX_OPT_ARGS];
576
577 if (!*p)
578 continue;
579
580 token = match_token(p, ovl_tokens, args);
581 switch (token) {
582 case OPT_UPPERDIR:
583 kfree(config->upperdir);
584 config->upperdir = match_strdup(&args[0]);
585 if (!config->upperdir)
586 return -ENOMEM;
587 break;
588
589 case OPT_LOWERDIR:
590 kfree(config->lowerdir);
591 config->lowerdir = match_strdup(&args[0]);
592 if (!config->lowerdir)
593 return -ENOMEM;
594 break;
595
596 case OPT_WORKDIR:
597 kfree(config->workdir);
598 config->workdir = match_strdup(&args[0]);
599 if (!config->workdir)
600 return -ENOMEM;
601 break;
602
603 default:
604 return -EINVAL;
605 }
606 }
607 return 0;
608}
609
610#define OVL_WORKDIR_NAME "work"
611
612static struct dentry *ovl_workdir_create(struct vfsmount *mnt,
613 struct dentry *dentry)
614{
615 struct inode *dir = dentry->d_inode;
616 struct dentry *work;
617 int err;
618 bool retried = false;
619
620 err = mnt_want_write(mnt);
621 if (err)
622 return ERR_PTR(err);
623
624 mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
625retry:
626 work = lookup_one_len(OVL_WORKDIR_NAME, dentry,
627 strlen(OVL_WORKDIR_NAME));
628
629 if (!IS_ERR(work)) {
630 struct kstat stat = {
631 .mode = S_IFDIR | 0,
632 };
633
634 if (work->d_inode) {
635 err = -EEXIST;
636 if (retried)
637 goto out_dput;
638
639 retried = true;
640 ovl_cleanup(dir, work);
641 dput(work);
642 goto retry;
643 }
644
645 err = ovl_create_real(dir, work, &stat, NULL, NULL, true);
646 if (err)
647 goto out_dput;
648 }
649out_unlock:
650 mutex_unlock(&dir->i_mutex);
651 mnt_drop_write(mnt);
652
653 return work;
654
655out_dput:
656 dput(work);
657 work = ERR_PTR(err);
658 goto out_unlock;
659}
660
Miklos Szeredi91c77942014-11-20 16:40:00 +0100661static void ovl_unescape(char *s)
662{
663 char *d = s;
664
665 for (;; s++, d++) {
666 if (*s == '\\')
667 s++;
668 *d = *s;
669 if (!*s)
670 break;
671 }
672}
673
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200674static bool ovl_is_allowed_fs_type(struct dentry *root)
675{
676 const struct dentry_operations *dop = root->d_op;
677
678 /*
679 * We don't support:
680 * - automount filesystems
681 * - filesystems with revalidate (FIXME for lower layer)
682 * - filesystems with case insensitive names
683 */
684 if (dop &&
685 (dop->d_manage || dop->d_automount ||
686 dop->d_revalidate || dop->d_weak_revalidate ||
687 dop->d_compare || dop->d_hash)) {
688 return false;
689 }
690 return true;
691}
692
Miklos Szerediab508822014-12-13 00:59:49 +0100693static int ovl_mount_dir_noesc(const char *name, struct path *path)
694{
695 int err;
696
697 err = kern_path(name, LOOKUP_FOLLOW, path);
698 if (err) {
699 pr_err("overlayfs: failed to resolve '%s': %i\n", name, err);
700 goto out;
701 }
702 err = -EINVAL;
703 if (!ovl_is_allowed_fs_type(path->dentry)) {
704 pr_err("overlayfs: filesystem on '%s' not supported\n", name);
705 goto out_put;
706 }
707 if (!S_ISDIR(path->dentry->d_inode->i_mode)) {
708 pr_err("overlayfs: '%s' not a directory\n", name);
709 goto out_put;
710 }
711 return 0;
712
713out_put:
714 path_put(path);
715out:
716 return err;
717}
718
719static int ovl_mount_dir(const char *name, struct path *path)
720{
721 int err = -ENOMEM;
722 char *tmp = kstrdup(name, GFP_KERNEL);
723
724 if (tmp) {
725 ovl_unescape(tmp);
726 err = ovl_mount_dir_noesc(tmp, path);
727 kfree(tmp);
728 }
729 return err;
730}
731
732static int ovl_lower_dir(const char *name, struct path *path, long *namelen,
733 int *stack_depth)
734{
735 int err;
736 struct kstatfs statfs;
737
738 err = ovl_mount_dir(name, path);
739 if (err)
740 goto out;
741
742 err = vfs_statfs(path, &statfs);
743 if (err) {
744 pr_err("overlayfs: statfs failed on '%s'\n", name);
745 goto out_put;
746 }
747 *namelen = max(*namelen, statfs.f_namelen);
748 *stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);
749
750 return 0;
751
752out_put:
753 path_put(path);
754out:
755 return err;
756}
757
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200758/* Workdir should not be subdir of upperdir and vice versa */
759static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
760{
761 bool ok = false;
762
763 if (workdir != upperdir) {
764 ok = (lock_rename(workdir, upperdir) == NULL);
765 unlock_rename(workdir, upperdir);
766 }
767 return ok;
768}
769
770static int ovl_fill_super(struct super_block *sb, void *data, int silent)
771{
772 struct path lowerpath;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100773 struct path upperpath = { NULL, NULL };
774 struct path workpath = { NULL, NULL };
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200775 struct dentry *root_dentry;
776 struct ovl_entry *oe;
777 struct ovl_fs *ufs;
Miklos Szeredidd662662014-12-13 00:59:43 +0100778 struct vfsmount *mnt;
779 unsigned int i;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200780 int err;
781
Erez Zadokf45827e82014-10-24 00:14:38 +0200782 err = -ENOMEM;
783 ufs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
784 if (!ufs)
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200785 goto out;
786
Erez Zadokf45827e82014-10-24 00:14:38 +0200787 err = ovl_parse_opt((char *) data, &ufs->config);
788 if (err)
789 goto out_free_config;
790
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200791 err = -EINVAL;
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100792 if (!ufs->config.lowerdir) {
793 pr_err("overlayfs: missing 'lowerdir'\n");
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200794 goto out_free_config;
795 }
796
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100797 sb->s_stack_depth = 0;
798 if (ufs->config.upperdir) {
799 /* FIXME: workdir is not needed for a R/O mount */
800 if (!ufs->config.workdir) {
801 pr_err("overlayfs: missing 'workdir'\n");
802 goto out_free_config;
803 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200804
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100805 err = ovl_mount_dir(ufs->config.upperdir, &upperpath);
806 if (err)
807 goto out_free_config;
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100808
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100809 err = ovl_mount_dir(ufs->config.workdir, &workpath);
810 if (err)
811 goto out_put_upperpath;
812
813 if (upperpath.mnt != workpath.mnt) {
814 pr_err("overlayfs: workdir and upperdir must reside under the same mount\n");
815 goto out_put_workpath;
816 }
817 if (!ovl_workdir_ok(workpath.dentry, upperpath.dentry)) {
818 pr_err("overlayfs: workdir and upperdir must be separate subtrees\n");
819 goto out_put_workpath;
820 }
821 sb->s_stack_depth = upperpath.mnt->mnt_sb->s_stack_depth;
Miklos Szerediab508822014-12-13 00:59:49 +0100822 }
Miklos Szerediab508822014-12-13 00:59:49 +0100823
824 err = ovl_lower_dir(ufs->config.lowerdir, &lowerpath,
825 &ufs->lower_namelen, &sb->s_stack_depth);
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100826 if (err)
827 goto out_put_workpath;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200828
829 err = -EINVAL;
Miklos Szerediab508822014-12-13 00:59:49 +0100830 sb->s_stack_depth++;
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200831 if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
832 pr_err("overlayfs: maximum fs stacking depth exceeded\n");
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100833 goto out_put_lowerpath;
Miklos Szeredi69c433e2014-10-24 00:14:39 +0200834 }
835
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100836 if (ufs->config.upperdir) {
837 ufs->upper_mnt = clone_private_mount(&upperpath);
838 err = PTR_ERR(ufs->upper_mnt);
839 if (IS_ERR(ufs->upper_mnt)) {
840 pr_err("overlayfs: failed to clone upperpath\n");
841 goto out_put_lowerpath;
842 }
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100843
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100844 ufs->workdir = ovl_workdir_create(ufs->upper_mnt, workpath.dentry);
845 err = PTR_ERR(ufs->workdir);
846 if (IS_ERR(ufs->workdir)) {
847 pr_err("overlayfs: failed to create directory %s/%s\n",
848 ufs->config.workdir, OVL_WORKDIR_NAME);
849 goto out_put_upper_mnt;
850 }
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200851 }
852
Miklos Szeredidd662662014-12-13 00:59:43 +0100853 ufs->lower_mnt = kcalloc(1, sizeof(struct vfsmount *), GFP_KERNEL);
854 if (ufs->lower_mnt == NULL)
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100855 goto out_put_workdir;
Miklos Szeredidd662662014-12-13 00:59:43 +0100856
857 mnt = clone_private_mount(&lowerpath);
858 err = PTR_ERR(mnt);
859 if (IS_ERR(mnt)) {
860 pr_err("overlayfs: failed to clone lowerpath\n");
861 goto out_put_lower_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200862 }
Miklos Szeredidd662662014-12-13 00:59:43 +0100863 /*
864 * Make lower_mnt R/O. That way fchmod/fchown on lower file
865 * will fail instead of modifying lower fs.
866 */
867 mnt->mnt_flags |= MNT_READONLY;
868
869 ufs->lower_mnt[0] = mnt;
870 ufs->numlower = 1;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200871
Miklos Szeredi53a08cb2014-12-13 00:59:51 +0100872 /* If the upper fs is r/o or nonexistent, we mark overlayfs r/o too */
873 if (!ufs->upper_mnt || (ufs->upper_mnt->mnt_sb->s_flags & MS_RDONLY))
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200874 sb->s_flags |= MS_RDONLY;
875
876 sb->s_d_op = &ovl_dentry_operations;
877
878 err = -ENOMEM;
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100879 oe = ovl_alloc_entry(1);
880 if (!oe)
881 goto out_put_lower_mnt;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200882
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100883 root_dentry = d_make_root(ovl_new_inode(sb, S_IFDIR, oe));
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200884 if (!root_dentry)
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100885 goto out_free_oe;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200886
887 mntput(upperpath.mnt);
888 mntput(lowerpath.mnt);
889 path_put(&workpath);
890
891 oe->__upperdentry = upperpath.dentry;
Miklos Szeredidd662662014-12-13 00:59:43 +0100892 oe->lowerstack[0].dentry = lowerpath.dentry;
893 oe->lowerstack[0].mnt = ufs->lower_mnt[0];
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200894
895 root_dentry->d_fsdata = oe;
896
Andy Whitcroftcc259632014-10-24 00:14:38 +0200897 sb->s_magic = OVERLAYFS_SUPER_MAGIC;
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200898 sb->s_op = &ovl_super_operations;
899 sb->s_root = root_dentry;
900 sb->s_fs_info = ufs;
901
902 return 0;
903
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100904out_free_oe:
905 kfree(oe);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200906out_put_lower_mnt:
Miklos Szeredidd662662014-12-13 00:59:43 +0100907 for (i = 0; i < ufs->numlower; i++)
908 mntput(ufs->lower_mnt[i]);
909 kfree(ufs->lower_mnt);
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100910out_put_workdir:
911 dput(ufs->workdir);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200912out_put_upper_mnt:
913 mntput(ufs->upper_mnt);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200914out_put_lowerpath:
915 path_put(&lowerpath);
Miklos Szeredi3b7a9a22014-12-13 00:59:48 +0100916out_put_workpath:
917 path_put(&workpath);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200918out_put_upperpath:
919 path_put(&upperpath);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200920out_free_config:
Erez Zadokf45827e82014-10-24 00:14:38 +0200921 kfree(ufs->config.lowerdir);
922 kfree(ufs->config.upperdir);
923 kfree(ufs->config.workdir);
924 kfree(ufs);
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200925out:
926 return err;
927}
928
929static struct dentry *ovl_mount(struct file_system_type *fs_type, int flags,
930 const char *dev_name, void *raw_data)
931{
932 return mount_nodev(fs_type, flags, raw_data, ovl_fill_super);
933}
934
935static struct file_system_type ovl_fs_type = {
936 .owner = THIS_MODULE,
Miklos Szeredief94b182014-11-20 16:39:59 +0100937 .name = "overlay",
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200938 .mount = ovl_mount,
939 .kill_sb = kill_anon_super,
940};
Miklos Szeredief94b182014-11-20 16:39:59 +0100941MODULE_ALIAS_FS("overlay");
Miklos Szeredie9be9d52014-10-24 00:14:38 +0200942
943static int __init ovl_init(void)
944{
945 return register_filesystem(&ovl_fs_type);
946}
947
948static void __exit ovl_exit(void)
949{
950 unregister_filesystem(&ovl_fs_type);
951}
952
953module_init(ovl_init);
954module_exit(ovl_exit);