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