xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision e96f8419)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
25  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
26  * Copyright (c) 2014 Integros [integros.com]
27  * Copyright 2017 Joyent, Inc.
28  */
29 
30 /* Portions Copyright 2010 Robert Milkowski */
31 
32 #ifndef	_SYS_FS_ZFS_H
33 #define	_SYS_FS_ZFS_H
34 
35 #include <sys/time.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 /*
42  * Types and constants shared between userland and the kernel.
43  */
44 
45 /*
46  * Each dataset can be one of the following types.  These constants can be
47  * combined into masks that can be passed to various functions.
48  */
49 typedef enum {
50 	ZFS_TYPE_FILESYSTEM	= (1 << 0),
51 	ZFS_TYPE_SNAPSHOT	= (1 << 1),
52 	ZFS_TYPE_VOLUME		= (1 << 2),
53 	ZFS_TYPE_POOL		= (1 << 3),
54 	ZFS_TYPE_BOOKMARK	= (1 << 4)
55 } zfs_type_t;
56 
57 /*
58  * NB: lzc_dataset_type should be updated whenever a new objset type is added,
59  * if it represents a real type of a dataset that can be created from userland.
60  */
61 typedef enum dmu_objset_type {
62 	DMU_OST_NONE,
63 	DMU_OST_META,
64 	DMU_OST_ZFS,
65 	DMU_OST_ZVOL,
66 	DMU_OST_OTHER,			/* For testing only! */
67 	DMU_OST_ANY,			/* Be careful! */
68 	DMU_OST_NUMTYPES
69 } dmu_objset_type_t;
70 
71 #define	ZFS_TYPE_DATASET	\
72 	(ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
73 
74 /*
75  * All of these include the terminating NUL byte.
76  */
77 #define	ZAP_MAXNAMELEN 256
78 #define	ZAP_MAXVALUELEN (1024 * 8)
79 #define	ZAP_OLDMAXVALUELEN 1024
80 #define	ZFS_MAX_DATASET_NAME_LEN 256
81 
82 /*
83  * Dataset properties are identified by these constants and must be added to
84  * the end of this list to ensure that external consumers are not affected
85  * by the change. If you make any changes to this list, be sure to update
86  * the property table in usr/src/common/zfs/zfs_prop.c.
87  */
88 typedef enum {
89 	ZFS_PROP_BAD = -1,
90 	ZFS_PROP_TYPE = 0,
91 	ZFS_PROP_CREATION,
92 	ZFS_PROP_USED,
93 	ZFS_PROP_AVAILABLE,
94 	ZFS_PROP_REFERENCED,
95 	ZFS_PROP_COMPRESSRATIO,
96 	ZFS_PROP_MOUNTED,
97 	ZFS_PROP_ORIGIN,
98 	ZFS_PROP_QUOTA,
99 	ZFS_PROP_RESERVATION,
100 	ZFS_PROP_VOLSIZE,
101 	ZFS_PROP_VOLBLOCKSIZE,
102 	ZFS_PROP_RECORDSIZE,
103 	ZFS_PROP_MOUNTPOINT,
104 	ZFS_PROP_SHARENFS,
105 	ZFS_PROP_CHECKSUM,
106 	ZFS_PROP_COMPRESSION,
107 	ZFS_PROP_ATIME,
108 	ZFS_PROP_DEVICES,
109 	ZFS_PROP_EXEC,
110 	ZFS_PROP_SETUID,
111 	ZFS_PROP_READONLY,
112 	ZFS_PROP_ZONED,
113 	ZFS_PROP_SNAPDIR,
114 	ZFS_PROP_ACLMODE,
115 	ZFS_PROP_ACLINHERIT,
116 	ZFS_PROP_CREATETXG,		/* not exposed to the user */
117 	ZFS_PROP_NAME,			/* not exposed to the user */
118 	ZFS_PROP_CANMOUNT,
119 	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */
120 	ZFS_PROP_XATTR,
121 	ZFS_PROP_NUMCLONES,		/* not exposed to the user */
122 	ZFS_PROP_COPIES,
123 	ZFS_PROP_VERSION,
124 	ZFS_PROP_UTF8ONLY,
125 	ZFS_PROP_NORMALIZE,
126 	ZFS_PROP_CASE,
127 	ZFS_PROP_VSCAN,
128 	ZFS_PROP_NBMAND,
129 	ZFS_PROP_SHARESMB,
130 	ZFS_PROP_REFQUOTA,
131 	ZFS_PROP_REFRESERVATION,
132 	ZFS_PROP_GUID,
133 	ZFS_PROP_PRIMARYCACHE,
134 	ZFS_PROP_SECONDARYCACHE,
135 	ZFS_PROP_USEDSNAP,
136 	ZFS_PROP_USEDDS,
137 	ZFS_PROP_USEDCHILD,
138 	ZFS_PROP_USEDREFRESERV,
139 	ZFS_PROP_USERACCOUNTING,	/* not exposed to the user */
140 	ZFS_PROP_STMF_SHAREINFO,	/* not exposed to the user */
141 	ZFS_PROP_DEFER_DESTROY,
142 	ZFS_PROP_USERREFS,
143 	ZFS_PROP_LOGBIAS,
144 	ZFS_PROP_UNIQUE,		/* not exposed to the user */
145 	ZFS_PROP_OBJSETID,		/* not exposed to the user */
146 	ZFS_PROP_DEDUP,
147 	ZFS_PROP_MLSLABEL,
148 	ZFS_PROP_SYNC,
149 	ZFS_PROP_REFRATIO,
150 	ZFS_PROP_WRITTEN,
151 	ZFS_PROP_CLONES,
152 	ZFS_PROP_LOGICALUSED,
153 	ZFS_PROP_LOGICALREFERENCED,
154 	ZFS_PROP_INCONSISTENT,		/* not exposed to the user */
155 	ZFS_PROP_FILESYSTEM_LIMIT,
156 	ZFS_PROP_SNAPSHOT_LIMIT,
157 	ZFS_PROP_FILESYSTEM_COUNT,
158 	ZFS_PROP_SNAPSHOT_COUNT,
159 	ZFS_PROP_REDUNDANT_METADATA,
160 	ZFS_PROP_PREV_SNAP,
161 	ZFS_PROP_RECEIVE_RESUME_TOKEN,
162 	ZFS_NUM_PROPS
163 } zfs_prop_t;
164 
165 typedef enum {
166 	ZFS_PROP_USERUSED,
167 	ZFS_PROP_USERQUOTA,
168 	ZFS_PROP_GROUPUSED,
169 	ZFS_PROP_GROUPQUOTA,
170 	ZFS_NUM_USERQUOTA_PROPS
171 } zfs_userquota_prop_t;
172 
173 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
174 
175 /*
176  * Pool properties are identified by these constants and must be added to the
177  * end of this list to ensure that external consumers are not affected
178  * by the change. If you make any changes to this list, be sure to update
179  * the property table in usr/src/common/zfs/zpool_prop.c.
180  */
181 typedef enum {
182 	ZPOOL_PROP_NAME,
183 	ZPOOL_PROP_SIZE,
184 	ZPOOL_PROP_CAPACITY,
185 	ZPOOL_PROP_ALTROOT,
186 	ZPOOL_PROP_HEALTH,
187 	ZPOOL_PROP_GUID,
188 	ZPOOL_PROP_VERSION,
189 	ZPOOL_PROP_BOOTFS,
190 	ZPOOL_PROP_DELEGATION,
191 	ZPOOL_PROP_AUTOREPLACE,
192 	ZPOOL_PROP_CACHEFILE,
193 	ZPOOL_PROP_FAILUREMODE,
194 	ZPOOL_PROP_LISTSNAPS,
195 	ZPOOL_PROP_AUTOEXPAND,
196 	ZPOOL_PROP_DEDUPDITTO,
197 	ZPOOL_PROP_DEDUPRATIO,
198 	ZPOOL_PROP_FREE,
199 	ZPOOL_PROP_ALLOCATED,
200 	ZPOOL_PROP_READONLY,
201 	ZPOOL_PROP_COMMENT,
202 	ZPOOL_PROP_EXPANDSZ,
203 	ZPOOL_PROP_FREEING,
204 	ZPOOL_PROP_FRAGMENTATION,
205 	ZPOOL_PROP_LEAKED,
206 	ZPOOL_PROP_MAXBLOCKSIZE,
207 	ZPOOL_PROP_BOOTSIZE,
208 	ZPOOL_NUM_PROPS
209 } zpool_prop_t;
210 
211 /* Small enough to not hog a whole line of printout in zpool(1M). */
212 #define	ZPROP_MAX_COMMENT	32
213 
214 #define	ZPROP_CONT		-2
215 #define	ZPROP_INVAL		-1
216 
217 #define	ZPROP_VALUE		"value"
218 #define	ZPROP_SOURCE		"source"
219 
220 typedef enum {
221 	ZPROP_SRC_NONE = 0x1,
222 	ZPROP_SRC_DEFAULT = 0x2,
223 	ZPROP_SRC_TEMPORARY = 0x4,
224 	ZPROP_SRC_LOCAL = 0x8,
225 	ZPROP_SRC_INHERITED = 0x10,
226 	ZPROP_SRC_RECEIVED = 0x20
227 } zprop_source_t;
228 
229 #define	ZPROP_SRC_ALL	0x3f
230 
231 #define	ZPROP_SOURCE_VAL_RECVD	"$recvd"
232 #define	ZPROP_N_MORE_ERRORS	"N_MORE_ERRORS"
233 /*
234  * Dataset flag implemented as a special entry in the props zap object
235  * indicating that the dataset has received properties on or after
236  * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
237  * just as it did in earlier versions, and thereafter, local properties are
238  * preserved.
239  */
240 #define	ZPROP_HAS_RECVD		"$hasrecvd"
241 
242 typedef enum {
243 	ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
244 	ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
245 } zprop_errflags_t;
246 
247 typedef int (*zprop_func)(int, void *);
248 
249 /*
250  * Properties to be set on the root file system of a new pool
251  * are stuffed into their own nvlist, which is then included in
252  * the properties nvlist with the pool properties.
253  */
254 #define	ZPOOL_ROOTFS_PROPS	"root-props-nvl"
255 
256 /*
257  * Dataset property functions shared between libzfs and kernel.
258  */
259 const char *zfs_prop_default_string(zfs_prop_t);
260 uint64_t zfs_prop_default_numeric(zfs_prop_t);
261 boolean_t zfs_prop_readonly(zfs_prop_t);
262 boolean_t zfs_prop_inheritable(zfs_prop_t);
263 boolean_t zfs_prop_setonce(zfs_prop_t);
264 const char *zfs_prop_to_name(zfs_prop_t);
265 zfs_prop_t zfs_name_to_prop(const char *);
266 boolean_t zfs_prop_user(const char *);
267 boolean_t zfs_prop_userquota(const char *);
268 boolean_t zfs_prop_written(const char *);
269 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
270 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
271 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
272 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
273 
274 /*
275  * Pool property functions shared between libzfs and kernel.
276  */
277 zpool_prop_t zpool_name_to_prop(const char *);
278 const char *zpool_prop_to_name(zpool_prop_t);
279 const char *zpool_prop_default_string(zpool_prop_t);
280 uint64_t zpool_prop_default_numeric(zpool_prop_t);
281 boolean_t zpool_prop_readonly(zpool_prop_t);
282 boolean_t zpool_prop_feature(const char *);
283 boolean_t zpool_prop_unsupported(const char *name);
284 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
285 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
286 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
287 
288 /*
289  * Definitions for the Delegation.
290  */
291 typedef enum {
292 	ZFS_DELEG_WHO_UNKNOWN = 0,
293 	ZFS_DELEG_USER = 'u',
294 	ZFS_DELEG_USER_SETS = 'U',
295 	ZFS_DELEG_GROUP = 'g',
296 	ZFS_DELEG_GROUP_SETS = 'G',
297 	ZFS_DELEG_EVERYONE = 'e',
298 	ZFS_DELEG_EVERYONE_SETS = 'E',
299 	ZFS_DELEG_CREATE = 'c',
300 	ZFS_DELEG_CREATE_SETS = 'C',
301 	ZFS_DELEG_NAMED_SET = 's',
302 	ZFS_DELEG_NAMED_SET_SETS = 'S'
303 } zfs_deleg_who_type_t;
304 
305 typedef enum {
306 	ZFS_DELEG_NONE = 0,
307 	ZFS_DELEG_PERM_LOCAL = 1,
308 	ZFS_DELEG_PERM_DESCENDENT = 2,
309 	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
310 	ZFS_DELEG_PERM_CREATE = 4
311 } zfs_deleg_inherit_t;
312 
313 #define	ZFS_DELEG_PERM_UID	"uid"
314 #define	ZFS_DELEG_PERM_GID	"gid"
315 #define	ZFS_DELEG_PERM_GROUPS	"groups"
316 
317 #define	ZFS_MLSLABEL_DEFAULT	"none"
318 
319 #define	ZFS_SMB_ACL_SRC		"src"
320 #define	ZFS_SMB_ACL_TARGET	"target"
321 
322 typedef enum {
323 	ZFS_CANMOUNT_OFF = 0,
324 	ZFS_CANMOUNT_ON = 1,
325 	ZFS_CANMOUNT_NOAUTO = 2
326 } zfs_canmount_type_t;
327 
328 typedef enum {
329 	ZFS_LOGBIAS_LATENCY = 0,
330 	ZFS_LOGBIAS_THROUGHPUT = 1
331 } zfs_logbias_op_t;
332 
333 typedef enum zfs_share_op {
334 	ZFS_SHARE_NFS = 0,
335 	ZFS_UNSHARE_NFS = 1,
336 	ZFS_SHARE_SMB = 2,
337 	ZFS_UNSHARE_SMB = 3
338 } zfs_share_op_t;
339 
340 typedef enum zfs_smb_acl_op {
341 	ZFS_SMB_ACL_ADD,
342 	ZFS_SMB_ACL_REMOVE,
343 	ZFS_SMB_ACL_RENAME,
344 	ZFS_SMB_ACL_PURGE
345 } zfs_smb_acl_op_t;
346 
347 typedef enum zfs_cache_type {
348 	ZFS_CACHE_NONE = 0,
349 	ZFS_CACHE_METADATA = 1,
350 	ZFS_CACHE_ALL = 2
351 } zfs_cache_type_t;
352 
353 typedef enum {
354 	ZFS_SYNC_STANDARD = 0,
355 	ZFS_SYNC_ALWAYS = 1,
356 	ZFS_SYNC_DISABLED = 2
357 } zfs_sync_type_t;
358 
359 typedef enum {
360 	ZFS_REDUNDANT_METADATA_ALL,
361 	ZFS_REDUNDANT_METADATA_MOST
362 } zfs_redundant_metadata_type_t;
363 
364 /*
365  * On-disk version number.
366  */
367 #define	SPA_VERSION_1			1ULL
368 #define	SPA_VERSION_2			2ULL
369 #define	SPA_VERSION_3			3ULL
370 #define	SPA_VERSION_4			4ULL
371 #define	SPA_VERSION_5			5ULL
372 #define	SPA_VERSION_6			6ULL
373 #define	SPA_VERSION_7			7ULL
374 #define	SPA_VERSION_8			8ULL
375 #define	SPA_VERSION_9			9ULL
376 #define	SPA_VERSION_10			10ULL
377 #define	SPA_VERSION_11			11ULL
378 #define	SPA_VERSION_12			12ULL
379 #define	SPA_VERSION_13			13ULL
380 #define	SPA_VERSION_14			14ULL
381 #define	SPA_VERSION_15			15ULL
382 #define	SPA_VERSION_16			16ULL
383 #define	SPA_VERSION_17			17ULL
384 #define	SPA_VERSION_18			18ULL
385 #define	SPA_VERSION_19			19ULL
386 #define	SPA_VERSION_20			20ULL
387 #define	SPA_VERSION_21			21ULL
388 #define	SPA_VERSION_22			22ULL
389 #define	SPA_VERSION_23			23ULL
390 #define	SPA_VERSION_24			24ULL
391 #define	SPA_VERSION_25			25ULL
392 #define	SPA_VERSION_26			26ULL
393 #define	SPA_VERSION_27			27ULL
394 #define	SPA_VERSION_28			28ULL
395 #define	SPA_VERSION_5000		5000ULL
396 
397 /*
398  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
399  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
400  * and do the appropriate changes.  Also bump the version number in
401  * usr/src/grub/capability.
402  */
403 #define	SPA_VERSION			SPA_VERSION_5000
404 #define	SPA_VERSION_STRING		"5000"
405 
406 /*
407  * Symbolic names for the changes that caused a SPA_VERSION switch.
408  * Used in the code when checking for presence or absence of a feature.
409  * Feel free to define multiple symbolic names for each version if there
410  * were multiple changes to on-disk structures during that version.
411  *
412  * NOTE: When checking the current SPA_VERSION in your code, be sure
413  *       to use spa_version() since it reports the version of the
414  *       last synced uberblock.  Checking the in-flight version can
415  *       be dangerous in some cases.
416  */
417 #define	SPA_VERSION_INITIAL		SPA_VERSION_1
418 #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
419 #define	SPA_VERSION_SPARES		SPA_VERSION_3
420 #define	SPA_VERSION_RAIDZ2		SPA_VERSION_3
421 #define	SPA_VERSION_BPOBJ_ACCOUNT	SPA_VERSION_3
422 #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
423 #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
424 #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
425 #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
426 #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
427 #define	SPA_VERSION_SLOGS		SPA_VERSION_7
428 #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
429 #define	SPA_VERSION_FUID		SPA_VERSION_9
430 #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
431 #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
432 #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
433 #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
434 #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
435 #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
436 #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
437 #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
438 #define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13
439 #define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14
440 #define	SPA_VERSION_USERSPACE		SPA_VERSION_15
441 #define	SPA_VERSION_STMF_PROP		SPA_VERSION_16
442 #define	SPA_VERSION_RAIDZ3		SPA_VERSION_17
443 #define	SPA_VERSION_USERREFS		SPA_VERSION_18
444 #define	SPA_VERSION_HOLES		SPA_VERSION_19
445 #define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20
446 #define	SPA_VERSION_DEDUP		SPA_VERSION_21
447 #define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22
448 #define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23
449 #define	SPA_VERSION_SA			SPA_VERSION_24
450 #define	SPA_VERSION_SCAN		SPA_VERSION_25
451 #define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26
452 #define	SPA_VERSION_DEADLISTS		SPA_VERSION_26
453 #define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27
454 #define	SPA_VERSION_MULTI_REPLACE	SPA_VERSION_28
455 #define	SPA_VERSION_BEFORE_FEATURES	SPA_VERSION_28
456 #define	SPA_VERSION_FEATURES		SPA_VERSION_5000
457 
458 #define	SPA_VERSION_IS_SUPPORTED(v) \
459 	(((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
460 	((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
461 
462 /*
463  * ZPL version - rev'd whenever an incompatible on-disk format change
464  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
465  * also update the version_table[] and help message in zfs_prop.c.
466  *
467  * When changing, be sure to teach GRUB how to read the new format!
468  * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
469  */
470 #define	ZPL_VERSION_1			1ULL
471 #define	ZPL_VERSION_2			2ULL
472 #define	ZPL_VERSION_3			3ULL
473 #define	ZPL_VERSION_4			4ULL
474 #define	ZPL_VERSION_5			5ULL
475 #define	ZPL_VERSION			ZPL_VERSION_5
476 #define	ZPL_VERSION_STRING		"5"
477 
478 #define	ZPL_VERSION_INITIAL		ZPL_VERSION_1
479 #define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2
480 #define	ZPL_VERSION_FUID		ZPL_VERSION_3
481 #define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3
482 #define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3
483 #define	ZPL_VERSION_USERSPACE		ZPL_VERSION_4
484 #define	ZPL_VERSION_SA			ZPL_VERSION_5
485 
486 /* Rewind request information */
487 #define	ZPOOL_NO_REWIND		1  /* No policy - default behavior */
488 #define	ZPOOL_NEVER_REWIND	2  /* Do not search for best txg or rewind */
489 #define	ZPOOL_TRY_REWIND	4  /* Search for best txg, but do not rewind */
490 #define	ZPOOL_DO_REWIND		8  /* Rewind to best txg w/in deferred frees */
491 #define	ZPOOL_EXTREME_REWIND	16 /* Allow extreme measures to find best txg */
492 #define	ZPOOL_REWIND_MASK	28 /* All the possible rewind bits */
493 #define	ZPOOL_REWIND_POLICIES	31 /* All the possible policy bits */
494 
495 typedef struct zpool_rewind_policy {
496 	uint32_t	zrp_request;	/* rewind behavior requested */
497 	uint64_t	zrp_maxmeta;	/* max acceptable meta-data errors */
498 	uint64_t	zrp_maxdata;	/* max acceptable data errors */
499 	uint64_t	zrp_txg;	/* specific txg to load */
500 } zpool_rewind_policy_t;
501 
502 /*
503  * The following are configuration names used in the nvlist describing a pool's
504  * configuration.
505  */
506 #define	ZPOOL_CONFIG_VERSION		"version"
507 #define	ZPOOL_CONFIG_POOL_NAME		"name"
508 #define	ZPOOL_CONFIG_POOL_STATE		"state"
509 #define	ZPOOL_CONFIG_POOL_TXG		"txg"
510 #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
511 #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
512 #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
513 #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
514 #define	ZPOOL_CONFIG_TYPE		"type"
515 #define	ZPOOL_CONFIG_CHILDREN		"children"
516 #define	ZPOOL_CONFIG_ID			"id"
517 #define	ZPOOL_CONFIG_GUID		"guid"
518 #define	ZPOOL_CONFIG_PATH		"path"
519 #define	ZPOOL_CONFIG_DEVID		"devid"
520 #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
521 #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
522 #define	ZPOOL_CONFIG_ASHIFT		"ashift"
523 #define	ZPOOL_CONFIG_ASIZE		"asize"
524 #define	ZPOOL_CONFIG_DTL		"DTL"
525 #define	ZPOOL_CONFIG_SCAN_STATS		"scan_stats"	/* not stored on disk */
526 #define	ZPOOL_CONFIG_VDEV_STATS		"vdev_stats"	/* not stored on disk */
527 #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
528 #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
529 #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
530 #define	ZPOOL_CONFIG_SPARES		"spares"
531 #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
532 #define	ZPOOL_CONFIG_NPARITY		"nparity"
533 #define	ZPOOL_CONFIG_HOSTID		"hostid"
534 #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
535 #define	ZPOOL_CONFIG_LOADED_TIME	"initial_load_time"
536 #define	ZPOOL_CONFIG_UNSPARE		"unspare"
537 #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
538 #define	ZPOOL_CONFIG_IS_LOG		"is_log"
539 #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
540 #define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"
541 #define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"
542 #define	ZPOOL_CONFIG_IS_HOLE		"is_hole"
543 #define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"
544 #define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"
545 #define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"
546 #define	ZPOOL_CONFIG_SPLIT		"splitcfg"
547 #define	ZPOOL_CONFIG_ORIG_GUID		"orig_guid"
548 #define	ZPOOL_CONFIG_SPLIT_GUID		"split_guid"
549 #define	ZPOOL_CONFIG_SPLIT_LIST		"guid_list"
550 #define	ZPOOL_CONFIG_REMOVING		"removing"
551 #define	ZPOOL_CONFIG_RESILVER_TXG	"resilver_txg"
552 #define	ZPOOL_CONFIG_COMMENT		"comment"
553 #define	ZPOOL_CONFIG_SUSPENDED		"suspended"	/* not stored on disk */
554 #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp"	/* not stored on disk */
555 #define	ZPOOL_CONFIG_BOOTFS		"bootfs"	/* not stored on disk */
556 #define	ZPOOL_CONFIG_MISSING_DEVICES	"missing_vdevs"	/* not stored on disk */
557 #define	ZPOOL_CONFIG_LOAD_INFO		"load_info"	/* not stored on disk */
558 #define	ZPOOL_CONFIG_REWIND_INFO	"rewind_info"	/* not stored on disk */
559 #define	ZPOOL_CONFIG_UNSUP_FEAT		"unsup_feat"	/* not stored on disk */
560 #define	ZPOOL_CONFIG_ENABLED_FEAT	"enabled_feat"	/* not stored on disk */
561 #define	ZPOOL_CONFIG_CAN_RDONLY		"can_rdonly"	/* not stored on disk */
562 #define	ZPOOL_CONFIG_FEATURES_FOR_READ	"features_for_read"
563 #define	ZPOOL_CONFIG_FEATURE_STATS	"feature_stats"	/* not stored on disk */
564 #define	ZPOOL_CONFIG_VDEV_TOP_ZAP	"com.delphix:vdev_zap_top"
565 #define	ZPOOL_CONFIG_VDEV_LEAF_ZAP	"com.delphix:vdev_zap_leaf"
566 #define	ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS	"com.delphix:has_per_vdev_zaps"
567 /*
568  * The persistent vdev state is stored as separate values rather than a single
569  * 'vdev_state' entry.  This is because a device can be in multiple states, such
570  * as offline and degraded.
571  */
572 #define	ZPOOL_CONFIG_OFFLINE		"offline"
573 #define	ZPOOL_CONFIG_FAULTED		"faulted"
574 #define	ZPOOL_CONFIG_DEGRADED		"degraded"
575 #define	ZPOOL_CONFIG_REMOVED		"removed"
576 #define	ZPOOL_CONFIG_FRU		"fru"
577 #define	ZPOOL_CONFIG_AUX_STATE		"aux_state"
578 
579 /* Rewind policy parameters */
580 #define	ZPOOL_REWIND_POLICY		"rewind-policy"
581 #define	ZPOOL_REWIND_REQUEST		"rewind-request"
582 #define	ZPOOL_REWIND_REQUEST_TXG	"rewind-request-txg"
583 #define	ZPOOL_REWIND_META_THRESH	"rewind-meta-thresh"
584 #define	ZPOOL_REWIND_DATA_THRESH	"rewind-data-thresh"
585 
586 /* Rewind data discovered */
587 #define	ZPOOL_CONFIG_LOAD_TIME		"rewind_txg_ts"
588 #define	ZPOOL_CONFIG_LOAD_DATA_ERRORS	"verify_data_errors"
589 #define	ZPOOL_CONFIG_REWIND_TIME	"seconds_of_rewind"
590 
591 #define	VDEV_TYPE_ROOT			"root"
592 #define	VDEV_TYPE_MIRROR		"mirror"
593 #define	VDEV_TYPE_REPLACING		"replacing"
594 #define	VDEV_TYPE_RAIDZ			"raidz"
595 #define	VDEV_TYPE_DISK			"disk"
596 #define	VDEV_TYPE_FILE			"file"
597 #define	VDEV_TYPE_MISSING		"missing"
598 #define	VDEV_TYPE_HOLE			"hole"
599 #define	VDEV_TYPE_SPARE			"spare"
600 #define	VDEV_TYPE_LOG			"log"
601 #define	VDEV_TYPE_L2CACHE		"l2cache"
602 
603 /*
604  * This is needed in userland to report the minimum necessary device size.
605  *
606  * Note that the zfs test suite uses 64MB vdevs.
607  */
608 #define	SPA_MINDEVSIZE		(64ULL << 20)
609 
610 /*
611  * Set if the fragmentation has not yet been calculated. This can happen
612  * because the space maps have not been upgraded or the histogram feature
613  * is not enabled.
614  */
615 #define	ZFS_FRAG_INVALID	UINT64_MAX
616 
617 /*
618  * The location of the pool configuration repository, shared between kernel and
619  * userland.
620  */
621 #define	ZPOOL_CACHE		"/etc/zfs/zpool.cache"
622 
623 /*
624  * vdev states are ordered from least to most healthy.
625  * A vdev that's CANT_OPEN or below is considered unusable.
626  */
627 typedef enum vdev_state {
628 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
629 	VDEV_STATE_CLOSED,	/* Not currently open			*/
630 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
631 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
632 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
633 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
634 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
635 	VDEV_STATE_HEALTHY	/* Presumed good			*/
636 } vdev_state_t;
637 
638 #define	VDEV_STATE_ONLINE	VDEV_STATE_HEALTHY
639 
640 /*
641  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
642  * of the vdev stats structure uses these constants to distinguish why.
643  */
644 typedef enum vdev_aux {
645 	VDEV_AUX_NONE,		/* no error				*/
646 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
647 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
648 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
649 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
650 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
651 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
652 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
653 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
654 	VDEV_AUX_UNSUP_FEAT,	/* unsupported features			*/
655 	VDEV_AUX_SPARED,	/* hot spare used in another pool	*/
656 	VDEV_AUX_ERR_EXCEEDED,	/* too many errors			*/
657 	VDEV_AUX_IO_FAILURE,	/* experienced I/O failure		*/
658 	VDEV_AUX_BAD_LOG,	/* cannot read log chain(s)		*/
659 	VDEV_AUX_EXTERNAL,	/* external diagnosis			*/
660 	VDEV_AUX_SPLIT_POOL	/* vdev was split off into another pool	*/
661 } vdev_aux_t;
662 
663 /*
664  * pool state.  The following states are written to disk as part of the normal
665  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
666  * states are software abstractions used at various levels to communicate
667  * pool state.
668  */
669 typedef enum pool_state {
670 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
671 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
672 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
673 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
674 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
675 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
676 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
677 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
678 } pool_state_t;
679 
680 /*
681  * Scan Functions.
682  */
683 typedef enum pool_scan_func {
684 	POOL_SCAN_NONE,
685 	POOL_SCAN_SCRUB,
686 	POOL_SCAN_RESILVER,
687 	POOL_SCAN_FUNCS
688 } pool_scan_func_t;
689 
690 /*
691  * ZIO types.  Needed to interpret vdev statistics below.
692  */
693 typedef enum zio_type {
694 	ZIO_TYPE_NULL = 0,
695 	ZIO_TYPE_READ,
696 	ZIO_TYPE_WRITE,
697 	ZIO_TYPE_FREE,
698 	ZIO_TYPE_CLAIM,
699 	ZIO_TYPE_IOCTL,
700 	ZIO_TYPES
701 } zio_type_t;
702 
703 /*
704  * Pool statistics.  Note: all fields should be 64-bit because this
705  * is passed between kernel and userland as an nvlist uint64 array.
706  */
707 typedef struct pool_scan_stat {
708 	/* values stored on disk */
709 	uint64_t	pss_func;	/* pool_scan_func_t */
710 	uint64_t	pss_state;	/* dsl_scan_state_t */
711 	uint64_t	pss_start_time;	/* scan start time */
712 	uint64_t	pss_end_time;	/* scan end time */
713 	uint64_t	pss_to_examine;	/* total bytes to scan */
714 	uint64_t	pss_examined;	/* total examined bytes	*/
715 	uint64_t	pss_to_process; /* total bytes to process */
716 	uint64_t	pss_processed;	/* total processed bytes */
717 	uint64_t	pss_errors;	/* scan errors	*/
718 
719 	/* values not stored on disk */
720 	uint64_t	pss_pass_exam;	/* examined bytes per scan pass */
721 	uint64_t	pss_pass_start;	/* start time of a scan pass */
722 } pool_scan_stat_t;
723 
724 typedef enum dsl_scan_state {
725 	DSS_NONE,
726 	DSS_SCANNING,
727 	DSS_FINISHED,
728 	DSS_CANCELED,
729 	DSS_NUM_STATES
730 } dsl_scan_state_t;
731 
732 
733 /*
734  * Vdev statistics.  Note: all fields should be 64-bit because this
735  * is passed between kernel and userland as an nvlist uint64 array.
736  */
737 typedef struct vdev_stat {
738 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
739 	uint64_t	vs_state;		/* vdev state		*/
740 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
741 	uint64_t	vs_alloc;		/* space allocated	*/
742 	uint64_t	vs_space;		/* total capacity	*/
743 	uint64_t	vs_dspace;		/* deflated capacity	*/
744 	uint64_t	vs_rsize;		/* replaceable dev size */
745 	uint64_t	vs_esize;		/* expandable dev size */
746 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
747 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
748 	uint64_t	vs_read_errors;		/* read errors		*/
749 	uint64_t	vs_write_errors;	/* write errors		*/
750 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
751 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
752 	uint64_t	vs_scan_removing;	/* removing?	*/
753 	uint64_t	vs_scan_processed;	/* scan processed bytes	*/
754 	uint64_t	vs_fragmentation;	/* device fragmentation */
755 } vdev_stat_t;
756 
757 /*
758  * DDT statistics.  Note: all fields should be 64-bit because this
759  * is passed between kernel and userland as an nvlist uint64 array.
760  */
761 typedef struct ddt_object {
762 	uint64_t	ddo_count;	/* number of elments in ddt 	*/
763 	uint64_t	ddo_dspace;	/* size of ddt on disk		*/
764 	uint64_t	ddo_mspace;	/* size of ddt in-core		*/
765 } ddt_object_t;
766 
767 typedef struct ddt_stat {
768 	uint64_t	dds_blocks;	/* blocks			*/
769 	uint64_t	dds_lsize;	/* logical size			*/
770 	uint64_t	dds_psize;	/* physical size		*/
771 	uint64_t	dds_dsize;	/* deflated allocated size	*/
772 	uint64_t	dds_ref_blocks;	/* referenced blocks		*/
773 	uint64_t	dds_ref_lsize;	/* referenced lsize * refcnt	*/
774 	uint64_t	dds_ref_psize;	/* referenced psize * refcnt	*/
775 	uint64_t	dds_ref_dsize;	/* referenced dsize * refcnt	*/
776 } ddt_stat_t;
777 
778 typedef struct ddt_histogram {
779 	ddt_stat_t	ddh_stat[64];	/* power-of-two histogram buckets */
780 } ddt_histogram_t;
781 
782 #define	ZVOL_DRIVER	"zvol"
783 #define	ZFS_DRIVER	"zfs"
784 #define	ZFS_DEV		"/dev/zfs"
785 #define	ZFS_DISK_ROOT	"/dev/dsk"
786 #define	ZFS_DISK_ROOTD	ZFS_DISK_ROOT "/"
787 #define	ZFS_RDISK_ROOT	"/dev/rdsk"
788 #define	ZFS_RDISK_ROOTD	ZFS_RDISK_ROOT "/"
789 
790 /* general zvol path */
791 #define	ZVOL_DIR		"/dev/zvol"
792 /* expansion */
793 #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zfs@0:"
794 /* for dump and swap */
795 #define	ZVOL_FULL_DEV_DIR	ZVOL_DIR "/dsk/"
796 #define	ZVOL_FULL_RDEV_DIR	ZVOL_DIR "/rdsk/"
797 
798 #define	ZVOL_PROP_NAME		"name"
799 #define	ZVOL_DEFAULT_BLOCKSIZE	8192
800 
801 /*
802  * /dev/zfs ioctl numbers.
803  */
804 typedef enum zfs_ioc {
805 	ZFS_IOC_FIRST =	('Z' << 8),
806 	ZFS_IOC = ZFS_IOC_FIRST,
807 	ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
808 	ZFS_IOC_POOL_DESTROY,
809 	ZFS_IOC_POOL_IMPORT,
810 	ZFS_IOC_POOL_EXPORT,
811 	ZFS_IOC_POOL_CONFIGS,
812 	ZFS_IOC_POOL_STATS,
813 	ZFS_IOC_POOL_TRYIMPORT,
814 	ZFS_IOC_POOL_SCAN,
815 	ZFS_IOC_POOL_FREEZE,
816 	ZFS_IOC_POOL_UPGRADE,
817 	ZFS_IOC_POOL_GET_HISTORY,
818 	ZFS_IOC_VDEV_ADD,
819 	ZFS_IOC_VDEV_REMOVE,
820 	ZFS_IOC_VDEV_SET_STATE,
821 	ZFS_IOC_VDEV_ATTACH,
822 	ZFS_IOC_VDEV_DETACH,
823 	ZFS_IOC_VDEV_SETPATH,
824 	ZFS_IOC_VDEV_SETFRU,
825 	ZFS_IOC_OBJSET_STATS,
826 	ZFS_IOC_OBJSET_ZPLPROPS,
827 	ZFS_IOC_DATASET_LIST_NEXT,
828 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
829 	ZFS_IOC_SET_PROP,
830 	ZFS_IOC_CREATE,
831 	ZFS_IOC_DESTROY,
832 	ZFS_IOC_ROLLBACK,
833 	ZFS_IOC_RENAME,
834 	ZFS_IOC_RECV,
835 	ZFS_IOC_SEND,
836 	ZFS_IOC_INJECT_FAULT,
837 	ZFS_IOC_CLEAR_FAULT,
838 	ZFS_IOC_INJECT_LIST_NEXT,
839 	ZFS_IOC_ERROR_LOG,
840 	ZFS_IOC_CLEAR,
841 	ZFS_IOC_PROMOTE,
842 	ZFS_IOC_SNAPSHOT,
843 	ZFS_IOC_DSOBJ_TO_DSNAME,
844 	ZFS_IOC_OBJ_TO_PATH,
845 	ZFS_IOC_POOL_SET_PROPS,
846 	ZFS_IOC_POOL_GET_PROPS,
847 	ZFS_IOC_SET_FSACL,
848 	ZFS_IOC_GET_FSACL,
849 	ZFS_IOC_SHARE,
850 	ZFS_IOC_INHERIT_PROP,
851 	ZFS_IOC_SMB_ACL,
852 	ZFS_IOC_USERSPACE_ONE,
853 	ZFS_IOC_USERSPACE_MANY,
854 	ZFS_IOC_USERSPACE_UPGRADE,
855 	ZFS_IOC_HOLD,
856 	ZFS_IOC_RELEASE,
857 	ZFS_IOC_GET_HOLDS,
858 	ZFS_IOC_OBJSET_RECVD_PROPS,
859 	ZFS_IOC_VDEV_SPLIT,
860 	ZFS_IOC_NEXT_OBJ,
861 	ZFS_IOC_DIFF,
862 	ZFS_IOC_TMP_SNAPSHOT,
863 	ZFS_IOC_OBJ_TO_STATS,
864 	ZFS_IOC_SPACE_WRITTEN,
865 	ZFS_IOC_SPACE_SNAPS,
866 	ZFS_IOC_DESTROY_SNAPS,
867 	ZFS_IOC_POOL_REGUID,
868 	ZFS_IOC_POOL_REOPEN,
869 	ZFS_IOC_SEND_PROGRESS,
870 	ZFS_IOC_LOG_HISTORY,
871 	ZFS_IOC_SEND_NEW,
872 	ZFS_IOC_SEND_SPACE,
873 	ZFS_IOC_CLONE,
874 	ZFS_IOC_BOOKMARK,
875 	ZFS_IOC_GET_BOOKMARKS,
876 	ZFS_IOC_DESTROY_BOOKMARKS,
877 	ZFS_IOC_LAST
878 } zfs_ioc_t;
879 
880 /*
881  * Internal SPA load state.  Used by FMA diagnosis engine.
882  */
883 typedef enum {
884 	SPA_LOAD_NONE,		/* no load in progress	*/
885 	SPA_LOAD_OPEN,		/* normal open		*/
886 	SPA_LOAD_IMPORT,	/* import in progress	*/
887 	SPA_LOAD_TRYIMPORT,	/* tryimport in progress */
888 	SPA_LOAD_RECOVER,	/* recovery requested	*/
889 	SPA_LOAD_ERROR,		/* load failed		*/
890 	SPA_LOAD_CREATE		/* creation in progress */
891 } spa_load_state_t;
892 
893 /*
894  * Bookmark name values.
895  */
896 #define	ZPOOL_ERR_LIST		"error list"
897 #define	ZPOOL_ERR_DATASET	"dataset"
898 #define	ZPOOL_ERR_OBJECT	"object"
899 
900 #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
901 
902 /*
903  * The following are names used in the nvlist describing
904  * the pool's history log.
905  */
906 #define	ZPOOL_HIST_RECORD	"history record"
907 #define	ZPOOL_HIST_TIME		"history time"
908 #define	ZPOOL_HIST_CMD		"history command"
909 #define	ZPOOL_HIST_WHO		"history who"
910 #define	ZPOOL_HIST_ZONE		"history zone"
911 #define	ZPOOL_HIST_HOST		"history hostname"
912 #define	ZPOOL_HIST_TXG		"history txg"
913 #define	ZPOOL_HIST_INT_EVENT	"history internal event"
914 #define	ZPOOL_HIST_INT_STR	"history internal str"
915 #define	ZPOOL_HIST_INT_NAME	"internal_name"
916 #define	ZPOOL_HIST_IOCTL	"ioctl"
917 #define	ZPOOL_HIST_INPUT_NVL	"in_nvl"
918 #define	ZPOOL_HIST_OUTPUT_NVL	"out_nvl"
919 #define	ZPOOL_HIST_DSNAME	"dsname"
920 #define	ZPOOL_HIST_DSID		"dsid"
921 
922 /*
923  * Flags for ZFS_IOC_VDEV_SET_STATE
924  */
925 #define	ZFS_ONLINE_CHECKREMOVE	0x1
926 #define	ZFS_ONLINE_UNSPARE	0x2
927 #define	ZFS_ONLINE_FORCEFAULT	0x4
928 #define	ZFS_ONLINE_EXPAND	0x8
929 #define	ZFS_OFFLINE_TEMPORARY	0x1
930 
931 /*
932  * Flags for ZFS_IOC_POOL_IMPORT
933  */
934 #define	ZFS_IMPORT_NORMAL	0x0
935 #define	ZFS_IMPORT_VERBATIM	0x1
936 #define	ZFS_IMPORT_ANY_HOST	0x2
937 #define	ZFS_IMPORT_MISSING_LOG	0x4
938 #define	ZFS_IMPORT_ONLY		0x8
939 
940 /*
941  * Sysevent payload members.  ZFS will generate the following sysevents with the
942  * given payloads:
943  *
944  *	ESC_ZFS_RESILVER_START
945  *	ESC_ZFS_RESILVER_END
946  *	ESC_ZFS_POOL_DESTROY
947  *	ESC_ZFS_POOL_REGUID
948  *
949  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
950  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
951  *
952  *	ESC_ZFS_VDEV_REMOVE
953  *	ESC_ZFS_VDEV_CLEAR
954  *	ESC_ZFS_VDEV_CHECK
955  *
956  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
957  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
958  *		ZFS_EV_VDEV_PATH	DATA_TYPE_STRING	(optional)
959  *		ZFS_EV_VDEV_GUID	DATA_TYPE_UINT64
960  *
961  *	ESC_ZFS_HISTORY_EVENT
962  *
963  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
964  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
965  *		ZFS_EV_HIST_TIME	DATA_TYPE_UINT64	(optional)
966  *		ZFS_EV_HIST_CMD		DATA_TYPE_STRING	(optional)
967  *		ZFS_EV_HIST_WHO		DATA_TYPE_UINT64	(optional)
968  *		ZFS_EV_HIST_ZONE	DATA_TYPE_STRING	(optional)
969  *		ZFS_EV_HIST_HOST	DATA_TYPE_STRING	(optional)
970  *		ZFS_EV_HIST_TXG		DATA_TYPE_UINT64	(optional)
971  *		ZFS_EV_HIST_INT_EVENT	DATA_TYPE_UINT64	(optional)
972  *		ZFS_EV_HIST_INT_STR	DATA_TYPE_STRING	(optional)
973  *		ZFS_EV_HIST_INT_NAME	DATA_TYPE_STRING	(optional)
974  *		ZFS_EV_HIST_IOCTL	DATA_TYPE_STRING	(optional)
975  *		ZFS_EV_HIST_DSNAME	DATA_TYPE_STRING	(optional)
976  *		ZFS_EV_HIST_DSID	DATA_TYPE_UINT64	(optional)
977  *
978  * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
979  * history log nvlist.  The keynames will be free of any spaces or other
980  * characters that could be potentially unexpected to consumers of the
981  * sysevents.
982  */
983 #define	ZFS_EV_POOL_NAME	"pool_name"
984 #define	ZFS_EV_POOL_GUID	"pool_guid"
985 #define	ZFS_EV_VDEV_PATH	"vdev_path"
986 #define	ZFS_EV_VDEV_GUID	"vdev_guid"
987 #define	ZFS_EV_HIST_TIME	"history_time"
988 #define	ZFS_EV_HIST_CMD		"history_command"
989 #define	ZFS_EV_HIST_WHO		"history_who"
990 #define	ZFS_EV_HIST_ZONE	"history_zone"
991 #define	ZFS_EV_HIST_HOST	"history_hostname"
992 #define	ZFS_EV_HIST_TXG		"history_txg"
993 #define	ZFS_EV_HIST_INT_EVENT	"history_internal_event"
994 #define	ZFS_EV_HIST_INT_STR	"history_internal_str"
995 #define	ZFS_EV_HIST_INT_NAME	"history_internal_name"
996 #define	ZFS_EV_HIST_IOCTL	"history_ioctl"
997 #define	ZFS_EV_HIST_DSNAME	"history_dsname"
998 #define	ZFS_EV_HIST_DSID	"history_dsid"
999 
1000 #ifdef	__cplusplus
1001 }
1002 #endif
1003 
1004 #endif	/* _SYS_FS_ZFS_H */
1005