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