fs_context flavour for submounts
[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
479/**
6e4eab57 480 * sget_userns - find or create a superblock
1da177e4
LT
481 * @type: filesystem type superblock should belong to
482 * @test: comparison callback
483 * @set: setup callback
9249e17f 484 * @flags: mount flags
6e4eab57 485 * @user_ns: User namespace for the super_block
1da177e4
LT
486 * @data: argument to each of them
487 */
6e4eab57 488struct super_block *sget_userns(struct file_system_type *type,
1da177e4
LT
489 int (*test)(struct super_block *,void *),
490 int (*set)(struct super_block *,void *),
6e4eab57 491 int flags, struct user_namespace *user_ns,
1da177e4
LT
492 void *data)
493{
494 struct super_block *s = NULL;
d4730127 495 struct super_block *old;
1da177e4
LT
496 int err;
497
e462ec50 498 if (!(flags & (SB_KERNMOUNT|SB_SUBMOUNT)) &&
a001e74c
EB
499 !(type->fs_flags & FS_USERNS_MOUNT) &&
500 !capable(CAP_SYS_ADMIN))
501 return ERR_PTR(-EPERM);
1da177e4
LT
502retry:
503 spin_lock(&sb_lock);
d4730127 504 if (test) {
b67bfe0d 505 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
d4730127
MK
506 if (!test(old, data))
507 continue;
6e4eab57
EB
508 if (user_ns != old->s_user_ns) {
509 spin_unlock(&sb_lock);
0200894d 510 destroy_unused_super(s);
6e4eab57
EB
511 return ERR_PTR(-EBUSY);
512 }
d4730127
MK
513 if (!grab_super(old))
514 goto retry;
0200894d 515 destroy_unused_super(s);
d4730127
MK
516 return old;
517 }
1da177e4
LT
518 }
519 if (!s) {
520 spin_unlock(&sb_lock);
e462ec50 521 s = alloc_super(type, (flags & ~SB_SUBMOUNT), user_ns);
1da177e4
LT
522 if (!s)
523 return ERR_PTR(-ENOMEM);
524 goto retry;
525 }
dd111b31 526
1da177e4
LT
527 err = set(s, data);
528 if (err) {
529 spin_unlock(&sb_lock);
0200894d 530 destroy_unused_super(s);
1da177e4
LT
531 return ERR_PTR(err);
532 }
533 s->s_type = type;
534 strlcpy(s->s_id, type->name, sizeof(s->s_id));
535 list_add_tail(&s->s_list, &super_blocks);
a5166169 536 hlist_add_head(&s->s_instances, &type->fs_supers);
1da177e4
LT
537 spin_unlock(&sb_lock);
538 get_filesystem(type);
8e04944f 539 register_shrinker_prepared(&s->s_shrink);
1da177e4
LT
540 return s;
541}
542
6e4eab57
EB
543EXPORT_SYMBOL(sget_userns);
544
545/**
546 * sget - find or create a superblock
547 * @type: filesystem type superblock should belong to
548 * @test: comparison callback
549 * @set: setup callback
550 * @flags: mount flags
551 * @data: argument to each of them
552 */
553struct super_block *sget(struct file_system_type *type,
554 int (*test)(struct super_block *,void *),
555 int (*set)(struct super_block *,void *),
556 int flags,
557 void *data)
558{
559 struct user_namespace *user_ns = current_user_ns();
560
93faccbb
EB
561 /* We don't yet pass the user namespace of the parent
562 * mount through to here so always use &init_user_ns
563 * until that changes.
564 */
e462ec50 565 if (flags & SB_SUBMOUNT)
93faccbb
EB
566 user_ns = &init_user_ns;
567
6e4eab57 568 /* Ensure the requestor has permissions over the target filesystem */
e462ec50 569 if (!(flags & (SB_KERNMOUNT|SB_SUBMOUNT)) && !ns_capable(user_ns, CAP_SYS_ADMIN))
6e4eab57
EB
570 return ERR_PTR(-EPERM);
571
572 return sget_userns(type, test, set, flags, user_ns, data);
573}
574
1da177e4
LT
575EXPORT_SYMBOL(sget);
576
577void drop_super(struct super_block *sb)
578{
579 up_read(&sb->s_umount);
580 put_super(sb);
581}
582
583EXPORT_SYMBOL(drop_super);
584
ba6379f7
JK
585void drop_super_exclusive(struct super_block *sb)
586{
587 up_write(&sb->s_umount);
588 put_super(sb);
589}
590EXPORT_SYMBOL(drop_super_exclusive);
591
fa7c1d50
MG
592static void __iterate_supers(void (*f)(struct super_block *))
593{
594 struct super_block *sb, *p = NULL;
595
596 spin_lock(&sb_lock);
597 list_for_each_entry(sb, &super_blocks, s_list) {
598 if (hlist_unhashed(&sb->s_instances))
599 continue;
600 sb->s_count++;
601 spin_unlock(&sb_lock);
602
603 f(sb);
604
605 spin_lock(&sb_lock);
606 if (p)
607 __put_super(p);
608 p = sb;
609 }
610 if (p)
611 __put_super(p);
612 spin_unlock(&sb_lock);
613}
01a05b33
AV
614/**
615 * iterate_supers - call function for all active superblocks
616 * @f: function to call
617 * @arg: argument to pass to it
618 *
619 * Scans the superblock list and calls given function, passing it
620 * locked superblock and given argument.
621 */
622void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
623{
dca33252 624 struct super_block *sb, *p = NULL;
01a05b33
AV
625
626 spin_lock(&sb_lock);
dca33252 627 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 628 if (hlist_unhashed(&sb->s_instances))
01a05b33
AV
629 continue;
630 sb->s_count++;
631 spin_unlock(&sb_lock);
632
633 down_read(&sb->s_umount);
e462ec50 634 if (sb->s_root && (sb->s_flags & SB_BORN))
01a05b33
AV
635 f(sb, arg);
636 up_read(&sb->s_umount);
637
638 spin_lock(&sb_lock);
dca33252
AV
639 if (p)
640 __put_super(p);
641 p = sb;
01a05b33 642 }
dca33252
AV
643 if (p)
644 __put_super(p);
01a05b33
AV
645 spin_unlock(&sb_lock);
646}
647
43e15cdb
AV
648/**
649 * iterate_supers_type - call function for superblocks of given type
650 * @type: fs type
651 * @f: function to call
652 * @arg: argument to pass to it
653 *
654 * Scans the superblock list and calls given function, passing it
655 * locked superblock and given argument.
656 */
657void iterate_supers_type(struct file_system_type *type,
658 void (*f)(struct super_block *, void *), void *arg)
659{
660 struct super_block *sb, *p = NULL;
661
662 spin_lock(&sb_lock);
b67bfe0d 663 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
43e15cdb
AV
664 sb->s_count++;
665 spin_unlock(&sb_lock);
666
667 down_read(&sb->s_umount);
e462ec50 668 if (sb->s_root && (sb->s_flags & SB_BORN))
43e15cdb
AV
669 f(sb, arg);
670 up_read(&sb->s_umount);
671
672 spin_lock(&sb_lock);
673 if (p)
674 __put_super(p);
675 p = sb;
676 }
677 if (p)
678 __put_super(p);
679 spin_unlock(&sb_lock);
680}
681
682EXPORT_SYMBOL(iterate_supers_type);
683
ba6379f7 684static struct super_block *__get_super(struct block_device *bdev, bool excl)
1da177e4 685{
618f0636
KK
686 struct super_block *sb;
687
1da177e4
LT
688 if (!bdev)
689 return NULL;
618f0636 690
1da177e4 691 spin_lock(&sb_lock);
618f0636
KK
692rescan:
693 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 694 if (hlist_unhashed(&sb->s_instances))
551de6f3 695 continue;
618f0636
KK
696 if (sb->s_bdev == bdev) {
697 sb->s_count++;
1da177e4 698 spin_unlock(&sb_lock);
ba6379f7
JK
699 if (!excl)
700 down_read(&sb->s_umount);
701 else
702 down_write(&sb->s_umount);
df40c01a 703 /* still alive? */
e462ec50 704 if (sb->s_root && (sb->s_flags & SB_BORN))
618f0636 705 return sb;
ba6379f7
JK
706 if (!excl)
707 up_read(&sb->s_umount);
708 else
709 up_write(&sb->s_umount);
df40c01a 710 /* nope, got unmounted */
618f0636 711 spin_lock(&sb_lock);
df40c01a
AV
712 __put_super(sb);
713 goto rescan;
1da177e4
LT
714 }
715 }
716 spin_unlock(&sb_lock);
717 return NULL;
718}
719
6b6dc836 720/**
ba6379f7 721 * get_super - get the superblock of a device
6b6dc836
JK
722 * @bdev: device to get the superblock for
723 *
724 * Scans the superblock list and finds the superblock of the file system
ba6379f7 725 * mounted on the device given. %NULL is returned if no match is found.
6b6dc836 726 */
ba6379f7
JK
727struct super_block *get_super(struct block_device *bdev)
728{
729 return __get_super(bdev, false);
730}
731EXPORT_SYMBOL(get_super);
732
733static struct super_block *__get_super_thawed(struct block_device *bdev,
734 bool excl)
6b6dc836
JK
735{
736 while (1) {
ba6379f7 737 struct super_block *s = __get_super(bdev, excl);
5accdf82 738 if (!s || s->s_writers.frozen == SB_UNFROZEN)
6b6dc836 739 return s;
ba6379f7
JK
740 if (!excl)
741 up_read(&s->s_umount);
742 else
743 up_write(&s->s_umount);
5accdf82
JK
744 wait_event(s->s_writers.wait_unfrozen,
745 s->s_writers.frozen == SB_UNFROZEN);
6b6dc836
JK
746 put_super(s);
747 }
748}
ba6379f7
JK
749
750/**
751 * get_super_thawed - get thawed superblock of a device
752 * @bdev: device to get the superblock for
753 *
754 * Scans the superblock list and finds the superblock of the file system
755 * mounted on the device. The superblock is returned once it is thawed
756 * (or immediately if it was not frozen). %NULL is returned if no match
757 * is found.
758 */
759struct super_block *get_super_thawed(struct block_device *bdev)
760{
761 return __get_super_thawed(bdev, false);
762}
6b6dc836
JK
763EXPORT_SYMBOL(get_super_thawed);
764
ba6379f7
JK
765/**
766 * get_super_exclusive_thawed - get thawed superblock of a device
767 * @bdev: device to get the superblock for
768 *
769 * Scans the superblock list and finds the superblock of the file system
770 * mounted on the device. The superblock is returned once it is thawed
771 * (or immediately if it was not frozen) and s_umount semaphore is held
772 * in exclusive mode. %NULL is returned if no match is found.
773 */
774struct super_block *get_super_exclusive_thawed(struct block_device *bdev)
775{
776 return __get_super_thawed(bdev, true);
777}
778EXPORT_SYMBOL(get_super_exclusive_thawed);
779
4504230a
CH
780/**
781 * get_active_super - get an active reference to the superblock of a device
782 * @bdev: device to get the superblock for
783 *
784 * Scans the superblock list and finds the superblock of the file system
785 * mounted on the device given. Returns the superblock with an active
d3f21473 786 * reference or %NULL if none was found.
4504230a
CH
787 */
788struct super_block *get_active_super(struct block_device *bdev)
789{
790 struct super_block *sb;
791
792 if (!bdev)
793 return NULL;
794
1494583d 795restart:
4504230a
CH
796 spin_lock(&sb_lock);
797 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 798 if (hlist_unhashed(&sb->s_instances))
551de6f3 799 continue;
1494583d 800 if (sb->s_bdev == bdev) {
acfec9a5 801 if (!grab_super(sb))
1494583d 802 goto restart;
acfec9a5
AV
803 up_write(&sb->s_umount);
804 return sb;
1494583d 805 }
4504230a
CH
806 }
807 spin_unlock(&sb_lock);
808 return NULL;
809}
dd111b31 810
df40c01a 811struct super_block *user_get_super(dev_t dev)
1da177e4 812{
618f0636 813 struct super_block *sb;
1da177e4 814
1da177e4 815 spin_lock(&sb_lock);
618f0636
KK
816rescan:
817 list_for_each_entry(sb, &super_blocks, s_list) {
a5166169 818 if (hlist_unhashed(&sb->s_instances))
551de6f3 819 continue;
618f0636
KK
820 if (sb->s_dev == dev) {
821 sb->s_count++;
1da177e4 822 spin_unlock(&sb_lock);
618f0636 823 down_read(&sb->s_umount);
df40c01a 824 /* still alive? */
e462ec50 825 if (sb->s_root && (sb->s_flags & SB_BORN))
618f0636
KK
826 return sb;
827 up_read(&sb->s_umount);
df40c01a 828 /* nope, got unmounted */
618f0636 829 spin_lock(&sb_lock);
df40c01a
AV
830 __put_super(sb);
831 goto rescan;
1da177e4
LT
832 }
833 }
834 spin_unlock(&sb_lock);
835 return NULL;
836}
837
1da177e4 838/**
8d0347f6
DH
839 * reconfigure_super - asks filesystem to change superblock parameters
840 * @fc: The superblock and configuration
1da177e4 841 *
8d0347f6 842 * Alters the configuration parameters of a live superblock.
1da177e4 843 */
8d0347f6 844int reconfigure_super(struct fs_context *fc)
1da177e4 845{
8d0347f6 846 struct super_block *sb = fc->root->d_sb;
1da177e4 847 int retval;
8d0347f6
DH
848 bool remount_ro = false;
849 bool force = fc->sb_flags & SB_FORCE;
4504230a 850
8d0347f6
DH
851 if (fc->sb_flags_mask & ~MS_RMT_MASK)
852 return -EINVAL;
5accdf82 853 if (sb->s_writers.frozen != SB_UNFROZEN)
4504230a
CH
854 return -EBUSY;
855
8d0347f6
DH
856 retval = security_sb_remount(sb, fc->security);
857 if (retval)
858 return retval;
859
860 if (fc->sb_flags_mask & SB_RDONLY) {
9361401e 861#ifdef CONFIG_BLOCK
8d0347f6
DH
862 if (!(fc->sb_flags & SB_RDONLY) && bdev_read_only(sb->s_bdev))
863 return -EACCES;
9361401e 864#endif
4504230a 865
8d0347f6
DH
866 remount_ro = (fc->sb_flags & SB_RDONLY) && !sb_rdonly(sb);
867 }
d208bbdd 868
0aec09d0 869 if (remount_ro) {
fdab684d 870 if (!hlist_empty(&sb->s_pins)) {
0aec09d0 871 up_write(&sb->s_umount);
fdab684d 872 group_pin_kill(&sb->s_pins);
0aec09d0
AV
873 down_write(&sb->s_umount);
874 if (!sb->s_root)
875 return 0;
876 if (sb->s_writers.frozen != SB_UNFROZEN)
877 return -EBUSY;
8d0347f6 878 remount_ro = !sb_rdonly(sb);
0aec09d0
AV
879 }
880 }
881 shrink_dcache_sb(sb);
882
8d0347f6
DH
883 /* If we are reconfiguring to RDONLY and current sb is read/write,
884 * make sure there are no files open for writing.
885 */
d208bbdd 886 if (remount_ro) {
4ed5e82f 887 if (force) {
eee5cc27
AV
888 sb->s_readonly_remount = 1;
889 smp_wmb();
4ed5e82f
MS
890 } else {
891 retval = sb_prepare_remount_readonly(sb);
892 if (retval)
893 return retval;
4ed5e82f 894 }
1da177e4
LT
895 }
896
8d0347f6
DH
897 retval = legacy_reconfigure(fc);
898 if (retval) {
899 if (!force)
900 goto cancel_readonly;
901 /* If forced remount, go ahead despite any errors */
902 WARN(1, "forced remount of a %s fs returned %i\n",
903 sb->s_type->name, retval);
1da177e4 904 }
8d0347f6
DH
905
906 WRITE_ONCE(sb->s_flags, ((sb->s_flags & ~fc->sb_flags_mask) |
907 (fc->sb_flags & fc->sb_flags_mask)));
4ed5e82f
MS
908 /* Needs to be ordered wrt mnt_is_readonly() */
909 smp_wmb();
910 sb->s_readonly_remount = 0;
c79d967d 911
d208bbdd
NP
912 /*
913 * Some filesystems modify their metadata via some other path than the
914 * bdev buffer cache (eg. use a private mapping, or directories in
915 * pagecache, etc). Also file data modifications go via their own
916 * mappings. So If we try to mount readonly then copy the filesystem
917 * from bdev, we could get stale data, so invalidate it to give a best
918 * effort at coherency.
919 */
920 if (remount_ro && sb->s_bdev)
921 invalidate_bdev(sb->s_bdev);
1da177e4 922 return 0;
4ed5e82f
MS
923
924cancel_readonly:
925 sb->s_readonly_remount = 0;
926 return retval;
1da177e4
LT
927}
928
fa7c1d50 929static void do_emergency_remount_callback(struct super_block *sb)
1da177e4 930{
fa7c1d50
MG
931 down_write(&sb->s_umount);
932 if (sb->s_root && sb->s_bdev && (sb->s_flags & SB_BORN) &&
933 !sb_rdonly(sb)) {
8d0347f6
DH
934 struct fs_context *fc;
935
936 fc = fs_context_for_reconfigure(sb->s_root,
937 SB_RDONLY | SB_FORCE, SB_RDONLY);
938 if (!IS_ERR(fc)) {
939 if (parse_monolithic_mount_data(fc, NULL) == 0)
940 (void)reconfigure_super(fc);
941 put_fs_context(fc);
942 }
1da177e4 943 }
fa7c1d50
MG
944 up_write(&sb->s_umount);
945}
946
947static void do_emergency_remount(struct work_struct *work)
948{
949 __iterate_supers(do_emergency_remount_callback);
a2a9537a 950 kfree(work);
1da177e4
LT
951 printk("Emergency Remount complete\n");
952}
953
954void emergency_remount(void)
955{
a2a9537a
JA
956 struct work_struct *work;
957
958 work = kmalloc(sizeof(*work), GFP_ATOMIC);
959 if (work) {
960 INIT_WORK(work, do_emergency_remount);
961 schedule_work(work);
962 }
1da177e4
LT
963}
964
08fdc8a0
MG
965static void do_thaw_all_callback(struct super_block *sb)
966{
967 down_write(&sb->s_umount);
1c18d2a1 968 if (sb->s_root && sb->s_flags & SB_BORN) {
08fdc8a0
MG
969 emergency_thaw_bdev(sb);
970 thaw_super_locked(sb);
971 } else {
972 up_write(&sb->s_umount);
973 }
974}
975
976static void do_thaw_all(struct work_struct *work)
977{
978 __iterate_supers(do_thaw_all_callback);
979 kfree(work);
980 printk(KERN_WARNING "Emergency Thaw complete\n");
981}
982
983/**
984 * emergency_thaw_all -- forcibly thaw every frozen filesystem
985 *
986 * Used for emergency unfreeze of all filesystems via SysRq
987 */
988void emergency_thaw_all(void)
989{
990 struct work_struct *work;
991
992 work = kmalloc(sizeof(*work), GFP_ATOMIC);
993 if (work) {
994 INIT_WORK(work, do_thaw_all);
995 schedule_work(work);
996 }
997}
998
ad76cbc6 999static DEFINE_IDA(unnamed_dev_ida);
1da177e4 1000
5a66847e
MW
1001/**
1002 * get_anon_bdev - Allocate a block device for filesystems which don't have one.
1003 * @p: Pointer to a dev_t.
1004 *
1005 * Filesystems which don't use real block devices can call this function
1006 * to allocate a virtual block device.
1007 *
1008 * Context: Any context. Frequently called while holding sb_lock.
1009 * Return: 0 on success, -EMFILE if there are no anonymous bdevs left
1010 * or -ENOMEM if memory allocation failed.
1011 */
0ee5dc67 1012int get_anon_bdev(dev_t *p)
1da177e4
LT
1013{
1014 int dev;
5a66847e
MW
1015
1016 /*
1017 * Many userspace utilities consider an FSID of 0 invalid.
1018 * Always return at least 1 from get_anon_bdev.
1019 */
1020 dev = ida_alloc_range(&unnamed_dev_ida, 1, (1 << MINORBITS) - 1,
1021 GFP_ATOMIC);
1022 if (dev == -ENOSPC)
1023 dev = -EMFILE;
1024 if (dev < 0)
1025 return dev;
1026
1027 *p = MKDEV(0, dev);
1da177e4
LT
1028 return 0;
1029}
0ee5dc67 1030EXPORT_SYMBOL(get_anon_bdev);
1da177e4 1031
0ee5dc67 1032void free_anon_bdev(dev_t dev)
1da177e4 1033{
5a66847e 1034 ida_free(&unnamed_dev_ida, MINOR(dev));
1da177e4 1035}
0ee5dc67
AV
1036EXPORT_SYMBOL(free_anon_bdev);
1037
1038int set_anon_super(struct super_block *s, void *data)
1039{
df0ce26c 1040 return get_anon_bdev(&s->s_dev);
0ee5dc67 1041}
0ee5dc67
AV
1042EXPORT_SYMBOL(set_anon_super);
1043
1044void kill_anon_super(struct super_block *sb)
1045{
1046 dev_t dev = sb->s_dev;
1047 generic_shutdown_super(sb);
1048 free_anon_bdev(dev);
1049}
1da177e4
LT
1050EXPORT_SYMBOL(kill_anon_super);
1051
1da177e4
LT
1052void kill_litter_super(struct super_block *sb)
1053{
1054 if (sb->s_root)
1055 d_genocide(sb->s_root);
1056 kill_anon_super(sb);
1057}
1da177e4
LT
1058EXPORT_SYMBOL(kill_litter_super);
1059
909e6d94
SH
1060static int ns_test_super(struct super_block *sb, void *data)
1061{
1062 return sb->s_fs_info == data;
1063}
1064
1065static int ns_set_super(struct super_block *sb, void *data)
1066{
1067 sb->s_fs_info = data;
1068 return set_anon_super(sb, NULL);
1069}
1070
d91ee87d
EB
1071struct dentry *mount_ns(struct file_system_type *fs_type,
1072 int flags, void *data, void *ns, struct user_namespace *user_ns,
1073 int (*fill_super)(struct super_block *, void *, int))
909e6d94
SH
1074{
1075 struct super_block *sb;
1076
d91ee87d
EB
1077 /* Don't allow mounting unless the caller has CAP_SYS_ADMIN
1078 * over the namespace.
1079 */
e462ec50 1080 if (!(flags & SB_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
d91ee87d
EB
1081 return ERR_PTR(-EPERM);
1082
6e4eab57
EB
1083 sb = sget_userns(fs_type, ns_test_super, ns_set_super, flags,
1084 user_ns, ns);
909e6d94 1085 if (IS_ERR(sb))
ceefda69 1086 return ERR_CAST(sb);
909e6d94
SH
1087
1088 if (!sb->s_root) {
1089 int err;
e462ec50 1090 err = fill_super(sb, data, flags & SB_SILENT ? 1 : 0);
909e6d94 1091 if (err) {
74dbbdd7 1092 deactivate_locked_super(sb);
ceefda69 1093 return ERR_PTR(err);
909e6d94
SH
1094 }
1095
e462ec50 1096 sb->s_flags |= SB_ACTIVE;
909e6d94
SH
1097 }
1098
ceefda69 1099 return dget(sb->s_root);
909e6d94
SH
1100}
1101
ceefda69 1102EXPORT_SYMBOL(mount_ns);
909e6d94 1103
9361401e 1104#ifdef CONFIG_BLOCK
1da177e4
LT
1105static int set_bdev_super(struct super_block *s, void *data)
1106{
1107 s->s_bdev = data;
1108 s->s_dev = s->s_bdev->bd_dev;
13eec236 1109 s->s_bdi = bdi_get(s->s_bdev->bd_bdi);
32a88aa1 1110
1da177e4
LT
1111 return 0;
1112}
1113
1114static int test_bdev_super(struct super_block *s, void *data)
1115{
1116 return (void *)s->s_bdev == data;
1117}
1118
152a0836 1119struct dentry *mount_bdev(struct file_system_type *fs_type,
1da177e4 1120 int flags, const char *dev_name, void *data,
152a0836 1121 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1122{
1123 struct block_device *bdev;
1124 struct super_block *s;
d4d77629 1125 fmode_t mode = FMODE_READ | FMODE_EXCL;
1da177e4
LT
1126 int error = 0;
1127
e462ec50 1128 if (!(flags & SB_RDONLY))
30c40d2c
AV
1129 mode |= FMODE_WRITE;
1130
d4d77629 1131 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
1da177e4 1132 if (IS_ERR(bdev))
152a0836 1133 return ERR_CAST(bdev);
1da177e4
LT
1134
1135 /*
1136 * once the super is inserted into the list by sget, s_umount
1137 * will protect the lockfs code from trying to start a snapshot
1138 * while we are mounting
1139 */
4fadd7bb
CH
1140 mutex_lock(&bdev->bd_fsfreeze_mutex);
1141 if (bdev->bd_fsfreeze_count > 0) {
1142 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1143 error = -EBUSY;
1144 goto error_bdev;
1145 }
e462ec50 1146 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | SB_NOSEC,
9249e17f 1147 bdev);
4fadd7bb 1148 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1da177e4 1149 if (IS_ERR(s))
454e2398 1150 goto error_s;
1da177e4
LT
1151
1152 if (s->s_root) {
e462ec50 1153 if ((flags ^ s->s_flags) & SB_RDONLY) {
74dbbdd7 1154 deactivate_locked_super(s);
454e2398
DH
1155 error = -EBUSY;
1156 goto error_bdev;
1da177e4 1157 }
454e2398 1158
4f331f01
TH
1159 /*
1160 * s_umount nests inside bd_mutex during
e525fd89
TH
1161 * __invalidate_device(). blkdev_put() acquires
1162 * bd_mutex and can't be called under s_umount. Drop
1163 * s_umount temporarily. This is safe as we're
1164 * holding an active reference.
4f331f01
TH
1165 */
1166 up_write(&s->s_umount);
d4d77629 1167 blkdev_put(bdev, mode);
4f331f01 1168 down_write(&s->s_umount);
1da177e4 1169 } else {
30c40d2c 1170 s->s_mode = mode;
a1c6f057 1171 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
e78c9a00 1172 sb_set_blocksize(s, block_size(bdev));
e462ec50 1173 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1174 if (error) {
74dbbdd7 1175 deactivate_locked_super(s);
454e2398 1176 goto error;
fa675765 1177 }
454e2398 1178
e462ec50 1179 s->s_flags |= SB_ACTIVE;
87d8fe1e 1180 bdev->bd_super = s;
1da177e4
LT
1181 }
1182
152a0836 1183 return dget(s->s_root);
1da177e4 1184
454e2398
DH
1185error_s:
1186 error = PTR_ERR(s);
1187error_bdev:
d4d77629 1188 blkdev_put(bdev, mode);
454e2398 1189error:
152a0836
AV
1190 return ERR_PTR(error);
1191}
1192EXPORT_SYMBOL(mount_bdev);
1193
1da177e4
LT
1194void kill_block_super(struct super_block *sb)
1195{
1196 struct block_device *bdev = sb->s_bdev;
30c40d2c 1197 fmode_t mode = sb->s_mode;
1da177e4 1198
ddbaaf30 1199 bdev->bd_super = NULL;
1da177e4
LT
1200 generic_shutdown_super(sb);
1201 sync_blockdev(bdev);
d4d77629 1202 WARN_ON_ONCE(!(mode & FMODE_EXCL));
e525fd89 1203 blkdev_put(bdev, mode | FMODE_EXCL);
1da177e4
LT
1204}
1205
1206EXPORT_SYMBOL(kill_block_super);
9361401e 1207#endif
1da177e4 1208
3c26ff6e 1209struct dentry *mount_nodev(struct file_system_type *fs_type,
1da177e4 1210 int flags, void *data,
3c26ff6e 1211 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1212{
1213 int error;
9249e17f 1214 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1da177e4
LT
1215
1216 if (IS_ERR(s))
3c26ff6e 1217 return ERR_CAST(s);
1da177e4 1218
e462ec50 1219 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1220 if (error) {
74dbbdd7 1221 deactivate_locked_super(s);
3c26ff6e 1222 return ERR_PTR(error);
1da177e4 1223 }
e462ec50 1224 s->s_flags |= SB_ACTIVE;
3c26ff6e 1225 return dget(s->s_root);
1da177e4 1226}
3c26ff6e
AV
1227EXPORT_SYMBOL(mount_nodev);
1228
8d0347f6
DH
1229static int reconfigure_single(struct super_block *s,
1230 int flags, void *data)
1231{
1232 struct fs_context *fc;
1233 int ret;
1234
1235 /* The caller really need to be passing fc down into mount_single(),
1236 * then a chunk of this can be removed. [Bollocks -- AV]
1237 * Better yet, reconfiguration shouldn't happen, but rather the second
1238 * mount should be rejected if the parameters are not compatible.
1239 */
1240 fc = fs_context_for_reconfigure(s->s_root, flags, MS_RMT_MASK);
1241 if (IS_ERR(fc))
1242 return PTR_ERR(fc);
1243
1244 ret = parse_monolithic_mount_data(fc, data);
1245 if (ret < 0)
1246 goto out;
1247
1248 ret = reconfigure_super(fc);
1249out:
1250 put_fs_context(fc);
1251 return ret;
1252}
1253
1da177e4
LT
1254static int compare_single(struct super_block *s, void *p)
1255{
1256 return 1;
1257}
1258
fc14f2fe 1259struct dentry *mount_single(struct file_system_type *fs_type,
1da177e4 1260 int flags, void *data,
fc14f2fe 1261 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1262{
1263 struct super_block *s;
1264 int error;
1265
9249e17f 1266 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1da177e4 1267 if (IS_ERR(s))
fc14f2fe 1268 return ERR_CAST(s);
1da177e4 1269 if (!s->s_root) {
e462ec50 1270 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
8d0347f6
DH
1271 if (!error)
1272 s->s_flags |= SB_ACTIVE;
9329d1be 1273 } else {
8d0347f6
DH
1274 error = reconfigure_single(s, flags, data);
1275 }
1276 if (unlikely(error)) {
1277 deactivate_locked_super(s);
1278 return ERR_PTR(error);
1da177e4 1279 }
fc14f2fe
AV
1280 return dget(s->s_root);
1281}
1282EXPORT_SYMBOL(mount_single);
1283
9bc61ab1
DH
1284/**
1285 * vfs_get_tree - Get the mountable root
1286 * @fc: The superblock configuration context.
1287 *
1288 * The filesystem is invoked to get or create a superblock which can then later
1289 * be used for mounting. The filesystem places a pointer to the root to be
1290 * used for mounting in @fc->root.
1291 */
1292int vfs_get_tree(struct fs_context *fc)
1da177e4 1293{
9d412a43 1294 struct super_block *sb;
9bc61ab1 1295 int error;
8089352a 1296
9bc61ab1
DH
1297 error = legacy_get_tree(fc);
1298 if (error < 0)
1299 return error;
1da177e4 1300
9bc61ab1 1301 sb = fc->root->d_sb;
9d412a43 1302 WARN_ON(!sb->s_bdi);
79f546a6 1303
a0c9a8b8
AV
1304 if (fc->subtype && !sb->s_subtype) {
1305 sb->s_subtype = fc->subtype;
1306 fc->subtype = NULL;
1307 }
1308
79f546a6
DC
1309 /*
1310 * Write barrier is for super_cache_count(). We place it before setting
1311 * SB_BORN as the data dependency between the two functions is the
1312 * superblock structure contents that we just set up, not the SB_BORN
1313 * flag.
1314 */
1315 smp_wmb();
e462ec50 1316 sb->s_flags |= SB_BORN;
454e2398 1317
9bc61ab1 1318 error = security_sb_set_mnt_opts(sb, fc->security, 0, NULL);
c9ce29ed
AV
1319 if (unlikely(error)) {
1320 fc_drop_locked(fc);
1321 return error;
a10d7c22
AV
1322 }
1323
42cb56ae
JL
1324 /*
1325 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1326 * but s_maxbytes was an unsigned long long for many releases. Throw
1327 * this warning for a little while to try and catch filesystems that
4358b567 1328 * violate this rule.
42cb56ae 1329 */
9d412a43 1330 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
9bc61ab1 1331 "negative value (%lld)\n", fc->fs_type->name, sb->s_maxbytes);
42cb56ae 1332
9bc61ab1 1333 return 0;
1da177e4 1334}
9bc61ab1 1335EXPORT_SYMBOL(vfs_get_tree);
1da177e4 1336
fca39346
JK
1337/*
1338 * Setup private BDI for given superblock. It gets automatically cleaned up
1339 * in generic_shutdown_super().
1340 */
1341int super_setup_bdi_name(struct super_block *sb, char *fmt, ...)
1342{
1343 struct backing_dev_info *bdi;
1344 int err;
1345 va_list args;
1346
1347 bdi = bdi_alloc(GFP_KERNEL);
1348 if (!bdi)
1349 return -ENOMEM;
1350
1351 bdi->name = sb->s_type->name;
1352
1353 va_start(args, fmt);
7c4cc300 1354 err = bdi_register_va(bdi, fmt, args);
fca39346
JK
1355 va_end(args);
1356 if (err) {
1357 bdi_put(bdi);
1358 return err;
1359 }
1360 WARN_ON(sb->s_bdi != &noop_backing_dev_info);
1361 sb->s_bdi = bdi;
fca39346
JK
1362
1363 return 0;
1364}
1365EXPORT_SYMBOL(super_setup_bdi_name);
1366
1367/*
1368 * Setup private BDI for given superblock. I gets automatically cleaned up
1369 * in generic_shutdown_super().
1370 */
1371int super_setup_bdi(struct super_block *sb)
1372{
1373 static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1374
1375 return super_setup_bdi_name(sb, "%.28s-%ld", sb->s_type->name,
1376 atomic_long_inc_return(&bdi_seq));
1377}
1378EXPORT_SYMBOL(super_setup_bdi);
1379
5accdf82
JK
1380/*
1381 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1382 * instead.
1383 */
1384void __sb_end_write(struct super_block *sb, int level)
1385{
8129ed29 1386 percpu_up_read(sb->s_writers.rw_sem + level-1);
5accdf82
JK
1387}
1388EXPORT_SYMBOL(__sb_end_write);
1389
f4b554af
ON
1390/*
1391 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1392 * instead.
1393 */
1394int __sb_start_write(struct super_block *sb, int level, bool wait)
1395{
1396 bool force_trylock = false;
8129ed29 1397 int ret = 1;
f4b554af
ON
1398
1399#ifdef CONFIG_LOCKDEP
1400 /*
1401 * We want lockdep to tell us about possible deadlocks with freezing
1402 * but it's it bit tricky to properly instrument it. Getting a freeze
1403 * protection works as getting a read lock but there are subtle
1404 * problems. XFS for example gets freeze protection on internal level
1405 * twice in some cases, which is OK only because we already hold a
1406 * freeze protection also on higher level. Due to these cases we have
1407 * to use wait == F (trylock mode) which must not fail.
1408 */
1409 if (wait) {
1410 int i;
1411
1412 for (i = 0; i < level - 1; i++)
8129ed29 1413 if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
f4b554af
ON
1414 force_trylock = true;
1415 break;
1416 }
1417 }
1418#endif
8129ed29
ON
1419 if (wait && !force_trylock)
1420 percpu_down_read(sb->s_writers.rw_sem + level-1);
1421 else
1422 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1423
22224a17 1424 WARN_ON(force_trylock && !ret);
f4b554af
ON
1425 return ret;
1426}
5accdf82
JK
1427EXPORT_SYMBOL(__sb_start_write);
1428
1429/**
1430 * sb_wait_write - wait until all writers to given file system finish
1431 * @sb: the super for which we wait
1432 * @level: type of writers we wait for (normal vs page fault)
1433 *
1434 * This function waits until there are no writers of given type to given file
8129ed29 1435 * system.
5accdf82
JK
1436 */
1437static void sb_wait_write(struct super_block *sb, int level)
1438{
8129ed29 1439 percpu_down_write(sb->s_writers.rw_sem + level-1);
8129ed29 1440}
5accdf82 1441
f1a96220
ON
1442/*
1443 * We are going to return to userspace and forget about these locks, the
1444 * ownership goes to the caller of thaw_super() which does unlock().
1445 */
1446static void lockdep_sb_freeze_release(struct super_block *sb)
1447{
1448 int level;
1449
1450 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1451 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1452}
1453
1454/*
1455 * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1456 */
1457static void lockdep_sb_freeze_acquire(struct super_block *sb)
8129ed29
ON
1458{
1459 int level;
5accdf82 1460
8129ed29
ON
1461 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1462 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
f1a96220
ON
1463}
1464
1465static void sb_freeze_unlock(struct super_block *sb)
1466{
1467 int level;
5accdf82 1468
8129ed29
ON
1469 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1470 percpu_up_write(sb->s_writers.rw_sem + level);
5accdf82
JK
1471}
1472
18e9e510 1473/**
7000d3c4
RD
1474 * freeze_super - lock the filesystem and force it into a consistent state
1475 * @sb: the super to lock
18e9e510
JB
1476 *
1477 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1478 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1479 * -EBUSY.
5accdf82
JK
1480 *
1481 * During this function, sb->s_writers.frozen goes through these values:
1482 *
1483 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1484 *
1485 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1486 * writes should be blocked, though page faults are still allowed. We wait for
1487 * all writes to complete and then proceed to the next stage.
1488 *
1489 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1490 * but internal fs threads can still modify the filesystem (although they
1491 * should not dirty new pages or inodes), writeback can run etc. After waiting
1492 * for all running page faults we sync the filesystem which will clean all
1493 * dirty pages and inodes (no new dirty pages or inodes can be created when
1494 * sync is running).
1495 *
1496 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1497 * modification are blocked (e.g. XFS preallocation truncation on inode
1498 * reclaim). This is usually implemented by blocking new transactions for
1499 * filesystems that have them and need this additional guard. After all
1500 * internal writers are finished we call ->freeze_fs() to finish filesystem
1501 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1502 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1503 *
1504 * sb->s_writers.frozen is protected by sb->s_umount.
18e9e510
JB
1505 */
1506int freeze_super(struct super_block *sb)
1507{
1508 int ret;
1509
1510 atomic_inc(&sb->s_active);
1511 down_write(&sb->s_umount);
5accdf82 1512 if (sb->s_writers.frozen != SB_UNFROZEN) {
18e9e510
JB
1513 deactivate_locked_super(sb);
1514 return -EBUSY;
1515 }
1516
e462ec50 1517 if (!(sb->s_flags & SB_BORN)) {
dabe0dc1
AV
1518 up_write(&sb->s_umount);
1519 return 0; /* sic - it's "nothing to do" */
1520 }
1521
bc98a42c 1522 if (sb_rdonly(sb)) {
5accdf82
JK
1523 /* Nothing to do really... */
1524 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
18e9e510
JB
1525 up_write(&sb->s_umount);
1526 return 0;
1527 }
1528
5accdf82 1529 sb->s_writers.frozen = SB_FREEZE_WRITE;
5accdf82
JK
1530 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1531 up_write(&sb->s_umount);
5accdf82 1532 sb_wait_write(sb, SB_FREEZE_WRITE);
8129ed29 1533 down_write(&sb->s_umount);
5accdf82
JK
1534
1535 /* Now we go and block page faults... */
5accdf82 1536 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
5accdf82
JK
1537 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1538
1539 /* All writers are done so after syncing there won't be dirty data */
18e9e510
JB
1540 sync_filesystem(sb);
1541
5accdf82
JK
1542 /* Now wait for internal filesystem counter */
1543 sb->s_writers.frozen = SB_FREEZE_FS;
5accdf82 1544 sb_wait_write(sb, SB_FREEZE_FS);
18e9e510 1545
18e9e510
JB
1546 if (sb->s_op->freeze_fs) {
1547 ret = sb->s_op->freeze_fs(sb);
1548 if (ret) {
1549 printk(KERN_ERR
1550 "VFS:Filesystem freeze failed\n");
5accdf82 1551 sb->s_writers.frozen = SB_UNFROZEN;
8129ed29 1552 sb_freeze_unlock(sb);
5accdf82 1553 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510
JB
1554 deactivate_locked_super(sb);
1555 return ret;
1556 }
1557 }
5accdf82 1558 /*
89f39af1
ON
1559 * For debugging purposes so that fs can warn if it sees write activity
1560 * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
5accdf82
JK
1561 */
1562 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
f1a96220 1563 lockdep_sb_freeze_release(sb);
18e9e510
JB
1564 up_write(&sb->s_umount);
1565 return 0;
1566}
1567EXPORT_SYMBOL(freeze_super);
1568
1569/**
1570 * thaw_super -- unlock filesystem
1571 * @sb: the super to thaw
1572 *
1573 * Unlocks the filesystem and marks it writeable again after freeze_super().
1574 */
08fdc8a0 1575static int thaw_super_locked(struct super_block *sb)
18e9e510
JB
1576{
1577 int error;
1578
89f39af1 1579 if (sb->s_writers.frozen != SB_FREEZE_COMPLETE) {
18e9e510
JB
1580 up_write(&sb->s_umount);
1581 return -EINVAL;
1582 }
1583
bc98a42c 1584 if (sb_rdonly(sb)) {
8129ed29 1585 sb->s_writers.frozen = SB_UNFROZEN;
18e9e510 1586 goto out;
8129ed29 1587 }
18e9e510 1588
f1a96220
ON
1589 lockdep_sb_freeze_acquire(sb);
1590
18e9e510
JB
1591 if (sb->s_op->unfreeze_fs) {
1592 error = sb->s_op->unfreeze_fs(sb);
1593 if (error) {
1594 printk(KERN_ERR
1595 "VFS:Filesystem thaw failed\n");
f1a96220 1596 lockdep_sb_freeze_release(sb);
18e9e510
JB
1597 up_write(&sb->s_umount);
1598 return error;
1599 }
1600 }
1601
5accdf82 1602 sb->s_writers.frozen = SB_UNFROZEN;
8129ed29
ON
1603 sb_freeze_unlock(sb);
1604out:
5accdf82 1605 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510 1606 deactivate_locked_super(sb);
18e9e510
JB
1607 return 0;
1608}
08fdc8a0
MG
1609
1610int thaw_super(struct super_block *sb)
1611{
1612 down_write(&sb->s_umount);
1613 return thaw_super_locked(sb);
1614}
18e9e510 1615EXPORT_SYMBOL(thaw_super);