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