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