[mirror_ubuntu-bionic-kernel.git] / zfs / include / sys / zfs_vfsops.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 */

#ifndef	_SYS_FS_ZFS_VFSOPS_H
#define	_SYS_FS_ZFS_VFSOPS_H

#include <sys/isa_defs.h>
#include <sys/types32.h>
#include <sys/list.h>
#include <sys/vfs.h>
#include <sys/zil.h>
#include <sys/sa.h>
#include <sys/rrwlock.h>
#include <sys/dsl_dataset.h>
#include <sys/zfs_ioctl.h>

#ifdef	__cplusplus
extern "C" {
#endif

typedef struct zfsvfs zfsvfs_t;
struct znode;

/*
 * This structure emulates the vfs_t from other platforms.  It's purpose
 * is to faciliate the handling of mount options and minimize structural
 * differences between the platforms.
 */
typedef struct vfs {
	struct zfsvfs	*vfs_data;
	char		*vfs_mntpoint;	/* Primary mount point */
	uint64_t	vfs_xattr;
	boolean_t	vfs_readonly;
	boolean_t	vfs_do_readonly;
	boolean_t	vfs_setuid;
	boolean_t	vfs_do_setuid;
	boolean_t	vfs_exec;
	boolean_t	vfs_do_exec;
	boolean_t	vfs_devices;
	boolean_t	vfs_do_devices;
	boolean_t	vfs_do_xattr;
	boolean_t	vfs_atime;
	boolean_t	vfs_do_atime;
	boolean_t	vfs_relatime;
	boolean_t	vfs_do_relatime;
	boolean_t	vfs_nbmand;
	boolean_t	vfs_do_nbmand;
} vfs_t;

typedef struct zfs_mnt {
	const char	*mnt_osname;	/* Objset name */
	char		*mnt_data;	/* Raw mount options */
} zfs_mnt_t;

struct zfsvfs {
	vfs_t		*z_vfs;		/* generic fs struct */
	struct super_block *z_sb;	/* generic super_block */
	struct zfsvfs	*z_parent;	/* parent fs */
	objset_t	*z_os;		/* objset reference */
	uint64_t	z_flags;	/* super_block flags */
	uint64_t	z_root;		/* id of root znode */
	uint64_t	z_unlinkedobj;	/* id of unlinked zapobj */
	uint64_t	z_max_blksz;	/* maximum block size for files */
	uint64_t	z_fuid_obj;	/* fuid table object number */
	uint64_t	z_fuid_size;	/* fuid table size */
	avl_tree_t	z_fuid_idx;	/* fuid tree keyed by index */
	avl_tree_t	z_fuid_domain;	/* fuid tree keyed by domain */
	krwlock_t	z_fuid_lock;	/* fuid lock */
	boolean_t	z_fuid_loaded;	/* fuid tables are loaded */
	boolean_t	z_fuid_dirty;   /* need to sync fuid table ? */
	struct zfs_fuid_info	*z_fuid_replay; /* fuid info for replay */
	zilog_t		*z_log;		/* intent log pointer */
	uint_t		z_acl_inherit;	/* acl inheritance behavior */
	uint_t		z_acl_type;	/* type of ACL usable on this FS */
	zfs_case_t	z_case;		/* case-sense */
	boolean_t	z_utf8;		/* utf8-only */
	int		z_norm;		/* normalization flags */
	boolean_t	z_atime;	/* enable atimes mount option */
	boolean_t	z_relatime;	/* enable relatime mount option */
	boolean_t	z_unmounted;	/* unmounted */
	rrmlock_t	z_teardown_lock;
	krwlock_t	z_teardown_inactive_lock;
	list_t		z_all_znodes;	/* all znodes in the fs */
	uint64_t	z_nr_znodes;	/* number of znodes in the fs */
	unsigned long	z_rollback_time; /* last online rollback time */
	unsigned long	z_snap_defer_time; /* last snapshot unmount deferal */
	kmutex_t	z_znodes_lock;	/* lock for z_all_znodes */
	arc_prune_t	*z_arc_prune;	/* called by ARC to prune caches */
	struct inode	*z_ctldir;	/* .zfs directory inode */
	boolean_t	z_show_ctldir;	/* expose .zfs in the root dir */
	boolean_t	z_issnap;	/* true if this is a snapshot */
	boolean_t	z_vscan;	/* virus scan on/off */
	boolean_t	z_use_fuids;	/* version allows fuids */
	boolean_t	z_replay;	/* set during ZIL replay */
	boolean_t	z_use_sa;	/* version allow system attributes */
	boolean_t	z_xattr_sa;	/* allow xattrs to be stores as SA */
	uint64_t	z_version;	/* ZPL version */
	uint64_t	z_shares_dir;	/* hidden shares dir */
	kmutex_t	z_lock;
	uint64_t	z_userquota_obj;
	uint64_t	z_groupquota_obj;
	uint64_t	z_userobjquota_obj;
	uint64_t	z_groupobjquota_obj;
	uint64_t	z_replay_eof;	/* New end of file - replay only */
	sa_attr_type_t	*z_attr_table;	/* SA attr mapping->id */
	uint64_t	z_hold_size;	/* znode hold array size */
	avl_tree_t	*z_hold_trees;	/* znode hold trees */
	kmutex_t	*z_hold_locks;	/* znode hold locks */
};

#define	ZSB_XATTR	0x0001		/* Enable user xattrs */

/*
 * Allow a maximum number of links.  While ZFS does not internally limit
 * this the inode->i_nlink member is defined as an unsigned int.  To be
 * safe we use 2^31-1 as the limit.
 */
#define	ZFS_LINK_MAX		((1U << 31) - 1U)

/*
 * Normal filesystems (those not under .zfs/snapshot) have a total
 * file ID size limited to 12 bytes (including the length field) due to
 * NFSv2 protocol's limitation of 32 bytes for a filehandle.  For historical
 * reasons, this same limit is being imposed by the Solaris NFSv3 implementation
 * (although the NFSv3 protocol actually permits a maximum of 64 bytes).  It
 * is not possible to expand beyond 12 bytes without abandoning support
 * of NFSv2.
 *
 * For normal filesystems, we partition up the available space as follows:
 *	2 bytes		fid length (required)
 *	6 bytes		object number (48 bits)
 *	4 bytes		generation number (32 bits)
 *
 * We reserve only 48 bits for the object number, as this is the limit
 * currently defined and imposed by the DMU.
 */
typedef struct zfid_short {
	uint16_t	zf_len;
	uint8_t		zf_object[6];		/* obj[i] = obj >> (8 * i) */
	uint8_t		zf_gen[4];		/* gen[i] = gen >> (8 * i) */
} zfid_short_t;

/*
 * Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
 * (including the length field).  This makes files under .zfs/snapshot
 * accessible by NFSv3 and NFSv4, but not NFSv2.
 *
 * For files under .zfs/snapshot, we partition up the available space
 * as follows:
 *	2 bytes		fid length (required)
 *	6 bytes		object number (48 bits)
 *	4 bytes		generation number (32 bits)
 *	6 bytes		objset id (48 bits)
 *	4 bytes		currently just zero (32 bits)
 *
 * We reserve only 48 bits for the object number and objset id, as these are
 * the limits currently defined and imposed by the DMU.
 */
typedef struct zfid_long {
	zfid_short_t	z_fid;
	uint8_t		zf_setid[6];		/* obj[i] = obj >> (8 * i) */
	uint8_t		zf_setgen[4];		/* gen[i] = gen >> (8 * i) */
} zfid_long_t;

#define	SHORT_FID_LEN	(sizeof (zfid_short_t) - sizeof (uint16_t))
#define	LONG_FID_LEN	(sizeof (zfid_long_t) - sizeof (uint16_t))

extern uint_t zfs_fsyncer_key;

extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
extern int zfs_resume_fs(zfsvfs_t *zfsvfs, struct dsl_dataset *ds);
extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
    const char *domain, uint64_t rid, uint64_t *valuep);
extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
    uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
    const char *domain, uint64_t rid, uint64_t quota);
extern boolean_t zfs_owner_overquota(zfsvfs_t *zfsvfs, struct znode *,
    boolean_t isgroup);
extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
    uint64_t fuid);
extern boolean_t zfs_fuid_overobjquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
    uint64_t fuid);
extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
extern int zfsvfs_create(const char *name, zfsvfs_t **zfvp);
extern void zfsvfs_free(zfsvfs_t *zfsvfs);
extern int zfs_check_global_label(const char *dsname, const char *hexsl);

extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs);
extern int zfs_domount(struct super_block *sb, zfs_mnt_t *zm, int silent);
extern void zfs_preumount(struct super_block *sb);
extern int zfs_umount(struct super_block *sb);
extern int zfs_remount(struct super_block *sb, int *flags, zfs_mnt_t *zm);
extern int zfs_statvfs(struct dentry *dentry, struct kstatfs *statp);
extern int zfs_vget(struct super_block *sb, struct inode **ipp, fid_t *fidp);
extern int zfs_prune(struct super_block *sb, unsigned long nr_to_scan,
    int *objects);

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_FS_ZFS_VFSOPS_H */
Commit	Line	Data
70e083d2 TG	1	/*
	2	* CDDL HEADER START
	3	*
	4	* The contents of this file are subject to the terms of the
	5	* Common Development and Distribution License (the "License").
	6	* You may not use this file except in compliance with the License.
	7	*
	8	* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
	9	* or http://www.opensolaris.org/os/licensing.
	10	* See the License for the specific language governing permissions
	11	* and limitations under the License.
	12	*
	13	* When distributing Covered Code, include this CDDL HEADER in each
	14	* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
	15	* If applicable, add the following below this CDDL HEADER, with the
	16	* fields enclosed by brackets "[]" replaced with your own identifying
	17	* information: Portions Copyright [yyyy] [name of copyright owner]
	18	*
	19	* CDDL HEADER END
	20	*/
	21	/*
	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
	23	*/
	24
	25	#ifndef _SYS_FS_ZFS_VFSOPS_H
	26	#define _SYS_FS_ZFS_VFSOPS_H
	27
	28	#include <sys/isa_defs.h>
	29	#include <sys/types32.h>
	30	#include <sys/list.h>
	31	#include <sys/vfs.h>
	32	#include <sys/zil.h>
	33	#include <sys/sa.h>
	34	#include <sys/rrwlock.h>
e0b2cca7	35	#include <sys/dsl_dataset.h>
70e083d2 TG	36	#include <sys/zfs_ioctl.h>
	37
	38	#ifdef __cplusplus
	39	extern "C" {
	40	#endif
	41
86e3c28a	42	typedef struct zfsvfs zfsvfs_t;
70e083d2 TG	43	struct znode;
70e083d2 TG	44
86e3c28a CIK	45	/*
	46	* This structure emulates the vfs_t from other platforms. It's purpose
	47	* is to faciliate the handling of mount options and minimize structural
	48	* differences between the platforms.
	49	*/
	50	typedef struct vfs {
	51	struct zfsvfs *vfs_data;
	52	char vfs_mntpoint; / Primary mount point */
	53	uint64_t vfs_xattr;
	54	boolean_t vfs_readonly;
	55	boolean_t vfs_do_readonly;
	56	boolean_t vfs_setuid;
	57	boolean_t vfs_do_setuid;
	58	boolean_t vfs_exec;
	59	boolean_t vfs_do_exec;
	60	boolean_t vfs_devices;
	61	boolean_t vfs_do_devices;
	62	boolean_t vfs_do_xattr;
	63	boolean_t vfs_atime;
	64	boolean_t vfs_do_atime;
	65	boolean_t vfs_relatime;
	66	boolean_t vfs_do_relatime;
	67	boolean_t vfs_nbmand;
	68	boolean_t vfs_do_nbmand;
	69	} vfs_t;
	70
	71	typedef struct zfs_mnt {
	72	const char mnt_osname; / Objset name */
	73	char mnt_data; / Raw mount options */
	74	} zfs_mnt_t;
	75
	76	struct zfsvfs {
	77	vfs_t z_vfs; / generic fs struct */
70e083d2	78	struct super_block z_sb; / generic super_block */
86e3c28a	79	struct zfsvfs z_parent; / parent fs */
70e083d2	80	objset_t z_os; / objset reference */
70e083d2 TG	81	uint64_t z_flags; /* super_block flags */
	82	uint64_t z_root; /* id of root znode */
	83	uint64_t z_unlinkedobj; /* id of unlinked zapobj */
	84	uint64_t z_max_blksz; /* maximum block size for files */
	85	uint64_t z_fuid_obj; /* fuid table object number */
	86	uint64_t z_fuid_size; /* fuid table size */
	87	avl_tree_t z_fuid_idx; /* fuid tree keyed by index */
	88	avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */
	89	krwlock_t z_fuid_lock; /* fuid lock */
	90	boolean_t z_fuid_loaded; /* fuid tables are loaded */
	91	boolean_t z_fuid_dirty; /* need to sync fuid table ? */
	92	struct zfs_fuid_info z_fuid_replay; / fuid info for replay */
	93	zilog_t z_log; / intent log pointer */
	94	uint_t z_acl_inherit; /* acl inheritance behavior */
	95	uint_t z_acl_type; /* type of ACL usable on this FS */
	96	zfs_case_t z_case; /* case-sense */
	97	boolean_t z_utf8; /* utf8-only */
	98	int z_norm; /* normalization flags */
	99	boolean_t z_atime; /* enable atimes mount option */
	100	boolean_t z_relatime; /* enable relatime mount option */
	101	boolean_t z_unmounted; /* unmounted */
	102	rrmlock_t z_teardown_lock;
	103	krwlock_t z_teardown_inactive_lock;
	104	list_t z_all_znodes; /* all znodes in the fs */
	105	uint64_t z_nr_znodes; /* number of znodes in the fs */
	106	unsigned long z_rollback_time; /* last online rollback time */
	107	unsigned long z_snap_defer_time; /* last snapshot unmount deferal */
	108	kmutex_t z_znodes_lock; /* lock for z_all_znodes */
	109	arc_prune_t z_arc_prune; / called by ARC to prune caches */
	110	struct inode z_ctldir; / .zfs directory inode */
	111	boolean_t z_show_ctldir; /* expose .zfs in the root dir */
	112	boolean_t z_issnap; /* true if this is a snapshot */
	113	boolean_t z_vscan; /* virus scan on/off */
	114	boolean_t z_use_fuids; /* version allows fuids */
	115	boolean_t z_replay; /* set during ZIL replay */
	116	boolean_t z_use_sa; /* version allow system attributes */
	117	boolean_t z_xattr_sa; /* allow xattrs to be stores as SA */
	118	uint64_t z_version; /* ZPL version */
	119	uint64_t z_shares_dir; /* hidden shares dir */
	120	kmutex_t z_lock;
	121	uint64_t z_userquota_obj;
	122	uint64_t z_groupquota_obj;
86e3c28a CIK	123	uint64_t z_userobjquota_obj;
86e3c28a CIK	124	uint64_t z_groupobjquota_obj;
70e083d2 TG	125	uint64_t z_replay_eof; /* New end of file - replay only */
	126	sa_attr_type_t z_attr_table; / SA attr mapping->id */
	127	uint64_t z_hold_size; /* znode hold array size */
	128	avl_tree_t z_hold_trees; / znode hold trees */
	129	kmutex_t z_hold_locks; / znode hold locks */
86e3c28a	130	};
70e083d2 TG	131
	132	#define ZSB_XATTR 0x0001 /* Enable user xattrs */
	133
	134	/*
	135	* Allow a maximum number of links. While ZFS does not internally limit
	136	* this the inode->i_nlink member is defined as an unsigned int. To be
	137	* safe we use 2^31-1 as the limit.
	138	*/
	139	#define ZFS_LINK_MAX ((1U << 31) - 1U)
	140
	141	/*
	142	* Normal filesystems (those not under .zfs/snapshot) have a total
	143	* file ID size limited to 12 bytes (including the length field) due to
	144	* NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
	145	* reasons, this same limit is being imposed by the Solaris NFSv3 implementation
	146	* (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
	147	* is not possible to expand beyond 12 bytes without abandoning support
	148	* of NFSv2.
	149	*
	150	* For normal filesystems, we partition up the available space as follows:
	151	* 2 bytes fid length (required)
	152	* 6 bytes object number (48 bits)
	153	* 4 bytes generation number (32 bits)
	154	*
	155	* We reserve only 48 bits for the object number, as this is the limit
	156	* currently defined and imposed by the DMU.
	157	*/
	158	typedef struct zfid_short {
	159	uint16_t zf_len;
	160	uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */
	161	uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */
	162	} zfid_short_t;
	163
	164	/*
	165	* Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
	166	* (including the length field). This makes files under .zfs/snapshot
	167	* accessible by NFSv3 and NFSv4, but not NFSv2.
	168	*
	169	* For files under .zfs/snapshot, we partition up the available space
	170	* as follows:
	171	* 2 bytes fid length (required)
	172	* 6 bytes object number (48 bits)
	173	* 4 bytes generation number (32 bits)
	174	* 6 bytes objset id (48 bits)
	175	* 4 bytes currently just zero (32 bits)
	176	*
	177	* We reserve only 48 bits for the object number and objset id, as these are
	178	* the limits currently defined and imposed by the DMU.
	179	*/
	180	typedef struct zfid_long {
	181	zfid_short_t z_fid;
	182	uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */
	183	uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */
	184	} zfid_long_t;
	185
	186	#define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
	187	#define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
	188
	189	extern uint_t zfs_fsyncer_key;
	190
86e3c28a CIK	191	extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
	192	extern int zfs_resume_fs(zfsvfs_t zfsvfs, struct dsl_dataset ds);
	193	extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
70e083d2	194	const char domain, uint64_t rid, uint64_t valuep);
86e3c28a	195	extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
70e083d2	196	uint64_t cookiep, void vbuf, uint64_t *bufsizep);
86e3c28a	197	extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
70e083d2	198	const char *domain, uint64_t rid, uint64_t quota);
86e3c28a	199	extern boolean_t zfs_owner_overquota(zfsvfs_t zfsvfs, struct znode ,
70e083d2	200	boolean_t isgroup);
86e3c28a	201	extern boolean_t zfs_fuid_overquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
70e083d2	202	uint64_t fuid);
86e3c28a CIK	203	extern boolean_t zfs_fuid_overobjquota(zfsvfs_t *zfsvfs, boolean_t isgroup,
	204	uint64_t fuid);
	205	extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
	206	extern int zfsvfs_create(const char name, zfsvfs_t *zfvp);
	207	extern void zfsvfs_free(zfsvfs_t *zfsvfs);
70e083d2	208	extern int zfs_check_global_label(const char dsname, const char hexsl);
70e083d2	209
86e3c28a CIK	210	extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs);
86e3c28a CIK	211	extern int zfs_domount(struct super_block sb, zfs_mnt_t zm, int silent);
70e083d2 TG	212	extern void zfs_preumount(struct super_block *sb);
70e083d2 TG	213	extern int zfs_umount(struct super_block *sb);
86e3c28a	214	extern int zfs_remount(struct super_block sb, int flags, zfs_mnt_t *zm);
70e083d2 TG	215	extern int zfs_statvfs(struct dentry dentry, struct kstatfs statp);
70e083d2 TG	216	extern int zfs_vget(struct super_block sb, struct inode ipp, fid_t fidp);
86e3c28a CIK	217	extern int zfs_prune(struct super_block *sb, unsigned long nr_to_scan,
86e3c28a CIK	218	int *objects);
70e083d2 TG	219
	220	#ifdef __cplusplus
	221	}
	222	#endif
	223
	224	#endif /* _SYS_FS_ZFS_VFSOPS_H */