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