blob: c808183554a22b16fbdce88293c4ffa9b2f03933 [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);
193 INIT_LIST_HEAD(&s->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500194 spin_lock_init(&s->s_inode_list_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400195
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800196 if (list_lru_init_memcg(&s->s_dentry_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400197 goto fail;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800198 if (list_lru_init_memcg(&s->s_inode_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400199 goto fail;
200
Al Viro7eb5e882013-10-01 15:09:58 -0400201 init_rwsem(&s->s_umount);
202 lockdep_set_class(&s->s_umount, &type->s_umount_key);
203 /*
204 * sget() can have s_umount recursion.
205 *
206 * When it cannot find a suitable sb, it allocates a new
207 * one (this one), and tries again to find a suitable old
208 * one.
209 *
210 * In case that succeeds, it will acquire the s_umount
211 * lock of the old one. Since these are clearly distrinct
212 * locks, and this object isn't exposed yet, there's no
213 * risk of deadlocks.
214 *
215 * Annotate this by putting this lock in a different
216 * subclass.
217 */
218 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
219 s->s_count = 1;
220 atomic_set(&s->s_active, 1);
221 mutex_init(&s->s_vfs_rename_mutex);
222 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
223 mutex_init(&s->s_dquot.dqio_mutex);
224 mutex_init(&s->s_dquot.dqonoff_mutex);
Al Viro7eb5e882013-10-01 15:09:58 -0400225 s->s_maxbytes = MAX_NON_LFS;
226 s->s_op = &default_op;
227 s->s_time_gran = 1000000000;
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700228 s->cleancache_poolid = CLEANCACHE_NO_POOL;
Al Viro7eb5e882013-10-01 15:09:58 -0400229
230 s->s_shrink.seeks = DEFAULT_SEEKS;
231 s->s_shrink.scan_objects = super_cache_scan;
232 s->s_shrink.count_objects = super_cache_count;
233 s->s_shrink.batch = 1024;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800234 s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 return s;
Glauber Costa5ca302c2013-08-28 10:18:18 +1000236
Al Viro7eb5e882013-10-01 15:09:58 -0400237fail:
238 destroy_super(s);
239 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240}
241
242/* Superblock refcounting */
243
244/*
Al Viro35cf7ba2010-03-22 21:13:53 -0400245 * Drop a superblock's refcount. The caller must hold sb_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 */
Al Virof47ec3f2011-11-21 21:15:42 -0500247static void __put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 if (!--sb->s_count) {
Al Viro551de6f2010-03-22 19:36:35 -0400250 list_del_init(&sb->s_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 destroy_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
254
255/**
256 * put_super - drop a temporary reference to superblock
257 * @sb: superblock in question
258 *
259 * Drops a temporary reference, frees superblock if there's no
260 * references left.
261 */
Al Virof47ec3f2011-11-21 21:15:42 -0500262static void put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263{
264 spin_lock(&sb_lock);
265 __put_super(sb);
266 spin_unlock(&sb_lock);
267}
268
269
270/**
Al Viro74dbbdd2009-05-06 01:07:50 -0400271 * deactivate_locked_super - drop an active reference to superblock
272 * @s: superblock to deactivate
273 *
Al Viro1712ac82010-03-22 15:22:31 -0400274 * Drops an active reference to superblock, converting it into a temprory
275 * one if there is no other active references left. In that case we
276 * tell fs driver to shut it down and drop the temporary reference we
277 * had just acquired.
278 *
279 * Caller holds exclusive lock on superblock; that lock is released.
Al Viro74dbbdd2009-05-06 01:07:50 -0400280 */
281void deactivate_locked_super(struct super_block *s)
282{
283 struct file_system_type *fs = s->s_type;
Al Virob20bd1a2010-03-22 08:53:19 -0400284 if (atomic_dec_and_test(&s->s_active)) {
Dan Magenheimer31677602011-09-21 11:56:28 -0400285 cleancache_invalidate_fs(s);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000286 unregister_shrinker(&s->s_shrink);
Dave Chinner28f2cd4f2014-06-04 16:10:46 -0700287 fs->kill_sb(s);
Glauber Costaf5e1dd32013-08-28 10:18:18 +1000288
Vladimir Davydovc0a5b562015-02-12 14:59:07 -0800289 /*
290 * Since list_lru_destroy() may sleep, we cannot call it from
291 * put_super(), where we hold the sb_lock. Therefore we destroy
292 * the lru lists right now.
293 */
294 list_lru_destroy(&s->s_dentry_lru);
295 list_lru_destroy(&s->s_inode_lru);
296
Al Viro74dbbdd2009-05-06 01:07:50 -0400297 put_filesystem(fs);
298 put_super(s);
299 } else {
300 up_write(&s->s_umount);
301 }
302}
303
304EXPORT_SYMBOL(deactivate_locked_super);
305
306/**
Al Viro1712ac82010-03-22 15:22:31 -0400307 * deactivate_super - drop an active reference to superblock
308 * @s: superblock to deactivate
309 *
310 * Variant of deactivate_locked_super(), except that superblock is *not*
311 * locked by caller. If we are going to drop the final active reference,
312 * lock will be acquired prior to that.
313 */
314void deactivate_super(struct super_block *s)
315{
316 if (!atomic_add_unless(&s->s_active, -1, 1)) {
317 down_write(&s->s_umount);
318 deactivate_locked_super(s);
319 }
320}
321
322EXPORT_SYMBOL(deactivate_super);
323
324/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 * grab_super - acquire an active reference
326 * @s: reference we are trying to make active
327 *
328 * Tries to acquire an active reference. grab_super() is used when we
329 * had just found a superblock in super_blocks or fs_type->fs_supers
330 * and want to turn it into a full-blown active reference. grab_super()
331 * is called with sb_lock held and drops it. Returns 1 in case of
332 * success, 0 if we had failed (superblock contents was already dead or
Al Viroacfec9a2013-07-20 03:13:55 +0400333 * dying when grab_super() had been called). Note that this is only
334 * called for superblocks not in rundown mode (== ones still on ->fs_supers
335 * of their type), so increment of ->s_count is OK here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 */
Josh Triplett9c4dbee2006-09-29 01:59:29 -0700337static int grab_super(struct super_block *s) __releases(sb_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338{
339 s->s_count++;
340 spin_unlock(&sb_lock);
341 down_write(&s->s_umount);
Al Viroacfec9a2013-07-20 03:13:55 +0400342 if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
343 put_super(s);
344 return 1;
345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 up_write(&s->s_umount);
347 put_super(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 return 0;
349}
350
David Howellscf9a2ae2006-08-29 19:05:54 +0100351/*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300352 * trylock_super - try to grab ->s_umount shared
Wanpeng Li331cbde2012-06-09 11:10:55 +0800353 * @sb: reference we are trying to grab
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000354 *
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300355 * Try to prevent fs shutdown. This is used in places where we
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000356 * cannot take an active reference but we need to ensure that the
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300357 * filesystem is not shut down while we are working on it. It returns
358 * false if we cannot acquire s_umount or if we lose the race and
359 * filesystem already got into shutdown, and returns true with the s_umount
360 * lock held in read mode in case of success. On successful return,
361 * the caller must drop the s_umount lock when done.
362 *
363 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
364 * The reason why it's safe is that we are OK with doing trylock instead
365 * of down_read(). There's a couple of places that are OK with that, but
366 * it's very much not a general-purpose interface.
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000367 */
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300368bool trylock_super(struct super_block *sb)
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000369{
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000370 if (down_read_trylock(&sb->s_umount)) {
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300371 if (!hlist_unhashed(&sb->s_instances) &&
372 sb->s_root && (sb->s_flags & MS_BORN))
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000373 return true;
374 up_read(&sb->s_umount);
375 }
376
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000377 return false;
378}
379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380/**
381 * generic_shutdown_super - common helper for ->kill_sb()
382 * @sb: superblock to kill
383 *
384 * generic_shutdown_super() does all fs-independent work on superblock
385 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
386 * that need destruction out of superblock, call generic_shutdown_super()
387 * and release aforementioned objects. Note: dentries and inodes _are_
388 * taken care of and do not need specific handling.
David Howellsc636ebd2006-10-11 01:22:19 -0700389 *
390 * Upon calling this function, the filesystem may no longer alter or
391 * rearrange the set of dentries belonging to this super_block, nor may it
392 * change the attachments of dentries to inodes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 */
394void generic_shutdown_super(struct super_block *sb)
395{
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800396 const struct super_operations *sop = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
David Howellsc636ebd2006-10-11 01:22:19 -0700398 if (sb->s_root) {
399 shrink_dcache_for_umount(sb);
Jan Kara60b06802009-04-27 16:43:53 +0200400 sync_filesystem(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 sb->s_flags &= ~MS_ACTIVE;
Arjan van de Venefaee192009-01-06 07:20:54 -0800402
Dave Chinner74278da2015-03-04 12:37:22 -0500403 fsnotify_unmount_inodes(sb);
Al Viro63997e92010-10-25 20:49:35 -0400404
405 evict_inodes(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200407 if (sb->s_dio_done_wq) {
408 destroy_workqueue(sb->s_dio_done_wq);
409 sb->s_dio_done_wq = NULL;
410 }
411
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 if (sop->put_super)
413 sop->put_super(sb);
414
Al Viro63997e92010-10-25 20:49:35 -0400415 if (!list_empty(&sb->s_inodes)) {
Dave Jones7b4fe292006-02-07 12:58:48 -0800416 printk("VFS: Busy inodes after unmount of %s. "
417 "Self-destruct in 5 seconds. Have a nice day...\n",
418 sb->s_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 }
421 spin_lock(&sb_lock);
422 /* should be initialized for __put_super_and_need_restart() */
Al Viroa5166162011-12-12 22:53:00 -0500423 hlist_del_init(&sb->s_instances);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 spin_unlock(&sb_lock);
425 up_write(&sb->s_umount);
426}
427
428EXPORT_SYMBOL(generic_shutdown_super);
429
430/**
431 * sget - find or create a superblock
432 * @type: filesystem type superblock should belong to
433 * @test: comparison callback
434 * @set: setup callback
David Howells9249e172012-06-25 12:55:37 +0100435 * @flags: mount flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 * @data: argument to each of them
437 */
438struct super_block *sget(struct file_system_type *type,
439 int (*test)(struct super_block *,void *),
440 int (*set)(struct super_block *,void *),
David Howells9249e172012-06-25 12:55:37 +0100441 int flags,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 void *data)
443{
444 struct super_block *s = NULL;
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700445 struct super_block *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 int err;
447
448retry:
449 spin_lock(&sb_lock);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700450 if (test) {
Sasha Levinb67bfe02013-02-27 17:06:00 -0800451 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700452 if (!test(old, data))
453 continue;
454 if (!grab_super(old))
455 goto retry;
Li Zefana3cfbb52009-03-12 14:31:29 -0700456 if (s) {
457 up_write(&s->s_umount);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700458 destroy_super(s);
Al Viro7a4dec52010-08-09 12:05:43 -0400459 s = NULL;
Li Zefana3cfbb52009-03-12 14:31:29 -0700460 }
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700461 return old;
462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 }
464 if (!s) {
465 spin_unlock(&sb_lock);
David Howells9249e172012-06-25 12:55:37 +0100466 s = alloc_super(type, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 if (!s)
468 return ERR_PTR(-ENOMEM);
469 goto retry;
470 }
471
472 err = set(s, data);
473 if (err) {
474 spin_unlock(&sb_lock);
Li Zefana3cfbb52009-03-12 14:31:29 -0700475 up_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 destroy_super(s);
477 return ERR_PTR(err);
478 }
479 s->s_type = type;
480 strlcpy(s->s_id, type->name, sizeof(s->s_id));
481 list_add_tail(&s->s_list, &super_blocks);
Al Viroa5166162011-12-12 22:53:00 -0500482 hlist_add_head(&s->s_instances, &type->fs_supers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 spin_unlock(&sb_lock);
484 get_filesystem(type);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000485 register_shrinker(&s->s_shrink);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 return s;
487}
488
489EXPORT_SYMBOL(sget);
490
491void drop_super(struct super_block *sb)
492{
493 up_read(&sb->s_umount);
494 put_super(sb);
495}
496
497EXPORT_SYMBOL(drop_super);
498
Christoph Hellwige5004752009-05-05 16:08:56 +0200499/**
Al Viro01a05b32010-03-23 06:06:58 -0400500 * iterate_supers - call function for all active superblocks
501 * @f: function to call
502 * @arg: argument to pass to it
503 *
504 * Scans the superblock list and calls given function, passing it
505 * locked superblock and given argument.
506 */
507void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
508{
Al Virodca33252010-07-25 02:31:46 +0400509 struct super_block *sb, *p = NULL;
Al Viro01a05b32010-03-23 06:06:58 -0400510
511 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400512 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500513 if (hlist_unhashed(&sb->s_instances))
Al Viro01a05b32010-03-23 06:06:58 -0400514 continue;
515 sb->s_count++;
516 spin_unlock(&sb_lock);
517
518 down_read(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500519 if (sb->s_root && (sb->s_flags & MS_BORN))
Al Viro01a05b32010-03-23 06:06:58 -0400520 f(sb, arg);
521 up_read(&sb->s_umount);
522
523 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400524 if (p)
525 __put_super(p);
526 p = sb;
Al Viro01a05b32010-03-23 06:06:58 -0400527 }
Al Virodca33252010-07-25 02:31:46 +0400528 if (p)
529 __put_super(p);
Al Viro01a05b32010-03-23 06:06:58 -0400530 spin_unlock(&sb_lock);
531}
532
533/**
Al Viro43e15cd2011-06-03 20:16:57 -0400534 * iterate_supers_type - call function for superblocks of given type
535 * @type: fs type
536 * @f: function to call
537 * @arg: argument to pass to it
538 *
539 * Scans the superblock list and calls given function, passing it
540 * locked superblock and given argument.
541 */
542void iterate_supers_type(struct file_system_type *type,
543 void (*f)(struct super_block *, void *), void *arg)
544{
545 struct super_block *sb, *p = NULL;
546
547 spin_lock(&sb_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800548 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
Al Viro43e15cd2011-06-03 20:16:57 -0400549 sb->s_count++;
550 spin_unlock(&sb_lock);
551
552 down_read(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500553 if (sb->s_root && (sb->s_flags & MS_BORN))
Al Viro43e15cd2011-06-03 20:16:57 -0400554 f(sb, arg);
555 up_read(&sb->s_umount);
556
557 spin_lock(&sb_lock);
558 if (p)
559 __put_super(p);
560 p = sb;
561 }
562 if (p)
563 __put_super(p);
564 spin_unlock(&sb_lock);
565}
566
567EXPORT_SYMBOL(iterate_supers_type);
568
569/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 * get_super - get the superblock of a device
571 * @bdev: device to get the superblock for
572 *
573 * Scans the superblock list and finds the superblock of the file system
574 * mounted on the device given. %NULL is returned if no match is found.
575 */
576
Al Virodf40c012010-03-22 20:23:25 -0400577struct super_block *get_super(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700579 struct super_block *sb;
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 if (!bdev)
582 return NULL;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700583
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700585rescan:
586 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500587 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400588 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700589 if (sb->s_bdev == bdev) {
590 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700592 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400593 /* still alive? */
Al Virodabe0dc2012-01-03 21:01:29 -0500594 if (sb->s_root && (sb->s_flags & MS_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700595 return sb;
596 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400597 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700598 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400599 __put_super(sb);
600 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 }
602 }
603 spin_unlock(&sb_lock);
604 return NULL;
605}
606
607EXPORT_SYMBOL(get_super);
Christoph Hellwig45042302009-08-03 23:28:35 +0200608
609/**
Jan Kara6b6dc832012-02-10 11:03:00 +0100610 * get_super_thawed - get thawed superblock of a device
611 * @bdev: device to get the superblock for
612 *
613 * Scans the superblock list and finds the superblock of the file system
614 * mounted on the device. The superblock is returned once it is thawed
615 * (or immediately if it was not frozen). %NULL is returned if no match
616 * is found.
617 */
618struct super_block *get_super_thawed(struct block_device *bdev)
619{
620 while (1) {
621 struct super_block *s = get_super(bdev);
Jan Kara5accdf82012-06-12 16:20:34 +0200622 if (!s || s->s_writers.frozen == SB_UNFROZEN)
Jan Kara6b6dc832012-02-10 11:03:00 +0100623 return s;
624 up_read(&s->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +0200625 wait_event(s->s_writers.wait_unfrozen,
626 s->s_writers.frozen == SB_UNFROZEN);
Jan Kara6b6dc832012-02-10 11:03:00 +0100627 put_super(s);
628 }
629}
630EXPORT_SYMBOL(get_super_thawed);
631
632/**
Christoph Hellwig45042302009-08-03 23:28:35 +0200633 * get_active_super - get an active reference to the superblock of a device
634 * @bdev: device to get the superblock for
635 *
636 * Scans the superblock list and finds the superblock of the file system
637 * mounted on the device given. Returns the superblock with an active
Al Virod3f21472010-03-23 11:11:05 -0400638 * reference or %NULL if none was found.
Christoph Hellwig45042302009-08-03 23:28:35 +0200639 */
640struct super_block *get_active_super(struct block_device *bdev)
641{
642 struct super_block *sb;
643
644 if (!bdev)
645 return NULL;
646
Al Viro14945832010-03-22 20:15:33 -0400647restart:
Christoph Hellwig45042302009-08-03 23:28:35 +0200648 spin_lock(&sb_lock);
649 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500650 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400651 continue;
Al Viro14945832010-03-22 20:15:33 -0400652 if (sb->s_bdev == bdev) {
Al Viroacfec9a2013-07-20 03:13:55 +0400653 if (!grab_super(sb))
Al Viro14945832010-03-22 20:15:33 -0400654 goto restart;
Al Viroacfec9a2013-07-20 03:13:55 +0400655 up_write(&sb->s_umount);
656 return sb;
Al Viro14945832010-03-22 20:15:33 -0400657 }
Christoph Hellwig45042302009-08-03 23:28:35 +0200658 }
659 spin_unlock(&sb_lock);
660 return NULL;
661}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Al Virodf40c012010-03-22 20:23:25 -0400663struct super_block *user_get_super(dev_t dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700665 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700668rescan:
669 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500670 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400671 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700672 if (sb->s_dev == dev) {
673 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700675 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400676 /* still alive? */
Al Virodabe0dc2012-01-03 21:01:29 -0500677 if (sb->s_root && (sb->s_flags & MS_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700678 return sb;
679 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400680 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700681 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400682 __put_super(sb);
683 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 }
685 }
686 spin_unlock(&sb_lock);
687 return NULL;
688}
689
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 * do_remount_sb - asks filesystem to change mount options.
692 * @sb: superblock in question
693 * @flags: numeric part of options
694 * @data: the rest of options
695 * @force: whether or not to force the change
696 *
697 * Alters the mount options of a mounted file system.
698 */
699int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
700{
701 int retval;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400702 int remount_ro;
Christoph Hellwig45042302009-08-03 23:28:35 +0200703
Jan Kara5accdf82012-06-12 16:20:34 +0200704 if (sb->s_writers.frozen != SB_UNFROZEN)
Christoph Hellwig45042302009-08-03 23:28:35 +0200705 return -EBUSY;
706
David Howells93614012006-09-30 20:45:40 +0200707#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
709 return -EACCES;
David Howells93614012006-09-30 20:45:40 +0200710#endif
Christoph Hellwig45042302009-08-03 23:28:35 +0200711
Nick Piggind208bbd2009-12-21 16:28:53 -0800712 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
Nick Piggind208bbd2009-12-21 16:28:53 -0800713
Al Viro0aec09d2014-08-07 07:32:06 -0400714 if (remount_ro) {
Al Virofdab6842015-01-11 10:57:27 -0500715 if (!hlist_empty(&sb->s_pins)) {
Al Viro0aec09d2014-08-07 07:32:06 -0400716 up_write(&sb->s_umount);
Al Virofdab6842015-01-11 10:57:27 -0500717 group_pin_kill(&sb->s_pins);
Al Viro0aec09d2014-08-07 07:32:06 -0400718 down_write(&sb->s_umount);
719 if (!sb->s_root)
720 return 0;
721 if (sb->s_writers.frozen != SB_UNFROZEN)
722 return -EBUSY;
723 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
724 }
725 }
726 shrink_dcache_sb(sb);
727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 /* If we are remounting RDONLY and current sb is read/write,
729 make sure there are no rw files opened */
Nick Piggind208bbd2009-12-21 16:28:53 -0800730 if (remount_ro) {
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100731 if (force) {
Al Viroeee5cc22013-10-04 11:06:42 -0400732 sb->s_readonly_remount = 1;
733 smp_wmb();
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100734 } else {
735 retval = sb_prepare_remount_readonly(sb);
736 if (retval)
737 return retval;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100738 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 }
740
741 if (sb->s_op->remount_fs) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 retval = sb->s_op->remount_fs(sb, &flags, data);
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200743 if (retval) {
744 if (!force)
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100745 goto cancel_readonly;
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200746 /* If forced remount, go ahead despite any errors */
747 WARN(1, "forced remount of a %s fs returned %i\n",
748 sb->s_type->name, retval);
749 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
751 sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100752 /* Needs to be ordered wrt mnt_is_readonly() */
753 smp_wmb();
754 sb->s_readonly_remount = 0;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400755
Nick Piggind208bbd2009-12-21 16:28:53 -0800756 /*
757 * Some filesystems modify their metadata via some other path than the
758 * bdev buffer cache (eg. use a private mapping, or directories in
759 * pagecache, etc). Also file data modifications go via their own
760 * mappings. So If we try to mount readonly then copy the filesystem
761 * from bdev, we could get stale data, so invalidate it to give a best
762 * effort at coherency.
763 */
764 if (remount_ro && sb->s_bdev)
765 invalidate_bdev(sb->s_bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 return 0;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100767
768cancel_readonly:
769 sb->s_readonly_remount = 0;
770 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771}
772
Jens Axboea2a95372009-03-17 09:38:40 +0100773static void do_emergency_remount(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774{
Al Virodca33252010-07-25 02:31:46 +0400775 struct super_block *sb, *p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
777 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400778 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500779 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400780 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 sb->s_count++;
782 spin_unlock(&sb_lock);
Al Viro443b94b2009-05-05 23:48:50 -0400783 down_write(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500784 if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
785 !(sb->s_flags & MS_RDONLY)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 * What lock protects sb->s_flags??
788 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 do_remount_sb(sb, MS_RDONLY, NULL, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 }
Al Viro443b94b2009-05-05 23:48:50 -0400791 up_write(&sb->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400793 if (p)
794 __put_super(p);
795 p = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 }
Al Virodca33252010-07-25 02:31:46 +0400797 if (p)
798 __put_super(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 spin_unlock(&sb_lock);
Jens Axboea2a95372009-03-17 09:38:40 +0100800 kfree(work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 printk("Emergency Remount complete\n");
802}
803
804void emergency_remount(void)
805{
Jens Axboea2a95372009-03-17 09:38:40 +0100806 struct work_struct *work;
807
808 work = kmalloc(sizeof(*work), GFP_ATOMIC);
809 if (work) {
810 INIT_WORK(work, do_emergency_remount);
811 schedule_work(work);
812 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813}
814
815/*
816 * Unnamed block devices are dummy devices used by virtual
817 * filesystems which don't use real block-devices. -- jrs
818 */
819
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400820static DEFINE_IDA(unnamed_dev_ida);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
Thomas Bächlera2a4dc42014-04-03 21:55:37 +0200822/* Many userspace utilities consider an FSID of 0 invalid.
823 * Always return at least 1 from get_anon_bdev.
824 */
825static int unnamed_dev_start = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Al Viro0ee5dc62011-07-07 15:44:25 -0400827int get_anon_bdev(dev_t *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828{
829 int dev;
830 int error;
831
832 retry:
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400833 if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 return -ENOMEM;
835 spin_lock(&unnamed_dev_lock);
Al Viroc63e09e2009-06-24 02:05:18 -0400836 error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
Al Virof21f6222009-06-24 03:12:00 -0400837 if (!error)
838 unnamed_dev_start = dev + 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 spin_unlock(&unnamed_dev_lock);
840 if (error == -EAGAIN)
841 /* We raced and lost with another CPU. */
842 goto retry;
843 else if (error)
844 return -EAGAIN;
845
Wang YanQing1af95de2015-06-23 18:54:45 +0800846 if (dev >= (1 << MINORBITS)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 spin_lock(&unnamed_dev_lock);
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400848 ida_remove(&unnamed_dev_ida, dev);
Al Virof21f6222009-06-24 03:12:00 -0400849 if (unnamed_dev_start > dev)
850 unnamed_dev_start = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 spin_unlock(&unnamed_dev_lock);
852 return -EMFILE;
853 }
Al Viro0ee5dc62011-07-07 15:44:25 -0400854 *p = MKDEV(0, dev & MINORMASK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 return 0;
856}
Al Viro0ee5dc62011-07-07 15:44:25 -0400857EXPORT_SYMBOL(get_anon_bdev);
858
859void free_anon_bdev(dev_t dev)
860{
861 int slot = MINOR(dev);
862 spin_lock(&unnamed_dev_lock);
863 ida_remove(&unnamed_dev_ida, slot);
864 if (slot < unnamed_dev_start)
865 unnamed_dev_start = slot;
866 spin_unlock(&unnamed_dev_lock);
867}
868EXPORT_SYMBOL(free_anon_bdev);
869
870int set_anon_super(struct super_block *s, void *data)
871{
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100872 return get_anon_bdev(&s->s_dev);
Al Viro0ee5dc62011-07-07 15:44:25 -0400873}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875EXPORT_SYMBOL(set_anon_super);
876
877void kill_anon_super(struct super_block *sb)
878{
Al Viro0ee5dc62011-07-07 15:44:25 -0400879 dev_t dev = sb->s_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 generic_shutdown_super(sb);
Al Viro0ee5dc62011-07-07 15:44:25 -0400881 free_anon_bdev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882}
883
884EXPORT_SYMBOL(kill_anon_super);
885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886void kill_litter_super(struct super_block *sb)
887{
888 if (sb->s_root)
889 d_genocide(sb->s_root);
890 kill_anon_super(sb);
891}
892
893EXPORT_SYMBOL(kill_litter_super);
894
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700895static int ns_test_super(struct super_block *sb, void *data)
896{
897 return sb->s_fs_info == data;
898}
899
900static int ns_set_super(struct super_block *sb, void *data)
901{
902 sb->s_fs_info = data;
903 return set_anon_super(sb, NULL);
904}
905
Al Viroceefda62010-07-26 13:16:50 +0400906struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
907 void *data, int (*fill_super)(struct super_block *, void *, int))
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700908{
909 struct super_block *sb;
910
David Howells9249e172012-06-25 12:55:37 +0100911 sb = sget(fs_type, ns_test_super, ns_set_super, flags, data);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700912 if (IS_ERR(sb))
Al Viroceefda62010-07-26 13:16:50 +0400913 return ERR_CAST(sb);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700914
915 if (!sb->s_root) {
916 int err;
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700917 err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
918 if (err) {
Al Viro74dbbdd2009-05-06 01:07:50 -0400919 deactivate_locked_super(sb);
Al Viroceefda62010-07-26 13:16:50 +0400920 return ERR_PTR(err);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700921 }
922
923 sb->s_flags |= MS_ACTIVE;
924 }
925
Al Viroceefda62010-07-26 13:16:50 +0400926 return dget(sb->s_root);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700927}
928
Al Viroceefda62010-07-26 13:16:50 +0400929EXPORT_SYMBOL(mount_ns);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700930
David Howells93614012006-09-30 20:45:40 +0200931#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932static int set_bdev_super(struct super_block *s, void *data)
933{
934 s->s_bdev = data;
935 s->s_dev = s->s_bdev->bd_dev;
Jens Axboe32a88aa2009-09-16 15:02:33 +0200936
937 /*
938 * We set the bdi here to the queue backing, file systems can
939 * overwrite this in ->fill_super()
940 */
941 s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 return 0;
943}
944
945static int test_bdev_super(struct super_block *s, void *data)
946{
947 return (void *)s->s_bdev == data;
948}
949
Al Viro152a0832010-07-25 00:46:55 +0400950struct dentry *mount_bdev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 int flags, const char *dev_name, void *data,
Al Viro152a0832010-07-25 00:46:55 +0400952 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953{
954 struct block_device *bdev;
955 struct super_block *s;
Tejun Heod4d77622010-11-13 11:55:18 +0100956 fmode_t mode = FMODE_READ | FMODE_EXCL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 int error = 0;
958
Al Viro30c40d22008-02-22 19:50:45 -0500959 if (!(flags & MS_RDONLY))
960 mode |= FMODE_WRITE;
961
Tejun Heod4d77622010-11-13 11:55:18 +0100962 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 if (IS_ERR(bdev))
Al Viro152a0832010-07-25 00:46:55 +0400964 return ERR_CAST(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966 /*
967 * once the super is inserted into the list by sget, s_umount
968 * will protect the lockfs code from trying to start a snapshot
969 * while we are mounting
970 */
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +0200971 mutex_lock(&bdev->bd_fsfreeze_mutex);
972 if (bdev->bd_fsfreeze_count > 0) {
973 mutex_unlock(&bdev->bd_fsfreeze_mutex);
974 error = -EBUSY;
975 goto error_bdev;
976 }
David Howells9249e172012-06-25 12:55:37 +0100977 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
978 bdev);
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +0200979 mutex_unlock(&bdev->bd_fsfreeze_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 if (IS_ERR(s))
David Howells454e2392006-06-23 02:02:57 -0700981 goto error_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
983 if (s->s_root) {
984 if ((flags ^ s->s_flags) & MS_RDONLY) {
Al Viro74dbbdd2009-05-06 01:07:50 -0400985 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -0700986 error = -EBUSY;
987 goto error_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 }
David Howells454e2392006-06-23 02:02:57 -0700989
Tejun Heo4f331f02010-07-20 15:18:07 -0700990 /*
991 * s_umount nests inside bd_mutex during
Tejun Heoe525fd82010-11-13 11:55:17 +0100992 * __invalidate_device(). blkdev_put() acquires
993 * bd_mutex and can't be called under s_umount. Drop
994 * s_umount temporarily. This is safe as we're
995 * holding an active reference.
Tejun Heo4f331f02010-07-20 15:18:07 -0700996 */
997 up_write(&s->s_umount);
Tejun Heod4d77622010-11-13 11:55:18 +0100998 blkdev_put(bdev, mode);
Tejun Heo4f331f02010-07-20 15:18:07 -0700999 down_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 } else {
1001 char b[BDEVNAME_SIZE];
1002
Al Viro30c40d22008-02-22 19:50:45 -05001003 s->s_mode = mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 strlcpy(s->s_id, bdevname(bdev, b), sizeof(s->s_id));
Pekka Enberge78c9a02006-01-08 01:03:39 -08001005 sb_set_blocksize(s, block_size(bdev));
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001006 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001008 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -07001009 goto error;
Greg Kroah-Hartmanfa675762006-02-22 09:39:02 -08001010 }
David Howells454e2392006-06-23 02:02:57 -07001011
1012 s->s_flags |= MS_ACTIVE;
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001013 bdev->bd_super = s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 }
1015
Al Viro152a0832010-07-25 00:46:55 +04001016 return dget(s->s_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001017
David Howells454e2392006-06-23 02:02:57 -07001018error_s:
1019 error = PTR_ERR(s);
1020error_bdev:
Tejun Heod4d77622010-11-13 11:55:18 +01001021 blkdev_put(bdev, mode);
David Howells454e2392006-06-23 02:02:57 -07001022error:
Al Viro152a0832010-07-25 00:46:55 +04001023 return ERR_PTR(error);
1024}
1025EXPORT_SYMBOL(mount_bdev);
1026
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027void kill_block_super(struct super_block *sb)
1028{
1029 struct block_device *bdev = sb->s_bdev;
Al Viro30c40d22008-02-22 19:50:45 -05001030 fmode_t mode = sb->s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
H Hartley Sweetenddbaaf32009-04-29 20:14:57 -04001032 bdev->bd_super = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 generic_shutdown_super(sb);
1034 sync_blockdev(bdev);
Tejun Heod4d77622010-11-13 11:55:18 +01001035 WARN_ON_ONCE(!(mode & FMODE_EXCL));
Tejun Heoe525fd82010-11-13 11:55:17 +01001036 blkdev_put(bdev, mode | FMODE_EXCL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037}
1038
1039EXPORT_SYMBOL(kill_block_super);
David Howells93614012006-09-30 20:45:40 +02001040#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
Al Viro3c26ff62010-07-25 11:46:36 +04001042struct dentry *mount_nodev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 int flags, void *data,
Al Viro3c26ff62010-07-25 11:46:36 +04001044 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045{
1046 int error;
David Howells9249e172012-06-25 12:55:37 +01001047 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
1049 if (IS_ERR(s))
Al Viro3c26ff62010-07-25 11:46:36 +04001050 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001052 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001054 deactivate_locked_super(s);
Al Viro3c26ff62010-07-25 11:46:36 +04001055 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
1057 s->s_flags |= MS_ACTIVE;
Al Viro3c26ff62010-07-25 11:46:36 +04001058 return dget(s->s_root);
1059}
1060EXPORT_SYMBOL(mount_nodev);
1061
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062static int compare_single(struct super_block *s, void *p)
1063{
1064 return 1;
1065}
1066
Al Virofc14f2f2010-07-25 01:48:30 +04001067struct dentry *mount_single(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 int flags, void *data,
Al Virofc14f2f2010-07-25 01:48:30 +04001069 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070{
1071 struct super_block *s;
1072 int error;
1073
David Howells9249e172012-06-25 12:55:37 +01001074 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075 if (IS_ERR(s))
Al Virofc14f2f2010-07-25 01:48:30 +04001076 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 if (!s->s_root) {
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001078 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001080 deactivate_locked_super(s);
Al Virofc14f2f2010-07-25 01:48:30 +04001081 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 }
1083 s->s_flags |= MS_ACTIVE;
Kay Sievers9329d1b2009-12-18 21:18:15 +01001084 } else {
1085 do_remount_sb(s, flags, data, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 }
Al Virofc14f2f2010-07-25 01:48:30 +04001087 return dget(s->s_root);
1088}
1089EXPORT_SYMBOL(mount_single);
1090
Al Viro9d412a42011-03-17 22:08:28 -04001091struct dentry *
1092mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093{
Al Viroc96e41e2010-07-25 00:17:56 +04001094 struct dentry *root;
Al Viro9d412a42011-03-17 22:08:28 -04001095 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 char *secdata = NULL;
Al Viro9d412a42011-03-17 22:08:28 -04001097 int error = -ENOMEM;
Al Viro80893522010-02-05 09:30:46 -05001098
Eric Parise0007522008-03-05 10:31:54 -05001099 if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 secdata = alloc_secdata();
David Howells454e2392006-06-23 02:02:57 -07001101 if (!secdata)
Al Viro9d412a42011-03-17 22:08:28 -04001102 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Eric Parise0007522008-03-05 10:31:54 -05001104 error = security_sb_copy_data(data, secdata);
David Howells454e2392006-06-23 02:02:57 -07001105 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 goto out_free_secdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 }
1108
Al Viro1a102ff2011-03-16 09:07:58 -04001109 root = type->mount(type, flags, name, data);
1110 if (IS_ERR(root)) {
1111 error = PTR_ERR(root);
1112 goto out_free_secdata;
Al Viroc96e41e2010-07-25 00:17:56 +04001113 }
Al Viro9d412a42011-03-17 22:08:28 -04001114 sb = root->d_sb;
1115 BUG_ON(!sb);
1116 WARN_ON(!sb->s_bdi);
1117 sb->s_flags |= MS_BORN;
David Howells454e2392006-06-23 02:02:57 -07001118
Al Viro9d412a42011-03-17 22:08:28 -04001119 error = security_sb_kern_mount(sb, flags, secdata);
Jörn Engel5129a462010-04-25 08:54:42 +02001120 if (error)
1121 goto out_sb;
David Howells454e2392006-06-23 02:02:57 -07001122
Jeff Layton42cb56a2009-09-18 13:05:53 -07001123 /*
1124 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1125 * but s_maxbytes was an unsigned long long for many releases. Throw
1126 * this warning for a little while to try and catch filesystems that
Jeff Layton4358b562011-03-29 09:33:31 -04001127 * violate this rule.
Jeff Layton42cb56a2009-09-18 13:05:53 -07001128 */
Al Viro9d412a42011-03-17 22:08:28 -04001129 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1130 "negative value (%lld)\n", type->name, sb->s_maxbytes);
Jeff Layton42cb56a2009-09-18 13:05:53 -07001131
Al Viro9d412a42011-03-17 22:08:28 -04001132 up_write(&sb->s_umount);
Gerald Schaefer8680e222005-06-21 17:15:16 -07001133 free_secdata(secdata);
Al Viro9d412a42011-03-17 22:08:28 -04001134 return root;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135out_sb:
Al Viro9d412a42011-03-17 22:08:28 -04001136 dput(root);
1137 deactivate_locked_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138out_free_secdata:
1139 free_secdata(secdata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140out:
David Howells454e2392006-06-23 02:02:57 -07001141 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142}
1143
Jan Kara5accdf82012-06-12 16:20:34 +02001144/*
1145 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1146 * instead.
1147 */
1148void __sb_end_write(struct super_block *sb, int level)
1149{
1150 percpu_counter_dec(&sb->s_writers.counter[level-1]);
1151 /*
1152 * Make sure s_writers are updated before we wake up waiters in
1153 * freeze_super().
1154 */
1155 smp_mb();
1156 if (waitqueue_active(&sb->s_writers.wait))
1157 wake_up(&sb->s_writers.wait);
1158 rwsem_release(&sb->s_writers.lock_map[level-1], 1, _RET_IP_);
1159}
1160EXPORT_SYMBOL(__sb_end_write);
1161
1162#ifdef CONFIG_LOCKDEP
1163/*
1164 * We want lockdep to tell us about possible deadlocks with freezing but
1165 * it's it bit tricky to properly instrument it. Getting a freeze protection
1166 * works as getting a read lock but there are subtle problems. XFS for example
1167 * gets freeze protection on internal level twice in some cases, which is OK
1168 * only because we already hold a freeze protection also on higher level. Due
1169 * to these cases we have to tell lockdep we are doing trylock when we
1170 * already hold a freeze protection for a higher freeze level.
1171 */
1172static void acquire_freeze_lock(struct super_block *sb, int level, bool trylock,
1173 unsigned long ip)
1174{
1175 int i;
1176
1177 if (!trylock) {
1178 for (i = 0; i < level - 1; i++)
1179 if (lock_is_held(&sb->s_writers.lock_map[i])) {
1180 trylock = true;
1181 break;
1182 }
1183 }
1184 rwsem_acquire_read(&sb->s_writers.lock_map[level-1], 0, trylock, ip);
1185}
1186#endif
1187
1188/*
1189 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1190 * instead.
1191 */
1192int __sb_start_write(struct super_block *sb, int level, bool wait)
1193{
1194retry:
1195 if (unlikely(sb->s_writers.frozen >= level)) {
1196 if (!wait)
1197 return 0;
1198 wait_event(sb->s_writers.wait_unfrozen,
1199 sb->s_writers.frozen < level);
1200 }
1201
1202#ifdef CONFIG_LOCKDEP
1203 acquire_freeze_lock(sb, level, !wait, _RET_IP_);
1204#endif
1205 percpu_counter_inc(&sb->s_writers.counter[level-1]);
1206 /*
1207 * Make sure counter is updated before we check for frozen.
1208 * freeze_super() first sets frozen and then checks the counter.
1209 */
1210 smp_mb();
1211 if (unlikely(sb->s_writers.frozen >= level)) {
1212 __sb_end_write(sb, level);
1213 goto retry;
1214 }
1215 return 1;
1216}
1217EXPORT_SYMBOL(__sb_start_write);
1218
1219/**
1220 * sb_wait_write - wait until all writers to given file system finish
1221 * @sb: the super for which we wait
1222 * @level: type of writers we wait for (normal vs page fault)
1223 *
1224 * This function waits until there are no writers of given type to given file
1225 * system. Caller of this function should make sure there can be no new writers
1226 * of type @level before calling this function. Otherwise this function can
1227 * livelock.
1228 */
1229static void sb_wait_write(struct super_block *sb, int level)
1230{
1231 s64 writers;
1232
1233 /*
1234 * We just cycle-through lockdep here so that it does not complain
1235 * about returning with lock to userspace
1236 */
1237 rwsem_acquire(&sb->s_writers.lock_map[level-1], 0, 0, _THIS_IP_);
1238 rwsem_release(&sb->s_writers.lock_map[level-1], 1, _THIS_IP_);
1239
1240 do {
1241 DEFINE_WAIT(wait);
1242
1243 /*
1244 * We use a barrier in prepare_to_wait() to separate setting
1245 * of frozen and checking of the counter
1246 */
1247 prepare_to_wait(&sb->s_writers.wait, &wait,
1248 TASK_UNINTERRUPTIBLE);
1249
1250 writers = percpu_counter_sum(&sb->s_writers.counter[level-1]);
1251 if (writers)
1252 schedule();
1253
1254 finish_wait(&sb->s_writers.wait, &wait);
1255 } while (writers);
1256}
1257
Josef Bacik18e9e512010-03-23 10:34:56 -04001258/**
Randy Dunlap7000d3c2010-05-24 22:22:34 -07001259 * freeze_super - lock the filesystem and force it into a consistent state
1260 * @sb: the super to lock
Josef Bacik18e9e512010-03-23 10:34:56 -04001261 *
1262 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1263 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1264 * -EBUSY.
Jan Kara5accdf82012-06-12 16:20:34 +02001265 *
1266 * During this function, sb->s_writers.frozen goes through these values:
1267 *
1268 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1269 *
1270 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1271 * writes should be blocked, though page faults are still allowed. We wait for
1272 * all writes to complete and then proceed to the next stage.
1273 *
1274 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1275 * but internal fs threads can still modify the filesystem (although they
1276 * should not dirty new pages or inodes), writeback can run etc. After waiting
1277 * for all running page faults we sync the filesystem which will clean all
1278 * dirty pages and inodes (no new dirty pages or inodes can be created when
1279 * sync is running).
1280 *
1281 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1282 * modification are blocked (e.g. XFS preallocation truncation on inode
1283 * reclaim). This is usually implemented by blocking new transactions for
1284 * filesystems that have them and need this additional guard. After all
1285 * internal writers are finished we call ->freeze_fs() to finish filesystem
1286 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1287 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1288 *
1289 * sb->s_writers.frozen is protected by sb->s_umount.
Josef Bacik18e9e512010-03-23 10:34:56 -04001290 */
1291int freeze_super(struct super_block *sb)
1292{
1293 int ret;
1294
1295 atomic_inc(&sb->s_active);
1296 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001297 if (sb->s_writers.frozen != SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001298 deactivate_locked_super(sb);
1299 return -EBUSY;
1300 }
1301
Al Virodabe0dc2012-01-03 21:01:29 -05001302 if (!(sb->s_flags & MS_BORN)) {
1303 up_write(&sb->s_umount);
1304 return 0; /* sic - it's "nothing to do" */
1305 }
1306
Josef Bacik18e9e512010-03-23 10:34:56 -04001307 if (sb->s_flags & MS_RDONLY) {
Jan Kara5accdf82012-06-12 16:20:34 +02001308 /* Nothing to do really... */
1309 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001310 up_write(&sb->s_umount);
1311 return 0;
1312 }
1313
Jan Kara5accdf82012-06-12 16:20:34 +02001314 /* From now on, no new normal writers can start */
1315 sb->s_writers.frozen = SB_FREEZE_WRITE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001316 smp_wmb();
1317
Jan Kara5accdf82012-06-12 16:20:34 +02001318 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1319 up_write(&sb->s_umount);
1320
1321 sb_wait_write(sb, SB_FREEZE_WRITE);
1322
1323 /* Now we go and block page faults... */
1324 down_write(&sb->s_umount);
1325 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
1326 smp_wmb();
1327
1328 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1329
1330 /* All writers are done so after syncing there won't be dirty data */
Josef Bacik18e9e512010-03-23 10:34:56 -04001331 sync_filesystem(sb);
1332
Jan Kara5accdf82012-06-12 16:20:34 +02001333 /* Now wait for internal filesystem counter */
1334 sb->s_writers.frozen = SB_FREEZE_FS;
Josef Bacik18e9e512010-03-23 10:34:56 -04001335 smp_wmb();
Jan Kara5accdf82012-06-12 16:20:34 +02001336 sb_wait_write(sb, SB_FREEZE_FS);
Josef Bacik18e9e512010-03-23 10:34:56 -04001337
Josef Bacik18e9e512010-03-23 10:34:56 -04001338 if (sb->s_op->freeze_fs) {
1339 ret = sb->s_op->freeze_fs(sb);
1340 if (ret) {
1341 printk(KERN_ERR
1342 "VFS:Filesystem freeze failed\n");
Jan Kara5accdf82012-06-12 16:20:34 +02001343 sb->s_writers.frozen = SB_UNFROZEN;
Kazuya Mioe1616302011-12-01 16:51:07 +09001344 smp_wmb();
Jan Kara5accdf82012-06-12 16:20:34 +02001345 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001346 deactivate_locked_super(sb);
1347 return ret;
1348 }
1349 }
Jan Kara5accdf82012-06-12 16:20:34 +02001350 /*
1351 * This is just for debugging purposes so that fs can warn if it
1352 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
1353 */
1354 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001355 up_write(&sb->s_umount);
1356 return 0;
1357}
1358EXPORT_SYMBOL(freeze_super);
1359
1360/**
1361 * thaw_super -- unlock filesystem
1362 * @sb: the super to thaw
1363 *
1364 * Unlocks the filesystem and marks it writeable again after freeze_super().
1365 */
1366int thaw_super(struct super_block *sb)
1367{
1368 int error;
1369
1370 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001371 if (sb->s_writers.frozen == SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001372 up_write(&sb->s_umount);
1373 return -EINVAL;
1374 }
1375
1376 if (sb->s_flags & MS_RDONLY)
1377 goto out;
1378
1379 if (sb->s_op->unfreeze_fs) {
1380 error = sb->s_op->unfreeze_fs(sb);
1381 if (error) {
1382 printk(KERN_ERR
1383 "VFS:Filesystem thaw failed\n");
Josef Bacik18e9e512010-03-23 10:34:56 -04001384 up_write(&sb->s_umount);
1385 return error;
1386 }
1387 }
1388
1389out:
Jan Kara5accdf82012-06-12 16:20:34 +02001390 sb->s_writers.frozen = SB_UNFROZEN;
Josef Bacik18e9e512010-03-23 10:34:56 -04001391 smp_wmb();
Jan Kara5accdf82012-06-12 16:20:34 +02001392 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001393 deactivate_locked_super(sb);
1394
1395 return 0;
1396}
1397EXPORT_SYMBOL(thaw_super);