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