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 /* 22a227b7f4Shs * 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 #ifdef __cplusplus 30fa9e4066Sahrens extern "C" { 31fa9e4066Sahrens #endif 32fa9e4066Sahrens 33fa9e4066Sahrens /* 34fa9e4066Sahrens * Types and constants shared between userland and the kernel. 35fa9e4066Sahrens */ 36fa9e4066Sahrens 37fa9e4066Sahrens /* 38fa9e4066Sahrens * Each dataset can be one of the following types. These constants can be 39fa9e4066Sahrens * combined into masks that can be passed to various functions. 40fa9e4066Sahrens */ 41fa9e4066Sahrens typedef enum { 42fa9e4066Sahrens ZFS_TYPE_FILESYSTEM = 0x1, 43fa9e4066Sahrens ZFS_TYPE_SNAPSHOT = 0x2, 44b1b8ab34Slling ZFS_TYPE_VOLUME = 0x4, 45b1b8ab34Slling ZFS_TYPE_POOL = 0x8 46fa9e4066Sahrens } zfs_type_t; 47fa9e4066Sahrens 48990b4856Slling #define ZFS_TYPE_DATASET \ 49fa9e4066Sahrens (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 50fa9e4066Sahrens 51fa9e4066Sahrens /* 52990b4856Slling * Dataset properties are identified by these constants and must be added to 53990b4856Slling * the end of this list to ensure that external consumers are not affected 54990b4856Slling * by the change. If you make any changes to this list, be sure to update 5566e2aaccSgw * the property table in usr/src/common/zfs/zfs_prop.c. 56fa9e4066Sahrens */ 57fa9e4066Sahrens typedef enum { 58fa9e4066Sahrens ZFS_PROP_TYPE, 59fa9e4066Sahrens ZFS_PROP_CREATION, 60fa9e4066Sahrens ZFS_PROP_USED, 61fa9e4066Sahrens ZFS_PROP_AVAILABLE, 62fa9e4066Sahrens ZFS_PROP_REFERENCED, 63fa9e4066Sahrens ZFS_PROP_COMPRESSRATIO, 64fa9e4066Sahrens ZFS_PROP_MOUNTED, 65fa9e4066Sahrens ZFS_PROP_ORIGIN, 66fa9e4066Sahrens ZFS_PROP_QUOTA, 67fa9e4066Sahrens ZFS_PROP_RESERVATION, 68fa9e4066Sahrens ZFS_PROP_VOLSIZE, 69fa9e4066Sahrens ZFS_PROP_VOLBLOCKSIZE, 70fa9e4066Sahrens ZFS_PROP_RECORDSIZE, 71fa9e4066Sahrens ZFS_PROP_MOUNTPOINT, 72fa9e4066Sahrens ZFS_PROP_SHARENFS, 73fa9e4066Sahrens ZFS_PROP_CHECKSUM, 74fa9e4066Sahrens ZFS_PROP_COMPRESSION, 75fa9e4066Sahrens ZFS_PROP_ATIME, 76fa9e4066Sahrens ZFS_PROP_DEVICES, 77fa9e4066Sahrens ZFS_PROP_EXEC, 78fa9e4066Sahrens ZFS_PROP_SETUID, 79fa9e4066Sahrens ZFS_PROP_READONLY, 80fa9e4066Sahrens ZFS_PROP_ZONED, 81fa9e4066Sahrens ZFS_PROP_SNAPDIR, 82fa9e4066Sahrens ZFS_PROP_ACLMODE, 83fa9e4066Sahrens ZFS_PROP_ACLINHERIT, 8466e2aaccSgw ZFS_PROP_CREATETXG, /* not exposed to the user */ 8566e2aaccSgw ZFS_PROP_NAME, /* not exposed to the user */ 86e9dbad6fSeschrock ZFS_PROP_CANMOUNT, 8766e2aaccSgw ZFS_PROP_SHAREISCSI, 8866e2aaccSgw ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 897b55fa8eSck ZFS_PROP_XATTR, 90d0ad202dSahrens ZFS_PROP_NUMCLONES, /* not exposed to the user */ 91b1b8ab34Slling ZFS_PROP_COPIES, 92e7437265Sahrens ZFS_PROP_VERSION, 93da6c28aaSamw ZFS_PROP_UTF8ONLY, 94da6c28aaSamw ZFS_PROP_NORMALIZE, 95da6c28aaSamw ZFS_PROP_CASE, 96da6c28aaSamw ZFS_PROP_VSCAN, 97da6c28aaSamw ZFS_PROP_NBMAND, 98da6c28aaSamw ZFS_PROP_SHARESMB, 99a9799022Sck ZFS_PROP_REFQUOTA, 100a9799022Sck ZFS_PROP_REFRESERVATION, 101c5904d13Seschrock ZFS_PROP_GUID, 1023baa08fcSek ZFS_PROP_PRIMARYCACHE, 1033baa08fcSek ZFS_PROP_SECONDARYCACHE, 10474e7dc98SMatthew Ahrens ZFS_PROP_USEDSNAP, 10574e7dc98SMatthew Ahrens ZFS_PROP_USEDDS, 10674e7dc98SMatthew Ahrens ZFS_PROP_USEDCHILD, 10774e7dc98SMatthew Ahrens ZFS_PROP_USEDREFRESERV, 10891ebeef5Sahrens ZFS_NUM_PROPS 109fa9e4066Sahrens } zfs_prop_t; 110fa9e4066Sahrens 111990b4856Slling /* 112990b4856Slling * Pool properties are identified by these constants and must be added to the 113b87f3af3Sperrin * end of this list to ensure that external consumers are not affected 114990b4856Slling * by the change. If you make any changes to this list, be sure to update 115990b4856Slling * the property table in usr/src/common/zfs/zpool_prop.c. 116990b4856Slling */ 117990b4856Slling typedef enum { 118990b4856Slling ZPOOL_PROP_NAME, 119990b4856Slling ZPOOL_PROP_SIZE, 120990b4856Slling ZPOOL_PROP_USED, 121990b4856Slling ZPOOL_PROP_AVAILABLE, 122990b4856Slling ZPOOL_PROP_CAPACITY, 123990b4856Slling ZPOOL_PROP_ALTROOT, 124990b4856Slling ZPOOL_PROP_HEALTH, 125990b4856Slling ZPOOL_PROP_GUID, 126990b4856Slling ZPOOL_PROP_VERSION, 127990b4856Slling ZPOOL_PROP_BOOTFS, 128990b4856Slling ZPOOL_PROP_DELEGATION, 129990b4856Slling ZPOOL_PROP_AUTOREPLACE, 1302f8aaab3Seschrock ZPOOL_PROP_CACHEFILE, 1310a4e9518Sgw ZPOOL_PROP_FAILUREMODE, 132d5b5bb25SRich Morris ZPOOL_PROP_LISTSNAPS, 133990b4856Slling ZPOOL_NUM_PROPS 134990b4856Slling } zpool_prop_t; 135b1b8ab34Slling 136990b4856Slling #define ZPROP_CONT -2 137990b4856Slling #define ZPROP_INVAL -1 1383d7072f8Seschrock 139990b4856Slling #define ZPROP_VALUE "value" 140990b4856Slling #define ZPROP_SOURCE "source" 1417f7322feSeschrock 142b1b8ab34Slling typedef enum { 143990b4856Slling ZPROP_SRC_NONE = 0x1, 144990b4856Slling ZPROP_SRC_DEFAULT = 0x2, 145990b4856Slling ZPROP_SRC_TEMPORARY = 0x4, 146990b4856Slling ZPROP_SRC_LOCAL = 0x8, 147990b4856Slling ZPROP_SRC_INHERITED = 0x10 148990b4856Slling } zprop_source_t; 149990b4856Slling 150990b4856Slling #define ZPROP_SRC_ALL 0x1f 151990b4856Slling 152990b4856Slling typedef int (*zprop_func)(int, void *); 153990b4856Slling 1540a48a24eStimh /* 1550a48a24eStimh * Properties to be set on the root file system of a new pool 1560a48a24eStimh * are stuffed into their own nvlist, which is then included in 1570a48a24eStimh * the properties nvlist with the pool properties. 1580a48a24eStimh */ 1590a48a24eStimh #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 1600a48a24eStimh 161990b4856Slling /* 162990b4856Slling * Dataset property functions shared between libzfs and kernel. 163990b4856Slling */ 164990b4856Slling const char *zfs_prop_default_string(zfs_prop_t); 165990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t); 166990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t); 167990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t); 168da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t); 169990b4856Slling const char *zfs_prop_to_name(zfs_prop_t); 170990b4856Slling zfs_prop_t zfs_name_to_prop(const char *); 171990b4856Slling boolean_t zfs_prop_user(const char *); 172990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 173990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 1744853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 175b1b8ab34Slling 176990b4856Slling /* 177990b4856Slling * Pool property functions shared between libzfs and kernel. 178990b4856Slling */ 179990b4856Slling zpool_prop_t zpool_name_to_prop(const char *); 180990b4856Slling const char *zpool_prop_to_name(zpool_prop_t); 181990b4856Slling const char *zpool_prop_default_string(zpool_prop_t); 182990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t); 183990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t); 184990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 185990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 186b1b8ab34Slling 187990b4856Slling /* 188990b4856Slling * Definitions for the Delegation. 189990b4856Slling */ 190ecd6cf80Smarks typedef enum { 191ecd6cf80Smarks ZFS_DELEG_WHO_UNKNOWN = 0, 192ecd6cf80Smarks ZFS_DELEG_USER = 'u', 193ecd6cf80Smarks ZFS_DELEG_USER_SETS = 'U', 194ecd6cf80Smarks ZFS_DELEG_GROUP = 'g', 195ecd6cf80Smarks ZFS_DELEG_GROUP_SETS = 'G', 196ecd6cf80Smarks ZFS_DELEG_EVERYONE = 'e', 197ecd6cf80Smarks ZFS_DELEG_EVERYONE_SETS = 'E', 198ecd6cf80Smarks ZFS_DELEG_CREATE = 'c', 199ecd6cf80Smarks ZFS_DELEG_CREATE_SETS = 'C', 200ecd6cf80Smarks ZFS_DELEG_NAMED_SET = 's', 201ecd6cf80Smarks ZFS_DELEG_NAMED_SET_SETS = 'S' 202ecd6cf80Smarks } zfs_deleg_who_type_t; 203ecd6cf80Smarks 204ecd6cf80Smarks typedef enum { 205ecd6cf80Smarks ZFS_DELEG_NONE = 0, 206ecd6cf80Smarks ZFS_DELEG_PERM_LOCAL = 1, 207ecd6cf80Smarks ZFS_DELEG_PERM_DESCENDENT = 2, 208ecd6cf80Smarks ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 209ecd6cf80Smarks ZFS_DELEG_PERM_CREATE = 4 210ecd6cf80Smarks } zfs_deleg_inherit_t; 211ecd6cf80Smarks 212ecd6cf80Smarks #define ZFS_DELEG_PERM_UID "uid" 213ecd6cf80Smarks #define ZFS_DELEG_PERM_GID "gid" 214ecd6cf80Smarks #define ZFS_DELEG_PERM_GROUPS "groups" 215ecd6cf80Smarks 216a227b7f4Shs typedef enum { 217a227b7f4Shs ZFS_CANMOUNT_OFF = 0, 218a227b7f4Shs ZFS_CANMOUNT_ON = 1, 219a227b7f4Shs ZFS_CANMOUNT_NOAUTO = 2 220a227b7f4Shs } zfs_canmount_type_t; 221a227b7f4Shs 222da6c28aaSamw typedef enum zfs_share_op { 223da6c28aaSamw ZFS_SHARE_NFS = 0, 224da6c28aaSamw ZFS_UNSHARE_NFS = 1, 225da6c28aaSamw ZFS_SHARE_SMB = 2, 226da6c28aaSamw ZFS_UNSHARE_SMB = 3 227da6c28aaSamw } zfs_share_op_t; 228da6c28aaSamw 2293baa08fcSek typedef enum zfs_cache_type { 2303baa08fcSek ZFS_CACHE_NONE = 0, 2313baa08fcSek ZFS_CACHE_METADATA = 1, 2323baa08fcSek ZFS_CACHE_ALL = 2 2333baa08fcSek } zfs_cache_type_t; 2343baa08fcSek 2353baa08fcSek 236eaca9bbdSeschrock /* 23799653d4eSeschrock * On-disk version number. 238eaca9bbdSeschrock */ 239e7437265Sahrens #define SPA_VERSION_1 1ULL 240e7437265Sahrens #define SPA_VERSION_2 2ULL 241e7437265Sahrens #define SPA_VERSION_3 3ULL 242e7437265Sahrens #define SPA_VERSION_4 4ULL 243e7437265Sahrens #define SPA_VERSION_5 5ULL 244e7437265Sahrens #define SPA_VERSION_6 6ULL 245e7437265Sahrens #define SPA_VERSION_7 7ULL 246e7437265Sahrens #define SPA_VERSION_8 8ULL 247da6c28aaSamw #define SPA_VERSION_9 9ULL 248fa94a07fSbrendan #define SPA_VERSION_10 10ULL 249088f3894Sahrens #define SPA_VERSION_11 11ULL 250bb0ade09Sahrens #define SPA_VERSION_12 12ULL 25174e7dc98SMatthew Ahrens #define SPA_VERSION_13 13ULL 252*d0f3f37eSMark Shellenbaum #define SPA_VERSION_14 14ULL 253b1b8ab34Slling /* 254e7cbe64fSgw * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 255b1b8ab34Slling * format change. Go to usr/src/grub/grub-0.95/stage2/{zfs-include/, fsys_zfs*}, 256b1b8ab34Slling * and do the appropriate changes. 257b1b8ab34Slling */ 258*d0f3f37eSMark Shellenbaum #define SPA_VERSION SPA_VERSION_14 259*d0f3f37eSMark Shellenbaum #define SPA_VERSION_STRING "14" 26044cd46caSbillm 26144cd46caSbillm /* 262e7437265Sahrens * Symbolic names for the changes that caused a SPA_VERSION switch. 26344cd46caSbillm * Used in the code when checking for presence or absence of a feature. 26444cd46caSbillm * Feel free to define multiple symbolic names for each version if there 26544cd46caSbillm * were multiple changes to on-disk structures during that version. 26644cd46caSbillm * 267e7437265Sahrens * NOTE: When checking the current SPA_VERSION in your code, be sure 26844cd46caSbillm * to use spa_version() since it reports the version of the 26944cd46caSbillm * last synced uberblock. Checking the in-flight version can 27044cd46caSbillm * be dangerous in some cases. 27144cd46caSbillm */ 272e7437265Sahrens #define SPA_VERSION_INITIAL SPA_VERSION_1 273e7437265Sahrens #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 274e7437265Sahrens #define SPA_VERSION_SPARES SPA_VERSION_3 275e7437265Sahrens #define SPA_VERSION_RAID6 SPA_VERSION_3 276e7437265Sahrens #define SPA_VERSION_BPLIST_ACCOUNT SPA_VERSION_3 277e7437265Sahrens #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 278e7437265Sahrens #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 279e7437265Sahrens #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 280e7437265Sahrens #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 281e7437265Sahrens #define SPA_VERSION_BOOTFS SPA_VERSION_6 282990b4856Slling #define SPA_VERSION_SLOGS SPA_VERSION_7 283990b4856Slling #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 284da6c28aaSamw #define SPA_VERSION_FUID SPA_VERSION_9 285a9799022Sck #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 286a9799022Sck #define SPA_VERSION_REFQUOTA SPA_VERSION_9 287a9799022Sck #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 288fa94a07fSbrendan #define SPA_VERSION_L2CACHE SPA_VERSION_10 289088f3894Sahrens #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 290088f3894Sahrens #define SPA_VERSION_ORIGIN SPA_VERSION_11 291088f3894Sahrens #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 292bb0ade09Sahrens #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 29374e7dc98SMatthew Ahrens #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 294*d0f3f37eSMark Shellenbaum #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 295e7437265Sahrens 296e7437265Sahrens /* 297e7437265Sahrens * ZPL version - rev'd whenever an incompatible on-disk format change 298e7437265Sahrens * occurs. This is independent of SPA/DMU/ZAP versioning. You must 299e7437265Sahrens * also update the version_table[] and help message in zfs_prop.c. 300e7437265Sahrens * 301e7437265Sahrens * When changing, be sure to teach GRUB how to read the new format! 302e7437265Sahrens * See usr/src/grub/grub-0.95/stage2/{zfs-include/,fsys_zfs*} 303e7437265Sahrens */ 304e7437265Sahrens #define ZPL_VERSION_1 1ULL 305e7437265Sahrens #define ZPL_VERSION_2 2ULL 306da6c28aaSamw #define ZPL_VERSION_3 3ULL 307da6c28aaSamw #define ZPL_VERSION ZPL_VERSION_3 308da6c28aaSamw #define ZPL_VERSION_STRING "3" 309e7437265Sahrens 310e7437265Sahrens #define ZPL_VERSION_INITIAL ZPL_VERSION_1 311e7437265Sahrens #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 312da6c28aaSamw #define ZPL_VERSION_FUID ZPL_VERSION_3 313de8267e0Stimh #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 314da6c28aaSamw #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 315eaca9bbdSeschrock 316fa9e4066Sahrens /* 317fa9e4066Sahrens * The following are configuration names used in the nvlist describing a pool's 318fa9e4066Sahrens * configuration. 319fa9e4066Sahrens */ 320fa9e4066Sahrens #define ZPOOL_CONFIG_VERSION "version" 321fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_NAME "name" 322fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_STATE "state" 323fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_TXG "txg" 324fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 325fa9e4066Sahrens #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 326fa9e4066Sahrens #define ZPOOL_CONFIG_TOP_GUID "top_guid" 327fa9e4066Sahrens #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 328fa9e4066Sahrens #define ZPOOL_CONFIG_TYPE "type" 329fa9e4066Sahrens #define ZPOOL_CONFIG_CHILDREN "children" 330fa9e4066Sahrens #define ZPOOL_CONFIG_ID "id" 331fa9e4066Sahrens #define ZPOOL_CONFIG_GUID "guid" 332fa9e4066Sahrens #define ZPOOL_CONFIG_PATH "path" 333fa9e4066Sahrens #define ZPOOL_CONFIG_DEVID "devid" 334fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 335fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 336fa9e4066Sahrens #define ZPOOL_CONFIG_ASHIFT "ashift" 337fa9e4066Sahrens #define ZPOOL_CONFIG_ASIZE "asize" 338fa9e4066Sahrens #define ZPOOL_CONFIG_DTL "DTL" 339fa9e4066Sahrens #define ZPOOL_CONFIG_STATS "stats" 340afefbcddSeschrock #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 341ea8dc4b6Seschrock #define ZPOOL_CONFIG_ERRCOUNT "error_count" 342ea8dc4b6Seschrock #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 34399653d4eSeschrock #define ZPOOL_CONFIG_SPARES "spares" 34499653d4eSeschrock #define ZPOOL_CONFIG_IS_SPARE "is_spare" 34599653d4eSeschrock #define ZPOOL_CONFIG_NPARITY "nparity" 34695173954Sek #define ZPOOL_CONFIG_HOSTID "hostid" 34795173954Sek #define ZPOOL_CONFIG_HOSTNAME "hostname" 3483d7072f8Seschrock #define ZPOOL_CONFIG_UNSPARE "unspare" 3493d7072f8Seschrock #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 3508654d025Sperrin #define ZPOOL_CONFIG_IS_LOG "is_log" 351fa94a07fSbrendan #define ZPOOL_CONFIG_L2CACHE "l2cache" 352e14bb325SJeff Bonwick #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 353e7cbe64fSgw #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 354e7cbe64fSgw #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 3553d7072f8Seschrock /* 3563d7072f8Seschrock * The persistent vdev state is stored as separate values rather than a single 3573d7072f8Seschrock * 'vdev_state' entry. This is because a device can be in multiple states, such 3583d7072f8Seschrock * as offline and degraded. 3593d7072f8Seschrock */ 3603d7072f8Seschrock #define ZPOOL_CONFIG_OFFLINE "offline" 3613d7072f8Seschrock #define ZPOOL_CONFIG_FAULTED "faulted" 3623d7072f8Seschrock #define ZPOOL_CONFIG_DEGRADED "degraded" 3633d7072f8Seschrock #define ZPOOL_CONFIG_REMOVED "removed" 364fa9e4066Sahrens 365fa9e4066Sahrens #define VDEV_TYPE_ROOT "root" 366fa9e4066Sahrens #define VDEV_TYPE_MIRROR "mirror" 367fa9e4066Sahrens #define VDEV_TYPE_REPLACING "replacing" 368fa9e4066Sahrens #define VDEV_TYPE_RAIDZ "raidz" 369fa9e4066Sahrens #define VDEV_TYPE_DISK "disk" 370fa9e4066Sahrens #define VDEV_TYPE_FILE "file" 371fa9e4066Sahrens #define VDEV_TYPE_MISSING "missing" 37299653d4eSeschrock #define VDEV_TYPE_SPARE "spare" 3738654d025Sperrin #define VDEV_TYPE_LOG "log" 374fa94a07fSbrendan #define VDEV_TYPE_L2CACHE "l2cache" 375fa9e4066Sahrens 376fa9e4066Sahrens /* 377fa9e4066Sahrens * This is needed in userland to report the minimum necessary device size. 378fa9e4066Sahrens */ 379fa9e4066Sahrens #define SPA_MINDEVSIZE (64ULL << 20) 380fa9e4066Sahrens 381fa9e4066Sahrens /* 382fa9e4066Sahrens * The location of the pool configuration repository, shared between kernel and 383fa9e4066Sahrens * userland. 384fa9e4066Sahrens */ 385c5904d13Seschrock #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 386fa9e4066Sahrens 387fa9e4066Sahrens /* 388fa9e4066Sahrens * vdev states are ordered from least to most healthy. 389fa9e4066Sahrens * A vdev that's CANT_OPEN or below is considered unusable. 390fa9e4066Sahrens */ 391fa9e4066Sahrens typedef enum vdev_state { 392fa9e4066Sahrens VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 393fa9e4066Sahrens VDEV_STATE_CLOSED, /* Not currently open */ 394fa9e4066Sahrens VDEV_STATE_OFFLINE, /* Not allowed to open */ 3953d7072f8Seschrock VDEV_STATE_REMOVED, /* Explicitly removed from system */ 396fa9e4066Sahrens VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 3973d7072f8Seschrock VDEV_STATE_FAULTED, /* External request to fault device */ 398fa9e4066Sahrens VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 399fa9e4066Sahrens VDEV_STATE_HEALTHY /* Presumed good */ 400fa9e4066Sahrens } vdev_state_t; 401fa9e4066Sahrens 4023d7072f8Seschrock #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 4033d7072f8Seschrock 404fa9e4066Sahrens /* 405fa9e4066Sahrens * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 406fa9e4066Sahrens * of the vdev stats structure uses these constants to distinguish why. 407fa9e4066Sahrens */ 408fa9e4066Sahrens typedef enum vdev_aux { 409fa9e4066Sahrens VDEV_AUX_NONE, /* no error */ 410fa9e4066Sahrens VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 411fa9e4066Sahrens VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 412fa9e4066Sahrens VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 413fa9e4066Sahrens VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 414fa9e4066Sahrens VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 415eaca9bbdSeschrock VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 416eaca9bbdSeschrock VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 41799653d4eSeschrock VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 4183d7072f8Seschrock VDEV_AUX_SPARED, /* hot spare used in another pool */ 41932b87932Sek VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 420b87f3af3Sperrin VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 421b87f3af3Sperrin VDEV_AUX_BAD_LOG /* cannot read log chain(s) */ 422fa9e4066Sahrens } vdev_aux_t; 423fa9e4066Sahrens 424fa9e4066Sahrens /* 42546a2abf2Seschrock * pool state. The following states are written to disk as part of the normal 426fa94a07fSbrendan * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 427fa94a07fSbrendan * states are software abstractions used at various levels to communicate 428fa94a07fSbrendan * pool state. 429fa9e4066Sahrens */ 430fa9e4066Sahrens typedef enum pool_state { 431fa9e4066Sahrens POOL_STATE_ACTIVE = 0, /* In active use */ 432fa9e4066Sahrens POOL_STATE_EXPORTED, /* Explicitly exported */ 433fa9e4066Sahrens POOL_STATE_DESTROYED, /* Explicitly destroyed */ 43499653d4eSeschrock POOL_STATE_SPARE, /* Reserved for hot spare use */ 435fa94a07fSbrendan POOL_STATE_L2CACHE, /* Level 2 ARC device */ 436fa9e4066Sahrens POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 43746a2abf2Seschrock POOL_STATE_UNAVAIL, /* Internal libzfs state */ 43846a2abf2Seschrock POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 439fa9e4066Sahrens } pool_state_t; 440fa9e4066Sahrens 441fa9e4066Sahrens /* 442fa9e4066Sahrens * Scrub types. 443fa9e4066Sahrens */ 444fa9e4066Sahrens typedef enum pool_scrub_type { 445fa9e4066Sahrens POOL_SCRUB_NONE, 446fa9e4066Sahrens POOL_SCRUB_RESILVER, 447fa9e4066Sahrens POOL_SCRUB_EVERYTHING, 448fa9e4066Sahrens POOL_SCRUB_TYPES 449fa9e4066Sahrens } pool_scrub_type_t; 450fa9e4066Sahrens 451fa9e4066Sahrens /* 452fa9e4066Sahrens * ZIO types. Needed to interpret vdev statistics below. 453fa9e4066Sahrens */ 454fa9e4066Sahrens typedef enum zio_type { 455fa9e4066Sahrens ZIO_TYPE_NULL = 0, 456fa9e4066Sahrens ZIO_TYPE_READ, 457fa9e4066Sahrens ZIO_TYPE_WRITE, 458fa9e4066Sahrens ZIO_TYPE_FREE, 459fa9e4066Sahrens ZIO_TYPE_CLAIM, 460fa9e4066Sahrens ZIO_TYPE_IOCTL, 461fa9e4066Sahrens ZIO_TYPES 462fa9e4066Sahrens } zio_type_t; 463fa9e4066Sahrens 464fa9e4066Sahrens /* 465fa9e4066Sahrens * Vdev statistics. Note: all fields should be 64-bit because this 466fa9e4066Sahrens * is passed between kernel and userland as an nvlist uint64 array. 467fa9e4066Sahrens */ 468fa9e4066Sahrens typedef struct vdev_stat { 469fa9e4066Sahrens hrtime_t vs_timestamp; /* time since vdev load */ 470fa9e4066Sahrens uint64_t vs_state; /* vdev state */ 471fa9e4066Sahrens uint64_t vs_aux; /* see vdev_aux_t */ 472fa9e4066Sahrens uint64_t vs_alloc; /* space allocated */ 473fa9e4066Sahrens uint64_t vs_space; /* total capacity */ 47499653d4eSeschrock uint64_t vs_dspace; /* deflated capacity */ 4752a79c5feSlling uint64_t vs_rsize; /* replaceable dev size */ 476fa9e4066Sahrens uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 477fa9e4066Sahrens uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 478fa9e4066Sahrens uint64_t vs_read_errors; /* read errors */ 479fa9e4066Sahrens uint64_t vs_write_errors; /* write errors */ 480fa9e4066Sahrens uint64_t vs_checksum_errors; /* checksum errors */ 481fa9e4066Sahrens uint64_t vs_self_healed; /* self-healed bytes */ 482fa9e4066Sahrens uint64_t vs_scrub_type; /* pool_scrub_type_t */ 483fa9e4066Sahrens uint64_t vs_scrub_complete; /* completed? */ 484fa9e4066Sahrens uint64_t vs_scrub_examined; /* bytes examined; top */ 485fa9e4066Sahrens uint64_t vs_scrub_repaired; /* bytes repaired; leaf */ 486fa9e4066Sahrens uint64_t vs_scrub_errors; /* errors during scrub */ 487fa9e4066Sahrens uint64_t vs_scrub_start; /* UTC scrub start time */ 488fa9e4066Sahrens uint64_t vs_scrub_end; /* UTC scrub end time */ 489fa9e4066Sahrens } vdev_stat_t; 490fa9e4066Sahrens 491e7cbe64fSgw #define ZVOL_DRIVER "zvol" 492fa9e4066Sahrens #define ZFS_DRIVER "zfs" 493fa9e4066Sahrens #define ZFS_DEV "/dev/zfs" 494fa9e4066Sahrens 495fa9e4066Sahrens /* 496fa9e4066Sahrens * zvol paths. Irritatingly, the devfsadm interfaces want all these 497fa9e4066Sahrens * paths without the /dev prefix, but for some things, we want the 498fa9e4066Sahrens * /dev prefix. Below are the names without /dev. 499fa9e4066Sahrens */ 500fa9e4066Sahrens #define ZVOL_DEV_DIR "zvol/dsk" 501fa9e4066Sahrens #define ZVOL_RDEV_DIR "zvol/rdsk" 502fa9e4066Sahrens 503fa9e4066Sahrens /* 504fa9e4066Sahrens * And here are the things we need with /dev, etc. in front of them. 505fa9e4066Sahrens */ 506fa9e4066Sahrens #define ZVOL_PSEUDO_DEV "/devices/pseudo/zvol@0:" 507e7cbe64fSgw #define ZVOL_FULL_DEV_DIR "/dev/" ZVOL_DEV_DIR "/" 508fa9e4066Sahrens 509fa9e4066Sahrens #define ZVOL_PROP_NAME "name" 510fa9e4066Sahrens 511fa9e4066Sahrens /* 512fa9e4066Sahrens * /dev/zfs ioctl numbers. 513fa9e4066Sahrens */ 514fa9e4066Sahrens #define ZFS_IOC ('Z' << 8) 515fa9e4066Sahrens 516fa9e4066Sahrens typedef enum zfs_ioc { 517fa9e4066Sahrens ZFS_IOC_POOL_CREATE = ZFS_IOC, 518fa9e4066Sahrens ZFS_IOC_POOL_DESTROY, 519fa9e4066Sahrens ZFS_IOC_POOL_IMPORT, 520fa9e4066Sahrens ZFS_IOC_POOL_EXPORT, 521fa9e4066Sahrens ZFS_IOC_POOL_CONFIGS, 522fa9e4066Sahrens ZFS_IOC_POOL_STATS, 523fa9e4066Sahrens ZFS_IOC_POOL_TRYIMPORT, 524fa9e4066Sahrens ZFS_IOC_POOL_SCRUB, 525fa9e4066Sahrens ZFS_IOC_POOL_FREEZE, 526eaca9bbdSeschrock ZFS_IOC_POOL_UPGRADE, 52706eeb2adSek ZFS_IOC_POOL_GET_HISTORY, 528fa9e4066Sahrens ZFS_IOC_VDEV_ADD, 529fa9e4066Sahrens ZFS_IOC_VDEV_REMOVE, 5303d7072f8Seschrock ZFS_IOC_VDEV_SET_STATE, 531fa9e4066Sahrens ZFS_IOC_VDEV_ATTACH, 532fa9e4066Sahrens ZFS_IOC_VDEV_DETACH, 533c67d9675Seschrock ZFS_IOC_VDEV_SETPATH, 534fa9e4066Sahrens ZFS_IOC_OBJSET_STATS, 535de8267e0Stimh ZFS_IOC_OBJSET_ZPLPROPS, 536fa9e4066Sahrens ZFS_IOC_DATASET_LIST_NEXT, 537fa9e4066Sahrens ZFS_IOC_SNAPSHOT_LIST_NEXT, 538fa9e4066Sahrens ZFS_IOC_SET_PROP, 539fa9e4066Sahrens ZFS_IOC_CREATE_MINOR, 540fa9e4066Sahrens ZFS_IOC_REMOVE_MINOR, 541fa9e4066Sahrens ZFS_IOC_CREATE, 542fa9e4066Sahrens ZFS_IOC_DESTROY, 543fa9e4066Sahrens ZFS_IOC_ROLLBACK, 544fa9e4066Sahrens ZFS_IOC_RENAME, 5453cb34c60Sahrens ZFS_IOC_RECV, 5463cb34c60Sahrens ZFS_IOC_SEND, 547ea8dc4b6Seschrock ZFS_IOC_INJECT_FAULT, 548ea8dc4b6Seschrock ZFS_IOC_CLEAR_FAULT, 549ea8dc4b6Seschrock ZFS_IOC_INJECT_LIST_NEXT, 550ea8dc4b6Seschrock ZFS_IOC_ERROR_LOG, 551ea8dc4b6Seschrock ZFS_IOC_CLEAR, 5521d452cf5Sahrens ZFS_IOC_PROMOTE, 5531d452cf5Sahrens ZFS_IOC_DESTROY_SNAPS, 55455434c77Sek ZFS_IOC_SNAPSHOT, 55555434c77Sek ZFS_IOC_DSOBJ_TO_DSNAME, 556b1b8ab34Slling ZFS_IOC_OBJ_TO_PATH, 557b1b8ab34Slling ZFS_IOC_POOL_SET_PROPS, 558ecd6cf80Smarks ZFS_IOC_POOL_GET_PROPS, 559ecd6cf80Smarks ZFS_IOC_SET_FSACL, 560ecd6cf80Smarks ZFS_IOC_GET_FSACL, 561ecd6cf80Smarks ZFS_IOC_ISCSI_PERM_CHECK, 562e45ce728Sahrens ZFS_IOC_SHARE, 563e45ce728Sahrens ZFS_IOC_INHERIT_PROP 564fa9e4066Sahrens } zfs_ioc_t; 565fa9e4066Sahrens 566ea8dc4b6Seschrock /* 567ea8dc4b6Seschrock * Internal SPA load state. Used by FMA diagnosis engine. 568ea8dc4b6Seschrock */ 569ea8dc4b6Seschrock typedef enum { 570ea8dc4b6Seschrock SPA_LOAD_NONE, /* no load in progress */ 571ea8dc4b6Seschrock SPA_LOAD_OPEN, /* normal open */ 572ea8dc4b6Seschrock SPA_LOAD_IMPORT, /* import in progress */ 573ea8dc4b6Seschrock SPA_LOAD_TRYIMPORT /* tryimport in progress */ 574ea8dc4b6Seschrock } spa_load_state_t; 575ea8dc4b6Seschrock 576e9dbad6fSeschrock /* 577e9dbad6fSeschrock * Bookmark name values. 578e9dbad6fSeschrock */ 57955434c77Sek #define ZPOOL_ERR_LIST "error list" 580e9dbad6fSeschrock #define ZPOOL_ERR_DATASET "dataset" 581e9dbad6fSeschrock #define ZPOOL_ERR_OBJECT "object" 582e9dbad6fSeschrock 58306eeb2adSek #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 58406eeb2adSek 58506eeb2adSek /* 58606eeb2adSek * The following are names used in the nvlist describing 58706eeb2adSek * the pool's history log. 58806eeb2adSek */ 58906eeb2adSek #define ZPOOL_HIST_RECORD "history record" 59006eeb2adSek #define ZPOOL_HIST_TIME "history time" 59106eeb2adSek #define ZPOOL_HIST_CMD "history command" 592ecd6cf80Smarks #define ZPOOL_HIST_WHO "history who" 593ecd6cf80Smarks #define ZPOOL_HIST_ZONE "history zone" 594ecd6cf80Smarks #define ZPOOL_HIST_HOST "history hostname" 595ecd6cf80Smarks #define ZPOOL_HIST_TXG "history txg" 596ecd6cf80Smarks #define ZPOOL_HIST_INT_EVENT "history internal event" 597ecd6cf80Smarks #define ZPOOL_HIST_INT_STR "history internal str" 59806eeb2adSek 5993d7072f8Seschrock /* 6003d7072f8Seschrock * Flags for ZFS_IOC_VDEV_SET_STATE 6013d7072f8Seschrock */ 6023d7072f8Seschrock #define ZFS_ONLINE_CHECKREMOVE 0x1 6033d7072f8Seschrock #define ZFS_ONLINE_UNSPARE 0x2 6043d7072f8Seschrock #define ZFS_ONLINE_FORCEFAULT 0x4 6053d7072f8Seschrock #define ZFS_OFFLINE_TEMPORARY 0x1 6063d7072f8Seschrock 6073d7072f8Seschrock /* 6083d7072f8Seschrock * Sysevent payload members. ZFS will generate the following sysevents with the 6093d7072f8Seschrock * given payloads: 6103d7072f8Seschrock * 6113d7072f8Seschrock * ESC_ZFS_RESILVER_START 6123d7072f8Seschrock * ESC_ZFS_RESILVER_END 6133d7072f8Seschrock * ESC_ZFS_POOL_DESTROY 6143d7072f8Seschrock * 6153d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 6163d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 6173d7072f8Seschrock * 6183d7072f8Seschrock * ESC_ZFS_VDEV_REMOVE 6193d7072f8Seschrock * ESC_ZFS_VDEV_CLEAR 6203d7072f8Seschrock * ESC_ZFS_VDEV_CHECK 6213d7072f8Seschrock * 6223d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 6233d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 6243d7072f8Seschrock * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 6253d7072f8Seschrock * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 6263d7072f8Seschrock */ 6273d7072f8Seschrock #define ZFS_EV_POOL_NAME "pool_name" 6283d7072f8Seschrock #define ZFS_EV_POOL_GUID "pool_guid" 6293d7072f8Seschrock #define ZFS_EV_VDEV_PATH "vdev_path" 6303d7072f8Seschrock #define ZFS_EV_VDEV_GUID "vdev_guid" 6313d7072f8Seschrock 632088f3894Sahrens /* 633088f3894Sahrens * Note: This is encoded on-disk, so new events must be added to the 634088f3894Sahrens * end, and unused events can not be removed. Be sure to edit 635088f3894Sahrens * zpool_main.c: hist_event_table[]. 636088f3894Sahrens */ 637ecd6cf80Smarks typedef enum history_internal_events { 638ecd6cf80Smarks LOG_NO_EVENT = 0, 639ecd6cf80Smarks LOG_POOL_CREATE, 640ecd6cf80Smarks LOG_POOL_VDEV_ADD, 641ecd6cf80Smarks LOG_POOL_REMOVE, 642ecd6cf80Smarks LOG_POOL_DESTROY, 643ecd6cf80Smarks LOG_POOL_EXPORT, 644ecd6cf80Smarks LOG_POOL_IMPORT, 645ecd6cf80Smarks LOG_POOL_VDEV_ATTACH, 646ecd6cf80Smarks LOG_POOL_VDEV_REPLACE, 647ecd6cf80Smarks LOG_POOL_VDEV_DETACH, 648ecd6cf80Smarks LOG_POOL_VDEV_ONLINE, 649ecd6cf80Smarks LOG_POOL_VDEV_OFFLINE, 650ecd6cf80Smarks LOG_POOL_UPGRADE, 651ecd6cf80Smarks LOG_POOL_CLEAR, 652ecd6cf80Smarks LOG_POOL_SCRUB, 653ecd6cf80Smarks LOG_POOL_PROPSET, 654ecd6cf80Smarks LOG_DS_CREATE, 655ecd6cf80Smarks LOG_DS_CLONE, 656ecd6cf80Smarks LOG_DS_DESTROY, 657ecd6cf80Smarks LOG_DS_DESTROY_BEGIN, 658ecd6cf80Smarks LOG_DS_INHERIT, 659ecd6cf80Smarks LOG_DS_PROPSET, 660ecd6cf80Smarks LOG_DS_QUOTA, 661ecd6cf80Smarks LOG_DS_PERM_UPDATE, 662ecd6cf80Smarks LOG_DS_PERM_REMOVE, 663ecd6cf80Smarks LOG_DS_PERM_WHO_REMOVE, 664ecd6cf80Smarks LOG_DS_PROMOTE, 665ecd6cf80Smarks LOG_DS_RECEIVE, 666ecd6cf80Smarks LOG_DS_RENAME, 667ecd6cf80Smarks LOG_DS_RESERVATION, 668ecd6cf80Smarks LOG_DS_REPLAY_INC_SYNC, 669ecd6cf80Smarks LOG_DS_REPLAY_FULL_SYNC, 670ecd6cf80Smarks LOG_DS_ROLLBACK, 671ecd6cf80Smarks LOG_DS_SNAPSHOT, 672e7437265Sahrens LOG_DS_UPGRADE, 673a9799022Sck LOG_DS_REFQUOTA, 674a9799022Sck LOG_DS_REFRESERV, 675088f3894Sahrens LOG_POOL_SCRUB_DONE, 676ecd6cf80Smarks LOG_END 677ecd6cf80Smarks } history_internal_events_t; 678ecd6cf80Smarks 679fa9e4066Sahrens #ifdef __cplusplus 680fa9e4066Sahrens } 681fa9e4066Sahrens #endif 682fa9e4066Sahrens 683fa9e4066Sahrens #endif /* _SYS_FS_ZFS_H */ 684