[mirror_zfs.git] / include / sys / zfs_ioctl.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) 2012, 2015 by Delphix. All rights reserved.
 */

#ifndef	_SYS_ZFS_IOCTL_H
#define	_SYS_ZFS_IOCTL_H

#include <sys/cred.h>
#include <sys/dmu.h>
#include <sys/zio.h>
#include <sys/dsl_deleg.h>
#include <sys/spa.h>
#include <sys/zfs_stat.h>

#ifdef _KERNEL
#include <sys/nvpair.h>
#endif	/* _KERNEL */

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * The structures in this file are passed between userland and the
 * kernel.  Userland may be running a 32-bit process, while the kernel
 * is 64-bit.  Therefore, these structures need to compile the same in
 * 32-bit and 64-bit.  This means not using type "long", and adding
 * explicit padding so that the 32-bit structure will not be packed more
 * tightly than the 64-bit structure (which requires 64-bit alignment).
 */

/*
 * Property values for snapdir
 */
#define	ZFS_SNAPDIR_HIDDEN		0
#define	ZFS_SNAPDIR_VISIBLE		1

/*
 * Property values for snapdev
 */
#define	ZFS_SNAPDEV_HIDDEN		0
#define	ZFS_SNAPDEV_VISIBLE		1
/*
 * Property values for acltype
 */
#define	ZFS_ACLTYPE_OFF			0
#define	ZFS_ACLTYPE_POSIXACL		1

/*
 * Field manipulation macros for the drr_versioninfo field of the
 * send stream header.
 */

/*
 * Header types for zfs send streams.
 */
typedef enum drr_headertype {
	DMU_SUBSTREAM = 0x1,
	DMU_COMPOUNDSTREAM = 0x2
} drr_headertype_t;

#define	DMU_GET_STREAM_HDRTYPE(vi)	BF64_GET((vi), 0, 2)
#define	DMU_SET_STREAM_HDRTYPE(vi, x)	BF64_SET((vi), 0, 2, x)

#define	DMU_GET_FEATUREFLAGS(vi)	BF64_GET((vi), 2, 30)
#define	DMU_SET_FEATUREFLAGS(vi, x)	BF64_SET((vi), 2, 30, x)

/*
 * Feature flags for zfs send streams (flags in drr_versioninfo)
 */

#define	DMU_BACKUP_FEATURE_DEDUP		(1 << 0)
#define	DMU_BACKUP_FEATURE_DEDUPPROPS		(1 << 1)
#define	DMU_BACKUP_FEATURE_SA_SPILL		(1 << 2)
/* flags #3 - #15 are reserved for incompatible closed-source implementations */
#define	DMU_BACKUP_FEATURE_EMBED_DATA		(1 << 16)
#define	DMU_BACKUP_FEATURE_EMBED_DATA_LZ4	(1 << 17)
/* flag #18 is reserved for a Delphix feature */
#define	DMU_BACKUP_FEATURE_LARGE_BLOCKS		(1 << 19)
#define	DMU_BACKUP_FEATURE_RESUMING		(1 << 20)
#define	DMU_BACKUP_FEATURE_LARGE_DNODE		(1 << 21)

/*
 * Mask of all supported backup features
 */
#define	DMU_BACKUP_FEATURE_MASK	(DMU_BACKUP_FEATURE_DEDUP | \
    DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
    DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \
    DMU_BACKUP_FEATURE_RESUMING | DMU_BACKUP_FEATURE_LARGE_BLOCKS | \
    DMU_BACKUP_FEATURE_LARGE_DNODE)

/* Are all features in the given flag word currently supported? */
#define	DMU_STREAM_SUPPORTED(x)	(!((x) & ~DMU_BACKUP_FEATURE_MASK))

typedef enum dmu_send_resume_token_version {
	ZFS_SEND_RESUME_TOKEN_VERSION = 1
} dmu_send_resume_token_version_t;

/*
 * The drr_versioninfo field of the dmu_replay_record has the
 * following layout:
 *
 *	64	56	48	40	32	24	16	8	0
 *	+-------+-------+-------+-------+-------+-------+-------+-------+
 *  	|		reserved	|        feature-flags	    |C|S|
 *	+-------+-------+-------+-------+-------+-------+-------+-------+
 *
 * The low order two bits indicate the header type: SUBSTREAM (0x1)
 * or COMPOUNDSTREAM (0x2).  Using two bits for this is historical:
 * this field used to be a version number, where the two version types
 * were 1 and 2.  Using two bits for this allows earlier versions of
 * the code to be able to recognize send streams that don't use any
 * of the features indicated by feature flags.
 */

#define	DMU_BACKUP_MAGIC 0x2F5bacbacULL

#define	DRR_FLAG_CLONE		(1<<0)
#define	DRR_FLAG_CI_DATA	(1<<1)
/*
 * This send stream, if it is a full send, includes the FREE and FREEOBJECT
 * records that are created by the sending process.  This means that the send
 * stream can be received as a clone, even though it is not an incremental.
 * This is not implemented as a feature flag, because the receiving side does
 * not need to have implemented it to receive this stream; it is fully backwards
 * compatible.  We need a flag, though, because full send streams without it
 * cannot necessarily be received as a clone correctly.
 */
#define	DRR_FLAG_FREERECORDS	(1<<2)

/*
 * flags in the drr_checksumflags field in the DRR_WRITE and
 * DRR_WRITE_BYREF blocks
 */
#define	DRR_CHECKSUM_DEDUP	(1<<0)

#define	DRR_IS_DEDUP_CAPABLE(flags)	((flags) & DRR_CHECKSUM_DEDUP)

/*
 * zfs ioctl command structure
 */
typedef struct dmu_replay_record {
	enum {
		DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
		DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
		DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
	} drr_type;
	uint32_t drr_payloadlen;
	union {
		struct drr_begin {
			uint64_t drr_magic;
			uint64_t drr_versioninfo; /* was drr_version */
			uint64_t drr_creation_time;
			dmu_objset_type_t drr_type;
			uint32_t drr_flags;
			uint64_t drr_toguid;
			uint64_t drr_fromguid;
			char drr_toname[MAXNAMELEN];
		} drr_begin;
		struct drr_end {
			zio_cksum_t drr_checksum;
			uint64_t drr_toguid;
		} drr_end;
		struct drr_object {
			uint64_t drr_object;
			dmu_object_type_t drr_type;
			dmu_object_type_t drr_bonustype;
			uint32_t drr_blksz;
			uint32_t drr_bonuslen;
			uint8_t drr_checksumtype;
			uint8_t drr_compress;
			uint8_t drr_dn_slots;
			uint8_t drr_pad[5];
			uint64_t drr_toguid;
			/* bonus content follows */
		} drr_object;
		struct drr_freeobjects {
			uint64_t drr_firstobj;
			uint64_t drr_numobjs;
			uint64_t drr_toguid;
		} drr_freeobjects;
		struct drr_write {
			uint64_t drr_object;
			dmu_object_type_t drr_type;
			uint32_t drr_pad;
			uint64_t drr_offset;
			uint64_t drr_length;
			uint64_t drr_toguid;
			uint8_t drr_checksumtype;
			uint8_t drr_checksumflags;
			uint8_t drr_pad2[6];
			ddt_key_t drr_key; /* deduplication key */
			/* content follows */
		} drr_write;
		struct drr_free {
			uint64_t drr_object;
			uint64_t drr_offset;
			uint64_t drr_length;
			uint64_t drr_toguid;
		} drr_free;
		struct drr_write_byref {
			/* where to put the data */
			uint64_t drr_object;
			uint64_t drr_offset;
			uint64_t drr_length;
			uint64_t drr_toguid;
			/* where to find the prior copy of the data */
			uint64_t drr_refguid;
			uint64_t drr_refobject;
			uint64_t drr_refoffset;
			/* properties of the data */
			uint8_t drr_checksumtype;
			uint8_t drr_checksumflags;
			uint8_t drr_pad2[6];
			ddt_key_t drr_key; /* deduplication key */
		} drr_write_byref;
		struct drr_spill {
			uint64_t drr_object;
			uint64_t drr_length;
			uint64_t drr_toguid;
			uint64_t drr_pad[4]; /* needed for crypto */
			/* spill data follows */
		} drr_spill;
		struct drr_write_embedded {
			uint64_t drr_object;
			uint64_t drr_offset;
			/* logical length, should equal blocksize */
			uint64_t drr_length;
			uint64_t drr_toguid;
			uint8_t drr_compression;
			uint8_t drr_etype;
			uint8_t drr_pad[6];
			uint32_t drr_lsize; /* uncompressed size of payload */
			uint32_t drr_psize; /* compr. (real) size of payload */
			/* (possibly compressed) content follows */
		} drr_write_embedded;

		/*
		 * Nore: drr_checksum is overlaid with all record types
		 * except DRR_BEGIN.  Therefore its (non-pad) members
		 * must not overlap with members from the other structs.
		 * We accomplish this by putting its members at the very
		 * end of the struct.
		 */
		struct drr_checksum {
			uint64_t drr_pad[34];
			/*
			 * fletcher-4 checksum of everything preceding the
			 * checksum.
			 */
			zio_cksum_t drr_checksum;
		} drr_checksum;
	} drr_u;
} dmu_replay_record_t;

/* diff record range types */
typedef enum diff_type {
	DDR_NONE = 0x1,
	DDR_INUSE = 0x2,
	DDR_FREE = 0x4
} diff_type_t;

/*
 * The diff reports back ranges of free or in-use objects.
 */
typedef struct dmu_diff_record {
	uint64_t ddr_type;
	uint64_t ddr_first;
	uint64_t ddr_last;
} dmu_diff_record_t;

typedef struct zinject_record {
	uint64_t	zi_objset;
	uint64_t	zi_object;
	uint64_t	zi_start;
	uint64_t	zi_end;
	uint64_t	zi_guid;
	uint32_t	zi_level;
	uint32_t	zi_error;
	uint64_t	zi_type;
	uint32_t	zi_freq;
	uint32_t	zi_failfast;
	char		zi_func[MAXNAMELEN];
	uint32_t	zi_iotype;
	int32_t		zi_duration;
	uint64_t	zi_timer;
	uint64_t	zi_nlanes;
	uint32_t	zi_cmd;
	uint32_t	zi_pad;
} zinject_record_t;

#define	ZINJECT_NULL		0x1
#define	ZINJECT_FLUSH_ARC	0x2
#define	ZINJECT_UNLOAD_SPA	0x4

#define	ZEVENT_NONE		0x0
#define	ZEVENT_NONBLOCK		0x1
#define	ZEVENT_SIZE		1024

#define	ZEVENT_SEEK_START	0
#define	ZEVENT_SEEK_END		UINT64_MAX

typedef enum zinject_type {
	ZINJECT_UNINITIALIZED,
	ZINJECT_DATA_FAULT,
	ZINJECT_DEVICE_FAULT,
	ZINJECT_LABEL_FAULT,
	ZINJECT_IGNORED_WRITES,
	ZINJECT_PANIC,
	ZINJECT_DELAY_IO,
} zinject_type_t;

typedef struct zfs_share {
	uint64_t	z_exportdata;
	uint64_t	z_sharedata;
	uint64_t	z_sharetype;	/* 0 = share, 1 = unshare */
	uint64_t	z_sharemax;  /* max length of share string */
} zfs_share_t;

/*
 * ZFS file systems may behave the usual, POSIX-compliant way, where
 * name lookups are case-sensitive.  They may also be set up so that
 * all the name lookups are case-insensitive, or so that only some
 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
 */
typedef enum zfs_case {
	ZFS_CASE_SENSITIVE,
	ZFS_CASE_INSENSITIVE,
	ZFS_CASE_MIXED
} zfs_case_t;

/*
 * Note: this struct must have the same layout in 32-bit and 64-bit, so
 * that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
 * kernel.  Therefore, we add padding to it so that no "hidden" padding
 * is automatically added on 64-bit (but not on 32-bit).
 */
typedef struct zfs_cmd {
	char		zc_name[MAXPATHLEN];	/* name of pool or dataset */
	uint64_t	zc_nvlist_src;		/* really (char *) */
	uint64_t	zc_nvlist_src_size;
	uint64_t	zc_nvlist_dst;		/* really (char *) */
	uint64_t	zc_nvlist_dst_size;
	boolean_t	zc_nvlist_dst_filled;	/* put an nvlist in dst? */
	int		zc_pad2;

	/*
	 * The following members are for legacy ioctls which haven't been
	 * converted to the new method.
	 */
	uint64_t	zc_history;		/* really (char *) */
	char		zc_value[MAXPATHLEN * 2];
	char		zc_string[MAXNAMELEN];
	uint64_t	zc_guid;
	uint64_t	zc_nvlist_conf;		/* really (char *) */
	uint64_t	zc_nvlist_conf_size;
	uint64_t	zc_cookie;
	uint64_t	zc_objset_type;
	uint64_t	zc_perm_action;
	uint64_t	zc_history_len;
	uint64_t	zc_history_offset;
	uint64_t	zc_obj;
	uint64_t	zc_iflags;		/* internal to zfs(7fs) */
	zfs_share_t	zc_share;
	dmu_objset_stats_t zc_objset_stats;
	dmu_replay_record_t zc_begin_record;
	zinject_record_t zc_inject_record;
	uint32_t	zc_defer_destroy;
	uint32_t	zc_flags;
	uint64_t	zc_action_handle;
	int		zc_cleanup_fd;
	uint8_t		zc_simple;
	boolean_t	zc_resumable;
	uint8_t		zc_pad[2];		/* alignment */
	uint64_t	zc_sendobj;
	uint64_t	zc_fromobj;
	uint64_t	zc_createtxg;
	zfs_stat_t	zc_stat;
} zfs_cmd_t;

typedef struct zfs_useracct {
	char zu_domain[256];
	uid_t zu_rid;
	uint32_t zu_pad;
	uint64_t zu_space;
} zfs_useracct_t;

#define	ZFSDEV_MAX_MINOR	(1 << 16)
#define	ZFS_MIN_MINOR	(ZFSDEV_MAX_MINOR + 1)

#define	ZPOOL_EXPORT_AFTER_SPLIT 0x1

#ifdef _KERNEL

typedef struct zfs_creat {
	nvlist_t	*zct_zplprops;
	nvlist_t	*zct_props;
} zfs_creat_t;

extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
extern int zfs_secpolicy_rename_perms(const char *from,
    const char *to, cred_t *cr);
extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
extern int zfs_unmount_snap(const char *);
extern void zfs_destroy_unmount_origin(const char *);

extern boolean_t dataset_name_hidden(const char *name);

enum zfsdev_state_type {
	ZST_ONEXIT,
	ZST_ZEVENT,
	ZST_ALL,
};

/*
 * The zfsdev_state_t structure is managed as a singly-linked list
 * from which items are never deleted.  This allows for lock-free
 * reading of the list so long as assignments to the zs_next and
 * reads from zs_minor are performed atomically.  Empty items are
 * indicated by storing -1 into zs_minor.
 */
typedef struct zfsdev_state {
	struct zfsdev_state	*zs_next;	/* next zfsdev_state_t link */
	struct file		*zs_file;	/* associated file struct */
	minor_t			zs_minor;	/* made up minor number */
	void			*zs_onexit;	/* onexit data */
	void			*zs_zevent;	/* zevent data */
} zfsdev_state_t;

extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
extern int zfsdev_getminor(struct file *filp, minor_t *minorp);
extern minor_t zfsdev_minor_alloc(void);

#endif	/* _KERNEL */

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_ZFS_IOCTL_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	/*
572e2857	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
e6d3a843	23	* Copyright (c) 2012, 2015 by Delphix. All rights reserved.
34dc7c2f BB	24	*/
	25
	26	#ifndef _SYS_ZFS_IOCTL_H
	27	#define _SYS_ZFS_IOCTL_H
	28
34dc7c2f BB	29	#include <sys/cred.h>
	30	#include <sys/dmu.h>
	31	#include <sys/zio.h>
	32	#include <sys/dsl_deleg.h>
428870ff	33	#include <sys/spa.h>
572e2857	34	#include <sys/zfs_stat.h>
34dc7c2f BB	35
	36	#ifdef _KERNEL
	37	#include <sys/nvpair.h>
	38	#endif /* _KERNEL */
	39
	40	#ifdef __cplusplus
	41	extern "C" {
	42	#endif
	43
6f1ffb06 MA	44	/*
	45	* The structures in this file are passed between userland and the
	46	* kernel. Userland may be running a 32-bit process, while the kernel
	47	* is 64-bit. Therefore, these structures need to compile the same in
	48	* 32-bit and 64-bit. This means not using type "long", and adding
	49	* explicit padding so that the 32-bit structure will not be packed more
	50	* tightly than the 64-bit structure (which requires 64-bit alignment).
	51	*/
	52
34dc7c2f BB	53	/*
	54	* Property values for snapdir
	55	*/
	56	#define ZFS_SNAPDIR_HIDDEN 0
	57	#define ZFS_SNAPDIR_VISIBLE 1
	58
0b4d1b58 ED	59	/*
	60	* Property values for snapdev
	61	*/
	62	#define ZFS_SNAPDEV_HIDDEN 0
	63	#define ZFS_SNAPDEV_VISIBLE 1
023699cd MM	64	/*
	65	* Property values for acltype
	66	*/
	67	#define ZFS_ACLTYPE_OFF 0
	68	#define ZFS_ACLTYPE_POSIXACL 1
0b4d1b58	69
428870ff BB	70	/*
	71	* Field manipulation macros for the drr_versioninfo field of the
	72	* send stream header.
	73	*/
	74
	75	/*
	76	* Header types for zfs send streams.
	77	*/
	78	typedef enum drr_headertype {
	79	DMU_SUBSTREAM = 0x1,
	80	DMU_COMPOUNDSTREAM = 0x2
	81	} drr_headertype_t;
	82
	83	#define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2)
	84	#define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x)
	85
	86	#define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
	87	#define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
	88
	89	/*
	90	* Feature flags for zfs send streams (flags in drr_versioninfo)
	91	*/
	92
47dfff3b MA	93	#define DMU_BACKUP_FEATURE_DEDUP (1 << 0)
	94	#define DMU_BACKUP_FEATURE_DEDUPPROPS (1 << 1)
	95	#define DMU_BACKUP_FEATURE_SA_SPILL (1 << 2)
9b67f605	96	/* flags #3 - #15 are reserved for incompatible closed-source implementations */
47dfff3b MA	97	#define DMU_BACKUP_FEATURE_EMBED_DATA (1 << 16)
47dfff3b MA	98	#define DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 (1 << 17)
f1512ee6	99	/* flag #18 is reserved for a Delphix feature */
47dfff3b MA	100	#define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19)
	101	#define DMU_BACKUP_FEATURE_RESUMING (1 << 20)
	102	#define DMU_BACKUP_FEATURE_LARGE_DNODE (1 << 21)
428870ff BB	103
	104	/*
	105	* Mask of all supported backup features
	106	*/
	107	#define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP \| \
9b67f605	108	DMU_BACKUP_FEATURE_DEDUPPROPS \| DMU_BACKUP_FEATURE_SA_SPILL \| \
f1512ee6	109	DMU_BACKUP_FEATURE_EMBED_DATA \| DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 \| \
47dfff3b MA	110	DMU_BACKUP_FEATURE_RESUMING \| DMU_BACKUP_FEATURE_LARGE_BLOCKS \| \
47dfff3b MA	111	DMU_BACKUP_FEATURE_LARGE_DNODE)
428870ff BB	112
	113	/* Are all features in the given flag word currently supported? */
	114	#define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
	115
47dfff3b MA	116	typedef enum dmu_send_resume_token_version {
	117	ZFS_SEND_RESUME_TOKEN_VERSION = 1
	118	} dmu_send_resume_token_version_t;
	119
428870ff BB	120	/*
	121	* The drr_versioninfo field of the dmu_replay_record has the
	122	* following layout:
	123	*
	124	* 64 56 48 40 32 24 16 8 0
	125	* +-------+-------+-------+-------+-------+-------+-------+-------+
	126	* \| reserved \| feature-flags \|C\|S\|
	127	* +-------+-------+-------+-------+-------+-------+-------+-------+
	128	*
	129	* The low order two bits indicate the header type: SUBSTREAM (0x1)
	130	* or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
	131	* this field used to be a version number, where the two version types
	132	* were 1 and 2. Using two bits for this allows earlier versions of
	133	* the code to be able to recognize send streams that don't use any
	134	* of the features indicated by feature flags.
	135	*/
	136
34dc7c2f BB	137	#define DMU_BACKUP_MAGIC 0x2F5bacbacULL
	138
	139	#define DRR_FLAG_CLONE (1<<0)
	140	#define DRR_FLAG_CI_DATA (1<<1)
e6d3a843 PD	141	/*
	142	* This send stream, if it is a full send, includes the FREE and FREEOBJECT
	143	* records that are created by the sending process. This means that the send
	144	* stream can be received as a clone, even though it is not an incremental.
	145	* This is not implemented as a feature flag, because the receiving side does
	146	* not need to have implemented it to receive this stream; it is fully backwards
	147	* compatible. We need a flag, though, because full send streams without it
	148	* cannot necessarily be received as a clone correctly.
	149	*/
	150	#define DRR_FLAG_FREERECORDS (1<<2)
34dc7c2f	151
428870ff BB	152	/*
	153	* flags in the drr_checksumflags field in the DRR_WRITE and
	154	* DRR_WRITE_BYREF blocks
	155	*/
	156	#define DRR_CHECKSUM_DEDUP (1<<0)
	157
	158	#define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
	159
34dc7c2f BB	160	/*
	161	* zfs ioctl command structure
	162	*/
	163	typedef struct dmu_replay_record {
	164	enum {
	165	DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
428870ff	166	DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
9b67f605	167	DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
34dc7c2f BB	168	} drr_type;
	169	uint32_t drr_payloadlen;
	170	union {
	171	struct drr_begin {
	172	uint64_t drr_magic;
428870ff	173	uint64_t drr_versioninfo; /* was drr_version */
34dc7c2f BB	174	uint64_t drr_creation_time;
	175	dmu_objset_type_t drr_type;
	176	uint32_t drr_flags;
	177	uint64_t drr_toguid;
	178	uint64_t drr_fromguid;
	179	char drr_toname[MAXNAMELEN];
	180	} drr_begin;
	181	struct drr_end {
	182	zio_cksum_t drr_checksum;
428870ff	183	uint64_t drr_toguid;
34dc7c2f BB	184	} drr_end;
	185	struct drr_object {
	186	uint64_t drr_object;
	187	dmu_object_type_t drr_type;
	188	dmu_object_type_t drr_bonustype;
	189	uint32_t drr_blksz;
	190	uint32_t drr_bonuslen;
428870ff	191	uint8_t drr_checksumtype;
34dc7c2f	192	uint8_t drr_compress;
50c957f7 NB	193	uint8_t drr_dn_slots;
50c957f7 NB	194	uint8_t drr_pad[5];
428870ff	195	uint64_t drr_toguid;
34dc7c2f BB	196	/* bonus content follows */
	197	} drr_object;
	198	struct drr_freeobjects {
	199	uint64_t drr_firstobj;
	200	uint64_t drr_numobjs;
428870ff	201	uint64_t drr_toguid;
34dc7c2f BB	202	} drr_freeobjects;
	203	struct drr_write {
	204	uint64_t drr_object;
	205	dmu_object_type_t drr_type;
	206	uint32_t drr_pad;
	207	uint64_t drr_offset;
	208	uint64_t drr_length;
428870ff BB	209	uint64_t drr_toguid;
	210	uint8_t drr_checksumtype;
	211	uint8_t drr_checksumflags;
	212	uint8_t drr_pad2[6];
	213	ddt_key_t drr_key; /* deduplication key */
34dc7c2f BB	214	/* content follows */
	215	} drr_write;
	216	struct drr_free {
	217	uint64_t drr_object;
	218	uint64_t drr_offset;
	219	uint64_t drr_length;
428870ff	220	uint64_t drr_toguid;
34dc7c2f	221	} drr_free;
428870ff BB	222	struct drr_write_byref {
	223	/* where to put the data */
	224	uint64_t drr_object;
	225	uint64_t drr_offset;
	226	uint64_t drr_length;
	227	uint64_t drr_toguid;
	228	/* where to find the prior copy of the data */
	229	uint64_t drr_refguid;
	230	uint64_t drr_refobject;
	231	uint64_t drr_refoffset;
	232	/* properties of the data */
	233	uint8_t drr_checksumtype;
	234	uint8_t drr_checksumflags;
	235	uint8_t drr_pad2[6];
	236	ddt_key_t drr_key; /* deduplication key */
	237	} drr_write_byref;
	238	struct drr_spill {
	239	uint64_t drr_object;
	240	uint64_t drr_length;
	241	uint64_t drr_toguid;
	242	uint64_t drr_pad[4]; /* needed for crypto */
	243	/* spill data follows */
	244	} drr_spill;
9b67f605 MA	245	struct drr_write_embedded {
	246	uint64_t drr_object;
	247	uint64_t drr_offset;
	248	/* logical length, should equal blocksize */
	249	uint64_t drr_length;
	250	uint64_t drr_toguid;
	251	uint8_t drr_compression;
	252	uint8_t drr_etype;
	253	uint8_t drr_pad[6];
	254	uint32_t drr_lsize; /* uncompressed size of payload */
	255	uint32_t drr_psize; /* compr. (real) size of payload */
	256	/* (possibly compressed) content follows */
	257	} drr_write_embedded;
37f8a883 MA	258
	259	/*
	260	* Nore: drr_checksum is overlaid with all record types
	261	* except DRR_BEGIN. Therefore its (non-pad) members
	262	* must not overlap with members from the other structs.
	263	* We accomplish this by putting its members at the very
	264	* end of the struct.
	265	*/
	266	struct drr_checksum {
	267	uint64_t drr_pad[34];
	268	/*
	269	* fletcher-4 checksum of everything preceding the
	270	* checksum.
	271	*/
	272	zio_cksum_t drr_checksum;
	273	} drr_checksum;
34dc7c2f BB	274	} drr_u;
	275	} dmu_replay_record_t;
	276
572e2857 BB	277	/* diff record range types */
	278	typedef enum diff_type {
	279	DDR_NONE = 0x1,
	280	DDR_INUSE = 0x2,
	281	DDR_FREE = 0x4
	282	} diff_type_t;
	283
	284	/*
	285	* The diff reports back ranges of free or in-use objects.
	286	*/
	287	typedef struct dmu_diff_record {
	288	uint64_t ddr_type;
	289	uint64_t ddr_first;
	290	uint64_t ddr_last;
	291	} dmu_diff_record_t;
	292
34dc7c2f BB	293	typedef struct zinject_record {
	294	uint64_t zi_objset;
	295	uint64_t zi_object;
	296	uint64_t zi_start;
	297	uint64_t zi_end;
	298	uint64_t zi_guid;
	299	uint32_t zi_level;
	300	uint32_t zi_error;
	301	uint64_t zi_type;
	302	uint32_t zi_freq;
9babb374	303	uint32_t zi_failfast;
428870ff BB	304	char zi_func[MAXNAMELEN];
	305	uint32_t zi_iotype;
	306	int32_t zi_duration;
	307	uint64_t zi_timer;
26ef0cc7	308	uint64_t zi_nlanes;
cc92e9d0 GW	309	uint32_t zi_cmd;
cc92e9d0 GW	310	uint32_t zi_pad;
34dc7c2f BB	311	} zinject_record_t;
	312
	313	#define ZINJECT_NULL 0x1
	314	#define ZINJECT_FLUSH_ARC 0x2
	315	#define ZINJECT_UNLOAD_SPA 0x4
	316
8c7aa0cf	317	#define ZEVENT_NONE 0x0
26685276 BB	318	#define ZEVENT_NONBLOCK 0x1
	319	#define ZEVENT_SIZE 1024
	320
75e3ff58 BB	321	#define ZEVENT_SEEK_START 0
	322	#define ZEVENT_SEEK_END UINT64_MAX
	323
cc92e9d0 GW	324	typedef enum zinject_type {
	325	ZINJECT_UNINITIALIZED,
	326	ZINJECT_DATA_FAULT,
	327	ZINJECT_DEVICE_FAULT,
	328	ZINJECT_LABEL_FAULT,
	329	ZINJECT_IGNORED_WRITES,
	330	ZINJECT_PANIC,
	331	ZINJECT_DELAY_IO,
	332	} zinject_type_t;
	333
34dc7c2f BB	334	typedef struct zfs_share {
	335	uint64_t z_exportdata;
	336	uint64_t z_sharedata;
	337	uint64_t z_sharetype; /* 0 = share, 1 = unshare */
	338	uint64_t z_sharemax; /* max length of share string */
	339	} zfs_share_t;
	340
	341	/*
	342	* ZFS file systems may behave the usual, POSIX-compliant way, where
	343	* name lookups are case-sensitive. They may also be set up so that
	344	* all the name lookups are case-insensitive, or so that only some
	345	* lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
	346	*/
	347	typedef enum zfs_case {
	348	ZFS_CASE_SENSITIVE,
	349	ZFS_CASE_INSENSITIVE,
	350	ZFS_CASE_MIXED
	351	} zfs_case_t;
	352
47dfff3b MA	353	/*
	354	* Note: this struct must have the same layout in 32-bit and 64-bit, so
	355	* that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
	356	* kernel. Therefore, we add padding to it so that no "hidden" padding
	357	* is automatically added on 64-bit (but not on 32-bit).
	358	*/
34dc7c2f	359	typedef struct zfs_cmd {
6f1ffb06 MA	360	char zc_name[MAXPATHLEN]; /* name of pool or dataset */
	361	uint64_t zc_nvlist_src; /* really (char ) /
	362	uint64_t zc_nvlist_src_size;
	363	uint64_t zc_nvlist_dst; /* really (char ) /
	364	uint64_t zc_nvlist_dst_size;
	365	boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
	366	int zc_pad2;
	367
	368	/*
	369	* The following members are for legacy ioctls which haven't been
	370	* converted to the new method.
	371	*/
	372	uint64_t zc_history; /* really (char ) /
34dc7c2f BB	373	char zc_value[MAXPATHLEN * 2];
	374	char zc_string[MAXNAMELEN];
	375	uint64_t zc_guid;
	376	uint64_t zc_nvlist_conf; /* really (char ) /
	377	uint64_t zc_nvlist_conf_size;
34dc7c2f BB	378	uint64_t zc_cookie;
	379	uint64_t zc_objset_type;
	380	uint64_t zc_perm_action;
6f1ffb06	381	uint64_t zc_history_len;
34dc7c2f BB	382	uint64_t zc_history_offset;
34dc7c2f BB	383	uint64_t zc_obj;
9babb374	384	uint64_t zc_iflags; /* internal to zfs(7fs) */
34dc7c2f BB	385	zfs_share_t zc_share;
34dc7c2f BB	386	dmu_objset_stats_t zc_objset_stats;
47dfff3b	387	dmu_replay_record_t zc_begin_record;
34dc7c2f	388	zinject_record_t zc_inject_record;
9b67f605 MA	389	uint32_t zc_defer_destroy;
9b67f605 MA	390	uint32_t zc_flags;
572e2857 BB	391	uint64_t zc_action_handle;
572e2857 BB	392	int zc_cleanup_fd;
0cee2406	393	uint8_t zc_simple;
47dfff3b MA	394	boolean_t zc_resumable;
47dfff3b MA	395	uint8_t zc_pad[2]; /* alignment */
572e2857 BB	396	uint64_t zc_sendobj;
	397	uint64_t zc_fromobj;
	398	uint64_t zc_createtxg;
	399	zfs_stat_t zc_stat;
34dc7c2f BB	400	} zfs_cmd_t;
34dc7c2f BB	401
9babb374 BB	402	typedef struct zfs_useracct {
	403	char zu_domain[256];
	404	uid_t zu_rid;
	405	uint32_t zu_pad;
	406	uint64_t zu_space;
	407	} zfs_useracct_t;
	408
572e2857 BB	409	#define ZFSDEV_MAX_MINOR (1 << 16)
572e2857 BB	410	#define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
34dc7c2f	411
428870ff BB	412	#define ZPOOL_EXPORT_AFTER_SPLIT 0x1
428870ff BB	413
34dc7c2f BB	414	#ifdef _KERNEL
	415
	416	typedef struct zfs_creat {
	417	nvlist_t *zct_zplprops;
	418	nvlist_t *zct_props;
	419	} zfs_creat_t;
	420
34dc7c2f BB	421	extern int zfs_secpolicy_snapshot_perms(const char name, cred_t cr);
	422	extern int zfs_secpolicy_rename_perms(const char *from,
	423	const char to, cred_t cr);
	424	extern int zfs_secpolicy_destroy_perms(const char name, cred_t cr);
d09f25dc	425	extern int zfs_unmount_snap(const char *);
13fe0198	426	extern void zfs_destroy_unmount_origin(const char *);
34dc7c2f	427
ba6a2402 BB	428	extern boolean_t dataset_name_hidden(const char *name);
ba6a2402 BB	429
325f0235 BB	430	enum zfsdev_state_type {
	431	ZST_ONEXIT,
	432	ZST_ZEVENT,
	433	ZST_ALL,
572e2857 BB	434	};
572e2857 BB	435
3937ab20 TC	436	/*
	437	* The zfsdev_state_t structure is managed as a singly-linked list
	438	* from which items are never deleted. This allows for lock-free
	439	* reading of the list so long as assignments to the zs_next and
	440	* reads from zs_minor are performed atomically. Empty items are
	441	* indicated by storing -1 into zs_minor.
	442	*/
325f0235	443	typedef struct zfsdev_state {
3937ab20	444	struct zfsdev_state zs_next; / next zfsdev_state_t link */
325f0235 BB	445	struct file zs_file; / associated file struct */
	446	minor_t zs_minor; /* made up minor number */
	447	void zs_onexit; / onexit data */
	448	void zs_zevent; / zevent data */
	449	} zfsdev_state_t;
572e2857	450
325f0235	451	extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
72540ea3	452	extern int zfsdev_getminor(struct file filp, minor_t minorp);
572e2857 BB	453	extern minor_t zfsdev_minor_alloc(void);
572e2857 BB	454
34dc7c2f BB	455	#endif /* _KERNEL */
	456
	457	#ifdef __cplusplus
	458	}
	459	#endif
	460
	461	#endif /* _SYS_ZFS_IOCTL_H */