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