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