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/module.h>
24 #include <linux/slab.h>
25 #include <linux/init.h>
26 #include <linux/smp_lock.h>
27 #include <linux/acct.h>
28 #include <linux/blkdev.h>
29 #include <linux/quotaops.h>
30 #include <linux/namei.h>
31 #include <linux/mount.h>
32 #include <linux/security.h>
33 #include <linux/syscalls.h>
34 #include <linux/vfs.h>
35 #include <linux/writeback.h> /* for the emergency remount stuff */
36 #include <linux/idr.h>
37 #include <linux/kobject.h>
38 #include <linux/mutex.h>
39 #include <linux/file.h>
40 #include <asm/uaccess.h>
44 LIST_HEAD(super_blocks
);
45 DEFINE_SPINLOCK(sb_lock
);
48 * alloc_super - create new superblock
49 * @type: filesystem type superblock should belong to
51 * Allocates and initializes a new &struct super_block. alloc_super()
52 * returns a pointer new superblock or %NULL if allocation had failed.
54 static struct super_block
*alloc_super(struct file_system_type
*type
)
56 struct super_block
*s
= kzalloc(sizeof(struct super_block
), GFP_USER
);
57 static struct super_operations default_op
;
60 if (security_sb_alloc(s
)) {
65 INIT_LIST_HEAD(&s
->s_dirty
);
66 INIT_LIST_HEAD(&s
->s_io
);
67 INIT_LIST_HEAD(&s
->s_more_io
);
68 INIT_LIST_HEAD(&s
->s_files
);
69 INIT_LIST_HEAD(&s
->s_instances
);
70 INIT_HLIST_HEAD(&s
->s_anon
);
71 INIT_LIST_HEAD(&s
->s_inodes
);
72 INIT_LIST_HEAD(&s
->s_dentry_lru
);
73 init_rwsem(&s
->s_umount
);
74 mutex_init(&s
->s_lock
);
75 lockdep_set_class(&s
->s_umount
, &type
->s_umount_key
);
77 * The locking rules for s_lock are up to the
78 * filesystem. For example ext3fs has different
79 * lock ordering than usbfs:
81 lockdep_set_class(&s
->s_lock
, &type
->s_lock_key
);
83 * sget() can have s_umount recursion.
85 * When it cannot find a suitable sb, it allocates a new
86 * one (this one), and tries again to find a suitable old
89 * In case that succeeds, it will acquire the s_umount
90 * lock of the old one. Since these are clearly distrinct
91 * locks, and this object isn't exposed yet, there's no
94 * Annotate this by putting this lock in a different
97 down_write_nested(&s
->s_umount
, SINGLE_DEPTH_NESTING
);
99 atomic_set(&s
->s_active
, 1);
100 mutex_init(&s
->s_vfs_rename_mutex
);
101 mutex_init(&s
->s_dquot
.dqio_mutex
);
102 mutex_init(&s
->s_dquot
.dqonoff_mutex
);
103 init_rwsem(&s
->s_dquot
.dqptr_sem
);
104 init_waitqueue_head(&s
->s_wait_unfrozen
);
105 s
->s_maxbytes
= MAX_NON_LFS
;
106 s
->dq_op
= sb_dquot_ops
;
107 s
->s_qcop
= sb_quotactl_ops
;
108 s
->s_op
= &default_op
;
109 s
->s_time_gran
= 1000000000;
116 * destroy_super - frees a superblock
117 * @s: superblock to free
119 * Frees a superblock.
121 static inline void destroy_super(struct super_block
*s
)
129 /* Superblock refcounting */
132 * Drop a superblock's refcount. Returns non-zero if the superblock was
133 * destroyed. The caller must hold sb_lock.
135 static int __put_super(struct super_block
*sb
)
139 if (!--sb
->s_count
) {
147 * Drop a superblock's refcount.
148 * Returns non-zero if the superblock is about to be destroyed and
149 * at least is already removed from super_blocks list, so if we are
150 * making a loop through super blocks then we need to restart.
151 * The caller must hold sb_lock.
153 int __put_super_and_need_restart(struct super_block
*sb
)
155 /* check for race with generic_shutdown_super() */
156 if (list_empty(&sb
->s_list
)) {
157 /* super block is removed, need to restart... */
161 /* can't be the last, since s_list is still in use */
163 BUG_ON(sb
->s_count
== 0);
168 * put_super - drop a temporary reference to superblock
169 * @sb: superblock in question
171 * Drops a temporary reference, frees superblock if there's no
174 static void put_super(struct super_block
*sb
)
178 spin_unlock(&sb_lock
);
183 * deactivate_super - drop an active reference to superblock
184 * @s: superblock to deactivate
186 * Drops an active reference to superblock, acquiring a temprory one if
187 * there is no active references left. In that case we lock superblock,
188 * tell fs driver to shut it down and drop the temporary reference we
191 void deactivate_super(struct super_block
*s
)
193 struct file_system_type
*fs
= s
->s_type
;
194 if (atomic_dec_and_lock(&s
->s_active
, &sb_lock
)) {
195 s
->s_count
-= S_BIAS
-1;
196 spin_unlock(&sb_lock
);
198 down_write(&s
->s_umount
);
205 EXPORT_SYMBOL(deactivate_super
);
208 * deactivate_locked_super - drop an active reference to superblock
209 * @s: superblock to deactivate
211 * Equivalent of up_write(&s->s_umount); deactivate_super(s);, except that
212 * it does not unlock it until it's all over. As the result, it's safe to
213 * use to dispose of new superblock on ->get_sb() failure exits - nobody
214 * will see the sucker until it's all over. Equivalent using up_write +
215 * deactivate_super is safe for that purpose only if superblock is either
216 * safe to use or has NULL ->s_root when we unlock.
218 void deactivate_locked_super(struct super_block
*s
)
220 struct file_system_type
*fs
= s
->s_type
;
221 if (atomic_dec_and_lock(&s
->s_active
, &sb_lock
)) {
222 s
->s_count
-= S_BIAS
-1;
223 spin_unlock(&sb_lock
);
229 up_write(&s
->s_umount
);
233 EXPORT_SYMBOL(deactivate_locked_super
);
236 * grab_super - acquire an active reference
237 * @s: reference we are trying to make active
239 * Tries to acquire an active reference. grab_super() is used when we
240 * had just found a superblock in super_blocks or fs_type->fs_supers
241 * and want to turn it into a full-blown active reference. grab_super()
242 * is called with sb_lock held and drops it. Returns 1 in case of
243 * success, 0 if we had failed (superblock contents was already dead or
244 * dying when grab_super() had been called).
246 static int grab_super(struct super_block
*s
) __releases(sb_lock
)
249 spin_unlock(&sb_lock
);
250 down_write(&s
->s_umount
);
253 if (s
->s_count
> S_BIAS
) {
254 atomic_inc(&s
->s_active
);
256 spin_unlock(&sb_lock
);
259 spin_unlock(&sb_lock
);
261 up_write(&s
->s_umount
);
268 * Superblock locking. We really ought to get rid of these two.
270 void lock_super(struct super_block
* sb
)
273 mutex_lock(&sb
->s_lock
);
276 void unlock_super(struct super_block
* sb
)
279 mutex_unlock(&sb
->s_lock
);
282 EXPORT_SYMBOL(lock_super
);
283 EXPORT_SYMBOL(unlock_super
);
286 * generic_shutdown_super - common helper for ->kill_sb()
287 * @sb: superblock to kill
289 * generic_shutdown_super() does all fs-independent work on superblock
290 * shutdown. Typical ->kill_sb() should pick all fs-specific objects
291 * that need destruction out of superblock, call generic_shutdown_super()
292 * and release aforementioned objects. Note: dentries and inodes _are_
293 * taken care of and do not need specific handling.
295 * Upon calling this function, the filesystem may no longer alter or
296 * rearrange the set of dentries belonging to this super_block, nor may it
297 * change the attachments of dentries to inodes.
299 void generic_shutdown_super(struct super_block
*sb
)
301 const struct super_operations
*sop
= sb
->s_op
;
305 shrink_dcache_for_umount(sb
);
308 sb
->s_flags
&= ~MS_ACTIVE
;
310 /* bad name - it should be evict_inodes() */
311 invalidate_inodes(sb
);
316 /* Forget any remaining inodes */
317 if (invalidate_inodes(sb
)) {
318 printk("VFS: Busy inodes after unmount of %s. "
319 "Self-destruct in 5 seconds. Have a nice day...\n",
325 /* should be initialized for __put_super_and_need_restart() */
326 list_del_init(&sb
->s_list
);
327 list_del(&sb
->s_instances
);
328 spin_unlock(&sb_lock
);
329 up_write(&sb
->s_umount
);
332 EXPORT_SYMBOL(generic_shutdown_super
);
335 * sget - find or create a superblock
336 * @type: filesystem type superblock should belong to
337 * @test: comparison callback
338 * @set: setup callback
339 * @data: argument to each of them
341 struct super_block
*sget(struct file_system_type
*type
,
342 int (*test
)(struct super_block
*,void *),
343 int (*set
)(struct super_block
*,void *),
346 struct super_block
*s
= NULL
;
347 struct super_block
*old
;
353 list_for_each_entry(old
, &type
->fs_supers
, s_instances
) {
354 if (!test(old
, data
))
356 if (!grab_super(old
))
359 up_write(&s
->s_umount
);
366 spin_unlock(&sb_lock
);
367 s
= alloc_super(type
);
369 return ERR_PTR(-ENOMEM
);
375 spin_unlock(&sb_lock
);
376 up_write(&s
->s_umount
);
381 strlcpy(s
->s_id
, type
->name
, sizeof(s
->s_id
));
382 list_add_tail(&s
->s_list
, &super_blocks
);
383 list_add(&s
->s_instances
, &type
->fs_supers
);
384 spin_unlock(&sb_lock
);
385 get_filesystem(type
);
391 void drop_super(struct super_block
*sb
)
393 up_read(&sb
->s_umount
);
397 EXPORT_SYMBOL(drop_super
);
400 * sync_supers - helper for periodic superblock writeback
402 * Call the write_super method if present on all dirty superblocks in
403 * the system. This is for the periodic writeback used by most older
404 * filesystems. For data integrity superblock writeback use
405 * sync_filesystems() instead.
407 * Note: check the dirty flag before waiting, so we don't
408 * hold up the sync while mounting a device. (The newly
409 * mounted device won't need syncing.)
411 void sync_supers(void)
413 struct super_block
*sb
;
417 list_for_each_entry(sb
, &super_blocks
, s_list
) {
418 if (sb
->s_op
->write_super
&& sb
->s_dirt
) {
420 spin_unlock(&sb_lock
);
422 down_read(&sb
->s_umount
);
423 if (sb
->s_root
&& sb
->s_dirt
)
424 sb
->s_op
->write_super(sb
);
425 up_read(&sb
->s_umount
);
428 if (__put_super_and_need_restart(sb
))
432 spin_unlock(&sb_lock
);
436 * get_super - get the superblock of a device
437 * @bdev: device to get the superblock for
439 * Scans the superblock list and finds the superblock of the file system
440 * mounted on the device given. %NULL is returned if no match is found.
443 struct super_block
* get_super(struct block_device
*bdev
)
445 struct super_block
*sb
;
452 list_for_each_entry(sb
, &super_blocks
, s_list
) {
453 if (sb
->s_bdev
== bdev
) {
455 spin_unlock(&sb_lock
);
456 down_read(&sb
->s_umount
);
459 up_read(&sb
->s_umount
);
460 /* restart only when sb is no longer on the list */
462 if (__put_super_and_need_restart(sb
))
466 spin_unlock(&sb_lock
);
470 EXPORT_SYMBOL(get_super
);
472 struct super_block
* user_get_super(dev_t dev
)
474 struct super_block
*sb
;
478 list_for_each_entry(sb
, &super_blocks
, s_list
) {
479 if (sb
->s_dev
== dev
) {
481 spin_unlock(&sb_lock
);
482 down_read(&sb
->s_umount
);
485 up_read(&sb
->s_umount
);
486 /* restart only when sb is no longer on the list */
488 if (__put_super_and_need_restart(sb
))
492 spin_unlock(&sb_lock
);
496 SYSCALL_DEFINE2(ustat
, unsigned, dev
, struct ustat __user
*, ubuf
)
498 struct super_block
*s
;
503 s
= user_get_super(new_decode_dev(dev
));
506 err
= vfs_statfs(s
->s_root
, &sbuf
);
511 memset(&tmp
,0,sizeof(struct ustat
));
512 tmp
.f_tfree
= sbuf
.f_bfree
;
513 tmp
.f_tinode
= sbuf
.f_ffree
;
515 err
= copy_to_user(ubuf
,&tmp
,sizeof(struct ustat
)) ? -EFAULT
: 0;
521 * do_remount_sb - asks filesystem to change mount options.
522 * @sb: superblock in question
523 * @flags: numeric part of options
524 * @data: the rest of options
525 * @force: whether or not to force the change
527 * Alters the mount options of a mounted file system.
529 int do_remount_sb(struct super_block
*sb
, int flags
, void *data
, int force
)
535 if (!(flags
& MS_RDONLY
) && bdev_read_only(sb
->s_bdev
))
538 if (flags
& MS_RDONLY
)
540 shrink_dcache_sb(sb
);
543 /* If we are remounting RDONLY and current sb is read/write,
544 make sure there are no rw files opened */
545 if ((flags
& MS_RDONLY
) && !(sb
->s_flags
& MS_RDONLY
)) {
548 else if (!fs_may_remount_ro(sb
))
550 retval
= vfs_dq_off(sb
, 1);
551 if (retval
< 0 && retval
!= -ENOSYS
)
554 remount_rw
= !(flags
& MS_RDONLY
) && (sb
->s_flags
& MS_RDONLY
);
556 if (sb
->s_op
->remount_fs
) {
557 retval
= sb
->s_op
->remount_fs(sb
, &flags
, data
);
561 sb
->s_flags
= (sb
->s_flags
& ~MS_RMT_MASK
) | (flags
& MS_RMT_MASK
);
563 vfs_dq_quota_on_remount(sb
);
567 static void do_emergency_remount(struct work_struct
*work
)
569 struct super_block
*sb
;
572 list_for_each_entry(sb
, &super_blocks
, s_list
) {
574 spin_unlock(&sb_lock
);
575 down_write(&sb
->s_umount
);
576 if (sb
->s_root
&& sb
->s_bdev
&& !(sb
->s_flags
& MS_RDONLY
)) {
578 * ->remount_fs needs lock_kernel().
580 * What lock protects sb->s_flags??
582 do_remount_sb(sb
, MS_RDONLY
, NULL
, 1);
584 up_write(&sb
->s_umount
);
588 spin_unlock(&sb_lock
);
590 printk("Emergency Remount complete\n");
593 void emergency_remount(void)
595 struct work_struct
*work
;
597 work
= kmalloc(sizeof(*work
), GFP_ATOMIC
);
599 INIT_WORK(work
, do_emergency_remount
);
605 * Unnamed block devices are dummy devices used by virtual
606 * filesystems which don't use real block-devices. -- jrs
609 static DEFINE_IDA(unnamed_dev_ida
);
610 static DEFINE_SPINLOCK(unnamed_dev_lock
);/* protects the above */
612 int set_anon_super(struct super_block
*s
, void *data
)
618 if (ida_pre_get(&unnamed_dev_ida
, GFP_ATOMIC
) == 0)
620 spin_lock(&unnamed_dev_lock
);
621 error
= ida_get_new(&unnamed_dev_ida
, &dev
);
622 spin_unlock(&unnamed_dev_lock
);
623 if (error
== -EAGAIN
)
624 /* We raced and lost with another CPU. */
629 if ((dev
& MAX_ID_MASK
) == (1 << MINORBITS
)) {
630 spin_lock(&unnamed_dev_lock
);
631 ida_remove(&unnamed_dev_ida
, dev
);
632 spin_unlock(&unnamed_dev_lock
);
635 s
->s_dev
= MKDEV(0, dev
& MINORMASK
);
639 EXPORT_SYMBOL(set_anon_super
);
641 void kill_anon_super(struct super_block
*sb
)
643 int slot
= MINOR(sb
->s_dev
);
645 generic_shutdown_super(sb
);
646 spin_lock(&unnamed_dev_lock
);
647 ida_remove(&unnamed_dev_ida
, slot
);
648 spin_unlock(&unnamed_dev_lock
);
651 EXPORT_SYMBOL(kill_anon_super
);
653 void kill_litter_super(struct super_block
*sb
)
656 d_genocide(sb
->s_root
);
660 EXPORT_SYMBOL(kill_litter_super
);
662 static int ns_test_super(struct super_block
*sb
, void *data
)
664 return sb
->s_fs_info
== data
;
667 static int ns_set_super(struct super_block
*sb
, void *data
)
669 sb
->s_fs_info
= data
;
670 return set_anon_super(sb
, NULL
);
673 int get_sb_ns(struct file_system_type
*fs_type
, int flags
, void *data
,
674 int (*fill_super
)(struct super_block
*, void *, int),
675 struct vfsmount
*mnt
)
677 struct super_block
*sb
;
679 sb
= sget(fs_type
, ns_test_super
, ns_set_super
, data
);
686 err
= fill_super(sb
, data
, flags
& MS_SILENT
? 1 : 0);
688 deactivate_locked_super(sb
);
692 sb
->s_flags
|= MS_ACTIVE
;
695 simple_set_mnt(mnt
, sb
);
699 EXPORT_SYMBOL(get_sb_ns
);
702 static int set_bdev_super(struct super_block
*s
, void *data
)
705 s
->s_dev
= s
->s_bdev
->bd_dev
;
709 static int test_bdev_super(struct super_block
*s
, void *data
)
711 return (void *)s
->s_bdev
== data
;
714 int get_sb_bdev(struct file_system_type
*fs_type
,
715 int flags
, const char *dev_name
, void *data
,
716 int (*fill_super
)(struct super_block
*, void *, int),
717 struct vfsmount
*mnt
)
719 struct block_device
*bdev
;
720 struct super_block
*s
;
721 fmode_t mode
= FMODE_READ
;
724 if (!(flags
& MS_RDONLY
))
727 bdev
= open_bdev_exclusive(dev_name
, mode
, fs_type
);
729 return PTR_ERR(bdev
);
732 * once the super is inserted into the list by sget, s_umount
733 * will protect the lockfs code from trying to start a snapshot
734 * while we are mounting
736 down(&bdev
->bd_mount_sem
);
737 s
= sget(fs_type
, test_bdev_super
, set_bdev_super
, bdev
);
738 up(&bdev
->bd_mount_sem
);
743 if ((flags
^ s
->s_flags
) & MS_RDONLY
) {
744 deactivate_locked_super(s
);
749 close_bdev_exclusive(bdev
, mode
);
751 char b
[BDEVNAME_SIZE
];
755 strlcpy(s
->s_id
, bdevname(bdev
, b
), sizeof(s
->s_id
));
756 sb_set_blocksize(s
, block_size(bdev
));
757 error
= fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
759 deactivate_locked_super(s
);
763 s
->s_flags
|= MS_ACTIVE
;
767 simple_set_mnt(mnt
, s
);
773 close_bdev_exclusive(bdev
, mode
);
778 EXPORT_SYMBOL(get_sb_bdev
);
780 void kill_block_super(struct super_block
*sb
)
782 struct block_device
*bdev
= sb
->s_bdev
;
783 fmode_t mode
= sb
->s_mode
;
785 bdev
->bd_super
= NULL
;
786 generic_shutdown_super(sb
);
788 close_bdev_exclusive(bdev
, mode
);
791 EXPORT_SYMBOL(kill_block_super
);
794 int get_sb_nodev(struct file_system_type
*fs_type
,
795 int flags
, void *data
,
796 int (*fill_super
)(struct super_block
*, void *, int),
797 struct vfsmount
*mnt
)
800 struct super_block
*s
= sget(fs_type
, NULL
, set_anon_super
, NULL
);
807 error
= fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
809 deactivate_locked_super(s
);
812 s
->s_flags
|= MS_ACTIVE
;
813 simple_set_mnt(mnt
, s
);
817 EXPORT_SYMBOL(get_sb_nodev
);
819 static int compare_single(struct super_block
*s
, void *p
)
824 int get_sb_single(struct file_system_type
*fs_type
,
825 int flags
, void *data
,
826 int (*fill_super
)(struct super_block
*, void *, int),
827 struct vfsmount
*mnt
)
829 struct super_block
*s
;
832 s
= sget(fs_type
, compare_single
, set_anon_super
, NULL
);
837 error
= fill_super(s
, data
, flags
& MS_SILENT
? 1 : 0);
839 deactivate_locked_super(s
);
842 s
->s_flags
|= MS_ACTIVE
;
844 do_remount_sb(s
, flags
, data
, 0);
845 simple_set_mnt(mnt
, s
);
849 EXPORT_SYMBOL(get_sb_single
);
852 vfs_kern_mount(struct file_system_type
*type
, int flags
, const char *name
, void *data
)
854 struct vfsmount
*mnt
;
855 char *secdata
= NULL
;
859 return ERR_PTR(-ENODEV
);
862 mnt
= alloc_vfsmnt(name
);
866 if (data
&& !(type
->fs_flags
& FS_BINARY_MOUNTDATA
)) {
867 secdata
= alloc_secdata();
871 error
= security_sb_copy_data(data
, secdata
);
873 goto out_free_secdata
;
876 error
= type
->get_sb(type
, flags
, name
, data
, mnt
);
878 goto out_free_secdata
;
879 BUG_ON(!mnt
->mnt_sb
);
881 error
= security_sb_kern_mount(mnt
->mnt_sb
, flags
, secdata
);
885 mnt
->mnt_mountpoint
= mnt
->mnt_root
;
886 mnt
->mnt_parent
= mnt
;
887 up_write(&mnt
->mnt_sb
->s_umount
);
888 free_secdata(secdata
);
892 deactivate_locked_super(mnt
->mnt_sb
);
894 free_secdata(secdata
);
898 return ERR_PTR(error
);
901 EXPORT_SYMBOL_GPL(vfs_kern_mount
);
903 static struct vfsmount
*fs_set_subtype(struct vfsmount
*mnt
, const char *fstype
)
906 const char *subtype
= strchr(fstype
, '.');
915 mnt
->mnt_sb
->s_subtype
= kstrdup(subtype
, GFP_KERNEL
);
917 if (!mnt
->mnt_sb
->s_subtype
)
927 do_kern_mount(const char *fstype
, int flags
, const char *name
, void *data
)
929 struct file_system_type
*type
= get_fs_type(fstype
);
930 struct vfsmount
*mnt
;
932 return ERR_PTR(-ENODEV
);
933 mnt
= vfs_kern_mount(type
, flags
, name
, data
);
934 if (!IS_ERR(mnt
) && (type
->fs_flags
& FS_HAS_SUBTYPE
) &&
935 !mnt
->mnt_sb
->s_subtype
)
936 mnt
= fs_set_subtype(mnt
, fstype
);
937 put_filesystem(type
);
940 EXPORT_SYMBOL_GPL(do_kern_mount
);
942 struct vfsmount
*kern_mount_data(struct file_system_type
*type
, void *data
)
944 return vfs_kern_mount(type
, MS_KERNMOUNT
, type
->name
, data
);
947 EXPORT_SYMBOL_GPL(kern_mount_data
);