super.c 35.3 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 *  linux/fs/super.c
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 *
 *  super.c contains code to handle: - mount structures
 *                                   - super-block tables
 *                                   - filesystem drivers list
 *                                   - mount system call
 *                                   - umount system call
 *                                   - ustat system call
 *
 * GK 2/5/95  -  Changed to support mounting the root fs via NFS
 *
 *  Added kerneld support: Jacques Gelinas and Bjorn Ekwall
 *  Added change_root: Werner Almesberger & Hans Lermen, Feb '96
 *  Added options to /proc/mounts:
18
 *    Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
L
Linus Torvalds 已提交
19 20 21 22
 *  Added devfs support: Richard Gooch <rgooch@atnf.csiro.au>, 13-JAN-1998
 *  Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
 */

23
#include <linux/export.h>
L
Linus Torvalds 已提交
24 25 26 27 28 29
#include <linux/slab.h>
#include <linux/blkdev.h>
#include <linux/mount.h>
#include <linux/security.h>
#include <linux/writeback.h>		/* for the emergency remount stuff */
#include <linux/idr.h>
I
Ingo Molnar 已提交
30
#include <linux/mutex.h>
31
#include <linux/backing-dev.h>
32
#include <linux/rculist_bl.h>
33
#include <linux/cleancache.h>
A
Al Viro 已提交
34
#include <linux/fsnotify.h>
35
#include <linux/lockdep.h>
36
#include "internal.h"
L
Linus Torvalds 已提交
37 38 39 40 41


LIST_HEAD(super_blocks);
DEFINE_SPINLOCK(sb_lock);

42 43 44 45 46 47
static char *sb_writers_name[SB_FREEZE_LEVELS] = {
	"sb_writers",
	"sb_pagefaults",
	"sb_internal",
};

48 49 50 51 52 53 54
/*
 * One thing we have to be careful of with a per-sb shrinker is that we don't
 * drop the last active reference to the superblock from within the shrinker.
 * If that happens we could trigger unregistering the shrinker from within the
 * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
 * take a passive reference to the superblock to avoid this from occurring.
 */
55 56
static unsigned long super_cache_scan(struct shrinker *shrink,
				      struct shrink_control *sc)
57 58
{
	struct super_block *sb;
59 60 61 62 63
	long	fs_objects = 0;
	long	total_objects;
	long	freed = 0;
	long	dentries;
	long	inodes;
64 65 66 67 68 69 70

	sb = container_of(shrink, struct super_block, s_shrink);

	/*
	 * Deadlock avoidance.  We may hold various FS locks, and we don't want
	 * to recurse into the FS that called us in clear_inode() and friends..
	 */
71 72
	if (!(sc->gfp_mask & __GFP_FS))
		return SHRINK_STOP;
73 74

	if (!grab_super_passive(sb))
75
		return SHRINK_STOP;
76

A
Al Viro 已提交
77
	if (sb->s_op->nr_cached_objects)
78
		fs_objects = sb->s_op->nr_cached_objects(sb, sc);
79

80 81
	inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
	dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
82
	total_objects = dentries + inodes + fs_objects + 1;
83 84
	if (!total_objects)
		total_objects = 1;
85

86
	/* proportion the scan between the caches */
87
	dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
88
	inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
89
	fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
90

91 92 93
	/*
	 * prune the dcache first as the icache is pinned by it, then
	 * prune the icache, followed by the filesystem specific caches
94 95 96
	 *
	 * Ensure that we always scan at least one object - memcg kmem
	 * accounting uses this to fully empty the caches.
97
	 */
98
	sc->nr_to_scan = dentries + 1;
99
	freed = prune_dcache_sb(sb, sc);
100
	sc->nr_to_scan = inodes + 1;
101
	freed += prune_icache_sb(sb, sc);
102

103
	if (fs_objects) {
104
		sc->nr_to_scan = fs_objects + 1;
105 106
		freed += sb->s_op->free_cached_objects(sb, sc);
	}
107

108 109 110 111 112 113 114 115 116 117 118 119
	drop_super(sb);
	return freed;
}

static unsigned long super_cache_count(struct shrinker *shrink,
				       struct shrink_control *sc)
{
	struct super_block *sb;
	long	total_objects = 0;

	sb = container_of(shrink, struct super_block, s_shrink);

120 121 122 123 124
	/*
	 * Don't call grab_super_passive as it is a potential
	 * scalability bottleneck. The counts could get updated
	 * between super_cache_count and super_cache_scan anyway.
	 * Call to super_cache_count with shrinker_rwsem held
125
	 * ensures the safety of call to list_lru_shrink_count() and
126 127
	 * s_op->nr_cached_objects().
	 */
128
	if (sb->s_op && sb->s_op->nr_cached_objects)
129
		total_objects = sb->s_op->nr_cached_objects(sb, sc);
130

131 132
	total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
	total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
133

134
	total_objects = vfs_pressure_ratio(total_objects);
135
	return total_objects;
136 137
}

138 139 140 141 142 143 144
/**
 *	destroy_super	-	frees a superblock
 *	@s: superblock to free
 *
 *	Frees a superblock.
 */
static void destroy_super(struct super_block *s)
145 146
{
	int i;
147 148
	list_lru_destroy(&s->s_dentry_lru);
	list_lru_destroy(&s->s_inode_lru);
149 150
	for (i = 0; i < SB_FREEZE_LEVELS; i++)
		percpu_counter_destroy(&s->s_writers.counter[i]);
151 152 153 154
	security_sb_free(s);
	WARN_ON(!list_empty(&s->s_mounts));
	kfree(s->s_subtype);
	kfree(s->s_options);
A
Al Viro 已提交
155
	kfree_rcu(s, rcu);
156 157
}

L
Linus Torvalds 已提交
158 159
/**
 *	alloc_super	-	create new superblock
160
 *	@type:	filesystem type superblock should belong to
D
David Howells 已提交
161
 *	@flags: the mount flags
L
Linus Torvalds 已提交
162 163 164 165
 *
 *	Allocates and initializes a new &struct super_block.  alloc_super()
 *	returns a pointer new superblock or %NULL if allocation had failed.
 */
D
David Howells 已提交
166
static struct super_block *alloc_super(struct file_system_type *type, int flags)
L
Linus Torvalds 已提交
167
{
168
	struct super_block *s = kzalloc(sizeof(struct super_block),  GFP_USER);
169
	static const struct super_operations default_op;
170 171 172 173
	int i;

	if (!s)
		return NULL;
L
Linus Torvalds 已提交
174

175 176
	INIT_LIST_HEAD(&s->s_mounts);

177 178
	if (security_sb_alloc(s))
		goto fail;
179

180
	for (i = 0; i < SB_FREEZE_LEVELS; i++) {
181 182
		if (percpu_counter_init(&s->s_writers.counter[i], 0,
					GFP_KERNEL) < 0)
183 184 185
			goto fail;
		lockdep_init_map(&s->s_writers.lock_map[i], sb_writers_name[i],
				 &type->s_writers_key[i], 0);
L
Linus Torvalds 已提交
186
	}
187 188 189 190 191 192 193 194
	init_waitqueue_head(&s->s_writers.wait);
	init_waitqueue_head(&s->s_writers.wait_unfrozen);
	s->s_flags = flags;
	s->s_bdi = &default_backing_dev_info;
	INIT_HLIST_NODE(&s->s_instances);
	INIT_HLIST_BL_HEAD(&s->s_anon);
	INIT_LIST_HEAD(&s->s_inodes);

V
Vladimir Davydov 已提交
195
	if (list_lru_init_memcg(&s->s_dentry_lru))
196
		goto fail;
V
Vladimir Davydov 已提交
197
	if (list_lru_init_memcg(&s->s_inode_lru))
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
		goto fail;

	init_rwsem(&s->s_umount);
	lockdep_set_class(&s->s_umount, &type->s_umount_key);
	/*
	 * sget() can have s_umount recursion.
	 *
	 * When it cannot find a suitable sb, it allocates a new
	 * one (this one), and tries again to find a suitable old
	 * one.
	 *
	 * In case that succeeds, it will acquire the s_umount
	 * lock of the old one. Since these are clearly distrinct
	 * locks, and this object isn't exposed yet, there's no
	 * risk of deadlocks.
	 *
	 * Annotate this by putting this lock in a different
	 * subclass.
	 */
	down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
	s->s_count = 1;
	atomic_set(&s->s_active, 1);
	mutex_init(&s->s_vfs_rename_mutex);
	lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
	mutex_init(&s->s_dquot.dqio_mutex);
	mutex_init(&s->s_dquot.dqonoff_mutex);
	s->s_maxbytes = MAX_NON_LFS;
	s->s_op = &default_op;
	s->s_time_gran = 1000000000;
	s->cleancache_poolid = -1;

	s->s_shrink.seeks = DEFAULT_SEEKS;
	s->s_shrink.scan_objects = super_cache_scan;
	s->s_shrink.count_objects = super_cache_count;
	s->s_shrink.batch = 1024;
V
Vladimir Davydov 已提交
233
	s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
L
Linus Torvalds 已提交
234
	return s;
235

236 237 238
fail:
	destroy_super(s);
	return NULL;
L
Linus Torvalds 已提交
239 240 241 242 243
}

/* Superblock refcounting  */

/*
A
Al Viro 已提交
244
 * Drop a superblock's refcount.  The caller must hold sb_lock.
L
Linus Torvalds 已提交
245
 */
A
Al Viro 已提交
246
static void __put_super(struct super_block *sb)
L
Linus Torvalds 已提交
247 248
{
	if (!--sb->s_count) {
249
		list_del_init(&sb->s_list);
L
Linus Torvalds 已提交
250 251 252 253 254 255 256 257 258 259 260
		destroy_super(sb);
	}
}

/**
 *	put_super	-	drop a temporary reference to superblock
 *	@sb: superblock in question
 *
 *	Drops a temporary reference, frees superblock if there's no
 *	references left.
 */
A
Al Viro 已提交
261
static void put_super(struct super_block *sb)
L
Linus Torvalds 已提交
262 263 264 265 266 267 268 269
{
	spin_lock(&sb_lock);
	__put_super(sb);
	spin_unlock(&sb_lock);
}


/**
270
 *	deactivate_locked_super	-	drop an active reference to superblock
L
Linus Torvalds 已提交
271 272
 *	@s: superblock to deactivate
 *
273 274
 *	Drops an active reference to superblock, converting it into a temprory
 *	one if there is no other active references left.  In that case we
L
Linus Torvalds 已提交
275 276
 *	tell fs driver to shut it down and drop the temporary reference we
 *	had just acquired.
277 278
 *
 *	Caller holds exclusive lock on superblock; that lock is released.
L
Linus Torvalds 已提交
279
 */
280
void deactivate_locked_super(struct super_block *s)
L
Linus Torvalds 已提交
281 282
{
	struct file_system_type *fs = s->s_type;
A
Al Viro 已提交
283
	if (atomic_dec_and_test(&s->s_active)) {
284
		cleancache_invalidate_fs(s);
285
		unregister_shrinker(&s->s_shrink);
286
		fs->kill_sb(s);
G
Glauber Costa 已提交
287

288 289 290 291 292 293 294 295
		/*
		 * Since list_lru_destroy() may sleep, we cannot call it from
		 * put_super(), where we hold the sb_lock. Therefore we destroy
		 * the lru lists right now.
		 */
		list_lru_destroy(&s->s_dentry_lru);
		list_lru_destroy(&s->s_inode_lru);

L
Linus Torvalds 已提交
296 297
		put_filesystem(fs);
		put_super(s);
298 299
	} else {
		up_write(&s->s_umount);
L
Linus Torvalds 已提交
300 301 302
	}
}

303
EXPORT_SYMBOL(deactivate_locked_super);
L
Linus Torvalds 已提交
304

A
Al Viro 已提交
305
/**
306
 *	deactivate_super	-	drop an active reference to superblock
A
Al Viro 已提交
307 308
 *	@s: superblock to deactivate
 *
309 310 311
 *	Variant of deactivate_locked_super(), except that superblock is *not*
 *	locked by caller.  If we are going to drop the final active reference,
 *	lock will be acquired prior to that.
A
Al Viro 已提交
312
 */
313
void deactivate_super(struct super_block *s)
A
Al Viro 已提交
314
{
315 316 317
        if (!atomic_add_unless(&s->s_active, -1, 1)) {
		down_write(&s->s_umount);
		deactivate_locked_super(s);
A
Al Viro 已提交
318 319 320
	}
}

321
EXPORT_SYMBOL(deactivate_super);
A
Al Viro 已提交
322

L
Linus Torvalds 已提交
323 324 325 326 327 328 329 330 331
/**
 *	grab_super - acquire an active reference
 *	@s: reference we are trying to make active
 *
 *	Tries to acquire an active reference.  grab_super() is used when we
 * 	had just found a superblock in super_blocks or fs_type->fs_supers
 *	and want to turn it into a full-blown active reference.  grab_super()
 *	is called with sb_lock held and drops it.  Returns 1 in case of
 *	success, 0 if we had failed (superblock contents was already dead or
A
Al Viro 已提交
332 333 334
 *	dying when grab_super() had been called).  Note that this is only
 *	called for superblocks not in rundown mode (== ones still on ->fs_supers
 *	of their type), so increment of ->s_count is OK here.
L
Linus Torvalds 已提交
335
 */
336
static int grab_super(struct super_block *s) __releases(sb_lock)
L
Linus Torvalds 已提交
337 338 339 340
{
	s->s_count++;
	spin_unlock(&sb_lock);
	down_write(&s->s_umount);
A
Al Viro 已提交
341 342 343 344
	if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
		put_super(s);
		return 1;
	}
L
Linus Torvalds 已提交
345 346 347 348 349
	up_write(&s->s_umount);
	put_super(s);
	return 0;
}

350 351
/*
 *	grab_super_passive - acquire a passive reference
W
Wanpeng Li 已提交
352
 *	@sb: reference we are trying to grab
353 354 355 356 357 358 359 360 361 362 363 364
 *
 *	Tries to acquire a passive reference. This is used in places where we
 *	cannot take an active reference but we need to ensure that the
 *	superblock does not go away while we are working on it. It returns
 *	false if a reference was not gained, and returns true with the s_umount
 *	lock held in read mode if a reference is gained. On successful return,
 *	the caller must drop the s_umount lock and the passive reference when
 *	done.
 */
bool grab_super_passive(struct super_block *sb)
{
	spin_lock(&sb_lock);
A
Al Viro 已提交
365
	if (hlist_unhashed(&sb->s_instances)) {
366 367 368 369 370 371 372 373
		spin_unlock(&sb_lock);
		return false;
	}

	sb->s_count++;
	spin_unlock(&sb_lock);

	if (down_read_trylock(&sb->s_umount)) {
A
Al Viro 已提交
374
		if (sb->s_root && (sb->s_flags & MS_BORN))
375 376 377 378 379 380 381 382
			return true;
		up_read(&sb->s_umount);
	}

	put_super(sb);
	return false;
}

L
Linus Torvalds 已提交
383 384 385 386 387 388 389 390 391
/**
 *	generic_shutdown_super	-	common helper for ->kill_sb()
 *	@sb: superblock to kill
 *
 *	generic_shutdown_super() does all fs-independent work on superblock
 *	shutdown.  Typical ->kill_sb() should pick all fs-specific objects
 *	that need destruction out of superblock, call generic_shutdown_super()
 *	and release aforementioned objects.  Note: dentries and inodes _are_
 *	taken care of and do not need specific handling.
392 393 394 395
 *
 *	Upon calling this function, the filesystem may no longer alter or
 *	rearrange the set of dentries belonging to this super_block, nor may it
 *	change the attachments of dentries to inodes.
L
Linus Torvalds 已提交
396 397 398
 */
void generic_shutdown_super(struct super_block *sb)
{
399
	const struct super_operations *sop = sb->s_op;
L
Linus Torvalds 已提交
400

401 402
	if (sb->s_root) {
		shrink_dcache_for_umount(sb);
403
		sync_filesystem(sb);
L
Linus Torvalds 已提交
404
		sb->s_flags &= ~MS_ACTIVE;
405

A
Al Viro 已提交
406 407 408
		fsnotify_unmount_inodes(&sb->s_inodes);

		evict_inodes(sb);
L
Linus Torvalds 已提交
409

410 411 412 413 414
		if (sb->s_dio_done_wq) {
			destroy_workqueue(sb->s_dio_done_wq);
			sb->s_dio_done_wq = NULL;
		}

L
Linus Torvalds 已提交
415 416 417
		if (sop->put_super)
			sop->put_super(sb);

A
Al Viro 已提交
418
		if (!list_empty(&sb->s_inodes)) {
419 420 421
			printk("VFS: Busy inodes after unmount of %s. "
			   "Self-destruct in 5 seconds.  Have a nice day...\n",
			   sb->s_id);
L
Linus Torvalds 已提交
422 423 424 425
		}
	}
	spin_lock(&sb_lock);
	/* should be initialized for __put_super_and_need_restart() */
A
Al Viro 已提交
426
	hlist_del_init(&sb->s_instances);
L
Linus Torvalds 已提交
427 428 429 430 431 432 433 434 435 436 437
	spin_unlock(&sb_lock);
	up_write(&sb->s_umount);
}

EXPORT_SYMBOL(generic_shutdown_super);

/**
 *	sget	-	find or create a superblock
 *	@type:	filesystem type superblock should belong to
 *	@test:	comparison callback
 *	@set:	setup callback
D
David Howells 已提交
438
 *	@flags:	mount flags
L
Linus Torvalds 已提交
439 440 441 442 443
 *	@data:	argument to each of them
 */
struct super_block *sget(struct file_system_type *type,
			int (*test)(struct super_block *,void *),
			int (*set)(struct super_block *,void *),
D
David Howells 已提交
444
			int flags,
L
Linus Torvalds 已提交
445 446 447
			void *data)
{
	struct super_block *s = NULL;
448
	struct super_block *old;
L
Linus Torvalds 已提交
449 450 451 452
	int err;

retry:
	spin_lock(&sb_lock);
453
	if (test) {
454
		hlist_for_each_entry(old, &type->fs_supers, s_instances) {
455 456 457 458
			if (!test(old, data))
				continue;
			if (!grab_super(old))
				goto retry;
L
Li Zefan 已提交
459 460
			if (s) {
				up_write(&s->s_umount);
461
				destroy_super(s);
A
Al Viro 已提交
462
				s = NULL;
L
Li Zefan 已提交
463
			}
464 465
			return old;
		}
L
Linus Torvalds 已提交
466 467 468
	}
	if (!s) {
		spin_unlock(&sb_lock);
D
David Howells 已提交
469
		s = alloc_super(type, flags);
L
Linus Torvalds 已提交
470 471 472 473 474 475 476 477
		if (!s)
			return ERR_PTR(-ENOMEM);
		goto retry;
	}
		
	err = set(s, data);
	if (err) {
		spin_unlock(&sb_lock);
L
Li Zefan 已提交
478
		up_write(&s->s_umount);
L
Linus Torvalds 已提交
479 480 481 482 483 484
		destroy_super(s);
		return ERR_PTR(err);
	}
	s->s_type = type;
	strlcpy(s->s_id, type->name, sizeof(s->s_id));
	list_add_tail(&s->s_list, &super_blocks);
A
Al Viro 已提交
485
	hlist_add_head(&s->s_instances, &type->fs_supers);
L
Linus Torvalds 已提交
486 487
	spin_unlock(&sb_lock);
	get_filesystem(type);
488
	register_shrinker(&s->s_shrink);
L
Linus Torvalds 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501
	return s;
}

EXPORT_SYMBOL(sget);

void drop_super(struct super_block *sb)
{
	up_read(&sb->s_umount);
	put_super(sb);
}

EXPORT_SYMBOL(drop_super);

A
Al Viro 已提交
502 503 504 505 506 507 508 509 510 511
/**
 *	iterate_supers - call function for all active superblocks
 *	@f: function to call
 *	@arg: argument to pass to it
 *
 *	Scans the superblock list and calls given function, passing it
 *	locked superblock and given argument.
 */
void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
{
512
	struct super_block *sb, *p = NULL;
A
Al Viro 已提交
513 514

	spin_lock(&sb_lock);
515
	list_for_each_entry(sb, &super_blocks, s_list) {
A
Al Viro 已提交
516
		if (hlist_unhashed(&sb->s_instances))
A
Al Viro 已提交
517 518 519 520 521
			continue;
		sb->s_count++;
		spin_unlock(&sb_lock);

		down_read(&sb->s_umount);
A
Al Viro 已提交
522
		if (sb->s_root && (sb->s_flags & MS_BORN))
A
Al Viro 已提交
523 524 525 526
			f(sb, arg);
		up_read(&sb->s_umount);

		spin_lock(&sb_lock);
527 528 529
		if (p)
			__put_super(p);
		p = sb;
A
Al Viro 已提交
530
	}
531 532
	if (p)
		__put_super(p);
A
Al Viro 已提交
533 534 535
	spin_unlock(&sb_lock);
}

A
Al Viro 已提交
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
/**
 *	iterate_supers_type - call function for superblocks of given type
 *	@type: fs type
 *	@f: function to call
 *	@arg: argument to pass to it
 *
 *	Scans the superblock list and calls given function, passing it
 *	locked superblock and given argument.
 */
void iterate_supers_type(struct file_system_type *type,
	void (*f)(struct super_block *, void *), void *arg)
{
	struct super_block *sb, *p = NULL;

	spin_lock(&sb_lock);
551
	hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
A
Al Viro 已提交
552 553 554 555
		sb->s_count++;
		spin_unlock(&sb_lock);

		down_read(&sb->s_umount);
A
Al Viro 已提交
556
		if (sb->s_root && (sb->s_flags & MS_BORN))
A
Al Viro 已提交
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
			f(sb, arg);
		up_read(&sb->s_umount);

		spin_lock(&sb_lock);
		if (p)
			__put_super(p);
		p = sb;
	}
	if (p)
		__put_super(p);
	spin_unlock(&sb_lock);
}

EXPORT_SYMBOL(iterate_supers_type);

L
Linus Torvalds 已提交
572 573 574 575 576 577 578 579
/**
 *	get_super - get the superblock of a device
 *	@bdev: device to get the superblock for
 *	
 *	Scans the superblock list and finds the superblock of the file system
 *	mounted on the device given. %NULL is returned if no match is found.
 */

580
struct super_block *get_super(struct block_device *bdev)
L
Linus Torvalds 已提交
581
{
582 583
	struct super_block *sb;

L
Linus Torvalds 已提交
584 585
	if (!bdev)
		return NULL;
586

L
Linus Torvalds 已提交
587
	spin_lock(&sb_lock);
588 589
rescan:
	list_for_each_entry(sb, &super_blocks, s_list) {
A
Al Viro 已提交
590
		if (hlist_unhashed(&sb->s_instances))
591
			continue;
592 593
		if (sb->s_bdev == bdev) {
			sb->s_count++;
L
Linus Torvalds 已提交
594
			spin_unlock(&sb_lock);
595
			down_read(&sb->s_umount);
596
			/* still alive? */
A
Al Viro 已提交
597
			if (sb->s_root && (sb->s_flags & MS_BORN))
598 599
				return sb;
			up_read(&sb->s_umount);
600
			/* nope, got unmounted */
601
			spin_lock(&sb_lock);
602 603
			__put_super(sb);
			goto rescan;
L
Linus Torvalds 已提交
604 605 606 607 608 609 610
		}
	}
	spin_unlock(&sb_lock);
	return NULL;
}

EXPORT_SYMBOL(get_super);
611

612 613 614 615 616 617 618 619 620 621 622 623 624
/**
 *	get_super_thawed - get thawed superblock of a device
 *	@bdev: device to get the superblock for
 *
 *	Scans the superblock list and finds the superblock of the file system
 *	mounted on the device. The superblock is returned once it is thawed
 *	(or immediately if it was not frozen). %NULL is returned if no match
 *	is found.
 */
struct super_block *get_super_thawed(struct block_device *bdev)
{
	while (1) {
		struct super_block *s = get_super(bdev);
625
		if (!s || s->s_writers.frozen == SB_UNFROZEN)
626 627
			return s;
		up_read(&s->s_umount);
628 629
		wait_event(s->s_writers.wait_unfrozen,
			   s->s_writers.frozen == SB_UNFROZEN);
630 631 632 633 634
		put_super(s);
	}
}
EXPORT_SYMBOL(get_super_thawed);

635 636 637 638 639 640
/**
 * get_active_super - get an active reference to the superblock of a device
 * @bdev: device to get the superblock for
 *
 * Scans the superblock list and finds the superblock of the file system
 * mounted on the device given.  Returns the superblock with an active
641
 * reference or %NULL if none was found.
642 643 644 645 646 647 648 649
 */
struct super_block *get_active_super(struct block_device *bdev)
{
	struct super_block *sb;

	if (!bdev)
		return NULL;

A
Al Viro 已提交
650
restart:
651 652
	spin_lock(&sb_lock);
	list_for_each_entry(sb, &super_blocks, s_list) {
A
Al Viro 已提交
653
		if (hlist_unhashed(&sb->s_instances))
654
			continue;
A
Al Viro 已提交
655
		if (sb->s_bdev == bdev) {
A
Al Viro 已提交
656
			if (!grab_super(sb))
A
Al Viro 已提交
657
				goto restart;
A
Al Viro 已提交
658 659
			up_write(&sb->s_umount);
			return sb;
A
Al Viro 已提交
660
		}
661 662 663 664
	}
	spin_unlock(&sb_lock);
	return NULL;
}
L
Linus Torvalds 已提交
665
 
666
struct super_block *user_get_super(dev_t dev)
L
Linus Torvalds 已提交
667
{
668
	struct super_block *sb;
L
Linus Torvalds 已提交
669 670

	spin_lock(&sb_lock);
671 672
rescan:
	list_for_each_entry(sb, &super_blocks, s_list) {
A
Al Viro 已提交
673
		if (hlist_unhashed(&sb->s_instances))
674
			continue;
675 676
		if (sb->s_dev ==  dev) {
			sb->s_count++;
L
Linus Torvalds 已提交
677
			spin_unlock(&sb_lock);
678
			down_read(&sb->s_umount);
679
			/* still alive? */
A
Al Viro 已提交
680
			if (sb->s_root && (sb->s_flags & MS_BORN))
681 682
				return sb;
			up_read(&sb->s_umount);
683
			/* nope, got unmounted */
684
			spin_lock(&sb_lock);
685 686
			__put_super(sb);
			goto rescan;
L
Linus Torvalds 已提交
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
		}
	}
	spin_unlock(&sb_lock);
	return NULL;
}

/**
 *	do_remount_sb - asks filesystem to change mount options.
 *	@sb:	superblock in question
 *	@flags:	numeric part of options
 *	@data:	the rest of options
 *      @force: whether or not to force the change
 *
 *	Alters the mount options of a mounted file system.
 */
int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
{
	int retval;
705
	int remount_ro;
706

707
	if (sb->s_writers.frozen != SB_UNFROZEN)
708 709
		return -EBUSY;

710
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
711 712
	if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
		return -EACCES;
713
#endif
714

715 716
	remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);

717 718 719
	if (remount_ro) {
		if (sb->s_pins.first) {
			up_write(&sb->s_umount);
720
			sb_pin_kill(sb);
721 722 723 724 725 726 727 728 729 730
			down_write(&sb->s_umount);
			if (!sb->s_root)
				return 0;
			if (sb->s_writers.frozen != SB_UNFROZEN)
				return -EBUSY;
			remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
		}
	}
	shrink_dcache_sb(sb);

L
Linus Torvalds 已提交
731 732
	/* If we are remounting RDONLY and current sb is read/write,
	   make sure there are no rw files opened */
733
	if (remount_ro) {
734
		if (force) {
A
Al Viro 已提交
735 736
			sb->s_readonly_remount = 1;
			smp_wmb();
737 738 739 740 741
		} else {
			retval = sb_prepare_remount_readonly(sb);
			if (retval)
				return retval;
		}
L
Linus Torvalds 已提交
742 743 744 745
	}

	if (sb->s_op->remount_fs) {
		retval = sb->s_op->remount_fs(sb, &flags, data);
746 747
		if (retval) {
			if (!force)
748
				goto cancel_readonly;
749 750 751 752
			/* If forced remount, go ahead despite any errors */
			WARN(1, "forced remount of a %s fs returned %i\n",
			     sb->s_type->name, retval);
		}
L
Linus Torvalds 已提交
753 754
	}
	sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
755 756 757
	/* Needs to be ordered wrt mnt_is_readonly() */
	smp_wmb();
	sb->s_readonly_remount = 0;
758

759 760 761 762 763 764 765 766 767 768
	/*
	 * Some filesystems modify their metadata via some other path than the
	 * bdev buffer cache (eg. use a private mapping, or directories in
	 * pagecache, etc). Also file data modifications go via their own
	 * mappings. So If we try to mount readonly then copy the filesystem
	 * from bdev, we could get stale data, so invalidate it to give a best
	 * effort at coherency.
	 */
	if (remount_ro && sb->s_bdev)
		invalidate_bdev(sb->s_bdev);
L
Linus Torvalds 已提交
769
	return 0;
770 771 772 773

cancel_readonly:
	sb->s_readonly_remount = 0;
	return retval;
L
Linus Torvalds 已提交
774 775
}

776
static void do_emergency_remount(struct work_struct *work)
L
Linus Torvalds 已提交
777
{
778
	struct super_block *sb, *p = NULL;
L
Linus Torvalds 已提交
779 780

	spin_lock(&sb_lock);
781
	list_for_each_entry(sb, &super_blocks, s_list) {
A
Al Viro 已提交
782
		if (hlist_unhashed(&sb->s_instances))
783
			continue;
L
Linus Torvalds 已提交
784 785
		sb->s_count++;
		spin_unlock(&sb_lock);
786
		down_write(&sb->s_umount);
A
Al Viro 已提交
787 788
		if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
		    !(sb->s_flags & MS_RDONLY)) {
L
Linus Torvalds 已提交
789 790 791 792 793
			/*
			 * What lock protects sb->s_flags??
			 */
			do_remount_sb(sb, MS_RDONLY, NULL, 1);
		}
794
		up_write(&sb->s_umount);
L
Linus Torvalds 已提交
795
		spin_lock(&sb_lock);
796 797 798
		if (p)
			__put_super(p);
		p = sb;
L
Linus Torvalds 已提交
799
	}
800 801
	if (p)
		__put_super(p);
L
Linus Torvalds 已提交
802
	spin_unlock(&sb_lock);
803
	kfree(work);
L
Linus Torvalds 已提交
804 805 806 807 808
	printk("Emergency Remount complete\n");
}

void emergency_remount(void)
{
809 810 811 812 813 814 815
	struct work_struct *work;

	work = kmalloc(sizeof(*work), GFP_ATOMIC);
	if (work) {
		INIT_WORK(work, do_emergency_remount);
		schedule_work(work);
	}
L
Linus Torvalds 已提交
816 817 818 819 820 821 822
}

/*
 * Unnamed block devices are dummy devices used by virtual
 * filesystems which don't use real block-devices.  -- jrs
 */

823
static DEFINE_IDA(unnamed_dev_ida);
L
Linus Torvalds 已提交
824
static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
825 826 827 828
/* Many userspace utilities consider an FSID of 0 invalid.
 * Always return at least 1 from get_anon_bdev.
 */
static int unnamed_dev_start = 1;
L
Linus Torvalds 已提交
829

830
int get_anon_bdev(dev_t *p)
L
Linus Torvalds 已提交
831 832 833 834 835
{
	int dev;
	int error;

 retry:
836
	if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
L
Linus Torvalds 已提交
837 838
		return -ENOMEM;
	spin_lock(&unnamed_dev_lock);
839
	error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
840 841
	if (!error)
		unnamed_dev_start = dev + 1;
L
Linus Torvalds 已提交
842 843 844 845 846 847 848
	spin_unlock(&unnamed_dev_lock);
	if (error == -EAGAIN)
		/* We raced and lost with another CPU. */
		goto retry;
	else if (error)
		return -EAGAIN;

849
	if (dev == (1 << MINORBITS)) {
L
Linus Torvalds 已提交
850
		spin_lock(&unnamed_dev_lock);
851
		ida_remove(&unnamed_dev_ida, dev);
852 853
		if (unnamed_dev_start > dev)
			unnamed_dev_start = dev;
L
Linus Torvalds 已提交
854 855 856
		spin_unlock(&unnamed_dev_lock);
		return -EMFILE;
	}
857
	*p = MKDEV(0, dev & MINORMASK);
L
Linus Torvalds 已提交
858 859
	return 0;
}
860
EXPORT_SYMBOL(get_anon_bdev);
L
Linus Torvalds 已提交
861

862
void free_anon_bdev(dev_t dev)
L
Linus Torvalds 已提交
863
{
864
	int slot = MINOR(dev);
L
Linus Torvalds 已提交
865
	spin_lock(&unnamed_dev_lock);
866
	ida_remove(&unnamed_dev_ida, slot);
867 868
	if (slot < unnamed_dev_start)
		unnamed_dev_start = slot;
L
Linus Torvalds 已提交
869 870
	spin_unlock(&unnamed_dev_lock);
}
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
EXPORT_SYMBOL(free_anon_bdev);

int set_anon_super(struct super_block *s, void *data)
{
	int error = get_anon_bdev(&s->s_dev);
	if (!error)
		s->s_bdi = &noop_backing_dev_info;
	return error;
}

EXPORT_SYMBOL(set_anon_super);

void kill_anon_super(struct super_block *sb)
{
	dev_t dev = sb->s_dev;
	generic_shutdown_super(sb);
	free_anon_bdev(dev);
}
L
Linus Torvalds 已提交
889 890 891 892 893 894 895 896 897 898 899 900

EXPORT_SYMBOL(kill_anon_super);

void kill_litter_super(struct super_block *sb)
{
	if (sb->s_root)
		d_genocide(sb->s_root);
	kill_anon_super(sb);
}

EXPORT_SYMBOL(kill_litter_super);

901 902 903 904 905 906 907 908 909 910 911
static int ns_test_super(struct super_block *sb, void *data)
{
	return sb->s_fs_info == data;
}

static int ns_set_super(struct super_block *sb, void *data)
{
	sb->s_fs_info = data;
	return set_anon_super(sb, NULL);
}

A
Al Viro 已提交
912 913
struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
	void *data, int (*fill_super)(struct super_block *, void *, int))
914 915 916
{
	struct super_block *sb;

D
David Howells 已提交
917
	sb = sget(fs_type, ns_test_super, ns_set_super, flags, data);
918
	if (IS_ERR(sb))
A
Al Viro 已提交
919
		return ERR_CAST(sb);
920 921 922 923 924

	if (!sb->s_root) {
		int err;
		err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
		if (err) {
A
Al Viro 已提交
925
			deactivate_locked_super(sb);
A
Al Viro 已提交
926
			return ERR_PTR(err);
927 928 929 930 931
		}

		sb->s_flags |= MS_ACTIVE;
	}

A
Al Viro 已提交
932
	return dget(sb->s_root);
933 934
}

A
Al Viro 已提交
935
EXPORT_SYMBOL(mount_ns);
936

937
#ifdef CONFIG_BLOCK
L
Linus Torvalds 已提交
938 939 940 941
static int set_bdev_super(struct super_block *s, void *data)
{
	s->s_bdev = data;
	s->s_dev = s->s_bdev->bd_dev;
J
Jens Axboe 已提交
942 943 944 945 946 947

	/*
	 * We set the bdi here to the queue backing, file systems can
	 * overwrite this in ->fill_super()
	 */
	s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
L
Linus Torvalds 已提交
948 949 950 951 952 953 954 955
	return 0;
}

static int test_bdev_super(struct super_block *s, void *data)
{
	return (void *)s->s_bdev == data;
}

A
Al Viro 已提交
956
struct dentry *mount_bdev(struct file_system_type *fs_type,
L
Linus Torvalds 已提交
957
	int flags, const char *dev_name, void *data,
A
Al Viro 已提交
958
	int (*fill_super)(struct super_block *, void *, int))
L
Linus Torvalds 已提交
959 960 961
{
	struct block_device *bdev;
	struct super_block *s;
962
	fmode_t mode = FMODE_READ | FMODE_EXCL;
L
Linus Torvalds 已提交
963 964
	int error = 0;

965 966 967
	if (!(flags & MS_RDONLY))
		mode |= FMODE_WRITE;

968
	bdev = blkdev_get_by_path(dev_name, mode, fs_type);
L
Linus Torvalds 已提交
969
	if (IS_ERR(bdev))
A
Al Viro 已提交
970
		return ERR_CAST(bdev);
L
Linus Torvalds 已提交
971 972 973 974 975 976

	/*
	 * once the super is inserted into the list by sget, s_umount
	 * will protect the lockfs code from trying to start a snapshot
	 * while we are mounting
	 */
977 978 979 980 981 982
	mutex_lock(&bdev->bd_fsfreeze_mutex);
	if (bdev->bd_fsfreeze_count > 0) {
		mutex_unlock(&bdev->bd_fsfreeze_mutex);
		error = -EBUSY;
		goto error_bdev;
	}
D
David Howells 已提交
983 984
	s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
		 bdev);
985
	mutex_unlock(&bdev->bd_fsfreeze_mutex);
L
Linus Torvalds 已提交
986
	if (IS_ERR(s))
987
		goto error_s;
L
Linus Torvalds 已提交
988 989 990

	if (s->s_root) {
		if ((flags ^ s->s_flags) & MS_RDONLY) {
A
Al Viro 已提交
991
			deactivate_locked_super(s);
992 993
			error = -EBUSY;
			goto error_bdev;
L
Linus Torvalds 已提交
994
		}
995

996 997
		/*
		 * s_umount nests inside bd_mutex during
998 999 1000 1001
		 * __invalidate_device().  blkdev_put() acquires
		 * bd_mutex and can't be called under s_umount.  Drop
		 * s_umount temporarily.  This is safe as we're
		 * holding an active reference.
1002 1003
		 */
		up_write(&s->s_umount);
1004
		blkdev_put(bdev, mode);
1005
		down_write(&s->s_umount);
L
Linus Torvalds 已提交
1006 1007 1008
	} else {
		char b[BDEVNAME_SIZE];

1009
		s->s_mode = mode;
L
Linus Torvalds 已提交
1010
		strlcpy(s->s_id, bdevname(bdev, b), sizeof(s->s_id));
1011
		sb_set_blocksize(s, block_size(bdev));
1012
		error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
L
Linus Torvalds 已提交
1013
		if (error) {
A
Al Viro 已提交
1014
			deactivate_locked_super(s);
1015
			goto error;
1016
		}
1017 1018

		s->s_flags |= MS_ACTIVE;
1019
		bdev->bd_super = s;
L
Linus Torvalds 已提交
1020 1021
	}

A
Al Viro 已提交
1022
	return dget(s->s_root);
L
Linus Torvalds 已提交
1023

1024 1025 1026
error_s:
	error = PTR_ERR(s);
error_bdev:
1027
	blkdev_put(bdev, mode);
1028
error:
A
Al Viro 已提交
1029 1030 1031 1032
	return ERR_PTR(error);
}
EXPORT_SYMBOL(mount_bdev);

L
Linus Torvalds 已提交
1033 1034 1035
void kill_block_super(struct super_block *sb)
{
	struct block_device *bdev = sb->s_bdev;
1036
	fmode_t mode = sb->s_mode;
L
Linus Torvalds 已提交
1037

1038
	bdev->bd_super = NULL;
L
Linus Torvalds 已提交
1039 1040
	generic_shutdown_super(sb);
	sync_blockdev(bdev);
1041
	WARN_ON_ONCE(!(mode & FMODE_EXCL));
1042
	blkdev_put(bdev, mode | FMODE_EXCL);
L
Linus Torvalds 已提交
1043 1044 1045
}

EXPORT_SYMBOL(kill_block_super);
1046
#endif
L
Linus Torvalds 已提交
1047

A
Al Viro 已提交
1048
struct dentry *mount_nodev(struct file_system_type *fs_type,
L
Linus Torvalds 已提交
1049
	int flags, void *data,
A
Al Viro 已提交
1050
	int (*fill_super)(struct super_block *, void *, int))
L
Linus Torvalds 已提交
1051 1052
{
	int error;
D
David Howells 已提交
1053
	struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
L
Linus Torvalds 已提交
1054 1055

	if (IS_ERR(s))
A
Al Viro 已提交
1056
		return ERR_CAST(s);
L
Linus Torvalds 已提交
1057

1058
	error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
L
Linus Torvalds 已提交
1059
	if (error) {
A
Al Viro 已提交
1060
		deactivate_locked_super(s);
A
Al Viro 已提交
1061
		return ERR_PTR(error);
L
Linus Torvalds 已提交
1062 1063
	}
	s->s_flags |= MS_ACTIVE;
A
Al Viro 已提交
1064
	return dget(s->s_root);
L
Linus Torvalds 已提交
1065
}
A
Al Viro 已提交
1066 1067
EXPORT_SYMBOL(mount_nodev);

L
Linus Torvalds 已提交
1068 1069 1070 1071 1072
static int compare_single(struct super_block *s, void *p)
{
	return 1;
}

A
Al Viro 已提交
1073
struct dentry *mount_single(struct file_system_type *fs_type,
L
Linus Torvalds 已提交
1074
	int flags, void *data,
A
Al Viro 已提交
1075
	int (*fill_super)(struct super_block *, void *, int))
L
Linus Torvalds 已提交
1076 1077 1078 1079
{
	struct super_block *s;
	int error;

D
David Howells 已提交
1080
	s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
L
Linus Torvalds 已提交
1081
	if (IS_ERR(s))
A
Al Viro 已提交
1082
		return ERR_CAST(s);
L
Linus Torvalds 已提交
1083
	if (!s->s_root) {
1084
		error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
L
Linus Torvalds 已提交
1085
		if (error) {
A
Al Viro 已提交
1086
			deactivate_locked_super(s);
A
Al Viro 已提交
1087
			return ERR_PTR(error);
L
Linus Torvalds 已提交
1088 1089
		}
		s->s_flags |= MS_ACTIVE;
1090 1091
	} else {
		do_remount_sb(s, flags, data, 0);
L
Linus Torvalds 已提交
1092
	}
A
Al Viro 已提交
1093 1094 1095 1096
	return dget(s->s_root);
}
EXPORT_SYMBOL(mount_single);

1097 1098
struct dentry *
mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
L
Linus Torvalds 已提交
1099
{
A
Al Viro 已提交
1100
	struct dentry *root;
1101
	struct super_block *sb;
L
Linus Torvalds 已提交
1102
	char *secdata = NULL;
1103
	int error = -ENOMEM;
A
Al Viro 已提交
1104

1105
	if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
L
Linus Torvalds 已提交
1106
		secdata = alloc_secdata();
1107
		if (!secdata)
1108
			goto out;
L
Linus Torvalds 已提交
1109

1110
		error = security_sb_copy_data(data, secdata);
1111
		if (error)
L
Linus Torvalds 已提交
1112 1113 1114
			goto out_free_secdata;
	}

A
Al Viro 已提交
1115 1116 1117 1118
	root = type->mount(type, flags, name, data);
	if (IS_ERR(root)) {
		error = PTR_ERR(root);
		goto out_free_secdata;
A
Al Viro 已提交
1119
	}
1120 1121 1122
	sb = root->d_sb;
	BUG_ON(!sb);
	WARN_ON(!sb->s_bdi);
1123
	WARN_ON(sb->s_bdi == &default_backing_dev_info);
1124
	sb->s_flags |= MS_BORN;
1125

1126
	error = security_sb_kern_mount(sb, flags, secdata);
J
Jörn Engel 已提交
1127 1128
	if (error)
		goto out_sb;
1129

1130 1131 1132 1133
	/*
	 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
	 * but s_maxbytes was an unsigned long long for many releases. Throw
	 * this warning for a little while to try and catch filesystems that
1134
	 * violate this rule.
1135
	 */
1136 1137
	WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
		"negative value (%lld)\n", type->name, sb->s_maxbytes);
1138

1139
	up_write(&sb->s_umount);
1140
	free_secdata(secdata);
1141
	return root;
L
Linus Torvalds 已提交
1142
out_sb:
1143 1144
	dput(root);
	deactivate_locked_super(sb);
L
Linus Torvalds 已提交
1145 1146 1147
out_free_secdata:
	free_secdata(secdata);
out:
1148
	return ERR_PTR(error);
L
Linus Torvalds 已提交
1149 1150
}

1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
/*
 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
 * instead.
 */
void __sb_end_write(struct super_block *sb, int level)
{
	percpu_counter_dec(&sb->s_writers.counter[level-1]);
	/*
	 * Make sure s_writers are updated before we wake up waiters in
	 * freeze_super().
	 */
	smp_mb();
	if (waitqueue_active(&sb->s_writers.wait))
		wake_up(&sb->s_writers.wait);
	rwsem_release(&sb->s_writers.lock_map[level-1], 1, _RET_IP_);
}
EXPORT_SYMBOL(__sb_end_write);

#ifdef CONFIG_LOCKDEP
/*
 * We want lockdep to tell us about possible deadlocks with freezing but
 * it's it bit tricky to properly instrument it. Getting a freeze protection
 * works as getting a read lock but there are subtle problems. XFS for example
 * gets freeze protection on internal level twice in some cases, which is OK
 * only because we already hold a freeze protection also on higher level. Due
 * to these cases we have to tell lockdep we are doing trylock when we
 * already hold a freeze protection for a higher freeze level.
 */
static void acquire_freeze_lock(struct super_block *sb, int level, bool trylock,
				unsigned long ip)
{
	int i;

	if (!trylock) {
		for (i = 0; i < level - 1; i++)
			if (lock_is_held(&sb->s_writers.lock_map[i])) {
				trylock = true;
				break;
			}
	}
	rwsem_acquire_read(&sb->s_writers.lock_map[level-1], 0, trylock, ip);
}
#endif

/*
 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
 * instead.
 */
int __sb_start_write(struct super_block *sb, int level, bool wait)
{
retry:
	if (unlikely(sb->s_writers.frozen >= level)) {
		if (!wait)
			return 0;
		wait_event(sb->s_writers.wait_unfrozen,
			   sb->s_writers.frozen < level);
	}

#ifdef CONFIG_LOCKDEP
	acquire_freeze_lock(sb, level, !wait, _RET_IP_);
#endif
	percpu_counter_inc(&sb->s_writers.counter[level-1]);
	/*
	 * Make sure counter is updated before we check for frozen.
	 * freeze_super() first sets frozen and then checks the counter.
	 */
	smp_mb();
	if (unlikely(sb->s_writers.frozen >= level)) {
		__sb_end_write(sb, level);
		goto retry;
	}
	return 1;
}
EXPORT_SYMBOL(__sb_start_write);

/**
 * sb_wait_write - wait until all writers to given file system finish
 * @sb: the super for which we wait
 * @level: type of writers we wait for (normal vs page fault)
 *
 * This function waits until there are no writers of given type to given file
 * system. Caller of this function should make sure there can be no new writers
 * of type @level before calling this function. Otherwise this function can
 * livelock.
 */
static void sb_wait_write(struct super_block *sb, int level)
{
	s64 writers;

	/*
	 * We just cycle-through lockdep here so that it does not complain
	 * about returning with lock to userspace
	 */
	rwsem_acquire(&sb->s_writers.lock_map[level-1], 0, 0, _THIS_IP_);
	rwsem_release(&sb->s_writers.lock_map[level-1], 1, _THIS_IP_);

	do {
		DEFINE_WAIT(wait);

		/*
		 * We use a barrier in prepare_to_wait() to separate setting
		 * of frozen and checking of the counter
		 */
		prepare_to_wait(&sb->s_writers.wait, &wait,
				TASK_UNINTERRUPTIBLE);

		writers = percpu_counter_sum(&sb->s_writers.counter[level-1]);
		if (writers)
			schedule();

		finish_wait(&sb->s_writers.wait, &wait);
	} while (writers);
}

1265
/**
R
Randy Dunlap 已提交
1266 1267
 * freeze_super - lock the filesystem and force it into a consistent state
 * @sb: the super to lock
1268 1269 1270 1271
 *
 * Syncs the super to make sure the filesystem is consistent and calls the fs's
 * freeze_fs.  Subsequent calls to this without first thawing the fs will return
 * -EBUSY.
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
 *
 * During this function, sb->s_writers.frozen goes through these values:
 *
 * SB_UNFROZEN: File system is normal, all writes progress as usual.
 *
 * SB_FREEZE_WRITE: The file system is in the process of being frozen.  New
 * writes should be blocked, though page faults are still allowed. We wait for
 * all writes to complete and then proceed to the next stage.
 *
 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
 * but internal fs threads can still modify the filesystem (although they
 * should not dirty new pages or inodes), writeback can run etc. After waiting
 * for all running page faults we sync the filesystem which will clean all
 * dirty pages and inodes (no new dirty pages or inodes can be created when
 * sync is running).
 *
 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
 * modification are blocked (e.g. XFS preallocation truncation on inode
 * reclaim). This is usually implemented by blocking new transactions for
 * filesystems that have them and need this additional guard. After all
 * internal writers are finished we call ->freeze_fs() to finish filesystem
 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
 *
 * sb->s_writers.frozen is protected by sb->s_umount.
1297 1298 1299 1300 1301 1302 1303
 */
int freeze_super(struct super_block *sb)
{
	int ret;

	atomic_inc(&sb->s_active);
	down_write(&sb->s_umount);
1304
	if (sb->s_writers.frozen != SB_UNFROZEN) {
1305 1306 1307 1308
		deactivate_locked_super(sb);
		return -EBUSY;
	}

A
Al Viro 已提交
1309 1310 1311 1312 1313
	if (!(sb->s_flags & MS_BORN)) {
		up_write(&sb->s_umount);
		return 0;	/* sic - it's "nothing to do" */
	}

1314
	if (sb->s_flags & MS_RDONLY) {
1315 1316
		/* Nothing to do really... */
		sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1317 1318 1319 1320
		up_write(&sb->s_umount);
		return 0;
	}

1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
	/* From now on, no new normal writers can start */
	sb->s_writers.frozen = SB_FREEZE_WRITE;
	smp_wmb();

	/* Release s_umount to preserve sb_start_write -> s_umount ordering */
	up_write(&sb->s_umount);

	sb_wait_write(sb, SB_FREEZE_WRITE);

	/* Now we go and block page faults... */
	down_write(&sb->s_umount);
	sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
1333 1334
	smp_wmb();

1335 1336 1337
	sb_wait_write(sb, SB_FREEZE_PAGEFAULT);

	/* All writers are done so after syncing there won't be dirty data */
1338 1339
	sync_filesystem(sb);

1340 1341
	/* Now wait for internal filesystem counter */
	sb->s_writers.frozen = SB_FREEZE_FS;
1342
	smp_wmb();
1343
	sb_wait_write(sb, SB_FREEZE_FS);
1344 1345 1346 1347 1348 1349

	if (sb->s_op->freeze_fs) {
		ret = sb->s_op->freeze_fs(sb);
		if (ret) {
			printk(KERN_ERR
				"VFS:Filesystem freeze failed\n");
1350
			sb->s_writers.frozen = SB_UNFROZEN;
1351
			smp_wmb();
1352
			wake_up(&sb->s_writers.wait_unfrozen);
1353 1354 1355 1356
			deactivate_locked_super(sb);
			return ret;
		}
	}
1357 1358 1359 1360 1361
	/*
	 * This is just for debugging purposes so that fs can warn if it
	 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
	 */
	sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
	up_write(&sb->s_umount);
	return 0;
}
EXPORT_SYMBOL(freeze_super);

/**
 * thaw_super -- unlock filesystem
 * @sb: the super to thaw
 *
 * Unlocks the filesystem and marks it writeable again after freeze_super().
 */
int thaw_super(struct super_block *sb)
{
	int error;

	down_write(&sb->s_umount);
1378
	if (sb->s_writers.frozen == SB_UNFROZEN) {
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
		up_write(&sb->s_umount);
		return -EINVAL;
	}

	if (sb->s_flags & MS_RDONLY)
		goto out;

	if (sb->s_op->unfreeze_fs) {
		error = sb->s_op->unfreeze_fs(sb);
		if (error) {
			printk(KERN_ERR
				"VFS:Filesystem thaw failed\n");
			up_write(&sb->s_umount);
			return error;
		}
	}

out:
1397
	sb->s_writers.frozen = SB_UNFROZEN;
1398
	smp_wmb();
1399
	wake_up(&sb->s_writers.wait_unfrozen);
1400 1401 1402 1403 1404
	deactivate_locked_super(sb);

	return 0;
}
EXPORT_SYMBOL(thaw_super);