xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision 5dafeea3ebd2dd77affc802bcb90f63faf01589f)
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 {
904ae5f5f0SAlan Somers 	ZPROP_CONT = -2,
914ae5f5f0SAlan Somers 	ZPROP_INVAL = -1,
92c16bcc45SIgor Kozhukhov 	ZFS_PROP_TYPE = 0,
93fa9e4066Sahrens 	ZFS_PROP_CREATION,
94fa9e4066Sahrens 	ZFS_PROP_USED,
95fa9e4066Sahrens 	ZFS_PROP_AVAILABLE,
96fa9e4066Sahrens 	ZFS_PROP_REFERENCED,
97fa9e4066Sahrens 	ZFS_PROP_COMPRESSRATIO,
98fa9e4066Sahrens 	ZFS_PROP_MOUNTED,
99fa9e4066Sahrens 	ZFS_PROP_ORIGIN,
100fa9e4066Sahrens 	ZFS_PROP_QUOTA,
101fa9e4066Sahrens 	ZFS_PROP_RESERVATION,
102fa9e4066Sahrens 	ZFS_PROP_VOLSIZE,
103fa9e4066Sahrens 	ZFS_PROP_VOLBLOCKSIZE,
104fa9e4066Sahrens 	ZFS_PROP_RECORDSIZE,
105fa9e4066Sahrens 	ZFS_PROP_MOUNTPOINT,
106fa9e4066Sahrens 	ZFS_PROP_SHARENFS,
107fa9e4066Sahrens 	ZFS_PROP_CHECKSUM,
108fa9e4066Sahrens 	ZFS_PROP_COMPRESSION,
109fa9e4066Sahrens 	ZFS_PROP_ATIME,
110fa9e4066Sahrens 	ZFS_PROP_DEVICES,
111fa9e4066Sahrens 	ZFS_PROP_EXEC,
112fa9e4066Sahrens 	ZFS_PROP_SETUID,
113fa9e4066Sahrens 	ZFS_PROP_READONLY,
114fa9e4066Sahrens 	ZFS_PROP_ZONED,
115fa9e4066Sahrens 	ZFS_PROP_SNAPDIR,
116a3c49ce1SAlbert Lee 	ZFS_PROP_ACLMODE,
117fa9e4066Sahrens 	ZFS_PROP_ACLINHERIT,
11866e2aaccSgw 	ZFS_PROP_CREATETXG,		/* not exposed to the user */
11966e2aaccSgw 	ZFS_PROP_NAME,			/* not exposed to the user */
120e9dbad6fSeschrock 	ZFS_PROP_CANMOUNT,
12166e2aaccSgw 	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */
1227b55fa8eSck 	ZFS_PROP_XATTR,
123d0ad202dSahrens 	ZFS_PROP_NUMCLONES,		/* not exposed to the user */
124b1b8ab34Slling 	ZFS_PROP_COPIES,
125e7437265Sahrens 	ZFS_PROP_VERSION,
126da6c28aaSamw 	ZFS_PROP_UTF8ONLY,
127da6c28aaSamw 	ZFS_PROP_NORMALIZE,
128da6c28aaSamw 	ZFS_PROP_CASE,
129da6c28aaSamw 	ZFS_PROP_VSCAN,
130da6c28aaSamw 	ZFS_PROP_NBMAND,
131da6c28aaSamw 	ZFS_PROP_SHARESMB,
132a9799022Sck 	ZFS_PROP_REFQUOTA,
133a9799022Sck 	ZFS_PROP_REFRESERVATION,
134c5904d13Seschrock 	ZFS_PROP_GUID,
1353baa08fcSek 	ZFS_PROP_PRIMARYCACHE,
1363baa08fcSek 	ZFS_PROP_SECONDARYCACHE,
13774e7dc98SMatthew Ahrens 	ZFS_PROP_USEDSNAP,
13874e7dc98SMatthew Ahrens 	ZFS_PROP_USEDDS,
13974e7dc98SMatthew Ahrens 	ZFS_PROP_USEDCHILD,
14074e7dc98SMatthew Ahrens 	ZFS_PROP_USEDREFRESERV,
14114843421SMatthew Ahrens 	ZFS_PROP_USERACCOUNTING,	/* not exposed to the user */
142478ed9adSEric Taylor 	ZFS_PROP_STMF_SHAREINFO,	/* not exposed to the user */
143842727c2SChris Kirby 	ZFS_PROP_DEFER_DESTROY,
144842727c2SChris Kirby 	ZFS_PROP_USERREFS,
145e09fa4daSNeil Perrin 	ZFS_PROP_LOGBIAS,
1461d713200SEric Schrock 	ZFS_PROP_UNIQUE,		/* not exposed to the user */
1471d713200SEric Schrock 	ZFS_PROP_OBJSETID,		/* not exposed to the user */
148b24ab676SJeff Bonwick 	ZFS_PROP_DEDUP,
1494201a95eSRic Aleshire 	ZFS_PROP_MLSLABEL,
15055da60b9SMark J Musante 	ZFS_PROP_SYNC,
151187d6ac0SMatt Ahrens 	ZFS_PROP_REFRATIO,
15219b94df9SMatthew Ahrens 	ZFS_PROP_WRITTEN,
15319b94df9SMatthew Ahrens 	ZFS_PROP_CLONES,
15477372cb0SMatthew Ahrens 	ZFS_PROP_LOGICALUSED,
15577372cb0SMatthew Ahrens 	ZFS_PROP_LOGICALREFERENCED,
156ca48f36fSKeith M Wesolowski 	ZFS_PROP_INCONSISTENT,		/* not exposed to the user */
157a2afb611SJerry Jelinek 	ZFS_PROP_FILESYSTEM_LIMIT,
158a2afb611SJerry Jelinek 	ZFS_PROP_SNAPSHOT_LIMIT,
159a2afb611SJerry Jelinek 	ZFS_PROP_FILESYSTEM_COUNT,
160a2afb611SJerry Jelinek 	ZFS_PROP_SNAPSHOT_COUNT,
161edf345e6SMatthew Ahrens 	ZFS_PROP_REDUNDANT_METADATA,
162b461c746SMatthew Ahrens 	ZFS_PROP_PREV_SNAP,
1639c3fd121SMatthew Ahrens 	ZFS_PROP_RECEIVE_RESUME_TOKEN,
1645cabbc6bSPrashanth Sreenivasa 	ZFS_PROP_REMAPTXG,		/* not exposed to the user */
16591ebeef5Sahrens 	ZFS_NUM_PROPS
166fa9e4066Sahrens } zfs_prop_t;
167fa9e4066Sahrens 
16814843421SMatthew Ahrens typedef enum {
16914843421SMatthew Ahrens 	ZFS_PROP_USERUSED,
17014843421SMatthew Ahrens 	ZFS_PROP_USERQUOTA,
17114843421SMatthew Ahrens 	ZFS_PROP_GROUPUSED,
17214843421SMatthew Ahrens 	ZFS_PROP_GROUPQUOTA,
17314843421SMatthew Ahrens 	ZFS_NUM_USERQUOTA_PROPS
17414843421SMatthew Ahrens } zfs_userquota_prop_t;
17514843421SMatthew Ahrens 
17614843421SMatthew Ahrens extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
17714843421SMatthew Ahrens 
178990b4856Slling /*
179990b4856Slling  * Pool properties are identified by these constants and must be added to the
180b87f3af3Sperrin  * end of this list to ensure that external consumers are not affected
181990b4856Slling  * by the change. If you make any changes to this list, be sure to update
182990b4856Slling  * the property table in usr/src/common/zfs/zpool_prop.c.
183990b4856Slling  */
184990b4856Slling typedef enum {
1854ae5f5f0SAlan Somers 	ZPOOL_PROP_INVAL = -1,
186990b4856Slling 	ZPOOL_PROP_NAME,
187990b4856Slling 	ZPOOL_PROP_SIZE,
188990b4856Slling 	ZPOOL_PROP_CAPACITY,
189990b4856Slling 	ZPOOL_PROP_ALTROOT,
190990b4856Slling 	ZPOOL_PROP_HEALTH,
191990b4856Slling 	ZPOOL_PROP_GUID,
192990b4856Slling 	ZPOOL_PROP_VERSION,
193990b4856Slling 	ZPOOL_PROP_BOOTFS,
194990b4856Slling 	ZPOOL_PROP_DELEGATION,
195990b4856Slling 	ZPOOL_PROP_AUTOREPLACE,
1962f8aaab3Seschrock 	ZPOOL_PROP_CACHEFILE,
1970a4e9518Sgw 	ZPOOL_PROP_FAILUREMODE,
198d5b5bb25SRich Morris 	ZPOOL_PROP_LISTSNAPS,
199573ca77eSGeorge Wilson 	ZPOOL_PROP_AUTOEXPAND,
200b24ab676SJeff Bonwick 	ZPOOL_PROP_DEDUPDITTO,
201b24ab676SJeff Bonwick 	ZPOOL_PROP_DEDUPRATIO,
202485bbbf5SGeorge Wilson 	ZPOOL_PROP_FREE,
203485bbbf5SGeorge Wilson 	ZPOOL_PROP_ALLOCATED,
204f9af39baSGeorge Wilson 	ZPOOL_PROP_READONLY,
2058704186eSDan McDonald 	ZPOOL_PROP_COMMENT,
2064263d13fSGeorge Wilson 	ZPOOL_PROP_EXPANDSZ,
207ad135b5dSChristopher Siden 	ZPOOL_PROP_FREEING,
2082e4c9986SGeorge Wilson 	ZPOOL_PROP_FRAGMENTATION,
2097fd05ac4SMatthew Ahrens 	ZPOOL_PROP_LEAKED,
210b5152584SMatthew Ahrens 	ZPOOL_PROP_MAXBLOCKSIZE,
2117855d95bSToomas Soome 	ZPOOL_PROP_BOOTSIZE,
21286714001SSerapheim Dimitropoulos 	ZPOOL_PROP_CHECKPOINT,
213990b4856Slling 	ZPOOL_NUM_PROPS
214990b4856Slling } zpool_prop_t;
215b1b8ab34Slling 
2168704186eSDan McDonald /* Small enough to not hog a whole line of printout in zpool(1M). */
2178704186eSDan McDonald #define	ZPROP_MAX_COMMENT	32
2188704186eSDan McDonald 
219990b4856Slling #define	ZPROP_VALUE		"value"
220990b4856Slling #define	ZPROP_SOURCE		"source"
2217f7322feSeschrock 
222b1b8ab34Slling typedef enum {
223990b4856Slling 	ZPROP_SRC_NONE = 0x1,
224990b4856Slling 	ZPROP_SRC_DEFAULT = 0x2,
225990b4856Slling 	ZPROP_SRC_TEMPORARY = 0x4,
226990b4856Slling 	ZPROP_SRC_LOCAL = 0x8,
22792241e0bSTom Erickson 	ZPROP_SRC_INHERITED = 0x10,
22892241e0bSTom Erickson 	ZPROP_SRC_RECEIVED = 0x20
229990b4856Slling } zprop_source_t;
230990b4856Slling 
23192241e0bSTom Erickson #define	ZPROP_SRC_ALL	0x3f
23292241e0bSTom Erickson 
23392241e0bSTom Erickson #define	ZPROP_SOURCE_VAL_RECVD	"$recvd"
23492241e0bSTom Erickson #define	ZPROP_N_MORE_ERRORS	"N_MORE_ERRORS"
23592241e0bSTom Erickson /*
23692241e0bSTom Erickson  * Dataset flag implemented as a special entry in the props zap object
23792241e0bSTom Erickson  * indicating that the dataset has received properties on or after
23892241e0bSTom Erickson  * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
23992241e0bSTom Erickson  * just as it did in earlier versions, and thereafter, local properties are
24092241e0bSTom Erickson  * preserved.
24192241e0bSTom Erickson  */
24292241e0bSTom Erickson #define	ZPROP_HAS_RECVD		"$hasrecvd"
24392241e0bSTom Erickson 
24492241e0bSTom Erickson typedef enum {
24592241e0bSTom Erickson 	ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
24692241e0bSTom Erickson 	ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
24792241e0bSTom Erickson } zprop_errflags_t;
248990b4856Slling 
249990b4856Slling typedef int (*zprop_func)(int, void *);
250990b4856Slling 
2510a48a24eStimh /*
2520a48a24eStimh  * Properties to be set on the root file system of a new pool
2530a48a24eStimh  * are stuffed into their own nvlist, which is then included in
2540a48a24eStimh  * the properties nvlist with the pool properties.
2550a48a24eStimh  */
2560a48a24eStimh #define	ZPOOL_ROOTFS_PROPS	"root-props-nvl"
2570a48a24eStimh 
258dfc11533SChris Williamson /*
259dfc11533SChris Williamson  * Length of 'written@' and 'written#'
260dfc11533SChris Williamson  */
261dfc11533SChris Williamson #define	ZFS_WRITTEN_PROP_PREFIX_LEN	8
262dfc11533SChris Williamson 
263990b4856Slling /*
264990b4856Slling  * Dataset property functions shared between libzfs and kernel.
265990b4856Slling  */
266990b4856Slling const char *zfs_prop_default_string(zfs_prop_t);
267990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t);
268990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t);
269dfc11533SChris Williamson boolean_t zfs_prop_visible(zfs_prop_t prop);
270990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t);
271da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t);
272990b4856Slling const char *zfs_prop_to_name(zfs_prop_t);
273990b4856Slling zfs_prop_t zfs_name_to_prop(const char *);
274990b4856Slling boolean_t zfs_prop_user(const char *);
27592241e0bSTom Erickson boolean_t zfs_prop_userquota(const char *);
27619b94df9SMatthew Ahrens boolean_t zfs_prop_written(const char *);
277990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
278990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
279b24ab676SJeff Bonwick uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
2804853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
281b1b8ab34Slling 
282990b4856Slling /*
283990b4856Slling  * Pool property functions shared between libzfs and kernel.
284990b4856Slling  */
285990b4856Slling zpool_prop_t zpool_name_to_prop(const char *);
286990b4856Slling const char *zpool_prop_to_name(zpool_prop_t);
287990b4856Slling const char *zpool_prop_default_string(zpool_prop_t);
288990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t);
289990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t);
290ad135b5dSChristopher Siden boolean_t zpool_prop_feature(const char *);
291ad135b5dSChristopher Siden boolean_t zpool_prop_unsupported(const char *name);
292990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
293990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
294b24ab676SJeff Bonwick uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
295b1b8ab34Slling 
296990b4856Slling /*
297990b4856Slling  * Definitions for the Delegation.
298990b4856Slling  */
299ecd6cf80Smarks typedef enum {
300ecd6cf80Smarks 	ZFS_DELEG_WHO_UNKNOWN = 0,
301ecd6cf80Smarks 	ZFS_DELEG_USER = 'u',
302ecd6cf80Smarks 	ZFS_DELEG_USER_SETS = 'U',
303ecd6cf80Smarks 	ZFS_DELEG_GROUP = 'g',
304ecd6cf80Smarks 	ZFS_DELEG_GROUP_SETS = 'G',
305ecd6cf80Smarks 	ZFS_DELEG_EVERYONE = 'e',
306ecd6cf80Smarks 	ZFS_DELEG_EVERYONE_SETS = 'E',
307ecd6cf80Smarks 	ZFS_DELEG_CREATE = 'c',
308ecd6cf80Smarks 	ZFS_DELEG_CREATE_SETS = 'C',
309ecd6cf80Smarks 	ZFS_DELEG_NAMED_SET = 's',
310ecd6cf80Smarks 	ZFS_DELEG_NAMED_SET_SETS = 'S'
311ecd6cf80Smarks } zfs_deleg_who_type_t;
312ecd6cf80Smarks 
313ecd6cf80Smarks typedef enum {
314ecd6cf80Smarks 	ZFS_DELEG_NONE = 0,
315ecd6cf80Smarks 	ZFS_DELEG_PERM_LOCAL = 1,
316ecd6cf80Smarks 	ZFS_DELEG_PERM_DESCENDENT = 2,
317ecd6cf80Smarks 	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
318ecd6cf80Smarks 	ZFS_DELEG_PERM_CREATE = 4
319ecd6cf80Smarks } zfs_deleg_inherit_t;
320ecd6cf80Smarks 
321ecd6cf80Smarks #define	ZFS_DELEG_PERM_UID	"uid"
322ecd6cf80Smarks #define	ZFS_DELEG_PERM_GID	"gid"
323ecd6cf80Smarks #define	ZFS_DELEG_PERM_GROUPS	"groups"
324ecd6cf80Smarks 
3254201a95eSRic Aleshire #define	ZFS_MLSLABEL_DEFAULT	"none"
3264201a95eSRic Aleshire 
327743a77edSAlan Wright #define	ZFS_SMB_ACL_SRC		"src"
328743a77edSAlan Wright #define	ZFS_SMB_ACL_TARGET	"target"
329743a77edSAlan Wright 
330a227b7f4Shs typedef enum {
331a227b7f4Shs 	ZFS_CANMOUNT_OFF = 0,
332a227b7f4Shs 	ZFS_CANMOUNT_ON = 1,
333a227b7f4Shs 	ZFS_CANMOUNT_NOAUTO = 2
334a227b7f4Shs } zfs_canmount_type_t;
335a227b7f4Shs 
336e09fa4daSNeil Perrin typedef enum {
337e09fa4daSNeil Perrin 	ZFS_LOGBIAS_LATENCY = 0,
338e09fa4daSNeil Perrin 	ZFS_LOGBIAS_THROUGHPUT = 1
339e09fa4daSNeil Perrin } zfs_logbias_op_t;
340e09fa4daSNeil Perrin 
341da6c28aaSamw typedef enum zfs_share_op {
342da6c28aaSamw 	ZFS_SHARE_NFS = 0,
343da6c28aaSamw 	ZFS_UNSHARE_NFS = 1,
344da6c28aaSamw 	ZFS_SHARE_SMB = 2,
345da6c28aaSamw 	ZFS_UNSHARE_SMB = 3
346da6c28aaSamw } zfs_share_op_t;
347da6c28aaSamw 
348743a77edSAlan Wright typedef enum zfs_smb_acl_op {
349743a77edSAlan Wright 	ZFS_SMB_ACL_ADD,
350743a77edSAlan Wright 	ZFS_SMB_ACL_REMOVE,
351743a77edSAlan Wright 	ZFS_SMB_ACL_RENAME,
352743a77edSAlan Wright 	ZFS_SMB_ACL_PURGE
353743a77edSAlan Wright } zfs_smb_acl_op_t;
354743a77edSAlan Wright 
3553baa08fcSek typedef enum zfs_cache_type {
3563baa08fcSek 	ZFS_CACHE_NONE = 0,
3573baa08fcSek 	ZFS_CACHE_METADATA = 1,
3583baa08fcSek 	ZFS_CACHE_ALL = 2
3593baa08fcSek } zfs_cache_type_t;
3603baa08fcSek 
36155da60b9SMark J Musante typedef enum {
36255da60b9SMark J Musante 	ZFS_SYNC_STANDARD = 0,
36355da60b9SMark J Musante 	ZFS_SYNC_ALWAYS = 1,
36455da60b9SMark J Musante 	ZFS_SYNC_DISABLED = 2
36555da60b9SMark J Musante } zfs_sync_type_t;
36655da60b9SMark J Musante 
367edf345e6SMatthew Ahrens typedef enum {
368edf345e6SMatthew Ahrens 	ZFS_REDUNDANT_METADATA_ALL,
369edf345e6SMatthew Ahrens 	ZFS_REDUNDANT_METADATA_MOST
370edf345e6SMatthew Ahrens } zfs_redundant_metadata_type_t;
3713baa08fcSek 
372eaca9bbdSeschrock /*
37399653d4eSeschrock  * On-disk version number.
374eaca9bbdSeschrock  */
375e7437265Sahrens #define	SPA_VERSION_1			1ULL
376e7437265Sahrens #define	SPA_VERSION_2			2ULL
377e7437265Sahrens #define	SPA_VERSION_3			3ULL
378e7437265Sahrens #define	SPA_VERSION_4			4ULL
379e7437265Sahrens #define	SPA_VERSION_5			5ULL
380e7437265Sahrens #define	SPA_VERSION_6			6ULL
381e7437265Sahrens #define	SPA_VERSION_7			7ULL
382e7437265Sahrens #define	SPA_VERSION_8			8ULL
383da6c28aaSamw #define	SPA_VERSION_9			9ULL
384fa94a07fSbrendan #define	SPA_VERSION_10			10ULL
385088f3894Sahrens #define	SPA_VERSION_11			11ULL
386bb0ade09Sahrens #define	SPA_VERSION_12			12ULL
38774e7dc98SMatthew Ahrens #define	SPA_VERSION_13			13ULL
388d0f3f37eSMark Shellenbaum #define	SPA_VERSION_14			14ULL
38914843421SMatthew Ahrens #define	SPA_VERSION_15			15ULL
390478ed9adSEric Taylor #define	SPA_VERSION_16			16ULL
391f94275ceSAdam Leventhal #define	SPA_VERSION_17			17ULL
392842727c2SChris Kirby #define	SPA_VERSION_18			18ULL
39388ecc943SGeorge Wilson #define	SPA_VERSION_19			19ULL
394b24ab676SJeff Bonwick #define	SPA_VERSION_20			20ULL
395b24ab676SJeff Bonwick #define	SPA_VERSION_21			21ULL
39692241e0bSTom Erickson #define	SPA_VERSION_22			22ULL
3976e1f5caaSNeil Perrin #define	SPA_VERSION_23			23ULL
3980a586ceaSMark Shellenbaum #define	SPA_VERSION_24			24ULL
3993f9d6ad7SLin Ling #define	SPA_VERSION_25			25ULL
400cde58dbcSMatthew Ahrens #define	SPA_VERSION_26			26ULL
4016e0cbcaaSMatthew Ahrens #define	SPA_VERSION_27			27ULL
402cb04b873SMark J Musante #define	SPA_VERSION_28			28ULL
403ad135b5dSChristopher Siden #define	SPA_VERSION_5000		5000ULL
404cb04b873SMark J Musante 
405b1b8ab34Slling /*
406e7cbe64fSgw  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
407478ed9adSEric Taylor  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
40814843421SMatthew Ahrens  * and do the appropriate changes.  Also bump the version number in
40914843421SMatthew Ahrens  * usr/src/grub/capability.
410b1b8ab34Slling  */
411ad135b5dSChristopher Siden #define	SPA_VERSION			SPA_VERSION_5000
412ad135b5dSChristopher Siden #define	SPA_VERSION_STRING		"5000"
41344cd46caSbillm 
41444cd46caSbillm /*
415e7437265Sahrens  * Symbolic names for the changes that caused a SPA_VERSION switch.
41644cd46caSbillm  * Used in the code when checking for presence or absence of a feature.
41744cd46caSbillm  * Feel free to define multiple symbolic names for each version if there
41844cd46caSbillm  * were multiple changes to on-disk structures during that version.
41944cd46caSbillm  *
420e7437265Sahrens  * NOTE: When checking the current SPA_VERSION in your code, be sure
42144cd46caSbillm  *       to use spa_version() since it reports the version of the
42244cd46caSbillm  *       last synced uberblock.  Checking the in-flight version can
42344cd46caSbillm  *       be dangerous in some cases.
42444cd46caSbillm  */
425e7437265Sahrens #define	SPA_VERSION_INITIAL		SPA_VERSION_1
426e7437265Sahrens #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
427e7437265Sahrens #define	SPA_VERSION_SPARES		SPA_VERSION_3
428f94275ceSAdam Leventhal #define	SPA_VERSION_RAIDZ2		SPA_VERSION_3
429cde58dbcSMatthew Ahrens #define	SPA_VERSION_BPOBJ_ACCOUNT	SPA_VERSION_3
430e7437265Sahrens #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
431e7437265Sahrens #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
432e7437265Sahrens #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
433e7437265Sahrens #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
434e7437265Sahrens #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
435990b4856Slling #define	SPA_VERSION_SLOGS		SPA_VERSION_7
436990b4856Slling #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
437da6c28aaSamw #define	SPA_VERSION_FUID		SPA_VERSION_9
438a9799022Sck #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
439a9799022Sck #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
440a9799022Sck #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
441fa94a07fSbrendan #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
442088f3894Sahrens #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
443088f3894Sahrens #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
444088f3894Sahrens #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
445bb0ade09Sahrens #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
44674e7dc98SMatthew Ahrens #define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13
447d0f3f37eSMark Shellenbaum #define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14
44814843421SMatthew Ahrens #define	SPA_VERSION_USERSPACE		SPA_VERSION_15
449478ed9adSEric Taylor #define	SPA_VERSION_STMF_PROP		SPA_VERSION_16
450f94275ceSAdam Leventhal #define	SPA_VERSION_RAIDZ3		SPA_VERSION_17
451842727c2SChris Kirby #define	SPA_VERSION_USERREFS		SPA_VERSION_18
45288ecc943SGeorge Wilson #define	SPA_VERSION_HOLES		SPA_VERSION_19
453b24ab676SJeff Bonwick #define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20
454b24ab676SJeff Bonwick #define	SPA_VERSION_DEDUP		SPA_VERSION_21
45592241e0bSTom Erickson #define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22
4566e1f5caaSNeil Perrin #define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23
4570a586ceaSMark Shellenbaum #define	SPA_VERSION_SA			SPA_VERSION_24
4583f9d6ad7SLin Ling #define	SPA_VERSION_SCAN		SPA_VERSION_25
459cde58dbcSMatthew Ahrens #define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26
460cde58dbcSMatthew Ahrens #define	SPA_VERSION_DEADLISTS		SPA_VERSION_26
4616e0cbcaaSMatthew Ahrens #define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27
462cb04b873SMark J Musante #define	SPA_VERSION_MULTI_REPLACE	SPA_VERSION_28
463ad135b5dSChristopher Siden #define	SPA_VERSION_BEFORE_FEATURES	SPA_VERSION_28
464ad135b5dSChristopher Siden #define	SPA_VERSION_FEATURES		SPA_VERSION_5000
465ad135b5dSChristopher Siden 
466ad135b5dSChristopher Siden #define	SPA_VERSION_IS_SUPPORTED(v) \
467ad135b5dSChristopher Siden 	(((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
468ad135b5dSChristopher Siden 	((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
469e7437265Sahrens 
470e7437265Sahrens /*
471e7437265Sahrens  * ZPL version - rev'd whenever an incompatible on-disk format change
472e7437265Sahrens  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
473e7437265Sahrens  * also update the version_table[] and help message in zfs_prop.c.
474e7437265Sahrens  *
475e7437265Sahrens  * When changing, be sure to teach GRUB how to read the new format!
476478ed9adSEric Taylor  * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
477e7437265Sahrens  */
478e7437265Sahrens #define	ZPL_VERSION_1			1ULL
479e7437265Sahrens #define	ZPL_VERSION_2			2ULL
480da6c28aaSamw #define	ZPL_VERSION_3			3ULL
48114843421SMatthew Ahrens #define	ZPL_VERSION_4			4ULL
4820a586ceaSMark Shellenbaum #define	ZPL_VERSION_5			5ULL
4830a586ceaSMark Shellenbaum #define	ZPL_VERSION			ZPL_VERSION_5
4840a586ceaSMark Shellenbaum #define	ZPL_VERSION_STRING		"5"
485e7437265Sahrens 
486e7437265Sahrens #define	ZPL_VERSION_INITIAL		ZPL_VERSION_1
487e7437265Sahrens #define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2
488da6c28aaSamw #define	ZPL_VERSION_FUID		ZPL_VERSION_3
489de8267e0Stimh #define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3
490da6c28aaSamw #define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3
49114843421SMatthew Ahrens #define	ZPL_VERSION_USERSPACE		ZPL_VERSION_4
4920a586ceaSMark Shellenbaum #define	ZPL_VERSION_SA			ZPL_VERSION_5
493eaca9bbdSeschrock 
494*5dafeea3SPavel Zakharov /* Rewind policy information */
495c8ee1847SVictor Latushkin #define	ZPOOL_NO_REWIND		1  /* No policy - default behavior */
496c8ee1847SVictor Latushkin #define	ZPOOL_NEVER_REWIND	2  /* Do not search for best txg or rewind */
497c8ee1847SVictor Latushkin #define	ZPOOL_TRY_REWIND	4  /* Search for best txg, but do not rewind */
498c8ee1847SVictor Latushkin #define	ZPOOL_DO_REWIND		8  /* Rewind to best txg w/in deferred frees */
499c8ee1847SVictor Latushkin #define	ZPOOL_EXTREME_REWIND	16 /* Allow extreme measures to find best txg */
500c8ee1847SVictor Latushkin #define	ZPOOL_REWIND_MASK	28 /* All the possible rewind bits */
501c8ee1847SVictor Latushkin #define	ZPOOL_REWIND_POLICIES	31 /* All the possible policy bits */
502468c413aSTim Haley 
503*5dafeea3SPavel Zakharov typedef struct zpool_load_policy {
504*5dafeea3SPavel Zakharov 	uint32_t	zlp_rewind;	/* rewind policy requested */
505*5dafeea3SPavel Zakharov 	uint64_t	zlp_maxmeta;	/* max acceptable meta-data errors */
506*5dafeea3SPavel Zakharov 	uint64_t	zlp_maxdata;	/* max acceptable data errors */
507*5dafeea3SPavel Zakharov 	uint64_t	zlp_txg;	/* specific txg to load */
508*5dafeea3SPavel Zakharov } zpool_load_policy_t;
509468c413aSTim Haley 
510fa9e4066Sahrens /*
511fa9e4066Sahrens  * The following are configuration names used in the nvlist describing a pool's
5125cabbc6bSPrashanth Sreenivasa  * configuration.  New on-disk names should be prefixed with "<reverse-DNS>:"
5135cabbc6bSPrashanth Sreenivasa  * (e.g. "org.open-zfs:") to avoid conflicting names being developed
5145cabbc6bSPrashanth Sreenivasa  * independently.
515fa9e4066Sahrens  */
516fa9e4066Sahrens #define	ZPOOL_CONFIG_VERSION		"version"
517fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_NAME		"name"
518fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_STATE		"state"
519fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_TXG		"txg"
520fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
521fa9e4066Sahrens #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
522fa9e4066Sahrens #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
523fa9e4066Sahrens #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
524fa9e4066Sahrens #define	ZPOOL_CONFIG_TYPE		"type"
525fa9e4066Sahrens #define	ZPOOL_CONFIG_CHILDREN		"children"
526fa9e4066Sahrens #define	ZPOOL_CONFIG_ID			"id"
527fa9e4066Sahrens #define	ZPOOL_CONFIG_GUID		"guid"
5285cabbc6bSPrashanth Sreenivasa #define	ZPOOL_CONFIG_INDIRECT_OBJECT	"com.delphix:indirect_object"
5295cabbc6bSPrashanth Sreenivasa #define	ZPOOL_CONFIG_INDIRECT_BIRTHS	"com.delphix:indirect_births"
5305cabbc6bSPrashanth Sreenivasa #define	ZPOOL_CONFIG_PREV_INDIRECT_VDEV	"com.delphix:prev_indirect_vdev"
531fa9e4066Sahrens #define	ZPOOL_CONFIG_PATH		"path"
532fa9e4066Sahrens #define	ZPOOL_CONFIG_DEVID		"devid"
533fa9e4066Sahrens #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
534fa9e4066Sahrens #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
535fa9e4066Sahrens #define	ZPOOL_CONFIG_ASHIFT		"ashift"
536fa9e4066Sahrens #define	ZPOOL_CONFIG_ASIZE		"asize"
537fa9e4066Sahrens #define	ZPOOL_CONFIG_DTL		"DTL"
5383f9d6ad7SLin Ling #define	ZPOOL_CONFIG_SCAN_STATS		"scan_stats"	/* not stored on disk */
5395cabbc6bSPrashanth Sreenivasa #define	ZPOOL_CONFIG_REMOVAL_STATS	"removal_stats"	/* not stored on disk */
54086714001SSerapheim Dimitropoulos #define	ZPOOL_CONFIG_CHECKPOINT_STATS	"checkpoint_stats" /* not on disk */
5413f9d6ad7SLin Ling #define	ZPOOL_CONFIG_VDEV_STATS		"vdev_stats"	/* not stored on disk */
5425cabbc6bSPrashanth Sreenivasa #define	ZPOOL_CONFIG_INDIRECT_SIZE	"indirect_size"	/* not stored on disk */
543afefbcddSeschrock #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
544ea8dc4b6Seschrock #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
545ea8dc4b6Seschrock #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
54699653d4eSeschrock #define	ZPOOL_CONFIG_SPARES		"spares"
54799653d4eSeschrock #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
54899653d4eSeschrock #define	ZPOOL_CONFIG_NPARITY		"nparity"
54995173954Sek #define	ZPOOL_CONFIG_HOSTID		"hostid"
55095173954Sek #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
55111027bc7STim Haley #define	ZPOOL_CONFIG_LOADED_TIME	"initial_load_time"
5523d7072f8Seschrock #define	ZPOOL_CONFIG_UNSPARE		"unspare"
5533d7072f8Seschrock #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
5548654d025Sperrin #define	ZPOOL_CONFIG_IS_LOG		"is_log"
555fa94a07fSbrendan #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
55688ecc943SGeorge Wilson #define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"
55788ecc943SGeorge Wilson #define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"
55888ecc943SGeorge Wilson #define	ZPOOL_CONFIG_IS_HOLE		"is_hole"
5599eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"
5609eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"
5619eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"
5621195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT		"splitcfg"
5631195e687SMark J Musante #define	ZPOOL_CONFIG_ORIG_GUID		"orig_guid"
5641195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT_GUID		"split_guid"
5651195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT_LIST		"guid_list"
5663f9d6ad7SLin Ling #define	ZPOOL_CONFIG_REMOVING		"removing"
567b4952e17SGeorge Wilson #define	ZPOOL_CONFIG_RESILVER_TXG	"resilver_txg"
5688704186eSDan McDonald #define	ZPOOL_CONFIG_COMMENT		"comment"
569e14bb325SJeff Bonwick #define	ZPOOL_CONFIG_SUSPENDED		"suspended"	/* not stored on disk */
570e7cbe64fSgw #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp"	/* not stored on disk */
571e7cbe64fSgw #define	ZPOOL_CONFIG_BOOTFS		"bootfs"	/* not stored on disk */
5724b964adaSGeorge Wilson #define	ZPOOL_CONFIG_MISSING_DEVICES	"missing_vdevs"	/* not stored on disk */
5734b964adaSGeorge Wilson #define	ZPOOL_CONFIG_LOAD_INFO		"load_info"	/* not stored on disk */
574ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_REWIND_INFO	"rewind_info"	/* not stored on disk */
575ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_UNSUP_FEAT		"unsup_feat"	/* not stored on disk */
57657221772SChristopher Siden #define	ZPOOL_CONFIG_ENABLED_FEAT	"enabled_feat"	/* not stored on disk */
577ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_CAN_RDONLY		"can_rdonly"	/* not stored on disk */
578ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_FEATURES_FOR_READ	"features_for_read"
579ad135b5dSChristopher Siden #define	ZPOOL_CONFIG_FEATURE_STATS	"feature_stats"	/* not stored on disk */
580215198a6SJoe Stein #define	ZPOOL_CONFIG_VDEV_TOP_ZAP	"com.delphix:vdev_zap_top"
581215198a6SJoe Stein #define	ZPOOL_CONFIG_VDEV_LEAF_ZAP	"com.delphix:vdev_zap_leaf"
582215198a6SJoe Stein #define	ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS	"com.delphix:has_per_vdev_zaps"
5836f793812SPavel Zakharov #define	ZPOOL_CONFIG_CACHEFILE		"cachefile"	/* not stored on disk */
5843d7072f8Seschrock /*
5853d7072f8Seschrock  * The persistent vdev state is stored as separate values rather than a single
5863d7072f8Seschrock  * 'vdev_state' entry.  This is because a device can be in multiple states, such
5873d7072f8Seschrock  * as offline and degraded.
5883d7072f8Seschrock  */
5893d7072f8Seschrock #define	ZPOOL_CONFIG_OFFLINE		"offline"
5903d7072f8Seschrock #define	ZPOOL_CONFIG_FAULTED		"faulted"
5913d7072f8Seschrock #define	ZPOOL_CONFIG_DEGRADED		"degraded"
5923d7072f8Seschrock #define	ZPOOL_CONFIG_REMOVED		"removed"
5936809eb4eSEric Schrock #define	ZPOOL_CONFIG_FRU		"fru"
594069f55e2SEric Schrock #define	ZPOOL_CONFIG_AUX_STATE		"aux_state"
595fa9e4066Sahrens 
596*5dafeea3SPavel Zakharov /* Pool load policy parameters */
597*5dafeea3SPavel Zakharov #define	ZPOOL_LOAD_POLICY		"load-policy"
598*5dafeea3SPavel Zakharov #define	ZPOOL_LOAD_REWIND_POLICY	"load-rewind-policy"
599*5dafeea3SPavel Zakharov #define	ZPOOL_LOAD_REQUEST_TXG		"load-request-txg"
600*5dafeea3SPavel Zakharov #define	ZPOOL_LOAD_META_THRESH		"load-meta-thresh"
601*5dafeea3SPavel Zakharov #define	ZPOOL_LOAD_DATA_THRESH		"load-data-thresh"
602468c413aSTim Haley 
603468c413aSTim Haley /* Rewind data discovered */
604468c413aSTim Haley #define	ZPOOL_CONFIG_LOAD_TIME		"rewind_txg_ts"
605468c413aSTim Haley #define	ZPOOL_CONFIG_LOAD_DATA_ERRORS	"verify_data_errors"
606468c413aSTim Haley #define	ZPOOL_CONFIG_REWIND_TIME	"seconds_of_rewind"
607468c413aSTim Haley 
608fa9e4066Sahrens #define	VDEV_TYPE_ROOT			"root"
609fa9e4066Sahrens #define	VDEV_TYPE_MIRROR		"mirror"
610fa9e4066Sahrens #define	VDEV_TYPE_REPLACING		"replacing"
611fa9e4066Sahrens #define	VDEV_TYPE_RAIDZ			"raidz"
612fa9e4066Sahrens #define	VDEV_TYPE_DISK			"disk"
613fa9e4066Sahrens #define	VDEV_TYPE_FILE			"file"
614fa9e4066Sahrens #define	VDEV_TYPE_MISSING		"missing"
61588ecc943SGeorge Wilson #define	VDEV_TYPE_HOLE			"hole"
61699653d4eSeschrock #define	VDEV_TYPE_SPARE			"spare"
6178654d025Sperrin #define	VDEV_TYPE_LOG			"log"
618fa94a07fSbrendan #define	VDEV_TYPE_L2CACHE		"l2cache"
6195cabbc6bSPrashanth Sreenivasa #define	VDEV_TYPE_INDIRECT		"indirect"
6205cabbc6bSPrashanth Sreenivasa 
6215cabbc6bSPrashanth Sreenivasa /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */
6225cabbc6bSPrashanth Sreenivasa #define	VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \
6235cabbc6bSPrashanth Sreenivasa 	"com.delphix:indirect_obsolete_sm"
6245cabbc6bSPrashanth Sreenivasa #define	VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \
6255cabbc6bSPrashanth Sreenivasa 	"com.delphix:obsolete_counts_are_precise"
62686714001SSerapheim Dimitropoulos #define	VDEV_TOP_ZAP_POOL_CHECKPOINT_SM \
62786714001SSerapheim Dimitropoulos 	"com.delphix:pool_checkpoint_sm"
628fa9e4066Sahrens 
629fa9e4066Sahrens /*
630fa9e4066Sahrens  * This is needed in userland to report the minimum necessary device size.
6314b5c8e93SMatthew Ahrens  *
6324b5c8e93SMatthew Ahrens  * Note that the zfs test suite uses 64MB vdevs.
633fa9e4066Sahrens  */
634fa9e4066Sahrens #define	SPA_MINDEVSIZE		(64ULL << 20)
635fa9e4066Sahrens 
6362e4c9986SGeorge Wilson /*
6372e4c9986SGeorge Wilson  * Set if the fragmentation has not yet been calculated. This can happen
6382e4c9986SGeorge Wilson  * because the space maps have not been upgraded or the histogram feature
6392e4c9986SGeorge Wilson  * is not enabled.
6402e4c9986SGeorge Wilson  */
6412e4c9986SGeorge Wilson #define	ZFS_FRAG_INVALID	UINT64_MAX
6422e4c9986SGeorge Wilson 
643fa9e4066Sahrens /*
644fa9e4066Sahrens  * The location of the pool configuration repository, shared between kernel and
645fa9e4066Sahrens  * userland.
646fa9e4066Sahrens  */
647c5904d13Seschrock #define	ZPOOL_CACHE		"/etc/zfs/zpool.cache"
648fa9e4066Sahrens 
649fa9e4066Sahrens /*
650fa9e4066Sahrens  * vdev states are ordered from least to most healthy.
651fa9e4066Sahrens  * A vdev that's CANT_OPEN or below is considered unusable.
652fa9e4066Sahrens  */
653fa9e4066Sahrens typedef enum vdev_state {
654fa9e4066Sahrens 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
655fa9e4066Sahrens 	VDEV_STATE_CLOSED,	/* Not currently open			*/
656fa9e4066Sahrens 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
6573d7072f8Seschrock 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
658fa9e4066Sahrens 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
6593d7072f8Seschrock 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
660fa9e4066Sahrens 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
661fa9e4066Sahrens 	VDEV_STATE_HEALTHY	/* Presumed good			*/
662fa9e4066Sahrens } vdev_state_t;
663fa9e4066Sahrens 
6643d7072f8Seschrock #define	VDEV_STATE_ONLINE	VDEV_STATE_HEALTHY
6653d7072f8Seschrock 
666fa9e4066Sahrens /*
667fa9e4066Sahrens  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
668fa9e4066Sahrens  * of the vdev stats structure uses these constants to distinguish why.
669fa9e4066Sahrens  */
670fa9e4066Sahrens typedef enum vdev_aux {
671fa9e4066Sahrens 	VDEV_AUX_NONE,		/* no error				*/
672fa9e4066Sahrens 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
673fa9e4066Sahrens 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
674fa9e4066Sahrens 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
675fa9e4066Sahrens 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
676fa9e4066Sahrens 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
677eaca9bbdSeschrock 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
678eaca9bbdSeschrock 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
67999653d4eSeschrock 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
680ad135b5dSChristopher Siden 	VDEV_AUX_UNSUP_FEAT,	/* unsupported features			*/
6813d7072f8Seschrock 	VDEV_AUX_SPARED,	/* hot spare used in another pool	*/
68232b87932Sek 	VDEV_AUX_ERR_EXCEEDED,	/* too many errors			*/
683b87f3af3Sperrin 	VDEV_AUX_IO_FAILURE,	/* experienced I/O failure		*/
684069f55e2SEric Schrock 	VDEV_AUX_BAD_LOG,	/* cannot read log chain(s)		*/
6851195e687SMark J Musante 	VDEV_AUX_EXTERNAL,	/* external diagnosis			*/
6866f793812SPavel Zakharov 	VDEV_AUX_SPLIT_POOL,	/* vdev was split off into another pool	*/
6876f793812SPavel Zakharov 	VDEV_AUX_CHILDREN_OFFLINE /* all children are offline		*/
688fa9e4066Sahrens } vdev_aux_t;
689fa9e4066Sahrens 
690fa9e4066Sahrens /*
69146a2abf2Seschrock  * pool state.  The following states are written to disk as part of the normal
692fa94a07fSbrendan  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
693fa94a07fSbrendan  * states are software abstractions used at various levels to communicate
694fa94a07fSbrendan  * pool state.
695fa9e4066Sahrens  */
696fa9e4066Sahrens typedef enum pool_state {
697fa9e4066Sahrens 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
698fa9e4066Sahrens 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
699fa9e4066Sahrens 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
70099653d4eSeschrock 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
701fa94a07fSbrendan 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
702fa9e4066Sahrens 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
70346a2abf2Seschrock 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
70446a2abf2Seschrock 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
705fa9e4066Sahrens } pool_state_t;
706fa9e4066Sahrens 
707fa9e4066Sahrens /*
7083f9d6ad7SLin Ling  * Scan Functions.
709fa9e4066Sahrens  */
7103f9d6ad7SLin Ling typedef enum pool_scan_func {
7113f9d6ad7SLin Ling 	POOL_SCAN_NONE,
7123f9d6ad7SLin Ling 	POOL_SCAN_SCRUB,
7133f9d6ad7SLin Ling 	POOL_SCAN_RESILVER,
7143f9d6ad7SLin Ling 	POOL_SCAN_FUNCS
7153f9d6ad7SLin Ling } pool_scan_func_t;
716fa9e4066Sahrens 
7171702cce7SAlek Pinchuk /*
7181702cce7SAlek Pinchuk  * Used to control scrub pause and resume.
7191702cce7SAlek Pinchuk  */
7201702cce7SAlek Pinchuk typedef enum pool_scrub_cmd {
7211702cce7SAlek Pinchuk 	POOL_SCRUB_NORMAL = 0,
7221702cce7SAlek Pinchuk 	POOL_SCRUB_PAUSE,
7231702cce7SAlek Pinchuk 	POOL_SCRUB_FLAGS_END
7241702cce7SAlek Pinchuk } pool_scrub_cmd_t;
7251702cce7SAlek Pinchuk 
7261702cce7SAlek Pinchuk 
727fa9e4066Sahrens /*
728fa9e4066Sahrens  * ZIO types.  Needed to interpret vdev statistics below.
729fa9e4066Sahrens  */
730fa9e4066Sahrens typedef enum zio_type {
731fa9e4066Sahrens 	ZIO_TYPE_NULL = 0,
732fa9e4066Sahrens 	ZIO_TYPE_READ,
733fa9e4066Sahrens 	ZIO_TYPE_WRITE,
734fa9e4066Sahrens 	ZIO_TYPE_FREE,
735fa9e4066Sahrens 	ZIO_TYPE_CLAIM,
736fa9e4066Sahrens 	ZIO_TYPE_IOCTL,
737fa9e4066Sahrens 	ZIO_TYPES
738fa9e4066Sahrens } zio_type_t;
739fa9e4066Sahrens 
7403f9d6ad7SLin Ling /*
7413f9d6ad7SLin Ling  * Pool statistics.  Note: all fields should be 64-bit because this
7423f9d6ad7SLin Ling  * is passed between kernel and userland as an nvlist uint64 array.
7433f9d6ad7SLin Ling  */
7443f9d6ad7SLin Ling typedef struct pool_scan_stat {
7453f9d6ad7SLin Ling 	/* values stored on disk */
7463f9d6ad7SLin Ling 	uint64_t	pss_func;	/* pool_scan_func_t */
7473f9d6ad7SLin Ling 	uint64_t	pss_state;	/* dsl_scan_state_t */
7483f9d6ad7SLin Ling 	uint64_t	pss_start_time;	/* scan start time */
7493f9d6ad7SLin Ling 	uint64_t	pss_end_time;	/* scan end time */
7503f9d6ad7SLin Ling 	uint64_t	pss_to_examine;	/* total bytes to scan */
7513f9d6ad7SLin Ling 	uint64_t	pss_examined;	/* total examined bytes	*/
7523f9d6ad7SLin Ling 	uint64_t	pss_to_process; /* total bytes to process */
7533f9d6ad7SLin Ling 	uint64_t	pss_processed;	/* total processed bytes */
7543f9d6ad7SLin Ling 	uint64_t	pss_errors;	/* scan errors	*/
7553f9d6ad7SLin Ling 
7563f9d6ad7SLin Ling 	/* values not stored on disk */
7573f9d6ad7SLin Ling 	uint64_t	pss_pass_exam;	/* examined bytes per scan pass */
7583f9d6ad7SLin Ling 	uint64_t	pss_pass_start;	/* start time of a scan pass */
7591702cce7SAlek Pinchuk 	uint64_t	pss_pass_scrub_pause; /* pause time of a scurb pass */
7601702cce7SAlek Pinchuk 	/* cumulative time scrub spent paused, needed for rate calculation */
7611702cce7SAlek Pinchuk 	uint64_t	pss_pass_scrub_spent_paused;
7623f9d6ad7SLin Ling } pool_scan_stat_t;
7633f9d6ad7SLin Ling 
7645cabbc6bSPrashanth Sreenivasa typedef struct pool_removal_stat {
7655cabbc6bSPrashanth Sreenivasa 	uint64_t prs_state; /* dsl_scan_state_t */
7665cabbc6bSPrashanth Sreenivasa 	uint64_t prs_removing_vdev;
7675cabbc6bSPrashanth Sreenivasa 	uint64_t prs_start_time;
7685cabbc6bSPrashanth Sreenivasa 	uint64_t prs_end_time;
7695cabbc6bSPrashanth Sreenivasa 	uint64_t prs_to_copy; /* bytes that need to be copied */
7705cabbc6bSPrashanth Sreenivasa 	uint64_t prs_copied; /* bytes copied so far */
7715cabbc6bSPrashanth Sreenivasa 	/*
7725cabbc6bSPrashanth Sreenivasa 	 * bytes of memory used for indirect mappings.
7735cabbc6bSPrashanth Sreenivasa 	 * This includes all removed vdevs.
7745cabbc6bSPrashanth Sreenivasa 	 */
7755cabbc6bSPrashanth Sreenivasa 	uint64_t prs_mapping_memory;
7765cabbc6bSPrashanth Sreenivasa } pool_removal_stat_t;
7775cabbc6bSPrashanth Sreenivasa 
7783f9d6ad7SLin Ling typedef enum dsl_scan_state {
7793f9d6ad7SLin Ling 	DSS_NONE,
7803f9d6ad7SLin Ling 	DSS_SCANNING,
7813f9d6ad7SLin Ling 	DSS_FINISHED,
7823f9d6ad7SLin Ling 	DSS_CANCELED,
7833f9d6ad7SLin Ling 	DSS_NUM_STATES
7843f9d6ad7SLin Ling } dsl_scan_state_t;
7853f9d6ad7SLin Ling 
78686714001SSerapheim Dimitropoulos typedef enum {
78786714001SSerapheim Dimitropoulos 	CS_NONE,
78886714001SSerapheim Dimitropoulos 	CS_CHECKPOINT_EXISTS,
78986714001SSerapheim Dimitropoulos 	CS_CHECKPOINT_DISCARDING,
79086714001SSerapheim Dimitropoulos 	CS_NUM_STATES
79186714001SSerapheim Dimitropoulos } checkpoint_state_t;
79286714001SSerapheim Dimitropoulos 
79386714001SSerapheim Dimitropoulos typedef struct pool_checkpoint_stat {
79486714001SSerapheim Dimitropoulos 	uint64_t pcs_state;		/* checkpoint_state_t */
79586714001SSerapheim Dimitropoulos 	uint64_t pcs_start_time;	/* time checkpoint/discard started */
79686714001SSerapheim Dimitropoulos 	uint64_t pcs_space;		/* checkpointed space */
79786714001SSerapheim Dimitropoulos } pool_checkpoint_stat_t;
7983f9d6ad7SLin Ling 
799fa9e4066Sahrens /*
800fa9e4066Sahrens  * Vdev statistics.  Note: all fields should be 64-bit because this
801fa9e4066Sahrens  * is passed between kernel and userland as an nvlist uint64 array.
802fa9e4066Sahrens  */
803fa9e4066Sahrens typedef struct vdev_stat {
804fa9e4066Sahrens 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
805fa9e4066Sahrens 	uint64_t	vs_state;		/* vdev state		*/
806fa9e4066Sahrens 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
807fa9e4066Sahrens 	uint64_t	vs_alloc;		/* space allocated	*/
808fa9e4066Sahrens 	uint64_t	vs_space;		/* total capacity	*/
80999653d4eSeschrock 	uint64_t	vs_dspace;		/* deflated capacity	*/
8102a79c5feSlling 	uint64_t	vs_rsize;		/* replaceable dev size */
8114263d13fSGeorge Wilson 	uint64_t	vs_esize;		/* expandable dev size */
812fa9e4066Sahrens 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
813fa9e4066Sahrens 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
814fa9e4066Sahrens 	uint64_t	vs_read_errors;		/* read errors		*/
815fa9e4066Sahrens 	uint64_t	vs_write_errors;	/* write errors		*/
816fa9e4066Sahrens 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
817fa9e4066Sahrens 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
8183f9d6ad7SLin Ling 	uint64_t	vs_scan_removing;	/* removing?	*/
8193f9d6ad7SLin Ling 	uint64_t	vs_scan_processed;	/* scan processed bytes	*/
8202e4c9986SGeorge Wilson 	uint64_t	vs_fragmentation;	/* device fragmentation */
82186714001SSerapheim Dimitropoulos 	uint64_t	vs_checkpoint_space;    /* checkpoint-consumed space */
822fa9e4066Sahrens } vdev_stat_t;
823fa9e4066Sahrens 
8249eb19f4dSGeorge Wilson /*
8259eb19f4dSGeorge Wilson  * DDT statistics.  Note: all fields should be 64-bit because this
8269eb19f4dSGeorge Wilson  * is passed between kernel and userland as an nvlist uint64 array.
8279eb19f4dSGeorge Wilson  */
8289eb19f4dSGeorge Wilson typedef struct ddt_object {
8299eb19f4dSGeorge Wilson 	uint64_t	ddo_count;	/* number of elments in ddt 	*/
8309eb19f4dSGeorge Wilson 	uint64_t	ddo_dspace;	/* size of ddt on disk		*/
8319eb19f4dSGeorge Wilson 	uint64_t	ddo_mspace;	/* size of ddt in-core		*/
8329eb19f4dSGeorge Wilson } ddt_object_t;
8339eb19f4dSGeorge Wilson 
8349eb19f4dSGeorge Wilson typedef struct ddt_stat {
8359eb19f4dSGeorge Wilson 	uint64_t	dds_blocks;	/* blocks			*/
8369eb19f4dSGeorge Wilson 	uint64_t	dds_lsize;	/* logical size			*/
8379eb19f4dSGeorge Wilson 	uint64_t	dds_psize;	/* physical size		*/
8389eb19f4dSGeorge Wilson 	uint64_t	dds_dsize;	/* deflated allocated size	*/
8399eb19f4dSGeorge Wilson 	uint64_t	dds_ref_blocks;	/* referenced blocks		*/
8409eb19f4dSGeorge Wilson 	uint64_t	dds_ref_lsize;	/* referenced lsize * refcnt	*/
8419eb19f4dSGeorge Wilson 	uint64_t	dds_ref_psize;	/* referenced psize * refcnt	*/
8429eb19f4dSGeorge Wilson 	uint64_t	dds_ref_dsize;	/* referenced dsize * refcnt	*/
8439eb19f4dSGeorge Wilson } ddt_stat_t;
8449eb19f4dSGeorge Wilson 
8459eb19f4dSGeorge Wilson typedef struct ddt_histogram {
8469eb19f4dSGeorge Wilson 	ddt_stat_t	ddh_stat[64];	/* power-of-two histogram buckets */
8479eb19f4dSGeorge Wilson } ddt_histogram_t;
8489eb19f4dSGeorge Wilson 
849e7cbe64fSgw #define	ZVOL_DRIVER	"zvol"
850fa9e4066Sahrens #define	ZFS_DRIVER	"zfs"
851fa9e4066Sahrens #define	ZFS_DEV		"/dev/zfs"
8526401734dSWill Andrews #define	ZFS_DISK_ROOT	"/dev/dsk"
8536401734dSWill Andrews #define	ZFS_DISK_ROOTD	ZFS_DISK_ROOT "/"
8546401734dSWill Andrews #define	ZFS_RDISK_ROOT	"/dev/rdsk"
8556401734dSWill Andrews #define	ZFS_RDISK_ROOTD	ZFS_RDISK_ROOT "/"
856fa9e4066Sahrens 
857681d9761SEric Taylor /* general zvol path */
858681d9761SEric Taylor #define	ZVOL_DIR		"/dev/zvol"
859681d9761SEric Taylor /* expansion */
860573ca77eSGeorge Wilson #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zfs@0:"
861681d9761SEric Taylor /* for dump and swap */
862681d9761SEric Taylor #define	ZVOL_FULL_DEV_DIR	ZVOL_DIR "/dsk/"
863681d9761SEric Taylor #define	ZVOL_FULL_RDEV_DIR	ZVOL_DIR "/rdsk/"
864fa9e4066Sahrens 
865fa9e4066Sahrens #define	ZVOL_PROP_NAME		"name"
866c1449561SEric Taylor #define	ZVOL_DEFAULT_BLOCKSIZE	8192
867fa9e4066Sahrens 
868fa9e4066Sahrens /*
869fa9e4066Sahrens  * /dev/zfs ioctl numbers.
870fa9e4066Sahrens  */
871fa9e4066Sahrens typedef enum zfs_ioc {
8724445fffbSMatthew Ahrens 	ZFS_IOC_FIRST =	('Z' << 8),
8734445fffbSMatthew Ahrens 	ZFS_IOC = ZFS_IOC_FIRST,
8744445fffbSMatthew Ahrens 	ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
875fa9e4066Sahrens 	ZFS_IOC_POOL_DESTROY,
876fa9e4066Sahrens 	ZFS_IOC_POOL_IMPORT,
877fa9e4066Sahrens 	ZFS_IOC_POOL_EXPORT,
878fa9e4066Sahrens 	ZFS_IOC_POOL_CONFIGS,
879fa9e4066Sahrens 	ZFS_IOC_POOL_STATS,
880fa9e4066Sahrens 	ZFS_IOC_POOL_TRYIMPORT,
8813f9d6ad7SLin Ling 	ZFS_IOC_POOL_SCAN,
882fa9e4066Sahrens 	ZFS_IOC_POOL_FREEZE,
883eaca9bbdSeschrock 	ZFS_IOC_POOL_UPGRADE,
88406eeb2adSek 	ZFS_IOC_POOL_GET_HISTORY,
885fa9e4066Sahrens 	ZFS_IOC_VDEV_ADD,
886fa9e4066Sahrens 	ZFS_IOC_VDEV_REMOVE,
8873d7072f8Seschrock 	ZFS_IOC_VDEV_SET_STATE,
888fa9e4066Sahrens 	ZFS_IOC_VDEV_ATTACH,
889fa9e4066Sahrens 	ZFS_IOC_VDEV_DETACH,
890c67d9675Seschrock 	ZFS_IOC_VDEV_SETPATH,
8916809eb4eSEric Schrock 	ZFS_IOC_VDEV_SETFRU,
892fa9e4066Sahrens 	ZFS_IOC_OBJSET_STATS,
893de8267e0Stimh 	ZFS_IOC_OBJSET_ZPLPROPS,
894fa9e4066Sahrens 	ZFS_IOC_DATASET_LIST_NEXT,
895fa9e4066Sahrens 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
896fa9e4066Sahrens 	ZFS_IOC_SET_PROP,
897fa9e4066Sahrens 	ZFS_IOC_CREATE,
898fa9e4066Sahrens 	ZFS_IOC_DESTROY,
899fa9e4066Sahrens 	ZFS_IOC_ROLLBACK,
900fa9e4066Sahrens 	ZFS_IOC_RENAME,
9013cb34c60Sahrens 	ZFS_IOC_RECV,
9023cb34c60Sahrens 	ZFS_IOC_SEND,
903ea8dc4b6Seschrock 	ZFS_IOC_INJECT_FAULT,
904ea8dc4b6Seschrock 	ZFS_IOC_CLEAR_FAULT,
905ea8dc4b6Seschrock 	ZFS_IOC_INJECT_LIST_NEXT,
906ea8dc4b6Seschrock 	ZFS_IOC_ERROR_LOG,
907ea8dc4b6Seschrock 	ZFS_IOC_CLEAR,
9081d452cf5Sahrens 	ZFS_IOC_PROMOTE,
90955434c77Sek 	ZFS_IOC_SNAPSHOT,
91055434c77Sek 	ZFS_IOC_DSOBJ_TO_DSNAME,
911b1b8ab34Slling 	ZFS_IOC_OBJ_TO_PATH,
912b1b8ab34Slling 	ZFS_IOC_POOL_SET_PROPS,
913ecd6cf80Smarks 	ZFS_IOC_POOL_GET_PROPS,
914ecd6cf80Smarks 	ZFS_IOC_SET_FSACL,
915ecd6cf80Smarks 	ZFS_IOC_GET_FSACL,
916e45ce728Sahrens 	ZFS_IOC_SHARE,
917743a77edSAlan Wright 	ZFS_IOC_INHERIT_PROP,
91814843421SMatthew Ahrens 	ZFS_IOC_SMB_ACL,
91914843421SMatthew Ahrens 	ZFS_IOC_USERSPACE_ONE,
92014843421SMatthew Ahrens 	ZFS_IOC_USERSPACE_MANY,
921842727c2SChris Kirby 	ZFS_IOC_USERSPACE_UPGRADE,
922842727c2SChris Kirby 	ZFS_IOC_HOLD,
923842727c2SChris Kirby 	ZFS_IOC_RELEASE,
92492241e0bSTom Erickson 	ZFS_IOC_GET_HOLDS,
9251195e687SMark J Musante 	ZFS_IOC_OBJSET_RECVD_PROPS,
92699d5e173STim Haley 	ZFS_IOC_VDEV_SPLIT,
92799d5e173STim Haley 	ZFS_IOC_NEXT_OBJ,
92899d5e173STim Haley 	ZFS_IOC_DIFF,
92999d5e173STim Haley 	ZFS_IOC_TMP_SNAPSHOT,
930e9103aaeSGarrett D'Amore 	ZFS_IOC_OBJ_TO_STATS,
93119b94df9SMatthew Ahrens 	ZFS_IOC_SPACE_WRITTEN,
93219b94df9SMatthew Ahrens 	ZFS_IOC_SPACE_SNAPS,
9334445fffbSMatthew Ahrens 	ZFS_IOC_DESTROY_SNAPS,
9344263d13fSGeorge Wilson 	ZFS_IOC_POOL_REGUID,
9354e3c9f44SBill Pijewski 	ZFS_IOC_POOL_REOPEN,
9364445fffbSMatthew Ahrens 	ZFS_IOC_SEND_PROGRESS,
9374445fffbSMatthew Ahrens 	ZFS_IOC_LOG_HISTORY,
9384445fffbSMatthew Ahrens 	ZFS_IOC_SEND_NEW,
9394445fffbSMatthew Ahrens 	ZFS_IOC_SEND_SPACE,
9404445fffbSMatthew Ahrens 	ZFS_IOC_CLONE,
94178f17100SMatthew Ahrens 	ZFS_IOC_BOOKMARK,
94278f17100SMatthew Ahrens 	ZFS_IOC_GET_BOOKMARKS,
94378f17100SMatthew Ahrens 	ZFS_IOC_DESTROY_BOOKMARKS,
944dfc11533SChris Williamson 	ZFS_IOC_CHANNEL_PROGRAM,
9455cabbc6bSPrashanth Sreenivasa 	ZFS_IOC_REMAP,
94686714001SSerapheim Dimitropoulos 	ZFS_IOC_POOL_CHECKPOINT,
94786714001SSerapheim Dimitropoulos 	ZFS_IOC_POOL_DISCARD_CHECKPOINT,
9484445fffbSMatthew Ahrens 	ZFS_IOC_LAST
949fa9e4066Sahrens } zfs_ioc_t;
950fa9e4066Sahrens 
95186714001SSerapheim Dimitropoulos /*
95286714001SSerapheim Dimitropoulos  * ZFS-specific error codes used for returning descriptive errors
95386714001SSerapheim Dimitropoulos  * to the userland through zfs ioctls.
95486714001SSerapheim Dimitropoulos  *
95586714001SSerapheim Dimitropoulos  * The enum implicitly includes all the error codes from errno.h.
95686714001SSerapheim Dimitropoulos  * New code should use and extend this enum for errors that are
95786714001SSerapheim Dimitropoulos  * not described precisely by generic errno codes.
95886714001SSerapheim Dimitropoulos  */
95986714001SSerapheim Dimitropoulos typedef enum {
96086714001SSerapheim Dimitropoulos 	ZFS_ERR_CHECKPOINT_EXISTS = 1024,
96186714001SSerapheim Dimitropoulos 	ZFS_ERR_DISCARDING_CHECKPOINT,
96286714001SSerapheim Dimitropoulos 	ZFS_ERR_NO_CHECKPOINT,
96386714001SSerapheim Dimitropoulos 	ZFS_ERR_DEVRM_IN_PROGRESS,
96486714001SSerapheim Dimitropoulos 	ZFS_ERR_VDEV_TOO_BIG
96586714001SSerapheim Dimitropoulos } zfs_errno_t;
96686714001SSerapheim Dimitropoulos 
967ea8dc4b6Seschrock /*
968ea8dc4b6Seschrock  * Internal SPA load state.  Used by FMA diagnosis engine.
969ea8dc4b6Seschrock  */
970ea8dc4b6Seschrock typedef enum {
9719eb19f4dSGeorge Wilson 	SPA_LOAD_NONE,		/* no load in progress	*/
9729eb19f4dSGeorge Wilson 	SPA_LOAD_OPEN,		/* normal open		*/
9739eb19f4dSGeorge Wilson 	SPA_LOAD_IMPORT,	/* import in progress	*/
974468c413aSTim Haley 	SPA_LOAD_TRYIMPORT,	/* tryimport in progress */
9759eb19f4dSGeorge Wilson 	SPA_LOAD_RECOVER,	/* recovery requested	*/
9760f7643c7SGeorge Wilson 	SPA_LOAD_ERROR,		/* load failed		*/
9770f7643c7SGeorge Wilson 	SPA_LOAD_CREATE		/* creation in progress */
978ea8dc4b6Seschrock } spa_load_state_t;
979ea8dc4b6Seschrock 
980e9dbad6fSeschrock /*
981e9dbad6fSeschrock  * Bookmark name values.
982e9dbad6fSeschrock  */
98355434c77Sek #define	ZPOOL_ERR_LIST		"error list"
984e9dbad6fSeschrock #define	ZPOOL_ERR_DATASET	"dataset"
985e9dbad6fSeschrock #define	ZPOOL_ERR_OBJECT	"object"
986e9dbad6fSeschrock 
98706eeb2adSek #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
98806eeb2adSek 
98906eeb2adSek /*
99006eeb2adSek  * The following are names used in the nvlist describing
99106eeb2adSek  * the pool's history log.
99206eeb2adSek  */
99306eeb2adSek #define	ZPOOL_HIST_RECORD	"history record"
99406eeb2adSek #define	ZPOOL_HIST_TIME		"history time"
99506eeb2adSek #define	ZPOOL_HIST_CMD		"history command"
996ecd6cf80Smarks #define	ZPOOL_HIST_WHO		"history who"
997ecd6cf80Smarks #define	ZPOOL_HIST_ZONE		"history zone"
998ecd6cf80Smarks #define	ZPOOL_HIST_HOST		"history hostname"
999ecd6cf80Smarks #define	ZPOOL_HIST_TXG		"history txg"
1000ecd6cf80Smarks #define	ZPOOL_HIST_INT_EVENT	"history internal event"
1001ecd6cf80Smarks #define	ZPOOL_HIST_INT_STR	"history internal str"
10024445fffbSMatthew Ahrens #define	ZPOOL_HIST_INT_NAME	"internal_name"
10034445fffbSMatthew Ahrens #define	ZPOOL_HIST_IOCTL	"ioctl"
10044445fffbSMatthew Ahrens #define	ZPOOL_HIST_INPUT_NVL	"in_nvl"
10054445fffbSMatthew Ahrens #define	ZPOOL_HIST_OUTPUT_NVL	"out_nvl"
10064445fffbSMatthew Ahrens #define	ZPOOL_HIST_DSNAME	"dsname"
10074445fffbSMatthew Ahrens #define	ZPOOL_HIST_DSID		"dsid"
1008dfc11533SChris Williamson #define	ZPOOL_HIST_ERRNO	"errno"
100906eeb2adSek 
10103d7072f8Seschrock /*
10113d7072f8Seschrock  * Flags for ZFS_IOC_VDEV_SET_STATE
10123d7072f8Seschrock  */
10133d7072f8Seschrock #define	ZFS_ONLINE_CHECKREMOVE	0x1
10143d7072f8Seschrock #define	ZFS_ONLINE_UNSPARE	0x2
10153d7072f8Seschrock #define	ZFS_ONLINE_FORCEFAULT	0x4
1016573ca77eSGeorge Wilson #define	ZFS_ONLINE_EXPAND	0x8
10173d7072f8Seschrock #define	ZFS_OFFLINE_TEMPORARY	0x1
10183d7072f8Seschrock 
10194b964adaSGeorge Wilson /*
10204b964adaSGeorge Wilson  * Flags for ZFS_IOC_POOL_IMPORT
10214b964adaSGeorge Wilson  */
10224b964adaSGeorge Wilson #define	ZFS_IMPORT_NORMAL	0x0
10234b964adaSGeorge Wilson #define	ZFS_IMPORT_VERBATIM	0x1
10244b964adaSGeorge Wilson #define	ZFS_IMPORT_ANY_HOST	0x2
10254b964adaSGeorge Wilson #define	ZFS_IMPORT_MISSING_LOG	0x4
1026f9af39baSGeorge Wilson #define	ZFS_IMPORT_ONLY		0x8
102786714001SSerapheim Dimitropoulos #define	ZFS_IMPORT_CHECKPOINT	0x10
10284b964adaSGeorge Wilson 
1029dfc11533SChris Williamson /*
1030dfc11533SChris Williamson  * Channel program argument/return nvlist keys and defaults.
1031dfc11533SChris Williamson  */
1032dfc11533SChris Williamson #define	ZCP_ARG_PROGRAM		"program"
1033dfc11533SChris Williamson #define	ZCP_ARG_ARGLIST		"arg"
1034a3b28680SSerapheim Dimitropoulos #define	ZCP_ARG_SYNC		"sync"
1035dfc11533SChris Williamson #define	ZCP_ARG_INSTRLIMIT	"instrlimit"
1036dfc11533SChris Williamson #define	ZCP_ARG_MEMLIMIT	"memlimit"
1037dfc11533SChris Williamson 
1038dfc11533SChris Williamson #define	ZCP_ARG_CLIARGV		"argv"
1039dfc11533SChris Williamson 
1040dfc11533SChris Williamson #define	ZCP_RET_ERROR		"error"
1041dfc11533SChris Williamson #define	ZCP_RET_RETURN		"return"
1042dfc11533SChris Williamson 
1043dfc11533SChris Williamson #define	ZCP_DEFAULT_INSTRLIMIT	(10 * 1000 * 1000)
1044dfc11533SChris Williamson #define	ZCP_MAX_INSTRLIMIT	(10 * ZCP_DEFAULT_INSTRLIMIT)
1045dfc11533SChris Williamson #define	ZCP_DEFAULT_MEMLIMIT	(10 * 1024 * 1024)
1046dfc11533SChris Williamson #define	ZCP_MAX_MEMLIMIT	(10 * ZCP_DEFAULT_MEMLIMIT)
1047dfc11533SChris Williamson 
10483d7072f8Seschrock /*
10493d7072f8Seschrock  * Sysevent payload members.  ZFS will generate the following sysevents with the
10503d7072f8Seschrock  * given payloads:
10513d7072f8Seschrock  *
10523d7072f8Seschrock  *	ESC_ZFS_RESILVER_START
10533d7072f8Seschrock  *	ESC_ZFS_RESILVER_END
10543d7072f8Seschrock  *	ESC_ZFS_POOL_DESTROY
1055e9103aaeSGarrett D'Amore  *	ESC_ZFS_POOL_REGUID
10563d7072f8Seschrock  *
10573d7072f8Seschrock  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
10583d7072f8Seschrock  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
10593d7072f8Seschrock  *
10603d7072f8Seschrock  *	ESC_ZFS_VDEV_REMOVE
10613d7072f8Seschrock  *	ESC_ZFS_VDEV_CLEAR
10623d7072f8Seschrock  *	ESC_ZFS_VDEV_CHECK
10633d7072f8Seschrock  *
10643d7072f8Seschrock  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
10653d7072f8Seschrock  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
10663d7072f8Seschrock  *		ZFS_EV_VDEV_PATH	DATA_TYPE_STRING	(optional)
10673d7072f8Seschrock  *		ZFS_EV_VDEV_GUID	DATA_TYPE_UINT64
1068ce1577b0SDave Eddy  *
1069ce1577b0SDave Eddy  *	ESC_ZFS_HISTORY_EVENT
1070ce1577b0SDave Eddy  *
1071ce1577b0SDave Eddy  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
1072ce1577b0SDave Eddy  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
1073ce1577b0SDave Eddy  *		ZFS_EV_HIST_TIME	DATA_TYPE_UINT64	(optional)
1074ce1577b0SDave Eddy  *		ZFS_EV_HIST_CMD		DATA_TYPE_STRING	(optional)
1075ce1577b0SDave Eddy  *		ZFS_EV_HIST_WHO		DATA_TYPE_UINT64	(optional)
1076ce1577b0SDave Eddy  *		ZFS_EV_HIST_ZONE	DATA_TYPE_STRING	(optional)
1077ce1577b0SDave Eddy  *		ZFS_EV_HIST_HOST	DATA_TYPE_STRING	(optional)
1078ce1577b0SDave Eddy  *		ZFS_EV_HIST_TXG		DATA_TYPE_UINT64	(optional)
1079ce1577b0SDave Eddy  *		ZFS_EV_HIST_INT_EVENT	DATA_TYPE_UINT64	(optional)
1080ce1577b0SDave Eddy  *		ZFS_EV_HIST_INT_STR	DATA_TYPE_STRING	(optional)
1081ce1577b0SDave Eddy  *		ZFS_EV_HIST_INT_NAME	DATA_TYPE_STRING	(optional)
1082ce1577b0SDave Eddy  *		ZFS_EV_HIST_IOCTL	DATA_TYPE_STRING	(optional)
1083ce1577b0SDave Eddy  *		ZFS_EV_HIST_DSNAME	DATA_TYPE_STRING	(optional)
1084ce1577b0SDave Eddy  *		ZFS_EV_HIST_DSID	DATA_TYPE_UINT64	(optional)
1085ce1577b0SDave Eddy  *
1086ce1577b0SDave Eddy  * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1087ce1577b0SDave Eddy  * history log nvlist.  The keynames will be free of any spaces or other
1088ce1577b0SDave Eddy  * characters that could be potentially unexpected to consumers of the
1089ce1577b0SDave Eddy  * sysevents.
10903d7072f8Seschrock  */
10913d7072f8Seschrock #define	ZFS_EV_POOL_NAME	"pool_name"
10923d7072f8Seschrock #define	ZFS_EV_POOL_GUID	"pool_guid"
10933d7072f8Seschrock #define	ZFS_EV_VDEV_PATH	"vdev_path"
10943d7072f8Seschrock #define	ZFS_EV_VDEV_GUID	"vdev_guid"
1095ce1577b0SDave Eddy #define	ZFS_EV_HIST_TIME	"history_time"
1096ce1577b0SDave Eddy #define	ZFS_EV_HIST_CMD		"history_command"
1097ce1577b0SDave Eddy #define	ZFS_EV_HIST_WHO		"history_who"
1098ce1577b0SDave Eddy #define	ZFS_EV_HIST_ZONE	"history_zone"
1099ce1577b0SDave Eddy #define	ZFS_EV_HIST_HOST	"history_hostname"
1100ce1577b0SDave Eddy #define	ZFS_EV_HIST_TXG		"history_txg"
1101ce1577b0SDave Eddy #define	ZFS_EV_HIST_INT_EVENT	"history_internal_event"
1102ce1577b0SDave Eddy #define	ZFS_EV_HIST_INT_STR	"history_internal_str"
1103ce1577b0SDave Eddy #define	ZFS_EV_HIST_INT_NAME	"history_internal_name"
1104ce1577b0SDave Eddy #define	ZFS_EV_HIST_IOCTL	"history_ioctl"
1105ce1577b0SDave Eddy #define	ZFS_EV_HIST_DSNAME	"history_dsname"
1106ce1577b0SDave Eddy #define	ZFS_EV_HIST_DSID	"history_dsid"
11073d7072f8Seschrock 
1108fa9e4066Sahrens #ifdef	__cplusplus
1109fa9e4066Sahrens }
1110fa9e4066Sahrens #endif
1111fa9e4066Sahrens 
1112fa9e4066Sahrens #endif	/* _SYS_FS_ZFS_H */
1113