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