xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision dfc115332c94a2f62058ac7f2bce7631fbd20b3d)
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, 2016 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  * Length of 'written@' and 'written#'
258  */
259 #define	ZFS_WRITTEN_PROP_PREFIX_LEN	8
260 
261 /*
262  * Dataset property functions shared between libzfs and kernel.
263  */
264 const char *zfs_prop_default_string(zfs_prop_t);
265 uint64_t zfs_prop_default_numeric(zfs_prop_t);
266 boolean_t zfs_prop_readonly(zfs_prop_t);
267 boolean_t zfs_prop_visible(zfs_prop_t prop);
268 boolean_t zfs_prop_inheritable(zfs_prop_t);
269 boolean_t zfs_prop_setonce(zfs_prop_t);
270 const char *zfs_prop_to_name(zfs_prop_t);
271 zfs_prop_t zfs_name_to_prop(const char *);
272 boolean_t zfs_prop_user(const char *);
273 boolean_t zfs_prop_userquota(const char *);
274 boolean_t zfs_prop_written(const char *);
275 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
276 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
277 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
278 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
279 
280 /*
281  * Pool property functions shared between libzfs and kernel.
282  */
283 zpool_prop_t zpool_name_to_prop(const char *);
284 const char *zpool_prop_to_name(zpool_prop_t);
285 const char *zpool_prop_default_string(zpool_prop_t);
286 uint64_t zpool_prop_default_numeric(zpool_prop_t);
287 boolean_t zpool_prop_readonly(zpool_prop_t);
288 boolean_t zpool_prop_feature(const char *);
289 boolean_t zpool_prop_unsupported(const char *name);
290 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
291 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
292 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
293 
294 /*
295  * Definitions for the Delegation.
296  */
297 typedef enum {
298 	ZFS_DELEG_WHO_UNKNOWN = 0,
299 	ZFS_DELEG_USER = 'u',
300 	ZFS_DELEG_USER_SETS = 'U',
301 	ZFS_DELEG_GROUP = 'g',
302 	ZFS_DELEG_GROUP_SETS = 'G',
303 	ZFS_DELEG_EVERYONE = 'e',
304 	ZFS_DELEG_EVERYONE_SETS = 'E',
305 	ZFS_DELEG_CREATE = 'c',
306 	ZFS_DELEG_CREATE_SETS = 'C',
307 	ZFS_DELEG_NAMED_SET = 's',
308 	ZFS_DELEG_NAMED_SET_SETS = 'S'
309 } zfs_deleg_who_type_t;
310 
311 typedef enum {
312 	ZFS_DELEG_NONE = 0,
313 	ZFS_DELEG_PERM_LOCAL = 1,
314 	ZFS_DELEG_PERM_DESCENDENT = 2,
315 	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
316 	ZFS_DELEG_PERM_CREATE = 4
317 } zfs_deleg_inherit_t;
318 
319 #define	ZFS_DELEG_PERM_UID	"uid"
320 #define	ZFS_DELEG_PERM_GID	"gid"
321 #define	ZFS_DELEG_PERM_GROUPS	"groups"
322 
323 #define	ZFS_MLSLABEL_DEFAULT	"none"
324 
325 #define	ZFS_SMB_ACL_SRC		"src"
326 #define	ZFS_SMB_ACL_TARGET	"target"
327 
328 typedef enum {
329 	ZFS_CANMOUNT_OFF = 0,
330 	ZFS_CANMOUNT_ON = 1,
331 	ZFS_CANMOUNT_NOAUTO = 2
332 } zfs_canmount_type_t;
333 
334 typedef enum {
335 	ZFS_LOGBIAS_LATENCY = 0,
336 	ZFS_LOGBIAS_THROUGHPUT = 1
337 } zfs_logbias_op_t;
338 
339 typedef enum zfs_share_op {
340 	ZFS_SHARE_NFS = 0,
341 	ZFS_UNSHARE_NFS = 1,
342 	ZFS_SHARE_SMB = 2,
343 	ZFS_UNSHARE_SMB = 3
344 } zfs_share_op_t;
345 
346 typedef enum zfs_smb_acl_op {
347 	ZFS_SMB_ACL_ADD,
348 	ZFS_SMB_ACL_REMOVE,
349 	ZFS_SMB_ACL_RENAME,
350 	ZFS_SMB_ACL_PURGE
351 } zfs_smb_acl_op_t;
352 
353 typedef enum zfs_cache_type {
354 	ZFS_CACHE_NONE = 0,
355 	ZFS_CACHE_METADATA = 1,
356 	ZFS_CACHE_ALL = 2
357 } zfs_cache_type_t;
358 
359 typedef enum {
360 	ZFS_SYNC_STANDARD = 0,
361 	ZFS_SYNC_ALWAYS = 1,
362 	ZFS_SYNC_DISABLED = 2
363 } zfs_sync_type_t;
364 
365 typedef enum {
366 	ZFS_REDUNDANT_METADATA_ALL,
367 	ZFS_REDUNDANT_METADATA_MOST
368 } zfs_redundant_metadata_type_t;
369 
370 /*
371  * On-disk version number.
372  */
373 #define	SPA_VERSION_1			1ULL
374 #define	SPA_VERSION_2			2ULL
375 #define	SPA_VERSION_3			3ULL
376 #define	SPA_VERSION_4			4ULL
377 #define	SPA_VERSION_5			5ULL
378 #define	SPA_VERSION_6			6ULL
379 #define	SPA_VERSION_7			7ULL
380 #define	SPA_VERSION_8			8ULL
381 #define	SPA_VERSION_9			9ULL
382 #define	SPA_VERSION_10			10ULL
383 #define	SPA_VERSION_11			11ULL
384 #define	SPA_VERSION_12			12ULL
385 #define	SPA_VERSION_13			13ULL
386 #define	SPA_VERSION_14			14ULL
387 #define	SPA_VERSION_15			15ULL
388 #define	SPA_VERSION_16			16ULL
389 #define	SPA_VERSION_17			17ULL
390 #define	SPA_VERSION_18			18ULL
391 #define	SPA_VERSION_19			19ULL
392 #define	SPA_VERSION_20			20ULL
393 #define	SPA_VERSION_21			21ULL
394 #define	SPA_VERSION_22			22ULL
395 #define	SPA_VERSION_23			23ULL
396 #define	SPA_VERSION_24			24ULL
397 #define	SPA_VERSION_25			25ULL
398 #define	SPA_VERSION_26			26ULL
399 #define	SPA_VERSION_27			27ULL
400 #define	SPA_VERSION_28			28ULL
401 #define	SPA_VERSION_5000		5000ULL
402 
403 /*
404  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
405  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
406  * and do the appropriate changes.  Also bump the version number in
407  * usr/src/grub/capability.
408  */
409 #define	SPA_VERSION			SPA_VERSION_5000
410 #define	SPA_VERSION_STRING		"5000"
411 
412 /*
413  * Symbolic names for the changes that caused a SPA_VERSION switch.
414  * Used in the code when checking for presence or absence of a feature.
415  * Feel free to define multiple symbolic names for each version if there
416  * were multiple changes to on-disk structures during that version.
417  *
418  * NOTE: When checking the current SPA_VERSION in your code, be sure
419  *       to use spa_version() since it reports the version of the
420  *       last synced uberblock.  Checking the in-flight version can
421  *       be dangerous in some cases.
422  */
423 #define	SPA_VERSION_INITIAL		SPA_VERSION_1
424 #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
425 #define	SPA_VERSION_SPARES		SPA_VERSION_3
426 #define	SPA_VERSION_RAIDZ2		SPA_VERSION_3
427 #define	SPA_VERSION_BPOBJ_ACCOUNT	SPA_VERSION_3
428 #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
429 #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
430 #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
431 #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
432 #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
433 #define	SPA_VERSION_SLOGS		SPA_VERSION_7
434 #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
435 #define	SPA_VERSION_FUID		SPA_VERSION_9
436 #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
437 #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
438 #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
439 #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
440 #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
441 #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
442 #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
443 #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
444 #define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13
445 #define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14
446 #define	SPA_VERSION_USERSPACE		SPA_VERSION_15
447 #define	SPA_VERSION_STMF_PROP		SPA_VERSION_16
448 #define	SPA_VERSION_RAIDZ3		SPA_VERSION_17
449 #define	SPA_VERSION_USERREFS		SPA_VERSION_18
450 #define	SPA_VERSION_HOLES		SPA_VERSION_19
451 #define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20
452 #define	SPA_VERSION_DEDUP		SPA_VERSION_21
453 #define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22
454 #define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23
455 #define	SPA_VERSION_SA			SPA_VERSION_24
456 #define	SPA_VERSION_SCAN		SPA_VERSION_25
457 #define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26
458 #define	SPA_VERSION_DEADLISTS		SPA_VERSION_26
459 #define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27
460 #define	SPA_VERSION_MULTI_REPLACE	SPA_VERSION_28
461 #define	SPA_VERSION_BEFORE_FEATURES	SPA_VERSION_28
462 #define	SPA_VERSION_FEATURES		SPA_VERSION_5000
463 
464 #define	SPA_VERSION_IS_SUPPORTED(v) \
465 	(((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
466 	((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
467 
468 /*
469  * ZPL version - rev'd whenever an incompatible on-disk format change
470  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
471  * also update the version_table[] and help message in zfs_prop.c.
472  *
473  * When changing, be sure to teach GRUB how to read the new format!
474  * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
475  */
476 #define	ZPL_VERSION_1			1ULL
477 #define	ZPL_VERSION_2			2ULL
478 #define	ZPL_VERSION_3			3ULL
479 #define	ZPL_VERSION_4			4ULL
480 #define	ZPL_VERSION_5			5ULL
481 #define	ZPL_VERSION			ZPL_VERSION_5
482 #define	ZPL_VERSION_STRING		"5"
483 
484 #define	ZPL_VERSION_INITIAL		ZPL_VERSION_1
485 #define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2
486 #define	ZPL_VERSION_FUID		ZPL_VERSION_3
487 #define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3
488 #define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3
489 #define	ZPL_VERSION_USERSPACE		ZPL_VERSION_4
490 #define	ZPL_VERSION_SA			ZPL_VERSION_5
491 
492 /* Rewind request information */
493 #define	ZPOOL_NO_REWIND		1  /* No policy - default behavior */
494 #define	ZPOOL_NEVER_REWIND	2  /* Do not search for best txg or rewind */
495 #define	ZPOOL_TRY_REWIND	4  /* Search for best txg, but do not rewind */
496 #define	ZPOOL_DO_REWIND		8  /* Rewind to best txg w/in deferred frees */
497 #define	ZPOOL_EXTREME_REWIND	16 /* Allow extreme measures to find best txg */
498 #define	ZPOOL_REWIND_MASK	28 /* All the possible rewind bits */
499 #define	ZPOOL_REWIND_POLICIES	31 /* All the possible policy bits */
500 
501 typedef struct zpool_rewind_policy {
502 	uint32_t	zrp_request;	/* rewind behavior requested */
503 	uint64_t	zrp_maxmeta;	/* max acceptable meta-data errors */
504 	uint64_t	zrp_maxdata;	/* max acceptable data errors */
505 	uint64_t	zrp_txg;	/* specific txg to load */
506 } zpool_rewind_policy_t;
507 
508 /*
509  * The following are configuration names used in the nvlist describing a pool's
510  * configuration.
511  */
512 #define	ZPOOL_CONFIG_VERSION		"version"
513 #define	ZPOOL_CONFIG_POOL_NAME		"name"
514 #define	ZPOOL_CONFIG_POOL_STATE		"state"
515 #define	ZPOOL_CONFIG_POOL_TXG		"txg"
516 #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
517 #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
518 #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
519 #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
520 #define	ZPOOL_CONFIG_TYPE		"type"
521 #define	ZPOOL_CONFIG_CHILDREN		"children"
522 #define	ZPOOL_CONFIG_ID			"id"
523 #define	ZPOOL_CONFIG_GUID		"guid"
524 #define	ZPOOL_CONFIG_PATH		"path"
525 #define	ZPOOL_CONFIG_DEVID		"devid"
526 #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
527 #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
528 #define	ZPOOL_CONFIG_ASHIFT		"ashift"
529 #define	ZPOOL_CONFIG_ASIZE		"asize"
530 #define	ZPOOL_CONFIG_DTL		"DTL"
531 #define	ZPOOL_CONFIG_SCAN_STATS		"scan_stats"	/* not stored on disk */
532 #define	ZPOOL_CONFIG_VDEV_STATS		"vdev_stats"	/* not stored on disk */
533 #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
534 #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
535 #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
536 #define	ZPOOL_CONFIG_SPARES		"spares"
537 #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
538 #define	ZPOOL_CONFIG_NPARITY		"nparity"
539 #define	ZPOOL_CONFIG_HOSTID		"hostid"
540 #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
541 #define	ZPOOL_CONFIG_LOADED_TIME	"initial_load_time"
542 #define	ZPOOL_CONFIG_UNSPARE		"unspare"
543 #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
544 #define	ZPOOL_CONFIG_IS_LOG		"is_log"
545 #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
546 #define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"
547 #define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"
548 #define	ZPOOL_CONFIG_IS_HOLE		"is_hole"
549 #define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"
550 #define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"
551 #define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"
552 #define	ZPOOL_CONFIG_SPLIT		"splitcfg"
553 #define	ZPOOL_CONFIG_ORIG_GUID		"orig_guid"
554 #define	ZPOOL_CONFIG_SPLIT_GUID		"split_guid"
555 #define	ZPOOL_CONFIG_SPLIT_LIST		"guid_list"
556 #define	ZPOOL_CONFIG_REMOVING		"removing"
557 #define	ZPOOL_CONFIG_RESILVER_TXG	"resilver_txg"
558 #define	ZPOOL_CONFIG_COMMENT		"comment"
559 #define	ZPOOL_CONFIG_SUSPENDED		"suspended"	/* not stored on disk */
560 #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp"	/* not stored on disk */
561 #define	ZPOOL_CONFIG_BOOTFS		"bootfs"	/* not stored on disk */
562 #define	ZPOOL_CONFIG_MISSING_DEVICES	"missing_vdevs"	/* not stored on disk */
563 #define	ZPOOL_CONFIG_LOAD_INFO		"load_info"	/* not stored on disk */
564 #define	ZPOOL_CONFIG_REWIND_INFO	"rewind_info"	/* not stored on disk */
565 #define	ZPOOL_CONFIG_UNSUP_FEAT		"unsup_feat"	/* not stored on disk */
566 #define	ZPOOL_CONFIG_ENABLED_FEAT	"enabled_feat"	/* not stored on disk */
567 #define	ZPOOL_CONFIG_CAN_RDONLY		"can_rdonly"	/* not stored on disk */
568 #define	ZPOOL_CONFIG_FEATURES_FOR_READ	"features_for_read"
569 #define	ZPOOL_CONFIG_FEATURE_STATS	"feature_stats"	/* not stored on disk */
570 #define	ZPOOL_CONFIG_VDEV_TOP_ZAP	"com.delphix:vdev_zap_top"
571 #define	ZPOOL_CONFIG_VDEV_LEAF_ZAP	"com.delphix:vdev_zap_leaf"
572 #define	ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS	"com.delphix:has_per_vdev_zaps"
573 /*
574  * The persistent vdev state is stored as separate values rather than a single
575  * 'vdev_state' entry.  This is because a device can be in multiple states, such
576  * as offline and degraded.
577  */
578 #define	ZPOOL_CONFIG_OFFLINE		"offline"
579 #define	ZPOOL_CONFIG_FAULTED		"faulted"
580 #define	ZPOOL_CONFIG_DEGRADED		"degraded"
581 #define	ZPOOL_CONFIG_REMOVED		"removed"
582 #define	ZPOOL_CONFIG_FRU		"fru"
583 #define	ZPOOL_CONFIG_AUX_STATE		"aux_state"
584 
585 /* Rewind policy parameters */
586 #define	ZPOOL_REWIND_POLICY		"rewind-policy"
587 #define	ZPOOL_REWIND_REQUEST		"rewind-request"
588 #define	ZPOOL_REWIND_REQUEST_TXG	"rewind-request-txg"
589 #define	ZPOOL_REWIND_META_THRESH	"rewind-meta-thresh"
590 #define	ZPOOL_REWIND_DATA_THRESH	"rewind-data-thresh"
591 
592 /* Rewind data discovered */
593 #define	ZPOOL_CONFIG_LOAD_TIME		"rewind_txg_ts"
594 #define	ZPOOL_CONFIG_LOAD_DATA_ERRORS	"verify_data_errors"
595 #define	ZPOOL_CONFIG_REWIND_TIME	"seconds_of_rewind"
596 
597 #define	VDEV_TYPE_ROOT			"root"
598 #define	VDEV_TYPE_MIRROR		"mirror"
599 #define	VDEV_TYPE_REPLACING		"replacing"
600 #define	VDEV_TYPE_RAIDZ			"raidz"
601 #define	VDEV_TYPE_DISK			"disk"
602 #define	VDEV_TYPE_FILE			"file"
603 #define	VDEV_TYPE_MISSING		"missing"
604 #define	VDEV_TYPE_HOLE			"hole"
605 #define	VDEV_TYPE_SPARE			"spare"
606 #define	VDEV_TYPE_LOG			"log"
607 #define	VDEV_TYPE_L2CACHE		"l2cache"
608 
609 /*
610  * This is needed in userland to report the minimum necessary device size.
611  *
612  * Note that the zfs test suite uses 64MB vdevs.
613  */
614 #define	SPA_MINDEVSIZE		(64ULL << 20)
615 
616 /*
617  * Set if the fragmentation has not yet been calculated. This can happen
618  * because the space maps have not been upgraded or the histogram feature
619  * is not enabled.
620  */
621 #define	ZFS_FRAG_INVALID	UINT64_MAX
622 
623 /*
624  * The location of the pool configuration repository, shared between kernel and
625  * userland.
626  */
627 #define	ZPOOL_CACHE		"/etc/zfs/zpool.cache"
628 
629 /*
630  * vdev states are ordered from least to most healthy.
631  * A vdev that's CANT_OPEN or below is considered unusable.
632  */
633 typedef enum vdev_state {
634 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
635 	VDEV_STATE_CLOSED,	/* Not currently open			*/
636 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
637 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
638 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
639 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
640 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
641 	VDEV_STATE_HEALTHY	/* Presumed good			*/
642 } vdev_state_t;
643 
644 #define	VDEV_STATE_ONLINE	VDEV_STATE_HEALTHY
645 
646 /*
647  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
648  * of the vdev stats structure uses these constants to distinguish why.
649  */
650 typedef enum vdev_aux {
651 	VDEV_AUX_NONE,		/* no error				*/
652 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
653 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
654 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
655 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
656 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
657 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
658 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
659 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
660 	VDEV_AUX_UNSUP_FEAT,	/* unsupported features			*/
661 	VDEV_AUX_SPARED,	/* hot spare used in another pool	*/
662 	VDEV_AUX_ERR_EXCEEDED,	/* too many errors			*/
663 	VDEV_AUX_IO_FAILURE,	/* experienced I/O failure		*/
664 	VDEV_AUX_BAD_LOG,	/* cannot read log chain(s)		*/
665 	VDEV_AUX_EXTERNAL,	/* external diagnosis			*/
666 	VDEV_AUX_SPLIT_POOL	/* vdev was split off into another pool	*/
667 } vdev_aux_t;
668 
669 /*
670  * pool state.  The following states are written to disk as part of the normal
671  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
672  * states are software abstractions used at various levels to communicate
673  * pool state.
674  */
675 typedef enum pool_state {
676 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
677 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
678 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
679 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
680 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
681 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
682 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
683 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
684 } pool_state_t;
685 
686 /*
687  * Scan Functions.
688  */
689 typedef enum pool_scan_func {
690 	POOL_SCAN_NONE,
691 	POOL_SCAN_SCRUB,
692 	POOL_SCAN_RESILVER,
693 	POOL_SCAN_FUNCS
694 } pool_scan_func_t;
695 
696 /*
697  * ZIO types.  Needed to interpret vdev statistics below.
698  */
699 typedef enum zio_type {
700 	ZIO_TYPE_NULL = 0,
701 	ZIO_TYPE_READ,
702 	ZIO_TYPE_WRITE,
703 	ZIO_TYPE_FREE,
704 	ZIO_TYPE_CLAIM,
705 	ZIO_TYPE_IOCTL,
706 	ZIO_TYPES
707 } zio_type_t;
708 
709 /*
710  * Pool statistics.  Note: all fields should be 64-bit because this
711  * is passed between kernel and userland as an nvlist uint64 array.
712  */
713 typedef struct pool_scan_stat {
714 	/* values stored on disk */
715 	uint64_t	pss_func;	/* pool_scan_func_t */
716 	uint64_t	pss_state;	/* dsl_scan_state_t */
717 	uint64_t	pss_start_time;	/* scan start time */
718 	uint64_t	pss_end_time;	/* scan end time */
719 	uint64_t	pss_to_examine;	/* total bytes to scan */
720 	uint64_t	pss_examined;	/* total examined bytes	*/
721 	uint64_t	pss_to_process; /* total bytes to process */
722 	uint64_t	pss_processed;	/* total processed bytes */
723 	uint64_t	pss_errors;	/* scan errors	*/
724 
725 	/* values not stored on disk */
726 	uint64_t	pss_pass_exam;	/* examined bytes per scan pass */
727 	uint64_t	pss_pass_start;	/* start time of a scan pass */
728 } pool_scan_stat_t;
729 
730 typedef enum dsl_scan_state {
731 	DSS_NONE,
732 	DSS_SCANNING,
733 	DSS_FINISHED,
734 	DSS_CANCELED,
735 	DSS_NUM_STATES
736 } dsl_scan_state_t;
737 
738 
739 /*
740  * Vdev statistics.  Note: all fields should be 64-bit because this
741  * is passed between kernel and userland as an nvlist uint64 array.
742  */
743 typedef struct vdev_stat {
744 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
745 	uint64_t	vs_state;		/* vdev state		*/
746 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
747 	uint64_t	vs_alloc;		/* space allocated	*/
748 	uint64_t	vs_space;		/* total capacity	*/
749 	uint64_t	vs_dspace;		/* deflated capacity	*/
750 	uint64_t	vs_rsize;		/* replaceable dev size */
751 	uint64_t	vs_esize;		/* expandable dev size */
752 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
753 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
754 	uint64_t	vs_read_errors;		/* read errors		*/
755 	uint64_t	vs_write_errors;	/* write errors		*/
756 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
757 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
758 	uint64_t	vs_scan_removing;	/* removing?	*/
759 	uint64_t	vs_scan_processed;	/* scan processed bytes	*/
760 	uint64_t	vs_fragmentation;	/* device fragmentation */
761 } vdev_stat_t;
762 
763 /*
764  * DDT statistics.  Note: all fields should be 64-bit because this
765  * is passed between kernel and userland as an nvlist uint64 array.
766  */
767 typedef struct ddt_object {
768 	uint64_t	ddo_count;	/* number of elments in ddt 	*/
769 	uint64_t	ddo_dspace;	/* size of ddt on disk		*/
770 	uint64_t	ddo_mspace;	/* size of ddt in-core		*/
771 } ddt_object_t;
772 
773 typedef struct ddt_stat {
774 	uint64_t	dds_blocks;	/* blocks			*/
775 	uint64_t	dds_lsize;	/* logical size			*/
776 	uint64_t	dds_psize;	/* physical size		*/
777 	uint64_t	dds_dsize;	/* deflated allocated size	*/
778 	uint64_t	dds_ref_blocks;	/* referenced blocks		*/
779 	uint64_t	dds_ref_lsize;	/* referenced lsize * refcnt	*/
780 	uint64_t	dds_ref_psize;	/* referenced psize * refcnt	*/
781 	uint64_t	dds_ref_dsize;	/* referenced dsize * refcnt	*/
782 } ddt_stat_t;
783 
784 typedef struct ddt_histogram {
785 	ddt_stat_t	ddh_stat[64];	/* power-of-two histogram buckets */
786 } ddt_histogram_t;
787 
788 #define	ZVOL_DRIVER	"zvol"
789 #define	ZFS_DRIVER	"zfs"
790 #define	ZFS_DEV		"/dev/zfs"
791 #define	ZFS_DISK_ROOT	"/dev/dsk"
792 #define	ZFS_DISK_ROOTD	ZFS_DISK_ROOT "/"
793 #define	ZFS_RDISK_ROOT	"/dev/rdsk"
794 #define	ZFS_RDISK_ROOTD	ZFS_RDISK_ROOT "/"
795 
796 /* general zvol path */
797 #define	ZVOL_DIR		"/dev/zvol"
798 /* expansion */
799 #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zfs@0:"
800 /* for dump and swap */
801 #define	ZVOL_FULL_DEV_DIR	ZVOL_DIR "/dsk/"
802 #define	ZVOL_FULL_RDEV_DIR	ZVOL_DIR "/rdsk/"
803 
804 #define	ZVOL_PROP_NAME		"name"
805 #define	ZVOL_DEFAULT_BLOCKSIZE	8192
806 
807 /*
808  * /dev/zfs ioctl numbers.
809  */
810 typedef enum zfs_ioc {
811 	ZFS_IOC_FIRST =	('Z' << 8),
812 	ZFS_IOC = ZFS_IOC_FIRST,
813 	ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
814 	ZFS_IOC_POOL_DESTROY,
815 	ZFS_IOC_POOL_IMPORT,
816 	ZFS_IOC_POOL_EXPORT,
817 	ZFS_IOC_POOL_CONFIGS,
818 	ZFS_IOC_POOL_STATS,
819 	ZFS_IOC_POOL_TRYIMPORT,
820 	ZFS_IOC_POOL_SCAN,
821 	ZFS_IOC_POOL_FREEZE,
822 	ZFS_IOC_POOL_UPGRADE,
823 	ZFS_IOC_POOL_GET_HISTORY,
824 	ZFS_IOC_VDEV_ADD,
825 	ZFS_IOC_VDEV_REMOVE,
826 	ZFS_IOC_VDEV_SET_STATE,
827 	ZFS_IOC_VDEV_ATTACH,
828 	ZFS_IOC_VDEV_DETACH,
829 	ZFS_IOC_VDEV_SETPATH,
830 	ZFS_IOC_VDEV_SETFRU,
831 	ZFS_IOC_OBJSET_STATS,
832 	ZFS_IOC_OBJSET_ZPLPROPS,
833 	ZFS_IOC_DATASET_LIST_NEXT,
834 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
835 	ZFS_IOC_SET_PROP,
836 	ZFS_IOC_CREATE,
837 	ZFS_IOC_DESTROY,
838 	ZFS_IOC_ROLLBACK,
839 	ZFS_IOC_RENAME,
840 	ZFS_IOC_RECV,
841 	ZFS_IOC_SEND,
842 	ZFS_IOC_INJECT_FAULT,
843 	ZFS_IOC_CLEAR_FAULT,
844 	ZFS_IOC_INJECT_LIST_NEXT,
845 	ZFS_IOC_ERROR_LOG,
846 	ZFS_IOC_CLEAR,
847 	ZFS_IOC_PROMOTE,
848 	ZFS_IOC_SNAPSHOT,
849 	ZFS_IOC_DSOBJ_TO_DSNAME,
850 	ZFS_IOC_OBJ_TO_PATH,
851 	ZFS_IOC_POOL_SET_PROPS,
852 	ZFS_IOC_POOL_GET_PROPS,
853 	ZFS_IOC_SET_FSACL,
854 	ZFS_IOC_GET_FSACL,
855 	ZFS_IOC_SHARE,
856 	ZFS_IOC_INHERIT_PROP,
857 	ZFS_IOC_SMB_ACL,
858 	ZFS_IOC_USERSPACE_ONE,
859 	ZFS_IOC_USERSPACE_MANY,
860 	ZFS_IOC_USERSPACE_UPGRADE,
861 	ZFS_IOC_HOLD,
862 	ZFS_IOC_RELEASE,
863 	ZFS_IOC_GET_HOLDS,
864 	ZFS_IOC_OBJSET_RECVD_PROPS,
865 	ZFS_IOC_VDEV_SPLIT,
866 	ZFS_IOC_NEXT_OBJ,
867 	ZFS_IOC_DIFF,
868 	ZFS_IOC_TMP_SNAPSHOT,
869 	ZFS_IOC_OBJ_TO_STATS,
870 	ZFS_IOC_SPACE_WRITTEN,
871 	ZFS_IOC_SPACE_SNAPS,
872 	ZFS_IOC_DESTROY_SNAPS,
873 	ZFS_IOC_POOL_REGUID,
874 	ZFS_IOC_POOL_REOPEN,
875 	ZFS_IOC_SEND_PROGRESS,
876 	ZFS_IOC_LOG_HISTORY,
877 	ZFS_IOC_SEND_NEW,
878 	ZFS_IOC_SEND_SPACE,
879 	ZFS_IOC_CLONE,
880 	ZFS_IOC_BOOKMARK,
881 	ZFS_IOC_GET_BOOKMARKS,
882 	ZFS_IOC_DESTROY_BOOKMARKS,
883 	ZFS_IOC_CHANNEL_PROGRAM,
884 	ZFS_IOC_LAST
885 } zfs_ioc_t;
886 
887 /*
888  * Internal SPA load state.  Used by FMA diagnosis engine.
889  */
890 typedef enum {
891 	SPA_LOAD_NONE,		/* no load in progress	*/
892 	SPA_LOAD_OPEN,		/* normal open		*/
893 	SPA_LOAD_IMPORT,	/* import in progress	*/
894 	SPA_LOAD_TRYIMPORT,	/* tryimport in progress */
895 	SPA_LOAD_RECOVER,	/* recovery requested	*/
896 	SPA_LOAD_ERROR,		/* load failed		*/
897 	SPA_LOAD_CREATE		/* creation in progress */
898 } spa_load_state_t;
899 
900 /*
901  * Bookmark name values.
902  */
903 #define	ZPOOL_ERR_LIST		"error list"
904 #define	ZPOOL_ERR_DATASET	"dataset"
905 #define	ZPOOL_ERR_OBJECT	"object"
906 
907 #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
908 
909 /*
910  * The following are names used in the nvlist describing
911  * the pool's history log.
912  */
913 #define	ZPOOL_HIST_RECORD	"history record"
914 #define	ZPOOL_HIST_TIME		"history time"
915 #define	ZPOOL_HIST_CMD		"history command"
916 #define	ZPOOL_HIST_WHO		"history who"
917 #define	ZPOOL_HIST_ZONE		"history zone"
918 #define	ZPOOL_HIST_HOST		"history hostname"
919 #define	ZPOOL_HIST_TXG		"history txg"
920 #define	ZPOOL_HIST_INT_EVENT	"history internal event"
921 #define	ZPOOL_HIST_INT_STR	"history internal str"
922 #define	ZPOOL_HIST_INT_NAME	"internal_name"
923 #define	ZPOOL_HIST_IOCTL	"ioctl"
924 #define	ZPOOL_HIST_INPUT_NVL	"in_nvl"
925 #define	ZPOOL_HIST_OUTPUT_NVL	"out_nvl"
926 #define	ZPOOL_HIST_DSNAME	"dsname"
927 #define	ZPOOL_HIST_DSID		"dsid"
928 #define	ZPOOL_HIST_ERRNO	"errno"
929 
930 /*
931  * Flags for ZFS_IOC_VDEV_SET_STATE
932  */
933 #define	ZFS_ONLINE_CHECKREMOVE	0x1
934 #define	ZFS_ONLINE_UNSPARE	0x2
935 #define	ZFS_ONLINE_FORCEFAULT	0x4
936 #define	ZFS_ONLINE_EXPAND	0x8
937 #define	ZFS_OFFLINE_TEMPORARY	0x1
938 
939 /*
940  * Flags for ZFS_IOC_POOL_IMPORT
941  */
942 #define	ZFS_IMPORT_NORMAL	0x0
943 #define	ZFS_IMPORT_VERBATIM	0x1
944 #define	ZFS_IMPORT_ANY_HOST	0x2
945 #define	ZFS_IMPORT_MISSING_LOG	0x4
946 #define	ZFS_IMPORT_ONLY		0x8
947 
948 /*
949  * Channel program argument/return nvlist keys and defaults.
950  */
951 #define	ZCP_ARG_PROGRAM		"program"
952 #define	ZCP_ARG_ARGLIST		"arg"
953 #define	ZCP_ARG_INSTRLIMIT	"instrlimit"
954 #define	ZCP_ARG_MEMLIMIT	"memlimit"
955 
956 #define	ZCP_ARG_CLIARGV		"argv"
957 
958 #define	ZCP_RET_ERROR		"error"
959 #define	ZCP_RET_RETURN		"return"
960 
961 #define	ZCP_DEFAULT_INSTRLIMIT	(10 * 1000 * 1000)
962 #define	ZCP_MAX_INSTRLIMIT	(10 * ZCP_DEFAULT_INSTRLIMIT)
963 #define	ZCP_DEFAULT_MEMLIMIT	(10 * 1024 * 1024)
964 #define	ZCP_MAX_MEMLIMIT	(10 * ZCP_DEFAULT_MEMLIMIT)
965 
966 /*
967  * Sysevent payload members.  ZFS will generate the following sysevents with the
968  * given payloads:
969  *
970  *	ESC_ZFS_RESILVER_START
971  *	ESC_ZFS_RESILVER_END
972  *	ESC_ZFS_POOL_DESTROY
973  *	ESC_ZFS_POOL_REGUID
974  *
975  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
976  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
977  *
978  *	ESC_ZFS_VDEV_REMOVE
979  *	ESC_ZFS_VDEV_CLEAR
980  *	ESC_ZFS_VDEV_CHECK
981  *
982  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
983  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
984  *		ZFS_EV_VDEV_PATH	DATA_TYPE_STRING	(optional)
985  *		ZFS_EV_VDEV_GUID	DATA_TYPE_UINT64
986  *
987  *	ESC_ZFS_HISTORY_EVENT
988  *
989  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
990  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
991  *		ZFS_EV_HIST_TIME	DATA_TYPE_UINT64	(optional)
992  *		ZFS_EV_HIST_CMD		DATA_TYPE_STRING	(optional)
993  *		ZFS_EV_HIST_WHO		DATA_TYPE_UINT64	(optional)
994  *		ZFS_EV_HIST_ZONE	DATA_TYPE_STRING	(optional)
995  *		ZFS_EV_HIST_HOST	DATA_TYPE_STRING	(optional)
996  *		ZFS_EV_HIST_TXG		DATA_TYPE_UINT64	(optional)
997  *		ZFS_EV_HIST_INT_EVENT	DATA_TYPE_UINT64	(optional)
998  *		ZFS_EV_HIST_INT_STR	DATA_TYPE_STRING	(optional)
999  *		ZFS_EV_HIST_INT_NAME	DATA_TYPE_STRING	(optional)
1000  *		ZFS_EV_HIST_IOCTL	DATA_TYPE_STRING	(optional)
1001  *		ZFS_EV_HIST_DSNAME	DATA_TYPE_STRING	(optional)
1002  *		ZFS_EV_HIST_DSID	DATA_TYPE_UINT64	(optional)
1003  *
1004  * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1005  * history log nvlist.  The keynames will be free of any spaces or other
1006  * characters that could be potentially unexpected to consumers of the
1007  * sysevents.
1008  */
1009 #define	ZFS_EV_POOL_NAME	"pool_name"
1010 #define	ZFS_EV_POOL_GUID	"pool_guid"
1011 #define	ZFS_EV_VDEV_PATH	"vdev_path"
1012 #define	ZFS_EV_VDEV_GUID	"vdev_guid"
1013 #define	ZFS_EV_HIST_TIME	"history_time"
1014 #define	ZFS_EV_HIST_CMD		"history_command"
1015 #define	ZFS_EV_HIST_WHO		"history_who"
1016 #define	ZFS_EV_HIST_ZONE	"history_zone"
1017 #define	ZFS_EV_HIST_HOST	"history_hostname"
1018 #define	ZFS_EV_HIST_TXG		"history_txg"
1019 #define	ZFS_EV_HIST_INT_EVENT	"history_internal_event"
1020 #define	ZFS_EV_HIST_INT_STR	"history_internal_str"
1021 #define	ZFS_EV_HIST_INT_NAME	"history_internal_name"
1022 #define	ZFS_EV_HIST_IOCTL	"history_ioctl"
1023 #define	ZFS_EV_HIST_DSNAME	"history_dsname"
1024 #define	ZFS_EV_HIST_DSID	"history_dsid"
1025 
1026 #ifdef	__cplusplus
1027 }
1028 #endif
1029 
1030 #endif	/* _SYS_FS_ZFS_H */
1031