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