vfs: Use sget_fc() for pseudo-filesystems
[linux-2.6-block.git] / fs / super.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
1da177e4
LT
2/*
3 * linux/fs/super.c
4 *
5 * Copyright (C) 1991, 1992 Linus Torvalds
6 *
7 * super.c contains code to handle: - mount structures
8 * - super-block tables
9 * - filesystem drivers list
10 * - mount system call
11 * - umount system call
12 * - ustat system call
13 *
14 * GK 2/5/95 - Changed to support mounting the root fs via NFS
15 *
16 * Added kerneld support: Jacques Gelinas and Bjorn Ekwall
17 * Added change_root: Werner Almesberger & Hans Lermen, Feb '96
18 * Added options to /proc/mounts:
96de0e25 19 * Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
1da177e4
LT
20 * Added devfs support: Richard Gooch <rgooch@atnf.csiro.au>, 13-JAN-1998
21 * Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
22 */
23
630d9c47 24#include <linux/export.h>
1da177e4 25#include <linux/slab.h>
1da177e4 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>
6e4eab57 37#include <linux/user_namespace.h>
9bc61ab1 38#include <linux/fs_context.h>
e262e32d 39#include <uapi/linux/mount.h>
6d59e7f5 40#include "internal.h"
1da177e4 41
08fdc8a0 42static int thaw_super_locked(struct super_block *sb);
1da177e4 43
15d0f5ea
AV
44static LIST_HEAD(super_blocks);
45static DEFINE_SPINLOCK(sb_lock);
1da177e4 46
5accdf82
JK
47static char *sb_writers_name[SB_FREEZE_LEVELS] = {
48 "sb_writers",
49 "sb_pagefaults",
50 "sb_internal",
51};
52
b0d40c92
DC
53/*
54 * One thing we have to be careful of with a per-sb shrinker is that we don't
55 * drop the last active reference to the superblock from within the shrinker.
56 * If that happens we could trigger unregistering the shrinker from within the
57 * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
58 * take a passive reference to the superblock to avoid this from occurring.
59 */
0a234c6d
DC
60static unsigned long super_cache_scan(struct shrinker *shrink,
61 struct shrink_control *sc)
b0d40c92
DC
62{
63 struct super_block *sb;
0a234c6d
DC
64 long fs_objects = 0;
65 long total_objects;
66 long freed = 0;
67 long dentries;
68 long inodes;
b0d40c92
DC
69
70 sb = container_of(shrink, struct super_block, s_shrink);
71
72 /*
73 * Deadlock avoidance. We may hold various FS locks, and we don't want
74 * to recurse into the FS that called us in clear_inode() and friends..
75 */
0a234c6d
DC
76 if (!(sc->gfp_mask & __GFP_FS))
77 return SHRINK_STOP;
b0d40c92 78
eb6ef3df 79 if (!trylock_super(sb))
0a234c6d 80 return SHRINK_STOP;
b0d40c92 81
d0407903 82 if (sb->s_op->nr_cached_objects)
4101b624 83 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
0e1fdafd 84
503c358c
VD
85 inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
86 dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
f6041567 87 total_objects = dentries + inodes + fs_objects + 1;
475d0db7
TH
88 if (!total_objects)
89 total_objects = 1;
0e1fdafd 90
0a234c6d 91 /* proportion the scan between the caches */
f6041567 92 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
bc3b14cb 93 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
503c358c 94 fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
b0d40c92 95
0a234c6d
DC
96 /*
97 * prune the dcache first as the icache is pinned by it, then
98 * prune the icache, followed by the filesystem specific caches
49e7e7ff
VD
99 *
100 * Ensure that we always scan at least one object - memcg kmem
101 * accounting uses this to fully empty the caches.
0a234c6d 102 */
49e7e7ff 103 sc->nr_to_scan = dentries + 1;
503c358c 104 freed = prune_dcache_sb(sb, sc);
49e7e7ff 105 sc->nr_to_scan = inodes + 1;
503c358c 106 freed += prune_icache_sb(sb, sc);
0a234c6d
DC
107
108 if (fs_objects) {
49e7e7ff 109 sc->nr_to_scan = fs_objects + 1;
4101b624 110 freed += sb->s_op->free_cached_objects(sb, sc);
b0d40c92
DC
111 }
112
eb6ef3df 113 up_read(&sb->s_umount);
0a234c6d
DC
114 return freed;
115}
116
117static unsigned long super_cache_count(struct shrinker *shrink,
118 struct shrink_control *sc)
119{
120 struct super_block *sb;
121 long total_objects = 0;
122
123 sb = container_of(shrink, struct super_block, s_shrink);
124
d23da150 125 /*
79f546a6
DC
126 * We don't call trylock_super() here as it is a scalability bottleneck,
127 * so we're exposed to partial setup state. The shrinker rwsem does not
128 * protect filesystem operations backing list_lru_shrink_count() or
129 * s_op->nr_cached_objects(). Counts can change between
130 * super_cache_count and super_cache_scan, so we really don't need locks
131 * here.
132 *
133 * However, if we are currently mounting the superblock, the underlying
134 * filesystem might be in a state of partial construction and hence it
135 * is dangerous to access it. trylock_super() uses a SB_BORN check to
136 * avoid this situation, so do the same here. The memory barrier is
137 * matched with the one in mount_fs() as we don't hold locks here.
d23da150 138 */
79f546a6
DC
139 if (!(sb->s_flags & SB_BORN))
140 return 0;
141 smp_rmb();
142
0a234c6d 143 if (sb->s_op && sb->s_op->nr_cached_objects)
4101b624 144 total_objects = sb->s_op->nr_cached_objects(sb, sc);
0a234c6d 145
503c358c
VD
146 total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
147 total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
0a234c6d 148
9b996468
KT
149 if (!total_objects)
150 return SHRINK_EMPTY;
151
55f841ce 152 total_objects = vfs_pressure_ratio(total_objects);
0e1fdafd 153 return total_objects;
b0d40c92
DC
154}
155
853b39a7
ON
156static void destroy_super_work(struct work_struct *work)
157{
158 struct super_block *s = container_of(work, struct super_block,
159 destroy_work);
160 int i;
161
162 for (i = 0; i < SB_FREEZE_LEVELS; i++)
8129ed29 163 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
853b39a7
ON
164 kfree(s);
165}
166
167static void destroy_super_rcu(struct rcu_head *head)
168{
169 struct super_block *s = container_of(head, struct super_block, rcu);
170 INIT_WORK(&s->destroy_work, destroy_super_work);
171 schedule_work(&s->destroy_work);
172}
173
0200894d
AV
174/* Free a superblock that has never been seen by anyone */
175static void destroy_unused_super(struct super_block *s)
5accdf82 176{
0200894d
AV
177 if (!s)
178 return;
179 up_write(&s->s_umount);
7eb5e882
AV
180 list_lru_destroy(&s->s_dentry_lru);
181 list_lru_destroy(&s->s_inode_lru);
7eb5e882 182 security_sb_free(s);
6e4eab57 183 put_user_ns(s->s_user_ns);
7eb5e882 184 kfree(s->s_subtype);
8e04944f 185 free_prealloced_shrinker(&s->s_shrink);
0200894d
AV
186 /* no delays needed */
187 destroy_super_work(&s->destroy_work);
5accdf82
JK
188}
189
1da177e4
LT
190/**
191 * alloc_super - create new superblock
fe2bbc48 192 * @type: filesystem type superblock should belong to
9249e17f 193 * @flags: the mount flags
6e4eab57 194 * @user_ns: User namespace for the super_block
1da177e4
LT
195 *
196 * Allocates and initializes a new &struct super_block. alloc_super()
197 * returns a pointer new superblock or %NULL if allocation had failed.
198 */
6e4eab57
EB
199static struct super_block *alloc_super(struct file_system_type *type, int flags,
200 struct user_namespace *user_ns)
1da177e4 201{
11b0b5ab 202 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_USER);
b87221de 203 static const struct super_operations default_op;
7eb5e882
AV
204 int i;
205
206 if (!s)
207 return NULL;
1da177e4 208
b5bd856a 209 INIT_LIST_HEAD(&s->s_mounts);
6e4eab57 210 s->s_user_ns = get_user_ns(user_ns);
ca0168e8
AV
211 init_rwsem(&s->s_umount);
212 lockdep_set_class(&s->s_umount, &type->s_umount_key);
213 /*
214 * sget() can have s_umount recursion.
215 *
216 * When it cannot find a suitable sb, it allocates a new
217 * one (this one), and tries again to find a suitable old
218 * one.
219 *
220 * In case that succeeds, it will acquire the s_umount
221 * lock of the old one. Since these are clearly distrinct
222 * locks, and this object isn't exposed yet, there's no
223 * risk of deadlocks.
224 *
225 * Annotate this by putting this lock in a different
226 * subclass.
227 */
228 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
b5bd856a 229
7eb5e882
AV
230 if (security_sb_alloc(s))
231 goto fail;
7b7a8665 232
7eb5e882 233 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
8129ed29
ON
234 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
235 sb_writers_name[i],
236 &type->s_writers_key[i]))
7eb5e882 237 goto fail;
1da177e4 238 }
7eb5e882 239 init_waitqueue_head(&s->s_writers.wait_unfrozen);
df0ce26c 240 s->s_bdi = &noop_backing_dev_info;
7eb5e882 241 s->s_flags = flags;
cc50a07a 242 if (s->s_user_ns != &init_user_ns)
67690f93 243 s->s_iflags |= SB_I_NODEV;
7eb5e882 244 INIT_HLIST_NODE(&s->s_instances);
f1ee6162 245 INIT_HLIST_BL_HEAD(&s->s_roots);
e97fedb9 246 mutex_init(&s->s_sync_lock);
7eb5e882 247 INIT_LIST_HEAD(&s->s_inodes);
74278da9 248 spin_lock_init(&s->s_inode_list_lock);
6c60d2b5
DC
249 INIT_LIST_HEAD(&s->s_inodes_wb);
250 spin_lock_init(&s->s_inode_wblist_lock);
7eb5e882 251
7eb5e882
AV
252 s->s_count = 1;
253 atomic_set(&s->s_active, 1);
254 mutex_init(&s->s_vfs_rename_mutex);
255 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
bc8230ee 256 init_rwsem(&s->s_dquot.dqio_sem);
7eb5e882
AV
257 s->s_maxbytes = MAX_NON_LFS;
258 s->s_op = &default_op;
259 s->s_time_gran = 1000000000;
3cb29d11 260 s->cleancache_poolid = CLEANCACHE_NO_POOL;
7eb5e882
AV
261
262 s->s_shrink.seeks = DEFAULT_SEEKS;
263 s->s_shrink.scan_objects = super_cache_scan;
264 s->s_shrink.count_objects = super_cache_count;
265 s->s_shrink.batch = 1024;
2acb60a0 266 s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
8e04944f
TH
267 if (prealloc_shrinker(&s->s_shrink))
268 goto fail;
c92e8e10 269 if (list_lru_init_memcg(&s->s_dentry_lru, &s->s_shrink))
2b3648a6 270 goto fail;
c92e8e10 271 if (list_lru_init_memcg(&s->s_inode_lru, &s->s_shrink))
2b3648a6 272 goto fail;
1da177e4 273 return s;
5ca302c8 274
7eb5e882 275fail:
0200894d 276 destroy_unused_super(s);
7eb5e882 277 return NULL;
1da177e4
LT
278}
279
280/* Superblock refcounting */
281
282/*
35cf7ba0 283 * Drop a superblock's refcount. The caller must hold sb_lock.
1da177e4 284 */
c645b930 285static void __put_super(struct super_block *s)
1da177e4 286{
c645b930
AV
287 if (!--s->s_count) {
288 list_del_init(&s->s_list);
289 WARN_ON(s->s_dentry_lru.node);
290 WARN_ON(s->s_inode_lru.node);
291 WARN_ON(!list_empty(&s->s_mounts));
292 security_sb_free(s);
293 put_user_ns(s->s_user_ns);
294 kfree(s->s_subtype);
295 call_rcu(&s->rcu, destroy_super_rcu);
1da177e4 296 }
1da177e4
LT
297}
298
299/**
300 * put_super - drop a temporary reference to superblock
301 * @sb: superblock in question
302 *
303 * Drops a temporary reference, frees superblock if there's no
304 * references left.
305 */
f47ec3f2 306static void put_super(struct super_block *sb)
1da177e4
LT
307{
308 spin_lock(&sb_lock);
309 __put_super(sb);
310 spin_unlock(&sb_lock);
311}
312
313
314/**
1712ac8f 315 * deactivate_locked_super - drop an active reference to superblock
1da177e4
LT
316 * @s: superblock to deactivate
317 *
bd7ced98 318 * Drops an active reference to superblock, converting it into a temporary
1712ac8f 319 * one if there is no other active references left. In that case we
1da177e4
LT
320 * tell fs driver to shut it down and drop the temporary reference we
321 * had just acquired.
1712ac8f
AV
322 *
323 * Caller holds exclusive lock on superblock; that lock is released.
1da177e4 324 */
1712ac8f 325void deactivate_locked_super(struct super_block *s)
1da177e4
LT
326{
327 struct file_system_type *fs = s->s_type;
b20bd1a5 328 if (atomic_dec_and_test(&s->s_active)) {
3167760f 329 cleancache_invalidate_fs(s);
b0d40c92 330 unregister_shrinker(&s->s_shrink);
28f2cd4f 331 fs->kill_sb(s);
f5e1dd34 332
c0a5b560
VD
333 /*
334 * Since list_lru_destroy() may sleep, we cannot call it from
335 * put_super(), where we hold the sb_lock. Therefore we destroy
336 * the lru lists right now.
337 */
338 list_lru_destroy(&s->s_dentry_lru);
339 list_lru_destroy(&s->s_inode_lru);
340
1da177e4
LT
341 put_filesystem(fs);
342 put_super(s);
1712ac8f
AV
343 } else {
344 up_write(&s->s_umount);
1da177e4
LT
345 }
346}
347
1712ac8f 348EXPORT_SYMBOL(deactivate_locked_super);
1da177e4 349
74dbbdd7 350/**
1712ac8f 351 * deactivate_super - drop an active reference to superblock
74dbbdd7
AV
352 * @s: superblock to deactivate
353 *
1712ac8f
AV
354 * Variant of deactivate_locked_super(), except that superblock is *not*
355 * locked by caller. If we are going to drop the final active reference,
356 * lock will be acquired prior to that.
74dbbdd7 357 */
1712ac8f 358void deactivate_super(struct super_block *s)
74dbbdd7 359{
1712ac8f
AV
360 if (!atomic_add_unless(&s->s_active, -1, 1)) {
361 down_write(&s->s_umount);
362 deactivate_locked_super(s);
74dbbdd7
AV
363 }
364}
365
1712ac8f 366EXPORT_SYMBOL(deactivate_super);
74dbbdd7 367
1da177e4
LT
368/**
369 * grab_super - acquire an active reference
370 * @s: reference we are trying to make active
371 *
372 * Tries to acquire an active reference. grab_super() is used when we
373 * had just found a superblock in super_blocks or fs_type->fs_supers
374 * and want to turn it into a full-blown active reference. grab_super()
375 * is called with sb_lock held and drops it. Returns 1 in case of
376 * success, 0 if we had failed (superblock contents was already dead or
acfec9a5
AV
377 * dying when grab_super() had been called). Note that this is only
378 * called for superblocks not in rundown mode (== ones still on ->fs_supers
379 * of their type), so increment of ->s_count is OK here.
1da177e4 380 */
9c4dbee7 381static int grab_super(struct super_block *s) __releases(sb_lock)
1da177e4
LT
382{
383 s->s_count++;
384 spin_unlock(&sb_lock);
385 down_write(&s->s_umount);
e462ec50 386 if ((s->s_flags & SB_BORN) && atomic_inc_not_zero(&s->s_active)) {
acfec9a5
AV
387 put_super(s);
388 return 1;
389 }
1da177e4
LT
390 up_write(&s->s_umount);
391 put_super(s);
1da177e4
LT
392 return 0;
393}
394
12ad3ab6 395/*
eb6ef3df 396 * trylock_super - try to grab ->s_umount shared
331cbdee 397 * @sb: reference we are trying to grab
12ad3ab6 398 *
eb6ef3df 399 * Try to prevent fs shutdown. This is used in places where we
12ad3ab6 400 * cannot take an active reference but we need to ensure that the
eb6ef3df
KK
401 * filesystem is not shut down while we are working on it. It returns
402 * false if we cannot acquire s_umount or if we lose the race and
403 * filesystem already got into shutdown, and returns true with the s_umount
404 * lock held in read mode in case of success. On successful return,
405 * the caller must drop the s_umount lock when done.
406 *
407 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
408 * The reason why it's safe is that we are OK with doing trylock instead
409 * of down_read(). There's a couple of places that are OK with that, but
410 * it's very much not a general-purpose interface.
12ad3ab6 411 */
eb6ef3df 412bool trylock_super(struct super_block *sb)
12ad3ab6 413{
12ad3ab6 414 if (down_read_trylock(&sb->s_umount)) {
eb6ef3df 415 if (!hlist_unhashed(&sb->s_instances) &&
e462ec50 416 sb->s_root && (sb->s_flags & SB_BORN))
12ad3ab6
DC
417 return true;
418 up_read(&sb->s_umount);
419 }
420
12ad3ab6
DC
421 return false;
422}
423
1da177e4
LT
424/**
425 * generic_shutdown_super - common helper for ->kill_sb()
426 * @sb: superblock to kill
427 *
428 * generic_shutdown_super() does all fs-independent work on superblock
429 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
430 * that need destruction out of superblock, call generic_shutdown_super()
431 * and release aforementioned objects. Note: dentries and inodes _are_
432 * taken care of and do not need specific handling.
c636ebdb
DH
433 *
434 * Upon calling this function, the filesystem may no longer alter or
435 * rearrange the set of dentries belonging to this super_block, nor may it
436 * change the attachments of dentries to inodes.
1da177e4
LT
437 */
438void generic_shutdown_super(struct super_block *sb)
439{
ee9b6d61 440 const struct super_operations *sop = sb->s_op;
1da177e4 441
c636ebdb
DH
442 if (sb->s_root) {
443 shrink_dcache_for_umount(sb);
60b0680f 444 sync_filesystem(sb);
e462ec50 445 sb->s_flags &= ~SB_ACTIVE;
efaee192 446
1e6cb723 447 fsnotify_sb_delete(sb);
a1a0e23e 448 cgroup_writeback_umount();
63997e98
AV
449
450 evict_inodes(sb);
1da177e4 451
7b7a8665
CH
452 if (sb->s_dio_done_wq) {
453 destroy_workqueue(sb->s_dio_done_wq);
454 sb->s_dio_done_wq = NULL;
455 }
456
1da177e4
LT
457 if (sop->put_super)
458 sop->put_super(sb);
459
63997e98 460 if (!list_empty(&sb->s_inodes)) {
7b4fe29e
DJ
461 printk("VFS: Busy inodes after unmount of %s. "
462 "Self-destruct in 5 seconds. Have a nice day...\n",
463 sb->s_id);
1da177e4 464 }
1da177e4
LT
465 }
466 spin_lock(&sb_lock);
467 /* should be initialized for __put_super_and_need_restart() */
a5166169 468 hlist_del_init(&sb->s_instances);
1da177e4
LT
469 spin_unlock(&sb_lock);
470 up_write(&sb->s_umount);
c1844d53 471 if (sb->s_bdi != &noop_backing_dev_info) {
fca39346
JK
472 bdi_put(sb->s_bdi);
473 sb->s_bdi = &noop_backing_dev_info;
fca39346 474 }
1da177e4
LT
475}
476
477EXPORT_SYMBOL(generic_shutdown_super);
478
20284ab7 479bool mount_capable(struct fs_context *fc)
0ce0cf12 480{
20284ab7
AV
481 struct user_namespace *user_ns = fc->global ? &init_user_ns
482 : fc->user_ns;
483
484 if (!(fc->fs_type->fs_flags & FS_USERNS_MOUNT))
0ce0cf12
AV
485 return capable(CAP_SYS_ADMIN);
486 else
20284ab7 487 return ns_capable(user_ns, CAP_SYS_ADMIN);
0ce0cf12
AV
488}
489
cb50b348
AV
490/**
491 * sget_fc - Find or create a superblock
492 * @fc: Filesystem context.
493 * @test: Comparison callback
494 * @set: Setup callback
495 *
496 * Find or create a superblock using the parameters stored in the filesystem
497 * context and the two callback functions.
498 *
499 * If an extant superblock is matched, then that will be returned with an
500 * elevated reference count that the caller must transfer or discard.
501 *
502 * If no match is made, a new superblock will be allocated and basic
503 * initialisation will be performed (s_type, s_fs_info and s_id will be set and
504 * the set() callback will be invoked), the superblock will be published and it
505 * will be returned in a partially constructed state with SB_BORN and SB_ACTIVE
506 * as yet unset.
507 */
508struct super_block *sget_fc(struct fs_context *fc,
509 int (*test)(struct super_block *, struct fs_context *),
510 int (*set)(struct super_block *, struct fs_context *))
511{
512 struct super_block *s = NULL;
513 struct super_block *old;
514 struct user_namespace *user_ns = fc->global ? &init_user_ns : fc->user_ns;
515 int err;
516
cb50b348
AV
517retry:
518 spin_lock(&sb_lock);
519 if (test) {
520 hlist_for_each_entry(old, &fc->fs_type->fs_supers, s_instances) {
521 if (test(old, fc))
522 goto share_extant_sb;
523 }
524 }
525 if (!s) {
526 spin_unlock(&sb_lock);
527 s = alloc_super(fc->fs_type, fc->sb_flags, user_ns);
528 if (!s)
529 return ERR_PTR(-ENOMEM);
530 goto retry;
531 }
532
533 s->s_fs_info = fc->s_fs_info;
534 err = set(s, fc);
535 if (err) {
536 s->s_fs_info = NULL;
537 spin_unlock(&sb_lock);
538 destroy_unused_super(s);
539 return ERR_PTR(err);
540 }
541 fc->s_fs_info = NULL;
542 s->s_type = fc->fs_type;
c80fa7c8 543 s->s_iflags |= fc->s_iflags;
cb50b348
AV
544 strlcpy(s->s_id, s->s_type->name, sizeof(s->s_id));
545 list_add_tail(&s->s_list, &super_blocks);
546 hlist_add_head(&s->s_instances, &s->s_type->fs_supers);
547 spin_unlock(&sb_lock);
548 get_filesystem(s->s_type);
549 register_shrinker_prepared(&s->s_shrink);
550 return s;
551
552share_extant_sb:
553 if (user_ns != old->s_user_ns) {
554 spin_unlock(&sb_lock);
555 destroy_unused_super(s);
556 return ERR_PTR(-EBUSY);
557 }
558 if (!grab_super(old))
559 goto retry;
560 destroy_unused_super(s);
561 return old;
562}
563EXPORT_SYMBOL(sget_fc);
564
1da177e4 565/**
6e4eab57 566 * sget_userns - find or create a superblock
1da177e4
LT
567 * @type: filesystem type superblock should belong to
568 * @test: comparison callback
569 * @set: setup callback
9249e17f 570 * @flags: mount flags
6e4eab57 571 * @user_ns: User namespace for the super_block
1da177e4
LT
572 * @data: argument to each of them
573 */
6e4eab57 574struct super_block *sget_userns(struct file_system_type *type,
1da177e4
LT
575 int (*test)(struct super_block *,void *),
576 int (*set)(struct super_block *,void *),
6e4eab57 577 int flags, struct user_namespace *user_ns,
1da177e4
LT
578 void *data)
579{
580 struct super_block *s = NULL;
d4730127 581 struct super_block *old;
1da177e4
LT
582 int err;
583
584retry:
585 spin_lock(&sb_lock);
d4730127 586 if (test) {
b67bfe0d 587 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
d4730127
MK
588 if (!test(old, data))
589 continue;
6e4eab57
EB
590 if (user_ns != old->s_user_ns) {
591 spin_unlock(&sb_lock);
0200894d 592 destroy_unused_super(s);
6e4eab57
EB
593 return ERR_PTR(-EBUSY);
594 }
d4730127
MK
595 if (!grab_super(old))
596 goto retry;
0200894d 597 destroy_unused_super(s);
d4730127
MK
598 return old;
599 }
1da177e4
LT
600 }
601 if (!s) {
602 spin_unlock(&sb_lock);
e462ec50 603 s = alloc_super(type, (flags & ~SB_SUBMOUNT), user_ns);
1da177e4
LT
604 if (!s)
605 return ERR_PTR(-ENOMEM);
606 goto retry;
607 }
dd111b31 608
1da177e4
LT
609 err = set(s, data);
610 if (err) {
611 spin_unlock(&sb_lock);
0200894d 612 destroy_unused_super(s);
1da177e4
LT
613 return ERR_PTR(err);
614 }
615 s->s_type = type;
616 strlcpy(s->s_id, type->name, sizeof(s->s_id));
617 list_add_tail(&s->s_list, &super_blocks);
a5166169 618 hlist_add_head(&s->s_instances, &type->fs_supers);
1da177e4
LT
619 spin_unlock(&sb_lock);
620 get_filesystem(type);
8e04944f 621 register_shrinker_prepared(&s->s_shrink);
1da177e4
LT
622 return s;
623}
624
6e4eab57
EB
625EXPORT_SYMBOL(sget_userns);
626
627/**
628 * sget - find or create a superblock
629 * @type: filesystem type superblock should belong to
630 * @test: comparison callback
631 * @set: setup callback
632 * @flags: mount flags
633 * @data: argument to each of them
634 */
635struct super_block *sget(struct file_system_type *type,
636 int (*test)(struct super_block *,void *),
637 int (*set)(struct super_block *,void *),
638 int flags,
639 void *data)
640{
641 struct user_namespace *user_ns = current_user_ns();
642
93faccbb
EB
643 /* We don't yet pass the user namespace of the parent
644 * mount through to here so always use &init_user_ns
645 * until that changes.
646 */
e462ec50 647 if (flags & SB_SUBMOUNT)
93faccbb
EB
648 user_ns = &init_user_ns;
649
6e4eab57
EB
650 return sget_userns(type, test, set, flags, user_ns, data);
651}
652
1da177e4
LT
653EXPORT_SYMBOL(sget);
654
655void drop_super(struct super_block *sb)
656{
657 up_read(&sb->s_umount);
658 put_super(sb);
659}
660
661EXPORT_SYMBOL(drop_super);
662
ba6379f7
JK
663void drop_super_exclusive(struct super_block *sb)
664{
665 up_write(&sb->s_umount);
666 put_super(sb);
667}
668EXPORT_SYMBOL(drop_super_exclusive);
669
fa7c1d50
MG
670static void __iterate_supers(void (*f)(struct super_block *))
671{
672 struct super_block *sb, *p = NULL;
673
674 spin_lock(&sb_lock);
675 list_for_each_entry(sb, &super_blocks, s_list) {
676 if (hlist_unhashed(&sb->s_instances))
677 continue;
678 sb->s_count++;
679 spin_unlock(&sb_lock);
680
681 f(sb);
682
683 spin_lock(&sb_lock);
684 if (p)
685 __put_super(p);
686 p = sb;
687 }
688 if (p)
689 __put_super(p);
690 spin_unlock(&sb_lock);
691}
01a05b33
AV
692/**
693 * iterate_supers - call function for all active superblocks
694 * @f: function to call
695 * @arg: argument to pass to it
696 *
697 * Scans the superblock list and calls given function, passing it
698 * locked superblock and given argument.
699 */
700void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
701{
dca33252 702 struct super_block *sb, *p = NULL;
01a05b33
AV
703
704 spin_lock(&sb_lock);
dca33252 705 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 706 if (hlist_unhashed(&sb->s_instances))
01a05b33
AV
707 continue;
708 sb->s_count++;
709 spin_unlock(&sb_lock);
710
711 down_read(&sb->s_umount);
e462ec50 712 if (sb->s_root && (sb->s_flags & SB_BORN))
01a05b33
AV
713 f(sb, arg);
714 up_read(&sb->s_umount);
715
716 spin_lock(&sb_lock);
dca33252
AV
717 if (p)
718 __put_super(p);
719 p = sb;
01a05b33 720 }
dca33252
AV
721 if (p)
722 __put_super(p);
01a05b33
AV
723 spin_unlock(&sb_lock);
724}
725
43e15cdb
AV
726/**
727 * iterate_supers_type - call function for superblocks of given type
728 * @type: fs type
729 * @f: function to call
730 * @arg: argument to pass to it
731 *
732 * Scans the superblock list and calls given function, passing it
733 * locked superblock and given argument.
734 */
735void iterate_supers_type(struct file_system_type *type,
736 void (*f)(struct super_block *, void *), void *arg)
737{
738 struct super_block *sb, *p = NULL;
739
740 spin_lock(&sb_lock);
b67bfe0d 741 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
43e15cdb
AV
742 sb->s_count++;
743 spin_unlock(&sb_lock);
744
745 down_read(&sb->s_umount);
e462ec50 746 if (sb->s_root && (sb->s_flags & SB_BORN))
43e15cdb
AV
747 f(sb, arg);
748 up_read(&sb->s_umount);
749
750 spin_lock(&sb_lock);
751 if (p)
752 __put_super(p);
753 p = sb;
754 }
755 if (p)
756 __put_super(p);
757 spin_unlock(&sb_lock);
758}
759
760EXPORT_SYMBOL(iterate_supers_type);
761
ba6379f7 762static struct super_block *__get_super(struct block_device *bdev, bool excl)
1da177e4 763{
618f0636
KK
764 struct super_block *sb;
765
1da177e4
LT
766 if (!bdev)
767 return NULL;
618f0636 768
1da177e4 769 spin_lock(&sb_lock);
618f0636
KK
770rescan:
771 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 772 if (hlist_unhashed(&sb->s_instances))
551de6f3 773 continue;
618f0636
KK
774 if (sb->s_bdev == bdev) {
775 sb->s_count++;
1da177e4 776 spin_unlock(&sb_lock);
ba6379f7
JK
777 if (!excl)
778 down_read(&sb->s_umount);
779 else
780 down_write(&sb->s_umount);
df40c01a 781 /* still alive? */
e462ec50 782 if (sb->s_root && (sb->s_flags & SB_BORN))
618f0636 783 return sb;
ba6379f7
JK
784 if (!excl)
785 up_read(&sb->s_umount);
786 else
787 up_write(&sb->s_umount);
df40c01a 788 /* nope, got unmounted */
618f0636 789 spin_lock(&sb_lock);
df40c01a
AV
790 __put_super(sb);
791 goto rescan;
1da177e4
LT
792 }
793 }
794 spin_unlock(&sb_lock);
795 return NULL;
796}
797
6b6dc836 798/**
ba6379f7 799 * get_super - get the superblock of a device
6b6dc836
JK
800 * @bdev: device to get the superblock for
801 *
802 * Scans the superblock list and finds the superblock of the file system
ba6379f7 803 * mounted on the device given. %NULL is returned if no match is found.
6b6dc836 804 */
ba6379f7
JK
805struct super_block *get_super(struct block_device *bdev)
806{
807 return __get_super(bdev, false);
808}
809EXPORT_SYMBOL(get_super);
810
811static struct super_block *__get_super_thawed(struct block_device *bdev,
812 bool excl)
6b6dc836
JK
813{
814 while (1) {
ba6379f7 815 struct super_block *s = __get_super(bdev, excl);
5accdf82 816 if (!s || s->s_writers.frozen == SB_UNFROZEN)
6b6dc836 817 return s;
ba6379f7
JK
818 if (!excl)
819 up_read(&s->s_umount);
820 else
821 up_write(&s->s_umount);
5accdf82
JK
822 wait_event(s->s_writers.wait_unfrozen,
823 s->s_writers.frozen == SB_UNFROZEN);
6b6dc836
JK
824 put_super(s);
825 }
826}
ba6379f7
JK
827
828/**
829 * get_super_thawed - get thawed superblock of a device
830 * @bdev: device to get the superblock for
831 *
832 * Scans the superblock list and finds the superblock of the file system
833 * mounted on the device. The superblock is returned once it is thawed
834 * (or immediately if it was not frozen). %NULL is returned if no match
835 * is found.
836 */
837struct super_block *get_super_thawed(struct block_device *bdev)
838{
839 return __get_super_thawed(bdev, false);
840}
6b6dc836
JK
841EXPORT_SYMBOL(get_super_thawed);
842
ba6379f7
JK
843/**
844 * get_super_exclusive_thawed - get thawed superblock of a device
845 * @bdev: device to get the superblock for
846 *
847 * Scans the superblock list and finds the superblock of the file system
848 * mounted on the device. The superblock is returned once it is thawed
849 * (or immediately if it was not frozen) and s_umount semaphore is held
850 * in exclusive mode. %NULL is returned if no match is found.
851 */
852struct super_block *get_super_exclusive_thawed(struct block_device *bdev)
853{
854 return __get_super_thawed(bdev, true);
855}
856EXPORT_SYMBOL(get_super_exclusive_thawed);
857
4504230a
CH
858/**
859 * get_active_super - get an active reference to the superblock of a device
860 * @bdev: device to get the superblock for
861 *
862 * Scans the superblock list and finds the superblock of the file system
863 * mounted on the device given. Returns the superblock with an active
d3f21473 864 * reference or %NULL if none was found.
4504230a
CH
865 */
866struct super_block *get_active_super(struct block_device *bdev)
867{
868 struct super_block *sb;
869
870 if (!bdev)
871 return NULL;
872
1494583d 873restart:
4504230a
CH
874 spin_lock(&sb_lock);
875 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 876 if (hlist_unhashed(&sb->s_instances))
551de6f3 877 continue;
1494583d 878 if (sb->s_bdev == bdev) {
acfec9a5 879 if (!grab_super(sb))
1494583d 880 goto restart;
acfec9a5
AV
881 up_write(&sb->s_umount);
882 return sb;
1494583d 883 }
4504230a
CH
884 }
885 spin_unlock(&sb_lock);
886 return NULL;
887}
dd111b31 888
df40c01a 889struct super_block *user_get_super(dev_t dev)
1da177e4 890{
618f0636 891 struct super_block *sb;
1da177e4 892
1da177e4 893 spin_lock(&sb_lock);
618f0636
KK
894rescan:
895 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 896 if (hlist_unhashed(&sb->s_instances))
551de6f3 897 continue;
618f0636
KK
898 if (sb->s_dev == dev) {
899 sb->s_count++;
1da177e4 900 spin_unlock(&sb_lock);
618f0636 901 down_read(&sb->s_umount);
df40c01a 902 /* still alive? */
e462ec50 903 if (sb->s_root && (sb->s_flags & SB_BORN))
618f0636
KK
904 return sb;
905 up_read(&sb->s_umount);
df40c01a 906 /* nope, got unmounted */
618f0636 907 spin_lock(&sb_lock);
df40c01a
AV
908 __put_super(sb);
909 goto rescan;
1da177e4
LT
910 }
911 }
912 spin_unlock(&sb_lock);
913 return NULL;
914}
915
1da177e4 916/**
8d0347f6
DH
917 * reconfigure_super - asks filesystem to change superblock parameters
918 * @fc: The superblock and configuration
1da177e4 919 *
8d0347f6 920 * Alters the configuration parameters of a live superblock.
1da177e4 921 */
8d0347f6 922int reconfigure_super(struct fs_context *fc)
1da177e4 923{
8d0347f6 924 struct super_block *sb = fc->root->d_sb;
1da177e4 925 int retval;
8d0347f6
DH
926 bool remount_ro = false;
927 bool force = fc->sb_flags & SB_FORCE;
4504230a 928
8d0347f6
DH
929 if (fc->sb_flags_mask & ~MS_RMT_MASK)
930 return -EINVAL;
5accdf82 931 if (sb->s_writers.frozen != SB_UNFROZEN)
4504230a
CH
932 return -EBUSY;
933
8d0347f6
DH
934 retval = security_sb_remount(sb, fc->security);
935 if (retval)
936 return retval;
937
938 if (fc->sb_flags_mask & SB_RDONLY) {
9361401e 939#ifdef CONFIG_BLOCK
8d0347f6
DH
940 if (!(fc->sb_flags & SB_RDONLY) && bdev_read_only(sb->s_bdev))
941 return -EACCES;
9361401e 942#endif
4504230a 943
8d0347f6
DH
944 remount_ro = (fc->sb_flags & SB_RDONLY) && !sb_rdonly(sb);
945 }
d208bbdd 946
0aec09d0 947 if (remount_ro) {
fdab684d 948 if (!hlist_empty(&sb->s_pins)) {
0aec09d0 949 up_write(&sb->s_umount);
fdab684d 950 group_pin_kill(&sb->s_pins);
0aec09d0
AV
951 down_write(&sb->s_umount);
952 if (!sb->s_root)
953 return 0;
954 if (sb->s_writers.frozen != SB_UNFROZEN)
955 return -EBUSY;
8d0347f6 956 remount_ro = !sb_rdonly(sb);
0aec09d0
AV
957 }
958 }
959 shrink_dcache_sb(sb);
960
8d0347f6
DH
961 /* If we are reconfiguring to RDONLY and current sb is read/write,
962 * make sure there are no files open for writing.
963 */
d208bbdd 964 if (remount_ro) {
4ed5e82f 965 if (force) {
eee5cc27
AV
966 sb->s_readonly_remount = 1;
967 smp_wmb();
4ed5e82f
MS
968 } else {
969 retval = sb_prepare_remount_readonly(sb);
970 if (retval)
971 return retval;
4ed5e82f 972 }
1da177e4
LT
973 }
974
f3a09c92
AV
975 if (fc->ops->reconfigure) {
976 retval = fc->ops->reconfigure(fc);
977 if (retval) {
978 if (!force)
979 goto cancel_readonly;
980 /* If forced remount, go ahead despite any errors */
981 WARN(1, "forced remount of a %s fs returned %i\n",
982 sb->s_type->name, retval);
983 }
1da177e4 984 }
8d0347f6
DH
985
986 WRITE_ONCE(sb->s_flags, ((sb->s_flags & ~fc->sb_flags_mask) |
987 (fc->sb_flags & fc->sb_flags_mask)));
4ed5e82f
MS
988 /* Needs to be ordered wrt mnt_is_readonly() */
989 smp_wmb();
990 sb->s_readonly_remount = 0;
c79d967d 991
d208bbdd
NP
992 /*
993 * Some filesystems modify their metadata via some other path than the
994 * bdev buffer cache (eg. use a private mapping, or directories in
995 * pagecache, etc). Also file data modifications go via their own
996 * mappings. So If we try to mount readonly then copy the filesystem
997 * from bdev, we could get stale data, so invalidate it to give a best
998 * effort at coherency.
999 */
1000 if (remount_ro && sb->s_bdev)
1001 invalidate_bdev(sb->s_bdev);
1da177e4 1002 return 0;
4ed5e82f
MS
1003
1004cancel_readonly:
1005 sb->s_readonly_remount = 0;
1006 return retval;
1da177e4
LT
1007}
1008
fa7c1d50 1009static void do_emergency_remount_callback(struct super_block *sb)
1da177e4 1010{
fa7c1d50
MG
1011 down_write(&sb->s_umount);
1012 if (sb->s_root && sb->s_bdev && (sb->s_flags & SB_BORN) &&
1013 !sb_rdonly(sb)) {
8d0347f6
DH
1014 struct fs_context *fc;
1015
1016 fc = fs_context_for_reconfigure(sb->s_root,
1017 SB_RDONLY | SB_FORCE, SB_RDONLY);
1018 if (!IS_ERR(fc)) {
1019 if (parse_monolithic_mount_data(fc, NULL) == 0)
1020 (void)reconfigure_super(fc);
1021 put_fs_context(fc);
1022 }
1da177e4 1023 }
fa7c1d50
MG
1024 up_write(&sb->s_umount);
1025}
1026
1027static void do_emergency_remount(struct work_struct *work)
1028{
1029 __iterate_supers(do_emergency_remount_callback);
a2a9537a 1030 kfree(work);
1da177e4
LT
1031 printk("Emergency Remount complete\n");
1032}
1033
1034void emergency_remount(void)
1035{
a2a9537a
JA
1036 struct work_struct *work;
1037
1038 work = kmalloc(sizeof(*work), GFP_ATOMIC);
1039 if (work) {
1040 INIT_WORK(work, do_emergency_remount);
1041 schedule_work(work);
1042 }
1da177e4
LT
1043}
1044
08fdc8a0
MG
1045static void do_thaw_all_callback(struct super_block *sb)
1046{
1047 down_write(&sb->s_umount);
1c18d2a1 1048 if (sb->s_root && sb->s_flags & SB_BORN) {
08fdc8a0
MG
1049 emergency_thaw_bdev(sb);
1050 thaw_super_locked(sb);
1051 } else {
1052 up_write(&sb->s_umount);
1053 }
1054}
1055
1056static void do_thaw_all(struct work_struct *work)
1057{
1058 __iterate_supers(do_thaw_all_callback);
1059 kfree(work);
1060 printk(KERN_WARNING "Emergency Thaw complete\n");
1061}
1062
1063/**
1064 * emergency_thaw_all -- forcibly thaw every frozen filesystem
1065 *
1066 * Used for emergency unfreeze of all filesystems via SysRq
1067 */
1068void emergency_thaw_all(void)
1069{
1070 struct work_struct *work;
1071
1072 work = kmalloc(sizeof(*work), GFP_ATOMIC);
1073 if (work) {
1074 INIT_WORK(work, do_thaw_all);
1075 schedule_work(work);
1076 }
1077}
1078
ad76cbc6 1079static DEFINE_IDA(unnamed_dev_ida);
1da177e4 1080
5a66847e
MW
1081/**
1082 * get_anon_bdev - Allocate a block device for filesystems which don't have one.
1083 * @p: Pointer to a dev_t.
1084 *
1085 * Filesystems which don't use real block devices can call this function
1086 * to allocate a virtual block device.
1087 *
1088 * Context: Any context. Frequently called while holding sb_lock.
1089 * Return: 0 on success, -EMFILE if there are no anonymous bdevs left
1090 * or -ENOMEM if memory allocation failed.
1091 */
0ee5dc67 1092int get_anon_bdev(dev_t *p)
1da177e4
LT
1093{
1094 int dev;
5a66847e
MW
1095
1096 /*
1097 * Many userspace utilities consider an FSID of 0 invalid.
1098 * Always return at least 1 from get_anon_bdev.
1099 */
1100 dev = ida_alloc_range(&unnamed_dev_ida, 1, (1 << MINORBITS) - 1,
1101 GFP_ATOMIC);
1102 if (dev == -ENOSPC)
1103 dev = -EMFILE;
1104 if (dev < 0)
1105 return dev;
1106
1107 *p = MKDEV(0, dev);
1da177e4
LT
1108 return 0;
1109}
0ee5dc67 1110EXPORT_SYMBOL(get_anon_bdev);
1da177e4 1111
0ee5dc67 1112void free_anon_bdev(dev_t dev)
1da177e4 1113{
5a66847e 1114 ida_free(&unnamed_dev_ida, MINOR(dev));
1da177e4 1115}
0ee5dc67
AV
1116EXPORT_SYMBOL(free_anon_bdev);
1117
1118int set_anon_super(struct super_block *s, void *data)
1119{
df0ce26c 1120 return get_anon_bdev(&s->s_dev);
0ee5dc67 1121}
0ee5dc67
AV
1122EXPORT_SYMBOL(set_anon_super);
1123
1124void kill_anon_super(struct super_block *sb)
1125{
1126 dev_t dev = sb->s_dev;
1127 generic_shutdown_super(sb);
1128 free_anon_bdev(dev);
1129}
1da177e4
LT
1130EXPORT_SYMBOL(kill_anon_super);
1131
1da177e4
LT
1132void kill_litter_super(struct super_block *sb)
1133{
1134 if (sb->s_root)
1135 d_genocide(sb->s_root);
1136 kill_anon_super(sb);
1137}
1da177e4
LT
1138EXPORT_SYMBOL(kill_litter_super);
1139
cb50b348
AV
1140int set_anon_super_fc(struct super_block *sb, struct fs_context *fc)
1141{
1142 return set_anon_super(sb, NULL);
1143}
1144EXPORT_SYMBOL(set_anon_super_fc);
1145
1146static int test_keyed_super(struct super_block *sb, struct fs_context *fc)
1147{
1148 return sb->s_fs_info == fc->s_fs_info;
1149}
1150
1151static int test_single_super(struct super_block *s, struct fs_context *fc)
1152{
1153 return 1;
1154}
1155
1156/**
1157 * vfs_get_super - Get a superblock with a search key set in s_fs_info.
1158 * @fc: The filesystem context holding the parameters
1159 * @keying: How to distinguish superblocks
1160 * @fill_super: Helper to initialise a new superblock
1161 *
1162 * Search for a superblock and create a new one if not found. The search
1163 * criterion is controlled by @keying. If the search fails, a new superblock
1164 * is created and @fill_super() is called to initialise it.
1165 *
1166 * @keying can take one of a number of values:
1167 *
1168 * (1) vfs_get_single_super - Only one superblock of this type may exist on the
1169 * system. This is typically used for special system filesystems.
1170 *
1171 * (2) vfs_get_keyed_super - Multiple superblocks may exist, but they must have
1172 * distinct keys (where the key is in s_fs_info). Searching for the same
1173 * key again will turn up the superblock for that key.
1174 *
1175 * (3) vfs_get_independent_super - Multiple superblocks may exist and are
1176 * unkeyed. Each call will get a new superblock.
1177 *
1178 * A permissions check is made by sget_fc() unless we're getting a superblock
1179 * for a kernel-internal mount or a submount.
1180 */
1181int vfs_get_super(struct fs_context *fc,
1182 enum vfs_get_super_keying keying,
1183 int (*fill_super)(struct super_block *sb,
1184 struct fs_context *fc))
1185{
1186 int (*test)(struct super_block *, struct fs_context *);
1187 struct super_block *sb;
1188
1189 switch (keying) {
1190 case vfs_get_single_super:
1191 test = test_single_super;
1192 break;
1193 case vfs_get_keyed_super:
1194 test = test_keyed_super;
1195 break;
1196 case vfs_get_independent_super:
1197 test = NULL;
1198 break;
1199 default:
1200 BUG();
1201 }
1202
1203 sb = sget_fc(fc, test, set_anon_super_fc);
1204 if (IS_ERR(sb))
1205 return PTR_ERR(sb);
1206
1207 if (!sb->s_root) {
1208 int err = fill_super(sb, fc);
1209 if (err) {
1210 deactivate_locked_super(sb);
1211 return err;
1212 }
1213
1214 sb->s_flags |= SB_ACTIVE;
1215 }
1216
1217 BUG_ON(fc->root);
1218 fc->root = dget(sb->s_root);
1219 return 0;
1220}
1221EXPORT_SYMBOL(vfs_get_super);
1222
9361401e 1223#ifdef CONFIG_BLOCK
1da177e4
LT
1224static int set_bdev_super(struct super_block *s, void *data)
1225{
1226 s->s_bdev = data;
1227 s->s_dev = s->s_bdev->bd_dev;
13eec236 1228 s->s_bdi = bdi_get(s->s_bdev->bd_bdi);
32a88aa1 1229
1da177e4
LT
1230 return 0;
1231}
1232
1233static int test_bdev_super(struct super_block *s, void *data)
1234{
1235 return (void *)s->s_bdev == data;
1236}
1237
152a0836 1238struct dentry *mount_bdev(struct file_system_type *fs_type,
1da177e4 1239 int flags, const char *dev_name, void *data,
152a0836 1240 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1241{
1242 struct block_device *bdev;
1243 struct super_block *s;
d4d77629 1244 fmode_t mode = FMODE_READ | FMODE_EXCL;
1da177e4
LT
1245 int error = 0;
1246
e462ec50 1247 if (!(flags & SB_RDONLY))
30c40d2c
AV
1248 mode |= FMODE_WRITE;
1249
d4d77629 1250 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
1da177e4 1251 if (IS_ERR(bdev))
152a0836 1252 return ERR_CAST(bdev);
1da177e4
LT
1253
1254 /*
1255 * once the super is inserted into the list by sget, s_umount
1256 * will protect the lockfs code from trying to start a snapshot
1257 * while we are mounting
1258 */
4fadd7bb
CH
1259 mutex_lock(&bdev->bd_fsfreeze_mutex);
1260 if (bdev->bd_fsfreeze_count > 0) {
1261 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1262 error = -EBUSY;
1263 goto error_bdev;
1264 }
e462ec50 1265 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | SB_NOSEC,
9249e17f 1266 bdev);
4fadd7bb 1267 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1da177e4 1268 if (IS_ERR(s))
454e2398 1269 goto error_s;
1da177e4
LT
1270
1271 if (s->s_root) {
e462ec50 1272 if ((flags ^ s->s_flags) & SB_RDONLY) {
74dbbdd7 1273 deactivate_locked_super(s);
454e2398
DH
1274 error = -EBUSY;
1275 goto error_bdev;
1da177e4 1276 }
454e2398 1277
4f331f01
TH
1278 /*
1279 * s_umount nests inside bd_mutex during
e525fd89
TH
1280 * __invalidate_device(). blkdev_put() acquires
1281 * bd_mutex and can't be called under s_umount. Drop
1282 * s_umount temporarily. This is safe as we're
1283 * holding an active reference.
4f331f01
TH
1284 */
1285 up_write(&s->s_umount);
d4d77629 1286 blkdev_put(bdev, mode);
4f331f01 1287 down_write(&s->s_umount);
1da177e4 1288 } else {
30c40d2c 1289 s->s_mode = mode;
a1c6f057 1290 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
e78c9a00 1291 sb_set_blocksize(s, block_size(bdev));
e462ec50 1292 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1293 if (error) {
74dbbdd7 1294 deactivate_locked_super(s);
454e2398 1295 goto error;
fa675765 1296 }
454e2398 1297
e462ec50 1298 s->s_flags |= SB_ACTIVE;
87d8fe1e 1299 bdev->bd_super = s;
1da177e4
LT
1300 }
1301
152a0836 1302 return dget(s->s_root);
1da177e4 1303
454e2398
DH
1304error_s:
1305 error = PTR_ERR(s);
1306error_bdev:
d4d77629 1307 blkdev_put(bdev, mode);
454e2398 1308error:
152a0836
AV
1309 return ERR_PTR(error);
1310}
1311EXPORT_SYMBOL(mount_bdev);
1312
1da177e4
LT
1313void kill_block_super(struct super_block *sb)
1314{
1315 struct block_device *bdev = sb->s_bdev;
30c40d2c 1316 fmode_t mode = sb->s_mode;
1da177e4 1317
ddbaaf30 1318 bdev->bd_super = NULL;
1da177e4
LT
1319 generic_shutdown_super(sb);
1320 sync_blockdev(bdev);
d4d77629 1321 WARN_ON_ONCE(!(mode & FMODE_EXCL));
e525fd89 1322 blkdev_put(bdev, mode | FMODE_EXCL);
1da177e4
LT
1323}
1324
1325EXPORT_SYMBOL(kill_block_super);
9361401e 1326#endif
1da177e4 1327
3c26ff6e 1328struct dentry *mount_nodev(struct file_system_type *fs_type,
1da177e4 1329 int flags, void *data,
3c26ff6e 1330 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1331{
1332 int error;
9249e17f 1333 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1da177e4
LT
1334
1335 if (IS_ERR(s))
3c26ff6e 1336 return ERR_CAST(s);
1da177e4 1337
e462ec50 1338 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1339 if (error) {
74dbbdd7 1340 deactivate_locked_super(s);
3c26ff6e 1341 return ERR_PTR(error);
1da177e4 1342 }
e462ec50 1343 s->s_flags |= SB_ACTIVE;
3c26ff6e 1344 return dget(s->s_root);
1da177e4 1345}
3c26ff6e
AV
1346EXPORT_SYMBOL(mount_nodev);
1347
8d0347f6
DH
1348static int reconfigure_single(struct super_block *s,
1349 int flags, void *data)
1350{
1351 struct fs_context *fc;
1352 int ret;
1353
1354 /* The caller really need to be passing fc down into mount_single(),
1355 * then a chunk of this can be removed. [Bollocks -- AV]
1356 * Better yet, reconfiguration shouldn't happen, but rather the second
1357 * mount should be rejected if the parameters are not compatible.
1358 */
1359 fc = fs_context_for_reconfigure(s->s_root, flags, MS_RMT_MASK);
1360 if (IS_ERR(fc))
1361 return PTR_ERR(fc);
1362
1363 ret = parse_monolithic_mount_data(fc, data);
1364 if (ret < 0)
1365 goto out;
1366
1367 ret = reconfigure_super(fc);
1368out:
1369 put_fs_context(fc);
1370 return ret;
1371}
1372
1da177e4
LT
1373static int compare_single(struct super_block *s, void *p)
1374{
1375 return 1;
1376}
1377
fc14f2fe 1378struct dentry *mount_single(struct file_system_type *fs_type,
1da177e4 1379 int flags, void *data,
fc14f2fe 1380 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1381{
1382 struct super_block *s;
1383 int error;
1384
9249e17f 1385 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1da177e4 1386 if (IS_ERR(s))
fc14f2fe 1387 return ERR_CAST(s);
1da177e4 1388 if (!s->s_root) {
e462ec50 1389 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
8d0347f6
DH
1390 if (!error)
1391 s->s_flags |= SB_ACTIVE;
9329d1be 1392 } else {
8d0347f6
DH
1393 error = reconfigure_single(s, flags, data);
1394 }
1395 if (unlikely(error)) {
1396 deactivate_locked_super(s);
1397 return ERR_PTR(error);
1da177e4 1398 }
fc14f2fe
AV
1399 return dget(s->s_root);
1400}
1401EXPORT_SYMBOL(mount_single);
1402
9bc61ab1
DH
1403/**
1404 * vfs_get_tree - Get the mountable root
1405 * @fc: The superblock configuration context.
1406 *
1407 * The filesystem is invoked to get or create a superblock which can then later
1408 * be used for mounting. The filesystem places a pointer to the root to be
1409 * used for mounting in @fc->root.
1410 */
1411int vfs_get_tree(struct fs_context *fc)
1da177e4 1412{
9d412a43 1413 struct super_block *sb;
9bc61ab1 1414 int error;
8089352a 1415
f3a09c92
AV
1416 if (fc->root)
1417 return -EBUSY;
1418
1419 /* Get the mountable root in fc->root, with a ref on the root and a ref
1420 * on the superblock.
1421 */
1422 error = fc->ops->get_tree(fc);
9bc61ab1
DH
1423 if (error < 0)
1424 return error;
1da177e4 1425
f3a09c92
AV
1426 if (!fc->root) {
1427 pr_err("Filesystem %s get_tree() didn't set fc->root\n",
1428 fc->fs_type->name);
1429 /* We don't know what the locking state of the superblock is -
1430 * if there is a superblock.
1431 */
1432 BUG();
1433 }
1434
9bc61ab1 1435 sb = fc->root->d_sb;
9d412a43 1436 WARN_ON(!sb->s_bdi);
79f546a6 1437
a0c9a8b8
AV
1438 if (fc->subtype && !sb->s_subtype) {
1439 sb->s_subtype = fc->subtype;
1440 fc->subtype = NULL;
1441 }
1442
79f546a6
DC
1443 /*
1444 * Write barrier is for super_cache_count(). We place it before setting
1445 * SB_BORN as the data dependency between the two functions is the
1446 * superblock structure contents that we just set up, not the SB_BORN
1447 * flag.
1448 */
1449 smp_wmb();
e462ec50 1450 sb->s_flags |= SB_BORN;
454e2398 1451
9bc61ab1 1452 error = security_sb_set_mnt_opts(sb, fc->security, 0, NULL);
c9ce29ed
AV
1453 if (unlikely(error)) {
1454 fc_drop_locked(fc);
1455 return error;
a10d7c22
AV
1456 }
1457
42cb56ae
JL
1458 /*
1459 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1460 * but s_maxbytes was an unsigned long long for many releases. Throw
1461 * this warning for a little while to try and catch filesystems that
4358b567 1462 * violate this rule.
42cb56ae 1463 */
9d412a43 1464 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
9bc61ab1 1465 "negative value (%lld)\n", fc->fs_type->name, sb->s_maxbytes);
42cb56ae 1466
9bc61ab1 1467 return 0;
1da177e4 1468}
9bc61ab1 1469EXPORT_SYMBOL(vfs_get_tree);
1da177e4 1470
fca39346
JK
1471/*
1472 * Setup private BDI for given superblock. It gets automatically cleaned up
1473 * in generic_shutdown_super().
1474 */
1475int super_setup_bdi_name(struct super_block *sb, char *fmt, ...)
1476{
1477 struct backing_dev_info *bdi;
1478 int err;
1479 va_list args;
1480
1481 bdi = bdi_alloc(GFP_KERNEL);
1482 if (!bdi)
1483 return -ENOMEM;
1484
1485 bdi->name = sb->s_type->name;
1486
1487 va_start(args, fmt);
7c4cc300 1488 err = bdi_register_va(bdi, fmt, args);
fca39346
JK
1489 va_end(args);
1490 if (err) {
1491 bdi_put(bdi);
1492 return err;
1493 }
1494 WARN_ON(sb->s_bdi != &noop_backing_dev_info);
1495 sb->s_bdi = bdi;
fca39346
JK
1496
1497 return 0;
1498}
1499EXPORT_SYMBOL(super_setup_bdi_name);
1500
1501/*
1502 * Setup private BDI for given superblock. I gets automatically cleaned up
1503 * in generic_shutdown_super().
1504 */
1505int super_setup_bdi(struct super_block *sb)
1506{
1507 static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1508
1509 return super_setup_bdi_name(sb, "%.28s-%ld", sb->s_type->name,
1510 atomic_long_inc_return(&bdi_seq));
1511}
1512EXPORT_SYMBOL(super_setup_bdi);
1513
5accdf82
JK
1514/*
1515 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1516 * instead.
1517 */
1518void __sb_end_write(struct super_block *sb, int level)
1519{
8129ed29 1520 percpu_up_read(sb->s_writers.rw_sem + level-1);
5accdf82
JK
1521}
1522EXPORT_SYMBOL(__sb_end_write);
1523
f4b554af
ON
1524/*
1525 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1526 * instead.
1527 */
1528int __sb_start_write(struct super_block *sb, int level, bool wait)
1529{
1530 bool force_trylock = false;
8129ed29 1531 int ret = 1;
f4b554af
ON
1532
1533#ifdef CONFIG_LOCKDEP
1534 /*
1535 * We want lockdep to tell us about possible deadlocks with freezing
1536 * but it's it bit tricky to properly instrument it. Getting a freeze
1537 * protection works as getting a read lock but there are subtle
1538 * problems. XFS for example gets freeze protection on internal level
1539 * twice in some cases, which is OK only because we already hold a
1540 * freeze protection also on higher level. Due to these cases we have
1541 * to use wait == F (trylock mode) which must not fail.
1542 */
1543 if (wait) {
1544 int i;
1545
1546 for (i = 0; i < level - 1; i++)
8129ed29 1547 if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
f4b554af
ON
1548 force_trylock = true;
1549 break;
1550 }
1551 }
1552#endif
8129ed29
ON
1553 if (wait && !force_trylock)
1554 percpu_down_read(sb->s_writers.rw_sem + level-1);
1555 else
1556 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1557
22224a17 1558 WARN_ON(force_trylock && !ret);
f4b554af
ON
1559 return ret;
1560}
5accdf82
JK
1561EXPORT_SYMBOL(__sb_start_write);
1562
1563/**
1564 * sb_wait_write - wait until all writers to given file system finish
1565 * @sb: the super for which we wait
1566 * @level: type of writers we wait for (normal vs page fault)
1567 *
1568 * This function waits until there are no writers of given type to given file
8129ed29 1569 * system.
5accdf82
JK
1570 */
1571static void sb_wait_write(struct super_block *sb, int level)
1572{
8129ed29 1573 percpu_down_write(sb->s_writers.rw_sem + level-1);
8129ed29 1574}
5accdf82 1575
f1a96220
ON
1576/*
1577 * We are going to return to userspace and forget about these locks, the
1578 * ownership goes to the caller of thaw_super() which does unlock().
1579 */
1580static void lockdep_sb_freeze_release(struct super_block *sb)
1581{
1582 int level;
1583
1584 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1585 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1586}
1587
1588/*
1589 * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1590 */
1591static void lockdep_sb_freeze_acquire(struct super_block *sb)
8129ed29
ON
1592{
1593 int level;
5accdf82 1594
8129ed29
ON
1595 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1596 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
f1a96220
ON
1597}
1598
1599static void sb_freeze_unlock(struct super_block *sb)
1600{
1601 int level;
5accdf82 1602
8129ed29
ON
1603 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1604 percpu_up_write(sb->s_writers.rw_sem + level);
5accdf82
JK
1605}
1606
18e9e510 1607/**
7000d3c4
RD
1608 * freeze_super - lock the filesystem and force it into a consistent state
1609 * @sb: the super to lock
18e9e510
JB
1610 *
1611 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1612 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1613 * -EBUSY.
5accdf82
JK
1614 *
1615 * During this function, sb->s_writers.frozen goes through these values:
1616 *
1617 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1618 *
1619 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1620 * writes should be blocked, though page faults are still allowed. We wait for
1621 * all writes to complete and then proceed to the next stage.
1622 *
1623 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1624 * but internal fs threads can still modify the filesystem (although they
1625 * should not dirty new pages or inodes), writeback can run etc. After waiting
1626 * for all running page faults we sync the filesystem which will clean all
1627 * dirty pages and inodes (no new dirty pages or inodes can be created when
1628 * sync is running).
1629 *
1630 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1631 * modification are blocked (e.g. XFS preallocation truncation on inode
1632 * reclaim). This is usually implemented by blocking new transactions for
1633 * filesystems that have them and need this additional guard. After all
1634 * internal writers are finished we call ->freeze_fs() to finish filesystem
1635 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1636 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1637 *
1638 * sb->s_writers.frozen is protected by sb->s_umount.
18e9e510
JB
1639 */
1640int freeze_super(struct super_block *sb)
1641{
1642 int ret;
1643
1644 atomic_inc(&sb->s_active);
1645 down_write(&sb->s_umount);
5accdf82 1646 if (sb->s_writers.frozen != SB_UNFROZEN) {
18e9e510
JB
1647 deactivate_locked_super(sb);
1648 return -EBUSY;
1649 }
1650
e462ec50 1651 if (!(sb->s_flags & SB_BORN)) {
dabe0dc1
AV
1652 up_write(&sb->s_umount);
1653 return 0; /* sic - it's "nothing to do" */
1654 }
1655
bc98a42c 1656 if (sb_rdonly(sb)) {
5accdf82
JK
1657 /* Nothing to do really... */
1658 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
18e9e510
JB
1659 up_write(&sb->s_umount);
1660 return 0;
1661 }
1662
5accdf82 1663 sb->s_writers.frozen = SB_FREEZE_WRITE;
5accdf82
JK
1664 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1665 up_write(&sb->s_umount);
5accdf82 1666 sb_wait_write(sb, SB_FREEZE_WRITE);
8129ed29 1667 down_write(&sb->s_umount);
5accdf82
JK
1668
1669 /* Now we go and block page faults... */
5accdf82 1670 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
5accdf82
JK
1671 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1672
1673 /* All writers are done so after syncing there won't be dirty data */
18e9e510
JB
1674 sync_filesystem(sb);
1675
5accdf82
JK
1676 /* Now wait for internal filesystem counter */
1677 sb->s_writers.frozen = SB_FREEZE_FS;
5accdf82 1678 sb_wait_write(sb, SB_FREEZE_FS);
18e9e510 1679
18e9e510
JB
1680 if (sb->s_op->freeze_fs) {
1681 ret = sb->s_op->freeze_fs(sb);
1682 if (ret) {
1683 printk(KERN_ERR
1684 "VFS:Filesystem freeze failed\n");
5accdf82 1685 sb->s_writers.frozen = SB_UNFROZEN;
8129ed29 1686 sb_freeze_unlock(sb);
5accdf82 1687 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510
JB
1688 deactivate_locked_super(sb);
1689 return ret;
1690 }
1691 }
5accdf82 1692 /*
89f39af1
ON
1693 * For debugging purposes so that fs can warn if it sees write activity
1694 * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
5accdf82
JK
1695 */
1696 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
f1a96220 1697 lockdep_sb_freeze_release(sb);
18e9e510
JB
1698 up_write(&sb->s_umount);
1699 return 0;
1700}
1701EXPORT_SYMBOL(freeze_super);
1702
1703/**
1704 * thaw_super -- unlock filesystem
1705 * @sb: the super to thaw
1706 *
1707 * Unlocks the filesystem and marks it writeable again after freeze_super().
1708 */
08fdc8a0 1709static int thaw_super_locked(struct super_block *sb)
18e9e510
JB
1710{
1711 int error;
1712
89f39af1 1713 if (sb->s_writers.frozen != SB_FREEZE_COMPLETE) {
18e9e510
JB
1714 up_write(&sb->s_umount);
1715 return -EINVAL;
1716 }
1717
bc98a42c 1718 if (sb_rdonly(sb)) {
8129ed29 1719 sb->s_writers.frozen = SB_UNFROZEN;
18e9e510 1720 goto out;
8129ed29 1721 }
18e9e510 1722
f1a96220
ON
1723 lockdep_sb_freeze_acquire(sb);
1724
18e9e510
JB
1725 if (sb->s_op->unfreeze_fs) {
1726 error = sb->s_op->unfreeze_fs(sb);
1727 if (error) {
1728 printk(KERN_ERR
1729 "VFS:Filesystem thaw failed\n");
f1a96220 1730 lockdep_sb_freeze_release(sb);
18e9e510
JB
1731 up_write(&sb->s_umount);
1732 return error;
1733 }
1734 }
1735
5accdf82 1736 sb->s_writers.frozen = SB_UNFROZEN;
8129ed29
ON
1737 sb_freeze_unlock(sb);
1738out:
5accdf82 1739 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510 1740 deactivate_locked_super(sb);
18e9e510
JB
1741 return 0;
1742}
08fdc8a0
MG
1743
1744int thaw_super(struct super_block *sb)
1745{
1746 down_write(&sb->s_umount);
1747 return thaw_super_locked(sb);
1748}
18e9e510 1749EXPORT_SYMBOL(thaw_super);