1/* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 22/* 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26/* Portions Copyright 2010 Robert Milkowski */ 27 28#ifndef _SYS_FS_ZFS_H 29#define _SYS_FS_ZFS_H 30 31#include <sys/time.h> 32 33#ifdef __cplusplus 34extern "C" { 35#endif 36 37/* 38 * Types and constants shared between userland and the kernel. 39 */ 40 41/* 42 * Each dataset can be one of the following types. These constants can be 43 * combined into masks that can be passed to various functions. 44 */ 45typedef enum { 46 ZFS_TYPE_FILESYSTEM = 0x1, 47 ZFS_TYPE_SNAPSHOT = 0x2, 48 ZFS_TYPE_VOLUME = 0x4, 49 ZFS_TYPE_POOL = 0x8 50} zfs_type_t; 51 52#define ZFS_TYPE_DATASET \ 53 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 54 55#define ZAP_MAXNAMELEN 256 56#define ZAP_MAXVALUELEN (1024 * 8) 57#define ZAP_OLDMAXVALUELEN 1024 58 59/* 60 * Dataset properties are identified by these constants and must be added to 61 * the end of this list to ensure that external consumers are not affected 62 * by the change. If you make any changes to this list, be sure to update 63 * the property table in usr/src/common/zfs/zfs_prop.c. 64 */ 65typedef enum { 66 ZFS_PROP_TYPE, 67 ZFS_PROP_CREATION, 68 ZFS_PROP_USED, 69 ZFS_PROP_AVAILABLE, 70 ZFS_PROP_REFERENCED, 71 ZFS_PROP_COMPRESSRATIO, 72 ZFS_PROP_MOUNTED, 73 ZFS_PROP_ORIGIN, 74 ZFS_PROP_QUOTA, 75 ZFS_PROP_RESERVATION, 76 ZFS_PROP_VOLSIZE, 77 ZFS_PROP_VOLBLOCKSIZE, 78 ZFS_PROP_RECORDSIZE, 79 ZFS_PROP_MOUNTPOINT, 80 ZFS_PROP_SHARENFS, 81 ZFS_PROP_CHECKSUM, 82 ZFS_PROP_COMPRESSION, 83 ZFS_PROP_ATIME, 84 ZFS_PROP_DEVICES, 85 ZFS_PROP_EXEC, 86 ZFS_PROP_SETUID, 87 ZFS_PROP_READONLY, 88 ZFS_PROP_ZONED, 89 ZFS_PROP_SNAPDIR, 90 ZFS_PROP_PRIVATE, /* not exposed to user, temporary */ 91 ZFS_PROP_ACLINHERIT, 92 ZFS_PROP_CREATETXG, /* not exposed to the user */ 93 ZFS_PROP_NAME, /* not exposed to the user */ 94 ZFS_PROP_CANMOUNT, 95 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 96 ZFS_PROP_XATTR, 97 ZFS_PROP_NUMCLONES, /* not exposed to the user */ 98 ZFS_PROP_COPIES, 99 ZFS_PROP_VERSION, 100 ZFS_PROP_UTF8ONLY, 101 ZFS_PROP_NORMALIZE, 102 ZFS_PROP_CASE, 103 ZFS_PROP_VSCAN, 104 ZFS_PROP_NBMAND, 105 ZFS_PROP_SHARESMB, 106 ZFS_PROP_REFQUOTA, 107 ZFS_PROP_REFRESERVATION, 108 ZFS_PROP_GUID, 109 ZFS_PROP_PRIMARYCACHE, 110 ZFS_PROP_SECONDARYCACHE, 111 ZFS_PROP_USEDSNAP, 112 ZFS_PROP_USEDDS, 113 ZFS_PROP_USEDCHILD, 114 ZFS_PROP_USEDREFRESERV, 115 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 116 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 117 ZFS_PROP_DEFER_DESTROY, 118 ZFS_PROP_USERREFS, 119 ZFS_PROP_LOGBIAS, 120 ZFS_PROP_UNIQUE, /* not exposed to the user */ 121 ZFS_PROP_OBJSETID, /* not exposed to the user */ 122 ZFS_PROP_DEDUP, 123 ZFS_PROP_MLSLABEL, 124 ZFS_PROP_SYNC, 125 ZFS_NUM_PROPS 126} zfs_prop_t; 127 128typedef enum { 129 ZFS_PROP_USERUSED, 130 ZFS_PROP_USERQUOTA, 131 ZFS_PROP_GROUPUSED, 132 ZFS_PROP_GROUPQUOTA, 133 ZFS_NUM_USERQUOTA_PROPS 134} zfs_userquota_prop_t; 135 136extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS]; 137 138/* 139 * Pool properties are identified by these constants and must be added to the 140 * end of this list to ensure that external consumers are not affected 141 * by the change. If you make any changes to this list, be sure to update 142 * the property table in usr/src/common/zfs/zpool_prop.c. 143 */ 144typedef enum { 145 ZPOOL_PROP_NAME, 146 ZPOOL_PROP_SIZE, 147 ZPOOL_PROP_CAPACITY, 148 ZPOOL_PROP_ALTROOT, 149 ZPOOL_PROP_HEALTH, 150 ZPOOL_PROP_GUID, 151 ZPOOL_PROP_VERSION, 152 ZPOOL_PROP_BOOTFS, 153 ZPOOL_PROP_DELEGATION, 154 ZPOOL_PROP_AUTOREPLACE, 155 ZPOOL_PROP_CACHEFILE, 156 ZPOOL_PROP_FAILUREMODE, 157 ZPOOL_PROP_LISTSNAPS, 158 ZPOOL_PROP_AUTOEXPAND, 159 ZPOOL_PROP_DEDUPDITTO, 160 ZPOOL_PROP_DEDUPRATIO, 161 ZPOOL_PROP_FREE, 162 ZPOOL_PROP_ALLOCATED, 163 ZPOOL_PROP_READONLY, 164 ZPOOL_NUM_PROPS 165} zpool_prop_t; 166 167#define ZPROP_CONT -2 168#define ZPROP_INVAL -1 169 170#define ZPROP_VALUE "value" 171#define ZPROP_SOURCE "source" 172 173typedef enum { 174 ZPROP_SRC_NONE = 0x1, 175 ZPROP_SRC_DEFAULT = 0x2, 176 ZPROP_SRC_TEMPORARY = 0x4, 177 ZPROP_SRC_LOCAL = 0x8, 178 ZPROP_SRC_INHERITED = 0x10, 179 ZPROP_SRC_RECEIVED = 0x20 180} zprop_source_t; 181 182#define ZPROP_SRC_ALL 0x3f 183 184#define ZPROP_SOURCE_VAL_RECVD "$recvd" 185#define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 186/* 187 * Dataset flag implemented as a special entry in the props zap object 188 * indicating that the dataset has received properties on or after 189 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 190 * just as it did in earlier versions, and thereafter, local properties are 191 * preserved. 192 */ 193#define ZPROP_HAS_RECVD "$hasrecvd" 194 195typedef enum { 196 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 197 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 198} zprop_errflags_t; 199 200typedef int (*zprop_func)(int, void *); 201 202/* 203 * Properties to be set on the root file system of a new pool 204 * are stuffed into their own nvlist, which is then included in 205 * the properties nvlist with the pool properties. 206 */ 207#define ZPOOL_ROOTFS_PROPS "root-props-nvl" 208 209/* 210 * Dataset property functions shared between libzfs and kernel. 211 */ 212const char *zfs_prop_default_string(zfs_prop_t); 213uint64_t zfs_prop_default_numeric(zfs_prop_t); 214boolean_t zfs_prop_readonly(zfs_prop_t); 215boolean_t zfs_prop_inheritable(zfs_prop_t); 216boolean_t zfs_prop_setonce(zfs_prop_t); 217const char *zfs_prop_to_name(zfs_prop_t); 218zfs_prop_t zfs_name_to_prop(const char *); 219boolean_t zfs_prop_user(const char *); 220boolean_t zfs_prop_userquota(const char *); 221int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 222int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 223uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 224boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 225 226/* 227 * Pool property functions shared between libzfs and kernel. 228 */ 229zpool_prop_t zpool_name_to_prop(const char *); 230const char *zpool_prop_to_name(zpool_prop_t); 231const char *zpool_prop_default_string(zpool_prop_t); 232uint64_t zpool_prop_default_numeric(zpool_prop_t); 233boolean_t zpool_prop_readonly(zpool_prop_t); 234int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 235int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 236uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 237 238/* 239 * Definitions for the Delegation. 240 */ 241typedef enum { 242 ZFS_DELEG_WHO_UNKNOWN = 0, 243 ZFS_DELEG_USER = 'u', 244 ZFS_DELEG_USER_SETS = 'U', 245 ZFS_DELEG_GROUP = 'g', 246 ZFS_DELEG_GROUP_SETS = 'G', 247 ZFS_DELEG_EVERYONE = 'e', 248 ZFS_DELEG_EVERYONE_SETS = 'E', 249 ZFS_DELEG_CREATE = 'c', 250 ZFS_DELEG_CREATE_SETS = 'C', 251 ZFS_DELEG_NAMED_SET = 's', 252 ZFS_DELEG_NAMED_SET_SETS = 'S' 253} zfs_deleg_who_type_t; 254 255typedef enum { 256 ZFS_DELEG_NONE = 0, 257 ZFS_DELEG_PERM_LOCAL = 1, 258 ZFS_DELEG_PERM_DESCENDENT = 2, 259 ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 260 ZFS_DELEG_PERM_CREATE = 4 261} zfs_deleg_inherit_t; 262 263#define ZFS_DELEG_PERM_UID "uid" 264#define ZFS_DELEG_PERM_GID "gid" 265#define ZFS_DELEG_PERM_GROUPS "groups" 266 267#define ZFS_MLSLABEL_DEFAULT "none" 268 269#define ZFS_SMB_ACL_SRC "src" 270#define ZFS_SMB_ACL_TARGET "target" 271 272typedef enum { 273 ZFS_CANMOUNT_OFF = 0, 274 ZFS_CANMOUNT_ON = 1, 275 ZFS_CANMOUNT_NOAUTO = 2 276} zfs_canmount_type_t; 277 278typedef enum { 279 ZFS_LOGBIAS_LATENCY = 0, 280 ZFS_LOGBIAS_THROUGHPUT = 1 281} zfs_logbias_op_t; 282 283typedef enum zfs_share_op { 284 ZFS_SHARE_NFS = 0, 285 ZFS_UNSHARE_NFS = 1, 286 ZFS_SHARE_SMB = 2, 287 ZFS_UNSHARE_SMB = 3 288} zfs_share_op_t; 289 290typedef enum zfs_smb_acl_op { 291 ZFS_SMB_ACL_ADD, 292 ZFS_SMB_ACL_REMOVE, 293 ZFS_SMB_ACL_RENAME, 294 ZFS_SMB_ACL_PURGE 295} zfs_smb_acl_op_t; 296 297typedef enum zfs_cache_type { 298 ZFS_CACHE_NONE = 0, 299 ZFS_CACHE_METADATA = 1, 300 ZFS_CACHE_ALL = 2 301} zfs_cache_type_t; 302 303typedef enum { 304 ZFS_SYNC_STANDARD = 0, 305 ZFS_SYNC_ALWAYS = 1, 306 ZFS_SYNC_DISABLED = 2 307} zfs_sync_type_t; 308 309 310/* 311 * On-disk version number. 312 */ 313#define SPA_VERSION_1 1ULL 314#define SPA_VERSION_2 2ULL 315#define SPA_VERSION_3 3ULL 316#define SPA_VERSION_4 4ULL 317#define SPA_VERSION_5 5ULL 318#define SPA_VERSION_6 6ULL 319#define SPA_VERSION_7 7ULL 320#define SPA_VERSION_8 8ULL 321#define SPA_VERSION_9 9ULL 322#define SPA_VERSION_10 10ULL 323#define SPA_VERSION_11 11ULL 324#define SPA_VERSION_12 12ULL 325#define SPA_VERSION_13 13ULL 326#define SPA_VERSION_14 14ULL 327#define SPA_VERSION_15 15ULL 328#define SPA_VERSION_16 16ULL 329#define SPA_VERSION_17 17ULL 330#define SPA_VERSION_18 18ULL 331#define SPA_VERSION_19 19ULL 332#define SPA_VERSION_20 20ULL 333#define SPA_VERSION_21 21ULL 334#define SPA_VERSION_22 22ULL 335#define SPA_VERSION_23 23ULL 336#define SPA_VERSION_24 24ULL 337#define SPA_VERSION_25 25ULL 338#define SPA_VERSION_26 26ULL 339#define SPA_VERSION_27 27ULL 340#define SPA_VERSION_28 28ULL 341 342/* 343 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 344 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 345 * and do the appropriate changes. Also bump the version number in 346 * usr/src/grub/capability. 347 */ 348#define SPA_VERSION SPA_VERSION_28 349#define SPA_VERSION_STRING "28" 350 351/* 352 * Symbolic names for the changes that caused a SPA_VERSION switch. 353 * Used in the code when checking for presence or absence of a feature. 354 * Feel free to define multiple symbolic names for each version if there 355 * were multiple changes to on-disk structures during that version. 356 * 357 * NOTE: When checking the current SPA_VERSION in your code, be sure 358 * to use spa_version() since it reports the version of the 359 * last synced uberblock. Checking the in-flight version can 360 * be dangerous in some cases. 361 */ 362#define SPA_VERSION_INITIAL SPA_VERSION_1 363#define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 364#define SPA_VERSION_SPARES SPA_VERSION_3 365#define SPA_VERSION_RAIDZ2 SPA_VERSION_3 366#define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 367#define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 368#define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 369#define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 370#define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 371#define SPA_VERSION_BOOTFS SPA_VERSION_6 372#define SPA_VERSION_SLOGS SPA_VERSION_7 373#define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 374#define SPA_VERSION_FUID SPA_VERSION_9 375#define SPA_VERSION_REFRESERVATION SPA_VERSION_9 376#define SPA_VERSION_REFQUOTA SPA_VERSION_9 377#define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 378#define SPA_VERSION_L2CACHE SPA_VERSION_10 379#define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 380#define SPA_VERSION_ORIGIN SPA_VERSION_11 381#define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 382#define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 383#define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 384#define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 385#define SPA_VERSION_USERSPACE SPA_VERSION_15 386#define SPA_VERSION_STMF_PROP SPA_VERSION_16 387#define SPA_VERSION_RAIDZ3 SPA_VERSION_17 388#define SPA_VERSION_USERREFS SPA_VERSION_18 389#define SPA_VERSION_HOLES SPA_VERSION_19 390#define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 391#define SPA_VERSION_DEDUP SPA_VERSION_21 392#define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 393#define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 394#define SPA_VERSION_SA SPA_VERSION_24 395#define SPA_VERSION_SCAN SPA_VERSION_25 396#define SPA_VERSION_DIR_CLONES SPA_VERSION_26 397#define SPA_VERSION_DEADLISTS SPA_VERSION_26 398#define SPA_VERSION_FAST_SNAP SPA_VERSION_27 399#define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 400 401/* 402 * ZPL version - rev'd whenever an incompatible on-disk format change 403 * occurs. This is independent of SPA/DMU/ZAP versioning. You must 404 * also update the version_table[] and help message in zfs_prop.c. 405 * 406 * When changing, be sure to teach GRUB how to read the new format! 407 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 408 */ 409#define ZPL_VERSION_1 1ULL 410#define ZPL_VERSION_2 2ULL 411#define ZPL_VERSION_3 3ULL 412#define ZPL_VERSION_4 4ULL 413#define ZPL_VERSION_5 5ULL 414#define ZPL_VERSION ZPL_VERSION_5 415#define ZPL_VERSION_STRING "5" 416 417#define ZPL_VERSION_INITIAL ZPL_VERSION_1 418#define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 419#define ZPL_VERSION_FUID ZPL_VERSION_3 420#define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 421#define ZPL_VERSION_SYSATTR ZPL_VERSION_3 422#define ZPL_VERSION_USERSPACE ZPL_VERSION_4 423#define ZPL_VERSION_SA ZPL_VERSION_5 424 425/* Rewind request information */ 426#define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 427#define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 428#define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 429#define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 430#define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 431#define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 432#define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 433 434typedef struct zpool_rewind_policy { 435 uint32_t zrp_request; /* rewind behavior requested */ 436 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */ 437 uint64_t zrp_maxdata; /* max acceptable data errors */ 438 uint64_t zrp_txg; /* specific txg to load */ 439} zpool_rewind_policy_t; 440 441/* 442 * The following are configuration names used in the nvlist describing a pool's 443 * configuration. 444 */ 445#define ZPOOL_CONFIG_VERSION "version" 446#define ZPOOL_CONFIG_POOL_NAME "name" 447#define ZPOOL_CONFIG_POOL_STATE "state" 448#define ZPOOL_CONFIG_POOL_TXG "txg" 449#define ZPOOL_CONFIG_POOL_GUID "pool_guid" 450#define ZPOOL_CONFIG_CREATE_TXG "create_txg" 451#define ZPOOL_CONFIG_TOP_GUID "top_guid" 452#define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 453#define ZPOOL_CONFIG_TYPE "type" 454#define ZPOOL_CONFIG_CHILDREN "children" 455#define ZPOOL_CONFIG_ID "id" 456#define ZPOOL_CONFIG_GUID "guid" 457#define ZPOOL_CONFIG_PATH "path" 458#define ZPOOL_CONFIG_DEVID "devid" 459#define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 460#define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 461#define ZPOOL_CONFIG_ASHIFT "ashift" 462#define ZPOOL_CONFIG_ASIZE "asize" 463#define ZPOOL_CONFIG_DTL "DTL" 464#define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 465#define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 466#define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 467#define ZPOOL_CONFIG_ERRCOUNT "error_count" 468#define ZPOOL_CONFIG_NOT_PRESENT "not_present" 469#define ZPOOL_CONFIG_SPARES "spares" 470#define ZPOOL_CONFIG_IS_SPARE "is_spare" 471#define ZPOOL_CONFIG_NPARITY "nparity" 472#define ZPOOL_CONFIG_HOSTID "hostid" 473#define ZPOOL_CONFIG_HOSTNAME "hostname" 474#define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 475#define ZPOOL_CONFIG_UNSPARE "unspare" 476#define ZPOOL_CONFIG_PHYS_PATH "phys_path" 477#define ZPOOL_CONFIG_IS_LOG "is_log" 478#define ZPOOL_CONFIG_L2CACHE "l2cache" 479#define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 480#define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 481#define ZPOOL_CONFIG_IS_HOLE "is_hole" 482#define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 483#define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 484#define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 485#define ZPOOL_CONFIG_SPLIT "splitcfg" 486#define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 487#define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 488#define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 489#define ZPOOL_CONFIG_REMOVING "removing" 490#define ZPOOL_CONFIG_RESILVERING "resilvering" 491#define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 492#define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 493#define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 494#define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 495#define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 496/* 497 * The persistent vdev state is stored as separate values rather than a single 498 * 'vdev_state' entry. This is because a device can be in multiple states, such 499 * as offline and degraded. 500 */ 501#define ZPOOL_CONFIG_OFFLINE "offline" 502#define ZPOOL_CONFIG_FAULTED "faulted" 503#define ZPOOL_CONFIG_DEGRADED "degraded" 504#define ZPOOL_CONFIG_REMOVED "removed" 505#define ZPOOL_CONFIG_FRU "fru" 506#define ZPOOL_CONFIG_AUX_STATE "aux_state" 507 508/* Rewind policy parameters */ 509#define ZPOOL_REWIND_POLICY "rewind-policy" 510#define ZPOOL_REWIND_REQUEST "rewind-request" 511#define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg" 512#define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh" 513#define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh" 514 515/* Rewind data discovered */ 516#define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 517#define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 518#define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 519 520#define VDEV_TYPE_ROOT "root" 521#define VDEV_TYPE_MIRROR "mirror" 522#define VDEV_TYPE_REPLACING "replacing" 523#define VDEV_TYPE_RAIDZ "raidz" 524#define VDEV_TYPE_DISK "disk" 525#define VDEV_TYPE_FILE "file" 526#define VDEV_TYPE_MISSING "missing" 527#define VDEV_TYPE_HOLE "hole" 528#define VDEV_TYPE_SPARE "spare" 529#define VDEV_TYPE_LOG "log" 530#define VDEV_TYPE_L2CACHE "l2cache" 531 532/* 533 * This is needed in userland to report the minimum necessary device size. 534 */ 535#define SPA_MINDEVSIZE (64ULL << 20) 536 537/* 538 * The location of the pool configuration repository, shared between kernel and 539 * userland. 540 */ 541#define ZPOOL_CACHE "/etc/zfs/zpool.cache" 542 543/* 544 * vdev states are ordered from least to most healthy. 545 * A vdev that's CANT_OPEN or below is considered unusable. 546 */ 547typedef enum vdev_state { 548 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 549 VDEV_STATE_CLOSED, /* Not currently open */ 550 VDEV_STATE_OFFLINE, /* Not allowed to open */ 551 VDEV_STATE_REMOVED, /* Explicitly removed from system */ 552 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 553 VDEV_STATE_FAULTED, /* External request to fault device */ 554 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 555 VDEV_STATE_HEALTHY /* Presumed good */ 556} vdev_state_t; 557 558#define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 559 560/* 561 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 562 * of the vdev stats structure uses these constants to distinguish why. 563 */ 564typedef enum vdev_aux { 565 VDEV_AUX_NONE, /* no error */ 566 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 567 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 568 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 569 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 570 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 571 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 572 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 573 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 574 VDEV_AUX_SPARED, /* hot spare used in another pool */ 575 VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 576 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 577 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 578 VDEV_AUX_EXTERNAL, /* external diagnosis */ 579 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */ 580} vdev_aux_t; 581 582/* 583 * pool state. The following states are written to disk as part of the normal 584 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 585 * states are software abstractions used at various levels to communicate 586 * pool state. 587 */ 588typedef enum pool_state { 589 POOL_STATE_ACTIVE = 0, /* In active use */ 590 POOL_STATE_EXPORTED, /* Explicitly exported */ 591 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 592 POOL_STATE_SPARE, /* Reserved for hot spare use */ 593 POOL_STATE_L2CACHE, /* Level 2 ARC device */ 594 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 595 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 596 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 597} pool_state_t; 598 599/* 600 * Scan Functions. 601 */ 602typedef enum pool_scan_func { 603 POOL_SCAN_NONE, 604 POOL_SCAN_SCRUB, 605 POOL_SCAN_RESILVER, 606 POOL_SCAN_FUNCS 607} pool_scan_func_t; 608 609/* 610 * ZIO types. Needed to interpret vdev statistics below. 611 */ 612typedef enum zio_type { 613 ZIO_TYPE_NULL = 0, 614 ZIO_TYPE_READ, 615 ZIO_TYPE_WRITE, 616 ZIO_TYPE_FREE, 617 ZIO_TYPE_CLAIM, 618 ZIO_TYPE_IOCTL, 619 ZIO_TYPES 620} zio_type_t; 621 622/* 623 * Pool statistics. Note: all fields should be 64-bit because this 624 * is passed between kernel and userland as an nvlist uint64 array. 625 */ 626typedef struct pool_scan_stat { 627 /* values stored on disk */ 628 uint64_t pss_func; /* pool_scan_func_t */ 629 uint64_t pss_state; /* dsl_scan_state_t */ 630 uint64_t pss_start_time; /* scan start time */ 631 uint64_t pss_end_time; /* scan end time */ 632 uint64_t pss_to_examine; /* total bytes to scan */ 633 uint64_t pss_examined; /* total examined bytes */ 634 uint64_t pss_to_process; /* total bytes to process */ 635 uint64_t pss_processed; /* total processed bytes */ 636 uint64_t pss_errors; /* scan errors */ 637 638 /* values not stored on disk */ 639 uint64_t pss_pass_exam; /* examined bytes per scan pass */ 640 uint64_t pss_pass_start; /* start time of a scan pass */ 641} pool_scan_stat_t; 642 643typedef enum dsl_scan_state { 644 DSS_NONE, 645 DSS_SCANNING, 646 DSS_FINISHED, 647 DSS_CANCELED, 648 DSS_NUM_STATES 649} dsl_scan_state_t; 650 651 652/* 653 * Vdev statistics. Note: all fields should be 64-bit because this 654 * is passed between kernel and userland as an nvlist uint64 array. 655 */ 656typedef struct vdev_stat { 657 hrtime_t vs_timestamp; /* time since vdev load */ 658 uint64_t vs_state; /* vdev state */ 659 uint64_t vs_aux; /* see vdev_aux_t */ 660 uint64_t vs_alloc; /* space allocated */ 661 uint64_t vs_space; /* total capacity */ 662 uint64_t vs_dspace; /* deflated capacity */ 663 uint64_t vs_rsize; /* replaceable dev size */ 664 uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 665 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 666 uint64_t vs_read_errors; /* read errors */ 667 uint64_t vs_write_errors; /* write errors */ 668 uint64_t vs_checksum_errors; /* checksum errors */ 669 uint64_t vs_self_healed; /* self-healed bytes */ 670 uint64_t vs_scan_removing; /* removing? */ 671 uint64_t vs_scan_processed; /* scan processed bytes */ 672} vdev_stat_t; 673 674/* 675 * DDT statistics. Note: all fields should be 64-bit because this 676 * is passed between kernel and userland as an nvlist uint64 array. 677 */ 678typedef struct ddt_object { 679 uint64_t ddo_count; /* number of elments in ddt */ 680 uint64_t ddo_dspace; /* size of ddt on disk */ 681 uint64_t ddo_mspace; /* size of ddt in-core */ 682} ddt_object_t; 683 684typedef struct ddt_stat { 685 uint64_t dds_blocks; /* blocks */ 686 uint64_t dds_lsize; /* logical size */ 687 uint64_t dds_psize; /* physical size */ 688 uint64_t dds_dsize; /* deflated allocated size */ 689 uint64_t dds_ref_blocks; /* referenced blocks */ 690 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 691 uint64_t dds_ref_psize; /* referenced psize * refcnt */ 692 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 693} ddt_stat_t; 694 695typedef struct ddt_histogram { 696 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 697} ddt_histogram_t; 698 699#define ZVOL_DRIVER "zvol" 700#define ZFS_DRIVER "zfs" 701#define ZFS_DEV "/dev/zfs" 702 703/* general zvol path */ 704#define ZVOL_DIR "/dev/zvol" 705/* expansion */ 706#define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 707/* for dump and swap */ 708#define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 709#define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 710 711#define ZVOL_PROP_NAME "name" 712#define ZVOL_DEFAULT_BLOCKSIZE 8192 713 714/* 715 * /dev/zfs ioctl numbers. 716 */ 717#define ZFS_IOC ('Z' << 8) 718 719typedef enum zfs_ioc { 720 ZFS_IOC_POOL_CREATE = ZFS_IOC, 721 ZFS_IOC_POOL_DESTROY, 722 ZFS_IOC_POOL_IMPORT, 723 ZFS_IOC_POOL_EXPORT, 724 ZFS_IOC_POOL_CONFIGS, 725 ZFS_IOC_POOL_STATS, 726 ZFS_IOC_POOL_TRYIMPORT, 727 ZFS_IOC_POOL_SCAN, 728 ZFS_IOC_POOL_FREEZE, 729 ZFS_IOC_POOL_UPGRADE, 730 ZFS_IOC_POOL_GET_HISTORY, 731 ZFS_IOC_VDEV_ADD, 732 ZFS_IOC_VDEV_REMOVE, 733 ZFS_IOC_VDEV_SET_STATE, 734 ZFS_IOC_VDEV_ATTACH, 735 ZFS_IOC_VDEV_DETACH, 736 ZFS_IOC_VDEV_SETPATH, 737 ZFS_IOC_VDEV_SETFRU, 738 ZFS_IOC_OBJSET_STATS, 739 ZFS_IOC_OBJSET_ZPLPROPS, 740 ZFS_IOC_DATASET_LIST_NEXT, 741 ZFS_IOC_SNAPSHOT_LIST_NEXT, 742 ZFS_IOC_SET_PROP, 743 ZFS_IOC_CREATE, 744 ZFS_IOC_DESTROY, 745 ZFS_IOC_ROLLBACK, 746 ZFS_IOC_RENAME, 747 ZFS_IOC_RECV, 748 ZFS_IOC_SEND, 749 ZFS_IOC_INJECT_FAULT, 750 ZFS_IOC_CLEAR_FAULT, 751 ZFS_IOC_INJECT_LIST_NEXT, 752 ZFS_IOC_ERROR_LOG, 753 ZFS_IOC_CLEAR, 754 ZFS_IOC_PROMOTE, 755 ZFS_IOC_DESTROY_SNAPS, 756 ZFS_IOC_SNAPSHOT, 757 ZFS_IOC_DSOBJ_TO_DSNAME, 758 ZFS_IOC_OBJ_TO_PATH, 759 ZFS_IOC_POOL_SET_PROPS, 760 ZFS_IOC_POOL_GET_PROPS, 761 ZFS_IOC_SET_FSACL, 762 ZFS_IOC_GET_FSACL, 763 ZFS_IOC_SHARE, 764 ZFS_IOC_INHERIT_PROP, 765 ZFS_IOC_SMB_ACL, 766 ZFS_IOC_USERSPACE_ONE, 767 ZFS_IOC_USERSPACE_MANY, 768 ZFS_IOC_USERSPACE_UPGRADE, 769 ZFS_IOC_HOLD, 770 ZFS_IOC_RELEASE, 771 ZFS_IOC_GET_HOLDS, 772 ZFS_IOC_OBJSET_RECVD_PROPS, 773 ZFS_IOC_VDEV_SPLIT, 774 ZFS_IOC_NEXT_OBJ, 775 ZFS_IOC_DIFF, 776 ZFS_IOC_TMP_SNAPSHOT, 777 ZFS_IOC_OBJ_TO_STATS 778} zfs_ioc_t; 779 780/* 781 * Internal SPA load state. Used by FMA diagnosis engine. 782 */ 783typedef enum { 784 SPA_LOAD_NONE, /* no load in progress */ 785 SPA_LOAD_OPEN, /* normal open */ 786 SPA_LOAD_IMPORT, /* import in progress */ 787 SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 788 SPA_LOAD_RECOVER, /* recovery requested */ 789 SPA_LOAD_ERROR /* load failed */ 790} spa_load_state_t; 791 792/* 793 * Bookmark name values. 794 */ 795#define ZPOOL_ERR_LIST "error list" 796#define ZPOOL_ERR_DATASET "dataset" 797#define ZPOOL_ERR_OBJECT "object" 798 799#define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 800 801/* 802 * The following are names used in the nvlist describing 803 * the pool's history log. 804 */ 805#define ZPOOL_HIST_RECORD "history record" 806#define ZPOOL_HIST_TIME "history time" 807#define ZPOOL_HIST_CMD "history command" 808#define ZPOOL_HIST_WHO "history who" 809#define ZPOOL_HIST_ZONE "history zone" 810#define ZPOOL_HIST_HOST "history hostname" 811#define ZPOOL_HIST_TXG "history txg" 812#define ZPOOL_HIST_INT_EVENT "history internal event" 813#define ZPOOL_HIST_INT_STR "history internal str" 814 815/* 816 * Flags for ZFS_IOC_VDEV_SET_STATE 817 */ 818#define ZFS_ONLINE_CHECKREMOVE 0x1 819#define ZFS_ONLINE_UNSPARE 0x2 820#define ZFS_ONLINE_FORCEFAULT 0x4 821#define ZFS_ONLINE_EXPAND 0x8 822#define ZFS_OFFLINE_TEMPORARY 0x1 823 824/* 825 * Flags for ZFS_IOC_POOL_IMPORT 826 */ 827#define ZFS_IMPORT_NORMAL 0x0 828#define ZFS_IMPORT_VERBATIM 0x1 829#define ZFS_IMPORT_ANY_HOST 0x2 830#define ZFS_IMPORT_MISSING_LOG 0x4 831#define ZFS_IMPORT_ONLY 0x8 832 833/* 834 * Sysevent payload members. ZFS will generate the following sysevents with the 835 * given payloads: 836 * 837 * ESC_ZFS_RESILVER_START 838 * ESC_ZFS_RESILVER_END 839 * ESC_ZFS_POOL_DESTROY 840 * 841 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 842 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 843 * 844 * ESC_ZFS_VDEV_REMOVE 845 * ESC_ZFS_VDEV_CLEAR 846 * ESC_ZFS_VDEV_CHECK 847 * 848 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 849 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 850 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 851 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 852 */ 853#define ZFS_EV_POOL_NAME "pool_name" 854#define ZFS_EV_POOL_GUID "pool_guid" 855#define ZFS_EV_VDEV_PATH "vdev_path" 856#define ZFS_EV_VDEV_GUID "vdev_guid" 857 858/* 859 * Note: This is encoded on-disk, so new events must be added to the 860 * end, and unused events can not be removed. Be sure to edit 861 * libzfs_pool.c: hist_event_table[]. 862 */ 863typedef enum history_internal_events { 864 LOG_NO_EVENT = 0, 865 LOG_POOL_CREATE, 866 LOG_POOL_VDEV_ADD, 867 LOG_POOL_REMOVE, 868 LOG_POOL_DESTROY, 869 LOG_POOL_EXPORT, 870 LOG_POOL_IMPORT, 871 LOG_POOL_VDEV_ATTACH, 872 LOG_POOL_VDEV_REPLACE, 873 LOG_POOL_VDEV_DETACH, 874 LOG_POOL_VDEV_ONLINE, 875 LOG_POOL_VDEV_OFFLINE, 876 LOG_POOL_UPGRADE, 877 LOG_POOL_CLEAR, 878 LOG_POOL_SCAN, 879 LOG_POOL_PROPSET, 880 LOG_DS_CREATE, 881 LOG_DS_CLONE, 882 LOG_DS_DESTROY, 883 LOG_DS_DESTROY_BEGIN, 884 LOG_DS_INHERIT, 885 LOG_DS_PROPSET, 886 LOG_DS_QUOTA, 887 LOG_DS_PERM_UPDATE, 888 LOG_DS_PERM_REMOVE, 889 LOG_DS_PERM_WHO_REMOVE, 890 LOG_DS_PROMOTE, 891 LOG_DS_RECEIVE, 892 LOG_DS_RENAME, 893 LOG_DS_RESERVATION, 894 LOG_DS_REPLAY_INC_SYNC, 895 LOG_DS_REPLAY_FULL_SYNC, 896 LOG_DS_ROLLBACK, 897 LOG_DS_SNAPSHOT, 898 LOG_DS_UPGRADE, 899 LOG_DS_REFQUOTA, 900 LOG_DS_REFRESERV, 901 LOG_POOL_SCAN_DONE, 902 LOG_DS_USER_HOLD, 903 LOG_DS_USER_RELEASE, 904 LOG_POOL_SPLIT, 905 LOG_END 906} history_internal_events_t; 907 908#ifdef __cplusplus 909} 910#endif 911 912#endif /* _SYS_FS_ZFS_H */ 913