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