sys/contrib/openzfs/include/sys/fs/zfs.h

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