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