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