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