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