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