introduce fs_context methods
[linux-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
f3a09c92
AV
897 if (fc->ops->reconfigure) {
898 retval = fc->ops->reconfigure(fc);
899 if (retval) {
900 if (!force)
901 goto cancel_readonly;
902 /* If forced remount, go ahead despite any errors */
903 WARN(1, "forced remount of a %s fs returned %i\n",
904 sb->s_type->name, retval);
905 }
1da177e4 906 }
8d0347f6
DH
907
908 WRITE_ONCE(sb->s_flags, ((sb->s_flags & ~fc->sb_flags_mask) |
909 (fc->sb_flags & fc->sb_flags_mask)));
4ed5e82f
MS
910 /* Needs to be ordered wrt mnt_is_readonly() */
911 smp_wmb();
912 sb->s_readonly_remount = 0;
c79d967d 913
d208bbdd
NP
914 /*
915 * Some filesystems modify their metadata via some other path than the
916 * bdev buffer cache (eg. use a private mapping, or directories in
917 * pagecache, etc). Also file data modifications go via their own
918 * mappings. So If we try to mount readonly then copy the filesystem
919 * from bdev, we could get stale data, so invalidate it to give a best
920 * effort at coherency.
921 */
922 if (remount_ro && sb->s_bdev)
923 invalidate_bdev(sb->s_bdev);
1da177e4 924 return 0;
4ed5e82f
MS
925
926cancel_readonly:
927 sb->s_readonly_remount = 0;
928 return retval;
1da177e4
LT
929}
930
fa7c1d50 931static void do_emergency_remount_callback(struct super_block *sb)
1da177e4 932{
fa7c1d50
MG
933 down_write(&sb->s_umount);
934 if (sb->s_root && sb->s_bdev && (sb->s_flags & SB_BORN) &&
935 !sb_rdonly(sb)) {
8d0347f6
DH
936 struct fs_context *fc;
937
938 fc = fs_context_for_reconfigure(sb->s_root,
939 SB_RDONLY | SB_FORCE, SB_RDONLY);
940 if (!IS_ERR(fc)) {
941 if (parse_monolithic_mount_data(fc, NULL) == 0)
942 (void)reconfigure_super(fc);
943 put_fs_context(fc);
944 }
1da177e4 945 }
fa7c1d50
MG
946 up_write(&sb->s_umount);
947}
948
949static void do_emergency_remount(struct work_struct *work)
950{
951 __iterate_supers(do_emergency_remount_callback);
a2a9537a 952 kfree(work);
1da177e4
LT
953 printk("Emergency Remount complete\n");
954}
955
956void emergency_remount(void)
957{
a2a9537a
JA
958 struct work_struct *work;
959
960 work = kmalloc(sizeof(*work), GFP_ATOMIC);
961 if (work) {
962 INIT_WORK(work, do_emergency_remount);
963 schedule_work(work);
964 }
1da177e4
LT
965}
966
08fdc8a0
MG
967static void do_thaw_all_callback(struct super_block *sb)
968{
969 down_write(&sb->s_umount);
1c18d2a1 970 if (sb->s_root && sb->s_flags & SB_BORN) {
08fdc8a0
MG
971 emergency_thaw_bdev(sb);
972 thaw_super_locked(sb);
973 } else {
974 up_write(&sb->s_umount);
975 }
976}
977
978static void do_thaw_all(struct work_struct *work)
979{
980 __iterate_supers(do_thaw_all_callback);
981 kfree(work);
982 printk(KERN_WARNING "Emergency Thaw complete\n");
983}
984
985/**
986 * emergency_thaw_all -- forcibly thaw every frozen filesystem
987 *
988 * Used for emergency unfreeze of all filesystems via SysRq
989 */
990void emergency_thaw_all(void)
991{
992 struct work_struct *work;
993
994 work = kmalloc(sizeof(*work), GFP_ATOMIC);
995 if (work) {
996 INIT_WORK(work, do_thaw_all);
997 schedule_work(work);
998 }
999}
1000
ad76cbc6 1001static DEFINE_IDA(unnamed_dev_ida);
1da177e4 1002
5a66847e
MW
1003/**
1004 * get_anon_bdev - Allocate a block device for filesystems which don't have one.
1005 * @p: Pointer to a dev_t.
1006 *
1007 * Filesystems which don't use real block devices can call this function
1008 * to allocate a virtual block device.
1009 *
1010 * Context: Any context. Frequently called while holding sb_lock.
1011 * Return: 0 on success, -EMFILE if there are no anonymous bdevs left
1012 * or -ENOMEM if memory allocation failed.
1013 */
0ee5dc67 1014int get_anon_bdev(dev_t *p)
1da177e4
LT
1015{
1016 int dev;
5a66847e
MW
1017
1018 /*
1019 * Many userspace utilities consider an FSID of 0 invalid.
1020 * Always return at least 1 from get_anon_bdev.
1021 */
1022 dev = ida_alloc_range(&unnamed_dev_ida, 1, (1 << MINORBITS) - 1,
1023 GFP_ATOMIC);
1024 if (dev == -ENOSPC)
1025 dev = -EMFILE;
1026 if (dev < 0)
1027 return dev;
1028
1029 *p = MKDEV(0, dev);
1da177e4
LT
1030 return 0;
1031}
0ee5dc67 1032EXPORT_SYMBOL(get_anon_bdev);
1da177e4 1033
0ee5dc67 1034void free_anon_bdev(dev_t dev)
1da177e4 1035{
5a66847e 1036 ida_free(&unnamed_dev_ida, MINOR(dev));
1da177e4 1037}
0ee5dc67
AV
1038EXPORT_SYMBOL(free_anon_bdev);
1039
1040int set_anon_super(struct super_block *s, void *data)
1041{
df0ce26c 1042 return get_anon_bdev(&s->s_dev);
0ee5dc67 1043}
0ee5dc67
AV
1044EXPORT_SYMBOL(set_anon_super);
1045
1046void kill_anon_super(struct super_block *sb)
1047{
1048 dev_t dev = sb->s_dev;
1049 generic_shutdown_super(sb);
1050 free_anon_bdev(dev);
1051}
1da177e4
LT
1052EXPORT_SYMBOL(kill_anon_super);
1053
1da177e4
LT
1054void kill_litter_super(struct super_block *sb)
1055{
1056 if (sb->s_root)
1057 d_genocide(sb->s_root);
1058 kill_anon_super(sb);
1059}
1da177e4
LT
1060EXPORT_SYMBOL(kill_litter_super);
1061
909e6d94
SH
1062static int ns_test_super(struct super_block *sb, void *data)
1063{
1064 return sb->s_fs_info == data;
1065}
1066
1067static int ns_set_super(struct super_block *sb, void *data)
1068{
1069 sb->s_fs_info = data;
1070 return set_anon_super(sb, NULL);
1071}
1072
d91ee87d
EB
1073struct dentry *mount_ns(struct file_system_type *fs_type,
1074 int flags, void *data, void *ns, struct user_namespace *user_ns,
1075 int (*fill_super)(struct super_block *, void *, int))
909e6d94
SH
1076{
1077 struct super_block *sb;
1078
d91ee87d
EB
1079 /* Don't allow mounting unless the caller has CAP_SYS_ADMIN
1080 * over the namespace.
1081 */
e462ec50 1082 if (!(flags & SB_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
d91ee87d
EB
1083 return ERR_PTR(-EPERM);
1084
6e4eab57
EB
1085 sb = sget_userns(fs_type, ns_test_super, ns_set_super, flags,
1086 user_ns, ns);
909e6d94 1087 if (IS_ERR(sb))
ceefda69 1088 return ERR_CAST(sb);
909e6d94
SH
1089
1090 if (!sb->s_root) {
1091 int err;
e462ec50 1092 err = fill_super(sb, data, flags & SB_SILENT ? 1 : 0);
909e6d94 1093 if (err) {
74dbbdd7 1094 deactivate_locked_super(sb);
ceefda69 1095 return ERR_PTR(err);
909e6d94
SH
1096 }
1097
e462ec50 1098 sb->s_flags |= SB_ACTIVE;
909e6d94
SH
1099 }
1100
ceefda69 1101 return dget(sb->s_root);
909e6d94
SH
1102}
1103
ceefda69 1104EXPORT_SYMBOL(mount_ns);
909e6d94 1105
9361401e 1106#ifdef CONFIG_BLOCK
1da177e4
LT
1107static int set_bdev_super(struct super_block *s, void *data)
1108{
1109 s->s_bdev = data;
1110 s->s_dev = s->s_bdev->bd_dev;
13eec236 1111 s->s_bdi = bdi_get(s->s_bdev->bd_bdi);
32a88aa1 1112
1da177e4
LT
1113 return 0;
1114}
1115
1116static int test_bdev_super(struct super_block *s, void *data)
1117{
1118 return (void *)s->s_bdev == data;
1119}
1120
152a0836 1121struct dentry *mount_bdev(struct file_system_type *fs_type,
1da177e4 1122 int flags, const char *dev_name, void *data,
152a0836 1123 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1124{
1125 struct block_device *bdev;
1126 struct super_block *s;
d4d77629 1127 fmode_t mode = FMODE_READ | FMODE_EXCL;
1da177e4
LT
1128 int error = 0;
1129
e462ec50 1130 if (!(flags & SB_RDONLY))
30c40d2c
AV
1131 mode |= FMODE_WRITE;
1132
d4d77629 1133 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
1da177e4 1134 if (IS_ERR(bdev))
152a0836 1135 return ERR_CAST(bdev);
1da177e4
LT
1136
1137 /*
1138 * once the super is inserted into the list by sget, s_umount
1139 * will protect the lockfs code from trying to start a snapshot
1140 * while we are mounting
1141 */
4fadd7bb
CH
1142 mutex_lock(&bdev->bd_fsfreeze_mutex);
1143 if (bdev->bd_fsfreeze_count > 0) {
1144 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1145 error = -EBUSY;
1146 goto error_bdev;
1147 }
e462ec50 1148 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | SB_NOSEC,
9249e17f 1149 bdev);
4fadd7bb 1150 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1da177e4 1151 if (IS_ERR(s))
454e2398 1152 goto error_s;
1da177e4
LT
1153
1154 if (s->s_root) {
e462ec50 1155 if ((flags ^ s->s_flags) & SB_RDONLY) {
74dbbdd7 1156 deactivate_locked_super(s);
454e2398
DH
1157 error = -EBUSY;
1158 goto error_bdev;
1da177e4 1159 }
454e2398 1160
4f331f01
TH
1161 /*
1162 * s_umount nests inside bd_mutex during
e525fd89
TH
1163 * __invalidate_device(). blkdev_put() acquires
1164 * bd_mutex and can't be called under s_umount. Drop
1165 * s_umount temporarily. This is safe as we're
1166 * holding an active reference.
4f331f01
TH
1167 */
1168 up_write(&s->s_umount);
d4d77629 1169 blkdev_put(bdev, mode);
4f331f01 1170 down_write(&s->s_umount);
1da177e4 1171 } else {
30c40d2c 1172 s->s_mode = mode;
a1c6f057 1173 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
e78c9a00 1174 sb_set_blocksize(s, block_size(bdev));
e462ec50 1175 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1176 if (error) {
74dbbdd7 1177 deactivate_locked_super(s);
454e2398 1178 goto error;
fa675765 1179 }
454e2398 1180
e462ec50 1181 s->s_flags |= SB_ACTIVE;
87d8fe1e 1182 bdev->bd_super = s;
1da177e4
LT
1183 }
1184
152a0836 1185 return dget(s->s_root);
1da177e4 1186
454e2398
DH
1187error_s:
1188 error = PTR_ERR(s);
1189error_bdev:
d4d77629 1190 blkdev_put(bdev, mode);
454e2398 1191error:
152a0836
AV
1192 return ERR_PTR(error);
1193}
1194EXPORT_SYMBOL(mount_bdev);
1195
1da177e4
LT
1196void kill_block_super(struct super_block *sb)
1197{
1198 struct block_device *bdev = sb->s_bdev;
30c40d2c 1199 fmode_t mode = sb->s_mode;
1da177e4 1200
ddbaaf30 1201 bdev->bd_super = NULL;
1da177e4
LT
1202 generic_shutdown_super(sb);
1203 sync_blockdev(bdev);
d4d77629 1204 WARN_ON_ONCE(!(mode & FMODE_EXCL));
e525fd89 1205 blkdev_put(bdev, mode | FMODE_EXCL);
1da177e4
LT
1206}
1207
1208EXPORT_SYMBOL(kill_block_super);
9361401e 1209#endif
1da177e4 1210
3c26ff6e 1211struct dentry *mount_nodev(struct file_system_type *fs_type,
1da177e4 1212 int flags, void *data,
3c26ff6e 1213 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1214{
1215 int error;
9249e17f 1216 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1da177e4
LT
1217
1218 if (IS_ERR(s))
3c26ff6e 1219 return ERR_CAST(s);
1da177e4 1220
e462ec50 1221 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1222 if (error) {
74dbbdd7 1223 deactivate_locked_super(s);
3c26ff6e 1224 return ERR_PTR(error);
1da177e4 1225 }
e462ec50 1226 s->s_flags |= SB_ACTIVE;
3c26ff6e 1227 return dget(s->s_root);
1da177e4 1228}
3c26ff6e
AV
1229EXPORT_SYMBOL(mount_nodev);
1230
8d0347f6
DH
1231static int reconfigure_single(struct super_block *s,
1232 int flags, void *data)
1233{
1234 struct fs_context *fc;
1235 int ret;
1236
1237 /* The caller really need to be passing fc down into mount_single(),
1238 * then a chunk of this can be removed. [Bollocks -- AV]
1239 * Better yet, reconfiguration shouldn't happen, but rather the second
1240 * mount should be rejected if the parameters are not compatible.
1241 */
1242 fc = fs_context_for_reconfigure(s->s_root, flags, MS_RMT_MASK);
1243 if (IS_ERR(fc))
1244 return PTR_ERR(fc);
1245
1246 ret = parse_monolithic_mount_data(fc, data);
1247 if (ret < 0)
1248 goto out;
1249
1250 ret = reconfigure_super(fc);
1251out:
1252 put_fs_context(fc);
1253 return ret;
1254}
1255
1da177e4
LT
1256static int compare_single(struct super_block *s, void *p)
1257{
1258 return 1;
1259}
1260
fc14f2fe 1261struct dentry *mount_single(struct file_system_type *fs_type,
1da177e4 1262 int flags, void *data,
fc14f2fe 1263 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1264{
1265 struct super_block *s;
1266 int error;
1267
9249e17f 1268 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1da177e4 1269 if (IS_ERR(s))
fc14f2fe 1270 return ERR_CAST(s);
1da177e4 1271 if (!s->s_root) {
e462ec50 1272 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
8d0347f6
DH
1273 if (!error)
1274 s->s_flags |= SB_ACTIVE;
9329d1be 1275 } else {
8d0347f6
DH
1276 error = reconfigure_single(s, flags, data);
1277 }
1278 if (unlikely(error)) {
1279 deactivate_locked_super(s);
1280 return ERR_PTR(error);
1da177e4 1281 }
fc14f2fe
AV
1282 return dget(s->s_root);
1283}
1284EXPORT_SYMBOL(mount_single);
1285
9bc61ab1
DH
1286/**
1287 * vfs_get_tree - Get the mountable root
1288 * @fc: The superblock configuration context.
1289 *
1290 * The filesystem is invoked to get or create a superblock which can then later
1291 * be used for mounting. The filesystem places a pointer to the root to be
1292 * used for mounting in @fc->root.
1293 */
1294int vfs_get_tree(struct fs_context *fc)
1da177e4 1295{
9d412a43 1296 struct super_block *sb;
9bc61ab1 1297 int error;
8089352a 1298
f3a09c92
AV
1299 if (fc->fs_type->fs_flags & FS_REQUIRES_DEV && !fc->source)
1300 return -ENOENT;
1301
1302 if (fc->root)
1303 return -EBUSY;
1304
1305 /* Get the mountable root in fc->root, with a ref on the root and a ref
1306 * on the superblock.
1307 */
1308 error = fc->ops->get_tree(fc);
9bc61ab1
DH
1309 if (error < 0)
1310 return error;
1da177e4 1311
f3a09c92
AV
1312 if (!fc->root) {
1313 pr_err("Filesystem %s get_tree() didn't set fc->root\n",
1314 fc->fs_type->name);
1315 /* We don't know what the locking state of the superblock is -
1316 * if there is a superblock.
1317 */
1318 BUG();
1319 }
1320
9bc61ab1 1321 sb = fc->root->d_sb;
9d412a43 1322 WARN_ON(!sb->s_bdi);
79f546a6 1323
a0c9a8b8
AV
1324 if (fc->subtype && !sb->s_subtype) {
1325 sb->s_subtype = fc->subtype;
1326 fc->subtype = NULL;
1327 }
1328
79f546a6
DC
1329 /*
1330 * Write barrier is for super_cache_count(). We place it before setting
1331 * SB_BORN as the data dependency between the two functions is the
1332 * superblock structure contents that we just set up, not the SB_BORN
1333 * flag.
1334 */
1335 smp_wmb();
e462ec50 1336 sb->s_flags |= SB_BORN;
454e2398 1337
9bc61ab1 1338 error = security_sb_set_mnt_opts(sb, fc->security, 0, NULL);
c9ce29ed
AV
1339 if (unlikely(error)) {
1340 fc_drop_locked(fc);
1341 return error;
a10d7c22
AV
1342 }
1343
42cb56ae
JL
1344 /*
1345 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1346 * but s_maxbytes was an unsigned long long for many releases. Throw
1347 * this warning for a little while to try and catch filesystems that
4358b567 1348 * violate this rule.
42cb56ae 1349 */
9d412a43 1350 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
9bc61ab1 1351 "negative value (%lld)\n", fc->fs_type->name, sb->s_maxbytes);
42cb56ae 1352
9bc61ab1 1353 return 0;
1da177e4 1354}
9bc61ab1 1355EXPORT_SYMBOL(vfs_get_tree);
1da177e4 1356
fca39346
JK
1357/*
1358 * Setup private BDI for given superblock. It gets automatically cleaned up
1359 * in generic_shutdown_super().
1360 */
1361int super_setup_bdi_name(struct super_block *sb, char *fmt, ...)
1362{
1363 struct backing_dev_info *bdi;
1364 int err;
1365 va_list args;
1366
1367 bdi = bdi_alloc(GFP_KERNEL);
1368 if (!bdi)
1369 return -ENOMEM;
1370
1371 bdi->name = sb->s_type->name;
1372
1373 va_start(args, fmt);
7c4cc300 1374 err = bdi_register_va(bdi, fmt, args);
fca39346
JK
1375 va_end(args);
1376 if (err) {
1377 bdi_put(bdi);
1378 return err;
1379 }
1380 WARN_ON(sb->s_bdi != &noop_backing_dev_info);
1381 sb->s_bdi = bdi;
fca39346
JK
1382
1383 return 0;
1384}
1385EXPORT_SYMBOL(super_setup_bdi_name);
1386
1387/*
1388 * Setup private BDI for given superblock. I gets automatically cleaned up
1389 * in generic_shutdown_super().
1390 */
1391int super_setup_bdi(struct super_block *sb)
1392{
1393 static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1394
1395 return super_setup_bdi_name(sb, "%.28s-%ld", sb->s_type->name,
1396 atomic_long_inc_return(&bdi_seq));
1397}
1398EXPORT_SYMBOL(super_setup_bdi);
1399
5accdf82
JK
1400/*
1401 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1402 * instead.
1403 */
1404void __sb_end_write(struct super_block *sb, int level)
1405{
8129ed29 1406 percpu_up_read(sb->s_writers.rw_sem + level-1);
5accdf82
JK
1407}
1408EXPORT_SYMBOL(__sb_end_write);
1409
f4b554af
ON
1410/*
1411 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1412 * instead.
1413 */
1414int __sb_start_write(struct super_block *sb, int level, bool wait)
1415{
1416 bool force_trylock = false;
8129ed29 1417 int ret = 1;
f4b554af
ON
1418
1419#ifdef CONFIG_LOCKDEP
1420 /*
1421 * We want lockdep to tell us about possible deadlocks with freezing
1422 * but it's it bit tricky to properly instrument it. Getting a freeze
1423 * protection works as getting a read lock but there are subtle
1424 * problems. XFS for example gets freeze protection on internal level
1425 * twice in some cases, which is OK only because we already hold a
1426 * freeze protection also on higher level. Due to these cases we have
1427 * to use wait == F (trylock mode) which must not fail.
1428 */
1429 if (wait) {
1430 int i;
1431
1432 for (i = 0; i < level - 1; i++)
8129ed29 1433 if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
f4b554af
ON
1434 force_trylock = true;
1435 break;
1436 }
1437 }
1438#endif
8129ed29
ON
1439 if (wait && !force_trylock)
1440 percpu_down_read(sb->s_writers.rw_sem + level-1);
1441 else
1442 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1443
22224a17 1444 WARN_ON(force_trylock && !ret);
f4b554af
ON
1445 return ret;
1446}
5accdf82
JK
1447EXPORT_SYMBOL(__sb_start_write);
1448
1449/**
1450 * sb_wait_write - wait until all writers to given file system finish
1451 * @sb: the super for which we wait
1452 * @level: type of writers we wait for (normal vs page fault)
1453 *
1454 * This function waits until there are no writers of given type to given file
8129ed29 1455 * system.
5accdf82
JK
1456 */
1457static void sb_wait_write(struct super_block *sb, int level)
1458{
8129ed29 1459 percpu_down_write(sb->s_writers.rw_sem + level-1);
8129ed29 1460}
5accdf82 1461
f1a96220
ON
1462/*
1463 * We are going to return to userspace and forget about these locks, the
1464 * ownership goes to the caller of thaw_super() which does unlock().
1465 */
1466static void lockdep_sb_freeze_release(struct super_block *sb)
1467{
1468 int level;
1469
1470 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1471 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1472}
1473
1474/*
1475 * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1476 */
1477static void lockdep_sb_freeze_acquire(struct super_block *sb)
8129ed29
ON
1478{
1479 int level;
5accdf82 1480
8129ed29
ON
1481 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1482 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
f1a96220
ON
1483}
1484
1485static void sb_freeze_unlock(struct super_block *sb)
1486{
1487 int level;
5accdf82 1488
8129ed29
ON
1489 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1490 percpu_up_write(sb->s_writers.rw_sem + level);
5accdf82
JK
1491}
1492
18e9e510 1493/**
7000d3c4
RD
1494 * freeze_super - lock the filesystem and force it into a consistent state
1495 * @sb: the super to lock
18e9e510
JB
1496 *
1497 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1498 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1499 * -EBUSY.
5accdf82
JK
1500 *
1501 * During this function, sb->s_writers.frozen goes through these values:
1502 *
1503 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1504 *
1505 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1506 * writes should be blocked, though page faults are still allowed. We wait for
1507 * all writes to complete and then proceed to the next stage.
1508 *
1509 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1510 * but internal fs threads can still modify the filesystem (although they
1511 * should not dirty new pages or inodes), writeback can run etc. After waiting
1512 * for all running page faults we sync the filesystem which will clean all
1513 * dirty pages and inodes (no new dirty pages or inodes can be created when
1514 * sync is running).
1515 *
1516 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1517 * modification are blocked (e.g. XFS preallocation truncation on inode
1518 * reclaim). This is usually implemented by blocking new transactions for
1519 * filesystems that have them and need this additional guard. After all
1520 * internal writers are finished we call ->freeze_fs() to finish filesystem
1521 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1522 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1523 *
1524 * sb->s_writers.frozen is protected by sb->s_umount.
18e9e510
JB
1525 */
1526int freeze_super(struct super_block *sb)
1527{
1528 int ret;
1529
1530 atomic_inc(&sb->s_active);
1531 down_write(&sb->s_umount);
5accdf82 1532 if (sb->s_writers.frozen != SB_UNFROZEN) {
18e9e510
JB
1533 deactivate_locked_super(sb);
1534 return -EBUSY;
1535 }
1536
e462ec50 1537 if (!(sb->s_flags & SB_BORN)) {
dabe0dc1
AV
1538 up_write(&sb->s_umount);
1539 return 0; /* sic - it's "nothing to do" */
1540 }
1541
bc98a42c 1542 if (sb_rdonly(sb)) {
5accdf82
JK
1543 /* Nothing to do really... */
1544 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
18e9e510
JB
1545 up_write(&sb->s_umount);
1546 return 0;
1547 }
1548
5accdf82 1549 sb->s_writers.frozen = SB_FREEZE_WRITE;
5accdf82
JK
1550 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1551 up_write(&sb->s_umount);
5accdf82 1552 sb_wait_write(sb, SB_FREEZE_WRITE);
8129ed29 1553 down_write(&sb->s_umount);
5accdf82
JK
1554
1555 /* Now we go and block page faults... */
5accdf82 1556 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
5accdf82
JK
1557 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1558
1559 /* All writers are done so after syncing there won't be dirty data */
18e9e510
JB
1560 sync_filesystem(sb);
1561
5accdf82
JK
1562 /* Now wait for internal filesystem counter */
1563 sb->s_writers.frozen = SB_FREEZE_FS;
5accdf82 1564 sb_wait_write(sb, SB_FREEZE_FS);
18e9e510 1565
18e9e510
JB
1566 if (sb->s_op->freeze_fs) {
1567 ret = sb->s_op->freeze_fs(sb);
1568 if (ret) {
1569 printk(KERN_ERR
1570 "VFS:Filesystem freeze failed\n");
5accdf82 1571 sb->s_writers.frozen = SB_UNFROZEN;
8129ed29 1572 sb_freeze_unlock(sb);
5accdf82 1573 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510
JB
1574 deactivate_locked_super(sb);
1575 return ret;
1576 }
1577 }
5accdf82 1578 /*
89f39af1
ON
1579 * For debugging purposes so that fs can warn if it sees write activity
1580 * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
5accdf82
JK
1581 */
1582 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
f1a96220 1583 lockdep_sb_freeze_release(sb);
18e9e510
JB
1584 up_write(&sb->s_umount);
1585 return 0;
1586}
1587EXPORT_SYMBOL(freeze_super);
1588
1589/**
1590 * thaw_super -- unlock filesystem
1591 * @sb: the super to thaw
1592 *
1593 * Unlocks the filesystem and marks it writeable again after freeze_super().
1594 */
08fdc8a0 1595static int thaw_super_locked(struct super_block *sb)
18e9e510
JB
1596{
1597 int error;
1598
89f39af1 1599 if (sb->s_writers.frozen != SB_FREEZE_COMPLETE) {
18e9e510
JB
1600 up_write(&sb->s_umount);
1601 return -EINVAL;
1602 }
1603
bc98a42c 1604 if (sb_rdonly(sb)) {
8129ed29 1605 sb->s_writers.frozen = SB_UNFROZEN;
18e9e510 1606 goto out;
8129ed29 1607 }
18e9e510 1608
f1a96220
ON
1609 lockdep_sb_freeze_acquire(sb);
1610
18e9e510
JB
1611 if (sb->s_op->unfreeze_fs) {
1612 error = sb->s_op->unfreeze_fs(sb);
1613 if (error) {
1614 printk(KERN_ERR
1615 "VFS:Filesystem thaw failed\n");
f1a96220 1616 lockdep_sb_freeze_release(sb);
18e9e510
JB
1617 up_write(&sb->s_umount);
1618 return error;
1619 }
1620 }
1621
5accdf82 1622 sb->s_writers.frozen = SB_UNFROZEN;
8129ed29
ON
1623 sb_freeze_unlock(sb);
1624out:
5accdf82 1625 wake_up(&sb->s_writers.wait_unfrozen);
18e9e510 1626 deactivate_locked_super(sb);
18e9e510
JB
1627 return 0;
1628}
08fdc8a0
MG
1629
1630int thaw_super(struct super_block *sb)
1631{
1632 down_write(&sb->s_umount);
1633 return thaw_super_locked(sb);
1634}
18e9e510 1635EXPORT_SYMBOL(thaw_super);