blob: 7ff1349609e4874a35268876065490d77f5e01ab [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/fs/super.c
4 *
5 * Copyright (C) 1991, 1992 Linus Torvalds
6 *
7 * super.c contains code to handle: - mount structures
8 * - super-block tables
9 * - filesystem drivers list
10 * - mount system call
11 * - umount system call
12 * - ustat system call
13 *
14 * GK 2/5/95 - Changed to support mounting the root fs via NFS
15 *
16 * Added kerneld support: Jacques Gelinas and Bjorn Ekwall
17 * Added change_root: Werner Almesberger & Hans Lermen, Feb '96
18 * Added options to /proc/mounts:
Jan Engelhardt96de0e22007-10-19 23:21:04 +020019 * Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
Linus Torvalds1da177e2005-04-16 15:20:36 -070020 * Added devfs support: Richard Gooch <rgooch@atnf.csiro.au>, 13-JAN-1998
21 * Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
22 */
23
Paul Gortmaker630d9c42011-11-16 23:57:37 -050024#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/blkdev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#include <linux/mount.h>
28#include <linux/security.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/writeback.h> /* for the emergency remount stuff */
30#include <linux/idr.h>
Ingo Molnar353ab6e2006-03-26 01:37:12 -080031#include <linux/mutex.h>
Jens Axboe5477d0f2010-04-29 20:33:35 +020032#include <linux/backing-dev.h>
Nick Pigginceb5bdc2011-01-07 17:50:05 +110033#include <linux/rculist_bl.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060034#include <linux/cleancache.h>
Al Viro40401532012-02-13 03:58:52 +000035#include <linux/fsnotify.h>
Jan Kara5accdf82012-06-12 16:20:34 +020036#include <linux/lockdep.h>
Eric W. Biederman6e4eab52016-05-24 09:29:01 -050037#include <linux/user_namespace.h>
Al Viro6d59e7f2008-03-22 15:48:17 -040038#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40
Al Viro15d0f5e2015-02-02 10:07:59 -070041static LIST_HEAD(super_blocks);
42static DEFINE_SPINLOCK(sb_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Jan Kara5accdf82012-06-12 16:20:34 +020044static char *sb_writers_name[SB_FREEZE_LEVELS] = {
45 "sb_writers",
46 "sb_pagefaults",
47 "sb_internal",
48};
49
Dave Chinnerb0d40c92011-07-08 14:14:42 +100050/*
51 * One thing we have to be careful of with a per-sb shrinker is that we don't
52 * drop the last active reference to the superblock from within the shrinker.
53 * If that happens we could trigger unregistering the shrinker from within the
54 * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
55 * take a passive reference to the superblock to avoid this from occurring.
56 */
Dave Chinner0a234c62013-08-28 10:17:57 +100057static unsigned long super_cache_scan(struct shrinker *shrink,
58 struct shrink_control *sc)
Dave Chinnerb0d40c92011-07-08 14:14:42 +100059{
60 struct super_block *sb;
Dave Chinner0a234c62013-08-28 10:17:57 +100061 long fs_objects = 0;
62 long total_objects;
63 long freed = 0;
64 long dentries;
65 long inodes;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100066
67 sb = container_of(shrink, struct super_block, s_shrink);
68
69 /*
70 * Deadlock avoidance. We may hold various FS locks, and we don't want
71 * to recurse into the FS that called us in clear_inode() and friends..
72 */
Dave Chinner0a234c62013-08-28 10:17:57 +100073 if (!(sc->gfp_mask & __GFP_FS))
74 return SHRINK_STOP;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100075
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +030076 if (!trylock_super(sb))
Dave Chinner0a234c62013-08-28 10:17:57 +100077 return SHRINK_STOP;
Dave Chinnerb0d40c92011-07-08 14:14:42 +100078
Al Virod0407902013-07-19 21:12:31 +040079 if (sb->s_op->nr_cached_objects)
Vladimir Davydov4101b622015-02-12 14:58:51 -080080 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
Dave Chinner0e1fdaf2011-07-08 14:14:44 +100081
Vladimir Davydov503c3582015-02-12 14:58:47 -080082 inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
83 dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
Dave Chinnerf6041562013-08-28 10:18:00 +100084 total_objects = dentries + inodes + fs_objects + 1;
Tetsuo Handa475d0db2014-05-17 20:56:38 +090085 if (!total_objects)
86 total_objects = 1;
Dave Chinner0e1fdaf2011-07-08 14:14:44 +100087
Dave Chinner0a234c62013-08-28 10:17:57 +100088 /* proportion the scan between the caches */
Dave Chinnerf6041562013-08-28 10:18:00 +100089 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
Dave Chinnerbc3b14c2013-08-28 10:17:58 +100090 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
Vladimir Davydov503c3582015-02-12 14:58:47 -080091 fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
Dave Chinnerb0d40c92011-07-08 14:14:42 +100092
Dave Chinner0a234c62013-08-28 10:17:57 +100093 /*
94 * prune the dcache first as the icache is pinned by it, then
95 * prune the icache, followed by the filesystem specific caches
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -080096 *
97 * Ensure that we always scan at least one object - memcg kmem
98 * accounting uses this to fully empty the caches.
Dave Chinner0a234c62013-08-28 10:17:57 +100099 */
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800100 sc->nr_to_scan = dentries + 1;
Vladimir Davydov503c3582015-02-12 14:58:47 -0800101 freed = prune_dcache_sb(sb, sc);
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800102 sc->nr_to_scan = inodes + 1;
Vladimir Davydov503c3582015-02-12 14:58:47 -0800103 freed += prune_icache_sb(sb, sc);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000104
Dave Chinner0a234c62013-08-28 10:17:57 +1000105 if (fs_objects) {
Vladimir Davydov49e7e7f2015-02-12 14:59:17 -0800106 sc->nr_to_scan = fs_objects + 1;
Vladimir Davydov4101b622015-02-12 14:58:51 -0800107 freed += sb->s_op->free_cached_objects(sb, sc);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000108 }
109
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300110 up_read(&sb->s_umount);
Dave Chinner0a234c62013-08-28 10:17:57 +1000111 return freed;
112}
113
114static unsigned long super_cache_count(struct shrinker *shrink,
115 struct shrink_control *sc)
116{
117 struct super_block *sb;
118 long total_objects = 0;
119
120 sb = container_of(shrink, struct super_block, s_shrink);
121
Tim Chend23da152014-06-04 16:10:47 -0700122 /*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300123 * Don't call trylock_super as it is a potential
Tim Chend23da152014-06-04 16:10:47 -0700124 * scalability bottleneck. The counts could get updated
125 * between super_cache_count and super_cache_scan anyway.
126 * Call to super_cache_count with shrinker_rwsem held
Vladimir Davydov503c3582015-02-12 14:58:47 -0800127 * ensures the safety of call to list_lru_shrink_count() and
Tim Chend23da152014-06-04 16:10:47 -0700128 * s_op->nr_cached_objects().
129 */
Dave Chinner0a234c62013-08-28 10:17:57 +1000130 if (sb->s_op && sb->s_op->nr_cached_objects)
Vladimir Davydov4101b622015-02-12 14:58:51 -0800131 total_objects = sb->s_op->nr_cached_objects(sb, sc);
Dave Chinner0a234c62013-08-28 10:17:57 +1000132
Vladimir Davydov503c3582015-02-12 14:58:47 -0800133 total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
134 total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
Dave Chinner0a234c62013-08-28 10:17:57 +1000135
Glauber Costa55f841c2013-08-28 10:17:53 +1000136 total_objects = vfs_pressure_ratio(total_objects);
Dave Chinner0e1fdaf2011-07-08 14:14:44 +1000137 return total_objects;
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000138}
139
Oleg Nesterov853b39a2015-07-22 20:21:13 +0200140static void destroy_super_work(struct work_struct *work)
141{
142 struct super_block *s = container_of(work, struct super_block,
143 destroy_work);
144 int i;
145
146 for (i = 0; i < SB_FREEZE_LEVELS; i++)
Oleg Nesterov8129ed22015-08-11 17:05:04 +0200147 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
Oleg Nesterov853b39a2015-07-22 20:21:13 +0200148 kfree(s);
149}
150
151static void destroy_super_rcu(struct rcu_head *head)
152{
153 struct super_block *s = container_of(head, struct super_block, rcu);
154 INIT_WORK(&s->destroy_work, destroy_super_work);
155 schedule_work(&s->destroy_work);
156}
157
Al Viro02008942017-10-11 13:48:55 -0400158/* Free a superblock that has never been seen by anyone */
159static void destroy_unused_super(struct super_block *s)
Jan Kara5accdf82012-06-12 16:20:34 +0200160{
Al Viro02008942017-10-11 13:48:55 -0400161 if (!s)
162 return;
163 up_write(&s->s_umount);
Al Viro7eb5e882013-10-01 15:09:58 -0400164 list_lru_destroy(&s->s_dentry_lru);
165 list_lru_destroy(&s->s_inode_lru);
Al Viro7eb5e882013-10-01 15:09:58 -0400166 security_sb_free(s);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500167 put_user_ns(s->s_user_ns);
Al Viro7eb5e882013-10-01 15:09:58 -0400168 kfree(s->s_subtype);
Al Viro02008942017-10-11 13:48:55 -0400169 /* no delays needed */
170 destroy_super_work(&s->destroy_work);
Jan Kara5accdf82012-06-12 16:20:34 +0200171}
172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173/**
174 * alloc_super - create new superblock
Henrik Kretzschmarfe2bbc42006-09-06 00:03:41 -0700175 * @type: filesystem type superblock should belong to
David Howells9249e172012-06-25 12:55:37 +0100176 * @flags: the mount flags
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500177 * @user_ns: User namespace for the super_block
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 *
179 * Allocates and initializes a new &struct super_block. alloc_super()
180 * returns a pointer new superblock or %NULL if allocation had failed.
181 */
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500182static struct super_block *alloc_super(struct file_system_type *type, int flags,
183 struct user_namespace *user_ns)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Oliver Neukum11b0b5a2006-03-25 03:08:13 -0800185 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_USER);
Alexey Dobriyanb87221d2009-09-21 17:01:09 -0700186 static const struct super_operations default_op;
Al Viro7eb5e882013-10-01 15:09:58 -0400187 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188
Al Viro7eb5e882013-10-01 15:09:58 -0400189 if (!s)
190 return NULL;
191
Vladimir Davydovb5bd8562014-01-21 15:48:45 -0800192 INIT_LIST_HEAD(&s->s_mounts);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500193 s->s_user_ns = get_user_ns(user_ns);
Al Viroca0168e2017-12-05 09:32:25 -0500194 init_rwsem(&s->s_umount);
195 lockdep_set_class(&s->s_umount, &type->s_umount_key);
196 /*
197 * sget() can have s_umount recursion.
198 *
199 * When it cannot find a suitable sb, it allocates a new
200 * one (this one), and tries again to find a suitable old
201 * one.
202 *
203 * In case that succeeds, it will acquire the s_umount
204 * lock of the old one. Since these are clearly distrinct
205 * locks, and this object isn't exposed yet, there's no
206 * risk of deadlocks.
207 *
208 * Annotate this by putting this lock in a different
209 * subclass.
210 */
211 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
Vladimir Davydovb5bd8562014-01-21 15:48:45 -0800212
Al Viro7eb5e882013-10-01 15:09:58 -0400213 if (security_sb_alloc(s))
214 goto fail;
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200215
Al Viro7eb5e882013-10-01 15:09:58 -0400216 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
Oleg Nesterov8129ed22015-08-11 17:05:04 +0200217 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
218 sb_writers_name[i],
219 &type->s_writers_key[i]))
Al Viro7eb5e882013-10-01 15:09:58 -0400220 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 }
Al Viro7eb5e882013-10-01 15:09:58 -0400222 init_waitqueue_head(&s->s_writers.wait_unfrozen);
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100223 s->s_bdi = &noop_backing_dev_info;
Al Viro7eb5e882013-10-01 15:09:58 -0400224 s->s_flags = flags;
Eric W. Biedermancc50a072016-06-09 15:44:48 -0500225 if (s->s_user_ns != &init_user_ns)
Eric W. Biederman67690f92016-05-18 13:50:06 -0500226 s->s_iflags |= SB_I_NODEV;
Al Viro7eb5e882013-10-01 15:09:58 -0400227 INIT_HLIST_NODE(&s->s_instances);
228 INIT_HLIST_BL_HEAD(&s->s_anon);
Dave Chinnere97fedb2015-03-04 13:40:00 -0500229 mutex_init(&s->s_sync_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400230 INIT_LIST_HEAD(&s->s_inodes);
Dave Chinner74278da2015-03-04 12:37:22 -0500231 spin_lock_init(&s->s_inode_list_lock);
Dave Chinner6c60d2b2016-07-26 15:21:50 -0700232 INIT_LIST_HEAD(&s->s_inodes_wb);
233 spin_lock_init(&s->s_inode_wblist_lock);
Al Viro7eb5e882013-10-01 15:09:58 -0400234
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800235 if (list_lru_init_memcg(&s->s_dentry_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400236 goto fail;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800237 if (list_lru_init_memcg(&s->s_inode_lru))
Al Viro7eb5e882013-10-01 15:09:58 -0400238 goto fail;
Al Viro7eb5e882013-10-01 15:09:58 -0400239 s->s_count = 1;
240 atomic_set(&s->s_active, 1);
241 mutex_init(&s->s_vfs_rename_mutex);
242 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
Jan Karabc8230e2017-06-08 14:39:48 +0200243 init_rwsem(&s->s_dquot.dqio_sem);
Al Viro7eb5e882013-10-01 15:09:58 -0400244 s->s_maxbytes = MAX_NON_LFS;
245 s->s_op = &default_op;
246 s->s_time_gran = 1000000000;
Vladimir Davydov3cb29d12015-04-14 15:46:48 -0700247 s->cleancache_poolid = CLEANCACHE_NO_POOL;
Al Viro7eb5e882013-10-01 15:09:58 -0400248
249 s->s_shrink.seeks = DEFAULT_SEEKS;
250 s->s_shrink.scan_objects = super_cache_scan;
251 s->s_shrink.count_objects = super_cache_count;
252 s->s_shrink.batch = 1024;
Vladimir Davydov2acb60a2015-02-12 14:59:14 -0800253 s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 return s;
Glauber Costa5ca302c2013-08-28 10:18:18 +1000255
Al Viro7eb5e882013-10-01 15:09:58 -0400256fail:
Al Viro02008942017-10-11 13:48:55 -0400257 destroy_unused_super(s);
Al Viro7eb5e882013-10-01 15:09:58 -0400258 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259}
260
261/* Superblock refcounting */
262
263/*
Al Viro35cf7ba2010-03-22 21:13:53 -0400264 * Drop a superblock's refcount. The caller must hold sb_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 */
Al Viroc645b932017-10-11 13:48:55 -0400266static void __put_super(struct super_block *s)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
Al Viroc645b932017-10-11 13:48:55 -0400268 if (!--s->s_count) {
269 list_del_init(&s->s_list);
270 WARN_ON(s->s_dentry_lru.node);
271 WARN_ON(s->s_inode_lru.node);
272 WARN_ON(!list_empty(&s->s_mounts));
273 security_sb_free(s);
274 put_user_ns(s->s_user_ns);
275 kfree(s->s_subtype);
276 call_rcu(&s->rcu, destroy_super_rcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278}
279
280/**
281 * put_super - drop a temporary reference to superblock
282 * @sb: superblock in question
283 *
284 * Drops a temporary reference, frees superblock if there's no
285 * references left.
286 */
Al Virof47ec3f2011-11-21 21:15:42 -0500287static void put_super(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
289 spin_lock(&sb_lock);
290 __put_super(sb);
291 spin_unlock(&sb_lock);
292}
293
294
295/**
Al Viro74dbbdd2009-05-06 01:07:50 -0400296 * deactivate_locked_super - drop an active reference to superblock
297 * @s: superblock to deactivate
298 *
Masanari Iidabd7ced92016-02-02 22:31:06 +0900299 * Drops an active reference to superblock, converting it into a temporary
Al Viro1712ac82010-03-22 15:22:31 -0400300 * one if there is no other active references left. In that case we
301 * tell fs driver to shut it down and drop the temporary reference we
302 * had just acquired.
303 *
304 * Caller holds exclusive lock on superblock; that lock is released.
Al Viro74dbbdd2009-05-06 01:07:50 -0400305 */
306void deactivate_locked_super(struct super_block *s)
307{
308 struct file_system_type *fs = s->s_type;
Al Virob20bd1a2010-03-22 08:53:19 -0400309 if (atomic_dec_and_test(&s->s_active)) {
Dan Magenheimer31677602011-09-21 11:56:28 -0400310 cleancache_invalidate_fs(s);
Dave Chinnerb0d40c92011-07-08 14:14:42 +1000311 unregister_shrinker(&s->s_shrink);
Dave Chinner28f2cd4f2014-06-04 16:10:46 -0700312 fs->kill_sb(s);
Glauber Costaf5e1dd32013-08-28 10:18:18 +1000313
Vladimir Davydovc0a5b562015-02-12 14:59:07 -0800314 /*
315 * Since list_lru_destroy() may sleep, we cannot call it from
316 * put_super(), where we hold the sb_lock. Therefore we destroy
317 * the lru lists right now.
318 */
319 list_lru_destroy(&s->s_dentry_lru);
320 list_lru_destroy(&s->s_inode_lru);
321
Al Viro74dbbdd2009-05-06 01:07:50 -0400322 put_filesystem(fs);
323 put_super(s);
324 } else {
325 up_write(&s->s_umount);
326 }
327}
328
329EXPORT_SYMBOL(deactivate_locked_super);
330
331/**
Al Viro1712ac82010-03-22 15:22:31 -0400332 * deactivate_super - drop an active reference to superblock
333 * @s: superblock to deactivate
334 *
335 * Variant of deactivate_locked_super(), except that superblock is *not*
336 * locked by caller. If we are going to drop the final active reference,
337 * lock will be acquired prior to that.
338 */
339void deactivate_super(struct super_block *s)
340{
341 if (!atomic_add_unless(&s->s_active, -1, 1)) {
342 down_write(&s->s_umount);
343 deactivate_locked_super(s);
344 }
345}
346
347EXPORT_SYMBOL(deactivate_super);
348
349/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 * grab_super - acquire an active reference
351 * @s: reference we are trying to make active
352 *
353 * Tries to acquire an active reference. grab_super() is used when we
354 * had just found a superblock in super_blocks or fs_type->fs_supers
355 * and want to turn it into a full-blown active reference. grab_super()
356 * is called with sb_lock held and drops it. Returns 1 in case of
357 * success, 0 if we had failed (superblock contents was already dead or
Al Viroacfec9a2013-07-20 03:13:55 +0400358 * dying when grab_super() had been called). Note that this is only
359 * called for superblocks not in rundown mode (== ones still on ->fs_supers
360 * of their type), so increment of ->s_count is OK here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 */
Josh Triplett9c4dbee2006-09-29 01:59:29 -0700362static int grab_super(struct super_block *s) __releases(sb_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363{
364 s->s_count++;
365 spin_unlock(&sb_lock);
366 down_write(&s->s_umount);
David Howellse462ec52017-07-17 08:45:35 +0100367 if ((s->s_flags & SB_BORN) && atomic_inc_not_zero(&s->s_active)) {
Al Viroacfec9a2013-07-20 03:13:55 +0400368 put_super(s);
369 return 1;
370 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 up_write(&s->s_umount);
372 put_super(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 return 0;
374}
375
David Howellscf9a2ae2006-08-29 19:05:54 +0100376/*
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300377 * trylock_super - try to grab ->s_umount shared
Wanpeng Li331cbde2012-06-09 11:10:55 +0800378 * @sb: reference we are trying to grab
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000379 *
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300380 * Try to prevent fs shutdown. This is used in places where we
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000381 * cannot take an active reference but we need to ensure that the
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300382 * filesystem is not shut down while we are working on it. It returns
383 * false if we cannot acquire s_umount or if we lose the race and
384 * filesystem already got into shutdown, and returns true with the s_umount
385 * lock held in read mode in case of success. On successful return,
386 * the caller must drop the s_umount lock when done.
387 *
388 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
389 * The reason why it's safe is that we are OK with doing trylock instead
390 * of down_read(). There's a couple of places that are OK with that, but
391 * it's very much not a general-purpose interface.
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000392 */
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300393bool trylock_super(struct super_block *sb)
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000394{
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000395 if (down_read_trylock(&sb->s_umount)) {
Konstantin Khlebnikoveb6ef3d2015-02-19 20:19:35 +0300396 if (!hlist_unhashed(&sb->s_instances) &&
David Howellse462ec52017-07-17 08:45:35 +0100397 sb->s_root && (sb->s_flags & SB_BORN))
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000398 return true;
399 up_read(&sb->s_umount);
400 }
401
Dave Chinner12ad3ab2011-07-08 14:14:41 +1000402 return false;
403}
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405/**
406 * generic_shutdown_super - common helper for ->kill_sb()
407 * @sb: superblock to kill
408 *
409 * generic_shutdown_super() does all fs-independent work on superblock
410 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
411 * that need destruction out of superblock, call generic_shutdown_super()
412 * and release aforementioned objects. Note: dentries and inodes _are_
413 * taken care of and do not need specific handling.
David Howellsc636ebd2006-10-11 01:22:19 -0700414 *
415 * Upon calling this function, the filesystem may no longer alter or
416 * rearrange the set of dentries belonging to this super_block, nor may it
417 * change the attachments of dentries to inodes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 */
419void generic_shutdown_super(struct super_block *sb)
420{
Josef 'Jeff' Sipekee9b6d62007-02-12 00:55:41 -0800421 const struct super_operations *sop = sb->s_op;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422
David Howellsc636ebd2006-10-11 01:22:19 -0700423 if (sb->s_root) {
424 shrink_dcache_for_umount(sb);
Jan Kara60b06802009-04-27 16:43:53 +0200425 sync_filesystem(sb);
David Howellse462ec52017-07-17 08:45:35 +0100426 sb->s_flags &= ~SB_ACTIVE;
Arjan van de Venefaee192009-01-06 07:20:54 -0800427
Dave Chinner74278da2015-03-04 12:37:22 -0500428 fsnotify_unmount_inodes(sb);
Tejun Heoa1a0e232016-02-29 18:28:53 -0500429 cgroup_writeback_umount();
Al Viro63997e92010-10-25 20:49:35 -0400430
431 evict_inodes(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Christoph Hellwig7b7a8662013-09-04 15:04:39 +0200433 if (sb->s_dio_done_wq) {
434 destroy_workqueue(sb->s_dio_done_wq);
435 sb->s_dio_done_wq = NULL;
436 }
437
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 if (sop->put_super)
439 sop->put_super(sb);
440
Al Viro63997e92010-10-25 20:49:35 -0400441 if (!list_empty(&sb->s_inodes)) {
Dave Jones7b4fe292006-02-07 12:58:48 -0800442 printk("VFS: Busy inodes after unmount of %s. "
443 "Self-destruct in 5 seconds. Have a nice day...\n",
444 sb->s_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 }
447 spin_lock(&sb_lock);
448 /* should be initialized for __put_super_and_need_restart() */
Al Viroa5166162011-12-12 22:53:00 -0500449 hlist_del_init(&sb->s_instances);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 spin_unlock(&sb_lock);
451 up_write(&sb->s_umount);
Jan Karac1844d52017-04-12 12:24:47 +0200452 if (sb->s_bdi != &noop_backing_dev_info) {
Jan Karafca39342017-04-12 12:24:28 +0200453 bdi_put(sb->s_bdi);
454 sb->s_bdi = &noop_backing_dev_info;
Jan Karafca39342017-04-12 12:24:28 +0200455 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456}
457
458EXPORT_SYMBOL(generic_shutdown_super);
459
460/**
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500461 * sget_userns - find or create a superblock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 * @type: filesystem type superblock should belong to
463 * @test: comparison callback
464 * @set: setup callback
David Howells9249e172012-06-25 12:55:37 +0100465 * @flags: mount flags
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500466 * @user_ns: User namespace for the super_block
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 * @data: argument to each of them
468 */
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500469struct super_block *sget_userns(struct file_system_type *type,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 int (*test)(struct super_block *,void *),
471 int (*set)(struct super_block *,void *),
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500472 int flags, struct user_namespace *user_ns,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 void *data)
474{
475 struct super_block *s = NULL;
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700476 struct super_block *old;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 int err;
478
David Howellse462ec52017-07-17 08:45:35 +0100479 if (!(flags & (SB_KERNMOUNT|SB_SUBMOUNT)) &&
Eric W. Biedermana001e742016-06-06 15:48:04 -0500480 !(type->fs_flags & FS_USERNS_MOUNT) &&
481 !capable(CAP_SYS_ADMIN))
482 return ERR_PTR(-EPERM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483retry:
484 spin_lock(&sb_lock);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700485 if (test) {
Sasha Levinb67bfe02013-02-27 17:06:00 -0800486 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700487 if (!test(old, data))
488 continue;
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500489 if (user_ns != old->s_user_ns) {
490 spin_unlock(&sb_lock);
Al Viro02008942017-10-11 13:48:55 -0400491 destroy_unused_super(s);
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500492 return ERR_PTR(-EBUSY);
493 }
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700494 if (!grab_super(old))
495 goto retry;
Al Viro02008942017-10-11 13:48:55 -0400496 destroy_unused_super(s);
Matthias Kaehlcked4730122007-10-18 23:39:57 -0700497 return old;
498 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 }
500 if (!s) {
501 spin_unlock(&sb_lock);
David Howellse462ec52017-07-17 08:45:35 +0100502 s = alloc_super(type, (flags & ~SB_SUBMOUNT), user_ns);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 if (!s)
504 return ERR_PTR(-ENOMEM);
505 goto retry;
506 }
David Howellsdd111b32017-07-04 17:25:09 +0100507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 err = set(s, data);
509 if (err) {
510 spin_unlock(&sb_lock);
Al Viro02008942017-10-11 13:48:55 -0400511 destroy_unused_super(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 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
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300542 /* We don't yet pass the user namespace of the parent
543 * mount through to here so always use &init_user_ns
544 * until that changes.
545 */
David Howellse462ec52017-07-17 08:45:35 +0100546 if (flags & SB_SUBMOUNT)
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300547 user_ns = &init_user_ns;
548
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500549 /* Ensure the requestor has permissions over the target filesystem */
David Howellse462ec52017-07-17 08:45:35 +0100550 if (!(flags & (SB_KERNMOUNT|SB_SUBMOUNT)) && !ns_capable(user_ns, CAP_SYS_ADMIN))
Eric W. Biederman6e4eab52016-05-24 09:29:01 -0500551 return ERR_PTR(-EPERM);
552
553 return sget_userns(type, test, set, flags, user_ns, data);
554}
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556EXPORT_SYMBOL(sget);
557
558void drop_super(struct super_block *sb)
559{
560 up_read(&sb->s_umount);
561 put_super(sb);
562}
563
564EXPORT_SYMBOL(drop_super);
565
Jan Karaba6379f2016-11-23 12:53:00 +0100566void drop_super_exclusive(struct super_block *sb)
567{
568 up_write(&sb->s_umount);
569 put_super(sb);
570}
571EXPORT_SYMBOL(drop_super_exclusive);
572
Christoph Hellwige5004752009-05-05 16:08:56 +0200573/**
Al Viro01a05b32010-03-23 06:06:58 -0400574 * iterate_supers - call function for all active superblocks
575 * @f: function to call
576 * @arg: argument to pass to it
577 *
578 * Scans the superblock list and calls given function, passing it
579 * locked superblock and given argument.
580 */
581void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
582{
Al Virodca33252010-07-25 02:31:46 +0400583 struct super_block *sb, *p = NULL;
Al Viro01a05b32010-03-23 06:06:58 -0400584
585 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400586 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500587 if (hlist_unhashed(&sb->s_instances))
Al Viro01a05b32010-03-23 06:06:58 -0400588 continue;
589 sb->s_count++;
590 spin_unlock(&sb_lock);
591
592 down_read(&sb->s_umount);
David Howellse462ec52017-07-17 08:45:35 +0100593 if (sb->s_root && (sb->s_flags & SB_BORN))
Al Viro01a05b32010-03-23 06:06:58 -0400594 f(sb, arg);
595 up_read(&sb->s_umount);
596
597 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400598 if (p)
599 __put_super(p);
600 p = sb;
Al Viro01a05b32010-03-23 06:06:58 -0400601 }
Al Virodca33252010-07-25 02:31:46 +0400602 if (p)
603 __put_super(p);
Al Viro01a05b32010-03-23 06:06:58 -0400604 spin_unlock(&sb_lock);
605}
606
607/**
Al Viro43e15cd2011-06-03 20:16:57 -0400608 * iterate_supers_type - call function for superblocks of given type
609 * @type: fs type
610 * @f: function to call
611 * @arg: argument to pass to it
612 *
613 * Scans the superblock list and calls given function, passing it
614 * locked superblock and given argument.
615 */
616void iterate_supers_type(struct file_system_type *type,
617 void (*f)(struct super_block *, void *), void *arg)
618{
619 struct super_block *sb, *p = NULL;
620
621 spin_lock(&sb_lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800622 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
Al Viro43e15cd2011-06-03 20:16:57 -0400623 sb->s_count++;
624 spin_unlock(&sb_lock);
625
626 down_read(&sb->s_umount);
David Howellse462ec52017-07-17 08:45:35 +0100627 if (sb->s_root && (sb->s_flags & SB_BORN))
Al Viro43e15cd2011-06-03 20:16:57 -0400628 f(sb, arg);
629 up_read(&sb->s_umount);
630
631 spin_lock(&sb_lock);
632 if (p)
633 __put_super(p);
634 p = sb;
635 }
636 if (p)
637 __put_super(p);
638 spin_unlock(&sb_lock);
639}
640
641EXPORT_SYMBOL(iterate_supers_type);
642
Jan Karaba6379f2016-11-23 12:53:00 +0100643static struct super_block *__get_super(struct block_device *bdev, bool excl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700645 struct super_block *sb;
646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 if (!bdev)
648 return NULL;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700651rescan:
652 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500653 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400654 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700655 if (sb->s_bdev == bdev) {
656 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 spin_unlock(&sb_lock);
Jan Karaba6379f2016-11-23 12:53:00 +0100658 if (!excl)
659 down_read(&sb->s_umount);
660 else
661 down_write(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400662 /* still alive? */
David Howellse462ec52017-07-17 08:45:35 +0100663 if (sb->s_root && (sb->s_flags & SB_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700664 return sb;
Jan Karaba6379f2016-11-23 12:53:00 +0100665 if (!excl)
666 up_read(&sb->s_umount);
667 else
668 up_write(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400669 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700670 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400671 __put_super(sb);
672 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 }
674 }
675 spin_unlock(&sb_lock);
676 return NULL;
677}
678
Jan Karaba6379f2016-11-23 12:53:00 +0100679/**
680 * get_super - get the superblock of a device
681 * @bdev: device to get the superblock for
682 *
683 * Scans the superblock list and finds the superblock of the file system
684 * mounted on the device given. %NULL is returned if no match is found.
685 */
686struct super_block *get_super(struct block_device *bdev)
687{
688 return __get_super(bdev, false);
689}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690EXPORT_SYMBOL(get_super);
Christoph Hellwig45042302009-08-03 23:28:35 +0200691
Jan Karaba6379f2016-11-23 12:53:00 +0100692static struct super_block *__get_super_thawed(struct block_device *bdev,
693 bool excl)
694{
695 while (1) {
696 struct super_block *s = __get_super(bdev, excl);
697 if (!s || s->s_writers.frozen == SB_UNFROZEN)
698 return s;
699 if (!excl)
700 up_read(&s->s_umount);
701 else
702 up_write(&s->s_umount);
703 wait_event(s->s_writers.wait_unfrozen,
704 s->s_writers.frozen == SB_UNFROZEN);
705 put_super(s);
706 }
707}
708
Christoph Hellwig45042302009-08-03 23:28:35 +0200709/**
Jan Kara6b6dc832012-02-10 11:03:00 +0100710 * get_super_thawed - get thawed superblock of a device
711 * @bdev: device to get the superblock for
712 *
713 * Scans the superblock list and finds the superblock of the file system
714 * mounted on the device. The superblock is returned once it is thawed
715 * (or immediately if it was not frozen). %NULL is returned if no match
716 * is found.
717 */
718struct super_block *get_super_thawed(struct block_device *bdev)
719{
Jan Karaba6379f2016-11-23 12:53:00 +0100720 return __get_super_thawed(bdev, false);
Jan Kara6b6dc832012-02-10 11:03:00 +0100721}
722EXPORT_SYMBOL(get_super_thawed);
723
724/**
Jan Karaba6379f2016-11-23 12:53:00 +0100725 * get_super_exclusive_thawed - get thawed superblock of a device
726 * @bdev: device to get the superblock for
727 *
728 * Scans the superblock list and finds the superblock of the file system
729 * mounted on the device. The superblock is returned once it is thawed
730 * (or immediately if it was not frozen) and s_umount semaphore is held
731 * in exclusive mode. %NULL is returned if no match is found.
732 */
733struct super_block *get_super_exclusive_thawed(struct block_device *bdev)
734{
735 return __get_super_thawed(bdev, true);
736}
737EXPORT_SYMBOL(get_super_exclusive_thawed);
738
739/**
Christoph Hellwig45042302009-08-03 23:28:35 +0200740 * get_active_super - get an active reference to the superblock of a device
741 * @bdev: device to get the superblock for
742 *
743 * Scans the superblock list and finds the superblock of the file system
744 * mounted on the device given. Returns the superblock with an active
Al Virod3f21472010-03-23 11:11:05 -0400745 * reference or %NULL if none was found.
Christoph Hellwig45042302009-08-03 23:28:35 +0200746 */
747struct super_block *get_active_super(struct block_device *bdev)
748{
749 struct super_block *sb;
750
751 if (!bdev)
752 return NULL;
753
Al Viro14945832010-03-22 20:15:33 -0400754restart:
Christoph Hellwig45042302009-08-03 23:28:35 +0200755 spin_lock(&sb_lock);
756 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500757 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400758 continue;
Al Viro14945832010-03-22 20:15:33 -0400759 if (sb->s_bdev == bdev) {
Al Viroacfec9a2013-07-20 03:13:55 +0400760 if (!grab_super(sb))
Al Viro14945832010-03-22 20:15:33 -0400761 goto restart;
Al Viroacfec9a2013-07-20 03:13:55 +0400762 up_write(&sb->s_umount);
763 return sb;
Al Viro14945832010-03-22 20:15:33 -0400764 }
Christoph Hellwig45042302009-08-03 23:28:35 +0200765 }
766 spin_unlock(&sb_lock);
767 return NULL;
768}
David Howellsdd111b32017-07-04 17:25:09 +0100769
Al Virodf40c012010-03-22 20:23:25 -0400770struct super_block *user_get_super(dev_t dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771{
Kirill Korotaev618f0632005-06-23 00:09:54 -0700772 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 spin_lock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700775rescan:
776 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500777 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400778 continue;
Kirill Korotaev618f0632005-06-23 00:09:54 -0700779 if (sb->s_dev == dev) {
780 sb->s_count++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 spin_unlock(&sb_lock);
Kirill Korotaev618f0632005-06-23 00:09:54 -0700782 down_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400783 /* still alive? */
David Howellse462ec52017-07-17 08:45:35 +0100784 if (sb->s_root && (sb->s_flags & SB_BORN))
Kirill Korotaev618f0632005-06-23 00:09:54 -0700785 return sb;
786 up_read(&sb->s_umount);
Al Virodf40c012010-03-22 20:23:25 -0400787 /* nope, got unmounted */
Kirill Korotaev618f0632005-06-23 00:09:54 -0700788 spin_lock(&sb_lock);
Al Virodf40c012010-03-22 20:23:25 -0400789 __put_super(sb);
790 goto rescan;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 }
792 }
793 spin_unlock(&sb_lock);
794 return NULL;
795}
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 * do_remount_sb - asks filesystem to change mount options.
799 * @sb: superblock in question
David Howellse462ec52017-07-17 08:45:35 +0100800 * @sb_flags: revised superblock flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 * @data: the rest of options
802 * @force: whether or not to force the change
803 *
804 * Alters the mount options of a mounted file system.
805 */
David Howellse462ec52017-07-17 08:45:35 +0100806int do_remount_sb(struct super_block *sb, int sb_flags, void *data, int force)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807{
808 int retval;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400809 int remount_ro;
Christoph Hellwig45042302009-08-03 23:28:35 +0200810
Jan Kara5accdf82012-06-12 16:20:34 +0200811 if (sb->s_writers.frozen != SB_UNFROZEN)
Christoph Hellwig45042302009-08-03 23:28:35 +0200812 return -EBUSY;
813
David Howells93614012006-09-30 20:45:40 +0200814#ifdef CONFIG_BLOCK
David Howellse462ec52017-07-17 08:45:35 +0100815 if (!(sb_flags & SB_RDONLY) && bdev_read_only(sb->s_bdev))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 return -EACCES;
David Howells93614012006-09-30 20:45:40 +0200817#endif
Christoph Hellwig45042302009-08-03 23:28:35 +0200818
David Howellse462ec52017-07-17 08:45:35 +0100819 remount_ro = (sb_flags & SB_RDONLY) && !sb_rdonly(sb);
Nick Piggind208bbd2009-12-21 16:28:53 -0800820
Al Viro0aec09d2014-08-07 07:32:06 -0400821 if (remount_ro) {
Al Virofdab6842015-01-11 10:57:27 -0500822 if (!hlist_empty(&sb->s_pins)) {
Al Viro0aec09d2014-08-07 07:32:06 -0400823 up_write(&sb->s_umount);
Al Virofdab6842015-01-11 10:57:27 -0500824 group_pin_kill(&sb->s_pins);
Al Viro0aec09d2014-08-07 07:32:06 -0400825 down_write(&sb->s_umount);
826 if (!sb->s_root)
827 return 0;
828 if (sb->s_writers.frozen != SB_UNFROZEN)
829 return -EBUSY;
David Howellse462ec52017-07-17 08:45:35 +0100830 remount_ro = (sb_flags & SB_RDONLY) && !sb_rdonly(sb);
Al Viro0aec09d2014-08-07 07:32:06 -0400831 }
832 }
833 shrink_dcache_sb(sb);
834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 /* If we are remounting RDONLY and current sb is read/write,
836 make sure there are no rw files opened */
Nick Piggind208bbd2009-12-21 16:28:53 -0800837 if (remount_ro) {
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100838 if (force) {
Al Viroeee5cc22013-10-04 11:06:42 -0400839 sb->s_readonly_remount = 1;
840 smp_wmb();
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100841 } else {
842 retval = sb_prepare_remount_readonly(sb);
843 if (retval)
844 return retval;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100845 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 }
847
848 if (sb->s_op->remount_fs) {
David Howellse462ec52017-07-17 08:45:35 +0100849 retval = sb->s_op->remount_fs(sb, &sb_flags, data);
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200850 if (retval) {
851 if (!force)
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100852 goto cancel_readonly;
Miklos Szeredi2833eb22011-10-28 14:13:20 +0200853 /* If forced remount, go ahead despite any errors */
854 WARN(1, "forced remount of a %s fs returned %i\n",
855 sb->s_type->name, retval);
856 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 }
David Howellse462ec52017-07-17 08:45:35 +0100858 sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (sb_flags & MS_RMT_MASK);
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100859 /* Needs to be ordered wrt mnt_is_readonly() */
860 smp_wmb();
861 sb->s_readonly_remount = 0;
Christoph Hellwigc79d9672010-05-19 07:16:40 -0400862
Nick Piggind208bbd2009-12-21 16:28:53 -0800863 /*
864 * Some filesystems modify their metadata via some other path than the
865 * bdev buffer cache (eg. use a private mapping, or directories in
866 * pagecache, etc). Also file data modifications go via their own
867 * mappings. So If we try to mount readonly then copy the filesystem
868 * from bdev, we could get stale data, so invalidate it to give a best
869 * effort at coherency.
870 */
871 if (remount_ro && sb->s_bdev)
872 invalidate_bdev(sb->s_bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 return 0;
Miklos Szeredi4ed5e822011-11-21 12:11:31 +0100874
875cancel_readonly:
876 sb->s_readonly_remount = 0;
877 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878}
879
Jens Axboea2a95372009-03-17 09:38:40 +0100880static void do_emergency_remount(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881{
Al Virodca33252010-07-25 02:31:46 +0400882 struct super_block *sb, *p = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400885 list_for_each_entry(sb, &super_blocks, s_list) {
Al Viroa5166162011-12-12 22:53:00 -0500886 if (hlist_unhashed(&sb->s_instances))
Al Viro551de6f2010-03-22 19:36:35 -0400887 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 sb->s_count++;
889 spin_unlock(&sb_lock);
Al Viro443b94b2009-05-05 23:48:50 -0400890 down_write(&sb->s_umount);
David Howellse462ec52017-07-17 08:45:35 +0100891 if (sb->s_root && sb->s_bdev && (sb->s_flags & SB_BORN) &&
David Howellsbc98a422017-07-17 08:45:34 +0100892 !sb_rdonly(sb)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 * What lock protects sb->s_flags??
895 */
David Howellse462ec52017-07-17 08:45:35 +0100896 do_remount_sb(sb, SB_RDONLY, NULL, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 }
Al Viro443b94b2009-05-05 23:48:50 -0400898 up_write(&sb->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 spin_lock(&sb_lock);
Al Virodca33252010-07-25 02:31:46 +0400900 if (p)
901 __put_super(p);
902 p = sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 }
Al Virodca33252010-07-25 02:31:46 +0400904 if (p)
905 __put_super(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 spin_unlock(&sb_lock);
Jens Axboea2a95372009-03-17 09:38:40 +0100907 kfree(work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 printk("Emergency Remount complete\n");
909}
910
911void emergency_remount(void)
912{
Jens Axboea2a95372009-03-17 09:38:40 +0100913 struct work_struct *work;
914
915 work = kmalloc(sizeof(*work), GFP_ATOMIC);
916 if (work) {
917 INIT_WORK(work, do_emergency_remount);
918 schedule_work(work);
919 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920}
921
922/*
923 * Unnamed block devices are dummy devices used by virtual
924 * filesystems which don't use real block-devices. -- jrs
925 */
926
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400927static DEFINE_IDA(unnamed_dev_ida);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
Thomas Bächlera2a4dc42014-04-03 21:55:37 +0200929/* Many userspace utilities consider an FSID of 0 invalid.
930 * Always return at least 1 from get_anon_bdev.
931 */
932static int unnamed_dev_start = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Al Viro0ee5dc62011-07-07 15:44:25 -0400934int get_anon_bdev(dev_t *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
936 int dev;
937 int error;
938
939 retry:
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400940 if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 return -ENOMEM;
942 spin_lock(&unnamed_dev_lock);
Al Viroc63e09e2009-06-24 02:05:18 -0400943 error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
Al Virof21f6222009-06-24 03:12:00 -0400944 if (!error)
945 unnamed_dev_start = dev + 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 spin_unlock(&unnamed_dev_lock);
947 if (error == -EAGAIN)
948 /* We raced and lost with another CPU. */
949 goto retry;
950 else if (error)
951 return -EAGAIN;
952
Wang YanQing1af95de2015-06-23 18:54:45 +0800953 if (dev >= (1 << MINORBITS)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 spin_lock(&unnamed_dev_lock);
Alexey Dobriyanad76cbc2008-08-28 06:26:23 +0400955 ida_remove(&unnamed_dev_ida, dev);
Al Virof21f6222009-06-24 03:12:00 -0400956 if (unnamed_dev_start > dev)
957 unnamed_dev_start = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 spin_unlock(&unnamed_dev_lock);
959 return -EMFILE;
960 }
Al Viro0ee5dc62011-07-07 15:44:25 -0400961 *p = MKDEV(0, dev & MINORMASK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return 0;
963}
Al Viro0ee5dc62011-07-07 15:44:25 -0400964EXPORT_SYMBOL(get_anon_bdev);
965
966void free_anon_bdev(dev_t dev)
967{
968 int slot = MINOR(dev);
969 spin_lock(&unnamed_dev_lock);
970 ida_remove(&unnamed_dev_ida, slot);
971 if (slot < unnamed_dev_start)
972 unnamed_dev_start = slot;
973 spin_unlock(&unnamed_dev_lock);
974}
975EXPORT_SYMBOL(free_anon_bdev);
976
977int set_anon_super(struct super_block *s, void *data)
978{
Christoph Hellwigdf0ce262015-01-14 10:42:41 +0100979 return get_anon_bdev(&s->s_dev);
Al Viro0ee5dc62011-07-07 15:44:25 -0400980}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
982EXPORT_SYMBOL(set_anon_super);
983
984void kill_anon_super(struct super_block *sb)
985{
Al Viro0ee5dc62011-07-07 15:44:25 -0400986 dev_t dev = sb->s_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 generic_shutdown_super(sb);
Al Viro0ee5dc62011-07-07 15:44:25 -0400988 free_anon_bdev(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989}
990
991EXPORT_SYMBOL(kill_anon_super);
992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993void kill_litter_super(struct super_block *sb)
994{
995 if (sb->s_root)
996 d_genocide(sb->s_root);
997 kill_anon_super(sb);
998}
999
1000EXPORT_SYMBOL(kill_litter_super);
1001
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001002static int ns_test_super(struct super_block *sb, void *data)
1003{
1004 return sb->s_fs_info == data;
1005}
1006
1007static int ns_set_super(struct super_block *sb, void *data)
1008{
1009 sb->s_fs_info = data;
1010 return set_anon_super(sb, NULL);
1011}
1012
Eric W. Biedermand91ee872016-05-23 14:51:59 -05001013struct dentry *mount_ns(struct file_system_type *fs_type,
1014 int flags, void *data, void *ns, struct user_namespace *user_ns,
1015 int (*fill_super)(struct super_block *, void *, int))
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001016{
1017 struct super_block *sb;
1018
Eric W. Biedermand91ee872016-05-23 14:51:59 -05001019 /* Don't allow mounting unless the caller has CAP_SYS_ADMIN
1020 * over the namespace.
1021 */
David Howellse462ec52017-07-17 08:45:35 +01001022 if (!(flags & SB_KERNMOUNT) && !ns_capable(user_ns, CAP_SYS_ADMIN))
Eric W. Biedermand91ee872016-05-23 14:51:59 -05001023 return ERR_PTR(-EPERM);
1024
Eric W. Biederman6e4eab52016-05-24 09:29:01 -05001025 sb = sget_userns(fs_type, ns_test_super, ns_set_super, flags,
1026 user_ns, ns);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001027 if (IS_ERR(sb))
Al Viroceefda62010-07-26 13:16:50 +04001028 return ERR_CAST(sb);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001029
1030 if (!sb->s_root) {
1031 int err;
David Howellse462ec52017-07-17 08:45:35 +01001032 err = fill_super(sb, data, flags & SB_SILENT ? 1 : 0);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001033 if (err) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001034 deactivate_locked_super(sb);
Al Viroceefda62010-07-26 13:16:50 +04001035 return ERR_PTR(err);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001036 }
1037
David Howellse462ec52017-07-17 08:45:35 +01001038 sb->s_flags |= SB_ACTIVE;
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001039 }
1040
Al Viroceefda62010-07-26 13:16:50 +04001041 return dget(sb->s_root);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001042}
1043
Al Viroceefda62010-07-26 13:16:50 +04001044EXPORT_SYMBOL(mount_ns);
Serge E. Hallyn909e6d92009-04-06 19:01:07 -07001045
David Howells93614012006-09-30 20:45:40 +02001046#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047static int set_bdev_super(struct super_block *s, void *data)
1048{
1049 s->s_bdev = data;
1050 s->s_dev = s->s_bdev->bd_dev;
Jan Kara13eec232017-04-12 12:24:29 +02001051 s->s_bdi = bdi_get(s->s_bdev->bd_bdi);
Jens Axboe32a88aa2009-09-16 15:02:33 +02001052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 return 0;
1054}
1055
1056static int test_bdev_super(struct super_block *s, void *data)
1057{
1058 return (void *)s->s_bdev == data;
1059}
1060
Al Viro152a0832010-07-25 00:46:55 +04001061struct dentry *mount_bdev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 int flags, const char *dev_name, void *data,
Al Viro152a0832010-07-25 00:46:55 +04001063 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064{
1065 struct block_device *bdev;
1066 struct super_block *s;
Tejun Heod4d77622010-11-13 11:55:18 +01001067 fmode_t mode = FMODE_READ | FMODE_EXCL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 int error = 0;
1069
David Howellse462ec52017-07-17 08:45:35 +01001070 if (!(flags & SB_RDONLY))
Al Viro30c40d22008-02-22 19:50:45 -05001071 mode |= FMODE_WRITE;
1072
Tejun Heod4d77622010-11-13 11:55:18 +01001073 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 if (IS_ERR(bdev))
Al Viro152a0832010-07-25 00:46:55 +04001075 return ERR_CAST(bdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077 /*
1078 * once the super is inserted into the list by sget, s_umount
1079 * will protect the lockfs code from trying to start a snapshot
1080 * while we are mounting
1081 */
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +02001082 mutex_lock(&bdev->bd_fsfreeze_mutex);
1083 if (bdev->bd_fsfreeze_count > 0) {
1084 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1085 error = -EBUSY;
1086 goto error_bdev;
1087 }
David Howellse462ec52017-07-17 08:45:35 +01001088 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | SB_NOSEC,
David Howells9249e172012-06-25 12:55:37 +01001089 bdev);
Christoph Hellwig4fadd7b2009-08-03 23:28:06 +02001090 mutex_unlock(&bdev->bd_fsfreeze_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 if (IS_ERR(s))
David Howells454e2392006-06-23 02:02:57 -07001092 goto error_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093
1094 if (s->s_root) {
David Howellse462ec52017-07-17 08:45:35 +01001095 if ((flags ^ s->s_flags) & SB_RDONLY) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001096 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -07001097 error = -EBUSY;
1098 goto error_bdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 }
David Howells454e2392006-06-23 02:02:57 -07001100
Tejun Heo4f331f02010-07-20 15:18:07 -07001101 /*
1102 * s_umount nests inside bd_mutex during
Tejun Heoe525fd82010-11-13 11:55:17 +01001103 * __invalidate_device(). blkdev_put() acquires
1104 * bd_mutex and can't be called under s_umount. Drop
1105 * s_umount temporarily. This is safe as we're
1106 * holding an active reference.
Tejun Heo4f331f02010-07-20 15:18:07 -07001107 */
1108 up_write(&s->s_umount);
Tejun Heod4d77622010-11-13 11:55:18 +01001109 blkdev_put(bdev, mode);
Tejun Heo4f331f02010-07-20 15:18:07 -07001110 down_write(&s->s_umount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 } else {
Al Viro30c40d22008-02-22 19:50:45 -05001112 s->s_mode = mode;
Dmitry Monakhova1c6f0572015-04-13 16:31:37 +04001113 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
Pekka Enberge78c9a02006-01-08 01:03:39 -08001114 sb_set_blocksize(s, block_size(bdev));
David Howellse462ec52017-07-17 08:45:35 +01001115 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001117 deactivate_locked_super(s);
David Howells454e2392006-06-23 02:02:57 -07001118 goto error;
Greg Kroah-Hartmanfa675762006-02-22 09:39:02 -08001119 }
David Howells454e2392006-06-23 02:02:57 -07001120
David Howellse462ec52017-07-17 08:45:35 +01001121 s->s_flags |= SB_ACTIVE;
Theodore Ts'o87d8fe12009-01-03 09:47:09 -05001122 bdev->bd_super = s;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 }
1124
Al Viro152a0832010-07-25 00:46:55 +04001125 return dget(s->s_root);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126
David Howells454e2392006-06-23 02:02:57 -07001127error_s:
1128 error = PTR_ERR(s);
1129error_bdev:
Tejun Heod4d77622010-11-13 11:55:18 +01001130 blkdev_put(bdev, mode);
David Howells454e2392006-06-23 02:02:57 -07001131error:
Al Viro152a0832010-07-25 00:46:55 +04001132 return ERR_PTR(error);
1133}
1134EXPORT_SYMBOL(mount_bdev);
1135
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136void kill_block_super(struct super_block *sb)
1137{
1138 struct block_device *bdev = sb->s_bdev;
Al Viro30c40d22008-02-22 19:50:45 -05001139 fmode_t mode = sb->s_mode;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
H Hartley Sweetenddbaaf32009-04-29 20:14:57 -04001141 bdev->bd_super = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 generic_shutdown_super(sb);
1143 sync_blockdev(bdev);
Tejun Heod4d77622010-11-13 11:55:18 +01001144 WARN_ON_ONCE(!(mode & FMODE_EXCL));
Tejun Heoe525fd82010-11-13 11:55:17 +01001145 blkdev_put(bdev, mode | FMODE_EXCL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146}
1147
1148EXPORT_SYMBOL(kill_block_super);
David Howells93614012006-09-30 20:45:40 +02001149#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Al Viro3c26ff62010-07-25 11:46:36 +04001151struct dentry *mount_nodev(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 int flags, void *data,
Al Viro3c26ff62010-07-25 11:46:36 +04001153 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154{
1155 int error;
David Howells9249e172012-06-25 12:55:37 +01001156 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
1158 if (IS_ERR(s))
Al Viro3c26ff62010-07-25 11:46:36 +04001159 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
David Howellse462ec52017-07-17 08:45:35 +01001161 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001163 deactivate_locked_super(s);
Al Viro3c26ff62010-07-25 11:46:36 +04001164 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 }
David Howellse462ec52017-07-17 08:45:35 +01001166 s->s_flags |= SB_ACTIVE;
Al Viro3c26ff62010-07-25 11:46:36 +04001167 return dget(s->s_root);
1168}
1169EXPORT_SYMBOL(mount_nodev);
1170
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171static int compare_single(struct super_block *s, void *p)
1172{
1173 return 1;
1174}
1175
Al Virofc14f2f2010-07-25 01:48:30 +04001176struct dentry *mount_single(struct file_system_type *fs_type,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 int flags, void *data,
Al Virofc14f2f2010-07-25 01:48:30 +04001178 int (*fill_super)(struct super_block *, void *, int))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179{
1180 struct super_block *s;
1181 int error;
1182
David Howells9249e172012-06-25 12:55:37 +01001183 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 if (IS_ERR(s))
Al Virofc14f2f2010-07-25 01:48:30 +04001185 return ERR_CAST(s);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 if (!s->s_root) {
David Howellse462ec52017-07-17 08:45:35 +01001187 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 if (error) {
Al Viro74dbbdd2009-05-06 01:07:50 -04001189 deactivate_locked_super(s);
Al Virofc14f2f2010-07-25 01:48:30 +04001190 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 }
David Howellse462ec52017-07-17 08:45:35 +01001192 s->s_flags |= SB_ACTIVE;
Kay Sievers9329d1b2009-12-18 21:18:15 +01001193 } else {
1194 do_remount_sb(s, flags, data, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195 }
Al Virofc14f2f2010-07-25 01:48:30 +04001196 return dget(s->s_root);
1197}
1198EXPORT_SYMBOL(mount_single);
1199
Al Viro9d412a42011-03-17 22:08:28 -04001200struct dentry *
1201mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202{
Al Viroc96e41e2010-07-25 00:17:56 +04001203 struct dentry *root;
Al Viro9d412a42011-03-17 22:08:28 -04001204 struct super_block *sb;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 char *secdata = NULL;
Al Viro9d412a42011-03-17 22:08:28 -04001206 int error = -ENOMEM;
Al Viro80893522010-02-05 09:30:46 -05001207
Eric Parise0007522008-03-05 10:31:54 -05001208 if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 secdata = alloc_secdata();
David Howells454e2392006-06-23 02:02:57 -07001210 if (!secdata)
Al Viro9d412a42011-03-17 22:08:28 -04001211 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Eric Parise0007522008-03-05 10:31:54 -05001213 error = security_sb_copy_data(data, secdata);
David Howells454e2392006-06-23 02:02:57 -07001214 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 goto out_free_secdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 }
1217
Al Viro1a102ff2011-03-16 09:07:58 -04001218 root = type->mount(type, flags, name, data);
1219 if (IS_ERR(root)) {
1220 error = PTR_ERR(root);
1221 goto out_free_secdata;
Al Viroc96e41e2010-07-25 00:17:56 +04001222 }
Al Viro9d412a42011-03-17 22:08:28 -04001223 sb = root->d_sb;
1224 BUG_ON(!sb);
1225 WARN_ON(!sb->s_bdi);
David Howellse462ec52017-07-17 08:45:35 +01001226 sb->s_flags |= SB_BORN;
David Howells454e2392006-06-23 02:02:57 -07001227
Al Viro9d412a42011-03-17 22:08:28 -04001228 error = security_sb_kern_mount(sb, flags, secdata);
Jörn Engel5129a462010-04-25 08:54:42 +02001229 if (error)
1230 goto out_sb;
David Howells454e2392006-06-23 02:02:57 -07001231
Jeff Layton42cb56a2009-09-18 13:05:53 -07001232 /*
1233 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1234 * but s_maxbytes was an unsigned long long for many releases. Throw
1235 * this warning for a little while to try and catch filesystems that
Jeff Layton4358b562011-03-29 09:33:31 -04001236 * violate this rule.
Jeff Layton42cb56a2009-09-18 13:05:53 -07001237 */
Al Viro9d412a42011-03-17 22:08:28 -04001238 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1239 "negative value (%lld)\n", type->name, sb->s_maxbytes);
Jeff Layton42cb56a2009-09-18 13:05:53 -07001240
Al Viro9d412a42011-03-17 22:08:28 -04001241 up_write(&sb->s_umount);
Gerald Schaefer8680e222005-06-21 17:15:16 -07001242 free_secdata(secdata);
Al Viro9d412a42011-03-17 22:08:28 -04001243 return root;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244out_sb:
Al Viro9d412a42011-03-17 22:08:28 -04001245 dput(root);
1246 deactivate_locked_super(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247out_free_secdata:
1248 free_secdata(secdata);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249out:
David Howells454e2392006-06-23 02:02:57 -07001250 return ERR_PTR(error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251}
1252
Jan Kara5accdf82012-06-12 16:20:34 +02001253/*
Jan Karafca39342017-04-12 12:24:28 +02001254 * Setup private BDI for given superblock. It gets automatically cleaned up
1255 * in generic_shutdown_super().
1256 */
1257int super_setup_bdi_name(struct super_block *sb, char *fmt, ...)
1258{
1259 struct backing_dev_info *bdi;
1260 int err;
1261 va_list args;
1262
1263 bdi = bdi_alloc(GFP_KERNEL);
1264 if (!bdi)
1265 return -ENOMEM;
1266
1267 bdi->name = sb->s_type->name;
1268
1269 va_start(args, fmt);
Jan Kara7c4cc302017-04-12 12:24:49 +02001270 err = bdi_register_va(bdi, fmt, args);
Jan Karafca39342017-04-12 12:24:28 +02001271 va_end(args);
1272 if (err) {
1273 bdi_put(bdi);
1274 return err;
1275 }
1276 WARN_ON(sb->s_bdi != &noop_backing_dev_info);
1277 sb->s_bdi = bdi;
Jan Karafca39342017-04-12 12:24:28 +02001278
1279 return 0;
1280}
1281EXPORT_SYMBOL(super_setup_bdi_name);
1282
1283/*
1284 * Setup private BDI for given superblock. I gets automatically cleaned up
1285 * in generic_shutdown_super().
1286 */
1287int super_setup_bdi(struct super_block *sb)
1288{
1289 static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1290
1291 return super_setup_bdi_name(sb, "%.28s-%ld", sb->s_type->name,
1292 atomic_long_inc_return(&bdi_seq));
1293}
1294EXPORT_SYMBOL(super_setup_bdi);
1295
1296/*
Jan Kara5accdf82012-06-12 16:20:34 +02001297 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1298 * instead.
1299 */
1300void __sb_end_write(struct super_block *sb, int level)
1301{
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001302 percpu_up_read(sb->s_writers.rw_sem + level-1);
Jan Kara5accdf82012-06-12 16:20:34 +02001303}
1304EXPORT_SYMBOL(__sb_end_write);
1305
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001306/*
1307 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1308 * instead.
1309 */
1310int __sb_start_write(struct super_block *sb, int level, bool wait)
1311{
1312 bool force_trylock = false;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001313 int ret = 1;
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001314
1315#ifdef CONFIG_LOCKDEP
1316 /*
1317 * We want lockdep to tell us about possible deadlocks with freezing
1318 * but it's it bit tricky to properly instrument it. Getting a freeze
1319 * protection works as getting a read lock but there are subtle
1320 * problems. XFS for example gets freeze protection on internal level
1321 * twice in some cases, which is OK only because we already hold a
1322 * freeze protection also on higher level. Due to these cases we have
1323 * to use wait == F (trylock mode) which must not fail.
1324 */
1325 if (wait) {
1326 int i;
1327
1328 for (i = 0; i < level - 1; i++)
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001329 if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001330 force_trylock = true;
1331 break;
1332 }
1333 }
1334#endif
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001335 if (wait && !force_trylock)
1336 percpu_down_read(sb->s_writers.rw_sem + level-1);
1337 else
1338 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1339
Vincent Stehlé22224a12015-09-21 17:18:34 +02001340 WARN_ON(force_trylock && !ret);
Oleg Nesterovf4b554a2015-07-20 00:50:55 +02001341 return ret;
1342}
Jan Kara5accdf82012-06-12 16:20:34 +02001343EXPORT_SYMBOL(__sb_start_write);
1344
1345/**
1346 * sb_wait_write - wait until all writers to given file system finish
1347 * @sb: the super for which we wait
1348 * @level: type of writers we wait for (normal vs page fault)
1349 *
1350 * This function waits until there are no writers of given type to given file
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001351 * system.
Jan Kara5accdf82012-06-12 16:20:34 +02001352 */
1353static void sb_wait_write(struct super_block *sb, int level)
1354{
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001355 percpu_down_write(sb->s_writers.rw_sem + level-1);
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001356}
Jan Kara5accdf82012-06-12 16:20:34 +02001357
Oleg Nesterovf1a96222016-09-26 18:55:25 +02001358/*
1359 * We are going to return to userspace and forget about these locks, the
1360 * ownership goes to the caller of thaw_super() which does unlock().
1361 */
1362static void lockdep_sb_freeze_release(struct super_block *sb)
1363{
1364 int level;
1365
1366 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1367 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1368}
1369
1370/*
1371 * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1372 */
1373static void lockdep_sb_freeze_acquire(struct super_block *sb)
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001374{
1375 int level;
Jan Kara5accdf82012-06-12 16:20:34 +02001376
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001377 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1378 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
Oleg Nesterovf1a96222016-09-26 18:55:25 +02001379}
1380
1381static void sb_freeze_unlock(struct super_block *sb)
1382{
1383 int level;
Jan Kara5accdf82012-06-12 16:20:34 +02001384
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001385 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1386 percpu_up_write(sb->s_writers.rw_sem + level);
Jan Kara5accdf82012-06-12 16:20:34 +02001387}
1388
Josef Bacik18e9e512010-03-23 10:34:56 -04001389/**
Randy Dunlap7000d3c2010-05-24 22:22:34 -07001390 * freeze_super - lock the filesystem and force it into a consistent state
1391 * @sb: the super to lock
Josef Bacik18e9e512010-03-23 10:34:56 -04001392 *
1393 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1394 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1395 * -EBUSY.
Jan Kara5accdf82012-06-12 16:20:34 +02001396 *
1397 * During this function, sb->s_writers.frozen goes through these values:
1398 *
1399 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1400 *
1401 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1402 * writes should be blocked, though page faults are still allowed. We wait for
1403 * all writes to complete and then proceed to the next stage.
1404 *
1405 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1406 * but internal fs threads can still modify the filesystem (although they
1407 * should not dirty new pages or inodes), writeback can run etc. After waiting
1408 * for all running page faults we sync the filesystem which will clean all
1409 * dirty pages and inodes (no new dirty pages or inodes can be created when
1410 * sync is running).
1411 *
1412 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1413 * modification are blocked (e.g. XFS preallocation truncation on inode
1414 * reclaim). This is usually implemented by blocking new transactions for
1415 * filesystems that have them and need this additional guard. After all
1416 * internal writers are finished we call ->freeze_fs() to finish filesystem
1417 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1418 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1419 *
1420 * sb->s_writers.frozen is protected by sb->s_umount.
Josef Bacik18e9e512010-03-23 10:34:56 -04001421 */
1422int freeze_super(struct super_block *sb)
1423{
1424 int ret;
1425
1426 atomic_inc(&sb->s_active);
1427 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001428 if (sb->s_writers.frozen != SB_UNFROZEN) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001429 deactivate_locked_super(sb);
1430 return -EBUSY;
1431 }
1432
David Howellse462ec52017-07-17 08:45:35 +01001433 if (!(sb->s_flags & SB_BORN)) {
Al Virodabe0dc2012-01-03 21:01:29 -05001434 up_write(&sb->s_umount);
1435 return 0; /* sic - it's "nothing to do" */
1436 }
1437
David Howellsbc98a422017-07-17 08:45:34 +01001438 if (sb_rdonly(sb)) {
Jan Kara5accdf82012-06-12 16:20:34 +02001439 /* Nothing to do really... */
1440 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Josef Bacik18e9e512010-03-23 10:34:56 -04001441 up_write(&sb->s_umount);
1442 return 0;
1443 }
1444
Jan Kara5accdf82012-06-12 16:20:34 +02001445 sb->s_writers.frozen = SB_FREEZE_WRITE;
Jan Kara5accdf82012-06-12 16:20:34 +02001446 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1447 up_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001448 sb_wait_write(sb, SB_FREEZE_WRITE);
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001449 down_write(&sb->s_umount);
Jan Kara5accdf82012-06-12 16:20:34 +02001450
1451 /* Now we go and block page faults... */
Jan Kara5accdf82012-06-12 16:20:34 +02001452 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
Jan Kara5accdf82012-06-12 16:20:34 +02001453 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1454
1455 /* All writers are done so after syncing there won't be dirty data */
Josef Bacik18e9e512010-03-23 10:34:56 -04001456 sync_filesystem(sb);
1457
Jan Kara5accdf82012-06-12 16:20:34 +02001458 /* Now wait for internal filesystem counter */
1459 sb->s_writers.frozen = SB_FREEZE_FS;
Jan Kara5accdf82012-06-12 16:20:34 +02001460 sb_wait_write(sb, SB_FREEZE_FS);
Josef Bacik18e9e512010-03-23 10:34:56 -04001461
Josef Bacik18e9e512010-03-23 10:34:56 -04001462 if (sb->s_op->freeze_fs) {
1463 ret = sb->s_op->freeze_fs(sb);
1464 if (ret) {
1465 printk(KERN_ERR
1466 "VFS:Filesystem freeze failed\n");
Jan Kara5accdf82012-06-12 16:20:34 +02001467 sb->s_writers.frozen = SB_UNFROZEN;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001468 sb_freeze_unlock(sb);
Jan Kara5accdf82012-06-12 16:20:34 +02001469 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001470 deactivate_locked_super(sb);
1471 return ret;
1472 }
1473 }
Jan Kara5accdf82012-06-12 16:20:34 +02001474 /*
Oleg Nesterov89f39af2016-09-26 18:07:48 +02001475 * For debugging purposes so that fs can warn if it sees write activity
1476 * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
Jan Kara5accdf82012-06-12 16:20:34 +02001477 */
1478 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
Oleg Nesterovf1a96222016-09-26 18:55:25 +02001479 lockdep_sb_freeze_release(sb);
Josef Bacik18e9e512010-03-23 10:34:56 -04001480 up_write(&sb->s_umount);
1481 return 0;
1482}
1483EXPORT_SYMBOL(freeze_super);
1484
1485/**
1486 * thaw_super -- unlock filesystem
1487 * @sb: the super to thaw
1488 *
1489 * Unlocks the filesystem and marks it writeable again after freeze_super().
1490 */
1491int thaw_super(struct super_block *sb)
1492{
1493 int error;
1494
1495 down_write(&sb->s_umount);
Oleg Nesterov89f39af2016-09-26 18:07:48 +02001496 if (sb->s_writers.frozen != SB_FREEZE_COMPLETE) {
Josef Bacik18e9e512010-03-23 10:34:56 -04001497 up_write(&sb->s_umount);
1498 return -EINVAL;
1499 }
1500
David Howellsbc98a422017-07-17 08:45:34 +01001501 if (sb_rdonly(sb)) {
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001502 sb->s_writers.frozen = SB_UNFROZEN;
Josef Bacik18e9e512010-03-23 10:34:56 -04001503 goto out;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001504 }
Josef Bacik18e9e512010-03-23 10:34:56 -04001505
Oleg Nesterovf1a96222016-09-26 18:55:25 +02001506 lockdep_sb_freeze_acquire(sb);
1507
Josef Bacik18e9e512010-03-23 10:34:56 -04001508 if (sb->s_op->unfreeze_fs) {
1509 error = sb->s_op->unfreeze_fs(sb);
1510 if (error) {
1511 printk(KERN_ERR
1512 "VFS:Filesystem thaw failed\n");
Oleg Nesterovf1a96222016-09-26 18:55:25 +02001513 lockdep_sb_freeze_release(sb);
Josef Bacik18e9e512010-03-23 10:34:56 -04001514 up_write(&sb->s_umount);
1515 return error;
1516 }
1517 }
1518
Jan Kara5accdf82012-06-12 16:20:34 +02001519 sb->s_writers.frozen = SB_UNFROZEN;
Oleg Nesterov8129ed22015-08-11 17:05:04 +02001520 sb_freeze_unlock(sb);
1521out:
Jan Kara5accdf82012-06-12 16:20:34 +02001522 wake_up(&sb->s_writers.wait_unfrozen);
Josef Bacik18e9e512010-03-23 10:34:56 -04001523 deactivate_locked_super(sb);
Josef Bacik18e9e512010-03-23 10:34:56 -04001524 return 0;
1525}
1526EXPORT_SYMBOL(thaw_super);