super.c 26.8 KB
Newer Older
M
Miklos Szeredi 已提交
1 2 3 4 5 6 7 8 9 10 11
/*
 *
 * Copyright (C) 2011 Novell Inc.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#include <linux/fs.h>
#include <linux/namei.h>
12
#include <linux/pagemap.h>
M
Miklos Szeredi 已提交
13 14 15 16 17 18
#include <linux/xattr.h>
#include <linux/security.h>
#include <linux/mount.h>
#include <linux/slab.h>
#include <linux/parser.h>
#include <linux/module.h>
19
#include <linux/pagemap.h>
M
Miklos Szeredi 已提交
20
#include <linux/sched.h>
A
Andy Whitcroft 已提交
21
#include <linux/statfs.h>
E
Erez Zadok 已提交
22
#include <linux/seq_file.h>
M
Miklos Szeredi 已提交
23 24 25 26 27 28
#include "overlayfs.h"

MODULE_AUTHOR("Miklos Szeredi <miklos@szeredi.hu>");
MODULE_DESCRIPTION("Overlay filesystem");
MODULE_LICENSE("GPL");

E
Erez Zadok 已提交
29 30 31 32
struct ovl_config {
	char *lowerdir;
	char *upperdir;
	char *workdir;
M
Miklos Szeredi 已提交
33
	bool default_permissions;
E
Erez Zadok 已提交
34 35
};

M
Miklos Szeredi 已提交
36 37 38
/* private information held for overlayfs's superblock */
struct ovl_fs {
	struct vfsmount *upper_mnt;
39 40
	unsigned numlower;
	struct vfsmount **lower_mnt;
M
Miklos Szeredi 已提交
41
	struct dentry *workdir;
A
Andy Whitcroft 已提交
42
	long lower_namelen;
E
Erez Zadok 已提交
43 44
	/* pathnames of lower and upper dirs, for show_options */
	struct ovl_config config;
45 46
	/* creds of process who forced instantiation of super block */
	const struct cred *creator_cred;
M
Miklos Szeredi 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
};

struct ovl_dir_cache;

/* private information held for every overlayfs dentry */
struct ovl_entry {
	struct dentry *__upperdentry;
	struct ovl_dir_cache *cache;
	union {
		struct {
			u64 version;
			bool opaque;
		};
		struct rcu_head rcu;
	};
62 63
	unsigned numlower;
	struct path lowerstack[];
M
Miklos Szeredi 已提交
64 65
};

66 67
#define OVL_MAX_STACK 500

68 69 70 71
static struct dentry *__ovl_dentry_lower(struct ovl_entry *oe)
{
	return oe->numlower ? oe->lowerstack[0].dentry : NULL;
}
M
Miklos Szeredi 已提交
72 73 74 75

enum ovl_path_type ovl_path_type(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;
M
Miklos Szeredi 已提交
76
	enum ovl_path_type type = 0;
M
Miklos Szeredi 已提交
77 78

	if (oe->__upperdentry) {
M
Miklos Szeredi 已提交
79 80
		type = __OVL_PATH_UPPER;

81 82 83 84 85 86 87
		/*
		 * Non-dir dentry can hold lower dentry from previous
		 * location. Its purity depends only on opaque flag.
		 */
		if (oe->numlower && S_ISDIR(dentry->d_inode->i_mode))
			type |= __OVL_PATH_MERGE;
		else if (!oe->opaque)
M
Miklos Szeredi 已提交
88
			type |= __OVL_PATH_PURE;
M
Miklos Szeredi 已提交
89 90 91
	} else {
		if (oe->numlower > 1)
			type |= __OVL_PATH_MERGE;
M
Miklos Szeredi 已提交
92
	}
M
Miklos Szeredi 已提交
93
	return type;
M
Miklos Szeredi 已提交
94 95 96 97
}

static struct dentry *ovl_upperdentry_dereference(struct ovl_entry *oe)
{
98
	return lockless_dereference(oe->__upperdentry);
M
Miklos Szeredi 已提交
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
}

void ovl_path_upper(struct dentry *dentry, struct path *path)
{
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
	struct ovl_entry *oe = dentry->d_fsdata;

	path->mnt = ofs->upper_mnt;
	path->dentry = ovl_upperdentry_dereference(oe);
}

enum ovl_path_type ovl_path_real(struct dentry *dentry, struct path *path)
{
	enum ovl_path_type type = ovl_path_type(dentry);

M
Miklos Szeredi 已提交
114
	if (!OVL_TYPE_UPPER(type))
M
Miklos Szeredi 已提交
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
		ovl_path_lower(dentry, path);
	else
		ovl_path_upper(dentry, path);

	return type;
}

struct dentry *ovl_dentry_upper(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

	return ovl_upperdentry_dereference(oe);
}

struct dentry *ovl_dentry_lower(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

133
	return __ovl_dentry_lower(oe);
M
Miklos Szeredi 已提交
134 135 136 137 138 139 140 141 142
}

struct dentry *ovl_dentry_real(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;
	struct dentry *realdentry;

	realdentry = ovl_upperdentry_dereference(oe);
	if (!realdentry)
143
		realdentry = __ovl_dentry_lower(oe);
M
Miklos Szeredi 已提交
144 145 146 147

	return realdentry;
}

148 149
static void ovl_inode_init(struct inode *inode, struct inode *realinode,
			   bool is_upper)
M
Miklos Szeredi 已提交
150
{
151 152
	WRITE_ONCE(inode->i_private, (unsigned long) realinode |
		   (is_upper ? OVL_ISUPPER_MASK : 0));
153 154
}

M
Miklos Szeredi 已提交
155 156 157 158 159 160 161 162 163 164 165 166
struct vfsmount *ovl_entry_mnt_real(struct ovl_entry *oe, struct inode *inode,
				    bool is_upper)
{
	if (is_upper) {
		struct ovl_fs *ofs = inode->i_sb->s_fs_info;

		return ofs->upper_mnt;
	} else {
		return oe->numlower ? oe->lowerstack[0].mnt : NULL;
	}
}

M
Miklos Szeredi 已提交
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
struct ovl_dir_cache *ovl_dir_cache(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

	return oe->cache;
}

void ovl_set_dir_cache(struct dentry *dentry, struct ovl_dir_cache *cache)
{
	struct ovl_entry *oe = dentry->d_fsdata;

	oe->cache = cache;
}

void ovl_path_lower(struct dentry *dentry, struct path *path)
{
	struct ovl_entry *oe = dentry->d_fsdata;

185
	*path = oe->numlower ? oe->lowerstack[0] : (struct path) { NULL, NULL };
M
Miklos Szeredi 已提交
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
}

int ovl_want_write(struct dentry *dentry)
{
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
	return mnt_want_write(ofs->upper_mnt);
}

void ovl_drop_write(struct dentry *dentry)
{
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
	mnt_drop_write(ofs->upper_mnt);
}

struct dentry *ovl_workdir(struct dentry *dentry)
{
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
	return ofs->workdir;
}

bool ovl_dentry_is_opaque(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;
	return oe->opaque;
}

void ovl_dentry_set_opaque(struct dentry *dentry, bool opaque)
{
	struct ovl_entry *oe = dentry->d_fsdata;
	oe->opaque = opaque;
}

void ovl_dentry_update(struct dentry *dentry, struct dentry *upperdentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

A
Al Viro 已提交
222
	WARN_ON(!inode_is_locked(upperdentry->d_parent->d_inode));
M
Miklos Szeredi 已提交
223 224 225 226 227 228 229 230 231
	WARN_ON(oe->__upperdentry);
	/*
	 * Make sure upperdentry is consistent before making it visible to
	 * ovl_upperdentry_dereference().
	 */
	smp_wmb();
	oe->__upperdentry = upperdentry;
}

232 233 234 235 236 237 238
void ovl_inode_update(struct inode *inode, struct inode *upperinode)
{
	WARN_ON(!upperinode);
	WRITE_ONCE(inode->i_private,
		   (unsigned long) upperinode | OVL_ISUPPER_MASK);
}

M
Miklos Szeredi 已提交
239 240 241 242
void ovl_dentry_version_inc(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

A
Al Viro 已提交
243
	WARN_ON(!inode_is_locked(dentry->d_inode));
M
Miklos Szeredi 已提交
244 245 246 247 248 249 250
	oe->version++;
}

u64 ovl_dentry_version_get(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

A
Al Viro 已提交
251
	WARN_ON(!inode_is_locked(dentry->d_inode));
M
Miklos Szeredi 已提交
252 253 254 255 256 257 258 259 260 261
	return oe->version;
}

bool ovl_is_whiteout(struct dentry *dentry)
{
	struct inode *inode = dentry->d_inode;

	return inode && IS_WHITEOUT(inode);
}

262 263 264 265 266 267 268
const struct cred *ovl_override_creds(struct super_block *sb)
{
	struct ovl_fs *ofs = sb->s_fs_info;

	return override_creds(ofs->creator_cred);
}

M
Miklos Szeredi 已提交
269 270 271 272 273 274 275 276 277
static bool ovl_is_opaquedir(struct dentry *dentry)
{
	int res;
	char val;
	struct inode *inode = dentry->d_inode;

	if (!S_ISDIR(inode->i_mode) || !inode->i_op->getxattr)
		return false;

278
	res = inode->i_op->getxattr(dentry, inode, OVL_XATTR_OPAQUE, &val, 1);
M
Miklos Szeredi 已提交
279 280 281 282 283 284 285 286 287 288 289
	if (res == 1 && val == 'y')
		return true;

	return false;
}

static void ovl_dentry_release(struct dentry *dentry)
{
	struct ovl_entry *oe = dentry->d_fsdata;

	if (oe) {
290 291
		unsigned int i;

M
Miklos Szeredi 已提交
292
		dput(oe->__upperdentry);
293 294
		for (i = 0; i < oe->numlower; i++)
			dput(oe->lowerstack[i].dentry);
M
Miklos Szeredi 已提交
295 296 297 298
		kfree_rcu(oe, rcu);
	}
}

299 300 301
static struct dentry *ovl_d_real(struct dentry *dentry,
				 const struct inode *inode,
				 unsigned int open_flags)
M
Miklos Szeredi 已提交
302 303 304 305 306 307 308 309 310
{
	struct dentry *real;

	if (d_is_dir(dentry)) {
		if (!inode || inode == d_inode(dentry))
			return dentry;
		goto bug;
	}

311 312 313 314 315 316 317 318 319 320
	if (d_is_negative(dentry))
		return dentry;

	if (open_flags) {
		int err = ovl_open_maybe_copy_up(dentry, open_flags);

		if (err)
			return ERR_PTR(err);
	}

M
Miklos Szeredi 已提交
321 322 323 324 325 326 327 328 329 330 331 332
	real = ovl_dentry_upper(dentry);
	if (real && (!inode || inode == d_inode(real)))
		return real;

	real = ovl_dentry_lower(dentry);
	if (!real)
		goto bug;

	if (!inode || inode == d_inode(real))
		return real;

	/* Handle recursion */
333
	return d_real(real, inode, open_flags);
M
Miklos Szeredi 已提交
334 335 336 337 338 339
bug:
	WARN(1, "ovl_d_real(%pd4, %s:%lu\n): real dentry not found\n", dentry,
	     inode ? inode->i_sb->s_id : "NULL", inode ? inode->i_ino : 0);
	return dentry;
}

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
static int ovl_dentry_revalidate(struct dentry *dentry, unsigned int flags)
{
	struct ovl_entry *oe = dentry->d_fsdata;
	unsigned int i;
	int ret = 1;

	for (i = 0; i < oe->numlower; i++) {
		struct dentry *d = oe->lowerstack[i].dentry;

		if (d->d_flags & DCACHE_OP_REVALIDATE) {
			ret = d->d_op->d_revalidate(d, flags);
			if (ret < 0)
				return ret;
			if (!ret) {
				if (!(flags & LOOKUP_RCU))
					d_invalidate(d);
				return -ESTALE;
			}
		}
	}
	return 1;
}

static int ovl_dentry_weak_revalidate(struct dentry *dentry, unsigned int flags)
{
	struct ovl_entry *oe = dentry->d_fsdata;
	unsigned int i;
	int ret = 1;

	for (i = 0; i < oe->numlower; i++) {
		struct dentry *d = oe->lowerstack[i].dentry;

		if (d->d_flags & DCACHE_OP_WEAK_REVALIDATE) {
			ret = d->d_op->d_weak_revalidate(d, flags);
			if (ret <= 0)
				break;
		}
	}
	return ret;
}

M
Miklos Szeredi 已提交
381 382
static const struct dentry_operations ovl_dentry_operations = {
	.d_release = ovl_dentry_release,
M
Miklos Szeredi 已提交
383
	.d_real = ovl_d_real,
M
Miklos Szeredi 已提交
384 385
};

386 387
static const struct dentry_operations ovl_reval_dentry_operations = {
	.d_release = ovl_dentry_release,
M
Miklos Szeredi 已提交
388
	.d_real = ovl_d_real,
389 390 391 392
	.d_revalidate = ovl_dentry_revalidate,
	.d_weak_revalidate = ovl_dentry_weak_revalidate,
};

393
static struct ovl_entry *ovl_alloc_entry(unsigned int numlower)
M
Miklos Szeredi 已提交
394
{
395 396 397 398 399 400 401
	size_t size = offsetof(struct ovl_entry, lowerstack[numlower]);
	struct ovl_entry *oe = kzalloc(size, GFP_KERNEL);

	if (oe)
		oe->numlower = numlower;

	return oe;
M
Miklos Szeredi 已提交
402 403
}

404 405 406 407 408 409 410 411 412 413 414 415 416 417
static bool ovl_dentry_remote(struct dentry *dentry)
{
	return dentry->d_flags &
		(DCACHE_OP_REVALIDATE | DCACHE_OP_WEAK_REVALIDATE);
}

static bool ovl_dentry_weird(struct dentry *dentry)
{
	return dentry->d_flags & (DCACHE_NEED_AUTOMOUNT |
				  DCACHE_MANAGE_TRANSIT |
				  DCACHE_OP_HASH |
				  DCACHE_OP_COMPARE);
}

418 419
static inline struct dentry *ovl_lookup_real(struct super_block *ovl_sb,
					     struct dentry *dir,
M
Miklos Szeredi 已提交
420 421
					     struct qstr *name)
{
422
	const struct cred *old_cred;
M
Miklos Szeredi 已提交
423 424
	struct dentry *dentry;

425 426 427
	old_cred = ovl_override_creds(ovl_sb);
	dentry = lookup_one_len_unlocked(name->name, dir, name->len);
	revert_creds(old_cred);
M
Miklos Szeredi 已提交
428 429 430 431 432 433 434

	if (IS_ERR(dentry)) {
		if (PTR_ERR(dentry) == -ENOENT)
			dentry = NULL;
	} else if (!dentry->d_inode) {
		dput(dentry);
		dentry = NULL;
435
	} else if (ovl_dentry_weird(dentry)) {
436
		dput(dentry);
437
		/* Don't support traversing automounts and other weirdness */
438
		dentry = ERR_PTR(-EREMOTE);
M
Miklos Szeredi 已提交
439 440 441 442
	}
	return dentry;
}

M
Miklos Szeredi 已提交
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
/*
 * Returns next layer in stack starting from top.
 * Returns -1 if this is the last layer.
 */
int ovl_path_next(int idx, struct dentry *dentry, struct path *path)
{
	struct ovl_entry *oe = dentry->d_fsdata;

	BUG_ON(idx < 0);
	if (idx == 0) {
		ovl_path_upper(dentry, path);
		if (path->dentry)
			return oe->numlower ? 1 : -1;
		idx++;
	}
	BUG_ON(idx > oe->numlower);
	*path = oe->lowerstack[idx - 1];

	return (idx < oe->numlower) ? idx + 1 : -1;
}

M
Miklos Szeredi 已提交
464 465 466 467
struct dentry *ovl_lookup(struct inode *dir, struct dentry *dentry,
			  unsigned int flags)
{
	struct ovl_entry *oe;
M
Miklos Szeredi 已提交
468 469 470 471
	struct ovl_entry *poe = dentry->d_parent->d_fsdata;
	struct path *stack = NULL;
	struct dentry *upperdir, *upperdentry = NULL;
	unsigned int ctr = 0;
M
Miklos Szeredi 已提交
472
	struct inode *inode = NULL;
M
Miklos Szeredi 已提交
473 474 475
	bool upperopaque = false;
	struct dentry *this, *prev = NULL;
	unsigned int i;
M
Miklos Szeredi 已提交
476 477
	int err;

M
Miklos Szeredi 已提交
478
	upperdir = ovl_upperdentry_dereference(poe);
M
Miklos Szeredi 已提交
479
	if (upperdir) {
480
		this = ovl_lookup_real(dentry->d_sb, upperdir, &dentry->d_name);
M
Miklos Szeredi 已提交
481 482 483 484
		err = PTR_ERR(this);
		if (IS_ERR(this))
			goto out;

485
		if (this) {
486 487 488 489 490
			if (unlikely(ovl_dentry_remote(this))) {
				dput(this);
				err = -EREMOTE;
				goto out;
			}
M
Miklos Szeredi 已提交
491 492 493 494
			if (ovl_is_whiteout(this)) {
				dput(this);
				this = NULL;
				upperopaque = true;
495
			} else if (poe->numlower && ovl_is_opaquedir(this)) {
M
Miklos Szeredi 已提交
496
				upperopaque = true;
M
Miklos Szeredi 已提交
497 498
			}
		}
M
Miklos Szeredi 已提交
499
		upperdentry = prev = this;
M
Miklos Szeredi 已提交
500
	}
M
Miklos Szeredi 已提交
501 502 503 504 505 506

	if (!upperopaque && poe->numlower) {
		err = -ENOMEM;
		stack = kcalloc(poe->numlower, sizeof(struct path), GFP_KERNEL);
		if (!stack)
			goto out_put_upper;
M
Miklos Szeredi 已提交
507 508
	}

M
Miklos Szeredi 已提交
509 510 511 512
	for (i = 0; !upperopaque && i < poe->numlower; i++) {
		bool opaque = false;
		struct path lowerpath = poe->lowerstack[i];

513 514
		this = ovl_lookup_real(dentry->d_sb,
				       lowerpath.dentry, &dentry->d_name);
M
Miklos Szeredi 已提交
515
		err = PTR_ERR(this);
516 517 518 519 520 521
		if (IS_ERR(this)) {
			/*
			 * If it's positive, then treat ENAMETOOLONG as ENOENT.
			 */
			if (err == -ENAMETOOLONG && (upperdentry || ctr))
				continue;
M
Miklos Szeredi 已提交
522
			goto out_put;
523
		}
M
Miklos Szeredi 已提交
524 525
		if (!this)
			continue;
526 527 528 529
		if (ovl_is_whiteout(this)) {
			dput(this);
			break;
		}
M
Miklos Szeredi 已提交
530
		/*
531 532
		 * Only makes sense to check opaque dir if this is not the
		 * lowermost layer.
M
Miklos Szeredi 已提交
533
		 */
534 535
		if (i < poe->numlower - 1 && ovl_is_opaquedir(this))
			opaque = true;
536 537 538 539 540 541 542

		if (prev && (!S_ISDIR(prev->d_inode->i_mode) ||
			     !S_ISDIR(this->d_inode->i_mode))) {
			/*
			 * FIXME: check for upper-opaqueness maybe better done
			 * in remove code.
			 */
M
Miklos Szeredi 已提交
543 544 545 546 547
			if (prev == upperdentry)
				upperopaque = true;
			dput(this);
			break;
		}
548 549 550 551 552 553
		/*
		 * If this is a non-directory then stop here.
		 */
		if (!S_ISDIR(this->d_inode->i_mode))
			opaque = true;

M
Miklos Szeredi 已提交
554 555 556 557 558 559
		stack[ctr].dentry = this;
		stack[ctr].mnt = lowerpath.mnt;
		ctr++;
		prev = this;
		if (opaque)
			break;
M
Miklos Szeredi 已提交
560 561
	}

M
Miklos Szeredi 已提交
562 563 564 565 566 567
	oe = ovl_alloc_entry(ctr);
	err = -ENOMEM;
	if (!oe)
		goto out_put;

	if (upperdentry || ctr) {
M
Miklos Szeredi 已提交
568
		struct dentry *realdentry;
569
		struct inode *realinode;
M
Miklos Szeredi 已提交
570

M
Miklos Szeredi 已提交
571
		realdentry = upperdentry ? upperdentry : stack[0].dentry;
572
		realinode = d_inode(realdentry);
M
Miklos Szeredi 已提交
573

M
Miklos Szeredi 已提交
574
		err = -ENOMEM;
575
		inode = ovl_new_inode(dentry->d_sb, realinode->i_mode);
M
Miklos Szeredi 已提交
576
		if (!inode)
M
Miklos Szeredi 已提交
577
			goto out_free_oe;
578
		ovl_inode_init(inode, realinode, !!upperdentry);
M
Miklos Szeredi 已提交
579 580 581
		ovl_copyattr(realdentry->d_inode, inode);
	}

M
Miklos Szeredi 已提交
582
	oe->opaque = upperopaque;
M
Miklos Szeredi 已提交
583
	oe->__upperdentry = upperdentry;
M
Miklos Szeredi 已提交
584 585
	memcpy(oe->lowerstack, stack, sizeof(struct path) * ctr);
	kfree(stack);
M
Miklos Szeredi 已提交
586 587 588 589 590
	dentry->d_fsdata = oe;
	d_add(dentry, inode);

	return NULL;

M
Miklos Szeredi 已提交
591
out_free_oe:
M
Miklos Szeredi 已提交
592
	kfree(oe);
M
Miklos Szeredi 已提交
593 594 595 596 597 598
out_put:
	for (i = 0; i < ctr; i++)
		dput(stack[i].dentry);
	kfree(stack);
out_put_upper:
	dput(upperdentry);
M
Miklos Szeredi 已提交
599 600 601 602 603 604
out:
	return ERR_PTR(err);
}

struct file *ovl_path_open(struct path *path, int flags)
{
M
Miklos Szeredi 已提交
605
	return dentry_open(path, flags | O_NOATIME, current_cred());
M
Miklos Szeredi 已提交
606 607 608 609 610
}

static void ovl_put_super(struct super_block *sb)
{
	struct ovl_fs *ufs = sb->s_fs_info;
611
	unsigned i;
M
Miklos Szeredi 已提交
612 613 614

	dput(ufs->workdir);
	mntput(ufs->upper_mnt);
615 616
	for (i = 0; i < ufs->numlower; i++)
		mntput(ufs->lower_mnt[i]);
617
	kfree(ufs->lower_mnt);
M
Miklos Szeredi 已提交
618

E
Erez Zadok 已提交
619 620 621
	kfree(ufs->config.lowerdir);
	kfree(ufs->config.upperdir);
	kfree(ufs->config.workdir);
622
	put_cred(ufs->creator_cred);
M
Miklos Szeredi 已提交
623 624 625
	kfree(ufs);
}

A
Andy Whitcroft 已提交
626 627 628 629 630 631
/**
 * ovl_statfs
 * @sb: The overlayfs super block
 * @buf: The struct kstatfs to fill in with stats
 *
 * Get the filesystem statistics.  As writes always target the upper layer
632
 * filesystem pass the statfs to the upper filesystem (if it exists)
A
Andy Whitcroft 已提交
633 634 635 636 637 638 639 640
 */
static int ovl_statfs(struct dentry *dentry, struct kstatfs *buf)
{
	struct ovl_fs *ofs = dentry->d_sb->s_fs_info;
	struct dentry *root_dentry = dentry->d_sb->s_root;
	struct path path;
	int err;

641
	ovl_path_real(root_dentry, &path);
A
Andy Whitcroft 已提交
642 643 644 645 646 647 648 649 650 651

	err = vfs_statfs(&path, buf);
	if (!err) {
		buf->f_namelen = max(buf->f_namelen, ofs->lower_namelen);
		buf->f_type = OVERLAYFS_SUPER_MAGIC;
	}

	return err;
}

E
Erez Zadok 已提交
652 653 654 655 656 657 658 659 660 661 662
/**
 * ovl_show_options
 *
 * Prints the mount options for a given superblock.
 * Returns zero; does not fail.
 */
static int ovl_show_options(struct seq_file *m, struct dentry *dentry)
{
	struct super_block *sb = dentry->d_sb;
	struct ovl_fs *ufs = sb->s_fs_info;

663
	seq_show_option(m, "lowerdir", ufs->config.lowerdir);
M
Miklos Szeredi 已提交
664
	if (ufs->config.upperdir) {
665 666
		seq_show_option(m, "upperdir", ufs->config.upperdir);
		seq_show_option(m, "workdir", ufs->config.workdir);
M
Miklos Szeredi 已提交
667
	}
M
Miklos Szeredi 已提交
668 669
	if (ufs->config.default_permissions)
		seq_puts(m, ",default_permissions");
E
Erez Zadok 已提交
670 671 672
	return 0;
}

673 674 675 676
static int ovl_remount(struct super_block *sb, int *flags, char *data)
{
	struct ovl_fs *ufs = sb->s_fs_info;

677
	if (!(*flags & MS_RDONLY) && (!ufs->upper_mnt || !ufs->workdir))
678 679 680 681 682
		return -EROFS;

	return 0;
}

M
Miklos Szeredi 已提交
683 684
static const struct super_operations ovl_super_operations = {
	.put_super	= ovl_put_super,
A
Andy Whitcroft 已提交
685
	.statfs		= ovl_statfs,
E
Erez Zadok 已提交
686
	.show_options	= ovl_show_options,
687
	.remount_fs	= ovl_remount,
M
Miklos Szeredi 已提交
688
	.drop_inode	= generic_delete_inode,
M
Miklos Szeredi 已提交
689 690 691 692 693 694
};

enum {
	OPT_LOWERDIR,
	OPT_UPPERDIR,
	OPT_WORKDIR,
M
Miklos Szeredi 已提交
695
	OPT_DEFAULT_PERMISSIONS,
M
Miklos Szeredi 已提交
696 697 698 699 700 701 702
	OPT_ERR,
};

static const match_table_t ovl_tokens = {
	{OPT_LOWERDIR,			"lowerdir=%s"},
	{OPT_UPPERDIR,			"upperdir=%s"},
	{OPT_WORKDIR,			"workdir=%s"},
M
Miklos Szeredi 已提交
703
	{OPT_DEFAULT_PERMISSIONS,	"default_permissions"},
M
Miklos Szeredi 已提交
704 705 706
	{OPT_ERR,			NULL}
};

M
Miklos Szeredi 已提交
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
static char *ovl_next_opt(char **s)
{
	char *sbegin = *s;
	char *p;

	if (sbegin == NULL)
		return NULL;

	for (p = sbegin; *p; p++) {
		if (*p == '\\') {
			p++;
			if (!*p)
				break;
		} else if (*p == ',') {
			*p = '\0';
			*s = p + 1;
			return sbegin;
		}
	}
	*s = NULL;
	return sbegin;
}

M
Miklos Szeredi 已提交
730 731 732 733
static int ovl_parse_opt(char *opt, struct ovl_config *config)
{
	char *p;

M
Miklos Szeredi 已提交
734
	while ((p = ovl_next_opt(&opt)) != NULL) {
M
Miklos Szeredi 已提交
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
		int token;
		substring_t args[MAX_OPT_ARGS];

		if (!*p)
			continue;

		token = match_token(p, ovl_tokens, args);
		switch (token) {
		case OPT_UPPERDIR:
			kfree(config->upperdir);
			config->upperdir = match_strdup(&args[0]);
			if (!config->upperdir)
				return -ENOMEM;
			break;

		case OPT_LOWERDIR:
			kfree(config->lowerdir);
			config->lowerdir = match_strdup(&args[0]);
			if (!config->lowerdir)
				return -ENOMEM;
			break;

		case OPT_WORKDIR:
			kfree(config->workdir);
			config->workdir = match_strdup(&args[0]);
			if (!config->workdir)
				return -ENOMEM;
			break;

M
Miklos Szeredi 已提交
764 765 766 767
		case OPT_DEFAULT_PERMISSIONS:
			config->default_permissions = true;
			break;

M
Miklos Szeredi 已提交
768
		default:
769
			pr_err("overlayfs: unrecognized mount option \"%s\" or missing value\n", p);
M
Miklos Szeredi 已提交
770 771 772
			return -EINVAL;
		}
	}
H
hujianyang 已提交
773 774 775 776 777 778 779 780 781

	/* Workdir is useless in non-upper mount */
	if (!config->upperdir && config->workdir) {
		pr_info("overlayfs: option \"workdir=%s\" is useless in a non-upper mount, ignore\n",
			config->workdir);
		kfree(config->workdir);
		config->workdir = NULL;
	}

M
Miklos Szeredi 已提交
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
	return 0;
}

#define OVL_WORKDIR_NAME "work"

static struct dentry *ovl_workdir_create(struct vfsmount *mnt,
					 struct dentry *dentry)
{
	struct inode *dir = dentry->d_inode;
	struct dentry *work;
	int err;
	bool retried = false;

	err = mnt_want_write(mnt);
	if (err)
		return ERR_PTR(err);

A
Al Viro 已提交
799
	inode_lock_nested(dir, I_MUTEX_PARENT);
M
Miklos Szeredi 已提交
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
retry:
	work = lookup_one_len(OVL_WORKDIR_NAME, dentry,
			      strlen(OVL_WORKDIR_NAME));

	if (!IS_ERR(work)) {
		struct kstat stat = {
			.mode = S_IFDIR | 0,
		};

		if (work->d_inode) {
			err = -EEXIST;
			if (retried)
				goto out_dput;

			retried = true;
			ovl_cleanup(dir, work);
			dput(work);
			goto retry;
		}

		err = ovl_create_real(dir, work, &stat, NULL, NULL, true);
		if (err)
			goto out_dput;
	}
out_unlock:
A
Al Viro 已提交
825
	inode_unlock(dir);
M
Miklos Szeredi 已提交
826 827 828 829 830 831 832 833 834 835
	mnt_drop_write(mnt);

	return work;

out_dput:
	dput(work);
	work = ERR_PTR(err);
	goto out_unlock;
}

M
Miklos Szeredi 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848
static void ovl_unescape(char *s)
{
	char *d = s;

	for (;; s++, d++) {
		if (*s == '\\')
			s++;
		*d = *s;
		if (!*s)
			break;
	}
}

M
Miklos Szeredi 已提交
849 850
static int ovl_mount_dir_noesc(const char *name, struct path *path)
{
851
	int err = -EINVAL;
M
Miklos Szeredi 已提交
852

853 854 855 856
	if (!*name) {
		pr_err("overlayfs: empty lowerdir\n");
		goto out;
	}
M
Miklos Szeredi 已提交
857 858 859 860 861 862
	err = kern_path(name, LOOKUP_FOLLOW, path);
	if (err) {
		pr_err("overlayfs: failed to resolve '%s': %i\n", name, err);
		goto out;
	}
	err = -EINVAL;
863
	if (ovl_dentry_weird(path->dentry)) {
M
Miklos Szeredi 已提交
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
		pr_err("overlayfs: filesystem on '%s' not supported\n", name);
		goto out_put;
	}
	if (!S_ISDIR(path->dentry->d_inode->i_mode)) {
		pr_err("overlayfs: '%s' not a directory\n", name);
		goto out_put;
	}
	return 0;

out_put:
	path_put(path);
out:
	return err;
}

static int ovl_mount_dir(const char *name, struct path *path)
{
	int err = -ENOMEM;
	char *tmp = kstrdup(name, GFP_KERNEL);

	if (tmp) {
		ovl_unescape(tmp);
		err = ovl_mount_dir_noesc(tmp, path);
887 888 889 890 891 892 893 894

		if (!err)
			if (ovl_dentry_remote(path->dentry)) {
				pr_err("overlayfs: filesystem on '%s' not supported as upperdir\n",
				       tmp);
				path_put(path);
				err = -EINVAL;
			}
M
Miklos Szeredi 已提交
895 896 897 898 899 900
		kfree(tmp);
	}
	return err;
}

static int ovl_lower_dir(const char *name, struct path *path, long *namelen,
901
			 int *stack_depth, bool *remote)
M
Miklos Szeredi 已提交
902 903 904 905
{
	int err;
	struct kstatfs statfs;

906
	err = ovl_mount_dir_noesc(name, path);
M
Miklos Szeredi 已提交
907 908 909 910 911 912 913 914 915 916 917
	if (err)
		goto out;

	err = vfs_statfs(path, &statfs);
	if (err) {
		pr_err("overlayfs: statfs failed on '%s'\n", name);
		goto out_put;
	}
	*namelen = max(*namelen, statfs.f_namelen);
	*stack_depth = max(*stack_depth, path->mnt->mnt_sb->s_stack_depth);

918 919 920
	if (ovl_dentry_remote(path->dentry))
		*remote = true;

M
Miklos Szeredi 已提交
921 922 923 924 925 926 927 928
	return 0;

out_put:
	path_put(path);
out:
	return err;
}

M
Miklos Szeredi 已提交
929 930 931 932 933 934 935 936 937 938 939 940
/* Workdir should not be subdir of upperdir and vice versa */
static bool ovl_workdir_ok(struct dentry *workdir, struct dentry *upperdir)
{
	bool ok = false;

	if (workdir != upperdir) {
		ok = (lock_rename(workdir, upperdir) == NULL);
		unlock_rename(workdir, upperdir);
	}
	return ok;
}

941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
static unsigned int ovl_split_lowerdirs(char *str)
{
	unsigned int ctr = 1;
	char *s, *d;

	for (s = d = str;; s++, d++) {
		if (*s == '\\') {
			s++;
		} else if (*s == ':') {
			*d = '\0';
			ctr++;
			continue;
		}
		*d = *s;
		if (!*s)
			break;
	}
	return ctr;
}

M
Miklos Szeredi 已提交
961 962
static int ovl_fill_super(struct super_block *sb, void *data, int silent)
{
M
Miklos Szeredi 已提交
963 964
	struct path upperpath = { NULL, NULL };
	struct path workpath = { NULL, NULL };
M
Miklos Szeredi 已提交
965
	struct dentry *root_dentry;
966
	struct inode *realinode;
M
Miklos Szeredi 已提交
967 968
	struct ovl_entry *oe;
	struct ovl_fs *ufs;
969 970 971 972 973
	struct path *stack = NULL;
	char *lowertmp;
	char *lower;
	unsigned int numlower;
	unsigned int stacklen = 0;
974
	unsigned int i;
975
	bool remote = false;
M
Miklos Szeredi 已提交
976 977
	int err;

E
Erez Zadok 已提交
978 979 980
	err = -ENOMEM;
	ufs = kzalloc(sizeof(struct ovl_fs), GFP_KERNEL);
	if (!ufs)
M
Miklos Szeredi 已提交
981 982
		goto out;

E
Erez Zadok 已提交
983 984 985 986
	err = ovl_parse_opt((char *) data, &ufs->config);
	if (err)
		goto out_free_config;

M
Miklos Szeredi 已提交
987
	err = -EINVAL;
M
Miklos Szeredi 已提交
988
	if (!ufs->config.lowerdir) {
989 990
		if (!silent)
			pr_err("overlayfs: missing 'lowerdir'\n");
M
Miklos Szeredi 已提交
991 992 993
		goto out_free_config;
	}

M
Miklos Szeredi 已提交
994
	sb->s_stack_depth = 0;
995
	sb->s_maxbytes = MAX_LFS_FILESIZE;
M
Miklos Szeredi 已提交
996 997 998 999 1000
	if (ufs->config.upperdir) {
		if (!ufs->config.workdir) {
			pr_err("overlayfs: missing 'workdir'\n");
			goto out_free_config;
		}
M
Miklos Szeredi 已提交
1001

M
Miklos Szeredi 已提交
1002 1003 1004
		err = ovl_mount_dir(ufs->config.upperdir, &upperpath);
		if (err)
			goto out_free_config;
M
Miklos Szeredi 已提交
1005

H
hujianyang 已提交
1006 1007 1008 1009 1010 1011 1012
		/* Upper fs should not be r/o */
		if (upperpath.mnt->mnt_sb->s_flags & MS_RDONLY) {
			pr_err("overlayfs: upper fs is r/o, try multi-lower layers mount\n");
			err = -EINVAL;
			goto out_put_upperpath;
		}

M
Miklos Szeredi 已提交
1013 1014 1015 1016
		err = ovl_mount_dir(ufs->config.workdir, &workpath);
		if (err)
			goto out_put_upperpath;

1017
		err = -EINVAL;
M
Miklos Szeredi 已提交
1018 1019 1020 1021 1022 1023 1024 1025 1026
		if (upperpath.mnt != workpath.mnt) {
			pr_err("overlayfs: workdir and upperdir must reside under the same mount\n");
			goto out_put_workpath;
		}
		if (!ovl_workdir_ok(workpath.dentry, upperpath.dentry)) {
			pr_err("overlayfs: workdir and upperdir must be separate subtrees\n");
			goto out_put_workpath;
		}
		sb->s_stack_depth = upperpath.mnt->mnt_sb->s_stack_depth;
A
Andy Whitcroft 已提交
1027
	}
1028 1029 1030
	err = -ENOMEM;
	lowertmp = kstrdup(ufs->config.lowerdir, GFP_KERNEL);
	if (!lowertmp)
M
Miklos Szeredi 已提交
1031
		goto out_put_workpath;
1032

1033 1034
	err = -EINVAL;
	stacklen = ovl_split_lowerdirs(lowertmp);
1035 1036 1037
	if (stacklen > OVL_MAX_STACK) {
		pr_err("overlayfs: too many lower directries, limit is %d\n",
		       OVL_MAX_STACK);
1038
		goto out_free_lowertmp;
1039 1040 1041 1042
	} else if (!ufs->config.upperdir && stacklen == 1) {
		pr_err("overlayfs: at least 2 lowerdir are needed while upperdir nonexistent\n");
		goto out_free_lowertmp;
	}
1043 1044 1045 1046 1047 1048 1049 1050

	stack = kcalloc(stacklen, sizeof(struct path), GFP_KERNEL);
	if (!stack)
		goto out_free_lowertmp;

	lower = lowertmp;
	for (numlower = 0; numlower < stacklen; numlower++) {
		err = ovl_lower_dir(lower, &stack[numlower],
1051 1052
				    &ufs->lower_namelen, &sb->s_stack_depth,
				    &remote);
1053 1054 1055 1056 1057 1058
		if (err)
			goto out_put_lowerpath;

		lower = strchr(lower, '\0') + 1;
	}

1059
	err = -EINVAL;
M
Miklos Szeredi 已提交
1060
	sb->s_stack_depth++;
1061 1062
	if (sb->s_stack_depth > FILESYSTEM_MAX_STACK_DEPTH) {
		pr_err("overlayfs: maximum fs stacking depth exceeded\n");
1063
		goto out_put_lowerpath;
1064 1065
	}

M
Miklos Szeredi 已提交
1066 1067 1068 1069 1070 1071 1072
	if (ufs->config.upperdir) {
		ufs->upper_mnt = clone_private_mount(&upperpath);
		err = PTR_ERR(ufs->upper_mnt);
		if (IS_ERR(ufs->upper_mnt)) {
			pr_err("overlayfs: failed to clone upperpath\n");
			goto out_put_lowerpath;
		}
M
Miklos Szeredi 已提交
1073 1074 1075 1076
		/* Don't inherit atime flags */
		ufs->upper_mnt->mnt_flags &= ~(MNT_NOATIME | MNT_NODIRATIME | MNT_RELATIME);

		sb->s_time_gran = ufs->upper_mnt->mnt_sb->s_time_gran;
1077

M
Miklos Szeredi 已提交
1078 1079 1080
		ufs->workdir = ovl_workdir_create(ufs->upper_mnt, workpath.dentry);
		err = PTR_ERR(ufs->workdir);
		if (IS_ERR(ufs->workdir)) {
1081 1082 1083 1084
			pr_warn("overlayfs: failed to create directory %s/%s (errno: %i); mounting read-only\n",
				ufs->config.workdir, OVL_WORKDIR_NAME, -err);
			sb->s_flags |= MS_RDONLY;
			ufs->workdir = NULL;
M
Miklos Szeredi 已提交
1085
		}
1086 1087 1088 1089

		/*
		 * Upper should support d_type, else whiteouts are visible.
		 * Given workdir and upper are on same fs, we can do
1090 1091
		 * iterate_dir() on workdir. This check requires successful
		 * creation of workdir in previous step.
1092
		 */
1093 1094 1095 1096
		if (ufs->workdir) {
			err = ovl_check_d_type_supported(&workpath);
			if (err < 0)
				goto out_put_workdir;
1097

1098 1099 1100 1101 1102 1103 1104
			/*
			 * We allowed this configuration and don't want to
			 * break users over kernel upgrade. So warn instead
			 * of erroring out.
			 */
			if (!err)
				pr_warn("overlayfs: upper fs needs to support d_type.\n");
1105
		}
M
Miklos Szeredi 已提交
1106 1107
	}

1108
	err = -ENOMEM;
1109
	ufs->lower_mnt = kcalloc(numlower, sizeof(struct vfsmount *), GFP_KERNEL);
1110
	if (ufs->lower_mnt == NULL)
1111
		goto out_put_workdir;
1112 1113
	for (i = 0; i < numlower; i++) {
		struct vfsmount *mnt = clone_private_mount(&stack[i]);
1114

1115
		err = PTR_ERR(mnt);
1116 1117 1118 1119 1120 1121 1122 1123
		if (IS_ERR(mnt)) {
			pr_err("overlayfs: failed to clone lowerpath\n");
			goto out_put_lower_mnt;
		}
		/*
		 * Make lower_mnt R/O.  That way fchmod/fchown on lower file
		 * will fail instead of modifying lower fs.
		 */
M
Miklos Szeredi 已提交
1124
		mnt->mnt_flags |= MNT_READONLY | MNT_NOATIME;
1125

1126 1127 1128
		ufs->lower_mnt[ufs->numlower] = mnt;
		ufs->numlower++;
	}
M
Miklos Szeredi 已提交
1129

H
hujianyang 已提交
1130 1131
	/* If the upper fs is nonexistent, we mark overlayfs r/o too */
	if (!ufs->upper_mnt)
M
Miklos Szeredi 已提交
1132 1133
		sb->s_flags |= MS_RDONLY;

1134 1135 1136 1137
	if (remote)
		sb->s_d_op = &ovl_reval_dentry_operations;
	else
		sb->s_d_op = &ovl_dentry_operations;
M
Miklos Szeredi 已提交
1138

1139 1140 1141 1142
	ufs->creator_cred = prepare_creds();
	if (!ufs->creator_cred)
		goto out_put_lower_mnt;

M
Miklos Szeredi 已提交
1143
	err = -ENOMEM;
1144
	oe = ovl_alloc_entry(numlower);
1145
	if (!oe)
1146
		goto out_put_cred;
M
Miklos Szeredi 已提交
1147

1148
	root_dentry = d_make_root(ovl_new_inode(sb, S_IFDIR));
M
Miklos Szeredi 已提交
1149
	if (!root_dentry)
1150
		goto out_free_oe;
M
Miklos Szeredi 已提交
1151 1152

	mntput(upperpath.mnt);
1153 1154
	for (i = 0; i < numlower; i++)
		mntput(stack[i].mnt);
M
Miklos Szeredi 已提交
1155
	path_put(&workpath);
1156
	kfree(lowertmp);
M
Miklos Szeredi 已提交
1157 1158

	oe->__upperdentry = upperpath.dentry;
1159 1160 1161 1162
	for (i = 0; i < numlower; i++) {
		oe->lowerstack[i].dentry = stack[i].dentry;
		oe->lowerstack[i].mnt = ufs->lower_mnt[i];
	}
1163
	kfree(stack);
M
Miklos Szeredi 已提交
1164 1165 1166

	root_dentry->d_fsdata = oe;

1167 1168 1169
	realinode = d_inode(ovl_dentry_real(root_dentry));
	ovl_inode_init(d_inode(root_dentry), realinode, !!upperpath.dentry);
	ovl_copyattr(realinode, d_inode(root_dentry));
M
Miklos Szeredi 已提交
1170

A
Andy Whitcroft 已提交
1171
	sb->s_magic = OVERLAYFS_SUPER_MAGIC;
M
Miklos Szeredi 已提交
1172 1173 1174
	sb->s_op = &ovl_super_operations;
	sb->s_root = root_dentry;
	sb->s_fs_info = ufs;
1175
	sb->s_flags |= MS_POSIXACL;
M
Miklos Szeredi 已提交
1176 1177 1178

	return 0;

1179 1180
out_free_oe:
	kfree(oe);
1181 1182
out_put_cred:
	put_cred(ufs->creator_cred);
M
Miklos Szeredi 已提交
1183
out_put_lower_mnt:
1184 1185 1186
	for (i = 0; i < ufs->numlower; i++)
		mntput(ufs->lower_mnt[i]);
	kfree(ufs->lower_mnt);
1187 1188
out_put_workdir:
	dput(ufs->workdir);
M
Miklos Szeredi 已提交
1189 1190
	mntput(ufs->upper_mnt);
out_put_lowerpath:
1191 1192 1193 1194 1195
	for (i = 0; i < numlower; i++)
		path_put(&stack[i]);
	kfree(stack);
out_free_lowertmp:
	kfree(lowertmp);
1196 1197
out_put_workpath:
	path_put(&workpath);
M
Miklos Szeredi 已提交
1198 1199 1200
out_put_upperpath:
	path_put(&upperpath);
out_free_config:
E
Erez Zadok 已提交
1201 1202 1203 1204
	kfree(ufs->config.lowerdir);
	kfree(ufs->config.upperdir);
	kfree(ufs->config.workdir);
	kfree(ufs);
M
Miklos Szeredi 已提交
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
out:
	return err;
}

static struct dentry *ovl_mount(struct file_system_type *fs_type, int flags,
				const char *dev_name, void *raw_data)
{
	return mount_nodev(fs_type, flags, raw_data, ovl_fill_super);
}

static struct file_system_type ovl_fs_type = {
	.owner		= THIS_MODULE,
1217
	.name		= "overlay",
M
Miklos Szeredi 已提交
1218 1219 1220
	.mount		= ovl_mount,
	.kill_sb	= kill_anon_super,
};
1221
MODULE_ALIAS_FS("overlay");
M
Miklos Szeredi 已提交
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234

static int __init ovl_init(void)
{
	return register_filesystem(&ovl_fs_type);
}

static void __exit ovl_exit(void)
{
	unregister_filesystem(&ovl_fs_type);
}

module_init(ovl_init);
module_exit(ovl_exit);