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 /* 58 * NB: lzc_dataset_type should be updated whenever a new objset type is added, 59 * if it represents a real type of a dataset that can be created from userland. 60 */ 61 typedef enum dmu_objset_type { 62 DMU_OST_NONE, 63 DMU_OST_META, 64 DMU_OST_ZFS, 65 DMU_OST_ZVOL, 66 DMU_OST_OTHER, /* For testing only! */ 67 DMU_OST_ANY, /* Be careful! */ 68 DMU_OST_NUMTYPES 69 } dmu_objset_type_t; 70 71 #define ZFS_TYPE_DATASET \ 72 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 73 74 #define ZAP_MAXNAMELEN 256 75 #define ZAP_MAXVALUELEN (1024 * 8) 76 #define ZAP_OLDMAXVALUELEN 1024 77 78 /* 79 * Dataset properties are identified by these constants and must be added to 80 * the end of this list to ensure that external consumers are not affected 81 * by the change. If you make any changes to this list, be sure to update 82 * the property table in usr/src/common/zfs/zfs_prop.c. 83 */ 84 typedef enum { 85 ZFS_PROP_BAD = -1, 86 ZFS_PROP_TYPE = 0, 87 ZFS_PROP_CREATION, 88 ZFS_PROP_USED, 89 ZFS_PROP_AVAILABLE, 90 ZFS_PROP_REFERENCED, 91 ZFS_PROP_COMPRESSRATIO, 92 ZFS_PROP_MOUNTED, 93 ZFS_PROP_ORIGIN, 94 ZFS_PROP_QUOTA, 95 ZFS_PROP_RESERVATION, 96 ZFS_PROP_VOLSIZE, 97 ZFS_PROP_VOLBLOCKSIZE, 98 ZFS_PROP_RECORDSIZE, 99 ZFS_PROP_MOUNTPOINT, 100 ZFS_PROP_SHARENFS, 101 ZFS_PROP_CHECKSUM, 102 ZFS_PROP_COMPRESSION, 103 ZFS_PROP_ATIME, 104 ZFS_PROP_DEVICES, 105 ZFS_PROP_EXEC, 106 ZFS_PROP_SETUID, 107 ZFS_PROP_READONLY, 108 ZFS_PROP_ZONED, 109 ZFS_PROP_SNAPDIR, 110 ZFS_PROP_ACLMODE, 111 ZFS_PROP_ACLINHERIT, 112 ZFS_PROP_CREATETXG, /* not exposed to the user */ 113 ZFS_PROP_NAME, /* not exposed to the user */ 114 ZFS_PROP_CANMOUNT, 115 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 116 ZFS_PROP_XATTR, 117 ZFS_PROP_NUMCLONES, /* not exposed to the user */ 118 ZFS_PROP_COPIES, 119 ZFS_PROP_VERSION, 120 ZFS_PROP_UTF8ONLY, 121 ZFS_PROP_NORMALIZE, 122 ZFS_PROP_CASE, 123 ZFS_PROP_VSCAN, 124 ZFS_PROP_NBMAND, 125 ZFS_PROP_SHARESMB, 126 ZFS_PROP_REFQUOTA, 127 ZFS_PROP_REFRESERVATION, 128 ZFS_PROP_GUID, 129 ZFS_PROP_PRIMARYCACHE, 130 ZFS_PROP_SECONDARYCACHE, 131 ZFS_PROP_USEDSNAP, 132 ZFS_PROP_USEDDS, 133 ZFS_PROP_USEDCHILD, 134 ZFS_PROP_USEDREFRESERV, 135 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 136 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 137 ZFS_PROP_DEFER_DESTROY, 138 ZFS_PROP_USERREFS, 139 ZFS_PROP_LOGBIAS, 140 ZFS_PROP_UNIQUE, /* not exposed to the user */ 141 ZFS_PROP_OBJSETID, /* not exposed to the user */ 142 ZFS_PROP_DEDUP, 143 ZFS_PROP_MLSLABEL, 144 ZFS_PROP_SYNC, 145 ZFS_PROP_REFRATIO, 146 ZFS_PROP_WRITTEN, 147 ZFS_PROP_CLONES, 148 ZFS_PROP_LOGICALUSED, 149 ZFS_PROP_LOGICALREFERENCED, 150 ZFS_PROP_INCONSISTENT, /* not exposed to the user */ 151 ZFS_PROP_FILESYSTEM_LIMIT, 152 ZFS_PROP_SNAPSHOT_LIMIT, 153 ZFS_PROP_FILESYSTEM_COUNT, 154 ZFS_PROP_SNAPSHOT_COUNT, 155 ZFS_PROP_REDUNDANT_METADATA, 156 ZFS_PROP_PREV_SNAP, 157 ZFS_PROP_RECEIVE_RESUME_TOKEN, 158 ZFS_NUM_PROPS 159 } zfs_prop_t; 160 161 typedef enum { 162 ZFS_PROP_USERUSED, 163 ZFS_PROP_USERQUOTA, 164 ZFS_PROP_GROUPUSED, 165 ZFS_PROP_GROUPQUOTA, 166 ZFS_NUM_USERQUOTA_PROPS 167 } zfs_userquota_prop_t; 168 169 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS]; 170 171 /* 172 * Pool properties are identified by these constants and must be added to the 173 * end of this list to ensure that external consumers are not affected 174 * by the change. If you make any changes to this list, be sure to update 175 * the property table in usr/src/common/zfs/zpool_prop.c. 176 */ 177 typedef enum { 178 ZPOOL_PROP_NAME, 179 ZPOOL_PROP_SIZE, 180 ZPOOL_PROP_CAPACITY, 181 ZPOOL_PROP_ALTROOT, 182 ZPOOL_PROP_HEALTH, 183 ZPOOL_PROP_GUID, 184 ZPOOL_PROP_VERSION, 185 ZPOOL_PROP_BOOTFS, 186 ZPOOL_PROP_DELEGATION, 187 ZPOOL_PROP_AUTOREPLACE, 188 ZPOOL_PROP_CACHEFILE, 189 ZPOOL_PROP_FAILUREMODE, 190 ZPOOL_PROP_LISTSNAPS, 191 ZPOOL_PROP_AUTOEXPAND, 192 ZPOOL_PROP_DEDUPDITTO, 193 ZPOOL_PROP_DEDUPRATIO, 194 ZPOOL_PROP_FREE, 195 ZPOOL_PROP_ALLOCATED, 196 ZPOOL_PROP_READONLY, 197 ZPOOL_PROP_COMMENT, 198 ZPOOL_PROP_EXPANDSZ, 199 ZPOOL_PROP_FREEING, 200 ZPOOL_PROP_FRAGMENTATION, 201 ZPOOL_PROP_LEAKED, 202 ZPOOL_PROP_MAXBLOCKSIZE, 203 ZPOOL_NUM_PROPS 204 } zpool_prop_t; 205 206 /* Small enough to not hog a whole line of printout in zpool(1M). */ 207 #define ZPROP_MAX_COMMENT 32 208 209 #define ZPROP_CONT -2 210 #define ZPROP_INVAL -1 211 212 #define ZPROP_VALUE "value" 213 #define ZPROP_SOURCE "source" 214 215 typedef enum { 216 ZPROP_SRC_NONE = 0x1, 217 ZPROP_SRC_DEFAULT = 0x2, 218 ZPROP_SRC_TEMPORARY = 0x4, 219 ZPROP_SRC_LOCAL = 0x8, 220 ZPROP_SRC_INHERITED = 0x10, 221 ZPROP_SRC_RECEIVED = 0x20 222 } zprop_source_t; 223 224 #define ZPROP_SRC_ALL 0x3f 225 226 #define ZPROP_SOURCE_VAL_RECVD "$recvd" 227 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 228 /* 229 * Dataset flag implemented as a special entry in the props zap object 230 * indicating that the dataset has received properties on or after 231 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 232 * just as it did in earlier versions, and thereafter, local properties are 233 * preserved. 234 */ 235 #define ZPROP_HAS_RECVD "$hasrecvd" 236 237 typedef enum { 238 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 239 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 240 } zprop_errflags_t; 241 242 typedef int (*zprop_func)(int, void *); 243 244 /* 245 * Properties to be set on the root file system of a new pool 246 * are stuffed into their own nvlist, which is then included in 247 * the properties nvlist with the pool properties. 248 */ 249 #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 250 251 /* 252 * Dataset property functions shared between libzfs and kernel. 253 */ 254 const char *zfs_prop_default_string(zfs_prop_t); 255 uint64_t zfs_prop_default_numeric(zfs_prop_t); 256 boolean_t zfs_prop_readonly(zfs_prop_t); 257 boolean_t zfs_prop_inheritable(zfs_prop_t); 258 boolean_t zfs_prop_setonce(zfs_prop_t); 259 const char *zfs_prop_to_name(zfs_prop_t); 260 zfs_prop_t zfs_name_to_prop(const char *); 261 boolean_t zfs_prop_user(const char *); 262 boolean_t zfs_prop_userquota(const char *); 263 boolean_t zfs_prop_written(const char *); 264 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 265 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 266 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 267 boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 268 269 /* 270 * Pool property functions shared between libzfs and kernel. 271 */ 272 zpool_prop_t zpool_name_to_prop(const char *); 273 const char *zpool_prop_to_name(zpool_prop_t); 274 const char *zpool_prop_default_string(zpool_prop_t); 275 uint64_t zpool_prop_default_numeric(zpool_prop_t); 276 boolean_t zpool_prop_readonly(zpool_prop_t); 277 boolean_t zpool_prop_feature(const char *); 278 boolean_t zpool_prop_unsupported(const char *name); 279 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 280 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 281 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 282 283 /* 284 * Definitions for the Delegation. 285 */ 286 typedef enum { 287 ZFS_DELEG_WHO_UNKNOWN = 0, 288 ZFS_DELEG_USER = 'u', 289 ZFS_DELEG_USER_SETS = 'U', 290 ZFS_DELEG_GROUP = 'g', 291 ZFS_DELEG_GROUP_SETS = 'G', 292 ZFS_DELEG_EVERYONE = 'e', 293 ZFS_DELEG_EVERYONE_SETS = 'E', 294 ZFS_DELEG_CREATE = 'c', 295 ZFS_DELEG_CREATE_SETS = 'C', 296 ZFS_DELEG_NAMED_SET = 's', 297 ZFS_DELEG_NAMED_SET_SETS = 'S' 298 } zfs_deleg_who_type_t; 299 300 typedef enum { 301 ZFS_DELEG_NONE = 0, 302 ZFS_DELEG_PERM_LOCAL = 1, 303 ZFS_DELEG_PERM_DESCENDENT = 2, 304 ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 305 ZFS_DELEG_PERM_CREATE = 4 306 } zfs_deleg_inherit_t; 307 308 #define ZFS_DELEG_PERM_UID "uid" 309 #define ZFS_DELEG_PERM_GID "gid" 310 #define ZFS_DELEG_PERM_GROUPS "groups" 311 312 #define ZFS_MLSLABEL_DEFAULT "none" 313 314 #define ZFS_SMB_ACL_SRC "src" 315 #define ZFS_SMB_ACL_TARGET "target" 316 317 typedef enum { 318 ZFS_CANMOUNT_OFF = 0, 319 ZFS_CANMOUNT_ON = 1, 320 ZFS_CANMOUNT_NOAUTO = 2 321 } zfs_canmount_type_t; 322 323 typedef enum { 324 ZFS_LOGBIAS_LATENCY = 0, 325 ZFS_LOGBIAS_THROUGHPUT = 1 326 } zfs_logbias_op_t; 327 328 typedef enum zfs_share_op { 329 ZFS_SHARE_NFS = 0, 330 ZFS_UNSHARE_NFS = 1, 331 ZFS_SHARE_SMB = 2, 332 ZFS_UNSHARE_SMB = 3 333 } zfs_share_op_t; 334 335 typedef enum zfs_smb_acl_op { 336 ZFS_SMB_ACL_ADD, 337 ZFS_SMB_ACL_REMOVE, 338 ZFS_SMB_ACL_RENAME, 339 ZFS_SMB_ACL_PURGE 340 } zfs_smb_acl_op_t; 341 342 typedef enum zfs_cache_type { 343 ZFS_CACHE_NONE = 0, 344 ZFS_CACHE_METADATA = 1, 345 ZFS_CACHE_ALL = 2 346 } zfs_cache_type_t; 347 348 typedef enum { 349 ZFS_SYNC_STANDARD = 0, 350 ZFS_SYNC_ALWAYS = 1, 351 ZFS_SYNC_DISABLED = 2 352 } zfs_sync_type_t; 353 354 typedef enum { 355 ZFS_REDUNDANT_METADATA_ALL, 356 ZFS_REDUNDANT_METADATA_MOST 357 } zfs_redundant_metadata_type_t; 358 359 /* 360 * On-disk version number. 361 */ 362 #define SPA_VERSION_1 1ULL 363 #define SPA_VERSION_2 2ULL 364 #define SPA_VERSION_3 3ULL 365 #define SPA_VERSION_4 4ULL 366 #define SPA_VERSION_5 5ULL 367 #define SPA_VERSION_6 6ULL 368 #define SPA_VERSION_7 7ULL 369 #define SPA_VERSION_8 8ULL 370 #define SPA_VERSION_9 9ULL 371 #define SPA_VERSION_10 10ULL 372 #define SPA_VERSION_11 11ULL 373 #define SPA_VERSION_12 12ULL 374 #define SPA_VERSION_13 13ULL 375 #define SPA_VERSION_14 14ULL 376 #define SPA_VERSION_15 15ULL 377 #define SPA_VERSION_16 16ULL 378 #define SPA_VERSION_17 17ULL 379 #define SPA_VERSION_18 18ULL 380 #define SPA_VERSION_19 19ULL 381 #define SPA_VERSION_20 20ULL 382 #define SPA_VERSION_21 21ULL 383 #define SPA_VERSION_22 22ULL 384 #define SPA_VERSION_23 23ULL 385 #define SPA_VERSION_24 24ULL 386 #define SPA_VERSION_25 25ULL 387 #define SPA_VERSION_26 26ULL 388 #define SPA_VERSION_27 27ULL 389 #define SPA_VERSION_28 28ULL 390 #define SPA_VERSION_5000 5000ULL 391 392 /* 393 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 394 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 395 * and do the appropriate changes. Also bump the version number in 396 * usr/src/grub/capability. 397 */ 398 #define SPA_VERSION SPA_VERSION_5000 399 #define SPA_VERSION_STRING "5000" 400 401 /* 402 * Symbolic names for the changes that caused a SPA_VERSION switch. 403 * Used in the code when checking for presence or absence of a feature. 404 * Feel free to define multiple symbolic names for each version if there 405 * were multiple changes to on-disk structures during that version. 406 * 407 * NOTE: When checking the current SPA_VERSION in your code, be sure 408 * to use spa_version() since it reports the version of the 409 * last synced uberblock. Checking the in-flight version can 410 * be dangerous in some cases. 411 */ 412 #define SPA_VERSION_INITIAL SPA_VERSION_1 413 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 414 #define SPA_VERSION_SPARES SPA_VERSION_3 415 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 416 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 417 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 418 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 419 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 420 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 421 #define SPA_VERSION_BOOTFS SPA_VERSION_6 422 #define SPA_VERSION_SLOGS SPA_VERSION_7 423 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 424 #define SPA_VERSION_FUID SPA_VERSION_9 425 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 426 #define SPA_VERSION_REFQUOTA SPA_VERSION_9 427 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 428 #define SPA_VERSION_L2CACHE SPA_VERSION_10 429 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 430 #define SPA_VERSION_ORIGIN SPA_VERSION_11 431 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 432 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 433 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 434 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 435 #define SPA_VERSION_USERSPACE SPA_VERSION_15 436 #define SPA_VERSION_STMF_PROP SPA_VERSION_16 437 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 438 #define SPA_VERSION_USERREFS SPA_VERSION_18 439 #define SPA_VERSION_HOLES SPA_VERSION_19 440 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 441 #define SPA_VERSION_DEDUP SPA_VERSION_21 442 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 443 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 444 #define SPA_VERSION_SA SPA_VERSION_24 445 #define SPA_VERSION_SCAN SPA_VERSION_25 446 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 447 #define SPA_VERSION_DEADLISTS SPA_VERSION_26 448 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 449 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 450 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 451 #define SPA_VERSION_FEATURES SPA_VERSION_5000 452 453 #define SPA_VERSION_IS_SUPPORTED(v) \ 454 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 455 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 456 457 /* 458 * ZPL version - rev'd whenever an incompatible on-disk format change 459 * occurs. This is independent of SPA/DMU/ZAP versioning. You must 460 * also update the version_table[] and help message in zfs_prop.c. 461 * 462 * When changing, be sure to teach GRUB how to read the new format! 463 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 464 */ 465 #define ZPL_VERSION_1 1ULL 466 #define ZPL_VERSION_2 2ULL 467 #define ZPL_VERSION_3 3ULL 468 #define ZPL_VERSION_4 4ULL 469 #define ZPL_VERSION_5 5ULL 470 #define ZPL_VERSION ZPL_VERSION_5 471 #define ZPL_VERSION_STRING "5" 472 473 #define ZPL_VERSION_INITIAL ZPL_VERSION_1 474 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 475 #define ZPL_VERSION_FUID ZPL_VERSION_3 476 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 477 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 478 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 479 #define ZPL_VERSION_SA ZPL_VERSION_5 480 481 /* Rewind request information */ 482 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 483 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 484 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 485 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 486 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 487 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 488 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 489 490 typedef struct zpool_rewind_policy { 491 uint32_t zrp_request; /* rewind behavior requested */ 492 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */ 493 uint64_t zrp_maxdata; /* max acceptable data errors */ 494 uint64_t zrp_txg; /* specific txg to load */ 495 } zpool_rewind_policy_t; 496 497 /* 498 * The following are configuration names used in the nvlist describing a pool's 499 * configuration. 500 */ 501 #define ZPOOL_CONFIG_VERSION "version" 502 #define ZPOOL_CONFIG_POOL_NAME "name" 503 #define ZPOOL_CONFIG_POOL_STATE "state" 504 #define ZPOOL_CONFIG_POOL_TXG "txg" 505 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 506 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 507 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 508 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 509 #define ZPOOL_CONFIG_TYPE "type" 510 #define ZPOOL_CONFIG_CHILDREN "children" 511 #define ZPOOL_CONFIG_ID "id" 512 #define ZPOOL_CONFIG_GUID "guid" 513 #define ZPOOL_CONFIG_PATH "path" 514 #define ZPOOL_CONFIG_DEVID "devid" 515 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 516 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 517 #define ZPOOL_CONFIG_ASHIFT "ashift" 518 #define ZPOOL_CONFIG_ASIZE "asize" 519 #define ZPOOL_CONFIG_DTL "DTL" 520 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 521 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 522 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 523 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 524 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 525 #define ZPOOL_CONFIG_SPARES "spares" 526 #define ZPOOL_CONFIG_IS_SPARE "is_spare" 527 #define ZPOOL_CONFIG_NPARITY "nparity" 528 #define ZPOOL_CONFIG_HOSTID "hostid" 529 #define ZPOOL_CONFIG_HOSTNAME "hostname" 530 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 531 #define ZPOOL_CONFIG_UNSPARE "unspare" 532 #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 533 #define ZPOOL_CONFIG_IS_LOG "is_log" 534 #define ZPOOL_CONFIG_L2CACHE "l2cache" 535 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 536 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 537 #define ZPOOL_CONFIG_IS_HOLE "is_hole" 538 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 539 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 540 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 541 #define ZPOOL_CONFIG_SPLIT "splitcfg" 542 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 543 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 544 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 545 #define ZPOOL_CONFIG_REMOVING "removing" 546 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg" 547 #define ZPOOL_CONFIG_COMMENT "comment" 548 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 549 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 550 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 551 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 552 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 553 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */ 554 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */ 555 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */ 556 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */ 557 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 558 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */ 559 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top" 560 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf" 561 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps" 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 #define ZFS_DISK_ROOT "/dev/dsk" 779 #define ZFS_DISK_ROOTD ZFS_DISK_ROOT "/" 780 #define ZFS_RDISK_ROOT "/dev/rdsk" 781 #define ZFS_RDISK_ROOTD ZFS_RDISK_ROOT "/" 782 783 /* general zvol path */ 784 #define ZVOL_DIR "/dev/zvol" 785 /* expansion */ 786 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 787 /* for dump and swap */ 788 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 789 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 790 791 #define ZVOL_PROP_NAME "name" 792 #define ZVOL_DEFAULT_BLOCKSIZE 8192 793 794 /* 795 * /dev/zfs ioctl numbers. 796 */ 797 typedef enum zfs_ioc { 798 ZFS_IOC_FIRST = ('Z' << 8), 799 ZFS_IOC = ZFS_IOC_FIRST, 800 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, 801 ZFS_IOC_POOL_DESTROY, 802 ZFS_IOC_POOL_IMPORT, 803 ZFS_IOC_POOL_EXPORT, 804 ZFS_IOC_POOL_CONFIGS, 805 ZFS_IOC_POOL_STATS, 806 ZFS_IOC_POOL_TRYIMPORT, 807 ZFS_IOC_POOL_SCAN, 808 ZFS_IOC_POOL_FREEZE, 809 ZFS_IOC_POOL_UPGRADE, 810 ZFS_IOC_POOL_GET_HISTORY, 811 ZFS_IOC_VDEV_ADD, 812 ZFS_IOC_VDEV_REMOVE, 813 ZFS_IOC_VDEV_SET_STATE, 814 ZFS_IOC_VDEV_ATTACH, 815 ZFS_IOC_VDEV_DETACH, 816 ZFS_IOC_VDEV_SETPATH, 817 ZFS_IOC_VDEV_SETFRU, 818 ZFS_IOC_OBJSET_STATS, 819 ZFS_IOC_OBJSET_ZPLPROPS, 820 ZFS_IOC_DATASET_LIST_NEXT, 821 ZFS_IOC_SNAPSHOT_LIST_NEXT, 822 ZFS_IOC_SET_PROP, 823 ZFS_IOC_CREATE, 824 ZFS_IOC_DESTROY, 825 ZFS_IOC_ROLLBACK, 826 ZFS_IOC_RENAME, 827 ZFS_IOC_RECV, 828 ZFS_IOC_SEND, 829 ZFS_IOC_INJECT_FAULT, 830 ZFS_IOC_CLEAR_FAULT, 831 ZFS_IOC_INJECT_LIST_NEXT, 832 ZFS_IOC_ERROR_LOG, 833 ZFS_IOC_CLEAR, 834 ZFS_IOC_PROMOTE, 835 ZFS_IOC_SNAPSHOT, 836 ZFS_IOC_DSOBJ_TO_DSNAME, 837 ZFS_IOC_OBJ_TO_PATH, 838 ZFS_IOC_POOL_SET_PROPS, 839 ZFS_IOC_POOL_GET_PROPS, 840 ZFS_IOC_SET_FSACL, 841 ZFS_IOC_GET_FSACL, 842 ZFS_IOC_SHARE, 843 ZFS_IOC_INHERIT_PROP, 844 ZFS_IOC_SMB_ACL, 845 ZFS_IOC_USERSPACE_ONE, 846 ZFS_IOC_USERSPACE_MANY, 847 ZFS_IOC_USERSPACE_UPGRADE, 848 ZFS_IOC_HOLD, 849 ZFS_IOC_RELEASE, 850 ZFS_IOC_GET_HOLDS, 851 ZFS_IOC_OBJSET_RECVD_PROPS, 852 ZFS_IOC_VDEV_SPLIT, 853 ZFS_IOC_NEXT_OBJ, 854 ZFS_IOC_DIFF, 855 ZFS_IOC_TMP_SNAPSHOT, 856 ZFS_IOC_OBJ_TO_STATS, 857 ZFS_IOC_SPACE_WRITTEN, 858 ZFS_IOC_SPACE_SNAPS, 859 ZFS_IOC_DESTROY_SNAPS, 860 ZFS_IOC_POOL_REGUID, 861 ZFS_IOC_POOL_REOPEN, 862 ZFS_IOC_SEND_PROGRESS, 863 ZFS_IOC_LOG_HISTORY, 864 ZFS_IOC_SEND_NEW, 865 ZFS_IOC_SEND_SPACE, 866 ZFS_IOC_CLONE, 867 ZFS_IOC_BOOKMARK, 868 ZFS_IOC_GET_BOOKMARKS, 869 ZFS_IOC_DESTROY_BOOKMARKS, 870 ZFS_IOC_LAST 871 } zfs_ioc_t; 872 873 /* 874 * Internal SPA load state. Used by FMA diagnosis engine. 875 */ 876 typedef enum { 877 SPA_LOAD_NONE, /* no load in progress */ 878 SPA_LOAD_OPEN, /* normal open */ 879 SPA_LOAD_IMPORT, /* import in progress */ 880 SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 881 SPA_LOAD_RECOVER, /* recovery requested */ 882 SPA_LOAD_ERROR /* load failed */ 883 } spa_load_state_t; 884 885 /* 886 * Bookmark name values. 887 */ 888 #define ZPOOL_ERR_LIST "error list" 889 #define ZPOOL_ERR_DATASET "dataset" 890 #define ZPOOL_ERR_OBJECT "object" 891 892 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 893 894 /* 895 * The following are names used in the nvlist describing 896 * the pool's history log. 897 */ 898 #define ZPOOL_HIST_RECORD "history record" 899 #define ZPOOL_HIST_TIME "history time" 900 #define ZPOOL_HIST_CMD "history command" 901 #define ZPOOL_HIST_WHO "history who" 902 #define ZPOOL_HIST_ZONE "history zone" 903 #define ZPOOL_HIST_HOST "history hostname" 904 #define ZPOOL_HIST_TXG "history txg" 905 #define ZPOOL_HIST_INT_EVENT "history internal event" 906 #define ZPOOL_HIST_INT_STR "history internal str" 907 #define ZPOOL_HIST_INT_NAME "internal_name" 908 #define ZPOOL_HIST_IOCTL "ioctl" 909 #define ZPOOL_HIST_INPUT_NVL "in_nvl" 910 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl" 911 #define ZPOOL_HIST_DSNAME "dsname" 912 #define ZPOOL_HIST_DSID "dsid" 913 914 /* 915 * Flags for ZFS_IOC_VDEV_SET_STATE 916 */ 917 #define ZFS_ONLINE_CHECKREMOVE 0x1 918 #define ZFS_ONLINE_UNSPARE 0x2 919 #define ZFS_ONLINE_FORCEFAULT 0x4 920 #define ZFS_ONLINE_EXPAND 0x8 921 #define ZFS_OFFLINE_TEMPORARY 0x1 922 923 /* 924 * Flags for ZFS_IOC_POOL_IMPORT 925 */ 926 #define ZFS_IMPORT_NORMAL 0x0 927 #define ZFS_IMPORT_VERBATIM 0x1 928 #define ZFS_IMPORT_ANY_HOST 0x2 929 #define ZFS_IMPORT_MISSING_LOG 0x4 930 #define ZFS_IMPORT_ONLY 0x8 931 932 /* 933 * Sysevent payload members. ZFS will generate the following sysevents with the 934 * given payloads: 935 * 936 * ESC_ZFS_RESILVER_START 937 * ESC_ZFS_RESILVER_END 938 * ESC_ZFS_POOL_DESTROY 939 * ESC_ZFS_POOL_REGUID 940 * 941 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 942 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 943 * 944 * ESC_ZFS_VDEV_REMOVE 945 * ESC_ZFS_VDEV_CLEAR 946 * ESC_ZFS_VDEV_CHECK 947 * 948 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 949 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 950 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 951 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 952 */ 953 #define ZFS_EV_POOL_NAME "pool_name" 954 #define ZFS_EV_POOL_GUID "pool_guid" 955 #define ZFS_EV_VDEV_PATH "vdev_path" 956 #define ZFS_EV_VDEV_GUID "vdev_guid" 957 958 #ifdef __cplusplus 959 } 960 #endif 961 962 #endif /* _SYS_FS_ZFS_H */ 963