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