blob: 37813bf479cfeefb8f334691f27250d53a7edb92 [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>
Eric W. Biederman6e4eab52016-05-24 09:29:01 -050036#include <linux/user_namespace.h>
Al Viro6d59e7f2008-03-22 15:48:17 -040037#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39
Al Viro15d0f5e2015-02-02 10:07:59 -070040static LIST_HEAD(super_blocks);
41static DEFINE_SPINLOCK(sb_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Jan Kara5accdf82012-06-12 16:20:34 +020043static char *sb_writers_name[SB_FREEZE_LEVELS] = {
44 "sb_writers",
45 "sb_pagefaults",
46 "sb_internal",
47};
48
Dave Chinnerb0d40c92011-07-08 14:14:42 +100049/*
50 * One thing we have to be careful of with a per-sb shrinker is that we don't
51 * drop the last active reference to the superblock from within the shrinker.
52 * If that happens we could trigger unregistering the shrinker from within the
53 * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
54 * take a passive reference to the superblock to avoid this from occurring.
55 */
Dave Chinner0a234c62013-08-28 10:17:57 +100056static unsigned long super_cache_scan(struct shrinker *shrink,
57 struct shrink_control *sc)
Dave Chinnerb0d40c92011-07-08 14:14:42 +100058{
59 struct super_block *sb;
Dave Chinner0a234c62013-08-28 10:17:57 +100060 long fs_objects = 0;
61 long total_objects;
62 long freed = 0;
63 long dentries;
64 long inodes;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100065
66 sb = container_of(shrink, struct super_block, s_shrink);
67
68 /*
69 * Deadlock avoidance. We may hold various FS locks, and we don't want
70 * to recurse into the FS that called us in clear_inode() and friends..
71 */
Dave Chinner0a234c62013-08-28 10:17:57 +100072 if (!(sc->gfp_mask & __GFP_FS))
73 return SHRINK_STOP;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100074
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +030075 if (!trylock_super(sb))
Dave Chinner0a234c62013-08-28 10:17:57 +100076 return SHRINK_STOP;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100077
Al Virod0407902013-07-19 21:12:31 +040078 if (sb->s_op->nr_cached_objects)
Vladimir Davydov4101b622015-02-12 14:58:51 -080079 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
Dave Chinner0e1fdaf2011-07-08 14:14:44 +100080
Vladimir Davydov503c3582015-02-12 14:58:47 -080081 inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
82 dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
Dave Chinnerf6041562013-08-28 10:18:00 +100083 total_objects = dentries + inodes + fs_objects + 1;
Tetsuo Handa475d0db2014-05-17 20:56:38 +090084 if (!total_objects)
85 total_objects = 1;
Dave Chinner0e1fdaf2011-07-08 14:14:44 +100086
Dave Chinner0a234c62013-08-28 10:17:57 +100087 /* proportion the scan between the caches */
Dave Chinnerf6041562013-08-28 10:18:00 +100088 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100089 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
Vladimir Davydov503c3582015-02-12 14:58:47 -080090 fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
Dave Chinnerb0d40c92011-07-08 14:14:42 +100091
Dave Chinner0a234c62013-08-28 10:17:57 +100092 /*
93 * prune the dcache first as the icache is pinned by it, then
94 * prune the icache, followed by the filesystem specific caches
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -080095 *
96 * Ensure that we always scan at least one object - memcg kmem
97 * accounting uses this to fully empty the caches.
Dave Chinner0a234c62013-08-28 10:17:57 +100098 */
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -080099 sc->nr_to_scan = dentries + 1;
Vladimir Davydov503c3582015-02-12 14:58:47 -0800100 freed = prune_dcache_sb(sb, sc);
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800101 sc->nr_to_scan = inodes + 1;
Vladimir Davydov503c3582015-02-12 14:58:47 -0800102 freed += prune_icache_sb(sb, sc);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000103
Dave Chinner0a234c62013-08-28 10:17:57 +1000104 if (fs_objects) {
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800105 sc->nr_to_scan = fs_objects + 1;
Vladimir Davydov4101b622015-02-12 14:58:51 -0800106 freed += sb->s_op->free_cached_objects(sb, sc);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000107 }
108
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300109 up_read(&sb->s_umount);
Dave Chinner0a234c62013-08-28 10:17:57 +1000110 return freed;
111}
112
113static unsigned long super_cache_count(struct shrinker *shrink,
114 struct shrink_control *sc)
115{
116 struct super_block *sb;
117 long total_objects = 0;
118
119 sb = container_of(shrink, struct super_block, s_shrink);
120
Tim Chend23da152014-06-04 16:10:47 -0700121 /*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300122 * Don't call trylock_super as it is a potential
Tim Chend23da152014-06-04 16:10:47 -0700123 * scalability bottleneck. The counts could get updated
124 * between super_cache_count and super_cache_scan anyway.
125 * Call to super_cache_count with shrinker_rwsem held
Vladimir Davydov503c3582015-02-12 14:58:47 -0800126 * ensures the safety of call to list_lru_shrink_count() and
Tim Chend23da152014-06-04 16:10:47 -0700127 * s_op->nr_cached_objects().
128 */
Dave Chinner0a234c62013-08-28 10:17:57 +1000129 if (sb->s_op && sb->s_op->nr_cached_objects)
Vladimir Davydov4101b622015-02-12 14:58:51 -0800130 total_objects = sb->s_op->nr_cached_objects(sb, sc);
Dave Chinner0a234c62013-08-28 10:17:57 +1000131
Vladimir Davydov503c3582015-02-12 14:58:47 -0800132 total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
133 total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
Dave Chinner0a234c62013-08-28 10:17:57 +1000134
Glauber Costa55f841c2013-08-28 10:17:53 +1000135 total_objects = vfs_pressure_ratio(total_objects);
Dave Chinner0e1fdaf2011-07-08 14:14:44 +1000136 return total_objects;
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000137}
138
Oleg Nesterov853b39a2015-07-22 20:21:13 +0200139static void destroy_super_work(struct work_struct *work)
140{
141 struct super_block *s = container_of(work, struct super_block,
142 destroy_work);
143 int i;
144
145 for (i = 0; i < SB_FREEZE_LEVELS; i++)
Oleg Nesterov8129ed22015-08-11 17:05:04 +0200146 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
Oleg Nesterov853b39a2015-07-22 20:21:13 +0200147 kfree(s);
148}
149
150static void destroy_super_rcu(struct rcu_head *head)
151{
152 struct super_block *s = container_of(head, struct super_block, rcu);
153 INIT_WORK(&s->destroy_work, destroy_super_work);
154 schedule_work(&s->destroy_work);
155}
156
Al Viro7eb5e882013-10-01 15:09:58 -0400157/**
158 * destroy_super - frees a superblock
159 * @s: superblock to free
160 *
161 * Frees a superblock.
162 */
163static void destroy_super(struct super_block *s)
Jan Kara5accdf82012-06-12 16:20:34 +0200164{
Al Viro7eb5e882013-10-01 15:09:58 -0400165 list_lru_destroy(&s->s_dentry_lru);
166 list_lru_destroy(&s->s_inode_lru);
Al Viro7eb5e882013-10-01 15:09:58 -0400167 security_sb_free(s);
168 WARN_ON(!list_empty(&s->s_mounts));
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500169 put_user_ns(s->s_user_ns);
Al Viro7eb5e882013-10-01 15:09:58 -0400170 kfree(s->s_subtype);
171 kfree(s->s_options);
Oleg Nesterov853b39a2015-07-22 20:21:13 +0200172 call_rcu(&s->rcu, destroy_super_rcu);
Jan Kara5accdf82012-06-12 16:20:34 +0200173}
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175/**
176 * alloc_super - create new superblock
Henrik Kretzschmarfe2bbc42006-09-06 00:03:41 -0700177 * @type: filesystem type superblock should belong to
David Howells9249e172012-06-25 12:55:37 +0100178 * @flags: the mount flags
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500179 * @user_ns: User namespace for the super_block
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 *
181 * Allocates and initializes a new &struct super_block. alloc_super()
182 * returns a pointer new superblock or %NULL if allocation had failed.
183 */
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500184static struct super_block *alloc_super(struct file_system_type *type, int flags,
185 struct user_namespace *user_ns)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186{
Oliver Neukum11b0b5a2006-03-25 03:08:13 -0800187 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_USER);
Alexey Dobriyanb87221d2009-09-21 17:01:09 -0700188 static const struct super_operations default_op;
Al Viro7eb5e882013-10-01 15:09:58 -0400189 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Al Viro7eb5e882013-10-01 15:09:58 -0400191 if (!s)
192 return NULL;
193
Vladimir Davydovb5bd8562014-01-21 15:48:45 -0800194 INIT_LIST_HEAD(&s->s_mounts);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500195 s->s_user_ns = get_user_ns(user_ns);
Vladimir Davydovb5bd8562014-01-21 15:48:45 -0800196
Al Viro7eb5e882013-10-01 15:09:58 -0400197 if (security_sb_alloc(s))
198 goto fail;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200199
Al Viro7eb5e882013-10-01 15:09:58 -0400200 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
Oleg Nesterov8129ed22015-08-11 17:05:04 +0200201 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
202 sb_writers_name[i],
203 &type->s_writers_key[i]))
Al Viro7eb5e882013-10-01 15:09:58 -0400204 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 }
Al Viro7eb5e882013-10-01 15:09:58 -0400206 init_waitqueue_head(&s->s_writers.wait_unfrozen);
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100207 s->s_bdi = &noop_backing_dev_info;
Al Viro7eb5e882013-10-01 15:09:58 -0400208 s->s_flags = flags;
Eric W. Biedermancc50a072016-06-09 15:44:48 -0500209 if (s->s_user_ns != &init_user_ns)
Eric W. Biederman67690f92016-05-18 13:50:06 -0500210 s->s_iflags |= SB_I_NODEV;
Al Viro7eb5e882013-10-01 15:09:58 -0400211 INIT_HLIST_NODE(&s->s_instances);
212 INIT_HLIST_BL_HEAD(&s->s_anon);
Dave Chinnere97fedb2015-03-04 13:40:00 -0500213 mutex_init(&s->s_sync_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400214 INIT_LIST_HEAD(&s->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500215 spin_lock_init(&s->s_inode_list_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400216
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800217 if (list_lru_init_memcg(&s->s_dentry_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400218 goto fail;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800219 if (list_lru_init_memcg(&s->s_inode_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400220 goto fail;
221
Al Viro7eb5e882013-10-01 15:09:58 -0400222 init_rwsem(&s->s_umount);
223 lockdep_set_class(&s->s_umount, &type->s_umount_key);
224 /*
225 * sget() can have s_umount recursion.
226 *
227 * When it cannot find a suitable sb, it allocates a new
228 * one (this one), and tries again to find a suitable old
229 * one.
230 *
231 * In case that succeeds, it will acquire the s_umount
232 * lock of the old one. Since these are clearly distrinct
233 * locks, and this object isn't exposed yet, there's no
234 * risk of deadlocks.
235 *
236 * Annotate this by putting this lock in a different
237 * subclass.
238 */
239 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
240 s->s_count = 1;
241 atomic_set(&s->s_active, 1);
242 mutex_init(&s->s_vfs_rename_mutex);
243 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
244 mutex_init(&s->s_dquot.dqio_mutex);
245 mutex_init(&s->s_dquot.dqonoff_mutex);
Al Viro7eb5e882013-10-01 15:09:58 -0400246 s->s_maxbytes = MAX_NON_LFS;
247 s->s_op = &default_op;
248 s->s_time_gran = 1000000000;
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700249 s->cleancache_poolid = CLEANCACHE_NO_POOL;
Al Viro7eb5e882013-10-01 15:09:58 -0400250
251 s->s_shrink.seeks = DEFAULT_SEEKS;
252 s->s_shrink.scan_objects = super_cache_scan;
253 s->s_shrink.count_objects = super_cache_count;
254 s->s_shrink.batch = 1024;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800255 s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 return s;
Glauber Costa5ca302c2013-08-28 10:18:18 +1000257
Al Viro7eb5e882013-10-01 15:09:58 -0400258fail:
259 destroy_super(s);
260 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
262
263/* Superblock refcounting */
264
265/*
Al Viro35cf7ba2010-03-22 21:13:53 -0400266 * Drop a superblock's refcount. The caller must hold sb_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 */
Al Virof47ec3f2011-11-21 21:15:42 -0500268static void __put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 if (!--sb->s_count) {
Al Viro551de6f2010-03-22 19:36:35 -0400271 list_del_init(&sb->s_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 destroy_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}
275
276/**
277 * put_super - drop a temporary reference to superblock
278 * @sb: superblock in question
279 *
280 * Drops a temporary reference, frees superblock if there's no
281 * references left.
282 */
Al Virof47ec3f2011-11-21 21:15:42 -0500283static void put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284{
285 spin_lock(&sb_lock);
286 __put_super(sb);
287 spin_unlock(&sb_lock);
288}
289
290
291/**
Al Viro74dbbdd2009-05-06 01:07:50 -0400292 * deactivate_locked_super - drop an active reference to superblock
293 * @s: superblock to deactivate
294 *
Masanari Iidabd7ced92016-02-02 22:31:06 +0900295 * Drops an active reference to superblock, converting it into a temporary
Al Viro1712ac82010-03-22 15:22:31 -0400296 * one if there is no other active references left. In that case we
297 * tell fs driver to shut it down and drop the temporary reference we
298 * had just acquired.
299 *
300 * Caller holds exclusive lock on superblock; that lock is released.
Al Viro74dbbdd2009-05-06 01:07:50 -0400301 */
302void deactivate_locked_super(struct super_block *s)
303{
304 struct file_system_type *fs = s->s_type;
Al Virob20bd1a2010-03-22 08:53:19 -0400305 if (atomic_dec_and_test(&s->s_active)) {
Dan Magenheimer31677602011-09-21 11:56:28 -0400306 cleancache_invalidate_fs(s);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000307 unregister_shrinker(&s->s_shrink);
Dave Chinner28f2cd4f2014-06-04 16:10:46 -0700308 fs->kill_sb(s);
Glauber Costaf5e1dd32013-08-28 10:18:18 +1000309
Vladimir Davydovc0a5b562015-02-12 14:59:07 -0800310 /*
311 * Since list_lru_destroy() may sleep, we cannot call it from
312 * put_super(), where we hold the sb_lock. Therefore we destroy
313 * the lru lists right now.
314 */
315 list_lru_destroy(&s->s_dentry_lru);
316 list_lru_destroy(&s->s_inode_lru);
317
Al Viro74dbbdd2009-05-06 01:07:50 -0400318 put_filesystem(fs);
319 put_super(s);
320 } else {
321 up_write(&s->s_umount);
322 }
323}
324
325EXPORT_SYMBOL(deactivate_locked_super);
326
327/**
Al Viro1712ac82010-03-22 15:22:31 -0400328 * deactivate_super - drop an active reference to superblock
329 * @s: superblock to deactivate
330 *
331 * Variant of deactivate_locked_super(), except that superblock is *not*
332 * locked by caller. If we are going to drop the final active reference,
333 * lock will be acquired prior to that.
334 */
335void deactivate_super(struct super_block *s)
336{
337 if (!atomic_add_unless(&s->s_active, -1, 1)) {
338 down_write(&s->s_umount);
339 deactivate_locked_super(s);
340 }
341}
342
343EXPORT_SYMBOL(deactivate_super);
344
345/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 * grab_super - acquire an active reference
347 * @s: reference we are trying to make active
348 *
349 * Tries to acquire an active reference. grab_super() is used when we
350 * had just found a superblock in super_blocks or fs_type->fs_supers
351 * and want to turn it into a full-blown active reference. grab_super()
352 * is called with sb_lock held and drops it. Returns 1 in case of
353 * success, 0 if we had failed (superblock contents was already dead or
Al Viroacfec9a2013-07-20 03:13:55 +0400354 * dying when grab_super() had been called). Note that this is only
355 * called for superblocks not in rundown mode (== ones still on ->fs_supers
356 * of their type), so increment of ->s_count is OK here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 */
Josh Triplett9c4dbee2006-09-29 01:59:29 -0700358static int grab_super(struct super_block *s) __releases(sb_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359{
360 s->s_count++;
361 spin_unlock(&sb_lock);
362 down_write(&s->s_umount);
Al Viroacfec9a2013-07-20 03:13:55 +0400363 if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
364 put_super(s);
365 return 1;
366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 up_write(&s->s_umount);
368 put_super(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 return 0;
370}
371
David Howellscf9a2ae2006-08-29 19:05:54 +0100372/*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300373 * trylock_super - try to grab ->s_umount shared
Wanpeng Li331cbde2012-06-09 11:10:55 +0800374 * @sb: reference we are trying to grab
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000375 *
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300376 * Try to prevent fs shutdown. This is used in places where we
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000377 * cannot take an active reference but we need to ensure that the
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300378 * filesystem is not shut down while we are working on it. It returns
379 * false if we cannot acquire s_umount or if we lose the race and
380 * filesystem already got into shutdown, and returns true with the s_umount
381 * lock held in read mode in case of success. On successful return,
382 * the caller must drop the s_umount lock when done.
383 *
384 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
385 * The reason why it's safe is that we are OK with doing trylock instead
386 * of down_read(). There's a couple of places that are OK with that, but
387 * it's very much not a general-purpose interface.
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000388 */
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300389bool trylock_super(struct super_block *sb)
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000390{
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000391 if (down_read_trylock(&sb->s_umount)) {
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300392 if (!hlist_unhashed(&sb->s_instances) &&
393 sb->s_root && (sb->s_flags & MS_BORN))
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000394 return true;
395 up_read(&sb->s_umount);
396 }
397
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000398 return false;
399}
400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401/**
402 * generic_shutdown_super - common helper for ->kill_sb()
403 * @sb: superblock to kill
404 *
405 * generic_shutdown_super() does all fs-independent work on superblock
406 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
407 * that need destruction out of superblock, call generic_shutdown_super()
408 * and release aforementioned objects. Note: dentries and inodes _are_
409 * taken care of and do not need specific handling.
David Howellsc636ebd2006-10-11 01:22:19 -0700410 *
411 * Upon calling this function, the filesystem may no longer alter or
412 * rearrange the set of dentries belonging to this super_block, nor may it
413 * change the attachments of dentries to inodes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 */
415void generic_shutdown_super(struct super_block *sb)
416{
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800417 const struct super_operations *sop = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
David Howellsc636ebd2006-10-11 01:22:19 -0700419 if (sb->s_root) {
420 shrink_dcache_for_umount(sb);
Jan Kara60b06802009-04-27 16:43:53 +0200421 sync_filesystem(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 sb->s_flags &= ~MS_ACTIVE;
Arjan van de Venefaee192009-01-06 07:20:54 -0800423
Dave Chinner74278da2015-03-04 12:37:22 -0500424 fsnotify_unmount_inodes(sb);
Tejun Heoa1a0e232016-02-29 18:28:53 -0500425 cgroup_writeback_umount();
Al Viro63997e92010-10-25 20:49:35 -0400426
427 evict_inodes(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200429 if (sb->s_dio_done_wq) {
430 destroy_workqueue(sb->s_dio_done_wq);
431 sb->s_dio_done_wq = NULL;
432 }
433
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 if (sop->put_super)
435 sop->put_super(sb);
436
Al Viro63997e92010-10-25 20:49:35 -0400437 if (!list_empty(&sb->s_inodes)) {
Dave Jones7b4fe292006-02-07 12:58:48 -0800438 printk("VFS: Busy inodes after unmount of %s. "
439 "Self-destruct in 5 seconds. Have a nice day...\n",
440 sb->s_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 }
443 spin_lock(&sb_lock);
444 /* should be initialized for __put_super_and_need_restart() */
Al Viroa5166162011-12-12 22:53:00 -0500445 hlist_del_init(&sb->s_instances);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 spin_unlock(&sb_lock);
447 up_write(&sb->s_umount);
448}
449
450EXPORT_SYMBOL(generic_shutdown_super);
451
452/**
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500453 * sget_userns - find or create a superblock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 * @type: filesystem type superblock should belong to
455 * @test: comparison callback
456 * @set: setup callback
David Howells9249e172012-06-25 12:55:37 +0100457 * @flags: mount flags
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500458 * @user_ns: User namespace for the super_block
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 * @data: argument to each of them
460 */
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500461struct super_block *sget_userns(struct file_system_type *type,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 int (*test)(struct super_block *,void *),
463 int (*set)(struct super_block *,void *),
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500464 int flags, struct user_namespace *user_ns,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 void *data)
466{
467 struct super_block *s = NULL;
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700468 struct super_block *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 int err;
470
Eric W. Biedermana001e742016-06-06 15:48:04 -0500471 if (!(flags & MS_KERNMOUNT) &&
472 !(type->fs_flags & FS_USERNS_MOUNT) &&
473 !capable(CAP_SYS_ADMIN))
474 return ERR_PTR(-EPERM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475retry:
476 spin_lock(&sb_lock);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700477 if (test) {
Sasha Levinb67bfe02013-02-27 17:06:00 -0800478 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700479 if (!test(old, data))
480 continue;
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500481 if (user_ns != old->s_user_ns) {
482 spin_unlock(&sb_lock);
483 if (s) {
484 up_write(&s->s_umount);
485 destroy_super(s);
486 }
487 return ERR_PTR(-EBUSY);
488 }
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700489 if (!grab_super(old))
490 goto retry;
Li Zefana3cfbb52009-03-12 14:31:29 -0700491 if (s) {
492 up_write(&s->s_umount);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700493 destroy_super(s);
Al Viro7a4dec52010-08-09 12:05:43 -0400494 s = NULL;
Li Zefana3cfbb52009-03-12 14:31:29 -0700495 }
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700496 return old;
497 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 }
499 if (!s) {
500 spin_unlock(&sb_lock);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500501 s = alloc_super(type, flags, user_ns);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 if (!s)
503 return ERR_PTR(-ENOMEM);
504 goto retry;
505 }
506
507 err = set(s, data);
508 if (err) {
509 spin_unlock(&sb_lock);
Li Zefana3cfbb52009-03-12 14:31:29 -0700510 up_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 destroy_super(s);
512 return ERR_PTR(err);
513 }
514 s->s_type = type;
515 strlcpy(s->s_id, type->name, sizeof(s->s_id));
516 list_add_tail(&s->s_list, &super_blocks);
Al Viroa5166162011-12-12 22:53:00 -0500517 hlist_add_head(&s->s_instances, &type->fs_supers);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 spin_unlock(&sb_lock);
519 get_filesystem(type);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000520 register_shrinker(&s->s_shrink);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 return s;
522}
523
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500524EXPORT_SYMBOL(sget_userns);
525
526/**
527 * sget - find or create a superblock
528 * @type: filesystem type superblock should belong to
529 * @test: comparison callback
530 * @set: setup callback
531 * @flags: mount flags
532 * @data: argument to each of them
533 */
534struct super_block *sget(struct file_system_type *type,
535 int (*test)(struct super_block *,void *),
536 int (*set)(struct super_block *,void *),
537 int flags,
538 void *data)
539{
540 struct user_namespace *user_ns = current_user_ns();
541
542 /* Ensure the requestor has permissions over the target filesystem */
543 if (!(flags & MS_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
544 return ERR_PTR(-EPERM);
545
546 return sget_userns(type, test, set, flags, user_ns, data);
547}
548
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549EXPORT_SYMBOL(sget);
550
551void drop_super(struct super_block *sb)
552{
553 up_read(&sb->s_umount);
554 put_super(sb);
555}
556
557EXPORT_SYMBOL(drop_super);
558
Christoph Hellwige5004752009-05-05 16:08:56 +0200559/**
Al Viro01a05b32010-03-23 06:06:58 -0400560 * iterate_supers - call function for all active superblocks
561 * @f: function to call
562 * @arg: argument to pass to it
563 *
564 * Scans the superblock list and calls given function, passing it
565 * locked superblock and given argument.
566 */
567void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
568{
Al Virodca33252010-07-25 02:31:46 +0400569 struct super_block *sb, *p = NULL;
Al Viro01a05b32010-03-23 06:06:58 -0400570
571 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400572 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500573 if (hlist_unhashed(&sb->s_instances))
Al Viro01a05b32010-03-23 06:06:58 -0400574 continue;
575 sb->s_count++;
576 spin_unlock(&sb_lock);
577
578 down_read(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500579 if (sb->s_root && (sb->s_flags & MS_BORN))
Al Viro01a05b32010-03-23 06:06:58 -0400580 f(sb, arg);
581 up_read(&sb->s_umount);
582
583 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400584 if (p)
585 __put_super(p);
586 p = sb;
Al Viro01a05b32010-03-23 06:06:58 -0400587 }
Al Virodca33252010-07-25 02:31:46 +0400588 if (p)
589 __put_super(p);
Al Viro01a05b32010-03-23 06:06:58 -0400590 spin_unlock(&sb_lock);
591}
592
593/**
Al Viro43e15cd2011-06-03 20:16:57 -0400594 * iterate_supers_type - call function for superblocks of given type
595 * @type: fs type
596 * @f: function to call
597 * @arg: argument to pass to it
598 *
599 * Scans the superblock list and calls given function, passing it
600 * locked superblock and given argument.
601 */
602void iterate_supers_type(struct file_system_type *type,
603 void (*f)(struct super_block *, void *), void *arg)
604{
605 struct super_block *sb, *p = NULL;
606
607 spin_lock(&sb_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800608 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
Al Viro43e15cd2011-06-03 20:16:57 -0400609 sb->s_count++;
610 spin_unlock(&sb_lock);
611
612 down_read(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500613 if (sb->s_root && (sb->s_flags & MS_BORN))
Al Viro43e15cd2011-06-03 20:16:57 -0400614 f(sb, arg);
615 up_read(&sb->s_umount);
616
617 spin_lock(&sb_lock);
618 if (p)
619 __put_super(p);
620 p = sb;
621 }
622 if (p)
623 __put_super(p);
624 spin_unlock(&sb_lock);
625}
626
627EXPORT_SYMBOL(iterate_supers_type);
628
629/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 * get_super - get the superblock of a device
631 * @bdev: device to get the superblock for
632 *
633 * Scans the superblock list and finds the superblock of the file system
634 * mounted on the device given. %NULL is returned if no match is found.
635 */
636
Al Virodf40c012010-03-22 20:23:25 -0400637struct super_block *get_super(struct block_device *bdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700639 struct super_block *sb;
640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 if (!bdev)
642 return NULL;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700645rescan:
646 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500647 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400648 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700649 if (sb->s_bdev == bdev) {
650 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700652 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400653 /* still alive? */
Al Virodabe0dc2012-01-03 21:01:29 -0500654 if (sb->s_root && (sb->s_flags & MS_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700655 return sb;
656 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400657 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700658 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400659 __put_super(sb);
660 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 }
662 }
663 spin_unlock(&sb_lock);
664 return NULL;
665}
666
667EXPORT_SYMBOL(get_super);
Christoph Hellwig45042302009-08-03 23:28:35 +0200668
669/**
Jan Kara6b6dc832012-02-10 11:03:00 +0100670 * get_super_thawed - get thawed superblock of a device
671 * @bdev: device to get the superblock for
672 *
673 * Scans the superblock list and finds the superblock of the file system
674 * mounted on the device. The superblock is returned once it is thawed
675 * (or immediately if it was not frozen). %NULL is returned if no match
676 * is found.
677 */
678struct super_block *get_super_thawed(struct block_device *bdev)
679{
680 while (1) {
681 struct super_block *s = get_super(bdev);
Jan Kara5accdf82012-06-12 16:20:34 +0200682 if (!s || s->s_writers.frozen == SB_UNFROZEN)
Jan Kara6b6dc832012-02-10 11:03:00 +0100683 return s;
684 up_read(&s->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +0200685 wait_event(s->s_writers.wait_unfrozen,
686 s->s_writers.frozen == SB_UNFROZEN);
Jan Kara6b6dc832012-02-10 11:03:00 +0100687 put_super(s);
688 }
689}
690EXPORT_SYMBOL(get_super_thawed);
691
692/**
Christoph Hellwig45042302009-08-03 23:28:35 +0200693 * get_active_super - get an active reference to the superblock of a device
694 * @bdev: device to get the superblock for
695 *
696 * Scans the superblock list and finds the superblock of the file system
697 * mounted on the device given. Returns the superblock with an active
Al Virod3f21472010-03-23 11:11:05 -0400698 * reference or %NULL if none was found.
Christoph Hellwig45042302009-08-03 23:28:35 +0200699 */
700struct super_block *get_active_super(struct block_device *bdev)
701{
702 struct super_block *sb;
703
704 if (!bdev)
705 return NULL;
706
Al Viro14945832010-03-22 20:15:33 -0400707restart:
Christoph Hellwig45042302009-08-03 23:28:35 +0200708 spin_lock(&sb_lock);
709 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500710 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400711 continue;
Al Viro14945832010-03-22 20:15:33 -0400712 if (sb->s_bdev == bdev) {
Al Viroacfec9a2013-07-20 03:13:55 +0400713 if (!grab_super(sb))
Al Viro14945832010-03-22 20:15:33 -0400714 goto restart;
Al Viroacfec9a2013-07-20 03:13:55 +0400715 up_write(&sb->s_umount);
716 return sb;
Al Viro14945832010-03-22 20:15:33 -0400717 }
Christoph Hellwig45042302009-08-03 23:28:35 +0200718 }
719 spin_unlock(&sb_lock);
720 return NULL;
721}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Al Virodf40c012010-03-22 20:23:25 -0400723struct super_block *user_get_super(dev_t dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700725 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700728rescan:
729 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500730 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400731 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700732 if (sb->s_dev == dev) {
733 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700735 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400736 /* still alive? */
Al Virodabe0dc2012-01-03 21:01:29 -0500737 if (sb->s_root && (sb->s_flags & MS_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700738 return sb;
739 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400740 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700741 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400742 __put_super(sb);
743 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 }
745 }
746 spin_unlock(&sb_lock);
747 return NULL;
748}
749
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 * do_remount_sb - asks filesystem to change mount options.
752 * @sb: superblock in question
753 * @flags: numeric part of options
754 * @data: the rest of options
755 * @force: whether or not to force the change
756 *
757 * Alters the mount options of a mounted file system.
758 */
759int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
760{
761 int retval;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400762 int remount_ro;
Christoph Hellwig45042302009-08-03 23:28:35 +0200763
Jan Kara5accdf82012-06-12 16:20:34 +0200764 if (sb->s_writers.frozen != SB_UNFROZEN)
Christoph Hellwig45042302009-08-03 23:28:35 +0200765 return -EBUSY;
766
David Howells93614012006-09-30 20:45:40 +0200767#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
769 return -EACCES;
David Howells93614012006-09-30 20:45:40 +0200770#endif
Christoph Hellwig45042302009-08-03 23:28:35 +0200771
Nick Piggind208bbd2009-12-21 16:28:53 -0800772 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
Nick Piggind208bbd2009-12-21 16:28:53 -0800773
Al Viro0aec09d2014-08-07 07:32:06 -0400774 if (remount_ro) {
Al Virofdab6842015-01-11 10:57:27 -0500775 if (!hlist_empty(&sb->s_pins)) {
Al Viro0aec09d2014-08-07 07:32:06 -0400776 up_write(&sb->s_umount);
Al Virofdab6842015-01-11 10:57:27 -0500777 group_pin_kill(&sb->s_pins);
Al Viro0aec09d2014-08-07 07:32:06 -0400778 down_write(&sb->s_umount);
779 if (!sb->s_root)
780 return 0;
781 if (sb->s_writers.frozen != SB_UNFROZEN)
782 return -EBUSY;
783 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
784 }
785 }
786 shrink_dcache_sb(sb);
787
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 /* If we are remounting RDONLY and current sb is read/write,
789 make sure there are no rw files opened */
Nick Piggind208bbd2009-12-21 16:28:53 -0800790 if (remount_ro) {
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100791 if (force) {
Al Viroeee5cc22013-10-04 11:06:42 -0400792 sb->s_readonly_remount = 1;
793 smp_wmb();
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100794 } else {
795 retval = sb_prepare_remount_readonly(sb);
796 if (retval)
797 return retval;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100798 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 }
800
801 if (sb->s_op->remount_fs) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 retval = sb->s_op->remount_fs(sb, &flags, data);
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200803 if (retval) {
804 if (!force)
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100805 goto cancel_readonly;
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200806 /* If forced remount, go ahead despite any errors */
807 WARN(1, "forced remount of a %s fs returned %i\n",
808 sb->s_type->name, retval);
809 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 }
811 sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100812 /* Needs to be ordered wrt mnt_is_readonly() */
813 smp_wmb();
814 sb->s_readonly_remount = 0;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400815
Nick Piggind208bbd2009-12-21 16:28:53 -0800816 /*
817 * Some filesystems modify their metadata via some other path than the
818 * bdev buffer cache (eg. use a private mapping, or directories in
819 * pagecache, etc). Also file data modifications go via their own
820 * mappings. So If we try to mount readonly then copy the filesystem
821 * from bdev, we could get stale data, so invalidate it to give a best
822 * effort at coherency.
823 */
824 if (remount_ro && sb->s_bdev)
825 invalidate_bdev(sb->s_bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return 0;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100827
828cancel_readonly:
829 sb->s_readonly_remount = 0;
830 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}
832
Jens Axboea2a95372009-03-17 09:38:40 +0100833static void do_emergency_remount(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Al Virodca33252010-07-25 02:31:46 +0400835 struct super_block *sb, *p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
837 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400838 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500839 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400840 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 sb->s_count++;
842 spin_unlock(&sb_lock);
Al Viro443b94b2009-05-05 23:48:50 -0400843 down_write(&sb->s_umount);
Al Virodabe0dc2012-01-03 21:01:29 -0500844 if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
845 !(sb->s_flags & MS_RDONLY)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 * What lock protects sb->s_flags??
848 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 do_remount_sb(sb, MS_RDONLY, NULL, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 }
Al Viro443b94b2009-05-05 23:48:50 -0400851 up_write(&sb->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400853 if (p)
854 __put_super(p);
855 p = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 }
Al Virodca33252010-07-25 02:31:46 +0400857 if (p)
858 __put_super(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 spin_unlock(&sb_lock);
Jens Axboea2a95372009-03-17 09:38:40 +0100860 kfree(work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 printk("Emergency Remount complete\n");
862}
863
864void emergency_remount(void)
865{
Jens Axboea2a95372009-03-17 09:38:40 +0100866 struct work_struct *work;
867
868 work = kmalloc(sizeof(*work), GFP_ATOMIC);
869 if (work) {
870 INIT_WORK(work, do_emergency_remount);
871 schedule_work(work);
872 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873}
874
875/*
876 * Unnamed block devices are dummy devices used by virtual
877 * filesystems which don't use real block-devices. -- jrs
878 */
879
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400880static DEFINE_IDA(unnamed_dev_ida);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
Thomas Bächlera2a4dc42014-04-03 21:55:37 +0200882/* Many userspace utilities consider an FSID of 0 invalid.
883 * Always return at least 1 from get_anon_bdev.
884 */
885static int unnamed_dev_start = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Al Viro0ee5dc62011-07-07 15:44:25 -0400887int get_anon_bdev(dev_t *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888{
889 int dev;
890 int error;
891
892 retry:
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400893 if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 return -ENOMEM;
895 spin_lock(&unnamed_dev_lock);
Al Viroc63e09e2009-06-24 02:05:18 -0400896 error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
Al Virof21f6222009-06-24 03:12:00 -0400897 if (!error)
898 unnamed_dev_start = dev + 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 spin_unlock(&unnamed_dev_lock);
900 if (error == -EAGAIN)
901 /* We raced and lost with another CPU. */
902 goto retry;
903 else if (error)
904 return -EAGAIN;
905
Wang YanQing1af95de2015-06-23 18:54:45 +0800906 if (dev >= (1 << MINORBITS)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 spin_lock(&unnamed_dev_lock);
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400908 ida_remove(&unnamed_dev_ida, dev);
Al Virof21f6222009-06-24 03:12:00 -0400909 if (unnamed_dev_start > dev)
910 unnamed_dev_start = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 spin_unlock(&unnamed_dev_lock);
912 return -EMFILE;
913 }
Al Viro0ee5dc62011-07-07 15:44:25 -0400914 *p = MKDEV(0, dev & MINORMASK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 return 0;
916}
Al Viro0ee5dc62011-07-07 15:44:25 -0400917EXPORT_SYMBOL(get_anon_bdev);
918
919void free_anon_bdev(dev_t dev)
920{
921 int slot = MINOR(dev);
922 spin_lock(&unnamed_dev_lock);
923 ida_remove(&unnamed_dev_ida, slot);
924 if (slot < unnamed_dev_start)
925 unnamed_dev_start = slot;
926 spin_unlock(&unnamed_dev_lock);
927}
928EXPORT_SYMBOL(free_anon_bdev);
929
930int set_anon_super(struct super_block *s, void *data)
931{
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100932 return get_anon_bdev(&s->s_dev);
Al Viro0ee5dc62011-07-07 15:44:25 -0400933}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
935EXPORT_SYMBOL(set_anon_super);
936
937void kill_anon_super(struct super_block *sb)
938{
Al Viro0ee5dc62011-07-07 15:44:25 -0400939 dev_t dev = sb->s_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 generic_shutdown_super(sb);
Al Viro0ee5dc62011-07-07 15:44:25 -0400941 free_anon_bdev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942}
943
944EXPORT_SYMBOL(kill_anon_super);
945
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946void kill_litter_super(struct super_block *sb)
947{
948 if (sb->s_root)
949 d_genocide(sb->s_root);
950 kill_anon_super(sb);
951}
952
953EXPORT_SYMBOL(kill_litter_super);
954
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700955static int ns_test_super(struct super_block *sb, void *data)
956{
957 return sb->s_fs_info == data;
958}
959
960static int ns_set_super(struct super_block *sb, void *data)
961{
962 sb->s_fs_info = data;
963 return set_anon_super(sb, NULL);
964}
965
Eric W. Biedermand91ee872016-05-23 14:51:59 -0500966struct dentry *mount_ns(struct file_system_type *fs_type,
967 int flags, void *data, void *ns, struct user_namespace *user_ns,
968 int (*fill_super)(struct super_block *, void *, int))
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700969{
970 struct super_block *sb;
971
Eric W. Biedermand91ee872016-05-23 14:51:59 -0500972 /* Don't allow mounting unless the caller has CAP_SYS_ADMIN
973 * over the namespace.
974 */
975 if (!(flags & MS_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
976 return ERR_PTR(-EPERM);
977
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500978 sb = sget_userns(fs_type, ns_test_super, ns_set_super, flags,
979 user_ns, ns);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700980 if (IS_ERR(sb))
Al Viroceefda62010-07-26 13:16:50 +0400981 return ERR_CAST(sb);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700982
983 if (!sb->s_root) {
984 int err;
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700985 err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
986 if (err) {
Al Viro74dbbdd2009-05-06 01:07:50 -0400987 deactivate_locked_super(sb);
Al Viroceefda62010-07-26 13:16:50 +0400988 return ERR_PTR(err);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700989 }
990
991 sb->s_flags |= MS_ACTIVE;
992 }
993
Al Viroceefda62010-07-26 13:16:50 +0400994 return dget(sb->s_root);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700995}
996
Al Viroceefda62010-07-26 13:16:50 +0400997EXPORT_SYMBOL(mount_ns);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -0700998
David Howells93614012006-09-30 20:45:40 +0200999#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000static int set_bdev_super(struct super_block *s, void *data)
1001{
1002 s->s_bdev = data;
1003 s->s_dev = s->s_bdev->bd_dev;
Jens Axboe32a88aa2009-09-16 15:02:33 +02001004
1005 /*
1006 * We set the bdi here to the queue backing, file systems can
1007 * overwrite this in ->fill_super()
1008 */
1009 s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 return 0;
1011}
1012
1013static int test_bdev_super(struct super_block *s, void *data)
1014{
1015 return (void *)s->s_bdev == data;
1016}
1017
Al Viro152a0832010-07-25 00:46:55 +04001018struct dentry *mount_bdev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 int flags, const char *dev_name, void *data,
Al Viro152a0832010-07-25 00:46:55 +04001020 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021{
1022 struct block_device *bdev;
1023 struct super_block *s;
Tejun Heod4d77622010-11-13 11:55:18 +01001024 fmode_t mode = FMODE_READ | FMODE_EXCL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 int error = 0;
1026
Al Viro30c40d22008-02-22 19:50:45 -05001027 if (!(flags & MS_RDONLY))
1028 mode |= FMODE_WRITE;
1029
Tejun Heod4d77622010-11-13 11:55:18 +01001030 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 if (IS_ERR(bdev))
Al Viro152a0832010-07-25 00:46:55 +04001032 return ERR_CAST(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
1034 /*
1035 * once the super is inserted into the list by sget, s_umount
1036 * will protect the lockfs code from trying to start a snapshot
1037 * while we are mounting
1038 */
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +02001039 mutex_lock(&bdev->bd_fsfreeze_mutex);
1040 if (bdev->bd_fsfreeze_count > 0) {
1041 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1042 error = -EBUSY;
1043 goto error_bdev;
1044 }
David Howells9249e172012-06-25 12:55:37 +01001045 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
1046 bdev);
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +02001047 mutex_unlock(&bdev->bd_fsfreeze_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 if (IS_ERR(s))
David Howells454e2392006-06-23 02:02:57 -07001049 goto error_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
1051 if (s->s_root) {
1052 if ((flags ^ s->s_flags) & MS_RDONLY) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001053 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -07001054 error = -EBUSY;
1055 goto error_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 }
David Howells454e2392006-06-23 02:02:57 -07001057
Tejun Heo4f331f02010-07-20 15:18:07 -07001058 /*
1059 * s_umount nests inside bd_mutex during
Tejun Heoe525fd82010-11-13 11:55:17 +01001060 * __invalidate_device(). blkdev_put() acquires
1061 * bd_mutex and can't be called under s_umount. Drop
1062 * s_umount temporarily. This is safe as we're
1063 * holding an active reference.
Tejun Heo4f331f02010-07-20 15:18:07 -07001064 */
1065 up_write(&s->s_umount);
Tejun Heod4d77622010-11-13 11:55:18 +01001066 blkdev_put(bdev, mode);
Tejun Heo4f331f02010-07-20 15:18:07 -07001067 down_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 } else {
Al Viro30c40d22008-02-22 19:50:45 -05001069 s->s_mode = mode;
Dmitry Monakhova1c6f0572015-04-13 16:31:37 +04001070 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
Pekka Enberge78c9a02006-01-08 01:03:39 -08001071 sb_set_blocksize(s, block_size(bdev));
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001072 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001074 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -07001075 goto error;
Greg Kroah-Hartmanfa675762006-02-22 09:39:02 -08001076 }
David Howells454e2392006-06-23 02:02:57 -07001077
1078 s->s_flags |= MS_ACTIVE;
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001079 bdev->bd_super = s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 }
1081
Al Viro152a0832010-07-25 00:46:55 +04001082 return dget(s->s_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
David Howells454e2392006-06-23 02:02:57 -07001084error_s:
1085 error = PTR_ERR(s);
1086error_bdev:
Tejun Heod4d77622010-11-13 11:55:18 +01001087 blkdev_put(bdev, mode);
David Howells454e2392006-06-23 02:02:57 -07001088error:
Al Viro152a0832010-07-25 00:46:55 +04001089 return ERR_PTR(error);
1090}
1091EXPORT_SYMBOL(mount_bdev);
1092
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093void kill_block_super(struct super_block *sb)
1094{
1095 struct block_device *bdev = sb->s_bdev;
Al Viro30c40d22008-02-22 19:50:45 -05001096 fmode_t mode = sb->s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
H Hartley Sweetenddbaaf32009-04-29 20:14:57 -04001098 bdev->bd_super = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 generic_shutdown_super(sb);
1100 sync_blockdev(bdev);
Tejun Heod4d77622010-11-13 11:55:18 +01001101 WARN_ON_ONCE(!(mode & FMODE_EXCL));
Tejun Heoe525fd82010-11-13 11:55:17 +01001102 blkdev_put(bdev, mode | FMODE_EXCL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103}
1104
1105EXPORT_SYMBOL(kill_block_super);
David Howells93614012006-09-30 20:45:40 +02001106#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107
Al Viro3c26ff62010-07-25 11:46:36 +04001108struct dentry *mount_nodev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 int flags, void *data,
Al Viro3c26ff62010-07-25 11:46:36 +04001110 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111{
1112 int error;
David Howells9249e172012-06-25 12:55:37 +01001113 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
1115 if (IS_ERR(s))
Al Viro3c26ff62010-07-25 11:46:36 +04001116 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001118 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001120 deactivate_locked_super(s);
Al Viro3c26ff62010-07-25 11:46:36 +04001121 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 }
1123 s->s_flags |= MS_ACTIVE;
Al Viro3c26ff62010-07-25 11:46:36 +04001124 return dget(s->s_root);
1125}
1126EXPORT_SYMBOL(mount_nodev);
1127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128static int compare_single(struct super_block *s, void *p)
1129{
1130 return 1;
1131}
1132
Al Virofc14f2f2010-07-25 01:48:30 +04001133struct dentry *mount_single(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 int flags, void *data,
Al Virofc14f2f2010-07-25 01:48:30 +04001135 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136{
1137 struct super_block *s;
1138 int error;
1139
David Howells9249e172012-06-25 12:55:37 +01001140 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 if (IS_ERR(s))
Al Virofc14f2f2010-07-25 01:48:30 +04001142 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 if (!s->s_root) {
Theodore Ts'o9b04c992006-03-24 03:15:10 -08001144 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001146 deactivate_locked_super(s);
Al Virofc14f2f2010-07-25 01:48:30 +04001147 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 }
1149 s->s_flags |= MS_ACTIVE;
Kay Sievers9329d1b2009-12-18 21:18:15 +01001150 } else {
1151 do_remount_sb(s, flags, data, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 }
Al Virofc14f2f2010-07-25 01:48:30 +04001153 return dget(s->s_root);
1154}
1155EXPORT_SYMBOL(mount_single);
1156
Al Viro9d412a42011-03-17 22:08:28 -04001157struct dentry *
1158mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159{
Al Viroc96e41e2010-07-25 00:17:56 +04001160 struct dentry *root;
Al Viro9d412a42011-03-17 22:08:28 -04001161 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 char *secdata = NULL;
Al Viro9d412a42011-03-17 22:08:28 -04001163 int error = -ENOMEM;
Al Viro80893522010-02-05 09:30:46 -05001164
Eric Parise0007522008-03-05 10:31:54 -05001165 if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166 secdata = alloc_secdata();
David Howells454e2392006-06-23 02:02:57 -07001167 if (!secdata)
Al Viro9d412a42011-03-17 22:08:28 -04001168 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
Eric Parise0007522008-03-05 10:31:54 -05001170 error = security_sb_copy_data(data, secdata);
David Howells454e2392006-06-23 02:02:57 -07001171 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 goto out_free_secdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 }
1174
Al Viro1a102ff2011-03-16 09:07:58 -04001175 root = type->mount(type, flags, name, data);
1176 if (IS_ERR(root)) {
1177 error = PTR_ERR(root);
1178 goto out_free_secdata;
Al Viroc96e41e2010-07-25 00:17:56 +04001179 }
Al Viro9d412a42011-03-17 22:08:28 -04001180 sb = root->d_sb;
1181 BUG_ON(!sb);
1182 WARN_ON(!sb->s_bdi);
1183 sb->s_flags |= MS_BORN;
David Howells454e2392006-06-23 02:02:57 -07001184
Al Viro9d412a42011-03-17 22:08:28 -04001185 error = security_sb_kern_mount(sb, flags, secdata);
Jörn Engel5129a462010-04-25 08:54:42 +02001186 if (error)
1187 goto out_sb;
David Howells454e2392006-06-23 02:02:57 -07001188
Jeff Layton42cb56a2009-09-18 13:05:53 -07001189 /*
1190 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1191 * but s_maxbytes was an unsigned long long for many releases. Throw
1192 * this warning for a little while to try and catch filesystems that
Jeff Layton4358b562011-03-29 09:33:31 -04001193 * violate this rule.
Jeff Layton42cb56a2009-09-18 13:05:53 -07001194 */
Al Viro9d412a42011-03-17 22:08:28 -04001195 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1196 "negative value (%lld)\n", type->name, sb->s_maxbytes);
Jeff Layton42cb56a2009-09-18 13:05:53 -07001197
Al Viro9d412a42011-03-17 22:08:28 -04001198 up_write(&sb->s_umount);
Gerald Schaefer8680e222005-06-21 17:15:16 -07001199 free_secdata(secdata);
Al Viro9d412a42011-03-17 22:08:28 -04001200 return root;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201out_sb:
Al Viro9d412a42011-03-17 22:08:28 -04001202 dput(root);
1203 deactivate_locked_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204out_free_secdata:
1205 free_secdata(secdata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206out:
David Howells454e2392006-06-23 02:02:57 -07001207 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208}
1209
Jan Kara5accdf82012-06-12 16:20:34 +02001210/*
1211 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1212 * instead.
1213 */
1214void __sb_end_write(struct super_block *sb, int level)
1215{
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001216 percpu_up_read(sb->s_writers.rw_sem + level-1);
Jan Kara5accdf82012-06-12 16:20:34 +02001217}
1218EXPORT_SYMBOL(__sb_end_write);
1219
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001220/*
1221 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1222 * instead.
1223 */
1224int __sb_start_write(struct super_block *sb, int level, bool wait)
1225{
1226 bool force_trylock = false;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001227 int ret = 1;
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001228
1229#ifdef CONFIG_LOCKDEP
1230 /*
1231 * We want lockdep to tell us about possible deadlocks with freezing
1232 * but it's it bit tricky to properly instrument it. Getting a freeze
1233 * protection works as getting a read lock but there are subtle
1234 * problems. XFS for example gets freeze protection on internal level
1235 * twice in some cases, which is OK only because we already hold a
1236 * freeze protection also on higher level. Due to these cases we have
1237 * to use wait == F (trylock mode) which must not fail.
1238 */
1239 if (wait) {
1240 int i;
1241
1242 for (i = 0; i < level - 1; i++)
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001243 if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001244 force_trylock = true;
1245 break;
1246 }
1247 }
1248#endif
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001249 if (wait && !force_trylock)
1250 percpu_down_read(sb->s_writers.rw_sem + level-1);
1251 else
1252 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1253
Vincent Stehlé22224a12015-09-21 17:18:34 +02001254 WARN_ON(force_trylock && !ret);
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001255 return ret;
1256}
Jan Kara5accdf82012-06-12 16:20:34 +02001257EXPORT_SYMBOL(__sb_start_write);
1258
1259/**
1260 * sb_wait_write - wait until all writers to given file system finish
1261 * @sb: the super for which we wait
1262 * @level: type of writers we wait for (normal vs page fault)
1263 *
1264 * This function waits until there are no writers of given type to given file
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001265 * system.
Jan Kara5accdf82012-06-12 16:20:34 +02001266 */
1267static void sb_wait_write(struct super_block *sb, int level)
1268{
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001269 percpu_down_write(sb->s_writers.rw_sem + level-1);
Oleg Nesterov0e28e012015-08-11 16:28:29 +02001270 /*
1271 * We are going to return to userspace and forget about this lock, the
1272 * ownership goes to the caller of thaw_super() which does unlock.
1273 *
1274 * FIXME: we should do this before return from freeze_super() after we
1275 * called sync_filesystem(sb) and s_op->freeze_fs(sb), and thaw_super()
1276 * should re-acquire these locks before s_op->unfreeze_fs(sb). However
1277 * this leads to lockdep false-positives, so currently we do the early
1278 * release right after acquire.
1279 */
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001280 percpu_rwsem_release(sb->s_writers.rw_sem + level-1, 0, _THIS_IP_);
1281}
Jan Kara5accdf82012-06-12 16:20:34 +02001282
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001283static void sb_freeze_unlock(struct super_block *sb)
1284{
1285 int level;
Jan Kara5accdf82012-06-12 16:20:34 +02001286
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001287 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1288 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
Jan Kara5accdf82012-06-12 16:20:34 +02001289
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001290 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1291 percpu_up_write(sb->s_writers.rw_sem + level);
Jan Kara5accdf82012-06-12 16:20:34 +02001292}
1293
Josef Bacik18e9e512010-03-23 10:34:56 -04001294/**
Randy Dunlap7000d3c2010-05-24 22:22:34 -07001295 * freeze_super - lock the filesystem and force it into a consistent state
1296 * @sb: the super to lock
Josef Bacik18e9e512010-03-23 10:34:56 -04001297 *
1298 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1299 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1300 * -EBUSY.
Jan Kara5accdf82012-06-12 16:20:34 +02001301 *
1302 * During this function, sb->s_writers.frozen goes through these values:
1303 *
1304 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1305 *
1306 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1307 * writes should be blocked, though page faults are still allowed. We wait for
1308 * all writes to complete and then proceed to the next stage.
1309 *
1310 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1311 * but internal fs threads can still modify the filesystem (although they
1312 * should not dirty new pages or inodes), writeback can run etc. After waiting
1313 * for all running page faults we sync the filesystem which will clean all
1314 * dirty pages and inodes (no new dirty pages or inodes can be created when
1315 * sync is running).
1316 *
1317 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1318 * modification are blocked (e.g. XFS preallocation truncation on inode
1319 * reclaim). This is usually implemented by blocking new transactions for
1320 * filesystems that have them and need this additional guard. After all
1321 * internal writers are finished we call ->freeze_fs() to finish filesystem
1322 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1323 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1324 *
1325 * sb->s_writers.frozen is protected by sb->s_umount.
Josef Bacik18e9e512010-03-23 10:34:56 -04001326 */
1327int freeze_super(struct super_block *sb)
1328{
1329 int ret;
1330
1331 atomic_inc(&sb->s_active);
1332 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001333 if (sb->s_writers.frozen != SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001334 deactivate_locked_super(sb);
1335 return -EBUSY;
1336 }
1337
Al Virodabe0dc2012-01-03 21:01:29 -05001338 if (!(sb->s_flags & MS_BORN)) {
1339 up_write(&sb->s_umount);
1340 return 0; /* sic - it's "nothing to do" */
1341 }
1342
Josef Bacik18e9e512010-03-23 10:34:56 -04001343 if (sb->s_flags & MS_RDONLY) {
Jan Kara5accdf82012-06-12 16:20:34 +02001344 /* Nothing to do really... */
1345 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001346 up_write(&sb->s_umount);
1347 return 0;
1348 }
1349
Jan Kara5accdf82012-06-12 16:20:34 +02001350 sb->s_writers.frozen = SB_FREEZE_WRITE;
Jan Kara5accdf82012-06-12 16:20:34 +02001351 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1352 up_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001353 sb_wait_write(sb, SB_FREEZE_WRITE);
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001354 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001355
1356 /* Now we go and block page faults... */
Jan Kara5accdf82012-06-12 16:20:34 +02001357 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
Jan Kara5accdf82012-06-12 16:20:34 +02001358 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1359
1360 /* All writers are done so after syncing there won't be dirty data */
Josef Bacik18e9e512010-03-23 10:34:56 -04001361 sync_filesystem(sb);
1362
Jan Kara5accdf82012-06-12 16:20:34 +02001363 /* Now wait for internal filesystem counter */
1364 sb->s_writers.frozen = SB_FREEZE_FS;
Jan Kara5accdf82012-06-12 16:20:34 +02001365 sb_wait_write(sb, SB_FREEZE_FS);
Josef Bacik18e9e512010-03-23 10:34:56 -04001366
Josef Bacik18e9e512010-03-23 10:34:56 -04001367 if (sb->s_op->freeze_fs) {
1368 ret = sb->s_op->freeze_fs(sb);
1369 if (ret) {
1370 printk(KERN_ERR
1371 "VFS:Filesystem freeze failed\n");
Jan Kara5accdf82012-06-12 16:20:34 +02001372 sb->s_writers.frozen = SB_UNFROZEN;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001373 sb_freeze_unlock(sb);
Jan Kara5accdf82012-06-12 16:20:34 +02001374 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001375 deactivate_locked_super(sb);
1376 return ret;
1377 }
1378 }
Jan Kara5accdf82012-06-12 16:20:34 +02001379 /*
1380 * This is just for debugging purposes so that fs can warn if it
1381 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
1382 */
1383 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001384 up_write(&sb->s_umount);
1385 return 0;
1386}
1387EXPORT_SYMBOL(freeze_super);
1388
1389/**
1390 * thaw_super -- unlock filesystem
1391 * @sb: the super to thaw
1392 *
1393 * Unlocks the filesystem and marks it writeable again after freeze_super().
1394 */
1395int thaw_super(struct super_block *sb)
1396{
1397 int error;
1398
1399 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001400 if (sb->s_writers.frozen == SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001401 up_write(&sb->s_umount);
1402 return -EINVAL;
1403 }
1404
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001405 if (sb->s_flags & MS_RDONLY) {
1406 sb->s_writers.frozen = SB_UNFROZEN;
Josef Bacik18e9e512010-03-23 10:34:56 -04001407 goto out;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001408 }
Josef Bacik18e9e512010-03-23 10:34:56 -04001409
1410 if (sb->s_op->unfreeze_fs) {
1411 error = sb->s_op->unfreeze_fs(sb);
1412 if (error) {
1413 printk(KERN_ERR
1414 "VFS:Filesystem thaw failed\n");
Josef Bacik18e9e512010-03-23 10:34:56 -04001415 up_write(&sb->s_umount);
1416 return error;
1417 }
1418 }
1419
Jan Kara5accdf82012-06-12 16:20:34 +02001420 sb->s_writers.frozen = SB_UNFROZEN;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001421 sb_freeze_unlock(sb);
1422out:
Jan Kara5accdf82012-06-12 16:20:34 +02001423 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001424 deactivate_locked_super(sb);
Josef Bacik18e9e512010-03-23 10:34:56 -04001425 return 0;
1426}
1427EXPORT_SYMBOL(thaw_super);