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 #define SPA_VERSION_25 25ULL 337 #define SPA_VERSION_26 26ULL 338 #define SPA_VERSION_27 27ULL 339 /* 340 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 341 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 342 * and do the appropriate changes. Also bump the version number in 343 * usr/src/grub/capability. 344 */ 345 #define SPA_VERSION SPA_VERSION_27 346 #define SPA_VERSION_STRING "27" 347 348 /* 349 * Symbolic names for the changes that caused a SPA_VERSION switch. 350 * Used in the code when checking for presence or absence of a feature. 351 * Feel free to define multiple symbolic names for each version if there 352 * were multiple changes to on-disk structures during that version. 353 * 354 * NOTE: When checking the current SPA_VERSION in your code, be sure 355 * to use spa_version() since it reports the version of the 356 * last synced uberblock. Checking the in-flight version can 357 * be dangerous in some cases. 358 */ 359 #define SPA_VERSION_INITIAL SPA_VERSION_1 360 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 361 #define SPA_VERSION_SPARES SPA_VERSION_3 362 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 363 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 364 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 365 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 366 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 367 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 368 #define SPA_VERSION_BOOTFS SPA_VERSION_6 369 #define SPA_VERSION_SLOGS SPA_VERSION_7 370 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 371 #define SPA_VERSION_FUID SPA_VERSION_9 372 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 373 #define SPA_VERSION_REFQUOTA SPA_VERSION_9 374 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 375 #define SPA_VERSION_L2CACHE SPA_VERSION_10 376 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 377 #define SPA_VERSION_ORIGIN SPA_VERSION_11 378 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 379 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 380 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 381 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 382 #define SPA_VERSION_USERSPACE SPA_VERSION_15 383 #define SPA_VERSION_STMF_PROP SPA_VERSION_16 384 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 385 #define SPA_VERSION_USERREFS SPA_VERSION_18 386 #define SPA_VERSION_HOLES SPA_VERSION_19 387 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 388 #define SPA_VERSION_DEDUP SPA_VERSION_21 389 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 390 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 391 #define SPA_VERSION_SA SPA_VERSION_24 392 #define SPA_VERSION_SCAN SPA_VERSION_25 393 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 394 #define SPA_VERSION_DEADLISTS SPA_VERSION_26 395 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 396 397 /* 398 * ZPL version - rev'd whenever an incompatible on-disk format change 399 * occurs. This is independent of SPA/DMU/ZAP versioning. You must 400 * also update the version_table[] and help message in zfs_prop.c. 401 * 402 * When changing, be sure to teach GRUB how to read the new format! 403 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 404 */ 405 #define ZPL_VERSION_1 1ULL 406 #define ZPL_VERSION_2 2ULL 407 #define ZPL_VERSION_3 3ULL 408 #define ZPL_VERSION_4 4ULL 409 #define ZPL_VERSION_5 5ULL 410 #define ZPL_VERSION ZPL_VERSION_5 411 #define ZPL_VERSION_STRING "5" 412 413 #define ZPL_VERSION_INITIAL ZPL_VERSION_1 414 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 415 #define ZPL_VERSION_FUID ZPL_VERSION_3 416 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 417 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 418 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 419 #define ZPL_VERSION_SA ZPL_VERSION_5 420 421 /* Rewind request information */ 422 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 423 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 424 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 425 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 426 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 427 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 428 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 429 430 typedef struct zpool_rewind_policy { 431 uint32_t zrp_request; /* rewind behavior requested */ 432 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */ 433 uint64_t zrp_maxdata; /* max acceptable data errors */ 434 uint64_t zrp_txg; /* specific txg to load */ 435 } zpool_rewind_policy_t; 436 437 /* 438 * The following are configuration names used in the nvlist describing a pool's 439 * configuration. 440 */ 441 #define ZPOOL_CONFIG_VERSION "version" 442 #define ZPOOL_CONFIG_POOL_NAME "name" 443 #define ZPOOL_CONFIG_POOL_STATE "state" 444 #define ZPOOL_CONFIG_POOL_TXG "txg" 445 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 446 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 447 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 448 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 449 #define ZPOOL_CONFIG_TYPE "type" 450 #define ZPOOL_CONFIG_CHILDREN "children" 451 #define ZPOOL_CONFIG_ID "id" 452 #define ZPOOL_CONFIG_GUID "guid" 453 #define ZPOOL_CONFIG_PATH "path" 454 #define ZPOOL_CONFIG_DEVID "devid" 455 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 456 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 457 #define ZPOOL_CONFIG_ASHIFT "ashift" 458 #define ZPOOL_CONFIG_ASIZE "asize" 459 #define ZPOOL_CONFIG_DTL "DTL" 460 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 461 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 462 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 463 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 464 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 465 #define ZPOOL_CONFIG_SPARES "spares" 466 #define ZPOOL_CONFIG_IS_SPARE "is_spare" 467 #define ZPOOL_CONFIG_NPARITY "nparity" 468 #define ZPOOL_CONFIG_HOSTID "hostid" 469 #define ZPOOL_CONFIG_HOSTNAME "hostname" 470 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 471 #define ZPOOL_CONFIG_UNSPARE "unspare" 472 #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 473 #define ZPOOL_CONFIG_IS_LOG "is_log" 474 #define ZPOOL_CONFIG_L2CACHE "l2cache" 475 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 476 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 477 #define ZPOOL_CONFIG_IS_HOLE "is_hole" 478 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 479 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 480 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 481 #define ZPOOL_CONFIG_SPLIT "splitcfg" 482 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 483 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 484 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 485 #define ZPOOL_CONFIG_REMOVING "removing" 486 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 487 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 488 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 489 /* 490 * The persistent vdev state is stored as separate values rather than a single 491 * 'vdev_state' entry. This is because a device can be in multiple states, such 492 * as offline and degraded. 493 */ 494 #define ZPOOL_CONFIG_OFFLINE "offline" 495 #define ZPOOL_CONFIG_FAULTED "faulted" 496 #define ZPOOL_CONFIG_DEGRADED "degraded" 497 #define ZPOOL_CONFIG_REMOVED "removed" 498 #define ZPOOL_CONFIG_FRU "fru" 499 #define ZPOOL_CONFIG_AUX_STATE "aux_state" 500 501 /* Rewind policy parameters */ 502 #define ZPOOL_REWIND_POLICY "rewind-policy" 503 #define ZPOOL_REWIND_REQUEST "rewind-request" 504 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg" 505 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh" 506 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh" 507 508 /* Rewind data discovered */ 509 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 510 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 511 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 512 513 #define VDEV_TYPE_ROOT "root" 514 #define VDEV_TYPE_MIRROR "mirror" 515 #define VDEV_TYPE_REPLACING "replacing" 516 #define VDEV_TYPE_RAIDZ "raidz" 517 #define VDEV_TYPE_DISK "disk" 518 #define VDEV_TYPE_FILE "file" 519 #define VDEV_TYPE_MISSING "missing" 520 #define VDEV_TYPE_HOLE "hole" 521 #define VDEV_TYPE_SPARE "spare" 522 #define VDEV_TYPE_LOG "log" 523 #define VDEV_TYPE_L2CACHE "l2cache" 524 525 /* 526 * This is needed in userland to report the minimum necessary device size. 527 */ 528 #define SPA_MINDEVSIZE (64ULL << 20) 529 530 /* 531 * The location of the pool configuration repository, shared between kernel and 532 * userland. 533 */ 534 #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 535 536 /* 537 * vdev states are ordered from least to most healthy. 538 * A vdev that's CANT_OPEN or below is considered unusable. 539 */ 540 typedef enum vdev_state { 541 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 542 VDEV_STATE_CLOSED, /* Not currently open */ 543 VDEV_STATE_OFFLINE, /* Not allowed to open */ 544 VDEV_STATE_REMOVED, /* Explicitly removed from system */ 545 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 546 VDEV_STATE_FAULTED, /* External request to fault device */ 547 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 548 VDEV_STATE_HEALTHY /* Presumed good */ 549 } vdev_state_t; 550 551 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 552 553 /* 554 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 555 * of the vdev stats structure uses these constants to distinguish why. 556 */ 557 typedef enum vdev_aux { 558 VDEV_AUX_NONE, /* no error */ 559 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 560 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 561 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 562 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 563 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 564 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 565 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 566 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 567 VDEV_AUX_SPARED, /* hot spare used in another pool */ 568 VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 569 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 570 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 571 VDEV_AUX_EXTERNAL, /* external diagnosis */ 572 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */ 573 } vdev_aux_t; 574 575 /* 576 * pool state. The following states are written to disk as part of the normal 577 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 578 * states are software abstractions used at various levels to communicate 579 * pool state. 580 */ 581 typedef enum pool_state { 582 POOL_STATE_ACTIVE = 0, /* In active use */ 583 POOL_STATE_EXPORTED, /* Explicitly exported */ 584 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 585 POOL_STATE_SPARE, /* Reserved for hot spare use */ 586 POOL_STATE_L2CACHE, /* Level 2 ARC device */ 587 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 588 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 589 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 590 } pool_state_t; 591 592 /* 593 * Scan Functions. 594 */ 595 typedef enum pool_scan_func { 596 POOL_SCAN_NONE, 597 POOL_SCAN_SCRUB, 598 POOL_SCAN_RESILVER, 599 POOL_SCAN_FUNCS 600 } pool_scan_func_t; 601 602 /* 603 * ZIO types. Needed to interpret vdev statistics below. 604 */ 605 typedef enum zio_type { 606 ZIO_TYPE_NULL = 0, 607 ZIO_TYPE_READ, 608 ZIO_TYPE_WRITE, 609 ZIO_TYPE_FREE, 610 ZIO_TYPE_CLAIM, 611 ZIO_TYPE_IOCTL, 612 ZIO_TYPES 613 } zio_type_t; 614 615 /* 616 * Pool statistics. Note: all fields should be 64-bit because this 617 * is passed between kernel and userland as an nvlist uint64 array. 618 */ 619 typedef struct pool_scan_stat { 620 /* values stored on disk */ 621 uint64_t pss_func; /* pool_scan_func_t */ 622 uint64_t pss_state; /* dsl_scan_state_t */ 623 uint64_t pss_start_time; /* scan start time */ 624 uint64_t pss_end_time; /* scan end time */ 625 uint64_t pss_to_examine; /* total bytes to scan */ 626 uint64_t pss_examined; /* total examined bytes */ 627 uint64_t pss_to_process; /* total bytes to process */ 628 uint64_t pss_processed; /* total processed bytes */ 629 uint64_t pss_errors; /* scan errors */ 630 631 /* values not stored on disk */ 632 uint64_t pss_pass_exam; /* examined bytes per scan pass */ 633 uint64_t pss_pass_start; /* start time of a scan pass */ 634 } pool_scan_stat_t; 635 636 typedef enum dsl_scan_state { 637 DSS_NONE, 638 DSS_SCANNING, 639 DSS_FINISHED, 640 DSS_CANCELED, 641 DSS_NUM_STATES 642 } dsl_scan_state_t; 643 644 645 /* 646 * Vdev statistics. Note: all fields should be 64-bit because this 647 * is passed between kernel and userland as an nvlist uint64 array. 648 */ 649 typedef struct vdev_stat { 650 hrtime_t vs_timestamp; /* time since vdev load */ 651 uint64_t vs_state; /* vdev state */ 652 uint64_t vs_aux; /* see vdev_aux_t */ 653 uint64_t vs_alloc; /* space allocated */ 654 uint64_t vs_space; /* total capacity */ 655 uint64_t vs_dspace; /* deflated capacity */ 656 uint64_t vs_rsize; /* replaceable dev size */ 657 uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 658 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 659 uint64_t vs_read_errors; /* read errors */ 660 uint64_t vs_write_errors; /* write errors */ 661 uint64_t vs_checksum_errors; /* checksum errors */ 662 uint64_t vs_self_healed; /* self-healed bytes */ 663 uint64_t vs_scan_removing; /* removing? */ 664 uint64_t vs_scan_processed; /* scan processed bytes */ 665 } vdev_stat_t; 666 667 /* 668 * DDT statistics. Note: all fields should be 64-bit because this 669 * is passed between kernel and userland as an nvlist uint64 array. 670 */ 671 typedef struct ddt_object { 672 uint64_t ddo_count; /* number of elments in ddt */ 673 uint64_t ddo_dspace; /* size of ddt on disk */ 674 uint64_t ddo_mspace; /* size of ddt in-core */ 675 } ddt_object_t; 676 677 typedef struct ddt_stat { 678 uint64_t dds_blocks; /* blocks */ 679 uint64_t dds_lsize; /* logical size */ 680 uint64_t dds_psize; /* physical size */ 681 uint64_t dds_dsize; /* deflated allocated size */ 682 uint64_t dds_ref_blocks; /* referenced blocks */ 683 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 684 uint64_t dds_ref_psize; /* referenced psize * refcnt */ 685 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 686 } ddt_stat_t; 687 688 typedef struct ddt_histogram { 689 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 690 } ddt_histogram_t; 691 692 #define ZVOL_DRIVER "zvol" 693 #define ZFS_DRIVER "zfs" 694 #define ZFS_DEV "/dev/zfs" 695 696 /* general zvol path */ 697 #define ZVOL_DIR "/dev/zvol" 698 /* expansion */ 699 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 700 /* for dump and swap */ 701 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 702 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 703 704 #define ZVOL_PROP_NAME "name" 705 #define ZVOL_DEFAULT_BLOCKSIZE 8192 706 707 /* 708 * /dev/zfs ioctl numbers. 709 */ 710 #define ZFS_IOC ('Z' << 8) 711 712 typedef enum zfs_ioc { 713 ZFS_IOC_POOL_CREATE = ZFS_IOC, 714 ZFS_IOC_POOL_DESTROY, 715 ZFS_IOC_POOL_IMPORT, 716 ZFS_IOC_POOL_EXPORT, 717 ZFS_IOC_POOL_CONFIGS, 718 ZFS_IOC_POOL_STATS, 719 ZFS_IOC_POOL_TRYIMPORT, 720 ZFS_IOC_POOL_SCAN, 721 ZFS_IOC_POOL_FREEZE, 722 ZFS_IOC_POOL_UPGRADE, 723 ZFS_IOC_POOL_GET_HISTORY, 724 ZFS_IOC_VDEV_ADD, 725 ZFS_IOC_VDEV_REMOVE, 726 ZFS_IOC_VDEV_SET_STATE, 727 ZFS_IOC_VDEV_ATTACH, 728 ZFS_IOC_VDEV_DETACH, 729 ZFS_IOC_VDEV_SETPATH, 730 ZFS_IOC_VDEV_SETFRU, 731 ZFS_IOC_OBJSET_STATS, 732 ZFS_IOC_OBJSET_ZPLPROPS, 733 ZFS_IOC_DATASET_LIST_NEXT, 734 ZFS_IOC_SNAPSHOT_LIST_NEXT, 735 ZFS_IOC_SET_PROP, 736 ZFS_IOC_CREATE, 737 ZFS_IOC_DESTROY, 738 ZFS_IOC_ROLLBACK, 739 ZFS_IOC_RENAME, 740 ZFS_IOC_RECV, 741 ZFS_IOC_SEND, 742 ZFS_IOC_INJECT_FAULT, 743 ZFS_IOC_CLEAR_FAULT, 744 ZFS_IOC_INJECT_LIST_NEXT, 745 ZFS_IOC_ERROR_LOG, 746 ZFS_IOC_CLEAR, 747 ZFS_IOC_PROMOTE, 748 ZFS_IOC_DESTROY_SNAPS, 749 ZFS_IOC_SNAPSHOT, 750 ZFS_IOC_DSOBJ_TO_DSNAME, 751 ZFS_IOC_OBJ_TO_PATH, 752 ZFS_IOC_POOL_SET_PROPS, 753 ZFS_IOC_POOL_GET_PROPS, 754 ZFS_IOC_SET_FSACL, 755 ZFS_IOC_GET_FSACL, 756 ZFS_IOC_SHARE, 757 ZFS_IOC_INHERIT_PROP, 758 ZFS_IOC_SMB_ACL, 759 ZFS_IOC_USERSPACE_ONE, 760 ZFS_IOC_USERSPACE_MANY, 761 ZFS_IOC_USERSPACE_UPGRADE, 762 ZFS_IOC_HOLD, 763 ZFS_IOC_RELEASE, 764 ZFS_IOC_GET_HOLDS, 765 ZFS_IOC_OBJSET_RECVD_PROPS, 766 ZFS_IOC_VDEV_SPLIT 767 } zfs_ioc_t; 768 769 /* 770 * Internal SPA load state. Used by FMA diagnosis engine. 771 */ 772 typedef enum { 773 SPA_LOAD_NONE, /* no load in progress */ 774 SPA_LOAD_OPEN, /* normal open */ 775 SPA_LOAD_IMPORT, /* import in progress */ 776 SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 777 SPA_LOAD_RECOVER, /* recovery requested */ 778 SPA_LOAD_ERROR /* load failed */ 779 } spa_load_state_t; 780 781 /* 782 * Bookmark name values. 783 */ 784 #define ZPOOL_ERR_LIST "error list" 785 #define ZPOOL_ERR_DATASET "dataset" 786 #define ZPOOL_ERR_OBJECT "object" 787 788 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 789 790 /* 791 * The following are names used in the nvlist describing 792 * the pool's history log. 793 */ 794 #define ZPOOL_HIST_RECORD "history record" 795 #define ZPOOL_HIST_TIME "history time" 796 #define ZPOOL_HIST_CMD "history command" 797 #define ZPOOL_HIST_WHO "history who" 798 #define ZPOOL_HIST_ZONE "history zone" 799 #define ZPOOL_HIST_HOST "history hostname" 800 #define ZPOOL_HIST_TXG "history txg" 801 #define ZPOOL_HIST_INT_EVENT "history internal event" 802 #define ZPOOL_HIST_INT_STR "history internal str" 803 804 /* 805 * Flags for ZFS_IOC_VDEV_SET_STATE 806 */ 807 #define ZFS_ONLINE_CHECKREMOVE 0x1 808 #define ZFS_ONLINE_UNSPARE 0x2 809 #define ZFS_ONLINE_FORCEFAULT 0x4 810 #define ZFS_ONLINE_EXPAND 0x8 811 #define ZFS_OFFLINE_TEMPORARY 0x1 812 813 /* 814 * Sysevent payload members. ZFS will generate the following sysevents with the 815 * given payloads: 816 * 817 * ESC_ZFS_RESILVER_START 818 * ESC_ZFS_RESILVER_END 819 * ESC_ZFS_POOL_DESTROY 820 * 821 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 822 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 823 * 824 * ESC_ZFS_VDEV_REMOVE 825 * ESC_ZFS_VDEV_CLEAR 826 * ESC_ZFS_VDEV_CHECK 827 * 828 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 829 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 830 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 831 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 832 */ 833 #define ZFS_EV_POOL_NAME "pool_name" 834 #define ZFS_EV_POOL_GUID "pool_guid" 835 #define ZFS_EV_VDEV_PATH "vdev_path" 836 #define ZFS_EV_VDEV_GUID "vdev_guid" 837 838 /* 839 * Note: This is encoded on-disk, so new events must be added to the 840 * end, and unused events can not be removed. Be sure to edit 841 * libzfs_pool.c: hist_event_table[]. 842 */ 843 typedef enum history_internal_events { 844 LOG_NO_EVENT = 0, 845 LOG_POOL_CREATE, 846 LOG_POOL_VDEV_ADD, 847 LOG_POOL_REMOVE, 848 LOG_POOL_DESTROY, 849 LOG_POOL_EXPORT, 850 LOG_POOL_IMPORT, 851 LOG_POOL_VDEV_ATTACH, 852 LOG_POOL_VDEV_REPLACE, 853 LOG_POOL_VDEV_DETACH, 854 LOG_POOL_VDEV_ONLINE, 855 LOG_POOL_VDEV_OFFLINE, 856 LOG_POOL_UPGRADE, 857 LOG_POOL_CLEAR, 858 LOG_POOL_SCAN, 859 LOG_POOL_PROPSET, 860 LOG_DS_CREATE, 861 LOG_DS_CLONE, 862 LOG_DS_DESTROY, 863 LOG_DS_DESTROY_BEGIN, 864 LOG_DS_INHERIT, 865 LOG_DS_PROPSET, 866 LOG_DS_QUOTA, 867 LOG_DS_PERM_UPDATE, 868 LOG_DS_PERM_REMOVE, 869 LOG_DS_PERM_WHO_REMOVE, 870 LOG_DS_PROMOTE, 871 LOG_DS_RECEIVE, 872 LOG_DS_RENAME, 873 LOG_DS_RESERVATION, 874 LOG_DS_REPLAY_INC_SYNC, 875 LOG_DS_REPLAY_FULL_SYNC, 876 LOG_DS_ROLLBACK, 877 LOG_DS_SNAPSHOT, 878 LOG_DS_UPGRADE, 879 LOG_DS_REFQUOTA, 880 LOG_DS_REFRESERV, 881 LOG_POOL_SCAN_DONE, 882 LOG_DS_USER_HOLD, 883 LOG_DS_USER_RELEASE, 884 LOG_POOL_SPLIT, 885 LOG_END 886 } history_internal_events_t; 887 888 #ifdef __cplusplus 889 } 890 #endif 891 892 #endif /* _SYS_FS_ZFS_H */ 893