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 */ 21fa9e4066Sahrens /* 22*a227b7f4Shs * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23fa9e4066Sahrens * Use is subject to license terms. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 26fa9e4066Sahrens #ifndef _SYS_FS_ZFS_H 27fa9e4066Sahrens #define _SYS_FS_ZFS_H 28fa9e4066Sahrens 29fa9e4066Sahrens #pragma ident "%Z%%M% %I% %E% SMI" 30fa9e4066Sahrens 31fa9e4066Sahrens #ifdef __cplusplus 32fa9e4066Sahrens extern "C" { 33fa9e4066Sahrens #endif 34fa9e4066Sahrens 35fa9e4066Sahrens /* 36fa9e4066Sahrens * Types and constants shared between userland and the kernel. 37fa9e4066Sahrens */ 38fa9e4066Sahrens 39fa9e4066Sahrens /* 40fa9e4066Sahrens * Each dataset can be one of the following types. These constants can be 41fa9e4066Sahrens * combined into masks that can be passed to various functions. 42fa9e4066Sahrens */ 43fa9e4066Sahrens typedef enum { 44fa9e4066Sahrens ZFS_TYPE_FILESYSTEM = 0x1, 45fa9e4066Sahrens ZFS_TYPE_SNAPSHOT = 0x2, 46b1b8ab34Slling ZFS_TYPE_VOLUME = 0x4, 47b1b8ab34Slling ZFS_TYPE_POOL = 0x8 48fa9e4066Sahrens } zfs_type_t; 49fa9e4066Sahrens 50990b4856Slling #define ZFS_TYPE_DATASET \ 51fa9e4066Sahrens (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 52fa9e4066Sahrens 53fa9e4066Sahrens /* 54990b4856Slling * Dataset properties are identified by these constants and must be added to 55990b4856Slling * the end of this list to ensure that external consumers are not affected 56990b4856Slling * by the change. If you make any changes to this list, be sure to update 5766e2aaccSgw * the property table in usr/src/common/zfs/zfs_prop.c. 58fa9e4066Sahrens */ 59fa9e4066Sahrens typedef enum { 60fa9e4066Sahrens ZFS_PROP_TYPE, 61fa9e4066Sahrens ZFS_PROP_CREATION, 62fa9e4066Sahrens ZFS_PROP_USED, 63fa9e4066Sahrens ZFS_PROP_AVAILABLE, 64fa9e4066Sahrens ZFS_PROP_REFERENCED, 65fa9e4066Sahrens ZFS_PROP_COMPRESSRATIO, 66fa9e4066Sahrens ZFS_PROP_MOUNTED, 67fa9e4066Sahrens ZFS_PROP_ORIGIN, 68fa9e4066Sahrens ZFS_PROP_QUOTA, 69fa9e4066Sahrens ZFS_PROP_RESERVATION, 70fa9e4066Sahrens ZFS_PROP_VOLSIZE, 71fa9e4066Sahrens ZFS_PROP_VOLBLOCKSIZE, 72fa9e4066Sahrens ZFS_PROP_RECORDSIZE, 73fa9e4066Sahrens ZFS_PROP_MOUNTPOINT, 74fa9e4066Sahrens ZFS_PROP_SHARENFS, 75fa9e4066Sahrens ZFS_PROP_CHECKSUM, 76fa9e4066Sahrens ZFS_PROP_COMPRESSION, 77fa9e4066Sahrens ZFS_PROP_ATIME, 78fa9e4066Sahrens ZFS_PROP_DEVICES, 79fa9e4066Sahrens ZFS_PROP_EXEC, 80fa9e4066Sahrens ZFS_PROP_SETUID, 81fa9e4066Sahrens ZFS_PROP_READONLY, 82fa9e4066Sahrens ZFS_PROP_ZONED, 83fa9e4066Sahrens ZFS_PROP_SNAPDIR, 84fa9e4066Sahrens ZFS_PROP_ACLMODE, 85fa9e4066Sahrens ZFS_PROP_ACLINHERIT, 8666e2aaccSgw ZFS_PROP_CREATETXG, /* not exposed to the user */ 8766e2aaccSgw ZFS_PROP_NAME, /* not exposed to the user */ 88e9dbad6fSeschrock ZFS_PROP_CANMOUNT, 8966e2aaccSgw ZFS_PROP_SHAREISCSI, 9066e2aaccSgw ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 917b55fa8eSck ZFS_PROP_XATTR, 92d0ad202dSahrens ZFS_PROP_NUMCLONES, /* not exposed to the user */ 93b1b8ab34Slling ZFS_PROP_COPIES, 94e7437265Sahrens ZFS_PROP_VERSION, 95da6c28aaSamw ZFS_PROP_UTF8ONLY, 96da6c28aaSamw ZFS_PROP_NORMALIZE, 97da6c28aaSamw ZFS_PROP_CASE, 98da6c28aaSamw ZFS_PROP_VSCAN, 99da6c28aaSamw ZFS_PROP_NBMAND, 100da6c28aaSamw ZFS_PROP_SHARESMB, 101a9799022Sck ZFS_PROP_REFQUOTA, 102a9799022Sck ZFS_PROP_REFRESERVATION, 10391ebeef5Sahrens ZFS_NUM_PROPS 104fa9e4066Sahrens } zfs_prop_t; 105fa9e4066Sahrens 106990b4856Slling /* 107990b4856Slling * Pool properties are identified by these constants and must be added to the 108990b4856Slling * end of this list to ensure that external conumsers are not affected 109990b4856Slling * by the change. If you make any changes to this list, be sure to update 110990b4856Slling * the property table in usr/src/common/zfs/zpool_prop.c. 111990b4856Slling */ 112990b4856Slling typedef enum { 113990b4856Slling ZPOOL_PROP_NAME, 114990b4856Slling ZPOOL_PROP_SIZE, 115990b4856Slling ZPOOL_PROP_USED, 116990b4856Slling ZPOOL_PROP_AVAILABLE, 117990b4856Slling ZPOOL_PROP_CAPACITY, 118990b4856Slling ZPOOL_PROP_ALTROOT, 119990b4856Slling ZPOOL_PROP_HEALTH, 120990b4856Slling ZPOOL_PROP_GUID, 121990b4856Slling ZPOOL_PROP_VERSION, 122990b4856Slling ZPOOL_PROP_BOOTFS, 123990b4856Slling ZPOOL_PROP_DELEGATION, 124990b4856Slling ZPOOL_PROP_AUTOREPLACE, 1252f8aaab3Seschrock ZPOOL_PROP_CACHEFILE, 1260a4e9518Sgw ZPOOL_PROP_FAILUREMODE, 127990b4856Slling ZPOOL_NUM_PROPS 128990b4856Slling } zpool_prop_t; 129b1b8ab34Slling 130990b4856Slling #define ZPROP_CONT -2 131990b4856Slling #define ZPROP_INVAL -1 1323d7072f8Seschrock 133990b4856Slling #define ZPROP_VALUE "value" 134990b4856Slling #define ZPROP_SOURCE "source" 1357f7322feSeschrock 136b1b8ab34Slling typedef enum { 137990b4856Slling ZPROP_SRC_NONE = 0x1, 138990b4856Slling ZPROP_SRC_DEFAULT = 0x2, 139990b4856Slling ZPROP_SRC_TEMPORARY = 0x4, 140990b4856Slling ZPROP_SRC_LOCAL = 0x8, 141990b4856Slling ZPROP_SRC_INHERITED = 0x10 142990b4856Slling } zprop_source_t; 143990b4856Slling 144990b4856Slling #define ZPROP_SRC_ALL 0x1f 145990b4856Slling 146990b4856Slling typedef int (*zprop_func)(int, void *); 147990b4856Slling 148990b4856Slling /* 149990b4856Slling * Dataset property functions shared between libzfs and kernel. 150990b4856Slling */ 151990b4856Slling const char *zfs_prop_default_string(zfs_prop_t); 152990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t); 153990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t); 154990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t); 155da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t); 156990b4856Slling const char *zfs_prop_to_name(zfs_prop_t); 157990b4856Slling zfs_prop_t zfs_name_to_prop(const char *); 158990b4856Slling boolean_t zfs_prop_user(const char *); 159990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 160990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 161da6c28aaSamw int zfs_prop_valid_for_type(int, zfs_type_t); 162b1b8ab34Slling 163990b4856Slling /* 164990b4856Slling * Pool property functions shared between libzfs and kernel. 165990b4856Slling */ 166990b4856Slling zpool_prop_t zpool_name_to_prop(const char *); 167990b4856Slling const char *zpool_prop_to_name(zpool_prop_t); 168990b4856Slling const char *zpool_prop_default_string(zpool_prop_t); 169990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t); 170990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t); 171990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 172990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 173b1b8ab34Slling 174990b4856Slling /* 175990b4856Slling * Definitions for the Delegation. 176990b4856Slling */ 177ecd6cf80Smarks typedef enum { 178ecd6cf80Smarks ZFS_DELEG_WHO_UNKNOWN = 0, 179ecd6cf80Smarks ZFS_DELEG_USER = 'u', 180ecd6cf80Smarks ZFS_DELEG_USER_SETS = 'U', 181ecd6cf80Smarks ZFS_DELEG_GROUP = 'g', 182ecd6cf80Smarks ZFS_DELEG_GROUP_SETS = 'G', 183ecd6cf80Smarks ZFS_DELEG_EVERYONE = 'e', 184ecd6cf80Smarks ZFS_DELEG_EVERYONE_SETS = 'E', 185ecd6cf80Smarks ZFS_DELEG_CREATE = 'c', 186ecd6cf80Smarks ZFS_DELEG_CREATE_SETS = 'C', 187ecd6cf80Smarks ZFS_DELEG_NAMED_SET = 's', 188ecd6cf80Smarks ZFS_DELEG_NAMED_SET_SETS = 'S' 189ecd6cf80Smarks } zfs_deleg_who_type_t; 190ecd6cf80Smarks 191ecd6cf80Smarks typedef enum { 192ecd6cf80Smarks ZFS_DELEG_NONE = 0, 193ecd6cf80Smarks ZFS_DELEG_PERM_LOCAL = 1, 194ecd6cf80Smarks ZFS_DELEG_PERM_DESCENDENT = 2, 195ecd6cf80Smarks ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 196ecd6cf80Smarks ZFS_DELEG_PERM_CREATE = 4 197ecd6cf80Smarks } zfs_deleg_inherit_t; 198ecd6cf80Smarks 199ecd6cf80Smarks #define ZFS_DELEG_PERM_UID "uid" 200ecd6cf80Smarks #define ZFS_DELEG_PERM_GID "gid" 201ecd6cf80Smarks #define ZFS_DELEG_PERM_GROUPS "groups" 202ecd6cf80Smarks 203*a227b7f4Shs typedef enum { 204*a227b7f4Shs ZFS_CANMOUNT_OFF = 0, 205*a227b7f4Shs ZFS_CANMOUNT_ON = 1, 206*a227b7f4Shs ZFS_CANMOUNT_NOAUTO = 2 207*a227b7f4Shs } zfs_canmount_type_t; 208*a227b7f4Shs 209da6c28aaSamw typedef enum zfs_share_op { 210da6c28aaSamw ZFS_SHARE_NFS = 0, 211da6c28aaSamw ZFS_UNSHARE_NFS = 1, 212da6c28aaSamw ZFS_SHARE_SMB = 2, 213da6c28aaSamw ZFS_UNSHARE_SMB = 3 214da6c28aaSamw } zfs_share_op_t; 215da6c28aaSamw 216eaca9bbdSeschrock /* 21799653d4eSeschrock * On-disk version number. 218eaca9bbdSeschrock */ 219e7437265Sahrens #define SPA_VERSION_1 1ULL 220e7437265Sahrens #define SPA_VERSION_2 2ULL 221e7437265Sahrens #define SPA_VERSION_3 3ULL 222e7437265Sahrens #define SPA_VERSION_4 4ULL 223e7437265Sahrens #define SPA_VERSION_5 5ULL 224e7437265Sahrens #define SPA_VERSION_6 6ULL 225e7437265Sahrens #define SPA_VERSION_7 7ULL 226e7437265Sahrens #define SPA_VERSION_8 8ULL 227da6c28aaSamw #define SPA_VERSION_9 9ULL 228fa94a07fSbrendan #define SPA_VERSION_10 10ULL 229da6c28aaSamw 230b1b8ab34Slling /* 231e7437265Sahrens * When bumping up SPA_VERSION, make sure GRUB ZFS understand the on-disk 232b1b8ab34Slling * format change. Go to usr/src/grub/grub-0.95/stage2/{zfs-include/, fsys_zfs*}, 233b1b8ab34Slling * and do the appropriate changes. 234b1b8ab34Slling */ 235fa94a07fSbrendan #define SPA_VERSION SPA_VERSION_10 236fa94a07fSbrendan #define SPA_VERSION_STRING "10" 23744cd46caSbillm 23844cd46caSbillm /* 239e7437265Sahrens * Symbolic names for the changes that caused a SPA_VERSION switch. 24044cd46caSbillm * Used in the code when checking for presence or absence of a feature. 24144cd46caSbillm * Feel free to define multiple symbolic names for each version if there 24244cd46caSbillm * were multiple changes to on-disk structures during that version. 24344cd46caSbillm * 244e7437265Sahrens * NOTE: When checking the current SPA_VERSION in your code, be sure 24544cd46caSbillm * to use spa_version() since it reports the version of the 24644cd46caSbillm * last synced uberblock. Checking the in-flight version can 24744cd46caSbillm * be dangerous in some cases. 24844cd46caSbillm */ 249e7437265Sahrens #define SPA_VERSION_INITIAL SPA_VERSION_1 250e7437265Sahrens #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 251e7437265Sahrens #define SPA_VERSION_SPARES SPA_VERSION_3 252e7437265Sahrens #define SPA_VERSION_RAID6 SPA_VERSION_3 253e7437265Sahrens #define SPA_VERSION_BPLIST_ACCOUNT SPA_VERSION_3 254e7437265Sahrens #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 255e7437265Sahrens #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 256e7437265Sahrens #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 257e7437265Sahrens #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 258e7437265Sahrens #define SPA_VERSION_BOOTFS SPA_VERSION_6 259990b4856Slling #define SPA_VERSION_SLOGS SPA_VERSION_7 260990b4856Slling #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 261da6c28aaSamw #define SPA_VERSION_FUID SPA_VERSION_9 262a9799022Sck #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 263a9799022Sck #define SPA_VERSION_REFQUOTA SPA_VERSION_9 264a9799022Sck #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 265fa94a07fSbrendan #define SPA_VERSION_L2CACHE SPA_VERSION_10 266e7437265Sahrens 267e7437265Sahrens /* 268e7437265Sahrens * ZPL version - rev'd whenever an incompatible on-disk format change 269e7437265Sahrens * occurs. This is independent of SPA/DMU/ZAP versioning. You must 270e7437265Sahrens * also update the version_table[] and help message in zfs_prop.c. 271e7437265Sahrens * 272e7437265Sahrens * When changing, be sure to teach GRUB how to read the new format! 273e7437265Sahrens * See usr/src/grub/grub-0.95/stage2/{zfs-include/,fsys_zfs*} 274e7437265Sahrens */ 275e7437265Sahrens #define ZPL_VERSION_1 1ULL 276e7437265Sahrens #define ZPL_VERSION_2 2ULL 277da6c28aaSamw #define ZPL_VERSION_3 3ULL 278da6c28aaSamw #define ZPL_VERSION ZPL_VERSION_3 279da6c28aaSamw #define ZPL_VERSION_STRING "3" 280e7437265Sahrens 281e7437265Sahrens #define ZPL_VERSION_INITIAL ZPL_VERSION_1 282e7437265Sahrens #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 283da6c28aaSamw #define ZPL_VERSION_FUID ZPL_VERSION_3 284de8267e0Stimh #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 285da6c28aaSamw #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 286eaca9bbdSeschrock 287fa9e4066Sahrens /* 288fa9e4066Sahrens * The following are configuration names used in the nvlist describing a pool's 289fa9e4066Sahrens * configuration. 290fa9e4066Sahrens */ 291fa9e4066Sahrens #define ZPOOL_CONFIG_VERSION "version" 292fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_NAME "name" 293fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_STATE "state" 294fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_TXG "txg" 295fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 296fa9e4066Sahrens #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 297fa9e4066Sahrens #define ZPOOL_CONFIG_TOP_GUID "top_guid" 298fa9e4066Sahrens #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 299fa9e4066Sahrens #define ZPOOL_CONFIG_TYPE "type" 300fa9e4066Sahrens #define ZPOOL_CONFIG_CHILDREN "children" 301fa9e4066Sahrens #define ZPOOL_CONFIG_ID "id" 302fa9e4066Sahrens #define ZPOOL_CONFIG_GUID "guid" 303fa9e4066Sahrens #define ZPOOL_CONFIG_PATH "path" 304fa9e4066Sahrens #define ZPOOL_CONFIG_DEVID "devid" 305fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 306fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 307fa9e4066Sahrens #define ZPOOL_CONFIG_ASHIFT "ashift" 308fa9e4066Sahrens #define ZPOOL_CONFIG_ASIZE "asize" 309fa9e4066Sahrens #define ZPOOL_CONFIG_DTL "DTL" 310fa9e4066Sahrens #define ZPOOL_CONFIG_STATS "stats" 311afefbcddSeschrock #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 312ea8dc4b6Seschrock #define ZPOOL_CONFIG_ERRCOUNT "error_count" 313ea8dc4b6Seschrock #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 31499653d4eSeschrock #define ZPOOL_CONFIG_SPARES "spares" 31599653d4eSeschrock #define ZPOOL_CONFIG_IS_SPARE "is_spare" 31699653d4eSeschrock #define ZPOOL_CONFIG_NPARITY "nparity" 31795173954Sek #define ZPOOL_CONFIG_HOSTID "hostid" 31895173954Sek #define ZPOOL_CONFIG_HOSTNAME "hostname" 31995173954Sek #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 3203d7072f8Seschrock #define ZPOOL_CONFIG_UNSPARE "unspare" 3213d7072f8Seschrock #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 3228654d025Sperrin #define ZPOOL_CONFIG_IS_LOG "is_log" 323fa94a07fSbrendan #define ZPOOL_CONFIG_L2CACHE "l2cache" 3243d7072f8Seschrock /* 3253d7072f8Seschrock * The persistent vdev state is stored as separate values rather than a single 3263d7072f8Seschrock * 'vdev_state' entry. This is because a device can be in multiple states, such 3273d7072f8Seschrock * as offline and degraded. 3283d7072f8Seschrock */ 3293d7072f8Seschrock #define ZPOOL_CONFIG_OFFLINE "offline" 3303d7072f8Seschrock #define ZPOOL_CONFIG_FAULTED "faulted" 3313d7072f8Seschrock #define ZPOOL_CONFIG_DEGRADED "degraded" 3323d7072f8Seschrock #define ZPOOL_CONFIG_REMOVED "removed" 333fa9e4066Sahrens 334fa9e4066Sahrens #define VDEV_TYPE_ROOT "root" 335fa9e4066Sahrens #define VDEV_TYPE_MIRROR "mirror" 336fa9e4066Sahrens #define VDEV_TYPE_REPLACING "replacing" 337fa9e4066Sahrens #define VDEV_TYPE_RAIDZ "raidz" 338fa9e4066Sahrens #define VDEV_TYPE_DISK "disk" 339fa9e4066Sahrens #define VDEV_TYPE_FILE "file" 340fa9e4066Sahrens #define VDEV_TYPE_MISSING "missing" 34199653d4eSeschrock #define VDEV_TYPE_SPARE "spare" 3428654d025Sperrin #define VDEV_TYPE_LOG "log" 343fa94a07fSbrendan #define VDEV_TYPE_L2CACHE "l2cache" 344fa9e4066Sahrens 345fa9e4066Sahrens /* 346fa9e4066Sahrens * This is needed in userland to report the minimum necessary device size. 347fa9e4066Sahrens */ 348fa9e4066Sahrens #define SPA_MINDEVSIZE (64ULL << 20) 349fa9e4066Sahrens 350fa9e4066Sahrens /* 351fa9e4066Sahrens * The location of the pool configuration repository, shared between kernel and 352fa9e4066Sahrens * userland. 353fa9e4066Sahrens */ 354fa9e4066Sahrens #define ZPOOL_CACHE_DIR "/etc/zfs" 355fa9e4066Sahrens #define ZPOOL_CACHE_FILE "zpool.cache" 356fa9e4066Sahrens #define ZPOOL_CACHE_TMP ".zpool.cache" 357fa9e4066Sahrens 358fa9e4066Sahrens #define ZPOOL_CACHE ZPOOL_CACHE_DIR "/" ZPOOL_CACHE_FILE 359fa9e4066Sahrens 360fa9e4066Sahrens /* 361fa9e4066Sahrens * vdev states are ordered from least to most healthy. 362fa9e4066Sahrens * A vdev that's CANT_OPEN or below is considered unusable. 363fa9e4066Sahrens */ 364fa9e4066Sahrens typedef enum vdev_state { 365fa9e4066Sahrens VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 366fa9e4066Sahrens VDEV_STATE_CLOSED, /* Not currently open */ 367fa9e4066Sahrens VDEV_STATE_OFFLINE, /* Not allowed to open */ 3683d7072f8Seschrock VDEV_STATE_REMOVED, /* Explicitly removed from system */ 369fa9e4066Sahrens VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 3703d7072f8Seschrock VDEV_STATE_FAULTED, /* External request to fault device */ 371fa9e4066Sahrens VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 372fa9e4066Sahrens VDEV_STATE_HEALTHY /* Presumed good */ 373fa9e4066Sahrens } vdev_state_t; 374fa9e4066Sahrens 3753d7072f8Seschrock #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 3763d7072f8Seschrock 377fa9e4066Sahrens /* 378fa9e4066Sahrens * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 379fa9e4066Sahrens * of the vdev stats structure uses these constants to distinguish why. 380fa9e4066Sahrens */ 381fa9e4066Sahrens typedef enum vdev_aux { 382fa9e4066Sahrens VDEV_AUX_NONE, /* no error */ 383fa9e4066Sahrens VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 384fa9e4066Sahrens VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 385fa9e4066Sahrens VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 386fa9e4066Sahrens VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 387fa9e4066Sahrens VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 388eaca9bbdSeschrock VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 389eaca9bbdSeschrock VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 39099653d4eSeschrock VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 3913d7072f8Seschrock VDEV_AUX_SPARED, /* hot spare used in another pool */ 3923d7072f8Seschrock VDEV_AUX_ERR_EXCEEDED /* too many errors */ 393fa9e4066Sahrens } vdev_aux_t; 394fa9e4066Sahrens 395fa9e4066Sahrens /* 39646a2abf2Seschrock * pool state. The following states are written to disk as part of the normal 397fa94a07fSbrendan * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 398fa94a07fSbrendan * states are software abstractions used at various levels to communicate 399fa94a07fSbrendan * pool state. 400fa9e4066Sahrens */ 401fa9e4066Sahrens typedef enum pool_state { 402fa9e4066Sahrens POOL_STATE_ACTIVE = 0, /* In active use */ 403fa9e4066Sahrens POOL_STATE_EXPORTED, /* Explicitly exported */ 404fa9e4066Sahrens POOL_STATE_DESTROYED, /* Explicitly destroyed */ 40599653d4eSeschrock POOL_STATE_SPARE, /* Reserved for hot spare use */ 406fa94a07fSbrendan POOL_STATE_L2CACHE, /* Level 2 ARC device */ 407fa9e4066Sahrens POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 4080a4e9518Sgw POOL_STATE_IO_FAILURE, /* Internal pool state */ 40946a2abf2Seschrock POOL_STATE_UNAVAIL, /* Internal libzfs state */ 41046a2abf2Seschrock POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 411fa9e4066Sahrens } pool_state_t; 412fa9e4066Sahrens 413fa9e4066Sahrens /* 414fa9e4066Sahrens * Scrub types. 415fa9e4066Sahrens */ 416fa9e4066Sahrens typedef enum pool_scrub_type { 417fa9e4066Sahrens POOL_SCRUB_NONE, 418fa9e4066Sahrens POOL_SCRUB_RESILVER, 419fa9e4066Sahrens POOL_SCRUB_EVERYTHING, 420fa9e4066Sahrens POOL_SCRUB_TYPES 421fa9e4066Sahrens } pool_scrub_type_t; 422fa9e4066Sahrens 423fa9e4066Sahrens /* 424fa9e4066Sahrens * ZIO types. Needed to interpret vdev statistics below. 425fa9e4066Sahrens */ 426fa9e4066Sahrens typedef enum zio_type { 427fa9e4066Sahrens ZIO_TYPE_NULL = 0, 428fa9e4066Sahrens ZIO_TYPE_READ, 429fa9e4066Sahrens ZIO_TYPE_WRITE, 430fa9e4066Sahrens ZIO_TYPE_FREE, 431fa9e4066Sahrens ZIO_TYPE_CLAIM, 432fa9e4066Sahrens ZIO_TYPE_IOCTL, 433fa9e4066Sahrens ZIO_TYPES 434fa9e4066Sahrens } zio_type_t; 435fa9e4066Sahrens 436fa9e4066Sahrens /* 437fa9e4066Sahrens * Vdev statistics. Note: all fields should be 64-bit because this 438fa9e4066Sahrens * is passed between kernel and userland as an nvlist uint64 array. 439fa9e4066Sahrens */ 440fa9e4066Sahrens typedef struct vdev_stat { 441fa9e4066Sahrens hrtime_t vs_timestamp; /* time since vdev load */ 442fa9e4066Sahrens uint64_t vs_state; /* vdev state */ 443fa9e4066Sahrens uint64_t vs_aux; /* see vdev_aux_t */ 444fa9e4066Sahrens uint64_t vs_alloc; /* space allocated */ 445fa9e4066Sahrens uint64_t vs_space; /* total capacity */ 44699653d4eSeschrock uint64_t vs_dspace; /* deflated capacity */ 4472a79c5feSlling uint64_t vs_rsize; /* replaceable dev size */ 448fa9e4066Sahrens uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 449fa9e4066Sahrens uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 450fa9e4066Sahrens uint64_t vs_read_errors; /* read errors */ 451fa9e4066Sahrens uint64_t vs_write_errors; /* write errors */ 452fa9e4066Sahrens uint64_t vs_checksum_errors; /* checksum errors */ 453fa9e4066Sahrens uint64_t vs_self_healed; /* self-healed bytes */ 454fa9e4066Sahrens uint64_t vs_scrub_type; /* pool_scrub_type_t */ 455fa9e4066Sahrens uint64_t vs_scrub_complete; /* completed? */ 456fa9e4066Sahrens uint64_t vs_scrub_examined; /* bytes examined; top */ 457fa9e4066Sahrens uint64_t vs_scrub_repaired; /* bytes repaired; leaf */ 458fa9e4066Sahrens uint64_t vs_scrub_errors; /* errors during scrub */ 459fa9e4066Sahrens uint64_t vs_scrub_start; /* UTC scrub start time */ 460fa9e4066Sahrens uint64_t vs_scrub_end; /* UTC scrub end time */ 461fa9e4066Sahrens } vdev_stat_t; 462fa9e4066Sahrens 463fa9e4066Sahrens #define ZFS_DRIVER "zfs" 464fa9e4066Sahrens #define ZFS_DEV "/dev/zfs" 465fa9e4066Sahrens 466fa9e4066Sahrens /* 467fa9e4066Sahrens * zvol paths. Irritatingly, the devfsadm interfaces want all these 468fa9e4066Sahrens * paths without the /dev prefix, but for some things, we want the 469fa9e4066Sahrens * /dev prefix. Below are the names without /dev. 470fa9e4066Sahrens */ 471fa9e4066Sahrens #define ZVOL_DEV_DIR "zvol/dsk" 472fa9e4066Sahrens #define ZVOL_RDEV_DIR "zvol/rdsk" 473fa9e4066Sahrens 474fa9e4066Sahrens /* 475fa9e4066Sahrens * And here are the things we need with /dev, etc. in front of them. 476fa9e4066Sahrens */ 477fa9e4066Sahrens #define ZVOL_PSEUDO_DEV "/devices/pseudo/zvol@0:" 478fa9e4066Sahrens #define ZVOL_FULL_DEV_DIR "/dev/" ZVOL_DEV_DIR 479fa9e4066Sahrens 480fa9e4066Sahrens #define ZVOL_PROP_NAME "name" 481fa9e4066Sahrens 482fa9e4066Sahrens /* 483fa9e4066Sahrens * /dev/zfs ioctl numbers. 484fa9e4066Sahrens */ 485fa9e4066Sahrens #define ZFS_IOC ('Z' << 8) 486fa9e4066Sahrens 487fa9e4066Sahrens typedef enum zfs_ioc { 488fa9e4066Sahrens ZFS_IOC_POOL_CREATE = ZFS_IOC, 489fa9e4066Sahrens ZFS_IOC_POOL_DESTROY, 490fa9e4066Sahrens ZFS_IOC_POOL_IMPORT, 491fa9e4066Sahrens ZFS_IOC_POOL_EXPORT, 492fa9e4066Sahrens ZFS_IOC_POOL_CONFIGS, 493fa9e4066Sahrens ZFS_IOC_POOL_STATS, 494fa9e4066Sahrens ZFS_IOC_POOL_TRYIMPORT, 495fa9e4066Sahrens ZFS_IOC_POOL_SCRUB, 496fa9e4066Sahrens ZFS_IOC_POOL_FREEZE, 497eaca9bbdSeschrock ZFS_IOC_POOL_UPGRADE, 49806eeb2adSek ZFS_IOC_POOL_GET_HISTORY, 499fa9e4066Sahrens ZFS_IOC_VDEV_ADD, 500fa9e4066Sahrens ZFS_IOC_VDEV_REMOVE, 5013d7072f8Seschrock ZFS_IOC_VDEV_SET_STATE, 502fa9e4066Sahrens ZFS_IOC_VDEV_ATTACH, 503fa9e4066Sahrens ZFS_IOC_VDEV_DETACH, 504c67d9675Seschrock ZFS_IOC_VDEV_SETPATH, 505fa9e4066Sahrens ZFS_IOC_OBJSET_STATS, 506de8267e0Stimh ZFS_IOC_OBJSET_ZPLPROPS, 507fa9e4066Sahrens ZFS_IOC_DATASET_LIST_NEXT, 508fa9e4066Sahrens ZFS_IOC_SNAPSHOT_LIST_NEXT, 509fa9e4066Sahrens ZFS_IOC_SET_PROP, 510fa9e4066Sahrens ZFS_IOC_CREATE_MINOR, 511fa9e4066Sahrens ZFS_IOC_REMOVE_MINOR, 512fa9e4066Sahrens ZFS_IOC_CREATE, 513fa9e4066Sahrens ZFS_IOC_DESTROY, 514fa9e4066Sahrens ZFS_IOC_ROLLBACK, 515fa9e4066Sahrens ZFS_IOC_RENAME, 5163cb34c60Sahrens ZFS_IOC_RECV, 5173cb34c60Sahrens ZFS_IOC_SEND, 518ea8dc4b6Seschrock ZFS_IOC_INJECT_FAULT, 519ea8dc4b6Seschrock ZFS_IOC_CLEAR_FAULT, 520ea8dc4b6Seschrock ZFS_IOC_INJECT_LIST_NEXT, 521ea8dc4b6Seschrock ZFS_IOC_ERROR_LOG, 522ea8dc4b6Seschrock ZFS_IOC_CLEAR, 5231d452cf5Sahrens ZFS_IOC_PROMOTE, 5241d452cf5Sahrens ZFS_IOC_DESTROY_SNAPS, 52555434c77Sek ZFS_IOC_SNAPSHOT, 52655434c77Sek ZFS_IOC_DSOBJ_TO_DSNAME, 527b1b8ab34Slling ZFS_IOC_OBJ_TO_PATH, 528b1b8ab34Slling ZFS_IOC_POOL_SET_PROPS, 529ecd6cf80Smarks ZFS_IOC_POOL_GET_PROPS, 530ecd6cf80Smarks ZFS_IOC_SET_FSACL, 531ecd6cf80Smarks ZFS_IOC_GET_FSACL, 532ecd6cf80Smarks ZFS_IOC_ISCSI_PERM_CHECK, 533e45ce728Sahrens ZFS_IOC_SHARE, 534e45ce728Sahrens ZFS_IOC_INHERIT_PROP 535fa9e4066Sahrens } zfs_ioc_t; 536fa9e4066Sahrens 537ea8dc4b6Seschrock /* 538ea8dc4b6Seschrock * Internal SPA load state. Used by FMA diagnosis engine. 539ea8dc4b6Seschrock */ 540ea8dc4b6Seschrock typedef enum { 541ea8dc4b6Seschrock SPA_LOAD_NONE, /* no load in progress */ 542ea8dc4b6Seschrock SPA_LOAD_OPEN, /* normal open */ 543ea8dc4b6Seschrock SPA_LOAD_IMPORT, /* import in progress */ 544ea8dc4b6Seschrock SPA_LOAD_TRYIMPORT /* tryimport in progress */ 545ea8dc4b6Seschrock } spa_load_state_t; 546ea8dc4b6Seschrock 547e9dbad6fSeschrock /* 548e9dbad6fSeschrock * Bookmark name values. 549e9dbad6fSeschrock */ 55055434c77Sek #define ZPOOL_ERR_LIST "error list" 551e9dbad6fSeschrock #define ZPOOL_ERR_DATASET "dataset" 552e9dbad6fSeschrock #define ZPOOL_ERR_OBJECT "object" 553e9dbad6fSeschrock 55406eeb2adSek #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 55506eeb2adSek 55606eeb2adSek /* 55706eeb2adSek * The following are names used in the nvlist describing 55806eeb2adSek * the pool's history log. 55906eeb2adSek */ 56006eeb2adSek #define ZPOOL_HIST_RECORD "history record" 56106eeb2adSek #define ZPOOL_HIST_TIME "history time" 56206eeb2adSek #define ZPOOL_HIST_CMD "history command" 563ecd6cf80Smarks #define ZPOOL_HIST_WHO "history who" 564ecd6cf80Smarks #define ZPOOL_HIST_ZONE "history zone" 565ecd6cf80Smarks #define ZPOOL_HIST_HOST "history hostname" 566ecd6cf80Smarks #define ZPOOL_HIST_TXG "history txg" 567ecd6cf80Smarks #define ZPOOL_HIST_INT_EVENT "history internal event" 568ecd6cf80Smarks #define ZPOOL_HIST_INT_STR "history internal str" 56906eeb2adSek 5703d7072f8Seschrock /* 5713d7072f8Seschrock * Flags for ZFS_IOC_VDEV_SET_STATE 5723d7072f8Seschrock */ 5733d7072f8Seschrock #define ZFS_ONLINE_CHECKREMOVE 0x1 5743d7072f8Seschrock #define ZFS_ONLINE_UNSPARE 0x2 5753d7072f8Seschrock #define ZFS_ONLINE_FORCEFAULT 0x4 5763d7072f8Seschrock #define ZFS_OFFLINE_TEMPORARY 0x1 5773d7072f8Seschrock 5783d7072f8Seschrock /* 5793d7072f8Seschrock * Sysevent payload members. ZFS will generate the following sysevents with the 5803d7072f8Seschrock * given payloads: 5813d7072f8Seschrock * 5823d7072f8Seschrock * ESC_ZFS_RESILVER_START 5833d7072f8Seschrock * ESC_ZFS_RESILVER_END 5843d7072f8Seschrock * ESC_ZFS_POOL_DESTROY 5853d7072f8Seschrock * 5863d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 5873d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 5883d7072f8Seschrock * 5893d7072f8Seschrock * ESC_ZFS_VDEV_REMOVE 5903d7072f8Seschrock * ESC_ZFS_VDEV_CLEAR 5913d7072f8Seschrock * ESC_ZFS_VDEV_CHECK 5923d7072f8Seschrock * 5933d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 5943d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 5953d7072f8Seschrock * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 5963d7072f8Seschrock * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 5973d7072f8Seschrock */ 5983d7072f8Seschrock #define ZFS_EV_POOL_NAME "pool_name" 5993d7072f8Seschrock #define ZFS_EV_POOL_GUID "pool_guid" 6003d7072f8Seschrock #define ZFS_EV_VDEV_PATH "vdev_path" 6013d7072f8Seschrock #define ZFS_EV_VDEV_GUID "vdev_guid" 6023d7072f8Seschrock 603ecd6cf80Smarks typedef enum history_internal_events { 604ecd6cf80Smarks LOG_NO_EVENT = 0, 605ecd6cf80Smarks LOG_POOL_CREATE, 606ecd6cf80Smarks LOG_POOL_VDEV_ADD, 607ecd6cf80Smarks LOG_POOL_REMOVE, 608ecd6cf80Smarks LOG_POOL_DESTROY, 609ecd6cf80Smarks LOG_POOL_EXPORT, 610ecd6cf80Smarks LOG_POOL_IMPORT, 611ecd6cf80Smarks LOG_POOL_VDEV_ATTACH, 612ecd6cf80Smarks LOG_POOL_VDEV_REPLACE, 613ecd6cf80Smarks LOG_POOL_VDEV_DETACH, 614ecd6cf80Smarks LOG_POOL_VDEV_ONLINE, 615ecd6cf80Smarks LOG_POOL_VDEV_OFFLINE, 616ecd6cf80Smarks LOG_POOL_UPGRADE, 617ecd6cf80Smarks LOG_POOL_CLEAR, 618ecd6cf80Smarks LOG_POOL_SCRUB, 619ecd6cf80Smarks LOG_POOL_PROPSET, 620ecd6cf80Smarks LOG_DS_CREATE, 621ecd6cf80Smarks LOG_DS_CLONE, 622ecd6cf80Smarks LOG_DS_DESTROY, 623ecd6cf80Smarks LOG_DS_DESTROY_BEGIN, 624ecd6cf80Smarks LOG_DS_INHERIT, 625ecd6cf80Smarks LOG_DS_PROPSET, 626ecd6cf80Smarks LOG_DS_QUOTA, 627ecd6cf80Smarks LOG_DS_PERM_UPDATE, 628ecd6cf80Smarks LOG_DS_PERM_REMOVE, 629ecd6cf80Smarks LOG_DS_PERM_WHO_REMOVE, 630ecd6cf80Smarks LOG_DS_PROMOTE, 631ecd6cf80Smarks LOG_DS_RECEIVE, 632ecd6cf80Smarks LOG_DS_RENAME, 633ecd6cf80Smarks LOG_DS_RESERVATION, 634ecd6cf80Smarks LOG_DS_REPLAY_INC_SYNC, 635ecd6cf80Smarks LOG_DS_REPLAY_FULL_SYNC, 636ecd6cf80Smarks LOG_DS_ROLLBACK, 637ecd6cf80Smarks LOG_DS_SNAPSHOT, 638e7437265Sahrens LOG_DS_UPGRADE, 639a9799022Sck LOG_DS_REFQUOTA, 640a9799022Sck LOG_DS_REFRESERV, 641ecd6cf80Smarks LOG_END 642ecd6cf80Smarks } history_internal_events_t; 643ecd6cf80Smarks 644fa9e4066Sahrens #ifdef __cplusplus 645fa9e4066Sahrens } 646fa9e4066Sahrens #endif 647fa9e4066Sahrens 648fa9e4066Sahrens #endif /* _SYS_FS_ZFS_H */ 649