module/zcommon/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  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26 #ifndef _SYS_FS_ZFS_H
  27 #define _SYS_FS_ZFS_H
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * Types and constants shared between userland and the kernel.
  35  */
  36
  37 /*
  38  * Each dataset can be one of the following types.  These constants can be
  39  * combined into masks that can be passed to various functions.
  40  */
  41 typedef enum {
  42         ZFS_TYPE_FILESYSTEM     = 0x1,
  43         ZFS_TYPE_SNAPSHOT       = 0x2,
  44         ZFS_TYPE_VOLUME         = 0x4,
  45         ZFS_TYPE_POOL           = 0x8
  46 } zfs_type_t;
  47
  48 #define ZFS_TYPE_DATASET        \
  49         (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
  50
  51 /*
  52  * Dataset properties are identified by these constants and must be added to
  53  * the end of this list to ensure that external consumers are not affected
  54  * by the change. If you make any changes to this list, be sure to update
  55  * the property table in usr/src/common/zfs/zfs_prop.c.
  56  */
  57 typedef enum {
  58         ZFS_PROP_TYPE,
  59         ZFS_PROP_CREATION,
  60         ZFS_PROP_USED,
  61         ZFS_PROP_AVAILABLE,
  62         ZFS_PROP_REFERENCED,
  63         ZFS_PROP_COMPRESSRATIO,
  64         ZFS_PROP_MOUNTED,
  65         ZFS_PROP_ORIGIN,
  66         ZFS_PROP_QUOTA,
  67         ZFS_PROP_RESERVATION,
  68         ZFS_PROP_VOLSIZE,
  69         ZFS_PROP_VOLBLOCKSIZE,
  70         ZFS_PROP_RECORDSIZE,
  71         ZFS_PROP_MOUNTPOINT,
  72         ZFS_PROP_SHARENFS,
  73         ZFS_PROP_CHECKSUM,
  74         ZFS_PROP_COMPRESSION,
  75         ZFS_PROP_ATIME,
  76         ZFS_PROP_DEVICES,
  77         ZFS_PROP_EXEC,
  78         ZFS_PROP_SETUID,
  79         ZFS_PROP_READONLY,
  80         ZFS_PROP_ZONED,
  81         ZFS_PROP_SNAPDIR,
  82         ZFS_PROP_ACLMODE,
  83         ZFS_PROP_ACLINHERIT,
  84         ZFS_PROP_CREATETXG,             /* not exposed to the user */
  85         ZFS_PROP_NAME,                  /* not exposed to the user */
  86         ZFS_PROP_CANMOUNT,
  87         ZFS_PROP_SHAREISCSI,
  88         ZFS_PROP_ISCSIOPTIONS,          /* not exposed to the user */
  89         ZFS_PROP_XATTR,
  90         ZFS_PROP_NUMCLONES,             /* not exposed to the user */
  91         ZFS_PROP_COPIES,
  92         ZFS_PROP_VERSION,
  93         ZFS_PROP_UTF8ONLY,
  94         ZFS_PROP_NORMALIZE,
  95         ZFS_PROP_CASE,
  96         ZFS_PROP_VSCAN,
  97         ZFS_PROP_NBMAND,
  98         ZFS_PROP_SHARESMB,
  99         ZFS_PROP_REFQUOTA,
 100         ZFS_PROP_REFRESERVATION,
 101         ZFS_PROP_GUID,
 102         ZFS_PROP_PRIMARYCACHE,
 103         ZFS_PROP_SECONDARYCACHE,
 104         ZFS_PROP_USEDSNAP,
 105         ZFS_PROP_USEDDS,
 106         ZFS_PROP_USEDCHILD,
 107         ZFS_PROP_USEDREFRESERV,
 108         ZFS_NUM_PROPS
 109 } zfs_prop_t;
 110
 111 /*
 112  * Pool properties are identified by these constants and must be added to the
 113  * end of this list to ensure that external consumers are not affected
 114  * by the change. If you make any changes to this list, be sure to update
 115  * the property table in usr/src/common/zfs/zpool_prop.c.
 116  */
 117 typedef enum {
 118         ZPOOL_PROP_NAME,
 119         ZPOOL_PROP_SIZE,
 120         ZPOOL_PROP_USED,
 121         ZPOOL_PROP_AVAILABLE,
 122         ZPOOL_PROP_CAPACITY,
 123         ZPOOL_PROP_ALTROOT,
 124         ZPOOL_PROP_HEALTH,
 125         ZPOOL_PROP_GUID,
 126         ZPOOL_PROP_VERSION,
 127         ZPOOL_PROP_BOOTFS,
 128         ZPOOL_PROP_DELEGATION,
 129         ZPOOL_PROP_AUTOREPLACE,
 130         ZPOOL_PROP_CACHEFILE,
 131         ZPOOL_PROP_FAILUREMODE,
 132         ZPOOL_PROP_LISTSNAPS,
 133         ZPOOL_NUM_PROPS
 134 } zpool_prop_t;
 135
 136 #define ZPROP_CONT              -2
 137 #define ZPROP_INVAL             -1
 138
 139 #define ZPROP_VALUE             "value"
 140 #define ZPROP_SOURCE            "source"
 141
 142 typedef enum {
 143         ZPROP_SRC_NONE = 0x1,
 144         ZPROP_SRC_DEFAULT = 0x2,
 145         ZPROP_SRC_TEMPORARY = 0x4,
 146         ZPROP_SRC_LOCAL = 0x8,
 147         ZPROP_SRC_INHERITED = 0x10
 148 } zprop_source_t;
 149
 150 #define ZPROP_SRC_ALL   0x1f
 151
 152 typedef int (*zprop_func)(int, void *);
 153
 154 /*
 155  * Properties to be set on the root file system of a new pool
 156  * are stuffed into their own nvlist, which is then included in
 157  * the properties nvlist with the pool properties.
 158  */
 159 #define ZPOOL_ROOTFS_PROPS      "root-props-nvl"
 160
 161 /*
 162  * Dataset property functions shared between libzfs and kernel.
 163  */
 164 const char *zfs_prop_default_string(zfs_prop_t);
 165 uint64_t zfs_prop_default_numeric(zfs_prop_t);
 166 boolean_t zfs_prop_readonly(zfs_prop_t);
 167 boolean_t zfs_prop_inheritable(zfs_prop_t);
 168 boolean_t zfs_prop_setonce(zfs_prop_t);
 169 const char *zfs_prop_to_name(zfs_prop_t);
 170 zfs_prop_t zfs_name_to_prop(const char *);
 171 boolean_t zfs_prop_user(const char *);
 172 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
 173 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
 174 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
 175
 176 /*
 177  * Pool property functions shared between libzfs and kernel.
 178  */
 179 zpool_prop_t zpool_name_to_prop(const char *);
 180 const char *zpool_prop_to_name(zpool_prop_t);
 181 const char *zpool_prop_default_string(zpool_prop_t);
 182 uint64_t zpool_prop_default_numeric(zpool_prop_t);
 183 boolean_t zpool_prop_readonly(zpool_prop_t);
 184 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
 185 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
 186
 187 /*
 188  * Definitions for the Delegation.
 189  */
 190 typedef enum {
 191         ZFS_DELEG_WHO_UNKNOWN = 0,
 192         ZFS_DELEG_USER = 'u',
 193         ZFS_DELEG_USER_SETS = 'U',
 194         ZFS_DELEG_GROUP = 'g',
 195         ZFS_DELEG_GROUP_SETS = 'G',
 196         ZFS_DELEG_EVERYONE = 'e',
 197         ZFS_DELEG_EVERYONE_SETS = 'E',
 198         ZFS_DELEG_CREATE = 'c',
 199         ZFS_DELEG_CREATE_SETS = 'C',
 200         ZFS_DELEG_NAMED_SET = 's',
 201         ZFS_DELEG_NAMED_SET_SETS = 'S'
 202 } zfs_deleg_who_type_t;
 203
 204 typedef enum {
 205         ZFS_DELEG_NONE = 0,
 206         ZFS_DELEG_PERM_LOCAL = 1,
 207         ZFS_DELEG_PERM_DESCENDENT = 2,
 208         ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
 209         ZFS_DELEG_PERM_CREATE = 4
 210 } zfs_deleg_inherit_t;
 211
 212 #define ZFS_DELEG_PERM_UID      "uid"
 213 #define ZFS_DELEG_PERM_GID      "gid"
 214 #define ZFS_DELEG_PERM_GROUPS   "groups"
 215
 216 typedef enum {
 217         ZFS_CANMOUNT_OFF = 0,
 218         ZFS_CANMOUNT_ON = 1,
 219         ZFS_CANMOUNT_NOAUTO = 2
 220 } zfs_canmount_type_t;
 221
 222 typedef enum zfs_share_op {
 223         ZFS_SHARE_NFS = 0,
 224         ZFS_UNSHARE_NFS = 1,
 225         ZFS_SHARE_SMB = 2,
 226         ZFS_UNSHARE_SMB = 3
 227 } zfs_share_op_t;
 228
 229 typedef enum zfs_cache_type {
 230         ZFS_CACHE_NONE = 0,
 231         ZFS_CACHE_METADATA = 1,
 232         ZFS_CACHE_ALL = 2
 233 } zfs_cache_type_t;
 234
 235
 236 /*
 237  * On-disk version number.
 238  */
 239 #define SPA_VERSION_1                   1ULL
 240 #define SPA_VERSION_2                   2ULL
 241 #define SPA_VERSION_3                   3ULL
 242 #define SPA_VERSION_4                   4ULL
 243 #define SPA_VERSION_5                   5ULL
 244 #define SPA_VERSION_6                   6ULL
 245 #define SPA_VERSION_7                   7ULL
 246 #define SPA_VERSION_8                   8ULL
 247 #define SPA_VERSION_9                   9ULL
 248 #define SPA_VERSION_10                  10ULL
 249 #define SPA_VERSION_11                  11ULL
 250 #define SPA_VERSION_12                  12ULL
 251 #define SPA_VERSION_13                  13ULL
 252 #define SPA_VERSION_14                  14ULL
 253 /*
 254  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
 255  * format change. Go to usr/src/grub/grub-0.95/stage2/{zfs-include/, fsys_zfs*},
 256  * and do the appropriate changes.
 257  */
 258 #define SPA_VERSION                     SPA_VERSION_14
 259 #define SPA_VERSION_STRING              "14"
 260
 261 /*
 262  * Symbolic names for the changes that caused a SPA_VERSION switch.
 263  * Used in the code when checking for presence or absence of a feature.
 264  * Feel free to define multiple symbolic names for each version if there
 265  * were multiple changes to on-disk structures during that version.
 266  *
 267  * NOTE: When checking the current SPA_VERSION in your code, be sure
 268  *       to use spa_version() since it reports the version of the
 269  *       last synced uberblock.  Checking the in-flight version can
 270  *       be dangerous in some cases.
 271  */
 272 #define SPA_VERSION_INITIAL             SPA_VERSION_1
 273 #define SPA_VERSION_DITTO_BLOCKS        SPA_VERSION_2
 274 #define SPA_VERSION_SPARES              SPA_VERSION_3
 275 #define SPA_VERSION_RAID6               SPA_VERSION_3
 276 #define SPA_VERSION_BPLIST_ACCOUNT      SPA_VERSION_3
 277 #define SPA_VERSION_RAIDZ_DEFLATE       SPA_VERSION_3
 278 #define SPA_VERSION_DNODE_BYTES         SPA_VERSION_3
 279 #define SPA_VERSION_ZPOOL_HISTORY       SPA_VERSION_4
 280 #define SPA_VERSION_GZIP_COMPRESSION    SPA_VERSION_5
 281 #define SPA_VERSION_BOOTFS              SPA_VERSION_6
 282 #define SPA_VERSION_SLOGS               SPA_VERSION_7
 283 #define SPA_VERSION_DELEGATED_PERMS     SPA_VERSION_8
 284 #define SPA_VERSION_FUID                SPA_VERSION_9
 285 #define SPA_VERSION_REFRESERVATION      SPA_VERSION_9
 286 #define SPA_VERSION_REFQUOTA            SPA_VERSION_9
 287 #define SPA_VERSION_UNIQUE_ACCURATE     SPA_VERSION_9
 288 #define SPA_VERSION_L2CACHE             SPA_VERSION_10
 289 #define SPA_VERSION_NEXT_CLONES         SPA_VERSION_11
 290 #define SPA_VERSION_ORIGIN              SPA_VERSION_11
 291 #define SPA_VERSION_DSL_SCRUB           SPA_VERSION_11
 292 #define SPA_VERSION_SNAP_PROPS          SPA_VERSION_12
 293 #define SPA_VERSION_USED_BREAKDOWN      SPA_VERSION_13
 294 #define SPA_VERSION_PASSTHROUGH_X       SPA_VERSION_14
 295
 296 /*
 297  * ZPL version - rev'd whenever an incompatible on-disk format change
 298  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
 299  * also update the version_table[] and help message in zfs_prop.c.
 300  *
 301  * When changing, be sure to teach GRUB how to read the new format!
 302  * See usr/src/grub/grub-0.95/stage2/{zfs-include/,fsys_zfs*}
 303  */
 304 #define ZPL_VERSION_1                   1ULL
 305 #define ZPL_VERSION_2                   2ULL
 306 #define ZPL_VERSION_3                   3ULL
 307 #define ZPL_VERSION                     ZPL_VERSION_3
 308 #define ZPL_VERSION_STRING              "3"
 309
 310 #define ZPL_VERSION_INITIAL             ZPL_VERSION_1
 311 #define ZPL_VERSION_DIRENT_TYPE         ZPL_VERSION_2
 312 #define ZPL_VERSION_FUID                ZPL_VERSION_3
 313 #define ZPL_VERSION_NORMALIZATION       ZPL_VERSION_3
 314 #define ZPL_VERSION_SYSATTR             ZPL_VERSION_3
 315
 316 /*
 317  * The following are configuration names used in the nvlist describing a pool's
 318  * configuration.
 319  */
 320 #define ZPOOL_CONFIG_VERSION            "version"
 321 #define ZPOOL_CONFIG_POOL_NAME          "name"
 322 #define ZPOOL_CONFIG_POOL_STATE         "state"
 323 #define ZPOOL_CONFIG_POOL_TXG           "txg"
 324 #define ZPOOL_CONFIG_POOL_GUID          "pool_guid"
 325 #define ZPOOL_CONFIG_CREATE_TXG         "create_txg"
 326 #define ZPOOL_CONFIG_TOP_GUID           "top_guid"
 327 #define ZPOOL_CONFIG_VDEV_TREE          "vdev_tree"
 328 #define ZPOOL_CONFIG_TYPE               "type"
 329 #define ZPOOL_CONFIG_CHILDREN           "children"
 330 #define ZPOOL_CONFIG_ID                 "id"
 331 #define ZPOOL_CONFIG_GUID               "guid"
 332 #define ZPOOL_CONFIG_PATH               "path"
 333 #define ZPOOL_CONFIG_DEVID              "devid"
 334 #define ZPOOL_CONFIG_METASLAB_ARRAY     "metaslab_array"
 335 #define ZPOOL_CONFIG_METASLAB_SHIFT     "metaslab_shift"
 336 #define ZPOOL_CONFIG_ASHIFT             "ashift"
 337 #define ZPOOL_CONFIG_ASIZE              "asize"
 338 #define ZPOOL_CONFIG_DTL                "DTL"
 339 #define ZPOOL_CONFIG_STATS              "stats"
 340 #define ZPOOL_CONFIG_WHOLE_DISK         "whole_disk"
 341 #define ZPOOL_CONFIG_ERRCOUNT           "error_count"
 342 #define ZPOOL_CONFIG_NOT_PRESENT        "not_present"
 343 #define ZPOOL_CONFIG_SPARES             "spares"
 344 #define ZPOOL_CONFIG_IS_SPARE           "is_spare"
 345 #define ZPOOL_CONFIG_NPARITY            "nparity"
 346 #define ZPOOL_CONFIG_HOSTID             "hostid"
 347 #define ZPOOL_CONFIG_HOSTNAME           "hostname"
 348 #define ZPOOL_CONFIG_UNSPARE            "unspare"
 349 #define ZPOOL_CONFIG_PHYS_PATH          "phys_path"
 350 #define ZPOOL_CONFIG_IS_LOG             "is_log"
 351 #define ZPOOL_CONFIG_L2CACHE            "l2cache"
 352 #define ZPOOL_CONFIG_SUSPENDED          "suspended"     /* not stored on disk */
 353 #define ZPOOL_CONFIG_TIMESTAMP          "timestamp"     /* not stored on disk */
 354 #define ZPOOL_CONFIG_BOOTFS             "bootfs"        /* not stored on disk */
 355 /*
 356  * The persistent vdev state is stored as separate values rather than a single
 357  * 'vdev_state' entry.  This is because a device can be in multiple states, such
 358  * as offline and degraded.
 359  */
 360 #define ZPOOL_CONFIG_OFFLINE            "offline"
 361 #define ZPOOL_CONFIG_FAULTED            "faulted"
 362 #define ZPOOL_CONFIG_DEGRADED           "degraded"
 363 #define ZPOOL_CONFIG_REMOVED            "removed"
 364
 365 #define VDEV_TYPE_ROOT                  "root"
 366 #define VDEV_TYPE_MIRROR                "mirror"
 367 #define VDEV_TYPE_REPLACING             "replacing"
 368 #define VDEV_TYPE_RAIDZ                 "raidz"
 369 #define VDEV_TYPE_DISK                  "disk"
 370 #define VDEV_TYPE_FILE                  "file"
 371 #define VDEV_TYPE_MISSING               "missing"
 372 #define VDEV_TYPE_SPARE                 "spare"
 373 #define VDEV_TYPE_LOG                   "log"
 374 #define VDEV_TYPE_L2CACHE               "l2cache"
 375
 376 /*
 377  * This is needed in userland to report the minimum necessary device size.
 378  */
 379 #define SPA_MINDEVSIZE          (64ULL << 20)
 380
 381 /*
 382  * The location of the pool configuration repository, shared between kernel and
 383  * userland.
 384  */
 385 #define ZPOOL_CACHE             "/etc/zfs/zpool.cache"
 386
 387 /*
 388  * vdev states are ordered from least to most healthy.
 389  * A vdev that's CANT_OPEN or below is considered unusable.
 390  */
 391 typedef enum vdev_state {
 392         VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev                   */
 393         VDEV_STATE_CLOSED,      /* Not currently open                   */
 394         VDEV_STATE_OFFLINE,     /* Not allowed to open                  */
 395         VDEV_STATE_REMOVED,     /* Explicitly removed from system       */
 396         VDEV_STATE_CANT_OPEN,   /* Tried to open, but failed            */
 397         VDEV_STATE_FAULTED,     /* External request to fault device     */
 398         VDEV_STATE_DEGRADED,    /* Replicated vdev with unhealthy kids  */
 399         VDEV_STATE_HEALTHY      /* Presumed good                        */
 400 } vdev_state_t;
 401
 402 #define VDEV_STATE_ONLINE       VDEV_STATE_HEALTHY
 403
 404 /*
 405  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
 406  * of the vdev stats structure uses these constants to distinguish why.
 407  */
 408 typedef enum vdev_aux {
 409         VDEV_AUX_NONE,          /* no error                             */
 410         VDEV_AUX_OPEN_FAILED,   /* ldi_open_*() or vn_open() failed     */
 411         VDEV_AUX_CORRUPT_DATA,  /* bad label or disk contents           */
 412         VDEV_AUX_NO_REPLICAS,   /* insufficient number of replicas      */
 413         VDEV_AUX_BAD_GUID_SUM,  /* vdev guid sum doesn't match          */
 414         VDEV_AUX_TOO_SMALL,     /* vdev size is too small               */
 415         VDEV_AUX_BAD_LABEL,     /* the label is OK but invalid          */
 416         VDEV_AUX_VERSION_NEWER, /* on-disk version is too new           */
 417         VDEV_AUX_VERSION_OLDER, /* on-disk version is too old           */
 418         VDEV_AUX_SPARED,        /* hot spare used in another pool       */
 419         VDEV_AUX_ERR_EXCEEDED,  /* too many errors                      */
 420         VDEV_AUX_IO_FAILURE,    /* experienced I/O failure              */
 421         VDEV_AUX_BAD_LOG        /* cannot read log chain(s)             */
 422 } vdev_aux_t;
 423
 424 /*
 425  * pool state.  The following states are written to disk as part of the normal
 426  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
 427  * states are software abstractions used at various levels to communicate
 428  * pool state.
 429  */
 430 typedef enum pool_state {
 431         POOL_STATE_ACTIVE = 0,          /* In active use                */
 432         POOL_STATE_EXPORTED,            /* Explicitly exported          */
 433         POOL_STATE_DESTROYED,           /* Explicitly destroyed         */
 434         POOL_STATE_SPARE,               /* Reserved for hot spare use   */
 435         POOL_STATE_L2CACHE,             /* Level 2 ARC device           */
 436         POOL_STATE_UNINITIALIZED,       /* Internal spa_t state         */
 437         POOL_STATE_UNAVAIL,             /* Internal libzfs state        */
 438         POOL_STATE_POTENTIALLY_ACTIVE   /* Internal libzfs state        */
 439 } pool_state_t;
 440
 441 /*
 442  * Scrub types.
 443  */
 444 typedef enum pool_scrub_type {
 445         POOL_SCRUB_NONE,
 446         POOL_SCRUB_RESILVER,
 447         POOL_SCRUB_EVERYTHING,
 448         POOL_SCRUB_TYPES
 449 } pool_scrub_type_t;
 450
 451 /*
 452  * ZIO types.  Needed to interpret vdev statistics below.
 453  */
 454 typedef enum zio_type {
 455         ZIO_TYPE_NULL = 0,
 456         ZIO_TYPE_READ,
 457         ZIO_TYPE_WRITE,
 458         ZIO_TYPE_FREE,
 459         ZIO_TYPE_CLAIM,
 460         ZIO_TYPE_IOCTL,
 461         ZIO_TYPES
 462 } zio_type_t;
 463
 464 /*
 465  * Vdev statistics.  Note: all fields should be 64-bit because this
 466  * is passed between kernel and userland as an nvlist uint64 array.
 467  */
 468 typedef struct vdev_stat {
 469         hrtime_t        vs_timestamp;           /* time since vdev load */
 470         uint64_t        vs_state;               /* vdev state           */
 471         uint64_t        vs_aux;                 /* see vdev_aux_t       */
 472         uint64_t        vs_alloc;               /* space allocated      */
 473         uint64_t        vs_space;               /* total capacity       */
 474         uint64_t        vs_dspace;              /* deflated capacity    */
 475         uint64_t        vs_rsize;               /* replaceable dev size */
 476         uint64_t        vs_ops[ZIO_TYPES];      /* operation count      */
 477         uint64_t        vs_bytes[ZIO_TYPES];    /* bytes read/written   */
 478         uint64_t        vs_read_errors;         /* read errors          */
 479         uint64_t        vs_write_errors;        /* write errors         */
 480         uint64_t        vs_checksum_errors;     /* checksum errors      */
 481         uint64_t        vs_self_healed;         /* self-healed bytes    */
 482         uint64_t        vs_scrub_type;          /* pool_scrub_type_t    */
 483         uint64_t        vs_scrub_complete;      /* completed?           */
 484         uint64_t        vs_scrub_examined;      /* bytes examined; top  */
 485         uint64_t        vs_scrub_repaired;      /* bytes repaired; leaf */
 486         uint64_t        vs_scrub_errors;        /* errors during scrub  */
 487         uint64_t        vs_scrub_start;         /* UTC scrub start time */
 488         uint64_t        vs_scrub_end;           /* UTC scrub end time   */
 489 } vdev_stat_t;
 490
 491 #define ZVOL_DRIVER     "zvol"
 492 #define ZFS_DRIVER      "zfs"
 493 #define ZFS_DEV         "/dev/zfs"
 494
 495 /*
 496  * zvol paths.  Irritatingly, the devfsadm interfaces want all these
 497  * paths without the /dev prefix, but for some things, we want the
 498  * /dev prefix.  Below are the names without /dev.
 499  */
 500 #define ZVOL_DEV_DIR    "zvol/dsk"
 501 #define ZVOL_RDEV_DIR   "zvol/rdsk"
 502
 503 /*
 504  * And here are the things we need with /dev, etc. in front of them.
 505  */
 506 #define ZVOL_PSEUDO_DEV         "/devices/pseudo/zvol@0:"
 507 #define ZVOL_FULL_DEV_DIR       "/dev/" ZVOL_DEV_DIR "/"
 508
 509 #define ZVOL_PROP_NAME          "name"
 510
 511 /*
 512  * /dev/zfs ioctl numbers.
 513  */
 514 #define ZFS_IOC         ('Z' << 8)
 515
 516 typedef enum zfs_ioc {
 517         ZFS_IOC_POOL_CREATE = ZFS_IOC,
 518         ZFS_IOC_POOL_DESTROY,
 519         ZFS_IOC_POOL_IMPORT,
 520         ZFS_IOC_POOL_EXPORT,
 521         ZFS_IOC_POOL_CONFIGS,
 522         ZFS_IOC_POOL_STATS,
 523         ZFS_IOC_POOL_TRYIMPORT,
 524         ZFS_IOC_POOL_SCRUB,
 525         ZFS_IOC_POOL_FREEZE,
 526         ZFS_IOC_POOL_UPGRADE,
 527         ZFS_IOC_POOL_GET_HISTORY,
 528         ZFS_IOC_VDEV_ADD,
 529         ZFS_IOC_VDEV_REMOVE,
 530         ZFS_IOC_VDEV_SET_STATE,
 531         ZFS_IOC_VDEV_ATTACH,
 532         ZFS_IOC_VDEV_DETACH,
 533         ZFS_IOC_VDEV_SETPATH,
 534         ZFS_IOC_OBJSET_STATS,
 535         ZFS_IOC_OBJSET_ZPLPROPS,
 536         ZFS_IOC_DATASET_LIST_NEXT,
 537         ZFS_IOC_SNAPSHOT_LIST_NEXT,
 538         ZFS_IOC_SET_PROP,
 539         ZFS_IOC_CREATE_MINOR,
 540         ZFS_IOC_REMOVE_MINOR,
 541         ZFS_IOC_CREATE,
 542         ZFS_IOC_DESTROY,
 543         ZFS_IOC_ROLLBACK,
 544         ZFS_IOC_RENAME,
 545         ZFS_IOC_RECV,
 546         ZFS_IOC_SEND,
 547         ZFS_IOC_INJECT_FAULT,
 548         ZFS_IOC_CLEAR_FAULT,
 549         ZFS_IOC_INJECT_LIST_NEXT,
 550         ZFS_IOC_ERROR_LOG,
 551         ZFS_IOC_CLEAR,
 552         ZFS_IOC_PROMOTE,
 553         ZFS_IOC_DESTROY_SNAPS,
 554         ZFS_IOC_SNAPSHOT,
 555         ZFS_IOC_DSOBJ_TO_DSNAME,
 556         ZFS_IOC_OBJ_TO_PATH,
 557         ZFS_IOC_POOL_SET_PROPS,
 558         ZFS_IOC_POOL_GET_PROPS,
 559         ZFS_IOC_SET_FSACL,
 560         ZFS_IOC_GET_FSACL,
 561         ZFS_IOC_ISCSI_PERM_CHECK,
 562         ZFS_IOC_SHARE,
 563         ZFS_IOC_INHERIT_PROP
 564 } zfs_ioc_t;
 565
 566 /*
 567  * Internal SPA load state.  Used by FMA diagnosis engine.
 568  */
 569 typedef enum {
 570         SPA_LOAD_NONE,          /* no load in progress */
 571         SPA_LOAD_OPEN,          /* normal open */
 572         SPA_LOAD_IMPORT,        /* import in progress */
 573         SPA_LOAD_TRYIMPORT      /* tryimport in progress */
 574 } spa_load_state_t;
 575
 576 /*
 577  * Bookmark name values.
 578  */
 579 #define ZPOOL_ERR_LIST          "error list"
 580 #define ZPOOL_ERR_DATASET       "dataset"
 581 #define ZPOOL_ERR_OBJECT        "object"
 582
 583 #define HIS_MAX_RECORD_LEN      (MAXPATHLEN + MAXPATHLEN + 1)
 584
 585 /*
 586  * The following are names used in the nvlist describing
 587  * the pool's history log.
 588  */
 589 #define ZPOOL_HIST_RECORD       "history record"
 590 #define ZPOOL_HIST_TIME         "history time"
 591 #define ZPOOL_HIST_CMD          "history command"
 592 #define ZPOOL_HIST_WHO          "history who"
 593 #define ZPOOL_HIST_ZONE         "history zone"
 594 #define ZPOOL_HIST_HOST         "history hostname"
 595 #define ZPOOL_HIST_TXG          "history txg"
 596 #define ZPOOL_HIST_INT_EVENT    "history internal event"
 597 #define ZPOOL_HIST_INT_STR      "history internal str"
 598
 599 /*
 600  * Flags for ZFS_IOC_VDEV_SET_STATE
 601  */
 602 #define ZFS_ONLINE_CHECKREMOVE  0x1
 603 #define ZFS_ONLINE_UNSPARE      0x2
 604 #define ZFS_ONLINE_FORCEFAULT   0x4
 605 #define ZFS_OFFLINE_TEMPORARY   0x1
 606
 607 /*
 608  * Sysevent payload members.  ZFS will generate the following sysevents with the
 609  * given payloads:
 610  *
 611  *      ESC_ZFS_RESILVER_START
 612  *      ESC_ZFS_RESILVER_END
 613  *      ESC_ZFS_POOL_DESTROY
 614  *
 615  *              ZFS_EV_POOL_NAME        DATA_TYPE_STRING
 616  *              ZFS_EV_POOL_GUID        DATA_TYPE_UINT64
 617  *
 618  *      ESC_ZFS_VDEV_REMOVE
 619  *      ESC_ZFS_VDEV_CLEAR
 620  *      ESC_ZFS_VDEV_CHECK
 621  *
 622  *              ZFS_EV_POOL_NAME        DATA_TYPE_STRING
 623  *              ZFS_EV_POOL_GUID        DATA_TYPE_UINT64
 624  *              ZFS_EV_VDEV_PATH        DATA_TYPE_STRING        (optional)
 625  *              ZFS_EV_VDEV_GUID        DATA_TYPE_UINT64
 626  */
 627 #define ZFS_EV_POOL_NAME        "pool_name"
 628 #define ZFS_EV_POOL_GUID        "pool_guid"
 629 #define ZFS_EV_VDEV_PATH        "vdev_path"
 630 #define ZFS_EV_VDEV_GUID        "vdev_guid"
 631
 632 /*
 633  * Note: This is encoded on-disk, so new events must be added to the
 634  * end, and unused events can not be removed.  Be sure to edit
 635  * zpool_main.c: hist_event_table[].
 636  */
 637 typedef enum history_internal_events {
 638         LOG_NO_EVENT = 0,
 639         LOG_POOL_CREATE,
 640         LOG_POOL_VDEV_ADD,
 641         LOG_POOL_REMOVE,
 642         LOG_POOL_DESTROY,
 643         LOG_POOL_EXPORT,
 644         LOG_POOL_IMPORT,
 645         LOG_POOL_VDEV_ATTACH,
 646         LOG_POOL_VDEV_REPLACE,
 647         LOG_POOL_VDEV_DETACH,
 648         LOG_POOL_VDEV_ONLINE,
 649         LOG_POOL_VDEV_OFFLINE,
 650         LOG_POOL_UPGRADE,
 651         LOG_POOL_CLEAR,
 652         LOG_POOL_SCRUB,
 653         LOG_POOL_PROPSET,
 654         LOG_DS_CREATE,
 655         LOG_DS_CLONE,
 656         LOG_DS_DESTROY,
 657         LOG_DS_DESTROY_BEGIN,
 658         LOG_DS_INHERIT,
 659         LOG_DS_PROPSET,
 660         LOG_DS_QUOTA,
 661         LOG_DS_PERM_UPDATE,
 662         LOG_DS_PERM_REMOVE,
 663         LOG_DS_PERM_WHO_REMOVE,
 664         LOG_DS_PROMOTE,
 665         LOG_DS_RECEIVE,
 666         LOG_DS_RENAME,
 667         LOG_DS_RESERVATION,
 668         LOG_DS_REPLAY_INC_SYNC,
 669         LOG_DS_REPLAY_FULL_SYNC,
 670         LOG_DS_ROLLBACK,
 671         LOG_DS_SNAPSHOT,
 672         LOG_DS_UPGRADE,
 673         LOG_DS_REFQUOTA,
 674         LOG_DS_REFRESERV,
 675         LOG_POOL_SCRUB_DONE,
 676         LOG_END
 677 } history_internal_events_t;
 678
 679 #ifdef  __cplusplus
 680 }
 681 #endif
 682
 683 #endif  /* _SYS_FS_ZFS_H */