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 https://opensource.org/licenses/CDDL-1.0. 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, 2020 by Delphix. All rights reserved. 25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 26 * Copyright (c) 2013, 2017 Joyent, Inc. All rights reserved. 27 * Copyright (c) 2014 Integros [integros.com] 28 * Copyright (c) 2017, Intel Corporation. 29 * Copyright (c) 2019 Datto Inc. 30 * Portions Copyright 2010 Robert Milkowski 31 * Copyright (c) 2021, Colm Buckley <colm@tuatha.org> 32 * Copyright (c) 2022 Hewlett Packard Enterprise Development LP. 33 */ 34 35 #ifndef _SYS_FS_ZFS_H 36 #define _SYS_FS_ZFS_H extern __attribute__((visibility("default"))) 37 38 #include <sys/time.h> 39 #include <sys/zio_priority.h> 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 /* 46 * Types and constants shared between userland and the kernel. 47 */ 48 49 /* 50 * Each dataset can be one of the following types. These constants can be 51 * combined into masks that can be passed to various functions. 52 */ 53 typedef enum { 54 ZFS_TYPE_INVALID = 0, 55 ZFS_TYPE_FILESYSTEM = (1 << 0), 56 ZFS_TYPE_SNAPSHOT = (1 << 1), 57 ZFS_TYPE_VOLUME = (1 << 2), 58 ZFS_TYPE_POOL = (1 << 3), 59 ZFS_TYPE_BOOKMARK = (1 << 4), 60 ZFS_TYPE_VDEV = (1 << 5), 61 } zfs_type_t; 62 63 /* 64 * NB: lzc_dataset_type should be updated whenever a new objset type is added, 65 * if it represents a real type of a dataset that can be created from userland. 66 */ 67 typedef enum dmu_objset_type { 68 DMU_OST_NONE, 69 DMU_OST_META, 70 DMU_OST_ZFS, 71 DMU_OST_ZVOL, 72 DMU_OST_OTHER, /* For testing only! */ 73 DMU_OST_ANY, /* Be careful! */ 74 DMU_OST_NUMTYPES 75 } dmu_objset_type_t; 76 77 #define ZFS_TYPE_DATASET \ 78 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 79 80 /* 81 * All of these include the terminating NUL byte. 82 */ 83 #define ZAP_MAXNAMELEN 256 84 #define ZAP_MAXVALUELEN (1024 * 8) 85 #define ZAP_OLDMAXVALUELEN 1024 86 #define ZFS_MAX_DATASET_NAME_LEN 256 87 88 /* 89 * Dataset properties are identified by these constants and must be added to 90 * the end of this list to ensure that external consumers are not affected 91 * by the change. If you make any changes to this list, be sure to update 92 * the property table in module/zcommon/zfs_prop.c. 93 */ 94 typedef enum { 95 ZPROP_CONT = -2, 96 ZPROP_INVAL = -1, 97 ZPROP_USERPROP = ZPROP_INVAL, 98 ZFS_PROP_TYPE = 0, 99 ZFS_PROP_CREATION, 100 ZFS_PROP_USED, 101 ZFS_PROP_AVAILABLE, 102 ZFS_PROP_REFERENCED, 103 ZFS_PROP_COMPRESSRATIO, 104 ZFS_PROP_MOUNTED, 105 ZFS_PROP_ORIGIN, 106 ZFS_PROP_QUOTA, 107 ZFS_PROP_RESERVATION, 108 ZFS_PROP_VOLSIZE, 109 ZFS_PROP_VOLBLOCKSIZE, 110 ZFS_PROP_RECORDSIZE, 111 ZFS_PROP_MOUNTPOINT, 112 ZFS_PROP_SHARENFS, 113 ZFS_PROP_CHECKSUM, 114 ZFS_PROP_COMPRESSION, 115 ZFS_PROP_ATIME, 116 ZFS_PROP_DEVICES, 117 ZFS_PROP_EXEC, 118 ZFS_PROP_SETUID, 119 ZFS_PROP_READONLY, 120 ZFS_PROP_ZONED, 121 ZFS_PROP_SNAPDIR, 122 ZFS_PROP_ACLMODE, 123 ZFS_PROP_ACLINHERIT, 124 ZFS_PROP_CREATETXG, 125 ZFS_PROP_NAME, /* not exposed to the user */ 126 ZFS_PROP_CANMOUNT, 127 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 128 ZFS_PROP_XATTR, 129 ZFS_PROP_NUMCLONES, /* not exposed to the user */ 130 ZFS_PROP_COPIES, 131 ZFS_PROP_VERSION, 132 ZFS_PROP_UTF8ONLY, 133 ZFS_PROP_NORMALIZE, 134 ZFS_PROP_CASE, 135 ZFS_PROP_VSCAN, 136 ZFS_PROP_NBMAND, 137 ZFS_PROP_SHARESMB, 138 ZFS_PROP_REFQUOTA, 139 ZFS_PROP_REFRESERVATION, 140 ZFS_PROP_GUID, 141 ZFS_PROP_PRIMARYCACHE, 142 ZFS_PROP_SECONDARYCACHE, 143 ZFS_PROP_USEDSNAP, 144 ZFS_PROP_USEDDS, 145 ZFS_PROP_USEDCHILD, 146 ZFS_PROP_USEDREFRESERV, 147 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 148 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 149 ZFS_PROP_DEFER_DESTROY, 150 ZFS_PROP_USERREFS, 151 ZFS_PROP_LOGBIAS, 152 ZFS_PROP_UNIQUE, /* not exposed to the user */ 153 ZFS_PROP_OBJSETID, 154 ZFS_PROP_DEDUP, 155 ZFS_PROP_MLSLABEL, 156 ZFS_PROP_SYNC, 157 ZFS_PROP_DNODESIZE, 158 ZFS_PROP_REFRATIO, 159 ZFS_PROP_WRITTEN, 160 ZFS_PROP_CLONES, 161 ZFS_PROP_LOGICALUSED, 162 ZFS_PROP_LOGICALREFERENCED, 163 ZFS_PROP_INCONSISTENT, /* not exposed to the user */ 164 ZFS_PROP_VOLMODE, 165 ZFS_PROP_FILESYSTEM_LIMIT, 166 ZFS_PROP_SNAPSHOT_LIMIT, 167 ZFS_PROP_FILESYSTEM_COUNT, 168 ZFS_PROP_SNAPSHOT_COUNT, 169 ZFS_PROP_SNAPDEV, 170 ZFS_PROP_ACLTYPE, 171 ZFS_PROP_SELINUX_CONTEXT, 172 ZFS_PROP_SELINUX_FSCONTEXT, 173 ZFS_PROP_SELINUX_DEFCONTEXT, 174 ZFS_PROP_SELINUX_ROOTCONTEXT, 175 ZFS_PROP_RELATIME, 176 ZFS_PROP_REDUNDANT_METADATA, 177 ZFS_PROP_OVERLAY, 178 ZFS_PROP_PREV_SNAP, 179 ZFS_PROP_RECEIVE_RESUME_TOKEN, 180 ZFS_PROP_ENCRYPTION, 181 ZFS_PROP_KEYLOCATION, 182 ZFS_PROP_KEYFORMAT, 183 ZFS_PROP_PBKDF2_SALT, 184 ZFS_PROP_PBKDF2_ITERS, 185 ZFS_PROP_ENCRYPTION_ROOT, 186 ZFS_PROP_KEY_GUID, 187 ZFS_PROP_KEYSTATUS, 188 ZFS_PROP_REMAPTXG, /* obsolete - no longer used */ 189 ZFS_PROP_SPECIAL_SMALL_BLOCKS, 190 ZFS_PROP_IVSET_GUID, /* not exposed to the user */ 191 ZFS_PROP_REDACTED, 192 ZFS_PROP_REDACT_SNAPS, 193 ZFS_PROP_SNAPSHOTS_CHANGED, 194 ZFS_PROP_PREFETCH, 195 ZFS_PROP_VOLTHREADING, 196 ZFS_NUM_PROPS 197 } zfs_prop_t; 198 199 typedef enum { 200 ZFS_PROP_USERUSED, 201 ZFS_PROP_USERQUOTA, 202 ZFS_PROP_GROUPUSED, 203 ZFS_PROP_GROUPQUOTA, 204 ZFS_PROP_USEROBJUSED, 205 ZFS_PROP_USEROBJQUOTA, 206 ZFS_PROP_GROUPOBJUSED, 207 ZFS_PROP_GROUPOBJQUOTA, 208 ZFS_PROP_PROJECTUSED, 209 ZFS_PROP_PROJECTQUOTA, 210 ZFS_PROP_PROJECTOBJUSED, 211 ZFS_PROP_PROJECTOBJQUOTA, 212 ZFS_NUM_USERQUOTA_PROPS 213 } zfs_userquota_prop_t; 214 215 _SYS_FS_ZFS_H const char *const zfs_userquota_prop_prefixes[ 216 ZFS_NUM_USERQUOTA_PROPS]; 217 218 /* 219 * Pool properties are identified by these constants and must be added to the 220 * end of this list to ensure that external consumers are not affected 221 * by the change. Properties must be registered in zfs_prop_init(). 222 */ 223 typedef enum { 224 ZPOOL_PROP_INVAL = -1, 225 ZPOOL_PROP_NAME, 226 ZPOOL_PROP_SIZE, 227 ZPOOL_PROP_CAPACITY, 228 ZPOOL_PROP_ALTROOT, 229 ZPOOL_PROP_HEALTH, 230 ZPOOL_PROP_GUID, 231 ZPOOL_PROP_VERSION, 232 ZPOOL_PROP_BOOTFS, 233 ZPOOL_PROP_DELEGATION, 234 ZPOOL_PROP_AUTOREPLACE, 235 ZPOOL_PROP_CACHEFILE, 236 ZPOOL_PROP_FAILUREMODE, 237 ZPOOL_PROP_LISTSNAPS, 238 ZPOOL_PROP_AUTOEXPAND, 239 ZPOOL_PROP_DEDUPDITTO, 240 ZPOOL_PROP_DEDUPRATIO, 241 ZPOOL_PROP_FREE, 242 ZPOOL_PROP_ALLOCATED, 243 ZPOOL_PROP_READONLY, 244 ZPOOL_PROP_ASHIFT, 245 ZPOOL_PROP_COMMENT, 246 ZPOOL_PROP_EXPANDSZ, 247 ZPOOL_PROP_FREEING, 248 ZPOOL_PROP_FRAGMENTATION, 249 ZPOOL_PROP_LEAKED, 250 ZPOOL_PROP_MAXBLOCKSIZE, 251 ZPOOL_PROP_TNAME, 252 ZPOOL_PROP_MAXDNODESIZE, 253 ZPOOL_PROP_MULTIHOST, 254 ZPOOL_PROP_CHECKPOINT, 255 ZPOOL_PROP_LOAD_GUID, 256 ZPOOL_PROP_AUTOTRIM, 257 ZPOOL_PROP_COMPATIBILITY, 258 ZPOOL_PROP_BCLONEUSED, 259 ZPOOL_PROP_BCLONESAVED, 260 ZPOOL_PROP_BCLONERATIO, 261 ZPOOL_NUM_PROPS 262 } zpool_prop_t; 263 264 /* Small enough to not hog a whole line of printout in zpool(8). */ 265 #define ZPROP_MAX_COMMENT 32 266 #define ZPROP_BOOLEAN_NA 2 267 268 #define ZPROP_VALUE "value" 269 #define ZPROP_SOURCE "source" 270 271 typedef enum { 272 ZPROP_SRC_NONE = 0x1, 273 ZPROP_SRC_DEFAULT = 0x2, 274 ZPROP_SRC_TEMPORARY = 0x4, 275 ZPROP_SRC_LOCAL = 0x8, 276 ZPROP_SRC_INHERITED = 0x10, 277 ZPROP_SRC_RECEIVED = 0x20 278 } zprop_source_t; 279 280 #define ZPROP_SRC_ALL 0x3f 281 282 #define ZPROP_SOURCE_VAL_RECVD "$recvd" 283 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 284 285 /* 286 * Dataset flag implemented as a special entry in the props zap object 287 * indicating that the dataset has received properties on or after 288 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 289 * just as it did in earlier versions, and thereafter, local properties are 290 * preserved. 291 */ 292 #define ZPROP_HAS_RECVD "$hasrecvd" 293 294 typedef enum { 295 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 296 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 297 } zprop_errflags_t; 298 299 typedef int (*zprop_func)(int, void *); 300 301 /* 302 * Properties to be set on the root file system of a new pool 303 * are stuffed into their own nvlist, which is then included in 304 * the properties nvlist with the pool properties. 305 */ 306 #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 307 308 /* 309 * Length of 'written@' and 'written#' 310 */ 311 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8 312 313 /* 314 * VDEV properties are identified by these constants and must be added to the 315 * end of this list to ensure that external consumers are not affected 316 * by the change. If you make any changes to this list, be sure to update 317 * the property table in usr/src/common/zfs/zpool_prop.c. 318 */ 319 typedef enum { 320 VDEV_PROP_INVAL = -1, 321 VDEV_PROP_USERPROP = VDEV_PROP_INVAL, 322 VDEV_PROP_NAME, 323 VDEV_PROP_CAPACITY, 324 VDEV_PROP_STATE, 325 VDEV_PROP_GUID, 326 VDEV_PROP_ASIZE, 327 VDEV_PROP_PSIZE, 328 VDEV_PROP_ASHIFT, 329 VDEV_PROP_SIZE, 330 VDEV_PROP_FREE, 331 VDEV_PROP_ALLOCATED, 332 VDEV_PROP_COMMENT, 333 VDEV_PROP_EXPANDSZ, 334 VDEV_PROP_FRAGMENTATION, 335 VDEV_PROP_BOOTSIZE, 336 VDEV_PROP_PARITY, 337 VDEV_PROP_PATH, 338 VDEV_PROP_DEVID, 339 VDEV_PROP_PHYS_PATH, 340 VDEV_PROP_ENC_PATH, 341 VDEV_PROP_FRU, 342 VDEV_PROP_PARENT, 343 VDEV_PROP_CHILDREN, 344 VDEV_PROP_NUMCHILDREN, 345 VDEV_PROP_READ_ERRORS, 346 VDEV_PROP_WRITE_ERRORS, 347 VDEV_PROP_CHECKSUM_ERRORS, 348 VDEV_PROP_INITIALIZE_ERRORS, 349 VDEV_PROP_OPS_NULL, 350 VDEV_PROP_OPS_READ, 351 VDEV_PROP_OPS_WRITE, 352 VDEV_PROP_OPS_FREE, 353 VDEV_PROP_OPS_CLAIM, 354 VDEV_PROP_OPS_TRIM, 355 VDEV_PROP_BYTES_NULL, 356 VDEV_PROP_BYTES_READ, 357 VDEV_PROP_BYTES_WRITE, 358 VDEV_PROP_BYTES_FREE, 359 VDEV_PROP_BYTES_CLAIM, 360 VDEV_PROP_BYTES_TRIM, 361 VDEV_PROP_REMOVING, 362 VDEV_PROP_ALLOCATING, 363 VDEV_PROP_FAILFAST, 364 VDEV_PROP_CHECKSUM_N, 365 VDEV_PROP_CHECKSUM_T, 366 VDEV_PROP_IO_N, 367 VDEV_PROP_IO_T, 368 VDEV_PROP_RAIDZ_EXPANDING, 369 VDEV_NUM_PROPS 370 } vdev_prop_t; 371 372 /* 373 * Dataset property functions shared between libzfs and kernel. 374 */ 375 _SYS_FS_ZFS_H const char *zfs_prop_default_string(zfs_prop_t); 376 _SYS_FS_ZFS_H uint64_t zfs_prop_default_numeric(zfs_prop_t); 377 _SYS_FS_ZFS_H boolean_t zfs_prop_readonly(zfs_prop_t); 378 _SYS_FS_ZFS_H boolean_t zfs_prop_visible(zfs_prop_t prop); 379 _SYS_FS_ZFS_H boolean_t zfs_prop_inheritable(zfs_prop_t); 380 _SYS_FS_ZFS_H boolean_t zfs_prop_setonce(zfs_prop_t); 381 _SYS_FS_ZFS_H boolean_t zfs_prop_encryption_key_param(zfs_prop_t); 382 _SYS_FS_ZFS_H boolean_t zfs_prop_valid_keylocation(const char *, boolean_t); 383 _SYS_FS_ZFS_H const char *zfs_prop_to_name(zfs_prop_t); 384 _SYS_FS_ZFS_H zfs_prop_t zfs_name_to_prop(const char *); 385 _SYS_FS_ZFS_H boolean_t zfs_prop_user(const char *); 386 _SYS_FS_ZFS_H boolean_t zfs_prop_userquota(const char *); 387 _SYS_FS_ZFS_H boolean_t zfs_prop_written(const char *); 388 _SYS_FS_ZFS_H int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 389 _SYS_FS_ZFS_H int zfs_prop_string_to_index(zfs_prop_t, const char *, 390 uint64_t *); 391 _SYS_FS_ZFS_H uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 392 _SYS_FS_ZFS_H boolean_t zfs_prop_valid_for_type(int, zfs_type_t, boolean_t); 393 394 /* 395 * Pool property functions shared between libzfs and kernel. 396 */ 397 _SYS_FS_ZFS_H zpool_prop_t zpool_name_to_prop(const char *); 398 _SYS_FS_ZFS_H const char *zpool_prop_to_name(zpool_prop_t); 399 _SYS_FS_ZFS_H const char *zpool_prop_default_string(zpool_prop_t); 400 _SYS_FS_ZFS_H uint64_t zpool_prop_default_numeric(zpool_prop_t); 401 _SYS_FS_ZFS_H boolean_t zpool_prop_readonly(zpool_prop_t); 402 _SYS_FS_ZFS_H boolean_t zpool_prop_setonce(zpool_prop_t); 403 _SYS_FS_ZFS_H boolean_t zpool_prop_feature(const char *); 404 _SYS_FS_ZFS_H boolean_t zpool_prop_unsupported(const char *); 405 _SYS_FS_ZFS_H int zpool_prop_index_to_string(zpool_prop_t, uint64_t, 406 const char **); 407 _SYS_FS_ZFS_H int zpool_prop_string_to_index(zpool_prop_t, const char *, 408 uint64_t *); 409 _SYS_FS_ZFS_H uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 410 411 /* 412 * VDEV property functions shared between libzfs and kernel. 413 */ 414 _SYS_FS_ZFS_H vdev_prop_t vdev_name_to_prop(const char *); 415 _SYS_FS_ZFS_H boolean_t vdev_prop_user(const char *name); 416 _SYS_FS_ZFS_H const char *vdev_prop_to_name(vdev_prop_t); 417 _SYS_FS_ZFS_H const char *vdev_prop_default_string(vdev_prop_t); 418 _SYS_FS_ZFS_H uint64_t vdev_prop_default_numeric(vdev_prop_t); 419 _SYS_FS_ZFS_H boolean_t vdev_prop_readonly(vdev_prop_t prop); 420 _SYS_FS_ZFS_H int vdev_prop_index_to_string(vdev_prop_t, uint64_t, 421 const char **); 422 _SYS_FS_ZFS_H int vdev_prop_string_to_index(vdev_prop_t, const char *, 423 uint64_t *); 424 _SYS_FS_ZFS_H boolean_t zpool_prop_vdev(const char *name); 425 _SYS_FS_ZFS_H uint64_t vdev_prop_random_value(vdev_prop_t prop, uint64_t seed); 426 427 /* 428 * Definitions for the Delegation. 429 */ 430 typedef enum { 431 ZFS_DELEG_WHO_UNKNOWN = 0, 432 ZFS_DELEG_USER = 'u', 433 ZFS_DELEG_USER_SETS = 'U', 434 ZFS_DELEG_GROUP = 'g', 435 ZFS_DELEG_GROUP_SETS = 'G', 436 ZFS_DELEG_EVERYONE = 'e', 437 ZFS_DELEG_EVERYONE_SETS = 'E', 438 ZFS_DELEG_CREATE = 'c', 439 ZFS_DELEG_CREATE_SETS = 'C', 440 ZFS_DELEG_NAMED_SET = 's', 441 ZFS_DELEG_NAMED_SET_SETS = 'S' 442 } zfs_deleg_who_type_t; 443 444 typedef enum { 445 ZFS_DELEG_NONE = 0, 446 ZFS_DELEG_PERM_LOCAL = 1, 447 ZFS_DELEG_PERM_DESCENDENT = 2, 448 ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 449 ZFS_DELEG_PERM_CREATE = 4 450 } zfs_deleg_inherit_t; 451 452 #define ZFS_DELEG_PERM_UID "uid" 453 #define ZFS_DELEG_PERM_GID "gid" 454 #define ZFS_DELEG_PERM_GROUPS "groups" 455 456 #define ZFS_MLSLABEL_DEFAULT "none" 457 458 #define ZFS_SMB_ACL_SRC "src" 459 #define ZFS_SMB_ACL_TARGET "target" 460 461 typedef enum { 462 ZFS_CANMOUNT_OFF = 0, 463 ZFS_CANMOUNT_ON = 1, 464 ZFS_CANMOUNT_NOAUTO = 2 465 } zfs_canmount_type_t; 466 467 typedef enum { 468 ZFS_LOGBIAS_LATENCY = 0, 469 ZFS_LOGBIAS_THROUGHPUT = 1 470 } zfs_logbias_op_t; 471 472 typedef enum zfs_share_op { 473 ZFS_SHARE_NFS = 0, 474 ZFS_UNSHARE_NFS = 1, 475 ZFS_SHARE_SMB = 2, 476 ZFS_UNSHARE_SMB = 3 477 } zfs_share_op_t; 478 479 typedef enum zfs_smb_acl_op { 480 ZFS_SMB_ACL_ADD, 481 ZFS_SMB_ACL_REMOVE, 482 ZFS_SMB_ACL_RENAME, 483 ZFS_SMB_ACL_PURGE 484 } zfs_smb_acl_op_t; 485 486 typedef enum zfs_cache_type { 487 ZFS_CACHE_NONE = 0, 488 ZFS_CACHE_METADATA = 1, 489 ZFS_CACHE_ALL = 2 490 } zfs_cache_type_t; 491 492 typedef enum { 493 ZFS_SYNC_STANDARD = 0, 494 ZFS_SYNC_ALWAYS = 1, 495 ZFS_SYNC_DISABLED = 2 496 } zfs_sync_type_t; 497 498 typedef enum { 499 ZFS_XATTR_OFF = 0, 500 ZFS_XATTR_DIR = 1, 501 ZFS_XATTR_SA = 2 502 } zfs_xattr_type_t; 503 504 typedef enum { 505 ZFS_DNSIZE_LEGACY = 0, 506 ZFS_DNSIZE_AUTO = 1, 507 ZFS_DNSIZE_1K = 1024, 508 ZFS_DNSIZE_2K = 2048, 509 ZFS_DNSIZE_4K = 4096, 510 ZFS_DNSIZE_8K = 8192, 511 ZFS_DNSIZE_16K = 16384 512 } zfs_dnsize_type_t; 513 514 typedef enum { 515 ZFS_REDUNDANT_METADATA_ALL, 516 ZFS_REDUNDANT_METADATA_MOST, 517 ZFS_REDUNDANT_METADATA_SOME, 518 ZFS_REDUNDANT_METADATA_NONE 519 } zfs_redundant_metadata_type_t; 520 521 typedef enum { 522 ZFS_VOLMODE_DEFAULT = 0, 523 ZFS_VOLMODE_GEOM = 1, 524 ZFS_VOLMODE_DEV = 2, 525 ZFS_VOLMODE_NONE = 3 526 } zfs_volmode_t; 527 528 typedef enum zfs_keystatus { 529 ZFS_KEYSTATUS_NONE = 0, 530 ZFS_KEYSTATUS_UNAVAILABLE, 531 ZFS_KEYSTATUS_AVAILABLE, 532 } zfs_keystatus_t; 533 534 typedef enum zfs_keyformat { 535 ZFS_KEYFORMAT_NONE = 0, 536 ZFS_KEYFORMAT_RAW, 537 ZFS_KEYFORMAT_HEX, 538 ZFS_KEYFORMAT_PASSPHRASE, 539 ZFS_KEYFORMAT_FORMATS 540 } zfs_keyformat_t; 541 542 typedef enum zfs_key_location { 543 ZFS_KEYLOCATION_NONE = 0, 544 ZFS_KEYLOCATION_PROMPT, 545 ZFS_KEYLOCATION_URI, 546 ZFS_KEYLOCATION_LOCATIONS 547 } zfs_keylocation_t; 548 549 typedef enum { 550 ZFS_PREFETCH_NONE = 0, 551 ZFS_PREFETCH_METADATA = 1, 552 ZFS_PREFETCH_ALL = 2 553 } zfs_prefetch_type_t; 554 555 #define DEFAULT_PBKDF2_ITERATIONS 350000 556 #define MIN_PBKDF2_ITERATIONS 100000 557 558 /* 559 * On-disk version number. 560 */ 561 #define SPA_VERSION_1 1ULL 562 #define SPA_VERSION_2 2ULL 563 #define SPA_VERSION_3 3ULL 564 #define SPA_VERSION_4 4ULL 565 #define SPA_VERSION_5 5ULL 566 #define SPA_VERSION_6 6ULL 567 #define SPA_VERSION_7 7ULL 568 #define SPA_VERSION_8 8ULL 569 #define SPA_VERSION_9 9ULL 570 #define SPA_VERSION_10 10ULL 571 #define SPA_VERSION_11 11ULL 572 #define SPA_VERSION_12 12ULL 573 #define SPA_VERSION_13 13ULL 574 #define SPA_VERSION_14 14ULL 575 #define SPA_VERSION_15 15ULL 576 #define SPA_VERSION_16 16ULL 577 #define SPA_VERSION_17 17ULL 578 #define SPA_VERSION_18 18ULL 579 #define SPA_VERSION_19 19ULL 580 #define SPA_VERSION_20 20ULL 581 #define SPA_VERSION_21 21ULL 582 #define SPA_VERSION_22 22ULL 583 #define SPA_VERSION_23 23ULL 584 #define SPA_VERSION_24 24ULL 585 #define SPA_VERSION_25 25ULL 586 #define SPA_VERSION_26 26ULL 587 #define SPA_VERSION_27 27ULL 588 #define SPA_VERSION_28 28ULL 589 #define SPA_VERSION_5000 5000ULL 590 591 /* 592 * The incrementing pool version number has been replaced by pool feature 593 * flags. For more details, see zfeature.c. 594 */ 595 #define SPA_VERSION SPA_VERSION_5000 596 #define SPA_VERSION_STRING "5000" 597 598 /* 599 * Symbolic names for the changes that caused a SPA_VERSION switch. 600 * Used in the code when checking for presence or absence of a feature. 601 * Feel free to define multiple symbolic names for each version if there 602 * were multiple changes to on-disk structures during that version. 603 * 604 * NOTE: When checking the current SPA_VERSION in your code, be sure 605 * to use spa_version() since it reports the version of the 606 * last synced uberblock. Checking the in-flight version can 607 * be dangerous in some cases. 608 */ 609 #define SPA_VERSION_INITIAL SPA_VERSION_1 610 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 611 #define SPA_VERSION_SPARES SPA_VERSION_3 612 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 613 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 614 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 615 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 616 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 617 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 618 #define SPA_VERSION_BOOTFS SPA_VERSION_6 619 #define SPA_VERSION_SLOGS SPA_VERSION_7 620 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 621 #define SPA_VERSION_FUID SPA_VERSION_9 622 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 623 #define SPA_VERSION_REFQUOTA SPA_VERSION_9 624 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 625 #define SPA_VERSION_L2CACHE SPA_VERSION_10 626 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 627 #define SPA_VERSION_ORIGIN SPA_VERSION_11 628 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 629 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 630 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 631 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 632 #define SPA_VERSION_USERSPACE SPA_VERSION_15 633 #define SPA_VERSION_STMF_PROP SPA_VERSION_16 634 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 635 #define SPA_VERSION_USERREFS SPA_VERSION_18 636 #define SPA_VERSION_HOLES SPA_VERSION_19 637 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 638 #define SPA_VERSION_DEDUP SPA_VERSION_21 639 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 640 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 641 #define SPA_VERSION_SA SPA_VERSION_24 642 #define SPA_VERSION_SCAN SPA_VERSION_25 643 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 644 #define SPA_VERSION_DEADLISTS SPA_VERSION_26 645 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 646 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 647 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 648 #define SPA_VERSION_FEATURES SPA_VERSION_5000 649 650 #define SPA_VERSION_IS_SUPPORTED(v) \ 651 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 652 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 653 654 /* 655 * ZPL version - rev'd whenever an incompatible on-disk format change 656 * occurs. This is independent of SPA/DMU/ZAP versioning. You must 657 * also update the version_table[] and help message in zfs_prop.c. 658 */ 659 #define ZPL_VERSION_1 1ULL 660 #define ZPL_VERSION_2 2ULL 661 #define ZPL_VERSION_3 3ULL 662 #define ZPL_VERSION_4 4ULL 663 #define ZPL_VERSION_5 5ULL 664 #define ZPL_VERSION ZPL_VERSION_5 665 #define ZPL_VERSION_STRING "5" 666 667 #define ZPL_VERSION_INITIAL ZPL_VERSION_1 668 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 669 #define ZPL_VERSION_FUID ZPL_VERSION_3 670 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 671 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 672 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 673 #define ZPL_VERSION_SA ZPL_VERSION_5 674 675 /* Persistent L2ARC version */ 676 #define L2ARC_PERSISTENT_VERSION_1 1ULL 677 #define L2ARC_PERSISTENT_VERSION L2ARC_PERSISTENT_VERSION_1 678 #define L2ARC_PERSISTENT_VERSION_STRING "1" 679 680 /* Rewind policy information */ 681 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 682 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 683 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 684 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 685 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 686 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 687 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 688 689 typedef struct zpool_load_policy { 690 uint32_t zlp_rewind; /* rewind policy requested */ 691 uint64_t zlp_maxmeta; /* max acceptable meta-data errors */ 692 uint64_t zlp_maxdata; /* max acceptable data errors */ 693 uint64_t zlp_txg; /* specific txg to load */ 694 } zpool_load_policy_t; 695 696 /* 697 * The following are configuration names used in the nvlist describing a pool's 698 * configuration. New on-disk names should be prefixed with "<reversed-DNS>:" 699 * (e.g. "org.openzfs:") to avoid conflicting names being developed 700 * independently. 701 */ 702 #define ZPOOL_CONFIG_VERSION "version" 703 #define ZPOOL_CONFIG_POOL_NAME "name" 704 #define ZPOOL_CONFIG_POOL_STATE "state" 705 #define ZPOOL_CONFIG_POOL_TXG "txg" 706 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 707 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 708 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 709 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 710 #define ZPOOL_CONFIG_TYPE "type" 711 #define ZPOOL_CONFIG_CHILDREN "children" 712 #define ZPOOL_CONFIG_ID "id" 713 #define ZPOOL_CONFIG_GUID "guid" 714 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object" 715 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births" 716 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev" 717 #define ZPOOL_CONFIG_PATH "path" 718 #define ZPOOL_CONFIG_DEVID "devid" 719 #define ZPOOL_CONFIG_SPARE_ID "spareid" 720 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 721 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 722 #define ZPOOL_CONFIG_ASHIFT "ashift" 723 #define ZPOOL_CONFIG_ASIZE "asize" 724 #define ZPOOL_CONFIG_DTL "DTL" 725 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 726 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */ 727 #define ZPOOL_CONFIG_CHECKPOINT_STATS "checkpoint_stats" /* not on disk */ 728 #define ZPOOL_CONFIG_RAIDZ_EXPAND_STATS "raidz_expand_stats" /* not on disk */ 729 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 730 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */ 731 732 /* container nvlist of extended stats */ 733 #define ZPOOL_CONFIG_VDEV_STATS_EX "vdev_stats_ex" 734 735 /* Active queue read/write stats */ 736 #define ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE "vdev_sync_r_active_queue" 737 #define ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE "vdev_sync_w_active_queue" 738 #define ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE "vdev_async_r_active_queue" 739 #define ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE "vdev_async_w_active_queue" 740 #define ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE "vdev_async_scrub_active_queue" 741 #define ZPOOL_CONFIG_VDEV_TRIM_ACTIVE_QUEUE "vdev_async_trim_active_queue" 742 #define ZPOOL_CONFIG_VDEV_REBUILD_ACTIVE_QUEUE "vdev_rebuild_active_queue" 743 744 /* Queue sizes */ 745 #define ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE "vdev_sync_r_pend_queue" 746 #define ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE "vdev_sync_w_pend_queue" 747 #define ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE "vdev_async_r_pend_queue" 748 #define ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE "vdev_async_w_pend_queue" 749 #define ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE "vdev_async_scrub_pend_queue" 750 #define ZPOOL_CONFIG_VDEV_TRIM_PEND_QUEUE "vdev_async_trim_pend_queue" 751 #define ZPOOL_CONFIG_VDEV_REBUILD_PEND_QUEUE "vdev_rebuild_pend_queue" 752 753 /* Latency read/write histogram stats */ 754 #define ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO "vdev_tot_r_lat_histo" 755 #define ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO "vdev_tot_w_lat_histo" 756 #define ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO "vdev_disk_r_lat_histo" 757 #define ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO "vdev_disk_w_lat_histo" 758 #define ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO "vdev_sync_r_lat_histo" 759 #define ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO "vdev_sync_w_lat_histo" 760 #define ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO "vdev_async_r_lat_histo" 761 #define ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO "vdev_async_w_lat_histo" 762 #define ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO "vdev_scrub_histo" 763 #define ZPOOL_CONFIG_VDEV_TRIM_LAT_HISTO "vdev_trim_histo" 764 #define ZPOOL_CONFIG_VDEV_REBUILD_LAT_HISTO "vdev_rebuild_histo" 765 766 /* Request size histograms */ 767 #define ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO "vdev_sync_ind_r_histo" 768 #define ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO "vdev_sync_ind_w_histo" 769 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO "vdev_async_ind_r_histo" 770 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO "vdev_async_ind_w_histo" 771 #define ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO "vdev_ind_scrub_histo" 772 #define ZPOOL_CONFIG_VDEV_IND_TRIM_HISTO "vdev_ind_trim_histo" 773 #define ZPOOL_CONFIG_VDEV_IND_REBUILD_HISTO "vdev_ind_rebuild_histo" 774 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO "vdev_sync_agg_r_histo" 775 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO "vdev_sync_agg_w_histo" 776 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO "vdev_async_agg_r_histo" 777 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO "vdev_async_agg_w_histo" 778 #define ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO "vdev_agg_scrub_histo" 779 #define ZPOOL_CONFIG_VDEV_AGG_TRIM_HISTO "vdev_agg_trim_histo" 780 #define ZPOOL_CONFIG_VDEV_AGG_REBUILD_HISTO "vdev_agg_rebuild_histo" 781 782 /* Number of slow IOs */ 783 #define ZPOOL_CONFIG_VDEV_SLOW_IOS "vdev_slow_ios" 784 785 /* vdev enclosure sysfs path */ 786 #define ZPOOL_CONFIG_VDEV_ENC_SYSFS_PATH "vdev_enc_sysfs_path" 787 788 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 789 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 790 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 791 #define ZPOOL_CONFIG_SPARES "spares" 792 #define ZPOOL_CONFIG_IS_SPARE "is_spare" 793 #define ZPOOL_CONFIG_NPARITY "nparity" 794 #define ZPOOL_CONFIG_RAIDZ_EXPANDING "raidz_expanding" 795 #define ZPOOL_CONFIG_RAIDZ_EXPAND_TXGS "raidz_expand_txgs" 796 #define ZPOOL_CONFIG_HOSTID "hostid" 797 #define ZPOOL_CONFIG_HOSTNAME "hostname" 798 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 799 #define ZPOOL_CONFIG_UNSPARE "unspare" 800 #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 801 #define ZPOOL_CONFIG_IS_LOG "is_log" 802 #define ZPOOL_CONFIG_L2CACHE "l2cache" 803 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 804 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 805 #define ZPOOL_CONFIG_IS_HOLE "is_hole" 806 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 807 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 808 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 809 #define ZPOOL_CONFIG_SPLIT "splitcfg" 810 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 811 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 812 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 813 #define ZPOOL_CONFIG_NONALLOCATING "non_allocating" 814 #define ZPOOL_CONFIG_REMOVING "removing" 815 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg" 816 #define ZPOOL_CONFIG_REBUILD_TXG "rebuild_txg" 817 #define ZPOOL_CONFIG_COMMENT "comment" 818 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 819 #define ZPOOL_CONFIG_SUSPENDED_REASON "suspended_reason" /* not stored */ 820 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 821 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 822 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 823 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 824 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */ 825 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */ 826 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */ 827 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */ 828 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 829 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */ 830 #define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */ 831 #define ZPOOL_CONFIG_VDEV_ROOT_ZAP "com.klarasystems:vdev_zap_root" 832 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top" 833 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf" 834 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps" 835 #define ZPOOL_CONFIG_RESILVER_DEFER "com.datto:resilver_defer" 836 #define ZPOOL_CONFIG_CACHEFILE "cachefile" /* not stored on disk */ 837 #define ZPOOL_CONFIG_MMP_STATE "mmp_state" /* not stored on disk */ 838 #define ZPOOL_CONFIG_MMP_TXG "mmp_txg" /* not stored on disk */ 839 #define ZPOOL_CONFIG_MMP_SEQ "mmp_seq" /* not stored on disk */ 840 #define ZPOOL_CONFIG_MMP_HOSTNAME "mmp_hostname" /* not stored on disk */ 841 #define ZPOOL_CONFIG_MMP_HOSTID "mmp_hostid" /* not stored on disk */ 842 #define ZPOOL_CONFIG_ALLOCATION_BIAS "alloc_bias" /* not stored on disk */ 843 #define ZPOOL_CONFIG_EXPANSION_TIME "expansion_time" /* not stored */ 844 #define ZPOOL_CONFIG_REBUILD_STATS "org.openzfs:rebuild_stats" 845 #define ZPOOL_CONFIG_COMPATIBILITY "compatibility" 846 847 /* 848 * The persistent vdev state is stored as separate values rather than a single 849 * 'vdev_state' entry. This is because a device can be in multiple states, such 850 * as offline and degraded. 851 */ 852 #define ZPOOL_CONFIG_OFFLINE "offline" 853 #define ZPOOL_CONFIG_FAULTED "faulted" 854 #define ZPOOL_CONFIG_DEGRADED "degraded" 855 #define ZPOOL_CONFIG_REMOVED "removed" 856 #define ZPOOL_CONFIG_FRU "fru" 857 #define ZPOOL_CONFIG_AUX_STATE "aux_state" 858 859 /* Pool load policy parameters */ 860 #define ZPOOL_LOAD_POLICY "load-policy" 861 #define ZPOOL_LOAD_REWIND_POLICY "load-rewind-policy" 862 #define ZPOOL_LOAD_REQUEST_TXG "load-request-txg" 863 #define ZPOOL_LOAD_META_THRESH "load-meta-thresh" 864 #define ZPOOL_LOAD_DATA_THRESH "load-data-thresh" 865 866 /* Rewind data discovered */ 867 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 868 #define ZPOOL_CONFIG_LOAD_META_ERRORS "verify_meta_errors" 869 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 870 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 871 872 /* dRAID configuration */ 873 #define ZPOOL_CONFIG_DRAID_NDATA "draid_ndata" 874 #define ZPOOL_CONFIG_DRAID_NSPARES "draid_nspares" 875 #define ZPOOL_CONFIG_DRAID_NGROUPS "draid_ngroups" 876 877 #define VDEV_TYPE_ROOT "root" 878 #define VDEV_TYPE_MIRROR "mirror" 879 #define VDEV_TYPE_REPLACING "replacing" 880 #define VDEV_TYPE_RAIDZ "raidz" 881 #define VDEV_TYPE_DRAID "draid" 882 #define VDEV_TYPE_DRAID_SPARE "dspare" 883 #define VDEV_TYPE_DISK "disk" 884 #define VDEV_TYPE_FILE "file" 885 #define VDEV_TYPE_MISSING "missing" 886 #define VDEV_TYPE_HOLE "hole" 887 #define VDEV_TYPE_SPARE "spare" 888 #define VDEV_TYPE_LOG "log" 889 #define VDEV_TYPE_L2CACHE "l2cache" 890 #define VDEV_TYPE_INDIRECT "indirect" 891 892 #define VDEV_RAIDZ_MAXPARITY 3 893 894 #define VDEV_DRAID_MAXPARITY 3 895 #define VDEV_DRAID_MIN_CHILDREN 2 896 #define VDEV_DRAID_MAX_CHILDREN UINT8_MAX 897 898 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */ 899 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \ 900 "com.delphix:indirect_obsolete_sm" 901 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \ 902 "com.delphix:obsolete_counts_are_precise" 903 #define VDEV_TOP_ZAP_POOL_CHECKPOINT_SM \ 904 "com.delphix:pool_checkpoint_sm" 905 #define VDEV_TOP_ZAP_MS_UNFLUSHED_PHYS_TXGS \ 906 "com.delphix:ms_unflushed_phys_txgs" 907 908 #define VDEV_TOP_ZAP_VDEV_REBUILD_PHYS \ 909 "org.openzfs:vdev_rebuild" 910 911 #define VDEV_TOP_ZAP_ALLOCATION_BIAS \ 912 "org.zfsonlinux:allocation_bias" 913 914 #define VDEV_TOP_ZAP_RAIDZ_EXPAND_STATE \ 915 "org.openzfs:raidz_expand_state" 916 #define VDEV_TOP_ZAP_RAIDZ_EXPAND_START_TIME \ 917 "org.openzfs:raidz_expand_start_time" 918 #define VDEV_TOP_ZAP_RAIDZ_EXPAND_END_TIME \ 919 "org.openzfs:raidz_expand_end_time" 920 #define VDEV_TOP_ZAP_RAIDZ_EXPAND_BYTES_COPIED \ 921 "org.openzfs:raidz_expand_bytes_copied" 922 923 /* vdev metaslab allocation bias */ 924 #define VDEV_ALLOC_BIAS_LOG "log" 925 #define VDEV_ALLOC_BIAS_SPECIAL "special" 926 #define VDEV_ALLOC_BIAS_DEDUP "dedup" 927 928 /* vdev initialize state */ 929 #define VDEV_LEAF_ZAP_INITIALIZE_LAST_OFFSET \ 930 "com.delphix:next_offset_to_initialize" 931 #define VDEV_LEAF_ZAP_INITIALIZE_STATE \ 932 "com.delphix:vdev_initialize_state" 933 #define VDEV_LEAF_ZAP_INITIALIZE_ACTION_TIME \ 934 "com.delphix:vdev_initialize_action_time" 935 936 /* vdev TRIM state */ 937 #define VDEV_LEAF_ZAP_TRIM_LAST_OFFSET \ 938 "org.zfsonlinux:next_offset_to_trim" 939 #define VDEV_LEAF_ZAP_TRIM_STATE \ 940 "org.zfsonlinux:vdev_trim_state" 941 #define VDEV_LEAF_ZAP_TRIM_ACTION_TIME \ 942 "org.zfsonlinux:vdev_trim_action_time" 943 #define VDEV_LEAF_ZAP_TRIM_RATE \ 944 "org.zfsonlinux:vdev_trim_rate" 945 #define VDEV_LEAF_ZAP_TRIM_PARTIAL \ 946 "org.zfsonlinux:vdev_trim_partial" 947 #define VDEV_LEAF_ZAP_TRIM_SECURE \ 948 "org.zfsonlinux:vdev_trim_secure" 949 950 /* 951 * This is needed in userland to report the minimum necessary device size. 952 */ 953 #define SPA_MINDEVSIZE (64ULL << 20) 954 955 /* 956 * Set if the fragmentation has not yet been calculated. This can happen 957 * because the space maps have not been upgraded or the histogram feature 958 * is not enabled. 959 */ 960 #define ZFS_FRAG_INVALID UINT64_MAX 961 962 /* 963 * The location of the pool configuration repository, shared between kernel and 964 * userland. 965 */ 966 #define ZPOOL_CACHE_BOOT "/boot/zfs/zpool.cache" 967 #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 968 /* 969 * Settings for zpool compatibility features files 970 */ 971 #define ZPOOL_SYSCONF_COMPAT_D SYSCONFDIR "/zfs/compatibility.d" 972 #define ZPOOL_DATA_COMPAT_D PKGDATADIR "/compatibility.d" 973 #define ZPOOL_COMPAT_MAXSIZE 16384 974 975 /* 976 * Hard-wired compatibility settings 977 */ 978 #define ZPOOL_COMPAT_LEGACY "legacy" 979 #define ZPOOL_COMPAT_OFF "off" 980 981 /* 982 * vdev states are ordered from least to most healthy. 983 * A vdev that's CANT_OPEN or below is considered unusable. 984 */ 985 typedef enum vdev_state { 986 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 987 VDEV_STATE_CLOSED, /* Not currently open */ 988 VDEV_STATE_OFFLINE, /* Not allowed to open */ 989 VDEV_STATE_REMOVED, /* Explicitly removed from system */ 990 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 991 VDEV_STATE_FAULTED, /* External request to fault device */ 992 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 993 VDEV_STATE_HEALTHY /* Presumed good */ 994 } vdev_state_t; 995 996 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 997 998 /* 999 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 1000 * of the vdev stats structure uses these constants to distinguish why. 1001 */ 1002 typedef enum vdev_aux { 1003 VDEV_AUX_NONE, /* no error */ 1004 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 1005 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 1006 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 1007 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 1008 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 1009 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 1010 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 1011 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 1012 VDEV_AUX_UNSUP_FEAT, /* unsupported features */ 1013 VDEV_AUX_SPARED, /* hot spare used in another pool */ 1014 VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 1015 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 1016 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 1017 VDEV_AUX_EXTERNAL, /* external diagnosis or forced fault */ 1018 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */ 1019 VDEV_AUX_BAD_ASHIFT, /* vdev ashift is invalid */ 1020 VDEV_AUX_EXTERNAL_PERSIST, /* persistent forced fault */ 1021 VDEV_AUX_ACTIVE, /* vdev active on a different host */ 1022 VDEV_AUX_CHILDREN_OFFLINE, /* all children are offline */ 1023 VDEV_AUX_ASHIFT_TOO_BIG, /* vdev's min block size is too large */ 1024 } vdev_aux_t; 1025 1026 /* 1027 * pool state. The following states are written to disk as part of the normal 1028 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 1029 * states are software abstractions used at various levels to communicate 1030 * pool state. 1031 */ 1032 typedef enum pool_state { 1033 POOL_STATE_ACTIVE = 0, /* In active use */ 1034 POOL_STATE_EXPORTED, /* Explicitly exported */ 1035 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 1036 POOL_STATE_SPARE, /* Reserved for hot spare use */ 1037 POOL_STATE_L2CACHE, /* Level 2 ARC device */ 1038 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 1039 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 1040 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 1041 } pool_state_t; 1042 1043 /* 1044 * mmp state. The following states provide additional detail describing 1045 * why a pool couldn't be safely imported. 1046 */ 1047 typedef enum mmp_state { 1048 MMP_STATE_ACTIVE = 0, /* In active use */ 1049 MMP_STATE_INACTIVE, /* Inactive and safe to import */ 1050 MMP_STATE_NO_HOSTID /* System hostid is not set */ 1051 } mmp_state_t; 1052 1053 /* 1054 * Scan Functions. 1055 */ 1056 typedef enum pool_scan_func { 1057 POOL_SCAN_NONE, 1058 POOL_SCAN_SCRUB, 1059 POOL_SCAN_RESILVER, 1060 POOL_SCAN_ERRORSCRUB, 1061 POOL_SCAN_FUNCS 1062 } pool_scan_func_t; 1063 1064 /* 1065 * Used to control scrub pause and resume. 1066 */ 1067 typedef enum pool_scrub_cmd { 1068 POOL_SCRUB_NORMAL = 0, 1069 POOL_SCRUB_PAUSE, 1070 POOL_SCRUB_FLAGS_END 1071 } pool_scrub_cmd_t; 1072 1073 typedef enum { 1074 CS_NONE, 1075 CS_CHECKPOINT_EXISTS, 1076 CS_CHECKPOINT_DISCARDING, 1077 CS_NUM_STATES 1078 } checkpoint_state_t; 1079 1080 typedef struct pool_checkpoint_stat { 1081 uint64_t pcs_state; /* checkpoint_state_t */ 1082 uint64_t pcs_start_time; /* time checkpoint/discard started */ 1083 uint64_t pcs_space; /* checkpointed space */ 1084 } pool_checkpoint_stat_t; 1085 1086 /* 1087 * ZIO types. Needed to interpret vdev statistics below. 1088 */ 1089 typedef enum zio_type { 1090 ZIO_TYPE_NULL = 0, 1091 ZIO_TYPE_READ, 1092 ZIO_TYPE_WRITE, 1093 ZIO_TYPE_FREE, 1094 ZIO_TYPE_CLAIM, 1095 ZIO_TYPE_IOCTL, 1096 ZIO_TYPE_TRIM, 1097 ZIO_TYPES 1098 } zio_type_t; 1099 1100 /* 1101 * Pool statistics. Note: all fields should be 64-bit because this 1102 * is passed between kernel and userland as an nvlist uint64 array. 1103 */ 1104 typedef struct pool_scan_stat { 1105 /* values stored on disk */ 1106 uint64_t pss_func; /* pool_scan_func_t */ 1107 uint64_t pss_state; /* dsl_scan_state_t */ 1108 uint64_t pss_start_time; /* scan start time */ 1109 uint64_t pss_end_time; /* scan end time */ 1110 uint64_t pss_to_examine; /* total bytes to scan */ 1111 uint64_t pss_examined; /* total bytes located by scanner */ 1112 uint64_t pss_skipped; /* total bytes skipped by scanner */ 1113 uint64_t pss_processed; /* total processed bytes */ 1114 uint64_t pss_errors; /* scan errors */ 1115 1116 /* values not stored on disk */ 1117 uint64_t pss_pass_exam; /* examined bytes per scan pass */ 1118 uint64_t pss_pass_start; /* start time of a scan pass */ 1119 uint64_t pss_pass_scrub_pause; /* pause time of a scrub pass */ 1120 /* cumulative time scrub spent paused, needed for rate calculation */ 1121 uint64_t pss_pass_scrub_spent_paused; 1122 uint64_t pss_pass_issued; /* issued bytes per scan pass */ 1123 uint64_t pss_issued; /* total bytes checked by scanner */ 1124 1125 /* error scrub values stored on disk */ 1126 uint64_t pss_error_scrub_func; /* pool_scan_func_t */ 1127 uint64_t pss_error_scrub_state; /* dsl_scan_state_t */ 1128 uint64_t pss_error_scrub_start; /* error scrub start time */ 1129 uint64_t pss_error_scrub_end; /* error scrub end time */ 1130 uint64_t pss_error_scrub_examined; /* error blocks issued I/O */ 1131 /* error blocks to be issued I/O */ 1132 uint64_t pss_error_scrub_to_be_examined; 1133 1134 /* error scrub values not stored on disk */ 1135 /* error scrub pause time in milliseconds */ 1136 uint64_t pss_pass_error_scrub_pause; 1137 1138 } pool_scan_stat_t; 1139 1140 typedef struct pool_removal_stat { 1141 uint64_t prs_state; /* dsl_scan_state_t */ 1142 uint64_t prs_removing_vdev; 1143 uint64_t prs_start_time; 1144 uint64_t prs_end_time; 1145 uint64_t prs_to_copy; /* bytes that need to be copied */ 1146 uint64_t prs_copied; /* bytes copied so far */ 1147 /* 1148 * bytes of memory used for indirect mappings. 1149 * This includes all removed vdevs. 1150 */ 1151 uint64_t prs_mapping_memory; 1152 } pool_removal_stat_t; 1153 1154 typedef struct pool_raidz_expand_stat { 1155 uint64_t pres_state; /* dsl_scan_state_t */ 1156 uint64_t pres_expanding_vdev; 1157 uint64_t pres_start_time; 1158 uint64_t pres_end_time; 1159 uint64_t pres_to_reflow; /* bytes that need to be moved */ 1160 uint64_t pres_reflowed; /* bytes moved so far */ 1161 uint64_t pres_waiting_for_resilver; 1162 } pool_raidz_expand_stat_t; 1163 1164 typedef enum dsl_scan_state { 1165 DSS_NONE, 1166 DSS_SCANNING, 1167 DSS_FINISHED, 1168 DSS_CANCELED, 1169 DSS_ERRORSCRUBBING, 1170 DSS_NUM_STATES 1171 } dsl_scan_state_t; 1172 1173 typedef struct vdev_rebuild_stat { 1174 uint64_t vrs_state; /* vdev_rebuild_state_t */ 1175 uint64_t vrs_start_time; /* time_t */ 1176 uint64_t vrs_end_time; /* time_t */ 1177 uint64_t vrs_scan_time_ms; /* total run time (millisecs) */ 1178 uint64_t vrs_bytes_scanned; /* allocated bytes scanned */ 1179 uint64_t vrs_bytes_issued; /* read bytes issued */ 1180 uint64_t vrs_bytes_rebuilt; /* rebuilt bytes */ 1181 uint64_t vrs_bytes_est; /* total bytes to scan */ 1182 uint64_t vrs_errors; /* scanning errors */ 1183 uint64_t vrs_pass_time_ms; /* pass run time (millisecs) */ 1184 uint64_t vrs_pass_bytes_scanned; /* bytes scanned since start/resume */ 1185 uint64_t vrs_pass_bytes_issued; /* bytes rebuilt since start/resume */ 1186 uint64_t vrs_pass_bytes_skipped; /* bytes skipped since start/resume */ 1187 } vdev_rebuild_stat_t; 1188 1189 /* 1190 * Errata described by https://openzfs.github.io/openzfs-docs/msg/ZFS-8000-ER. 1191 * The ordering of this enum must be maintained to ensure the errata identifiers 1192 * map to the correct documentation. New errata may only be appended to the 1193 * list and must contain corresponding documentation at the above link. 1194 */ 1195 typedef enum zpool_errata { 1196 ZPOOL_ERRATA_NONE, 1197 ZPOOL_ERRATA_ZOL_2094_SCRUB, 1198 ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY, 1199 ZPOOL_ERRATA_ZOL_6845_ENCRYPTION, 1200 ZPOOL_ERRATA_ZOL_8308_ENCRYPTION, 1201 } zpool_errata_t; 1202 1203 /* 1204 * Vdev statistics. Note: all fields should be 64-bit because this 1205 * is passed between kernel and user land as an nvlist uint64 array. 1206 * 1207 * The vs_ops[] and vs_bytes[] arrays must always be an array size of 6 in 1208 * order to keep subsequent members at their known fixed offsets. When 1209 * adding a new field it must be added to the end the structure. 1210 */ 1211 #define VS_ZIO_TYPES 6 1212 1213 typedef struct vdev_stat { 1214 hrtime_t vs_timestamp; /* time since vdev load */ 1215 uint64_t vs_state; /* vdev state */ 1216 uint64_t vs_aux; /* see vdev_aux_t */ 1217 uint64_t vs_alloc; /* space allocated */ 1218 uint64_t vs_space; /* total capacity */ 1219 uint64_t vs_dspace; /* deflated capacity */ 1220 uint64_t vs_rsize; /* replaceable dev size */ 1221 uint64_t vs_esize; /* expandable dev size */ 1222 uint64_t vs_ops[VS_ZIO_TYPES]; /* operation count */ 1223 uint64_t vs_bytes[VS_ZIO_TYPES]; /* bytes read/written */ 1224 uint64_t vs_read_errors; /* read errors */ 1225 uint64_t vs_write_errors; /* write errors */ 1226 uint64_t vs_checksum_errors; /* checksum errors */ 1227 uint64_t vs_initialize_errors; /* initializing errors */ 1228 uint64_t vs_self_healed; /* self-healed bytes */ 1229 uint64_t vs_scan_removing; /* removing? */ 1230 uint64_t vs_scan_processed; /* scan processed bytes */ 1231 uint64_t vs_fragmentation; /* device fragmentation */ 1232 uint64_t vs_initialize_bytes_done; /* bytes initialized */ 1233 uint64_t vs_initialize_bytes_est; /* total bytes to initialize */ 1234 uint64_t vs_initialize_state; /* vdev_initializing_state_t */ 1235 uint64_t vs_initialize_action_time; /* time_t */ 1236 uint64_t vs_checkpoint_space; /* checkpoint-consumed space */ 1237 uint64_t vs_resilver_deferred; /* resilver deferred */ 1238 uint64_t vs_slow_ios; /* slow IOs */ 1239 uint64_t vs_trim_errors; /* trimming errors */ 1240 uint64_t vs_trim_notsup; /* supported by device */ 1241 uint64_t vs_trim_bytes_done; /* bytes trimmed */ 1242 uint64_t vs_trim_bytes_est; /* total bytes to trim */ 1243 uint64_t vs_trim_state; /* vdev_trim_state_t */ 1244 uint64_t vs_trim_action_time; /* time_t */ 1245 uint64_t vs_rebuild_processed; /* bytes rebuilt */ 1246 uint64_t vs_configured_ashift; /* TLV vdev_ashift */ 1247 uint64_t vs_logical_ashift; /* vdev_logical_ashift */ 1248 uint64_t vs_physical_ashift; /* vdev_physical_ashift */ 1249 uint64_t vs_noalloc; /* allocations halted? */ 1250 uint64_t vs_pspace; /* physical capacity */ 1251 } vdev_stat_t; 1252 1253 #define VDEV_STAT_VALID(field, uint64_t_field_count) \ 1254 ((uint64_t_field_count * sizeof (uint64_t)) >= \ 1255 (offsetof(vdev_stat_t, field) + sizeof (((vdev_stat_t *)NULL)->field))) 1256 1257 /* 1258 * Extended stats 1259 * 1260 * These are stats which aren't included in the original iostat output. For 1261 * convenience, they are grouped together in vdev_stat_ex, although each stat 1262 * is individually exported as an nvlist. 1263 */ 1264 typedef struct vdev_stat_ex { 1265 /* Number of ZIOs issued to disk and waiting to finish */ 1266 uint64_t vsx_active_queue[ZIO_PRIORITY_NUM_QUEUEABLE]; 1267 1268 /* Number of ZIOs pending to be issued to disk */ 1269 uint64_t vsx_pend_queue[ZIO_PRIORITY_NUM_QUEUEABLE]; 1270 1271 /* 1272 * Below are the histograms for various latencies. Buckets are in 1273 * units of nanoseconds. 1274 */ 1275 1276 /* 1277 * 2^37 nanoseconds = 134s. Timeouts will probably start kicking in 1278 * before this. 1279 */ 1280 #define VDEV_L_HISTO_BUCKETS 37 /* Latency histo buckets */ 1281 #define VDEV_RQ_HISTO_BUCKETS 25 /* Request size histo buckets */ 1282 1283 /* Amount of time in ZIO queue (ns) */ 1284 uint64_t vsx_queue_histo[ZIO_PRIORITY_NUM_QUEUEABLE] 1285 [VDEV_L_HISTO_BUCKETS]; 1286 1287 /* Total ZIO latency (ns). Includes queuing and disk access time */ 1288 uint64_t vsx_total_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS]; 1289 1290 /* Amount of time to read/write the disk (ns) */ 1291 uint64_t vsx_disk_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS]; 1292 1293 /* "lookup the bucket for a value" histogram macros */ 1294 #define HISTO(val, buckets) (val != 0 ? MIN(highbit64(val) - 1, \ 1295 buckets - 1) : 0) 1296 #define L_HISTO(a) HISTO(a, VDEV_L_HISTO_BUCKETS) 1297 #define RQ_HISTO(a) HISTO(a, VDEV_RQ_HISTO_BUCKETS) 1298 1299 /* Physical IO histogram */ 1300 uint64_t vsx_ind_histo[ZIO_PRIORITY_NUM_QUEUEABLE] 1301 [VDEV_RQ_HISTO_BUCKETS]; 1302 1303 /* Delegated (aggregated) physical IO histogram */ 1304 uint64_t vsx_agg_histo[ZIO_PRIORITY_NUM_QUEUEABLE] 1305 [VDEV_RQ_HISTO_BUCKETS]; 1306 1307 } vdev_stat_ex_t; 1308 1309 /* 1310 * Initialize functions. 1311 */ 1312 typedef enum pool_initialize_func { 1313 POOL_INITIALIZE_START, 1314 POOL_INITIALIZE_CANCEL, 1315 POOL_INITIALIZE_SUSPEND, 1316 POOL_INITIALIZE_UNINIT, 1317 POOL_INITIALIZE_FUNCS 1318 } pool_initialize_func_t; 1319 1320 /* 1321 * TRIM functions. 1322 */ 1323 typedef enum pool_trim_func { 1324 POOL_TRIM_START, 1325 POOL_TRIM_CANCEL, 1326 POOL_TRIM_SUSPEND, 1327 POOL_TRIM_FUNCS 1328 } pool_trim_func_t; 1329 1330 /* 1331 * DDT statistics. Note: all fields should be 64-bit because this 1332 * is passed between kernel and userland as an nvlist uint64 array. 1333 */ 1334 typedef struct ddt_object { 1335 uint64_t ddo_count; /* number of elements in ddt */ 1336 uint64_t ddo_dspace; /* size of ddt on disk */ 1337 uint64_t ddo_mspace; /* size of ddt in-core */ 1338 } ddt_object_t; 1339 1340 typedef struct ddt_stat { 1341 uint64_t dds_blocks; /* blocks */ 1342 uint64_t dds_lsize; /* logical size */ 1343 uint64_t dds_psize; /* physical size */ 1344 uint64_t dds_dsize; /* deflated allocated size */ 1345 uint64_t dds_ref_blocks; /* referenced blocks */ 1346 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 1347 uint64_t dds_ref_psize; /* referenced psize * refcnt */ 1348 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 1349 } ddt_stat_t; 1350 1351 typedef struct ddt_histogram { 1352 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 1353 } ddt_histogram_t; 1354 1355 #define ZVOL_DRIVER "zvol" 1356 #define ZFS_DRIVER "zfs" 1357 #define ZFS_DEV "/dev/zfs" 1358 #define ZFS_DEVDIR "/dev" 1359 1360 #define ZFS_SUPER_MAGIC 0x2fc12fc1 1361 1362 /* general zvol path */ 1363 #define ZVOL_DIR "/dev/zvol/" 1364 1365 #define ZVOL_MAJOR 230 1366 #define ZVOL_MINOR_BITS 4 1367 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1) 1368 #define ZVOL_MINORS (1 << 4) 1369 #define ZVOL_DEV_NAME "zd" 1370 1371 #define ZVOL_PROP_NAME "name" 1372 #define ZVOL_DEFAULT_BLOCKSIZE 16384 1373 1374 typedef enum { 1375 VDEV_INITIALIZE_NONE, 1376 VDEV_INITIALIZE_ACTIVE, 1377 VDEV_INITIALIZE_CANCELED, 1378 VDEV_INITIALIZE_SUSPENDED, 1379 VDEV_INITIALIZE_COMPLETE 1380 } vdev_initializing_state_t; 1381 1382 typedef enum { 1383 VDEV_TRIM_NONE, 1384 VDEV_TRIM_ACTIVE, 1385 VDEV_TRIM_CANCELED, 1386 VDEV_TRIM_SUSPENDED, 1387 VDEV_TRIM_COMPLETE, 1388 } vdev_trim_state_t; 1389 1390 typedef enum { 1391 VDEV_REBUILD_NONE, 1392 VDEV_REBUILD_ACTIVE, 1393 VDEV_REBUILD_CANCELED, 1394 VDEV_REBUILD_COMPLETE, 1395 } vdev_rebuild_state_t; 1396 1397 /* 1398 * nvlist name constants. Facilitate restricting snapshot iteration range for 1399 * the "list next snapshot" ioctl 1400 */ 1401 #define SNAP_ITER_MIN_TXG "snap_iter_min_txg" 1402 #define SNAP_ITER_MAX_TXG "snap_iter_max_txg" 1403 1404 /* 1405 * /dev/zfs ioctl numbers. 1406 * 1407 * These numbers cannot change over time. New ioctl numbers must be appended. 1408 */ 1409 typedef enum zfs_ioc { 1410 /* 1411 * Core features - 88/128 numbers reserved. 1412 */ 1413 #ifdef __FreeBSD__ 1414 ZFS_IOC_FIRST = 0, 1415 #else 1416 ZFS_IOC_FIRST = ('Z' << 8), 1417 #endif 1418 ZFS_IOC = ZFS_IOC_FIRST, 1419 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, /* 0x5a00 */ 1420 ZFS_IOC_POOL_DESTROY, /* 0x5a01 */ 1421 ZFS_IOC_POOL_IMPORT, /* 0x5a02 */ 1422 ZFS_IOC_POOL_EXPORT, /* 0x5a03 */ 1423 ZFS_IOC_POOL_CONFIGS, /* 0x5a04 */ 1424 ZFS_IOC_POOL_STATS, /* 0x5a05 */ 1425 ZFS_IOC_POOL_TRYIMPORT, /* 0x5a06 */ 1426 ZFS_IOC_POOL_SCAN, /* 0x5a07 */ 1427 ZFS_IOC_POOL_FREEZE, /* 0x5a08 */ 1428 ZFS_IOC_POOL_UPGRADE, /* 0x5a09 */ 1429 ZFS_IOC_POOL_GET_HISTORY, /* 0x5a0a */ 1430 ZFS_IOC_VDEV_ADD, /* 0x5a0b */ 1431 ZFS_IOC_VDEV_REMOVE, /* 0x5a0c */ 1432 ZFS_IOC_VDEV_SET_STATE, /* 0x5a0d */ 1433 ZFS_IOC_VDEV_ATTACH, /* 0x5a0e */ 1434 ZFS_IOC_VDEV_DETACH, /* 0x5a0f */ 1435 ZFS_IOC_VDEV_SETPATH, /* 0x5a10 */ 1436 ZFS_IOC_VDEV_SETFRU, /* 0x5a11 */ 1437 ZFS_IOC_OBJSET_STATS, /* 0x5a12 */ 1438 ZFS_IOC_OBJSET_ZPLPROPS, /* 0x5a13 */ 1439 ZFS_IOC_DATASET_LIST_NEXT, /* 0x5a14 */ 1440 ZFS_IOC_SNAPSHOT_LIST_NEXT, /* 0x5a15 */ 1441 ZFS_IOC_SET_PROP, /* 0x5a16 */ 1442 ZFS_IOC_CREATE, /* 0x5a17 */ 1443 ZFS_IOC_DESTROY, /* 0x5a18 */ 1444 ZFS_IOC_ROLLBACK, /* 0x5a19 */ 1445 ZFS_IOC_RENAME, /* 0x5a1a */ 1446 ZFS_IOC_RECV, /* 0x5a1b */ 1447 ZFS_IOC_SEND, /* 0x5a1c */ 1448 ZFS_IOC_INJECT_FAULT, /* 0x5a1d */ 1449 ZFS_IOC_CLEAR_FAULT, /* 0x5a1e */ 1450 ZFS_IOC_INJECT_LIST_NEXT, /* 0x5a1f */ 1451 ZFS_IOC_ERROR_LOG, /* 0x5a20 */ 1452 ZFS_IOC_CLEAR, /* 0x5a21 */ 1453 ZFS_IOC_PROMOTE, /* 0x5a22 */ 1454 ZFS_IOC_SNAPSHOT, /* 0x5a23 */ 1455 ZFS_IOC_DSOBJ_TO_DSNAME, /* 0x5a24 */ 1456 ZFS_IOC_OBJ_TO_PATH, /* 0x5a25 */ 1457 ZFS_IOC_POOL_SET_PROPS, /* 0x5a26 */ 1458 ZFS_IOC_POOL_GET_PROPS, /* 0x5a27 */ 1459 ZFS_IOC_SET_FSACL, /* 0x5a28 */ 1460 ZFS_IOC_GET_FSACL, /* 0x5a29 */ 1461 ZFS_IOC_SHARE, /* 0x5a2a */ 1462 ZFS_IOC_INHERIT_PROP, /* 0x5a2b */ 1463 ZFS_IOC_SMB_ACL, /* 0x5a2c */ 1464 ZFS_IOC_USERSPACE_ONE, /* 0x5a2d */ 1465 ZFS_IOC_USERSPACE_MANY, /* 0x5a2e */ 1466 ZFS_IOC_USERSPACE_UPGRADE, /* 0x5a2f */ 1467 ZFS_IOC_HOLD, /* 0x5a30 */ 1468 ZFS_IOC_RELEASE, /* 0x5a31 */ 1469 ZFS_IOC_GET_HOLDS, /* 0x5a32 */ 1470 ZFS_IOC_OBJSET_RECVD_PROPS, /* 0x5a33 */ 1471 ZFS_IOC_VDEV_SPLIT, /* 0x5a34 */ 1472 ZFS_IOC_NEXT_OBJ, /* 0x5a35 */ 1473 ZFS_IOC_DIFF, /* 0x5a36 */ 1474 ZFS_IOC_TMP_SNAPSHOT, /* 0x5a37 */ 1475 ZFS_IOC_OBJ_TO_STATS, /* 0x5a38 */ 1476 ZFS_IOC_SPACE_WRITTEN, /* 0x5a39 */ 1477 ZFS_IOC_SPACE_SNAPS, /* 0x5a3a */ 1478 ZFS_IOC_DESTROY_SNAPS, /* 0x5a3b */ 1479 ZFS_IOC_POOL_REGUID, /* 0x5a3c */ 1480 ZFS_IOC_POOL_REOPEN, /* 0x5a3d */ 1481 ZFS_IOC_SEND_PROGRESS, /* 0x5a3e */ 1482 ZFS_IOC_LOG_HISTORY, /* 0x5a3f */ 1483 ZFS_IOC_SEND_NEW, /* 0x5a40 */ 1484 ZFS_IOC_SEND_SPACE, /* 0x5a41 */ 1485 ZFS_IOC_CLONE, /* 0x5a42 */ 1486 ZFS_IOC_BOOKMARK, /* 0x5a43 */ 1487 ZFS_IOC_GET_BOOKMARKS, /* 0x5a44 */ 1488 ZFS_IOC_DESTROY_BOOKMARKS, /* 0x5a45 */ 1489 ZFS_IOC_RECV_NEW, /* 0x5a46 */ 1490 ZFS_IOC_POOL_SYNC, /* 0x5a47 */ 1491 ZFS_IOC_CHANNEL_PROGRAM, /* 0x5a48 */ 1492 ZFS_IOC_LOAD_KEY, /* 0x5a49 */ 1493 ZFS_IOC_UNLOAD_KEY, /* 0x5a4a */ 1494 ZFS_IOC_CHANGE_KEY, /* 0x5a4b */ 1495 ZFS_IOC_REMAP, /* 0x5a4c */ 1496 ZFS_IOC_POOL_CHECKPOINT, /* 0x5a4d */ 1497 ZFS_IOC_POOL_DISCARD_CHECKPOINT, /* 0x5a4e */ 1498 ZFS_IOC_POOL_INITIALIZE, /* 0x5a4f */ 1499 ZFS_IOC_POOL_TRIM, /* 0x5a50 */ 1500 ZFS_IOC_REDACT, /* 0x5a51 */ 1501 ZFS_IOC_GET_BOOKMARK_PROPS, /* 0x5a52 */ 1502 ZFS_IOC_WAIT, /* 0x5a53 */ 1503 ZFS_IOC_WAIT_FS, /* 0x5a54 */ 1504 ZFS_IOC_VDEV_GET_PROPS, /* 0x5a55 */ 1505 ZFS_IOC_VDEV_SET_PROPS, /* 0x5a56 */ 1506 ZFS_IOC_POOL_SCRUB, /* 0x5a57 */ 1507 1508 /* 1509 * Per-platform (Optional) - 8/128 numbers reserved. 1510 */ 1511 ZFS_IOC_PLATFORM = ZFS_IOC_FIRST + 0x80, 1512 ZFS_IOC_EVENTS_NEXT, /* 0x81 (Linux) */ 1513 ZFS_IOC_EVENTS_CLEAR, /* 0x82 (Linux) */ 1514 ZFS_IOC_EVENTS_SEEK, /* 0x83 (Linux) */ 1515 ZFS_IOC_NEXTBOOT, /* 0x84 (FreeBSD) */ 1516 ZFS_IOC_JAIL, /* 0x85 (FreeBSD) */ 1517 ZFS_IOC_USERNS_ATTACH = ZFS_IOC_JAIL, /* 0x85 (Linux) */ 1518 ZFS_IOC_UNJAIL, /* 0x86 (FreeBSD) */ 1519 ZFS_IOC_USERNS_DETACH = ZFS_IOC_UNJAIL, /* 0x86 (Linux) */ 1520 ZFS_IOC_SET_BOOTENV, /* 0x87 */ 1521 ZFS_IOC_GET_BOOTENV, /* 0x88 */ 1522 ZFS_IOC_LAST 1523 } zfs_ioc_t; 1524 1525 /* 1526 * zvol ioctl to get dataset name 1527 */ 1528 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAX_DATASET_NAME_LEN]) 1529 1530 #ifdef __linux__ 1531 1532 /* 1533 * IOCTLs to update and retrieve additional file level attributes on 1534 * Linux. 1535 */ 1536 #define ZFS_IOC_GETDOSFLAGS _IOR(0x83, 1, uint64_t) 1537 #define ZFS_IOC_SETDOSFLAGS _IOW(0x83, 2, uint64_t) 1538 1539 /* 1540 * Additional file level attributes, that are stored 1541 * in the upper half of z_pflags 1542 */ 1543 #define ZFS_READONLY 0x0000000100000000ull 1544 #define ZFS_HIDDEN 0x0000000200000000ull 1545 #define ZFS_SYSTEM 0x0000000400000000ull 1546 #define ZFS_ARCHIVE 0x0000000800000000ull 1547 #define ZFS_IMMUTABLE 0x0000001000000000ull 1548 #define ZFS_NOUNLINK 0x0000002000000000ull 1549 #define ZFS_APPENDONLY 0x0000004000000000ull 1550 #define ZFS_NODUMP 0x0000008000000000ull 1551 #define ZFS_OPAQUE 0x0000010000000000ull 1552 #define ZFS_AV_QUARANTINED 0x0000020000000000ull 1553 #define ZFS_AV_MODIFIED 0x0000040000000000ull 1554 #define ZFS_REPARSE 0x0000080000000000ull 1555 #define ZFS_OFFLINE 0x0000100000000000ull 1556 #define ZFS_SPARSE 0x0000200000000000ull 1557 1558 #define ZFS_DOS_FL_USER_VISIBLE (ZFS_IMMUTABLE | ZFS_APPENDONLY | \ 1559 ZFS_NOUNLINK | ZFS_ARCHIVE | ZFS_NODUMP | ZFS_SYSTEM | \ 1560 ZFS_HIDDEN | ZFS_READONLY | ZFS_REPARSE | ZFS_OFFLINE | \ 1561 ZFS_SPARSE) 1562 1563 #endif 1564 1565 /* 1566 * ZFS-specific error codes used for returning descriptive errors 1567 * to the userland through zfs ioctls. 1568 * 1569 * The enum implicitly includes all the error codes from errno.h. 1570 * New code should use and extend this enum for errors that are 1571 * not described precisely by generic errno codes. 1572 * 1573 * These numbers should not change over time. New entries should be appended. 1574 * 1575 * (Keep in sync with contrib/pyzfs/libzfs_core/_constants.py) 1576 */ 1577 typedef enum { 1578 ZFS_ERR_CHECKPOINT_EXISTS = 1024, 1579 ZFS_ERR_DISCARDING_CHECKPOINT, 1580 ZFS_ERR_NO_CHECKPOINT, 1581 ZFS_ERR_DEVRM_IN_PROGRESS, 1582 ZFS_ERR_VDEV_TOO_BIG, 1583 ZFS_ERR_IOC_CMD_UNAVAIL, 1584 ZFS_ERR_IOC_ARG_UNAVAIL, 1585 ZFS_ERR_IOC_ARG_REQUIRED, 1586 ZFS_ERR_IOC_ARG_BADTYPE, 1587 ZFS_ERR_WRONG_PARENT, 1588 ZFS_ERR_FROM_IVSET_GUID_MISSING, 1589 ZFS_ERR_FROM_IVSET_GUID_MISMATCH, 1590 ZFS_ERR_SPILL_BLOCK_FLAG_MISSING, 1591 ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE, 1592 ZFS_ERR_EXPORT_IN_PROGRESS, 1593 ZFS_ERR_BOOKMARK_SOURCE_NOT_ANCESTOR, 1594 ZFS_ERR_STREAM_TRUNCATED, 1595 ZFS_ERR_STREAM_LARGE_BLOCK_MISMATCH, 1596 ZFS_ERR_RESILVER_IN_PROGRESS, 1597 ZFS_ERR_REBUILD_IN_PROGRESS, 1598 ZFS_ERR_BADPROP, 1599 ZFS_ERR_VDEV_NOTSUP, 1600 ZFS_ERR_NOT_USER_NAMESPACE, 1601 ZFS_ERR_RESUME_EXISTS, 1602 ZFS_ERR_CRYPTO_NOTSUP, 1603 ZFS_ERR_RAIDZ_EXPAND_IN_PROGRESS, 1604 } zfs_errno_t; 1605 1606 /* 1607 * Internal SPA load state. Used by FMA diagnosis engine. 1608 */ 1609 typedef enum { 1610 SPA_LOAD_NONE, /* no load in progress */ 1611 SPA_LOAD_OPEN, /* normal open */ 1612 SPA_LOAD_IMPORT, /* import in progress */ 1613 SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 1614 SPA_LOAD_RECOVER, /* recovery requested */ 1615 SPA_LOAD_ERROR, /* load failed */ 1616 SPA_LOAD_CREATE /* creation in progress */ 1617 } spa_load_state_t; 1618 1619 typedef enum { 1620 ZPOOL_WAIT_CKPT_DISCARD, 1621 ZPOOL_WAIT_FREE, 1622 ZPOOL_WAIT_INITIALIZE, 1623 ZPOOL_WAIT_REPLACE, 1624 ZPOOL_WAIT_REMOVE, 1625 ZPOOL_WAIT_RESILVER, 1626 ZPOOL_WAIT_SCRUB, 1627 ZPOOL_WAIT_TRIM, 1628 ZPOOL_WAIT_RAIDZ_EXPAND, 1629 ZPOOL_WAIT_NUM_ACTIVITIES 1630 } zpool_wait_activity_t; 1631 1632 typedef enum { 1633 ZFS_WAIT_DELETEQ, 1634 ZFS_WAIT_NUM_ACTIVITIES 1635 } zfs_wait_activity_t; 1636 1637 /* 1638 * Bookmark name values. 1639 */ 1640 #define ZPOOL_ERR_LIST "error list" 1641 #define ZPOOL_ERR_DATASET "dataset" 1642 #define ZPOOL_ERR_OBJECT "object" 1643 1644 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 1645 1646 /* 1647 * The following are names used in the nvlist describing 1648 * the pool's history log. 1649 */ 1650 #define ZPOOL_HIST_RECORD "history record" 1651 #define ZPOOL_HIST_TIME "history time" 1652 #define ZPOOL_HIST_CMD "history command" 1653 #define ZPOOL_HIST_WHO "history who" 1654 #define ZPOOL_HIST_ZONE "history zone" 1655 #define ZPOOL_HIST_HOST "history hostname" 1656 #define ZPOOL_HIST_TXG "history txg" 1657 #define ZPOOL_HIST_INT_EVENT "history internal event" 1658 #define ZPOOL_HIST_INT_STR "history internal str" 1659 #define ZPOOL_HIST_INT_NAME "internal_name" 1660 #define ZPOOL_HIST_IOCTL "ioctl" 1661 #define ZPOOL_HIST_INPUT_NVL "in_nvl" 1662 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl" 1663 #define ZPOOL_HIST_OUTPUT_SIZE "out_size" 1664 #define ZPOOL_HIST_DSNAME "dsname" 1665 #define ZPOOL_HIST_DSID "dsid" 1666 #define ZPOOL_HIST_ERRNO "errno" 1667 #define ZPOOL_HIST_ELAPSED_NS "elapsed_ns" 1668 1669 /* 1670 * Special nvlist name that will not have its args recorded in the pool's 1671 * history log. 1672 */ 1673 #define ZPOOL_HIDDEN_ARGS "hidden_args" 1674 1675 /* 1676 * The following are names used when invoking ZFS_IOC_POOL_INITIALIZE. 1677 */ 1678 #define ZPOOL_INITIALIZE_COMMAND "initialize_command" 1679 #define ZPOOL_INITIALIZE_VDEVS "initialize_vdevs" 1680 1681 /* 1682 * The following are names used when invoking ZFS_IOC_POOL_TRIM. 1683 */ 1684 #define ZPOOL_TRIM_COMMAND "trim_command" 1685 #define ZPOOL_TRIM_VDEVS "trim_vdevs" 1686 #define ZPOOL_TRIM_RATE "trim_rate" 1687 #define ZPOOL_TRIM_SECURE "trim_secure" 1688 1689 /* 1690 * The following are names used when invoking ZFS_IOC_POOL_WAIT. 1691 */ 1692 #define ZPOOL_WAIT_ACTIVITY "wait_activity" 1693 #define ZPOOL_WAIT_TAG "wait_tag" 1694 #define ZPOOL_WAIT_WAITED "wait_waited" 1695 1696 /* 1697 * The following are names used when invoking ZFS_IOC_VDEV_GET_PROP. 1698 */ 1699 #define ZPOOL_VDEV_PROPS_GET_VDEV "vdevprops_get_vdev" 1700 #define ZPOOL_VDEV_PROPS_GET_PROPS "vdevprops_get_props" 1701 1702 /* 1703 * The following are names used when invoking ZFS_IOC_VDEV_SET_PROP. 1704 */ 1705 #define ZPOOL_VDEV_PROPS_SET_VDEV "vdevprops_set_vdev" 1706 #define ZPOOL_VDEV_PROPS_SET_PROPS "vdevprops_set_props" 1707 1708 /* 1709 * The following are names used when invoking ZFS_IOC_WAIT_FS. 1710 */ 1711 #define ZFS_WAIT_ACTIVITY "wait_activity" 1712 #define ZFS_WAIT_WAITED "wait_waited" 1713 1714 /* 1715 * Flags for ZFS_IOC_VDEV_SET_STATE 1716 */ 1717 #define ZFS_ONLINE_CHECKREMOVE 0x1 1718 #define ZFS_ONLINE_UNSPARE 0x2 1719 #define ZFS_ONLINE_FORCEFAULT 0x4 1720 #define ZFS_ONLINE_EXPAND 0x8 1721 #define ZFS_ONLINE_SPARE 0x10 1722 #define ZFS_OFFLINE_TEMPORARY 0x1 1723 1724 /* 1725 * Flags for ZFS_IOC_POOL_IMPORT 1726 */ 1727 #define ZFS_IMPORT_NORMAL 0x0 1728 #define ZFS_IMPORT_VERBATIM 0x1 1729 #define ZFS_IMPORT_ANY_HOST 0x2 1730 #define ZFS_IMPORT_MISSING_LOG 0x4 1731 #define ZFS_IMPORT_ONLY 0x8 1732 #define ZFS_IMPORT_TEMP_NAME 0x10 1733 #define ZFS_IMPORT_SKIP_MMP 0x20 1734 #define ZFS_IMPORT_LOAD_KEYS 0x40 1735 #define ZFS_IMPORT_CHECKPOINT 0x80 1736 1737 /* 1738 * Channel program argument/return nvlist keys and defaults. 1739 */ 1740 #define ZCP_ARG_PROGRAM "program" 1741 #define ZCP_ARG_ARGLIST "arg" 1742 #define ZCP_ARG_SYNC "sync" 1743 #define ZCP_ARG_INSTRLIMIT "instrlimit" 1744 #define ZCP_ARG_MEMLIMIT "memlimit" 1745 1746 #define ZCP_ARG_CLIARGV "argv" 1747 1748 #define ZCP_RET_ERROR "error" 1749 #define ZCP_RET_RETURN "return" 1750 1751 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000) 1752 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT) 1753 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024) 1754 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT) 1755 1756 /* 1757 * Sysevent payload members. ZFS will generate the following sysevents with the 1758 * given payloads: 1759 * 1760 * ESC_ZFS_RESILVER_START 1761 * ESC_ZFS_RESILVER_FINISH 1762 * 1763 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1764 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1765 * ZFS_EV_RESILVER_TYPE DATA_TYPE_STRING 1766 * 1767 * ESC_ZFS_POOL_DESTROY 1768 * ESC_ZFS_POOL_REGUID 1769 * 1770 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1771 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1772 * 1773 * ESC_ZFS_VDEV_REMOVE 1774 * ESC_ZFS_VDEV_CLEAR 1775 * ESC_ZFS_VDEV_CHECK 1776 * 1777 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1778 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1779 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 1780 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 1781 * 1782 * ESC_ZFS_HISTORY_EVENT 1783 * 1784 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1785 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1786 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional) 1787 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional) 1788 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional) 1789 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional) 1790 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional) 1791 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional) 1792 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional) 1793 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional) 1794 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional) 1795 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional) 1796 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional) 1797 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional) 1798 * 1799 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the 1800 * history log nvlist. The keynames will be free of any spaces or other 1801 * characters that could be potentially unexpected to consumers of the 1802 * sysevents. 1803 */ 1804 #define ZFS_EV_POOL_NAME "pool_name" 1805 #define ZFS_EV_POOL_GUID "pool_guid" 1806 #define ZFS_EV_VDEV_PATH "vdev_path" 1807 #define ZFS_EV_VDEV_GUID "vdev_guid" 1808 #define ZFS_EV_HIST_TIME "history_time" 1809 #define ZFS_EV_HIST_CMD "history_command" 1810 #define ZFS_EV_HIST_WHO "history_who" 1811 #define ZFS_EV_HIST_ZONE "history_zone" 1812 #define ZFS_EV_HIST_HOST "history_hostname" 1813 #define ZFS_EV_HIST_TXG "history_txg" 1814 #define ZFS_EV_HIST_INT_EVENT "history_internal_event" 1815 #define ZFS_EV_HIST_INT_STR "history_internal_str" 1816 #define ZFS_EV_HIST_INT_NAME "history_internal_name" 1817 #define ZFS_EV_HIST_IOCTL "history_ioctl" 1818 #define ZFS_EV_HIST_DSNAME "history_dsname" 1819 #define ZFS_EV_HIST_DSID "history_dsid" 1820 #define ZFS_EV_RESILVER_TYPE "resilver_type" 1821 1822 /* 1823 * We currently support block sizes from 512 bytes to 16MB. 1824 * The benefits of larger blocks, and thus larger IO, need to be weighed 1825 * against the cost of COWing a giant block to modify one byte, and the 1826 * large latency of reading or writing a large block. 1827 * 1828 * The recordsize property can not be set larger than zfs_max_recordsize 1829 * (default 16MB on 64-bit and 1MB on 32-bit). See the comment near 1830 * zfs_max_recordsize in dsl_dataset.c for details. 1831 * 1832 * Note that although the LSIZE field of the blkptr_t can store sizes up 1833 * to 32MB, the dnode's dn_datablkszsec can only store sizes up to 1834 * 32MB - 512 bytes. Therefore, we limit SPA_MAXBLOCKSIZE to 16MB. 1835 */ 1836 #define SPA_MINBLOCKSHIFT 9 1837 #define SPA_OLD_MAXBLOCKSHIFT 17 1838 #define SPA_MAXBLOCKSHIFT 24 1839 #define SPA_MINBLOCKSIZE (1ULL << SPA_MINBLOCKSHIFT) 1840 #define SPA_OLD_MAXBLOCKSIZE (1ULL << SPA_OLD_MAXBLOCKSHIFT) 1841 #define SPA_MAXBLOCKSIZE (1ULL << SPA_MAXBLOCKSHIFT) 1842 1843 /* supported encryption algorithms */ 1844 enum zio_encrypt { 1845 ZIO_CRYPT_INHERIT = 0, 1846 ZIO_CRYPT_ON, 1847 ZIO_CRYPT_OFF, 1848 ZIO_CRYPT_AES_128_CCM, 1849 ZIO_CRYPT_AES_192_CCM, 1850 ZIO_CRYPT_AES_256_CCM, 1851 ZIO_CRYPT_AES_128_GCM, 1852 ZIO_CRYPT_AES_192_GCM, 1853 ZIO_CRYPT_AES_256_GCM, 1854 ZIO_CRYPT_FUNCTIONS 1855 }; 1856 1857 #define ZIO_CRYPT_ON_VALUE ZIO_CRYPT_AES_256_GCM 1858 #define ZIO_CRYPT_DEFAULT ZIO_CRYPT_OFF 1859 1860 /* 1861 * xattr namespace prefixes. These are forbidden in xattr names. 1862 * 1863 * For cross-platform compatibility, xattrs in the user namespace should not be 1864 * prefixed with the namespace name, but for backwards compatibility with older 1865 * ZFS on Linux versions we do prefix the namespace. 1866 */ 1867 #define ZFS_XA_NS_FREEBSD_PREFIX "freebsd:" 1868 #define ZFS_XA_NS_FREEBSD_PREFIX_LEN strlen("freebsd:") 1869 #define ZFS_XA_NS_LINUX_SECURITY_PREFIX "security." 1870 #define ZFS_XA_NS_LINUX_SECURITY_PREFIX_LEN strlen("security.") 1871 #define ZFS_XA_NS_LINUX_SYSTEM_PREFIX "system." 1872 #define ZFS_XA_NS_LINUX_SYSTEM_PREFIX_LEN strlen("system.") 1873 #define ZFS_XA_NS_LINUX_TRUSTED_PREFIX "trusted." 1874 #define ZFS_XA_NS_LINUX_TRUSTED_PREFIX_LEN strlen("trusted.") 1875 #define ZFS_XA_NS_LINUX_USER_PREFIX "user." 1876 #define ZFS_XA_NS_LINUX_USER_PREFIX_LEN strlen("user.") 1877 1878 #define ZFS_XA_NS_PREFIX_MATCH(ns, name) \ 1879 (strncmp(name, ZFS_XA_NS_##ns##_PREFIX, \ 1880 ZFS_XA_NS_##ns##_PREFIX_LEN) == 0) 1881 1882 #define ZFS_XA_NS_PREFIX_FORBIDDEN(name) \ 1883 (ZFS_XA_NS_PREFIX_MATCH(FREEBSD, name) || \ 1884 ZFS_XA_NS_PREFIX_MATCH(LINUX_SECURITY, name) || \ 1885 ZFS_XA_NS_PREFIX_MATCH(LINUX_SYSTEM, name) || \ 1886 ZFS_XA_NS_PREFIX_MATCH(LINUX_TRUSTED, name) || \ 1887 ZFS_XA_NS_PREFIX_MATCH(LINUX_USER, name)) 1888 1889 #ifdef __cplusplus 1890 } 1891 #endif 1892 1893 #endif /* _SYS_FS_ZFS_H */ 1894