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