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