[linux-block.git] / fs / freevxfs / vxfs_super.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2000-2001 Christoph Hellwig.
 * Copyright (c) 2016 Krzysztof Blaszkowski
 */

/*
 * Veritas filesystem driver - superblock related routines.
 */
#include <linux/init.h>
#include <linux/module.h>

#include <linux/blkdev.h>
#include <linux/fs.h>
#include <linux/buffer_head.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/stat.h>
#include <linux/vfs.h>
#include <linux/mount.h>

#include "vxfs.h"
#include "vxfs_extern.h"
#include "vxfs_dir.h"
#include "vxfs_inode.h"


MODULE_AUTHOR("Christoph Hellwig, Krzysztof Blaszkowski");
MODULE_DESCRIPTION("Veritas Filesystem (VxFS) driver");
MODULE_LICENSE("Dual BSD/GPL");

static struct kmem_cache *vxfs_inode_cachep;

/**
 * vxfs_put_super - free superblock resources
 * @sbp:	VFS superblock.
 *
 * Description:
 *   vxfs_put_super frees all resources allocated for @sbp
 *   after the last instance of the filesystem is unmounted.
 */

static void
vxfs_put_super(struct super_block *sbp)
{
	struct vxfs_sb_info	*infp = VXFS_SBI(sbp);

	iput(infp->vsi_fship);
	iput(infp->vsi_ilist);
	iput(infp->vsi_stilist);

	brelse(infp->vsi_bp);
	kfree(infp);
}

/**
 * vxfs_statfs - get filesystem information
 * @dentry:	VFS dentry to locate superblock
 * @bufp:	output buffer
 *
 * Description:
 *   vxfs_statfs fills the statfs buffer @bufp with information
 *   about the filesystem described by @dentry.
 *
 * Returns:
 *   Zero.
 *
 * Locking:
 *   No locks held.
 *
 * Notes:
 *   This is everything but complete...
 */
static int
vxfs_statfs(struct dentry *dentry, struct kstatfs *bufp)
{
	struct vxfs_sb_info		*infp = VXFS_SBI(dentry->d_sb);
	struct vxfs_sb *raw_sb = infp->vsi_raw;

	bufp->f_type = VXFS_SUPER_MAGIC;
	bufp->f_bsize = dentry->d_sb->s_blocksize;
	bufp->f_blocks = fs32_to_cpu(infp, raw_sb->vs_dsize);
	bufp->f_bfree = fs32_to_cpu(infp, raw_sb->vs_free);
	bufp->f_bavail = 0;
	bufp->f_files = 0;
	bufp->f_ffree = fs32_to_cpu(infp, raw_sb->vs_ifree);
	bufp->f_namelen = VXFS_NAMELEN;

	return 0;
}

static int vxfs_remount(struct super_block *sb, int *flags, char *data)
{
	sync_filesystem(sb);
	*flags |= SB_RDONLY;
	return 0;
}

static struct inode *vxfs_alloc_inode(struct super_block *sb)
{
	struct vxfs_inode_info *vi;

	vi = alloc_inode_sb(sb, vxfs_inode_cachep, GFP_KERNEL);
	if (!vi)
		return NULL;
	inode_init_once(&vi->vfs_inode);
	return &vi->vfs_inode;
}

static void vxfs_free_inode(struct inode *inode)
{
	kmem_cache_free(vxfs_inode_cachep, VXFS_INO(inode));
}

static const struct super_operations vxfs_super_ops = {
	.alloc_inode		= vxfs_alloc_inode,
	.free_inode		= vxfs_free_inode,
	.evict_inode		= vxfs_evict_inode,
	.put_super		= vxfs_put_super,
	.statfs			= vxfs_statfs,
	.remount_fs		= vxfs_remount,
};

static int vxfs_try_sb_magic(struct super_block *sbp, int silent,
		unsigned blk, __fs32 magic)
{
	struct buffer_head *bp;
	struct vxfs_sb *rsbp;
	struct vxfs_sb_info *infp = VXFS_SBI(sbp);
	int rc = -ENOMEM;

	bp = sb_bread(sbp, blk);
	do {
		if (!bp || !buffer_mapped(bp)) {
			if (!silent) {
				printk(KERN_WARNING
					"vxfs: unable to read disk superblock at %u\n",
					blk);
			}
			break;
		}

		rc = -EINVAL;
		rsbp = (struct vxfs_sb *)bp->b_data;
		if (rsbp->vs_magic != magic) {
			if (!silent)
				printk(KERN_NOTICE
					"vxfs: WRONG superblock magic %08x at %u\n",
					rsbp->vs_magic, blk);
			break;
		}

		rc = 0;
		infp->vsi_raw = rsbp;
		infp->vsi_bp = bp;
	} while (0);

	if (rc) {
		infp->vsi_raw = NULL;
		infp->vsi_bp = NULL;
		brelse(bp);
	}

	return rc;
}

/**
 * vxfs_fill_super - read superblock into memory and initialize filesystem
 * @sbp:		VFS superblock (to fill)
 * @dp:			fs private mount data
 * @silent:		do not complain loudly when sth is wrong
 *
 * Description:
 *   We are called on the first mount of a filesystem to read the
 *   superblock into memory and do some basic setup.
 *
 * Returns:
 *   The superblock on success, else %NULL.
 *
 * Locking:
 *   We are under @sbp->s_lock.
 */
static int vxfs_fill_super(struct super_block *sbp, void *dp, int silent)
{
	struct vxfs_sb_info	*infp;
	struct vxfs_sb		*rsbp;
	u_long			bsize;
	struct inode *root;
	int ret = -EINVAL;
	u32 j;

	sbp->s_flags |= SB_RDONLY;

	infp = kzalloc(sizeof(*infp), GFP_KERNEL);
	if (!infp) {
		printk(KERN_WARNING "vxfs: unable to allocate incore superblock\n");
		return -ENOMEM;
	}

	bsize = sb_min_blocksize(sbp, BLOCK_SIZE);
	if (!bsize) {
		printk(KERN_WARNING "vxfs: unable to set blocksize\n");
		goto out;
	}

	sbp->s_op = &vxfs_super_ops;
	sbp->s_fs_info = infp;
	sbp->s_time_min = 0;
	sbp->s_time_max = U32_MAX;

	if (!vxfs_try_sb_magic(sbp, silent, 1,
			(__force __fs32)cpu_to_le32(VXFS_SUPER_MAGIC))) {
		/* Unixware, x86 */
		infp->byte_order = VXFS_BO_LE;
	} else if (!vxfs_try_sb_magic(sbp, silent, 8,
			(__force __fs32)cpu_to_be32(VXFS_SUPER_MAGIC))) {
		/* HP-UX, parisc */
		infp->byte_order = VXFS_BO_BE;
	} else {
		if (!silent)
			printk(KERN_NOTICE "vxfs: can't find superblock.\n");
		goto out;
	}

	rsbp = infp->vsi_raw;
	j = fs32_to_cpu(infp, rsbp->vs_version);
	if ((j < 2 || j > 4) && !silent) {
		printk(KERN_NOTICE "vxfs: unsupported VxFS version (%d)\n", j);
		goto out;
	}

#ifdef DIAGNOSTIC
	printk(KERN_DEBUG "vxfs: supported VxFS version (%d)\n", j);
	printk(KERN_DEBUG "vxfs: blocksize: %d\n",
		fs32_to_cpu(infp, rsbp->vs_bsize));
#endif

	sbp->s_magic = fs32_to_cpu(infp, rsbp->vs_magic);

	infp->vsi_oltext = fs32_to_cpu(infp, rsbp->vs_oltext[0]);
	infp->vsi_oltsize = fs32_to_cpu(infp, rsbp->vs_oltsize);

	j = fs32_to_cpu(infp, rsbp->vs_bsize);
	if (!sb_set_blocksize(sbp, j)) {
		printk(KERN_WARNING "vxfs: unable to set final block size\n");
		goto out;
	}

	if (vxfs_read_olt(sbp, bsize)) {
		printk(KERN_WARNING "vxfs: unable to read olt\n");
		goto out;
	}

	if (vxfs_read_fshead(sbp)) {
		printk(KERN_WARNING "vxfs: unable to read fshead\n");
		goto out;
	}

	root = vxfs_iget(sbp, VXFS_ROOT_INO);
	if (IS_ERR(root)) {
		ret = PTR_ERR(root);
		goto out;
	}
	sbp->s_root = d_make_root(root);
	if (!sbp->s_root) {
		printk(KERN_WARNING "vxfs: unable to get root dentry.\n");
		goto out_free_ilist;
	}

	return 0;
	
out_free_ilist:
	iput(infp->vsi_fship);
	iput(infp->vsi_ilist);
	iput(infp->vsi_stilist);
out:
	brelse(infp->vsi_bp);
	kfree(infp);
	return ret;
}

/*
 * The usual module blurb.
 */
static struct dentry *vxfs_mount(struct file_system_type *fs_type,
	int flags, const char *dev_name, void *data)
{
	return mount_bdev(fs_type, flags, dev_name, data, vxfs_fill_super);
}

static struct file_system_type vxfs_fs_type = {
	.owner		= THIS_MODULE,
	.name		= "vxfs",
	.mount		= vxfs_mount,
	.kill_sb	= kill_block_super,
	.fs_flags	= FS_REQUIRES_DEV,
};
MODULE_ALIAS_FS("vxfs"); /* makes mount -t vxfs autoload the module */
MODULE_ALIAS("vxfs");

static int __init
vxfs_init(void)
{
	int rv;

	vxfs_inode_cachep = kmem_cache_create_usercopy("vxfs_inode",
			sizeof(struct vxfs_inode_info), 0,
			SLAB_RECLAIM_ACCOUNT|SLAB_MEM_SPREAD,
			offsetof(struct vxfs_inode_info, vii_immed.vi_immed),
			sizeof_field(struct vxfs_inode_info,
				vii_immed.vi_immed),
			NULL);
	if (!vxfs_inode_cachep)
		return -ENOMEM;
	rv = register_filesystem(&vxfs_fs_type);
	if (rv < 0)
		kmem_cache_destroy(vxfs_inode_cachep);
	return rv;
}

static void __exit
vxfs_cleanup(void)
{
	unregister_filesystem(&vxfs_fs_type);
	/*
	 * Make sure all delayed rcu free inodes are flushed before we
	 * destroy cache.
	 */
	rcu_barrier();
	kmem_cache_destroy(vxfs_inode_cachep);
}

module_init(vxfs_init);
module_exit(vxfs_cleanup);
Commit	Line	Data
0b1e987c	1	// SPDX-License-Identifier: GPL-2.0-only
1da177e4 LT	2	/*
1da177e4 LT	3	* Copyright (c) 2000-2001 Christoph Hellwig.
1cce1701	4	* Copyright (c) 2016 Krzysztof Blaszkowski
1da177e4 LT	5	*/
	6
	7	/*
	8	* Veritas filesystem driver - superblock related routines.
	9	*/
	10	#include <linux/init.h>
	11	#include <linux/module.h>
	12
	13	#include <linux/blkdev.h>
	14	#include <linux/fs.h>
	15	#include <linux/buffer_head.h>
	16	#include <linux/kernel.h>
	17	#include <linux/slab.h>
	18	#include <linux/stat.h>
	19	#include <linux/vfs.h>
726c3342	20	#include <linux/mount.h>
1da177e4 LT	21
	22	#include "vxfs.h"
	23	#include "vxfs_extern.h"
	24	#include "vxfs_dir.h"
	25	#include "vxfs_inode.h"
	26
	27
1cce1701	28	MODULE_AUTHOR("Christoph Hellwig, Krzysztof Blaszkowski");
1da177e4 LT	29	MODULE_DESCRIPTION("Veritas Filesystem (VxFS) driver");
	30	MODULE_LICENSE("Dual BSD/GPL");
	31
2f137e31 CH	32	static struct kmem_cache *vxfs_inode_cachep;
2f137e31 CH	33
1da177e4 LT	34	/**
	35	* vxfs_put_super - free superblock resources
	36	* @sbp: VFS superblock.
	37	*
	38	* Description:
	39	* vxfs_put_super frees all resources allocated for @sbp
	40	* after the last instance of the filesystem is unmounted.
	41	*/
	42
	43	static void
	44	vxfs_put_super(struct super_block *sbp)
	45	{
	46	struct vxfs_sb_info *infp = VXFS_SBI(sbp);
	47
0e481d3c KB	48	iput(infp->vsi_fship);
	49	iput(infp->vsi_ilist);
	50	iput(infp->vsi_stilist);
1da177e4 LT	51
	52	brelse(infp->vsi_bp);
	53	kfree(infp);
	54	}
	55
	56	/**
	57	* vxfs_statfs - get filesystem information
726c3342	58	* @dentry: VFS dentry to locate superblock
1da177e4 LT	59	* @bufp: output buffer
	60	*
	61	* Description:
	62	* vxfs_statfs fills the statfs buffer @bufp with information
726c3342	63	* about the filesystem described by @dentry.
1da177e4 LT	64	*
	65	* Returns:
	66	* Zero.
	67	*
	68	* Locking:
	69	* No locks held.
	70	*
	71	* Notes:
	72	* This is everything but complete...
	73	*/
	74	static int
726c3342	75	vxfs_statfs(struct dentry dentry, struct kstatfs bufp)
1da177e4	76	{
726c3342	77	struct vxfs_sb_info *infp = VXFS_SBI(dentry->d_sb);
0d83f7fc	78	struct vxfs_sb *raw_sb = infp->vsi_raw;
1da177e4 LT	79
1da177e4 LT	80	bufp->f_type = VXFS_SUPER_MAGIC;
726c3342	81	bufp->f_bsize = dentry->d_sb->s_blocksize;
0d83f7fc KB	82	bufp->f_blocks = fs32_to_cpu(infp, raw_sb->vs_dsize);
0d83f7fc KB	83	bufp->f_bfree = fs32_to_cpu(infp, raw_sb->vs_free);
1da177e4 LT	84	bufp->f_bavail = 0;
1da177e4 LT	85	bufp->f_files = 0;
0d83f7fc	86	bufp->f_ffree = fs32_to_cpu(infp, raw_sb->vs_ifree);
1da177e4 LT	87	bufp->f_namelen = VXFS_NAMELEN;
	88
	89	return 0;
	90	}
	91
	92	static int vxfs_remount(struct super_block sb, int flags, char *data)
	93	{
02b9984d	94	sync_filesystem(sb);
1751e8a6	95	*flags \|= SB_RDONLY;
1da177e4 LT	96	return 0;
	97	}
	98
2f137e31 CH	99	static struct inode vxfs_alloc_inode(struct super_block sb)
	100	{
	101	struct vxfs_inode_info *vi;
	102
fd60b288	103	vi = alloc_inode_sb(sb, vxfs_inode_cachep, GFP_KERNEL);
2f137e31 CH	104	if (!vi)
2f137e31 CH	105	return NULL;
f2fe2fa1	106	inode_init_once(&vi->vfs_inode);
2f137e31 CH	107	return &vi->vfs_inode;
	108	}
	109
9f179271	110	static void vxfs_free_inode(struct inode *inode)
2f137e31	111	{
2f137e31 CH	112	kmem_cache_free(vxfs_inode_cachep, VXFS_INO(inode));
	113	}
	114
f2bf2c70	115	static const struct super_operations vxfs_super_ops = {
2f137e31	116	.alloc_inode = vxfs_alloc_inode,
9f179271	117	.free_inode = vxfs_free_inode,
f2bf2c70 CH	118	.evict_inode = vxfs_evict_inode,
	119	.put_super = vxfs_put_super,
	120	.statfs = vxfs_statfs,
	121	.remount_fs = vxfs_remount,
	122	};
0d83f7fc KB	123
	124	static int vxfs_try_sb_magic(struct super_block *sbp, int silent,
	125	unsigned blk, __fs32 magic)
	126	{
	127	struct buffer_head *bp;
	128	struct vxfs_sb *rsbp;
	129	struct vxfs_sb_info *infp = VXFS_SBI(sbp);
	130	int rc = -ENOMEM;
	131
	132	bp = sb_bread(sbp, blk);
	133	do {
	134	if (!bp \|\| !buffer_mapped(bp)) {
	135	if (!silent) {
	136	printk(KERN_WARNING
	137	"vxfs: unable to read disk superblock at %u\n",
	138	blk);
	139	}
	140	break;
	141	}
	142
	143	rc = -EINVAL;
	144	rsbp = (struct vxfs_sb *)bp->b_data;
	145	if (rsbp->vs_magic != magic) {
	146	if (!silent)
	147	printk(KERN_NOTICE
	148	"vxfs: WRONG superblock magic %08x at %u\n",
	149	rsbp->vs_magic, blk);
	150	break;
	151	}
	152
	153	rc = 0;
	154	infp->vsi_raw = rsbp;
	155	infp->vsi_bp = bp;
	156	} while (0);
	157
	158	if (rc) {
	159	infp->vsi_raw = NULL;
	160	infp->vsi_bp = NULL;
	161	brelse(bp);
	162	}
	163
	164	return rc;
	165	}
	166
1da177e4	167	/**
d3fcf834	168	* vxfs_fill_super - read superblock into memory and initialize filesystem
1da177e4 LT	169	* @sbp: VFS superblock (to fill)
	170	* @dp: fs private mount data
	171	* @silent: do not complain loudly when sth is wrong
	172	*
	173	* Description:
	174	* We are called on the first mount of a filesystem to read the
	175	* superblock into memory and do some basic setup.
	176	*
	177	* Returns:
	178	* The superblock on success, else %NULL.
	179	*
	180	* Locking:
db719222	181	* We are under @sbp->s_lock.
1da177e4 LT	182	*/
	183	static int vxfs_fill_super(struct super_block sbp, void dp, int silent)
	184	{
	185	struct vxfs_sb_info *infp;
	186	struct vxfs_sb *rsbp;
1da177e4 LT	187	u_long bsize;
1da177e4 LT	188	struct inode *root;
d0b07948	189	int ret = -EINVAL;
0d83f7fc	190	u32 j;
1da177e4	191
1751e8a6	192	sbp->s_flags \|= SB_RDONLY;
1da177e4	193
e915fc49	194	infp = kzalloc(sizeof(*infp), GFP_KERNEL);
1da177e4 LT	195	if (!infp) {
	196	printk(KERN_WARNING "vxfs: unable to allocate incore superblock\n");
	197	return -ENOMEM;
	198	}
1da177e4 LT	199
	200	bsize = sb_min_blocksize(sbp, BLOCK_SIZE);
	201	if (!bsize) {
	202	printk(KERN_WARNING "vxfs: unable to set blocksize\n");
	203	goto out;
	204	}
	205
2f137e31	206	sbp->s_op = &vxfs_super_ops;
0d83f7fc	207	sbp->s_fs_info = infp;
22b13969 DD	208	sbp->s_time_min = 0;
22b13969 DD	209	sbp->s_time_max = U32_MAX;
1da177e4	210
0d83f7fc KB	211	if (!vxfs_try_sb_magic(sbp, silent, 1,
	212	(__force __fs32)cpu_to_le32(VXFS_SUPER_MAGIC))) {
	213	/* Unixware, x86 */
	214	infp->byte_order = VXFS_BO_LE;
	215	} else if (!vxfs_try_sb_magic(sbp, silent, 8,
	216	(__force __fs32)cpu_to_be32(VXFS_SUPER_MAGIC))) {
	217	/* HP-UX, parisc */
	218	infp->byte_order = VXFS_BO_BE;
	219	} else {
1da177e4	220	if (!silent)
0d83f7fc	221	printk(KERN_NOTICE "vxfs: can't find superblock.\n");
1da177e4 LT	222	goto out;
	223	}
	224
0d83f7fc KB	225	rsbp = infp->vsi_raw;
	226	j = fs32_to_cpu(infp, rsbp->vs_version);
	227	if ((j < 2 \|\| j > 4) && !silent) {
	228	printk(KERN_NOTICE "vxfs: unsupported VxFS version (%d)\n", j);
1da177e4 LT	229	goto out;
	230	}
	231
	232	#ifdef DIAGNOSTIC
0d83f7fc KB	233	printk(KERN_DEBUG "vxfs: supported VxFS version (%d)\n", j);
	234	printk(KERN_DEBUG "vxfs: blocksize: %d\n",
	235	fs32_to_cpu(infp, rsbp->vs_bsize));
1da177e4 LT	236	#endif
1da177e4 LT	237
0d83f7fc	238	sbp->s_magic = fs32_to_cpu(infp, rsbp->vs_magic);
1da177e4	239
0d83f7fc KB	240	infp->vsi_oltext = fs32_to_cpu(infp, rsbp->vs_oltext[0]);
0d83f7fc KB	241	infp->vsi_oltsize = fs32_to_cpu(infp, rsbp->vs_oltsize);
1da177e4	242
0d83f7fc KB	243	j = fs32_to_cpu(infp, rsbp->vs_bsize);
0d83f7fc KB	244	if (!sb_set_blocksize(sbp, j)) {
1da177e4 LT	245	printk(KERN_WARNING "vxfs: unable to set final block size\n");
	246	goto out;
	247	}
	248
	249	if (vxfs_read_olt(sbp, bsize)) {
	250	printk(KERN_WARNING "vxfs: unable to read olt\n");
	251	goto out;
	252	}
	253
	254	if (vxfs_read_fshead(sbp)) {
	255	printk(KERN_WARNING "vxfs: unable to read fshead\n");
	256	goto out;
	257	}
	258
d0b07948 DH	259	root = vxfs_iget(sbp, VXFS_ROOT_INO);
	260	if (IS_ERR(root)) {
	261	ret = PTR_ERR(root);
	262	goto out;
	263	}
48fde701	264	sbp->s_root = d_make_root(root);
1da177e4	265	if (!sbp->s_root) {
1da177e4 LT	266	printk(KERN_WARNING "vxfs: unable to get root dentry.\n");
	267	goto out_free_ilist;
	268	}
	269
	270	return 0;
	271
	272	out_free_ilist:
0e481d3c KB	273	iput(infp->vsi_fship);
	274	iput(infp->vsi_ilist);
	275	iput(infp->vsi_stilist);
1da177e4	276	out:
0d83f7fc	277	brelse(infp->vsi_bp);
1da177e4	278	kfree(infp);
d0b07948	279	return ret;
1da177e4 LT	280	}
	281
	282	/*
	283	* The usual module blurb.
	284	*/
152a0836 AV	285	static struct dentry vxfs_mount(struct file_system_type fs_type,
152a0836 AV	286	int flags, const char dev_name, void data)
1da177e4	287	{
152a0836	288	return mount_bdev(fs_type, flags, dev_name, data, vxfs_fill_super);
1da177e4 LT	289	}
	290
	291	static struct file_system_type vxfs_fs_type = {
	292	.owner = THIS_MODULE,
	293	.name = "vxfs",
152a0836	294	.mount = vxfs_mount,
1da177e4 LT	295	.kill_sb = kill_block_super,
	296	.fs_flags = FS_REQUIRES_DEV,
	297	};
7f78e035	298	MODULE_ALIAS_FS("vxfs"); /* makes mount -t vxfs autoload the module */
fa7614dd	299	MODULE_ALIAS("vxfs");
1da177e4 LT	300
	301	static int __init
	302	vxfs_init(void)
	303	{
a4376e13 AD	304	int rv;
a4376e13 AD	305
e9a0561b	306	vxfs_inode_cachep = kmem_cache_create_usercopy("vxfs_inode",
20c2df83	307	sizeof(struct vxfs_inode_info), 0,
e9a0561b DW	308	SLAB_RECLAIM_ACCOUNT\|SLAB_MEM_SPREAD,
	309	offsetof(struct vxfs_inode_info, vii_immed.vi_immed),
	310	sizeof_field(struct vxfs_inode_info,
	311	vii_immed.vi_immed),
	312	NULL);
a4376e13 AD	313	if (!vxfs_inode_cachep)
	314	return -ENOMEM;
	315	rv = register_filesystem(&vxfs_fs_type);
	316	if (rv < 0)
	317	kmem_cache_destroy(vxfs_inode_cachep);
	318	return rv;
1da177e4 LT	319	}
	320
	321	static void __exit
	322	vxfs_cleanup(void)
	323	{
	324	unregister_filesystem(&vxfs_fs_type);
8c0a8537 KS	325	/*
	326	* Make sure all delayed rcu free inodes are flushed before we
	327	* destroy cache.
	328	*/
	329	rcu_barrier();
1da177e4 LT	330	kmem_cache_destroy(vxfs_inode_cachep);
	331	}
	332
	333	module_init(vxfs_init);
	334	module_exit(vxfs_cleanup);