[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.
 * Copyright (c) 2013, 2018 by Delphix. All rights reserved.
 */

#ifndef	_SYS_FS_ZFS_VFSOPS_H
#define	_SYS_FS_ZFS_VFSOPS_H

#include <sys/dataset_kstats.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 */
	boolean_t	z_draining;	/* is true when drain is active */
	boolean_t	z_drain_cancel; /* signal the unlinked drain to stop */
	uint64_t	z_version;	/* ZPL version */
	uint64_t	z_shares_dir;	/* hidden shares dir */
	dataset_kstats_t	z_kstat;	/* fs kstats */
	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_projectquota_obj;
	uint64_t	z_projectobjquota_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 */
	taskqid_t	z_drain_task;	/* task id for the unlink drain task */
};

#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_id_overblockquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
    uint64_t id);
extern boolean_t zfs_id_overobjquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
    uint64_t id);
extern boolean_t zfs_id_overquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
    uint64_t id);
extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
extern int zfsvfs_create(const char *name, boolean_t readony, zfsvfs_t **zfvp);
extern int zfsvfs_create_impl(zfsvfs_t **zfvp, zfsvfs_t *zfsvfs, objset_t *os);
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
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.
a448a255	23	* Copyright (c) 2013, 2018 by Delphix. All rights reserved.
34dc7c2f BB	24	*/
	25
	26	#ifndef _SYS_FS_ZFS_VFSOPS_H
	27	#define _SYS_FS_ZFS_VFSOPS_H
	28
a448a255	29	#include <sys/dataset_kstats.h>
34dc7c2f BB	30	#include <sys/isa_defs.h>
	31	#include <sys/types32.h>
	32	#include <sys/list.h>
	33	#include <sys/vfs.h>
	34	#include <sys/zil.h>
428870ff	35	#include <sys/sa.h>
34dc7c2f	36	#include <sys/rrwlock.h>
ac09630d	37	#include <sys/dsl_dataset.h>
34dc7c2f BB	38	#include <sys/zfs_ioctl.h>
	39
	40	#ifdef __cplusplus
	41	extern "C" {
	42	#endif
	43
0037b49e	44	typedef struct zfsvfs zfsvfs_t;
428870ff	45	struct znode;
34dc7c2f	46
1c2555ef BB	47	/*
	48	* This structure emulates the vfs_t from other platforms. It's purpose
	49	* is to faciliate the handling of mount options and minimize structural
	50	* differences between the platforms.
	51	*/
	52	typedef struct vfs {
	53	struct zfsvfs *vfs_data;
	54	char vfs_mntpoint; / Primary mount point */
	55	uint64_t vfs_xattr;
	56	boolean_t vfs_readonly;
	57	boolean_t vfs_do_readonly;
	58	boolean_t vfs_setuid;
	59	boolean_t vfs_do_setuid;
	60	boolean_t vfs_exec;
	61	boolean_t vfs_do_exec;
	62	boolean_t vfs_devices;
	63	boolean_t vfs_do_devices;
	64	boolean_t vfs_do_xattr;
	65	boolean_t vfs_atime;
	66	boolean_t vfs_do_atime;
	67	boolean_t vfs_relatime;
	68	boolean_t vfs_do_relatime;
	69	boolean_t vfs_nbmand;
	70	boolean_t vfs_do_nbmand;
	71	} vfs_t;
	72
	73	typedef struct zfs_mnt {
	74	const char mnt_osname; / Objset name */
	75	char mnt_data; / Raw mount options */
	76	} zfs_mnt_t;
0282c413	77
0037b49e	78	struct zfsvfs {
1c2555ef	79	vfs_t z_vfs; / generic fs struct */
3558fd73	80	struct super_block z_sb; / generic super_block */
0037b49e	81	struct zfsvfs z_parent; / parent fs */
34dc7c2f	82	objset_t z_os; / objset reference */
3558fd73	83	uint64_t z_flags; /* super_block flags */
34dc7c2f BB	84	uint64_t z_root; /* id of root znode */
	85	uint64_t z_unlinkedobj; /* id of unlinked zapobj */
	86	uint64_t z_max_blksz; /* maximum block size for files */
34dc7c2f BB	87	uint64_t z_fuid_obj; /* fuid table object number */
	88	uint64_t z_fuid_size; /* fuid table size */
	89	avl_tree_t z_fuid_idx; /* fuid tree keyed by index */
	90	avl_tree_t z_fuid_domain; /* fuid tree keyed by domain */
	91	krwlock_t z_fuid_lock; /* fuid lock */
	92	boolean_t z_fuid_loaded; /* fuid tables are loaded */
9babb374	93	boolean_t z_fuid_dirty; /* need to sync fuid table ? */
34dc7c2f BB	94	struct zfs_fuid_info z_fuid_replay; / fuid info for replay */
34dc7c2f BB	95	zilog_t z_log; / intent log pointer */
34dc7c2f	96	uint_t z_acl_inherit; /* acl inheritance behavior */
023699cd	97	uint_t z_acl_type; /* type of ACL usable on this FS */
34dc7c2f BB	98	zfs_case_t z_case; /* case-sense */
	99	boolean_t z_utf8; /* utf8-only */
	100	int z_norm; /* normalization flags */
	101	boolean_t z_atime; /* enable atimes mount option */
6d111134	102	boolean_t z_relatime; /* enable relatime mount option */
34dc7c2f	103	boolean_t z_unmounted; /* unmounted */
e16b3fcc	104	rrmlock_t z_teardown_lock;
34dc7c2f	105	krwlock_t z_teardown_inactive_lock;
ab26409d BB	106	list_t z_all_znodes; /* all znodes in the fs */
ab26409d BB	107	uint64_t z_nr_znodes; /* number of znodes in the fs */
d1d7e268	108	unsigned long z_rollback_time; /* last online rollback time */
278bee93	109	unsigned long z_snap_defer_time; /* last snapshot unmount deferal */
34dc7c2f	110	kmutex_t z_znodes_lock; /* lock for z_all_znodes */
2cbb06b5	111	arc_prune_t z_arc_prune; / called by ARC to prune caches */
bcf30822	112	struct inode z_ctldir; / .zfs directory inode */
34dc7c2f BB	113	boolean_t z_show_ctldir; /* expose .zfs in the root dir */
	114	boolean_t z_issnap; /* true if this is a snapshot */
	115	boolean_t z_vscan; /* virus scan on/off */
	116	boolean_t z_use_fuids; /* version allows fuids */
fb5f0bc8	117	boolean_t z_replay; /* set during ZIL replay */
428870ff	118	boolean_t z_use_sa; /* version allow system attributes */
82a37189	119	boolean_t z_xattr_sa; /* allow xattrs to be stores as SA */
dcec0a12 AP	120	boolean_t z_draining; /* is true when drain is active */
dcec0a12 AP	121	boolean_t z_drain_cancel; /* signal the unlinked drain to stop */
34dc7c2f	122	uint64_t z_version; /* ZPL version */
9babb374	123	uint64_t z_shares_dir; /* hidden shares dir */
a448a255	124	dataset_kstats_t z_kstat; /* fs kstats */
9babb374 BB	125	kmutex_t z_lock;
	126	uint64_t z_userquota_obj;
	127	uint64_t z_groupquota_obj;
1de321e6 JX	128	uint64_t z_userobjquota_obj;
1de321e6 JX	129	uint64_t z_groupobjquota_obj;
9c5167d1 NF	130	uint64_t z_projectquota_obj;
9c5167d1 NF	131	uint64_t z_projectobjquota_obj;
572e2857	132	uint64_t z_replay_eof; /* New end of file - replay only */
428870ff	133	sa_attr_type_t z_attr_table; / SA attr mapping->id */
c96c36fa BB	134	uint64_t z_hold_size; /* znode hold array size */
	135	avl_tree_t z_hold_trees; / znode hold trees */
	136	kmutex_t z_hold_locks; / znode hold locks */
dcec0a12	137	taskqid_t z_drain_task; /* task id for the unlink drain task */
0037b49e	138	};
bcf30822	139
2cf7f52b	140	#define ZSB_XATTR 0x0001 /* Enable user xattrs */
3558fd73	141
bcf30822 BB	142	/*
bcf30822 BB	143	* Allow a maximum number of links. While ZFS does not internally limit
a8783adf BB	144	* this the inode->i_nlink member is defined as an unsigned int. To be
a8783adf BB	145	* safe we use 2^31-1 as the limit.
bcf30822	146	*/
d1d7e268	147	#define ZFS_LINK_MAX ((1U << 31) - 1U)
34dc7c2f BB	148
	149	/*
	150	* Normal filesystems (those not under .zfs/snapshot) have a total
	151	* file ID size limited to 12 bytes (including the length field) due to
	152	* NFSv2 protocol's limitation of 32 bytes for a filehandle. For historical
	153	* reasons, this same limit is being imposed by the Solaris NFSv3 implementation
	154	* (although the NFSv3 protocol actually permits a maximum of 64 bytes). It
	155	* is not possible to expand beyond 12 bytes without abandoning support
	156	* of NFSv2.
	157	*
	158	* For normal filesystems, we partition up the available space as follows:
	159	* 2 bytes fid length (required)
	160	* 6 bytes object number (48 bits)
	161	* 4 bytes generation number (32 bits)
	162	*
	163	* We reserve only 48 bits for the object number, as this is the limit
	164	* currently defined and imposed by the DMU.
	165	*/
	166	typedef struct zfid_short {
	167	uint16_t zf_len;
	168	uint8_t zf_object[6]; /* obj[i] = obj >> (8 * i) */
	169	uint8_t zf_gen[4]; /* gen[i] = gen >> (8 * i) */
	170	} zfid_short_t;
	171
	172	/*
	173	* Filesystems under .zfs/snapshot have a total file ID size of 22 bytes
	174	* (including the length field). This makes files under .zfs/snapshot
	175	* accessible by NFSv3 and NFSv4, but not NFSv2.
	176	*
	177	* For files under .zfs/snapshot, we partition up the available space
	178	* as follows:
	179	* 2 bytes fid length (required)
	180	* 6 bytes object number (48 bits)
	181	* 4 bytes generation number (32 bits)
	182	* 6 bytes objset id (48 bits)
	183	* 4 bytes currently just zero (32 bits)
	184	*
	185	* We reserve only 48 bits for the object number and objset id, as these are
	186	* the limits currently defined and imposed by the DMU.
	187	*/
	188	typedef struct zfid_long {
	189	zfid_short_t z_fid;
	190	uint8_t zf_setid[6]; /* obj[i] = obj >> (8 * i) */
	191	uint8_t zf_setgen[4]; /* gen[i] = gen >> (8 * i) */
	192	} zfid_long_t;
	193
	194	#define SHORT_FID_LEN (sizeof (zfid_short_t) - sizeof (uint16_t))
	195	#define LONG_FID_LEN (sizeof (zfid_long_t) - sizeof (uint16_t))
	196
d5446cfc BB	197	extern uint_t zfs_fsyncer_key;
d5446cfc BB	198
0037b49e BB	199	extern int zfs_suspend_fs(zfsvfs_t *zfsvfs);
	200	extern int zfs_resume_fs(zfsvfs_t zfsvfs, struct dsl_dataset ds);
	201	extern int zfs_userspace_one(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
9babb374	202	const char domain, uint64_t rid, uint64_t valuep);
0037b49e	203	extern int zfs_userspace_many(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
9babb374	204	uint64_t cookiep, void vbuf, uint64_t *bufsizep);
0037b49e	205	extern int zfs_set_userquota(zfsvfs_t *zfsvfs, zfs_userquota_prop_t type,
9babb374	206	const char *domain, uint64_t rid, uint64_t quota);
9c5167d1 NF	207	extern boolean_t zfs_id_overblockquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
	208	uint64_t id);
	209	extern boolean_t zfs_id_overobjquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
	210	uint64_t id);
	211	extern boolean_t zfs_id_overquota(zfsvfs_t *zfsvfs, uint64_t usedobj,
	212	uint64_t id);
0037b49e	213	extern int zfs_set_version(zfsvfs_t *zfsvfs, uint64_t newvers);
163a8c28	214	extern int zfsvfs_create(const char name, boolean_t readony, zfsvfs_t *zfvp);
d99a0153	215	extern int zfsvfs_create_impl(zfsvfs_t *zfvp, zfsvfs_t zfsvfs, objset_t *os);
f298b24d	216	extern void zfsvfs_free(zfsvfs_t *zfsvfs);
428870ff	217	extern int zfs_check_global_label(const char dsname, const char hexsl);
34dc7c2f	218
f298b24d	219	extern boolean_t zfs_is_readonly(zfsvfs_t *zfsvfs);
1c2555ef	220	extern int zfs_domount(struct super_block sb, zfs_mnt_t zm, int silent);
ebe7e575	221	extern void zfs_preumount(struct super_block *sb);
3558fd73	222	extern int zfs_umount(struct super_block *sb);
1c2555ef	223	extern int zfs_remount(struct super_block sb, int flags, zfs_mnt_t *zm);
3558fd73	224	extern int zfs_statvfs(struct dentry dentry, struct kstatfs statp);
2cf7f52b	225	extern int zfs_vget(struct super_block sb, struct inode ipp, fid_t fidp);
f298b24d BB	226	extern int zfs_prune(struct super_block *sb, unsigned long nr_to_scan,
f298b24d BB	227	int *objects);
e5c39b95	228
34dc7c2f BB	229	#ifdef __cplusplus
	230	}
	231	#endif
	232
	233	#endif /* _SYS_FS_ZFS_VFSOPS_H */