Linux 6.1.66
[platform/kernel/linux-starfive.git] / fs / super.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
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:
19  *    Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
20  *  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
24 #include <linux/export.h>
25 #include <linux/slab.h>
26 #include <linux/blkdev.h>
27 #include <linux/mount.h>
28 #include <linux/security.h>
29 #include <linux/writeback.h>            /* for the emergency remount stuff */
30 #include <linux/idr.h>
31 #include <linux/mutex.h>
32 #include <linux/backing-dev.h>
33 #include <linux/rculist_bl.h>
34 #include <linux/fscrypt.h>
35 #include <linux/fsnotify.h>
36 #include <linux/lockdep.h>
37 #include <linux/user_namespace.h>
38 #include <linux/fs_context.h>
39 #include <uapi/linux/mount.h>
40 #include "internal.h"
41
42 static int thaw_super_locked(struct super_block *sb);
43
44 static LIST_HEAD(super_blocks);
45 static DEFINE_SPINLOCK(sb_lock);
46
47 static char *sb_writers_name[SB_FREEZE_LEVELS] = {
48         "sb_writers",
49         "sb_pagefaults",
50         "sb_internal",
51 };
52
53 /*
54  * One thing we have to be careful of with a per-sb shrinker is that we don't
55  * drop the last active reference to the superblock from within the shrinker.
56  * If that happens we could trigger unregistering the shrinker from within the
57  * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
58  * take a passive reference to the superblock to avoid this from occurring.
59  */
60 static unsigned long super_cache_scan(struct shrinker *shrink,
61                                       struct shrink_control *sc)
62 {
63         struct super_block *sb;
64         long    fs_objects = 0;
65         long    total_objects;
66         long    freed = 0;
67         long    dentries;
68         long    inodes;
69
70         sb = container_of(shrink, struct super_block, s_shrink);
71
72         /*
73          * Deadlock avoidance.  We may hold various FS locks, and we don't want
74          * to recurse into the FS that called us in clear_inode() and friends..
75          */
76         if (!(sc->gfp_mask & __GFP_FS))
77                 return SHRINK_STOP;
78
79         if (!trylock_super(sb))
80                 return SHRINK_STOP;
81
82         if (sb->s_op->nr_cached_objects)
83                 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
84
85         inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
86         dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
87         total_objects = dentries + inodes + fs_objects + 1;
88         if (!total_objects)
89                 total_objects = 1;
90
91         /* proportion the scan between the caches */
92         dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
93         inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
94         fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
95
96         /*
97          * prune the dcache first as the icache is pinned by it, then
98          * prune the icache, followed by the filesystem specific caches
99          *
100          * Ensure that we always scan at least one object - memcg kmem
101          * accounting uses this to fully empty the caches.
102          */
103         sc->nr_to_scan = dentries + 1;
104         freed = prune_dcache_sb(sb, sc);
105         sc->nr_to_scan = inodes + 1;
106         freed += prune_icache_sb(sb, sc);
107
108         if (fs_objects) {
109                 sc->nr_to_scan = fs_objects + 1;
110                 freed += sb->s_op->free_cached_objects(sb, sc);
111         }
112
113         up_read(&sb->s_umount);
114         return freed;
115 }
116
117 static unsigned long super_cache_count(struct shrinker *shrink,
118                                        struct shrink_control *sc)
119 {
120         struct super_block *sb;
121         long    total_objects = 0;
122
123         sb = container_of(shrink, struct super_block, s_shrink);
124
125         /*
126          * We don't call trylock_super() here as it is a scalability bottleneck,
127          * so we're exposed to partial setup state. The shrinker rwsem does not
128          * protect filesystem operations backing list_lru_shrink_count() or
129          * s_op->nr_cached_objects(). Counts can change between
130          * super_cache_count and super_cache_scan, so we really don't need locks
131          * here.
132          *
133          * However, if we are currently mounting the superblock, the underlying
134          * filesystem might be in a state of partial construction and hence it
135          * is dangerous to access it.  trylock_super() uses a SB_BORN check to
136          * avoid this situation, so do the same here. The memory barrier is
137          * matched with the one in mount_fs() as we don't hold locks here.
138          */
139         if (!(sb->s_flags & SB_BORN))
140                 return 0;
141         smp_rmb();
142
143         if (sb->s_op && sb->s_op->nr_cached_objects)
144                 total_objects = sb->s_op->nr_cached_objects(sb, sc);
145
146         total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
147         total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
148
149         if (!total_objects)
150                 return SHRINK_EMPTY;
151
152         total_objects = vfs_pressure_ratio(total_objects);
153         return total_objects;
154 }
155
156 static void destroy_super_work(struct work_struct *work)
157 {
158         struct super_block *s = container_of(work, struct super_block,
159                                                         destroy_work);
160         int i;
161
162         for (i = 0; i < SB_FREEZE_LEVELS; i++)
163                 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
164         kfree(s);
165 }
166
167 static void destroy_super_rcu(struct rcu_head *head)
168 {
169         struct super_block *s = container_of(head, struct super_block, rcu);
170         INIT_WORK(&s->destroy_work, destroy_super_work);
171         schedule_work(&s->destroy_work);
172 }
173
174 /* Free a superblock that has never been seen by anyone */
175 static void destroy_unused_super(struct super_block *s)
176 {
177         if (!s)
178                 return;
179         up_write(&s->s_umount);
180         list_lru_destroy(&s->s_dentry_lru);
181         list_lru_destroy(&s->s_inode_lru);
182         security_sb_free(s);
183         put_user_ns(s->s_user_ns);
184         kfree(s->s_subtype);
185         free_prealloced_shrinker(&s->s_shrink);
186         /* no delays needed */
187         destroy_super_work(&s->destroy_work);
188 }
189
190 /**
191  *      alloc_super     -       create new superblock
192  *      @type:  filesystem type superblock should belong to
193  *      @flags: the mount flags
194  *      @user_ns: User namespace for the super_block
195  *
196  *      Allocates and initializes a new &struct super_block.  alloc_super()
197  *      returns a pointer new superblock or %NULL if allocation had failed.
198  */
199 static struct super_block *alloc_super(struct file_system_type *type, int flags,
200                                        struct user_namespace *user_ns)
201 {
202         struct super_block *s = kzalloc(sizeof(struct super_block),  GFP_USER);
203         static const struct super_operations default_op;
204         int i;
205
206         if (!s)
207                 return NULL;
208
209         INIT_LIST_HEAD(&s->s_mounts);
210         s->s_user_ns = get_user_ns(user_ns);
211         init_rwsem(&s->s_umount);
212         lockdep_set_class(&s->s_umount, &type->s_umount_key);
213         /*
214          * sget() can have s_umount recursion.
215          *
216          * When it cannot find a suitable sb, it allocates a new
217          * one (this one), and tries again to find a suitable old
218          * one.
219          *
220          * In case that succeeds, it will acquire the s_umount
221          * lock of the old one. Since these are clearly distrinct
222          * locks, and this object isn't exposed yet, there's no
223          * risk of deadlocks.
224          *
225          * Annotate this by putting this lock in a different
226          * subclass.
227          */
228         down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
229
230         if (security_sb_alloc(s))
231                 goto fail;
232
233         for (i = 0; i < SB_FREEZE_LEVELS; i++) {
234                 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
235                                         sb_writers_name[i],
236                                         &type->s_writers_key[i]))
237                         goto fail;
238         }
239         init_waitqueue_head(&s->s_writers.wait_unfrozen);
240         s->s_bdi = &noop_backing_dev_info;
241         s->s_flags = flags;
242         if (s->s_user_ns != &init_user_ns)
243                 s->s_iflags |= SB_I_NODEV;
244         INIT_HLIST_NODE(&s->s_instances);
245         INIT_HLIST_BL_HEAD(&s->s_roots);
246         mutex_init(&s->s_sync_lock);
247         INIT_LIST_HEAD(&s->s_inodes);
248         spin_lock_init(&s->s_inode_list_lock);
249         INIT_LIST_HEAD(&s->s_inodes_wb);
250         spin_lock_init(&s->s_inode_wblist_lock);
251
252         s->s_count = 1;
253         atomic_set(&s->s_active, 1);
254         mutex_init(&s->s_vfs_rename_mutex);
255         lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
256         init_rwsem(&s->s_dquot.dqio_sem);
257         s->s_maxbytes = MAX_NON_LFS;
258         s->s_op = &default_op;
259         s->s_time_gran = 1000000000;
260         s->s_time_min = TIME64_MIN;
261         s->s_time_max = TIME64_MAX;
262
263         s->s_shrink.seeks = DEFAULT_SEEKS;
264         s->s_shrink.scan_objects = super_cache_scan;
265         s->s_shrink.count_objects = super_cache_count;
266         s->s_shrink.batch = 1024;
267         s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
268         if (prealloc_shrinker(&s->s_shrink, "sb-%s", type->name))
269                 goto fail;
270         if (list_lru_init_memcg(&s->s_dentry_lru, &s->s_shrink))
271                 goto fail;
272         if (list_lru_init_memcg(&s->s_inode_lru, &s->s_shrink))
273                 goto fail;
274         return s;
275
276 fail:
277         destroy_unused_super(s);
278         return NULL;
279 }
280
281 /* Superblock refcounting  */
282
283 /*
284  * Drop a superblock's refcount.  The caller must hold sb_lock.
285  */
286 static void __put_super(struct super_block *s)
287 {
288         if (!--s->s_count) {
289                 list_del_init(&s->s_list);
290                 WARN_ON(s->s_dentry_lru.node);
291                 WARN_ON(s->s_inode_lru.node);
292                 WARN_ON(!list_empty(&s->s_mounts));
293                 security_sb_free(s);
294                 fscrypt_destroy_keyring(s);
295                 put_user_ns(s->s_user_ns);
296                 kfree(s->s_subtype);
297                 call_rcu(&s->rcu, destroy_super_rcu);
298         }
299 }
300
301 /**
302  *      put_super       -       drop a temporary reference to superblock
303  *      @sb: superblock in question
304  *
305  *      Drops a temporary reference, frees superblock if there's no
306  *      references left.
307  */
308 void put_super(struct super_block *sb)
309 {
310         spin_lock(&sb_lock);
311         __put_super(sb);
312         spin_unlock(&sb_lock);
313 }
314
315
316 /**
317  *      deactivate_locked_super -       drop an active reference to superblock
318  *      @s: superblock to deactivate
319  *
320  *      Drops an active reference to superblock, converting it into a temporary
321  *      one if there is no other active references left.  In that case we
322  *      tell fs driver to shut it down and drop the temporary reference we
323  *      had just acquired.
324  *
325  *      Caller holds exclusive lock on superblock; that lock is released.
326  */
327 void deactivate_locked_super(struct super_block *s)
328 {
329         struct file_system_type *fs = s->s_type;
330         if (atomic_dec_and_test(&s->s_active)) {
331                 unregister_shrinker(&s->s_shrink);
332                 fs->kill_sb(s);
333
334                 /*
335                  * Since list_lru_destroy() may sleep, we cannot call it from
336                  * put_super(), where we hold the sb_lock. Therefore we destroy
337                  * the lru lists right now.
338                  */
339                 list_lru_destroy(&s->s_dentry_lru);
340                 list_lru_destroy(&s->s_inode_lru);
341
342                 put_filesystem(fs);
343                 put_super(s);
344         } else {
345                 up_write(&s->s_umount);
346         }
347 }
348
349 EXPORT_SYMBOL(deactivate_locked_super);
350
351 /**
352  *      deactivate_super        -       drop an active reference to superblock
353  *      @s: superblock to deactivate
354  *
355  *      Variant of deactivate_locked_super(), except that superblock is *not*
356  *      locked by caller.  If we are going to drop the final active reference,
357  *      lock will be acquired prior to that.
358  */
359 void deactivate_super(struct super_block *s)
360 {
361         if (!atomic_add_unless(&s->s_active, -1, 1)) {
362                 down_write(&s->s_umount);
363                 deactivate_locked_super(s);
364         }
365 }
366
367 EXPORT_SYMBOL(deactivate_super);
368
369 /**
370  *      grab_super - acquire an active reference
371  *      @s: reference we are trying to make active
372  *
373  *      Tries to acquire an active reference.  grab_super() is used when we
374  *      had just found a superblock in super_blocks or fs_type->fs_supers
375  *      and want to turn it into a full-blown active reference.  grab_super()
376  *      is called with sb_lock held and drops it.  Returns 1 in case of
377  *      success, 0 if we had failed (superblock contents was already dead or
378  *      dying when grab_super() had been called).  Note that this is only
379  *      called for superblocks not in rundown mode (== ones still on ->fs_supers
380  *      of their type), so increment of ->s_count is OK here.
381  */
382 static int grab_super(struct super_block *s) __releases(sb_lock)
383 {
384         s->s_count++;
385         spin_unlock(&sb_lock);
386         down_write(&s->s_umount);
387         if ((s->s_flags & SB_BORN) && atomic_inc_not_zero(&s->s_active)) {
388                 put_super(s);
389                 return 1;
390         }
391         up_write(&s->s_umount);
392         put_super(s);
393         return 0;
394 }
395
396 /*
397  *      trylock_super - try to grab ->s_umount shared
398  *      @sb: reference we are trying to grab
399  *
400  *      Try to prevent fs shutdown.  This is used in places where we
401  *      cannot take an active reference but we need to ensure that the
402  *      filesystem is not shut down while we are working on it. It returns
403  *      false if we cannot acquire s_umount or if we lose the race and
404  *      filesystem already got into shutdown, and returns true with the s_umount
405  *      lock held in read mode in case of success. On successful return,
406  *      the caller must drop the s_umount lock when done.
407  *
408  *      Note that unlike get_super() et.al. this one does *not* bump ->s_count.
409  *      The reason why it's safe is that we are OK with doing trylock instead
410  *      of down_read().  There's a couple of places that are OK with that, but
411  *      it's very much not a general-purpose interface.
412  */
413 bool trylock_super(struct super_block *sb)
414 {
415         if (down_read_trylock(&sb->s_umount)) {
416                 if (!hlist_unhashed(&sb->s_instances) &&
417                     sb->s_root && (sb->s_flags & SB_BORN))
418                         return true;
419                 up_read(&sb->s_umount);
420         }
421
422         return false;
423 }
424
425 /**
426  *      retire_super    -       prevents superblock from being reused
427  *      @sb: superblock to retire
428  *
429  *      The function marks superblock to be ignored in superblock test, which
430  *      prevents it from being reused for any new mounts.  If the superblock has
431  *      a private bdi, it also unregisters it, but doesn't reduce the refcount
432  *      of the superblock to prevent potential races.  The refcount is reduced
433  *      by generic_shutdown_super().  The function can not be called
434  *      concurrently with generic_shutdown_super().  It is safe to call the
435  *      function multiple times, subsequent calls have no effect.
436  *
437  *      The marker will affect the re-use only for block-device-based
438  *      superblocks.  Other superblocks will still get marked if this function
439  *      is used, but that will not affect their reusability.
440  */
441 void retire_super(struct super_block *sb)
442 {
443         WARN_ON(!sb->s_bdev);
444         down_write(&sb->s_umount);
445         if (sb->s_iflags & SB_I_PERSB_BDI) {
446                 bdi_unregister(sb->s_bdi);
447                 sb->s_iflags &= ~SB_I_PERSB_BDI;
448         }
449         sb->s_iflags |= SB_I_RETIRED;
450         up_write(&sb->s_umount);
451 }
452 EXPORT_SYMBOL(retire_super);
453
454 /**
455  *      generic_shutdown_super  -       common helper for ->kill_sb()
456  *      @sb: superblock to kill
457  *
458  *      generic_shutdown_super() does all fs-independent work on superblock
459  *      shutdown.  Typical ->kill_sb() should pick all fs-specific objects
460  *      that need destruction out of superblock, call generic_shutdown_super()
461  *      and release aforementioned objects.  Note: dentries and inodes _are_
462  *      taken care of and do not need specific handling.
463  *
464  *      Upon calling this function, the filesystem may no longer alter or
465  *      rearrange the set of dentries belonging to this super_block, nor may it
466  *      change the attachments of dentries to inodes.
467  */
468 void generic_shutdown_super(struct super_block *sb)
469 {
470         const struct super_operations *sop = sb->s_op;
471
472         if (sb->s_root) {
473                 shrink_dcache_for_umount(sb);
474                 sync_filesystem(sb);
475                 sb->s_flags &= ~SB_ACTIVE;
476
477                 cgroup_writeback_umount();
478
479                 /* Evict all inodes with zero refcount. */
480                 evict_inodes(sb);
481
482                 /*
483                  * Clean up and evict any inodes that still have references due
484                  * to fsnotify or the security policy.
485                  */
486                 fsnotify_sb_delete(sb);
487                 security_sb_delete(sb);
488
489                 /*
490                  * Now that all potentially-encrypted inodes have been evicted,
491                  * the fscrypt keyring can be destroyed.
492                  */
493                 fscrypt_destroy_keyring(sb);
494
495                 if (sb->s_dio_done_wq) {
496                         destroy_workqueue(sb->s_dio_done_wq);
497                         sb->s_dio_done_wq = NULL;
498                 }
499
500                 if (sop->put_super)
501                         sop->put_super(sb);
502
503                 if (CHECK_DATA_CORRUPTION(!list_empty(&sb->s_inodes),
504                                 "VFS: Busy inodes after unmount of %s (%s)",
505                                 sb->s_id, sb->s_type->name)) {
506                         /*
507                          * Adding a proper bailout path here would be hard, but
508                          * we can at least make it more likely that a later
509                          * iput_final() or such crashes cleanly.
510                          */
511                         struct inode *inode;
512
513                         spin_lock(&sb->s_inode_list_lock);
514                         list_for_each_entry(inode, &sb->s_inodes, i_sb_list) {
515                                 inode->i_op = VFS_PTR_POISON;
516                                 inode->i_sb = VFS_PTR_POISON;
517                                 inode->i_mapping = VFS_PTR_POISON;
518                         }
519                         spin_unlock(&sb->s_inode_list_lock);
520                 }
521         }
522         spin_lock(&sb_lock);
523         /* should be initialized for __put_super_and_need_restart() */
524         hlist_del_init(&sb->s_instances);
525         spin_unlock(&sb_lock);
526         up_write(&sb->s_umount);
527         if (sb->s_bdi != &noop_backing_dev_info) {
528                 if (sb->s_iflags & SB_I_PERSB_BDI)
529                         bdi_unregister(sb->s_bdi);
530                 bdi_put(sb->s_bdi);
531                 sb->s_bdi = &noop_backing_dev_info;
532         }
533 }
534
535 EXPORT_SYMBOL(generic_shutdown_super);
536
537 bool mount_capable(struct fs_context *fc)
538 {
539         if (!(fc->fs_type->fs_flags & FS_USERNS_MOUNT))
540                 return capable(CAP_SYS_ADMIN);
541         else
542                 return ns_capable(fc->user_ns, CAP_SYS_ADMIN);
543 }
544
545 /**
546  * sget_fc - Find or create a superblock
547  * @fc: Filesystem context.
548  * @test: Comparison callback
549  * @set: Setup callback
550  *
551  * Find or create a superblock using the parameters stored in the filesystem
552  * context and the two callback functions.
553  *
554  * If an extant superblock is matched, then that will be returned with an
555  * elevated reference count that the caller must transfer or discard.
556  *
557  * If no match is made, a new superblock will be allocated and basic
558  * initialisation will be performed (s_type, s_fs_info and s_id will be set and
559  * the set() callback will be invoked), the superblock will be published and it
560  * will be returned in a partially constructed state with SB_BORN and SB_ACTIVE
561  * as yet unset.
562  */
563 struct super_block *sget_fc(struct fs_context *fc,
564                             int (*test)(struct super_block *, struct fs_context *),
565                             int (*set)(struct super_block *, struct fs_context *))
566 {
567         struct super_block *s = NULL;
568         struct super_block *old;
569         struct user_namespace *user_ns = fc->global ? &init_user_ns : fc->user_ns;
570         int err;
571
572 retry:
573         spin_lock(&sb_lock);
574         if (test) {
575                 hlist_for_each_entry(old, &fc->fs_type->fs_supers, s_instances) {
576                         if (test(old, fc))
577                                 goto share_extant_sb;
578                 }
579         }
580         if (!s) {
581                 spin_unlock(&sb_lock);
582                 s = alloc_super(fc->fs_type, fc->sb_flags, user_ns);
583                 if (!s)
584                         return ERR_PTR(-ENOMEM);
585                 goto retry;
586         }
587
588         s->s_fs_info = fc->s_fs_info;
589         err = set(s, fc);
590         if (err) {
591                 s->s_fs_info = NULL;
592                 spin_unlock(&sb_lock);
593                 destroy_unused_super(s);
594                 return ERR_PTR(err);
595         }
596         fc->s_fs_info = NULL;
597         s->s_type = fc->fs_type;
598         s->s_iflags |= fc->s_iflags;
599         strlcpy(s->s_id, s->s_type->name, sizeof(s->s_id));
600         list_add_tail(&s->s_list, &super_blocks);
601         hlist_add_head(&s->s_instances, &s->s_type->fs_supers);
602         spin_unlock(&sb_lock);
603         get_filesystem(s->s_type);
604         register_shrinker_prepared(&s->s_shrink);
605         return s;
606
607 share_extant_sb:
608         if (user_ns != old->s_user_ns) {
609                 spin_unlock(&sb_lock);
610                 destroy_unused_super(s);
611                 return ERR_PTR(-EBUSY);
612         }
613         if (!grab_super(old))
614                 goto retry;
615         destroy_unused_super(s);
616         return old;
617 }
618 EXPORT_SYMBOL(sget_fc);
619
620 /**
621  *      sget    -       find or create a superblock
622  *      @type:    filesystem type superblock should belong to
623  *      @test:    comparison callback
624  *      @set:     setup callback
625  *      @flags:   mount flags
626  *      @data:    argument to each of them
627  */
628 struct super_block *sget(struct file_system_type *type,
629                         int (*test)(struct super_block *,void *),
630                         int (*set)(struct super_block *,void *),
631                         int flags,
632                         void *data)
633 {
634         struct user_namespace *user_ns = current_user_ns();
635         struct super_block *s = NULL;
636         struct super_block *old;
637         int err;
638
639         /* We don't yet pass the user namespace of the parent
640          * mount through to here so always use &init_user_ns
641          * until that changes.
642          */
643         if (flags & SB_SUBMOUNT)
644                 user_ns = &init_user_ns;
645
646 retry:
647         spin_lock(&sb_lock);
648         if (test) {
649                 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
650                         if (!test(old, data))
651                                 continue;
652                         if (user_ns != old->s_user_ns) {
653                                 spin_unlock(&sb_lock);
654                                 destroy_unused_super(s);
655                                 return ERR_PTR(-EBUSY);
656                         }
657                         if (!grab_super(old))
658                                 goto retry;
659                         destroy_unused_super(s);
660                         return old;
661                 }
662         }
663         if (!s) {
664                 spin_unlock(&sb_lock);
665                 s = alloc_super(type, (flags & ~SB_SUBMOUNT), user_ns);
666                 if (!s)
667                         return ERR_PTR(-ENOMEM);
668                 goto retry;
669         }
670
671         err = set(s, data);
672         if (err) {
673                 spin_unlock(&sb_lock);
674                 destroy_unused_super(s);
675                 return ERR_PTR(err);
676         }
677         s->s_type = type;
678         strlcpy(s->s_id, type->name, sizeof(s->s_id));
679         list_add_tail(&s->s_list, &super_blocks);
680         hlist_add_head(&s->s_instances, &type->fs_supers);
681         spin_unlock(&sb_lock);
682         get_filesystem(type);
683         register_shrinker_prepared(&s->s_shrink);
684         return s;
685 }
686 EXPORT_SYMBOL(sget);
687
688 void drop_super(struct super_block *sb)
689 {
690         up_read(&sb->s_umount);
691         put_super(sb);
692 }
693
694 EXPORT_SYMBOL(drop_super);
695
696 void drop_super_exclusive(struct super_block *sb)
697 {
698         up_write(&sb->s_umount);
699         put_super(sb);
700 }
701 EXPORT_SYMBOL(drop_super_exclusive);
702
703 static void __iterate_supers(void (*f)(struct super_block *))
704 {
705         struct super_block *sb, *p = NULL;
706
707         spin_lock(&sb_lock);
708         list_for_each_entry(sb, &super_blocks, s_list) {
709                 if (hlist_unhashed(&sb->s_instances))
710                         continue;
711                 sb->s_count++;
712                 spin_unlock(&sb_lock);
713
714                 f(sb);
715
716                 spin_lock(&sb_lock);
717                 if (p)
718                         __put_super(p);
719                 p = sb;
720         }
721         if (p)
722                 __put_super(p);
723         spin_unlock(&sb_lock);
724 }
725 /**
726  *      iterate_supers - call function for all active superblocks
727  *      @f: function to call
728  *      @arg: argument to pass to it
729  *
730  *      Scans the superblock list and calls given function, passing it
731  *      locked superblock and given argument.
732  */
733 void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
734 {
735         struct super_block *sb, *p = NULL;
736
737         spin_lock(&sb_lock);
738         list_for_each_entry(sb, &super_blocks, s_list) {
739                 if (hlist_unhashed(&sb->s_instances))
740                         continue;
741                 sb->s_count++;
742                 spin_unlock(&sb_lock);
743
744                 down_read(&sb->s_umount);
745                 if (sb->s_root && (sb->s_flags & SB_BORN))
746                         f(sb, arg);
747                 up_read(&sb->s_umount);
748
749                 spin_lock(&sb_lock);
750                 if (p)
751                         __put_super(p);
752                 p = sb;
753         }
754         if (p)
755                 __put_super(p);
756         spin_unlock(&sb_lock);
757 }
758
759 /**
760  *      iterate_supers_type - call function for superblocks of given type
761  *      @type: fs type
762  *      @f: function to call
763  *      @arg: argument to pass to it
764  *
765  *      Scans the superblock list and calls given function, passing it
766  *      locked superblock and given argument.
767  */
768 void iterate_supers_type(struct file_system_type *type,
769         void (*f)(struct super_block *, void *), void *arg)
770 {
771         struct super_block *sb, *p = NULL;
772
773         spin_lock(&sb_lock);
774         hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
775                 sb->s_count++;
776                 spin_unlock(&sb_lock);
777
778                 down_read(&sb->s_umount);
779                 if (sb->s_root && (sb->s_flags & SB_BORN))
780                         f(sb, arg);
781                 up_read(&sb->s_umount);
782
783                 spin_lock(&sb_lock);
784                 if (p)
785                         __put_super(p);
786                 p = sb;
787         }
788         if (p)
789                 __put_super(p);
790         spin_unlock(&sb_lock);
791 }
792
793 EXPORT_SYMBOL(iterate_supers_type);
794
795 /**
796  * get_super - get the superblock of a device
797  * @bdev: device to get the superblock for
798  *
799  * Scans the superblock list and finds the superblock of the file system
800  * mounted on the device given. %NULL is returned if no match is found.
801  */
802 struct super_block *get_super(struct block_device *bdev)
803 {
804         struct super_block *sb;
805
806         if (!bdev)
807                 return NULL;
808
809         spin_lock(&sb_lock);
810 rescan:
811         list_for_each_entry(sb, &super_blocks, s_list) {
812                 if (hlist_unhashed(&sb->s_instances))
813                         continue;
814                 if (sb->s_bdev == bdev) {
815                         sb->s_count++;
816                         spin_unlock(&sb_lock);
817                         down_read(&sb->s_umount);
818                         /* still alive? */
819                         if (sb->s_root && (sb->s_flags & SB_BORN))
820                                 return sb;
821                         up_read(&sb->s_umount);
822                         /* nope, got unmounted */
823                         spin_lock(&sb_lock);
824                         __put_super(sb);
825                         goto rescan;
826                 }
827         }
828         spin_unlock(&sb_lock);
829         return NULL;
830 }
831
832 /**
833  * get_active_super - get an active reference to the superblock of a device
834  * @bdev: device to get the superblock for
835  *
836  * Scans the superblock list and finds the superblock of the file system
837  * mounted on the device given.  Returns the superblock with an active
838  * reference or %NULL if none was found.
839  */
840 struct super_block *get_active_super(struct block_device *bdev)
841 {
842         struct super_block *sb;
843
844         if (!bdev)
845                 return NULL;
846
847 restart:
848         spin_lock(&sb_lock);
849         list_for_each_entry(sb, &super_blocks, s_list) {
850                 if (hlist_unhashed(&sb->s_instances))
851                         continue;
852                 if (sb->s_bdev == bdev) {
853                         if (!grab_super(sb))
854                                 goto restart;
855                         up_write(&sb->s_umount);
856                         return sb;
857                 }
858         }
859         spin_unlock(&sb_lock);
860         return NULL;
861 }
862
863 struct super_block *user_get_super(dev_t dev, bool excl)
864 {
865         struct super_block *sb;
866
867         spin_lock(&sb_lock);
868 rescan:
869         list_for_each_entry(sb, &super_blocks, s_list) {
870                 if (hlist_unhashed(&sb->s_instances))
871                         continue;
872                 if (sb->s_dev ==  dev) {
873                         sb->s_count++;
874                         spin_unlock(&sb_lock);
875                         if (excl)
876                                 down_write(&sb->s_umount);
877                         else
878                                 down_read(&sb->s_umount);
879                         /* still alive? */
880                         if (sb->s_root && (sb->s_flags & SB_BORN))
881                                 return sb;
882                         if (excl)
883                                 up_write(&sb->s_umount);
884                         else
885                                 up_read(&sb->s_umount);
886                         /* nope, got unmounted */
887                         spin_lock(&sb_lock);
888                         __put_super(sb);
889                         goto rescan;
890                 }
891         }
892         spin_unlock(&sb_lock);
893         return NULL;
894 }
895
896 /**
897  * reconfigure_super - asks filesystem to change superblock parameters
898  * @fc: The superblock and configuration
899  *
900  * Alters the configuration parameters of a live superblock.
901  */
902 int reconfigure_super(struct fs_context *fc)
903 {
904         struct super_block *sb = fc->root->d_sb;
905         int retval;
906         bool remount_ro = false;
907         bool remount_rw = false;
908         bool force = fc->sb_flags & SB_FORCE;
909
910         if (fc->sb_flags_mask & ~MS_RMT_MASK)
911                 return -EINVAL;
912         if (sb->s_writers.frozen != SB_UNFROZEN)
913                 return -EBUSY;
914
915         retval = security_sb_remount(sb, fc->security);
916         if (retval)
917                 return retval;
918
919         if (fc->sb_flags_mask & SB_RDONLY) {
920 #ifdef CONFIG_BLOCK
921                 if (!(fc->sb_flags & SB_RDONLY) && sb->s_bdev &&
922                     bdev_read_only(sb->s_bdev))
923                         return -EACCES;
924 #endif
925                 remount_rw = !(fc->sb_flags & SB_RDONLY) && sb_rdonly(sb);
926                 remount_ro = (fc->sb_flags & SB_RDONLY) && !sb_rdonly(sb);
927         }
928
929         if (remount_ro) {
930                 if (!hlist_empty(&sb->s_pins)) {
931                         up_write(&sb->s_umount);
932                         group_pin_kill(&sb->s_pins);
933                         down_write(&sb->s_umount);
934                         if (!sb->s_root)
935                                 return 0;
936                         if (sb->s_writers.frozen != SB_UNFROZEN)
937                                 return -EBUSY;
938                         remount_ro = !sb_rdonly(sb);
939                 }
940         }
941         shrink_dcache_sb(sb);
942
943         /* If we are reconfiguring to RDONLY and current sb is read/write,
944          * make sure there are no files open for writing.
945          */
946         if (remount_ro) {
947                 if (force) {
948                         sb->s_readonly_remount = 1;
949                         smp_wmb();
950                 } else {
951                         retval = sb_prepare_remount_readonly(sb);
952                         if (retval)
953                                 return retval;
954                 }
955         } else if (remount_rw) {
956                 /*
957                  * We set s_readonly_remount here to protect filesystem's
958                  * reconfigure code from writes from userspace until
959                  * reconfigure finishes.
960                  */
961                 sb->s_readonly_remount = 1;
962                 smp_wmb();
963         }
964
965         if (fc->ops->reconfigure) {
966                 retval = fc->ops->reconfigure(fc);
967                 if (retval) {
968                         if (!force)
969                                 goto cancel_readonly;
970                         /* If forced remount, go ahead despite any errors */
971                         WARN(1, "forced remount of a %s fs returned %i\n",
972                              sb->s_type->name, retval);
973                 }
974         }
975
976         WRITE_ONCE(sb->s_flags, ((sb->s_flags & ~fc->sb_flags_mask) |
977                                  (fc->sb_flags & fc->sb_flags_mask)));
978         /* Needs to be ordered wrt mnt_is_readonly() */
979         smp_wmb();
980         sb->s_readonly_remount = 0;
981
982         /*
983          * Some filesystems modify their metadata via some other path than the
984          * bdev buffer cache (eg. use a private mapping, or directories in
985          * pagecache, etc). Also file data modifications go via their own
986          * mappings. So If we try to mount readonly then copy the filesystem
987          * from bdev, we could get stale data, so invalidate it to give a best
988          * effort at coherency.
989          */
990         if (remount_ro && sb->s_bdev)
991                 invalidate_bdev(sb->s_bdev);
992         return 0;
993
994 cancel_readonly:
995         sb->s_readonly_remount = 0;
996         return retval;
997 }
998
999 static void do_emergency_remount_callback(struct super_block *sb)
1000 {
1001         down_write(&sb->s_umount);
1002         if (sb->s_root && sb->s_bdev && (sb->s_flags & SB_BORN) &&
1003             !sb_rdonly(sb)) {
1004                 struct fs_context *fc;
1005
1006                 fc = fs_context_for_reconfigure(sb->s_root,
1007                                         SB_RDONLY | SB_FORCE, SB_RDONLY);
1008                 if (!IS_ERR(fc)) {
1009                         if (parse_monolithic_mount_data(fc, NULL) == 0)
1010                                 (void)reconfigure_super(fc);
1011                         put_fs_context(fc);
1012                 }
1013         }
1014         up_write(&sb->s_umount);
1015 }
1016
1017 static void do_emergency_remount(struct work_struct *work)
1018 {
1019         __iterate_supers(do_emergency_remount_callback);
1020         kfree(work);
1021         printk("Emergency Remount complete\n");
1022 }
1023
1024 void emergency_remount(void)
1025 {
1026         struct work_struct *work;
1027
1028         work = kmalloc(sizeof(*work), GFP_ATOMIC);
1029         if (work) {
1030                 INIT_WORK(work, do_emergency_remount);
1031                 schedule_work(work);
1032         }
1033 }
1034
1035 static void do_thaw_all_callback(struct super_block *sb)
1036 {
1037         down_write(&sb->s_umount);
1038         if (sb->s_root && sb->s_flags & SB_BORN) {
1039                 emergency_thaw_bdev(sb);
1040                 thaw_super_locked(sb);
1041         } else {
1042                 up_write(&sb->s_umount);
1043         }
1044 }
1045
1046 static void do_thaw_all(struct work_struct *work)
1047 {
1048         __iterate_supers(do_thaw_all_callback);
1049         kfree(work);
1050         printk(KERN_WARNING "Emergency Thaw complete\n");
1051 }
1052
1053 /**
1054  * emergency_thaw_all -- forcibly thaw every frozen filesystem
1055  *
1056  * Used for emergency unfreeze of all filesystems via SysRq
1057  */
1058 void emergency_thaw_all(void)
1059 {
1060         struct work_struct *work;
1061
1062         work = kmalloc(sizeof(*work), GFP_ATOMIC);
1063         if (work) {
1064                 INIT_WORK(work, do_thaw_all);
1065                 schedule_work(work);
1066         }
1067 }
1068
1069 static DEFINE_IDA(unnamed_dev_ida);
1070
1071 /**
1072  * get_anon_bdev - Allocate a block device for filesystems which don't have one.
1073  * @p: Pointer to a dev_t.
1074  *
1075  * Filesystems which don't use real block devices can call this function
1076  * to allocate a virtual block device.
1077  *
1078  * Context: Any context.  Frequently called while holding sb_lock.
1079  * Return: 0 on success, -EMFILE if there are no anonymous bdevs left
1080  * or -ENOMEM if memory allocation failed.
1081  */
1082 int get_anon_bdev(dev_t *p)
1083 {
1084         int dev;
1085
1086         /*
1087          * Many userspace utilities consider an FSID of 0 invalid.
1088          * Always return at least 1 from get_anon_bdev.
1089          */
1090         dev = ida_alloc_range(&unnamed_dev_ida, 1, (1 << MINORBITS) - 1,
1091                         GFP_ATOMIC);
1092         if (dev == -ENOSPC)
1093                 dev = -EMFILE;
1094         if (dev < 0)
1095                 return dev;
1096
1097         *p = MKDEV(0, dev);
1098         return 0;
1099 }
1100 EXPORT_SYMBOL(get_anon_bdev);
1101
1102 void free_anon_bdev(dev_t dev)
1103 {
1104         ida_free(&unnamed_dev_ida, MINOR(dev));
1105 }
1106 EXPORT_SYMBOL(free_anon_bdev);
1107
1108 int set_anon_super(struct super_block *s, void *data)
1109 {
1110         return get_anon_bdev(&s->s_dev);
1111 }
1112 EXPORT_SYMBOL(set_anon_super);
1113
1114 void kill_anon_super(struct super_block *sb)
1115 {
1116         dev_t dev = sb->s_dev;
1117         generic_shutdown_super(sb);
1118         free_anon_bdev(dev);
1119 }
1120 EXPORT_SYMBOL(kill_anon_super);
1121
1122 void kill_litter_super(struct super_block *sb)
1123 {
1124         if (sb->s_root)
1125                 d_genocide(sb->s_root);
1126         kill_anon_super(sb);
1127 }
1128 EXPORT_SYMBOL(kill_litter_super);
1129
1130 int set_anon_super_fc(struct super_block *sb, struct fs_context *fc)
1131 {
1132         return set_anon_super(sb, NULL);
1133 }
1134 EXPORT_SYMBOL(set_anon_super_fc);
1135
1136 static int test_keyed_super(struct super_block *sb, struct fs_context *fc)
1137 {
1138         return sb->s_fs_info == fc->s_fs_info;
1139 }
1140
1141 static int test_single_super(struct super_block *s, struct fs_context *fc)
1142 {
1143         return 1;
1144 }
1145
1146 /**
1147  * vfs_get_super - Get a superblock with a search key set in s_fs_info.
1148  * @fc: The filesystem context holding the parameters
1149  * @keying: How to distinguish superblocks
1150  * @fill_super: Helper to initialise a new superblock
1151  *
1152  * Search for a superblock and create a new one if not found.  The search
1153  * criterion is controlled by @keying.  If the search fails, a new superblock
1154  * is created and @fill_super() is called to initialise it.
1155  *
1156  * @keying can take one of a number of values:
1157  *
1158  * (1) vfs_get_single_super - Only one superblock of this type may exist on the
1159  *     system.  This is typically used for special system filesystems.
1160  *
1161  * (2) vfs_get_keyed_super - Multiple superblocks may exist, but they must have
1162  *     distinct keys (where the key is in s_fs_info).  Searching for the same
1163  *     key again will turn up the superblock for that key.
1164  *
1165  * (3) vfs_get_independent_super - Multiple superblocks may exist and are
1166  *     unkeyed.  Each call will get a new superblock.
1167  *
1168  * A permissions check is made by sget_fc() unless we're getting a superblock
1169  * for a kernel-internal mount or a submount.
1170  */
1171 int vfs_get_super(struct fs_context *fc,
1172                   enum vfs_get_super_keying keying,
1173                   int (*fill_super)(struct super_block *sb,
1174                                     struct fs_context *fc))
1175 {
1176         int (*test)(struct super_block *, struct fs_context *);
1177         struct super_block *sb;
1178         int err;
1179
1180         switch (keying) {
1181         case vfs_get_single_super:
1182         case vfs_get_single_reconf_super:
1183                 test = test_single_super;
1184                 break;
1185         case vfs_get_keyed_super:
1186                 test = test_keyed_super;
1187                 break;
1188         case vfs_get_independent_super:
1189                 test = NULL;
1190                 break;
1191         default:
1192                 BUG();
1193         }
1194
1195         sb = sget_fc(fc, test, set_anon_super_fc);
1196         if (IS_ERR(sb))
1197                 return PTR_ERR(sb);
1198
1199         if (!sb->s_root) {
1200                 err = fill_super(sb, fc);
1201                 if (err)
1202                         goto error;
1203
1204                 sb->s_flags |= SB_ACTIVE;
1205                 fc->root = dget(sb->s_root);
1206         } else {
1207                 fc->root = dget(sb->s_root);
1208                 if (keying == vfs_get_single_reconf_super) {
1209                         err = reconfigure_super(fc);
1210                         if (err < 0) {
1211                                 dput(fc->root);
1212                                 fc->root = NULL;
1213                                 goto error;
1214                         }
1215                 }
1216         }
1217
1218         return 0;
1219
1220 error:
1221         deactivate_locked_super(sb);
1222         return err;
1223 }
1224 EXPORT_SYMBOL(vfs_get_super);
1225
1226 int get_tree_nodev(struct fs_context *fc,
1227                   int (*fill_super)(struct super_block *sb,
1228                                     struct fs_context *fc))
1229 {
1230         return vfs_get_super(fc, vfs_get_independent_super, fill_super);
1231 }
1232 EXPORT_SYMBOL(get_tree_nodev);
1233
1234 int get_tree_single(struct fs_context *fc,
1235                   int (*fill_super)(struct super_block *sb,
1236                                     struct fs_context *fc))
1237 {
1238         return vfs_get_super(fc, vfs_get_single_super, fill_super);
1239 }
1240 EXPORT_SYMBOL(get_tree_single);
1241
1242 int get_tree_single_reconf(struct fs_context *fc,
1243                   int (*fill_super)(struct super_block *sb,
1244                                     struct fs_context *fc))
1245 {
1246         return vfs_get_super(fc, vfs_get_single_reconf_super, fill_super);
1247 }
1248 EXPORT_SYMBOL(get_tree_single_reconf);
1249
1250 int get_tree_keyed(struct fs_context *fc,
1251                   int (*fill_super)(struct super_block *sb,
1252                                     struct fs_context *fc),
1253                 void *key)
1254 {
1255         fc->s_fs_info = key;
1256         return vfs_get_super(fc, vfs_get_keyed_super, fill_super);
1257 }
1258 EXPORT_SYMBOL(get_tree_keyed);
1259
1260 #ifdef CONFIG_BLOCK
1261
1262 static int set_bdev_super(struct super_block *s, void *data)
1263 {
1264         s->s_bdev = data;
1265         s->s_dev = s->s_bdev->bd_dev;
1266         s->s_bdi = bdi_get(s->s_bdev->bd_disk->bdi);
1267
1268         if (bdev_stable_writes(s->s_bdev))
1269                 s->s_iflags |= SB_I_STABLE_WRITES;
1270         return 0;
1271 }
1272
1273 static int set_bdev_super_fc(struct super_block *s, struct fs_context *fc)
1274 {
1275         return set_bdev_super(s, fc->sget_key);
1276 }
1277
1278 static int test_bdev_super_fc(struct super_block *s, struct fs_context *fc)
1279 {
1280         return !(s->s_iflags & SB_I_RETIRED) && s->s_bdev == fc->sget_key;
1281 }
1282
1283 /**
1284  * get_tree_bdev - Get a superblock based on a single block device
1285  * @fc: The filesystem context holding the parameters
1286  * @fill_super: Helper to initialise a new superblock
1287  */
1288 int get_tree_bdev(struct fs_context *fc,
1289                 int (*fill_super)(struct super_block *,
1290                                   struct fs_context *))
1291 {
1292         struct block_device *bdev;
1293         struct super_block *s;
1294         fmode_t mode = FMODE_READ | FMODE_EXCL;
1295         int error = 0;
1296
1297         if (!(fc->sb_flags & SB_RDONLY))
1298                 mode |= FMODE_WRITE;
1299
1300         if (!fc->source)
1301                 return invalf(fc, "No source specified");
1302
1303         bdev = blkdev_get_by_path(fc->source, mode, fc->fs_type);
1304         if (IS_ERR(bdev)) {
1305                 errorf(fc, "%s: Can't open blockdev", fc->source);
1306                 return PTR_ERR(bdev);
1307         }
1308
1309         /* Once the superblock is inserted into the list by sget_fc(), s_umount
1310          * will protect the lockfs code from trying to start a snapshot while
1311          * we are mounting
1312          */
1313         mutex_lock(&bdev->bd_fsfreeze_mutex);
1314         if (bdev->bd_fsfreeze_count > 0) {
1315                 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1316                 warnf(fc, "%pg: Can't mount, blockdev is frozen", bdev);
1317                 blkdev_put(bdev, mode);
1318                 return -EBUSY;
1319         }
1320
1321         fc->sb_flags |= SB_NOSEC;
1322         fc->sget_key = bdev;
1323         s = sget_fc(fc, test_bdev_super_fc, set_bdev_super_fc);
1324         mutex_unlock(&bdev->bd_fsfreeze_mutex);
1325         if (IS_ERR(s)) {
1326                 blkdev_put(bdev, mode);
1327                 return PTR_ERR(s);
1328         }
1329
1330         if (s->s_root) {
1331                 /* Don't summarily change the RO/RW state. */
1332                 if ((fc->sb_flags ^ s->s_flags) & SB_RDONLY) {
1333                         warnf(fc, "%pg: Can't mount, would change RO state", bdev);
1334                         deactivate_locked_super(s);
1335                         blkdev_put(bdev, mode);
1336                         return -EBUSY;
1337                 }
1338
1339                 /*
1340                  * s_umount nests inside open_mutex during
1341                  * __invalidate_device().  blkdev_put() acquires
1342                  * open_mutex and can't be called under s_umount.  Drop
1343                  * s_umount temporarily.  This is safe as we're
1344                  * holding an active reference.
1345                  */
1346                 up_write(&s->s_umount);
1347                 blkdev_put(bdev, mode);
1348                 down_write(&s->s_umount);
1349         } else {
1350                 s->s_mode = mode;
1351                 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
1352                 shrinker_debugfs_rename(&s->s_shrink, "sb-%s:%s",
1353                                         fc->fs_type->name, s->s_id);
1354                 sb_set_blocksize(s, block_size(bdev));
1355                 error = fill_super(s, fc);
1356                 if (error) {
1357                         deactivate_locked_super(s);
1358                         return error;
1359                 }
1360
1361                 s->s_flags |= SB_ACTIVE;
1362                 bdev->bd_super = s;
1363         }
1364
1365         BUG_ON(fc->root);
1366         fc->root = dget(s->s_root);
1367         return 0;
1368 }
1369 EXPORT_SYMBOL(get_tree_bdev);
1370
1371 static int test_bdev_super(struct super_block *s, void *data)
1372 {
1373         return !(s->s_iflags & SB_I_RETIRED) && (void *)s->s_bdev == data;
1374 }
1375
1376 struct dentry *mount_bdev(struct file_system_type *fs_type,
1377         int flags, const char *dev_name, void *data,
1378         int (*fill_super)(struct super_block *, void *, int))
1379 {
1380         struct block_device *bdev;
1381         struct super_block *s;
1382         fmode_t mode = FMODE_READ | FMODE_EXCL;
1383         int error = 0;
1384
1385         if (!(flags & SB_RDONLY))
1386                 mode |= FMODE_WRITE;
1387
1388         bdev = blkdev_get_by_path(dev_name, mode, fs_type);
1389         if (IS_ERR(bdev))
1390                 return ERR_CAST(bdev);
1391
1392         /*
1393          * once the super is inserted into the list by sget, s_umount
1394          * will protect the lockfs code from trying to start a snapshot
1395          * while we are mounting
1396          */
1397         mutex_lock(&bdev->bd_fsfreeze_mutex);
1398         if (bdev->bd_fsfreeze_count > 0) {
1399                 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1400                 error = -EBUSY;
1401                 goto error_bdev;
1402         }
1403         s = sget(fs_type, test_bdev_super, set_bdev_super, flags | SB_NOSEC,
1404                  bdev);
1405         mutex_unlock(&bdev->bd_fsfreeze_mutex);
1406         if (IS_ERR(s))
1407                 goto error_s;
1408
1409         if (s->s_root) {
1410                 if ((flags ^ s->s_flags) & SB_RDONLY) {
1411                         deactivate_locked_super(s);
1412                         error = -EBUSY;
1413                         goto error_bdev;
1414                 }
1415
1416                 /*
1417                  * s_umount nests inside open_mutex during
1418                  * __invalidate_device().  blkdev_put() acquires
1419                  * open_mutex and can't be called under s_umount.  Drop
1420                  * s_umount temporarily.  This is safe as we're
1421                  * holding an active reference.
1422                  */
1423                 up_write(&s->s_umount);
1424                 blkdev_put(bdev, mode);
1425                 down_write(&s->s_umount);
1426         } else {
1427                 s->s_mode = mode;
1428                 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
1429                 shrinker_debugfs_rename(&s->s_shrink, "sb-%s:%s",
1430                                         fs_type->name, s->s_id);
1431                 sb_set_blocksize(s, block_size(bdev));
1432                 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1433                 if (error) {
1434                         deactivate_locked_super(s);
1435                         goto error;
1436                 }
1437
1438                 s->s_flags |= SB_ACTIVE;
1439                 bdev->bd_super = s;
1440         }
1441
1442         return dget(s->s_root);
1443
1444 error_s:
1445         error = PTR_ERR(s);
1446 error_bdev:
1447         blkdev_put(bdev, mode);
1448 error:
1449         return ERR_PTR(error);
1450 }
1451 EXPORT_SYMBOL(mount_bdev);
1452
1453 void kill_block_super(struct super_block *sb)
1454 {
1455         struct block_device *bdev = sb->s_bdev;
1456         fmode_t mode = sb->s_mode;
1457
1458         bdev->bd_super = NULL;
1459         generic_shutdown_super(sb);
1460         sync_blockdev(bdev);
1461         WARN_ON_ONCE(!(mode & FMODE_EXCL));
1462         blkdev_put(bdev, mode | FMODE_EXCL);
1463 }
1464
1465 EXPORT_SYMBOL(kill_block_super);
1466 #endif
1467
1468 struct dentry *mount_nodev(struct file_system_type *fs_type,
1469         int flags, void *data,
1470         int (*fill_super)(struct super_block *, void *, int))
1471 {
1472         int error;
1473         struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1474
1475         if (IS_ERR(s))
1476                 return ERR_CAST(s);
1477
1478         error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1479         if (error) {
1480                 deactivate_locked_super(s);
1481                 return ERR_PTR(error);
1482         }
1483         s->s_flags |= SB_ACTIVE;
1484         return dget(s->s_root);
1485 }
1486 EXPORT_SYMBOL(mount_nodev);
1487
1488 int reconfigure_single(struct super_block *s,
1489                        int flags, void *data)
1490 {
1491         struct fs_context *fc;
1492         int ret;
1493
1494         /* The caller really need to be passing fc down into mount_single(),
1495          * then a chunk of this can be removed.  [Bollocks -- AV]
1496          * Better yet, reconfiguration shouldn't happen, but rather the second
1497          * mount should be rejected if the parameters are not compatible.
1498          */
1499         fc = fs_context_for_reconfigure(s->s_root, flags, MS_RMT_MASK);
1500         if (IS_ERR(fc))
1501                 return PTR_ERR(fc);
1502
1503         ret = parse_monolithic_mount_data(fc, data);
1504         if (ret < 0)
1505                 goto out;
1506
1507         ret = reconfigure_super(fc);
1508 out:
1509         put_fs_context(fc);
1510         return ret;
1511 }
1512
1513 static int compare_single(struct super_block *s, void *p)
1514 {
1515         return 1;
1516 }
1517
1518 struct dentry *mount_single(struct file_system_type *fs_type,
1519         int flags, void *data,
1520         int (*fill_super)(struct super_block *, void *, int))
1521 {
1522         struct super_block *s;
1523         int error;
1524
1525         s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1526         if (IS_ERR(s))
1527                 return ERR_CAST(s);
1528         if (!s->s_root) {
1529                 error = fill_super(s, data, flags & SB_SILENT ? 1 : 0);
1530                 if (!error)
1531                         s->s_flags |= SB_ACTIVE;
1532         } else {
1533                 error = reconfigure_single(s, flags, data);
1534         }
1535         if (unlikely(error)) {
1536                 deactivate_locked_super(s);
1537                 return ERR_PTR(error);
1538         }
1539         return dget(s->s_root);
1540 }
1541 EXPORT_SYMBOL(mount_single);
1542
1543 /**
1544  * vfs_get_tree - Get the mountable root
1545  * @fc: The superblock configuration context.
1546  *
1547  * The filesystem is invoked to get or create a superblock which can then later
1548  * be used for mounting.  The filesystem places a pointer to the root to be
1549  * used for mounting in @fc->root.
1550  */
1551 int vfs_get_tree(struct fs_context *fc)
1552 {
1553         struct super_block *sb;
1554         int error;
1555
1556         if (fc->root)
1557                 return -EBUSY;
1558
1559         /* Get the mountable root in fc->root, with a ref on the root and a ref
1560          * on the superblock.
1561          */
1562         error = fc->ops->get_tree(fc);
1563         if (error < 0)
1564                 return error;
1565
1566         if (!fc->root) {
1567                 pr_err("Filesystem %s get_tree() didn't set fc->root\n",
1568                        fc->fs_type->name);
1569                 /* We don't know what the locking state of the superblock is -
1570                  * if there is a superblock.
1571                  */
1572                 BUG();
1573         }
1574
1575         sb = fc->root->d_sb;
1576         WARN_ON(!sb->s_bdi);
1577
1578         /*
1579          * Write barrier is for super_cache_count(). We place it before setting
1580          * SB_BORN as the data dependency between the two functions is the
1581          * superblock structure contents that we just set up, not the SB_BORN
1582          * flag.
1583          */
1584         smp_wmb();
1585         sb->s_flags |= SB_BORN;
1586
1587         error = security_sb_set_mnt_opts(sb, fc->security, 0, NULL);
1588         if (unlikely(error)) {
1589                 fc_drop_locked(fc);
1590                 return error;
1591         }
1592
1593         /*
1594          * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1595          * but s_maxbytes was an unsigned long long for many releases. Throw
1596          * this warning for a little while to try and catch filesystems that
1597          * violate this rule.
1598          */
1599         WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1600                 "negative value (%lld)\n", fc->fs_type->name, sb->s_maxbytes);
1601
1602         return 0;
1603 }
1604 EXPORT_SYMBOL(vfs_get_tree);
1605
1606 /*
1607  * Setup private BDI for given superblock. It gets automatically cleaned up
1608  * in generic_shutdown_super().
1609  */
1610 int super_setup_bdi_name(struct super_block *sb, char *fmt, ...)
1611 {
1612         struct backing_dev_info *bdi;
1613         int err;
1614         va_list args;
1615
1616         bdi = bdi_alloc(NUMA_NO_NODE);
1617         if (!bdi)
1618                 return -ENOMEM;
1619
1620         va_start(args, fmt);
1621         err = bdi_register_va(bdi, fmt, args);
1622         va_end(args);
1623         if (err) {
1624                 bdi_put(bdi);
1625                 return err;
1626         }
1627         WARN_ON(sb->s_bdi != &noop_backing_dev_info);
1628         sb->s_bdi = bdi;
1629         sb->s_iflags |= SB_I_PERSB_BDI;
1630
1631         return 0;
1632 }
1633 EXPORT_SYMBOL(super_setup_bdi_name);
1634
1635 /*
1636  * Setup private BDI for given superblock. I gets automatically cleaned up
1637  * in generic_shutdown_super().
1638  */
1639 int super_setup_bdi(struct super_block *sb)
1640 {
1641         static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1642
1643         return super_setup_bdi_name(sb, "%.28s-%ld", sb->s_type->name,
1644                                     atomic_long_inc_return(&bdi_seq));
1645 }
1646 EXPORT_SYMBOL(super_setup_bdi);
1647
1648 /**
1649  * sb_wait_write - wait until all writers to given file system finish
1650  * @sb: the super for which we wait
1651  * @level: type of writers we wait for (normal vs page fault)
1652  *
1653  * This function waits until there are no writers of given type to given file
1654  * system.
1655  */
1656 static void sb_wait_write(struct super_block *sb, int level)
1657 {
1658         percpu_down_write(sb->s_writers.rw_sem + level-1);
1659 }
1660
1661 /*
1662  * We are going to return to userspace and forget about these locks, the
1663  * ownership goes to the caller of thaw_super() which does unlock().
1664  */
1665 static void lockdep_sb_freeze_release(struct super_block *sb)
1666 {
1667         int level;
1668
1669         for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1670                 percpu_rwsem_release(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1671 }
1672
1673 /*
1674  * Tell lockdep we are holding these locks before we call ->unfreeze_fs(sb).
1675  */
1676 static void lockdep_sb_freeze_acquire(struct super_block *sb)
1677 {
1678         int level;
1679
1680         for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1681                 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1682 }
1683
1684 static void sb_freeze_unlock(struct super_block *sb, int level)
1685 {
1686         for (level--; level >= 0; level--)
1687                 percpu_up_write(sb->s_writers.rw_sem + level);
1688 }
1689
1690 /**
1691  * freeze_super - lock the filesystem and force it into a consistent state
1692  * @sb: the super to lock
1693  *
1694  * Syncs the super to make sure the filesystem is consistent and calls the fs's
1695  * freeze_fs.  Subsequent calls to this without first thawing the fs will return
1696  * -EBUSY.
1697  *
1698  * During this function, sb->s_writers.frozen goes through these values:
1699  *
1700  * SB_UNFROZEN: File system is normal, all writes progress as usual.
1701  *
1702  * SB_FREEZE_WRITE: The file system is in the process of being frozen.  New
1703  * writes should be blocked, though page faults are still allowed. We wait for
1704  * all writes to complete and then proceed to the next stage.
1705  *
1706  * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1707  * but internal fs threads can still modify the filesystem (although they
1708  * should not dirty new pages or inodes), writeback can run etc. After waiting
1709  * for all running page faults we sync the filesystem which will clean all
1710  * dirty pages and inodes (no new dirty pages or inodes can be created when
1711  * sync is running).
1712  *
1713  * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1714  * modification are blocked (e.g. XFS preallocation truncation on inode
1715  * reclaim). This is usually implemented by blocking new transactions for
1716  * filesystems that have them and need this additional guard. After all
1717  * internal writers are finished we call ->freeze_fs() to finish filesystem
1718  * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1719  * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1720  *
1721  * sb->s_writers.frozen is protected by sb->s_umount.
1722  */
1723 int freeze_super(struct super_block *sb)
1724 {
1725         int ret;
1726
1727         atomic_inc(&sb->s_active);
1728         down_write(&sb->s_umount);
1729         if (sb->s_writers.frozen != SB_UNFROZEN) {
1730                 deactivate_locked_super(sb);
1731                 return -EBUSY;
1732         }
1733
1734         if (!(sb->s_flags & SB_BORN)) {
1735                 up_write(&sb->s_umount);
1736                 return 0;       /* sic - it's "nothing to do" */
1737         }
1738
1739         if (sb_rdonly(sb)) {
1740                 /* Nothing to do really... */
1741                 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1742                 up_write(&sb->s_umount);
1743                 return 0;
1744         }
1745
1746         sb->s_writers.frozen = SB_FREEZE_WRITE;
1747         /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1748         up_write(&sb->s_umount);
1749         sb_wait_write(sb, SB_FREEZE_WRITE);
1750         down_write(&sb->s_umount);
1751
1752         /* Now we go and block page faults... */
1753         sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
1754         sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1755
1756         /* All writers are done so after syncing there won't be dirty data */
1757         ret = sync_filesystem(sb);
1758         if (ret) {
1759                 sb->s_writers.frozen = SB_UNFROZEN;
1760                 sb_freeze_unlock(sb, SB_FREEZE_PAGEFAULT);
1761                 wake_up(&sb->s_writers.wait_unfrozen);
1762                 deactivate_locked_super(sb);
1763                 return ret;
1764         }
1765
1766         /* Now wait for internal filesystem counter */
1767         sb->s_writers.frozen = SB_FREEZE_FS;
1768         sb_wait_write(sb, SB_FREEZE_FS);
1769
1770         if (sb->s_op->freeze_fs) {
1771                 ret = sb->s_op->freeze_fs(sb);
1772                 if (ret) {
1773                         printk(KERN_ERR
1774                                 "VFS:Filesystem freeze failed\n");
1775                         sb->s_writers.frozen = SB_UNFROZEN;
1776                         sb_freeze_unlock(sb, SB_FREEZE_FS);
1777                         wake_up(&sb->s_writers.wait_unfrozen);
1778                         deactivate_locked_super(sb);
1779                         return ret;
1780                 }
1781         }
1782         /*
1783          * For debugging purposes so that fs can warn if it sees write activity
1784          * when frozen is set to SB_FREEZE_COMPLETE, and for thaw_super().
1785          */
1786         sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1787         lockdep_sb_freeze_release(sb);
1788         up_write(&sb->s_umount);
1789         return 0;
1790 }
1791 EXPORT_SYMBOL(freeze_super);
1792
1793 static int thaw_super_locked(struct super_block *sb)
1794 {
1795         int error;
1796
1797         if (sb->s_writers.frozen != SB_FREEZE_COMPLETE) {
1798                 up_write(&sb->s_umount);
1799                 return -EINVAL;
1800         }
1801
1802         if (sb_rdonly(sb)) {
1803                 sb->s_writers.frozen = SB_UNFROZEN;
1804                 goto out;
1805         }
1806
1807         lockdep_sb_freeze_acquire(sb);
1808
1809         if (sb->s_op->unfreeze_fs) {
1810                 error = sb->s_op->unfreeze_fs(sb);
1811                 if (error) {
1812                         printk(KERN_ERR
1813                                 "VFS:Filesystem thaw failed\n");
1814                         lockdep_sb_freeze_release(sb);
1815                         up_write(&sb->s_umount);
1816                         return error;
1817                 }
1818         }
1819
1820         sb->s_writers.frozen = SB_UNFROZEN;
1821         sb_freeze_unlock(sb, SB_FREEZE_FS);
1822 out:
1823         wake_up(&sb->s_writers.wait_unfrozen);
1824         deactivate_locked_super(sb);
1825         return 0;
1826 }
1827
1828 /**
1829  * thaw_super -- unlock filesystem
1830  * @sb: the super to thaw
1831  *
1832  * Unlocks the filesystem and marks it writeable again after freeze_super().
1833  */
1834 int thaw_super(struct super_block *sb)
1835 {
1836         down_write(&sb->s_umount);
1837         return thaw_super_locked(sb);
1838 }
1839 EXPORT_SYMBOL(thaw_super);