blob: fd427ec0b372df1231b2a4b017d2ffe59a7284ea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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:
Jan Engelhardt96de0e22007-10-19 23:21:04 +020018 * Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 * 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
Paul Gortmaker630d9c42011-11-16 23:57:37 -050023#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/mount.h>
27#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/writeback.h> /* for the emergency remount stuff */
29#include <linux/idr.h>
Ingo Molnar353ab6e2006-03-26 01:37:12 -080030#include <linux/mutex.h>
Jens Axboe5477d0f2010-04-29 20:33:35 +020031#include <linux/backing-dev.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110032#include <linux/rculist_bl.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060033#include <linux/cleancache.h>
Al Viro40401532012-02-13 03:58:52 +000034#include <linux/fsnotify.h>
Jan Kara5accdf82012-06-12 16:20:34 +020035#include <linux/lockdep.h>
Al Viro6d59e7f2008-03-22 15:48:17 -040036#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38
Al Viro15d0f5e2015-02-02 10:07:59 -070039static LIST_HEAD(super_blocks);
40static DEFINE_SPINLOCK(sb_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Jan Kara5accdf82012-06-12 16:20:34 +020042static char *sb_writers_name[SB_FREEZE_LEVELS] = {
43 "sb_writers",
44 "sb_pagefaults",
45 "sb_internal",
46};
47
Dave Chinnerb0d40c92011-07-08 14:14:42 +100048/*
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 */
Dave Chinner0a234c62013-08-28 10:17:57 +100055static unsigned long super_cache_scan(struct shrinker *shrink,
56 struct shrink_control *sc)
Dave Chinnerb0d40c92011-07-08 14:14:42 +100057{
58 struct super_block *sb;
Dave Chinner0a234c62013-08-28 10:17:57 +100059 long fs_objects = 0;
60 long total_objects;
61 long freed = 0;
62 long dentries;
63 long inodes;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100064
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 */
Dave Chinner0a234c62013-08-28 10:17:57 +100071 if (!(sc->gfp_mask & __GFP_FS))
72 return SHRINK_STOP;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100073
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +030074 if (!trylock_super(sb))
Dave Chinner0a234c62013-08-28 10:17:57 +100075 return SHRINK_STOP;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100076
Al Virod0407902013-07-19 21:12:31 +040077 if (sb->s_op->nr_cached_objects)
Vladimir Davydov4101b622015-02-12 14:58:51 -080078 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
Dave Chinner0e1fdaf2011-07-08 14:14:44 +100079
Vladimir Davydov503c3582015-02-12 14:58:47 -080080 inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
81 dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
Dave Chinnerf6041562013-08-28 10:18:00 +100082 total_objects = dentries + inodes + fs_objects + 1;
Tetsuo Handa475d0db2014-05-17 20:56:38 +090083 if (!total_objects)
84 total_objects = 1;
Dave Chinner0e1fdaf2011-07-08 14:14:44 +100085
Dave Chinner0a234c62013-08-28 10:17:57 +100086 /* proportion the scan between the caches */
Dave Chinnerf6041562013-08-28 10:18:00 +100087 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100088 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
Vladimir Davydov503c3582015-02-12 14:58:47 -080089 fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
Dave Chinnerb0d40c92011-07-08 14:14:42 +100090
Dave Chinner0a234c62013-08-28 10:17:57 +100091 /*
92 * prune the dcache first as the icache is pinned by it, then
93 * prune the icache, followed by the filesystem specific caches
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -080094 *
95 * Ensure that we always scan at least one object - memcg kmem
96 * accounting uses this to fully empty the caches.
Dave Chinner0a234c62013-08-28 10:17:57 +100097 */
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -080098 sc->nr_to_scan = dentries + 1;
Vladimir Davydov503c3582015-02-12 14:58:47 -080099 freed = prune_dcache_sb(sb, sc);
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800100 sc->nr_to_scan = inodes + 1;
Vladimir Davydov503c3582015-02-12 14:58:47 -0800101 freed += prune_icache_sb(sb, sc);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000102
Dave Chinner0a234c62013-08-28 10:17:57 +1000103 if (fs_objects) {
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800104 sc->nr_to_scan = fs_objects + 1;
Vladimir Davydov4101b622015-02-12 14:58:51 -0800105 freed += sb->s_op->free_cached_objects(sb, sc);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000106 }
107
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300108 up_read(&sb->s_umount);
Dave Chinner0a234c62013-08-28 10:17:57 +1000109 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
Tim Chend23da152014-06-04 16:10:47 -0700120 /*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300121 * Don't call trylock_super as it is a potential
Tim Chend23da152014-06-04 16:10:47 -0700122 * 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
Vladimir Davydov503c3582015-02-12 14:58:47 -0800125 * ensures the safety of call to list_lru_shrink_count() and
Tim Chend23da152014-06-04 16:10:47 -0700126 * s_op->nr_cached_objects().
127 */
Dave Chinner0a234c62013-08-28 10:17:57 +1000128 if (sb->s_op && sb->s_op->nr_cached_objects)
Vladimir Davydov4101b622015-02-12 14:58:51 -0800129 total_objects = sb->s_op->nr_cached_objects(sb, sc);
Dave Chinner0a234c62013-08-28 10:17:57 +1000130
Vladimir Davydov503c3582015-02-12 14:58:47 -0800131 total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
132 total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
Dave Chinner0a234c62013-08-28 10:17:57 +1000133
Glauber Costa55f841c2013-08-28 10:17:53 +1000134 total_objects = vfs_pressure_ratio(total_objects);
Dave Chinner0e1fdaf2011-07-08 14:14:44 +1000135 return total_objects;
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000136}
137
Al Viro7eb5e882013-10-01 15:09:58 -0400138/**
139 * destroy_super - frees a superblock
140 * @s: superblock to free
141 *
142 * Frees a superblock.
143 */
144static void destroy_super(struct super_block *s)
Jan Kara5accdf82012-06-12 16:20:34 +0200145{
146 int i;
Al Viro7eb5e882013-10-01 15:09:58 -0400147 list_lru_destroy(&s->s_dentry_lru);
148 list_lru_destroy(&s->s_inode_lru);
Jan Kara5accdf82012-06-12 16:20:34 +0200149 for (i = 0; i < SB_FREEZE_LEVELS; i++)
150 percpu_counter_destroy(&s->s_writers.counter[i]);
Al Viro7eb5e882013-10-01 15:09:58 -0400151 security_sb_free(s);
152 WARN_ON(!list_empty(&s->s_mounts));
153 kfree(s->s_subtype);
154 kfree(s->s_options);
Al Viroe2fec7c2013-10-04 17:06:56 -0400155 kfree_rcu(s, rcu);
Jan Kara5accdf82012-06-12 16:20:34 +0200156}
157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158/**
159 * alloc_super - create new superblock
Henrik Kretzschmarfe2bbc42006-09-06 00:03:41 -0700160 * @type: filesystem type superblock should belong to
David Howells9249e172012-06-25 12:55:37 +0100161 * @flags: the mount flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 *
163 * Allocates and initializes a new &struct super_block. alloc_super()
164 * returns a pointer new superblock or %NULL if allocation had failed.
165 */
David Howells9249e172012-06-25 12:55:37 +0100166static struct super_block *alloc_super(struct file_system_type *type, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Oliver Neukum11b0b5a2006-03-25 03:08:13 -0800168 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_USER);
Alexey Dobriyanb87221d2009-09-21 17:01:09 -0700169 static const struct super_operations default_op;
Al Viro7eb5e882013-10-01 15:09:58 -0400170 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Al Viro7eb5e882013-10-01 15:09:58 -0400172 if (!s)
173 return NULL;
174
Vladimir Davydovb5bd8562014-01-21 15:48:45 -0800175 INIT_LIST_HEAD(&s->s_mounts);
176
Al Viro7eb5e882013-10-01 15:09:58 -0400177 if (security_sb_alloc(s))
178 goto fail;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200179
Al Viro7eb5e882013-10-01 15:09:58 -0400180 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
Tejun Heo908c7f12014-09-08 09:51:29 +0900181 if (percpu_counter_init(&s->s_writers.counter[i], 0,
182 GFP_KERNEL) < 0)
Al Viro7eb5e882013-10-01 15:09:58 -0400183 goto fail;
184 lockdep_init_map(&s->s_writers.lock_map[i], sb_writers_name[i],
185 &type->s_writers_key[i], 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
Al Viro7eb5e882013-10-01 15:09:58 -0400187 init_waitqueue_head(&s->s_writers.wait);
188 init_waitqueue_head(&s->s_writers.wait_unfrozen);
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100189 s->s_bdi = &noop_backing_dev_info;
Al Viro7eb5e882013-10-01 15:09:58 -0400190 s->s_flags = flags;
Al Viro7eb5e882013-10-01 15:09:58 -0400191 INIT_HLIST_NODE(&s->s_instances);
192 INIT_HLIST_BL_HEAD(&s->s_anon);
Dave Chinnere97fedb2015-03-04 13:40:00 -0500193 mutex_init(&s->s_sync_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400194 INIT_LIST_HEAD(&s->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500195 spin_lock_init(&s->s_inode_list_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400196
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800197 if (list_lru_init_memcg(&s->s_dentry_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400198 goto fail;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800199 if (list_lru_init_memcg(&s->s_inode_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400200 goto fail;
201
Al Viro7eb5e882013-10-01 15:09:58 -0400202 init_rwsem(&s->s_umount);
203 lockdep_set_class(&s->s_umount, &type->s_umount_key);
204 /*
205 * sget() can have s_umount recursion.
206 *
207 * When it cannot find a suitable sb, it allocates a new
208 * one (this one), and tries again to find a suitable old
209 * one.
210 *
211 * In case that succeeds, it will acquire the s_umount
212 * lock of the old one. Since these are clearly distrinct
213 * locks, and this object isn't exposed yet, there's no
214 * risk of deadlocks.
215 *
216 * Annotate this by putting this lock in a different
217 * subclass.
218 */
219 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
220 s->s_count = 1;
221 atomic_set(&s->s_active, 1);
222 mutex_init(&s->s_vfs_rename_mutex);
223 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
224 mutex_init(&s->s_dquot.dqio_mutex);
225 mutex_init(&s->s_dquot.dqonoff_mutex);
Al Viro7eb5e882013-10-01 15:09:58 -0400226 s->s_maxbytes = MAX_NON_LFS;
227 s->s_op = &default_op;
228 s->s_time_gran = 1000000000;
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700229 s->cleancache_poolid = CLEANCACHE_NO_POOL;
Al Viro7eb5e882013-10-01 15:09:58 -0400230
231 s->s_shrink.seeks = DEFAULT_SEEKS;
232 s->s_shrink.scan_objects = super_cache_scan;
233 s->s_shrink.count_objects = super_cache_count;
234 s->s_shrink.batch = 1024;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800235 s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 return s;
Glauber Costa5ca302c2013-08-28 10:18:18 +1000237
Al Viro7eb5e882013-10-01 15:09:58 -0400238fail:
239 destroy_super(s);
240 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241}
242
243/* Superblock refcounting */
244
245/*
Al Viro35cf7ba2010-03-22 21:13:53 -0400246 * Drop a superblock's refcount. The caller must hold sb_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 */
Al Virof47ec3f2011-11-21 21:15:42 -0500248static void __put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 if (!--sb->s_count) {
Al Viro551de6f2010-03-22 19:36:35 -0400251 list_del_init(&sb->s_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 destroy_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
256/**
257 * put_super - drop a temporary reference to superblock
258 * @sb: superblock in question
259 *
260 * Drops a temporary reference, frees superblock if there's no
261 * references left.
262 */
Al Virof47ec3f2011-11-21 21:15:42 -0500263static void put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
265 spin_lock(&sb_lock);
266 __put_super(sb);
267 spin_unlock(&sb_lock);
268}
269
270
271/**
Al Viro74dbbdd2009-05-06 01:07:50 -0400272 * deactivate_locked_super - drop an active reference to superblock
273 * @s: superblock to deactivate
274 *
Al Viro1712ac82010-03-22 15:22:31 -0400275 * Drops an active reference to superblock, converting it into a temprory
276 * one if there is no other active references left. In that case we
277 * tell fs driver to shut it down and drop the temporary reference we
278 * had just acquired.
279 *
280 * Caller holds exclusive lock on superblock; that lock is released.
Al Viro74dbbdd2009-05-06 01:07:50 -0400281 */
282void deactivate_locked_super(struct super_block *s)
283{
284 struct file_system_type *fs = s->s_type;
Al Virob20bd1a2010-03-22 08:53:19 -0400285 if (atomic_dec_and_test(&s->s_active)) {
Dan Magenheimer31677602011-09-21 11:56:28 -0400286 cleancache_invalidate_fs(s);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000287 unregister_shrinker(&s->s_shrink);
Dave Chinner28f2cd4f2014-06-04 16:10:46 -0700288 fs->kill_sb(s);
Glauber Costaf5e1dd32013-08-28 10:18:18 +1000289
Vladimir Davydovc0a5b562015-02-12 14:59:07 -0800290 /*
291 * Since list_lru_destroy() may sleep, we cannot call it from
292 * put_super(), where we hold the sb_lock. Therefore we destroy
293 * the lru lists right now.
294 */
295 list_lru_destroy(&s->s_dentry_lru);
296 list_lru_destroy(&s->s_inode_lru);
297
Al Viro74dbbdd2009-05-06 01:07:50 -0400298 put_filesystem(fs);
299 put_super(s);
300 } else {
301 up_write(&s->s_umount);
302 }
303}
304
305EXPORT_SYMBOL(deactivate_locked_super);
306
307/**
Al Viro1712ac82010-03-22 15:22:31 -0400308 * deactivate_super - drop an active reference to superblock
309 * @s: superblock to deactivate
310 *
311 * Variant of deactivate_locked_super(), except that superblock is *not*
312 * locked by caller. If we are going to drop the final active reference,
313 * lock will be acquired prior to that.
314 */
315void deactivate_super(struct super_block *s)
316{
317 if (!atomic_add_unless(&s->s_active, -1, 1)) {
318 down_write(&s->s_umount);
319 deactivate_locked_super(s);
320 }
321}
322
323EXPORT_SYMBOL(deactivate_super);
324
325/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 * grab_super - acquire an active reference
327 * @s: reference we are trying to make active
328 *
329 * Tries to acquire an active reference. grab_super() is used when we
330 * had just found a superblock in super_blocks or fs_type->fs_supers
331 * and want to turn it into a full-blown active reference. grab_super()
332 * is called with sb_lock held and drops it. Returns 1 in case of
333 * success, 0 if we had failed (superblock contents was already dead or
Al Viroacfec9a2013-07-20 03:13:55 +0400334 * dying when grab_super() had been called). Note that this is only
335 * called for superblocks not in rundown mode (== ones still on ->fs_supers
336 * of their type), so increment of ->s_count is OK here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 */
Josh Triplett9c4dbee2006-09-29 01:59:29 -0700338static int grab_super(struct super_block *s) __releases(sb_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339{
340 s->s_count++;
341 spin_unlock(&sb_lock);
342 down_write(&s->s_umount);
Al Viroacfec9a2013-07-20 03:13:55 +0400343 if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
344 put_super(s);
345 return 1;
346 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 up_write(&s->s_umount);
348 put_super(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 return 0;
350}
351
David Howellscf9a2ae2006-08-29 19:05:54 +0100352/*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300353 * trylock_super - try to grab ->s_umount shared
Wanpeng Li331cbde2012-06-09 11:10:55 +0800354 * @sb: reference we are trying to grab
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000355 *
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300356 * Try to prevent fs shutdown. This is used in places where we
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000357 * cannot take an active reference but we need to ensure that the
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300358 * filesystem is not shut down while we are working on it. It returns
359 * false if we cannot acquire s_umount or if we lose the race and
360 * filesystem already got into shutdown, and returns true with the s_umount
361 * lock held in read mode in case of success. On successful return,
362 * the caller must drop the s_umount lock when done.
363 *
364 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
365 * The reason why it's safe is that we are OK with doing trylock instead
366 * of down_read(). There's a couple of places that are OK with that, but
367 * it's very much not a general-purpose interface.
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000368 */
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300369bool trylock_super(struct super_block *sb)
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000370{
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000371 if (down_read_trylock(&sb->s_umount)) {
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300372 if (!hlist_unhashed(&sb->s_instances) &&
373 sb->s_root && (sb->s_flags & MS_BORN))
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000374 return true;
375 up_read(&sb->s_umount);
376 }
377
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000378 return false;
379}
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381/**
382 * generic_shutdown_super - common helper for ->kill_sb()
383 * @sb: superblock to kill
384 *
385 * generic_shutdown_super() does all fs-independent work on superblock
386 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
387 * that need destruction out of superblock, call generic_shutdown_super()
388 * and release aforementioned objects. Note: dentries and inodes _are_
389 * taken care of and do not need specific handling.
David Howellsc636ebd2006-10-11 01:22:19 -0700390 *
391 * Upon calling this function, the filesystem may no longer alter or
392 * rearrange the set of dentries belonging to this super_block, nor may it
393 * change the attachments of dentries to inodes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 */
395void generic_shutdown_super(struct super_block *sb)
396{
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800397 const struct super_operations *sop = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
David Howellsc636ebd2006-10-11 01:22:19 -0700399 if (sb->s_root) {
400 shrink_dcache_for_umount(sb);
Jan Kara60b06802009-04-27 16:43:53 +0200401 sync_filesystem(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 sb->s_flags &= ~MS_ACTIVE;
Arjan van de Venefaee192009-01-06 07:20:54 -0800403
Dave Chinner74278da2015-03-04 12:37:22 -0500404 fsnotify_unmount_inodes(sb);
Al Viro63997e92010-10-25 20:49:35 -0400405
406 evict_inodes(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200408 if (sb->s_dio_done_wq) {
409 destroy_workqueue(sb->s_dio_done_wq);
410 sb->s_dio_done_wq = NULL;
411 }
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 if (sop->put_super)
414 sop->put_super(sb);
415
Al Viro63997e92010-10-25 20:49:35 -0400416 if (!list_empty(&sb->s_inodes)) {
Dave Jones7b4fe292006-02-07 12:58:48 -0800417 printk("VFS: Busy inodes after unmount of %s. "
418 "Self-destruct in 5 seconds. Have a nice day...\n",
419 sb->s_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
422 spin_lock(&sb_lock);
423 /* should be initialized for __put_super_and_need_restart() */
Al Viroa5166162011-12-12 22:53:00 -0500424 hlist_del_init(&sb->s_instances);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 spin_unlock(&sb_lock);
426 up_write(&sb->s_umount);
427}
428
429EXPORT_SYMBOL(generic_shutdown_super);
430
431/**
432 * sget - find or create a superblock
433 * @type: filesystem type superblock should belong to
434 * @test: comparison callback
435 * @set: setup callback
David Howells9249e172012-06-25 12:55:37 +0100436 * @flags: mount flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 * @data: argument to each of them
438 */
439struct super_block *sget(struct file_system_type *type,
440 int (*test)(struct super_block *,void *),
441 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +0100442 int flags,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 void *data)
444{
445 struct super_block *s = NULL;
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700446 struct super_block *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 int err;
448
449retry:
450 spin_lock(&sb_lock);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700451 if (test) {
Sasha Levinb67bfe02013-02-27 17:06:00 -0800452 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700453 if (!test(old, data))
454 continue;
455 if (!grab_super(old))
456 goto retry;
Li Zefana3cfbb52009-03-12 14:31:29 -0700457 if (s) {
458 up_write(&s->s_umount);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700459 destroy_super(s);
Al Viro7a4dec52010-08-09 12:05:43 -0400460 s = NULL;
Li Zefana3cfbb52009-03-12 14:31:29 -0700461 }
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700462 return old;
463 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 }
465 if (!s) {
466 spin_unlock(&sb_lock);
David Howells9249e172012-06-25 12:55:37 +0100467 s = alloc_super(type, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 if (!s)
469 return ERR_PTR(-ENOMEM);
470 goto retry;
471 }
472
473 err = set(s, data);
474 if (err) {
475 spin_unlock(&sb_lock);
Li Zefana3cfbb52009-03-12 14:31:29 -0700476 up_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 destroy_super(s);
478 return ERR_PTR(err);
479 }
480 s->s_type = type;
481 strlcpy(s->s_id, type->name, sizeof(s->s_id));
482 list_add_tail(&s->s_list, &super_blocks);
Al Viroa5166162011-12-12 22:53:00 -0500483 hlist_add_head(&s->s_instances, &type->fs_supers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 spin_unlock(&sb_lock);
485 get_filesystem(type);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000486 register_shrinker(&s->s_shrink);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 return s;
488}
489
490EXPORT_SYMBOL(sget);
491
492void drop_super(struct super_block *sb)
493{
494 up_read(&sb->s_umount);
495 put_super(sb);
496}
497
498EXPORT_SYMBOL(drop_super);
499
Christoph Hellwige5004752009-05-05 16:08:56 +0200500/**
Al Viro01a05b32010-03-23 06:06:58 -0400501 * iterate_supers - call function for all active superblocks
502 * @f: function to call
503 * @arg: argument to pass to it
504 *
505 * Scans the superblock list and calls given function, passing it
506 * locked superblock and given argument.
507 */
508void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
509{
Al Virodca33252010-07-25 02:31:46 +0400510 struct super_block *sb, *p = NULL;
Al Viro01a05b32010-03-23 06:06:58 -0400511
512 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400513 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500514 if (hlist_unhashed(&sb->s_instances))
Al Viro01a05b32010-03-23 06:06:58 -0400515 continue;
516 sb->s_count++;
517 spin_unlock(&sb_lock);
518
519 down_read(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500520 if (sb->s_root && (sb->s_flags & MS_BORN))
Al Viro01a05b32010-03-23 06:06:58 -0400521 f(sb, arg);
522 up_read(&sb->s_umount);
523
524 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400525 if (p)
526 __put_super(p);
527 p = sb;
Al Viro01a05b32010-03-23 06:06:58 -0400528 }
Al Virodca33252010-07-25 02:31:46 +0400529 if (p)
530 __put_super(p);
Al Viro01a05b32010-03-23 06:06:58 -0400531 spin_unlock(&sb_lock);
532}
533
534/**
Al Viro43e15cd2011-06-03 20:16:57 -0400535 * iterate_supers_type - call function for superblocks of given type
536 * @type: fs type
537 * @f: function to call
538 * @arg: argument to pass to it
539 *
540 * Scans the superblock list and calls given function, passing it
541 * locked superblock and given argument.
542 */
543void iterate_supers_type(struct file_system_type *type,
544 void (*f)(struct super_block *, void *), void *arg)
545{
546 struct super_block *sb, *p = NULL;
547
548 spin_lock(&sb_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800549 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
Al Viro43e15cd2011-06-03 20:16:57 -0400550 sb->s_count++;
551 spin_unlock(&sb_lock);
552
553 down_read(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500554 if (sb->s_root && (sb->s_flags & MS_BORN))
Al Viro43e15cd2011-06-03 20:16:57 -0400555 f(sb, arg);
556 up_read(&sb->s_umount);
557
558 spin_lock(&sb_lock);
559 if (p)
560 __put_super(p);
561 p = sb;
562 }
563 if (p)
564 __put_super(p);
565 spin_unlock(&sb_lock);
566}
567
568EXPORT_SYMBOL(iterate_supers_type);
569
570/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 * get_super - get the superblock of a device
572 * @bdev: device to get the superblock for
573 *
574 * Scans the superblock list and finds the superblock of the file system
575 * mounted on the device given. %NULL is returned if no match is found.
576 */
577
Al Virodf40c012010-03-22 20:23:25 -0400578struct super_block *get_super(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700580 struct super_block *sb;
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 if (!bdev)
583 return NULL;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700586rescan:
587 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500588 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400589 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700590 if (sb->s_bdev == bdev) {
591 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700593 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400594 /* still alive? */
Al Virodabe0dc2012-01-03 21:01:29 -0500595 if (sb->s_root && (sb->s_flags & MS_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700596 return sb;
597 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400598 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700599 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400600 __put_super(sb);
601 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 }
603 }
604 spin_unlock(&sb_lock);
605 return NULL;
606}
607
608EXPORT_SYMBOL(get_super);
Christoph Hellwig45042302009-08-03 23:28:35 +0200609
610/**
Jan Kara6b6dc832012-02-10 11:03:00 +0100611 * get_super_thawed - get thawed superblock of a device
612 * @bdev: device to get the superblock for
613 *
614 * Scans the superblock list and finds the superblock of the file system
615 * mounted on the device. The superblock is returned once it is thawed
616 * (or immediately if it was not frozen). %NULL is returned if no match
617 * is found.
618 */
619struct super_block *get_super_thawed(struct block_device *bdev)
620{
621 while (1) {
622 struct super_block *s = get_super(bdev);
Jan Kara5accdf82012-06-12 16:20:34 +0200623 if (!s || s->s_writers.frozen == SB_UNFROZEN)
Jan Kara6b6dc832012-02-10 11:03:00 +0100624 return s;
625 up_read(&s->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +0200626 wait_event(s->s_writers.wait_unfrozen,
627 s->s_writers.frozen == SB_UNFROZEN);
Jan Kara6b6dc832012-02-10 11:03:00 +0100628 put_super(s);
629 }
630}
631EXPORT_SYMBOL(get_super_thawed);
632
633/**
Christoph Hellwig45042302009-08-03 23:28:35 +0200634 * get_active_super - get an active reference to the superblock of a device
635 * @bdev: device to get the superblock for
636 *
637 * Scans the superblock list and finds the superblock of the file system
638 * mounted on the device given. Returns the superblock with an active
Al Virod3f21472010-03-23 11:11:05 -0400639 * reference or %NULL if none was found.
Christoph Hellwig45042302009-08-03 23:28:35 +0200640 */
641struct super_block *get_active_super(struct block_device *bdev)
642{
643 struct super_block *sb;
644
645 if (!bdev)
646 return NULL;
647
Al Viro14945832010-03-22 20:15:33 -0400648restart:
Christoph Hellwig45042302009-08-03 23:28:35 +0200649 spin_lock(&sb_lock);
650 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500651 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400652 continue;
Al Viro14945832010-03-22 20:15:33 -0400653 if (sb->s_bdev == bdev) {
Al Viroacfec9a2013-07-20 03:13:55 +0400654 if (!grab_super(sb))
Al Viro14945832010-03-22 20:15:33 -0400655 goto restart;
Al Viroacfec9a2013-07-20 03:13:55 +0400656 up_write(&sb->s_umount);
657 return sb;
Al Viro14945832010-03-22 20:15:33 -0400658 }
Christoph Hellwig45042302009-08-03 23:28:35 +0200659 }
660 spin_unlock(&sb_lock);
661 return NULL;
662}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Al Virodf40c012010-03-22 20:23:25 -0400664struct super_block *user_get_super(dev_t dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700666 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700669rescan:
670 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500671 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400672 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700673 if (sb->s_dev == dev) {
674 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700676 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400677 /* still alive? */
Al Virodabe0dc2012-01-03 21:01:29 -0500678 if (sb->s_root && (sb->s_flags & MS_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700679 return sb;
680 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400681 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700682 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400683 __put_super(sb);
684 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 }
686 }
687 spin_unlock(&sb_lock);
688 return NULL;
689}
690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692 * do_remount_sb - asks filesystem to change mount options.
693 * @sb: superblock in question
694 * @flags: numeric part of options
695 * @data: the rest of options
696 * @force: whether or not to force the change
697 *
698 * Alters the mount options of a mounted file system.
699 */
700int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
701{
702 int retval;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400703 int remount_ro;
Christoph Hellwig45042302009-08-03 23:28:35 +0200704
Jan Kara5accdf82012-06-12 16:20:34 +0200705 if (sb->s_writers.frozen != SB_UNFROZEN)
Christoph Hellwig45042302009-08-03 23:28:35 +0200706 return -EBUSY;
707
David Howells93614012006-09-30 20:45:40 +0200708#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
710 return -EACCES;
David Howells93614012006-09-30 20:45:40 +0200711#endif
Christoph Hellwig45042302009-08-03 23:28:35 +0200712
Nick Piggind208bbd2009-12-21 16:28:53 -0800713 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
Nick Piggind208bbd2009-12-21 16:28:53 -0800714
Al Viro0aec09d2014-08-07 07:32:06 -0400715 if (remount_ro) {
Al Virofdab6842015-01-11 10:57:27 -0500716 if (!hlist_empty(&sb->s_pins)) {
Al Viro0aec09d2014-08-07 07:32:06 -0400717 up_write(&sb->s_umount);
Al Virofdab6842015-01-11 10:57:27 -0500718 group_pin_kill(&sb->s_pins);
Al Viro0aec09d2014-08-07 07:32:06 -0400719 down_write(&sb->s_umount);
720 if (!sb->s_root)
721 return 0;
722 if (sb->s_writers.frozen != SB_UNFROZEN)
723 return -EBUSY;
724 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
725 }
726 }
727 shrink_dcache_sb(sb);
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 /* If we are remounting RDONLY and current sb is read/write,
730 make sure there are no rw files opened */
Nick Piggind208bbd2009-12-21 16:28:53 -0800731 if (remount_ro) {
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100732 if (force) {
Al Viroeee5cc22013-10-04 11:06:42 -0400733 sb->s_readonly_remount = 1;
734 smp_wmb();
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100735 } else {
736 retval = sb_prepare_remount_readonly(sb);
737 if (retval)
738 return retval;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100739 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 }
741
742 if (sb->s_op->remount_fs) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 retval = sb->s_op->remount_fs(sb, &flags, data);
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200744 if (retval) {
745 if (!force)
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100746 goto cancel_readonly;
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200747 /* If forced remount, go ahead despite any errors */
748 WARN(1, "forced remount of a %s fs returned %i\n",
749 sb->s_type->name, retval);
750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 }
752 sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100753 /* Needs to be ordered wrt mnt_is_readonly() */
754 smp_wmb();
755 sb->s_readonly_remount = 0;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400756
Nick Piggind208bbd2009-12-21 16:28:53 -0800757 /*
758 * Some filesystems modify their metadata via some other path than the
759 * bdev buffer cache (eg. use a private mapping, or directories in
760 * pagecache, etc). Also file data modifications go via their own
761 * mappings. So If we try to mount readonly then copy the filesystem
762 * from bdev, we could get stale data, so invalidate it to give a best
763 * effort at coherency.
764 */
765 if (remount_ro && sb->s_bdev)
766 invalidate_bdev(sb->s_bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return 0;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100768
769cancel_readonly:
770 sb->s_readonly_remount = 0;
771 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773
Jens Axboea2a95372009-03-17 09:38:40 +0100774static void do_emergency_remount(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775{
Al Virodca33252010-07-25 02:31:46 +0400776 struct super_block *sb, *p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400779 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500780 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400781 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 sb->s_count++;
783 spin_unlock(&sb_lock);
Al Viro443b94b2009-05-05 23:48:50 -0400784 down_write(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500785 if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
786 !(sb->s_flags & MS_RDONLY)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 * What lock protects sb->s_flags??
789 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 do_remount_sb(sb, MS_RDONLY, NULL, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 }
Al Viro443b94b2009-05-05 23:48:50 -0400792 up_write(&sb->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400794 if (p)
795 __put_super(p);
796 p = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 }
Al Virodca33252010-07-25 02:31:46 +0400798 if (p)
799 __put_super(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 spin_unlock(&sb_lock);
Jens Axboea2a95372009-03-17 09:38:40 +0100801 kfree(work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 printk("Emergency Remount complete\n");
803}
804
805void emergency_remount(void)
806{
Jens Axboea2a95372009-03-17 09:38:40 +0100807 struct work_struct *work;
808
809 work = kmalloc(sizeof(*work), GFP_ATOMIC);
810 if (work) {
811 INIT_WORK(work, do_emergency_remount);
812 schedule_work(work);
813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814}
815
816/*
817 * Unnamed block devices are dummy devices used by virtual
818 * filesystems which don't use real block-devices. -- jrs
819 */
820
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400821static DEFINE_IDA(unnamed_dev_ida);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
Thomas Bächlera2a4dc42014-04-03 21:55:37 +0200823/* Many userspace utilities consider an FSID of 0 invalid.
824 * Always return at least 1 from get_anon_bdev.
825 */
826static int unnamed_dev_start = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827
Al Viro0ee5dc62011-07-07 15:44:25 -0400828int get_anon_bdev(dev_t *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829{
830 int dev;
831 int error;
832
833 retry:
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400834 if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return -ENOMEM;
836 spin_lock(&unnamed_dev_lock);
Al Viroc63e09e2009-06-24 02:05:18 -0400837 error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
Al Virof21f6222009-06-24 03:12:00 -0400838 if (!error)
839 unnamed_dev_start = dev + 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 spin_unlock(&unnamed_dev_lock);
841 if (error == -EAGAIN)
842 /* We raced and lost with another CPU. */
843 goto retry;
844 else if (error)
845 return -EAGAIN;
846
Wang YanQing1af95de2015-06-23 18:54:45 +0800847 if (dev >= (1 << MINORBITS)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 spin_lock(&unnamed_dev_lock);
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400849 ida_remove(&unnamed_dev_ida, dev);
Al Virof21f6222009-06-24 03:12:00 -0400850 if (unnamed_dev_start > dev)
851 unnamed_dev_start = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 spin_unlock(&unnamed_dev_lock);
853 return -EMFILE;
854 }
Al Viro0ee5dc62011-07-07 15:44:25 -0400855 *p = MKDEV(0, dev & MINORMASK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 return 0;
857}
Al Viro0ee5dc62011-07-07 15:44:25 -0400858EXPORT_SYMBOL(get_anon_bdev);
859
860void free_anon_bdev(dev_t dev)
861{
862 int slot = MINOR(dev);
863 spin_lock(&unnamed_dev_lock);
864 ida_remove(&unnamed_dev_ida, slot);
865 if (slot < unnamed_dev_start)
866 unnamed_dev_start = slot;
867 spin_unlock(&unnamed_dev_lock);
868}
869EXPORT_SYMBOL(free_anon_bdev);
870
871int set_anon_super(struct super_block *s, void *data)
872{
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100873 return get_anon_bdev(&s->s_dev);
Al Viro0ee5dc62011-07-07 15:44:25 -0400874}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875
876EXPORT_SYMBOL(set_anon_super);
877
878void kill_anon_super(struct super_block *sb)
879{
Al Viro0ee5dc62011-07-07 15:44:25 -0400880 dev_t dev = sb->s_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 generic_shutdown_super(sb);
Al Viro0ee5dc62011-07-07 15:44:25 -0400882 free_anon_bdev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883}
884
885EXPORT_SYMBOL(kill_anon_super);
886
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887void kill_litter_super(struct super_block *sb)
888{
889 if (sb->s_root)
890 d_genocide(sb->s_root);
891 kill_anon_super(sb);
892}
893
894EXPORT_SYMBOL(kill_litter_super);
895
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700896static int ns_test_super(struct super_block *sb, void *data)
897{
898 return sb->s_fs_info == data;
899}
900
901static int ns_set_super(struct super_block *sb, void *data)
902{
903 sb->s_fs_info = data;
904 return set_anon_super(sb, NULL);
905}
906
Al Viroceefda62010-07-26 13:16:50 +0400907struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
908 void *data, int (*fill_super)(struct super_block *, void *, int))
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700909{
910 struct super_block *sb;
911
David Howells9249e172012-06-25 12:55:37 +0100912 sb = sget(fs_type, ns_test_super, ns_set_super, flags, data);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700913 if (IS_ERR(sb))
Al Viroceefda62010-07-26 13:16:50 +0400914 return ERR_CAST(sb);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700915
916 if (!sb->s_root) {
917 int err;
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700918 err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
919 if (err) {
Al Viro74dbbdd2009-05-06 01:07:50 -0400920 deactivate_locked_super(sb);
Al Viroceefda62010-07-26 13:16:50 +0400921 return ERR_PTR(err);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700922 }
923
924 sb->s_flags |= MS_ACTIVE;
925 }
926
Al Viroceefda62010-07-26 13:16:50 +0400927 return dget(sb->s_root);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700928}
929
Al Viroceefda62010-07-26 13:16:50 +0400930EXPORT_SYMBOL(mount_ns);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700931
David Howells93614012006-09-30 20:45:40 +0200932#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933static int set_bdev_super(struct super_block *s, void *data)
934{
935 s->s_bdev = data;
936 s->s_dev = s->s_bdev->bd_dev;
Jens Axboe32a88aa2009-09-16 15:02:33 +0200937
938 /*
939 * We set the bdi here to the queue backing, file systems can
940 * overwrite this in ->fill_super()
941 */
942 s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 return 0;
944}
945
946static int test_bdev_super(struct super_block *s, void *data)
947{
948 return (void *)s->s_bdev == data;
949}
950
Al Viro152a0832010-07-25 00:46:55 +0400951struct dentry *mount_bdev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 int flags, const char *dev_name, void *data,
Al Viro152a0832010-07-25 00:46:55 +0400953 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954{
955 struct block_device *bdev;
956 struct super_block *s;
Tejun Heod4d77622010-11-13 11:55:18 +0100957 fmode_t mode = FMODE_READ | FMODE_EXCL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 int error = 0;
959
Al Viro30c40d22008-02-22 19:50:45 -0500960 if (!(flags & MS_RDONLY))
961 mode |= FMODE_WRITE;
962
Tejun Heod4d77622010-11-13 11:55:18 +0100963 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 if (IS_ERR(bdev))
Al Viro152a0832010-07-25 00:46:55 +0400965 return ERR_CAST(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
967 /*
968 * once the super is inserted into the list by sget, s_umount
969 * will protect the lockfs code from trying to start a snapshot
970 * while we are mounting
971 */
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +0200972 mutex_lock(&bdev->bd_fsfreeze_mutex);
973 if (bdev->bd_fsfreeze_count > 0) {
974 mutex_unlock(&bdev->bd_fsfreeze_mutex);
975 error = -EBUSY;
976 goto error_bdev;
977 }
David Howells9249e172012-06-25 12:55:37 +0100978 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
979 bdev);
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +0200980 mutex_unlock(&bdev->bd_fsfreeze_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 if (IS_ERR(s))
David Howells454e2392006-06-23 02:02:57 -0700982 goto error_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
984 if (s->s_root) {
985 if ((flags ^ s->s_flags) & MS_RDONLY) {
Al Viro74dbbdd2009-05-06 01:07:50 -0400986 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -0700987 error = -EBUSY;
988 goto error_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 }
David Howells454e2392006-06-23 02:02:57 -0700990
Tejun Heo4f331f02010-07-20 15:18:07 -0700991 /*
992 * s_umount nests inside bd_mutex during
Tejun Heoe525fd82010-11-13 11:55:17 +0100993 * __invalidate_device(). blkdev_put() acquires
994 * bd_mutex and can't be called under s_umount. Drop
995 * s_umount temporarily. This is safe as we're
996 * holding an active reference.
Tejun Heo4f331f02010-07-20 15:18:07 -0700997 */
998 up_write(&s->s_umount);
Tejun Heod4d77622010-11-13 11:55:18 +0100999 blkdev_put(bdev, mode);
Tejun Heo4f331f02010-07-20 15:18:07 -07001000 down_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 } else {
1002 char b[BDEVNAME_SIZE];
1003
Al Viro30c40d22008-02-22 19:50:45 -05001004 s->s_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 strlcpy(s->s_id, bdevname(bdev, b), sizeof(s->s_id));
Pekka Enberge78c9a02006-01-08 01:03:39 -08001006 sb_set_blocksize(s, block_size(bdev));
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001007 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001009 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -07001010 goto error;
Greg Kroah-Hartmanfa675762006-02-22 09:39:02 -08001011 }
David Howells454e2392006-06-23 02:02:57 -07001012
1013 s->s_flags |= MS_ACTIVE;
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001014 bdev->bd_super = s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 }
1016
Al Viro152a0832010-07-25 00:46:55 +04001017 return dget(s->s_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
David Howells454e2392006-06-23 02:02:57 -07001019error_s:
1020 error = PTR_ERR(s);
1021error_bdev:
Tejun Heod4d77622010-11-13 11:55:18 +01001022 blkdev_put(bdev, mode);
David Howells454e2392006-06-23 02:02:57 -07001023error:
Al Viro152a0832010-07-25 00:46:55 +04001024 return ERR_PTR(error);
1025}
1026EXPORT_SYMBOL(mount_bdev);
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028void kill_block_super(struct super_block *sb)
1029{
1030 struct block_device *bdev = sb->s_bdev;
Al Viro30c40d22008-02-22 19:50:45 -05001031 fmode_t mode = sb->s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032
H Hartley Sweetenddbaaf32009-04-29 20:14:57 -04001033 bdev->bd_super = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 generic_shutdown_super(sb);
1035 sync_blockdev(bdev);
Tejun Heod4d77622010-11-13 11:55:18 +01001036 WARN_ON_ONCE(!(mode & FMODE_EXCL));
Tejun Heoe525fd82010-11-13 11:55:17 +01001037 blkdev_put(bdev, mode | FMODE_EXCL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038}
1039
1040EXPORT_SYMBOL(kill_block_super);
David Howells93614012006-09-30 20:45:40 +02001041#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042
Al Viro3c26ff62010-07-25 11:46:36 +04001043struct dentry *mount_nodev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 int flags, void *data,
Al Viro3c26ff62010-07-25 11:46:36 +04001045 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046{
1047 int error;
David Howells9249e172012-06-25 12:55:37 +01001048 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
1050 if (IS_ERR(s))
Al Viro3c26ff62010-07-25 11:46:36 +04001051 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001053 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001055 deactivate_locked_super(s);
Al Viro3c26ff62010-07-25 11:46:36 +04001056 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 }
1058 s->s_flags |= MS_ACTIVE;
Al Viro3c26ff62010-07-25 11:46:36 +04001059 return dget(s->s_root);
1060}
1061EXPORT_SYMBOL(mount_nodev);
1062
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063static int compare_single(struct super_block *s, void *p)
1064{
1065 return 1;
1066}
1067
Al Virofc14f2f2010-07-25 01:48:30 +04001068struct dentry *mount_single(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 int flags, void *data,
Al Virofc14f2f2010-07-25 01:48:30 +04001070 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071{
1072 struct super_block *s;
1073 int error;
1074
David Howells9249e172012-06-25 12:55:37 +01001075 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 if (IS_ERR(s))
Al Virofc14f2f2010-07-25 01:48:30 +04001077 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 if (!s->s_root) {
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001079 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001081 deactivate_locked_super(s);
Al Virofc14f2f2010-07-25 01:48:30 +04001082 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 }
1084 s->s_flags |= MS_ACTIVE;
Kay Sievers9329d1b2009-12-18 21:18:15 +01001085 } else {
1086 do_remount_sb(s, flags, data, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 }
Al Virofc14f2f2010-07-25 01:48:30 +04001088 return dget(s->s_root);
1089}
1090EXPORT_SYMBOL(mount_single);
1091
Al Viro9d412a42011-03-17 22:08:28 -04001092struct dentry *
1093mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094{
Al Viroc96e41e2010-07-25 00:17:56 +04001095 struct dentry *root;
Al Viro9d412a42011-03-17 22:08:28 -04001096 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 char *secdata = NULL;
Al Viro9d412a42011-03-17 22:08:28 -04001098 int error = -ENOMEM;
Al Viro80893522010-02-05 09:30:46 -05001099
Eric Parise0007522008-03-05 10:31:54 -05001100 if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 secdata = alloc_secdata();
David Howells454e2392006-06-23 02:02:57 -07001102 if (!secdata)
Al Viro9d412a42011-03-17 22:08:28 -04001103 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
Eric Parise0007522008-03-05 10:31:54 -05001105 error = security_sb_copy_data(data, secdata);
David Howells454e2392006-06-23 02:02:57 -07001106 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 goto out_free_secdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 }
1109
Al Viro1a102ff2011-03-16 09:07:58 -04001110 root = type->mount(type, flags, name, data);
1111 if (IS_ERR(root)) {
1112 error = PTR_ERR(root);
1113 goto out_free_secdata;
Al Viroc96e41e2010-07-25 00:17:56 +04001114 }
Al Viro9d412a42011-03-17 22:08:28 -04001115 sb = root->d_sb;
1116 BUG_ON(!sb);
1117 WARN_ON(!sb->s_bdi);
1118 sb->s_flags |= MS_BORN;
David Howells454e2392006-06-23 02:02:57 -07001119
Al Viro9d412a42011-03-17 22:08:28 -04001120 error = security_sb_kern_mount(sb, flags, secdata);
Jörn Engel5129a462010-04-25 08:54:42 +02001121 if (error)
1122 goto out_sb;
David Howells454e2392006-06-23 02:02:57 -07001123
Jeff Layton42cb56a2009-09-18 13:05:53 -07001124 /*
1125 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1126 * but s_maxbytes was an unsigned long long for many releases. Throw
1127 * this warning for a little while to try and catch filesystems that
Jeff Layton4358b562011-03-29 09:33:31 -04001128 * violate this rule.
Jeff Layton42cb56a2009-09-18 13:05:53 -07001129 */
Al Viro9d412a42011-03-17 22:08:28 -04001130 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1131 "negative value (%lld)\n", type->name, sb->s_maxbytes);
Jeff Layton42cb56a2009-09-18 13:05:53 -07001132
Al Viro9d412a42011-03-17 22:08:28 -04001133 up_write(&sb->s_umount);
Gerald Schaefer8680e222005-06-21 17:15:16 -07001134 free_secdata(secdata);
Al Viro9d412a42011-03-17 22:08:28 -04001135 return root;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136out_sb:
Al Viro9d412a42011-03-17 22:08:28 -04001137 dput(root);
1138 deactivate_locked_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139out_free_secdata:
1140 free_secdata(secdata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141out:
David Howells454e2392006-06-23 02:02:57 -07001142 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143}
1144
Jan Kara5accdf82012-06-12 16:20:34 +02001145/*
1146 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1147 * instead.
1148 */
1149void __sb_end_write(struct super_block *sb, int level)
1150{
1151 percpu_counter_dec(&sb->s_writers.counter[level-1]);
1152 /*
1153 * Make sure s_writers are updated before we wake up waiters in
1154 * freeze_super().
1155 */
1156 smp_mb();
1157 if (waitqueue_active(&sb->s_writers.wait))
1158 wake_up(&sb->s_writers.wait);
1159 rwsem_release(&sb->s_writers.lock_map[level-1], 1, _RET_IP_);
1160}
1161EXPORT_SYMBOL(__sb_end_write);
1162
1163#ifdef CONFIG_LOCKDEP
1164/*
1165 * We want lockdep to tell us about possible deadlocks with freezing but
1166 * it's it bit tricky to properly instrument it. Getting a freeze protection
1167 * works as getting a read lock but there are subtle problems. XFS for example
1168 * gets freeze protection on internal level twice in some cases, which is OK
1169 * only because we already hold a freeze protection also on higher level. Due
1170 * to these cases we have to tell lockdep we are doing trylock when we
1171 * already hold a freeze protection for a higher freeze level.
1172 */
1173static void acquire_freeze_lock(struct super_block *sb, int level, bool trylock,
1174 unsigned long ip)
1175{
1176 int i;
1177
1178 if (!trylock) {
1179 for (i = 0; i < level - 1; i++)
1180 if (lock_is_held(&sb->s_writers.lock_map[i])) {
1181 trylock = true;
1182 break;
1183 }
1184 }
1185 rwsem_acquire_read(&sb->s_writers.lock_map[level-1], 0, trylock, ip);
1186}
1187#endif
1188
1189/*
1190 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1191 * instead.
1192 */
1193int __sb_start_write(struct super_block *sb, int level, bool wait)
1194{
1195retry:
1196 if (unlikely(sb->s_writers.frozen >= level)) {
1197 if (!wait)
1198 return 0;
1199 wait_event(sb->s_writers.wait_unfrozen,
1200 sb->s_writers.frozen < level);
1201 }
1202
1203#ifdef CONFIG_LOCKDEP
1204 acquire_freeze_lock(sb, level, !wait, _RET_IP_);
1205#endif
1206 percpu_counter_inc(&sb->s_writers.counter[level-1]);
1207 /*
1208 * Make sure counter is updated before we check for frozen.
1209 * freeze_super() first sets frozen and then checks the counter.
1210 */
1211 smp_mb();
1212 if (unlikely(sb->s_writers.frozen >= level)) {
1213 __sb_end_write(sb, level);
1214 goto retry;
1215 }
1216 return 1;
1217}
1218EXPORT_SYMBOL(__sb_start_write);
1219
1220/**
1221 * sb_wait_write - wait until all writers to given file system finish
1222 * @sb: the super for which we wait
1223 * @level: type of writers we wait for (normal vs page fault)
1224 *
1225 * This function waits until there are no writers of given type to given file
1226 * system. Caller of this function should make sure there can be no new writers
1227 * of type @level before calling this function. Otherwise this function can
1228 * livelock.
1229 */
1230static void sb_wait_write(struct super_block *sb, int level)
1231{
1232 s64 writers;
1233
1234 /*
1235 * We just cycle-through lockdep here so that it does not complain
1236 * about returning with lock to userspace
1237 */
1238 rwsem_acquire(&sb->s_writers.lock_map[level-1], 0, 0, _THIS_IP_);
1239 rwsem_release(&sb->s_writers.lock_map[level-1], 1, _THIS_IP_);
1240
1241 do {
1242 DEFINE_WAIT(wait);
1243
1244 /*
1245 * We use a barrier in prepare_to_wait() to separate setting
1246 * of frozen and checking of the counter
1247 */
1248 prepare_to_wait(&sb->s_writers.wait, &wait,
1249 TASK_UNINTERRUPTIBLE);
1250
1251 writers = percpu_counter_sum(&sb->s_writers.counter[level-1]);
1252 if (writers)
1253 schedule();
1254
1255 finish_wait(&sb->s_writers.wait, &wait);
1256 } while (writers);
1257}
1258
Josef Bacik18e9e512010-03-23 10:34:56 -04001259/**
Randy Dunlap7000d3c2010-05-24 22:22:34 -07001260 * freeze_super - lock the filesystem and force it into a consistent state
1261 * @sb: the super to lock
Josef Bacik18e9e512010-03-23 10:34:56 -04001262 *
1263 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1264 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1265 * -EBUSY.
Jan Kara5accdf82012-06-12 16:20:34 +02001266 *
1267 * During this function, sb->s_writers.frozen goes through these values:
1268 *
1269 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1270 *
1271 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1272 * writes should be blocked, though page faults are still allowed. We wait for
1273 * all writes to complete and then proceed to the next stage.
1274 *
1275 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1276 * but internal fs threads can still modify the filesystem (although they
1277 * should not dirty new pages or inodes), writeback can run etc. After waiting
1278 * for all running page faults we sync the filesystem which will clean all
1279 * dirty pages and inodes (no new dirty pages or inodes can be created when
1280 * sync is running).
1281 *
1282 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1283 * modification are blocked (e.g. XFS preallocation truncation on inode
1284 * reclaim). This is usually implemented by blocking new transactions for
1285 * filesystems that have them and need this additional guard. After all
1286 * internal writers are finished we call ->freeze_fs() to finish filesystem
1287 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1288 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1289 *
1290 * sb->s_writers.frozen is protected by sb->s_umount.
Josef Bacik18e9e512010-03-23 10:34:56 -04001291 */
1292int freeze_super(struct super_block *sb)
1293{
1294 int ret;
1295
1296 atomic_inc(&sb->s_active);
1297 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001298 if (sb->s_writers.frozen != SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001299 deactivate_locked_super(sb);
1300 return -EBUSY;
1301 }
1302
Al Virodabe0dc2012-01-03 21:01:29 -05001303 if (!(sb->s_flags & MS_BORN)) {
1304 up_write(&sb->s_umount);
1305 return 0; /* sic - it's "nothing to do" */
1306 }
1307
Josef Bacik18e9e512010-03-23 10:34:56 -04001308 if (sb->s_flags & MS_RDONLY) {
Jan Kara5accdf82012-06-12 16:20:34 +02001309 /* Nothing to do really... */
1310 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001311 up_write(&sb->s_umount);
1312 return 0;
1313 }
1314
Jan Kara5accdf82012-06-12 16:20:34 +02001315 /* From now on, no new normal writers can start */
1316 sb->s_writers.frozen = SB_FREEZE_WRITE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001317 smp_wmb();
1318
Jan Kara5accdf82012-06-12 16:20:34 +02001319 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1320 up_write(&sb->s_umount);
1321
1322 sb_wait_write(sb, SB_FREEZE_WRITE);
1323
1324 /* Now we go and block page faults... */
1325 down_write(&sb->s_umount);
1326 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
1327 smp_wmb();
1328
1329 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1330
1331 /* All writers are done so after syncing there won't be dirty data */
Josef Bacik18e9e512010-03-23 10:34:56 -04001332 sync_filesystem(sb);
1333
Jan Kara5accdf82012-06-12 16:20:34 +02001334 /* Now wait for internal filesystem counter */
1335 sb->s_writers.frozen = SB_FREEZE_FS;
Josef Bacik18e9e512010-03-23 10:34:56 -04001336 smp_wmb();
Jan Kara5accdf82012-06-12 16:20:34 +02001337 sb_wait_write(sb, SB_FREEZE_FS);
Josef Bacik18e9e512010-03-23 10:34:56 -04001338
Josef Bacik18e9e512010-03-23 10:34:56 -04001339 if (sb->s_op->freeze_fs) {
1340 ret = sb->s_op->freeze_fs(sb);
1341 if (ret) {
1342 printk(KERN_ERR
1343 "VFS:Filesystem freeze failed\n");
Jan Kara5accdf82012-06-12 16:20:34 +02001344 sb->s_writers.frozen = SB_UNFROZEN;
Kazuya Mioe1616302011-12-01 16:51:07 +09001345 smp_wmb();
Jan Kara5accdf82012-06-12 16:20:34 +02001346 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001347 deactivate_locked_super(sb);
1348 return ret;
1349 }
1350 }
Jan Kara5accdf82012-06-12 16:20:34 +02001351 /*
1352 * This is just for debugging purposes so that fs can warn if it
1353 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
1354 */
1355 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001356 up_write(&sb->s_umount);
1357 return 0;
1358}
1359EXPORT_SYMBOL(freeze_super);
1360
1361/**
1362 * thaw_super -- unlock filesystem
1363 * @sb: the super to thaw
1364 *
1365 * Unlocks the filesystem and marks it writeable again after freeze_super().
1366 */
1367int thaw_super(struct super_block *sb)
1368{
1369 int error;
1370
1371 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001372 if (sb->s_writers.frozen == SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001373 up_write(&sb->s_umount);
1374 return -EINVAL;
1375 }
1376
1377 if (sb->s_flags & MS_RDONLY)
1378 goto out;
1379
1380 if (sb->s_op->unfreeze_fs) {
1381 error = sb->s_op->unfreeze_fs(sb);
1382 if (error) {
1383 printk(KERN_ERR
1384 "VFS:Filesystem thaw failed\n");
Josef Bacik18e9e512010-03-23 10:34:56 -04001385 up_write(&sb->s_umount);
1386 return error;
1387 }
1388 }
1389
1390out:
Jan Kara5accdf82012-06-12 16:20:34 +02001391 sb->s_writers.frozen = SB_UNFROZEN;
Josef Bacik18e9e512010-03-23 10:34:56 -04001392 smp_wmb();
Jan Kara5accdf82012-06-12 16:20:34 +02001393 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001394 deactivate_locked_super(sb);
1395
1396 return 0;
1397}
1398EXPORT_SYMBOL(thaw_super);