Merge tag 'iommu-fixes-v6.8-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git...
[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>
22d94f49 34#include <linux/fscrypt.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
880b9577 42static int thaw_super_locked(struct super_block *sb, enum freeze_holder who);
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
5e874914 53static inline void __super_lock(struct super_block *sb, bool excl)
0ed33598
CB
54{
55 if (excl)
56 down_write(&sb->s_umount);
57 else
58 down_read(&sb->s_umount);
59}
60
61static inline void super_unlock(struct super_block *sb, bool excl)
62{
63 if (excl)
64 up_write(&sb->s_umount);
65 else
66 up_read(&sb->s_umount);
67}
68
5e874914 69static inline void __super_lock_excl(struct super_block *sb)
0ed33598 70{
5e874914 71 __super_lock(sb, true);
0ed33598
CB
72}
73
74static inline void super_unlock_excl(struct super_block *sb)
75{
76 super_unlock(sb, true);
77}
78
79static inline void super_unlock_shared(struct super_block *sb)
80{
81 super_unlock(sb, false);
82}
83
b30850c5 84static bool super_flags(const struct super_block *sb, unsigned int flags)
5e874914 85{
5e874914
CB
86 /*
87 * Pairs with smp_store_release() in super_wake() and ensures
b30850c5 88 * that we see @flags after we're woken.
5e874914 89 */
b30850c5 90 return smp_load_acquire(&sb->s_flags) & flags;
5e874914
CB
91}
92
93/**
94 * super_lock - wait for superblock to become ready and lock it
95 * @sb: superblock to wait for
96 * @excl: whether exclusive access is required
97 *
98 * If the superblock has neither passed through vfs_get_tree() or
99 * generic_shutdown_super() yet wait for it to happen. Either superblock
100 * creation will succeed and SB_BORN is set by vfs_get_tree() or we're
101 * woken and we'll see SB_DYING.
102 *
103 * The caller must have acquired a temporary reference on @sb->s_count.
104 *
f0cd9880
CB
105 * Return: The function returns true if SB_BORN was set and with
106 * s_umount held. The function returns false if SB_DYING was
107 * set and without s_umount held.
5e874914
CB
108 */
109static __must_check bool super_lock(struct super_block *sb, bool excl)
110{
5e874914
CB
111 lockdep_assert_not_held(&sb->s_umount);
112
b30850c5
CB
113 /* wait until the superblock is ready or dying */
114 wait_var_event(&sb->s_flags, super_flags(sb, SB_BORN | SB_DYING));
115
116 /* Don't pointlessly acquire s_umount. */
117 if (super_flags(sb, SB_DYING))
118 return false;
119
5e874914
CB
120 __super_lock(sb, excl);
121
122 /*
123 * Has gone through generic_shutdown_super() in the meantime.
124 * @sb->s_root is NULL and @sb->s_active is 0. No one needs to
125 * grab a reference to this. Tell them so.
126 */
f0cd9880
CB
127 if (sb->s_flags & SB_DYING) {
128 super_unlock(sb, excl);
5e874914 129 return false;
f0cd9880 130 }
5e874914 131
b30850c5
CB
132 WARN_ON_ONCE(!(sb->s_flags & SB_BORN));
133 return true;
5e874914
CB
134}
135
f0cd9880 136/* wait and try to acquire read-side of @sb->s_umount */
5e874914
CB
137static inline bool super_lock_shared(struct super_block *sb)
138{
139 return super_lock(sb, false);
140}
141
f0cd9880 142/* wait and try to acquire write-side of @sb->s_umount */
5e874914
CB
143static inline bool super_lock_excl(struct super_block *sb)
144{
145 return super_lock(sb, true);
146}
147
148/* wake waiters */
2c18a63b 149#define SUPER_WAKE_FLAGS (SB_BORN | SB_DYING | SB_DEAD)
5e874914
CB
150static void super_wake(struct super_block *sb, unsigned int flag)
151{
152 WARN_ON_ONCE((flag & ~SUPER_WAKE_FLAGS));
153 WARN_ON_ONCE(hweight32(flag & SUPER_WAKE_FLAGS) > 1);
154
155 /*
156 * Pairs with smp_load_acquire() in super_lock() to make sure
157 * all initializations in the superblock are seen by the user
158 * seeing SB_BORN sent.
159 */
160 smp_store_release(&sb->s_flags, sb->s_flags | flag);
161 /*
162 * Pairs with the barrier in prepare_to_wait_event() to make sure
163 * ___wait_var_event() either sees SB_BORN set or
164 * waitqueue_active() check in wake_up_var() sees the waiter.
165 */
166 smp_mb();
167 wake_up_var(&sb->s_flags);
168}
169
b0d40c92
DC
170/*
171 * One thing we have to be careful of with a per-sb shrinker is that we don't
172 * drop the last active reference to the superblock from within the shrinker.
173 * If that happens we could trigger unregistering the shrinker from within the
8a0e8bb1 174 * shrinker path and that leads to deadlock on the shrinker_mutex. Hence we
b0d40c92
DC
175 * take a passive reference to the superblock to avoid this from occurring.
176 */
0a234c6d
DC
177static unsigned long super_cache_scan(struct shrinker *shrink,
178 struct shrink_control *sc)
b0d40c92
DC
179{
180 struct super_block *sb;
0a234c6d
DC
181 long fs_objects = 0;
182 long total_objects;
183 long freed = 0;
184 long dentries;
185 long inodes;
b0d40c92 186
1720f5dd 187 sb = shrink->private_data;
b0d40c92
DC
188
189 /*
190 * Deadlock avoidance. We may hold various FS locks, and we don't want
191 * to recurse into the FS that called us in clear_inode() and friends..
192 */
0a234c6d
DC
193 if (!(sc->gfp_mask & __GFP_FS))
194 return SHRINK_STOP;
b0d40c92 195
d8ce82ef 196 if (!super_trylock_shared(sb))
0a234c6d 197 return SHRINK_STOP;
b0d40c92 198
d0407903 199 if (sb->s_op->nr_cached_objects)
4101b624 200 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
0e1fdafd 201
503c358c
VD
202 inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
203 dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
f6041567 204 total_objects = dentries + inodes + fs_objects + 1;
475d0db7
TH
205 if (!total_objects)
206 total_objects = 1;
0e1fdafd 207
0a234c6d 208 /* proportion the scan between the caches */
f6041567 209 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
bc3b14cb 210 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
503c358c 211 fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
b0d40c92 212
0a234c6d
DC
213 /*
214 * prune the dcache first as the icache is pinned by it, then
215 * prune the icache, followed by the filesystem specific caches
49e7e7ff
VD
216 *
217 * Ensure that we always scan at least one object - memcg kmem
218 * accounting uses this to fully empty the caches.
0a234c6d 219 */
49e7e7ff 220 sc->nr_to_scan = dentries + 1;
503c358c 221 freed = prune_dcache_sb(sb, sc);
49e7e7ff 222 sc->nr_to_scan = inodes + 1;
503c358c 223 freed += prune_icache_sb(sb, sc);
0a234c6d
DC
224
225 if (fs_objects) {
49e7e7ff 226 sc->nr_to_scan = fs_objects + 1;
4101b624 227 freed += sb->s_op->free_cached_objects(sb, sc);
b0d40c92
DC
228 }
229
0ed33598 230 super_unlock_shared(sb);
0a234c6d
DC
231 return freed;
232}
233
234static unsigned long super_cache_count(struct shrinker *shrink,
235 struct shrink_control *sc)
236{
237 struct super_block *sb;
238 long total_objects = 0;
239
1720f5dd 240 sb = shrink->private_data;
0a234c6d 241
d23da150 242 /*
d8ce82ef
CB
243 * We don't call super_trylock_shared() here as it is a scalability
244 * bottleneck, so we're exposed to partial setup state. The shrinker
245 * rwsem does not protect filesystem operations backing
246 * list_lru_shrink_count() or s_op->nr_cached_objects(). Counts can
247 * change between super_cache_count and super_cache_scan, so we really
248 * don't need locks here.
79f546a6
DC
249 *
250 * However, if we are currently mounting the superblock, the underlying
251 * filesystem might be in a state of partial construction and hence it
d8ce82ef
CB
252 * is dangerous to access it. super_trylock_shared() uses a SB_BORN check
253 * to avoid this situation, so do the same here. The memory barrier is
79f546a6 254 * matched with the one in mount_fs() as we don't hold locks here.
d23da150 255 */
79f546a6
DC
256 if (!(sb->s_flags & SB_BORN))
257 return 0;
258 smp_rmb();
259
0a234c6d 260 if (sb->s_op && sb->s_op->nr_cached_objects)
4101b624 261 total_objects = sb->s_op->nr_cached_objects(sb, sc);
0a234c6d 262
503c358c
VD
263 total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
264 total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
0a234c6d 265
9b996468
KT
266 if (!total_objects)
267 return SHRINK_EMPTY;
268
55f841ce 269 total_objects = vfs_pressure_ratio(total_objects);
0e1fdafd 270 return total_objects;
b0d40c92
DC
271}
272
853b39a7
ON
273static void destroy_super_work(struct work_struct *work)
274{
275 struct super_block *s = container_of(work, struct super_block,
276 destroy_work);
277 int i;
278
279 for (i = 0; i < SB_FREEZE_LEVELS; i++)
8129ed29 280 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
853b39a7
ON
281 kfree(s);
282}
283
284static void destroy_super_rcu(struct rcu_head *head)
285{
286 struct super_block *s = container_of(head, struct super_block, rcu);
287 INIT_WORK(&s->destroy_work, destroy_super_work);
288 schedule_work(&s->destroy_work);
289}
290
0200894d
AV
291/* Free a superblock that has never been seen by anyone */
292static void destroy_unused_super(struct super_block *s)
5accdf82 293{
0200894d
AV
294 if (!s)
295 return;
0ed33598 296 super_unlock_excl(s);
7eb5e882
AV
297 list_lru_destroy(&s->s_dentry_lru);
298 list_lru_destroy(&s->s_inode_lru);
7eb5e882 299 security_sb_free(s);
6e4eab57 300 put_user_ns(s->s_user_ns);
7eb5e882 301 kfree(s->s_subtype);
1720f5dd 302 shrinker_free(s->s_shrink);
0200894d
AV
303 /* no delays needed */
304 destroy_super_work(&s->destroy_work);
5accdf82
JK
305}
306
1da177e4
LT
307/**
308 * alloc_super - create new superblock
fe2bbc48 309 * @type: filesystem type superblock should belong to
9249e17f 310 * @flags: the mount flags
6e4eab57 311 * @user_ns: User namespace for the super_block
1da177e4
LT
312 *
313 * Allocates and initializes a new &struct super_block. alloc_super()
314 * returns a pointer new superblock or %NULL if allocation had failed.
315 */
6e4eab57
EB
316static struct super_block *alloc_super(struct file_system_type *type, int flags,
317 struct user_namespace *user_ns)
1da177e4 318{
2b46a19d 319 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_KERNEL);
b87221de 320 static const struct super_operations default_op;
7eb5e882
AV
321 int i;
322
323 if (!s)
324 return NULL;
1da177e4 325
b5bd856a 326 INIT_LIST_HEAD(&s->s_mounts);
6e4eab57 327 s->s_user_ns = get_user_ns(user_ns);
ca0168e8
AV
328 init_rwsem(&s->s_umount);
329 lockdep_set_class(&s->s_umount, &type->s_umount_key);
330 /*
331 * sget() can have s_umount recursion.
332 *
333 * When it cannot find a suitable sb, it allocates a new
334 * one (this one), and tries again to find a suitable old
335 * one.
336 *
337 * In case that succeeds, it will acquire the s_umount
338 * lock of the old one. Since these are clearly distrinct
339 * locks, and this object isn't exposed yet, there's no
340 * risk of deadlocks.
341 *
342 * Annotate this by putting this lock in a different
343 * subclass.
344 */
345 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
b5bd856a 346
7eb5e882
AV
347 if (security_sb_alloc(s))
348 goto fail;
7b7a8665 349
7eb5e882 350 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
8129ed29
ON
351 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
352 sb_writers_name[i],
353 &type->s_writers_key[i]))
7eb5e882 354 goto fail;
1da177e4 355 }
df0ce26c 356 s->s_bdi = &noop_backing_dev_info;
7eb5e882 357 s->s_flags = flags;
cc50a07a 358 if (s->s_user_ns != &init_user_ns)
67690f93 359 s->s_iflags |= SB_I_NODEV;
7eb5e882 360 INIT_HLIST_NODE(&s->s_instances);
f1ee6162 361 INIT_HLIST_BL_HEAD(&s->s_roots);
e97fedb9 362 mutex_init(&s->s_sync_lock);
7eb5e882 363 INIT_LIST_HEAD(&s->s_inodes);
74278da9 364 spin_lock_init(&s->s_inode_list_lock);
6c60d2b5
DC
365 INIT_LIST_HEAD(&s->s_inodes_wb);
366 spin_lock_init(&s->s_inode_wblist_lock);
7eb5e882 367
7eb5e882
AV
368 s->s_count = 1;
369 atomic_set(&s->s_active, 1);
370 mutex_init(&s->s_vfs_rename_mutex);
371 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
bc8230ee 372 init_rwsem(&s->s_dquot.dqio_sem);
7eb5e882
AV
373 s->s_maxbytes = MAX_NON_LFS;
374 s->s_op = &default_op;
375 s->s_time_gran = 1000000000;
188d20bc
DD
376 s->s_time_min = TIME64_MIN;
377 s->s_time_max = TIME64_MAX;
7eb5e882 378
1720f5dd
QZ
379 s->s_shrink = shrinker_alloc(SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE,
380 "sb-%s", type->name);
381 if (!s->s_shrink)
8e04944f 382 goto fail;
1720f5dd
QZ
383
384 s->s_shrink->scan_objects = super_cache_scan;
385 s->s_shrink->count_objects = super_cache_count;
386 s->s_shrink->batch = 1024;
387 s->s_shrink->private_data = s;
388
389 if (list_lru_init_memcg(&s->s_dentry_lru, s->s_shrink))
2b3648a6 390 goto fail;
1720f5dd 391 if (list_lru_init_memcg(&s->s_inode_lru, s->s_shrink))
2b3648a6 392 goto fail;
1da177e4 393 return s;
5ca302c8 394
7eb5e882 395fail:
0200894d 396 destroy_unused_super(s);
7eb5e882 397 return NULL;
1da177e4
LT
398}
399
400/* Superblock refcounting */
401
402/*
35cf7ba0 403 * Drop a superblock's refcount. The caller must hold sb_lock.
1da177e4 404 */
c645b930 405static void __put_super(struct super_block *s)
1da177e4 406{
c645b930
AV
407 if (!--s->s_count) {
408 list_del_init(&s->s_list);
409 WARN_ON(s->s_dentry_lru.node);
410 WARN_ON(s->s_inode_lru.node);
411 WARN_ON(!list_empty(&s->s_mounts));
412 security_sb_free(s);
413 put_user_ns(s->s_user_ns);
414 kfree(s->s_subtype);
415 call_rcu(&s->rcu, destroy_super_rcu);
1da177e4 416 }
1da177e4
LT
417}
418
419/**
420 * put_super - drop a temporary reference to superblock
421 * @sb: superblock in question
422 *
423 * Drops a temporary reference, frees superblock if there's no
424 * references left.
425 */
60b49885 426void put_super(struct super_block *sb)
1da177e4
LT
427{
428 spin_lock(&sb_lock);
429 __put_super(sb);
430 spin_unlock(&sb_lock);
431}
432
dc3216b1
CB
433static void kill_super_notify(struct super_block *sb)
434{
435 lockdep_assert_not_held(&sb->s_umount);
436
437 /* already notified earlier */
438 if (sb->s_flags & SB_DEAD)
439 return;
440
441 /*
442 * Remove it from @fs_supers so it isn't found by new
443 * sget{_fc}() walkers anymore. Any concurrent mounter still
444 * managing to grab a temporary reference is guaranteed to
445 * already see SB_DYING and will wait until we notify them about
446 * SB_DEAD.
447 */
448 spin_lock(&sb_lock);
449 hlist_del_init(&sb->s_instances);
450 spin_unlock(&sb_lock);
451
452 /*
453 * Let concurrent mounts know that this thing is really dead.
454 * We don't need @sb->s_umount here as every concurrent caller
455 * will see SB_DYING and either discard the superblock or wait
456 * for SB_DEAD.
457 */
458 super_wake(sb, SB_DEAD);
459}
1da177e4
LT
460
461/**
1712ac8f 462 * deactivate_locked_super - drop an active reference to superblock
1da177e4
LT
463 * @s: superblock to deactivate
464 *
bd7ced98 465 * Drops an active reference to superblock, converting it into a temporary
1712ac8f 466 * one if there is no other active references left. In that case we
1da177e4
LT
467 * tell fs driver to shut it down and drop the temporary reference we
468 * had just acquired.
1712ac8f
AV
469 *
470 * Caller holds exclusive lock on superblock; that lock is released.
1da177e4 471 */
1712ac8f 472void deactivate_locked_super(struct super_block *s)
1da177e4
LT
473{
474 struct file_system_type *fs = s->s_type;
b20bd1a5 475 if (atomic_dec_and_test(&s->s_active)) {
1720f5dd 476 shrinker_free(s->s_shrink);
28f2cd4f 477 fs->kill_sb(s);
f5e1dd34 478
dc3216b1
CB
479 kill_super_notify(s);
480
c0a5b560
VD
481 /*
482 * Since list_lru_destroy() may sleep, we cannot call it from
483 * put_super(), where we hold the sb_lock. Therefore we destroy
484 * the lru lists right now.
485 */
486 list_lru_destroy(&s->s_dentry_lru);
487 list_lru_destroy(&s->s_inode_lru);
488
1da177e4
LT
489 put_filesystem(fs);
490 put_super(s);
1712ac8f 491 } else {
0ed33598 492 super_unlock_excl(s);
1da177e4
LT
493 }
494}
495
1712ac8f 496EXPORT_SYMBOL(deactivate_locked_super);
1da177e4 497
74dbbdd7 498/**
1712ac8f 499 * deactivate_super - drop an active reference to superblock
74dbbdd7
AV
500 * @s: superblock to deactivate
501 *
1712ac8f
AV
502 * Variant of deactivate_locked_super(), except that superblock is *not*
503 * locked by caller. If we are going to drop the final active reference,
504 * lock will be acquired prior to that.
74dbbdd7 505 */
1712ac8f 506void deactivate_super(struct super_block *s)
74dbbdd7 507{
cc23402c 508 if (!atomic_add_unless(&s->s_active, -1, 1)) {
5e874914 509 __super_lock_excl(s);
1712ac8f 510 deactivate_locked_super(s);
74dbbdd7
AV
511 }
512}
513
1712ac8f 514EXPORT_SYMBOL(deactivate_super);
74dbbdd7 515
1da177e4 516/**
97cbed04 517 * grab_super - acquire an active reference to a superblock
2c18a63b
CB
518 * @sb: superblock to acquire
519 *
520 * Acquire a temporary reference on a superblock and try to trade it for
521 * an active reference. This is used in sget{_fc}() to wait for a
522 * superblock to either become SB_BORN or for it to pass through
523 * sb->kill() and be marked as SB_DEAD.
524 *
525 * Return: This returns true if an active reference could be acquired,
526 * false if not.
527 */
97cbed04 528static bool grab_super(struct super_block *sb)
2c18a63b 529{
97cbed04 530 bool locked;
2c18a63b
CB
531
532 sb->s_count++;
97cbed04
CB
533 spin_unlock(&sb_lock);
534 locked = super_lock_excl(sb);
535 if (locked) {
536 if (atomic_inc_not_zero(&sb->s_active)) {
537 put_super(sb);
538 return true;
539 }
540 super_unlock_excl(sb);
2c18a63b 541 }
b30850c5 542 wait_var_event(&sb->s_flags, super_flags(sb, SB_DEAD));
345a5c4a 543 put_super(sb);
2c18a63b
CB
544 return false;
545}
546
12ad3ab6 547/*
d8ce82ef 548 * super_trylock_shared - try to grab ->s_umount shared
331cbdee 549 * @sb: reference we are trying to grab
12ad3ab6 550 *
eb6ef3df 551 * Try to prevent fs shutdown. This is used in places where we
12ad3ab6 552 * cannot take an active reference but we need to ensure that the
eb6ef3df
KK
553 * filesystem is not shut down while we are working on it. It returns
554 * false if we cannot acquire s_umount or if we lose the race and
555 * filesystem already got into shutdown, and returns true with the s_umount
556 * lock held in read mode in case of success. On successful return,
557 * the caller must drop the s_umount lock when done.
558 *
559 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
560 * The reason why it's safe is that we are OK with doing trylock instead
561 * of down_read(). There's a couple of places that are OK with that, but
562 * it's very much not a general-purpose interface.
12ad3ab6 563 */
d8ce82ef 564bool super_trylock_shared(struct super_block *sb)
12ad3ab6 565{
12ad3ab6 566 if (down_read_trylock(&sb->s_umount)) {
5e874914
CB
567 if (!(sb->s_flags & SB_DYING) && sb->s_root &&
568 (sb->s_flags & SB_BORN))
12ad3ab6 569 return true;
0ed33598 570 super_unlock_shared(sb);
12ad3ab6
DC
571 }
572
12ad3ab6
DC
573 return false;
574}
575
04b94071
DL
576/**
577 * retire_super - prevents superblock from being reused
578 * @sb: superblock to retire
579 *
580 * The function marks superblock to be ignored in superblock test, which
581 * prevents it from being reused for any new mounts. If the superblock has
582 * a private bdi, it also unregisters it, but doesn't reduce the refcount
583 * of the superblock to prevent potential races. The refcount is reduced
584 * by generic_shutdown_super(). The function can not be called
585 * concurrently with generic_shutdown_super(). It is safe to call the
586 * function multiple times, subsequent calls have no effect.
587 *
588 * The marker will affect the re-use only for block-device-based
589 * superblocks. Other superblocks will still get marked if this function
590 * is used, but that will not affect their reusability.
591 */
592void retire_super(struct super_block *sb)
593{
594 WARN_ON(!sb->s_bdev);
5e874914 595 __super_lock_excl(sb);
04b94071
DL
596 if (sb->s_iflags & SB_I_PERSB_BDI) {
597 bdi_unregister(sb->s_bdi);
598 sb->s_iflags &= ~SB_I_PERSB_BDI;
599 }
600 sb->s_iflags |= SB_I_RETIRED;
0ed33598 601 super_unlock_excl(sb);
04b94071
DL
602}
603EXPORT_SYMBOL(retire_super);
604
1da177e4
LT
605/**
606 * generic_shutdown_super - common helper for ->kill_sb()
607 * @sb: superblock to kill
608 *
609 * generic_shutdown_super() does all fs-independent work on superblock
610 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
611 * that need destruction out of superblock, call generic_shutdown_super()
612 * and release aforementioned objects. Note: dentries and inodes _are_
613 * taken care of and do not need specific handling.
c636ebdb
DH
614 *
615 * Upon calling this function, the filesystem may no longer alter or
616 * rearrange the set of dentries belonging to this super_block, nor may it
617 * change the attachments of dentries to inodes.
1da177e4
LT
618 */
619void generic_shutdown_super(struct super_block *sb)
620{
ee9b6d61 621 const struct super_operations *sop = sb->s_op;
1da177e4 622
c636ebdb
DH
623 if (sb->s_root) {
624 shrink_dcache_for_umount(sb);
60b0680f 625 sync_filesystem(sb);
e462ec50 626 sb->s_flags &= ~SB_ACTIVE;
efaee192 627
a1a0e23e 628 cgroup_writeback_umount();
63997e98 629
ccb820dc 630 /* Evict all inodes with zero refcount. */
63997e98 631 evict_inodes(sb);
ccb820dc
EB
632
633 /*
634 * Clean up and evict any inodes that still have references due
635 * to fsnotify or the security policy.
636 */
1edc8eb2 637 fsnotify_sb_delete(sb);
83e804f0 638 security_sb_delete(sb);
1da177e4 639
7b7a8665
CH
640 if (sb->s_dio_done_wq) {
641 destroy_workqueue(sb->s_dio_done_wq);
642 sb->s_dio_done_wq = NULL;
643 }
644
1da177e4
LT
645 if (sop->put_super)
646 sop->put_super(sb);
647
2a0e8571
JB
648 /*
649 * Now that all potentially-encrypted inodes have been evicted,
650 * the fscrypt keyring can be destroyed.
651 */
652 fscrypt_destroy_keyring(sb);
653
47d58691
JH
654 if (CHECK_DATA_CORRUPTION(!list_empty(&sb->s_inodes),
655 "VFS: Busy inodes after unmount of %s (%s)",
656 sb->s_id, sb->s_type->name)) {
657 /*
658 * Adding a proper bailout path here would be hard, but
659 * we can at least make it more likely that a later
660 * iput_final() or such crashes cleanly.
661 */
662 struct inode *inode;
663
664 spin_lock(&sb->s_inode_list_lock);
665 list_for_each_entry(inode, &sb->s_inodes, i_sb_list) {
666 inode->i_op = VFS_PTR_POISON;
667 inode->i_sb = VFS_PTR_POISON;
668 inode->i_mapping = VFS_PTR_POISON;
669 }
670 spin_unlock(&sb->s_inode_list_lock);
1da177e4 671 }
1da177e4 672 }
5e874914
CB
673 /*
674 * Broadcast to everyone that grabbed a temporary reference to this
675 * superblock before we removed it from @fs_supers that the superblock
676 * is dying. Every walker of @fs_supers outside of sget{_fc}() will now
677 * discard this superblock and treat it as dead.
2c18a63b
CB
678 *
679 * We leave the superblock on @fs_supers so it can be found by
680 * sget{_fc}() until we passed sb->kill_sb().
5e874914
CB
681 */
682 super_wake(sb, SB_DYING);
0ed33598 683 super_unlock_excl(sb);
c1844d53 684 if (sb->s_bdi != &noop_backing_dev_info) {
0b3ea092
CH
685 if (sb->s_iflags & SB_I_PERSB_BDI)
686 bdi_unregister(sb->s_bdi);
fca39346
JK
687 bdi_put(sb->s_bdi);
688 sb->s_bdi = &noop_backing_dev_info;
fca39346 689 }
1da177e4
LT
690}
691
692EXPORT_SYMBOL(generic_shutdown_super);
693
20284ab7 694bool mount_capable(struct fs_context *fc)
0ce0cf12 695{
20284ab7 696 if (!(fc->fs_type->fs_flags & FS_USERNS_MOUNT))
0ce0cf12
AV
697 return capable(CAP_SYS_ADMIN);
698 else
c2c44ec2 699 return ns_capable(fc->user_ns, CAP_SYS_ADMIN);
0ce0cf12
AV
700}
701
cb50b348
AV
702/**
703 * sget_fc - Find or create a superblock
704 * @fc: Filesystem context.
705 * @test: Comparison callback
706 * @set: Setup callback
707 *
22ed7ecd 708 * Create a new superblock or find an existing one.
cb50b348 709 *
22ed7ecd
CB
710 * The @test callback is used to find a matching existing superblock.
711 * Whether or not the requested parameters in @fc are taken into account
712 * is specific to the @test callback that is used. They may even be
713 * completely ignored.
714 *
715 * If an extant superblock is matched, it will be returned unless:
716 *
717 * (1) the namespace the filesystem context @fc and the extant
718 * superblock's namespace differ
719 *
720 * (2) the filesystem context @fc has requested that reusing an extant
721 * superblock is not allowed
722 *
723 * In both cases EBUSY will be returned.
cb50b348
AV
724 *
725 * If no match is made, a new superblock will be allocated and basic
22ed7ecd
CB
726 * initialisation will be performed (s_type, s_fs_info and s_id will be
727 * set and the @set callback will be invoked), the superblock will be
728 * published and it will be returned in a partially constructed state
729 * with SB_BORN and SB_ACTIVE as yet unset.
730 *
731 * Return: On success, an extant or newly created superblock is
732 * returned. On failure an error pointer is returned.
cb50b348
AV
733 */
734struct super_block *sget_fc(struct fs_context *fc,
735 int (*test)(struct super_block *, struct fs_context *),
736 int (*set)(struct super_block *, struct fs_context *))
737{
738 struct super_block *s = NULL;
739 struct super_block *old;
740 struct user_namespace *user_ns = fc->global ? &init_user_ns : fc->user_ns;
741 int err;
742
cb50b348
AV
743retry:
744 spin_lock(&sb_lock);
745 if (test) {
746 hlist_for_each_entry(old, &fc->fs_type->fs_supers, s_instances) {
747 if (test(old, fc))
748 goto share_extant_sb;
749 }
750 }
751 if (!s) {
752 spin_unlock(&sb_lock);
753 s = alloc_super(fc->fs_type, fc->sb_flags, user_ns);
754 if (!s)
755 return ERR_PTR(-ENOMEM);
756 goto retry;
757 }
758
759 s->s_fs_info = fc->s_fs_info;
760 err = set(s, fc);
761 if (err) {
762 s->s_fs_info = NULL;
763 spin_unlock(&sb_lock);
764 destroy_unused_super(s);
765 return ERR_PTR(err);
766 }
767 fc->s_fs_info = NULL;
768 s->s_type = fc->fs_type;
c80fa7c8 769 s->s_iflags |= fc->s_iflags;
c642256b 770 strscpy(s->s_id, s->s_type->name, sizeof(s->s_id));
5e874914
CB
771 /*
772 * Make the superblock visible on @super_blocks and @fs_supers.
773 * It's in a nascent state and users should wait on SB_BORN or
774 * SB_DYING to be set.
775 */
cb50b348
AV
776 list_add_tail(&s->s_list, &super_blocks);
777 hlist_add_head(&s->s_instances, &s->s_type->fs_supers);
778 spin_unlock(&sb_lock);
779 get_filesystem(s->s_type);
1720f5dd 780 shrinker_register(s->s_shrink);
cb50b348
AV
781 return s;
782
783share_extant_sb:
22ed7ecd 784 if (user_ns != old->s_user_ns || fc->exclusive) {
cb50b348
AV
785 spin_unlock(&sb_lock);
786 destroy_unused_super(s);
22ed7ecd
CB
787 if (fc->exclusive)
788 warnfc(fc, "reusing existing filesystem not allowed");
789 else
790 warnfc(fc, "reusing existing filesystem in another namespace not allowed");
cb50b348
AV
791 return ERR_PTR(-EBUSY);
792 }
97cbed04 793 if (!grab_super(old))
cb50b348
AV
794 goto retry;
795 destroy_unused_super(s);
796 return old;
797}
798EXPORT_SYMBOL(sget_fc);
799
1da177e4 800/**
023d066a
DH
801 * sget - find or create a superblock
802 * @type: filesystem type superblock should belong to
803 * @test: comparison callback
804 * @set: setup callback
805 * @flags: mount flags
806 * @data: argument to each of them
1da177e4 807 */
023d066a 808struct super_block *sget(struct file_system_type *type,
1da177e4
LT
809 int (*test)(struct super_block *,void *),
810 int (*set)(struct super_block *,void *),
023d066a 811 int flags,
1da177e4
LT
812 void *data)
813{
023d066a 814 struct user_namespace *user_ns = current_user_ns();
1da177e4 815 struct super_block *s = NULL;
d4730127 816 struct super_block *old;
1da177e4
LT
817 int err;
818
023d066a
DH
819 /* We don't yet pass the user namespace of the parent
820 * mount through to here so always use &init_user_ns
821 * until that changes.
822 */
823 if (flags & SB_SUBMOUNT)
824 user_ns = &init_user_ns;
825
1da177e4
LT
826retry:
827 spin_lock(&sb_lock);
d4730127 828 if (test) {
b67bfe0d 829 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
d4730127
MK
830 if (!test(old, data))
831 continue;
6e4eab57
EB
832 if (user_ns != old->s_user_ns) {
833 spin_unlock(&sb_lock);
0200894d 834 destroy_unused_super(s);
6e4eab57
EB
835 return ERR_PTR(-EBUSY);
836 }
97cbed04 837 if (!grab_super(old))
d4730127 838 goto retry;
0200894d 839 destroy_unused_super(s);
d4730127
MK
840 return old;
841 }
1da177e4
LT
842 }
843 if (!s) {
844 spin_unlock(&sb_lock);
e462ec50 845 s = alloc_super(type, (flags & ~SB_SUBMOUNT), user_ns);
1da177e4
LT
846 if (!s)
847 return ERR_PTR(-ENOMEM);
848 goto retry;
849 }
dd111b31 850
1da177e4
LT
851 err = set(s, data);
852 if (err) {
853 spin_unlock(&sb_lock);
0200894d 854 destroy_unused_super(s);
1da177e4
LT
855 return ERR_PTR(err);
856 }
857 s->s_type = type;
c642256b 858 strscpy(s->s_id, type->name, sizeof(s->s_id));
1da177e4 859 list_add_tail(&s->s_list, &super_blocks);
a5166169 860 hlist_add_head(&s->s_instances, &type->fs_supers);
1da177e4
LT
861 spin_unlock(&sb_lock);
862 get_filesystem(type);
1720f5dd 863 shrinker_register(s->s_shrink);
1da177e4
LT
864 return s;
865}
1da177e4
LT
866EXPORT_SYMBOL(sget);
867
868void drop_super(struct super_block *sb)
869{
0ed33598 870 super_unlock_shared(sb);
1da177e4
LT
871 put_super(sb);
872}
873
874EXPORT_SYMBOL(drop_super);
875
ba6379f7
JK
876void drop_super_exclusive(struct super_block *sb)
877{
0ed33598 878 super_unlock_excl(sb);
ba6379f7
JK
879 put_super(sb);
880}
881EXPORT_SYMBOL(drop_super_exclusive);
882
fa7c1d50
MG
883static void __iterate_supers(void (*f)(struct super_block *))
884{
885 struct super_block *sb, *p = NULL;
886
887 spin_lock(&sb_lock);
888 list_for_each_entry(sb, &super_blocks, s_list) {
b30850c5 889 if (super_flags(sb, SB_DYING))
fa7c1d50
MG
890 continue;
891 sb->s_count++;
892 spin_unlock(&sb_lock);
893
894 f(sb);
895
896 spin_lock(&sb_lock);
897 if (p)
898 __put_super(p);
899 p = sb;
900 }
901 if (p)
902 __put_super(p);
903 spin_unlock(&sb_lock);
904}
01a05b33
AV
905/**
906 * iterate_supers - call function for all active superblocks
907 * @f: function to call
908 * @arg: argument to pass to it
909 *
910 * Scans the superblock list and calls given function, passing it
911 * locked superblock and given argument.
912 */
913void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
914{
dca33252 915 struct super_block *sb, *p = NULL;
01a05b33
AV
916
917 spin_lock(&sb_lock);
dca33252 918 list_for_each_entry(sb, &super_blocks, s_list) {
f0cd9880 919 bool locked;
5e874914 920
01a05b33
AV
921 sb->s_count++;
922 spin_unlock(&sb_lock);
923
f0cd9880
CB
924 locked = super_lock_shared(sb);
925 if (locked) {
926 if (sb->s_root)
927 f(sb, arg);
928 super_unlock_shared(sb);
929 }
01a05b33
AV
930
931 spin_lock(&sb_lock);
dca33252
AV
932 if (p)
933 __put_super(p);
934 p = sb;
01a05b33 935 }
dca33252
AV
936 if (p)
937 __put_super(p);
01a05b33
AV
938 spin_unlock(&sb_lock);
939}
940
43e15cdb
AV
941/**
942 * iterate_supers_type - call function for superblocks of given type
943 * @type: fs type
944 * @f: function to call
945 * @arg: argument to pass to it
946 *
947 * Scans the superblock list and calls given function, passing it
948 * locked superblock and given argument.
949 */
950void iterate_supers_type(struct file_system_type *type,
951 void (*f)(struct super_block *, void *), void *arg)
952{
953 struct super_block *sb, *p = NULL;
954
955 spin_lock(&sb_lock);
b67bfe0d 956 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
f0cd9880 957 bool locked;
5e874914 958
43e15cdb
AV
959 sb->s_count++;
960 spin_unlock(&sb_lock);
961
f0cd9880
CB
962 locked = super_lock_shared(sb);
963 if (locked) {
964 if (sb->s_root)
965 f(sb, arg);
966 super_unlock_shared(sb);
967 }
43e15cdb
AV
968
969 spin_lock(&sb_lock);
970 if (p)
971 __put_super(p);
972 p = sb;
973 }
974 if (p)
975 __put_super(p);
976 spin_unlock(&sb_lock);
977}
978
979EXPORT_SYMBOL(iterate_supers_type);
980
4e7b5671 981struct super_block *user_get_super(dev_t dev, bool excl)
1da177e4 982{
618f0636 983 struct super_block *sb;
1da177e4 984
1da177e4 985 spin_lock(&sb_lock);
618f0636
KK
986 list_for_each_entry(sb, &super_blocks, s_list) {
987 if (sb->s_dev == dev) {
f0cd9880 988 bool locked;
5e874914 989
618f0636 990 sb->s_count++;
1da177e4 991 spin_unlock(&sb_lock);
df40c01a 992 /* still alive? */
f0cd9880
CB
993 locked = super_lock(sb, excl);
994 if (locked) {
995 if (sb->s_root)
996 return sb;
997 super_unlock(sb, excl);
998 }
df40c01a 999 /* nope, got unmounted */
618f0636 1000 spin_lock(&sb_lock);
df40c01a 1001 __put_super(sb);
5e874914 1002 break;
1da177e4
LT
1003 }
1004 }
1005 spin_unlock(&sb_lock);
1006 return NULL;
1007}
1008
1da177e4 1009/**
8d0347f6
DH
1010 * reconfigure_super - asks filesystem to change superblock parameters
1011 * @fc: The superblock and configuration
1da177e4 1012 *
8d0347f6 1013 * Alters the configuration parameters of a live superblock.
1da177e4 1014 */
8d0347f6 1015int reconfigure_super(struct fs_context *fc)
1da177e4 1016{
8d0347f6 1017 struct super_block *sb = fc->root->d_sb;
1da177e4 1018 int retval;
8d0347f6 1019 bool remount_ro = false;
c541dce8 1020 bool remount_rw = false;
8d0347f6 1021 bool force = fc->sb_flags & SB_FORCE;
4504230a 1022
8d0347f6
DH
1023 if (fc->sb_flags_mask & ~MS_RMT_MASK)
1024 return -EINVAL;
5accdf82 1025 if (sb->s_writers.frozen != SB_UNFROZEN)
4504230a
CH
1026 return -EBUSY;
1027
8d0347f6
DH
1028 retval = security_sb_remount(sb, fc->security);
1029 if (retval)
1030 return retval;
1031
1032 if (fc->sb_flags_mask & SB_RDONLY) {
9361401e 1033#ifdef CONFIG_BLOCK
6f0d9689
CH
1034 if (!(fc->sb_flags & SB_RDONLY) && sb->s_bdev &&
1035 bdev_read_only(sb->s_bdev))
8d0347f6 1036 return -EACCES;
9361401e 1037#endif
c541dce8 1038 remount_rw = !(fc->sb_flags & SB_RDONLY) && sb_rdonly(sb);
8d0347f6
DH
1039 remount_ro = (fc->sb_flags & SB_RDONLY) && !sb_rdonly(sb);
1040 }
d208bbdd 1041
0aec09d0 1042 if (remount_ro) {
fdab684d 1043 if (!hlist_empty(&sb->s_pins)) {
0ed33598 1044 super_unlock_excl(sb);
fdab684d 1045 group_pin_kill(&sb->s_pins);
5e874914 1046 __super_lock_excl(sb);
0aec09d0
AV
1047 if (!sb->s_root)
1048 return 0;
1049 if (sb->s_writers.frozen != SB_UNFROZEN)
1050 return -EBUSY;
8d0347f6 1051 remount_ro = !sb_rdonly(sb);
0aec09d0
AV
1052 }
1053 }
1054 shrink_dcache_sb(sb);
1055
8d0347f6
DH
1056 /* If we are reconfiguring to RDONLY and current sb is read/write,
1057 * make sure there are no files open for writing.
1058 */
d208bbdd 1059 if (remount_ro) {
4ed5e82f 1060 if (force) {
d7439fb1 1061 sb_start_ro_state_change(sb);
4ed5e82f
MS
1062 } else {
1063 retval = sb_prepare_remount_readonly(sb);
1064 if (retval)
1065 return retval;
4ed5e82f 1066 }
c541dce8
JK
1067 } else if (remount_rw) {
1068 /*
d7439fb1
JK
1069 * Protect filesystem's reconfigure code from writes from
1070 * userspace until reconfigure finishes.
c541dce8 1071 */
d7439fb1 1072 sb_start_ro_state_change(sb);
1da177e4
LT
1073 }
1074
f3a09c92
AV
1075 if (fc->ops->reconfigure) {
1076 retval = fc->ops->reconfigure(fc);
1077 if (retval) {
1078 if (!force)
1079 goto cancel_readonly;
1080 /* If forced remount, go ahead despite any errors */
1081 WARN(1, "forced remount of a %s fs returned %i\n",
1082 sb->s_type->name, retval);
1083 }
1da177e4 1084 }
8d0347f6
DH
1085
1086 WRITE_ONCE(sb->s_flags, ((sb->s_flags & ~fc->sb_flags_mask) |
1087 (fc->sb_flags & fc->sb_flags_mask)));
d7439fb1 1088 sb_end_ro_state_change(sb);
c79d967d 1089
d208bbdd
NP
1090 /*
1091 * Some filesystems modify their metadata via some other path than the
1092 * bdev buffer cache (eg. use a private mapping, or directories in
1093 * pagecache, etc). Also file data modifications go via their own
1094 * mappings. So If we try to mount readonly then copy the filesystem
1095 * from bdev, we could get stale data, so invalidate it to give a best
1096 * effort at coherency.
1097 */
1098 if (remount_ro && sb->s_bdev)
1099 invalidate_bdev(sb->s_bdev);
1da177e4 1100 return 0;
4ed5e82f
MS
1101
1102cancel_readonly:
d7439fb1 1103 sb_end_ro_state_change(sb);
4ed5e82f 1104 return retval;
1da177e4
LT
1105}
1106
fa7c1d50 1107static void do_emergency_remount_callback(struct super_block *sb)
1da177e4 1108{
f0cd9880 1109 bool locked = super_lock_excl(sb);
5e874914 1110
f0cd9880 1111 if (locked && sb->s_root && sb->s_bdev && !sb_rdonly(sb)) {
8d0347f6
DH
1112 struct fs_context *fc;
1113
1114 fc = fs_context_for_reconfigure(sb->s_root,
1115 SB_RDONLY | SB_FORCE, SB_RDONLY);
1116 if (!IS_ERR(fc)) {
1117 if (parse_monolithic_mount_data(fc, NULL) == 0)
1118 (void)reconfigure_super(fc);
1119 put_fs_context(fc);
1120 }
1da177e4 1121 }
f0cd9880
CB
1122 if (locked)
1123 super_unlock_excl(sb);
fa7c1d50
MG
1124}
1125
1126static void do_emergency_remount(struct work_struct *work)
1127{
1128 __iterate_supers(do_emergency_remount_callback);
a2a9537a 1129 kfree(work);
1da177e4
LT
1130 printk("Emergency Remount complete\n");
1131}
1132
1133void emergency_remount(void)
1134{
a2a9537a
JA
1135 struct work_struct *work;
1136
1137 work = kmalloc(sizeof(*work), GFP_ATOMIC);
1138 if (work) {
1139 INIT_WORK(work, do_emergency_remount);
1140 schedule_work(work);
1141 }
1da177e4
LT
1142}
1143
08fdc8a0
MG
1144static void do_thaw_all_callback(struct super_block *sb)
1145{
f0cd9880 1146 bool locked = super_lock_excl(sb);
5e874914 1147
f0cd9880 1148 if (locked && sb->s_root) {
4a8b719f 1149 if (IS_ENABLED(CONFIG_BLOCK))
982c3b30 1150 while (sb->s_bdev && !bdev_thaw(sb->s_bdev))
4a8b719f 1151 pr_warn("Emergency Thaw on %pg\n", sb->s_bdev);
880b9577 1152 thaw_super_locked(sb, FREEZE_HOLDER_USERSPACE);
f0cd9880 1153 return;
08fdc8a0 1154 }
f0cd9880
CB
1155 if (locked)
1156 super_unlock_excl(sb);
08fdc8a0
MG
1157}
1158
1159static void do_thaw_all(struct work_struct *work)
1160{
1161 __iterate_supers(do_thaw_all_callback);
1162 kfree(work);
1163 printk(KERN_WARNING "Emergency Thaw complete\n");
1164}
1165
1166/**
1167 * emergency_thaw_all -- forcibly thaw every frozen filesystem
1168 *
1169 * Used for emergency unfreeze of all filesystems via SysRq
1170 */
1171void emergency_thaw_all(void)
1172{
1173 struct work_struct *work;
1174
1175 work = kmalloc(sizeof(*work), GFP_ATOMIC);
1176 if (work) {
1177 INIT_WORK(work, do_thaw_all);
1178 schedule_work(work);
1179 }
1180}
1181
ad76cbc6 1182static DEFINE_IDA(unnamed_dev_ida);
1da177e4 1183
5a66847e
MW
1184/**
1185 * get_anon_bdev - Allocate a block device for filesystems which don't have one.
1186 * @p: Pointer to a dev_t.
1187 *
1188 * Filesystems which don't use real block devices can call this function
1189 * to allocate a virtual block device.
1190 *
1191 * Context: Any context. Frequently called while holding sb_lock.
1192 * Return: 0 on success, -EMFILE if there are no anonymous bdevs left
1193 * or -ENOMEM if memory allocation failed.
1194 */
0ee5dc67 1195int get_anon_bdev(dev_t *p)
1da177e4
LT
1196{
1197 int dev;
5a66847e
MW
1198
1199 /*
1200 * Many userspace utilities consider an FSID of 0 invalid.
1201 * Always return at least 1 from get_anon_bdev.
1202 */
1203 dev = ida_alloc_range(&unnamed_dev_ida, 1, (1 << MINORBITS) - 1,
1204 GFP_ATOMIC);
1205 if (dev == -ENOSPC)
1206 dev = -EMFILE;
1207 if (dev < 0)
1208 return dev;
1209
1210 *p = MKDEV(0, dev);
1da177e4
LT
1211 return 0;
1212}
0ee5dc67 1213EXPORT_SYMBOL(get_anon_bdev);
1da177e4 1214
0ee5dc67 1215void free_anon_bdev(dev_t dev)
1da177e4 1216{
5a66847e 1217 ida_free(&unnamed_dev_ida, MINOR(dev));
1da177e4 1218}
0ee5dc67
AV
1219EXPORT_SYMBOL(free_anon_bdev);
1220
1221int set_anon_super(struct super_block *s, void *data)
1222{
df0ce26c 1223 return get_anon_bdev(&s->s_dev);
0ee5dc67 1224}
0ee5dc67
AV
1225EXPORT_SYMBOL(set_anon_super);
1226
1227void kill_anon_super(struct super_block *sb)
1228{
1229 dev_t dev = sb->s_dev;
1230 generic_shutdown_super(sb);
dc3216b1 1231 kill_super_notify(sb);
0ee5dc67
AV
1232 free_anon_bdev(dev);
1233}
1da177e4
LT
1234EXPORT_SYMBOL(kill_anon_super);
1235
1da177e4
LT
1236void kill_litter_super(struct super_block *sb)
1237{
1238 if (sb->s_root)
1239 d_genocide(sb->s_root);
1240 kill_anon_super(sb);
1241}
1da177e4
LT
1242EXPORT_SYMBOL(kill_litter_super);
1243
cb50b348
AV
1244int set_anon_super_fc(struct super_block *sb, struct fs_context *fc)
1245{
1246 return set_anon_super(sb, NULL);
1247}
1248EXPORT_SYMBOL(set_anon_super_fc);
1249
1250static int test_keyed_super(struct super_block *sb, struct fs_context *fc)
1251{
1252 return sb->s_fs_info == fc->s_fs_info;
1253}
1254
1255static int test_single_super(struct super_block *s, struct fs_context *fc)
1256{
1257 return 1;
1258}
1259
e062abae 1260static int vfs_get_super(struct fs_context *fc,
cda2ed05
CH
1261 int (*test)(struct super_block *, struct fs_context *),
1262 int (*fill_super)(struct super_block *sb,
1263 struct fs_context *fc))
cb50b348 1264{
cb50b348 1265 struct super_block *sb;
43ce4c1f 1266 int err;
cb50b348 1267
cb50b348
AV
1268 sb = sget_fc(fc, test, set_anon_super_fc);
1269 if (IS_ERR(sb))
1270 return PTR_ERR(sb);
1271
1272 if (!sb->s_root) {
43ce4c1f
DH
1273 err = fill_super(sb, fc);
1274 if (err)
1275 goto error;
cb50b348
AV
1276
1277 sb->s_flags |= SB_ACTIVE;
1278 }
1279
e062abae 1280 fc->root = dget(sb->s_root);
cb50b348 1281 return 0;
43ce4c1f
DH
1282
1283error:
1284 deactivate_locked_super(sb);
1285 return err;
cb50b348 1286}
cb50b348 1287
2ac295d4
AV
1288int get_tree_nodev(struct fs_context *fc,
1289 int (*fill_super)(struct super_block *sb,
1290 struct fs_context *fc))
1291{
e062abae 1292 return vfs_get_super(fc, NULL, fill_super);
2ac295d4
AV
1293}
1294EXPORT_SYMBOL(get_tree_nodev);
1295
c23a0bba
AV
1296int get_tree_single(struct fs_context *fc,
1297 int (*fill_super)(struct super_block *sb,
1298 struct fs_context *fc))
1299{
e062abae 1300 return vfs_get_super(fc, test_single_super, fill_super);
c23a0bba
AV
1301}
1302EXPORT_SYMBOL(get_tree_single);
1303
533770cc
AV
1304int get_tree_keyed(struct fs_context *fc,
1305 int (*fill_super)(struct super_block *sb,
1306 struct fs_context *fc),
1307 void *key)
1308{
1309 fc->s_fs_info = key;
e062abae 1310 return vfs_get_super(fc, test_keyed_super, fill_super);
533770cc
AV
1311}
1312EXPORT_SYMBOL(get_tree_keyed);
1313
69881be3
CB
1314static int set_bdev_super(struct super_block *s, void *data)
1315{
1316 s->s_dev = *(dev_t *)data;
1317 return 0;
1318}
1319
1320static int super_s_dev_set(struct super_block *s, struct fs_context *fc)
1321{
1322 return set_bdev_super(s, fc->sget_key);
1323}
1324
1325static int super_s_dev_test(struct super_block *s, struct fs_context *fc)
1326{
1327 return !(s->s_iflags & SB_I_RETIRED) &&
1328 s->s_dev == *(dev_t *)fc->sget_key;
1329}
1330
1331/**
1332 * sget_dev - Find or create a superblock by device number
1333 * @fc: Filesystem context.
1334 * @dev: device number
1335 *
1336 * Find or create a superblock using the provided device number that
1337 * will be stored in fc->sget_key.
1338 *
1339 * If an extant superblock is matched, then that will be returned with
1340 * an elevated reference count that the caller must transfer or discard.
1341 *
1342 * If no match is made, a new superblock will be allocated and basic
1343 * initialisation will be performed (s_type, s_fs_info, s_id, s_dev will
1344 * be set). The superblock will be published and it will be returned in
1345 * a partially constructed state with SB_BORN and SB_ACTIVE as yet
1346 * unset.
1347 *
1348 * Return: an existing or newly created superblock on success, an error
1349 * pointer on failure.
1350 */
1351struct super_block *sget_dev(struct fs_context *fc, dev_t dev)
1352{
1353 fc->sget_key = &dev;
1354 return sget_fc(fc, super_s_dev_test, super_s_dev_set);
1355}
1356EXPORT_SYMBOL(sget_dev);
1357
9361401e 1358#ifdef CONFIG_BLOCK
9c09a7cf 1359/*
fd146410
JK
1360 * Lock the superblock that is holder of the bdev. Returns the superblock
1361 * pointer if we successfully locked the superblock and it is alive. Otherwise
1362 * we return NULL and just unlock bdev->bd_holder_lock.
9c09a7cf 1363 *
fd146410 1364 * The function must be called with bdev->bd_holder_lock and releases it.
9c09a7cf 1365 */
49ef8832 1366static struct super_block *bdev_super_lock(struct block_device *bdev, bool excl)
fd146410 1367 __releases(&bdev->bd_holder_lock)
87efb390 1368{
fd146410 1369 struct super_block *sb = bdev->bd_holder;
f0cd9880 1370 bool locked;
fd146410
JK
1371
1372 lockdep_assert_held(&bdev->bd_holder_lock);
1373 lockdep_assert_not_held(&sb->s_umount);
3b224e1d 1374 lockdep_assert_not_held(&bdev->bd_disk->open_mutex);
fd146410
JK
1375
1376 /* Make sure sb doesn't go away from under us */
1377 spin_lock(&sb_lock);
1378 sb->s_count++;
1379 spin_unlock(&sb_lock);
49ef8832 1380
fd146410 1381 mutex_unlock(&bdev->bd_holder_lock);
87efb390 1382
49ef8832
CB
1383 locked = super_lock(sb, excl);
1384
fd146410 1385 /*
49ef8832
CB
1386 * If the superblock wasn't already SB_DYING then we hold
1387 * s_umount and can safely drop our temporary reference.
1388 */
fd146410 1389 put_super(sb);
49ef8832
CB
1390
1391 if (!locked)
1392 return NULL;
1393
1394 if (!sb->s_root || !(sb->s_flags & SB_ACTIVE)) {
1395 super_unlock(sb, excl);
1396 return NULL;
1397 }
1398
fd146410 1399 return sb;
9c09a7cf
CH
1400}
1401
d8530de5 1402static void fs_bdev_mark_dead(struct block_device *bdev, bool surprise)
87efb390 1403{
fd146410 1404 struct super_block *sb;
9c09a7cf 1405
49ef8832 1406 sb = bdev_super_lock(bdev, false);
fd146410 1407 if (!sb)
87efb390
CH
1408 return;
1409
d8530de5
CH
1410 if (!surprise)
1411 sync_filesystem(sb);
1412 shrink_dcache_sb(sb);
e127b9bc 1413 invalidate_inodes(sb);
87efb390
CH
1414 if (sb->s_op->shutdown)
1415 sb->s_op->shutdown(sb);
9c09a7cf 1416
0ed33598 1417 super_unlock_shared(sb);
87efb390
CH
1418}
1419
2142b88c
CH
1420static void fs_bdev_sync(struct block_device *bdev)
1421{
fd146410 1422 struct super_block *sb;
2142b88c 1423
49ef8832 1424 sb = bdev_super_lock(bdev, false);
fd146410 1425 if (!sb)
2142b88c 1426 return;
49ef8832 1427
2142b88c 1428 sync_filesystem(sb);
0ed33598 1429 super_unlock_shared(sb);
2142b88c
CH
1430}
1431
49ef8832
CB
1432static struct super_block *get_bdev_super(struct block_device *bdev)
1433{
1434 bool active = false;
1435 struct super_block *sb;
1436
1437 sb = bdev_super_lock(bdev, true);
1438 if (sb) {
1439 active = atomic_inc_not_zero(&sb->s_active);
1440 super_unlock_excl(sb);
1441 }
1442 if (!active)
1443 return NULL;
1444 return sb;
1445}
1446
7366f8b6
CB
1447/**
1448 * fs_bdev_freeze - freeze owning filesystem of block device
1449 * @bdev: block device
1450 *
1451 * Freeze the filesystem that owns this block device if it is still
1452 * active.
1453 *
1454 * A filesystem that owns multiple block devices may be frozen from each
1455 * block device and won't be unfrozen until all block devices are
1456 * unfrozen. Each block device can only freeze the filesystem once as we
1457 * nest freezes for block devices in the block layer.
1458 *
1459 * Return: If the freeze was successful zero is returned. If the freeze
1460 * failed a negative error code is returned.
1461 */
49ef8832
CB
1462static int fs_bdev_freeze(struct block_device *bdev)
1463{
1464 struct super_block *sb;
1465 int error = 0;
1466
1467 lockdep_assert_held(&bdev->bd_fsfreeze_mutex);
1468
1469 sb = get_bdev_super(bdev);
1470 if (!sb)
1471 return -EINVAL;
1472
1473 if (sb->s_op->freeze_super)
7366f8b6
CB
1474 error = sb->s_op->freeze_super(sb,
1475 FREEZE_MAY_NEST | FREEZE_HOLDER_USERSPACE);
49ef8832 1476 else
7366f8b6
CB
1477 error = freeze_super(sb,
1478 FREEZE_MAY_NEST | FREEZE_HOLDER_USERSPACE);
49ef8832
CB
1479 if (!error)
1480 error = sync_blockdev(bdev);
1481 deactivate_super(sb);
1482 return error;
1483}
1484
7366f8b6
CB
1485/**
1486 * fs_bdev_thaw - thaw owning filesystem of block device
1487 * @bdev: block device
1488 *
1489 * Thaw the filesystem that owns this block device.
1490 *
1491 * A filesystem that owns multiple block devices may be frozen from each
1492 * block device and won't be unfrozen until all block devices are
1493 * unfrozen. Each block device can only freeze the filesystem once as we
1494 * nest freezes for block devices in the block layer.
1495 *
1496 * Return: If the thaw was successful zero is returned. If the thaw
1497 * failed a negative error code is returned. If this function
1498 * returns zero it doesn't mean that the filesystem is unfrozen
1499 * as it may have been frozen multiple times (kernel may hold a
1500 * freeze or might be frozen from other block devices).
1501 */
49ef8832
CB
1502static int fs_bdev_thaw(struct block_device *bdev)
1503{
1504 struct super_block *sb;
1505 int error;
1506
1507 lockdep_assert_held(&bdev->bd_fsfreeze_mutex);
1508
1509 sb = get_bdev_super(bdev);
1510 if (WARN_ON_ONCE(!sb))
1511 return -EINVAL;
1512
1513 if (sb->s_op->thaw_super)
7366f8b6
CB
1514 error = sb->s_op->thaw_super(sb,
1515 FREEZE_MAY_NEST | FREEZE_HOLDER_USERSPACE);
49ef8832 1516 else
7366f8b6
CB
1517 error = thaw_super(sb,
1518 FREEZE_MAY_NEST | FREEZE_HOLDER_USERSPACE);
49ef8832
CB
1519 deactivate_super(sb);
1520 return error;
1521}
1522
7ecd0b6f 1523const struct blk_holder_ops fs_holder_ops = {
d8530de5 1524 .mark_dead = fs_bdev_mark_dead,
2142b88c 1525 .sync = fs_bdev_sync,
49ef8832
CB
1526 .freeze = fs_bdev_freeze,
1527 .thaw = fs_bdev_thaw,
87efb390 1528};
7ecd0b6f 1529EXPORT_SYMBOL_GPL(fs_holder_ops);
fe62c3a4 1530
cf6da236 1531int setup_bdev_super(struct super_block *sb, int sb_flags,
aca740ce
JK
1532 struct fs_context *fc)
1533{
1534 blk_mode_t mode = sb_open_mode(sb_flags);
f4a48bc3 1535 struct bdev_handle *bdev_handle;
aca740ce
JK
1536 struct block_device *bdev;
1537
f4a48bc3
JK
1538 bdev_handle = bdev_open_by_dev(sb->s_dev, mode, sb, &fs_holder_ops);
1539 if (IS_ERR(bdev_handle)) {
aca740ce
JK
1540 if (fc)
1541 errorf(fc, "%s: Can't open blockdev", fc->source);
f4a48bc3 1542 return PTR_ERR(bdev_handle);
aca740ce 1543 }
f4a48bc3 1544 bdev = bdev_handle->bdev;
aca740ce
JK
1545
1546 /*
1547 * This really should be in blkdev_get_by_dev, but right now can't due
1548 * to legacy issues that require us to allow opening a block device node
1549 * writable from userspace even for a read-only block device.
1550 */
1551 if ((mode & BLK_OPEN_WRITE) && bdev_read_only(bdev)) {
f4a48bc3 1552 bdev_release(bdev_handle);
aca740ce
JK
1553 return -EACCES;
1554 }
1555
1556 /*
49ef8832
CB
1557 * It is enough to check bdev was not frozen before we set
1558 * s_bdev as freezing will wait until SB_BORN is set.
aca740ce 1559 */
49ef8832 1560 if (atomic_read(&bdev->bd_fsfreeze_count) > 0) {
aca740ce
JK
1561 if (fc)
1562 warnf(fc, "%pg: Can't mount, blockdev is frozen", bdev);
f4a48bc3 1563 bdev_release(bdev_handle);
aca740ce
JK
1564 return -EBUSY;
1565 }
1566 spin_lock(&sb_lock);
f4a48bc3 1567 sb->s_bdev_handle = bdev_handle;
aca740ce
JK
1568 sb->s_bdev = bdev;
1569 sb->s_bdi = bdi_get(bdev->bd_disk->bdi);
1570 if (bdev_stable_writes(bdev))
1571 sb->s_iflags |= SB_I_STABLE_WRITES;
1572 spin_unlock(&sb_lock);
aca740ce
JK
1573
1574 snprintf(sb->s_id, sizeof(sb->s_id), "%pg", bdev);
1720f5dd 1575 shrinker_debugfs_rename(sb->s_shrink, "sb-%s:%s", sb->s_type->name,
aca740ce
JK
1576 sb->s_id);
1577 sb_set_blocksize(sb, block_size(bdev));
1578 return 0;
fe62c3a4 1579}
cf6da236 1580EXPORT_SYMBOL_GPL(setup_bdev_super);
fe62c3a4
DH
1581
1582/**
1583 * get_tree_bdev - Get a superblock based on a single block device
1584 * @fc: The filesystem context holding the parameters
1585 * @fill_super: Helper to initialise a new superblock
1586 */
1587int get_tree_bdev(struct fs_context *fc,
1588 int (*fill_super)(struct super_block *,
1589 struct fs_context *))
1590{
fe62c3a4 1591 struct super_block *s;
fe62c3a4 1592 int error = 0;
aca740ce 1593 dev_t dev;
fe62c3a4 1594
fe62c3a4
DH
1595 if (!fc->source)
1596 return invalf(fc, "No source specified");
1597
aca740ce
JK
1598 error = lookup_bdev(fc->source, &dev);
1599 if (error) {
1600 errorf(fc, "%s: Can't lookup blockdev", fc->source);
1601 return error;
fe62c3a4
DH
1602 }
1603
1604 fc->sb_flags |= SB_NOSEC;
69881be3 1605 s = sget_dev(fc, dev);
aca740ce 1606 if (IS_ERR(s))
fe62c3a4
DH
1607 return PTR_ERR(s);
1608
1609 if (s->s_root) {
1610 /* Don't summarily change the RO/RW state. */
1611 if ((fc->sb_flags ^ s->s_flags) & SB_RDONLY) {
aca740ce 1612 warnf(fc, "%pg: Can't mount, would change RO state", s->s_bdev);
fe62c3a4 1613 deactivate_locked_super(s);
fe62c3a4
DH
1614 return -EBUSY;
1615 }
aca740ce 1616 } else {
aca740ce 1617 error = setup_bdev_super(s, fc->sb_flags, fc);
aca740ce
JK
1618 if (!error)
1619 error = fill_super(s, fc);
fe62c3a4
DH
1620 if (error) {
1621 deactivate_locked_super(s);
1622 return error;
1623 }
fe62c3a4 1624 s->s_flags |= SB_ACTIVE;
fe62c3a4
DH
1625 }
1626
1627 BUG_ON(fc->root);
1628 fc->root = dget(s->s_root);
1629 return 0;
1630}
1631EXPORT_SYMBOL(get_tree_bdev);
1632
1da177e4
LT
1633static int test_bdev_super(struct super_block *s, void *data)
1634{
aca740ce 1635 return !(s->s_iflags & SB_I_RETIRED) && s->s_dev == *(dev_t *)data;
1da177e4
LT
1636}
1637
152a0836 1638struct dentry *mount_bdev(struct file_system_type *fs_type,
1da177e4 1639 int flags, const char *dev_name, void *data,
152a0836 1640 int (*fill_super)(struct super_block *, void *, int))
1da177e4 1641{
1da177e4 1642 struct super_block *s;
aca740ce
JK
1643 int error;
1644 dev_t dev;
1da177e4 1645
aca740ce
JK
1646 error = lookup_bdev(dev_name, &dev);
1647 if (error)
1648 return ERR_PTR(error);
1da177e4 1649
aca740ce
JK
1650 flags |= SB_NOSEC;
1651 s = sget(fs_type, test_bdev_super, set_bdev_super, flags, &dev);
1da177e4 1652 if (IS_ERR(s))
aca740ce 1653 return ERR_CAST(s);
1da177e4
LT
1654
1655 if (s->s_root) {
e462ec50 1656 if ((flags ^ s->s_flags) & SB_RDONLY) {
74dbbdd7 1657 deactivate_locked_super(s);
aca740ce 1658 return ERR_PTR(-EBUSY);
1da177e4 1659 }
aca740ce 1660 } else {
aca740ce 1661 error = setup_bdev_super(s, flags, NULL);
aca740ce
JK
1662 if (!error)
1663 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1664 if (error) {
74dbbdd7 1665 deactivate_locked_super(s);
aca740ce 1666 return ERR_PTR(error);
fa675765 1667 }
454e2398 1668
e462ec50 1669 s->s_flags |= SB_ACTIVE;
1da177e4
LT
1670 }
1671
152a0836 1672 return dget(s->s_root);
152a0836
AV
1673}
1674EXPORT_SYMBOL(mount_bdev);
1675
1da177e4
LT
1676void kill_block_super(struct super_block *sb)
1677{
1678 struct block_device *bdev = sb->s_bdev;
1679
1da177e4 1680 generic_shutdown_super(sb);
aca740ce
JK
1681 if (bdev) {
1682 sync_blockdev(bdev);
f4a48bc3 1683 bdev_release(sb->s_bdev_handle);
aca740ce 1684 }
1da177e4
LT
1685}
1686
1687EXPORT_SYMBOL(kill_block_super);
9361401e 1688#endif
1da177e4 1689
3c26ff6e 1690struct dentry *mount_nodev(struct file_system_type *fs_type,
1da177e4 1691 int flags, void *data,
3c26ff6e 1692 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1693{
1694 int error;
9249e17f 1695 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1da177e4
LT
1696
1697 if (IS_ERR(s))
3c26ff6e 1698 return ERR_CAST(s);
1da177e4 1699
e462ec50 1700 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1da177e4 1701 if (error) {
74dbbdd7 1702 deactivate_locked_super(s);
3c26ff6e 1703 return ERR_PTR(error);
1da177e4 1704 }
e462ec50 1705 s->s_flags |= SB_ACTIVE;
3c26ff6e 1706 return dget(s->s_root);
1da177e4 1707}
3c26ff6e
AV
1708EXPORT_SYMBOL(mount_nodev);
1709
a6097180
N
1710int reconfigure_single(struct super_block *s,
1711 int flags, void *data)
8d0347f6
DH
1712{
1713 struct fs_context *fc;
1714 int ret;
1715
1716 /* The caller really need to be passing fc down into mount_single(),
1717 * then a chunk of this can be removed. [Bollocks -- AV]
1718 * Better yet, reconfiguration shouldn't happen, but rather the second
1719 * mount should be rejected if the parameters are not compatible.
1720 */
1721 fc = fs_context_for_reconfigure(s->s_root, flags, MS_RMT_MASK);
1722 if (IS_ERR(fc))
1723 return PTR_ERR(fc);
1724
1725 ret = parse_monolithic_mount_data(fc, data);
1726 if (ret < 0)
1727 goto out;
1728
1729 ret = reconfigure_super(fc);
1730out:
1731 put_fs_context(fc);
1732 return ret;
1733}
1734
1da177e4
LT
1735static int compare_single(struct super_block *s, void *p)
1736{
1737 return 1;
1738}
1739
fc14f2fe 1740struct dentry *mount_single(struct file_system_type *fs_type,
1da177e4 1741 int flags, void *data,
fc14f2fe 1742 int (*fill_super)(struct super_block *, void *, int))
1da177e4
LT
1743{
1744 struct super_block *s;
1745 int error;
1746
9249e17f 1747 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1da177e4 1748 if (IS_ERR(s))
fc14f2fe 1749 return ERR_CAST(s);
1da177e4 1750 if (!s->s_root) {
e462ec50 1751 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
8d0347f6
DH
1752 if (!error)
1753 s->s_flags |= SB_ACTIVE;
9329d1be 1754 } else {
8d0347f6
DH
1755 error = reconfigure_single(s, flags, data);
1756 }
1757 if (unlikely(error)) {
1758 deactivate_locked_super(s);
1759 return ERR_PTR(error);
1da177e4 1760 }
fc14f2fe
AV
1761 return dget(s->s_root);
1762}
1763EXPORT_SYMBOL(mount_single);
1764
9bc61ab1
DH
1765/**
1766 * vfs_get_tree - Get the mountable root
1767 * @fc: The superblock configuration context.
1768 *
1769 * The filesystem is invoked to get or create a superblock which can then later
1770 * be used for mounting. The filesystem places a pointer to the root to be
1771 * used for mounting in @fc->root.
1772 */
1773int vfs_get_tree(struct fs_context *fc)
1da177e4 1774{
9d412a43 1775 struct super_block *sb;
9bc61ab1 1776 int error;
8089352a 1777
f3a09c92
AV
1778 if (fc->root)
1779 return -EBUSY;
1780
1781 /* Get the mountable root in fc->root, with a ref on the root and a ref
1782 * on the superblock.
1783 */
1784 error = fc->ops->get_tree(fc);
9bc61ab1
DH
1785 if (error < 0)
1786 return error;
1da177e4 1787
f3a09c92
AV
1788 if (!fc->root) {
1789 pr_err("Filesystem %s get_tree() didn't set fc->root\n",
1790 fc->fs_type->name);
1791 /* We don't know what the locking state of the superblock is -
1792 * if there is a superblock.
1793 */
1794 BUG();
1795 }
1796
9bc61ab1 1797 sb = fc->root->d_sb;
9d412a43 1798 WARN_ON(!sb->s_bdi);
79f546a6
DC
1799
1800 /*
5e874914
CB
1801 * super_wake() contains a memory barrier which also care of
1802 * ordering for super_cache_count(). We place it before setting
1803 * SB_BORN as the data dependency between the two functions is
1804 * the superblock structure contents that we just set up, not
1805 * the SB_BORN flag.
79f546a6 1806 */
5e874914 1807 super_wake(sb, SB_BORN);
454e2398 1808
9bc61ab1 1809 error = security_sb_set_mnt_opts(sb, fc->security, 0, NULL);
c9ce29ed
AV
1810 if (unlikely(error)) {
1811 fc_drop_locked(fc);
1812 return error;
a10d7c22
AV
1813 }
1814
42cb56ae
JL
1815 /*
1816 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1817 * but s_maxbytes was an unsigned long long for many releases. Throw
1818 * this warning for a little while to try and catch filesystems that
4358b567 1819 * violate this rule.
42cb56ae 1820 */
9d412a43 1821 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
9bc61ab1 1822 "negative value (%lld)\n", fc->fs_type->name, sb->s_maxbytes);
42cb56ae 1823
9bc61ab1 1824 return 0;
1da177e4 1825}
9bc61ab1 1826EXPORT_SYMBOL(vfs_get_tree);
1da177e4 1827
fca39346
JK
1828/*
1829 * Setup private BDI for given superblock. It gets automatically cleaned up
1830 * in generic_shutdown_super().
1831 */
1832int super_setup_bdi_name(struct super_block *sb, char *fmt, ...)
1833{
1834 struct backing_dev_info *bdi;
1835 int err;
1836 va_list args;
1837
aef33c2f 1838 bdi = bdi_alloc(NUMA_NO_NODE);
fca39346
JK
1839 if (!bdi)
1840 return -ENOMEM;
1841
fca39346 1842 va_start(args, fmt);
7c4cc300 1843 err = bdi_register_va(bdi, fmt, args);
fca39346
JK
1844 va_end(args);
1845 if (err) {
1846 bdi_put(bdi);
1847 return err;
1848 }
1849 WARN_ON(sb->s_bdi != &noop_backing_dev_info);
1850 sb->s_bdi = bdi;
0b3ea092 1851 sb->s_iflags |= SB_I_PERSB_BDI;
fca39346
JK
1852
1853 return 0;
1854}
1855EXPORT_SYMBOL(super_setup_bdi_name);
1856
1857/*
1858 * Setup private BDI for given superblock. I gets automatically cleaned up
1859 * in generic_shutdown_super().
1860 */
1861int super_setup_bdi(struct super_block *sb)
1862{
1863 static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1864
1865 return super_setup_bdi_name(sb, "%.28s-%ld", sb->s_type->name,
1866 atomic_long_inc_return(&bdi_seq));
1867}
1868EXPORT_SYMBOL(super_setup_bdi);
1869
5accdf82
JK
1870/**
1871 * sb_wait_write - wait until all writers to given file system finish
1872 * @sb: the super for which we wait
1873 * @level: type of writers we wait for (normal vs page fault)
1874 *
1875 * This function waits until there are no writers of given type to given file
8129ed29 1876 * system.
5accdf82
JK
1877 */
1878static void sb_wait_write(struct super_block *sb, int level)
1879{
8129ed29 1880 percpu_down_write(sb->s_writers.rw_sem + level-1);
8129ed29 1881}
5accdf82 1882
f1a96220
ON
1883/*
1884 * We are going to return to userspace and forget about these locks, the
1885 * ownership goes to the caller of thaw_super() which does unlock().
1886 */
1887static void lockdep_sb_freeze_release(struct super_block *sb)
1888{
1889 int level;
1890
1891 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1892 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1893}
1894
1895/*
1896 * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1897 */
1898static void lockdep_sb_freeze_acquire(struct super_block *sb)
8129ed29
ON
1899{
1900 int level;
5accdf82 1901
8129ed29
ON
1902 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1903 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
f1a96220
ON
1904}
1905
2719c716 1906static void sb_freeze_unlock(struct super_block *sb, int level)
f1a96220 1907{
2719c716 1908 for (level--; level >= 0; level--)
8129ed29 1909 percpu_up_write(sb->s_writers.rw_sem + level);
5accdf82
JK
1910}
1911
59ba4fdd
DW
1912static int wait_for_partially_frozen(struct super_block *sb)
1913{
1914 int ret = 0;
1915
1916 do {
1917 unsigned short old = sb->s_writers.frozen;
1918
1919 up_write(&sb->s_umount);
1920 ret = wait_var_event_killable(&sb->s_writers.frozen,
1921 sb->s_writers.frozen != old);
1922 down_write(&sb->s_umount);
1923 } while (ret == 0 &&
1924 sb->s_writers.frozen != SB_UNFROZEN &&
1925 sb->s_writers.frozen != SB_FREEZE_COMPLETE);
1926
1927 return ret;
1928}
1929
7366f8b6
CB
1930#define FREEZE_HOLDERS (FREEZE_HOLDER_KERNEL | FREEZE_HOLDER_USERSPACE)
1931#define FREEZE_FLAGS (FREEZE_HOLDERS | FREEZE_MAY_NEST)
1932
1933static inline int freeze_inc(struct super_block *sb, enum freeze_holder who)
1934{
1935 WARN_ON_ONCE((who & ~FREEZE_FLAGS));
1936 WARN_ON_ONCE(hweight32(who & FREEZE_HOLDERS) > 1);
1937
1938 if (who & FREEZE_HOLDER_KERNEL)
1939 ++sb->s_writers.freeze_kcount;
1940 if (who & FREEZE_HOLDER_USERSPACE)
1941 ++sb->s_writers.freeze_ucount;
1942 return sb->s_writers.freeze_kcount + sb->s_writers.freeze_ucount;
1943}
1944
1945static inline int freeze_dec(struct super_block *sb, enum freeze_holder who)
1946{
1947 WARN_ON_ONCE((who & ~FREEZE_FLAGS));
1948 WARN_ON_ONCE(hweight32(who & FREEZE_HOLDERS) > 1);
1949
1950 if ((who & FREEZE_HOLDER_KERNEL) && sb->s_writers.freeze_kcount)
1951 --sb->s_writers.freeze_kcount;
1952 if ((who & FREEZE_HOLDER_USERSPACE) && sb->s_writers.freeze_ucount)
1953 --sb->s_writers.freeze_ucount;
1954 return sb->s_writers.freeze_kcount + sb->s_writers.freeze_ucount;
1955}
1956
1957static inline bool may_freeze(struct super_block *sb, enum freeze_holder who)
1958{
1959 WARN_ON_ONCE((who & ~FREEZE_FLAGS));
1960 WARN_ON_ONCE(hweight32(who & FREEZE_HOLDERS) > 1);
1961
1962 if (who & FREEZE_HOLDER_KERNEL)
1963 return (who & FREEZE_MAY_NEST) ||
1964 sb->s_writers.freeze_kcount == 0;
1965 if (who & FREEZE_HOLDER_USERSPACE)
1966 return (who & FREEZE_MAY_NEST) ||
1967 sb->s_writers.freeze_ucount == 0;
1968 return false;
1969}
1970
18e9e510 1971/**
7000d3c4
RD
1972 * freeze_super - lock the filesystem and force it into a consistent state
1973 * @sb: the super to lock
880b9577 1974 * @who: context that wants to freeze
18e9e510
JB
1975 *
1976 * Syncs the super to make sure the filesystem is consistent and calls the fs's
880b9577 1977 * freeze_fs. Subsequent calls to this without first thawing the fs may return
18e9e510 1978 * -EBUSY.
5accdf82 1979 *
880b9577
DW
1980 * @who should be:
1981 * * %FREEZE_HOLDER_USERSPACE if userspace wants to freeze the fs;
1982 * * %FREEZE_HOLDER_KERNEL if the kernel wants to freeze the fs.
7366f8b6 1983 * * %FREEZE_MAY_NEST whether nesting freeze and thaw requests is allowed.
880b9577
DW
1984 *
1985 * The @who argument distinguishes between the kernel and userspace trying to
1986 * freeze the filesystem. Although there cannot be multiple kernel freezes or
1987 * multiple userspace freezes in effect at any given time, the kernel and
1988 * userspace can both hold a filesystem frozen. The filesystem remains frozen
1989 * until there are no kernel or userspace freezes in effect.
1990 *
7366f8b6
CB
1991 * A filesystem may hold multiple devices and thus a filesystems may be
1992 * frozen through the block layer via multiple block devices. In this
1993 * case the request is marked as being allowed to nest by passing
1994 * FREEZE_MAY_NEST. The filesystem remains frozen until all block
1995 * devices are unfrozen. If multiple freezes are attempted without
1996 * FREEZE_MAY_NEST -EBUSY will be returned.
1997 *
5accdf82
JK
1998 * During this function, sb->s_writers.frozen goes through these values:
1999 *
2000 * SB_UNFROZEN: File system is normal, all writes progress as usual.
2001 *
2002 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
2003 * writes should be blocked, though page faults are still allowed. We wait for
2004 * all writes to complete and then proceed to the next stage.
2005 *
2006 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
2007 * but internal fs threads can still modify the filesystem (although they
2008 * should not dirty new pages or inodes), writeback can run etc. After waiting
2009 * for all running page faults we sync the filesystem which will clean all
2010 * dirty pages and inodes (no new dirty pages or inodes can be created when
2011 * sync is running).
2012 *
2013 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
2014 * modification are blocked (e.g. XFS preallocation truncation on inode
2015 * reclaim). This is usually implemented by blocking new transactions for
2016 * filesystems that have them and need this additional guard. After all
2017 * internal writers are finished we call ->freeze_fs() to finish filesystem
2018 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
2019 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
2020 *
2021 * sb->s_writers.frozen is protected by sb->s_umount.
7366f8b6
CB
2022 *
2023 * Return: If the freeze was successful zero is returned. If the freeze
2024 * failed a negative error code is returned.
18e9e510 2025 */
880b9577 2026int freeze_super(struct super_block *sb, enum freeze_holder who)
18e9e510
JB
2027{
2028 int ret;
2029
f0cd9880
CB
2030 if (!super_lock_excl(sb)) {
2031 WARN_ON_ONCE("Dying superblock while freezing!");
2032 return -EINVAL;
2033 }
18e9e510 2034 atomic_inc(&sb->s_active);
051178c3 2035
59ba4fdd 2036retry:
880b9577 2037 if (sb->s_writers.frozen == SB_FREEZE_COMPLETE) {
7366f8b6
CB
2038 if (may_freeze(sb, who))
2039 ret = !!WARN_ON_ONCE(freeze_inc(sb, who) == 1);
2040 else
2041 ret = -EBUSY;
2042 /* All freezers share a single active reference. */
2043 deactivate_locked_super(sb);
2044 return ret;
880b9577
DW
2045 }
2046
5accdf82 2047 if (sb->s_writers.frozen != SB_UNFROZEN) {
59ba4fdd
DW
2048 ret = wait_for_partially_frozen(sb);
2049 if (ret) {
2050 deactivate_locked_super(sb);
2051 return ret;
2052 }
2053
2054 goto retry;
18e9e510
JB
2055 }
2056
bc98a42c 2057 if (sb_rdonly(sb)) {
5accdf82 2058 /* Nothing to do really... */
7366f8b6 2059 WARN_ON_ONCE(freeze_inc(sb, who) > 1);
5accdf82 2060 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
59ba4fdd 2061 wake_up_var(&sb->s_writers.frozen);
0ed33598 2062 super_unlock_excl(sb);
18e9e510
JB
2063 return 0;
2064 }
2065
5accdf82 2066 sb->s_writers.frozen = SB_FREEZE_WRITE;
5accdf82 2067 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
0ed33598 2068 super_unlock_excl(sb);
5accdf82 2069 sb_wait_write(sb, SB_FREEZE_WRITE);
63513f85 2070 __super_lock_excl(sb);
5accdf82
JK
2071
2072 /* Now we go and block page faults... */
5accdf82 2073 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
5accdf82
JK
2074 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
2075
2076 /* All writers are done so after syncing there won't be dirty data */
2719c716
DW
2077 ret = sync_filesystem(sb);
2078 if (ret) {
2079 sb->s_writers.frozen = SB_UNFROZEN;
2080 sb_freeze_unlock(sb, SB_FREEZE_PAGEFAULT);
59ba4fdd 2081 wake_up_var(&sb->s_writers.frozen);
2719c716
DW
2082 deactivate_locked_super(sb);
2083 return ret;
2084 }
18e9e510 2085
5accdf82
JK
2086 /* Now wait for internal filesystem counter */
2087 sb->s_writers.frozen = SB_FREEZE_FS;
5accdf82 2088 sb_wait_write(sb, SB_FREEZE_FS);
18e9e510 2089
18e9e510
JB
2090 if (sb->s_op->freeze_fs) {
2091 ret = sb->s_op->freeze_fs(sb);
2092 if (ret) {
2093 printk(KERN_ERR
2094 "VFS:Filesystem freeze failed\n");
5accdf82 2095 sb->s_writers.frozen = SB_UNFROZEN;
2719c716 2096 sb_freeze_unlock(sb, SB_FREEZE_FS);
59ba4fdd 2097 wake_up_var(&sb->s_writers.frozen);
18e9e510
JB
2098 deactivate_locked_super(sb);
2099 return ret;
2100 }
2101 }
5accdf82 2102 /*
89f39af1
ON
2103 * For debugging purposes so that fs can warn if it sees write activity
2104 * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
5accdf82 2105 */
7366f8b6 2106 WARN_ON_ONCE(freeze_inc(sb, who) > 1);
5accdf82 2107 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
59ba4fdd 2108 wake_up_var(&sb->s_writers.frozen);
f1a96220 2109 lockdep_sb_freeze_release(sb);
0ed33598 2110 super_unlock_excl(sb);
18e9e510
JB
2111 return 0;
2112}
2113EXPORT_SYMBOL(freeze_super);
2114
880b9577
DW
2115/*
2116 * Undoes the effect of a freeze_super_locked call. If the filesystem is
2117 * frozen both by userspace and the kernel, a thaw call from either source
2118 * removes that state without releasing the other state or unlocking the
2119 * filesystem.
2120 */
2121static int thaw_super_locked(struct super_block *sb, enum freeze_holder who)
18e9e510 2122{
24c372d5 2123 int error = -EINVAL;
18e9e510 2124
24c372d5
CH
2125 if (sb->s_writers.frozen != SB_FREEZE_COMPLETE)
2126 goto out_unlock;
880b9577 2127
24c372d5 2128 /*
7366f8b6
CB
2129 * All freezers share a single active reference.
2130 * So just unlock in case there are any left.
24c372d5 2131 */
7366f8b6
CB
2132 if (freeze_dec(sb, who))
2133 goto out_unlock;
18e9e510 2134
bc98a42c 2135 if (sb_rdonly(sb)) {
8129ed29 2136 sb->s_writers.frozen = SB_UNFROZEN;
59ba4fdd 2137 wake_up_var(&sb->s_writers.frozen);
24c372d5 2138 goto out_deactivate;
8129ed29 2139 }
18e9e510 2140
f1a96220
ON
2141 lockdep_sb_freeze_acquire(sb);
2142
18e9e510
JB
2143 if (sb->s_op->unfreeze_fs) {
2144 error = sb->s_op->unfreeze_fs(sb);
2145 if (error) {
7366f8b6
CB
2146 pr_err("VFS: Filesystem thaw failed\n");
2147 freeze_inc(sb, who);
f1a96220 2148 lockdep_sb_freeze_release(sb);
24c372d5 2149 goto out_unlock;
18e9e510
JB
2150 }
2151 }
2152
5accdf82 2153 sb->s_writers.frozen = SB_UNFROZEN;
59ba4fdd 2154 wake_up_var(&sb->s_writers.frozen);
2719c716 2155 sb_freeze_unlock(sb, SB_FREEZE_FS);
24c372d5 2156out_deactivate:
18e9e510 2157 deactivate_locked_super(sb);
18e9e510 2158 return 0;
24c372d5
CH
2159
2160out_unlock:
2161 super_unlock_excl(sb);
2162 return error;
18e9e510 2163}
08fdc8a0 2164
961f3c89
MCC
2165/**
2166 * thaw_super -- unlock filesystem
2167 * @sb: the super to thaw
880b9577
DW
2168 * @who: context that wants to freeze
2169 *
2170 * Unlocks the filesystem and marks it writeable again after freeze_super()
2171 * if there are no remaining freezes on the filesystem.
961f3c89 2172 *
880b9577
DW
2173 * @who should be:
2174 * * %FREEZE_HOLDER_USERSPACE if userspace wants to thaw the fs;
2175 * * %FREEZE_HOLDER_KERNEL if the kernel wants to thaw the fs.
7366f8b6
CB
2176 * * %FREEZE_MAY_NEST whether nesting freeze and thaw requests is allowed
2177 *
2178 * A filesystem may hold multiple devices and thus a filesystems may
2179 * have been frozen through the block layer via multiple block devices.
2180 * The filesystem remains frozen until all block devices are unfrozen.
961f3c89 2181 */
880b9577 2182int thaw_super(struct super_block *sb, enum freeze_holder who)
08fdc8a0 2183{
f0cd9880
CB
2184 if (!super_lock_excl(sb)) {
2185 WARN_ON_ONCE("Dying superblock while thawing!");
2186 return -EINVAL;
2187 }
880b9577 2188 return thaw_super_locked(sb, who);
08fdc8a0 2189}
18e9e510 2190EXPORT_SYMBOL(thaw_super);
439bc39b
CH
2191
2192/*
2193 * Create workqueue for deferred direct IO completions. We allocate the
2194 * workqueue when it's first needed. This avoids creating workqueue for
2195 * filesystems that don't need it and also allows us to create the workqueue
2196 * late enough so the we can include s_id in the name of the workqueue.
2197 */
2198int sb_init_dio_done_wq(struct super_block *sb)
2199{
2200 struct workqueue_struct *old;
2201 struct workqueue_struct *wq = alloc_workqueue("dio/%s",
2202 WQ_MEM_RECLAIM, 0,
2203 sb->s_id);
2204 if (!wq)
2205 return -ENOMEM;
2206 /*
2207 * This has to be atomic as more DIOs can race to create the workqueue
2208 */
2209 old = cmpxchg(&sb->s_dio_done_wq, NULL, wq);
2210 /* Someone created workqueue before us? Free ours... */
2211 if (old)
2212 destroy_workqueue(wq);
2213 return 0;
2214}
389a4a4a 2215EXPORT_SYMBOL_GPL(sb_init_dio_done_wq);