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