[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_sb {
	struct vfsmount	*z_vfs;		/* generic vfs struct */
	struct super_block *z_sb;	/* generic super_block */
	struct zfs_sb	*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 */
	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_unmounted;	/* unmounted */
	rrwlock_t	z_teardown_lock;
	krwlock_t	z_teardown_inactive_lock;
	list_t		z_all_znodes;	/* all vnodes in the fs */
	kmutex_t	z_znodes_lock;	/* lock for z_all_znodes */
	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 */
	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_replay_eof;	/* New end of file - replay only */
	sa_attr_type_t	*z_attr_table;	/* SA attr mapping->id */
#define	ZFS_OBJ_MTX_SZ	64
	kmutex_t	z_hold_mtx[ZFS_OBJ_MTX_SZ];	/* znode hold locks */
} zfs_sb_t;

#define	ZFS_SUPER_MAGIC	0x2fc12fc1

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


/*
 * Minimal snapshot helpers, the bulk of the Linux snapshot implementation
 * lives in the zpl_snap.c file which is part of the zpl source.
 */
#define	ZFS_CTLDIR_NAME		".zfs"

#define	zfs_has_ctldir(zdp)	\
	((zdp)->z_id == ZTOZSB(zdp)->z_root && \
	(ZTOZSB(zdp)->z_ctldir != NULL))
#define	zfs_show_ctldir(zdp)	\
	(zfs_has_ctldir(zdp) &&	\
	(ZTOZSB(zdp)->z_show_ctldir))

#define	ZFSCTL_INO_ROOT		0x1
#define	ZFSCTL_INO_SNAPDIR	0x2
#define	ZFSCTL_INO_SHARES	0x3

/*
 * Allow a maximum number of links.  While ZFS does not internally limit
 * this most Linux filesystems do.  It's probably a good idea to limit
 * this to a large value until it is validated that this is safe.
 */
#define ZFS_LINK_MAX		65536

/*
 * 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 int zfs_set_version(zfs_sb_t *zsb, uint64_t newvers);
extern int zfs_sb_create(const char *name, zfs_sb_t **zsbp);
extern void zfs_sb_free(zfs_sb_t *zsb);
extern int zfs_check_global_label(const char *dsname, const char *hexsl);

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, void *data, int silent);
extern int zfs_umount(struct super_block *sb);
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 vfsmount *vfsp, 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
3558fd73 BB	44	typedef struct zfs_sb {
	45	struct vfsmount z_vfs; / generic vfs struct */
	46	struct super_block z_sb; / generic super_block */
	47	struct zfs_sb z_parent; / parent fs */
34dc7c2f	48	objset_t z_os; / objset reference */
3558fd73	49	uint64_t z_flags; /* super_block flags */
34dc7c2f BB	50	uint64_t z_root; /* id of root znode */
	51	uint64_t z_unlinkedobj; /* id of unlinked zapobj */
	52	uint64_t z_max_blksz; /* maximum block size for files */
34dc7c2f BB	53	uint64_t z_fuid_obj; /* fuid table object number */
	54	uint64_t z_fuid_size; /* fuid table size */
	55	avl_tree_t z_fuid_idx; /* fuid tree keyed by index */
	56	avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */
	57	krwlock_t z_fuid_lock; /* fuid lock */
	58	boolean_t z_fuid_loaded; /* fuid tables are loaded */
9babb374	59	boolean_t z_fuid_dirty; /* need to sync fuid table ? */
34dc7c2f BB	60	struct zfs_fuid_info z_fuid_replay; / fuid info for replay */
34dc7c2f BB	61	zilog_t z_log; / intent log pointer */
34dc7c2f BB	62	uint_t z_acl_inherit; /* acl inheritance behavior */
	63	zfs_case_t z_case; /* case-sense */
	64	boolean_t z_utf8; /* utf8-only */
	65	int z_norm; /* normalization flags */
	66	boolean_t z_atime; /* enable atimes mount option */
	67	boolean_t z_unmounted; /* unmounted */
	68	rrwlock_t z_teardown_lock;
	69	krwlock_t z_teardown_inactive_lock;
	70	list_t z_all_znodes; /* all vnodes in the fs */
	71	kmutex_t z_znodes_lock; /* lock for z_all_znodes */
bcf30822	72	struct inode z_ctldir; / .zfs directory inode */
34dc7c2f BB	73	boolean_t z_show_ctldir; /* expose .zfs in the root dir */
	74	boolean_t z_issnap; /* true if this is a snapshot */
	75	boolean_t z_vscan; /* virus scan on/off */
	76	boolean_t z_use_fuids; /* version allows fuids */
fb5f0bc8	77	boolean_t z_replay; /* set during ZIL replay */
428870ff	78	boolean_t z_use_sa; /* version allow system attributes */
34dc7c2f	79	uint64_t z_version; /* ZPL version */
9babb374 BB	80	uint64_t z_shares_dir; /* hidden shares dir */
	81	kmutex_t z_lock;
	82	uint64_t z_userquota_obj;
	83	uint64_t z_groupquota_obj;
572e2857	84	uint64_t z_replay_eof; /* New end of file - replay only */
428870ff	85	sa_attr_type_t z_attr_table; / SA attr mapping->id */
34dc7c2f BB	86	#define ZFS_OBJ_MTX_SZ 64
34dc7c2f BB	87	kmutex_t z_hold_mtx[ZFS_OBJ_MTX_SZ]; /* znode hold locks */
bcf30822 BB	88	} zfs_sb_t;
	89
	90	#define ZFS_SUPER_MAGIC 0x2fc12fc1
	91
3558fd73 BB	92	#define ZSB_XATTR_USER 0x0001 /* Enable user xattrs */
3558fd73 BB	93
bcf30822 BB	94
	95	/*
	96	* Minimal snapshot helpers, the bulk of the Linux snapshot implementation
	97	* lives in the zpl_snap.c file which is part of the zpl source.
	98	*/
	99	#define ZFS_CTLDIR_NAME ".zfs"
	100
	101	#define zfs_has_ctldir(zdp) \
	102	((zdp)->z_id == ZTOZSB(zdp)->z_root && \
	103	(ZTOZSB(zdp)->z_ctldir != NULL))
	104	#define zfs_show_ctldir(zdp) \
	105	(zfs_has_ctldir(zdp) && \
	106	(ZTOZSB(zdp)->z_show_ctldir))
	107
	108	#define ZFSCTL_INO_ROOT 0x1
	109	#define ZFSCTL_INO_SNAPDIR 0x2
	110	#define ZFSCTL_INO_SHARES 0x3
	111
	112	/*
	113	* Allow a maximum number of links. While ZFS does not internally limit
	114	* this most Linux filesystems do. It's probably a good idea to limit
	115	* this to a large value until it is validated that this is safe.
	116	*/
	117	#define ZFS_LINK_MAX 65536
34dc7c2f BB	118
	119	/*
	120	* Normal filesystems (those not under .zfs/snapshot) have a total
	121	* file ID size limited to 12 bytes (including the length field) due to
	122	* NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
	123	* reasons, this same limit is being imposed by the Solaris NFSv3 implementation
	124	* (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
	125	* is not possible to expand beyond 12 bytes without abandoning support
	126	* of NFSv2.
	127	*
	128	* For normal filesystems, we partition up the available space as follows:
	129	* 2 bytes fid length (required)
	130	* 6 bytes object number (48 bits)
	131	* 4 bytes generation number (32 bits)
	132	*
	133	* We reserve only 48 bits for the object number, as this is the limit
	134	* currently defined and imposed by the DMU.
	135	*/
	136	typedef struct zfid_short {
	137	uint16_t zf_len;
	138	uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */
	139	uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */
	140	} zfid_short_t;
	141
	142	/*
	143	* Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
	144	* (including the length field). This makes files under .zfs/snapshot
	145	* accessible by NFSv3 and NFSv4, but not NFSv2.
	146	*
	147	* For files under .zfs/snapshot, we partition up the available space
	148	* as follows:
	149	* 2 bytes fid length (required)
	150	* 6 bytes object number (48 bits)
	151	* 4 bytes generation number (32 bits)
	152	* 6 bytes objset id (48 bits)
	153	* 4 bytes currently just zero (32 bits)
	154	*
	155	* We reserve only 48 bits for the object number and objset id, as these are
	156	* the limits currently defined and imposed by the DMU.
	157	*/
	158	typedef struct zfid_long {
	159	zfid_short_t z_fid;
	160	uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */
	161	uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */
	162	} zfid_long_t;
	163
	164	#define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
	165	#define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
	166
	167	extern uint_t zfs_fsyncer_key;
	168
3558fd73 BB	169	extern int zfs_suspend_fs(zfs_sb_t *zsb);
	170	extern int zfs_resume_fs(zfs_sb_t zsb, const char osname);
	171	extern int zfs_userspace_one(zfs_sb_t *zsb, zfs_userquota_prop_t type,
9babb374	172	const char domain, uint64_t rid, uint64_t valuep);
3558fd73	173	extern int zfs_userspace_many(zfs_sb_t *zsb, zfs_userquota_prop_t type,
9babb374	174	uint64_t cookiep, void vbuf, uint64_t *bufsizep);
3558fd73	175	extern int zfs_set_userquota(zfs_sb_t *zsb, zfs_userquota_prop_t type,
9babb374	176	const char *domain, uint64_t rid, uint64_t quota);
3558fd73	177	extern boolean_t zfs_owner_overquota(zfs_sb_t zsb, struct znode ,
428870ff	178	boolean_t isgroup);
3558fd73	179	extern boolean_t zfs_fuid_overquota(zfs_sb_t *zsb, boolean_t isgroup,
428870ff	180	uint64_t fuid);
3558fd73 BB	181	extern int zfs_set_version(zfs_sb_t *zsb, uint64_t newvers);
	182	extern int zfs_sb_create(const char name, zfs_sb_t *zsbp);
	183	extern void zfs_sb_free(zfs_sb_t *zsb);
428870ff	184	extern int zfs_check_global_label(const char dsname, const char hexsl);
34dc7c2f	185
3558fd73 BB	186	extern int zfs_register_callbacks(zfs_sb_t *zsb);
	187	extern void zfs_unregister_callbacks(zfs_sb_t *zsb);
	188	extern int zfs_domount(struct super_block sb, void data, int silent);
	189	extern int zfs_umount(struct super_block *sb);
	190	extern int zfs_root(zfs_sb_t zsb, struct inode *ipp);
	191	extern int zfs_statvfs(struct dentry dentry, struct kstatfs statp);
	192	extern int zfs_vget(struct vfsmount vfsp, struct inode ipp, fid_t fidp);
e5c39b95	193
34dc7c2f BB	194	#ifdef __cplusplus
	195	}
	196	#endif
	197
	198	#endif /* _SYS_FS_ZFS_VFSOPS_H */