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