xref: /illumos-gate/usr/src/uts/common/sys/fs/zfs.h (revision 99e6869ff7df020d73a2a959aafdf73d3e7b31ca)
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  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_FS_ZFS_H
27 #define	_SYS_FS_ZFS_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef	__cplusplus
32 extern "C" {
33 #endif
34 
35 /*
36  * Types and constants shared between userland and the kernel.
37  */
38 
39 /*
40  * Each dataset can be one of the following types.  These constants can be
41  * combined into masks that can be passed to various functions.
42  */
43 typedef enum {
44 	ZFS_TYPE_FILESYSTEM	= 0x1,
45 	ZFS_TYPE_SNAPSHOT	= 0x2,
46 	ZFS_TYPE_VOLUME		= 0x4,
47 	ZFS_TYPE_POOL		= 0x8
48 } zfs_type_t;
49 
50 #define	ZFS_TYPE_DATASET	\
51 	(ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
52 
53 /*
54  * Dataset properties are identified by these constants and must be added to
55  * the end of this list to ensure that external consumers are not affected
56  * by the change. If you make any changes to this list, be sure to update
57  * the property table in usr/src/common/zfs/zfs_prop.c.
58  */
59 typedef enum {
60 	ZFS_PROP_TYPE,
61 	ZFS_PROP_CREATION,
62 	ZFS_PROP_USED,
63 	ZFS_PROP_AVAILABLE,
64 	ZFS_PROP_REFERENCED,
65 	ZFS_PROP_COMPRESSRATIO,
66 	ZFS_PROP_MOUNTED,
67 	ZFS_PROP_ORIGIN,
68 	ZFS_PROP_QUOTA,
69 	ZFS_PROP_RESERVATION,
70 	ZFS_PROP_VOLSIZE,
71 	ZFS_PROP_VOLBLOCKSIZE,
72 	ZFS_PROP_RECORDSIZE,
73 	ZFS_PROP_MOUNTPOINT,
74 	ZFS_PROP_SHARENFS,
75 	ZFS_PROP_CHECKSUM,
76 	ZFS_PROP_COMPRESSION,
77 	ZFS_PROP_ATIME,
78 	ZFS_PROP_DEVICES,
79 	ZFS_PROP_EXEC,
80 	ZFS_PROP_SETUID,
81 	ZFS_PROP_READONLY,
82 	ZFS_PROP_ZONED,
83 	ZFS_PROP_SNAPDIR,
84 	ZFS_PROP_ACLMODE,
85 	ZFS_PROP_ACLINHERIT,
86 	ZFS_PROP_CREATETXG,		/* not exposed to the user */
87 	ZFS_PROP_NAME,			/* not exposed to the user */
88 	ZFS_PROP_CANMOUNT,
89 	ZFS_PROP_SHAREISCSI,
90 	ZFS_PROP_ISCSIOPTIONS,		/* not exposed to the user */
91 	ZFS_PROP_XATTR,
92 	ZFS_PROP_NUMCLONES,		/* not exposed to the user */
93 	ZFS_PROP_COPIES,
94 	ZFS_PROP_VERSION,
95 	ZFS_PROP_UTF8ONLY,
96 	ZFS_PROP_NORMALIZE,
97 	ZFS_PROP_CASE,
98 	ZFS_PROP_VSCAN,
99 	ZFS_PROP_NBMAND,
100 	ZFS_PROP_SHARESMB,
101 	ZFS_PROP_REFQUOTA,
102 	ZFS_PROP_REFRESERVATION,
103 	ZFS_PROP_GUID,
104 	ZFS_PROP_PRIMARYCACHE,
105 	ZFS_PROP_SECONDARYCACHE,
106 	ZFS_NUM_PROPS
107 } zfs_prop_t;
108 
109 /*
110  * Pool properties are identified by these constants and must be added to the
111  * end of this list to ensure that external conumsers are not affected
112  * by the change. If you make any changes to this list, be sure to update
113  * the property table in usr/src/common/zfs/zpool_prop.c.
114  */
115 typedef enum {
116 	ZPOOL_PROP_NAME,
117 	ZPOOL_PROP_SIZE,
118 	ZPOOL_PROP_USED,
119 	ZPOOL_PROP_AVAILABLE,
120 	ZPOOL_PROP_CAPACITY,
121 	ZPOOL_PROP_ALTROOT,
122 	ZPOOL_PROP_HEALTH,
123 	ZPOOL_PROP_GUID,
124 	ZPOOL_PROP_VERSION,
125 	ZPOOL_PROP_BOOTFS,
126 	ZPOOL_PROP_DELEGATION,
127 	ZPOOL_PROP_AUTOREPLACE,
128 	ZPOOL_PROP_CACHEFILE,
129 	ZPOOL_PROP_FAILUREMODE,
130 	ZPOOL_NUM_PROPS
131 } zpool_prop_t;
132 
133 #define	ZPROP_CONT		-2
134 #define	ZPROP_INVAL		-1
135 
136 #define	ZPROP_VALUE		"value"
137 #define	ZPROP_SOURCE		"source"
138 
139 typedef enum {
140 	ZPROP_SRC_NONE = 0x1,
141 	ZPROP_SRC_DEFAULT = 0x2,
142 	ZPROP_SRC_TEMPORARY = 0x4,
143 	ZPROP_SRC_LOCAL = 0x8,
144 	ZPROP_SRC_INHERITED = 0x10
145 } zprop_source_t;
146 
147 #define	ZPROP_SRC_ALL	0x1f
148 
149 typedef int (*zprop_func)(int, void *);
150 
151 /*
152  * Properties to be set on the root file system of a new pool
153  * are stuffed into their own nvlist, which is then included in
154  * the properties nvlist with the pool properties.
155  */
156 #define	ZPOOL_ROOTFS_PROPS	"root-props-nvl"
157 
158 /*
159  * Dataset property functions shared between libzfs and kernel.
160  */
161 const char *zfs_prop_default_string(zfs_prop_t);
162 uint64_t zfs_prop_default_numeric(zfs_prop_t);
163 boolean_t zfs_prop_readonly(zfs_prop_t);
164 boolean_t zfs_prop_inheritable(zfs_prop_t);
165 boolean_t zfs_prop_setonce(zfs_prop_t);
166 const char *zfs_prop_to_name(zfs_prop_t);
167 zfs_prop_t zfs_name_to_prop(const char *);
168 boolean_t zfs_prop_user(const char *);
169 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
170 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
171 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
172 
173 /*
174  * Pool property functions shared between libzfs and kernel.
175  */
176 zpool_prop_t zpool_name_to_prop(const char *);
177 const char *zpool_prop_to_name(zpool_prop_t);
178 const char *zpool_prop_default_string(zpool_prop_t);
179 uint64_t zpool_prop_default_numeric(zpool_prop_t);
180 boolean_t zpool_prop_readonly(zpool_prop_t);
181 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
182 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
183 
184 /*
185  * Definitions for the Delegation.
186  */
187 typedef enum {
188 	ZFS_DELEG_WHO_UNKNOWN = 0,
189 	ZFS_DELEG_USER = 'u',
190 	ZFS_DELEG_USER_SETS = 'U',
191 	ZFS_DELEG_GROUP = 'g',
192 	ZFS_DELEG_GROUP_SETS = 'G',
193 	ZFS_DELEG_EVERYONE = 'e',
194 	ZFS_DELEG_EVERYONE_SETS = 'E',
195 	ZFS_DELEG_CREATE = 'c',
196 	ZFS_DELEG_CREATE_SETS = 'C',
197 	ZFS_DELEG_NAMED_SET = 's',
198 	ZFS_DELEG_NAMED_SET_SETS = 'S'
199 } zfs_deleg_who_type_t;
200 
201 typedef enum {
202 	ZFS_DELEG_NONE = 0,
203 	ZFS_DELEG_PERM_LOCAL = 1,
204 	ZFS_DELEG_PERM_DESCENDENT = 2,
205 	ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
206 	ZFS_DELEG_PERM_CREATE = 4
207 } zfs_deleg_inherit_t;
208 
209 #define	ZFS_DELEG_PERM_UID	"uid"
210 #define	ZFS_DELEG_PERM_GID	"gid"
211 #define	ZFS_DELEG_PERM_GROUPS	"groups"
212 
213 typedef enum {
214 	ZFS_CANMOUNT_OFF = 0,
215 	ZFS_CANMOUNT_ON = 1,
216 	ZFS_CANMOUNT_NOAUTO = 2
217 } zfs_canmount_type_t;
218 
219 typedef enum zfs_share_op {
220 	ZFS_SHARE_NFS = 0,
221 	ZFS_UNSHARE_NFS = 1,
222 	ZFS_SHARE_SMB = 2,
223 	ZFS_UNSHARE_SMB = 3
224 } zfs_share_op_t;
225 
226 typedef enum zfs_cache_type {
227 	ZFS_CACHE_NONE = 0,
228 	ZFS_CACHE_METADATA = 1,
229 	ZFS_CACHE_ALL = 2
230 } zfs_cache_type_t;
231 
232 
233 /*
234  * On-disk version number.
235  */
236 #define	SPA_VERSION_1			1ULL
237 #define	SPA_VERSION_2			2ULL
238 #define	SPA_VERSION_3			3ULL
239 #define	SPA_VERSION_4			4ULL
240 #define	SPA_VERSION_5			5ULL
241 #define	SPA_VERSION_6			6ULL
242 #define	SPA_VERSION_7			7ULL
243 #define	SPA_VERSION_8			8ULL
244 #define	SPA_VERSION_9			9ULL
245 #define	SPA_VERSION_10			10ULL
246 #define	SPA_VERSION_11			11ULL
247 #define	SPA_VERSION_12			12ULL
248 /*
249  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
250  * format change. Go to usr/src/grub/grub-0.95/stage2/{zfs-include/, fsys_zfs*},
251  * and do the appropriate changes.
252  */
253 #define	SPA_VERSION			SPA_VERSION_12
254 #define	SPA_VERSION_STRING		"12"
255 
256 /*
257  * Symbolic names for the changes that caused a SPA_VERSION switch.
258  * Used in the code when checking for presence or absence of a feature.
259  * Feel free to define multiple symbolic names for each version if there
260  * were multiple changes to on-disk structures during that version.
261  *
262  * NOTE: When checking the current SPA_VERSION in your code, be sure
263  *       to use spa_version() since it reports the version of the
264  *       last synced uberblock.  Checking the in-flight version can
265  *       be dangerous in some cases.
266  */
267 #define	SPA_VERSION_INITIAL		SPA_VERSION_1
268 #define	SPA_VERSION_DITTO_BLOCKS	SPA_VERSION_2
269 #define	SPA_VERSION_SPARES		SPA_VERSION_3
270 #define	SPA_VERSION_RAID6		SPA_VERSION_3
271 #define	SPA_VERSION_BPLIST_ACCOUNT	SPA_VERSION_3
272 #define	SPA_VERSION_RAIDZ_DEFLATE	SPA_VERSION_3
273 #define	SPA_VERSION_DNODE_BYTES		SPA_VERSION_3
274 #define	SPA_VERSION_ZPOOL_HISTORY	SPA_VERSION_4
275 #define	SPA_VERSION_GZIP_COMPRESSION	SPA_VERSION_5
276 #define	SPA_VERSION_BOOTFS		SPA_VERSION_6
277 #define	SPA_VERSION_SLOGS		SPA_VERSION_7
278 #define	SPA_VERSION_DELEGATED_PERMS	SPA_VERSION_8
279 #define	SPA_VERSION_FUID		SPA_VERSION_9
280 #define	SPA_VERSION_REFRESERVATION	SPA_VERSION_9
281 #define	SPA_VERSION_REFQUOTA		SPA_VERSION_9
282 #define	SPA_VERSION_UNIQUE_ACCURATE	SPA_VERSION_9
283 #define	SPA_VERSION_L2CACHE		SPA_VERSION_10
284 #define	SPA_VERSION_NEXT_CLONES		SPA_VERSION_11
285 #define	SPA_VERSION_ORIGIN		SPA_VERSION_11
286 #define	SPA_VERSION_DSL_SCRUB		SPA_VERSION_11
287 #define	SPA_VERSION_SNAP_PROPS		SPA_VERSION_12
288 
289 /*
290  * ZPL version - rev'd whenever an incompatible on-disk format change
291  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
292  * also update the version_table[] and help message in zfs_prop.c.
293  *
294  * When changing, be sure to teach GRUB how to read the new format!
295  * See usr/src/grub/grub-0.95/stage2/{zfs-include/,fsys_zfs*}
296  */
297 #define	ZPL_VERSION_1			1ULL
298 #define	ZPL_VERSION_2			2ULL
299 #define	ZPL_VERSION_3			3ULL
300 #define	ZPL_VERSION			ZPL_VERSION_3
301 #define	ZPL_VERSION_STRING		"3"
302 
303 #define	ZPL_VERSION_INITIAL		ZPL_VERSION_1
304 #define	ZPL_VERSION_DIRENT_TYPE		ZPL_VERSION_2
305 #define	ZPL_VERSION_FUID		ZPL_VERSION_3
306 #define	ZPL_VERSION_NORMALIZATION	ZPL_VERSION_3
307 #define	ZPL_VERSION_SYSATTR		ZPL_VERSION_3
308 
309 /*
310  * The following are configuration names used in the nvlist describing a pool's
311  * configuration.
312  */
313 #define	ZPOOL_CONFIG_VERSION		"version"
314 #define	ZPOOL_CONFIG_POOL_NAME		"name"
315 #define	ZPOOL_CONFIG_POOL_STATE		"state"
316 #define	ZPOOL_CONFIG_POOL_TXG		"txg"
317 #define	ZPOOL_CONFIG_POOL_GUID		"pool_guid"
318 #define	ZPOOL_CONFIG_CREATE_TXG		"create_txg"
319 #define	ZPOOL_CONFIG_TOP_GUID		"top_guid"
320 #define	ZPOOL_CONFIG_VDEV_TREE		"vdev_tree"
321 #define	ZPOOL_CONFIG_TYPE		"type"
322 #define	ZPOOL_CONFIG_CHILDREN		"children"
323 #define	ZPOOL_CONFIG_ID			"id"
324 #define	ZPOOL_CONFIG_GUID		"guid"
325 #define	ZPOOL_CONFIG_PATH		"path"
326 #define	ZPOOL_CONFIG_DEVID		"devid"
327 #define	ZPOOL_CONFIG_METASLAB_ARRAY	"metaslab_array"
328 #define	ZPOOL_CONFIG_METASLAB_SHIFT	"metaslab_shift"
329 #define	ZPOOL_CONFIG_ASHIFT		"ashift"
330 #define	ZPOOL_CONFIG_ASIZE		"asize"
331 #define	ZPOOL_CONFIG_DTL		"DTL"
332 #define	ZPOOL_CONFIG_STATS		"stats"
333 #define	ZPOOL_CONFIG_WHOLE_DISK		"whole_disk"
334 #define	ZPOOL_CONFIG_ERRCOUNT		"error_count"
335 #define	ZPOOL_CONFIG_NOT_PRESENT	"not_present"
336 #define	ZPOOL_CONFIG_SPARES		"spares"
337 #define	ZPOOL_CONFIG_IS_SPARE		"is_spare"
338 #define	ZPOOL_CONFIG_NPARITY		"nparity"
339 #define	ZPOOL_CONFIG_HOSTID		"hostid"
340 #define	ZPOOL_CONFIG_HOSTNAME		"hostname"
341 #define	ZPOOL_CONFIG_UNSPARE		"unspare"
342 #define	ZPOOL_CONFIG_PHYS_PATH		"phys_path"
343 #define	ZPOOL_CONFIG_IS_LOG		"is_log"
344 #define	ZPOOL_CONFIG_L2CACHE		"l2cache"
345 #define	ZPOOL_CONFIG_TIMESTAMP		"timestamp"	/* not stored on disk */
346 #define	ZPOOL_CONFIG_BOOTFS		"bootfs"	/* not stored on disk */
347 /*
348  * The persistent vdev state is stored as separate values rather than a single
349  * 'vdev_state' entry.  This is because a device can be in multiple states, such
350  * as offline and degraded.
351  */
352 #define	ZPOOL_CONFIG_OFFLINE		"offline"
353 #define	ZPOOL_CONFIG_FAULTED		"faulted"
354 #define	ZPOOL_CONFIG_DEGRADED		"degraded"
355 #define	ZPOOL_CONFIG_REMOVED		"removed"
356 
357 #define	VDEV_TYPE_ROOT			"root"
358 #define	VDEV_TYPE_MIRROR		"mirror"
359 #define	VDEV_TYPE_REPLACING		"replacing"
360 #define	VDEV_TYPE_RAIDZ			"raidz"
361 #define	VDEV_TYPE_DISK			"disk"
362 #define	VDEV_TYPE_FILE			"file"
363 #define	VDEV_TYPE_MISSING		"missing"
364 #define	VDEV_TYPE_SPARE			"spare"
365 #define	VDEV_TYPE_LOG			"log"
366 #define	VDEV_TYPE_L2CACHE		"l2cache"
367 
368 /*
369  * This is needed in userland to report the minimum necessary device size.
370  */
371 #define	SPA_MINDEVSIZE		(64ULL << 20)
372 
373 /*
374  * The location of the pool configuration repository, shared between kernel and
375  * userland.
376  */
377 #define	ZPOOL_CACHE		"/etc/zfs/zpool.cache"
378 
379 /*
380  * vdev states are ordered from least to most healthy.
381  * A vdev that's CANT_OPEN or below is considered unusable.
382  */
383 typedef enum vdev_state {
384 	VDEV_STATE_UNKNOWN = 0,	/* Uninitialized vdev			*/
385 	VDEV_STATE_CLOSED,	/* Not currently open			*/
386 	VDEV_STATE_OFFLINE,	/* Not allowed to open			*/
387 	VDEV_STATE_REMOVED,	/* Explicitly removed from system	*/
388 	VDEV_STATE_CANT_OPEN,	/* Tried to open, but failed		*/
389 	VDEV_STATE_FAULTED,	/* External request to fault device	*/
390 	VDEV_STATE_DEGRADED,	/* Replicated vdev with unhealthy kids	*/
391 	VDEV_STATE_HEALTHY	/* Presumed good			*/
392 } vdev_state_t;
393 
394 #define	VDEV_STATE_ONLINE	VDEV_STATE_HEALTHY
395 
396 /*
397  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
398  * of the vdev stats structure uses these constants to distinguish why.
399  */
400 typedef enum vdev_aux {
401 	VDEV_AUX_NONE,		/* no error				*/
402 	VDEV_AUX_OPEN_FAILED,	/* ldi_open_*() or vn_open() failed	*/
403 	VDEV_AUX_CORRUPT_DATA,	/* bad label or disk contents		*/
404 	VDEV_AUX_NO_REPLICAS,	/* insufficient number of replicas	*/
405 	VDEV_AUX_BAD_GUID_SUM,	/* vdev guid sum doesn't match		*/
406 	VDEV_AUX_TOO_SMALL,	/* vdev size is too small		*/
407 	VDEV_AUX_BAD_LABEL,	/* the label is OK but invalid		*/
408 	VDEV_AUX_VERSION_NEWER,	/* on-disk version is too new		*/
409 	VDEV_AUX_VERSION_OLDER,	/* on-disk version is too old		*/
410 	VDEV_AUX_SPARED,	/* hot spare used in another pool	*/
411 	VDEV_AUX_ERR_EXCEEDED,	/* too many errors			*/
412 	VDEV_AUX_IO_FAILURE	/* experienced I/O failure		*/
413 } vdev_aux_t;
414 
415 /*
416  * pool state.  The following states are written to disk as part of the normal
417  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
418  * states are software abstractions used at various levels to communicate
419  * pool state.
420  */
421 typedef enum pool_state {
422 	POOL_STATE_ACTIVE = 0,		/* In active use		*/
423 	POOL_STATE_EXPORTED,		/* Explicitly exported		*/
424 	POOL_STATE_DESTROYED,		/* Explicitly destroyed		*/
425 	POOL_STATE_SPARE,		/* Reserved for hot spare use	*/
426 	POOL_STATE_L2CACHE,		/* Level 2 ARC device		*/
427 	POOL_STATE_UNINITIALIZED,	/* Internal spa_t state		*/
428 	POOL_STATE_IO_FAILURE,		/* Internal pool state		*/
429 	POOL_STATE_UNAVAIL,		/* Internal libzfs state	*/
430 	POOL_STATE_POTENTIALLY_ACTIVE	/* Internal libzfs state	*/
431 } pool_state_t;
432 
433 /*
434  * Scrub types.
435  */
436 typedef enum pool_scrub_type {
437 	POOL_SCRUB_NONE,
438 	POOL_SCRUB_RESILVER,
439 	POOL_SCRUB_EVERYTHING,
440 	POOL_SCRUB_TYPES
441 } pool_scrub_type_t;
442 
443 /*
444  * ZIO types.  Needed to interpret vdev statistics below.
445  */
446 typedef enum zio_type {
447 	ZIO_TYPE_NULL = 0,
448 	ZIO_TYPE_READ,
449 	ZIO_TYPE_WRITE,
450 	ZIO_TYPE_FREE,
451 	ZIO_TYPE_CLAIM,
452 	ZIO_TYPE_IOCTL,
453 	ZIO_TYPES
454 } zio_type_t;
455 
456 /*
457  * Vdev statistics.  Note: all fields should be 64-bit because this
458  * is passed between kernel and userland as an nvlist uint64 array.
459  */
460 typedef struct vdev_stat {
461 	hrtime_t	vs_timestamp;		/* time since vdev load	*/
462 	uint64_t	vs_state;		/* vdev state		*/
463 	uint64_t	vs_aux;			/* see vdev_aux_t	*/
464 	uint64_t	vs_alloc;		/* space allocated	*/
465 	uint64_t	vs_space;		/* total capacity	*/
466 	uint64_t	vs_dspace;		/* deflated capacity	*/
467 	uint64_t	vs_rsize;		/* replaceable dev size */
468 	uint64_t	vs_ops[ZIO_TYPES];	/* operation count	*/
469 	uint64_t	vs_bytes[ZIO_TYPES];	/* bytes read/written	*/
470 	uint64_t	vs_read_errors;		/* read errors		*/
471 	uint64_t	vs_write_errors;	/* write errors		*/
472 	uint64_t	vs_checksum_errors;	/* checksum errors	*/
473 	uint64_t	vs_self_healed;		/* self-healed bytes	*/
474 	uint64_t	vs_scrub_type;		/* pool_scrub_type_t	*/
475 	uint64_t	vs_scrub_complete;	/* completed?		*/
476 	uint64_t	vs_scrub_examined;	/* bytes examined; top	*/
477 	uint64_t	vs_scrub_repaired;	/* bytes repaired; leaf	*/
478 	uint64_t	vs_scrub_errors;	/* errors during scrub	*/
479 	uint64_t	vs_scrub_start;		/* UTC scrub start time	*/
480 	uint64_t	vs_scrub_end;		/* UTC scrub end time	*/
481 } vdev_stat_t;
482 
483 #define	ZVOL_DRIVER	"zvol"
484 #define	ZFS_DRIVER	"zfs"
485 #define	ZFS_DEV		"/dev/zfs"
486 
487 /*
488  * zvol paths.  Irritatingly, the devfsadm interfaces want all these
489  * paths without the /dev prefix, but for some things, we want the
490  * /dev prefix.  Below are the names without /dev.
491  */
492 #define	ZVOL_DEV_DIR	"zvol/dsk"
493 #define	ZVOL_RDEV_DIR	"zvol/rdsk"
494 
495 /*
496  * And here are the things we need with /dev, etc. in front of them.
497  */
498 #define	ZVOL_PSEUDO_DEV		"/devices/pseudo/zvol@0:"
499 #define	ZVOL_FULL_DEV_DIR	"/dev/" ZVOL_DEV_DIR "/"
500 
501 #define	ZVOL_PROP_NAME		"name"
502 
503 /*
504  * /dev/zfs ioctl numbers.
505  */
506 #define	ZFS_IOC		('Z' << 8)
507 
508 typedef enum zfs_ioc {
509 	ZFS_IOC_POOL_CREATE = ZFS_IOC,
510 	ZFS_IOC_POOL_DESTROY,
511 	ZFS_IOC_POOL_IMPORT,
512 	ZFS_IOC_POOL_EXPORT,
513 	ZFS_IOC_POOL_CONFIGS,
514 	ZFS_IOC_POOL_STATS,
515 	ZFS_IOC_POOL_TRYIMPORT,
516 	ZFS_IOC_POOL_SCRUB,
517 	ZFS_IOC_POOL_FREEZE,
518 	ZFS_IOC_POOL_UPGRADE,
519 	ZFS_IOC_POOL_GET_HISTORY,
520 	ZFS_IOC_VDEV_ADD,
521 	ZFS_IOC_VDEV_REMOVE,
522 	ZFS_IOC_VDEV_SET_STATE,
523 	ZFS_IOC_VDEV_ATTACH,
524 	ZFS_IOC_VDEV_DETACH,
525 	ZFS_IOC_VDEV_SETPATH,
526 	ZFS_IOC_OBJSET_STATS,
527 	ZFS_IOC_OBJSET_ZPLPROPS,
528 	ZFS_IOC_DATASET_LIST_NEXT,
529 	ZFS_IOC_SNAPSHOT_LIST_NEXT,
530 	ZFS_IOC_SET_PROP,
531 	ZFS_IOC_CREATE_MINOR,
532 	ZFS_IOC_REMOVE_MINOR,
533 	ZFS_IOC_CREATE,
534 	ZFS_IOC_DESTROY,
535 	ZFS_IOC_ROLLBACK,
536 	ZFS_IOC_RENAME,
537 	ZFS_IOC_RECV,
538 	ZFS_IOC_SEND,
539 	ZFS_IOC_INJECT_FAULT,
540 	ZFS_IOC_CLEAR_FAULT,
541 	ZFS_IOC_INJECT_LIST_NEXT,
542 	ZFS_IOC_ERROR_LOG,
543 	ZFS_IOC_CLEAR,
544 	ZFS_IOC_PROMOTE,
545 	ZFS_IOC_DESTROY_SNAPS,
546 	ZFS_IOC_SNAPSHOT,
547 	ZFS_IOC_DSOBJ_TO_DSNAME,
548 	ZFS_IOC_OBJ_TO_PATH,
549 	ZFS_IOC_POOL_SET_PROPS,
550 	ZFS_IOC_POOL_GET_PROPS,
551 	ZFS_IOC_SET_FSACL,
552 	ZFS_IOC_GET_FSACL,
553 	ZFS_IOC_ISCSI_PERM_CHECK,
554 	ZFS_IOC_SHARE,
555 	ZFS_IOC_INHERIT_PROP
556 } zfs_ioc_t;
557 
558 /*
559  * Internal SPA load state.  Used by FMA diagnosis engine.
560  */
561 typedef enum {
562 	SPA_LOAD_NONE,		/* no load in progress */
563 	SPA_LOAD_OPEN,		/* normal open */
564 	SPA_LOAD_IMPORT,	/* import in progress */
565 	SPA_LOAD_TRYIMPORT	/* tryimport in progress */
566 } spa_load_state_t;
567 
568 /*
569  * Bookmark name values.
570  */
571 #define	ZPOOL_ERR_LIST		"error list"
572 #define	ZPOOL_ERR_DATASET	"dataset"
573 #define	ZPOOL_ERR_OBJECT	"object"
574 
575 #define	HIS_MAX_RECORD_LEN	(MAXPATHLEN + MAXPATHLEN + 1)
576 
577 /*
578  * The following are names used in the nvlist describing
579  * the pool's history log.
580  */
581 #define	ZPOOL_HIST_RECORD	"history record"
582 #define	ZPOOL_HIST_TIME		"history time"
583 #define	ZPOOL_HIST_CMD		"history command"
584 #define	ZPOOL_HIST_WHO		"history who"
585 #define	ZPOOL_HIST_ZONE		"history zone"
586 #define	ZPOOL_HIST_HOST		"history hostname"
587 #define	ZPOOL_HIST_TXG		"history txg"
588 #define	ZPOOL_HIST_INT_EVENT	"history internal event"
589 #define	ZPOOL_HIST_INT_STR	"history internal str"
590 
591 /*
592  * Flags for ZFS_IOC_VDEV_SET_STATE
593  */
594 #define	ZFS_ONLINE_CHECKREMOVE	0x1
595 #define	ZFS_ONLINE_UNSPARE	0x2
596 #define	ZFS_ONLINE_FORCEFAULT	0x4
597 #define	ZFS_OFFLINE_TEMPORARY	0x1
598 
599 /*
600  * Sysevent payload members.  ZFS will generate the following sysevents with the
601  * given payloads:
602  *
603  *	ESC_ZFS_RESILVER_START
604  *	ESC_ZFS_RESILVER_END
605  *	ESC_ZFS_POOL_DESTROY
606  *
607  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
608  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
609  *
610  *	ESC_ZFS_VDEV_REMOVE
611  *	ESC_ZFS_VDEV_CLEAR
612  *	ESC_ZFS_VDEV_CHECK
613  *
614  *		ZFS_EV_POOL_NAME	DATA_TYPE_STRING
615  *		ZFS_EV_POOL_GUID	DATA_TYPE_UINT64
616  *		ZFS_EV_VDEV_PATH	DATA_TYPE_STRING	(optional)
617  *		ZFS_EV_VDEV_GUID	DATA_TYPE_UINT64
618  */
619 #define	ZFS_EV_POOL_NAME	"pool_name"
620 #define	ZFS_EV_POOL_GUID	"pool_guid"
621 #define	ZFS_EV_VDEV_PATH	"vdev_path"
622 #define	ZFS_EV_VDEV_GUID	"vdev_guid"
623 
624 /*
625  * Note: This is encoded on-disk, so new events must be added to the
626  * end, and unused events can not be removed.  Be sure to edit
627  * zpool_main.c: hist_event_table[].
628  */
629 typedef enum history_internal_events {
630 	LOG_NO_EVENT = 0,
631 	LOG_POOL_CREATE,
632 	LOG_POOL_VDEV_ADD,
633 	LOG_POOL_REMOVE,
634 	LOG_POOL_DESTROY,
635 	LOG_POOL_EXPORT,
636 	LOG_POOL_IMPORT,
637 	LOG_POOL_VDEV_ATTACH,
638 	LOG_POOL_VDEV_REPLACE,
639 	LOG_POOL_VDEV_DETACH,
640 	LOG_POOL_VDEV_ONLINE,
641 	LOG_POOL_VDEV_OFFLINE,
642 	LOG_POOL_UPGRADE,
643 	LOG_POOL_CLEAR,
644 	LOG_POOL_SCRUB,
645 	LOG_POOL_PROPSET,
646 	LOG_DS_CREATE,
647 	LOG_DS_CLONE,
648 	LOG_DS_DESTROY,
649 	LOG_DS_DESTROY_BEGIN,
650 	LOG_DS_INHERIT,
651 	LOG_DS_PROPSET,
652 	LOG_DS_QUOTA,
653 	LOG_DS_PERM_UPDATE,
654 	LOG_DS_PERM_REMOVE,
655 	LOG_DS_PERM_WHO_REMOVE,
656 	LOG_DS_PROMOTE,
657 	LOG_DS_RECEIVE,
658 	LOG_DS_RENAME,
659 	LOG_DS_RESERVATION,
660 	LOG_DS_REPLAY_INC_SYNC,
661 	LOG_DS_REPLAY_FULL_SYNC,
662 	LOG_DS_ROLLBACK,
663 	LOG_DS_SNAPSHOT,
664 	LOG_DS_UPGRADE,
665 	LOG_DS_REFQUOTA,
666 	LOG_DS_REFRESERV,
667 	LOG_POOL_SCRUB_DONE,
668 	LOG_END
669 } history_internal_events_t;
670 
671 #ifdef	__cplusplus
672 }
673 #endif
674 
675 #endif	/* _SYS_FS_ZFS_H */
676