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. 27c3d26abcSMatthew 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 5726455f9eSAndriy Gapon /* 5826455f9eSAndriy Gapon * NB: lzc_dataset_type should be updated whenever a new objset type is added, 5926455f9eSAndriy Gapon * if it represents a real type of a dataset that can be created from userland. 6026455f9eSAndriy Gapon */ 614445fffbSMatthew Ahrens typedef enum dmu_objset_type { 624445fffbSMatthew Ahrens DMU_OST_NONE, 634445fffbSMatthew Ahrens DMU_OST_META, 644445fffbSMatthew Ahrens DMU_OST_ZFS, 654445fffbSMatthew Ahrens DMU_OST_ZVOL, 664445fffbSMatthew Ahrens DMU_OST_OTHER, /* For testing only! */ 674445fffbSMatthew Ahrens DMU_OST_ANY, /* Be careful! */ 684445fffbSMatthew Ahrens DMU_OST_NUMTYPES 694445fffbSMatthew Ahrens } dmu_objset_type_t; 704445fffbSMatthew Ahrens 71990b4856Slling #define ZFS_TYPE_DATASET \ 72fa9e4066Sahrens (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 73fa9e4066Sahrens 74*9adfa60dSMatthew Ahrens /* 75*9adfa60dSMatthew Ahrens * All of these include the terminating NUL byte. 76*9adfa60dSMatthew Ahrens */ 77478ed9adSEric Taylor #define ZAP_MAXNAMELEN 256 78478ed9adSEric Taylor #define ZAP_MAXVALUELEN (1024 * 8) 79478ed9adSEric Taylor #define ZAP_OLDMAXVALUELEN 1024 80*9adfa60dSMatthew Ahrens #define ZFS_MAX_DATASET_NAME_LEN 256 81478ed9adSEric Taylor 82fa9e4066Sahrens /* 83990b4856Slling * Dataset properties are identified by these constants and must be added to 84990b4856Slling * the end of this list to ensure that external consumers are not affected 85990b4856Slling * by the change. If you make any changes to this list, be sure to update 8666e2aaccSgw * the property table in usr/src/common/zfs/zfs_prop.c. 87fa9e4066Sahrens */ 88fa9e4066Sahrens typedef enum { 89c16bcc45SIgor Kozhukhov ZFS_PROP_BAD = -1, 90c16bcc45SIgor Kozhukhov ZFS_PROP_TYPE = 0, 91fa9e4066Sahrens ZFS_PROP_CREATION, 92fa9e4066Sahrens ZFS_PROP_USED, 93fa9e4066Sahrens ZFS_PROP_AVAILABLE, 94fa9e4066Sahrens ZFS_PROP_REFERENCED, 95fa9e4066Sahrens ZFS_PROP_COMPRESSRATIO, 96fa9e4066Sahrens ZFS_PROP_MOUNTED, 97fa9e4066Sahrens ZFS_PROP_ORIGIN, 98fa9e4066Sahrens ZFS_PROP_QUOTA, 99fa9e4066Sahrens ZFS_PROP_RESERVATION, 100fa9e4066Sahrens ZFS_PROP_VOLSIZE, 101fa9e4066Sahrens ZFS_PROP_VOLBLOCKSIZE, 102fa9e4066Sahrens ZFS_PROP_RECORDSIZE, 103fa9e4066Sahrens ZFS_PROP_MOUNTPOINT, 104fa9e4066Sahrens ZFS_PROP_SHARENFS, 105fa9e4066Sahrens ZFS_PROP_CHECKSUM, 106fa9e4066Sahrens ZFS_PROP_COMPRESSION, 107fa9e4066Sahrens ZFS_PROP_ATIME, 108fa9e4066Sahrens ZFS_PROP_DEVICES, 109fa9e4066Sahrens ZFS_PROP_EXEC, 110fa9e4066Sahrens ZFS_PROP_SETUID, 111fa9e4066Sahrens ZFS_PROP_READONLY, 112fa9e4066Sahrens ZFS_PROP_ZONED, 113fa9e4066Sahrens ZFS_PROP_SNAPDIR, 114a3c49ce1SAlbert Lee ZFS_PROP_ACLMODE, 115fa9e4066Sahrens ZFS_PROP_ACLINHERIT, 11666e2aaccSgw ZFS_PROP_CREATETXG, /* not exposed to the user */ 11766e2aaccSgw ZFS_PROP_NAME, /* not exposed to the user */ 118e9dbad6fSeschrock ZFS_PROP_CANMOUNT, 11966e2aaccSgw ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 1207b55fa8eSck ZFS_PROP_XATTR, 121d0ad202dSahrens ZFS_PROP_NUMCLONES, /* not exposed to the user */ 122b1b8ab34Slling ZFS_PROP_COPIES, 123e7437265Sahrens ZFS_PROP_VERSION, 124da6c28aaSamw ZFS_PROP_UTF8ONLY, 125da6c28aaSamw ZFS_PROP_NORMALIZE, 126da6c28aaSamw ZFS_PROP_CASE, 127da6c28aaSamw ZFS_PROP_VSCAN, 128da6c28aaSamw ZFS_PROP_NBMAND, 129da6c28aaSamw ZFS_PROP_SHARESMB, 130a9799022Sck ZFS_PROP_REFQUOTA, 131a9799022Sck ZFS_PROP_REFRESERVATION, 132c5904d13Seschrock ZFS_PROP_GUID, 1333baa08fcSek ZFS_PROP_PRIMARYCACHE, 1343baa08fcSek ZFS_PROP_SECONDARYCACHE, 13574e7dc98SMatthew Ahrens ZFS_PROP_USEDSNAP, 13674e7dc98SMatthew Ahrens ZFS_PROP_USEDDS, 13774e7dc98SMatthew Ahrens ZFS_PROP_USEDCHILD, 13874e7dc98SMatthew Ahrens ZFS_PROP_USEDREFRESERV, 13914843421SMatthew Ahrens ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 140478ed9adSEric Taylor ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 141842727c2SChris Kirby ZFS_PROP_DEFER_DESTROY, 142842727c2SChris Kirby ZFS_PROP_USERREFS, 143e09fa4daSNeil Perrin ZFS_PROP_LOGBIAS, 1441d713200SEric Schrock ZFS_PROP_UNIQUE, /* not exposed to the user */ 1451d713200SEric Schrock ZFS_PROP_OBJSETID, /* not exposed to the user */ 146b24ab676SJeff Bonwick ZFS_PROP_DEDUP, 1474201a95eSRic Aleshire ZFS_PROP_MLSLABEL, 14855da60b9SMark J Musante ZFS_PROP_SYNC, 149187d6ac0SMatt Ahrens ZFS_PROP_REFRATIO, 15019b94df9SMatthew Ahrens ZFS_PROP_WRITTEN, 15119b94df9SMatthew Ahrens ZFS_PROP_CLONES, 15277372cb0SMatthew Ahrens ZFS_PROP_LOGICALUSED, 15377372cb0SMatthew Ahrens ZFS_PROP_LOGICALREFERENCED, 154ca48f36fSKeith M Wesolowski ZFS_PROP_INCONSISTENT, /* not exposed to the user */ 155a2afb611SJerry Jelinek ZFS_PROP_FILESYSTEM_LIMIT, 156a2afb611SJerry Jelinek ZFS_PROP_SNAPSHOT_LIMIT, 157a2afb611SJerry Jelinek ZFS_PROP_FILESYSTEM_COUNT, 158a2afb611SJerry Jelinek ZFS_PROP_SNAPSHOT_COUNT, 159edf345e6SMatthew Ahrens ZFS_PROP_REDUNDANT_METADATA, 160b461c746SMatthew Ahrens ZFS_PROP_PREV_SNAP, 1619c3fd121SMatthew Ahrens ZFS_PROP_RECEIVE_RESUME_TOKEN, 16291ebeef5Sahrens ZFS_NUM_PROPS 163fa9e4066Sahrens } zfs_prop_t; 164fa9e4066Sahrens 16514843421SMatthew Ahrens typedef enum { 16614843421SMatthew Ahrens ZFS_PROP_USERUSED, 16714843421SMatthew Ahrens ZFS_PROP_USERQUOTA, 16814843421SMatthew Ahrens ZFS_PROP_GROUPUSED, 16914843421SMatthew Ahrens ZFS_PROP_GROUPQUOTA, 17014843421SMatthew Ahrens ZFS_NUM_USERQUOTA_PROPS 17114843421SMatthew Ahrens } zfs_userquota_prop_t; 17214843421SMatthew Ahrens 17314843421SMatthew Ahrens extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS]; 17414843421SMatthew Ahrens 175990b4856Slling /* 176990b4856Slling * Pool properties are identified by these constants and must be added to the 177b87f3af3Sperrin * end of this list to ensure that external consumers are not affected 178990b4856Slling * by the change. If you make any changes to this list, be sure to update 179990b4856Slling * the property table in usr/src/common/zfs/zpool_prop.c. 180990b4856Slling */ 181990b4856Slling typedef enum { 182990b4856Slling ZPOOL_PROP_NAME, 183990b4856Slling ZPOOL_PROP_SIZE, 184990b4856Slling ZPOOL_PROP_CAPACITY, 185990b4856Slling ZPOOL_PROP_ALTROOT, 186990b4856Slling ZPOOL_PROP_HEALTH, 187990b4856Slling ZPOOL_PROP_GUID, 188990b4856Slling ZPOOL_PROP_VERSION, 189990b4856Slling ZPOOL_PROP_BOOTFS, 190990b4856Slling ZPOOL_PROP_DELEGATION, 191990b4856Slling ZPOOL_PROP_AUTOREPLACE, 1922f8aaab3Seschrock ZPOOL_PROP_CACHEFILE, 1930a4e9518Sgw ZPOOL_PROP_FAILUREMODE, 194d5b5bb25SRich Morris ZPOOL_PROP_LISTSNAPS, 195573ca77eSGeorge Wilson ZPOOL_PROP_AUTOEXPAND, 196b24ab676SJeff Bonwick ZPOOL_PROP_DEDUPDITTO, 197b24ab676SJeff Bonwick ZPOOL_PROP_DEDUPRATIO, 198485bbbf5SGeorge Wilson ZPOOL_PROP_FREE, 199485bbbf5SGeorge Wilson ZPOOL_PROP_ALLOCATED, 200f9af39baSGeorge Wilson ZPOOL_PROP_READONLY, 2018704186eSDan McDonald ZPOOL_PROP_COMMENT, 2024263d13fSGeorge Wilson ZPOOL_PROP_EXPANDSZ, 203ad135b5dSChristopher Siden ZPOOL_PROP_FREEING, 2042e4c9986SGeorge Wilson ZPOOL_PROP_FRAGMENTATION, 2057fd05ac4SMatthew Ahrens ZPOOL_PROP_LEAKED, 206b5152584SMatthew Ahrens ZPOOL_PROP_MAXBLOCKSIZE, 207990b4856Slling ZPOOL_NUM_PROPS 208990b4856Slling } zpool_prop_t; 209b1b8ab34Slling 2108704186eSDan McDonald /* Small enough to not hog a whole line of printout in zpool(1M). */ 2118704186eSDan McDonald #define ZPROP_MAX_COMMENT 32 2128704186eSDan McDonald 213990b4856Slling #define ZPROP_CONT -2 214990b4856Slling #define ZPROP_INVAL -1 2153d7072f8Seschrock 216990b4856Slling #define ZPROP_VALUE "value" 217990b4856Slling #define ZPROP_SOURCE "source" 2187f7322feSeschrock 219b1b8ab34Slling typedef enum { 220990b4856Slling ZPROP_SRC_NONE = 0x1, 221990b4856Slling ZPROP_SRC_DEFAULT = 0x2, 222990b4856Slling ZPROP_SRC_TEMPORARY = 0x4, 223990b4856Slling ZPROP_SRC_LOCAL = 0x8, 22492241e0bSTom Erickson ZPROP_SRC_INHERITED = 0x10, 22592241e0bSTom Erickson ZPROP_SRC_RECEIVED = 0x20 226990b4856Slling } zprop_source_t; 227990b4856Slling 22892241e0bSTom Erickson #define ZPROP_SRC_ALL 0x3f 22992241e0bSTom Erickson 23092241e0bSTom Erickson #define ZPROP_SOURCE_VAL_RECVD "$recvd" 23192241e0bSTom Erickson #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 23292241e0bSTom Erickson /* 23392241e0bSTom Erickson * Dataset flag implemented as a special entry in the props zap object 23492241e0bSTom Erickson * indicating that the dataset has received properties on or after 23592241e0bSTom Erickson * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 23692241e0bSTom Erickson * just as it did in earlier versions, and thereafter, local properties are 23792241e0bSTom Erickson * preserved. 23892241e0bSTom Erickson */ 23992241e0bSTom Erickson #define ZPROP_HAS_RECVD "$hasrecvd" 24092241e0bSTom Erickson 24192241e0bSTom Erickson typedef enum { 24292241e0bSTom Erickson ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 24392241e0bSTom Erickson ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 24492241e0bSTom Erickson } zprop_errflags_t; 245990b4856Slling 246990b4856Slling typedef int (*zprop_func)(int, void *); 247990b4856Slling 2480a48a24eStimh /* 2490a48a24eStimh * Properties to be set on the root file system of a new pool 2500a48a24eStimh * are stuffed into their own nvlist, which is then included in 2510a48a24eStimh * the properties nvlist with the pool properties. 2520a48a24eStimh */ 2530a48a24eStimh #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 2540a48a24eStimh 255990b4856Slling /* 256990b4856Slling * Dataset property functions shared between libzfs and kernel. 257990b4856Slling */ 258990b4856Slling const char *zfs_prop_default_string(zfs_prop_t); 259990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t); 260990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t); 261990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t); 262da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t); 263990b4856Slling const char *zfs_prop_to_name(zfs_prop_t); 264990b4856Slling zfs_prop_t zfs_name_to_prop(const char *); 265990b4856Slling boolean_t zfs_prop_user(const char *); 26692241e0bSTom Erickson boolean_t zfs_prop_userquota(const char *); 26719b94df9SMatthew Ahrens boolean_t zfs_prop_written(const char *); 268990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 269990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 270b24ab676SJeff Bonwick uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 2714853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 272b1b8ab34Slling 273990b4856Slling /* 274990b4856Slling * Pool property functions shared between libzfs and kernel. 275990b4856Slling */ 276990b4856Slling zpool_prop_t zpool_name_to_prop(const char *); 277990b4856Slling const char *zpool_prop_to_name(zpool_prop_t); 278990b4856Slling const char *zpool_prop_default_string(zpool_prop_t); 279990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t); 280990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t); 281ad135b5dSChristopher Siden boolean_t zpool_prop_feature(const char *); 282ad135b5dSChristopher Siden boolean_t zpool_prop_unsupported(const char *name); 283990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 284990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 285b24ab676SJeff Bonwick uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 286b1b8ab34Slling 287990b4856Slling /* 288990b4856Slling * Definitions for the Delegation. 289990b4856Slling */ 290ecd6cf80Smarks typedef enum { 291ecd6cf80Smarks ZFS_DELEG_WHO_UNKNOWN = 0, 292ecd6cf80Smarks ZFS_DELEG_USER = 'u', 293ecd6cf80Smarks ZFS_DELEG_USER_SETS = 'U', 294ecd6cf80Smarks ZFS_DELEG_GROUP = 'g', 295ecd6cf80Smarks ZFS_DELEG_GROUP_SETS = 'G', 296ecd6cf80Smarks ZFS_DELEG_EVERYONE = 'e', 297ecd6cf80Smarks ZFS_DELEG_EVERYONE_SETS = 'E', 298ecd6cf80Smarks ZFS_DELEG_CREATE = 'c', 299ecd6cf80Smarks ZFS_DELEG_CREATE_SETS = 'C', 300ecd6cf80Smarks ZFS_DELEG_NAMED_SET = 's', 301ecd6cf80Smarks ZFS_DELEG_NAMED_SET_SETS = 'S' 302ecd6cf80Smarks } zfs_deleg_who_type_t; 303ecd6cf80Smarks 304ecd6cf80Smarks typedef enum { 305ecd6cf80Smarks ZFS_DELEG_NONE = 0, 306ecd6cf80Smarks ZFS_DELEG_PERM_LOCAL = 1, 307ecd6cf80Smarks ZFS_DELEG_PERM_DESCENDENT = 2, 308ecd6cf80Smarks ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 309ecd6cf80Smarks ZFS_DELEG_PERM_CREATE = 4 310ecd6cf80Smarks } zfs_deleg_inherit_t; 311ecd6cf80Smarks 312ecd6cf80Smarks #define ZFS_DELEG_PERM_UID "uid" 313ecd6cf80Smarks #define ZFS_DELEG_PERM_GID "gid" 314ecd6cf80Smarks #define ZFS_DELEG_PERM_GROUPS "groups" 315ecd6cf80Smarks 3164201a95eSRic Aleshire #define ZFS_MLSLABEL_DEFAULT "none" 3174201a95eSRic Aleshire 318743a77edSAlan Wright #define ZFS_SMB_ACL_SRC "src" 319743a77edSAlan Wright #define ZFS_SMB_ACL_TARGET "target" 320743a77edSAlan Wright 321a227b7f4Shs typedef enum { 322a227b7f4Shs ZFS_CANMOUNT_OFF = 0, 323a227b7f4Shs ZFS_CANMOUNT_ON = 1, 324a227b7f4Shs ZFS_CANMOUNT_NOAUTO = 2 325a227b7f4Shs } zfs_canmount_type_t; 326a227b7f4Shs 327e09fa4daSNeil Perrin typedef enum { 328e09fa4daSNeil Perrin ZFS_LOGBIAS_LATENCY = 0, 329e09fa4daSNeil Perrin ZFS_LOGBIAS_THROUGHPUT = 1 330e09fa4daSNeil Perrin } zfs_logbias_op_t; 331e09fa4daSNeil Perrin 332da6c28aaSamw typedef enum zfs_share_op { 333da6c28aaSamw ZFS_SHARE_NFS = 0, 334da6c28aaSamw ZFS_UNSHARE_NFS = 1, 335da6c28aaSamw ZFS_SHARE_SMB = 2, 336da6c28aaSamw ZFS_UNSHARE_SMB = 3 337da6c28aaSamw } zfs_share_op_t; 338da6c28aaSamw 339743a77edSAlan Wright typedef enum zfs_smb_acl_op { 340743a77edSAlan Wright ZFS_SMB_ACL_ADD, 341743a77edSAlan Wright ZFS_SMB_ACL_REMOVE, 342743a77edSAlan Wright ZFS_SMB_ACL_RENAME, 343743a77edSAlan Wright ZFS_SMB_ACL_PURGE 344743a77edSAlan Wright } zfs_smb_acl_op_t; 345743a77edSAlan Wright 3463baa08fcSek typedef enum zfs_cache_type { 3473baa08fcSek ZFS_CACHE_NONE = 0, 3483baa08fcSek ZFS_CACHE_METADATA = 1, 3493baa08fcSek ZFS_CACHE_ALL = 2 3503baa08fcSek } zfs_cache_type_t; 3513baa08fcSek 35255da60b9SMark J Musante typedef enum { 35355da60b9SMark J Musante ZFS_SYNC_STANDARD = 0, 35455da60b9SMark J Musante ZFS_SYNC_ALWAYS = 1, 35555da60b9SMark J Musante ZFS_SYNC_DISABLED = 2 35655da60b9SMark J Musante } zfs_sync_type_t; 35755da60b9SMark J Musante 358edf345e6SMatthew Ahrens typedef enum { 359edf345e6SMatthew Ahrens ZFS_REDUNDANT_METADATA_ALL, 360edf345e6SMatthew Ahrens ZFS_REDUNDANT_METADATA_MOST 361edf345e6SMatthew Ahrens } zfs_redundant_metadata_type_t; 3623baa08fcSek 363eaca9bbdSeschrock /* 36499653d4eSeschrock * On-disk version number. 365eaca9bbdSeschrock */ 366e7437265Sahrens #define SPA_VERSION_1 1ULL 367e7437265Sahrens #define SPA_VERSION_2 2ULL 368e7437265Sahrens #define SPA_VERSION_3 3ULL 369e7437265Sahrens #define SPA_VERSION_4 4ULL 370e7437265Sahrens #define SPA_VERSION_5 5ULL 371e7437265Sahrens #define SPA_VERSION_6 6ULL 372e7437265Sahrens #define SPA_VERSION_7 7ULL 373e7437265Sahrens #define SPA_VERSION_8 8ULL 374da6c28aaSamw #define SPA_VERSION_9 9ULL 375fa94a07fSbrendan #define SPA_VERSION_10 10ULL 376088f3894Sahrens #define SPA_VERSION_11 11ULL 377bb0ade09Sahrens #define SPA_VERSION_12 12ULL 37874e7dc98SMatthew Ahrens #define SPA_VERSION_13 13ULL 379d0f3f37eSMark Shellenbaum #define SPA_VERSION_14 14ULL 38014843421SMatthew Ahrens #define SPA_VERSION_15 15ULL 381478ed9adSEric Taylor #define SPA_VERSION_16 16ULL 382f94275ceSAdam Leventhal #define SPA_VERSION_17 17ULL 383842727c2SChris Kirby #define SPA_VERSION_18 18ULL 38488ecc943SGeorge Wilson #define SPA_VERSION_19 19ULL 385b24ab676SJeff Bonwick #define SPA_VERSION_20 20ULL 386b24ab676SJeff Bonwick #define SPA_VERSION_21 21ULL 38792241e0bSTom Erickson #define SPA_VERSION_22 22ULL 3886e1f5caaSNeil Perrin #define SPA_VERSION_23 23ULL 3890a586ceaSMark Shellenbaum #define SPA_VERSION_24 24ULL 3903f9d6ad7SLin Ling #define SPA_VERSION_25 25ULL 391cde58dbcSMatthew Ahrens #define SPA_VERSION_26 26ULL 3926e0cbcaaSMatthew Ahrens #define SPA_VERSION_27 27ULL 393cb04b873SMark J Musante #define SPA_VERSION_28 28ULL 394ad135b5dSChristopher Siden #define SPA_VERSION_5000 5000ULL 395cb04b873SMark J Musante 396b1b8ab34Slling /* 397e7cbe64fSgw * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 398478ed9adSEric Taylor * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 39914843421SMatthew Ahrens * and do the appropriate changes. Also bump the version number in 40014843421SMatthew Ahrens * usr/src/grub/capability. 401b1b8ab34Slling */ 402ad135b5dSChristopher Siden #define SPA_VERSION SPA_VERSION_5000 403ad135b5dSChristopher Siden #define SPA_VERSION_STRING "5000" 40444cd46caSbillm 40544cd46caSbillm /* 406e7437265Sahrens * Symbolic names for the changes that caused a SPA_VERSION switch. 40744cd46caSbillm * Used in the code when checking for presence or absence of a feature. 40844cd46caSbillm * Feel free to define multiple symbolic names for each version if there 40944cd46caSbillm * were multiple changes to on-disk structures during that version. 41044cd46caSbillm * 411e7437265Sahrens * NOTE: When checking the current SPA_VERSION in your code, be sure 41244cd46caSbillm * to use spa_version() since it reports the version of the 41344cd46caSbillm * last synced uberblock. Checking the in-flight version can 41444cd46caSbillm * be dangerous in some cases. 41544cd46caSbillm */ 416e7437265Sahrens #define SPA_VERSION_INITIAL SPA_VERSION_1 417e7437265Sahrens #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 418e7437265Sahrens #define SPA_VERSION_SPARES SPA_VERSION_3 419f94275ceSAdam Leventhal #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 420cde58dbcSMatthew Ahrens #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 421e7437265Sahrens #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 422e7437265Sahrens #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 423e7437265Sahrens #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 424e7437265Sahrens #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 425e7437265Sahrens #define SPA_VERSION_BOOTFS SPA_VERSION_6 426990b4856Slling #define SPA_VERSION_SLOGS SPA_VERSION_7 427990b4856Slling #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 428da6c28aaSamw #define SPA_VERSION_FUID SPA_VERSION_9 429a9799022Sck #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 430a9799022Sck #define SPA_VERSION_REFQUOTA SPA_VERSION_9 431a9799022Sck #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 432fa94a07fSbrendan #define SPA_VERSION_L2CACHE SPA_VERSION_10 433088f3894Sahrens #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 434088f3894Sahrens #define SPA_VERSION_ORIGIN SPA_VERSION_11 435088f3894Sahrens #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 436bb0ade09Sahrens #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 43774e7dc98SMatthew Ahrens #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 438d0f3f37eSMark Shellenbaum #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 43914843421SMatthew Ahrens #define SPA_VERSION_USERSPACE SPA_VERSION_15 440478ed9adSEric Taylor #define SPA_VERSION_STMF_PROP SPA_VERSION_16 441f94275ceSAdam Leventhal #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 442842727c2SChris Kirby #define SPA_VERSION_USERREFS SPA_VERSION_18 44388ecc943SGeorge Wilson #define SPA_VERSION_HOLES SPA_VERSION_19 444b24ab676SJeff Bonwick #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 445b24ab676SJeff Bonwick #define SPA_VERSION_DEDUP SPA_VERSION_21 44692241e0bSTom Erickson #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 4476e1f5caaSNeil Perrin #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 4480a586ceaSMark Shellenbaum #define SPA_VERSION_SA SPA_VERSION_24 4493f9d6ad7SLin Ling #define SPA_VERSION_SCAN SPA_VERSION_25 450cde58dbcSMatthew Ahrens #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 451cde58dbcSMatthew Ahrens #define SPA_VERSION_DEADLISTS SPA_VERSION_26 4526e0cbcaaSMatthew Ahrens #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 453cb04b873SMark J Musante #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 454ad135b5dSChristopher Siden #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 455ad135b5dSChristopher Siden #define SPA_VERSION_FEATURES SPA_VERSION_5000 456ad135b5dSChristopher Siden 457ad135b5dSChristopher Siden #define SPA_VERSION_IS_SUPPORTED(v) \ 458ad135b5dSChristopher Siden (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 459ad135b5dSChristopher Siden ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 460e7437265Sahrens 461e7437265Sahrens /* 462e7437265Sahrens * ZPL version - rev'd whenever an incompatible on-disk format change 463e7437265Sahrens * occurs. This is independent of SPA/DMU/ZAP versioning. You must 464e7437265Sahrens * also update the version_table[] and help message in zfs_prop.c. 465e7437265Sahrens * 466e7437265Sahrens * When changing, be sure to teach GRUB how to read the new format! 467478ed9adSEric Taylor * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 468e7437265Sahrens */ 469e7437265Sahrens #define ZPL_VERSION_1 1ULL 470e7437265Sahrens #define ZPL_VERSION_2 2ULL 471da6c28aaSamw #define ZPL_VERSION_3 3ULL 47214843421SMatthew Ahrens #define ZPL_VERSION_4 4ULL 4730a586ceaSMark Shellenbaum #define ZPL_VERSION_5 5ULL 4740a586ceaSMark Shellenbaum #define ZPL_VERSION ZPL_VERSION_5 4750a586ceaSMark Shellenbaum #define ZPL_VERSION_STRING "5" 476e7437265Sahrens 477e7437265Sahrens #define ZPL_VERSION_INITIAL ZPL_VERSION_1 478e7437265Sahrens #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 479da6c28aaSamw #define ZPL_VERSION_FUID ZPL_VERSION_3 480de8267e0Stimh #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 481da6c28aaSamw #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 48214843421SMatthew Ahrens #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 4830a586ceaSMark Shellenbaum #define ZPL_VERSION_SA ZPL_VERSION_5 484eaca9bbdSeschrock 485468c413aSTim Haley /* Rewind request information */ 486c8ee1847SVictor Latushkin #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 487c8ee1847SVictor Latushkin #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 488c8ee1847SVictor Latushkin #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 489c8ee1847SVictor Latushkin #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 490c8ee1847SVictor Latushkin #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 491c8ee1847SVictor Latushkin #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 492c8ee1847SVictor Latushkin #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 493468c413aSTim Haley 494468c413aSTim Haley typedef struct zpool_rewind_policy { 495468c413aSTim Haley uint32_t zrp_request; /* rewind behavior requested */ 496c8ee1847SVictor Latushkin uint64_t zrp_maxmeta; /* max acceptable meta-data errors */ 497c8ee1847SVictor Latushkin uint64_t zrp_maxdata; /* max acceptable data errors */ 498468c413aSTim Haley uint64_t zrp_txg; /* specific txg to load */ 499468c413aSTim Haley } zpool_rewind_policy_t; 500468c413aSTim Haley 501fa9e4066Sahrens /* 502fa9e4066Sahrens * The following are configuration names used in the nvlist describing a pool's 503fa9e4066Sahrens * configuration. 504fa9e4066Sahrens */ 505fa9e4066Sahrens #define ZPOOL_CONFIG_VERSION "version" 506fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_NAME "name" 507fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_STATE "state" 508fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_TXG "txg" 509fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 510fa9e4066Sahrens #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 511fa9e4066Sahrens #define ZPOOL_CONFIG_TOP_GUID "top_guid" 512fa9e4066Sahrens #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 513fa9e4066Sahrens #define ZPOOL_CONFIG_TYPE "type" 514fa9e4066Sahrens #define ZPOOL_CONFIG_CHILDREN "children" 515fa9e4066Sahrens #define ZPOOL_CONFIG_ID "id" 516fa9e4066Sahrens #define ZPOOL_CONFIG_GUID "guid" 517fa9e4066Sahrens #define ZPOOL_CONFIG_PATH "path" 518fa9e4066Sahrens #define ZPOOL_CONFIG_DEVID "devid" 519fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 520fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 521fa9e4066Sahrens #define ZPOOL_CONFIG_ASHIFT "ashift" 522fa9e4066Sahrens #define ZPOOL_CONFIG_ASIZE "asize" 523fa9e4066Sahrens #define ZPOOL_CONFIG_DTL "DTL" 5243f9d6ad7SLin Ling #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 5253f9d6ad7SLin Ling #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 526afefbcddSeschrock #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 527ea8dc4b6Seschrock #define ZPOOL_CONFIG_ERRCOUNT "error_count" 528ea8dc4b6Seschrock #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 52999653d4eSeschrock #define ZPOOL_CONFIG_SPARES "spares" 53099653d4eSeschrock #define ZPOOL_CONFIG_IS_SPARE "is_spare" 53199653d4eSeschrock #define ZPOOL_CONFIG_NPARITY "nparity" 53295173954Sek #define ZPOOL_CONFIG_HOSTID "hostid" 53395173954Sek #define ZPOOL_CONFIG_HOSTNAME "hostname" 53411027bc7STim Haley #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 5353d7072f8Seschrock #define ZPOOL_CONFIG_UNSPARE "unspare" 5363d7072f8Seschrock #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 5378654d025Sperrin #define ZPOOL_CONFIG_IS_LOG "is_log" 538fa94a07fSbrendan #define ZPOOL_CONFIG_L2CACHE "l2cache" 53988ecc943SGeorge Wilson #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 54088ecc943SGeorge Wilson #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 54188ecc943SGeorge Wilson #define ZPOOL_CONFIG_IS_HOLE "is_hole" 5429eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 5439eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 5449eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 5451195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT "splitcfg" 5461195e687SMark J Musante #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 5471195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 5481195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 5493f9d6ad7SLin Ling #define ZPOOL_CONFIG_REMOVING "removing" 550b4952e17SGeorge Wilson #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg" 5518704186eSDan McDonald #define ZPOOL_CONFIG_COMMENT "comment" 552e14bb325SJeff Bonwick #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 553e7cbe64fSgw #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 554e7cbe64fSgw #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 5554b964adaSGeorge Wilson #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 5564b964adaSGeorge Wilson #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 557ad135b5dSChristopher Siden #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */ 558ad135b5dSChristopher Siden #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */ 55957221772SChristopher Siden #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */ 560ad135b5dSChristopher Siden #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */ 561ad135b5dSChristopher Siden #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 562ad135b5dSChristopher Siden #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */ 563215198a6SJoe Stein #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top" 564215198a6SJoe Stein #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf" 565215198a6SJoe Stein #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps" 5663d7072f8Seschrock /* 5673d7072f8Seschrock * The persistent vdev state is stored as separate values rather than a single 5683d7072f8Seschrock * 'vdev_state' entry. This is because a device can be in multiple states, such 5693d7072f8Seschrock * as offline and degraded. 5703d7072f8Seschrock */ 5713d7072f8Seschrock #define ZPOOL_CONFIG_OFFLINE "offline" 5723d7072f8Seschrock #define ZPOOL_CONFIG_FAULTED "faulted" 5733d7072f8Seschrock #define ZPOOL_CONFIG_DEGRADED "degraded" 5743d7072f8Seschrock #define ZPOOL_CONFIG_REMOVED "removed" 5756809eb4eSEric Schrock #define ZPOOL_CONFIG_FRU "fru" 576069f55e2SEric Schrock #define ZPOOL_CONFIG_AUX_STATE "aux_state" 577fa9e4066Sahrens 578468c413aSTim Haley /* Rewind policy parameters */ 579468c413aSTim Haley #define ZPOOL_REWIND_POLICY "rewind-policy" 580468c413aSTim Haley #define ZPOOL_REWIND_REQUEST "rewind-request" 581468c413aSTim Haley #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg" 582468c413aSTim Haley #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh" 583468c413aSTim Haley #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh" 584468c413aSTim Haley 585468c413aSTim Haley /* Rewind data discovered */ 586468c413aSTim Haley #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 587468c413aSTim Haley #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 588468c413aSTim Haley #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 589468c413aSTim Haley 590fa9e4066Sahrens #define VDEV_TYPE_ROOT "root" 591fa9e4066Sahrens #define VDEV_TYPE_MIRROR "mirror" 592fa9e4066Sahrens #define VDEV_TYPE_REPLACING "replacing" 593fa9e4066Sahrens #define VDEV_TYPE_RAIDZ "raidz" 594fa9e4066Sahrens #define VDEV_TYPE_DISK "disk" 595fa9e4066Sahrens #define VDEV_TYPE_FILE "file" 596fa9e4066Sahrens #define VDEV_TYPE_MISSING "missing" 59788ecc943SGeorge Wilson #define VDEV_TYPE_HOLE "hole" 59899653d4eSeschrock #define VDEV_TYPE_SPARE "spare" 5998654d025Sperrin #define VDEV_TYPE_LOG "log" 600fa94a07fSbrendan #define VDEV_TYPE_L2CACHE "l2cache" 601fa9e4066Sahrens 602fa9e4066Sahrens /* 603fa9e4066Sahrens * This is needed in userland to report the minimum necessary device size. 604fa9e4066Sahrens */ 605fa9e4066Sahrens #define SPA_MINDEVSIZE (64ULL << 20) 606fa9e4066Sahrens 6072e4c9986SGeorge Wilson /* 6082e4c9986SGeorge Wilson * Set if the fragmentation has not yet been calculated. This can happen 6092e4c9986SGeorge Wilson * because the space maps have not been upgraded or the histogram feature 6102e4c9986SGeorge Wilson * is not enabled. 6112e4c9986SGeorge Wilson */ 6122e4c9986SGeorge Wilson #define ZFS_FRAG_INVALID UINT64_MAX 6132e4c9986SGeorge Wilson 614fa9e4066Sahrens /* 615fa9e4066Sahrens * The location of the pool configuration repository, shared between kernel and 616fa9e4066Sahrens * userland. 617fa9e4066Sahrens */ 618c5904d13Seschrock #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 619fa9e4066Sahrens 620fa9e4066Sahrens /* 621fa9e4066Sahrens * vdev states are ordered from least to most healthy. 622fa9e4066Sahrens * A vdev that's CANT_OPEN or below is considered unusable. 623fa9e4066Sahrens */ 624fa9e4066Sahrens typedef enum vdev_state { 625fa9e4066Sahrens VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 626fa9e4066Sahrens VDEV_STATE_CLOSED, /* Not currently open */ 627fa9e4066Sahrens VDEV_STATE_OFFLINE, /* Not allowed to open */ 6283d7072f8Seschrock VDEV_STATE_REMOVED, /* Explicitly removed from system */ 629fa9e4066Sahrens VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 6303d7072f8Seschrock VDEV_STATE_FAULTED, /* External request to fault device */ 631fa9e4066Sahrens VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 632fa9e4066Sahrens VDEV_STATE_HEALTHY /* Presumed good */ 633fa9e4066Sahrens } vdev_state_t; 634fa9e4066Sahrens 6353d7072f8Seschrock #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 6363d7072f8Seschrock 637fa9e4066Sahrens /* 638fa9e4066Sahrens * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 639fa9e4066Sahrens * of the vdev stats structure uses these constants to distinguish why. 640fa9e4066Sahrens */ 641fa9e4066Sahrens typedef enum vdev_aux { 642fa9e4066Sahrens VDEV_AUX_NONE, /* no error */ 643fa9e4066Sahrens VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 644fa9e4066Sahrens VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 645fa9e4066Sahrens VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 646fa9e4066Sahrens VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 647fa9e4066Sahrens VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 648eaca9bbdSeschrock VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 649eaca9bbdSeschrock VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 65099653d4eSeschrock VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 651ad135b5dSChristopher Siden VDEV_AUX_UNSUP_FEAT, /* unsupported features */ 6523d7072f8Seschrock VDEV_AUX_SPARED, /* hot spare used in another pool */ 65332b87932Sek VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 654b87f3af3Sperrin VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 655069f55e2SEric Schrock VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 6561195e687SMark J Musante VDEV_AUX_EXTERNAL, /* external diagnosis */ 6571195e687SMark J Musante VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */ 658fa9e4066Sahrens } vdev_aux_t; 659fa9e4066Sahrens 660fa9e4066Sahrens /* 66146a2abf2Seschrock * pool state. The following states are written to disk as part of the normal 662fa94a07fSbrendan * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 663fa94a07fSbrendan * states are software abstractions used at various levels to communicate 664fa94a07fSbrendan * pool state. 665fa9e4066Sahrens */ 666fa9e4066Sahrens typedef enum pool_state { 667fa9e4066Sahrens POOL_STATE_ACTIVE = 0, /* In active use */ 668fa9e4066Sahrens POOL_STATE_EXPORTED, /* Explicitly exported */ 669fa9e4066Sahrens POOL_STATE_DESTROYED, /* Explicitly destroyed */ 67099653d4eSeschrock POOL_STATE_SPARE, /* Reserved for hot spare use */ 671fa94a07fSbrendan POOL_STATE_L2CACHE, /* Level 2 ARC device */ 672fa9e4066Sahrens POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 67346a2abf2Seschrock POOL_STATE_UNAVAIL, /* Internal libzfs state */ 67446a2abf2Seschrock POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 675fa9e4066Sahrens } pool_state_t; 676fa9e4066Sahrens 677fa9e4066Sahrens /* 6783f9d6ad7SLin Ling * Scan Functions. 679fa9e4066Sahrens */ 6803f9d6ad7SLin Ling typedef enum pool_scan_func { 6813f9d6ad7SLin Ling POOL_SCAN_NONE, 6823f9d6ad7SLin Ling POOL_SCAN_SCRUB, 6833f9d6ad7SLin Ling POOL_SCAN_RESILVER, 6843f9d6ad7SLin Ling POOL_SCAN_FUNCS 6853f9d6ad7SLin Ling } pool_scan_func_t; 686fa9e4066Sahrens 687fa9e4066Sahrens /* 688fa9e4066Sahrens * ZIO types. Needed to interpret vdev statistics below. 689fa9e4066Sahrens */ 690fa9e4066Sahrens typedef enum zio_type { 691fa9e4066Sahrens ZIO_TYPE_NULL = 0, 692fa9e4066Sahrens ZIO_TYPE_READ, 693fa9e4066Sahrens ZIO_TYPE_WRITE, 694fa9e4066Sahrens ZIO_TYPE_FREE, 695fa9e4066Sahrens ZIO_TYPE_CLAIM, 696fa9e4066Sahrens ZIO_TYPE_IOCTL, 697fa9e4066Sahrens ZIO_TYPES 698fa9e4066Sahrens } zio_type_t; 699fa9e4066Sahrens 7003f9d6ad7SLin Ling /* 7013f9d6ad7SLin Ling * Pool statistics. Note: all fields should be 64-bit because this 7023f9d6ad7SLin Ling * is passed between kernel and userland as an nvlist uint64 array. 7033f9d6ad7SLin Ling */ 7043f9d6ad7SLin Ling typedef struct pool_scan_stat { 7053f9d6ad7SLin Ling /* values stored on disk */ 7063f9d6ad7SLin Ling uint64_t pss_func; /* pool_scan_func_t */ 7073f9d6ad7SLin Ling uint64_t pss_state; /* dsl_scan_state_t */ 7083f9d6ad7SLin Ling uint64_t pss_start_time; /* scan start time */ 7093f9d6ad7SLin Ling uint64_t pss_end_time; /* scan end time */ 7103f9d6ad7SLin Ling uint64_t pss_to_examine; /* total bytes to scan */ 7113f9d6ad7SLin Ling uint64_t pss_examined; /* total examined bytes */ 7123f9d6ad7SLin Ling uint64_t pss_to_process; /* total bytes to process */ 7133f9d6ad7SLin Ling uint64_t pss_processed; /* total processed bytes */ 7143f9d6ad7SLin Ling uint64_t pss_errors; /* scan errors */ 7153f9d6ad7SLin Ling 7163f9d6ad7SLin Ling /* values not stored on disk */ 7173f9d6ad7SLin Ling uint64_t pss_pass_exam; /* examined bytes per scan pass */ 7183f9d6ad7SLin Ling uint64_t pss_pass_start; /* start time of a scan pass */ 7193f9d6ad7SLin Ling } pool_scan_stat_t; 7203f9d6ad7SLin Ling 7213f9d6ad7SLin Ling typedef enum dsl_scan_state { 7223f9d6ad7SLin Ling DSS_NONE, 7233f9d6ad7SLin Ling DSS_SCANNING, 7243f9d6ad7SLin Ling DSS_FINISHED, 7253f9d6ad7SLin Ling DSS_CANCELED, 7263f9d6ad7SLin Ling DSS_NUM_STATES 7273f9d6ad7SLin Ling } dsl_scan_state_t; 7283f9d6ad7SLin Ling 7293f9d6ad7SLin Ling 730fa9e4066Sahrens /* 731fa9e4066Sahrens * Vdev statistics. Note: all fields should be 64-bit because this 732fa9e4066Sahrens * is passed between kernel and userland as an nvlist uint64 array. 733fa9e4066Sahrens */ 734fa9e4066Sahrens typedef struct vdev_stat { 735fa9e4066Sahrens hrtime_t vs_timestamp; /* time since vdev load */ 736fa9e4066Sahrens uint64_t vs_state; /* vdev state */ 737fa9e4066Sahrens uint64_t vs_aux; /* see vdev_aux_t */ 738fa9e4066Sahrens uint64_t vs_alloc; /* space allocated */ 739fa9e4066Sahrens uint64_t vs_space; /* total capacity */ 74099653d4eSeschrock uint64_t vs_dspace; /* deflated capacity */ 7412a79c5feSlling uint64_t vs_rsize; /* replaceable dev size */ 7424263d13fSGeorge Wilson uint64_t vs_esize; /* expandable dev size */ 743fa9e4066Sahrens uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 744fa9e4066Sahrens uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 745fa9e4066Sahrens uint64_t vs_read_errors; /* read errors */ 746fa9e4066Sahrens uint64_t vs_write_errors; /* write errors */ 747fa9e4066Sahrens uint64_t vs_checksum_errors; /* checksum errors */ 748fa9e4066Sahrens uint64_t vs_self_healed; /* self-healed bytes */ 7493f9d6ad7SLin Ling uint64_t vs_scan_removing; /* removing? */ 7503f9d6ad7SLin Ling uint64_t vs_scan_processed; /* scan processed bytes */ 7512e4c9986SGeorge Wilson uint64_t vs_fragmentation; /* device fragmentation */ 752fa9e4066Sahrens } vdev_stat_t; 753fa9e4066Sahrens 7549eb19f4dSGeorge Wilson /* 7559eb19f4dSGeorge Wilson * DDT statistics. Note: all fields should be 64-bit because this 7569eb19f4dSGeorge Wilson * is passed between kernel and userland as an nvlist uint64 array. 7579eb19f4dSGeorge Wilson */ 7589eb19f4dSGeorge Wilson typedef struct ddt_object { 7599eb19f4dSGeorge Wilson uint64_t ddo_count; /* number of elments in ddt */ 7609eb19f4dSGeorge Wilson uint64_t ddo_dspace; /* size of ddt on disk */ 7619eb19f4dSGeorge Wilson uint64_t ddo_mspace; /* size of ddt in-core */ 7629eb19f4dSGeorge Wilson } ddt_object_t; 7639eb19f4dSGeorge Wilson 7649eb19f4dSGeorge Wilson typedef struct ddt_stat { 7659eb19f4dSGeorge Wilson uint64_t dds_blocks; /* blocks */ 7669eb19f4dSGeorge Wilson uint64_t dds_lsize; /* logical size */ 7679eb19f4dSGeorge Wilson uint64_t dds_psize; /* physical size */ 7689eb19f4dSGeorge Wilson uint64_t dds_dsize; /* deflated allocated size */ 7699eb19f4dSGeorge Wilson uint64_t dds_ref_blocks; /* referenced blocks */ 7709eb19f4dSGeorge Wilson uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 7719eb19f4dSGeorge Wilson uint64_t dds_ref_psize; /* referenced psize * refcnt */ 7729eb19f4dSGeorge Wilson uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 7739eb19f4dSGeorge Wilson } ddt_stat_t; 7749eb19f4dSGeorge Wilson 7759eb19f4dSGeorge Wilson typedef struct ddt_histogram { 7769eb19f4dSGeorge Wilson ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 7779eb19f4dSGeorge Wilson } ddt_histogram_t; 7789eb19f4dSGeorge Wilson 779e7cbe64fSgw #define ZVOL_DRIVER "zvol" 780fa9e4066Sahrens #define ZFS_DRIVER "zfs" 781fa9e4066Sahrens #define ZFS_DEV "/dev/zfs" 7826401734dSWill Andrews #define ZFS_DISK_ROOT "/dev/dsk" 7836401734dSWill Andrews #define ZFS_DISK_ROOTD ZFS_DISK_ROOT "/" 7846401734dSWill Andrews #define ZFS_RDISK_ROOT "/dev/rdsk" 7856401734dSWill Andrews #define ZFS_RDISK_ROOTD ZFS_RDISK_ROOT "/" 786fa9e4066Sahrens 787681d9761SEric Taylor /* general zvol path */ 788681d9761SEric Taylor #define ZVOL_DIR "/dev/zvol" 789681d9761SEric Taylor /* expansion */ 790573ca77eSGeorge Wilson #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 791681d9761SEric Taylor /* for dump and swap */ 792681d9761SEric Taylor #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 793681d9761SEric Taylor #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 794fa9e4066Sahrens 795fa9e4066Sahrens #define ZVOL_PROP_NAME "name" 796c1449561SEric Taylor #define ZVOL_DEFAULT_BLOCKSIZE 8192 797fa9e4066Sahrens 798fa9e4066Sahrens /* 799fa9e4066Sahrens * /dev/zfs ioctl numbers. 800fa9e4066Sahrens */ 801fa9e4066Sahrens typedef enum zfs_ioc { 8024445fffbSMatthew Ahrens ZFS_IOC_FIRST = ('Z' << 8), 8034445fffbSMatthew Ahrens ZFS_IOC = ZFS_IOC_FIRST, 8044445fffbSMatthew Ahrens ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, 805fa9e4066Sahrens ZFS_IOC_POOL_DESTROY, 806fa9e4066Sahrens ZFS_IOC_POOL_IMPORT, 807fa9e4066Sahrens ZFS_IOC_POOL_EXPORT, 808fa9e4066Sahrens ZFS_IOC_POOL_CONFIGS, 809fa9e4066Sahrens ZFS_IOC_POOL_STATS, 810fa9e4066Sahrens ZFS_IOC_POOL_TRYIMPORT, 8113f9d6ad7SLin Ling ZFS_IOC_POOL_SCAN, 812fa9e4066Sahrens ZFS_IOC_POOL_FREEZE, 813eaca9bbdSeschrock ZFS_IOC_POOL_UPGRADE, 81406eeb2adSek ZFS_IOC_POOL_GET_HISTORY, 815fa9e4066Sahrens ZFS_IOC_VDEV_ADD, 816fa9e4066Sahrens ZFS_IOC_VDEV_REMOVE, 8173d7072f8Seschrock ZFS_IOC_VDEV_SET_STATE, 818fa9e4066Sahrens ZFS_IOC_VDEV_ATTACH, 819fa9e4066Sahrens ZFS_IOC_VDEV_DETACH, 820c67d9675Seschrock ZFS_IOC_VDEV_SETPATH, 8216809eb4eSEric Schrock ZFS_IOC_VDEV_SETFRU, 822fa9e4066Sahrens ZFS_IOC_OBJSET_STATS, 823de8267e0Stimh ZFS_IOC_OBJSET_ZPLPROPS, 824fa9e4066Sahrens ZFS_IOC_DATASET_LIST_NEXT, 825fa9e4066Sahrens ZFS_IOC_SNAPSHOT_LIST_NEXT, 826fa9e4066Sahrens ZFS_IOC_SET_PROP, 827fa9e4066Sahrens ZFS_IOC_CREATE, 828fa9e4066Sahrens ZFS_IOC_DESTROY, 829fa9e4066Sahrens ZFS_IOC_ROLLBACK, 830fa9e4066Sahrens ZFS_IOC_RENAME, 8313cb34c60Sahrens ZFS_IOC_RECV, 8323cb34c60Sahrens ZFS_IOC_SEND, 833ea8dc4b6Seschrock ZFS_IOC_INJECT_FAULT, 834ea8dc4b6Seschrock ZFS_IOC_CLEAR_FAULT, 835ea8dc4b6Seschrock ZFS_IOC_INJECT_LIST_NEXT, 836ea8dc4b6Seschrock ZFS_IOC_ERROR_LOG, 837ea8dc4b6Seschrock ZFS_IOC_CLEAR, 8381d452cf5Sahrens ZFS_IOC_PROMOTE, 83955434c77Sek ZFS_IOC_SNAPSHOT, 84055434c77Sek ZFS_IOC_DSOBJ_TO_DSNAME, 841b1b8ab34Slling ZFS_IOC_OBJ_TO_PATH, 842b1b8ab34Slling ZFS_IOC_POOL_SET_PROPS, 843ecd6cf80Smarks ZFS_IOC_POOL_GET_PROPS, 844ecd6cf80Smarks ZFS_IOC_SET_FSACL, 845ecd6cf80Smarks ZFS_IOC_GET_FSACL, 846e45ce728Sahrens ZFS_IOC_SHARE, 847743a77edSAlan Wright ZFS_IOC_INHERIT_PROP, 84814843421SMatthew Ahrens ZFS_IOC_SMB_ACL, 84914843421SMatthew Ahrens ZFS_IOC_USERSPACE_ONE, 85014843421SMatthew Ahrens ZFS_IOC_USERSPACE_MANY, 851842727c2SChris Kirby ZFS_IOC_USERSPACE_UPGRADE, 852842727c2SChris Kirby ZFS_IOC_HOLD, 853842727c2SChris Kirby ZFS_IOC_RELEASE, 85492241e0bSTom Erickson ZFS_IOC_GET_HOLDS, 8551195e687SMark J Musante ZFS_IOC_OBJSET_RECVD_PROPS, 85699d5e173STim Haley ZFS_IOC_VDEV_SPLIT, 85799d5e173STim Haley ZFS_IOC_NEXT_OBJ, 85899d5e173STim Haley ZFS_IOC_DIFF, 85999d5e173STim Haley ZFS_IOC_TMP_SNAPSHOT, 860e9103aaeSGarrett D'Amore ZFS_IOC_OBJ_TO_STATS, 86119b94df9SMatthew Ahrens ZFS_IOC_SPACE_WRITTEN, 86219b94df9SMatthew Ahrens ZFS_IOC_SPACE_SNAPS, 8634445fffbSMatthew Ahrens ZFS_IOC_DESTROY_SNAPS, 8644263d13fSGeorge Wilson ZFS_IOC_POOL_REGUID, 8654e3c9f44SBill Pijewski ZFS_IOC_POOL_REOPEN, 8664445fffbSMatthew Ahrens ZFS_IOC_SEND_PROGRESS, 8674445fffbSMatthew Ahrens ZFS_IOC_LOG_HISTORY, 8684445fffbSMatthew Ahrens ZFS_IOC_SEND_NEW, 8694445fffbSMatthew Ahrens ZFS_IOC_SEND_SPACE, 8704445fffbSMatthew Ahrens ZFS_IOC_CLONE, 87178f17100SMatthew Ahrens ZFS_IOC_BOOKMARK, 87278f17100SMatthew Ahrens ZFS_IOC_GET_BOOKMARKS, 87378f17100SMatthew Ahrens ZFS_IOC_DESTROY_BOOKMARKS, 8744445fffbSMatthew Ahrens ZFS_IOC_LAST 875fa9e4066Sahrens } zfs_ioc_t; 876fa9e4066Sahrens 877ea8dc4b6Seschrock /* 878ea8dc4b6Seschrock * Internal SPA load state. Used by FMA diagnosis engine. 879ea8dc4b6Seschrock */ 880ea8dc4b6Seschrock typedef enum { 8819eb19f4dSGeorge Wilson SPA_LOAD_NONE, /* no load in progress */ 8829eb19f4dSGeorge Wilson SPA_LOAD_OPEN, /* normal open */ 8839eb19f4dSGeorge Wilson SPA_LOAD_IMPORT, /* import in progress */ 884468c413aSTim Haley SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 8859eb19f4dSGeorge Wilson SPA_LOAD_RECOVER, /* recovery requested */ 8869eb19f4dSGeorge Wilson SPA_LOAD_ERROR /* load failed */ 887ea8dc4b6Seschrock } spa_load_state_t; 888ea8dc4b6Seschrock 889e9dbad6fSeschrock /* 890e9dbad6fSeschrock * Bookmark name values. 891e9dbad6fSeschrock */ 89255434c77Sek #define ZPOOL_ERR_LIST "error list" 893e9dbad6fSeschrock #define ZPOOL_ERR_DATASET "dataset" 894e9dbad6fSeschrock #define ZPOOL_ERR_OBJECT "object" 895e9dbad6fSeschrock 89606eeb2adSek #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 89706eeb2adSek 89806eeb2adSek /* 89906eeb2adSek * The following are names used in the nvlist describing 90006eeb2adSek * the pool's history log. 90106eeb2adSek */ 90206eeb2adSek #define ZPOOL_HIST_RECORD "history record" 90306eeb2adSek #define ZPOOL_HIST_TIME "history time" 90406eeb2adSek #define ZPOOL_HIST_CMD "history command" 905ecd6cf80Smarks #define ZPOOL_HIST_WHO "history who" 906ecd6cf80Smarks #define ZPOOL_HIST_ZONE "history zone" 907ecd6cf80Smarks #define ZPOOL_HIST_HOST "history hostname" 908ecd6cf80Smarks #define ZPOOL_HIST_TXG "history txg" 909ecd6cf80Smarks #define ZPOOL_HIST_INT_EVENT "history internal event" 910ecd6cf80Smarks #define ZPOOL_HIST_INT_STR "history internal str" 9114445fffbSMatthew Ahrens #define ZPOOL_HIST_INT_NAME "internal_name" 9124445fffbSMatthew Ahrens #define ZPOOL_HIST_IOCTL "ioctl" 9134445fffbSMatthew Ahrens #define ZPOOL_HIST_INPUT_NVL "in_nvl" 9144445fffbSMatthew Ahrens #define ZPOOL_HIST_OUTPUT_NVL "out_nvl" 9154445fffbSMatthew Ahrens #define ZPOOL_HIST_DSNAME "dsname" 9164445fffbSMatthew Ahrens #define ZPOOL_HIST_DSID "dsid" 91706eeb2adSek 9183d7072f8Seschrock /* 9193d7072f8Seschrock * Flags for ZFS_IOC_VDEV_SET_STATE 9203d7072f8Seschrock */ 9213d7072f8Seschrock #define ZFS_ONLINE_CHECKREMOVE 0x1 9223d7072f8Seschrock #define ZFS_ONLINE_UNSPARE 0x2 9233d7072f8Seschrock #define ZFS_ONLINE_FORCEFAULT 0x4 924573ca77eSGeorge Wilson #define ZFS_ONLINE_EXPAND 0x8 9253d7072f8Seschrock #define ZFS_OFFLINE_TEMPORARY 0x1 9263d7072f8Seschrock 9274b964adaSGeorge Wilson /* 9284b964adaSGeorge Wilson * Flags for ZFS_IOC_POOL_IMPORT 9294b964adaSGeorge Wilson */ 9304b964adaSGeorge Wilson #define ZFS_IMPORT_NORMAL 0x0 9314b964adaSGeorge Wilson #define ZFS_IMPORT_VERBATIM 0x1 9324b964adaSGeorge Wilson #define ZFS_IMPORT_ANY_HOST 0x2 9334b964adaSGeorge Wilson #define ZFS_IMPORT_MISSING_LOG 0x4 934f9af39baSGeorge Wilson #define ZFS_IMPORT_ONLY 0x8 9354b964adaSGeorge Wilson 9363d7072f8Seschrock /* 9373d7072f8Seschrock * Sysevent payload members. ZFS will generate the following sysevents with the 9383d7072f8Seschrock * given payloads: 9393d7072f8Seschrock * 9403d7072f8Seschrock * ESC_ZFS_RESILVER_START 9413d7072f8Seschrock * ESC_ZFS_RESILVER_END 9423d7072f8Seschrock * ESC_ZFS_POOL_DESTROY 943e9103aaeSGarrett D'Amore * ESC_ZFS_POOL_REGUID 9443d7072f8Seschrock * 9453d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 9463d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 9473d7072f8Seschrock * 9483d7072f8Seschrock * ESC_ZFS_VDEV_REMOVE 9493d7072f8Seschrock * ESC_ZFS_VDEV_CLEAR 9503d7072f8Seschrock * ESC_ZFS_VDEV_CHECK 9513d7072f8Seschrock * 9523d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 9533d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 9543d7072f8Seschrock * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 9553d7072f8Seschrock * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 9563d7072f8Seschrock */ 9573d7072f8Seschrock #define ZFS_EV_POOL_NAME "pool_name" 9583d7072f8Seschrock #define ZFS_EV_POOL_GUID "pool_guid" 9593d7072f8Seschrock #define ZFS_EV_VDEV_PATH "vdev_path" 9603d7072f8Seschrock #define ZFS_EV_VDEV_GUID "vdev_guid" 9613d7072f8Seschrock 962fa9e4066Sahrens #ifdef __cplusplus 963fa9e4066Sahrens } 964fa9e4066Sahrens #endif 965fa9e4066Sahrens 966fa9e4066Sahrens #endif /* _SYS_FS_ZFS_H */ 967