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