4 * Copyright (C) 1991, 1992 Linus Torvalds
6 * super.c contains code to handle: - mount structures
8 * - filesystem drivers list
10 * - umount system call
13 * GK 2/5/95 - Changed to support mounting the root fs via NFS
15 * Added kerneld support: Jacques Gelinas and Bjorn Ekwall
16 * Added change_root: Werner Almesberger & Hans Lermen, Feb '96
17 * Added options to /proc/mounts:
20 * Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
23 #include <linux/export.h>
24 #include <linux/slab.h>
25 #include <linux/blkdev.h>
26 #include <linux/mount.h>
27 #include <linux/security.h>
28 #include <linux/writeback.h> /* for the emergency remount stuff */
29 #include <linux/idr.h>
30 #include <linux/mutex.h>
31 #include <linux/backing-dev.h>
32 #include <linux/rculist_bl.h>
33 #include <linux/cleancache.h>
34 #include <linux/fsnotify.h>
35 #include <linux/lockdep.h>
39 static LIST_HEAD(super_blocks);
40 static DEFINE_SPINLOCK(sb_lock);
42 static char *sb_writers_name[SB_FREEZE_LEVELS] = {
49 * One thing we have to be careful of with a per-sb shrinker is that we don't
50 * drop the last active reference to the superblock from within the shrinker.
51 * If that happens we could trigger unregistering the shrinker from within the
52 * shrinker path and that leads to deadlock on the shrinker_rwsem. Hence we
53 * take a passive reference to the superblock to avoid this from occurring.
55 static unsigned long super_cache_scan(struct shrinker *shrink,
56 struct shrink_control *sc)
58 struct super_block *sb;
65 sb = container_of(shrink, struct super_block, s_shrink);
68 * Deadlock avoidance. We may hold various FS locks, and we don't want
69 * to recurse into the FS that called us in clear_inode() and friends..
71 if (!(sc->gfp_mask & __GFP_FS))
74 if (!trylock_super(sb))
77 if (sb->s_op->nr_cached_objects)
78 fs_objects = sb->s_op->nr_cached_objects(sb, sc);
80 inodes = list_lru_shrink_count(&sb->s_inode_lru, sc);
81 dentries = list_lru_shrink_count(&sb->s_dentry_lru, sc);
82 total_objects = dentries + inodes + fs_objects + 1;
86 /* proportion the scan between the caches */
87 dentries = mult_frac(sc->nr_to_scan, dentries, total_objects);
88 inodes = mult_frac(sc->nr_to_scan, inodes, total_objects);
89 fs_objects = mult_frac(sc->nr_to_scan, fs_objects, total_objects);
92 * prune the dcache first as the icache is pinned by it, then
93 * prune the icache, followed by the filesystem specific caches
95 * Ensure that we always scan at least one object - memcg kmem
96 * accounting uses this to fully empty the caches.
98 sc->nr_to_scan = dentries + 1;
99 freed = prune_dcache_sb(sb, sc);
100 sc->nr_to_scan = inodes + 1;
101 freed += prune_icache_sb(sb, sc);
104 sc->nr_to_scan = fs_objects + 1;
105 freed += sb->s_op->free_cached_objects(sb, sc);
108 up_read(&sb->s_umount);
112 static unsigned long super_cache_count(struct shrinker *shrink,
113 struct shrink_control *sc)
115 struct super_block *sb;
116 long total_objects = 0;
118 sb = container_of(shrink, struct super_block, s_shrink);
121 * Don't call trylock_super as it is a potential
122 * scalability bottleneck. The counts could get updated
123 * between super_cache_count and super_cache_scan anyway.
124 * Call to super_cache_count with shrinker_rwsem held
125 * ensures the safety of call to list_lru_shrink_count() and
126 * s_op->nr_cached_objects().
128 if (sb->s_op && sb->s_op->nr_cached_objects)
129 total_objects = sb->s_op->nr_cached_objects(sb, sc);
131 total_objects += list_lru_shrink_count(&sb->s_dentry_lru, sc);
132 total_objects += list_lru_shrink_count(&sb->s_inode_lru, sc);
134 total_objects = vfs_pressure_ratio(total_objects);
135 return total_objects;
138 static void destroy_super_work(struct work_struct *work)
140 struct super_block *s = container_of(work, struct super_block,
144 for (i = 0; i < SB_FREEZE_LEVELS; i++)
145 percpu_free_rwsem(&s->s_writers.rw_sem[i]);
149 static void destroy_super_rcu(struct rcu_head *head)
151 struct super_block *s = container_of(head, struct super_block, rcu);
152 INIT_WORK(&s->destroy_work, destroy_super_work);
153 schedule_work(&s->destroy_work);
157 * destroy_super - frees a superblock
158 * @s: superblock to free
160 * Frees a superblock.
162 static void destroy_super(struct super_block *s)
164 list_lru_destroy(&s->s_dentry_lru);
165 list_lru_destroy(&s->s_inode_lru);
167 WARN_ON(!list_empty(&s->s_mounts));
170 call_rcu(&s->rcu, destroy_super_rcu);
174 * alloc_super - create new superblock
175 * @type: filesystem type superblock should belong to
176 * @flags: the mount flags
178 * Allocates and initializes a new &struct super_block. alloc_super()
179 * returns a pointer new superblock or %NULL if allocation had failed.
181 static struct super_block *alloc_super(struct file_system_type *type, int flags)
183 struct super_block *s = kzalloc(sizeof(struct super_block), GFP_USER);
184 static const struct super_operations default_op;
190 INIT_LIST_HEAD(&s->s_mounts);
192 if (security_sb_alloc(s))
195 for (i = 0; i < SB_FREEZE_LEVELS; i++) {
196 if (__percpu_init_rwsem(&s->s_writers.rw_sem[i],
198 &type->s_writers_key[i]))
201 init_waitqueue_head(&s->s_writers.wait_unfrozen);
202 s->s_bdi = &noop_backing_dev_info;
204 INIT_HLIST_NODE(&s->s_instances);
205 INIT_HLIST_BL_HEAD(&s->s_anon);
206 mutex_init(&s->s_sync_lock);
207 INIT_LIST_HEAD(&s->s_inodes);
208 spin_lock_init(&s->s_inode_list_lock);
209 INIT_LIST_HEAD(&s->s_inodes_wb);
210 spin_lock_init(&s->s_inode_wblist_lock);
212 if (list_lru_init_memcg(&s->s_dentry_lru))
214 if (list_lru_init_memcg(&s->s_inode_lru))
217 init_rwsem(&s->s_umount);
218 lockdep_set_class(&s->s_umount, &type->s_umount_key);
220 * sget() can have s_umount recursion.
222 * When it cannot find a suitable sb, it allocates a new
223 * one (this one), and tries again to find a suitable old
226 * In case that succeeds, it will acquire the s_umount
227 * lock of the old one. Since these are clearly distrinct
228 * locks, and this object isn't exposed yet, there's no
231 * Annotate this by putting this lock in a different
234 down_write_nested(&s->s_umount, SINGLE_DEPTH_NESTING);
236 atomic_set(&s->s_active, 1);
237 mutex_init(&s->s_vfs_rename_mutex);
238 lockdep_set_class(&s->s_vfs_rename_mutex, &type->s_vfs_rename_key);
239 mutex_init(&s->s_dquot.dqio_mutex);
240 mutex_init(&s->s_dquot.dqonoff_mutex);
241 s->s_maxbytes = MAX_NON_LFS;
242 s->s_op = &default_op;
243 s->s_time_gran = 1000000000;
244 s->cleancache_poolid = CLEANCACHE_NO_POOL;
246 s->s_shrink.seeks = DEFAULT_SEEKS;
247 s->s_shrink.scan_objects = super_cache_scan;
248 s->s_shrink.count_objects = super_cache_count;
249 s->s_shrink.batch = 1024;
250 s->s_shrink.flags = SHRINKER_NUMA_AWARE | SHRINKER_MEMCG_AWARE;
258 /* Superblock refcounting */
261 * Drop a superblock's refcount. The caller must hold sb_lock.
263 static void __put_super(struct super_block *sb)
265 if (!--sb->s_count) {
266 list_del_init(&sb->s_list);
272 * put_super - drop a temporary reference to superblock
273 * @sb: superblock in question
275 * Drops a temporary reference, frees superblock if there's no
278 static void put_super(struct super_block *sb)
282 spin_unlock(&sb_lock);
287 * deactivate_locked_super - drop an active reference to superblock
288 * @s: superblock to deactivate
290 * Drops an active reference to superblock, converting it into a temporary
291 * one if there is no other active references left. In that case we
292 * tell fs driver to shut it down and drop the temporary reference we
295 * Caller holds exclusive lock on superblock; that lock is released.
297 void deactivate_locked_super(struct super_block *s)
299 struct file_system_type *fs = s->s_type;
300 if (atomic_dec_and_test(&s->s_active)) {
301 cleancache_invalidate_fs(s);
302 unregister_shrinker(&s->s_shrink);
306 * Since list_lru_destroy() may sleep, we cannot call it from
307 * put_super(), where we hold the sb_lock. Therefore we destroy
308 * the lru lists right now.
310 list_lru_destroy(&s->s_dentry_lru);
311 list_lru_destroy(&s->s_inode_lru);
316 up_write(&s->s_umount);
320 EXPORT_SYMBOL(deactivate_locked_super);
323 * deactivate_super - drop an active reference to superblock
324 * @s: superblock to deactivate
326 * Variant of deactivate_locked_super(), except that superblock is *not*
327 * locked by caller. If we are going to drop the final active reference,
328 * lock will be acquired prior to that.
330 void deactivate_super(struct super_block *s)
332 if (!atomic_add_unless(&s->s_active, -1, 1)) {
333 down_write(&s->s_umount);
334 deactivate_locked_super(s);
338 EXPORT_SYMBOL(deactivate_super);
341 * grab_super - acquire an active reference
342 * @s: reference we are trying to make active
344 * Tries to acquire an active reference. grab_super() is used when we
345 * had just found a superblock in super_blocks or fs_type->fs_supers
346 * and want to turn it into a full-blown active reference. grab_super()
347 * is called with sb_lock held and drops it. Returns 1 in case of
348 * success, 0 if we had failed (superblock contents was already dead or
349 * dying when grab_super() had been called). Note that this is only
350 * called for superblocks not in rundown mode (== ones still on ->fs_supers
351 * of their type), so increment of ->s_count is OK here.
353 static int grab_super(struct super_block *s) __releases(sb_lock)
356 spin_unlock(&sb_lock);
357 down_write(&s->s_umount);
358 if ((s->s_flags & MS_BORN) && atomic_inc_not_zero(&s->s_active)) {
362 up_write(&s->s_umount);
368 * trylock_super - try to grab ->s_umount shared
369 * @sb: reference we are trying to grab
371 * Try to prevent fs shutdown. This is used in places where we
372 * cannot take an active reference but we need to ensure that the
373 * filesystem is not shut down while we are working on it. It returns
374 * false if we cannot acquire s_umount or if we lose the race and
375 * filesystem already got into shutdown, and returns true with the s_umount
376 * lock held in read mode in case of success. On successful return,
377 * the caller must drop the s_umount lock when done.
379 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
380 * The reason why it's safe is that we are OK with doing trylock instead
381 * of down_read(). There's a couple of places that are OK with that, but
382 * it's very much not a general-purpose interface.
384 bool trylock_super(struct super_block *sb)
386 if (down_read_trylock(&sb->s_umount)) {
387 if (!hlist_unhashed(&sb->s_instances) &&
388 sb->s_root && (sb->s_flags & MS_BORN))
390 up_read(&sb->s_umount);
397 * generic_shutdown_super - common helper for ->kill_sb()
398 * @sb: superblock to kill
400 * generic_shutdown_super() does all fs-independent work on superblock
401 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
402 * that need destruction out of superblock, call generic_shutdown_super()
403 * and release aforementioned objects. Note: dentries and inodes _are_
404 * taken care of and do not need specific handling.
406 * Upon calling this function, the filesystem may no longer alter or
407 * rearrange the set of dentries belonging to this super_block, nor may it
408 * change the attachments of dentries to inodes.
410 void generic_shutdown_super(struct super_block *sb)
412 const struct super_operations *sop = sb->s_op;
415 shrink_dcache_for_umount(sb);
417 sb->s_flags &= ~MS_ACTIVE;
419 fsnotify_unmount_inodes(sb);
420 cgroup_writeback_umount();
424 if (sb->s_dio_done_wq) {
425 destroy_workqueue(sb->s_dio_done_wq);
426 sb->s_dio_done_wq = NULL;
432 if (!list_empty(&sb->s_inodes)) {
433 printk("VFS: Busy inodes after unmount of %s. "
434 "Self-destruct in 5 seconds. Have a nice day...\n",
439 /* should be initialized for __put_super_and_need_restart() */
440 hlist_del_init(&sb->s_instances);
441 spin_unlock(&sb_lock);
442 up_write(&sb->s_umount);
445 EXPORT_SYMBOL(generic_shutdown_super);
448 * sget - find or create a superblock
449 * @type: filesystem type superblock should belong to
450 * @test: comparison callback
451 * @set: setup callback
452 * @flags: mount flags
453 * @data: argument to each of them
455 struct super_block *sget(struct file_system_type *type,
456 int (*test)(struct super_block *,void *),
457 int (*set)(struct super_block *,void *),
461 struct super_block *s = NULL;
462 struct super_block *old;
468 hlist_for_each_entry(old, &type->fs_supers, s_instances) {
469 if (!test(old, data))
471 if (!grab_super(old))
474 up_write(&s->s_umount);
482 spin_unlock(&sb_lock);
483 s = alloc_super(type, flags);
485 return ERR_PTR(-ENOMEM);
491 spin_unlock(&sb_lock);
492 up_write(&s->s_umount);
497 strlcpy(s->s_id, type->name, sizeof(s->s_id));
498 list_add_tail(&s->s_list, &super_blocks);
499 hlist_add_head(&s->s_instances, &type->fs_supers);
500 spin_unlock(&sb_lock);
501 get_filesystem(type);
502 register_shrinker(&s->s_shrink);
508 void drop_super(struct super_block *sb)
510 up_read(&sb->s_umount);
514 EXPORT_SYMBOL(drop_super);
517 * iterate_supers - call function for all active superblocks
518 * @f: function to call
519 * @arg: argument to pass to it
521 * Scans the superblock list and calls given function, passing it
522 * locked superblock and given argument.
524 void iterate_supers(void (*f)(struct super_block *, void *), void *arg)
526 struct super_block *sb, *p = NULL;
529 list_for_each_entry(sb, &super_blocks, s_list) {
530 if (hlist_unhashed(&sb->s_instances))
533 spin_unlock(&sb_lock);
535 down_read(&sb->s_umount);
536 if (sb->s_root && (sb->s_flags & MS_BORN))
538 up_read(&sb->s_umount);
547 spin_unlock(&sb_lock);
551 * iterate_supers_type - call function for superblocks of given type
553 * @f: function to call
554 * @arg: argument to pass to it
556 * Scans the superblock list and calls given function, passing it
557 * locked superblock and given argument.
559 void iterate_supers_type(struct file_system_type *type,
560 void (*f)(struct super_block *, void *), void *arg)
562 struct super_block *sb, *p = NULL;
565 hlist_for_each_entry(sb, &type->fs_supers, s_instances) {
567 spin_unlock(&sb_lock);
569 down_read(&sb->s_umount);
570 if (sb->s_root && (sb->s_flags & MS_BORN))
572 up_read(&sb->s_umount);
581 spin_unlock(&sb_lock);
584 EXPORT_SYMBOL(iterate_supers_type);
587 * get_super - get the superblock of a device
588 * @bdev: device to get the superblock for
590 * Scans the superblock list and finds the superblock of the file system
591 * mounted on the device given. %NULL is returned if no match is found.
594 struct super_block *get_super(struct block_device *bdev)
596 struct super_block *sb;
603 list_for_each_entry(sb, &super_blocks, s_list) {
604 if (hlist_unhashed(&sb->s_instances))
606 if (sb->s_bdev == bdev) {
608 spin_unlock(&sb_lock);
609 down_read(&sb->s_umount);
611 if (sb->s_root && (sb->s_flags & MS_BORN))
613 up_read(&sb->s_umount);
614 /* nope, got unmounted */
620 spin_unlock(&sb_lock);
624 EXPORT_SYMBOL(get_super);
627 * get_super_thawed - get thawed superblock of a device
628 * @bdev: device to get the superblock for
630 * Scans the superblock list and finds the superblock of the file system
631 * mounted on the device. The superblock is returned once it is thawed
632 * (or immediately if it was not frozen). %NULL is returned if no match
635 struct super_block *get_super_thawed(struct block_device *bdev)
638 struct super_block *s = get_super(bdev);
639 if (!s || s->s_writers.frozen == SB_UNFROZEN)
641 up_read(&s->s_umount);
642 wait_event(s->s_writers.wait_unfrozen,
643 s->s_writers.frozen == SB_UNFROZEN);
647 EXPORT_SYMBOL(get_super_thawed);
650 * get_active_super - get an active reference to the superblock of a device
651 * @bdev: device to get the superblock for
653 * Scans the superblock list and finds the superblock of the file system
654 * mounted on the device given. Returns the superblock with an active
655 * reference or %NULL if none was found.
657 struct super_block *get_active_super(struct block_device *bdev)
659 struct super_block *sb;
666 list_for_each_entry(sb, &super_blocks, s_list) {
667 if (hlist_unhashed(&sb->s_instances))
669 if (sb->s_bdev == bdev) {
672 up_write(&sb->s_umount);
676 spin_unlock(&sb_lock);
680 struct super_block *user_get_super(dev_t dev)
682 struct super_block *sb;
686 list_for_each_entry(sb, &super_blocks, s_list) {
687 if (hlist_unhashed(&sb->s_instances))
689 if (sb->s_dev == dev) {
691 spin_unlock(&sb_lock);
692 down_read(&sb->s_umount);
694 if (sb->s_root && (sb->s_flags & MS_BORN))
696 up_read(&sb->s_umount);
697 /* nope, got unmounted */
703 spin_unlock(&sb_lock);
708 * do_remount_sb - asks filesystem to change mount options.
709 * @sb: superblock in question
710 * @flags: numeric part of options
711 * @data: the rest of options
712 * @force: whether or not to force the change
714 * Alters the mount options of a mounted file system.
716 int do_remount_sb(struct super_block *sb, int flags, void *data, int force)
721 if (sb->s_writers.frozen != SB_UNFROZEN)
725 if (!(flags & MS_RDONLY) && bdev_read_only(sb->s_bdev))
729 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
732 if (!hlist_empty(&sb->s_pins)) {
733 up_write(&sb->s_umount);
734 group_pin_kill(&sb->s_pins);
735 down_write(&sb->s_umount);
738 if (sb->s_writers.frozen != SB_UNFROZEN)
740 remount_ro = (flags & MS_RDONLY) && !(sb->s_flags & MS_RDONLY);
743 shrink_dcache_sb(sb);
745 /* If we are remounting RDONLY and current sb is read/write,
746 make sure there are no rw files opened */
749 sb->s_readonly_remount = 1;
752 retval = sb_prepare_remount_readonly(sb);
758 if (sb->s_op->remount_fs) {
759 retval = sb->s_op->remount_fs(sb, &flags, data);
762 goto cancel_readonly;
763 /* If forced remount, go ahead despite any errors */
764 WARN(1, "forced remount of a %s fs returned %i\n",
765 sb->s_type->name, retval);
768 sb->s_flags = (sb->s_flags & ~MS_RMT_MASK) | (flags & MS_RMT_MASK);
769 /* Needs to be ordered wrt mnt_is_readonly() */
771 sb->s_readonly_remount = 0;
774 * Some filesystems modify their metadata via some other path than the
775 * bdev buffer cache (eg. use a private mapping, or directories in
776 * pagecache, etc). Also file data modifications go via their own
777 * mappings. So If we try to mount readonly then copy the filesystem
778 * from bdev, we could get stale data, so invalidate it to give a best
779 * effort at coherency.
781 if (remount_ro && sb->s_bdev)
782 invalidate_bdev(sb->s_bdev);
786 sb->s_readonly_remount = 0;
790 static void do_emergency_remount(struct work_struct *work)
792 struct super_block *sb, *p = NULL;
795 list_for_each_entry(sb, &super_blocks, s_list) {
796 if (hlist_unhashed(&sb->s_instances))
799 spin_unlock(&sb_lock);
800 down_write(&sb->s_umount);
801 if (sb->s_root && sb->s_bdev && (sb->s_flags & MS_BORN) &&
802 !(sb->s_flags & MS_RDONLY)) {
804 * What lock protects sb->s_flags??
806 do_remount_sb(sb, MS_RDONLY, NULL, 1);
808 up_write(&sb->s_umount);
816 spin_unlock(&sb_lock);
818 printk("Emergency Remount complete\n");
821 void emergency_remount(void)
823 struct work_struct *work;
825 work = kmalloc(sizeof(*work), GFP_ATOMIC);
827 INIT_WORK(work, do_emergency_remount);
833 * Unnamed block devices are dummy devices used by virtual
834 * filesystems which don't use real block-devices. -- jrs
837 static DEFINE_IDA(unnamed_dev_ida);
838 static DEFINE_SPINLOCK(unnamed_dev_lock);/* protects the above */
839 /* Many userspace utilities consider an FSID of 0 invalid.
840 * Always return at least 1 from get_anon_bdev.
842 static int unnamed_dev_start = 1;
844 int get_anon_bdev(dev_t *p)
850 if (ida_pre_get(&unnamed_dev_ida, GFP_ATOMIC) == 0)
852 spin_lock(&unnamed_dev_lock);
853 error = ida_get_new_above(&unnamed_dev_ida, unnamed_dev_start, &dev);
855 unnamed_dev_start = dev + 1;
856 spin_unlock(&unnamed_dev_lock);
857 if (error == -EAGAIN)
858 /* We raced and lost with another CPU. */
863 if (dev >= (1 << MINORBITS)) {
864 spin_lock(&unnamed_dev_lock);
865 ida_remove(&unnamed_dev_ida, dev);
866 if (unnamed_dev_start > dev)
867 unnamed_dev_start = dev;
868 spin_unlock(&unnamed_dev_lock);
871 *p = MKDEV(0, dev & MINORMASK);
874 EXPORT_SYMBOL(get_anon_bdev);
876 void free_anon_bdev(dev_t dev)
878 int slot = MINOR(dev);
879 spin_lock(&unnamed_dev_lock);
880 ida_remove(&unnamed_dev_ida, slot);
881 if (slot < unnamed_dev_start)
882 unnamed_dev_start = slot;
883 spin_unlock(&unnamed_dev_lock);
885 EXPORT_SYMBOL(free_anon_bdev);
887 int set_anon_super(struct super_block *s, void *data)
889 return get_anon_bdev(&s->s_dev);
892 EXPORT_SYMBOL(set_anon_super);
894 void kill_anon_super(struct super_block *sb)
896 dev_t dev = sb->s_dev;
897 generic_shutdown_super(sb);
901 EXPORT_SYMBOL(kill_anon_super);
903 void kill_litter_super(struct super_block *sb)
906 d_genocide(sb->s_root);
910 EXPORT_SYMBOL(kill_litter_super);
912 static int ns_test_super(struct super_block *sb, void *data)
914 return sb->s_fs_info == data;
917 static int ns_set_super(struct super_block *sb, void *data)
919 sb->s_fs_info = data;
920 return set_anon_super(sb, NULL);
923 struct dentry *mount_ns(struct file_system_type *fs_type, int flags,
924 void *data, int (*fill_super)(struct super_block *, void *, int))
926 struct super_block *sb;
928 sb = sget(fs_type, ns_test_super, ns_set_super, flags, data);
934 err = fill_super(sb, data, flags & MS_SILENT ? 1 : 0);
936 deactivate_locked_super(sb);
940 sb->s_flags |= MS_ACTIVE;
943 return dget(sb->s_root);
946 EXPORT_SYMBOL(mount_ns);
949 static int set_bdev_super(struct super_block *s, void *data)
952 s->s_dev = s->s_bdev->bd_dev;
955 * We set the bdi here to the queue backing, file systems can
956 * overwrite this in ->fill_super()
958 s->s_bdi = &bdev_get_queue(s->s_bdev)->backing_dev_info;
962 static int test_bdev_super(struct super_block *s, void *data)
964 return (void *)s->s_bdev == data;
967 struct dentry *mount_bdev(struct file_system_type *fs_type,
968 int flags, const char *dev_name, void *data,
969 int (*fill_super)(struct super_block *, void *, int))
971 struct block_device *bdev;
972 struct super_block *s;
973 fmode_t mode = FMODE_READ | FMODE_EXCL;
976 if (!(flags & MS_RDONLY))
979 bdev = blkdev_get_by_path(dev_name, mode, fs_type);
981 return ERR_CAST(bdev);
984 * once the super is inserted into the list by sget, s_umount
985 * will protect the lockfs code from trying to start a snapshot
986 * while we are mounting
988 mutex_lock(&bdev->bd_fsfreeze_mutex);
989 if (bdev->bd_fsfreeze_count > 0) {
990 mutex_unlock(&bdev->bd_fsfreeze_mutex);
994 s = sget(fs_type, test_bdev_super, set_bdev_super, flags | MS_NOSEC,
996 mutex_unlock(&bdev->bd_fsfreeze_mutex);
1001 if ((flags ^ s->s_flags) & MS_RDONLY) {
1002 deactivate_locked_super(s);
1008 * s_umount nests inside bd_mutex during
1009 * __invalidate_device(). blkdev_put() acquires
1010 * bd_mutex and can't be called under s_umount. Drop
1011 * s_umount temporarily. This is safe as we're
1012 * holding an active reference.
1014 up_write(&s->s_umount);
1015 blkdev_put(bdev, mode);
1016 down_write(&s->s_umount);
1019 snprintf(s->s_id, sizeof(s->s_id), "%pg", bdev);
1020 sb_set_blocksize(s, block_size(bdev));
1021 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1023 deactivate_locked_super(s);
1027 s->s_flags |= MS_ACTIVE;
1031 return dget(s->s_root);
1036 blkdev_put(bdev, mode);
1038 return ERR_PTR(error);
1040 EXPORT_SYMBOL(mount_bdev);
1042 void kill_block_super(struct super_block *sb)
1044 struct block_device *bdev = sb->s_bdev;
1045 fmode_t mode = sb->s_mode;
1047 bdev->bd_super = NULL;
1048 generic_shutdown_super(sb);
1049 sync_blockdev(bdev);
1050 WARN_ON_ONCE(!(mode & FMODE_EXCL));
1051 blkdev_put(bdev, mode | FMODE_EXCL);
1054 EXPORT_SYMBOL(kill_block_super);
1057 struct dentry *mount_nodev(struct file_system_type *fs_type,
1058 int flags, void *data,
1059 int (*fill_super)(struct super_block *, void *, int))
1062 struct super_block *s = sget(fs_type, NULL, set_anon_super, flags, NULL);
1067 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1069 deactivate_locked_super(s);
1070 return ERR_PTR(error);
1072 s->s_flags |= MS_ACTIVE;
1073 return dget(s->s_root);
1075 EXPORT_SYMBOL(mount_nodev);
1077 static int compare_single(struct super_block *s, void *p)
1082 struct dentry *mount_single(struct file_system_type *fs_type,
1083 int flags, void *data,
1084 int (*fill_super)(struct super_block *, void *, int))
1086 struct super_block *s;
1089 s = sget(fs_type, compare_single, set_anon_super, flags, NULL);
1093 error = fill_super(s, data, flags & MS_SILENT ? 1 : 0);
1095 deactivate_locked_super(s);
1096 return ERR_PTR(error);
1098 s->s_flags |= MS_ACTIVE;
1100 do_remount_sb(s, flags, data, 0);
1102 return dget(s->s_root);
1104 EXPORT_SYMBOL(mount_single);
1107 mount_fs(struct file_system_type *type, int flags, const char *name, void *data)
1109 struct dentry *root;
1110 struct super_block *sb;
1111 char *secdata = NULL;
1112 int error = -ENOMEM;
1114 if (data && !(type->fs_flags & FS_BINARY_MOUNTDATA)) {
1115 secdata = alloc_secdata();
1119 error = security_sb_copy_data(data, secdata);
1121 goto out_free_secdata;
1124 root = type->mount(type, flags, name, data);
1126 error = PTR_ERR(root);
1127 goto out_free_secdata;
1131 WARN_ON(!sb->s_bdi);
1132 sb->s_flags |= MS_BORN;
1134 error = security_sb_kern_mount(sb, flags, secdata);
1139 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1140 * but s_maxbytes was an unsigned long long for many releases. Throw
1141 * this warning for a little while to try and catch filesystems that
1142 * violate this rule.
1144 WARN((sb->s_maxbytes < 0), "%s set sb->s_maxbytes to "
1145 "negative value (%lld)\n", type->name, sb->s_maxbytes);
1147 up_write(&sb->s_umount);
1148 free_secdata(secdata);
1152 deactivate_locked_super(sb);
1154 free_secdata(secdata);
1156 return ERR_PTR(error);
1160 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1163 void __sb_end_write(struct super_block *sb, int level)
1165 percpu_up_read(sb->s_writers.rw_sem + level-1);
1167 EXPORT_SYMBOL(__sb_end_write);
1170 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1173 int __sb_start_write(struct super_block *sb, int level, bool wait)
1175 bool force_trylock = false;
1178 #ifdef CONFIG_LOCKDEP
1180 * We want lockdep to tell us about possible deadlocks with freezing
1181 * but it's it bit tricky to properly instrument it. Getting a freeze
1182 * protection works as getting a read lock but there are subtle
1183 * problems. XFS for example gets freeze protection on internal level
1184 * twice in some cases, which is OK only because we already hold a
1185 * freeze protection also on higher level. Due to these cases we have
1186 * to use wait == F (trylock mode) which must not fail.
1191 for (i = 0; i < level - 1; i++)
1192 if (percpu_rwsem_is_held(sb->s_writers.rw_sem + i)) {
1193 force_trylock = true;
1198 if (wait && !force_trylock)
1199 percpu_down_read(sb->s_writers.rw_sem + level-1);
1201 ret = percpu_down_read_trylock(sb->s_writers.rw_sem + level-1);
1203 WARN_ON(force_trylock && !ret);
1206 EXPORT_SYMBOL(__sb_start_write);
1209 * sb_wait_write - wait until all writers to given file system finish
1210 * @sb: the super for which we wait
1211 * @level: type of writers we wait for (normal vs page fault)
1213 * This function waits until there are no writers of given type to given file
1216 static void sb_wait_write(struct super_block *sb, int level)
1218 percpu_down_write(sb->s_writers.rw_sem + level-1);
1220 * We are going to return to userspace and forget about this lock, the
1221 * ownership goes to the caller of thaw_super() which does unlock.
1223 * FIXME: we should do this before return from freeze_super() after we
1224 * called sync_filesystem(sb) and s_op->freeze_fs(sb), and thaw_super()
1225 * should re-acquire these locks before s_op->unfreeze_fs(sb). However
1226 * this leads to lockdep false-positives, so currently we do the early
1227 * release right after acquire.
1229 percpu_rwsem_release(sb->s_writers.rw_sem + level-1, 0, _THIS_IP_);
1232 static void sb_freeze_unlock(struct super_block *sb)
1236 for (level = 0; level < SB_FREEZE_LEVELS; ++level)
1237 percpu_rwsem_acquire(sb->s_writers.rw_sem + level, 0, _THIS_IP_);
1239 for (level = SB_FREEZE_LEVELS - 1; level >= 0; level--)
1240 percpu_up_write(sb->s_writers.rw_sem + level);
1244 * freeze_super - lock the filesystem and force it into a consistent state
1245 * @sb: the super to lock
1247 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1248 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1251 * During this function, sb->s_writers.frozen goes through these values:
1253 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1255 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1256 * writes should be blocked, though page faults are still allowed. We wait for
1257 * all writes to complete and then proceed to the next stage.
1259 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1260 * but internal fs threads can still modify the filesystem (although they
1261 * should not dirty new pages or inodes), writeback can run etc. After waiting
1262 * for all running page faults we sync the filesystem which will clean all
1263 * dirty pages and inodes (no new dirty pages or inodes can be created when
1266 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1267 * modification are blocked (e.g. XFS preallocation truncation on inode
1268 * reclaim). This is usually implemented by blocking new transactions for
1269 * filesystems that have them and need this additional guard. After all
1270 * internal writers are finished we call ->freeze_fs() to finish filesystem
1271 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1272 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1274 * sb->s_writers.frozen is protected by sb->s_umount.
1276 int freeze_super(struct super_block *sb)
1280 atomic_inc(&sb->s_active);
1281 down_write(&sb->s_umount);
1282 if (sb->s_writers.frozen != SB_UNFROZEN) {
1283 deactivate_locked_super(sb);
1287 if (!(sb->s_flags & MS_BORN)) {
1288 up_write(&sb->s_umount);
1289 return 0; /* sic - it's "nothing to do" */
1292 if (sb->s_flags & MS_RDONLY) {
1293 /* Nothing to do really... */
1294 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1295 up_write(&sb->s_umount);
1299 sb->s_writers.frozen = SB_FREEZE_WRITE;
1300 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1301 up_write(&sb->s_umount);
1302 sb_wait_write(sb, SB_FREEZE_WRITE);
1303 down_write(&sb->s_umount);
1305 /* Now we go and block page faults... */
1306 sb->s_writers.frozen = SB_FREEZE_PAGEFAULT;
1307 sb_wait_write(sb, SB_FREEZE_PAGEFAULT);
1309 /* All writers are done so after syncing there won't be dirty data */
1310 sync_filesystem(sb);
1312 /* Now wait for internal filesystem counter */
1313 sb->s_writers.frozen = SB_FREEZE_FS;
1314 sb_wait_write(sb, SB_FREEZE_FS);
1316 if (sb->s_op->freeze_fs) {
1317 ret = sb->s_op->freeze_fs(sb);
1320 "VFS:Filesystem freeze failed\n");
1321 sb->s_writers.frozen = SB_UNFROZEN;
1322 sb_freeze_unlock(sb);
1323 wake_up(&sb->s_writers.wait_unfrozen);
1324 deactivate_locked_super(sb);
1329 * This is just for debugging purposes so that fs can warn if it
1330 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
1332 sb->s_writers.frozen = SB_FREEZE_COMPLETE;
1333 up_write(&sb->s_umount);
1336 EXPORT_SYMBOL(freeze_super);
1339 * thaw_super -- unlock filesystem
1340 * @sb: the super to thaw
1342 * Unlocks the filesystem and marks it writeable again after freeze_super().
1344 int thaw_super(struct super_block *sb)
1348 down_write(&sb->s_umount);
1349 if (sb->s_writers.frozen == SB_UNFROZEN) {
1350 up_write(&sb->s_umount);
1354 if (sb->s_flags & MS_RDONLY) {
1355 sb->s_writers.frozen = SB_UNFROZEN;
1359 if (sb->s_op->unfreeze_fs) {
1360 error = sb->s_op->unfreeze_fs(sb);
1363 "VFS:Filesystem thaw failed\n");
1364 up_write(&sb->s_umount);
1369 sb->s_writers.frozen = SB_UNFROZEN;
1370 sb_freeze_unlock(sb);
1372 wake_up(&sb->s_writers.wait_unfrozen);
1373 deactivate_locked_super(sb);
1376 EXPORT_SYMBOL(thaw_super);