xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision 19b94df933188a15d4f0d6c568f0bab3f127892e)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5441d80aaSlling  * Common Development and Distribution License (the "License").
6441d80aaSlling  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21f94275ceSAdam Leventhal 
22fa9e4066Sahrens /*
2327dd1e87SMark Shellenbaum  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24187d6ac0SMatt Ahrens  * Copyright (c) 2011 by Delphix. All rights reserved.
25e9103aaeSGarrett D'Amore  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
26fa9e4066Sahrens  */
27fa9e4066Sahrens 
2855da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */
2955da60b9SMark J Musante 
30fa9e4066Sahrens #ifndef	_SYS_FS_ZFS_H
31fa9e4066Sahrens #define	_SYS_FS_ZFS_H
32fa9e4066Sahrens 
33842727c2SChris Kirby #include <sys/time.h>
34842727c2SChris Kirby 
35fa9e4066Sahrens #ifdef	__cplusplus
36fa9e4066Sahrens extern "C" {
37fa9e4066Sahrens #endif
38fa9e4066Sahrens 
39fa9e4066Sahrens /*
40fa9e4066Sahrens  * Types and constants shared between userland and the kernel.
41fa9e4066Sahrens  */
42fa9e4066Sahrens 
43fa9e4066Sahrens /*
44fa9e4066Sahrens  * Each dataset can be one of the following types.  These constants can be
45fa9e4066Sahrens  * combined into masks that can be passed to various functions.
46fa9e4066Sahrens  */
47fa9e4066Sahrens typedef enum {
48fa9e4066Sahrens 	ZFS_TYPE_FILESYSTEM	= 0x1,
49fa9e4066Sahrens 	ZFS_TYPE_SNAPSHOT	= 0x2,
50b1b8ab34Slling 	ZFS_TYPE_VOLUME		= 0x4,
51b1b8ab34Slling 	ZFS_TYPE_POOL		= 0x8
52fa9e4066Sahrens } zfs_type_t;
53fa9e4066Sahrens 
54990b4856Slling #define	ZFS_TYPE_DATASET	\
55fa9e4066Sahrens 	(ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
56fa9e4066Sahrens 
57478ed9adSEric Taylor #define	ZAP_MAXNAMELEN 256
58478ed9adSEric Taylor #define	ZAP_MAXVALUELEN (1024 * 8)
59478ed9adSEric Taylor #define	ZAP_OLDMAXVALUELEN 1024
60478ed9adSEric Taylor 
61fa9e4066Sahrens /*
62990b4856Slling  * Dataset properties are identified by these constants and must be added to
63990b4856Slling  * the end of this list to ensure that external consumers are not affected
64990b4856Slling  * by the change. If you make any changes to this list, be sure to update
6566e2aaccSgw  * the property table in usr/src/common/zfs/zfs_prop.c.
66fa9e4066Sahrens  */
67fa9e4066Sahrens typedef enum {
68fa9e4066Sahrens 	ZFS_PROP_TYPE,
69fa9e4066Sahrens 	ZFS_PROP_CREATION,
70fa9e4066Sahrens 	ZFS_PROP_USED,
71fa9e4066Sahrens 	ZFS_PROP_AVAILABLE,
72fa9e4066Sahrens 	ZFS_PROP_REFERENCED,
73fa9e4066Sahrens 	ZFS_PROP_COMPRESSRATIO,
74fa9e4066Sahrens 	ZFS_PROP_MOUNTED,
75fa9e4066Sahrens 	ZFS_PROP_ORIGIN,
76fa9e4066Sahrens 	ZFS_PROP_QUOTA,
77fa9e4066Sahrens 	ZFS_PROP_RESERVATION,
78fa9e4066Sahrens 	ZFS_PROP_VOLSIZE,
79fa9e4066Sahrens 	ZFS_PROP_VOLBLOCKSIZE,
80fa9e4066Sahrens 	ZFS_PROP_RECORDSIZE,
81fa9e4066Sahrens 	ZFS_PROP_MOUNTPOINT,
82fa9e4066Sahrens 	ZFS_PROP_SHARENFS,
83fa9e4066Sahrens 	ZFS_PROP_CHECKSUM,
84fa9e4066Sahrens 	ZFS_PROP_COMPRESSION,
85fa9e4066Sahrens 	ZFS_PROP_ATIME,
86fa9e4066Sahrens 	ZFS_PROP_DEVICES,
87fa9e4066Sahrens 	ZFS_PROP_EXEC,
88fa9e4066Sahrens 	ZFS_PROP_SETUID,
89fa9e4066Sahrens 	ZFS_PROP_READONLY,
90fa9e4066Sahrens 	ZFS_PROP_ZONED,
91fa9e4066Sahrens 	ZFS_PROP_SNAPDIR,
92a3c49ce1SAlbert Lee 	ZFS_PROP_ACLMODE,
93fa9e4066Sahrens 	ZFS_PROP_ACLINHERIT,
9466e2aaccSgw 	ZFS_PROP_CREATETXG,		/* not exposed to the user */
9566e2aaccSgw 	ZFS_PROP_NAME,			/* not exposed to the user */
96e9dbad6fSeschrock 	ZFS_PROP_CANMOUNT,
9766e2aaccSgw 	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */
987b55fa8eSck 	ZFS_PROP_XATTR,
99d0ad202dSahrens 	ZFS_PROP_NUMCLONES,		/* not exposed to the user */
100b1b8ab34Slling 	ZFS_PROP_COPIES,
101e7437265Sahrens 	ZFS_PROP_VERSION,
102da6c28aaSamw 	ZFS_PROP_UTF8ONLY,
103da6c28aaSamw 	ZFS_PROP_NORMALIZE,
104da6c28aaSamw 	ZFS_PROP_CASE,
105da6c28aaSamw 	ZFS_PROP_VSCAN,
106da6c28aaSamw 	ZFS_PROP_NBMAND,
107da6c28aaSamw 	ZFS_PROP_SHARESMB,
108a9799022Sck 	ZFS_PROP_REFQUOTA,
109a9799022Sck 	ZFS_PROP_REFRESERVATION,
110c5904d13Seschrock 	ZFS_PROP_GUID,
1113baa08fcSek 	ZFS_PROP_PRIMARYCACHE,
1123baa08fcSek 	ZFS_PROP_SECONDARYCACHE,
11374e7dc98SMatthew Ahrens 	ZFS_PROP_USEDSNAP,
11474e7dc98SMatthew Ahrens 	ZFS_PROP_USEDDS,
11574e7dc98SMatthew Ahrens 	ZFS_PROP_USEDCHILD,
11674e7dc98SMatthew Ahrens 	ZFS_PROP_USEDREFRESERV,
11714843421SMatthew Ahrens 	ZFS_PROP_USERACCOUNTING,	/* not exposed to the user */
118478ed9adSEric Taylor 	ZFS_PROP_STMF_SHAREINFO,	/* not exposed to the user */
119842727c2SChris Kirby 	ZFS_PROP_DEFER_DESTROY,
120842727c2SChris Kirby 	ZFS_PROP_USERREFS,
121e09fa4daSNeil Perrin 	ZFS_PROP_LOGBIAS,
1221d713200SEric Schrock 	ZFS_PROP_UNIQUE,		/* not exposed to the user */
1231d713200SEric Schrock 	ZFS_PROP_OBJSETID,		/* not exposed to the user */
124b24ab676SJeff Bonwick 	ZFS_PROP_DEDUP,
1254201a95eSRic Aleshire 	ZFS_PROP_MLSLABEL,
12655da60b9SMark J Musante 	ZFS_PROP_SYNC,
127187d6ac0SMatt Ahrens 	ZFS_PROP_REFRATIO,
128*19b94df9SMatthew Ahrens 	ZFS_PROP_WRITTEN,
129*19b94df9SMatthew Ahrens 	ZFS_PROP_CLONES,
13091ebeef5Sahrens 	ZFS_NUM_PROPS
131fa9e4066Sahrens } zfs_prop_t;
132fa9e4066Sahrens 
13314843421SMatthew Ahrens typedef enum {
13414843421SMatthew Ahrens 	ZFS_PROP_USERUSED,
13514843421SMatthew Ahrens 	ZFS_PROP_USERQUOTA,
13614843421SMatthew Ahrens 	ZFS_PROP_GROUPUSED,
13714843421SMatthew Ahrens 	ZFS_PROP_GROUPQUOTA,
13814843421SMatthew Ahrens 	ZFS_NUM_USERQUOTA_PROPS
13914843421SMatthew Ahrens } zfs_userquota_prop_t;
14014843421SMatthew Ahrens 
14114843421SMatthew Ahrens extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
14214843421SMatthew Ahrens 
143990b4856Slling /*
144990b4856Slling  * Pool properties are identified by these constants and must be added to the
145b87f3af3Sperrin  * end of this list to ensure that external consumers are not affected
146990b4856Slling  * by the change. If you make any changes to this list, be sure to update
147990b4856Slling  * the property table in usr/src/common/zfs/zpool_prop.c.
148990b4856Slling  */
149990b4856Slling typedef enum {
150990b4856Slling 	ZPOOL_PROP_NAME,
151990b4856Slling 	ZPOOL_PROP_SIZE,
152990b4856Slling 	ZPOOL_PROP_CAPACITY,
153990b4856Slling 	ZPOOL_PROP_ALTROOT,
154990b4856Slling 	ZPOOL_PROP_HEALTH,
155990b4856Slling 	ZPOOL_PROP_GUID,
156990b4856Slling 	ZPOOL_PROP_VERSION,
157990b4856Slling 	ZPOOL_PROP_BOOTFS,
158990b4856Slling 	ZPOOL_PROP_DELEGATION,
159990b4856Slling 	ZPOOL_PROP_AUTOREPLACE,
1602f8aaab3Seschrock 	ZPOOL_PROP_CACHEFILE,
1610a4e9518Sgw 	ZPOOL_PROP_FAILUREMODE,
162d5b5bb25SRich Morris 	ZPOOL_PROP_LISTSNAPS,
163573ca77eSGeorge Wilson 	ZPOOL_PROP_AUTOEXPAND,
164b24ab676SJeff Bonwick 	ZPOOL_PROP_DEDUPDITTO,
165b24ab676SJeff Bonwick 	ZPOOL_PROP_DEDUPRATIO,
166485bbbf5SGeorge Wilson 	ZPOOL_PROP_FREE,
167485bbbf5SGeorge Wilson 	ZPOOL_PROP_ALLOCATED,
168f9af39baSGeorge Wilson 	ZPOOL_PROP_READONLY,
169990b4856Slling 	ZPOOL_NUM_PROPS
170990b4856Slling } zpool_prop_t;
171b1b8ab34Slling 
172990b4856Slling #define	ZPROP_CONT		-2
173990b4856Slling #define	ZPROP_INVAL		-1
1743d7072f8Seschrock 
175990b4856Slling #define	ZPROP_VALUE		"value"
176990b4856Slling #define	ZPROP_SOURCE		"source"
1777f7322feSeschrock 
178b1b8ab34Slling typedef enum {
179990b4856Slling 	ZPROP_SRC_NONE = 0x1,
180990b4856Slling 	ZPROP_SRC_DEFAULT = 0x2,
181990b4856Slling 	ZPROP_SRC_TEMPORARY = 0x4,
182990b4856Slling 	ZPROP_SRC_LOCAL = 0x8,
18392241e0bSTom Erickson 	ZPROP_SRC_INHERITED = 0x10,
18492241e0bSTom Erickson 	ZPROP_SRC_RECEIVED = 0x20
185990b4856Slling } zprop_source_t;
186990b4856Slling 
18792241e0bSTom Erickson #define	ZPROP_SRC_ALL	0x3f
18892241e0bSTom Erickson 
18992241e0bSTom Erickson #define	ZPROP_SOURCE_VAL_RECVD	"$recvd"
19092241e0bSTom Erickson #define	ZPROP_N_MORE_ERRORS	"N_MORE_ERRORS"
19192241e0bSTom Erickson /*
19292241e0bSTom Erickson  * Dataset flag implemented as a special entry in the props zap object
19392241e0bSTom Erickson  * indicating that the dataset has received properties on or after
19492241e0bSTom Erickson  * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
19592241e0bSTom Erickson  * just as it did in earlier versions, and thereafter, local properties are
19692241e0bSTom Erickson  * preserved.
19792241e0bSTom Erickson  */
19892241e0bSTom Erickson #define	ZPROP_HAS_RECVD		"$hasrecvd"
19992241e0bSTom Erickson 
20092241e0bSTom Erickson typedef enum {
20192241e0bSTom Erickson 	ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
20292241e0bSTom Erickson 	ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
20392241e0bSTom Erickson } zprop_errflags_t;
204990b4856Slling 
205990b4856Slling typedef int (*zprop_func)(int, void *);
206990b4856Slling 
2070a48a24eStimh /*
2080a48a24eStimh  * Properties to be set on the root file system of a new pool
2090a48a24eStimh  * are stuffed into their own nvlist, which is then included in
2100a48a24eStimh  * the properties nvlist with the pool properties.
2110a48a24eStimh  */
2120a48a24eStimh #define	ZPOOL_ROOTFS_PROPS	"root-props-nvl"
2130a48a24eStimh 
214990b4856Slling /*
215990b4856Slling  * Dataset property functions shared between libzfs and kernel.
216990b4856Slling  */
217990b4856Slling const char *zfs_prop_default_string(zfs_prop_t);
218990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t);
219990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t);
220990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t);
221da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t);
222990b4856Slling const char *zfs_prop_to_name(zfs_prop_t);
223990b4856Slling zfs_prop_t zfs_name_to_prop(const char *);
224990b4856Slling boolean_t zfs_prop_user(const char *);
22592241e0bSTom Erickson boolean_t zfs_prop_userquota(const char *);
226*19b94df9SMatthew Ahrens boolean_t zfs_prop_written(const char *);
227990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
228990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
229b24ab676SJeff Bonwick uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
2304853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
231b1b8ab34Slling 
232990b4856Slling /*
233990b4856Slling  * Pool property functions shared between libzfs and kernel.
234990b4856Slling  */
235990b4856Slling zpool_prop_t zpool_name_to_prop(const char *);
236990b4856Slling const char *zpool_prop_to_name(zpool_prop_t);
237990b4856Slling const char *zpool_prop_default_string(zpool_prop_t);
238990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t);
239990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t);
240990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
241990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
242b24ab676SJeff Bonwick uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
243b1b8ab34Slling 
244990b4856Slling /*
245990b4856Slling  * Definitions for the Delegation.
246990b4856Slling  */
247ecd6cf80Smarks typedef enum {
248ecd6cf80Smarks 	ZFS_DELEG_WHO_UNKNOWN = 0,
249ecd6cf80Smarks 	ZFS_DELEG_USER = 'u',
250ecd6cf80Smarks 	ZFS_DELEG_USER_SETS = 'U',
251ecd6cf80Smarks 	ZFS_DELEG_GROUP = 'g',
252ecd6cf80Smarks 	ZFS_DELEG_GROUP_SETS = 'G',
253ecd6cf80Smarks 	ZFS_DELEG_EVERYONE = 'e',
254ecd6cf80Smarks 	ZFS_DELEG_EVERYONE_SETS = 'E',
255ecd6cf80Smarks 	ZFS_DELEG_CREATE = 'c',
256ecd6cf80Smarks 	ZFS_DELEG_CREATE_SETS = 'C',
257ecd6cf80Smarks 	ZFS_DELEG_NAMED_SET = 's',
258ecd6cf80Smarks 	ZFS_DELEG_NAMED_SET_SETS = 'S'
259ecd6cf80Smarks } zfs_deleg_who_type_t;
260ecd6cf80Smarks 
261ecd6cf80Smarks typedef enum {
262ecd6cf80Smarks 	ZFS_DELEG_NONE = 0,
263ecd6cf80Smarks 	ZFS_DELEG_PERM_LOCAL = 1,
264ecd6cf80Smarks 	ZFS_DELEG_PERM_DESCENDENT = 2,
265ecd6cf80Smarks 	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
266ecd6cf80Smarks 	ZFS_DELEG_PERM_CREATE = 4
267ecd6cf80Smarks } zfs_deleg_inherit_t;
268ecd6cf80Smarks 
269ecd6cf80Smarks #define	ZFS_DELEG_PERM_UID	"uid"
270ecd6cf80Smarks #define	ZFS_DELEG_PERM_GID	"gid"
271ecd6cf80Smarks #define	ZFS_DELEG_PERM_GROUPS	"groups"
272ecd6cf80Smarks 
2734201a95eSRic Aleshire #define	ZFS_MLSLABEL_DEFAULT	"none"
2744201a95eSRic Aleshire 
275743a77edSAlan Wright #define	ZFS_SMB_ACL_SRC		"src"
276743a77edSAlan Wright #define	ZFS_SMB_ACL_TARGET	"target"
277743a77edSAlan Wright 
278a227b7f4Shs typedef enum {
279a227b7f4Shs 	ZFS_CANMOUNT_OFF = 0,
280a227b7f4Shs 	ZFS_CANMOUNT_ON = 1,
281a227b7f4Shs 	ZFS_CANMOUNT_NOAUTO = 2
282a227b7f4Shs } zfs_canmount_type_t;
283a227b7f4Shs 
284e09fa4daSNeil Perrin typedef enum {
285e09fa4daSNeil Perrin 	ZFS_LOGBIAS_LATENCY = 0,
286e09fa4daSNeil Perrin 	ZFS_LOGBIAS_THROUGHPUT = 1
287e09fa4daSNeil Perrin } zfs_logbias_op_t;
288e09fa4daSNeil Perrin 
289da6c28aaSamw typedef enum zfs_share_op {
290da6c28aaSamw 	ZFS_SHARE_NFS = 0,
291da6c28aaSamw 	ZFS_UNSHARE_NFS = 1,
292da6c28aaSamw 	ZFS_SHARE_SMB = 2,
293da6c28aaSamw 	ZFS_UNSHARE_SMB = 3
294da6c28aaSamw } zfs_share_op_t;
295da6c28aaSamw 
296743a77edSAlan Wright typedef enum zfs_smb_acl_op {
297743a77edSAlan Wright 	ZFS_SMB_ACL_ADD,
298743a77edSAlan Wright 	ZFS_SMB_ACL_REMOVE,
299743a77edSAlan Wright 	ZFS_SMB_ACL_RENAME,
300743a77edSAlan Wright 	ZFS_SMB_ACL_PURGE
301743a77edSAlan Wright } zfs_smb_acl_op_t;
302743a77edSAlan Wright 
3033baa08fcSek typedef enum zfs_cache_type {
3043baa08fcSek 	ZFS_CACHE_NONE = 0,
3053baa08fcSek 	ZFS_CACHE_METADATA = 1,
3063baa08fcSek 	ZFS_CACHE_ALL = 2
3073baa08fcSek } zfs_cache_type_t;
3083baa08fcSek 
30955da60b9SMark J Musante typedef enum {
31055da60b9SMark J Musante 	ZFS_SYNC_STANDARD = 0,
31155da60b9SMark J Musante 	ZFS_SYNC_ALWAYS = 1,
31255da60b9SMark J Musante 	ZFS_SYNC_DISABLED = 2
31355da60b9SMark J Musante } zfs_sync_type_t;
31455da60b9SMark J Musante 
3153baa08fcSek 
316eaca9bbdSeschrock /*
31799653d4eSeschrock  * On-disk version number.
318eaca9bbdSeschrock  */
319e7437265Sahrens #define	SPA_VERSION_1			1ULL
320e7437265Sahrens #define	SPA_VERSION_2			2ULL
321e7437265Sahrens #define	SPA_VERSION_3			3ULL
322e7437265Sahrens #define	SPA_VERSION_4			4ULL
323e7437265Sahrens #define	SPA_VERSION_5			5ULL
324e7437265Sahrens #define	SPA_VERSION_6			6ULL
325e7437265Sahrens #define	SPA_VERSION_7			7ULL
326e7437265Sahrens #define	SPA_VERSION_8			8ULL
327da6c28aaSamw #define	SPA_VERSION_9			9ULL
328fa94a07fSbrendan #define	SPA_VERSION_10			10ULL
329088f3894Sahrens #define	SPA_VERSION_11			11ULL
330bb0ade09Sahrens #define	SPA_VERSION_12			12ULL
33174e7dc98SMatthew Ahrens #define	SPA_VERSION_13			13ULL
332d0f3f37eSMark Shellenbaum #define	SPA_VERSION_14			14ULL
33314843421SMatthew Ahrens #define	SPA_VERSION_15			15ULL
334478ed9adSEric Taylor #define	SPA_VERSION_16			16ULL
335f94275ceSAdam Leventhal #define	SPA_VERSION_17			17ULL
336842727c2SChris Kirby #define	SPA_VERSION_18			18ULL
33788ecc943SGeorge Wilson #define	SPA_VERSION_19			19ULL
338b24ab676SJeff Bonwick #define	SPA_VERSION_20			20ULL
339b24ab676SJeff Bonwick #define	SPA_VERSION_21			21ULL
34092241e0bSTom Erickson #define	SPA_VERSION_22			22ULL
3416e1f5caaSNeil Perrin #define	SPA_VERSION_23			23ULL
3420a586ceaSMark Shellenbaum #define	SPA_VERSION_24			24ULL
3433f9d6ad7SLin Ling #define	SPA_VERSION_25			25ULL
344cde58dbcSMatthew Ahrens #define	SPA_VERSION_26			26ULL
3456e0cbcaaSMatthew Ahrens #define	SPA_VERSION_27			27ULL
346cb04b873SMark J Musante #define	SPA_VERSION_28			28ULL
347cb04b873SMark J Musante 
348b1b8ab34Slling /*
349e7cbe64fSgw  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
350478ed9adSEric Taylor  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
35114843421SMatthew Ahrens  * and do the appropriate changes.  Also bump the version number in
35214843421SMatthew Ahrens  * usr/src/grub/capability.
353b1b8ab34Slling  */
354cb04b873SMark J Musante #define	SPA_VERSION			SPA_VERSION_28
355cb04b873SMark J Musante #define	SPA_VERSION_STRING		"28"
35644cd46caSbillm 
35744cd46caSbillm /*
358e7437265Sahrens  * Symbolic names for the changes that caused a SPA_VERSION switch.
35944cd46caSbillm  * Used in the code when checking for presence or absence of a feature.
36044cd46caSbillm  * Feel free to define multiple symbolic names for each version if there
36144cd46caSbillm  * were multiple changes to on-disk structures during that version.
36244cd46caSbillm  *
363e7437265Sahrens  * NOTE: When checking the current SPA_VERSION in your code, be sure
36444cd46caSbillm  *       to use spa_version() since it reports the version of the
36544cd46caSbillm  *       last synced uberblock.  Checking the in-flight version can
36644cd46caSbillm  *       be dangerous in some cases.
36744cd46caSbillm  */
368e7437265Sahrens #define	SPA_VERSION_INITIAL		SPA_VERSION_1
369e7437265Sahrens #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
370e7437265Sahrens #define	SPA_VERSION_SPARES		SPA_VERSION_3
371f94275ceSAdam Leventhal #define	SPA_VERSION_RAIDZ2		SPA_VERSION_3
372cde58dbcSMatthew Ahrens #define	SPA_VERSION_BPOBJ_ACCOUNT	SPA_VERSION_3
373e7437265Sahrens #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
374e7437265Sahrens #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
375e7437265Sahrens #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
376e7437265Sahrens #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
377e7437265Sahrens #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
378990b4856Slling #define	SPA_VERSION_SLOGS		SPA_VERSION_7
379990b4856Slling #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
380da6c28aaSamw #define	SPA_VERSION_FUID		SPA_VERSION_9
381a9799022Sck #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
382a9799022Sck #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
383a9799022Sck #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
384fa94a07fSbrendan #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
385088f3894Sahrens #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
386088f3894Sahrens #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
387088f3894Sahrens #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
388bb0ade09Sahrens #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
38974e7dc98SMatthew Ahrens #define	SPA_VERSION_USED_BREAKDOWN	SPA_VERSION_13
390d0f3f37eSMark Shellenbaum #define	SPA_VERSION_PASSTHROUGH_X	SPA_VERSION_14
39114843421SMatthew Ahrens #define	SPA_VERSION_USERSPACE		SPA_VERSION_15
392478ed9adSEric Taylor #define	SPA_VERSION_STMF_PROP		SPA_VERSION_16
393f94275ceSAdam Leventhal #define	SPA_VERSION_RAIDZ3		SPA_VERSION_17
394842727c2SChris Kirby #define	SPA_VERSION_USERREFS		SPA_VERSION_18
39588ecc943SGeorge Wilson #define	SPA_VERSION_HOLES		SPA_VERSION_19
396b24ab676SJeff Bonwick #define	SPA_VERSION_ZLE_COMPRESSION	SPA_VERSION_20
397b24ab676SJeff Bonwick #define	SPA_VERSION_DEDUP		SPA_VERSION_21
39892241e0bSTom Erickson #define	SPA_VERSION_RECVD_PROPS		SPA_VERSION_22
3996e1f5caaSNeil Perrin #define	SPA_VERSION_SLIM_ZIL		SPA_VERSION_23
4000a586ceaSMark Shellenbaum #define	SPA_VERSION_SA			SPA_VERSION_24
4013f9d6ad7SLin Ling #define	SPA_VERSION_SCAN		SPA_VERSION_25
402cde58dbcSMatthew Ahrens #define	SPA_VERSION_DIR_CLONES		SPA_VERSION_26
403cde58dbcSMatthew Ahrens #define	SPA_VERSION_DEADLISTS		SPA_VERSION_26
4046e0cbcaaSMatthew Ahrens #define	SPA_VERSION_FAST_SNAP		SPA_VERSION_27
405cb04b873SMark J Musante #define	SPA_VERSION_MULTI_REPLACE	SPA_VERSION_28
406e7437265Sahrens 
407e7437265Sahrens /*
408e7437265Sahrens  * ZPL version - rev'd whenever an incompatible on-disk format change
409e7437265Sahrens  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
410e7437265Sahrens  * also update the version_table[] and help message in zfs_prop.c.
411e7437265Sahrens  *
412e7437265Sahrens  * When changing, be sure to teach GRUB how to read the new format!
413478ed9adSEric Taylor  * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
414e7437265Sahrens  */
415e7437265Sahrens #define	ZPL_VERSION_1			1ULL
416e7437265Sahrens #define	ZPL_VERSION_2			2ULL
417da6c28aaSamw #define	ZPL_VERSION_3			3ULL
41814843421SMatthew Ahrens #define	ZPL_VERSION_4			4ULL
4190a586ceaSMark Shellenbaum #define	ZPL_VERSION_5			5ULL
4200a586ceaSMark Shellenbaum #define	ZPL_VERSION			ZPL_VERSION_5
4210a586ceaSMark Shellenbaum #define	ZPL_VERSION_STRING		"5"
422e7437265Sahrens 
423e7437265Sahrens #define	ZPL_VERSION_INITIAL		ZPL_VERSION_1
424e7437265Sahrens #define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2
425da6c28aaSamw #define	ZPL_VERSION_FUID		ZPL_VERSION_3
426de8267e0Stimh #define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3
427da6c28aaSamw #define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3
42814843421SMatthew Ahrens #define	ZPL_VERSION_USERSPACE		ZPL_VERSION_4
4290a586ceaSMark Shellenbaum #define	ZPL_VERSION_SA			ZPL_VERSION_5
430eaca9bbdSeschrock 
431468c413aSTim Haley /* Rewind request information */
432c8ee1847SVictor Latushkin #define	ZPOOL_NO_REWIND		1  /* No policy - default behavior */
433c8ee1847SVictor Latushkin #define	ZPOOL_NEVER_REWIND	2  /* Do not search for best txg or rewind */
434c8ee1847SVictor Latushkin #define	ZPOOL_TRY_REWIND	4  /* Search for best txg, but do not rewind */
435c8ee1847SVictor Latushkin #define	ZPOOL_DO_REWIND		8  /* Rewind to best txg w/in deferred frees */
436c8ee1847SVictor Latushkin #define	ZPOOL_EXTREME_REWIND	16 /* Allow extreme measures to find best txg */
437c8ee1847SVictor Latushkin #define	ZPOOL_REWIND_MASK	28 /* All the possible rewind bits */
438c8ee1847SVictor Latushkin #define	ZPOOL_REWIND_POLICIES	31 /* All the possible policy bits */
439468c413aSTim Haley 
440468c413aSTim Haley typedef struct zpool_rewind_policy {
441468c413aSTim Haley 	uint32_t	zrp_request;	/* rewind behavior requested */
442c8ee1847SVictor Latushkin 	uint64_t	zrp_maxmeta;	/* max acceptable meta-data errors */
443c8ee1847SVictor Latushkin 	uint64_t	zrp_maxdata;	/* max acceptable data errors */
444468c413aSTim Haley 	uint64_t	zrp_txg;	/* specific txg to load */
445468c413aSTim Haley } zpool_rewind_policy_t;
446468c413aSTim Haley 
447fa9e4066Sahrens /*
448fa9e4066Sahrens  * The following are configuration names used in the nvlist describing a pool's
449fa9e4066Sahrens  * configuration.
450fa9e4066Sahrens  */
451fa9e4066Sahrens #define	ZPOOL_CONFIG_VERSION		"version"
452fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_NAME		"name"
453fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_STATE		"state"
454fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_TXG		"txg"
455fa9e4066Sahrens #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
456fa9e4066Sahrens #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
457fa9e4066Sahrens #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
458fa9e4066Sahrens #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
459fa9e4066Sahrens #define	ZPOOL_CONFIG_TYPE		"type"
460fa9e4066Sahrens #define	ZPOOL_CONFIG_CHILDREN		"children"
461fa9e4066Sahrens #define	ZPOOL_CONFIG_ID			"id"
462fa9e4066Sahrens #define	ZPOOL_CONFIG_GUID		"guid"
463fa9e4066Sahrens #define	ZPOOL_CONFIG_PATH		"path"
464fa9e4066Sahrens #define	ZPOOL_CONFIG_DEVID		"devid"
465fa9e4066Sahrens #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
466fa9e4066Sahrens #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
467fa9e4066Sahrens #define	ZPOOL_CONFIG_ASHIFT		"ashift"
468fa9e4066Sahrens #define	ZPOOL_CONFIG_ASIZE		"asize"
469fa9e4066Sahrens #define	ZPOOL_CONFIG_DTL		"DTL"
4703f9d6ad7SLin Ling #define	ZPOOL_CONFIG_SCAN_STATS		"scan_stats"	/* not stored on disk */
4713f9d6ad7SLin Ling #define	ZPOOL_CONFIG_VDEV_STATS		"vdev_stats"	/* not stored on disk */
472afefbcddSeschrock #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
473ea8dc4b6Seschrock #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
474ea8dc4b6Seschrock #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
47599653d4eSeschrock #define	ZPOOL_CONFIG_SPARES		"spares"
47699653d4eSeschrock #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
47799653d4eSeschrock #define	ZPOOL_CONFIG_NPARITY		"nparity"
47895173954Sek #define	ZPOOL_CONFIG_HOSTID		"hostid"
47995173954Sek #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
48011027bc7STim Haley #define	ZPOOL_CONFIG_LOADED_TIME	"initial_load_time"
4813d7072f8Seschrock #define	ZPOOL_CONFIG_UNSPARE		"unspare"
4823d7072f8Seschrock #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
4838654d025Sperrin #define	ZPOOL_CONFIG_IS_LOG		"is_log"
484fa94a07fSbrendan #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
48588ecc943SGeorge Wilson #define	ZPOOL_CONFIG_HOLE_ARRAY		"hole_array"
48688ecc943SGeorge Wilson #define	ZPOOL_CONFIG_VDEV_CHILDREN	"vdev_children"
48788ecc943SGeorge Wilson #define	ZPOOL_CONFIG_IS_HOLE		"is_hole"
4889eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_HISTOGRAM	"ddt_histogram"
4899eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_OBJ_STATS	"ddt_object_stats"
4909eb19f4dSGeorge Wilson #define	ZPOOL_CONFIG_DDT_STATS		"ddt_stats"
4911195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT		"splitcfg"
4921195e687SMark J Musante #define	ZPOOL_CONFIG_ORIG_GUID		"orig_guid"
4931195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT_GUID		"split_guid"
4941195e687SMark J Musante #define	ZPOOL_CONFIG_SPLIT_LIST		"guid_list"
4953f9d6ad7SLin Ling #define	ZPOOL_CONFIG_REMOVING		"removing"
496cb04b873SMark J Musante #define	ZPOOL_CONFIG_RESILVERING	"resilvering"
497e14bb325SJeff Bonwick #define	ZPOOL_CONFIG_SUSPENDED		"suspended"	/* not stored on disk */
498e7cbe64fSgw #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp"	/* not stored on disk */
499e7cbe64fSgw #define	ZPOOL_CONFIG_BOOTFS		"bootfs"	/* not stored on disk */
5004b964adaSGeorge Wilson #define	ZPOOL_CONFIG_MISSING_DEVICES	"missing_vdevs"	/* not stored on disk */
5014b964adaSGeorge Wilson #define	ZPOOL_CONFIG_LOAD_INFO		"load_info"	/* not stored on disk */
5023d7072f8Seschrock /*
5033d7072f8Seschrock  * The persistent vdev state is stored as separate values rather than a single
5043d7072f8Seschrock  * 'vdev_state' entry.  This is because a device can be in multiple states, such
5053d7072f8Seschrock  * as offline and degraded.
5063d7072f8Seschrock  */
5073d7072f8Seschrock #define	ZPOOL_CONFIG_OFFLINE		"offline"
5083d7072f8Seschrock #define	ZPOOL_CONFIG_FAULTED		"faulted"
5093d7072f8Seschrock #define	ZPOOL_CONFIG_DEGRADED		"degraded"
5103d7072f8Seschrock #define	ZPOOL_CONFIG_REMOVED		"removed"
5116809eb4eSEric Schrock #define	ZPOOL_CONFIG_FRU		"fru"
512069f55e2SEric Schrock #define	ZPOOL_CONFIG_AUX_STATE		"aux_state"
513fa9e4066Sahrens 
514468c413aSTim Haley /* Rewind policy parameters */
515468c413aSTim Haley #define	ZPOOL_REWIND_POLICY		"rewind-policy"
516468c413aSTim Haley #define	ZPOOL_REWIND_REQUEST		"rewind-request"
517468c413aSTim Haley #define	ZPOOL_REWIND_REQUEST_TXG	"rewind-request-txg"
518468c413aSTim Haley #define	ZPOOL_REWIND_META_THRESH	"rewind-meta-thresh"
519468c413aSTim Haley #define	ZPOOL_REWIND_DATA_THRESH	"rewind-data-thresh"
520468c413aSTim Haley 
521468c413aSTim Haley /* Rewind data discovered */
522468c413aSTim Haley #define	ZPOOL_CONFIG_LOAD_TIME		"rewind_txg_ts"
523468c413aSTim Haley #define	ZPOOL_CONFIG_LOAD_DATA_ERRORS	"verify_data_errors"
524468c413aSTim Haley #define	ZPOOL_CONFIG_REWIND_TIME	"seconds_of_rewind"
525468c413aSTim Haley 
526fa9e4066Sahrens #define	VDEV_TYPE_ROOT			"root"
527fa9e4066Sahrens #define	VDEV_TYPE_MIRROR		"mirror"
528fa9e4066Sahrens #define	VDEV_TYPE_REPLACING		"replacing"
529fa9e4066Sahrens #define	VDEV_TYPE_RAIDZ			"raidz"
530fa9e4066Sahrens #define	VDEV_TYPE_DISK			"disk"
531fa9e4066Sahrens #define	VDEV_TYPE_FILE			"file"
532fa9e4066Sahrens #define	VDEV_TYPE_MISSING		"missing"
53388ecc943SGeorge Wilson #define	VDEV_TYPE_HOLE			"hole"
53499653d4eSeschrock #define	VDEV_TYPE_SPARE			"spare"
5358654d025Sperrin #define	VDEV_TYPE_LOG			"log"
536fa94a07fSbrendan #define	VDEV_TYPE_L2CACHE		"l2cache"
537fa9e4066Sahrens 
538fa9e4066Sahrens /*
539fa9e4066Sahrens  * This is needed in userland to report the minimum necessary device size.
540fa9e4066Sahrens  */
541fa9e4066Sahrens #define	SPA_MINDEVSIZE		(64ULL << 20)
542fa9e4066Sahrens 
543fa9e4066Sahrens /*
544fa9e4066Sahrens  * The location of the pool configuration repository, shared between kernel and
545fa9e4066Sahrens  * userland.
546fa9e4066Sahrens  */
547c5904d13Seschrock #define	ZPOOL_CACHE		"/etc/zfs/zpool.cache"
548fa9e4066Sahrens 
549fa9e4066Sahrens /*
550fa9e4066Sahrens  * vdev states are ordered from least to most healthy.
551fa9e4066Sahrens  * A vdev that's CANT_OPEN or below is considered unusable.
552fa9e4066Sahrens  */
553fa9e4066Sahrens typedef enum vdev_state {
554fa9e4066Sahrens 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
555fa9e4066Sahrens 	VDEV_STATE_CLOSED,	/* Not currently open			*/
556fa9e4066Sahrens 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
5573d7072f8Seschrock 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
558fa9e4066Sahrens 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
5593d7072f8Seschrock 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
560fa9e4066Sahrens 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
561fa9e4066Sahrens 	VDEV_STATE_HEALTHY	/* Presumed good			*/
562fa9e4066Sahrens } vdev_state_t;
563fa9e4066Sahrens 
5643d7072f8Seschrock #define	VDEV_STATE_ONLINE	VDEV_STATE_HEALTHY
5653d7072f8Seschrock 
566fa9e4066Sahrens /*
567fa9e4066Sahrens  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
568fa9e4066Sahrens  * of the vdev stats structure uses these constants to distinguish why.
569fa9e4066Sahrens  */
570fa9e4066Sahrens typedef enum vdev_aux {
571fa9e4066Sahrens 	VDEV_AUX_NONE,		/* no error				*/
572fa9e4066Sahrens 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
573fa9e4066Sahrens 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
574fa9e4066Sahrens 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
575fa9e4066Sahrens 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
576fa9e4066Sahrens 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
577eaca9bbdSeschrock 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
578eaca9bbdSeschrock 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
57999653d4eSeschrock 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
5803d7072f8Seschrock 	VDEV_AUX_SPARED,	/* hot spare used in another pool	*/
58132b87932Sek 	VDEV_AUX_ERR_EXCEEDED,	/* too many errors			*/
582b87f3af3Sperrin 	VDEV_AUX_IO_FAILURE,	/* experienced I/O failure		*/
583069f55e2SEric Schrock 	VDEV_AUX_BAD_LOG,	/* cannot read log chain(s)		*/
5841195e687SMark J Musante 	VDEV_AUX_EXTERNAL,	/* external diagnosis			*/
5851195e687SMark J Musante 	VDEV_AUX_SPLIT_POOL	/* vdev was split off into another pool	*/
586fa9e4066Sahrens } vdev_aux_t;
587fa9e4066Sahrens 
588fa9e4066Sahrens /*
58946a2abf2Seschrock  * pool state.  The following states are written to disk as part of the normal
590fa94a07fSbrendan  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
591fa94a07fSbrendan  * states are software abstractions used at various levels to communicate
592fa94a07fSbrendan  * pool state.
593fa9e4066Sahrens  */
594fa9e4066Sahrens typedef enum pool_state {
595fa9e4066Sahrens 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
596fa9e4066Sahrens 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
597fa9e4066Sahrens 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
59899653d4eSeschrock 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
599fa94a07fSbrendan 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
600fa9e4066Sahrens 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
60146a2abf2Seschrock 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
60246a2abf2Seschrock 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
603fa9e4066Sahrens } pool_state_t;
604fa9e4066Sahrens 
605fa9e4066Sahrens /*
6063f9d6ad7SLin Ling  * Scan Functions.
607fa9e4066Sahrens  */
6083f9d6ad7SLin Ling typedef enum pool_scan_func {
6093f9d6ad7SLin Ling 	POOL_SCAN_NONE,
6103f9d6ad7SLin Ling 	POOL_SCAN_SCRUB,
6113f9d6ad7SLin Ling 	POOL_SCAN_RESILVER,
6123f9d6ad7SLin Ling 	POOL_SCAN_FUNCS
6133f9d6ad7SLin Ling } pool_scan_func_t;
614fa9e4066Sahrens 
615fa9e4066Sahrens /*
616fa9e4066Sahrens  * ZIO types.  Needed to interpret vdev statistics below.
617fa9e4066Sahrens  */
618fa9e4066Sahrens typedef enum zio_type {
619fa9e4066Sahrens 	ZIO_TYPE_NULL = 0,
620fa9e4066Sahrens 	ZIO_TYPE_READ,
621fa9e4066Sahrens 	ZIO_TYPE_WRITE,
622fa9e4066Sahrens 	ZIO_TYPE_FREE,
623fa9e4066Sahrens 	ZIO_TYPE_CLAIM,
624fa9e4066Sahrens 	ZIO_TYPE_IOCTL,
625fa9e4066Sahrens 	ZIO_TYPES
626fa9e4066Sahrens } zio_type_t;
627fa9e4066Sahrens 
6283f9d6ad7SLin Ling /*
6293f9d6ad7SLin Ling  * Pool statistics.  Note: all fields should be 64-bit because this
6303f9d6ad7SLin Ling  * is passed between kernel and userland as an nvlist uint64 array.
6313f9d6ad7SLin Ling  */
6323f9d6ad7SLin Ling typedef struct pool_scan_stat {
6333f9d6ad7SLin Ling 	/* values stored on disk */
6343f9d6ad7SLin Ling 	uint64_t	pss_func;	/* pool_scan_func_t */
6353f9d6ad7SLin Ling 	uint64_t	pss_state;	/* dsl_scan_state_t */
6363f9d6ad7SLin Ling 	uint64_t	pss_start_time;	/* scan start time */
6373f9d6ad7SLin Ling 	uint64_t	pss_end_time;	/* scan end time */
6383f9d6ad7SLin Ling 	uint64_t	pss_to_examine;	/* total bytes to scan */
6393f9d6ad7SLin Ling 	uint64_t	pss_examined;	/* total examined bytes	*/
6403f9d6ad7SLin Ling 	uint64_t	pss_to_process; /* total bytes to process */
6413f9d6ad7SLin Ling 	uint64_t	pss_processed;	/* total processed bytes */
6423f9d6ad7SLin Ling 	uint64_t	pss_errors;	/* scan errors	*/
6433f9d6ad7SLin Ling 
6443f9d6ad7SLin Ling 	/* values not stored on disk */
6453f9d6ad7SLin Ling 	uint64_t	pss_pass_exam;	/* examined bytes per scan pass */
6463f9d6ad7SLin Ling 	uint64_t	pss_pass_start;	/* start time of a scan pass */
6473f9d6ad7SLin Ling } pool_scan_stat_t;
6483f9d6ad7SLin Ling 
6493f9d6ad7SLin Ling typedef enum dsl_scan_state {
6503f9d6ad7SLin Ling 	DSS_NONE,
6513f9d6ad7SLin Ling 	DSS_SCANNING,
6523f9d6ad7SLin Ling 	DSS_FINISHED,
6533f9d6ad7SLin Ling 	DSS_CANCELED,
6543f9d6ad7SLin Ling 	DSS_NUM_STATES
6553f9d6ad7SLin Ling } dsl_scan_state_t;
6563f9d6ad7SLin Ling 
6573f9d6ad7SLin Ling 
658fa9e4066Sahrens /*
659fa9e4066Sahrens  * Vdev statistics.  Note: all fields should be 64-bit because this
660fa9e4066Sahrens  * is passed between kernel and userland as an nvlist uint64 array.
661fa9e4066Sahrens  */
662fa9e4066Sahrens typedef struct vdev_stat {
663fa9e4066Sahrens 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
664fa9e4066Sahrens 	uint64_t	vs_state;		/* vdev state		*/
665fa9e4066Sahrens 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
666fa9e4066Sahrens 	uint64_t	vs_alloc;		/* space allocated	*/
667fa9e4066Sahrens 	uint64_t	vs_space;		/* total capacity	*/
66899653d4eSeschrock 	uint64_t	vs_dspace;		/* deflated capacity	*/
6692a79c5feSlling 	uint64_t	vs_rsize;		/* replaceable dev size */
670fa9e4066Sahrens 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
671fa9e4066Sahrens 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
672fa9e4066Sahrens 	uint64_t	vs_read_errors;		/* read errors		*/
673fa9e4066Sahrens 	uint64_t	vs_write_errors;	/* write errors		*/
674fa9e4066Sahrens 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
675fa9e4066Sahrens 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
6763f9d6ad7SLin Ling 	uint64_t	vs_scan_removing;	/* removing?	*/
6773f9d6ad7SLin Ling 	uint64_t	vs_scan_processed;	/* scan processed bytes	*/
678fa9e4066Sahrens } vdev_stat_t;
679fa9e4066Sahrens 
6809eb19f4dSGeorge Wilson /*
6819eb19f4dSGeorge Wilson  * DDT statistics.  Note: all fields should be 64-bit because this
6829eb19f4dSGeorge Wilson  * is passed between kernel and userland as an nvlist uint64 array.
6839eb19f4dSGeorge Wilson  */
6849eb19f4dSGeorge Wilson typedef struct ddt_object {
6859eb19f4dSGeorge Wilson 	uint64_t	ddo_count;	/* number of elments in ddt 	*/
6869eb19f4dSGeorge Wilson 	uint64_t	ddo_dspace;	/* size of ddt on disk		*/
6879eb19f4dSGeorge Wilson 	uint64_t	ddo_mspace;	/* size of ddt in-core		*/
6889eb19f4dSGeorge Wilson } ddt_object_t;
6899eb19f4dSGeorge Wilson 
6909eb19f4dSGeorge Wilson typedef struct ddt_stat {
6919eb19f4dSGeorge Wilson 	uint64_t	dds_blocks;	/* blocks			*/
6929eb19f4dSGeorge Wilson 	uint64_t	dds_lsize;	/* logical size			*/
6939eb19f4dSGeorge Wilson 	uint64_t	dds_psize;	/* physical size		*/
6949eb19f4dSGeorge Wilson 	uint64_t	dds_dsize;	/* deflated allocated size	*/
6959eb19f4dSGeorge Wilson 	uint64_t	dds_ref_blocks;	/* referenced blocks		*/
6969eb19f4dSGeorge Wilson 	uint64_t	dds_ref_lsize;	/* referenced lsize * refcnt	*/
6979eb19f4dSGeorge Wilson 	uint64_t	dds_ref_psize;	/* referenced psize * refcnt	*/
6989eb19f4dSGeorge Wilson 	uint64_t	dds_ref_dsize;	/* referenced dsize * refcnt	*/
6999eb19f4dSGeorge Wilson } ddt_stat_t;
7009eb19f4dSGeorge Wilson 
7019eb19f4dSGeorge Wilson typedef struct ddt_histogram {
7029eb19f4dSGeorge Wilson 	ddt_stat_t	ddh_stat[64];	/* power-of-two histogram buckets */
7039eb19f4dSGeorge Wilson } ddt_histogram_t;
7049eb19f4dSGeorge Wilson 
705e7cbe64fSgw #define	ZVOL_DRIVER	"zvol"
706fa9e4066Sahrens #define	ZFS_DRIVER	"zfs"
707fa9e4066Sahrens #define	ZFS_DEV		"/dev/zfs"
708fa9e4066Sahrens 
709681d9761SEric Taylor /* general zvol path */
710681d9761SEric Taylor #define	ZVOL_DIR		"/dev/zvol"
711681d9761SEric Taylor /* expansion */
712573ca77eSGeorge Wilson #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zfs@0:"
713681d9761SEric Taylor /* for dump and swap */
714681d9761SEric Taylor #define	ZVOL_FULL_DEV_DIR	ZVOL_DIR "/dsk/"
715681d9761SEric Taylor #define	ZVOL_FULL_RDEV_DIR	ZVOL_DIR "/rdsk/"
716fa9e4066Sahrens 
717fa9e4066Sahrens #define	ZVOL_PROP_NAME		"name"
718c1449561SEric Taylor #define	ZVOL_DEFAULT_BLOCKSIZE	8192
719fa9e4066Sahrens 
720fa9e4066Sahrens /*
721fa9e4066Sahrens  * /dev/zfs ioctl numbers.
722fa9e4066Sahrens  */
723fa9e4066Sahrens #define	ZFS_IOC		('Z' << 8)
724fa9e4066Sahrens 
725fa9e4066Sahrens typedef enum zfs_ioc {
726fa9e4066Sahrens 	ZFS_IOC_POOL_CREATE = ZFS_IOC,
727fa9e4066Sahrens 	ZFS_IOC_POOL_DESTROY,
728fa9e4066Sahrens 	ZFS_IOC_POOL_IMPORT,
729fa9e4066Sahrens 	ZFS_IOC_POOL_EXPORT,
730fa9e4066Sahrens 	ZFS_IOC_POOL_CONFIGS,
731fa9e4066Sahrens 	ZFS_IOC_POOL_STATS,
732fa9e4066Sahrens 	ZFS_IOC_POOL_TRYIMPORT,
7333f9d6ad7SLin Ling 	ZFS_IOC_POOL_SCAN,
734fa9e4066Sahrens 	ZFS_IOC_POOL_FREEZE,
735eaca9bbdSeschrock 	ZFS_IOC_POOL_UPGRADE,
73606eeb2adSek 	ZFS_IOC_POOL_GET_HISTORY,
737fa9e4066Sahrens 	ZFS_IOC_VDEV_ADD,
738fa9e4066Sahrens 	ZFS_IOC_VDEV_REMOVE,
7393d7072f8Seschrock 	ZFS_IOC_VDEV_SET_STATE,
740fa9e4066Sahrens 	ZFS_IOC_VDEV_ATTACH,
741fa9e4066Sahrens 	ZFS_IOC_VDEV_DETACH,
742c67d9675Seschrock 	ZFS_IOC_VDEV_SETPATH,
7436809eb4eSEric Schrock 	ZFS_IOC_VDEV_SETFRU,
744fa9e4066Sahrens 	ZFS_IOC_OBJSET_STATS,
745de8267e0Stimh 	ZFS_IOC_OBJSET_ZPLPROPS,
746fa9e4066Sahrens 	ZFS_IOC_DATASET_LIST_NEXT,
747fa9e4066Sahrens 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
748fa9e4066Sahrens 	ZFS_IOC_SET_PROP,
749fa9e4066Sahrens 	ZFS_IOC_CREATE,
750fa9e4066Sahrens 	ZFS_IOC_DESTROY,
751fa9e4066Sahrens 	ZFS_IOC_ROLLBACK,
752fa9e4066Sahrens 	ZFS_IOC_RENAME,
7533cb34c60Sahrens 	ZFS_IOC_RECV,
7543cb34c60Sahrens 	ZFS_IOC_SEND,
755ea8dc4b6Seschrock 	ZFS_IOC_INJECT_FAULT,
756ea8dc4b6Seschrock 	ZFS_IOC_CLEAR_FAULT,
757ea8dc4b6Seschrock 	ZFS_IOC_INJECT_LIST_NEXT,
758ea8dc4b6Seschrock 	ZFS_IOC_ERROR_LOG,
759ea8dc4b6Seschrock 	ZFS_IOC_CLEAR,
7601d452cf5Sahrens 	ZFS_IOC_PROMOTE,
76155434c77Sek 	ZFS_IOC_SNAPSHOT,
76255434c77Sek 	ZFS_IOC_DSOBJ_TO_DSNAME,
763b1b8ab34Slling 	ZFS_IOC_OBJ_TO_PATH,
764b1b8ab34Slling 	ZFS_IOC_POOL_SET_PROPS,
765ecd6cf80Smarks 	ZFS_IOC_POOL_GET_PROPS,
766ecd6cf80Smarks 	ZFS_IOC_SET_FSACL,
767ecd6cf80Smarks 	ZFS_IOC_GET_FSACL,
768e45ce728Sahrens 	ZFS_IOC_SHARE,
769743a77edSAlan Wright 	ZFS_IOC_INHERIT_PROP,
77014843421SMatthew Ahrens 	ZFS_IOC_SMB_ACL,
77114843421SMatthew Ahrens 	ZFS_IOC_USERSPACE_ONE,
77214843421SMatthew Ahrens 	ZFS_IOC_USERSPACE_MANY,
773842727c2SChris Kirby 	ZFS_IOC_USERSPACE_UPGRADE,
774842727c2SChris Kirby 	ZFS_IOC_HOLD,
775842727c2SChris Kirby 	ZFS_IOC_RELEASE,
77692241e0bSTom Erickson 	ZFS_IOC_GET_HOLDS,
7771195e687SMark J Musante 	ZFS_IOC_OBJSET_RECVD_PROPS,
77899d5e173STim Haley 	ZFS_IOC_VDEV_SPLIT,
77999d5e173STim Haley 	ZFS_IOC_NEXT_OBJ,
78099d5e173STim Haley 	ZFS_IOC_DIFF,
78199d5e173STim Haley 	ZFS_IOC_TMP_SNAPSHOT,
782e9103aaeSGarrett D'Amore 	ZFS_IOC_OBJ_TO_STATS,
783*19b94df9SMatthew Ahrens 	ZFS_IOC_SPACE_WRITTEN,
784*19b94df9SMatthew Ahrens 	ZFS_IOC_SPACE_SNAPS,
785*19b94df9SMatthew Ahrens 	ZFS_IOC_DESTROY_SNAPS_NVL,
786e9103aaeSGarrett D'Amore 	ZFS_IOC_POOL_REGUID
787fa9e4066Sahrens } zfs_ioc_t;
788fa9e4066Sahrens 
789ea8dc4b6Seschrock /*
790ea8dc4b6Seschrock  * Internal SPA load state.  Used by FMA diagnosis engine.
791ea8dc4b6Seschrock  */
792ea8dc4b6Seschrock typedef enum {
7939eb19f4dSGeorge Wilson 	SPA_LOAD_NONE,		/* no load in progress	*/
7949eb19f4dSGeorge Wilson 	SPA_LOAD_OPEN,		/* normal open		*/
7959eb19f4dSGeorge Wilson 	SPA_LOAD_IMPORT,	/* import in progress	*/
796468c413aSTim Haley 	SPA_LOAD_TRYIMPORT,	/* tryimport in progress */
7979eb19f4dSGeorge Wilson 	SPA_LOAD_RECOVER,	/* recovery requested	*/
7989eb19f4dSGeorge Wilson 	SPA_LOAD_ERROR		/* load failed		*/
799ea8dc4b6Seschrock } spa_load_state_t;
800ea8dc4b6Seschrock 
801e9dbad6fSeschrock /*
802e9dbad6fSeschrock  * Bookmark name values.
803e9dbad6fSeschrock  */
80455434c77Sek #define	ZPOOL_ERR_LIST		"error list"
805e9dbad6fSeschrock #define	ZPOOL_ERR_DATASET	"dataset"
806e9dbad6fSeschrock #define	ZPOOL_ERR_OBJECT	"object"
807e9dbad6fSeschrock 
80806eeb2adSek #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
80906eeb2adSek 
81006eeb2adSek /*
81106eeb2adSek  * The following are names used in the nvlist describing
81206eeb2adSek  * the pool's history log.
81306eeb2adSek  */
81406eeb2adSek #define	ZPOOL_HIST_RECORD	"history record"
81506eeb2adSek #define	ZPOOL_HIST_TIME		"history time"
81606eeb2adSek #define	ZPOOL_HIST_CMD		"history command"
817ecd6cf80Smarks #define	ZPOOL_HIST_WHO		"history who"
818ecd6cf80Smarks #define	ZPOOL_HIST_ZONE		"history zone"
819ecd6cf80Smarks #define	ZPOOL_HIST_HOST		"history hostname"
820ecd6cf80Smarks #define	ZPOOL_HIST_TXG		"history txg"
821ecd6cf80Smarks #define	ZPOOL_HIST_INT_EVENT	"history internal event"
822ecd6cf80Smarks #define	ZPOOL_HIST_INT_STR	"history internal str"
82306eeb2adSek 
8243d7072f8Seschrock /*
8253d7072f8Seschrock  * Flags for ZFS_IOC_VDEV_SET_STATE
8263d7072f8Seschrock  */
8273d7072f8Seschrock #define	ZFS_ONLINE_CHECKREMOVE	0x1
8283d7072f8Seschrock #define	ZFS_ONLINE_UNSPARE	0x2
8293d7072f8Seschrock #define	ZFS_ONLINE_FORCEFAULT	0x4
830573ca77eSGeorge Wilson #define	ZFS_ONLINE_EXPAND	0x8
8313d7072f8Seschrock #define	ZFS_OFFLINE_TEMPORARY	0x1
8323d7072f8Seschrock 
8334b964adaSGeorge Wilson /*
8344b964adaSGeorge Wilson  * Flags for ZFS_IOC_POOL_IMPORT
8354b964adaSGeorge Wilson  */
8364b964adaSGeorge Wilson #define	ZFS_IMPORT_NORMAL	0x0
8374b964adaSGeorge Wilson #define	ZFS_IMPORT_VERBATIM	0x1
8384b964adaSGeorge Wilson #define	ZFS_IMPORT_ANY_HOST	0x2
8394b964adaSGeorge Wilson #define	ZFS_IMPORT_MISSING_LOG	0x4
840f9af39baSGeorge Wilson #define	ZFS_IMPORT_ONLY		0x8
8414b964adaSGeorge Wilson 
8423d7072f8Seschrock /*
8433d7072f8Seschrock  * Sysevent payload members.  ZFS will generate the following sysevents with the
8443d7072f8Seschrock  * given payloads:
8453d7072f8Seschrock  *
8463d7072f8Seschrock  *	ESC_ZFS_RESILVER_START
8473d7072f8Seschrock  *	ESC_ZFS_RESILVER_END
8483d7072f8Seschrock  *	ESC_ZFS_POOL_DESTROY
849e9103aaeSGarrett D'Amore  *	ESC_ZFS_POOL_REGUID
8503d7072f8Seschrock  *
8513d7072f8Seschrock  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
8523d7072f8Seschrock  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
8533d7072f8Seschrock  *
8543d7072f8Seschrock  *	ESC_ZFS_VDEV_REMOVE
8553d7072f8Seschrock  *	ESC_ZFS_VDEV_CLEAR
8563d7072f8Seschrock  *	ESC_ZFS_VDEV_CHECK
8573d7072f8Seschrock  *
8583d7072f8Seschrock  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
8593d7072f8Seschrock  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
8603d7072f8Seschrock  *		ZFS_EV_VDEV_PATH	DATA_TYPE_STRING	(optional)
8613d7072f8Seschrock  *		ZFS_EV_VDEV_GUID	DATA_TYPE_UINT64
8623d7072f8Seschrock  */
8633d7072f8Seschrock #define	ZFS_EV_POOL_NAME	"pool_name"
8643d7072f8Seschrock #define	ZFS_EV_POOL_GUID	"pool_guid"
8653d7072f8Seschrock #define	ZFS_EV_VDEV_PATH	"vdev_path"
8663d7072f8Seschrock #define	ZFS_EV_VDEV_GUID	"vdev_guid"
8673d7072f8Seschrock 
868088f3894Sahrens /*
869088f3894Sahrens  * Note: This is encoded on-disk, so new events must be added to the
870088f3894Sahrens  * end, and unused events can not be removed.  Be sure to edit
8718f18d1faSGeorge Wilson  * libzfs_pool.c: hist_event_table[].
872088f3894Sahrens  */
873ecd6cf80Smarks typedef enum history_internal_events {
874ecd6cf80Smarks 	LOG_NO_EVENT = 0,
875ecd6cf80Smarks 	LOG_POOL_CREATE,
876ecd6cf80Smarks 	LOG_POOL_VDEV_ADD,
877ecd6cf80Smarks 	LOG_POOL_REMOVE,
878ecd6cf80Smarks 	LOG_POOL_DESTROY,
879ecd6cf80Smarks 	LOG_POOL_EXPORT,
880ecd6cf80Smarks 	LOG_POOL_IMPORT,
881ecd6cf80Smarks 	LOG_POOL_VDEV_ATTACH,
882ecd6cf80Smarks 	LOG_POOL_VDEV_REPLACE,
883ecd6cf80Smarks 	LOG_POOL_VDEV_DETACH,
884ecd6cf80Smarks 	LOG_POOL_VDEV_ONLINE,
885ecd6cf80Smarks 	LOG_POOL_VDEV_OFFLINE,
886ecd6cf80Smarks 	LOG_POOL_UPGRADE,
887ecd6cf80Smarks 	LOG_POOL_CLEAR,
8883f9d6ad7SLin Ling 	LOG_POOL_SCAN,
889ecd6cf80Smarks 	LOG_POOL_PROPSET,
890ecd6cf80Smarks 	LOG_DS_CREATE,
891ecd6cf80Smarks 	LOG_DS_CLONE,
892ecd6cf80Smarks 	LOG_DS_DESTROY,
893ecd6cf80Smarks 	LOG_DS_DESTROY_BEGIN,
894ecd6cf80Smarks 	LOG_DS_INHERIT,
895ecd6cf80Smarks 	LOG_DS_PROPSET,
896ecd6cf80Smarks 	LOG_DS_QUOTA,
897ecd6cf80Smarks 	LOG_DS_PERM_UPDATE,
898ecd6cf80Smarks 	LOG_DS_PERM_REMOVE,
899ecd6cf80Smarks 	LOG_DS_PERM_WHO_REMOVE,
900ecd6cf80Smarks 	LOG_DS_PROMOTE,
901ecd6cf80Smarks 	LOG_DS_RECEIVE,
902ecd6cf80Smarks 	LOG_DS_RENAME,
903ecd6cf80Smarks 	LOG_DS_RESERVATION,
904ecd6cf80Smarks 	LOG_DS_REPLAY_INC_SYNC,
905ecd6cf80Smarks 	LOG_DS_REPLAY_FULL_SYNC,
906ecd6cf80Smarks 	LOG_DS_ROLLBACK,
907ecd6cf80Smarks 	LOG_DS_SNAPSHOT,
908e7437265Sahrens 	LOG_DS_UPGRADE,
909a9799022Sck 	LOG_DS_REFQUOTA,
910a9799022Sck 	LOG_DS_REFRESERV,
9113f9d6ad7SLin Ling 	LOG_POOL_SCAN_DONE,
912842727c2SChris Kirby 	LOG_DS_USER_HOLD,
913842727c2SChris Kirby 	LOG_DS_USER_RELEASE,
9141195e687SMark J Musante 	LOG_POOL_SPLIT,
915ecd6cf80Smarks 	LOG_END
916ecd6cf80Smarks } history_internal_events_t;
917ecd6cf80Smarks 
918fa9e4066Sahrens #ifdef	__cplusplus
919fa9e4066Sahrens }
920fa9e4066Sahrens #endif
921fa9e4066Sahrens 
922fa9e4066Sahrens #endif	/* _SYS_FS_ZFS_H */
923