[mirror_zfs.git] / 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/zfs_ioctl.h>

#ifdef	__cplusplus
extern "C" {
#endif

struct zfs_sb;
struct znode;

typedef struct zfs_mntopts {
	char		*z_osname;	/* Objset name */
	char		*z_mntpoint;	/* Primary mount point */
	uint64_t	z_xattr;
	boolean_t	z_readonly;
	boolean_t	z_do_readonly;
	boolean_t	z_setuid;
	boolean_t	z_do_setuid;
	boolean_t	z_exec;
	boolean_t	z_do_exec;
	boolean_t	z_devices;
	boolean_t	z_do_devices;
	boolean_t	z_do_xattr;
	boolean_t	z_atime;
	boolean_t	z_do_atime;
	boolean_t	z_relatime;
	boolean_t	z_do_relatime;
	boolean_t	z_nbmand;
	boolean_t	z_do_nbmand;
} zfs_mntopts_t;

typedef struct zfs_sb {
	struct super_block *z_sb;	/* generic super_block */
	struct backing_dev_info z_bdi;	/* generic backing dev info */
	struct zfs_sb	*z_parent;	/* parent fs */
	objset_t	*z_os;		/* objset reference */
	zfs_mntopts_t	*z_mntopts;	/* passed mount options */
	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 */
} zfs_sb_t;

#define	ZFS_SUPER_MAGIC	0x2fc12fc1

#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(zfs_sb_t *zsb);
extern int zfs_resume_fs(zfs_sb_t *zsb, const char *osname);
extern int zfs_userspace_one(zfs_sb_t *zsb, zfs_userquota_prop_t type,
    const char *domain, uint64_t rid, uint64_t *valuep);
extern int zfs_userspace_many(zfs_sb_t *zsb, zfs_userquota_prop_t type,
    uint64_t *cookiep, void *vbuf, uint64_t *bufsizep);
extern int zfs_set_userquota(zfs_sb_t *zsb, zfs_userquota_prop_t type,
    const char *domain, uint64_t rid, uint64_t quota);
extern boolean_t zfs_owner_overquota(zfs_sb_t *zsb, struct znode *,
    boolean_t isgroup);
extern boolean_t zfs_fuid_overquota(zfs_sb_t *zsb, boolean_t isgroup,
    uint64_t fuid);
extern boolean_t zfs_fuid_overobjquota(zfs_sb_t *zsb, boolean_t isgroup,
    uint64_t fuid);
extern int zfs_set_version(zfs_sb_t *zsb, uint64_t newvers);
extern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop,
    uint64_t *value);
extern zfs_mntopts_t *zfs_mntopts_alloc(void);
extern void zfs_mntopts_free(zfs_mntopts_t *zmo);
extern int zfs_sb_create(const char *name, zfs_mntopts_t *zmo,
    zfs_sb_t **zsbp);
extern int zfs_sb_setup(zfs_sb_t *zsb, boolean_t mounting);
extern void zfs_sb_free(zfs_sb_t *zsb);
extern int zfs_sb_prune(struct super_block *sb, unsigned long nr_to_scan,
    int *objects);
extern int zfs_sb_teardown(zfs_sb_t *zsb, boolean_t unmounting);
extern int zfs_check_global_label(const char *dsname, const char *hexsl);
extern boolean_t zfs_is_readonly(zfs_sb_t *zsb);

extern int zfs_register_callbacks(zfs_sb_t *zsb);
extern void zfs_unregister_callbacks(zfs_sb_t *zsb);
extern int zfs_domount(struct super_block *sb, zfs_mntopts_t *zmo, 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_mntopts_t *zmo);
extern int zfs_root(zfs_sb_t *zsb, struct inode **ipp);
extern int zfs_statvfs(struct dentry *dentry, struct kstatfs *statp);
extern int zfs_vget(struct super_block *sb, struct inode **ipp, fid_t *fidp);

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_FS_ZFS_VFSOPS_H */
Commit	Line	Data
34dc7c2f BB	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	/*
428870ff	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
34dc7c2f BB	23	*/
	24
	25	#ifndef _SYS_FS_ZFS_VFSOPS_H
	26	#define _SYS_FS_ZFS_VFSOPS_H
	27
34dc7c2f BB	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>
428870ff	33	#include <sys/sa.h>
34dc7c2f BB	34	#include <sys/rrwlock.h>
	35	#include <sys/zfs_ioctl.h>
	36
	37	#ifdef __cplusplus
	38	extern "C" {
	39	#endif
	40
3558fd73	41	struct zfs_sb;
428870ff	42	struct znode;
34dc7c2f	43
0282c413 BB	44	typedef struct zfs_mntopts {
	45	char z_osname; / Objset name */
	46	char z_mntpoint; / Primary mount point */
3af56fd9	47	uint64_t z_xattr;
0282c413 BB	48	boolean_t z_readonly;
	49	boolean_t z_do_readonly;
	50	boolean_t z_setuid;
	51	boolean_t z_do_setuid;
	52	boolean_t z_exec;
	53	boolean_t z_do_exec;
	54	boolean_t z_devices;
	55	boolean_t z_do_devices;
0282c413 BB	56	boolean_t z_do_xattr;
	57	boolean_t z_atime;
	58	boolean_t z_do_atime;
	59	boolean_t z_relatime;
	60	boolean_t z_do_relatime;
	61	boolean_t z_nbmand;
	62	boolean_t z_do_nbmand;
	63	} zfs_mntopts_t;
	64
3558fd73	65	typedef struct zfs_sb {
3558fd73	66	struct super_block z_sb; / generic super_block */
76659dc1	67	struct backing_dev_info z_bdi; /* generic backing dev info */
3558fd73	68	struct zfs_sb z_parent; / parent fs */
34dc7c2f	69	objset_t z_os; / objset reference */
0282c413	70	zfs_mntopts_t z_mntopts; / passed mount options */
3558fd73	71	uint64_t z_flags; /* super_block flags */
34dc7c2f BB	72	uint64_t z_root; /* id of root znode */
	73	uint64_t z_unlinkedobj; /* id of unlinked zapobj */
	74	uint64_t z_max_blksz; /* maximum block size for files */
34dc7c2f BB	75	uint64_t z_fuid_obj; /* fuid table object number */
	76	uint64_t z_fuid_size; /* fuid table size */
	77	avl_tree_t z_fuid_idx; /* fuid tree keyed by index */
	78	avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */
	79	krwlock_t z_fuid_lock; /* fuid lock */
	80	boolean_t z_fuid_loaded; /* fuid tables are loaded */
9babb374	81	boolean_t z_fuid_dirty; /* need to sync fuid table ? */
34dc7c2f BB	82	struct zfs_fuid_info z_fuid_replay; / fuid info for replay */
34dc7c2f BB	83	zilog_t z_log; / intent log pointer */
34dc7c2f	84	uint_t z_acl_inherit; /* acl inheritance behavior */
023699cd	85	uint_t z_acl_type; /* type of ACL usable on this FS */
34dc7c2f BB	86	zfs_case_t z_case; /* case-sense */
	87	boolean_t z_utf8; /* utf8-only */
	88	int z_norm; /* normalization flags */
	89	boolean_t z_atime; /* enable atimes mount option */
6d111134	90	boolean_t z_relatime; /* enable relatime mount option */
34dc7c2f	91	boolean_t z_unmounted; /* unmounted */
e16b3fcc	92	rrmlock_t z_teardown_lock;
34dc7c2f	93	krwlock_t z_teardown_inactive_lock;
ab26409d BB	94	list_t z_all_znodes; /* all znodes in the fs */
ab26409d BB	95	uint64_t z_nr_znodes; /* number of znodes in the fs */
d1d7e268	96	unsigned long z_rollback_time; /* last online rollback time */
278bee93	97	unsigned long z_snap_defer_time; /* last snapshot unmount deferal */
34dc7c2f	98	kmutex_t z_znodes_lock; /* lock for z_all_znodes */
2cbb06b5	99	arc_prune_t z_arc_prune; / called by ARC to prune caches */
bcf30822	100	struct inode z_ctldir; / .zfs directory inode */
34dc7c2f BB	101	boolean_t z_show_ctldir; /* expose .zfs in the root dir */
	102	boolean_t z_issnap; /* true if this is a snapshot */
	103	boolean_t z_vscan; /* virus scan on/off */
	104	boolean_t z_use_fuids; /* version allows fuids */
fb5f0bc8	105	boolean_t z_replay; /* set during ZIL replay */
428870ff	106	boolean_t z_use_sa; /* version allow system attributes */
82a37189	107	boolean_t z_xattr_sa; /* allow xattrs to be stores as SA */
34dc7c2f	108	uint64_t z_version; /* ZPL version */
9babb374 BB	109	uint64_t z_shares_dir; /* hidden shares dir */
	110	kmutex_t z_lock;
	111	uint64_t z_userquota_obj;
	112	uint64_t z_groupquota_obj;
1de321e6 JX	113	uint64_t z_userobjquota_obj;
1de321e6 JX	114	uint64_t z_groupobjquota_obj;
572e2857	115	uint64_t z_replay_eof; /* New end of file - replay only */
428870ff	116	sa_attr_type_t z_attr_table; / SA attr mapping->id */
c96c36fa BB	117	uint64_t z_hold_size; /* znode hold array size */
	118	avl_tree_t z_hold_trees; / znode hold trees */
	119	kmutex_t z_hold_locks; / znode hold locks */
bcf30822 BB	120	} zfs_sb_t;
	121
	122	#define ZFS_SUPER_MAGIC 0x2fc12fc1
	123
2cf7f52b	124	#define ZSB_XATTR 0x0001 /* Enable user xattrs */
3558fd73	125
bcf30822 BB	126	/*
bcf30822 BB	127	* Allow a maximum number of links. While ZFS does not internally limit
a8783adf BB	128	* this the inode->i_nlink member is defined as an unsigned int. To be
a8783adf BB	129	* safe we use 2^31-1 as the limit.
bcf30822	130	*/
d1d7e268	131	#define ZFS_LINK_MAX ((1U << 31) - 1U)
34dc7c2f BB	132
	133	/*
	134	* Normal filesystems (those not under .zfs/snapshot) have a total
	135	* file ID size limited to 12 bytes (including the length field) due to
	136	* NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
	137	* reasons, this same limit is being imposed by the Solaris NFSv3 implementation
	138	* (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
	139	* is not possible to expand beyond 12 bytes without abandoning support
	140	* of NFSv2.
	141	*
	142	* For normal filesystems, we partition up the available space as follows:
	143	* 2 bytes fid length (required)
	144	* 6 bytes object number (48 bits)
	145	* 4 bytes generation number (32 bits)
	146	*
	147	* We reserve only 48 bits for the object number, as this is the limit
	148	* currently defined and imposed by the DMU.
	149	*/
	150	typedef struct zfid_short {
	151	uint16_t zf_len;
	152	uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */
	153	uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */
	154	} zfid_short_t;
	155
	156	/*
	157	* Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
	158	* (including the length field). This makes files under .zfs/snapshot
	159	* accessible by NFSv3 and NFSv4, but not NFSv2.
	160	*
	161	* For files under .zfs/snapshot, we partition up the available space
	162	* as follows:
	163	* 2 bytes fid length (required)
	164	* 6 bytes object number (48 bits)
	165	* 4 bytes generation number (32 bits)
	166	* 6 bytes objset id (48 bits)
	167	* 4 bytes currently just zero (32 bits)
	168	*
	169	* We reserve only 48 bits for the object number and objset id, as these are
	170	* the limits currently defined and imposed by the DMU.
	171	*/
	172	typedef struct zfid_long {
	173	zfid_short_t z_fid;
	174	uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */
	175	uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */
	176	} zfid_long_t;
	177
	178	#define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
	179	#define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
	180
d5446cfc BB	181	extern uint_t zfs_fsyncer_key;
d5446cfc BB	182
3558fd73 BB	183	extern int zfs_suspend_fs(zfs_sb_t *zsb);
	184	extern int zfs_resume_fs(zfs_sb_t zsb, const char osname);
	185	extern int zfs_userspace_one(zfs_sb_t *zsb, zfs_userquota_prop_t type,
9babb374	186	const char domain, uint64_t rid, uint64_t valuep);
3558fd73	187	extern int zfs_userspace_many(zfs_sb_t *zsb, zfs_userquota_prop_t type,
9babb374	188	uint64_t cookiep, void vbuf, uint64_t *bufsizep);
3558fd73	189	extern int zfs_set_userquota(zfs_sb_t *zsb, zfs_userquota_prop_t type,
9babb374	190	const char *domain, uint64_t rid, uint64_t quota);
3558fd73	191	extern boolean_t zfs_owner_overquota(zfs_sb_t zsb, struct znode ,
428870ff	192	boolean_t isgroup);
3558fd73	193	extern boolean_t zfs_fuid_overquota(zfs_sb_t *zsb, boolean_t isgroup,
428870ff	194	uint64_t fuid);
1de321e6 JX	195	extern boolean_t zfs_fuid_overobjquota(zfs_sb_t *zsb, boolean_t isgroup,
1de321e6 JX	196	uint64_t fuid);
3558fd73	197	extern int zfs_set_version(zfs_sb_t *zsb, uint64_t newvers);
86f35f34 BB	198	extern int zfs_get_zplprop(objset_t *os, zfs_prop_t prop,
86f35f34 BB	199	uint64_t *value);
0282c413 BB	200	extern zfs_mntopts_t *zfs_mntopts_alloc(void);
	201	extern void zfs_mntopts_free(zfs_mntopts_t *zmo);
	202	extern int zfs_sb_create(const char name, zfs_mntopts_t zmo,
	203	zfs_sb_t **zsbp);
86f35f34	204	extern int zfs_sb_setup(zfs_sb_t *zsb, boolean_t mounting);
3558fd73	205	extern void zfs_sb_free(zfs_sb_t *zsb);
ab26409d BB	206	extern int zfs_sb_prune(struct super_block *sb, unsigned long nr_to_scan,
ab26409d BB	207	int *objects);
86f35f34	208	extern int zfs_sb_teardown(zfs_sb_t *zsb, boolean_t unmounting);
428870ff	209	extern int zfs_check_global_label(const char dsname, const char hexsl);
2cf7f52b	210	extern boolean_t zfs_is_readonly(zfs_sb_t *zsb);
34dc7c2f	211
3558fd73 BB	212	extern int zfs_register_callbacks(zfs_sb_t *zsb);
3558fd73 BB	213	extern void zfs_unregister_callbacks(zfs_sb_t *zsb);
0282c413	214	extern int zfs_domount(struct super_block sb, zfs_mntopts_t zmo, int silent);
ebe7e575	215	extern void zfs_preumount(struct super_block *sb);
3558fd73	216	extern int zfs_umount(struct super_block *sb);
0282c413	217	extern int zfs_remount(struct super_block sb, int flags, zfs_mntopts_t *zmo);
3558fd73 BB	218	extern int zfs_root(zfs_sb_t zsb, struct inode *ipp);
3558fd73 BB	219	extern int zfs_statvfs(struct dentry dentry, struct kstatfs statp);
2cf7f52b	220	extern int zfs_vget(struct super_block sb, struct inode ipp, fid_t fidp);
e5c39b95	221
34dc7c2f BB	222	#ifdef __cplusplus
	223	}
	224	#endif
	225
	226	#endif /* _SYS_FS_ZFS_VFSOPS_H */