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