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