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