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