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