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