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