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. 244263d13fSGeorge Wilson * Copyright (c) 2012 by Delphix. All rights reserved. 25e9103aaeSGarrett D'Amore * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 264e3c9f44SBill Pijewski * Copyright (c) 2012, Joyent, Inc. All rights reserved. 27fa9e4066Sahrens */ 28fa9e4066Sahrens 2955da60b9SMark J Musante /* Portions Copyright 2010 Robert Milkowski */ 3055da60b9SMark J Musante 31fa9e4066Sahrens #ifndef _SYS_FS_ZFS_H 32fa9e4066Sahrens #define _SYS_FS_ZFS_H 33fa9e4066Sahrens 34842727c2SChris Kirby #include <sys/time.h> 35842727c2SChris Kirby 36fa9e4066Sahrens #ifdef __cplusplus 37fa9e4066Sahrens extern "C" { 38fa9e4066Sahrens #endif 39fa9e4066Sahrens 40fa9e4066Sahrens /* 41fa9e4066Sahrens * Types and constants shared between userland and the kernel. 42fa9e4066Sahrens */ 43fa9e4066Sahrens 44fa9e4066Sahrens /* 45fa9e4066Sahrens * Each dataset can be one of the following types. These constants can be 46fa9e4066Sahrens * combined into masks that can be passed to various functions. 47fa9e4066Sahrens */ 48fa9e4066Sahrens typedef enum { 49fa9e4066Sahrens ZFS_TYPE_FILESYSTEM = 0x1, 50fa9e4066Sahrens ZFS_TYPE_SNAPSHOT = 0x2, 51b1b8ab34Slling ZFS_TYPE_VOLUME = 0x4, 52b1b8ab34Slling ZFS_TYPE_POOL = 0x8 53fa9e4066Sahrens } zfs_type_t; 54fa9e4066Sahrens 55*4445fffbSMatthew Ahrens typedef enum dmu_objset_type { 56*4445fffbSMatthew Ahrens DMU_OST_NONE, 57*4445fffbSMatthew Ahrens DMU_OST_META, 58*4445fffbSMatthew Ahrens DMU_OST_ZFS, 59*4445fffbSMatthew Ahrens DMU_OST_ZVOL, 60*4445fffbSMatthew Ahrens DMU_OST_OTHER, /* For testing only! */ 61*4445fffbSMatthew Ahrens DMU_OST_ANY, /* Be careful! */ 62*4445fffbSMatthew Ahrens DMU_OST_NUMTYPES 63*4445fffbSMatthew Ahrens } dmu_objset_type_t; 64*4445fffbSMatthew Ahrens 65990b4856Slling #define ZFS_TYPE_DATASET \ 66fa9e4066Sahrens (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 67fa9e4066Sahrens 68478ed9adSEric Taylor #define ZAP_MAXNAMELEN 256 69478ed9adSEric Taylor #define ZAP_MAXVALUELEN (1024 * 8) 70478ed9adSEric Taylor #define ZAP_OLDMAXVALUELEN 1024 71478ed9adSEric Taylor 72fa9e4066Sahrens /* 73990b4856Slling * Dataset properties are identified by these constants and must be added to 74990b4856Slling * the end of this list to ensure that external consumers are not affected 75990b4856Slling * by the change. If you make any changes to this list, be sure to update 7666e2aaccSgw * the property table in usr/src/common/zfs/zfs_prop.c. 77fa9e4066Sahrens */ 78fa9e4066Sahrens typedef enum { 79fa9e4066Sahrens ZFS_PROP_TYPE, 80fa9e4066Sahrens ZFS_PROP_CREATION, 81fa9e4066Sahrens ZFS_PROP_USED, 82fa9e4066Sahrens ZFS_PROP_AVAILABLE, 83fa9e4066Sahrens ZFS_PROP_REFERENCED, 84fa9e4066Sahrens ZFS_PROP_COMPRESSRATIO, 85fa9e4066Sahrens ZFS_PROP_MOUNTED, 86fa9e4066Sahrens ZFS_PROP_ORIGIN, 87fa9e4066Sahrens ZFS_PROP_QUOTA, 88fa9e4066Sahrens ZFS_PROP_RESERVATION, 89fa9e4066Sahrens ZFS_PROP_VOLSIZE, 90fa9e4066Sahrens ZFS_PROP_VOLBLOCKSIZE, 91fa9e4066Sahrens ZFS_PROP_RECORDSIZE, 92fa9e4066Sahrens ZFS_PROP_MOUNTPOINT, 93fa9e4066Sahrens ZFS_PROP_SHARENFS, 94fa9e4066Sahrens ZFS_PROP_CHECKSUM, 95fa9e4066Sahrens ZFS_PROP_COMPRESSION, 96fa9e4066Sahrens ZFS_PROP_ATIME, 97fa9e4066Sahrens ZFS_PROP_DEVICES, 98fa9e4066Sahrens ZFS_PROP_EXEC, 99fa9e4066Sahrens ZFS_PROP_SETUID, 100fa9e4066Sahrens ZFS_PROP_READONLY, 101fa9e4066Sahrens ZFS_PROP_ZONED, 102fa9e4066Sahrens ZFS_PROP_SNAPDIR, 103a3c49ce1SAlbert Lee ZFS_PROP_ACLMODE, 104fa9e4066Sahrens ZFS_PROP_ACLINHERIT, 10566e2aaccSgw ZFS_PROP_CREATETXG, /* not exposed to the user */ 10666e2aaccSgw ZFS_PROP_NAME, /* not exposed to the user */ 107e9dbad6fSeschrock ZFS_PROP_CANMOUNT, 10866e2aaccSgw ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 1097b55fa8eSck ZFS_PROP_XATTR, 110d0ad202dSahrens ZFS_PROP_NUMCLONES, /* not exposed to the user */ 111b1b8ab34Slling ZFS_PROP_COPIES, 112e7437265Sahrens ZFS_PROP_VERSION, 113da6c28aaSamw ZFS_PROP_UTF8ONLY, 114da6c28aaSamw ZFS_PROP_NORMALIZE, 115da6c28aaSamw ZFS_PROP_CASE, 116da6c28aaSamw ZFS_PROP_VSCAN, 117da6c28aaSamw ZFS_PROP_NBMAND, 118da6c28aaSamw ZFS_PROP_SHARESMB, 119a9799022Sck ZFS_PROP_REFQUOTA, 120a9799022Sck ZFS_PROP_REFRESERVATION, 121c5904d13Seschrock ZFS_PROP_GUID, 1223baa08fcSek ZFS_PROP_PRIMARYCACHE, 1233baa08fcSek ZFS_PROP_SECONDARYCACHE, 12474e7dc98SMatthew Ahrens ZFS_PROP_USEDSNAP, 12574e7dc98SMatthew Ahrens ZFS_PROP_USEDDS, 12674e7dc98SMatthew Ahrens ZFS_PROP_USEDCHILD, 12774e7dc98SMatthew Ahrens ZFS_PROP_USEDREFRESERV, 12814843421SMatthew Ahrens ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 129478ed9adSEric Taylor ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 130842727c2SChris Kirby ZFS_PROP_DEFER_DESTROY, 131842727c2SChris Kirby ZFS_PROP_USERREFS, 132e09fa4daSNeil Perrin ZFS_PROP_LOGBIAS, 1331d713200SEric Schrock ZFS_PROP_UNIQUE, /* not exposed to the user */ 1341d713200SEric Schrock ZFS_PROP_OBJSETID, /* not exposed to the user */ 135b24ab676SJeff Bonwick ZFS_PROP_DEDUP, 1364201a95eSRic Aleshire ZFS_PROP_MLSLABEL, 13755da60b9SMark J Musante ZFS_PROP_SYNC, 138187d6ac0SMatt Ahrens ZFS_PROP_REFRATIO, 13919b94df9SMatthew Ahrens ZFS_PROP_WRITTEN, 14019b94df9SMatthew Ahrens ZFS_PROP_CLONES, 14191ebeef5Sahrens ZFS_NUM_PROPS 142fa9e4066Sahrens } zfs_prop_t; 143fa9e4066Sahrens 14414843421SMatthew Ahrens typedef enum { 14514843421SMatthew Ahrens ZFS_PROP_USERUSED, 14614843421SMatthew Ahrens ZFS_PROP_USERQUOTA, 14714843421SMatthew Ahrens ZFS_PROP_GROUPUSED, 14814843421SMatthew Ahrens ZFS_PROP_GROUPQUOTA, 14914843421SMatthew Ahrens ZFS_NUM_USERQUOTA_PROPS 15014843421SMatthew Ahrens } zfs_userquota_prop_t; 15114843421SMatthew Ahrens 15214843421SMatthew Ahrens extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS]; 15314843421SMatthew Ahrens 154990b4856Slling /* 155990b4856Slling * Pool properties are identified by these constants and must be added to the 156b87f3af3Sperrin * end of this list to ensure that external consumers are not affected 157990b4856Slling * by the change. If you make any changes to this list, be sure to update 158990b4856Slling * the property table in usr/src/common/zfs/zpool_prop.c. 159990b4856Slling */ 160990b4856Slling typedef enum { 161990b4856Slling ZPOOL_PROP_NAME, 162990b4856Slling ZPOOL_PROP_SIZE, 163990b4856Slling ZPOOL_PROP_CAPACITY, 164990b4856Slling ZPOOL_PROP_ALTROOT, 165990b4856Slling ZPOOL_PROP_HEALTH, 166990b4856Slling ZPOOL_PROP_GUID, 167990b4856Slling ZPOOL_PROP_VERSION, 168990b4856Slling ZPOOL_PROP_BOOTFS, 169990b4856Slling ZPOOL_PROP_DELEGATION, 170990b4856Slling ZPOOL_PROP_AUTOREPLACE, 1712f8aaab3Seschrock ZPOOL_PROP_CACHEFILE, 1720a4e9518Sgw ZPOOL_PROP_FAILUREMODE, 173d5b5bb25SRich Morris ZPOOL_PROP_LISTSNAPS, 174573ca77eSGeorge Wilson ZPOOL_PROP_AUTOEXPAND, 175b24ab676SJeff Bonwick ZPOOL_PROP_DEDUPDITTO, 176b24ab676SJeff Bonwick ZPOOL_PROP_DEDUPRATIO, 177485bbbf5SGeorge Wilson ZPOOL_PROP_FREE, 178485bbbf5SGeorge Wilson ZPOOL_PROP_ALLOCATED, 179f9af39baSGeorge Wilson ZPOOL_PROP_READONLY, 1808704186eSDan McDonald ZPOOL_PROP_COMMENT, 1814263d13fSGeorge Wilson ZPOOL_PROP_EXPANDSZ, 182ad135b5dSChristopher Siden ZPOOL_PROP_FREEING, 183990b4856Slling ZPOOL_NUM_PROPS 184990b4856Slling } zpool_prop_t; 185b1b8ab34Slling 1868704186eSDan McDonald /* Small enough to not hog a whole line of printout in zpool(1M). */ 1878704186eSDan McDonald #define ZPROP_MAX_COMMENT 32 1888704186eSDan McDonald 189990b4856Slling #define ZPROP_CONT -2 190990b4856Slling #define ZPROP_INVAL -1 1913d7072f8Seschrock 192990b4856Slling #define ZPROP_VALUE "value" 193990b4856Slling #define ZPROP_SOURCE "source" 1947f7322feSeschrock 195b1b8ab34Slling typedef enum { 196990b4856Slling ZPROP_SRC_NONE = 0x1, 197990b4856Slling ZPROP_SRC_DEFAULT = 0x2, 198990b4856Slling ZPROP_SRC_TEMPORARY = 0x4, 199990b4856Slling ZPROP_SRC_LOCAL = 0x8, 20092241e0bSTom Erickson ZPROP_SRC_INHERITED = 0x10, 20192241e0bSTom Erickson ZPROP_SRC_RECEIVED = 0x20 202990b4856Slling } zprop_source_t; 203990b4856Slling 20492241e0bSTom Erickson #define ZPROP_SRC_ALL 0x3f 20592241e0bSTom Erickson 20692241e0bSTom Erickson #define ZPROP_SOURCE_VAL_RECVD "$recvd" 20792241e0bSTom Erickson #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 20892241e0bSTom Erickson /* 20992241e0bSTom Erickson * Dataset flag implemented as a special entry in the props zap object 21092241e0bSTom Erickson * indicating that the dataset has received properties on or after 21192241e0bSTom Erickson * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 21292241e0bSTom Erickson * just as it did in earlier versions, and thereafter, local properties are 21392241e0bSTom Erickson * preserved. 21492241e0bSTom Erickson */ 21592241e0bSTom Erickson #define ZPROP_HAS_RECVD "$hasrecvd" 21692241e0bSTom Erickson 21792241e0bSTom Erickson typedef enum { 21892241e0bSTom Erickson ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 21992241e0bSTom Erickson ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 22092241e0bSTom Erickson } zprop_errflags_t; 221990b4856Slling 222990b4856Slling typedef int (*zprop_func)(int, void *); 223990b4856Slling 2240a48a24eStimh /* 2250a48a24eStimh * Properties to be set on the root file system of a new pool 2260a48a24eStimh * are stuffed into their own nvlist, which is then included in 2270a48a24eStimh * the properties nvlist with the pool properties. 2280a48a24eStimh */ 2290a48a24eStimh #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 2300a48a24eStimh 231990b4856Slling /* 232990b4856Slling * Dataset property functions shared between libzfs and kernel. 233990b4856Slling */ 234990b4856Slling const char *zfs_prop_default_string(zfs_prop_t); 235990b4856Slling uint64_t zfs_prop_default_numeric(zfs_prop_t); 236990b4856Slling boolean_t zfs_prop_readonly(zfs_prop_t); 237990b4856Slling boolean_t zfs_prop_inheritable(zfs_prop_t); 238da6c28aaSamw boolean_t zfs_prop_setonce(zfs_prop_t); 239990b4856Slling const char *zfs_prop_to_name(zfs_prop_t); 240990b4856Slling zfs_prop_t zfs_name_to_prop(const char *); 241990b4856Slling boolean_t zfs_prop_user(const char *); 24292241e0bSTom Erickson boolean_t zfs_prop_userquota(const char *); 24319b94df9SMatthew Ahrens boolean_t zfs_prop_written(const char *); 244990b4856Slling int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 245990b4856Slling int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 246b24ab676SJeff Bonwick uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 2474853e976Sgw boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 248b1b8ab34Slling 249990b4856Slling /* 250990b4856Slling * Pool property functions shared between libzfs and kernel. 251990b4856Slling */ 252990b4856Slling zpool_prop_t zpool_name_to_prop(const char *); 253990b4856Slling const char *zpool_prop_to_name(zpool_prop_t); 254990b4856Slling const char *zpool_prop_default_string(zpool_prop_t); 255990b4856Slling uint64_t zpool_prop_default_numeric(zpool_prop_t); 256990b4856Slling boolean_t zpool_prop_readonly(zpool_prop_t); 257ad135b5dSChristopher Siden boolean_t zpool_prop_feature(const char *); 258ad135b5dSChristopher Siden boolean_t zpool_prop_unsupported(const char *name); 259990b4856Slling int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 260990b4856Slling int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 261b24ab676SJeff Bonwick uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 262b1b8ab34Slling 263990b4856Slling /* 264990b4856Slling * Definitions for the Delegation. 265990b4856Slling */ 266ecd6cf80Smarks typedef enum { 267ecd6cf80Smarks ZFS_DELEG_WHO_UNKNOWN = 0, 268ecd6cf80Smarks ZFS_DELEG_USER = 'u', 269ecd6cf80Smarks ZFS_DELEG_USER_SETS = 'U', 270ecd6cf80Smarks ZFS_DELEG_GROUP = 'g', 271ecd6cf80Smarks ZFS_DELEG_GROUP_SETS = 'G', 272ecd6cf80Smarks ZFS_DELEG_EVERYONE = 'e', 273ecd6cf80Smarks ZFS_DELEG_EVERYONE_SETS = 'E', 274ecd6cf80Smarks ZFS_DELEG_CREATE = 'c', 275ecd6cf80Smarks ZFS_DELEG_CREATE_SETS = 'C', 276ecd6cf80Smarks ZFS_DELEG_NAMED_SET = 's', 277ecd6cf80Smarks ZFS_DELEG_NAMED_SET_SETS = 'S' 278ecd6cf80Smarks } zfs_deleg_who_type_t; 279ecd6cf80Smarks 280ecd6cf80Smarks typedef enum { 281ecd6cf80Smarks ZFS_DELEG_NONE = 0, 282ecd6cf80Smarks ZFS_DELEG_PERM_LOCAL = 1, 283ecd6cf80Smarks ZFS_DELEG_PERM_DESCENDENT = 2, 284ecd6cf80Smarks ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 285ecd6cf80Smarks ZFS_DELEG_PERM_CREATE = 4 286ecd6cf80Smarks } zfs_deleg_inherit_t; 287ecd6cf80Smarks 288ecd6cf80Smarks #define ZFS_DELEG_PERM_UID "uid" 289ecd6cf80Smarks #define ZFS_DELEG_PERM_GID "gid" 290ecd6cf80Smarks #define ZFS_DELEG_PERM_GROUPS "groups" 291ecd6cf80Smarks 2924201a95eSRic Aleshire #define ZFS_MLSLABEL_DEFAULT "none" 2934201a95eSRic Aleshire 294743a77edSAlan Wright #define ZFS_SMB_ACL_SRC "src" 295743a77edSAlan Wright #define ZFS_SMB_ACL_TARGET "target" 296743a77edSAlan Wright 297a227b7f4Shs typedef enum { 298a227b7f4Shs ZFS_CANMOUNT_OFF = 0, 299a227b7f4Shs ZFS_CANMOUNT_ON = 1, 300a227b7f4Shs ZFS_CANMOUNT_NOAUTO = 2 301a227b7f4Shs } zfs_canmount_type_t; 302a227b7f4Shs 303e09fa4daSNeil Perrin typedef enum { 304e09fa4daSNeil Perrin ZFS_LOGBIAS_LATENCY = 0, 305e09fa4daSNeil Perrin ZFS_LOGBIAS_THROUGHPUT = 1 306e09fa4daSNeil Perrin } zfs_logbias_op_t; 307e09fa4daSNeil Perrin 308da6c28aaSamw typedef enum zfs_share_op { 309da6c28aaSamw ZFS_SHARE_NFS = 0, 310da6c28aaSamw ZFS_UNSHARE_NFS = 1, 311da6c28aaSamw ZFS_SHARE_SMB = 2, 312da6c28aaSamw ZFS_UNSHARE_SMB = 3 313da6c28aaSamw } zfs_share_op_t; 314da6c28aaSamw 315743a77edSAlan Wright typedef enum zfs_smb_acl_op { 316743a77edSAlan Wright ZFS_SMB_ACL_ADD, 317743a77edSAlan Wright ZFS_SMB_ACL_REMOVE, 318743a77edSAlan Wright ZFS_SMB_ACL_RENAME, 319743a77edSAlan Wright ZFS_SMB_ACL_PURGE 320743a77edSAlan Wright } zfs_smb_acl_op_t; 321743a77edSAlan Wright 3223baa08fcSek typedef enum zfs_cache_type { 3233baa08fcSek ZFS_CACHE_NONE = 0, 3243baa08fcSek ZFS_CACHE_METADATA = 1, 3253baa08fcSek ZFS_CACHE_ALL = 2 3263baa08fcSek } zfs_cache_type_t; 3273baa08fcSek 32855da60b9SMark J Musante typedef enum { 32955da60b9SMark J Musante ZFS_SYNC_STANDARD = 0, 33055da60b9SMark J Musante ZFS_SYNC_ALWAYS = 1, 33155da60b9SMark J Musante ZFS_SYNC_DISABLED = 2 33255da60b9SMark J Musante } zfs_sync_type_t; 33355da60b9SMark J Musante 3343baa08fcSek 335eaca9bbdSeschrock /* 33699653d4eSeschrock * On-disk version number. 337eaca9bbdSeschrock */ 338e7437265Sahrens #define SPA_VERSION_1 1ULL 339e7437265Sahrens #define SPA_VERSION_2 2ULL 340e7437265Sahrens #define SPA_VERSION_3 3ULL 341e7437265Sahrens #define SPA_VERSION_4 4ULL 342e7437265Sahrens #define SPA_VERSION_5 5ULL 343e7437265Sahrens #define SPA_VERSION_6 6ULL 344e7437265Sahrens #define SPA_VERSION_7 7ULL 345e7437265Sahrens #define SPA_VERSION_8 8ULL 346da6c28aaSamw #define SPA_VERSION_9 9ULL 347fa94a07fSbrendan #define SPA_VERSION_10 10ULL 348088f3894Sahrens #define SPA_VERSION_11 11ULL 349bb0ade09Sahrens #define SPA_VERSION_12 12ULL 35074e7dc98SMatthew Ahrens #define SPA_VERSION_13 13ULL 351d0f3f37eSMark Shellenbaum #define SPA_VERSION_14 14ULL 35214843421SMatthew Ahrens #define SPA_VERSION_15 15ULL 353478ed9adSEric Taylor #define SPA_VERSION_16 16ULL 354f94275ceSAdam Leventhal #define SPA_VERSION_17 17ULL 355842727c2SChris Kirby #define SPA_VERSION_18 18ULL 35688ecc943SGeorge Wilson #define SPA_VERSION_19 19ULL 357b24ab676SJeff Bonwick #define SPA_VERSION_20 20ULL 358b24ab676SJeff Bonwick #define SPA_VERSION_21 21ULL 35992241e0bSTom Erickson #define SPA_VERSION_22 22ULL 3606e1f5caaSNeil Perrin #define SPA_VERSION_23 23ULL 3610a586ceaSMark Shellenbaum #define SPA_VERSION_24 24ULL 3623f9d6ad7SLin Ling #define SPA_VERSION_25 25ULL 363cde58dbcSMatthew Ahrens #define SPA_VERSION_26 26ULL 3646e0cbcaaSMatthew Ahrens #define SPA_VERSION_27 27ULL 365cb04b873SMark J Musante #define SPA_VERSION_28 28ULL 366ad135b5dSChristopher Siden #define SPA_VERSION_5000 5000ULL 367cb04b873SMark J Musante 368b1b8ab34Slling /* 369e7cbe64fSgw * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 370478ed9adSEric Taylor * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 37114843421SMatthew Ahrens * and do the appropriate changes. Also bump the version number in 37214843421SMatthew Ahrens * usr/src/grub/capability. 373b1b8ab34Slling */ 374ad135b5dSChristopher Siden #define SPA_VERSION SPA_VERSION_5000 375ad135b5dSChristopher Siden #define SPA_VERSION_STRING "5000" 37644cd46caSbillm 37744cd46caSbillm /* 378e7437265Sahrens * Symbolic names for the changes that caused a SPA_VERSION switch. 37944cd46caSbillm * Used in the code when checking for presence or absence of a feature. 38044cd46caSbillm * Feel free to define multiple symbolic names for each version if there 38144cd46caSbillm * were multiple changes to on-disk structures during that version. 38244cd46caSbillm * 383e7437265Sahrens * NOTE: When checking the current SPA_VERSION in your code, be sure 38444cd46caSbillm * to use spa_version() since it reports the version of the 38544cd46caSbillm * last synced uberblock. Checking the in-flight version can 38644cd46caSbillm * be dangerous in some cases. 38744cd46caSbillm */ 388e7437265Sahrens #define SPA_VERSION_INITIAL SPA_VERSION_1 389e7437265Sahrens #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 390e7437265Sahrens #define SPA_VERSION_SPARES SPA_VERSION_3 391f94275ceSAdam Leventhal #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 392cde58dbcSMatthew Ahrens #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 393e7437265Sahrens #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 394e7437265Sahrens #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 395e7437265Sahrens #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 396e7437265Sahrens #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 397e7437265Sahrens #define SPA_VERSION_BOOTFS SPA_VERSION_6 398990b4856Slling #define SPA_VERSION_SLOGS SPA_VERSION_7 399990b4856Slling #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 400da6c28aaSamw #define SPA_VERSION_FUID SPA_VERSION_9 401a9799022Sck #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 402a9799022Sck #define SPA_VERSION_REFQUOTA SPA_VERSION_9 403a9799022Sck #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 404fa94a07fSbrendan #define SPA_VERSION_L2CACHE SPA_VERSION_10 405088f3894Sahrens #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 406088f3894Sahrens #define SPA_VERSION_ORIGIN SPA_VERSION_11 407088f3894Sahrens #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 408bb0ade09Sahrens #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 40974e7dc98SMatthew Ahrens #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 410d0f3f37eSMark Shellenbaum #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 41114843421SMatthew Ahrens #define SPA_VERSION_USERSPACE SPA_VERSION_15 412478ed9adSEric Taylor #define SPA_VERSION_STMF_PROP SPA_VERSION_16 413f94275ceSAdam Leventhal #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 414842727c2SChris Kirby #define SPA_VERSION_USERREFS SPA_VERSION_18 41588ecc943SGeorge Wilson #define SPA_VERSION_HOLES SPA_VERSION_19 416b24ab676SJeff Bonwick #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 417b24ab676SJeff Bonwick #define SPA_VERSION_DEDUP SPA_VERSION_21 41892241e0bSTom Erickson #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 4196e1f5caaSNeil Perrin #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 4200a586ceaSMark Shellenbaum #define SPA_VERSION_SA SPA_VERSION_24 4213f9d6ad7SLin Ling #define SPA_VERSION_SCAN SPA_VERSION_25 422cde58dbcSMatthew Ahrens #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 423cde58dbcSMatthew Ahrens #define SPA_VERSION_DEADLISTS SPA_VERSION_26 4246e0cbcaaSMatthew Ahrens #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 425cb04b873SMark J Musante #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 426ad135b5dSChristopher Siden #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 427ad135b5dSChristopher Siden #define SPA_VERSION_FEATURES SPA_VERSION_5000 428ad135b5dSChristopher Siden 429ad135b5dSChristopher Siden #define SPA_VERSION_IS_SUPPORTED(v) \ 430ad135b5dSChristopher Siden (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 431ad135b5dSChristopher Siden ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 432e7437265Sahrens 433e7437265Sahrens /* 434e7437265Sahrens * ZPL version - rev'd whenever an incompatible on-disk format change 435e7437265Sahrens * occurs. This is independent of SPA/DMU/ZAP versioning. You must 436e7437265Sahrens * also update the version_table[] and help message in zfs_prop.c. 437e7437265Sahrens * 438e7437265Sahrens * When changing, be sure to teach GRUB how to read the new format! 439478ed9adSEric Taylor * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 440e7437265Sahrens */ 441e7437265Sahrens #define ZPL_VERSION_1 1ULL 442e7437265Sahrens #define ZPL_VERSION_2 2ULL 443da6c28aaSamw #define ZPL_VERSION_3 3ULL 44414843421SMatthew Ahrens #define ZPL_VERSION_4 4ULL 4450a586ceaSMark Shellenbaum #define ZPL_VERSION_5 5ULL 4460a586ceaSMark Shellenbaum #define ZPL_VERSION ZPL_VERSION_5 4470a586ceaSMark Shellenbaum #define ZPL_VERSION_STRING "5" 448e7437265Sahrens 449e7437265Sahrens #define ZPL_VERSION_INITIAL ZPL_VERSION_1 450e7437265Sahrens #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 451da6c28aaSamw #define ZPL_VERSION_FUID ZPL_VERSION_3 452de8267e0Stimh #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 453da6c28aaSamw #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 45414843421SMatthew Ahrens #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 4550a586ceaSMark Shellenbaum #define ZPL_VERSION_SA ZPL_VERSION_5 456eaca9bbdSeschrock 457468c413aSTim Haley /* Rewind request information */ 458c8ee1847SVictor Latushkin #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 459c8ee1847SVictor Latushkin #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 460c8ee1847SVictor Latushkin #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 461c8ee1847SVictor Latushkin #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 462c8ee1847SVictor Latushkin #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 463c8ee1847SVictor Latushkin #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 464c8ee1847SVictor Latushkin #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 465468c413aSTim Haley 466468c413aSTim Haley typedef struct zpool_rewind_policy { 467468c413aSTim Haley uint32_t zrp_request; /* rewind behavior requested */ 468c8ee1847SVictor Latushkin uint64_t zrp_maxmeta; /* max acceptable meta-data errors */ 469c8ee1847SVictor Latushkin uint64_t zrp_maxdata; /* max acceptable data errors */ 470468c413aSTim Haley uint64_t zrp_txg; /* specific txg to load */ 471468c413aSTim Haley } zpool_rewind_policy_t; 472468c413aSTim Haley 473fa9e4066Sahrens /* 474fa9e4066Sahrens * The following are configuration names used in the nvlist describing a pool's 475fa9e4066Sahrens * configuration. 476fa9e4066Sahrens */ 477fa9e4066Sahrens #define ZPOOL_CONFIG_VERSION "version" 478fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_NAME "name" 479fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_STATE "state" 480fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_TXG "txg" 481fa9e4066Sahrens #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 482fa9e4066Sahrens #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 483fa9e4066Sahrens #define ZPOOL_CONFIG_TOP_GUID "top_guid" 484fa9e4066Sahrens #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 485fa9e4066Sahrens #define ZPOOL_CONFIG_TYPE "type" 486fa9e4066Sahrens #define ZPOOL_CONFIG_CHILDREN "children" 487fa9e4066Sahrens #define ZPOOL_CONFIG_ID "id" 488fa9e4066Sahrens #define ZPOOL_CONFIG_GUID "guid" 489fa9e4066Sahrens #define ZPOOL_CONFIG_PATH "path" 490fa9e4066Sahrens #define ZPOOL_CONFIG_DEVID "devid" 491fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 492fa9e4066Sahrens #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 493fa9e4066Sahrens #define ZPOOL_CONFIG_ASHIFT "ashift" 494fa9e4066Sahrens #define ZPOOL_CONFIG_ASIZE "asize" 495fa9e4066Sahrens #define ZPOOL_CONFIG_DTL "DTL" 4963f9d6ad7SLin Ling #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 4973f9d6ad7SLin Ling #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 498afefbcddSeschrock #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 499ea8dc4b6Seschrock #define ZPOOL_CONFIG_ERRCOUNT "error_count" 500ea8dc4b6Seschrock #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 50199653d4eSeschrock #define ZPOOL_CONFIG_SPARES "spares" 50299653d4eSeschrock #define ZPOOL_CONFIG_IS_SPARE "is_spare" 50399653d4eSeschrock #define ZPOOL_CONFIG_NPARITY "nparity" 50495173954Sek #define ZPOOL_CONFIG_HOSTID "hostid" 50595173954Sek #define ZPOOL_CONFIG_HOSTNAME "hostname" 50611027bc7STim Haley #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 5073d7072f8Seschrock #define ZPOOL_CONFIG_UNSPARE "unspare" 5083d7072f8Seschrock #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 5098654d025Sperrin #define ZPOOL_CONFIG_IS_LOG "is_log" 510fa94a07fSbrendan #define ZPOOL_CONFIG_L2CACHE "l2cache" 51188ecc943SGeorge Wilson #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 51288ecc943SGeorge Wilson #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 51388ecc943SGeorge Wilson #define ZPOOL_CONFIG_IS_HOLE "is_hole" 5149eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 5159eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 5169eb19f4dSGeorge Wilson #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 5171195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT "splitcfg" 5181195e687SMark J Musante #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 5191195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 5201195e687SMark J Musante #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 5213f9d6ad7SLin Ling #define ZPOOL_CONFIG_REMOVING "removing" 522cb04b873SMark J Musante #define ZPOOL_CONFIG_RESILVERING "resilvering" 5238704186eSDan McDonald #define ZPOOL_CONFIG_COMMENT "comment" 524e14bb325SJeff Bonwick #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 525e7cbe64fSgw #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 526e7cbe64fSgw #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 5274b964adaSGeorge Wilson #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 5284b964adaSGeorge Wilson #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 529ad135b5dSChristopher Siden #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */ 530ad135b5dSChristopher Siden #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */ 531ad135b5dSChristopher Siden #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */ 532ad135b5dSChristopher Siden #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 533ad135b5dSChristopher Siden #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */ 5343d7072f8Seschrock /* 5353d7072f8Seschrock * The persistent vdev state is stored as separate values rather than a single 5363d7072f8Seschrock * 'vdev_state' entry. This is because a device can be in multiple states, such 5373d7072f8Seschrock * as offline and degraded. 5383d7072f8Seschrock */ 5393d7072f8Seschrock #define ZPOOL_CONFIG_OFFLINE "offline" 5403d7072f8Seschrock #define ZPOOL_CONFIG_FAULTED "faulted" 5413d7072f8Seschrock #define ZPOOL_CONFIG_DEGRADED "degraded" 5423d7072f8Seschrock #define ZPOOL_CONFIG_REMOVED "removed" 5436809eb4eSEric Schrock #define ZPOOL_CONFIG_FRU "fru" 544069f55e2SEric Schrock #define ZPOOL_CONFIG_AUX_STATE "aux_state" 545fa9e4066Sahrens 546468c413aSTim Haley /* Rewind policy parameters */ 547468c413aSTim Haley #define ZPOOL_REWIND_POLICY "rewind-policy" 548468c413aSTim Haley #define ZPOOL_REWIND_REQUEST "rewind-request" 549468c413aSTim Haley #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg" 550468c413aSTim Haley #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh" 551468c413aSTim Haley #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh" 552468c413aSTim Haley 553468c413aSTim Haley /* Rewind data discovered */ 554468c413aSTim Haley #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 555468c413aSTim Haley #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 556468c413aSTim Haley #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 557468c413aSTim Haley 558fa9e4066Sahrens #define VDEV_TYPE_ROOT "root" 559fa9e4066Sahrens #define VDEV_TYPE_MIRROR "mirror" 560fa9e4066Sahrens #define VDEV_TYPE_REPLACING "replacing" 561fa9e4066Sahrens #define VDEV_TYPE_RAIDZ "raidz" 562fa9e4066Sahrens #define VDEV_TYPE_DISK "disk" 563fa9e4066Sahrens #define VDEV_TYPE_FILE "file" 564fa9e4066Sahrens #define VDEV_TYPE_MISSING "missing" 56588ecc943SGeorge Wilson #define VDEV_TYPE_HOLE "hole" 56699653d4eSeschrock #define VDEV_TYPE_SPARE "spare" 5678654d025Sperrin #define VDEV_TYPE_LOG "log" 568fa94a07fSbrendan #define VDEV_TYPE_L2CACHE "l2cache" 569fa9e4066Sahrens 570fa9e4066Sahrens /* 571fa9e4066Sahrens * This is needed in userland to report the minimum necessary device size. 572fa9e4066Sahrens */ 573fa9e4066Sahrens #define SPA_MINDEVSIZE (64ULL << 20) 574fa9e4066Sahrens 575fa9e4066Sahrens /* 576fa9e4066Sahrens * The location of the pool configuration repository, shared between kernel and 577fa9e4066Sahrens * userland. 578fa9e4066Sahrens */ 579c5904d13Seschrock #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 580fa9e4066Sahrens 581fa9e4066Sahrens /* 582fa9e4066Sahrens * vdev states are ordered from least to most healthy. 583fa9e4066Sahrens * A vdev that's CANT_OPEN or below is considered unusable. 584fa9e4066Sahrens */ 585fa9e4066Sahrens typedef enum vdev_state { 586fa9e4066Sahrens VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 587fa9e4066Sahrens VDEV_STATE_CLOSED, /* Not currently open */ 588fa9e4066Sahrens VDEV_STATE_OFFLINE, /* Not allowed to open */ 5893d7072f8Seschrock VDEV_STATE_REMOVED, /* Explicitly removed from system */ 590fa9e4066Sahrens VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 5913d7072f8Seschrock VDEV_STATE_FAULTED, /* External request to fault device */ 592fa9e4066Sahrens VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 593fa9e4066Sahrens VDEV_STATE_HEALTHY /* Presumed good */ 594fa9e4066Sahrens } vdev_state_t; 595fa9e4066Sahrens 5963d7072f8Seschrock #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 5973d7072f8Seschrock 598fa9e4066Sahrens /* 599fa9e4066Sahrens * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 600fa9e4066Sahrens * of the vdev stats structure uses these constants to distinguish why. 601fa9e4066Sahrens */ 602fa9e4066Sahrens typedef enum vdev_aux { 603fa9e4066Sahrens VDEV_AUX_NONE, /* no error */ 604fa9e4066Sahrens VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 605fa9e4066Sahrens VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 606fa9e4066Sahrens VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 607fa9e4066Sahrens VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 608fa9e4066Sahrens VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 609eaca9bbdSeschrock VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 610eaca9bbdSeschrock VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 61199653d4eSeschrock VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 612ad135b5dSChristopher Siden VDEV_AUX_UNSUP_FEAT, /* unsupported features */ 6133d7072f8Seschrock VDEV_AUX_SPARED, /* hot spare used in another pool */ 61432b87932Sek VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 615b87f3af3Sperrin VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 616069f55e2SEric Schrock VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 6171195e687SMark J Musante VDEV_AUX_EXTERNAL, /* external diagnosis */ 6181195e687SMark J Musante VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */ 619fa9e4066Sahrens } vdev_aux_t; 620fa9e4066Sahrens 621fa9e4066Sahrens /* 62246a2abf2Seschrock * pool state. The following states are written to disk as part of the normal 623fa94a07fSbrendan * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 624fa94a07fSbrendan * states are software abstractions used at various levels to communicate 625fa94a07fSbrendan * pool state. 626fa9e4066Sahrens */ 627fa9e4066Sahrens typedef enum pool_state { 628fa9e4066Sahrens POOL_STATE_ACTIVE = 0, /* In active use */ 629fa9e4066Sahrens POOL_STATE_EXPORTED, /* Explicitly exported */ 630fa9e4066Sahrens POOL_STATE_DESTROYED, /* Explicitly destroyed */ 63199653d4eSeschrock POOL_STATE_SPARE, /* Reserved for hot spare use */ 632fa94a07fSbrendan POOL_STATE_L2CACHE, /* Level 2 ARC device */ 633fa9e4066Sahrens POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 63446a2abf2Seschrock POOL_STATE_UNAVAIL, /* Internal libzfs state */ 63546a2abf2Seschrock POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 636fa9e4066Sahrens } pool_state_t; 637fa9e4066Sahrens 638fa9e4066Sahrens /* 6393f9d6ad7SLin Ling * Scan Functions. 640fa9e4066Sahrens */ 6413f9d6ad7SLin Ling typedef enum pool_scan_func { 6423f9d6ad7SLin Ling POOL_SCAN_NONE, 6433f9d6ad7SLin Ling POOL_SCAN_SCRUB, 6443f9d6ad7SLin Ling POOL_SCAN_RESILVER, 6453f9d6ad7SLin Ling POOL_SCAN_FUNCS 6463f9d6ad7SLin Ling } pool_scan_func_t; 647fa9e4066Sahrens 648fa9e4066Sahrens /* 649fa9e4066Sahrens * ZIO types. Needed to interpret vdev statistics below. 650fa9e4066Sahrens */ 651fa9e4066Sahrens typedef enum zio_type { 652fa9e4066Sahrens ZIO_TYPE_NULL = 0, 653fa9e4066Sahrens ZIO_TYPE_READ, 654fa9e4066Sahrens ZIO_TYPE_WRITE, 655fa9e4066Sahrens ZIO_TYPE_FREE, 656fa9e4066Sahrens ZIO_TYPE_CLAIM, 657fa9e4066Sahrens ZIO_TYPE_IOCTL, 658fa9e4066Sahrens ZIO_TYPES 659fa9e4066Sahrens } zio_type_t; 660fa9e4066Sahrens 6613f9d6ad7SLin Ling /* 6623f9d6ad7SLin Ling * Pool statistics. Note: all fields should be 64-bit because this 6633f9d6ad7SLin Ling * is passed between kernel and userland as an nvlist uint64 array. 6643f9d6ad7SLin Ling */ 6653f9d6ad7SLin Ling typedef struct pool_scan_stat { 6663f9d6ad7SLin Ling /* values stored on disk */ 6673f9d6ad7SLin Ling uint64_t pss_func; /* pool_scan_func_t */ 6683f9d6ad7SLin Ling uint64_t pss_state; /* dsl_scan_state_t */ 6693f9d6ad7SLin Ling uint64_t pss_start_time; /* scan start time */ 6703f9d6ad7SLin Ling uint64_t pss_end_time; /* scan end time */ 6713f9d6ad7SLin Ling uint64_t pss_to_examine; /* total bytes to scan */ 6723f9d6ad7SLin Ling uint64_t pss_examined; /* total examined bytes */ 6733f9d6ad7SLin Ling uint64_t pss_to_process; /* total bytes to process */ 6743f9d6ad7SLin Ling uint64_t pss_processed; /* total processed bytes */ 6753f9d6ad7SLin Ling uint64_t pss_errors; /* scan errors */ 6763f9d6ad7SLin Ling 6773f9d6ad7SLin Ling /* values not stored on disk */ 6783f9d6ad7SLin Ling uint64_t pss_pass_exam; /* examined bytes per scan pass */ 6793f9d6ad7SLin Ling uint64_t pss_pass_start; /* start time of a scan pass */ 6803f9d6ad7SLin Ling } pool_scan_stat_t; 6813f9d6ad7SLin Ling 6823f9d6ad7SLin Ling typedef enum dsl_scan_state { 6833f9d6ad7SLin Ling DSS_NONE, 6843f9d6ad7SLin Ling DSS_SCANNING, 6853f9d6ad7SLin Ling DSS_FINISHED, 6863f9d6ad7SLin Ling DSS_CANCELED, 6873f9d6ad7SLin Ling DSS_NUM_STATES 6883f9d6ad7SLin Ling } dsl_scan_state_t; 6893f9d6ad7SLin Ling 6903f9d6ad7SLin Ling 691fa9e4066Sahrens /* 692fa9e4066Sahrens * Vdev statistics. Note: all fields should be 64-bit because this 693fa9e4066Sahrens * is passed between kernel and userland as an nvlist uint64 array. 694fa9e4066Sahrens */ 695fa9e4066Sahrens typedef struct vdev_stat { 696fa9e4066Sahrens hrtime_t vs_timestamp; /* time since vdev load */ 697fa9e4066Sahrens uint64_t vs_state; /* vdev state */ 698fa9e4066Sahrens uint64_t vs_aux; /* see vdev_aux_t */ 699fa9e4066Sahrens uint64_t vs_alloc; /* space allocated */ 700fa9e4066Sahrens uint64_t vs_space; /* total capacity */ 70199653d4eSeschrock uint64_t vs_dspace; /* deflated capacity */ 7022a79c5feSlling uint64_t vs_rsize; /* replaceable dev size */ 7034263d13fSGeorge Wilson uint64_t vs_esize; /* expandable dev size */ 704fa9e4066Sahrens uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 705fa9e4066Sahrens uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 706fa9e4066Sahrens uint64_t vs_read_errors; /* read errors */ 707fa9e4066Sahrens uint64_t vs_write_errors; /* write errors */ 708fa9e4066Sahrens uint64_t vs_checksum_errors; /* checksum errors */ 709fa9e4066Sahrens uint64_t vs_self_healed; /* self-healed bytes */ 7103f9d6ad7SLin Ling uint64_t vs_scan_removing; /* removing? */ 7113f9d6ad7SLin Ling uint64_t vs_scan_processed; /* scan processed bytes */ 712fa9e4066Sahrens } vdev_stat_t; 713fa9e4066Sahrens 7149eb19f4dSGeorge Wilson /* 7159eb19f4dSGeorge Wilson * DDT statistics. Note: all fields should be 64-bit because this 7169eb19f4dSGeorge Wilson * is passed between kernel and userland as an nvlist uint64 array. 7179eb19f4dSGeorge Wilson */ 7189eb19f4dSGeorge Wilson typedef struct ddt_object { 7199eb19f4dSGeorge Wilson uint64_t ddo_count; /* number of elments in ddt */ 7209eb19f4dSGeorge Wilson uint64_t ddo_dspace; /* size of ddt on disk */ 7219eb19f4dSGeorge Wilson uint64_t ddo_mspace; /* size of ddt in-core */ 7229eb19f4dSGeorge Wilson } ddt_object_t; 7239eb19f4dSGeorge Wilson 7249eb19f4dSGeorge Wilson typedef struct ddt_stat { 7259eb19f4dSGeorge Wilson uint64_t dds_blocks; /* blocks */ 7269eb19f4dSGeorge Wilson uint64_t dds_lsize; /* logical size */ 7279eb19f4dSGeorge Wilson uint64_t dds_psize; /* physical size */ 7289eb19f4dSGeorge Wilson uint64_t dds_dsize; /* deflated allocated size */ 7299eb19f4dSGeorge Wilson uint64_t dds_ref_blocks; /* referenced blocks */ 7309eb19f4dSGeorge Wilson uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 7319eb19f4dSGeorge Wilson uint64_t dds_ref_psize; /* referenced psize * refcnt */ 7329eb19f4dSGeorge Wilson uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 7339eb19f4dSGeorge Wilson } ddt_stat_t; 7349eb19f4dSGeorge Wilson 7359eb19f4dSGeorge Wilson typedef struct ddt_histogram { 7369eb19f4dSGeorge Wilson ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 7379eb19f4dSGeorge Wilson } ddt_histogram_t; 7389eb19f4dSGeorge Wilson 739e7cbe64fSgw #define ZVOL_DRIVER "zvol" 740fa9e4066Sahrens #define ZFS_DRIVER "zfs" 741fa9e4066Sahrens #define ZFS_DEV "/dev/zfs" 742fa9e4066Sahrens 743681d9761SEric Taylor /* general zvol path */ 744681d9761SEric Taylor #define ZVOL_DIR "/dev/zvol" 745681d9761SEric Taylor /* expansion */ 746573ca77eSGeorge Wilson #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 747681d9761SEric Taylor /* for dump and swap */ 748681d9761SEric Taylor #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 749681d9761SEric Taylor #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 750fa9e4066Sahrens 751fa9e4066Sahrens #define ZVOL_PROP_NAME "name" 752c1449561SEric Taylor #define ZVOL_DEFAULT_BLOCKSIZE 8192 753fa9e4066Sahrens 754fa9e4066Sahrens /* 755fa9e4066Sahrens * /dev/zfs ioctl numbers. 756fa9e4066Sahrens */ 757fa9e4066Sahrens typedef enum zfs_ioc { 758*4445fffbSMatthew Ahrens ZFS_IOC_FIRST = ('Z' << 8), 759*4445fffbSMatthew Ahrens ZFS_IOC = ZFS_IOC_FIRST, 760*4445fffbSMatthew Ahrens ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, 761fa9e4066Sahrens ZFS_IOC_POOL_DESTROY, 762fa9e4066Sahrens ZFS_IOC_POOL_IMPORT, 763fa9e4066Sahrens ZFS_IOC_POOL_EXPORT, 764fa9e4066Sahrens ZFS_IOC_POOL_CONFIGS, 765fa9e4066Sahrens ZFS_IOC_POOL_STATS, 766fa9e4066Sahrens ZFS_IOC_POOL_TRYIMPORT, 7673f9d6ad7SLin Ling ZFS_IOC_POOL_SCAN, 768fa9e4066Sahrens ZFS_IOC_POOL_FREEZE, 769eaca9bbdSeschrock ZFS_IOC_POOL_UPGRADE, 77006eeb2adSek ZFS_IOC_POOL_GET_HISTORY, 771fa9e4066Sahrens ZFS_IOC_VDEV_ADD, 772fa9e4066Sahrens ZFS_IOC_VDEV_REMOVE, 7733d7072f8Seschrock ZFS_IOC_VDEV_SET_STATE, 774fa9e4066Sahrens ZFS_IOC_VDEV_ATTACH, 775fa9e4066Sahrens ZFS_IOC_VDEV_DETACH, 776c67d9675Seschrock ZFS_IOC_VDEV_SETPATH, 7776809eb4eSEric Schrock ZFS_IOC_VDEV_SETFRU, 778fa9e4066Sahrens ZFS_IOC_OBJSET_STATS, 779de8267e0Stimh ZFS_IOC_OBJSET_ZPLPROPS, 780fa9e4066Sahrens ZFS_IOC_DATASET_LIST_NEXT, 781fa9e4066Sahrens ZFS_IOC_SNAPSHOT_LIST_NEXT, 782fa9e4066Sahrens ZFS_IOC_SET_PROP, 783fa9e4066Sahrens ZFS_IOC_CREATE, 784fa9e4066Sahrens ZFS_IOC_DESTROY, 785fa9e4066Sahrens ZFS_IOC_ROLLBACK, 786fa9e4066Sahrens ZFS_IOC_RENAME, 7873cb34c60Sahrens ZFS_IOC_RECV, 7883cb34c60Sahrens ZFS_IOC_SEND, 789ea8dc4b6Seschrock ZFS_IOC_INJECT_FAULT, 790ea8dc4b6Seschrock ZFS_IOC_CLEAR_FAULT, 791ea8dc4b6Seschrock ZFS_IOC_INJECT_LIST_NEXT, 792ea8dc4b6Seschrock ZFS_IOC_ERROR_LOG, 793ea8dc4b6Seschrock ZFS_IOC_CLEAR, 7941d452cf5Sahrens ZFS_IOC_PROMOTE, 79555434c77Sek ZFS_IOC_SNAPSHOT, 79655434c77Sek ZFS_IOC_DSOBJ_TO_DSNAME, 797b1b8ab34Slling ZFS_IOC_OBJ_TO_PATH, 798b1b8ab34Slling ZFS_IOC_POOL_SET_PROPS, 799ecd6cf80Smarks ZFS_IOC_POOL_GET_PROPS, 800ecd6cf80Smarks ZFS_IOC_SET_FSACL, 801ecd6cf80Smarks ZFS_IOC_GET_FSACL, 802e45ce728Sahrens ZFS_IOC_SHARE, 803743a77edSAlan Wright ZFS_IOC_INHERIT_PROP, 80414843421SMatthew Ahrens ZFS_IOC_SMB_ACL, 80514843421SMatthew Ahrens ZFS_IOC_USERSPACE_ONE, 80614843421SMatthew Ahrens ZFS_IOC_USERSPACE_MANY, 807842727c2SChris Kirby ZFS_IOC_USERSPACE_UPGRADE, 808842727c2SChris Kirby ZFS_IOC_HOLD, 809842727c2SChris Kirby ZFS_IOC_RELEASE, 81092241e0bSTom Erickson ZFS_IOC_GET_HOLDS, 8111195e687SMark J Musante ZFS_IOC_OBJSET_RECVD_PROPS, 81299d5e173STim Haley ZFS_IOC_VDEV_SPLIT, 81399d5e173STim Haley ZFS_IOC_NEXT_OBJ, 81499d5e173STim Haley ZFS_IOC_DIFF, 81599d5e173STim Haley ZFS_IOC_TMP_SNAPSHOT, 816e9103aaeSGarrett D'Amore ZFS_IOC_OBJ_TO_STATS, 81719b94df9SMatthew Ahrens ZFS_IOC_SPACE_WRITTEN, 81819b94df9SMatthew Ahrens ZFS_IOC_SPACE_SNAPS, 819*4445fffbSMatthew Ahrens ZFS_IOC_DESTROY_SNAPS, 8204263d13fSGeorge Wilson ZFS_IOC_POOL_REGUID, 8214e3c9f44SBill Pijewski ZFS_IOC_POOL_REOPEN, 822*4445fffbSMatthew Ahrens ZFS_IOC_SEND_PROGRESS, 823*4445fffbSMatthew Ahrens ZFS_IOC_LOG_HISTORY, 824*4445fffbSMatthew Ahrens ZFS_IOC_SEND_NEW, 825*4445fffbSMatthew Ahrens ZFS_IOC_SEND_SPACE, 826*4445fffbSMatthew Ahrens ZFS_IOC_CLONE, 827*4445fffbSMatthew Ahrens ZFS_IOC_LAST 828fa9e4066Sahrens } zfs_ioc_t; 829fa9e4066Sahrens 830ea8dc4b6Seschrock /* 831ea8dc4b6Seschrock * Internal SPA load state. Used by FMA diagnosis engine. 832ea8dc4b6Seschrock */ 833ea8dc4b6Seschrock typedef enum { 8349eb19f4dSGeorge Wilson SPA_LOAD_NONE, /* no load in progress */ 8359eb19f4dSGeorge Wilson SPA_LOAD_OPEN, /* normal open */ 8369eb19f4dSGeorge Wilson SPA_LOAD_IMPORT, /* import in progress */ 837468c413aSTim Haley SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 8389eb19f4dSGeorge Wilson SPA_LOAD_RECOVER, /* recovery requested */ 8399eb19f4dSGeorge Wilson SPA_LOAD_ERROR /* load failed */ 840ea8dc4b6Seschrock } spa_load_state_t; 841ea8dc4b6Seschrock 842e9dbad6fSeschrock /* 843e9dbad6fSeschrock * Bookmark name values. 844e9dbad6fSeschrock */ 84555434c77Sek #define ZPOOL_ERR_LIST "error list" 846e9dbad6fSeschrock #define ZPOOL_ERR_DATASET "dataset" 847e9dbad6fSeschrock #define ZPOOL_ERR_OBJECT "object" 848e9dbad6fSeschrock 84906eeb2adSek #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 85006eeb2adSek 85106eeb2adSek /* 85206eeb2adSek * The following are names used in the nvlist describing 85306eeb2adSek * the pool's history log. 85406eeb2adSek */ 85506eeb2adSek #define ZPOOL_HIST_RECORD "history record" 85606eeb2adSek #define ZPOOL_HIST_TIME "history time" 85706eeb2adSek #define ZPOOL_HIST_CMD "history command" 858ecd6cf80Smarks #define ZPOOL_HIST_WHO "history who" 859ecd6cf80Smarks #define ZPOOL_HIST_ZONE "history zone" 860ecd6cf80Smarks #define ZPOOL_HIST_HOST "history hostname" 861ecd6cf80Smarks #define ZPOOL_HIST_TXG "history txg" 862ecd6cf80Smarks #define ZPOOL_HIST_INT_EVENT "history internal event" 863ecd6cf80Smarks #define ZPOOL_HIST_INT_STR "history internal str" 864*4445fffbSMatthew Ahrens #define ZPOOL_HIST_INT_NAME "internal_name" 865*4445fffbSMatthew Ahrens #define ZPOOL_HIST_IOCTL "ioctl" 866*4445fffbSMatthew Ahrens #define ZPOOL_HIST_INPUT_NVL "in_nvl" 867*4445fffbSMatthew Ahrens #define ZPOOL_HIST_OUTPUT_NVL "out_nvl" 868*4445fffbSMatthew Ahrens #define ZPOOL_HIST_DSNAME "dsname" 869*4445fffbSMatthew Ahrens #define ZPOOL_HIST_DSID "dsid" 87006eeb2adSek 8713d7072f8Seschrock /* 8723d7072f8Seschrock * Flags for ZFS_IOC_VDEV_SET_STATE 8733d7072f8Seschrock */ 8743d7072f8Seschrock #define ZFS_ONLINE_CHECKREMOVE 0x1 8753d7072f8Seschrock #define ZFS_ONLINE_UNSPARE 0x2 8763d7072f8Seschrock #define ZFS_ONLINE_FORCEFAULT 0x4 877573ca77eSGeorge Wilson #define ZFS_ONLINE_EXPAND 0x8 8783d7072f8Seschrock #define ZFS_OFFLINE_TEMPORARY 0x1 8793d7072f8Seschrock 8804b964adaSGeorge Wilson /* 8814b964adaSGeorge Wilson * Flags for ZFS_IOC_POOL_IMPORT 8824b964adaSGeorge Wilson */ 8834b964adaSGeorge Wilson #define ZFS_IMPORT_NORMAL 0x0 8844b964adaSGeorge Wilson #define ZFS_IMPORT_VERBATIM 0x1 8854b964adaSGeorge Wilson #define ZFS_IMPORT_ANY_HOST 0x2 8864b964adaSGeorge Wilson #define ZFS_IMPORT_MISSING_LOG 0x4 887f9af39baSGeorge Wilson #define ZFS_IMPORT_ONLY 0x8 8884b964adaSGeorge Wilson 8893d7072f8Seschrock /* 8903d7072f8Seschrock * Sysevent payload members. ZFS will generate the following sysevents with the 8913d7072f8Seschrock * given payloads: 8923d7072f8Seschrock * 8933d7072f8Seschrock * ESC_ZFS_RESILVER_START 8943d7072f8Seschrock * ESC_ZFS_RESILVER_END 8953d7072f8Seschrock * ESC_ZFS_POOL_DESTROY 896e9103aaeSGarrett D'Amore * ESC_ZFS_POOL_REGUID 8973d7072f8Seschrock * 8983d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 8993d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 9003d7072f8Seschrock * 9013d7072f8Seschrock * ESC_ZFS_VDEV_REMOVE 9023d7072f8Seschrock * ESC_ZFS_VDEV_CLEAR 9033d7072f8Seschrock * ESC_ZFS_VDEV_CHECK 9043d7072f8Seschrock * 9053d7072f8Seschrock * ZFS_EV_POOL_NAME DATA_TYPE_STRING 9063d7072f8Seschrock * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 9073d7072f8Seschrock * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 9083d7072f8Seschrock * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 9093d7072f8Seschrock */ 9103d7072f8Seschrock #define ZFS_EV_POOL_NAME "pool_name" 9113d7072f8Seschrock #define ZFS_EV_POOL_GUID "pool_guid" 9123d7072f8Seschrock #define ZFS_EV_VDEV_PATH "vdev_path" 9133d7072f8Seschrock #define ZFS_EV_VDEV_GUID "vdev_guid" 9143d7072f8Seschrock 915fa9e4066Sahrens #ifdef __cplusplus 916fa9e4066Sahrens } 917fa9e4066Sahrens #endif 918fa9e4066Sahrens 919fa9e4066Sahrens #endif /* _SYS_FS_ZFS_H */ 920