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