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