xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision a3b28680)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5441d80aaSlling  * Common Development and Distribution License (the "License").
6441d80aaSlling  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21f94275ceSAdam Leventhal 
22fa9e4066Sahrens /*
2327dd1e87SMark Shellenbaum  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24dfc11533SChris Williamson  * Copyright (c) 2011, 2016 by Delphix. All rights reserved.
25e9103aaeSGarrett D'Amore  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
26c3d26abcSMatthew Ahrens  * Copyright (c) 2014 Integros [integros.com]
27ce1577b0SDave Eddy  * Copyright 2017 Joyent, Inc.
281702cce7SAlek Pinchuk  * Copyright (c) 2017 Datto Inc.
29fa9e4066Sahrens  */
30fa9e4066Sahrens 
3155da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */
3255da60b9SMark J Musante 
33fa9e4066Sahrens #ifndef	_SYS_FS_ZFS_H
34fa9e4066Sahrens #define	_SYS_FS_ZFS_H
35fa9e4066Sahrens 
36842727c2SChris Kirby #include <sys/time.h>
37842727c2SChris Kirby 
38fa9e4066Sahrens #ifdef	__cplusplus
39fa9e4066Sahrens extern "C" {
40fa9e4066Sahrens #endif
41fa9e4066Sahrens 
42fa9e4066Sahrens /*
43fa9e4066Sahrens  * Types and constants shared between userland and the kernel.
44fa9e4066Sahrens  */
45fa9e4066Sahrens 
46fa9e4066Sahrens /*
47fa9e4066Sahrens  * Each dataset can be one of the following types.  These constants can be
48fa9e4066Sahrens  * combined into masks that can be passed to various functions.
49fa9e4066Sahrens  */
50fa9e4066Sahrens typedef enum {
5178f17100SMatthew Ahrens 	ZFS_TYPE_FILESYSTEM	= (1 << 0),
5278f17100SMatthew Ahrens 	ZFS_TYPE_SNAPSHOT	= (1 << 1),
5378f17100SMatthew Ahrens 	ZFS_TYPE_VOLUME		= (1 << 2),
5478f17100SMatthew Ahrens 	ZFS_TYPE_POOL		= (1 << 3),
5578f17100SMatthew Ahrens 	ZFS_TYPE_BOOKMARK	= (1 << 4)
56fa9e4066Sahrens } zfs_type_t;
57fa9e4066Sahrens 
5826455f9eSAndriy Gapon /*
5926455f9eSAndriy Gapon  * NB: lzc_dataset_type should be updated whenever a new objset type is added,
6026455f9eSAndriy Gapon  * if it represents a real type of a dataset that can be created from userland.
6126455f9eSAndriy Gapon  */
624445fffbSMatthew Ahrens typedef enum dmu_objset_type {
634445fffbSMatthew Ahrens 	DMU_OST_NONE,
644445fffbSMatthew Ahrens 	DMU_OST_META,
654445fffbSMatthew Ahrens 	DMU_OST_ZFS,
664445fffbSMatthew Ahrens 	DMU_OST_ZVOL,
674445fffbSMatthew Ahrens 	DMU_OST_OTHER,			/* For testing only! */
684445fffbSMatthew Ahrens 	DMU_OST_ANY,			/* Be careful! */
694445fffbSMatthew Ahrens 	DMU_OST_NUMTYPES
704445fffbSMatthew Ahrens } dmu_objset_type_t;
714445fffbSMatthew Ahrens 
72990b4856Slling #define	ZFS_TYPE_DATASET	\
73fa9e4066Sahrens 	(ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
74fa9e4066Sahrens 
759adfa60dSMatthew Ahrens /*
769adfa60dSMatthew Ahrens  * All of these include the terminating NUL byte.
779adfa60dSMatthew Ahrens  */
78478ed9adSEric Taylor #define	ZAP_MAXNAMELEN 256
79478ed9adSEric Taylor #define	ZAP_MAXVALUELEN (1024 * 8)
80478ed9adSEric Taylor #define	ZAP_OLDMAXVALUELEN 1024
819adfa60dSMatthew Ahrens #define	ZFS_MAX_DATASET_NAME_LEN 256
82478ed9adSEric Taylor 
83fa9e4066Sahrens /*
84990b4856Slling  * Dataset properties are identified by these constants and must be added to
85990b4856Slling  * the end of this list to ensure that external consumers are not affected
86990b4856Slling  * by the change. If you make any changes to this list, be sure to update
8766e2aaccSgw  * the property table in usr/src/common/zfs/zfs_prop.c.
88fa9e4066Sahrens  */
89fa9e4066Sahrens typedef enum {
90c16bcc45SIgor Kozhukhov 	ZFS_PROP_BAD = -1,
91c16bcc45SIgor Kozhukhov 	ZFS_PROP_TYPE = 0,
92fa9e4066Sahrens 	ZFS_PROP_CREATION,
93fa9e4066Sahrens 	ZFS_PROP_USED,
94fa9e4066Sahrens 	ZFS_PROP_AVAILABLE,
95fa9e4066Sahrens 	ZFS_PROP_REFERENCED,
96fa9e4066Sahrens 	ZFS_PROP_COMPRESSRATIO,
97fa9e4066Sahrens 	ZFS_PROP_MOUNTED,
98fa9e4066Sahrens 	ZFS_PROP_ORIGIN,
99fa9e4066Sahrens 	ZFS_PROP_QUOTA,
100fa9e4066Sahrens 	ZFS_PROP_RESERVATION,
101fa9e4066Sahrens 	ZFS_PROP_VOLSIZE,
102fa9e4066Sahrens 	ZFS_PROP_VOLBLOCKSIZE,
103fa9e4066Sahrens 	ZFS_PROP_RECORDSIZE,
104fa9e4066Sahrens 	ZFS_PROP_MOUNTPOINT,
105fa9e4066Sahrens 	ZFS_PROP_SHARENFS,
106fa9e4066Sahrens 	ZFS_PROP_CHECKSUM,
107fa9e4066Sahrens 	ZFS_PROP_COMPRESSION,
108fa9e4066Sahrens 	ZFS_PROP_ATIME,
109fa9e4066Sahrens 	ZFS_PROP_DEVICES,
110fa9e4066Sahrens 	ZFS_PROP_EXEC,
111fa9e4066Sahrens 	ZFS_PROP_SETUID,
112fa9e4066Sahrens 	ZFS_PROP_READONLY,
113fa9e4066Sahrens 	ZFS_PROP_ZONED,
114fa9e4066Sahrens 	ZFS_PROP_SNAPDIR,
115a3c49ce1SAlbert Lee 	ZFS_PROP_ACLMODE,
116fa9e4066Sahrens 	ZFS_PROP_ACLINHERIT,
11766e2aaccSgw 	ZFS_PROP_CREATETXG,		/* not exposed to the user */
11866e2aaccSgw 	ZFS_PROP_NAME,			/* not exposed to the user */
119e9dbad6fSeschrock 	ZFS_PROP_CANMOUNT,
12066e2aaccSgw 	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */
1217b55fa8eSck 	ZFS_PROP_XATTR,
122d0ad202dSahrens 	ZFS_PROP_NUMCLONES,		/* not exposed to the user */
123b1b8ab34Slling 	ZFS_PROP_COPIES,
124e7437265Sahrens 	ZFS_PROP_VERSION,
125da6c28aaSamw 	ZFS_PROP_UTF8ONLY,
126da6c28aaSamw 	ZFS_PROP_NORMALIZE,
127da6c28aaSamw 	ZFS_PROP_CASE,
128da6c28aaSamw 	ZFS_PROP_VSCAN,
129da6c28aaSamw 	ZFS_PROP_NBMAND,
130da6c28aaSamw 	ZFS_PROP_SHARESMB,
131a9799022Sck 	ZFS_PROP_REFQUOTA,
132a9799022Sck 	ZFS_PROP_REFRESERVATION,
133c5904d13Seschrock 	ZFS_PROP_GUID,
1343baa08fcSek 	ZFS_PROP_PRIMARYCACHE,
1353baa08fcSek 	ZFS_PROP_SECONDARYCACHE,
13674e7dc98SMatthew Ahrens 	ZFS_PROP_USEDSNAP,
13774e7dc98SMatthew Ahrens 	ZFS_PROP_USEDDS,
13874e7dc98SMatthew Ahrens 	ZFS_PROP_USEDCHILD,
13974e7dc98SMatthew Ahrens 	ZFS_PROP_USEDREFRESERV,
14014843421SMatthew Ahrens 	ZFS_PROP_USERACCOUNTING,	/* not exposed to the user */
141478ed9adSEric Taylor 	ZFS_PROP_STMF_SHAREINFO,	/* not exposed to the user */
142842727c2SChris Kirby 	ZFS_PROP_DEFER_DESTROY,
143842727c2SChris Kirby 	ZFS_PROP_USERREFS,
144e09fa4daSNeil Perrin 	ZFS_PROP_LOGBIAS,
1451d713200SEric Schrock 	ZFS_PROP_UNIQUE,		/* not exposed to the user */
1461d713200SEric Schrock 	ZFS_PROP_OBJSETID,		/* not exposed to the user */
147b24ab676SJeff Bonwick 	ZFS_PROP_DEDUP,
1484201a95eSRic Aleshire 	ZFS_PROP_MLSLABEL,
14955da60b9SMark J Musante 	ZFS_PROP_SYNC,
150187d6ac0SMatt Ahrens 	ZFS_PROP_REFRATIO,
15119b94df9SMatthew Ahrens 	ZFS_PROP_WRITTEN,
15219b94df9SMatthew Ahrens 	ZFS_PROP_CLONES,
15377372cb0SMatthew Ahrens 	ZFS_PROP_LOGICALUSED,
15477372cb0SMatthew Ahrens 	ZFS_PROP_LOGICALREFERENCED,
155ca48f36fSKeith M Wesolowski 	ZFS_PROP_INCONSISTENT,		/* not exposed to the user */
156a2afb611SJerry Jelinek 	ZFS_PROP_FILESYSTEM_LIMIT,
157a2afb611SJerry Jelinek 	ZFS_PROP_SNAPSHOT_LIMIT,
158a2afb611SJerry Jelinek 	ZFS_PROP_FILESYSTEM_COUNT,
159a2afb611SJerry Jelinek 	ZFS_PROP_SNAPSHOT_COUNT,
160edf345e6SMatthew Ahrens 	ZFS_PROP_REDUNDANT_METADATA,
161b461c746SMatthew Ahrens 	ZFS_PROP_PREV_SNAP,
1629c3fd121SMatthew Ahrens 	ZFS_PROP_RECEIVE_RESUME_TOKEN,
16391ebeef5Sahrens 	ZFS_NUM_PROPS
164fa9e4066Sahrens } zfs_prop_t;
165fa9e4066Sahrens 
16614843421SMatthew Ahrens typedef enum {
16714843421SMatthew Ahrens 	ZFS_PROP_USERUSED,
16814843421SMatthew Ahrens 	ZFS_PROP_USERQUOTA,
16914843421SMatthew Ahrens 	ZFS_PROP_GROUPUSED,
17014843421SMatthew Ahrens 	ZFS_PROP_GROUPQUOTA,
17114843421SMatthew Ahrens 	ZFS_NUM_USERQUOTA_PROPS
17214843421SMatthew Ahrens } zfs_userquota_prop_t;
17314843421SMatthew Ahrens 
17414843421SMatthew Ahrens extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
17514843421SMatthew Ahrens 
176990b4856Slling /*
177990b4856Slling  * Pool properties are identified by these constants and must be added to the
178b87f3af3Sperrin  * end of this list to ensure that external consumers are not affected
179990b4856Slling  * by the change. If you make any changes to this list, be sure to update
180990b4856Slling  * the property table in usr/src/common/zfs/zpool_prop.c.
181990b4856Slling  */
182990b4856Slling typedef enum {
183990b4856Slling 	ZPOOL_PROP_NAME,
184990b4856Slling 	ZPOOL_PROP_SIZE,
185990b4856Slling 	ZPOOL_PROP_CAPACITY,
186990b4856Slling 	ZPOOL_PROP_ALTROOT,
187990b4856Slling 	ZPOOL_PROP_HEALTH,
188990b4856Slling 	ZPOOL_PROP_GUID,
189990b4856Slling 	ZPOOL_PROP_VERSION,
190990b4856Slling 	ZPOOL_PROP_BOOTFS,
191990b4856Slling 	ZPOOL_PROP_DELEGATION,
192990b4856Slling 	ZPOOL_PROP_AUTOREPLACE,
1932f8aaab3Seschrock 	ZPOOL_PROP_CACHEFILE,
1940a4e9518Sgw 	ZPOOL_PROP_FAILUREMODE,
195d5b5bb25SRich Morris 	ZPOOL_PROP_LISTSNAPS,
196573ca77eSGeorge Wilson 	ZPOOL_PROP_AUTOEXPAND,
197b24ab676SJeff Bonwick 	ZPOOL_PROP_DEDUPDITTO,
198b24ab676SJeff Bonwick 	ZPOOL_PROP_DEDUPRATIO,
199485bbbf5SGeorge Wilson 	ZPOOL_PROP_FREE,
200485bbbf5SGeorge Wilson 	ZPOOL_PROP_ALLOCATED,
201f9af39baSGeorge Wilson 	ZPOOL_PROP_READONLY,
2028704186eSDan McDonald 	ZPOOL_PROP_COMMENT,
2034263d13fSGeorge Wilson 	ZPOOL_PROP_EXPANDSZ,
204ad135b5dSChristopher Siden 	ZPOOL_PROP_FREEING,
2052e4c9986SGeorge Wilson 	ZPOOL_PROP_FRAGMENTATION,
2067fd05ac4SMatthew Ahrens 	ZPOOL_PROP_LEAKED,
207b5152584SMatthew Ahrens 	ZPOOL_PROP_MAXBLOCKSIZE,
2087855d95bSToomas Soome 	ZPOOL_PROP_BOOTSIZE,
209990b4856Slling 	ZPOOL_NUM_PROPS
210990b4856Slling } zpool_prop_t;
211b1b8ab34Slling 
2128704186eSDan McDonald /* Small enough to not hog a whole line of printout in zpool(1M). */
2138704186eSDan McDonald #define	ZPROP_MAX_COMMENT	32
2148704186eSDan McDonald 
215990b4856Slling #define	ZPROP_CONT		-2
216990b4856Slling #define	ZPROP_INVAL		-1
2173d7072f8Seschrock 
218990b4856Slling #define	ZPROP_VALUE		"value"
219990b4856Slling #define	ZPROP_SOURCE		"source"
2207f7322feSeschrock 
221b1b8ab34Slling typedef enum {
222990b4856Slling 	ZPROP_SRC_NONE = 0x1,
223990b4856Slling 	ZPROP_SRC_DEFAULT = 0x2,
224990b4856Slling 	ZPROP_SRC_TEMPORARY = 0x4,
225990b4856Slling 	ZPROP_SRC_LOCAL = 0x8,
22692241e0bSTom Erickson 	ZPROP_SRC_INHERITED = 0x10,
22792241e0bSTom Erickson 	ZPROP_SRC_RECEIVED = 0x20
228990b4856Slling } zprop_source_t;
229990b4856Slling 
23092241e0bSTom Erickson #define	ZPROP_SRC_ALL	0x3f
23192241e0bSTom Erickson 
23292241e0bSTom Erickson #define	ZPROP_SOURCE_VAL_RECVD	"$recvd"
23392241e0bSTom Erickson #define	ZPROP_N_MORE_ERRORS	"N_MORE_ERRORS"
23492241e0bSTom Erickson /*
23592241e0bSTom Erickson  * Dataset flag implemented as a special entry in the props zap object
23692241e0bSTom Erickson  * indicating that the dataset has received properties on or after
23792241e0bSTom Erickson  * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
23892241e0bSTom Erickson  * just as it did in earlier versions, and thereafter, local properties are
23992241e0bSTom Erickson  * preserved.
24092241e0bSTom Erickson  */
24192241e0bSTom Erickson #define	ZPROP_HAS_RECVD		"$hasrecvd"
24292241e0bSTom Erickson 
24392241e0bSTom Erickson typedef enum {
24492241e0bSTom Erickson 	ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
24592241e0bSTom Erickson 	ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
24692241e0bSTom Erickson } zprop_errflags_t;
247990b4856Slling 
248990b4856Slling typedef int (*zprop_func)(int, void *);
249990b4856Slling 
2500a48a24eStimh /*
2510a48a24eStimh  * Properties to be set on the root file system of a new pool
2520a48a24eStimh  * are stuffed into their own nvlist, which is then included in
2530a48a24eStimh  * the properties nvlist with the pool properties.
2540a48a24eStimh  */
2550a48a24eStimh #define	ZPOOL_ROOTFS_PROPS	"root-props-nvl"
2560a48a24eStimh 
257dfc11533SChris Williamson /*
258dfc11533SChris Williamson  * Length of 'written@' and 'written#'
259dfc11533SChris Williamson  */
260dfc11533SChris Williamson #define	ZFS_WRITTEN_PROP_PREFIX_LEN	8
261dfc11533SChris Williamson 
262990b4856Slling /*
263990b4856Slling  * Dataset property functions shared between libzfs and kernel.
264990b4856Slling  */
265990b4856Slling const char *zfs_prop_default_string(zfs_prop_t);
266990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t);
267990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t);
268dfc11533SChris Williamson boolean_t zfs_prop_visible(zfs_prop_t prop);
269990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t);
270da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t);
271990b4856Slling const char *zfs_prop_to_name(zfs_prop_t);
272990b4856Slling zfs_prop_t zfs_name_to_prop(const char *);
273990b4856Slling boolean_t zfs_prop_user(const char *);
27492241e0bSTom Erickson boolean_t zfs_prop_userquota(const char *);
27519b94df9SMatthew Ahrens boolean_t zfs_prop_written(const char *);
276990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
277990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
278b24ab676SJeff Bonwick uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
2794853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
280b1b8ab34Slling 
281990b4856Slling /*
282990b4856Slling  * Pool property functions shared between libzfs and kernel.
283990b4856Slling  */
284990b4856Slling zpool_prop_t zpool_name_to_prop(const char *);
285990b4856Slling const char *zpool_prop_to_name(zpool_prop_t);
286990b4856Slling const char *zpool_prop_default_string(zpool_prop_t);
287990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t);
288990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t);
289ad135b5dSChristopher Siden boolean_t zpool_prop_feature(const char *);
290ad135b5dSChristopher Siden boolean_t zpool_prop_unsupported(const char *name);
291990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
292990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
293b24ab676SJeff Bonwick uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
294b1b8ab34Slling 
295990b4856Slling /*
296990b4856Slling  * Definitions for the Delegation.
297990b4856Slling  */
298ecd6cf80Smarks typedef enum {
299ecd6cf80Smarks 	ZFS_DELEG_WHO_UNKNOWN = 0,
300ecd6cf80Smarks 	ZFS_DELEG_USER = 'u',
301ecd6cf80Smarks 	ZFS_DELEG_USER_SETS = 'U',
302ecd6cf80Smarks 	ZFS_DELEG_GROUP = 'g',
303ecd6cf80Smarks 	ZFS_DELEG_GROUP_SETS = 'G',
304ecd6cf80Smarks 	ZFS_DELEG_EVERYONE = 'e',
305ecd6cf80Smarks 	ZFS_DELEG_EVERYONE_SETS = 'E',
306ecd6cf80Smarks 	ZFS_DELEG_CREATE = 'c',
307ecd6cf80Smarks 	ZFS_DELEG_CREATE_SETS = 'C',
308ecd6cf80Smarks 	ZFS_DELEG_NAMED_SET = 's',
309ecd6cf80Smarks 	ZFS_DELEG_NAMED_SET_SETS = 'S'
310ecd6cf80Smarks } zfs_deleg_who_type_t;
311ecd6cf80Smarks 
312ecd6cf80Smarks typedef enum {
313ecd6cf80Smarks 	ZFS_DELEG_NONE = 0,
314ecd6cf80Smarks 	ZFS_DELEG_PERM_LOCAL = 1,
315ecd6cf80Smarks 	ZFS_DELEG_PERM_DESCENDENT = 2,
316ecd6cf80Smarks 	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
317ecd6cf80Smarks 	ZFS_DELEG_PERM_CREATE = 4
318ecd6cf80Smarks } zfs_deleg_inherit_t;
319ecd6cf80Smarks 
320ecd6cf80Smarks #define	ZFS_DELEG_PERM_UID	"uid"
321ecd6cf80Smarks #define	ZFS_DELEG_PERM_GID	"gid"
322ecd6cf80Smarks #define	ZFS_DELEG_PERM_GROUPS	"groups"
323ecd6cf80Smarks 
3244201a95eSRic Aleshire #define	ZFS_MLSLABEL_DEFAULT	"none"
3254201a95eSRic Aleshire 
326743a77edSAlan Wright #define	ZFS_SMB_ACL_SRC		"src"
327743a77edSAlan Wright #define	ZFS_SMB_ACL_TARGET	"target"
328743a77edSAlan Wright 
329a227b7f4Shs typedef enum {
330a227b7f4Shs 	ZFS_CANMOUNT_OFF = 0,
331a227b7f4Shs 	ZFS_CANMOUNT_ON = 1,
332a227b7f4Shs 	ZFS_CANMOUNT_NOAUTO = 2
333a227b7f4Shs } zfs_canmount_type_t;
334a227b7f4Shs 
335e09fa4daSNeil Perrin typedef enum {
336e09fa4daSNeil Perrin 	ZFS_LOGBIAS_LATENCY = 0,
337e09fa4daSNeil Perrin 	ZFS_LOGBIAS_THROUGHPUT = 1
338e09fa4daSNeil Perrin } zfs_logbias_op_t;
339e09fa4daSNeil Perrin 
340da6c28aaSamw typedef enum zfs_share_op {
341da6c28aaSamw 	ZFS_SHARE_NFS = 0,
342da6c28aaSamw 	ZFS_UNSHARE_NFS = 1,
343da6c28aaSamw 	ZFS_SHARE_SMB = 2,
344da6c28aaSamw 	ZFS_UNSHARE_SMB = 3
345da6c28aaSamw } zfs_share_op_t;
346da6c28aaSamw 
347743a77edSAlan Wright typedef enum zfs_smb_acl_op {
348743a77edSAlan Wright 	ZFS_SMB_ACL_ADD,
349743a77edSAlan Wright 	ZFS_SMB_ACL_REMOVE,
350743a77edSAlan Wright 	ZFS_SMB_ACL_RENAME,
351743a77edSAlan Wright 	ZFS_SMB_ACL_PURGE
352743a77edSAlan Wright } zfs_smb_acl_op_t;
353743a77edSAlan Wright 
3543baa08fcSek typedef enum zfs_cache_type {
3553baa08fcSek 	ZFS_CACHE_NONE = 0,
3563baa08fcSek 	ZFS_CACHE_METADATA = 1,
3573baa08fcSek 	ZFS_CACHE_ALL = 2
3583baa08fcSek } zfs_cache_type_t;
3593baa08fcSek 
36055da60b9SMark J Musante typedef enum {
36155da60b9SMark J Musante 	ZFS_SYNC_STANDARD = 0,
36255da60b9SMark J Musante 	ZFS_SYNC_ALWAYS = 1,
36355da60b9SMark J Musante 	ZFS_SYNC_DISABLED = 2
36455da60b9SMark J Musante } zfs_sync_type_t;
36555da60b9SMark J Musante 
366edf345e6SMatthew Ahrens typedef enum {
367edf345e6SMatthew Ahrens 	ZFS_REDUNDANT_METADATA_ALL,
368edf345e6SMatthew Ahrens 	ZFS_REDUNDANT_METADATA_MOST
369edf345e6SMatthew Ahrens } zfs_redundant_metadata_type_t;
3703baa08fcSek 
371eaca9bbdSeschrock /*
37299653d4eSeschrock  * On-disk version number.
373eaca9bbdSeschrock  */
374e7437265Sahrens #define	SPA_VERSION_1			1ULL
375e7437265Sahrens #define	SPA_VERSION_2			2ULL
376e7437265Sahrens #define	SPA_VERSION_3			3ULL
377e7437265Sahrens #define	SPA_VERSION_4			4ULL
378e7437265Sahrens #define	SPA_VERSION_5			5ULL
379e7437265Sahrens #define	SPA_VERSION_6			6ULL
380e7437265Sahrens #define	SPA_VERSION_7			7ULL
381e7437265Sahrens #define	SPA_VERSION_8			8ULL
382da6c28aaSamw #define	SPA_VERSION_9			9ULL
383fa94a07fSbrendan #define	SPA_VERSION_10			10ULL
384088f3894Sahrens #define	SPA_VERSION_11			11ULL
385bb0ade09Sahrens #define	SPA_VERSION_12			12ULL
38674e7dc98SMatthew Ahrens #define	SPA_VERSION_13			13ULL
387d0f3f37eSMark Shellenbaum #define	SPA_VERSION_14			14ULL
38814843421SMatthew Ahrens #define	SPA_VERSION_15			15ULL
389478ed9adSEric Taylor #define	SPA_VERSION_16			16ULL
390f94275ceSAdam Leventhal #define	SPA_VERSION_17			17ULL
391842727c2SChris Kirby #define	SPA_VERSION_18			18ULL
39288ecc943SGeorge Wilson #define	SPA_VERSION_19			19ULL
393b24ab676SJeff Bonwick #define	SPA_VERSION_20			20ULL
394b24ab676SJeff Bonwick #define	SPA_VERSION_21			21ULL
39592241e0bSTom Erickson #define	SPA_VERSION_22			22ULL
3966e1f5caaSNeil Perrin #define	SPA_VERSION_23			23ULL
3970a586ceaSMark Shellenbaum #define	SPA_VERSION_24			24ULL
3983f9d6ad7SLin Ling #define	SPA_VERSION_25			25ULL
399cde58dbcSMatthew Ahrens #define	SPA_VERSION_26			26ULL
4006e0cbcaaSMatthew Ahrens #define	SPA_VERSION_27			27ULL
401cb04b873SMark J Musante #define	SPA_VERSION_28			28ULL
402ad135b5dSChristopher Siden #define	SPA_VERSION_5000		5000ULL
403cb04b873SMark J Musante 
404b1b8ab34Slling /*
405e7cbe64fSgw  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
406478ed9adSEric Taylor  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
40714843421SMatthew Ahrens  * and do the appropriate changes.  Also bump the version number in
40814843421SMatthew Ahrens  * usr/src/grub/capability.
409b1b8ab34Slling  */
410ad135b5dSChristopher Siden #define	SPA_VERSION			SPA_VERSION_5000
411ad135b5dSChristopher Siden #define	SPA_VERSION_STRING		"5000"
41244cd46caSbillm 
41344cd46caSbillm /*
414e7437265Sahrens  * Symbolic names for the changes that caused a SPA_VERSION switch.
41544cd46caSbillm  * Used in the code when checking for presence or absence of a feature.
41644cd46caSbillm  * Feel free to define multiple symbolic names for each version if there
41744cd46caSbillm  * were multiple changes to on-disk structures during that version.
41844cd46caSbillm  *
419e7437265Sahrens  * NOTE: When checking the current SPA_VERSION in your code, be sure
42044cd46caSbillm  *       to use spa_version() since it reports the version of the
42144cd46caSbillm  *       last synced uberblock.  Checking the in-flight version can
42244cd46caSbillm  *       be dangerous in some cases.
42344cd46caSbillm  */
424e7437265Sahrens #define	SPA_VERSION_INITIAL		SPA_VERSION_1
425e7437265Sahrens #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
426e7437265Sahrens #define	SPA_VERSION_SPARES		SPA_VERSION_3
427f94275ceSAdam Leventhal #define	SPA_VERSION_RAIDZ2		SPA_VERSION_3
428cde58dbcSMatthew Ahrens #define	SPA_VERSION_BPOBJ_ACCOUNT	SPA_VERSION_3
429e7437265Sahrens #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
430e7437265Sahrens #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
431e7437265Sahrens #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
432e7437265Sahrens #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
433e7437265Sahrens #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
434990b4856Slling #define	SPA_VERSION_SLOGS		SPA_VERSION_7
435990b4856Slling #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
436da6c28aaSamw #define	SPA_VERSION_FUID		SPA_VERSION_9
437a9799022Sck #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
438a9799022Sck #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
439a9799022Sck #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
440fa94a07fSbrendan #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
441088f3894Sahrens #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
442088f3894Sahrens #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
443088f3894Sahrens #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
444bb0ade09Sahrens #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
44574e7dc98SMatthew Ahrens #define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13
446d0f3f37eSMark Shellenbaum #define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14
44714843421SMatthew Ahrens #define	SPA_VERSION_USERSPACE		SPA_VERSION_15
448478ed9adSEric Taylor #define	SPA_VERSION_STMF_PROP		SPA_VERSION_16
449f94275ceSAdam Leventhal #define	SPA_VERSION_RAIDZ3		SPA_VERSION_17
450842727c2SChris Kirby #define	SPA_VERSION_USERREFS		SPA_VERSION_18
45188ecc943SGeorge Wilson #define	SPA_VERSION_HOLES		SPA_VERSION_19
452b24ab676SJeff Bonwick #define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20
453b24ab676SJeff Bonwick #define	SPA_VERSION_DEDUP		SPA_VERSION_21
45492241e0bSTom Erickson #define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22
4556e1f5caaSNeil Perrin #define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23
4560a586ceaSMark Shellenbaum #define	SPA_VERSION_SA			SPA_VERSION_24
4573f9d6ad7SLin Ling #define	SPA_VERSION_SCAN		SPA_VERSION_25
458cde58dbcSMatthew Ahrens #define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26
459cde58dbcSMatthew Ahrens #define	SPA_VERSION_DEADLISTS		SPA_VERSION_26
4606e0cbcaaSMatthew Ahrens #define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27
461cb04b873SMark J Musante #define	SPA_VERSION_MULTI_REPLACE	SPA_VERSION_28
462ad135b5dSChristopher Siden #define	SPA_VERSION_BEFORE_FEATURES	SPA_VERSION_28
463ad135b5dSChristopher Siden #define	SPA_VERSION_FEATURES		SPA_VERSION_5000
464ad135b5dSChristopher Siden 
465ad135b5dSChristopher Siden #define	SPA_VERSION_IS_SUPPORTED(v) \
466ad135b5dSChristopher Siden 	(((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
467ad135b5dSChristopher Siden 	((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
468e7437265Sahrens 
469e7437265Sahrens /*
470e7437265Sahrens  * ZPL version - rev'd whenever an incompatible on-disk format change
471e7437265Sahrens  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
472e7437265Sahrens  * also update the version_table[] and help message in zfs_prop.c.
473e7437265Sahrens  *
474e7437265Sahrens  * When changing, be sure to teach GRUB how to read the new format!
475478ed9adSEric Taylor  * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
476e7437265Sahrens  */
477e7437265Sahrens #define	ZPL_VERSION_1			1ULL
478e7437265Sahrens #define	ZPL_VERSION_2			2ULL
479da6c28aaSamw #define	ZPL_VERSION_3			3ULL
48014843421SMatthew Ahrens #define	ZPL_VERSION_4			4ULL
4810a586ceaSMark Shellenbaum #define	ZPL_VERSION_5			5ULL
4820a586ceaSMark Shellenbaum #define	ZPL_VERSION			ZPL_VERSION_5
4830a586ceaSMark Shellenbaum #define	ZPL_VERSION_STRING		"5"
484e7437265Sahrens 
485e7437265Sahrens #define	ZPL_VERSION_INITIAL		ZPL_VERSION_1
486e7437265Sahrens #define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2
487da6c28aaSamw #define	ZPL_VERSION_FUID		ZPL_VERSION_3
488de8267e0Stimh #define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3
489da6c28aaSamw #define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3
49014843421SMatthew Ahrens #define	ZPL_VERSION_USERSPACE		ZPL_VERSION_4
4910a586ceaSMark Shellenbaum #define	ZPL_VERSION_SA			ZPL_VERSION_5
492eaca9bbdSeschrock 
493468c413aSTim Haley /* Rewind request information */
494c8ee1847SVictor Latushkin #define	ZPOOL_NO_REWIND		1  /* No policy - default behavior */
495c8ee1847SVictor Latushkin #define	ZPOOL_NEVER_REWIND	2  /* Do not search for best txg or rewind */
496c8ee1847SVictor Latushkin #define	ZPOOL_TRY_REWIND	4  /* Search for best txg, but do not rewind */
497c8ee1847SVictor Latushkin #define	ZPOOL_DO_REWIND		8  /* Rewind to best txg w/in deferred frees */
498c8ee1847SVictor Latushkin #define	ZPOOL_EXTREME_REWIND	16 /* Allow extreme measures to find best txg */
499c8ee1847SVictor Latushkin #define	ZPOOL_REWIND_MASK	28 /* All the possible rewind bits */
500c8ee1847SVictor Latushkin #define	ZPOOL_REWIND_POLICIES	31 /* All the possible policy bits */
501468c413aSTim Haley 
502468c413aSTim Haley typedef struct zpool_rewind_policy {
503468c413aSTim Haley 	uint32_t	zrp_request;	/* rewind behavior requested */
504c8ee1847SVictor Latushkin 	uint64_t	zrp_maxmeta;	/* max acceptable meta-data errors */
505c8ee1847SVictor Latushkin 	uint64_t	zrp_maxdata;	/* max acceptable data errors */
506468c413aSTim Haley 	uint64_t	zrp_txg;	/* specific txg to load */
507468c413aSTim Haley } zpool_rewind_policy_t;
508468c413aSTim Haley 
509fa9e4066Sahrens /*
510fa9e4066Sahrens  * The following are configuration names used in the nvlist describing a pool's
511fa9e4066Sahrens  * configuration.
512fa9e4066Sahrens  */
513fa9e4066Sahrens #define	ZPOOL_CONFIG_VERSION		"version"
514fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_NAME		"name"
515fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_STATE		"state"
516fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_TXG		"txg"
517fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
518fa9e4066Sahrens #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
519fa9e4066Sahrens #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
520fa9e4066Sahrens #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
521fa9e4066Sahrens #define	ZPOOL_CONFIG_TYPE		"type"
522fa9e4066Sahrens #define	ZPOOL_CONFIG_CHILDREN		"children"
523fa9e4066Sahrens #define	ZPOOL_CONFIG_ID			"id"
524fa9e4066Sahrens #define	ZPOOL_CONFIG_GUID		"guid"
525fa9e4066Sahrens #define	ZPOOL_CONFIG_PATH		"path"
526fa9e4066Sahrens #define	ZPOOL_CONFIG_DEVID		"devid"
527fa9e4066Sahrens #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
528fa9e4066Sahrens #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
529fa9e4066Sahrens #define	ZPOOL_CONFIG_ASHIFT		"ashift"
530fa9e4066Sahrens #define	ZPOOL_CONFIG_ASIZE		"asize"
531fa9e4066Sahrens #define	ZPOOL_CONFIG_DTL		"DTL"
5323f9d6ad7SLin Ling #define	ZPOOL_CONFIG_SCAN_STATS		"scan_stats"	/* not stored on disk */
5333f9d6ad7SLin Ling #define	ZPOOL_CONFIG_VDEV_STATS		"vdev_stats"	/* not stored on disk */
534afefbcddSeschrock #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
535ea8dc4b6Seschrock #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
536ea8dc4b6Seschrock #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
53799653d4eSeschrock #define	ZPOOL_CONFIG_SPARES		"spares"
53899653d4eSeschrock #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
53999653d4eSeschrock #define	ZPOOL_CONFIG_NPARITY		"nparity"
54095173954Sek #define	ZPOOL_CONFIG_HOSTID		"hostid"
54195173954Sek #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
54211027bc7STim Haley #define	ZPOOL_CONFIG_LOADED_TIME	"initial_load_time"
5433d7072f8Seschrock #define	ZPOOL_CONFIG_UNSPARE		"unspare"
5443d7072f8Seschrock #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
5458654d025Sperrin #define	ZPOOL_CONFIG_IS_LOG		"is_log"
546fa94a07fSbrendan #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
54788ecc943SGeorge Wilson #define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"
54888ecc943SGeorge Wilson #define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"
54988ecc943SGeorge Wilson #define	ZPOOL_CONFIG_IS_HOLE		"is_hole"
5509eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"
5519eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"
5529eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"
5531195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT		"splitcfg"
5541195e687SMark J Musante #define	ZPOOL_CONFIG_ORIG_GUID		"orig_guid"
5551195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT_GUID		"split_guid"
5561195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT_LIST		"guid_list"
5573f9d6ad7SLin Ling #define	ZPOOL_CONFIG_REMOVING		"removing"
558b4952e17SGeorge Wilson #define	ZPOOL_CONFIG_RESILVER_TXG	"resilver_txg"
5598704186eSDan McDonald #define	ZPOOL_CONFIG_COMMENT		"comment"
560e14bb325SJeff Bonwick #define	ZPOOL_CONFIG_SUSPENDED		"suspended"	/* not stored on disk */
561e7cbe64fSgw #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp"	/* not stored on disk */
562e7cbe64fSgw #define	ZPOOL_CONFIG_BOOTFS		"bootfs"	/* not stored on disk */
5634b964adaSGeorge Wilson #define	ZPOOL_CONFIG_MISSING_DEVICES	"missing_vdevs"	/* not stored on disk */
5644b964adaSGeorge Wilson #define	ZPOOL_CONFIG_LOAD_INFO		"load_info"	/* not stored on disk */
565ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_REWIND_INFO	"rewind_info"	/* not stored on disk */
566ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_UNSUP_FEAT		"unsup_feat"	/* not stored on disk */
56757221772SChristopher Siden #define	ZPOOL_CONFIG_ENABLED_FEAT	"enabled_feat"	/* not stored on disk */
568ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_CAN_RDONLY		"can_rdonly"	/* not stored on disk */
569ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_FEATURES_FOR_READ	"features_for_read"
570ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_FEATURE_STATS	"feature_stats"	/* not stored on disk */
571215198a6SJoe Stein #define	ZPOOL_CONFIG_VDEV_TOP_ZAP	"com.delphix:vdev_zap_top"
572215198a6SJoe Stein #define	ZPOOL_CONFIG_VDEV_LEAF_ZAP	"com.delphix:vdev_zap_leaf"
573215198a6SJoe Stein #define	ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS	"com.delphix:has_per_vdev_zaps"
5743d7072f8Seschrock /*
5753d7072f8Seschrock  * The persistent vdev state is stored as separate values rather than a single
5763d7072f8Seschrock  * 'vdev_state' entry.  This is because a device can be in multiple states, such
5773d7072f8Seschrock  * as offline and degraded.
5783d7072f8Seschrock  */
5793d7072f8Seschrock #define	ZPOOL_CONFIG_OFFLINE		"offline"
5803d7072f8Seschrock #define	ZPOOL_CONFIG_FAULTED		"faulted"
5813d7072f8Seschrock #define	ZPOOL_CONFIG_DEGRADED		"degraded"
5823d7072f8Seschrock #define	ZPOOL_CONFIG_REMOVED		"removed"
5836809eb4eSEric Schrock #define	ZPOOL_CONFIG_FRU		"fru"
584069f55e2SEric Schrock #define	ZPOOL_CONFIG_AUX_STATE		"aux_state"
585fa9e4066Sahrens 
586468c413aSTim Haley /* Rewind policy parameters */
587468c413aSTim Haley #define	ZPOOL_REWIND_POLICY		"rewind-policy"
588468c413aSTim Haley #define	ZPOOL_REWIND_REQUEST		"rewind-request"
589468c413aSTim Haley #define	ZPOOL_REWIND_REQUEST_TXG	"rewind-request-txg"
590468c413aSTim Haley #define	ZPOOL_REWIND_META_THRESH	"rewind-meta-thresh"
591468c413aSTim Haley #define	ZPOOL_REWIND_DATA_THRESH	"rewind-data-thresh"
592468c413aSTim Haley 
593468c413aSTim Haley /* Rewind data discovered */
594468c413aSTim Haley #define	ZPOOL_CONFIG_LOAD_TIME		"rewind_txg_ts"
595468c413aSTim Haley #define	ZPOOL_CONFIG_LOAD_DATA_ERRORS	"verify_data_errors"
596468c413aSTim Haley #define	ZPOOL_CONFIG_REWIND_TIME	"seconds_of_rewind"
597468c413aSTim Haley 
598fa9e4066Sahrens #define	VDEV_TYPE_ROOT			"root"
599fa9e4066Sahrens #define	VDEV_TYPE_MIRROR		"mirror"
600fa9e4066Sahrens #define	VDEV_TYPE_REPLACING		"replacing"
601fa9e4066Sahrens #define	VDEV_TYPE_RAIDZ			"raidz"
602fa9e4066Sahrens #define	VDEV_TYPE_DISK			"disk"
603fa9e4066Sahrens #define	VDEV_TYPE_FILE			"file"
604fa9e4066Sahrens #define	VDEV_TYPE_MISSING		"missing"
60588ecc943SGeorge Wilson #define	VDEV_TYPE_HOLE			"hole"
60699653d4eSeschrock #define	VDEV_TYPE_SPARE			"spare"
6078654d025Sperrin #define	VDEV_TYPE_LOG			"log"
608fa94a07fSbrendan #define	VDEV_TYPE_L2CACHE		"l2cache"
609fa9e4066Sahrens 
610fa9e4066Sahrens /*
611fa9e4066Sahrens  * This is needed in userland to report the minimum necessary device size.
6124b5c8e93SMatthew Ahrens  *
6134b5c8e93SMatthew Ahrens  * Note that the zfs test suite uses 64MB vdevs.
614fa9e4066Sahrens  */
615fa9e4066Sahrens #define	SPA_MINDEVSIZE		(64ULL << 20)
616fa9e4066Sahrens 
6172e4c9986SGeorge Wilson /*
6182e4c9986SGeorge Wilson  * Set if the fragmentation has not yet been calculated. This can happen
6192e4c9986SGeorge Wilson  * because the space maps have not been upgraded or the histogram feature
6202e4c9986SGeorge Wilson  * is not enabled.
6212e4c9986SGeorge Wilson  */
6222e4c9986SGeorge Wilson #define	ZFS_FRAG_INVALID	UINT64_MAX
6232e4c9986SGeorge Wilson 
624fa9e4066Sahrens /*
625fa9e4066Sahrens  * The location of the pool configuration repository, shared between kernel and
626fa9e4066Sahrens  * userland.
627fa9e4066Sahrens  */
628c5904d13Seschrock #define	ZPOOL_CACHE		"/etc/zfs/zpool.cache"
629fa9e4066Sahrens 
630fa9e4066Sahrens /*
631fa9e4066Sahrens  * vdev states are ordered from least to most healthy.
632fa9e4066Sahrens  * A vdev that's CANT_OPEN or below is considered unusable.
633fa9e4066Sahrens  */
634fa9e4066Sahrens typedef enum vdev_state {
635fa9e4066Sahrens 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
636fa9e4066Sahrens 	VDEV_STATE_CLOSED,	/* Not currently open			*/
637fa9e4066Sahrens 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
6383d7072f8Seschrock 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
639fa9e4066Sahrens 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
6403d7072f8Seschrock 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
641fa9e4066Sahrens 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
642fa9e4066Sahrens 	VDEV_STATE_HEALTHY	/* Presumed good			*/
643fa9e4066Sahrens } vdev_state_t;
644fa9e4066Sahrens 
6453d7072f8Seschrock #define	VDEV_STATE_ONLINE	VDEV_STATE_HEALTHY
6463d7072f8Seschrock 
647fa9e4066Sahrens /*
648fa9e4066Sahrens  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
649fa9e4066Sahrens  * of the vdev stats structure uses these constants to distinguish why.
650fa9e4066Sahrens  */
651fa9e4066Sahrens typedef enum vdev_aux {
652fa9e4066Sahrens 	VDEV_AUX_NONE,		/* no error				*/
653fa9e4066Sahrens 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
654fa9e4066Sahrens 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
655fa9e4066Sahrens 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
656fa9e4066Sahrens 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
657fa9e4066Sahrens 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
658eaca9bbdSeschrock 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
659eaca9bbdSeschrock 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
66099653d4eSeschrock 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
661ad135b5dSChristopher Siden 	VDEV_AUX_UNSUP_FEAT,	/* unsupported features			*/
6623d7072f8Seschrock 	VDEV_AUX_SPARED,	/* hot spare used in another pool	*/
66332b87932Sek 	VDEV_AUX_ERR_EXCEEDED,	/* too many errors			*/
664b87f3af3Sperrin 	VDEV_AUX_IO_FAILURE,	/* experienced I/O failure		*/
665069f55e2SEric Schrock 	VDEV_AUX_BAD_LOG,	/* cannot read log chain(s)		*/
6661195e687SMark J Musante 	VDEV_AUX_EXTERNAL,	/* external diagnosis			*/
6671195e687SMark J Musante 	VDEV_AUX_SPLIT_POOL	/* vdev was split off into another pool	*/
668fa9e4066Sahrens } vdev_aux_t;
669fa9e4066Sahrens 
670fa9e4066Sahrens /*
67146a2abf2Seschrock  * pool state.  The following states are written to disk as part of the normal
672fa94a07fSbrendan  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
673fa94a07fSbrendan  * states are software abstractions used at various levels to communicate
674fa94a07fSbrendan  * pool state.
675fa9e4066Sahrens  */
676fa9e4066Sahrens typedef enum pool_state {
677fa9e4066Sahrens 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
678fa9e4066Sahrens 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
679fa9e4066Sahrens 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
68099653d4eSeschrock 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
681fa94a07fSbrendan 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
682fa9e4066Sahrens 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
68346a2abf2Seschrock 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
68446a2abf2Seschrock 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
685fa9e4066Sahrens } pool_state_t;
686fa9e4066Sahrens 
687fa9e4066Sahrens /*
6883f9d6ad7SLin Ling  * Scan Functions.
689fa9e4066Sahrens  */
6903f9d6ad7SLin Ling typedef enum pool_scan_func {
6913f9d6ad7SLin Ling 	POOL_SCAN_NONE,
6923f9d6ad7SLin Ling 	POOL_SCAN_SCRUB,
6933f9d6ad7SLin Ling 	POOL_SCAN_RESILVER,
6943f9d6ad7SLin Ling 	POOL_SCAN_FUNCS
6953f9d6ad7SLin Ling } pool_scan_func_t;
696fa9e4066Sahrens 
6971702cce7SAlek Pinchuk /*
6981702cce7SAlek Pinchuk  * Used to control scrub pause and resume.
6991702cce7SAlek Pinchuk  */
7001702cce7SAlek Pinchuk typedef enum pool_scrub_cmd {
7011702cce7SAlek Pinchuk 	POOL_SCRUB_NORMAL = 0,
7021702cce7SAlek Pinchuk 	POOL_SCRUB_PAUSE,
7031702cce7SAlek Pinchuk 	POOL_SCRUB_FLAGS_END
7041702cce7SAlek Pinchuk } pool_scrub_cmd_t;
7051702cce7SAlek Pinchuk 
7061702cce7SAlek Pinchuk 
707fa9e4066Sahrens /*
708fa9e4066Sahrens  * ZIO types.  Needed to interpret vdev statistics below.
709fa9e4066Sahrens  */
710fa9e4066Sahrens typedef enum zio_type {
711fa9e4066Sahrens 	ZIO_TYPE_NULL = 0,
712fa9e4066Sahrens 	ZIO_TYPE_READ,
713fa9e4066Sahrens 	ZIO_TYPE_WRITE,
714fa9e4066Sahrens 	ZIO_TYPE_FREE,
715fa9e4066Sahrens 	ZIO_TYPE_CLAIM,
716fa9e4066Sahrens 	ZIO_TYPE_IOCTL,
717fa9e4066Sahrens 	ZIO_TYPES
718fa9e4066Sahrens } zio_type_t;
719fa9e4066Sahrens 
7203f9d6ad7SLin Ling /*
7213f9d6ad7SLin Ling  * Pool statistics.  Note: all fields should be 64-bit because this
7223f9d6ad7SLin Ling  * is passed between kernel and userland as an nvlist uint64 array.
7233f9d6ad7SLin Ling  */
7243f9d6ad7SLin Ling typedef struct pool_scan_stat {
7253f9d6ad7SLin Ling 	/* values stored on disk */
7263f9d6ad7SLin Ling 	uint64_t	pss_func;	/* pool_scan_func_t */
7273f9d6ad7SLin Ling 	uint64_t	pss_state;	/* dsl_scan_state_t */
7283f9d6ad7SLin Ling 	uint64_t	pss_start_time;	/* scan start time */
7293f9d6ad7SLin Ling 	uint64_t	pss_end_time;	/* scan end time */
7303f9d6ad7SLin Ling 	uint64_t	pss_to_examine;	/* total bytes to scan */
7313f9d6ad7SLin Ling 	uint64_t	pss_examined;	/* total examined bytes	*/
7323f9d6ad7SLin Ling 	uint64_t	pss_to_process; /* total bytes to process */
7333f9d6ad7SLin Ling 	uint64_t	pss_processed;	/* total processed bytes */
7343f9d6ad7SLin Ling 	uint64_t	pss_errors;	/* scan errors	*/
7353f9d6ad7SLin Ling 
7363f9d6ad7SLin Ling 	/* values not stored on disk */
7373f9d6ad7SLin Ling 	uint64_t	pss_pass_exam;	/* examined bytes per scan pass */
7383f9d6ad7SLin Ling 	uint64_t	pss_pass_start;	/* start time of a scan pass */
7391702cce7SAlek Pinchuk 	uint64_t	pss_pass_scrub_pause; /* pause time of a scurb pass */
7401702cce7SAlek Pinchuk 	/* cumulative time scrub spent paused, needed for rate calculation */
7411702cce7SAlek Pinchuk 	uint64_t	pss_pass_scrub_spent_paused;
7423f9d6ad7SLin Ling } pool_scan_stat_t;
7433f9d6ad7SLin Ling 
7443f9d6ad7SLin Ling typedef enum dsl_scan_state {
7453f9d6ad7SLin Ling 	DSS_NONE,
7463f9d6ad7SLin Ling 	DSS_SCANNING,
7473f9d6ad7SLin Ling 	DSS_FINISHED,
7483f9d6ad7SLin Ling 	DSS_CANCELED,
7493f9d6ad7SLin Ling 	DSS_NUM_STATES
7503f9d6ad7SLin Ling } dsl_scan_state_t;
7513f9d6ad7SLin Ling 
7523f9d6ad7SLin Ling 
753fa9e4066Sahrens /*
754fa9e4066Sahrens  * Vdev statistics.  Note: all fields should be 64-bit because this
755fa9e4066Sahrens  * is passed between kernel and userland as an nvlist uint64 array.
756fa9e4066Sahrens  */
757fa9e4066Sahrens typedef struct vdev_stat {
758fa9e4066Sahrens 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
759fa9e4066Sahrens 	uint64_t	vs_state;		/* vdev state		*/
760fa9e4066Sahrens 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
761fa9e4066Sahrens 	uint64_t	vs_alloc;		/* space allocated	*/
762fa9e4066Sahrens 	uint64_t	vs_space;		/* total capacity	*/
76399653d4eSeschrock 	uint64_t	vs_dspace;		/* deflated capacity	*/
7642a79c5feSlling 	uint64_t	vs_rsize;		/* replaceable dev size */
7654263d13fSGeorge Wilson 	uint64_t	vs_esize;		/* expandable dev size */
766fa9e4066Sahrens 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
767fa9e4066Sahrens 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
768fa9e4066Sahrens 	uint64_t	vs_read_errors;		/* read errors		*/
769fa9e4066Sahrens 	uint64_t	vs_write_errors;	/* write errors		*/
770fa9e4066Sahrens 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
771fa9e4066Sahrens 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
7723f9d6ad7SLin Ling 	uint64_t	vs_scan_removing;	/* removing?	*/
7733f9d6ad7SLin Ling 	uint64_t	vs_scan_processed;	/* scan processed bytes	*/
7742e4c9986SGeorge Wilson 	uint64_t	vs_fragmentation;	/* device fragmentation */
775fa9e4066Sahrens } vdev_stat_t;
776fa9e4066Sahrens 
7779eb19f4dSGeorge Wilson /*
7789eb19f4dSGeorge Wilson  * DDT statistics.  Note: all fields should be 64-bit because this
7799eb19f4dSGeorge Wilson  * is passed between kernel and userland as an nvlist uint64 array.
7809eb19f4dSGeorge Wilson  */
7819eb19f4dSGeorge Wilson typedef struct ddt_object {
7829eb19f4dSGeorge Wilson 	uint64_t	ddo_count;	/* number of elments in ddt 	*/
7839eb19f4dSGeorge Wilson 	uint64_t	ddo_dspace;	/* size of ddt on disk		*/
7849eb19f4dSGeorge Wilson 	uint64_t	ddo_mspace;	/* size of ddt in-core		*/
7859eb19f4dSGeorge Wilson } ddt_object_t;
7869eb19f4dSGeorge Wilson 
7879eb19f4dSGeorge Wilson typedef struct ddt_stat {
7889eb19f4dSGeorge Wilson 	uint64_t	dds_blocks;	/* blocks			*/
7899eb19f4dSGeorge Wilson 	uint64_t	dds_lsize;	/* logical size			*/
7909eb19f4dSGeorge Wilson 	uint64_t	dds_psize;	/* physical size		*/
7919eb19f4dSGeorge Wilson 	uint64_t	dds_dsize;	/* deflated allocated size	*/
7929eb19f4dSGeorge Wilson 	uint64_t	dds_ref_blocks;	/* referenced blocks		*/
7939eb19f4dSGeorge Wilson 	uint64_t	dds_ref_lsize;	/* referenced lsize * refcnt	*/
7949eb19f4dSGeorge Wilson 	uint64_t	dds_ref_psize;	/* referenced psize * refcnt	*/
7959eb19f4dSGeorge Wilson 	uint64_t	dds_ref_dsize;	/* referenced dsize * refcnt	*/
7969eb19f4dSGeorge Wilson } ddt_stat_t;
7979eb19f4dSGeorge Wilson 
7989eb19f4dSGeorge Wilson typedef struct ddt_histogram {
7999eb19f4dSGeorge Wilson 	ddt_stat_t	ddh_stat[64];	/* power-of-two histogram buckets */
8009eb19f4dSGeorge Wilson } ddt_histogram_t;
8019eb19f4dSGeorge Wilson 
802e7cbe64fSgw #define	ZVOL_DRIVER	"zvol"
803fa9e4066Sahrens #define	ZFS_DRIVER	"zfs"
804fa9e4066Sahrens #define	ZFS_DEV		"/dev/zfs"
8056401734dSWill Andrews #define	ZFS_DISK_ROOT	"/dev/dsk"
8066401734dSWill Andrews #define	ZFS_DISK_ROOTD	ZFS_DISK_ROOT "/"
8076401734dSWill Andrews #define	ZFS_RDISK_ROOT	"/dev/rdsk"
8086401734dSWill Andrews #define	ZFS_RDISK_ROOTD	ZFS_RDISK_ROOT "/"
809fa9e4066Sahrens 
810681d9761SEric Taylor /* general zvol path */
811681d9761SEric Taylor #define	ZVOL_DIR		"/dev/zvol"
812681d9761SEric Taylor /* expansion */
813573ca77eSGeorge Wilson #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zfs@0:"
814681d9761SEric Taylor /* for dump and swap */
815681d9761SEric Taylor #define	ZVOL_FULL_DEV_DIR	ZVOL_DIR "/dsk/"
816681d9761SEric Taylor #define	ZVOL_FULL_RDEV_DIR	ZVOL_DIR "/rdsk/"
817fa9e4066Sahrens 
818fa9e4066Sahrens #define	ZVOL_PROP_NAME		"name"
819c1449561SEric Taylor #define	ZVOL_DEFAULT_BLOCKSIZE	8192
820fa9e4066Sahrens 
821fa9e4066Sahrens /*
822fa9e4066Sahrens  * /dev/zfs ioctl numbers.
823fa9e4066Sahrens  */
824fa9e4066Sahrens typedef enum zfs_ioc {
8254445fffbSMatthew Ahrens 	ZFS_IOC_FIRST =	('Z' << 8),
8264445fffbSMatthew Ahrens 	ZFS_IOC = ZFS_IOC_FIRST,
8274445fffbSMatthew Ahrens 	ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
828fa9e4066Sahrens 	ZFS_IOC_POOL_DESTROY,
829fa9e4066Sahrens 	ZFS_IOC_POOL_IMPORT,
830fa9e4066Sahrens 	ZFS_IOC_POOL_EXPORT,
831fa9e4066Sahrens 	ZFS_IOC_POOL_CONFIGS,
832fa9e4066Sahrens 	ZFS_IOC_POOL_STATS,
833fa9e4066Sahrens 	ZFS_IOC_POOL_TRYIMPORT,
8343f9d6ad7SLin Ling 	ZFS_IOC_POOL_SCAN,
835fa9e4066Sahrens 	ZFS_IOC_POOL_FREEZE,
836eaca9bbdSeschrock 	ZFS_IOC_POOL_UPGRADE,
83706eeb2adSek 	ZFS_IOC_POOL_GET_HISTORY,
838fa9e4066Sahrens 	ZFS_IOC_VDEV_ADD,
839fa9e4066Sahrens 	ZFS_IOC_VDEV_REMOVE,
8403d7072f8Seschrock 	ZFS_IOC_VDEV_SET_STATE,
841fa9e4066Sahrens 	ZFS_IOC_VDEV_ATTACH,
842fa9e4066Sahrens 	ZFS_IOC_VDEV_DETACH,
843c67d9675Seschrock 	ZFS_IOC_VDEV_SETPATH,
8446809eb4eSEric Schrock 	ZFS_IOC_VDEV_SETFRU,
845fa9e4066Sahrens 	ZFS_IOC_OBJSET_STATS,
846de8267e0Stimh 	ZFS_IOC_OBJSET_ZPLPROPS,
847fa9e4066Sahrens 	ZFS_IOC_DATASET_LIST_NEXT,
848fa9e4066Sahrens 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
849fa9e4066Sahrens 	ZFS_IOC_SET_PROP,
850fa9e4066Sahrens 	ZFS_IOC_CREATE,
851fa9e4066Sahrens 	ZFS_IOC_DESTROY,
852fa9e4066Sahrens 	ZFS_IOC_ROLLBACK,
853fa9e4066Sahrens 	ZFS_IOC_RENAME,
8543cb34c60Sahrens 	ZFS_IOC_RECV,
8553cb34c60Sahrens 	ZFS_IOC_SEND,
856ea8dc4b6Seschrock 	ZFS_IOC_INJECT_FAULT,
857ea8dc4b6Seschrock 	ZFS_IOC_CLEAR_FAULT,
858ea8dc4b6Seschrock 	ZFS_IOC_INJECT_LIST_NEXT,
859ea8dc4b6Seschrock 	ZFS_IOC_ERROR_LOG,
860ea8dc4b6Seschrock 	ZFS_IOC_CLEAR,
8611d452cf5Sahrens 	ZFS_IOC_PROMOTE,
86255434c77Sek 	ZFS_IOC_SNAPSHOT,
86355434c77Sek 	ZFS_IOC_DSOBJ_TO_DSNAME,
864b1b8ab34Slling 	ZFS_IOC_OBJ_TO_PATH,
865b1b8ab34Slling 	ZFS_IOC_POOL_SET_PROPS,
866ecd6cf80Smarks 	ZFS_IOC_POOL_GET_PROPS,
867ecd6cf80Smarks 	ZFS_IOC_SET_FSACL,
868ecd6cf80Smarks 	ZFS_IOC_GET_FSACL,
869e45ce728Sahrens 	ZFS_IOC_SHARE,
870743a77edSAlan Wright 	ZFS_IOC_INHERIT_PROP,
87114843421SMatthew Ahrens 	ZFS_IOC_SMB_ACL,
87214843421SMatthew Ahrens 	ZFS_IOC_USERSPACE_ONE,
87314843421SMatthew Ahrens 	ZFS_IOC_USERSPACE_MANY,
874842727c2SChris Kirby 	ZFS_IOC_USERSPACE_UPGRADE,
875842727c2SChris Kirby 	ZFS_IOC_HOLD,
876842727c2SChris Kirby 	ZFS_IOC_RELEASE,
87792241e0bSTom Erickson 	ZFS_IOC_GET_HOLDS,
8781195e687SMark J Musante 	ZFS_IOC_OBJSET_RECVD_PROPS,
87999d5e173STim Haley 	ZFS_IOC_VDEV_SPLIT,
88099d5e173STim Haley 	ZFS_IOC_NEXT_OBJ,
88199d5e173STim Haley 	ZFS_IOC_DIFF,
88299d5e173STim Haley 	ZFS_IOC_TMP_SNAPSHOT,
883e9103aaeSGarrett D'Amore 	ZFS_IOC_OBJ_TO_STATS,
88419b94df9SMatthew Ahrens 	ZFS_IOC_SPACE_WRITTEN,
88519b94df9SMatthew Ahrens 	ZFS_IOC_SPACE_SNAPS,
8864445fffbSMatthew Ahrens 	ZFS_IOC_DESTROY_SNAPS,
8874263d13fSGeorge Wilson 	ZFS_IOC_POOL_REGUID,
8884e3c9f44SBill Pijewski 	ZFS_IOC_POOL_REOPEN,
8894445fffbSMatthew Ahrens 	ZFS_IOC_SEND_PROGRESS,
8904445fffbSMatthew Ahrens 	ZFS_IOC_LOG_HISTORY,
8914445fffbSMatthew Ahrens 	ZFS_IOC_SEND_NEW,
8924445fffbSMatthew Ahrens 	ZFS_IOC_SEND_SPACE,
8934445fffbSMatthew Ahrens 	ZFS_IOC_CLONE,
89478f17100SMatthew Ahrens 	ZFS_IOC_BOOKMARK,
89578f17100SMatthew Ahrens 	ZFS_IOC_GET_BOOKMARKS,
89678f17100SMatthew Ahrens 	ZFS_IOC_DESTROY_BOOKMARKS,
897dfc11533SChris Williamson 	ZFS_IOC_CHANNEL_PROGRAM,
8984445fffbSMatthew Ahrens 	ZFS_IOC_LAST
899fa9e4066Sahrens } zfs_ioc_t;
900fa9e4066Sahrens 
901ea8dc4b6Seschrock /*
902ea8dc4b6Seschrock  * Internal SPA load state.  Used by FMA diagnosis engine.
903ea8dc4b6Seschrock  */
904ea8dc4b6Seschrock typedef enum {
9059eb19f4dSGeorge Wilson 	SPA_LOAD_NONE,		/* no load in progress	*/
9069eb19f4dSGeorge Wilson 	SPA_LOAD_OPEN,		/* normal open		*/
9079eb19f4dSGeorge Wilson 	SPA_LOAD_IMPORT,	/* import in progress	*/
908468c413aSTim Haley 	SPA_LOAD_TRYIMPORT,	/* tryimport in progress */
9099eb19f4dSGeorge Wilson 	SPA_LOAD_RECOVER,	/* recovery requested	*/
9100f7643c7SGeorge Wilson 	SPA_LOAD_ERROR,		/* load failed		*/
9110f7643c7SGeorge Wilson 	SPA_LOAD_CREATE		/* creation in progress */
912ea8dc4b6Seschrock } spa_load_state_t;
913ea8dc4b6Seschrock 
914e9dbad6fSeschrock /*
915e9dbad6fSeschrock  * Bookmark name values.
916e9dbad6fSeschrock  */
91755434c77Sek #define	ZPOOL_ERR_LIST		"error list"
918e9dbad6fSeschrock #define	ZPOOL_ERR_DATASET	"dataset"
919e9dbad6fSeschrock #define	ZPOOL_ERR_OBJECT	"object"
920e9dbad6fSeschrock 
92106eeb2adSek #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
92206eeb2adSek 
92306eeb2adSek /*
92406eeb2adSek  * The following are names used in the nvlist describing
92506eeb2adSek  * the pool's history log.
92606eeb2adSek  */
92706eeb2adSek #define	ZPOOL_HIST_RECORD	"history record"
92806eeb2adSek #define	ZPOOL_HIST_TIME		"history time"
92906eeb2adSek #define	ZPOOL_HIST_CMD		"history command"
930ecd6cf80Smarks #define	ZPOOL_HIST_WHO		"history who"
931ecd6cf80Smarks #define	ZPOOL_HIST_ZONE		"history zone"
932ecd6cf80Smarks #define	ZPOOL_HIST_HOST		"history hostname"
933ecd6cf80Smarks #define	ZPOOL_HIST_TXG		"history txg"
934ecd6cf80Smarks #define	ZPOOL_HIST_INT_EVENT	"history internal event"
935ecd6cf80Smarks #define	ZPOOL_HIST_INT_STR	"history internal str"
9364445fffbSMatthew Ahrens #define	ZPOOL_HIST_INT_NAME	"internal_name"
9374445fffbSMatthew Ahrens #define	ZPOOL_HIST_IOCTL	"ioctl"
9384445fffbSMatthew Ahrens #define	ZPOOL_HIST_INPUT_NVL	"in_nvl"
9394445fffbSMatthew Ahrens #define	ZPOOL_HIST_OUTPUT_NVL	"out_nvl"
9404445fffbSMatthew Ahrens #define	ZPOOL_HIST_DSNAME	"dsname"
9414445fffbSMatthew Ahrens #define	ZPOOL_HIST_DSID		"dsid"
942dfc11533SChris Williamson #define	ZPOOL_HIST_ERRNO	"errno"
94306eeb2adSek 
9443d7072f8Seschrock /*
9453d7072f8Seschrock  * Flags for ZFS_IOC_VDEV_SET_STATE
9463d7072f8Seschrock  */
9473d7072f8Seschrock #define	ZFS_ONLINE_CHECKREMOVE	0x1
9483d7072f8Seschrock #define	ZFS_ONLINE_UNSPARE	0x2
9493d7072f8Seschrock #define	ZFS_ONLINE_FORCEFAULT	0x4
950573ca77eSGeorge Wilson #define	ZFS_ONLINE_EXPAND	0x8
9513d7072f8Seschrock #define	ZFS_OFFLINE_TEMPORARY	0x1
9523d7072f8Seschrock 
9534b964adaSGeorge Wilson /*
9544b964adaSGeorge Wilson  * Flags for ZFS_IOC_POOL_IMPORT
9554b964adaSGeorge Wilson  */
9564b964adaSGeorge Wilson #define	ZFS_IMPORT_NORMAL	0x0
9574b964adaSGeorge Wilson #define	ZFS_IMPORT_VERBATIM	0x1
9584b964adaSGeorge Wilson #define	ZFS_IMPORT_ANY_HOST	0x2
9594b964adaSGeorge Wilson #define	ZFS_IMPORT_MISSING_LOG	0x4
960f9af39baSGeorge Wilson #define	ZFS_IMPORT_ONLY		0x8
9614b964adaSGeorge Wilson 
962dfc11533SChris Williamson /*
963dfc11533SChris Williamson  * Channel program argument/return nvlist keys and defaults.
964dfc11533SChris Williamson  */
965dfc11533SChris Williamson #define	ZCP_ARG_PROGRAM		"program"
966dfc11533SChris Williamson #define	ZCP_ARG_ARGLIST		"arg"
967*a3b28680SSerapheim Dimitropoulos #define	ZCP_ARG_SYNC		"sync"
968dfc11533SChris Williamson #define	ZCP_ARG_INSTRLIMIT	"instrlimit"
969dfc11533SChris Williamson #define	ZCP_ARG_MEMLIMIT	"memlimit"
970dfc11533SChris Williamson 
971dfc11533SChris Williamson #define	ZCP_ARG_CLIARGV		"argv"
972dfc11533SChris Williamson 
973dfc11533SChris Williamson #define	ZCP_RET_ERROR		"error"
974dfc11533SChris Williamson #define	ZCP_RET_RETURN		"return"
975dfc11533SChris Williamson 
976dfc11533SChris Williamson #define	ZCP_DEFAULT_INSTRLIMIT	(10 * 1000 * 1000)
977dfc11533SChris Williamson #define	ZCP_MAX_INSTRLIMIT	(10 * ZCP_DEFAULT_INSTRLIMIT)
978dfc11533SChris Williamson #define	ZCP_DEFAULT_MEMLIMIT	(10 * 1024 * 1024)
979dfc11533SChris Williamson #define	ZCP_MAX_MEMLIMIT	(10 * ZCP_DEFAULT_MEMLIMIT)
980dfc11533SChris Williamson 
9813d7072f8Seschrock /*
9823d7072f8Seschrock  * Sysevent payload members.  ZFS will generate the following sysevents with the
9833d7072f8Seschrock  * given payloads:
9843d7072f8Seschrock  *
9853d7072f8Seschrock  *	ESC_ZFS_RESILVER_START
9863d7072f8Seschrock  *	ESC_ZFS_RESILVER_END
9873d7072f8Seschrock  *	ESC_ZFS_POOL_DESTROY
988e9103aaeSGarrett D'Amore  *	ESC_ZFS_POOL_REGUID
9893d7072f8Seschrock  *
9903d7072f8Seschrock  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
9913d7072f8Seschrock  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
9923d7072f8Seschrock  *
9933d7072f8Seschrock  *	ESC_ZFS_VDEV_REMOVE
9943d7072f8Seschrock  *	ESC_ZFS_VDEV_CLEAR
9953d7072f8Seschrock  *	ESC_ZFS_VDEV_CHECK
9963d7072f8Seschrock  *
9973d7072f8Seschrock  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
9983d7072f8Seschrock  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
9993d7072f8Seschrock  *		ZFS_EV_VDEV_PATH	DATA_TYPE_STRING	(optional)
10003d7072f8Seschrock  *		ZFS_EV_VDEV_GUID	DATA_TYPE_UINT64
1001ce1577b0SDave Eddy  *
1002ce1577b0SDave Eddy  *	ESC_ZFS_HISTORY_EVENT
1003ce1577b0SDave Eddy  *
1004ce1577b0SDave Eddy  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
1005ce1577b0SDave Eddy  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
1006ce1577b0SDave Eddy  *		ZFS_EV_HIST_TIME	DATA_TYPE_UINT64	(optional)
1007ce1577b0SDave Eddy  *		ZFS_EV_HIST_CMD		DATA_TYPE_STRING	(optional)
1008ce1577b0SDave Eddy  *		ZFS_EV_HIST_WHO		DATA_TYPE_UINT64	(optional)
1009ce1577b0SDave Eddy  *		ZFS_EV_HIST_ZONE	DATA_TYPE_STRING	(optional)
1010ce1577b0SDave Eddy  *		ZFS_EV_HIST_HOST	DATA_TYPE_STRING	(optional)
1011ce1577b0SDave Eddy  *		ZFS_EV_HIST_TXG		DATA_TYPE_UINT64	(optional)
1012ce1577b0SDave Eddy  *		ZFS_EV_HIST_INT_EVENT	DATA_TYPE_UINT64	(optional)
1013ce1577b0SDave Eddy  *		ZFS_EV_HIST_INT_STR	DATA_TYPE_STRING	(optional)
1014ce1577b0SDave Eddy  *		ZFS_EV_HIST_INT_NAME	DATA_TYPE_STRING	(optional)
1015ce1577b0SDave Eddy  *		ZFS_EV_HIST_IOCTL	DATA_TYPE_STRING	(optional)
1016ce1577b0SDave Eddy  *		ZFS_EV_HIST_DSNAME	DATA_TYPE_STRING	(optional)
1017ce1577b0SDave Eddy  *		ZFS_EV_HIST_DSID	DATA_TYPE_UINT64	(optional)
1018ce1577b0SDave Eddy  *
1019ce1577b0SDave Eddy  * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1020ce1577b0SDave Eddy  * history log nvlist.  The keynames will be free of any spaces or other
1021ce1577b0SDave Eddy  * characters that could be potentially unexpected to consumers of the
1022ce1577b0SDave Eddy  * sysevents.
10233d7072f8Seschrock  */
10243d7072f8Seschrock #define	ZFS_EV_POOL_NAME	"pool_name"
10253d7072f8Seschrock #define	ZFS_EV_POOL_GUID	"pool_guid"
10263d7072f8Seschrock #define	ZFS_EV_VDEV_PATH	"vdev_path"
10273d7072f8Seschrock #define	ZFS_EV_VDEV_GUID	"vdev_guid"
1028ce1577b0SDave Eddy #define	ZFS_EV_HIST_TIME	"history_time"
1029ce1577b0SDave Eddy #define	ZFS_EV_HIST_CMD		"history_command"
1030ce1577b0SDave Eddy #define	ZFS_EV_HIST_WHO		"history_who"
1031ce1577b0SDave Eddy #define	ZFS_EV_HIST_ZONE	"history_zone"
1032ce1577b0SDave Eddy #define	ZFS_EV_HIST_HOST	"history_hostname"
1033ce1577b0SDave Eddy #define	ZFS_EV_HIST_TXG		"history_txg"
1034ce1577b0SDave Eddy #define	ZFS_EV_HIST_INT_EVENT	"history_internal_event"
1035ce1577b0SDave Eddy #define	ZFS_EV_HIST_INT_STR	"history_internal_str"
1036ce1577b0SDave Eddy #define	ZFS_EV_HIST_INT_NAME	"history_internal_name"
1037ce1577b0SDave Eddy #define	ZFS_EV_HIST_IOCTL	"history_ioctl"
1038ce1577b0SDave Eddy #define	ZFS_EV_HIST_DSNAME	"history_dsname"
1039ce1577b0SDave Eddy #define	ZFS_EV_HIST_DSID	"history_dsid"
10403d7072f8Seschrock 
1041fa9e4066Sahrens #ifdef	__cplusplus
1042fa9e4066Sahrens }
1043fa9e4066Sahrens #endif
1044fa9e4066Sahrens 
1045fa9e4066Sahrens #endif	/* _SYS_FS_ZFS_H */
1046