mm: fix typo in comment in do_fault_around()
[linux-2.6-block.git] / fs / super.c
CommitLineData
1da177e4
LT
1/*
2 * linux/fs/super.c
3 *
4 * Copyright (C) 1991, 1992 Linus Torvalds
5 *
6 * super.c contains code to handle: - mount structures
7 * - super-block tables
8 * - filesystem drivers list
9 * - mount system call
10 * - umount system call
11 * - ustat system call
12 *
13 * GK 2/5/95 - Changed to support mounting the root fs via NFS
14 *
15 * Added kerneld support: Jacques Gelinas and Bjorn Ekwall
16 * Added change_root: Werner Almesberger & Hans Lermen, Feb '96
17 * Added options to /proc/mounts:
96de0e25 18 * Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
1da177e4
LT
19 * Added devfs support: Richard Gooch <rgooch@atnf.csiro.au>, 13-JAN-1998
20 * Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
21 */
22
630d9c47 23#include <linux/export.h>
1da177e4 24#include <linux/slab.h>
1da177e4
LT
25#include <linux/acct.h>
26#include <linux/blkdev.h>
1da177e4
LT
27#include <linux/mount.h>
28#include <linux/security.h>
1da177e4
LT
29#include <linux/writeback.h> /* for the emergency remount stuff */
30#include <linux/idr.h>
353ab6e9 31#include <linux/mutex.h>
5477d0fa 32#include <linux/backing-dev.h>
ceb5bdc2 33#include <linux/rculist_bl.h>
c515e1fd 34#include <linux/cleancache.h>
40401530 35#include <linux/fsnotify.h>
5accdf82 36#include <linux/lockdep.h>
6d59e7f5 37#include "internal.h"
1da177e4
LT
38
39
1da177e4
LT
40LIST_HEAD(super_blocks);
41DEFINE_SPINLOCK(sb_lock);
42
5accdf82
JK
43static char *sb_writers_name[SB_FREEZE_LEVELS] = {
44 "sb_writers",
45 "sb_pagefaults",
46 "sb_internal",
47};
48
b0d40c92
DC
49/*
50 * One thing we have to be careful of with a per-sb shrinker is that we don't
51 * drop the last active reference to the superblock from within the shrinker.
52 * If that happens we could trigger unregistering the shrinker from within the
53 * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
54 * take a passive reference to the superblock to avoid this from occurring.
55 */
0a234c6d
DC
56static unsigned long super_cache_scan(struct shrinker *shrink,
57 struct shrink_control *sc)
b0d40c92
DC
58{
59 struct super_block *sb;
0a234c6d
DC
60 long fs_objects = 0;
61 long total_objects;
62 long freed = 0;
63 long dentries;
64 long inodes;
b0d40c92
DC
65
66 sb = container_of(shrink, struct super_block, s_shrink);
67
68 /*
69 * Deadlock avoidance. We may hold various FS locks, and we don't want
70 * to recurse into the FS that called us in clear_inode() and friends..
71 */
0a234c6d
DC
72 if (!(sc->gfp_mask & __GFP_FS))
73 return SHRINK_STOP;
b0d40c92
DC
74
75 if (!grab_super_passive(sb))
0a234c6d 76 return SHRINK_STOP;
b0d40c92 77
d0407903 78 if (sb->s_op->nr_cached_objects)
9b17c623 79 fs_objects = sb->s_op->nr_cached_objects(sb, sc->nid);
0e1fdafd 80
9b17c623
DC
81 inodes = list_lru_count_node(&sb->s_inode_lru, sc->nid);
82 dentries = list_lru_count_node(&sb->s_dentry_lru, sc->nid);
f6041567 83 total_objects = dentries + inodes + fs_objects + 1;
0e1fdafd 84
0a234c6d 85 /* proportion the scan between the caches */
f6041567 86 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
bc3b14cb 87 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
b0d40c92 88
0a234c6d
DC
89 /*
90 * prune the dcache first as the icache is pinned by it, then
91 * prune the icache, followed by the filesystem specific caches
92 */
9b17c623
DC
93 freed = prune_dcache_sb(sb, dentries, sc->nid);
94 freed += prune_icache_sb(sb, inodes, sc->nid);
0a234c6d
DC
95
96 if (fs_objects) {
97 fs_objects = mult_frac(sc->nr_to_scan, fs_objects,
98 total_objects);
9b17c623
DC
99 freed += sb->s_op->free_cached_objects(sb, fs_objects,
100 sc->nid);
b0d40c92
DC
101 }
102
0a234c6d
DC
103 drop_super(sb);
104 return freed;
105}
106
107static unsigned long super_cache_count(struct shrinker *shrink,
108 struct shrink_control *sc)
109{
110 struct super_block *sb;
111 long total_objects = 0;
112
113 sb = container_of(shrink, struct super_block, s_shrink);
114
115 if (!grab_super_passive(sb))
116 return 0;
117
118 if (sb->s_op && sb->s_op->nr_cached_objects)
9b17c623
DC
119 total_objects = sb->s_op->nr_cached_objects(sb,
120 sc->nid);
0a234c6d 121
9b17c623
DC
122 total_objects += list_lru_count_node(&sb->s_dentry_lru,
123 sc->nid);
124 total_objects += list_lru_count_node(&sb->s_inode_lru,
125 sc->nid);
0a234c6d 126
55f841ce 127 total_objects = vfs_pressure_ratio(total_objects);
b0d40c92 128 drop_super(sb);
0e1fdafd 129 return total_objects;
b0d40c92
DC
130}
131
7eb5e882
AV
132/**
133 * destroy_super - frees a superblock
134 * @s: superblock to free
135 *
136 * Frees a superblock.
137 */
138static void destroy_super(struct super_block *s)
5accdf82
JK
139{
140 int i;
7eb5e882
AV
141 list_lru_destroy(&s->s_dentry_lru);
142 list_lru_destroy(&s->s_inode_lru);
5accdf82
JK
143 for (i = 0; i < SB_FREEZE_LEVELS; i++)
144 percpu_counter_destroy(&s->s_writers.counter[i]);
7eb5e882
AV
145 security_sb_free(s);
146 WARN_ON(!list_empty(&s->s_mounts));
147 kfree(s->s_subtype);
148 kfree(s->s_options);
e2fec7c3 149 kfree_rcu(s, rcu);
5accdf82
JK
150}
151
1da177e4
LT
152/**
153 * alloc_super - create new superblock
fe2bbc48 154 * @type: filesystem type superblock should belong to
9249e17f 155 * @flags: the mount flags
1da177e4
LT
156 *
157 * Allocates and initializes a new &struct super_block. alloc_super()
158 * returns a pointer new superblock or %NULL if allocation had failed.
159 */
9249e17f 160static struct super_block *alloc_super(struct file_system_type *type, int flags)
1da177e4 161{
11b0b5ab 162 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_USER);
b87221de 163 static const struct super_operations default_op;
7eb5e882
AV
164 int i;
165
166 if (!s)
167 return NULL;
1da177e4 168
b5bd856a
VD
169 INIT_LIST_HEAD(&s->s_mounts);
170
7eb5e882
AV
171 if (security_sb_alloc(s))
172 goto fail;
7b7a8665 173
7eb5e882
AV
174 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
175 if (percpu_counter_init(&s->s_writers.counter[i], 0) < 0)
176 goto fail;
177 lockdep_init_map(&s->s_writers.lock_map[i], sb_writers_name[i],
178 &type->s_writers_key[i], 0);
1da177e4 179 }
7eb5e882
AV
180 init_waitqueue_head(&s->s_writers.wait);
181 init_waitqueue_head(&s->s_writers.wait_unfrozen);
182 s->s_flags = flags;
183 s->s_bdi = &default_backing_dev_info;
184 INIT_HLIST_NODE(&s->s_instances);
185 INIT_HLIST_BL_HEAD(&s->s_anon);
186 INIT_LIST_HEAD(&s->s_inodes);
187
188 if (list_lru_init(&s->s_dentry_lru))
189 goto fail;
190 if (list_lru_init(&s->s_inode_lru))
191 goto fail;
192
7eb5e882
AV
193 init_rwsem(&s->s_umount);
194 lockdep_set_class(&s->s_umount, &type->s_umount_key);
195 /*
196 * sget() can have s_umount recursion.
197 *
198 * When it cannot find a suitable sb, it allocates a new
199 * one (this one), and tries again to find a suitable old
200 * one.
201 *
202 * In case that succeeds, it will acquire the s_umount
203 * lock of the old one. Since these are clearly distrinct
204 * locks, and this object isn't exposed yet, there's no
205 * risk of deadlocks.
206 *
207 * Annotate this by putting this lock in a different
208 * subclass.
209 */
210 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
211 s->s_count = 1;
212 atomic_set(&s->s_active, 1);
213 mutex_init(&s->s_vfs_rename_mutex);
214 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
215 mutex_init(&s->s_dquot.dqio_mutex);
216 mutex_init(&s->s_dquot.dqonoff_mutex);
217 init_rwsem(&s->s_dquot.dqptr_sem);
218 s->s_maxbytes = MAX_NON_LFS;
219 s->s_op = &default_op;
220 s->s_time_gran = 1000000000;
221 s->cleancache_poolid = -1;
222
223 s->s_shrink.seeks = DEFAULT_SEEKS;
224 s->s_shrink.scan_objects = super_cache_scan;
225 s->s_shrink.count_objects = super_cache_count;
226 s->s_shrink.batch = 1024;
227 s->s_shrink.flags = SHRINKER_NUMA_AWARE;
1da177e4 228 return s;
5ca302c8 229
7eb5e882
AV
230fail:
231 destroy_super(s);
232 return NULL;
1da177e4
LT
233}
234
235/* Superblock refcounting */
236
237/*
35cf7ba0 238 * Drop a superblock's refcount. The caller must hold sb_lock.
1da177e4 239 */
f47ec3f2 240static void __put_super(struct super_block *sb)
1da177e4 241{
1da177e4 242 if (!--sb->s_count) {
551de6f3 243 list_del_init(&sb->s_list);
1da177e4 244 destroy_super(sb);
1da177e4 245 }
1da177e4
LT
246}
247
248/**
249 * put_super - drop a temporary reference to superblock
250 * @sb: superblock in question
251 *
252 * Drops a temporary reference, frees superblock if there's no
253 * references left.
254 */
f47ec3f2 255static void put_super(struct super_block *sb)
1da177e4
LT
256{
257 spin_lock(&sb_lock);
258 __put_super(sb);
259 spin_unlock(&sb_lock);
260}
261
262
263/**
1712ac8f 264 * deactivate_locked_super - drop an active reference to superblock
1da177e4
LT
265 * @s: superblock to deactivate
266 *
1712ac8f
AV
267 * Drops an active reference to superblock, converting it into a temprory
268 * one if there is no other active references left. In that case we
1da177e4
LT
269 * tell fs driver to shut it down and drop the temporary reference we
270 * had just acquired.
1712ac8f
AV
271 *
272 * Caller holds exclusive lock on superblock; that lock is released.
1da177e4 273 */
1712ac8f 274void deactivate_locked_super(struct super_block *s)
1da177e4
LT
275{
276 struct file_system_type *fs = s->s_type;
b20bd1a5 277 if (atomic_dec_and_test(&s->s_active)) {
3167760f 278 cleancache_invalidate_fs(s);
1da177e4 279 fs->kill_sb(s);
b0d40c92
DC
280
281 /* caches are now gone, we can safely kill the shrinker now */
282 unregister_shrinker(&s->s_shrink);
f5e1dd34 283
1da177e4
LT
284 put_filesystem(fs);
285 put_super(s);
1712ac8f
AV
286 } else {
287 up_write(&s->s_umount);
1da177e4
LT
288 }
289}
290
1712ac8f 291EXPORT_SYMBOL(deactivate_locked_super);
1da177e4 292
74dbbdd7 293/**
1712ac8f 294 * deactivate_super - drop an active reference to superblock
74dbbdd7
AV
295 * @s: superblock to deactivate
296 *
1712ac8f
AV
297 * Variant of deactivate_locked_super(), except that superblock is *not*
298 * locked by caller. If we are going to drop the final active reference,
299 * lock will be acquired prior to that.
74dbbdd7 300 */
1712ac8f 301void deactivate_super(struct super_block *s)
74dbbdd7 302{
1712ac8f
AV
303 if (!atomic_add_unless(&s->s_active, -1, 1)) {
304 down_write(&s->s_umount);
305 deactivate_locked_super(s);
74dbbdd7
AV
306 }
307}
308
1712ac8f 309EXPORT_SYMBOL(deactivate_super);
74dbbdd7 310
1da177e4
LT
311/**
312 * grab_super - acquire an active reference
313 * @s: reference we are trying to make active
314 *
315 * Tries to acquire an active reference. grab_super() is used when we
316 * had just found a superblock in super_blocks or fs_type->fs_supers
317 * and want to turn it into a full-blown active reference. grab_super()
318 * is called with sb_lock held and drops it. Returns 1 in case of
319 * success, 0 if we had failed (superblock contents was already dead or
acfec9a5
AV
320 * dying when grab_super() had been called). Note that this is only
321 * called for superblocks not in rundown mode (== ones still on ->fs_supers
322 * of their type), so increment of ->s_count is OK here.
1da177e4 323 */
9c4dbee7 324static int grab_super(struct super_block *s) __releases(sb_lock)
1da177e4
LT
325{
326 s->s_count++;
327 spin_unlock(&sb_lock);
328 down_write(&s->s_umount);
acfec9a5
AV
329 if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
330 put_super(s);
331 return 1;
332 }
1da177e4
LT
333 up_write(&s->s_umount);
334 put_super(s);
1da177e4
LT
335 return 0;
336}
337
12ad3ab6
DC
338/*
339 * grab_super_passive - acquire a passive reference
331cbdee 340 * @sb: reference we are trying to grab
12ad3ab6
DC
341 *
342 * Tries to acquire a passive reference. This is used in places where we
343 * cannot take an active reference but we need to ensure that the
344 * superblock does not go away while we are working on it. It returns
345 * false if a reference was not gained, and returns true with the s_umount
346 * lock held in read mode if a reference is gained. On successful return,
347 * the caller must drop the s_umount lock and the passive reference when
348 * done.
349 */
350bool grab_super_passive(struct super_block *sb)
351{
352 spin_lock(&sb_lock);
a5166169 353 if (hlist_unhashed(&sb->s_instances)) {
12ad3ab6
DC
354 spin_unlock(&sb_lock);
355 return false;
356 }
357
358 sb->s_count++;
359 spin_unlock(&sb_lock);
360
361 if (down_read_trylock(&sb->s_umount)) {
dabe0dc1 362 if (sb->s_root && (sb->s_flags & MS_BORN))
12ad3ab6
DC
363 return true;
364 up_read(&sb->s_umount);
365 }
366
367 put_super(sb);
368 return false;
369}
370
1da177e4
LT
371/**
372 * generic_shutdown_super - common helper for ->kill_sb()
373 * @sb: superblock to kill
374 *
375 * generic_shutdown_super() does all fs-independent work on superblock
376 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
377 * that need destruction out of superblock, call generic_shutdown_super()
378 * and release aforementioned objects. Note: dentries and inodes _are_
379 * taken care of and do not need specific handling.
c636ebdb
DH
380 *
381 * Upon calling this function, the filesystem may no longer alter or
382 * rearrange the set of dentries belonging to this super_block, nor may it
383 * change the attachments of dentries to inodes.
1da177e4
LT
384 */
385void generic_shutdown_super(struct super_block *sb)
386{
ee9b6d61 387 const struct super_operations *sop = sb->s_op;
1da177e4 388
c636ebdb
DH
389 if (sb->s_root) {
390 shrink_dcache_for_umount(sb);
60b0680f 391 sync_filesystem(sb);
1da177e4 392 sb->s_flags &= ~MS_ACTIVE;
efaee192 393
63997e98
AV
394 fsnotify_unmount_inodes(&sb->s_inodes);
395
396 evict_inodes(sb);
1da177e4 397
7b7a8665
CH
398 if (sb->s_dio_done_wq) {
399 destroy_workqueue(sb->s_dio_done_wq);
400 sb->s_dio_done_wq = NULL;
401 }
402
1da177e4
LT
403 if (sop->put_super)
404 sop->put_super(sb);
405
63997e98 406 if (!list_empty(&sb->s_inodes)) {
7b4fe29e
DJ
407 printk("VFS: Busy inodes after unmount of %s. "
408 "Self-destruct in 5 seconds. Have a nice day...\n",
409 sb->s_id);
1da177e4 410 }
1da177e4
LT
411 }
412 spin_lock(&sb_lock);
413 /* should be initialized for __put_super_and_need_restart() */
a5166169 414 hlist_del_init(&sb->s_instances);
1da177e4
LT
415 spin_unlock(&sb_lock);
416 up_write(&sb->s_umount);
417}
418
419EXPORT_SYMBOL(generic_shutdown_super);
420
421/**
422 * sget - find or create a superblock
423 * @type: filesystem type superblock should belong to
424 * @test: comparison callback
425 * @set: setup callback
9249e17f 426 * @flags: mount flags
1da177e4
LT
427 * @data: argument to each of them
428 */
429struct super_block *sget(struct file_system_type *type,
430 int (*test)(struct super_block *,void *),
431 int (*set)(struct super_block *,void *),
9249e17f 432 int flags,
1da177e4
LT
433 void *data)
434{
435 struct super_block *s = NULL;
d4730127 436 struct super_block *old;
1da177e4
LT
437 int err;
438
439retry:
440 spin_lock(&sb_lock);
d4730127 441 if (test) {
b67bfe0d 442 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
d4730127
MK
443 if (!test(old, data))
444 continue;
445 if (!grab_super(old))
446 goto retry;
a3cfbb53
LZ
447 if (s) {
448 up_write(&s->s_umount);
d4730127 449 destroy_super(s);
7a4dec53 450 s = NULL;
a3cfbb53 451 }
d4730127
MK
452 return old;
453 }
1da177e4
LT
454 }
455 if (!s) {
456 spin_unlock(&sb_lock);
9249e17f 457 s = alloc_super(type, flags);
1da177e4
LT
458 if (!s)
459 return ERR_PTR(-ENOMEM);
460 goto retry;
461 }
462
463 err = set(s, data);
464 if (err) {
465 spin_unlock(&sb_lock);
a3cfbb53 466 up_write(&s->s_umount);
1da177e4
LT
467 destroy_super(s);
468 return ERR_PTR(err);
469 }
470 s->s_type = type;
471 strlcpy(s->s_id, type->name, sizeof(s->s_id));
472 list_add_tail(&s->s_list, &super_blocks);
a5166169 473 hlist_add_head(&s->s_instances, &type->fs_supers);
1da177e4
LT
474 spin_unlock(&sb_lock);
475 get_filesystem(type);
b0d40c92 476 register_shrinker(&s->s_shrink);
1da177e4
LT
477 return s;
478}
479
480EXPORT_SYMBOL(sget);
481
482void drop_super(struct super_block *sb)
483{
484 up_read(&sb->s_umount);
485 put_super(sb);
486}
487
488EXPORT_SYMBOL(drop_super);
489
01a05b33
AV
490/**
491 * iterate_supers - call function for all active superblocks
492 * @f: function to call
493 * @arg: argument to pass to it
494 *
495 * Scans the superblock list and calls given function, passing it
496 * locked superblock and given argument.
497 */
498void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
499{
dca33252 500 struct super_block *sb, *p = NULL;
01a05b33
AV
501
502 spin_lock(&sb_lock);
dca33252 503 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 504 if (hlist_unhashed(&sb->s_instances))
01a05b33
AV
505 continue;
506 sb->s_count++;
507 spin_unlock(&sb_lock);
508
509 down_read(&sb->s_umount);
dabe0dc1 510 if (sb->s_root && (sb->s_flags & MS_BORN))
01a05b33
AV
511 f(sb, arg);
512 up_read(&sb->s_umount);
513
514 spin_lock(&sb_lock);
dca33252
AV
515 if (p)
516 __put_super(p);
517 p = sb;
01a05b33 518 }
dca33252
AV
519 if (p)
520 __put_super(p);
01a05b33
AV
521 spin_unlock(&sb_lock);
522}
523
43e15cdb
AV
524/**
525 * iterate_supers_type - call function for superblocks of given type
526 * @type: fs type
527 * @f: function to call
528 * @arg: argument to pass to it
529 *
530 * Scans the superblock list and calls given function, passing it
531 * locked superblock and given argument.
532 */
533void iterate_supers_type(struct file_system_type *type,
534 void (*f)(struct super_block *, void *), void *arg)
535{
536 struct super_block *sb, *p = NULL;
537
538 spin_lock(&sb_lock);
b67bfe0d 539 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
43e15cdb
AV
540 sb->s_count++;
541 spin_unlock(&sb_lock);
542
543 down_read(&sb->s_umount);
dabe0dc1 544 if (sb->s_root && (sb->s_flags & MS_BORN))
43e15cdb
AV
545 f(sb, arg);
546 up_read(&sb->s_umount);
547
548 spin_lock(&sb_lock);
549 if (p)
550 __put_super(p);
551 p = sb;
552 }
553 if (p)
554 __put_super(p);
555 spin_unlock(&sb_lock);
556}
557
558EXPORT_SYMBOL(iterate_supers_type);
559
1da177e4
LT
560/**
561 * get_super - get the superblock of a device
562 * @bdev: device to get the superblock for
563 *
564 * Scans the superblock list and finds the superblock of the file system
565 * mounted on the device given. %NULL is returned if no match is found.
566 */
567
df40c01a 568struct super_block *get_super(struct block_device *bdev)
1da177e4 569{
618f0636
KK
570 struct super_block *sb;
571
1da177e4
LT
572 if (!bdev)
573 return NULL;
618f0636 574
1da177e4 575 spin_lock(&sb_lock);
618f0636
KK
576rescan:
577 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 578 if (hlist_unhashed(&sb->s_instances))
551de6f3 579 continue;
618f0636
KK
580 if (sb->s_bdev == bdev) {
581 sb->s_count++;
1da177e4 582 spin_unlock(&sb_lock);
618f0636 583 down_read(&sb->s_umount);
df40c01a 584 /* still alive? */
dabe0dc1 585 if (sb->s_root && (sb->s_flags & MS_BORN))
618f0636
KK
586 return sb;
587 up_read(&sb->s_umount);
df40c01a 588 /* nope, got unmounted */
618f0636 589 spin_lock(&sb_lock);
df40c01a
AV
590 __put_super(sb);
591 goto rescan;
1da177e4
LT
592 }
593 }
594 spin_unlock(&sb_lock);
595 return NULL;
596}
597
598EXPORT_SYMBOL(get_super);
4504230a 599
6b6dc836
JK
600/**
601 * get_super_thawed - get thawed superblock of a device
602 * @bdev: device to get the superblock for
603 *
604 * Scans the superblock list and finds the superblock of the file system
605 * mounted on the device. The superblock is returned once it is thawed
606 * (or immediately if it was not frozen). %NULL is returned if no match
607 * is found.
608 */
609struct super_block *get_super_thawed(struct block_device *bdev)
610{
611 while (1) {
612 struct super_block *s = get_super(bdev);
5accdf82 613 if (!s || s->s_writers.frozen == SB_UNFROZEN)
6b6dc836
JK
614 return s;
615 up_read(&s->s_umount);
5accdf82
JK
616 wait_event(s->s_writers.wait_unfrozen,
617 s->s_writers.frozen == SB_UNFROZEN);
6b6dc836
JK
618 put_super(s);
619 }
620}
621EXPORT_SYMBOL(get_super_thawed);
622
4504230a
CH
623/**
624 * get_active_super - get an active reference to the superblock of a device
625 * @bdev: device to get the superblock for
626 *
627 * Scans the superblock list and finds the superblock of the file system
628 * mounted on the device given. Returns the superblock with an active
d3f21473 629 * reference or %NULL if none was found.
4504230a
CH
630 */
631struct super_block *get_active_super(struct block_device *bdev)
632{
633 struct super_block *sb;
634
635 if (!bdev)
636 return NULL;
637
1494583d 638restart:
4504230a
CH
639 spin_lock(&sb_lock);
640 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 641 if (hlist_unhashed(&sb->s_instances))
551de6f3 642 continue;
1494583d 643 if (sb->s_bdev == bdev) {
acfec9a5 644 if (!grab_super(sb))
1494583d 645 goto restart;
acfec9a5
AV
646 up_write(&sb->s_umount);
647 return sb;
1494583d 648 }
4504230a
CH
649 }
650 spin_unlock(&sb_lock);
651 return NULL;
652}
1da177e4 653
df40c01a 654struct super_block *user_get_super(dev_t dev)
1da177e4 655{
618f0636 656 struct super_block *sb;
1da177e4 657
1da177e4 658 spin_lock(&sb_lock);
618f0636
KK
659rescan:
660 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 661 if (hlist_unhashed(&sb->s_instances))
551de6f3 662 continue;
618f0636
KK
663 if (sb->s_dev == dev) {
664 sb->s_count++;
1da177e4 665 spin_unlock(&sb_lock);
618f0636 666 down_read(&sb->s_umount);
df40c01a 667 /* still alive? */
dabe0dc1 668 if (sb->s_root && (sb->s_flags & MS_BORN))
618f0636
KK
669 return sb;
670 up_read(&sb->s_umount);
df40c01a 671 /* nope, got unmounted */
618f0636 672 spin_lock(&sb_lock);
df40c01a
AV
673 __put_super(sb);
674 goto rescan;
1da177e4
LT
675 }
676 }
677 spin_unlock(&sb_lock);
678 return NULL;
679}
680
1da177e4
LT
681/**
682 * do_remount_sb - asks filesystem to change mount options.
683 * @sb: superblock in question
684 * @flags: numeric part of options
685 * @data: the rest of options
686 * @force: whether or not to force the change
687 *
688 * Alters the mount options of a mounted file system.
689 */
690int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
691{
692 int retval;
c79d967d 693 int remount_ro;
4504230a 694
5accdf82 695 if (sb->s_writers.frozen != SB_UNFROZEN)
4504230a
CH
696 return -EBUSY;
697
9361401e 698#ifdef CONFIG_BLOCK
1da177e4
LT
699 if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
700 return -EACCES;
9361401e 701#endif
4504230a 702
1da177e4
LT
703 if (flags & MS_RDONLY)
704 acct_auto_close(sb);
705 shrink_dcache_sb(sb);
1da177e4 706
d208bbdd 707 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
d208bbdd 708
1da177e4
LT
709 /* If we are remounting RDONLY and current sb is read/write,
710 make sure there are no rw files opened */
d208bbdd 711 if (remount_ro) {
4ed5e82f 712 if (force) {
eee5cc27
AV
713 sb->s_readonly_remount = 1;
714 smp_wmb();
4ed5e82f
MS
715 } else {
716 retval = sb_prepare_remount_readonly(sb);
717 if (retval)
718 return retval;
4ed5e82f 719 }
1da177e4
LT
720 }
721
722 if (sb->s_op->remount_fs) {
1da177e4 723 retval = sb->s_op->remount_fs(sb, &flags, data);
2833eb2b
MS
724 if (retval) {
725 if (!force)
4ed5e82f 726 goto cancel_readonly;
2833eb2b
MS
727 /* If forced remount, go ahead despite any errors */
728 WARN(1, "forced remount of a %s fs returned %i\n",
729 sb->s_type->name, retval);
730 }
1da177e4
LT
731 }
732 sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
4ed5e82f
MS
733 /* Needs to be ordered wrt mnt_is_readonly() */
734 smp_wmb();
735 sb->s_readonly_remount = 0;
c79d967d 736
d208bbdd
NP
737 /*
738 * Some filesystems modify their metadata via some other path than the
739 * bdev buffer cache (eg. use a private mapping, or directories in
740 * pagecache, etc). Also file data modifications go via their own
741 * mappings. So If we try to mount readonly then copy the filesystem
742 * from bdev, we could get stale data, so invalidate it to give a best
743 * effort at coherency.
744 */
745 if (remount_ro && sb->s_bdev)
746 invalidate_bdev(sb->s_bdev);
1da177e4 747 return 0;
4ed5e82f
MS
748
749cancel_readonly:
750 sb->s_readonly_remount = 0;
751 return retval;
1da177e4
LT
752}
753
a2a9537a 754static void do_emergency_remount(struct work_struct *work)
1da177e4 755{
dca33252 756 struct super_block *sb, *p = NULL;
1da177e4
LT
757
758 spin_lock(&sb_lock);
dca33252 759 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 760 if (hlist_unhashed(&sb->s_instances))
551de6f3 761 continue;
1da177e4
LT
762 sb->s_count++;
763 spin_unlock(&sb_lock);
443b94ba 764 down_write(&sb->s_umount);
dabe0dc1
AV
765 if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
766 !(sb->s_flags & MS_RDONLY)) {
1da177e4 767 /*
1da177e4
LT
768 * What lock protects sb->s_flags??
769 */
1da177e4 770 do_remount_sb(sb, MS_RDONLY, NULL, 1);
1da177e4 771 }
443b94ba 772 up_write(&sb->s_umount);
1da177e4 773 spin_lock(&sb_lock);
dca33252
AV
774 if (p)
775 __put_super(p);
776 p = sb;
1da177e4 777 }
dca33252
AV
778 if (p)
779 __put_super(p);
1da177e4 780 spin_unlock(&sb_lock);
a2a9537a 781 kfree(work);
1da177e4
LT
782 printk("Emergency Remount complete\n");
783}
784
785void emergency_remount(void)
786{
a2a9537a
JA
787 struct work_struct *work;
788
789 work = kmalloc(sizeof(*work), GFP_ATOMIC);
790 if (work) {
791 INIT_WORK(work, do_emergency_remount);
792 schedule_work(work);
793 }
1da177e4
LT
794}
795
796/*
797 * Unnamed block devices are dummy devices used by virtual
798 * filesystems which don't use real block-devices. -- jrs
799 */
800
ad76cbc6 801static DEFINE_IDA(unnamed_dev_ida);
1da177e4 802static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
a2a4dc49
TB
803/* Many userspace utilities consider an FSID of 0 invalid.
804 * Always return at least 1 from get_anon_bdev.
805 */
806static int unnamed_dev_start = 1;
1da177e4 807
0ee5dc67 808int get_anon_bdev(dev_t *p)
1da177e4
LT
809{
810 int dev;
811 int error;
812
813 retry:
ad76cbc6 814 if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
1da177e4
LT
815 return -ENOMEM;
816 spin_lock(&unnamed_dev_lock);
c63e09ec 817 error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
f21f6220
AV
818 if (!error)
819 unnamed_dev_start = dev + 1;
1da177e4
LT
820 spin_unlock(&unnamed_dev_lock);
821 if (error == -EAGAIN)
822 /* We raced and lost with another CPU. */
823 goto retry;
824 else if (error)
825 return -EAGAIN;
826
e8c8d1bc 827 if (dev == (1 << MINORBITS)) {
1da177e4 828 spin_lock(&unnamed_dev_lock);
ad76cbc6 829 ida_remove(&unnamed_dev_ida, dev);
f21f6220
AV
830 if (unnamed_dev_start > dev)
831 unnamed_dev_start = dev;
1da177e4
LT
832 spin_unlock(&unnamed_dev_lock);
833 return -EMFILE;
834 }
0ee5dc67 835 *p = MKDEV(0, dev & MINORMASK);
1da177e4
LT
836 return 0;
837}
0ee5dc67 838EXPORT_SYMBOL(get_anon_bdev);
1da177e4 839
0ee5dc67 840void free_anon_bdev(dev_t dev)
1da177e4 841{
0ee5dc67 842 int slot = MINOR(dev);
1da177e4 843 spin_lock(&unnamed_dev_lock);
ad76cbc6 844 ida_remove(&unnamed_dev_ida, slot);
c63e09ec
AV
845 if (slot < unnamed_dev_start)
846 unnamed_dev_start = slot;
1da177e4
LT
847 spin_unlock(&unnamed_dev_lock);
848}
0ee5dc67
AV
849EXPORT_SYMBOL(free_anon_bdev);
850
851int set_anon_super(struct super_block *s, void *data)
852{
853 int error = get_anon_bdev(&s->s_dev);
854 if (!error)
855 s->s_bdi = &noop_backing_dev_info;
856 return error;
857}
858
859EXPORT_SYMBOL(set_anon_super);
860
861void kill_anon_super(struct super_block *sb)
862{
863 dev_t dev = sb->s_dev;
864 generic_shutdown_super(sb);
865 free_anon_bdev(dev);
866}
1da177e4
LT
867
868EXPORT_SYMBOL(kill_anon_super);
869
1da177e4
LT
870void kill_litter_super(struct super_block *sb)
871{
872 if (sb->s_root)
873 d_genocide(sb->s_root);
874 kill_anon_super(sb);
875}
876
877EXPORT_SYMBOL(kill_litter_super);
878
909e6d94
SH
879static int ns_test_super(struct super_block *sb, void *data)
880{
881 return sb->s_fs_info == data;
882}
883
884static int ns_set_super(struct super_block *sb, void *data)
885{
886 sb->s_fs_info = data;
887 return set_anon_super(sb, NULL);
888}
889
ceefda69
AV
890struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
891 void *data, int (*fill_super)(struct super_block *, void *, int))
909e6d94
SH
892{
893 struct super_block *sb;
894
9249e17f 895 sb = sget(fs_type, ns_test_super, ns_set_super, flags, data);
909e6d94 896 if (IS_ERR(sb))
ceefda69 897 return ERR_CAST(sb);
909e6d94
SH
898
899 if (!sb->s_root) {
900 int err;
909e6d94
SH
901 err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
902 if (err) {
74dbbdd7 903 deactivate_locked_super(sb);
ceefda69 904 return ERR_PTR(err);
909e6d94
SH
905 }
906
907 sb->s_flags |= MS_ACTIVE;
908 }
909
ceefda69 910 return dget(sb->s_root);
909e6d94
SH
911}
912
ceefda69 913EXPORT_SYMBOL(mount_ns);
909e6d94 914
9361401e 915#ifdef CONFIG_BLOCK
1da177e4
LT
916static int set_bdev_super(struct super_block *s, void *data)
917{
918 s->s_bdev = data;
919 s->s_dev = s->s_bdev->bd_dev;
32a88aa1
JA
920
921 /*
922 * We set the bdi here to the queue backing, file systems can
923 * overwrite this in ->fill_super()
924 */
925 s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
1da177e4
LT
926 return 0;
927}
928
929static int test_bdev_super(struct super_block *s, void *data)
930{
931 return (void *)s->s_bdev == data;
932}
933
152a0836 934struct dentry *mount_bdev(struct file_system_type *fs_type,
1da177e4 935 int flags, const char *dev_name, void *data,
152a0836 936 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
937{
938 struct block_device *bdev;
939 struct super_block *s;
d4d77629 940 fmode_t mode = FMODE_READ | FMODE_EXCL;
1da177e4
LT
941 int error = 0;
942
30c40d2c
AV
943 if (!(flags & MS_RDONLY))
944 mode |= FMODE_WRITE;
945
d4d77629 946 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
1da177e4 947 if (IS_ERR(bdev))
152a0836 948 return ERR_CAST(bdev);
1da177e4
LT
949
950 /*
951 * once the super is inserted into the list by sget, s_umount
952 * will protect the lockfs code from trying to start a snapshot
953 * while we are mounting
954 */
4fadd7bb
CH
955 mutex_lock(&bdev->bd_fsfreeze_mutex);
956 if (bdev->bd_fsfreeze_count > 0) {
957 mutex_unlock(&bdev->bd_fsfreeze_mutex);
958 error = -EBUSY;
959 goto error_bdev;
960 }
9249e17f
DH
961 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
962 bdev);
4fadd7bb 963 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1da177e4 964 if (IS_ERR(s))
454e2398 965 goto error_s;
1da177e4
LT
966
967 if (s->s_root) {
968 if ((flags ^ s->s_flags) & MS_RDONLY) {
74dbbdd7 969 deactivate_locked_super(s);
454e2398
DH
970 error = -EBUSY;
971 goto error_bdev;
1da177e4 972 }
454e2398 973
4f331f01
TH
974 /*
975 * s_umount nests inside bd_mutex during
e525fd89
TH
976 * __invalidate_device(). blkdev_put() acquires
977 * bd_mutex and can't be called under s_umount. Drop
978 * s_umount temporarily. This is safe as we're
979 * holding an active reference.
4f331f01
TH
980 */
981 up_write(&s->s_umount);
d4d77629 982 blkdev_put(bdev, mode);
4f331f01 983 down_write(&s->s_umount);
1da177e4
LT
984 } else {
985 char b[BDEVNAME_SIZE];
986
30c40d2c 987 s->s_mode = mode;
1da177e4 988 strlcpy(s->s_id, bdevname(bdev, b), sizeof(s->s_id));
e78c9a00 989 sb_set_blocksize(s, block_size(bdev));
9b04c997 990 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1da177e4 991 if (error) {
74dbbdd7 992 deactivate_locked_super(s);
454e2398 993 goto error;
fa675765 994 }
454e2398
DH
995
996 s->s_flags |= MS_ACTIVE;
87d8fe1e 997 bdev->bd_super = s;
1da177e4
LT
998 }
999
152a0836 1000 return dget(s->s_root);
1da177e4 1001
454e2398
DH
1002error_s:
1003 error = PTR_ERR(s);
1004error_bdev:
d4d77629 1005 blkdev_put(bdev, mode);
454e2398 1006error:
152a0836
AV
1007 return ERR_PTR(error);
1008}
1009EXPORT_SYMBOL(mount_bdev);
1010
1da177e4
LT
1011void kill_block_super(struct super_block *sb)
1012{
1013 struct block_device *bdev = sb->s_bdev;
30c40d2c 1014 fmode_t mode = sb->s_mode;
1da177e4 1015
ddbaaf30 1016 bdev->bd_super = NULL;
1da177e4
LT
1017 generic_shutdown_super(sb);
1018 sync_blockdev(bdev);
d4d77629 1019 WARN_ON_ONCE(!(mode & FMODE_EXCL));
e525fd89 1020 blkdev_put(bdev, mode | FMODE_EXCL);
1da177e4
LT
1021}
1022
1023EXPORT_SYMBOL(kill_block_super);
9361401e 1024#endif
1da177e4 1025
3c26ff6e 1026struct dentry *mount_nodev(struct file_system_type *fs_type,
1da177e4 1027 int flags, void *data,
3c26ff6e 1028 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1029{
1030 int error;
9249e17f 1031 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1da177e4
LT
1032
1033 if (IS_ERR(s))
3c26ff6e 1034 return ERR_CAST(s);
1da177e4 1035
9b04c997 1036 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1da177e4 1037 if (error) {
74dbbdd7 1038 deactivate_locked_super(s);
3c26ff6e 1039 return ERR_PTR(error);
1da177e4
LT
1040 }
1041 s->s_flags |= MS_ACTIVE;
3c26ff6e 1042 return dget(s->s_root);
1da177e4 1043}
3c26ff6e
AV
1044EXPORT_SYMBOL(mount_nodev);
1045
1da177e4
LT
1046static int compare_single(struct super_block *s, void *p)
1047{
1048 return 1;
1049}
1050
fc14f2fe 1051struct dentry *mount_single(struct file_system_type *fs_type,
1da177e4 1052 int flags, void *data,
fc14f2fe 1053 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1054{
1055 struct super_block *s;
1056 int error;
1057
9249e17f 1058 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1da177e4 1059 if (IS_ERR(s))
fc14f2fe 1060 return ERR_CAST(s);
1da177e4 1061 if (!s->s_root) {
9b04c997 1062 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1da177e4 1063 if (error) {
74dbbdd7 1064 deactivate_locked_super(s);
fc14f2fe 1065 return ERR_PTR(error);
1da177e4
LT
1066 }
1067 s->s_flags |= MS_ACTIVE;
9329d1be
KS
1068 } else {
1069 do_remount_sb(s, flags, data, 0);
1da177e4 1070 }
fc14f2fe
AV
1071 return dget(s->s_root);
1072}
1073EXPORT_SYMBOL(mount_single);
1074
9d412a43
AV
1075struct dentry *
1076mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
1da177e4 1077{
c96e41e9 1078 struct dentry *root;
9d412a43 1079 struct super_block *sb;
1da177e4 1080 char *secdata = NULL;
9d412a43 1081 int error = -ENOMEM;
8089352a 1082
e0007529 1083 if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
1da177e4 1084 secdata = alloc_secdata();
454e2398 1085 if (!secdata)
9d412a43 1086 goto out;
1da177e4 1087
e0007529 1088 error = security_sb_copy_data(data, secdata);
454e2398 1089 if (error)
1da177e4 1090 goto out_free_secdata;
1da177e4
LT
1091 }
1092
1a102ff9
AV
1093 root = type->mount(type, flags, name, data);
1094 if (IS_ERR(root)) {
1095 error = PTR_ERR(root);
1096 goto out_free_secdata;
c96e41e9 1097 }
9d412a43
AV
1098 sb = root->d_sb;
1099 BUG_ON(!sb);
1100 WARN_ON(!sb->s_bdi);
6c510389 1101 WARN_ON(sb->s_bdi == &default_backing_dev_info);
9d412a43 1102 sb->s_flags |= MS_BORN;
454e2398 1103
9d412a43 1104 error = security_sb_kern_mount(sb, flags, secdata);
5129a469
JE
1105 if (error)
1106 goto out_sb;
454e2398 1107
42cb56ae
JL
1108 /*
1109 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1110 * but s_maxbytes was an unsigned long long for many releases. Throw
1111 * this warning for a little while to try and catch filesystems that
4358b567 1112 * violate this rule.
42cb56ae 1113 */
9d412a43
AV
1114 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1115 "negative value (%lld)\n", type->name, sb->s_maxbytes);
42cb56ae 1116
9d412a43 1117 up_write(&sb->s_umount);
8680e22f 1118 free_secdata(secdata);
9d412a43 1119 return root;
1da177e4 1120out_sb:
9d412a43
AV
1121 dput(root);
1122 deactivate_locked_super(sb);
1da177e4
LT
1123out_free_secdata:
1124 free_secdata(secdata);
1da177e4 1125out:
454e2398 1126 return ERR_PTR(error);
1da177e4
LT
1127}
1128
5accdf82
JK
1129/*
1130 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1131 * instead.
1132 */
1133void __sb_end_write(struct super_block *sb, int level)
1134{
1135 percpu_counter_dec(&sb->s_writers.counter[level-1]);
1136 /*
1137 * Make sure s_writers are updated before we wake up waiters in
1138 * freeze_super().
1139 */
1140 smp_mb();
1141 if (waitqueue_active(&sb->s_writers.wait))
1142 wake_up(&sb->s_writers.wait);
1143 rwsem_release(&sb->s_writers.lock_map[level-1], 1, _RET_IP_);
1144}
1145EXPORT_SYMBOL(__sb_end_write);
1146
1147#ifdef CONFIG_LOCKDEP
1148/*
1149 * We want lockdep to tell us about possible deadlocks with freezing but
1150 * it's it bit tricky to properly instrument it. Getting a freeze protection
1151 * works as getting a read lock but there are subtle problems. XFS for example
1152 * gets freeze protection on internal level twice in some cases, which is OK
1153 * only because we already hold a freeze protection also on higher level. Due
1154 * to these cases we have to tell lockdep we are doing trylock when we
1155 * already hold a freeze protection for a higher freeze level.
1156 */
1157static void acquire_freeze_lock(struct super_block *sb, int level, bool trylock,
1158 unsigned long ip)
1159{
1160 int i;
1161
1162 if (!trylock) {
1163 for (i = 0; i < level - 1; i++)
1164 if (lock_is_held(&sb->s_writers.lock_map[i])) {
1165 trylock = true;
1166 break;
1167 }
1168 }
1169 rwsem_acquire_read(&sb->s_writers.lock_map[level-1], 0, trylock, ip);
1170}
1171#endif
1172
1173/*
1174 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1175 * instead.
1176 */
1177int __sb_start_write(struct super_block *sb, int level, bool wait)
1178{
1179retry:
1180 if (unlikely(sb->s_writers.frozen >= level)) {
1181 if (!wait)
1182 return 0;
1183 wait_event(sb->s_writers.wait_unfrozen,
1184 sb->s_writers.frozen < level);
1185 }
1186
1187#ifdef CONFIG_LOCKDEP
1188 acquire_freeze_lock(sb, level, !wait, _RET_IP_);
1189#endif
1190 percpu_counter_inc(&sb->s_writers.counter[level-1]);
1191 /*
1192 * Make sure counter is updated before we check for frozen.
1193 * freeze_super() first sets frozen and then checks the counter.
1194 */
1195 smp_mb();
1196 if (unlikely(sb->s_writers.frozen >= level)) {
1197 __sb_end_write(sb, level);
1198 goto retry;
1199 }
1200 return 1;
1201}
1202EXPORT_SYMBOL(__sb_start_write);
1203
1204/**
1205 * sb_wait_write - wait until all writers to given file system finish
1206 * @sb: the super for which we wait
1207 * @level: type of writers we wait for (normal vs page fault)
1208 *
1209 * This function waits until there are no writers of given type to given file
1210 * system. Caller of this function should make sure there can be no new writers
1211 * of type @level before calling this function. Otherwise this function can
1212 * livelock.
1213 */
1214static void sb_wait_write(struct super_block *sb, int level)
1215{
1216 s64 writers;
1217
1218 /*
1219 * We just cycle-through lockdep here so that it does not complain
1220 * about returning with lock to userspace
1221 */
1222 rwsem_acquire(&sb->s_writers.lock_map[level-1], 0, 0, _THIS_IP_);
1223 rwsem_release(&sb->s_writers.lock_map[level-1], 1, _THIS_IP_);
1224
1225 do {
1226 DEFINE_WAIT(wait);
1227
1228 /*
1229 * We use a barrier in prepare_to_wait() to separate setting
1230 * of frozen and checking of the counter
1231 */
1232 prepare_to_wait(&sb->s_writers.wait, &wait,
1233 TASK_UNINTERRUPTIBLE);
1234
1235 writers = percpu_counter_sum(&sb->s_writers.counter[level-1]);
1236 if (writers)
1237 schedule();
1238
1239 finish_wait(&sb->s_writers.wait, &wait);
1240 } while (writers);
1241}
1242
18e9e510 1243/**
7000d3c4
RD
1244 * freeze_super - lock the filesystem and force it into a consistent state
1245 * @sb: the super to lock
18e9e510
JB
1246 *
1247 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1248 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1249 * -EBUSY.
5accdf82
JK
1250 *
1251 * During this function, sb->s_writers.frozen goes through these values:
1252 *
1253 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1254 *
1255 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1256 * writes should be blocked, though page faults are still allowed. We wait for
1257 * all writes to complete and then proceed to the next stage.
1258 *
1259 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1260 * but internal fs threads can still modify the filesystem (although they
1261 * should not dirty new pages or inodes), writeback can run etc. After waiting
1262 * for all running page faults we sync the filesystem which will clean all
1263 * dirty pages and inodes (no new dirty pages or inodes can be created when
1264 * sync is running).
1265 *
1266 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1267 * modification are blocked (e.g. XFS preallocation truncation on inode
1268 * reclaim). This is usually implemented by blocking new transactions for
1269 * filesystems that have them and need this additional guard. After all
1270 * internal writers are finished we call ->freeze_fs() to finish filesystem
1271 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1272 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1273 *
1274 * sb->s_writers.frozen is protected by sb->s_umount.
18e9e510
JB
1275 */
1276int freeze_super(struct super_block *sb)
1277{
1278 int ret;
1279
1280 atomic_inc(&sb->s_active);
1281 down_write(&sb->s_umount);
5accdf82 1282 if (sb->s_writers.frozen != SB_UNFROZEN) {
18e9e510
JB
1283 deactivate_locked_super(sb);
1284 return -EBUSY;
1285 }
1286
dabe0dc1
AV
1287 if (!(sb->s_flags & MS_BORN)) {
1288 up_write(&sb->s_umount);
1289 return 0; /* sic - it's "nothing to do" */
1290 }
1291
18e9e510 1292 if (sb->s_flags & MS_RDONLY) {
5accdf82
JK
1293 /* Nothing to do really... */
1294 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
18e9e510
JB
1295 up_write(&sb->s_umount);
1296 return 0;
1297 }
1298
5accdf82
JK
1299 /* From now on, no new normal writers can start */
1300 sb->s_writers.frozen = SB_FREEZE_WRITE;
1301 smp_wmb();
1302
1303 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1304 up_write(&sb->s_umount);
1305
1306 sb_wait_write(sb, SB_FREEZE_WRITE);
1307
1308 /* Now we go and block page faults... */
1309 down_write(&sb->s_umount);
1310 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
18e9e510
JB
1311 smp_wmb();
1312
5accdf82
JK
1313 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1314
1315 /* All writers are done so after syncing there won't be dirty data */
18e9e510
JB
1316 sync_filesystem(sb);
1317
5accdf82
JK
1318 /* Now wait for internal filesystem counter */
1319 sb->s_writers.frozen = SB_FREEZE_FS;
18e9e510 1320 smp_wmb();
5accdf82 1321 sb_wait_write(sb, SB_FREEZE_FS);
18e9e510 1322
18e9e510
JB
1323 if (sb->s_op->freeze_fs) {
1324 ret = sb->s_op->freeze_fs(sb);
1325 if (ret) {
1326 printk(KERN_ERR
1327 "VFS:Filesystem freeze failed\n");
5accdf82 1328 sb->s_writers.frozen = SB_UNFROZEN;
e1616300 1329 smp_wmb();
5accdf82 1330 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510
JB
1331 deactivate_locked_super(sb);
1332 return ret;
1333 }
1334 }
5accdf82
JK
1335 /*
1336 * This is just for debugging purposes so that fs can warn if it
1337 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
1338 */
1339 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
18e9e510
JB
1340 up_write(&sb->s_umount);
1341 return 0;
1342}
1343EXPORT_SYMBOL(freeze_super);
1344
1345/**
1346 * thaw_super -- unlock filesystem
1347 * @sb: the super to thaw
1348 *
1349 * Unlocks the filesystem and marks it writeable again after freeze_super().
1350 */
1351int thaw_super(struct super_block *sb)
1352{
1353 int error;
1354
1355 down_write(&sb->s_umount);
5accdf82 1356 if (sb->s_writers.frozen == SB_UNFROZEN) {
18e9e510
JB
1357 up_write(&sb->s_umount);
1358 return -EINVAL;
1359 }
1360
1361 if (sb->s_flags & MS_RDONLY)
1362 goto out;
1363
1364 if (sb->s_op->unfreeze_fs) {
1365 error = sb->s_op->unfreeze_fs(sb);
1366 if (error) {
1367 printk(KERN_ERR
1368 "VFS:Filesystem thaw failed\n");
18e9e510
JB
1369 up_write(&sb->s_umount);
1370 return error;
1371 }
1372 }
1373
1374out:
5accdf82 1375 sb->s_writers.frozen = SB_UNFROZEN;
18e9e510 1376 smp_wmb();
5accdf82 1377 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510
JB
1378 deactivate_locked_super(sb);
1379
1380 return 0;
1381}
1382EXPORT_SYMBOL(thaw_super);