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