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:
18 * Torbjörn Lindh (torbjorn.lindh@gopta.se), April 14, 1996.
19 * Added devfs support: Richard Gooch <rgooch@atnf.csiro.au>, 13-JAN-1998
20 * Heavily rewritten for 'one fs - one tree' dcache architecture. AV, Mar 2000
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
;
139 * destroy_super - frees a superblock
140 * @s: superblock to free
142 * Frees a superblock.
144 static void destroy_super(struct super_block
*s
)
147 list_lru_destroy(&s
->s_dentry_lru
);
148 list_lru_destroy(&s
->s_inode_lru
);
149 for (i
= 0; i
< SB_FREEZE_LEVELS
; i
++)
150 percpu_counter_destroy(&s
->s_writers
.counter
[i
]);
152 WARN_ON(!list_empty(&s
->s_mounts
));
159 * alloc_super - create new superblock
160 * @type: filesystem type superblock should belong to
161 * @flags: the mount flags
163 * Allocates and initializes a new &struct super_block. alloc_super()
164 * returns a pointer new superblock or %NULL if allocation had failed.
166 static struct super_block
*alloc_super(struct file_system_type
*type
, int flags
)
168 struct super_block
*s
= kzalloc(sizeof(struct super_block
), GFP_USER
);
169 static const struct super_operations default_op
;
175 INIT_LIST_HEAD(&s
->s_mounts
);
177 if (security_sb_alloc(s
))
180 for (i
= 0; i
< SB_FREEZE_LEVELS
; i
++) {
181 if (percpu_counter_init(&s
->s_writers
.counter
[i
], 0,
184 lockdep_init_map(&s
->s_writers
.lock_map
[i
], sb_writers_name
[i
],
185 &type
->s_writers_key
[i
], 0);
187 init_waitqueue_head(&s
->s_writers
.wait
);
188 init_waitqueue_head(&s
->s_writers
.wait_unfrozen
);
189 s
->s_bdi
= &noop_backing_dev_info
;
191 INIT_HLIST_NODE(&s
->s_instances
);
192 INIT_HLIST_BL_HEAD(&s
->s_anon
);
193 INIT_LIST_HEAD(&s
->s_inodes
);
195 if (list_lru_init_memcg(&s
->s_dentry_lru
))
197 if (list_lru_init_memcg(&s
->s_inode_lru
))
200 init_rwsem(&s
->s_umount
);
201 lockdep_set_class(&s
->s_umount
, &type
->s_umount_key
);
203 * sget() can have s_umount recursion.
205 * When it cannot find a suitable sb, it allocates a new
206 * one (this one), and tries again to find a suitable old
209 * In case that succeeds, it will acquire the s_umount
210 * lock of the old one. Since these are clearly distrinct
211 * locks, and this object isn't exposed yet, there's no
214 * Annotate this by putting this lock in a different
217 down_write_nested(&s
->s_umount
, SINGLE_DEPTH_NESTING
);
219 atomic_set(&s
->s_active
, 1);
220 mutex_init(&s
->s_vfs_rename_mutex
);
221 lockdep_set_class(&s
->s_vfs_rename_mutex
, &type
->s_vfs_rename_key
);
222 mutex_init(&s
->s_dquot
.dqio_mutex
);
223 mutex_init(&s
->s_dquot
.dqonoff_mutex
);
224 s
->s_maxbytes
= MAX_NON_LFS
;
225 s
->s_op
= &default_op
;
226 s
->s_time_gran
= 1000000000;
227 s
->cleancache_poolid
= CLEANCACHE_NO_POOL
;
229 s
->s_shrink
.seeks
= DEFAULT_SEEKS
;
230 s
->s_shrink
.scan_objects
= super_cache_scan
;
231 s
->s_shrink
.count_objects
= super_cache_count
;
232 s
->s_shrink
.batch
= 1024;
233 s
->s_shrink
.flags
= SHRINKER_NUMA_AWARE
| SHRINKER_MEMCG_AWARE
;
241 /* Superblock refcounting */
244 * Drop a superblock's refcount. The caller must hold sb_lock.
246 static void __put_super(struct super_block
*sb
)
248 if (!--sb
->s_count
) {
249 list_del_init(&sb
->s_list
);
255 * put_super - drop a temporary reference to superblock
256 * @sb: superblock in question
258 * Drops a temporary reference, frees superblock if there's no
261 static void put_super(struct super_block
*sb
)
265 spin_unlock(&sb_lock
);
270 * deactivate_locked_super - drop an active reference to superblock
271 * @s: superblock to deactivate
273 * Drops an active reference to superblock, converting it into a temprory
274 * one if there is no other active references left. In that case we
275 * tell fs driver to shut it down and drop the temporary reference we
278 * Caller holds exclusive lock on superblock; that lock is released.
280 void deactivate_locked_super(struct super_block
*s
)
282 struct file_system_type
*fs
= s
->s_type
;
283 if (atomic_dec_and_test(&s
->s_active
)) {
284 cleancache_invalidate_fs(s
);
285 unregister_shrinker(&s
->s_shrink
);
289 * Since list_lru_destroy() may sleep, we cannot call it from
290 * put_super(), where we hold the sb_lock. Therefore we destroy
291 * the lru lists right now.
293 list_lru_destroy(&s
->s_dentry_lru
);
294 list_lru_destroy(&s
->s_inode_lru
);
299 up_write(&s
->s_umount
);
303 EXPORT_SYMBOL(deactivate_locked_super
);
306 * deactivate_super - drop an active reference to superblock
307 * @s: superblock to deactivate
309 * Variant of deactivate_locked_super(), except that superblock is *not*
310 * locked by caller. If we are going to drop the final active reference,
311 * lock will be acquired prior to that.
313 void deactivate_super(struct super_block
*s
)
315 if (!atomic_add_unless(&s
->s_active
, -1, 1)) {
316 down_write(&s
->s_umount
);
317 deactivate_locked_super(s
);
321 EXPORT_SYMBOL(deactivate_super
);
324 * grab_super - acquire an active reference
325 * @s: reference we are trying to make active
327 * Tries to acquire an active reference. grab_super() is used when we
328 * had just found a superblock in super_blocks or fs_type->fs_supers
329 * and want to turn it into a full-blown active reference. grab_super()
330 * is called with sb_lock held and drops it. Returns 1 in case of
331 * success, 0 if we had failed (superblock contents was already dead or
332 * dying when grab_super() had been called). Note that this is only
333 * called for superblocks not in rundown mode (== ones still on ->fs_supers
334 * of their type), so increment of ->s_count is OK here.
336 static int grab_super(struct super_block
*s
) __releases(sb_lock
)
339 spin_unlock(&sb_lock
);
340 down_write(&s
->s_umount
);
341 if ((s
->s_flags
& MS_BORN
) && atomic_inc_not_zero(&s
->s_active
)) {
345 up_write(&s
->s_umount
);
351 * trylock_super - try to grab ->s_umount shared
352 * @sb: reference we are trying to grab
354 * Try to prevent fs shutdown. This is used in places where we
355 * cannot take an active reference but we need to ensure that the
356 * filesystem is not shut down while we are working on it. It returns
357 * false if we cannot acquire s_umount or if we lose the race and
358 * filesystem already got into shutdown, and returns true with the s_umount
359 * lock held in read mode in case of success. On successful return,
360 * the caller must drop the s_umount lock when done.
362 * Note that unlike get_super() et.al. this one does *not* bump ->s_count.
363 * The reason why it's safe is that we are OK with doing trylock instead
364 * of down_read(). There's a couple of places that are OK with that, but
365 * it's very much not a general-purpose interface.
367 bool trylock_super(struct super_block
*sb
)
369 if (down_read_trylock(&sb
->s_umount
)) {
370 if (!hlist_unhashed(&sb
->s_instances
) &&
371 sb
->s_root
&& (sb
->s_flags
& MS_BORN
))
373 up_read(&sb
->s_umount
);
380 * generic_shutdown_super - common helper for ->kill_sb()
381 * @sb: superblock to kill
383 * generic_shutdown_super() does all fs-independent work on superblock
384 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
385 * that need destruction out of superblock, call generic_shutdown_super()
386 * and release aforementioned objects. Note: dentries and inodes _are_
387 * taken care of and do not need specific handling.
389 * Upon calling this function, the filesystem may no longer alter or
390 * rearrange the set of dentries belonging to this super_block, nor may it
391 * change the attachments of dentries to inodes.
393 void generic_shutdown_super(struct super_block
*sb
)
395 const struct super_operations
*sop
= sb
->s_op
;
398 shrink_dcache_for_umount(sb
);
400 sb
->s_flags
&= ~MS_ACTIVE
;
402 fsnotify_unmount_inodes(&sb
->s_inodes
);
406 if (sb
->s_dio_done_wq
) {
407 destroy_workqueue(sb
->s_dio_done_wq
);
408 sb
->s_dio_done_wq
= NULL
;
414 if (!list_empty(&sb
->s_inodes
)) {
415 printk("VFS: Busy inodes after unmount of %s. "
416 "Self-destruct in 5 seconds. Have a nice day...\n",
421 /* should be initialized for __put_super_and_need_restart() */
422 hlist_del_init(&sb
->s_instances
);
423 spin_unlock(&sb_lock
);
424 up_write(&sb
->s_umount
);
427 EXPORT_SYMBOL(generic_shutdown_super
);
430 * sget - find or create a superblock
431 * @type: filesystem type superblock should belong to
432 * @test: comparison callback
433 * @set: setup callback
434 * @flags: mount flags
435 * @data: argument to each of them
437 struct super_block
*sget(struct file_system_type
*type
,
438 int (*test
)(struct super_block
*,void *),
439 int (*set
)(struct super_block
*,void *),
443 struct super_block
*s
= NULL
;
444 struct super_block
*old
;
450 hlist_for_each_entry(old
, &type
->fs_supers
, s_instances
) {
451 if (!test(old
, data
))
453 if (!grab_super(old
))
456 up_write(&s
->s_umount
);
464 spin_unlock(&sb_lock
);
465 s
= alloc_super(type
, flags
);
467 return ERR_PTR(-ENOMEM
);
473 spin_unlock(&sb_lock
);
474 up_write(&s
->s_umount
);
479 strlcpy(s
->s_id
, type
->name
, sizeof(s
->s_id
));
480 list_add_tail(&s
->s_list
, &super_blocks
);
481 hlist_add_head(&s
->s_instances
, &type
->fs_supers
);
482 spin_unlock(&sb_lock
);
483 get_filesystem(type
);
484 register_shrinker(&s
->s_shrink
);
490 void drop_super(struct super_block
*sb
)
492 up_read(&sb
->s_umount
);
496 EXPORT_SYMBOL(drop_super
);
499 * iterate_supers - call function for all active superblocks
500 * @f: function to call
501 * @arg: argument to pass to it
503 * Scans the superblock list and calls given function, passing it
504 * locked superblock and given argument.
506 void iterate_supers(void (*f
)(struct super_block
*, void *), void *arg
)
508 struct super_block
*sb
, *p
= NULL
;
511 list_for_each_entry(sb
, &super_blocks
, s_list
) {
512 if (hlist_unhashed(&sb
->s_instances
))
515 spin_unlock(&sb_lock
);
517 down_read(&sb
->s_umount
);
518 if (sb
->s_root
&& (sb
->s_flags
& MS_BORN
))
520 up_read(&sb
->s_umount
);
529 spin_unlock(&sb_lock
);
533 * iterate_supers_type - call function for superblocks of given type
535 * @f: function to call
536 * @arg: argument to pass to it
538 * Scans the superblock list and calls given function, passing it
539 * locked superblock and given argument.
541 void iterate_supers_type(struct file_system_type
*type
,
542 void (*f
)(struct super_block
*, void *), void *arg
)
544 struct super_block
*sb
, *p
= NULL
;
547 hlist_for_each_entry(sb
, &type
->fs_supers
, s_instances
) {
549 spin_unlock(&sb_lock
);
551 down_read(&sb
->s_umount
);
552 if (sb
->s_root
&& (sb
->s_flags
& MS_BORN
))
554 up_read(&sb
->s_umount
);
563 spin_unlock(&sb_lock
);
566 EXPORT_SYMBOL(iterate_supers_type
);
569 * get_super - get the superblock of a device
570 * @bdev: device to get the superblock for
572 * Scans the superblock list and finds the superblock of the file system
573 * mounted on the device given. %NULL is returned if no match is found.
576 struct super_block
*get_super(struct block_device
*bdev
)
578 struct super_block
*sb
;
585 list_for_each_entry(sb
, &super_blocks
, s_list
) {
586 if (hlist_unhashed(&sb
->s_instances
))
588 if (sb
->s_bdev
== bdev
) {
590 spin_unlock(&sb_lock
);
591 down_read(&sb
->s_umount
);
593 if (sb
->s_root
&& (sb
->s_flags
& MS_BORN
))
595 up_read(&sb
->s_umount
);
596 /* nope, got unmounted */
602 spin_unlock(&sb_lock
);
606 EXPORT_SYMBOL(get_super
);
609 * get_super_thawed - get thawed superblock of a device
610 * @bdev: device to get the superblock for
612 * Scans the superblock list and finds the superblock of the file system
613 * mounted on the device. The superblock is returned once it is thawed
614 * (or immediately if it was not frozen). %NULL is returned if no match
617 struct super_block
*get_super_thawed(struct block_device
*bdev
)
620 struct super_block
*s
= get_super(bdev
);
621 if (!s
|| s
->s_writers
.frozen
== SB_UNFROZEN
)
623 up_read(&s
->s_umount
);
624 wait_event(s
->s_writers
.wait_unfrozen
,
625 s
->s_writers
.frozen
== SB_UNFROZEN
);
629 EXPORT_SYMBOL(get_super_thawed
);
632 * get_active_super - get an active reference to the superblock of a device
633 * @bdev: device to get the superblock for
635 * Scans the superblock list and finds the superblock of the file system
636 * mounted on the device given. Returns the superblock with an active
637 * reference or %NULL if none was found.
639 struct super_block
*get_active_super(struct block_device
*bdev
)
641 struct super_block
*sb
;
648 list_for_each_entry(sb
, &super_blocks
, s_list
) {
649 if (hlist_unhashed(&sb
->s_instances
))
651 if (sb
->s_bdev
== bdev
) {
654 up_write(&sb
->s_umount
);
658 spin_unlock(&sb_lock
);
662 struct super_block
*user_get_super(dev_t dev
)
664 struct super_block
*sb
;
668 list_for_each_entry(sb
, &super_blocks
, s_list
) {
669 if (hlist_unhashed(&sb
->s_instances
))
671 if (sb
->s_dev
== dev
) {
673 spin_unlock(&sb_lock
);
674 down_read(&sb
->s_umount
);
676 if (sb
->s_root
&& (sb
->s_flags
& MS_BORN
))
678 up_read(&sb
->s_umount
);
679 /* nope, got unmounted */
685 spin_unlock(&sb_lock
);
690 * do_remount_sb - asks filesystem to change mount options.
691 * @sb: superblock in question
692 * @flags: numeric part of options
693 * @data: the rest of options
694 * @force: whether or not to force the change
696 * Alters the mount options of a mounted file system.
698 int do_remount_sb(struct super_block
*sb
, int flags
, void *data
, int force
)
703 if (sb
->s_writers
.frozen
!= SB_UNFROZEN
)
707 if (!(flags
& MS_RDONLY
) && bdev_read_only(sb
->s_bdev
))
711 remount_ro
= (flags
& MS_RDONLY
) && !(sb
->s_flags
& MS_RDONLY
);
714 if (!hlist_empty(&sb
->s_pins
)) {
715 up_write(&sb
->s_umount
);
716 group_pin_kill(&sb
->s_pins
);
717 down_write(&sb
->s_umount
);
720 if (sb
->s_writers
.frozen
!= SB_UNFROZEN
)
722 remount_ro
= (flags
& MS_RDONLY
) && !(sb
->s_flags
& MS_RDONLY
);
725 shrink_dcache_sb(sb
);
727 /* If we are remounting RDONLY and current sb is read/write,
728 make sure there are no rw files opened */
731 sb
->s_readonly_remount
= 1;
734 retval
= sb_prepare_remount_readonly(sb
);
740 if (sb
->s_op
->remount_fs
) {
741 retval
= sb
->s_op
->remount_fs(sb
, &flags
, data
);
744 goto cancel_readonly
;
745 /* If forced remount, go ahead despite any errors */
746 WARN(1, "forced remount of a %s fs returned %i\n",
747 sb
->s_type
->name
, retval
);
750 sb
->s_flags
= (sb
->s_flags
& ~MS_RMT_MASK
) | (flags
& MS_RMT_MASK
);
751 /* Needs to be ordered wrt mnt_is_readonly() */
753 sb
->s_readonly_remount
= 0;
756 * Some filesystems modify their metadata via some other path than the
757 * bdev buffer cache (eg. use a private mapping, or directories in
758 * pagecache, etc). Also file data modifications go via their own
759 * mappings. So If we try to mount readonly then copy the filesystem
760 * from bdev, we could get stale data, so invalidate it to give a best
761 * effort at coherency.
763 if (remount_ro
&& sb
->s_bdev
)
764 invalidate_bdev(sb
->s_bdev
);
768 sb
->s_readonly_remount
= 0;
772 static void do_emergency_remount(struct work_struct
*work
)
774 struct super_block
*sb
, *p
= NULL
;
777 list_for_each_entry(sb
, &super_blocks
, s_list
) {
778 if (hlist_unhashed(&sb
->s_instances
))
781 spin_unlock(&sb_lock
);
782 down_write(&sb
->s_umount
);
783 if (sb
->s_root
&& sb
->s_bdev
&& (sb
->s_flags
& MS_BORN
) &&
784 !(sb
->s_flags
& MS_RDONLY
)) {
786 * What lock protects sb->s_flags??
788 do_remount_sb(sb
, MS_RDONLY
, NULL
, 1);
790 up_write(&sb
->s_umount
);
798 spin_unlock(&sb_lock
);
800 printk("Emergency Remount complete\n");
803 void emergency_remount(void)
805 struct work_struct
*work
;
807 work
= kmalloc(sizeof(*work
), GFP_ATOMIC
);
809 INIT_WORK(work
, do_emergency_remount
);
815 * Unnamed block devices are dummy devices used by virtual
816 * filesystems which don't use real block-devices. -- jrs
819 static DEFINE_IDA(unnamed_dev_ida
);
820 static DEFINE_SPINLOCK(unnamed_dev_lock
);/* protects the above */
821 /* Many userspace utilities consider an FSID of 0 invalid.
822 * Always return at least 1 from get_anon_bdev.
824 static int unnamed_dev_start
= 1;
826 int get_anon_bdev(dev_t
*p
)
832 if (ida_pre_get(&unnamed_dev_ida
, GFP_ATOMIC
) == 0)
834 spin_lock(&unnamed_dev_lock
);
835 error
= ida_get_new_above(&unnamed_dev_ida
, unnamed_dev_start
, &dev
);
837 unnamed_dev_start
= dev
+ 1;
838 spin_unlock(&unnamed_dev_lock
);
839 if (error
== -EAGAIN
)
840 /* We raced and lost with another CPU. */
845 if (dev
== (1 << MINORBITS
)) {
846 spin_lock(&unnamed_dev_lock
);
847 ida_remove(&unnamed_dev_ida
, dev
);
848 if (unnamed_dev_start
> dev
)
849 unnamed_dev_start
= dev
;
850 spin_unlock(&unnamed_dev_lock
);
853 *p
= MKDEV(0, dev
& MINORMASK
);
856 EXPORT_SYMBOL(get_anon_bdev
);
858 void free_anon_bdev(dev_t dev
)
860 int slot
= MINOR(dev
);
861 spin_lock(&unnamed_dev_lock
);
862 ida_remove(&unnamed_dev_ida
, slot
);
863 if (slot
< unnamed_dev_start
)
864 unnamed_dev_start
= slot
;
865 spin_unlock(&unnamed_dev_lock
);
867 EXPORT_SYMBOL(free_anon_bdev
);
869 int set_anon_super(struct super_block
*s
, void *data
)
871 return get_anon_bdev(&s
->s_dev
);
874 EXPORT_SYMBOL(set_anon_super
);
876 void kill_anon_super(struct super_block
*sb
)
878 dev_t dev
= sb
->s_dev
;
879 generic_shutdown_super(sb
);
883 EXPORT_SYMBOL(kill_anon_super
);
885 void kill_litter_super(struct super_block
*sb
)
888 d_genocide(sb
->s_root
);
892 EXPORT_SYMBOL(kill_litter_super
);
894 static int ns_test_super(struct super_block
*sb
, void *data
)
896 return sb
->s_fs_info
== data
;
899 static int ns_set_super(struct super_block
*sb
, void *data
)
901 sb
->s_fs_info
= data
;
902 return set_anon_super(sb
, NULL
);
905 struct dentry
*mount_ns(struct file_system_type
*fs_type
, int flags
,
906 void *data
, int (*fill_super
)(struct super_block
*, void *, int))
908 struct super_block
*sb
;
910 sb
= sget(fs_type
, ns_test_super
, ns_set_super
, flags
, data
);
916 err
= fill_super(sb
, data
, flags
& MS_SILENT
? 1 : 0);
918 deactivate_locked_super(sb
);
922 sb
->s_flags
|= MS_ACTIVE
;
925 return dget(sb
->s_root
);
928 EXPORT_SYMBOL(mount_ns
);
931 static int set_bdev_super(struct super_block
*s
, void *data
)
934 s
->s_dev
= s
->s_bdev
->bd_dev
;
937 * We set the bdi here to the queue backing, file systems can
938 * overwrite this in ->fill_super()
940 s
->s_bdi
= &bdev_get_queue(s
->s_bdev
)->backing_dev_info
;
944 static int test_bdev_super(struct super_block
*s
, void *data
)
946 return (void *)s
->s_bdev
== data
;
949 struct dentry
*mount_bdev(struct file_system_type
*fs_type
,
950 int flags
, const char *dev_name
, void *data
,
951 int (*fill_super
)(struct super_block
*, void *, int))
953 struct block_device
*bdev
;
954 struct super_block
*s
;
955 fmode_t mode
= FMODE_READ
| FMODE_EXCL
;
958 if (!(flags
& MS_RDONLY
))
961 bdev
= blkdev_get_by_path(dev_name
, mode
, fs_type
);
963 return ERR_CAST(bdev
);
966 * once the super is inserted into the list by sget, s_umount
967 * will protect the lockfs code from trying to start a snapshot
968 * while we are mounting
970 mutex_lock(&bdev
->bd_fsfreeze_mutex
);
971 if (bdev
->bd_fsfreeze_count
> 0) {
972 mutex_unlock(&bdev
->bd_fsfreeze_mutex
);
976 s
= sget(fs_type
, test_bdev_super
, set_bdev_super
, flags
| MS_NOSEC
,
978 mutex_unlock(&bdev
->bd_fsfreeze_mutex
);
983 if ((flags
^ s
->s_flags
) & MS_RDONLY
) {
984 deactivate_locked_super(s
);
990 * s_umount nests inside bd_mutex during
991 * __invalidate_device(). blkdev_put() acquires
992 * bd_mutex and can't be called under s_umount. Drop
993 * s_umount temporarily. This is safe as we're
994 * holding an active reference.
996 up_write(&s
->s_umount
);
997 blkdev_put(bdev
, mode
);
998 down_write(&s
->s_umount
);
1000 char b
[BDEVNAME_SIZE
];
1003 strlcpy(s
->s_id
, bdevname(bdev
, b
), sizeof(s
->s_id
));
1004 sb_set_blocksize(s
, block_size(bdev
));
1005 error
= fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
1007 deactivate_locked_super(s
);
1011 s
->s_flags
|= MS_ACTIVE
;
1015 return dget(s
->s_root
);
1020 blkdev_put(bdev
, mode
);
1022 return ERR_PTR(error
);
1024 EXPORT_SYMBOL(mount_bdev
);
1026 void kill_block_super(struct super_block
*sb
)
1028 struct block_device
*bdev
= sb
->s_bdev
;
1029 fmode_t mode
= sb
->s_mode
;
1031 bdev
->bd_super
= NULL
;
1032 generic_shutdown_super(sb
);
1033 sync_blockdev(bdev
);
1034 WARN_ON_ONCE(!(mode
& FMODE_EXCL
));
1035 blkdev_put(bdev
, mode
| FMODE_EXCL
);
1038 EXPORT_SYMBOL(kill_block_super
);
1041 struct dentry
*mount_nodev(struct file_system_type
*fs_type
,
1042 int flags
, void *data
,
1043 int (*fill_super
)(struct super_block
*, void *, int))
1046 struct super_block
*s
= sget(fs_type
, NULL
, set_anon_super
, flags
, NULL
);
1051 error
= fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
1053 deactivate_locked_super(s
);
1054 return ERR_PTR(error
);
1056 s
->s_flags
|= MS_ACTIVE
;
1057 return dget(s
->s_root
);
1059 EXPORT_SYMBOL(mount_nodev
);
1061 static int compare_single(struct super_block
*s
, void *p
)
1066 struct dentry
*mount_single(struct file_system_type
*fs_type
,
1067 int flags
, void *data
,
1068 int (*fill_super
)(struct super_block
*, void *, int))
1070 struct super_block
*s
;
1073 s
= sget(fs_type
, compare_single
, set_anon_super
, flags
, NULL
);
1077 error
= fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
1079 deactivate_locked_super(s
);
1080 return ERR_PTR(error
);
1082 s
->s_flags
|= MS_ACTIVE
;
1084 do_remount_sb(s
, flags
, data
, 0);
1086 return dget(s
->s_root
);
1088 EXPORT_SYMBOL(mount_single
);
1091 mount_fs(struct file_system_type
*type
, int flags
, const char *name
, void *data
)
1093 struct dentry
*root
;
1094 struct super_block
*sb
;
1095 char *secdata
= NULL
;
1096 int error
= -ENOMEM
;
1098 if (data
&& !(type
->fs_flags
& FS_BINARY_MOUNTDATA
)) {
1099 secdata
= alloc_secdata();
1103 error
= security_sb_copy_data(data
, secdata
);
1105 goto out_free_secdata
;
1108 root
= type
->mount(type
, flags
, name
, data
);
1110 error
= PTR_ERR(root
);
1111 goto out_free_secdata
;
1115 WARN_ON(!sb
->s_bdi
);
1116 sb
->s_flags
|= MS_BORN
;
1118 error
= security_sb_kern_mount(sb
, flags
, secdata
);
1123 * filesystems should never set s_maxbytes larger than MAX_LFS_FILESIZE
1124 * but s_maxbytes was an unsigned long long for many releases. Throw
1125 * this warning for a little while to try and catch filesystems that
1126 * violate this rule.
1128 WARN((sb
->s_maxbytes
< 0), "%s set sb->s_maxbytes to "
1129 "negative value (%lld)\n", type
->name
, sb
->s_maxbytes
);
1131 up_write(&sb
->s_umount
);
1132 free_secdata(secdata
);
1136 deactivate_locked_super(sb
);
1138 free_secdata(secdata
);
1140 return ERR_PTR(error
);
1144 * This is an internal function, please use sb_end_{write,pagefault,intwrite}
1147 void __sb_end_write(struct super_block
*sb
, int level
)
1149 percpu_counter_dec(&sb
->s_writers
.counter
[level
-1]);
1151 * Make sure s_writers are updated before we wake up waiters in
1155 if (waitqueue_active(&sb
->s_writers
.wait
))
1156 wake_up(&sb
->s_writers
.wait
);
1157 rwsem_release(&sb
->s_writers
.lock_map
[level
-1], 1, _RET_IP_
);
1159 EXPORT_SYMBOL(__sb_end_write
);
1161 #ifdef CONFIG_LOCKDEP
1163 * We want lockdep to tell us about possible deadlocks with freezing but
1164 * it's it bit tricky to properly instrument it. Getting a freeze protection
1165 * works as getting a read lock but there are subtle problems. XFS for example
1166 * gets freeze protection on internal level twice in some cases, which is OK
1167 * only because we already hold a freeze protection also on higher level. Due
1168 * to these cases we have to tell lockdep we are doing trylock when we
1169 * already hold a freeze protection for a higher freeze level.
1171 static void acquire_freeze_lock(struct super_block
*sb
, int level
, bool trylock
,
1177 for (i
= 0; i
< level
- 1; i
++)
1178 if (lock_is_held(&sb
->s_writers
.lock_map
[i
])) {
1183 rwsem_acquire_read(&sb
->s_writers
.lock_map
[level
-1], 0, trylock
, ip
);
1188 * This is an internal function, please use sb_start_{write,pagefault,intwrite}
1191 int __sb_start_write(struct super_block
*sb
, int level
, bool wait
)
1194 if (unlikely(sb
->s_writers
.frozen
>= level
)) {
1197 wait_event(sb
->s_writers
.wait_unfrozen
,
1198 sb
->s_writers
.frozen
< level
);
1201 #ifdef CONFIG_LOCKDEP
1202 acquire_freeze_lock(sb
, level
, !wait
, _RET_IP_
);
1204 percpu_counter_inc(&sb
->s_writers
.counter
[level
-1]);
1206 * Make sure counter is updated before we check for frozen.
1207 * freeze_super() first sets frozen and then checks the counter.
1210 if (unlikely(sb
->s_writers
.frozen
>= level
)) {
1211 __sb_end_write(sb
, level
);
1216 EXPORT_SYMBOL(__sb_start_write
);
1219 * sb_wait_write - wait until all writers to given file system finish
1220 * @sb: the super for which we wait
1221 * @level: type of writers we wait for (normal vs page fault)
1223 * This function waits until there are no writers of given type to given file
1224 * system. Caller of this function should make sure there can be no new writers
1225 * of type @level before calling this function. Otherwise this function can
1228 static void sb_wait_write(struct super_block
*sb
, int level
)
1233 * We just cycle-through lockdep here so that it does not complain
1234 * about returning with lock to userspace
1236 rwsem_acquire(&sb
->s_writers
.lock_map
[level
-1], 0, 0, _THIS_IP_
);
1237 rwsem_release(&sb
->s_writers
.lock_map
[level
-1], 1, _THIS_IP_
);
1243 * We use a barrier in prepare_to_wait() to separate setting
1244 * of frozen and checking of the counter
1246 prepare_to_wait(&sb
->s_writers
.wait
, &wait
,
1247 TASK_UNINTERRUPTIBLE
);
1249 writers
= percpu_counter_sum(&sb
->s_writers
.counter
[level
-1]);
1253 finish_wait(&sb
->s_writers
.wait
, &wait
);
1258 * freeze_super - lock the filesystem and force it into a consistent state
1259 * @sb: the super to lock
1261 * Syncs the super to make sure the filesystem is consistent and calls the fs's
1262 * freeze_fs. Subsequent calls to this without first thawing the fs will return
1265 * During this function, sb->s_writers.frozen goes through these values:
1267 * SB_UNFROZEN: File system is normal, all writes progress as usual.
1269 * SB_FREEZE_WRITE: The file system is in the process of being frozen. New
1270 * writes should be blocked, though page faults are still allowed. We wait for
1271 * all writes to complete and then proceed to the next stage.
1273 * SB_FREEZE_PAGEFAULT: Freezing continues. Now also page faults are blocked
1274 * but internal fs threads can still modify the filesystem (although they
1275 * should not dirty new pages or inodes), writeback can run etc. After waiting
1276 * for all running page faults we sync the filesystem which will clean all
1277 * dirty pages and inodes (no new dirty pages or inodes can be created when
1280 * SB_FREEZE_FS: The file system is frozen. Now all internal sources of fs
1281 * modification are blocked (e.g. XFS preallocation truncation on inode
1282 * reclaim). This is usually implemented by blocking new transactions for
1283 * filesystems that have them and need this additional guard. After all
1284 * internal writers are finished we call ->freeze_fs() to finish filesystem
1285 * freezing. Then we transition to SB_FREEZE_COMPLETE state. This state is
1286 * mostly auxiliary for filesystems to verify they do not modify frozen fs.
1288 * sb->s_writers.frozen is protected by sb->s_umount.
1290 int freeze_super(struct super_block
*sb
)
1294 atomic_inc(&sb
->s_active
);
1295 down_write(&sb
->s_umount
);
1296 if (sb
->s_writers
.frozen
!= SB_UNFROZEN
) {
1297 deactivate_locked_super(sb
);
1301 if (!(sb
->s_flags
& MS_BORN
)) {
1302 up_write(&sb
->s_umount
);
1303 return 0; /* sic - it's "nothing to do" */
1306 if (sb
->s_flags
& MS_RDONLY
) {
1307 /* Nothing to do really... */
1308 sb
->s_writers
.frozen
= SB_FREEZE_COMPLETE
;
1309 up_write(&sb
->s_umount
);
1313 /* From now on, no new normal writers can start */
1314 sb
->s_writers
.frozen
= SB_FREEZE_WRITE
;
1317 /* Release s_umount to preserve sb_start_write -> s_umount ordering */
1318 up_write(&sb
->s_umount
);
1320 sb_wait_write(sb
, SB_FREEZE_WRITE
);
1322 /* Now we go and block page faults... */
1323 down_write(&sb
->s_umount
);
1324 sb
->s_writers
.frozen
= SB_FREEZE_PAGEFAULT
;
1327 sb_wait_write(sb
, SB_FREEZE_PAGEFAULT
);
1329 /* All writers are done so after syncing there won't be dirty data */
1330 sync_filesystem(sb
);
1332 /* Now wait for internal filesystem counter */
1333 sb
->s_writers
.frozen
= SB_FREEZE_FS
;
1335 sb_wait_write(sb
, SB_FREEZE_FS
);
1337 if (sb
->s_op
->freeze_fs
) {
1338 ret
= sb
->s_op
->freeze_fs(sb
);
1341 "VFS:Filesystem freeze failed\n");
1342 sb
->s_writers
.frozen
= SB_UNFROZEN
;
1344 wake_up(&sb
->s_writers
.wait_unfrozen
);
1345 deactivate_locked_super(sb
);
1350 * This is just for debugging purposes so that fs can warn if it
1351 * sees write activity when frozen is set to SB_FREEZE_COMPLETE.
1353 sb
->s_writers
.frozen
= SB_FREEZE_COMPLETE
;
1354 up_write(&sb
->s_umount
);
1357 EXPORT_SYMBOL(freeze_super
);
1360 * thaw_super -- unlock filesystem
1361 * @sb: the super to thaw
1363 * Unlocks the filesystem and marks it writeable again after freeze_super().
1365 int thaw_super(struct super_block
*sb
)
1369 down_write(&sb
->s_umount
);
1370 if (sb
->s_writers
.frozen
== SB_UNFROZEN
) {
1371 up_write(&sb
->s_umount
);
1375 if (sb
->s_flags
& MS_RDONLY
)
1378 if (sb
->s_op
->unfreeze_fs
) {
1379 error
= sb
->s_op
->unfreeze_fs(sb
);
1382 "VFS:Filesystem thaw failed\n");
1383 up_write(&sb
->s_umount
);
1389 sb
->s_writers
.frozen
= SB_UNFROZEN
;
1391 wake_up(&sb
->s_writers
.wait_unfrozen
);
1392 deactivate_locked_super(sb
);
1396 EXPORT_SYMBOL(thaw_super
);