1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5441d80aaSlling * Common Development and Distribution License (the "License"). 6441d80aaSlling * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21f94275ceSAdam Leventhal 22fa9e4066Sahrens /* 2327dd1e87SMark Shellenbaum * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24edf345e6SMatthew Ahrens * Copyright (c) 2011, 2014 by Delphix. All rights reserved. 25e9103aaeSGarrett D'Amore * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 26a2afb611SJerry Jelinek * Copyright (c) 2013, Joyent, Inc. All rights reserved. 27*c3d26abcSMatthew Ahrens * Copyright (c) 2014 Integros [integros.com] 28fa9e4066Sahrens */ 29fa9e4066Sahrens 3055da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */ 3155da60b9SMark J Musante 32fa9e4066Sahrens #ifndef _SYS_FS_ZFS_H 33fa9e4066Sahrens #define _SYS_FS_ZFS_H 34fa9e4066Sahrens 35842727c2SChris Kirby #include <sys/time.h> 36842727c2SChris Kirby 37fa9e4066Sahrens #ifdef __cplusplus 38fa9e4066Sahrens extern "C" { 39fa9e4066Sahrens #endif 40fa9e4066Sahrens 41fa9e4066Sahrens /* 42fa9e4066Sahrens * Types and constants shared between userland and the kernel. 43fa9e4066Sahrens */ 44fa9e4066Sahrens 45fa9e4066Sahrens /* 46fa9e4066Sahrens * Each dataset can be one of the following types. These constants can be 47fa9e4066Sahrens * combined into masks that can be passed to various functions. 48fa9e4066Sahrens */ 49fa9e4066Sahrens typedef enum { 5078f17100SMatthew Ahrens ZFS_TYPE_FILESYSTEM = (1 << 0), 5178f17100SMatthew Ahrens ZFS_TYPE_SNAPSHOT = (1 << 1), 5278f17100SMatthew Ahrens ZFS_TYPE_VOLUME = (1 << 2), 5378f17100SMatthew Ahrens ZFS_TYPE_POOL = (1 << 3), 5478f17100SMatthew Ahrens ZFS_TYPE_BOOKMARK = (1 << 4) 55fa9e4066Sahrens } zfs_type_t; 56fa9e4066Sahrens 574445fffbSMatthew Ahrens typedef enum dmu_objset_type { 584445fffbSMatthew Ahrens DMU_OST_NONE, 594445fffbSMatthew Ahrens DMU_OST_META, 604445fffbSMatthew Ahrens DMU_OST_ZFS, 614445fffbSMatthew Ahrens DMU_OST_ZVOL, 624445fffbSMatthew Ahrens DMU_OST_OTHER, /* For testing only! */ 634445fffbSMatthew Ahrens DMU_OST_ANY, /* Be careful! */ 644445fffbSMatthew Ahrens DMU_OST_NUMTYPES 654445fffbSMatthew Ahrens } dmu_objset_type_t; 664445fffbSMatthew Ahrens 67990b4856Slling #define ZFS_TYPE_DATASET \ 68fa9e4066Sahrens (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 69fa9e4066Sahrens 70478ed9adSEric Taylor #define ZAP_MAXNAMELEN 256 71478ed9adSEric Taylor #define ZAP_MAXVALUELEN (1024 * 8) 72478ed9adSEric Taylor #define ZAP_OLDMAXVALUELEN 1024 73478ed9adSEric Taylor 74fa9e4066Sahrens /* 75990b4856Slling * Dataset properties are identified by these constants and must be added to 76990b4856Slling * the end of this list to ensure that external consumers are not affected 77990b4856Slling * by the change. If you make any changes to this list, be sure to update 7866e2aaccSgw * the property table in usr/src/common/zfs/zfs_prop.c. 79fa9e4066Sahrens */ 80fa9e4066Sahrens typedef enum { 81fa9e4066Sahrens ZFS_PROP_TYPE, 82fa9e4066Sahrens ZFS_PROP_CREATION, 83fa9e4066Sahrens ZFS_PROP_USED, 84fa9e4066Sahrens ZFS_PROP_AVAILABLE, 85fa9e4066Sahrens ZFS_PROP_REFERENCED, 86fa9e4066Sahrens ZFS_PROP_COMPRESSRATIO, 87fa9e4066Sahrens ZFS_PROP_MOUNTED, 88fa9e4066Sahrens ZFS_PROP_ORIGIN, 89fa9e4066Sahrens ZFS_PROP_QUOTA, 90fa9e4066Sahrens ZFS_PROP_RESERVATION, 91fa9e4066Sahrens ZFS_PROP_VOLSIZE, 92fa9e4066Sahrens ZFS_PROP_VOLBLOCKSIZE, 93fa9e4066Sahrens ZFS_PROP_RECORDSIZE, 94fa9e4066Sahrens ZFS_PROP_MOUNTPOINT, 95fa9e4066Sahrens ZFS_PROP_SHARENFS, 96fa9e4066Sahrens ZFS_PROP_CHECKSUM, 97fa9e4066Sahrens ZFS_PROP_COMPRESSION, 98fa9e4066Sahrens ZFS_PROP_ATIME, 99fa9e4066Sahrens ZFS_PROP_DEVICES, 100fa9e4066Sahrens ZFS_PROP_EXEC, 101fa9e4066Sahrens ZFS_PROP_SETUID, 102fa9e4066Sahrens ZFS_PROP_READONLY, 103fa9e4066Sahrens ZFS_PROP_ZONED, 104fa9e4066Sahrens ZFS_PROP_SNAPDIR, 105a3c49ce1SAlbert Lee ZFS_PROP_ACLMODE, 106fa9e4066Sahrens ZFS_PROP_ACLINHERIT, 10766e2aaccSgw ZFS_PROP_CREATETXG, /* not exposed to the user */ 10866e2aaccSgw ZFS_PROP_NAME, /* not exposed to the user */ 109e9dbad6fSeschrock ZFS_PROP_CANMOUNT, 11066e2aaccSgw ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 1117b55fa8eSck ZFS_PROP_XATTR, 112d0ad202dSahrens ZFS_PROP_NUMCLONES, /* not exposed to the user */ 113b1b8ab34Slling ZFS_PROP_COPIES, 114e7437265Sahrens ZFS_PROP_VERSION, 115da6c28aaSamw ZFS_PROP_UTF8ONLY, 116da6c28aaSamw ZFS_PROP_NORMALIZE, 117da6c28aaSamw ZFS_PROP_CASE, 118da6c28aaSamw ZFS_PROP_VSCAN, 119da6c28aaSamw ZFS_PROP_NBMAND, 120da6c28aaSamw ZFS_PROP_SHARESMB, 121a9799022Sck ZFS_PROP_REFQUOTA, 122a9799022Sck ZFS_PROP_REFRESERVATION, 123c5904d13Seschrock ZFS_PROP_GUID, 1243baa08fcSek ZFS_PROP_PRIMARYCACHE, 1253baa08fcSek ZFS_PROP_SECONDARYCACHE, 12674e7dc98SMatthew Ahrens ZFS_PROP_USEDSNAP, 12774e7dc98SMatthew Ahrens ZFS_PROP_USEDDS, 12874e7dc98SMatthew Ahrens ZFS_PROP_USEDCHILD, 12974e7dc98SMatthew Ahrens ZFS_PROP_USEDREFRESERV, 13014843421SMatthew Ahrens ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 131478ed9adSEric Taylor ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 132842727c2SChris Kirby ZFS_PROP_DEFER_DESTROY, 133842727c2SChris Kirby ZFS_PROP_USERREFS, 134e09fa4daSNeil Perrin ZFS_PROP_LOGBIAS, 1351d713200SEric Schrock ZFS_PROP_UNIQUE, /* not exposed to the user */ 1361d713200SEric Schrock ZFS_PROP_OBJSETID, /* not exposed to the user */ 137b24ab676SJeff Bonwick ZFS_PROP_DEDUP, 1384201a95eSRic Aleshire ZFS_PROP_MLSLABEL, 13955da60b9SMark J Musante ZFS_PROP_SYNC, 140187d6ac0SMatt Ahrens ZFS_PROP_REFRATIO, 14119b94df9SMatthew Ahrens ZFS_PROP_WRITTEN, 14219b94df9SMatthew Ahrens ZFS_PROP_CLONES, 14377372cb0SMatthew Ahrens ZFS_PROP_LOGICALUSED, 14477372cb0SMatthew Ahrens ZFS_PROP_LOGICALREFERENCED, 145ca48f36fSKeith M Wesolowski ZFS_PROP_INCONSISTENT, /* not exposed to the user */ 146a2afb611SJerry Jelinek ZFS_PROP_FILESYSTEM_LIMIT, 147a2afb611SJerry Jelinek ZFS_PROP_SNAPSHOT_LIMIT, 148a2afb611SJerry Jelinek ZFS_PROP_FILESYSTEM_COUNT, 149a2afb611SJerry Jelinek ZFS_PROP_SNAPSHOT_COUNT, 150edf345e6SMatthew Ahrens ZFS_PROP_REDUNDANT_METADATA, 151b461c746SMatthew Ahrens ZFS_PROP_PREV_SNAP, 1529c3fd121SMatthew Ahrens ZFS_PROP_RECEIVE_RESUME_TOKEN, 15391ebeef5Sahrens ZFS_NUM_PROPS 154fa9e4066Sahrens } zfs_prop_t; 155fa9e4066Sahrens 15614843421SMatthew Ahrens typedef enum { 15714843421SMatthew Ahrens ZFS_PROP_USERUSED, 15814843421SMatthew Ahrens ZFS_PROP_USERQUOTA, 15914843421SMatthew Ahrens ZFS_PROP_GROUPUSED, 16014843421SMatthew Ahrens ZFS_PROP_GROUPQUOTA, 16114843421SMatthew Ahrens ZFS_NUM_USERQUOTA_PROPS 16214843421SMatthew Ahrens } zfs_userquota_prop_t; 16314843421SMatthew Ahrens 16414843421SMatthew Ahrens extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS]; 16514843421SMatthew Ahrens 166990b4856Slling /* 167990b4856Slling * Pool properties are identified by these constants and must be added to the 168b87f3af3Sperrin * end of this list to ensure that external consumers are not affected 169990b4856Slling * by the change. If you make any changes to this list, be sure to update 170990b4856Slling * the property table in usr/src/common/zfs/zpool_prop.c. 171990b4856Slling */ 172990b4856Slling typedef enum { 173990b4856Slling ZPOOL_PROP_NAME, 174990b4856Slling ZPOOL_PROP_SIZE, 175990b4856Slling ZPOOL_PROP_CAPACITY, 176990b4856Slling ZPOOL_PROP_ALTROOT, 177990b4856Slling ZPOOL_PROP_HEALTH, 178990b4856Slling ZPOOL_PROP_GUID, 179990b4856Slling ZPOOL_PROP_VERSION, 180990b4856Slling ZPOOL_PROP_BOOTFS, 181990b4856Slling ZPOOL_PROP_DELEGATION, 182990b4856Slling ZPOOL_PROP_AUTOREPLACE, 1832f8aaab3Seschrock ZPOOL_PROP_CACHEFILE, 1840a4e9518Sgw ZPOOL_PROP_FAILUREMODE, 185d5b5bb25SRich Morris ZPOOL_PROP_LISTSNAPS, 186573ca77eSGeorge Wilson ZPOOL_PROP_AUTOEXPAND, 187b24ab676SJeff Bonwick ZPOOL_PROP_DEDUPDITTO, 188b24ab676SJeff Bonwick ZPOOL_PROP_DEDUPRATIO, 189485bbbf5SGeorge Wilson ZPOOL_PROP_FREE, 190485bbbf5SGeorge Wilson ZPOOL_PROP_ALLOCATED, 191f9af39baSGeorge Wilson ZPOOL_PROP_READONLY, 1928704186eSDan McDonald ZPOOL_PROP_COMMENT, 1934263d13fSGeorge Wilson ZPOOL_PROP_EXPANDSZ, 194ad135b5dSChristopher Siden ZPOOL_PROP_FREEING, 1952e4c9986SGeorge Wilson ZPOOL_PROP_FRAGMENTATION, 1967fd05ac4SMatthew Ahrens ZPOOL_PROP_LEAKED, 197b5152584SMatthew Ahrens ZPOOL_PROP_MAXBLOCKSIZE, 198990b4856Slling ZPOOL_NUM_PROPS 199990b4856Slling } zpool_prop_t; 200b1b8ab34Slling 2018704186eSDan McDonald /* Small enough to not hog a whole line of printout in zpool(1M). */ 2028704186eSDan McDonald #define ZPROP_MAX_COMMENT 32 2038704186eSDan McDonald 204990b4856Slling #define ZPROP_CONT -2 205990b4856Slling #define ZPROP_INVAL -1 2063d7072f8Seschrock 207990b4856Slling #define ZPROP_VALUE "value" 208990b4856Slling #define ZPROP_SOURCE "source" 2097f7322feSeschrock 210b1b8ab34Slling typedef enum { 211990b4856Slling ZPROP_SRC_NONE = 0x1, 212990b4856Slling ZPROP_SRC_DEFAULT = 0x2, 213990b4856Slling ZPROP_SRC_TEMPORARY = 0x4, 214990b4856Slling ZPROP_SRC_LOCAL = 0x8, 21592241e0bSTom Erickson ZPROP_SRC_INHERITED = 0x10, 21692241e0bSTom Erickson ZPROP_SRC_RECEIVED = 0x20 217990b4856Slling } zprop_source_t; 218990b4856Slling 21992241e0bSTom Erickson #define ZPROP_SRC_ALL 0x3f 22092241e0bSTom Erickson 22192241e0bSTom Erickson #define ZPROP_SOURCE_VAL_RECVD "$recvd" 22292241e0bSTom Erickson #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 22392241e0bSTom Erickson /* 22492241e0bSTom Erickson * Dataset flag implemented as a special entry in the props zap object 22592241e0bSTom Erickson * indicating that the dataset has received properties on or after 22692241e0bSTom Erickson * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 22792241e0bSTom Erickson * just as it did in earlier versions, and thereafter, local properties are 22892241e0bSTom Erickson * preserved. 22992241e0bSTom Erickson */ 23092241e0bSTom Erickson #define ZPROP_HAS_RECVD "$hasrecvd" 23192241e0bSTom Erickson 23292241e0bSTom Erickson typedef enum { 23392241e0bSTom Erickson ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 23492241e0bSTom Erickson ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 23592241e0bSTom Erickson } zprop_errflags_t; 236990b4856Slling 237990b4856Slling typedef int (*zprop_func)(int, void *); 238990b4856Slling 2390a48a24eStimh /* 2400a48a24eStimh * Properties to be set on the root file system of a new pool 2410a48a24eStimh * are stuffed into their own nvlist, which is then included in 2420a48a24eStimh * the properties nvlist with the pool properties. 2430a48a24eStimh */ 2440a48a24eStimh #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 2450a48a24eStimh 246990b4856Slling /* 247990b4856Slling * Dataset property functions shared between libzfs and kernel. 248990b4856Slling */ 249990b4856Slling const char *zfs_prop_default_string(zfs_prop_t); 250990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t); 251990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t); 252990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t); 253da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t); 254990b4856Slling const char *zfs_prop_to_name(zfs_prop_t); 255990b4856Slling zfs_prop_t zfs_name_to_prop(const char *); 256990b4856Slling boolean_t zfs_prop_user(const char *); 25792241e0bSTom Erickson boolean_t zfs_prop_userquota(const char *); 25819b94df9SMatthew Ahrens boolean_t zfs_prop_written(const char *); 259990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 260990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 261b24ab676SJeff Bonwick uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 2624853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 263b1b8ab34Slling 264990b4856Slling /* 265990b4856Slling * Pool property functions shared between libzfs and kernel. 266990b4856Slling */ 267990b4856Slling zpool_prop_t zpool_name_to_prop(const char *); 268990b4856Slling const char *zpool_prop_to_name(zpool_prop_t); 269990b4856Slling const char *zpool_prop_default_string(zpool_prop_t); 270990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t); 271990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t); 272ad135b5dSChristopher Siden boolean_t zpool_prop_feature(const char *); 273ad135b5dSChristopher Siden boolean_t zpool_prop_unsupported(const char *name); 274990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 275990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 276b24ab676SJeff Bonwick uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 277b1b8ab34Slling 278990b4856Slling /* 279990b4856Slling * Definitions for the Delegation. 280990b4856Slling */ 281ecd6cf80Smarks typedef enum { 282ecd6cf80Smarks ZFS_DELEG_WHO_UNKNOWN = 0, 283ecd6cf80Smarks ZFS_DELEG_USER = 'u', 284ecd6cf80Smarks ZFS_DELEG_USER_SETS = 'U', 285ecd6cf80Smarks ZFS_DELEG_GROUP = 'g', 286ecd6cf80Smarks ZFS_DELEG_GROUP_SETS = 'G', 287ecd6cf80Smarks ZFS_DELEG_EVERYONE = 'e', 288ecd6cf80Smarks ZFS_DELEG_EVERYONE_SETS = 'E', 289ecd6cf80Smarks ZFS_DELEG_CREATE = 'c', 290ecd6cf80Smarks ZFS_DELEG_CREATE_SETS = 'C', 291ecd6cf80Smarks ZFS_DELEG_NAMED_SET = 's', 292ecd6cf80Smarks ZFS_DELEG_NAMED_SET_SETS = 'S' 293ecd6cf80Smarks } zfs_deleg_who_type_t; 294ecd6cf80Smarks 295ecd6cf80Smarks typedef enum { 296ecd6cf80Smarks ZFS_DELEG_NONE = 0, 297ecd6cf80Smarks ZFS_DELEG_PERM_LOCAL = 1, 298ecd6cf80Smarks ZFS_DELEG_PERM_DESCENDENT = 2, 299ecd6cf80Smarks ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 300ecd6cf80Smarks ZFS_DELEG_PERM_CREATE = 4 301ecd6cf80Smarks } zfs_deleg_inherit_t; 302ecd6cf80Smarks 303ecd6cf80Smarks #define ZFS_DELEG_PERM_UID "uid" 304ecd6cf80Smarks #define ZFS_DELEG_PERM_GID "gid" 305ecd6cf80Smarks #define ZFS_DELEG_PERM_GROUPS "groups" 306ecd6cf80Smarks 3074201a95eSRic Aleshire #define ZFS_MLSLABEL_DEFAULT "none" 3084201a95eSRic Aleshire 309743a77edSAlan Wright #define ZFS_SMB_ACL_SRC "src" 310743a77edSAlan Wright #define ZFS_SMB_ACL_TARGET "target" 311743a77edSAlan Wright 312a227b7f4Shs typedef enum { 313a227b7f4Shs ZFS_CANMOUNT_OFF = 0, 314a227b7f4Shs ZFS_CANMOUNT_ON = 1, 315a227b7f4Shs ZFS_CANMOUNT_NOAUTO = 2 316a227b7f4Shs } zfs_canmount_type_t; 317a227b7f4Shs 318e09fa4daSNeil Perrin typedef enum { 319e09fa4daSNeil Perrin ZFS_LOGBIAS_LATENCY = 0, 320e09fa4daSNeil Perrin ZFS_LOGBIAS_THROUGHPUT = 1 321e09fa4daSNeil Perrin } zfs_logbias_op_t; 322e09fa4daSNeil Perrin 323da6c28aaSamw typedef enum zfs_share_op { 324da6c28aaSamw ZFS_SHARE_NFS = 0, 325da6c28aaSamw ZFS_UNSHARE_NFS = 1, 326da6c28aaSamw ZFS_SHARE_SMB = 2, 327da6c28aaSamw ZFS_UNSHARE_SMB = 3 328da6c28aaSamw } zfs_share_op_t; 329da6c28aaSamw 330743a77edSAlan Wright typedef enum zfs_smb_acl_op { 331743a77edSAlan Wright ZFS_SMB_ACL_ADD, 332743a77edSAlan Wright ZFS_SMB_ACL_REMOVE, 333743a77edSAlan Wright ZFS_SMB_ACL_RENAME, 334743a77edSAlan Wright ZFS_SMB_ACL_PURGE 335743a77edSAlan Wright } zfs_smb_acl_op_t; 336743a77edSAlan Wright 3373baa08fcSek typedef enum zfs_cache_type { 3383baa08fcSek ZFS_CACHE_NONE = 0, 3393baa08fcSek ZFS_CACHE_METADATA = 1, 3403baa08fcSek ZFS_CACHE_ALL = 2 3413baa08fcSek } zfs_cache_type_t; 3423baa08fcSek 34355da60b9SMark J Musante typedef enum { 34455da60b9SMark J Musante ZFS_SYNC_STANDARD = 0, 34555da60b9SMark J Musante ZFS_SYNC_ALWAYS = 1, 34655da60b9SMark J Musante ZFS_SYNC_DISABLED = 2 34755da60b9SMark J Musante } zfs_sync_type_t; 34855da60b9SMark J Musante 349edf345e6SMatthew Ahrens typedef enum { 350edf345e6SMatthew Ahrens ZFS_REDUNDANT_METADATA_ALL, 351edf345e6SMatthew Ahrens ZFS_REDUNDANT_METADATA_MOST 352edf345e6SMatthew Ahrens } zfs_redundant_metadata_type_t; 3533baa08fcSek 354eaca9bbdSeschrock /* 35599653d4eSeschrock * On-disk version number. 356eaca9bbdSeschrock */ 357e7437265Sahrens #define SPA_VERSION_1 1ULL 358e7437265Sahrens #define SPA_VERSION_2 2ULL 359e7437265Sahrens #define SPA_VERSION_3 3ULL 360e7437265Sahrens #define SPA_VERSION_4 4ULL 361e7437265Sahrens #define SPA_VERSION_5 5ULL 362e7437265Sahrens #define SPA_VERSION_6 6ULL 363e7437265Sahrens #define SPA_VERSION_7 7ULL 364e7437265Sahrens #define SPA_VERSION_8 8ULL 365da6c28aaSamw #define SPA_VERSION_9 9ULL 366fa94a07fSbrendan #define SPA_VERSION_10 10ULL 367088f3894Sahrens #define SPA_VERSION_11 11ULL 368bb0ade09Sahrens #define SPA_VERSION_12 12ULL 36974e7dc98SMatthew Ahrens #define SPA_VERSION_13 13ULL 370d0f3f37eSMark Shellenbaum #define SPA_VERSION_14 14ULL 37114843421SMatthew Ahrens #define SPA_VERSION_15 15ULL 372478ed9adSEric Taylor #define SPA_VERSION_16 16ULL 373f94275ceSAdam Leventhal #define SPA_VERSION_17 17ULL 374842727c2SChris Kirby #define SPA_VERSION_18 18ULL 37588ecc943SGeorge Wilson #define SPA_VERSION_19 19ULL 376b24ab676SJeff Bonwick #define SPA_VERSION_20 20ULL 377b24ab676SJeff Bonwick #define SPA_VERSION_21 21ULL 37892241e0bSTom Erickson #define SPA_VERSION_22 22ULL 3796e1f5caaSNeil Perrin #define SPA_VERSION_23 23ULL 3800a586ceaSMark Shellenbaum #define SPA_VERSION_24 24ULL 3813f9d6ad7SLin Ling #define SPA_VERSION_25 25ULL 382cde58dbcSMatthew Ahrens #define SPA_VERSION_26 26ULL 3836e0cbcaaSMatthew Ahrens #define SPA_VERSION_27 27ULL 384cb04b873SMark J Musante #define SPA_VERSION_28 28ULL 385ad135b5dSChristopher Siden #define SPA_VERSION_5000 5000ULL 386cb04b873SMark J Musante 387b1b8ab34Slling /* 388e7cbe64fSgw * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 389478ed9adSEric Taylor * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 39014843421SMatthew Ahrens * and do the appropriate changes. Also bump the version number in 39114843421SMatthew Ahrens * usr/src/grub/capability. 392b1b8ab34Slling */ 393ad135b5dSChristopher Siden #define SPA_VERSION SPA_VERSION_5000 394ad135b5dSChristopher Siden #define SPA_VERSION_STRING "5000" 39544cd46caSbillm 39644cd46caSbillm /* 397e7437265Sahrens * Symbolic names for the changes that caused a SPA_VERSION switch. 39844cd46caSbillm * Used in the code when checking for presence or absence of a feature. 39944cd46caSbillm * Feel free to define multiple symbolic names for each version if there 40044cd46caSbillm * were multiple changes to on-disk structures during that version. 40144cd46caSbillm * 402e7437265Sahrens * NOTE: When checking the current SPA_VERSION in your code, be sure 40344cd46caSbillm * to use spa_version() since it reports the version of the 40444cd46caSbillm * last synced uberblock. Checking the in-flight version can 40544cd46caSbillm * be dangerous in some cases. 40644cd46caSbillm */ 407e7437265Sahrens #define SPA_VERSION_INITIAL SPA_VERSION_1 408e7437265Sahrens #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 409e7437265Sahrens #define SPA_VERSION_SPARES SPA_VERSION_3 410f94275ceSAdam Leventhal #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 411cde58dbcSMatthew Ahrens #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 412e7437265Sahrens #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 413e7437265Sahrens #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 414e7437265Sahrens #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 415e7437265Sahrens #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 416e7437265Sahrens #define SPA_VERSION_BOOTFS SPA_VERSION_6 417990b4856Slling #define SPA_VERSION_SLOGS SPA_VERSION_7 418990b4856Slling #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 419da6c28aaSamw #define SPA_VERSION_FUID SPA_VERSION_9 420a9799022Sck #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 421a9799022Sck #define SPA_VERSION_REFQUOTA SPA_VERSION_9 422a9799022Sck #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 423fa94a07fSbrendan #define SPA_VERSION_L2CACHE SPA_VERSION_10 424088f3894Sahrens #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 425088f3894Sahrens #define SPA_VERSION_ORIGIN SPA_VERSION_11 426088f3894Sahrens #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 427bb0ade09Sahrens #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 42874e7dc98SMatthew Ahrens #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 429d0f3f37eSMark Shellenbaum #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 43014843421SMatthew Ahrens #define SPA_VERSION_USERSPACE SPA_VERSION_15 431478ed9adSEric Taylor #define SPA_VERSION_STMF_PROP SPA_VERSION_16 432f94275ceSAdam Leventhal #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 433842727c2SChris Kirby #define SPA_VERSION_USERREFS SPA_VERSION_18 43488ecc943SGeorge Wilson #define SPA_VERSION_HOLES SPA_VERSION_19 435b24ab676SJeff Bonwick #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 436b24ab676SJeff Bonwick #define SPA_VERSION_DEDUP SPA_VERSION_21 43792241e0bSTom Erickson #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 4386e1f5caaSNeil Perrin #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 4390a586ceaSMark Shellenbaum #define SPA_VERSION_SA SPA_VERSION_24 4403f9d6ad7SLin Ling #define SPA_VERSION_SCAN SPA_VERSION_25 441cde58dbcSMatthew Ahrens #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 442cde58dbcSMatthew Ahrens #define SPA_VERSION_DEADLISTS SPA_VERSION_26 4436e0cbcaaSMatthew Ahrens #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 444cb04b873SMark J Musante #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 445ad135b5dSChristopher Siden #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 446ad135b5dSChristopher Siden #define SPA_VERSION_FEATURES SPA_VERSION_5000 447ad135b5dSChristopher Siden 448ad135b5dSChristopher Siden #define SPA_VERSION_IS_SUPPORTED(v) \ 449ad135b5dSChristopher Siden (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 450ad135b5dSChristopher Siden ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 451e7437265Sahrens 452e7437265Sahrens /* 453e7437265Sahrens * ZPL version - rev'd whenever an incompatible on-disk format change 454e7437265Sahrens * occurs. This is independent of SPA/DMU/ZAP versioning. You must 455e7437265Sahrens * also update the version_table[] and help message in zfs_prop.c. 456e7437265Sahrens * 457e7437265Sahrens * When changing, be sure to teach GRUB how to read the new format! 458478ed9adSEric Taylor * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 459e7437265Sahrens */ 460e7437265Sahrens #define ZPL_VERSION_1 1ULL 461e7437265Sahrens #define ZPL_VERSION_2 2ULL 462da6c28aaSamw #define ZPL_VERSION_3 3ULL 46314843421SMatthew Ahrens #define ZPL_VERSION_4 4ULL 4640a586ceaSMark Shellenbaum #define ZPL_VERSION_5 5ULL 4650a586ceaSMark Shellenbaum #define ZPL_VERSION ZPL_VERSION_5 4660a586ceaSMark Shellenbaum #define ZPL_VERSION_STRING "5" 467e7437265Sahrens 468e7437265Sahrens #define ZPL_VERSION_INITIAL ZPL_VERSION_1 469e7437265Sahrens #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 470da6c28aaSamw #define ZPL_VERSION_FUID ZPL_VERSION_3 471de8267e0Stimh #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 472da6c28aaSamw #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 47314843421SMatthew Ahrens #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 4740a586ceaSMark Shellenbaum #define ZPL_VERSION_SA ZPL_VERSION_5 475eaca9bbdSeschrock 476468c413aSTim Haley /* Rewind request information */ 477c8ee1847SVictor Latushkin #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 478c8ee1847SVictor Latushkin #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 479c8ee1847SVictor Latushkin #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 480c8ee1847SVictor Latushkin #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 481c8ee1847SVictor Latushkin #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 482c8ee1847SVictor Latushkin #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 483c8ee1847SVictor Latushkin #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 484468c413aSTim Haley 485468c413aSTim Haley typedef struct zpool_rewind_policy { 486468c413aSTim Haley uint32_t zrp_request; /* rewind behavior requested */ 487c8ee1847SVictor Latushkin uint64_t zrp_maxmeta; /* max acceptable meta-data errors */ 488c8ee1847SVictor Latushkin uint64_t zrp_maxdata; /* max acceptable data errors */ 489468c413aSTim Haley uint64_t zrp_txg; /* specific txg to load */ 490468c413aSTim Haley } zpool_rewind_policy_t; 491468c413aSTim Haley 492fa9e4066Sahrens /* 493fa9e4066Sahrens * The following are configuration names used in the nvlist describing a pool's 494fa9e4066Sahrens * configuration. 495fa9e4066Sahrens */ 496fa9e4066Sahrens #define ZPOOL_CONFIG_VERSION "version" 497fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_NAME "name" 498fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_STATE "state" 499fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_TXG "txg" 500fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 501fa9e4066Sahrens #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 502fa9e4066Sahrens #define ZPOOL_CONFIG_TOP_GUID "top_guid" 503fa9e4066Sahrens #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 504fa9e4066Sahrens #define ZPOOL_CONFIG_TYPE "type" 505fa9e4066Sahrens #define ZPOOL_CONFIG_CHILDREN "children" 506fa9e4066Sahrens #define ZPOOL_CONFIG_ID "id" 507fa9e4066Sahrens #define ZPOOL_CONFIG_GUID "guid" 508fa9e4066Sahrens #define ZPOOL_CONFIG_PATH "path" 509fa9e4066Sahrens #define ZPOOL_CONFIG_DEVID "devid" 510fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 511fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 512fa9e4066Sahrens #define ZPOOL_CONFIG_ASHIFT "ashift" 513fa9e4066Sahrens #define ZPOOL_CONFIG_ASIZE "asize" 514fa9e4066Sahrens #define ZPOOL_CONFIG_DTL "DTL" 5153f9d6ad7SLin Ling #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 5163f9d6ad7SLin Ling #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 517afefbcddSeschrock #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 518ea8dc4b6Seschrock #define ZPOOL_CONFIG_ERRCOUNT "error_count" 519ea8dc4b6Seschrock #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 52099653d4eSeschrock #define ZPOOL_CONFIG_SPARES "spares" 52199653d4eSeschrock #define ZPOOL_CONFIG_IS_SPARE "is_spare" 52299653d4eSeschrock #define ZPOOL_CONFIG_NPARITY "nparity" 52395173954Sek #define ZPOOL_CONFIG_HOSTID "hostid" 52495173954Sek #define ZPOOL_CONFIG_HOSTNAME "hostname" 52511027bc7STim Haley #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 5263d7072f8Seschrock #define ZPOOL_CONFIG_UNSPARE "unspare" 5273d7072f8Seschrock #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 5288654d025Sperrin #define ZPOOL_CONFIG_IS_LOG "is_log" 529fa94a07fSbrendan #define ZPOOL_CONFIG_L2CACHE "l2cache" 53088ecc943SGeorge Wilson #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 53188ecc943SGeorge Wilson #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 53288ecc943SGeorge Wilson #define ZPOOL_CONFIG_IS_HOLE "is_hole" 5339eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 5349eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 5359eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 5361195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT "splitcfg" 5371195e687SMark J Musante #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 5381195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 5391195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 5403f9d6ad7SLin Ling #define ZPOOL_CONFIG_REMOVING "removing" 541b4952e17SGeorge Wilson #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg" 5428704186eSDan McDonald #define ZPOOL_CONFIG_COMMENT "comment" 543e14bb325SJeff Bonwick #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 544e7cbe64fSgw #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 545e7cbe64fSgw #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 5464b964adaSGeorge Wilson #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 5474b964adaSGeorge Wilson #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 548ad135b5dSChristopher Siden #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */ 549ad135b5dSChristopher Siden #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */ 55057221772SChristopher Siden #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */ 551ad135b5dSChristopher Siden #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */ 552ad135b5dSChristopher Siden #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 553ad135b5dSChristopher Siden #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */ 5543d7072f8Seschrock /* 5553d7072f8Seschrock * The persistent vdev state is stored as separate values rather than a single 5563d7072f8Seschrock * 'vdev_state' entry. This is because a device can be in multiple states, such 5573d7072f8Seschrock * as offline and degraded. 5583d7072f8Seschrock */ 5593d7072f8Seschrock #define ZPOOL_CONFIG_OFFLINE "offline" 5603d7072f8Seschrock #define ZPOOL_CONFIG_FAULTED "faulted" 5613d7072f8Seschrock #define ZPOOL_CONFIG_DEGRADED "degraded" 5623d7072f8Seschrock #define ZPOOL_CONFIG_REMOVED "removed" 5636809eb4eSEric Schrock #define ZPOOL_CONFIG_FRU "fru" 564069f55e2SEric Schrock #define ZPOOL_CONFIG_AUX_STATE "aux_state" 565fa9e4066Sahrens 566468c413aSTim Haley /* Rewind policy parameters */ 567468c413aSTim Haley #define ZPOOL_REWIND_POLICY "rewind-policy" 568468c413aSTim Haley #define ZPOOL_REWIND_REQUEST "rewind-request" 569468c413aSTim Haley #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg" 570468c413aSTim Haley #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh" 571468c413aSTim Haley #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh" 572468c413aSTim Haley 573468c413aSTim Haley /* Rewind data discovered */ 574468c413aSTim Haley #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 575468c413aSTim Haley #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 576468c413aSTim Haley #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 577468c413aSTim Haley 578fa9e4066Sahrens #define VDEV_TYPE_ROOT "root" 579fa9e4066Sahrens #define VDEV_TYPE_MIRROR "mirror" 580fa9e4066Sahrens #define VDEV_TYPE_REPLACING "replacing" 581fa9e4066Sahrens #define VDEV_TYPE_RAIDZ "raidz" 582fa9e4066Sahrens #define VDEV_TYPE_DISK "disk" 583fa9e4066Sahrens #define VDEV_TYPE_FILE "file" 584fa9e4066Sahrens #define VDEV_TYPE_MISSING "missing" 58588ecc943SGeorge Wilson #define VDEV_TYPE_HOLE "hole" 58699653d4eSeschrock #define VDEV_TYPE_SPARE "spare" 5878654d025Sperrin #define VDEV_TYPE_LOG "log" 588fa94a07fSbrendan #define VDEV_TYPE_L2CACHE "l2cache" 589fa9e4066Sahrens 590fa9e4066Sahrens /* 591fa9e4066Sahrens * This is needed in userland to report the minimum necessary device size. 592fa9e4066Sahrens */ 593fa9e4066Sahrens #define SPA_MINDEVSIZE (64ULL << 20) 594fa9e4066Sahrens 5952e4c9986SGeorge Wilson /* 5962e4c9986SGeorge Wilson * Set if the fragmentation has not yet been calculated. This can happen 5972e4c9986SGeorge Wilson * because the space maps have not been upgraded or the histogram feature 5982e4c9986SGeorge Wilson * is not enabled. 5992e4c9986SGeorge Wilson */ 6002e4c9986SGeorge Wilson #define ZFS_FRAG_INVALID UINT64_MAX 6012e4c9986SGeorge Wilson 602fa9e4066Sahrens /* 603fa9e4066Sahrens * The location of the pool configuration repository, shared between kernel and 604fa9e4066Sahrens * userland. 605fa9e4066Sahrens */ 606c5904d13Seschrock #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 607fa9e4066Sahrens 608fa9e4066Sahrens /* 609fa9e4066Sahrens * vdev states are ordered from least to most healthy. 610fa9e4066Sahrens * A vdev that's CANT_OPEN or below is considered unusable. 611fa9e4066Sahrens */ 612fa9e4066Sahrens typedef enum vdev_state { 613fa9e4066Sahrens VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 614fa9e4066Sahrens VDEV_STATE_CLOSED, /* Not currently open */ 615fa9e4066Sahrens VDEV_STATE_OFFLINE, /* Not allowed to open */ 6163d7072f8Seschrock VDEV_STATE_REMOVED, /* Explicitly removed from system */ 617fa9e4066Sahrens VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 6183d7072f8Seschrock VDEV_STATE_FAULTED, /* External request to fault device */ 619fa9e4066Sahrens VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 620fa9e4066Sahrens VDEV_STATE_HEALTHY /* Presumed good */ 621fa9e4066Sahrens } vdev_state_t; 622fa9e4066Sahrens 6233d7072f8Seschrock #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 6243d7072f8Seschrock 625fa9e4066Sahrens /* 626fa9e4066Sahrens * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 627fa9e4066Sahrens * of the vdev stats structure uses these constants to distinguish why. 628fa9e4066Sahrens */ 629fa9e4066Sahrens typedef enum vdev_aux { 630fa9e4066Sahrens VDEV_AUX_NONE, /* no error */ 631fa9e4066Sahrens VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 632fa9e4066Sahrens VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 633fa9e4066Sahrens VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 634fa9e4066Sahrens VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 635fa9e4066Sahrens VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 636eaca9bbdSeschrock VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 637eaca9bbdSeschrock VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 63899653d4eSeschrock VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 639ad135b5dSChristopher Siden VDEV_AUX_UNSUP_FEAT, /* unsupported features */ 6403d7072f8Seschrock VDEV_AUX_SPARED, /* hot spare used in another pool */ 64132b87932Sek VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 642b87f3af3Sperrin VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 643069f55e2SEric Schrock VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 6441195e687SMark J Musante VDEV_AUX_EXTERNAL, /* external diagnosis */ 6451195e687SMark J Musante VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */ 646fa9e4066Sahrens } vdev_aux_t; 647fa9e4066Sahrens 648fa9e4066Sahrens /* 64946a2abf2Seschrock * pool state. The following states are written to disk as part of the normal 650fa94a07fSbrendan * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 651fa94a07fSbrendan * states are software abstractions used at various levels to communicate 652fa94a07fSbrendan * pool state. 653fa9e4066Sahrens */ 654fa9e4066Sahrens typedef enum pool_state { 655fa9e4066Sahrens POOL_STATE_ACTIVE = 0, /* In active use */ 656fa9e4066Sahrens POOL_STATE_EXPORTED, /* Explicitly exported */ 657fa9e4066Sahrens POOL_STATE_DESTROYED, /* Explicitly destroyed */ 65899653d4eSeschrock POOL_STATE_SPARE, /* Reserved for hot spare use */ 659fa94a07fSbrendan POOL_STATE_L2CACHE, /* Level 2 ARC device */ 660fa9e4066Sahrens POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 66146a2abf2Seschrock POOL_STATE_UNAVAIL, /* Internal libzfs state */ 66246a2abf2Seschrock POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 663fa9e4066Sahrens } pool_state_t; 664fa9e4066Sahrens 665fa9e4066Sahrens /* 6663f9d6ad7SLin Ling * Scan Functions. 667fa9e4066Sahrens */ 6683f9d6ad7SLin Ling typedef enum pool_scan_func { 6693f9d6ad7SLin Ling POOL_SCAN_NONE, 6703f9d6ad7SLin Ling POOL_SCAN_SCRUB, 6713f9d6ad7SLin Ling POOL_SCAN_RESILVER, 6723f9d6ad7SLin Ling POOL_SCAN_FUNCS 6733f9d6ad7SLin Ling } pool_scan_func_t; 674fa9e4066Sahrens 675fa9e4066Sahrens /* 676fa9e4066Sahrens * ZIO types. Needed to interpret vdev statistics below. 677fa9e4066Sahrens */ 678fa9e4066Sahrens typedef enum zio_type { 679fa9e4066Sahrens ZIO_TYPE_NULL = 0, 680fa9e4066Sahrens ZIO_TYPE_READ, 681fa9e4066Sahrens ZIO_TYPE_WRITE, 682fa9e4066Sahrens ZIO_TYPE_FREE, 683fa9e4066Sahrens ZIO_TYPE_CLAIM, 684fa9e4066Sahrens ZIO_TYPE_IOCTL, 685fa9e4066Sahrens ZIO_TYPES 686fa9e4066Sahrens } zio_type_t; 687fa9e4066Sahrens 6883f9d6ad7SLin Ling /* 6893f9d6ad7SLin Ling * Pool statistics. Note: all fields should be 64-bit because this 6903f9d6ad7SLin Ling * is passed between kernel and userland as an nvlist uint64 array. 6913f9d6ad7SLin Ling */ 6923f9d6ad7SLin Ling typedef struct pool_scan_stat { 6933f9d6ad7SLin Ling /* values stored on disk */ 6943f9d6ad7SLin Ling uint64_t pss_func; /* pool_scan_func_t */ 6953f9d6ad7SLin Ling uint64_t pss_state; /* dsl_scan_state_t */ 6963f9d6ad7SLin Ling uint64_t pss_start_time; /* scan start time */ 6973f9d6ad7SLin Ling uint64_t pss_end_time; /* scan end time */ 6983f9d6ad7SLin Ling uint64_t pss_to_examine; /* total bytes to scan */ 6993f9d6ad7SLin Ling uint64_t pss_examined; /* total examined bytes */ 7003f9d6ad7SLin Ling uint64_t pss_to_process; /* total bytes to process */ 7013f9d6ad7SLin Ling uint64_t pss_processed; /* total processed bytes */ 7023f9d6ad7SLin Ling uint64_t pss_errors; /* scan errors */ 7033f9d6ad7SLin Ling 7043f9d6ad7SLin Ling /* values not stored on disk */ 7053f9d6ad7SLin Ling uint64_t pss_pass_exam; /* examined bytes per scan pass */ 7063f9d6ad7SLin Ling uint64_t pss_pass_start; /* start time of a scan pass */ 7073f9d6ad7SLin Ling } pool_scan_stat_t; 7083f9d6ad7SLin Ling 7093f9d6ad7SLin Ling typedef enum dsl_scan_state { 7103f9d6ad7SLin Ling DSS_NONE, 7113f9d6ad7SLin Ling DSS_SCANNING, 7123f9d6ad7SLin Ling DSS_FINISHED, 7133f9d6ad7SLin Ling DSS_CANCELED, 7143f9d6ad7SLin Ling DSS_NUM_STATES 7153f9d6ad7SLin Ling } dsl_scan_state_t; 7163f9d6ad7SLin Ling 7173f9d6ad7SLin Ling 718fa9e4066Sahrens /* 719fa9e4066Sahrens * Vdev statistics. Note: all fields should be 64-bit because this 720fa9e4066Sahrens * is passed between kernel and userland as an nvlist uint64 array. 721fa9e4066Sahrens */ 722fa9e4066Sahrens typedef struct vdev_stat { 723fa9e4066Sahrens hrtime_t vs_timestamp; /* time since vdev load */ 724fa9e4066Sahrens uint64_t vs_state; /* vdev state */ 725fa9e4066Sahrens uint64_t vs_aux; /* see vdev_aux_t */ 726fa9e4066Sahrens uint64_t vs_alloc; /* space allocated */ 727fa9e4066Sahrens uint64_t vs_space; /* total capacity */ 72899653d4eSeschrock uint64_t vs_dspace; /* deflated capacity */ 7292a79c5feSlling uint64_t vs_rsize; /* replaceable dev size */ 7304263d13fSGeorge Wilson uint64_t vs_esize; /* expandable dev size */ 731fa9e4066Sahrens uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 732fa9e4066Sahrens uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 733fa9e4066Sahrens uint64_t vs_read_errors; /* read errors */ 734fa9e4066Sahrens uint64_t vs_write_errors; /* write errors */ 735fa9e4066Sahrens uint64_t vs_checksum_errors; /* checksum errors */ 736fa9e4066Sahrens uint64_t vs_self_healed; /* self-healed bytes */ 7373f9d6ad7SLin Ling uint64_t vs_scan_removing; /* removing? */ 7383f9d6ad7SLin Ling uint64_t vs_scan_processed; /* scan processed bytes */ 7392e4c9986SGeorge Wilson uint64_t vs_fragmentation; /* device fragmentation */ 740fa9e4066Sahrens } vdev_stat_t; 741fa9e4066Sahrens 7429eb19f4dSGeorge Wilson /* 7439eb19f4dSGeorge Wilson * DDT statistics. Note: all fields should be 64-bit because this 7449eb19f4dSGeorge Wilson * is passed between kernel and userland as an nvlist uint64 array. 7459eb19f4dSGeorge Wilson */ 7469eb19f4dSGeorge Wilson typedef struct ddt_object { 7479eb19f4dSGeorge Wilson uint64_t ddo_count; /* number of elments in ddt */ 7489eb19f4dSGeorge Wilson uint64_t ddo_dspace; /* size of ddt on disk */ 7499eb19f4dSGeorge Wilson uint64_t ddo_mspace; /* size of ddt in-core */ 7509eb19f4dSGeorge Wilson } ddt_object_t; 7519eb19f4dSGeorge Wilson 7529eb19f4dSGeorge Wilson typedef struct ddt_stat { 7539eb19f4dSGeorge Wilson uint64_t dds_blocks; /* blocks */ 7549eb19f4dSGeorge Wilson uint64_t dds_lsize; /* logical size */ 7559eb19f4dSGeorge Wilson uint64_t dds_psize; /* physical size */ 7569eb19f4dSGeorge Wilson uint64_t dds_dsize; /* deflated allocated size */ 7579eb19f4dSGeorge Wilson uint64_t dds_ref_blocks; /* referenced blocks */ 7589eb19f4dSGeorge Wilson uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 7599eb19f4dSGeorge Wilson uint64_t dds_ref_psize; /* referenced psize * refcnt */ 7609eb19f4dSGeorge Wilson uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 7619eb19f4dSGeorge Wilson } ddt_stat_t; 7629eb19f4dSGeorge Wilson 7639eb19f4dSGeorge Wilson typedef struct ddt_histogram { 7649eb19f4dSGeorge Wilson ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 7659eb19f4dSGeorge Wilson } ddt_histogram_t; 7669eb19f4dSGeorge Wilson 767e7cbe64fSgw #define ZVOL_DRIVER "zvol" 768fa9e4066Sahrens #define ZFS_DRIVER "zfs" 769fa9e4066Sahrens #define ZFS_DEV "/dev/zfs" 770fa9e4066Sahrens 771681d9761SEric Taylor /* general zvol path */ 772681d9761SEric Taylor #define ZVOL_DIR "/dev/zvol" 773681d9761SEric Taylor /* expansion */ 774573ca77eSGeorge Wilson #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 775681d9761SEric Taylor /* for dump and swap */ 776681d9761SEric Taylor #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 777681d9761SEric Taylor #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 778fa9e4066Sahrens 779fa9e4066Sahrens #define ZVOL_PROP_NAME "name" 780c1449561SEric Taylor #define ZVOL_DEFAULT_BLOCKSIZE 8192 781fa9e4066Sahrens 782fa9e4066Sahrens /* 783fa9e4066Sahrens * /dev/zfs ioctl numbers. 784fa9e4066Sahrens */ 785fa9e4066Sahrens typedef enum zfs_ioc { 7864445fffbSMatthew Ahrens ZFS_IOC_FIRST = ('Z' << 8), 7874445fffbSMatthew Ahrens ZFS_IOC = ZFS_IOC_FIRST, 7884445fffbSMatthew Ahrens ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, 789fa9e4066Sahrens ZFS_IOC_POOL_DESTROY, 790fa9e4066Sahrens ZFS_IOC_POOL_IMPORT, 791fa9e4066Sahrens ZFS_IOC_POOL_EXPORT, 792fa9e4066Sahrens ZFS_IOC_POOL_CONFIGS, 793fa9e4066Sahrens ZFS_IOC_POOL_STATS, 794fa9e4066Sahrens ZFS_IOC_POOL_TRYIMPORT, 7953f9d6ad7SLin Ling ZFS_IOC_POOL_SCAN, 796fa9e4066Sahrens ZFS_IOC_POOL_FREEZE, 797eaca9bbdSeschrock ZFS_IOC_POOL_UPGRADE, 79806eeb2adSek ZFS_IOC_POOL_GET_HISTORY, 799fa9e4066Sahrens ZFS_IOC_VDEV_ADD, 800fa9e4066Sahrens ZFS_IOC_VDEV_REMOVE, 8013d7072f8Seschrock ZFS_IOC_VDEV_SET_STATE, 802fa9e4066Sahrens ZFS_IOC_VDEV_ATTACH, 803fa9e4066Sahrens ZFS_IOC_VDEV_DETACH, 804c67d9675Seschrock ZFS_IOC_VDEV_SETPATH, 8056809eb4eSEric Schrock ZFS_IOC_VDEV_SETFRU, 806fa9e4066Sahrens ZFS_IOC_OBJSET_STATS, 807de8267e0Stimh ZFS_IOC_OBJSET_ZPLPROPS, 808fa9e4066Sahrens ZFS_IOC_DATASET_LIST_NEXT, 809fa9e4066Sahrens ZFS_IOC_SNAPSHOT_LIST_NEXT, 810fa9e4066Sahrens ZFS_IOC_SET_PROP, 811fa9e4066Sahrens ZFS_IOC_CREATE, 812fa9e4066Sahrens ZFS_IOC_DESTROY, 813fa9e4066Sahrens ZFS_IOC_ROLLBACK, 814fa9e4066Sahrens ZFS_IOC_RENAME, 8153cb34c60Sahrens ZFS_IOC_RECV, 8163cb34c60Sahrens ZFS_IOC_SEND, 817ea8dc4b6Seschrock ZFS_IOC_INJECT_FAULT, 818ea8dc4b6Seschrock ZFS_IOC_CLEAR_FAULT, 819ea8dc4b6Seschrock ZFS_IOC_INJECT_LIST_NEXT, 820ea8dc4b6Seschrock ZFS_IOC_ERROR_LOG, 821ea8dc4b6Seschrock ZFS_IOC_CLEAR, 8221d452cf5Sahrens ZFS_IOC_PROMOTE, 82355434c77Sek ZFS_IOC_SNAPSHOT, 82455434c77Sek ZFS_IOC_DSOBJ_TO_DSNAME, 825b1b8ab34Slling ZFS_IOC_OBJ_TO_PATH, 826b1b8ab34Slling ZFS_IOC_POOL_SET_PROPS, 827ecd6cf80Smarks ZFS_IOC_POOL_GET_PROPS, 828ecd6cf80Smarks ZFS_IOC_SET_FSACL, 829ecd6cf80Smarks ZFS_IOC_GET_FSACL, 830e45ce728Sahrens ZFS_IOC_SHARE, 831743a77edSAlan Wright ZFS_IOC_INHERIT_PROP, 83214843421SMatthew Ahrens ZFS_IOC_SMB_ACL, 83314843421SMatthew Ahrens ZFS_IOC_USERSPACE_ONE, 83414843421SMatthew Ahrens ZFS_IOC_USERSPACE_MANY, 835842727c2SChris Kirby ZFS_IOC_USERSPACE_UPGRADE, 836842727c2SChris Kirby ZFS_IOC_HOLD, 837842727c2SChris Kirby ZFS_IOC_RELEASE, 83892241e0bSTom Erickson ZFS_IOC_GET_HOLDS, 8391195e687SMark J Musante ZFS_IOC_OBJSET_RECVD_PROPS, 84099d5e173STim Haley ZFS_IOC_VDEV_SPLIT, 84199d5e173STim Haley ZFS_IOC_NEXT_OBJ, 84299d5e173STim Haley ZFS_IOC_DIFF, 84399d5e173STim Haley ZFS_IOC_TMP_SNAPSHOT, 844e9103aaeSGarrett D'Amore ZFS_IOC_OBJ_TO_STATS, 84519b94df9SMatthew Ahrens ZFS_IOC_SPACE_WRITTEN, 84619b94df9SMatthew Ahrens ZFS_IOC_SPACE_SNAPS, 8474445fffbSMatthew Ahrens ZFS_IOC_DESTROY_SNAPS, 8484263d13fSGeorge Wilson ZFS_IOC_POOL_REGUID, 8494e3c9f44SBill Pijewski ZFS_IOC_POOL_REOPEN, 8504445fffbSMatthew Ahrens ZFS_IOC_SEND_PROGRESS, 8514445fffbSMatthew Ahrens ZFS_IOC_LOG_HISTORY, 8524445fffbSMatthew Ahrens ZFS_IOC_SEND_NEW, 8534445fffbSMatthew Ahrens ZFS_IOC_SEND_SPACE, 8544445fffbSMatthew Ahrens ZFS_IOC_CLONE, 85578f17100SMatthew Ahrens ZFS_IOC_BOOKMARK, 85678f17100SMatthew Ahrens ZFS_IOC_GET_BOOKMARKS, 85778f17100SMatthew Ahrens ZFS_IOC_DESTROY_BOOKMARKS, 8584445fffbSMatthew Ahrens ZFS_IOC_LAST 859fa9e4066Sahrens } zfs_ioc_t; 860fa9e4066Sahrens 861ea8dc4b6Seschrock /* 862ea8dc4b6Seschrock * Internal SPA load state. Used by FMA diagnosis engine. 863ea8dc4b6Seschrock */ 864ea8dc4b6Seschrock typedef enum { 8659eb19f4dSGeorge Wilson SPA_LOAD_NONE, /* no load in progress */ 8669eb19f4dSGeorge Wilson SPA_LOAD_OPEN, /* normal open */ 8679eb19f4dSGeorge Wilson SPA_LOAD_IMPORT, /* import in progress */ 868468c413aSTim Haley SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 8699eb19f4dSGeorge Wilson SPA_LOAD_RECOVER, /* recovery requested */ 8709eb19f4dSGeorge Wilson SPA_LOAD_ERROR /* load failed */ 871ea8dc4b6Seschrock } spa_load_state_t; 872ea8dc4b6Seschrock 873e9dbad6fSeschrock /* 874e9dbad6fSeschrock * Bookmark name values. 875e9dbad6fSeschrock */ 87655434c77Sek #define ZPOOL_ERR_LIST "error list" 877e9dbad6fSeschrock #define ZPOOL_ERR_DATASET "dataset" 878e9dbad6fSeschrock #define ZPOOL_ERR_OBJECT "object" 879e9dbad6fSeschrock 88006eeb2adSek #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 88106eeb2adSek 88206eeb2adSek /* 88306eeb2adSek * The following are names used in the nvlist describing 88406eeb2adSek * the pool's history log. 88506eeb2adSek */ 88606eeb2adSek #define ZPOOL_HIST_RECORD "history record" 88706eeb2adSek #define ZPOOL_HIST_TIME "history time" 88806eeb2adSek #define ZPOOL_HIST_CMD "history command" 889ecd6cf80Smarks #define ZPOOL_HIST_WHO "history who" 890ecd6cf80Smarks #define ZPOOL_HIST_ZONE "history zone" 891ecd6cf80Smarks #define ZPOOL_HIST_HOST "history hostname" 892ecd6cf80Smarks #define ZPOOL_HIST_TXG "history txg" 893ecd6cf80Smarks #define ZPOOL_HIST_INT_EVENT "history internal event" 894ecd6cf80Smarks #define ZPOOL_HIST_INT_STR "history internal str" 8954445fffbSMatthew Ahrens #define ZPOOL_HIST_INT_NAME "internal_name" 8964445fffbSMatthew Ahrens #define ZPOOL_HIST_IOCTL "ioctl" 8974445fffbSMatthew Ahrens #define ZPOOL_HIST_INPUT_NVL "in_nvl" 8984445fffbSMatthew Ahrens #define ZPOOL_HIST_OUTPUT_NVL "out_nvl" 8994445fffbSMatthew Ahrens #define ZPOOL_HIST_DSNAME "dsname" 9004445fffbSMatthew Ahrens #define ZPOOL_HIST_DSID "dsid" 90106eeb2adSek 9023d7072f8Seschrock /* 9033d7072f8Seschrock * Flags for ZFS_IOC_VDEV_SET_STATE 9043d7072f8Seschrock */ 9053d7072f8Seschrock #define ZFS_ONLINE_CHECKREMOVE 0x1 9063d7072f8Seschrock #define ZFS_ONLINE_UNSPARE 0x2 9073d7072f8Seschrock #define ZFS_ONLINE_FORCEFAULT 0x4 908573ca77eSGeorge Wilson #define ZFS_ONLINE_EXPAND 0x8 9093d7072f8Seschrock #define ZFS_OFFLINE_TEMPORARY 0x1 9103d7072f8Seschrock 9114b964adaSGeorge Wilson /* 9124b964adaSGeorge Wilson * Flags for ZFS_IOC_POOL_IMPORT 9134b964adaSGeorge Wilson */ 9144b964adaSGeorge Wilson #define ZFS_IMPORT_NORMAL 0x0 9154b964adaSGeorge Wilson #define ZFS_IMPORT_VERBATIM 0x1 9164b964adaSGeorge Wilson #define ZFS_IMPORT_ANY_HOST 0x2 9174b964adaSGeorge Wilson #define ZFS_IMPORT_MISSING_LOG 0x4 918f9af39baSGeorge Wilson #define ZFS_IMPORT_ONLY 0x8 9194b964adaSGeorge Wilson 9203d7072f8Seschrock /* 9213d7072f8Seschrock * Sysevent payload members. ZFS will generate the following sysevents with the 9223d7072f8Seschrock * given payloads: 9233d7072f8Seschrock * 9243d7072f8Seschrock * ESC_ZFS_RESILVER_START 9253d7072f8Seschrock * ESC_ZFS_RESILVER_END 9263d7072f8Seschrock * ESC_ZFS_POOL_DESTROY 927e9103aaeSGarrett D'Amore * ESC_ZFS_POOL_REGUID 9283d7072f8Seschrock * 9293d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 9303d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 9313d7072f8Seschrock * 9323d7072f8Seschrock * ESC_ZFS_VDEV_REMOVE 9333d7072f8Seschrock * ESC_ZFS_VDEV_CLEAR 9343d7072f8Seschrock * ESC_ZFS_VDEV_CHECK 9353d7072f8Seschrock * 9363d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 9373d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 9383d7072f8Seschrock * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 9393d7072f8Seschrock * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 9403d7072f8Seschrock */ 9413d7072f8Seschrock #define ZFS_EV_POOL_NAME "pool_name" 9423d7072f8Seschrock #define ZFS_EV_POOL_GUID "pool_guid" 9433d7072f8Seschrock #define ZFS_EV_VDEV_PATH "vdev_path" 9443d7072f8Seschrock #define ZFS_EV_VDEV_GUID "vdev_guid" 9453d7072f8Seschrock 946fa9e4066Sahrens #ifdef __cplusplus 947fa9e4066Sahrens } 948fa9e4066Sahrens #endif 949fa9e4066Sahrens 950fa9e4066Sahrens #endif /* _SYS_FS_ZFS_H */ 951