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 /*
  23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  */
  25
  26 /* Portions Copyright 2010 Robert Milkowski */
  27
  28 #ifndef _SYS_FS_ZFS_H
  29 #define _SYS_FS_ZFS_H
  30
  31 #include <sys/time.h>
  32
  33 #ifdef  __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*
  38  * Types and constants shared between userland and the kernel.
  39  */
  40
  41 /*
  42  * Each dataset can be one of the following types.  These constants can be
  43  * combined into masks that can be passed to various functions.
  44  */
  45 typedef enum {
  46         ZFS_TYPE_FILESYSTEM     = 0x1,
  47         ZFS_TYPE_SNAPSHOT       = 0x2,
  48         ZFS_TYPE_VOLUME         = 0x4,
  49         ZFS_TYPE_POOL           = 0x8
  50 } zfs_type_t;
  51
  52 #define ZFS_TYPE_DATASET        \
  53         (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
  54
  55 #define ZAP_MAXNAMELEN 256
  56 #define ZAP_MAXVALUELEN (1024 * 8)
  57 #define ZAP_OLDMAXVALUELEN 1024
  58
  59 /*
  60  * Dataset properties are identified by these constants and must be added to
  61  * the end of this list to ensure that external consumers are not affected
  62  * by the change. If you make any changes to this list, be sure to update
  63  * the property table in usr/src/common/zfs/zfs_prop.c.
  64  */
  65 typedef enum {
  66         ZFS_PROP_TYPE,
  67         ZFS_PROP_CREATION,
  68         ZFS_PROP_USED,
  69         ZFS_PROP_AVAILABLE,
  70         ZFS_PROP_REFERENCED,
  71         ZFS_PROP_COMPRESSRATIO,
  72         ZFS_PROP_MOUNTED,
  73         ZFS_PROP_ORIGIN,
  74         ZFS_PROP_QUOTA,
  75         ZFS_PROP_RESERVATION,
  76         ZFS_PROP_VOLSIZE,
  77         ZFS_PROP_VOLBLOCKSIZE,
  78         ZFS_PROP_RECORDSIZE,
  79         ZFS_PROP_MOUNTPOINT,
  80         ZFS_PROP_SHARENFS,
  81         ZFS_PROP_CHECKSUM,
  82         ZFS_PROP_COMPRESSION,
  83         ZFS_PROP_ATIME,
  84         ZFS_PROP_DEVICES,
  85         ZFS_PROP_EXEC,
  86         ZFS_PROP_SETUID,
  87         ZFS_PROP_READONLY,
  88         ZFS_PROP_ZONED,
  89         ZFS_PROP_SNAPDIR,
  90         ZFS_PROP_PRIVATE,               /* not exposed to user, temporary */
  91         ZFS_PROP_ACLINHERIT,
  92         ZFS_PROP_CREATETXG,             /* not exposed to the user */
  93         ZFS_PROP_NAME,                  /* not exposed to the user */
  94         ZFS_PROP_CANMOUNT,
  95         ZFS_PROP_ISCSIOPTIONS,          /* not exposed to the user */
  96         ZFS_PROP_XATTR,
  97         ZFS_PROP_NUMCLONES,             /* not exposed to the user */
  98         ZFS_PROP_COPIES,
  99         ZFS_PROP_VERSION,
 100         ZFS_PROP_UTF8ONLY,
 101         ZFS_PROP_NORMALIZE,
 102         ZFS_PROP_CASE,
 103         ZFS_PROP_VSCAN,
 104         ZFS_PROP_NBMAND,
 105         ZFS_PROP_SHARESMB,
 106         ZFS_PROP_REFQUOTA,
 107         ZFS_PROP_REFRESERVATION,
 108         ZFS_PROP_GUID,
 109         ZFS_PROP_PRIMARYCACHE,
 110         ZFS_PROP_SECONDARYCACHE,
 111         ZFS_PROP_USEDSNAP,
 112         ZFS_PROP_USEDDS,
 113         ZFS_PROP_USEDCHILD,
 114         ZFS_PROP_USEDREFRESERV,
 115         ZFS_PROP_USERACCOUNTING,        /* not exposed to the user */
 116         ZFS_PROP_STMF_SHAREINFO,        /* not exposed to the user */
 117         ZFS_PROP_DEFER_DESTROY,
 118         ZFS_PROP_USERREFS,
 119         ZFS_PROP_LOGBIAS,
 120         ZFS_PROP_UNIQUE,                /* not exposed to the user */
 121         ZFS_PROP_OBJSETID,              /* not exposed to the user */
 122         ZFS_PROP_DEDUP,
 123         ZFS_PROP_MLSLABEL,
 124         ZFS_PROP_SYNC,
 125         ZFS_NUM_PROPS
 126 } zfs_prop_t;
 127
 128 typedef enum {
 129         ZFS_PROP_USERUSED,
 130         ZFS_PROP_USERQUOTA,
 131         ZFS_PROP_GROUPUSED,
 132         ZFS_PROP_GROUPQUOTA,
 133         ZFS_NUM_USERQUOTA_PROPS
 134 } zfs_userquota_prop_t;
 135
 136 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
 137
 138 /*
 139  * Pool properties are identified by these constants and must be added to the
 140  * end of this list to ensure that external consumers are not affected
 141  * by the change. If you make any changes to this list, be sure to update
 142  * the property table in usr/src/common/zfs/zpool_prop.c.
 143  */
 144 typedef enum {
 145         ZPOOL_PROP_NAME,
 146         ZPOOL_PROP_SIZE,
 147         ZPOOL_PROP_CAPACITY,
 148         ZPOOL_PROP_ALTROOT,
 149         ZPOOL_PROP_HEALTH,
 150         ZPOOL_PROP_GUID,
 151         ZPOOL_PROP_VERSION,
 152         ZPOOL_PROP_BOOTFS,
 153         ZPOOL_PROP_DELEGATION,
 154         ZPOOL_PROP_AUTOREPLACE,
 155         ZPOOL_PROP_CACHEFILE,
 156         ZPOOL_PROP_FAILUREMODE,
 157         ZPOOL_PROP_LISTSNAPS,
 158         ZPOOL_PROP_AUTOEXPAND,
 159         ZPOOL_PROP_DEDUPDITTO,
 160         ZPOOL_PROP_DEDUPRATIO,
 161         ZPOOL_PROP_FREE,
 162         ZPOOL_PROP_ALLOCATED,
 163         ZPOOL_NUM_PROPS
 164 } zpool_prop_t;
 165
 166 #define ZPROP_CONT              -2
 167 #define ZPROP_INVAL             -1
 168
 169 #define ZPROP_VALUE             "value"
 170 #define ZPROP_SOURCE            "source"
 171
 172 typedef enum {
 173         ZPROP_SRC_NONE = 0x1,
 174         ZPROP_SRC_DEFAULT = 0x2,
 175         ZPROP_SRC_TEMPORARY = 0x4,
 176         ZPROP_SRC_LOCAL = 0x8,
 177         ZPROP_SRC_INHERITED = 0x10,
 178         ZPROP_SRC_RECEIVED = 0x20
 179 } zprop_source_t;
 180
 181 #define ZPROP_SRC_ALL   0x3f
 182
 183 #define ZPROP_SOURCE_VAL_RECVD  "$recvd"
 184 #define ZPROP_N_MORE_ERRORS     "N_MORE_ERRORS"
 185 /*
 186  * Dataset flag implemented as a special entry in the props zap object
 187  * indicating that the dataset has received properties on or after
 188  * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
 189  * just as it did in earlier versions, and thereafter, local properties are
 190  * preserved.
 191  */
 192 #define ZPROP_HAS_RECVD         "$hasrecvd"
 193
 194 typedef enum {
 195         ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
 196         ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
 197 } zprop_errflags_t;
 198
 199 typedef int (*zprop_func)(int, void *);
 200
 201 /*
 202  * Properties to be set on the root file system of a new pool
 203  * are stuffed into their own nvlist, which is then included in
 204  * the properties nvlist with the pool properties.
 205  */
 206 #define ZPOOL_ROOTFS_PROPS      "root-props-nvl"
 207
 208 /*
 209  * Dataset property functions shared between libzfs and kernel.
 210  */
 211 const char *zfs_prop_default_string(zfs_prop_t);
 212 uint64_t zfs_prop_default_numeric(zfs_prop_t);
 213 boolean_t zfs_prop_readonly(zfs_prop_t);
 214 boolean_t zfs_prop_inheritable(zfs_prop_t);
 215 boolean_t zfs_prop_setonce(zfs_prop_t);
 216 const char *zfs_prop_to_name(zfs_prop_t);
 217 zfs_prop_t zfs_name_to_prop(const char *);
 218 boolean_t zfs_prop_user(const char *);
 219 boolean_t zfs_prop_userquota(const char *);
 220 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
 221 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
 222 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
 223 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
 224
 225 /*
 226  * Pool property functions shared between libzfs and kernel.
 227  */
 228 zpool_prop_t zpool_name_to_prop(const char *);
 229 const char *zpool_prop_to_name(zpool_prop_t);
 230 const char *zpool_prop_default_string(zpool_prop_t);
 231 uint64_t zpool_prop_default_numeric(zpool_prop_t);
 232 boolean_t zpool_prop_readonly(zpool_prop_t);
 233 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
 234 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
 235 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
 236
 237 /*
 238  * Definitions for the Delegation.
 239  */
 240 typedef enum {
 241         ZFS_DELEG_WHO_UNKNOWN = 0,
 242         ZFS_DELEG_USER = 'u',
 243         ZFS_DELEG_USER_SETS = 'U',
 244         ZFS_DELEG_GROUP = 'g',
 245         ZFS_DELEG_GROUP_SETS = 'G',
 246         ZFS_DELEG_EVERYONE = 'e',
 247         ZFS_DELEG_EVERYONE_SETS = 'E',
 248         ZFS_DELEG_CREATE = 'c',
 249         ZFS_DELEG_CREATE_SETS = 'C',
 250         ZFS_DELEG_NAMED_SET = 's',
 251         ZFS_DELEG_NAMED_SET_SETS = 'S'
 252 } zfs_deleg_who_type_t;
 253
 254 typedef enum {
 255         ZFS_DELEG_NONE = 0,
 256         ZFS_DELEG_PERM_LOCAL = 1,
 257         ZFS_DELEG_PERM_DESCENDENT = 2,
 258         ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
 259         ZFS_DELEG_PERM_CREATE = 4
 260 } zfs_deleg_inherit_t;
 261
 262 #define ZFS_DELEG_PERM_UID      "uid"
 263 #define ZFS_DELEG_PERM_GID      "gid"
 264 #define ZFS_DELEG_PERM_GROUPS   "groups"
 265
 266 #define ZFS_MLSLABEL_DEFAULT    "none"
 267
 268 #define ZFS_SMB_ACL_SRC         "src"
 269 #define ZFS_SMB_ACL_TARGET      "target"
 270
 271 typedef enum {
 272         ZFS_CANMOUNT_OFF = 0,
 273         ZFS_CANMOUNT_ON = 1,
 274         ZFS_CANMOUNT_NOAUTO = 2
 275 } zfs_canmount_type_t;
 276
 277 typedef enum {
 278         ZFS_LOGBIAS_LATENCY = 0,
 279         ZFS_LOGBIAS_THROUGHPUT = 1
 280 } zfs_logbias_op_t;
 281
 282 typedef enum zfs_share_op {
 283         ZFS_SHARE_NFS = 0,
 284         ZFS_UNSHARE_NFS = 1,
 285         ZFS_SHARE_SMB = 2,
 286         ZFS_UNSHARE_SMB = 3
 287 } zfs_share_op_t;
 288
 289 typedef enum zfs_smb_acl_op {
 290         ZFS_SMB_ACL_ADD,
 291         ZFS_SMB_ACL_REMOVE,
 292         ZFS_SMB_ACL_RENAME,
 293         ZFS_SMB_ACL_PURGE
 294 } zfs_smb_acl_op_t;
 295
 296 typedef enum zfs_cache_type {
 297         ZFS_CACHE_NONE = 0,
 298         ZFS_CACHE_METADATA = 1,
 299         ZFS_CACHE_ALL = 2
 300 } zfs_cache_type_t;
 301
 302 typedef enum {
 303         ZFS_SYNC_STANDARD = 0,
 304         ZFS_SYNC_ALWAYS = 1,
 305         ZFS_SYNC_DISABLED = 2
 306 } zfs_sync_type_t;
 307
 308
 309 /*
 310  * On-disk version number.
 311  */
 312 #define SPA_VERSION_1                   1ULL
 313 #define SPA_VERSION_2                   2ULL
 314 #define SPA_VERSION_3                   3ULL
 315 #define SPA_VERSION_4                   4ULL
 316 #define SPA_VERSION_5                   5ULL
 317 #define SPA_VERSION_6                   6ULL
 318 #define SPA_VERSION_7                   7ULL
 319 #define SPA_VERSION_8                   8ULL
 320 #define SPA_VERSION_9                   9ULL
 321 #define SPA_VERSION_10                  10ULL
 322 #define SPA_VERSION_11                  11ULL
 323 #define SPA_VERSION_12                  12ULL
 324 #define SPA_VERSION_13                  13ULL
 325 #define SPA_VERSION_14                  14ULL
 326 #define SPA_VERSION_15                  15ULL
 327 #define SPA_VERSION_16                  16ULL
 328 #define SPA_VERSION_17                  17ULL
 329 #define SPA_VERSION_18                  18ULL
 330 #define SPA_VERSION_19                  19ULL
 331 #define SPA_VERSION_20                  20ULL
 332 #define SPA_VERSION_21                  21ULL
 333 #define SPA_VERSION_22                  22ULL
 334 #define SPA_VERSION_23                  23ULL
 335 #define SPA_VERSION_24                  24ULL
 336 #define SPA_VERSION_25                  25ULL
 337 #define SPA_VERSION_26                  26ULL
 338 /*
 339  * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
 340  * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
 341  * and do the appropriate changes.  Also bump the version number in
 342  * usr/src/grub/capability.
 343  */
 344 #define SPA_VERSION                     SPA_VERSION_26
 345 #define SPA_VERSION_STRING              "26"
 346
 347 /*
 348  * Symbolic names for the changes that caused a SPA_VERSION switch.
 349  * Used in the code when checking for presence or absence of a feature.
 350  * Feel free to define multiple symbolic names for each version if there
 351  * were multiple changes to on-disk structures during that version.
 352  *
 353  * NOTE: When checking the current SPA_VERSION in your code, be sure
 354  *       to use spa_version() since it reports the version of the
 355  *       last synced uberblock.  Checking the in-flight version can
 356  *       be dangerous in some cases.
 357  */
 358 #define SPA_VERSION_INITIAL             SPA_VERSION_1
 359 #define SPA_VERSION_DITTO_BLOCKS        SPA_VERSION_2
 360 #define SPA_VERSION_SPARES              SPA_VERSION_3
 361 #define SPA_VERSION_RAIDZ2              SPA_VERSION_3
 362 #define SPA_VERSION_BPOBJ_ACCOUNT       SPA_VERSION_3
 363 #define SPA_VERSION_RAIDZ_DEFLATE       SPA_VERSION_3
 364 #define SPA_VERSION_DNODE_BYTES         SPA_VERSION_3
 365 #define SPA_VERSION_ZPOOL_HISTORY       SPA_VERSION_4
 366 #define SPA_VERSION_GZIP_COMPRESSION    SPA_VERSION_5
 367 #define SPA_VERSION_BOOTFS              SPA_VERSION_6
 368 #define SPA_VERSION_SLOGS               SPA_VERSION_7
 369 #define SPA_VERSION_DELEGATED_PERMS     SPA_VERSION_8
 370 #define SPA_VERSION_FUID                SPA_VERSION_9
 371 #define SPA_VERSION_REFRESERVATION      SPA_VERSION_9
 372 #define SPA_VERSION_REFQUOTA            SPA_VERSION_9
 373 #define SPA_VERSION_UNIQUE_ACCURATE     SPA_VERSION_9
 374 #define SPA_VERSION_L2CACHE             SPA_VERSION_10
 375 #define SPA_VERSION_NEXT_CLONES         SPA_VERSION_11
 376 #define SPA_VERSION_ORIGIN              SPA_VERSION_11
 377 #define SPA_VERSION_DSL_SCRUB           SPA_VERSION_11
 378 #define SPA_VERSION_SNAP_PROPS          SPA_VERSION_12
 379 #define SPA_VERSION_USED_BREAKDOWN      SPA_VERSION_13
 380 #define SPA_VERSION_PASSTHROUGH_X       SPA_VERSION_14
 381 #define SPA_VERSION_USERSPACE           SPA_VERSION_15
 382 #define SPA_VERSION_STMF_PROP           SPA_VERSION_16
 383 #define SPA_VERSION_RAIDZ3              SPA_VERSION_17
 384 #define SPA_VERSION_USERREFS            SPA_VERSION_18
 385 #define SPA_VERSION_HOLES               SPA_VERSION_19
 386 #define SPA_VERSION_ZLE_COMPRESSION     SPA_VERSION_20
 387 #define SPA_VERSION_DEDUP               SPA_VERSION_21
 388 #define SPA_VERSION_RECVD_PROPS         SPA_VERSION_22
 389 #define SPA_VERSION_SLIM_ZIL            SPA_VERSION_23
 390 #define SPA_VERSION_SA                  SPA_VERSION_24
 391 #define SPA_VERSION_SCAN                SPA_VERSION_25
 392 #define SPA_VERSION_DIR_CLONES          SPA_VERSION_26
 393 #define SPA_VERSION_DEADLISTS           SPA_VERSION_26
 394
 395 /*
 396  * ZPL version - rev'd whenever an incompatible on-disk format change
 397  * occurs.  This is independent of SPA/DMU/ZAP versioning.  You must
 398  * also update the version_table[] and help message in zfs_prop.c.
 399  *
 400  * When changing, be sure to teach GRUB how to read the new format!
 401  * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
 402  */
 403 #define ZPL_VERSION_1                   1ULL
 404 #define ZPL_VERSION_2                   2ULL
 405 #define ZPL_VERSION_3                   3ULL
 406 #define ZPL_VERSION_4                   4ULL
 407 #define ZPL_VERSION_5                   5ULL
 408 #define ZPL_VERSION                     ZPL_VERSION_5
 409 #define ZPL_VERSION_STRING              "5"
 410
 411 #define ZPL_VERSION_INITIAL             ZPL_VERSION_1
 412 #define ZPL_VERSION_DIRENT_TYPE         ZPL_VERSION_2
 413 #define ZPL_VERSION_FUID                ZPL_VERSION_3
 414 #define ZPL_VERSION_NORMALIZATION       ZPL_VERSION_3
 415 #define ZPL_VERSION_SYSATTR             ZPL_VERSION_3
 416 #define ZPL_VERSION_USERSPACE           ZPL_VERSION_4
 417 #define ZPL_VERSION_SA                  ZPL_VERSION_5
 418
 419 /* Rewind request information */
 420 #define ZPOOL_NO_REWIND         1  /* No policy - default behavior */
 421 #define ZPOOL_NEVER_REWIND      2  /* Do not search for best txg or rewind */
 422 #define ZPOOL_TRY_REWIND        4  /* Search for best txg, but do not rewind */
 423 #define ZPOOL_DO_REWIND         8  /* Rewind to best txg w/in deferred frees */
 424 #define ZPOOL_EXTREME_REWIND    16 /* Allow extreme measures to find best txg */
 425 #define ZPOOL_REWIND_MASK       28 /* All the possible rewind bits */
 426 #define ZPOOL_REWIND_POLICIES   31 /* All the possible policy bits */
 427
 428 typedef struct zpool_rewind_policy {
 429         uint32_t        zrp_request;    /* rewind behavior requested */
 430         uint64_t        zrp_maxmeta;    /* max acceptable meta-data errors */
 431         uint64_t        zrp_maxdata;    /* max acceptable data errors */
 432         uint64_t        zrp_txg;        /* specific txg to load */
 433 } zpool_rewind_policy_t;
 434
 435 /*
 436  * The following are configuration names used in the nvlist describing a pool's
 437  * configuration.
 438  */
 439 #define ZPOOL_CONFIG_VERSION            "version"
 440 #define ZPOOL_CONFIG_POOL_NAME          "name"
 441 #define ZPOOL_CONFIG_POOL_STATE         "state"
 442 #define ZPOOL_CONFIG_POOL_TXG           "txg"
 443 #define ZPOOL_CONFIG_POOL_GUID          "pool_guid"
 444 #define ZPOOL_CONFIG_CREATE_TXG         "create_txg"
 445 #define ZPOOL_CONFIG_TOP_GUID           "top_guid"
 446 #define ZPOOL_CONFIG_VDEV_TREE          "vdev_tree"
 447 #define ZPOOL_CONFIG_TYPE               "type"
 448 #define ZPOOL_CONFIG_CHILDREN           "children"
 449 #define ZPOOL_CONFIG_ID                 "id"
 450 #define ZPOOL_CONFIG_GUID               "guid"
 451 #define ZPOOL_CONFIG_PATH               "path"
 452 #define ZPOOL_CONFIG_DEVID              "devid"
 453 #define ZPOOL_CONFIG_METASLAB_ARRAY     "metaslab_array"
 454 #define ZPOOL_CONFIG_METASLAB_SHIFT     "metaslab_shift"
 455 #define ZPOOL_CONFIG_ASHIFT             "ashift"
 456 #define ZPOOL_CONFIG_ASIZE              "asize"
 457 #define ZPOOL_CONFIG_DTL                "DTL"
 458 #define ZPOOL_CONFIG_SCAN_STATS         "scan_stats"    /* not stored on disk */
 459 #define ZPOOL_CONFIG_VDEV_STATS         "vdev_stats"    /* not stored on disk */
 460 #define ZPOOL_CONFIG_WHOLE_DISK         "whole_disk"
 461 #define ZPOOL_CONFIG_ERRCOUNT           "error_count"
 462 #define ZPOOL_CONFIG_NOT_PRESENT        "not_present"
 463 #define ZPOOL_CONFIG_SPARES             "spares"
 464 #define ZPOOL_CONFIG_IS_SPARE           "is_spare"
 465 #define ZPOOL_CONFIG_NPARITY            "nparity"
 466 #define ZPOOL_CONFIG_HOSTID             "hostid"
 467 #define ZPOOL_CONFIG_HOSTNAME           "hostname"
 468 #define ZPOOL_CONFIG_UNSPARE            "unspare"
 469 #define ZPOOL_CONFIG_PHYS_PATH          "phys_path"
 470 #define ZPOOL_CONFIG_IS_LOG             "is_log"
 471 #define ZPOOL_CONFIG_L2CACHE            "l2cache"
 472 #define ZPOOL_CONFIG_HOLE_ARRAY         "hole_array"
 473 #define ZPOOL_CONFIG_VDEV_CHILDREN      "vdev_children"
 474 #define ZPOOL_CONFIG_IS_HOLE            "is_hole"
 475 #define ZPOOL_CONFIG_DDT_HISTOGRAM      "ddt_histogram"
 476 #define ZPOOL_CONFIG_DDT_OBJ_STATS      "ddt_object_stats"
 477 #define ZPOOL_CONFIG_DDT_STATS          "ddt_stats"
 478 #define ZPOOL_CONFIG_SPLIT              "splitcfg"
 479 #define ZPOOL_CONFIG_ORIG_GUID          "orig_guid"
 480 #define ZPOOL_CONFIG_SPLIT_GUID         "split_guid"
 481 #define ZPOOL_CONFIG_SPLIT_LIST         "guid_list"
 482 #define ZPOOL_CONFIG_REMOVING           "removing"
 483 #define ZPOOL_CONFIG_SUSPENDED          "suspended"     /* not stored on disk */
 484 #define ZPOOL_CONFIG_TIMESTAMP          "timestamp"     /* not stored on disk */
 485 #define ZPOOL_CONFIG_BOOTFS             "bootfs"        /* not stored on disk */
 486 /*
 487  * The persistent vdev state is stored as separate values rather than a single
 488  * 'vdev_state' entry.  This is because a device can be in multiple states, such
 489  * as offline and degraded.
 490  */
 491 #define ZPOOL_CONFIG_OFFLINE            "offline"
 492 #define ZPOOL_CONFIG_FAULTED            "faulted"
 493 #define ZPOOL_CONFIG_DEGRADED           "degraded"
 494 #define ZPOOL_CONFIG_REMOVED            "removed"
 495 #define ZPOOL_CONFIG_FRU                "fru"
 496 #define ZPOOL_CONFIG_AUX_STATE          "aux_state"
 497
 498 /* Rewind policy parameters */
 499 #define ZPOOL_REWIND_POLICY             "rewind-policy"
 500 #define ZPOOL_REWIND_REQUEST            "rewind-request"
 501 #define ZPOOL_REWIND_REQUEST_TXG        "rewind-request-txg"
 502 #define ZPOOL_REWIND_META_THRESH        "rewind-meta-thresh"
 503 #define ZPOOL_REWIND_DATA_THRESH        "rewind-data-thresh"
 504
 505 /* Rewind data discovered */
 506 #define ZPOOL_CONFIG_LOAD_TIME          "rewind_txg_ts"
 507 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS   "verify_data_errors"
 508 #define ZPOOL_CONFIG_REWIND_TIME        "seconds_of_rewind"
 509
 510 #define VDEV_TYPE_ROOT                  "root"
 511 #define VDEV_TYPE_MIRROR                "mirror"
 512 #define VDEV_TYPE_REPLACING             "replacing"
 513 #define VDEV_TYPE_RAIDZ                 "raidz"
 514 #define VDEV_TYPE_DISK                  "disk"
 515 #define VDEV_TYPE_FILE                  "file"
 516 #define VDEV_TYPE_MISSING               "missing"
 517 #define VDEV_TYPE_HOLE                  "hole"
 518 #define VDEV_TYPE_SPARE                 "spare"
 519 #define VDEV_TYPE_LOG                   "log"
 520 #define VDEV_TYPE_L2CACHE               "l2cache"
 521
 522 /*
 523  * This is needed in userland to report the minimum necessary device size.
 524  */
 525 #define SPA_MINDEVSIZE          (64ULL << 20)
 526
 527 /*
 528  * The location of the pool configuration repository, shared between kernel and
 529  * userland.
 530  */
 531 #define ZPOOL_CACHE             "/etc/zfs/zpool.cache"
 532
 533 /*
 534  * vdev states are ordered from least to most healthy.
 535  * A vdev that's CANT_OPEN or below is considered unusable.
 536  */
 537 typedef enum vdev_state {
 538         VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev                   */
 539         VDEV_STATE_CLOSED,      /* Not currently open                   */
 540         VDEV_STATE_OFFLINE,     /* Not allowed to open                  */
 541         VDEV_STATE_REMOVED,     /* Explicitly removed from system       */
 542         VDEV_STATE_CANT_OPEN,   /* Tried to open, but failed            */
 543         VDEV_STATE_FAULTED,     /* External request to fault device     */
 544         VDEV_STATE_DEGRADED,    /* Replicated vdev with unhealthy kids  */
 545         VDEV_STATE_HEALTHY      /* Presumed good                        */
 546 } vdev_state_t;
 547
 548 #define VDEV_STATE_ONLINE       VDEV_STATE_HEALTHY
 549
 550 /*
 551  * vdev aux states.  When a vdev is in the CANT_OPEN state, the aux field
 552  * of the vdev stats structure uses these constants to distinguish why.
 553  */
 554 typedef enum vdev_aux {
 555         VDEV_AUX_NONE,          /* no error                             */
 556         VDEV_AUX_OPEN_FAILED,   /* ldi_open_*() or vn_open() failed     */
 557         VDEV_AUX_CORRUPT_DATA,  /* bad label or disk contents           */
 558         VDEV_AUX_NO_REPLICAS,   /* insufficient number of replicas      */
 559         VDEV_AUX_BAD_GUID_SUM,  /* vdev guid sum doesn't match          */
 560         VDEV_AUX_TOO_SMALL,     /* vdev size is too small               */
 561         VDEV_AUX_BAD_LABEL,     /* the label is OK but invalid          */
 562         VDEV_AUX_VERSION_NEWER, /* on-disk version is too new           */
 563         VDEV_AUX_VERSION_OLDER, /* on-disk version is too old           */
 564         VDEV_AUX_SPARED,        /* hot spare used in another pool       */
 565         VDEV_AUX_ERR_EXCEEDED,  /* too many errors                      */
 566         VDEV_AUX_IO_FAILURE,    /* experienced I/O failure              */
 567         VDEV_AUX_BAD_LOG,       /* cannot read log chain(s)             */
 568         VDEV_AUX_EXTERNAL,      /* external diagnosis                   */
 569         VDEV_AUX_SPLIT_POOL     /* vdev was split off into another pool */
 570 } vdev_aux_t;
 571
 572 /*
 573  * pool state.  The following states are written to disk as part of the normal
 574  * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE.  The remaining
 575  * states are software abstractions used at various levels to communicate
 576  * pool state.
 577  */
 578 typedef enum pool_state {
 579         POOL_STATE_ACTIVE = 0,          /* In active use                */
 580         POOL_STATE_EXPORTED,            /* Explicitly exported          */
 581         POOL_STATE_DESTROYED,           /* Explicitly destroyed         */
 582         POOL_STATE_SPARE,               /* Reserved for hot spare use   */
 583         POOL_STATE_L2CACHE,             /* Level 2 ARC device           */
 584         POOL_STATE_UNINITIALIZED,       /* Internal spa_t state         */
 585         POOL_STATE_UNAVAIL,             /* Internal libzfs state        */
 586         POOL_STATE_POTENTIALLY_ACTIVE   /* Internal libzfs state        */
 587 } pool_state_t;
 588
 589 /*
 590  * Scan Functions.
 591  */
 592 typedef enum pool_scan_func {
 593         POOL_SCAN_NONE,
 594         POOL_SCAN_SCRUB,
 595         POOL_SCAN_RESILVER,
 596         POOL_SCAN_FUNCS
 597 } pool_scan_func_t;
 598
 599 /*
 600  * ZIO types.  Needed to interpret vdev statistics below.
 601  */
 602 typedef enum zio_type {
 603         ZIO_TYPE_NULL = 0,
 604         ZIO_TYPE_READ,
 605         ZIO_TYPE_WRITE,
 606         ZIO_TYPE_FREE,
 607         ZIO_TYPE_CLAIM,
 608         ZIO_TYPE_IOCTL,
 609         ZIO_TYPES
 610 } zio_type_t;
 611
 612 /*
 613  * Pool statistics.  Note: all fields should be 64-bit because this
 614  * is passed between kernel and userland as an nvlist uint64 array.
 615  */
 616 typedef struct pool_scan_stat {
 617         /* values stored on disk */
 618         uint64_t        pss_func;       /* pool_scan_func_t */
 619         uint64_t        pss_state;      /* dsl_scan_state_t */
 620         uint64_t        pss_start_time; /* scan start time */
 621         uint64_t        pss_end_time;   /* scan end time */
 622         uint64_t        pss_to_examine; /* total bytes to scan */
 623         uint64_t        pss_examined;   /* total examined bytes */
 624         uint64_t        pss_to_process; /* total bytes to process */
 625         uint64_t        pss_processed;  /* total processed bytes */
 626         uint64_t        pss_errors;     /* scan errors  */
 627
 628         /* values not stored on disk */
 629         uint64_t        pss_pass_exam;  /* examined bytes per scan pass */
 630         uint64_t        pss_pass_start; /* start time of a scan pass */
 631 } pool_scan_stat_t;
 632
 633 typedef enum dsl_scan_state {
 634         DSS_NONE,
 635         DSS_SCANNING,
 636         DSS_FINISHED,
 637         DSS_CANCELED,
 638         DSS_NUM_STATES
 639 } dsl_scan_state_t;
 640
 641
 642 /*
 643  * Vdev statistics.  Note: all fields should be 64-bit because this
 644  * is passed between kernel and userland as an nvlist uint64 array.
 645  */
 646 typedef struct vdev_stat {
 647         hrtime_t        vs_timestamp;           /* time since vdev load */
 648         uint64_t        vs_state;               /* vdev state           */
 649         uint64_t        vs_aux;                 /* see vdev_aux_t       */
 650         uint64_t        vs_alloc;               /* space allocated      */
 651         uint64_t        vs_space;               /* total capacity       */
 652         uint64_t        vs_dspace;              /* deflated capacity    */
 653         uint64_t        vs_rsize;               /* replaceable dev size */
 654         uint64_t        vs_ops[ZIO_TYPES];      /* operation count      */
 655         uint64_t        vs_bytes[ZIO_TYPES];    /* bytes read/written   */
 656         uint64_t        vs_read_errors;         /* read errors          */
 657         uint64_t        vs_write_errors;        /* write errors         */
 658         uint64_t        vs_checksum_errors;     /* checksum errors      */
 659         uint64_t        vs_self_healed;         /* self-healed bytes    */
 660         uint64_t        vs_scan_removing;       /* removing?    */
 661         uint64_t        vs_scan_processed;      /* scan processed bytes */
 662 } vdev_stat_t;
 663
 664 /*
 665  * DDT statistics.  Note: all fields should be 64-bit because this
 666  * is passed between kernel and userland as an nvlist uint64 array.
 667  */
 668 typedef struct ddt_object {
 669         uint64_t        ddo_count;      /* number of elments in ddt     */
 670         uint64_t        ddo_dspace;     /* size of ddt on disk          */
 671         uint64_t        ddo_mspace;     /* size of ddt in-core          */
 672 } ddt_object_t;
 673
 674 typedef struct ddt_stat {
 675         uint64_t        dds_blocks;     /* blocks                       */
 676         uint64_t        dds_lsize;      /* logical size                 */
 677         uint64_t        dds_psize;      /* physical size                */
 678         uint64_t        dds_dsize;      /* deflated allocated size      */
 679         uint64_t        dds_ref_blocks; /* referenced blocks            */
 680         uint64_t        dds_ref_lsize;  /* referenced lsize * refcnt    */
 681         uint64_t        dds_ref_psize;  /* referenced psize * refcnt    */
 682         uint64_t        dds_ref_dsize;  /* referenced dsize * refcnt    */
 683 } ddt_stat_t;
 684
 685 typedef struct ddt_histogram {
 686         ddt_stat_t      ddh_stat[64];   /* power-of-two histogram buckets */
 687 } ddt_histogram_t;
 688
 689 #define ZVOL_DRIVER     "zvol"
 690 #define ZFS_DRIVER      "zfs"
 691 #define ZFS_DEV         "/dev/zfs"
 692
 693 /* general zvol path */
 694 #define ZVOL_DIR                "/dev/zvol"
 695 /* expansion */
 696 #define ZVOL_PSEUDO_DEV         "/devices/pseudo/zfs@0:"
 697 /* for dump and swap */
 698 #define ZVOL_FULL_DEV_DIR       ZVOL_DIR "/dsk/"
 699 #define ZVOL_FULL_RDEV_DIR      ZVOL_DIR "/rdsk/"
 700
 701 #define ZVOL_PROP_NAME          "name"
 702 #define ZVOL_DEFAULT_BLOCKSIZE  8192
 703
 704 /*
 705  * /dev/zfs ioctl numbers.
 706  */
 707 #define ZFS_IOC         ('Z' << 8)
 708
 709 typedef enum zfs_ioc {
 710         ZFS_IOC_POOL_CREATE = ZFS_IOC,
 711         ZFS_IOC_POOL_DESTROY,
 712         ZFS_IOC_POOL_IMPORT,
 713         ZFS_IOC_POOL_EXPORT,
 714         ZFS_IOC_POOL_CONFIGS,
 715         ZFS_IOC_POOL_STATS,
 716         ZFS_IOC_POOL_TRYIMPORT,
 717         ZFS_IOC_POOL_SCAN,
 718         ZFS_IOC_POOL_FREEZE,
 719         ZFS_IOC_POOL_UPGRADE,
 720         ZFS_IOC_POOL_GET_HISTORY,
 721         ZFS_IOC_VDEV_ADD,
 722         ZFS_IOC_VDEV_REMOVE,
 723         ZFS_IOC_VDEV_SET_STATE,
 724         ZFS_IOC_VDEV_ATTACH,
 725         ZFS_IOC_VDEV_DETACH,
 726         ZFS_IOC_VDEV_SETPATH,
 727         ZFS_IOC_VDEV_SETFRU,
 728         ZFS_IOC_OBJSET_STATS,
 729         ZFS_IOC_OBJSET_ZPLPROPS,
 730         ZFS_IOC_DATASET_LIST_NEXT,
 731         ZFS_IOC_SNAPSHOT_LIST_NEXT,
 732         ZFS_IOC_SET_PROP,
 733         ZFS_IOC_CREATE,
 734         ZFS_IOC_DESTROY,
 735         ZFS_IOC_ROLLBACK,
 736         ZFS_IOC_RENAME,
 737         ZFS_IOC_RECV,
 738         ZFS_IOC_SEND,
 739         ZFS_IOC_INJECT_FAULT,
 740         ZFS_IOC_CLEAR_FAULT,
 741         ZFS_IOC_INJECT_LIST_NEXT,
 742         ZFS_IOC_ERROR_LOG,
 743         ZFS_IOC_CLEAR,
 744         ZFS_IOC_PROMOTE,
 745         ZFS_IOC_DESTROY_SNAPS,
 746         ZFS_IOC_SNAPSHOT,
 747         ZFS_IOC_DSOBJ_TO_DSNAME,
 748         ZFS_IOC_OBJ_TO_PATH,
 749         ZFS_IOC_POOL_SET_PROPS,
 750         ZFS_IOC_POOL_GET_PROPS,
 751         ZFS_IOC_SET_FSACL,
 752         ZFS_IOC_GET_FSACL,
 753         ZFS_IOC_SHARE,
 754         ZFS_IOC_INHERIT_PROP,
 755         ZFS_IOC_SMB_ACL,
 756         ZFS_IOC_USERSPACE_ONE,
 757         ZFS_IOC_USERSPACE_MANY,
 758         ZFS_IOC_USERSPACE_UPGRADE,
 759         ZFS_IOC_HOLD,
 760         ZFS_IOC_RELEASE,
 761         ZFS_IOC_GET_HOLDS,
 762         ZFS_IOC_OBJSET_RECVD_PROPS,
 763         ZFS_IOC_VDEV_SPLIT
 764 } zfs_ioc_t;
 765
 766 /*
 767  * Internal SPA load state.  Used by FMA diagnosis engine.
 768  */
 769 typedef enum {
 770         SPA_LOAD_NONE,          /* no load in progress  */
 771         SPA_LOAD_OPEN,          /* normal open          */
 772         SPA_LOAD_IMPORT,        /* import in progress   */
 773         SPA_LOAD_TRYIMPORT,     /* tryimport in progress */
 774         SPA_LOAD_RECOVER,       /* recovery requested   */
 775         SPA_LOAD_ERROR          /* load failed          */
 776 } spa_load_state_t;
 777
 778 /*
 779  * Bookmark name values.
 780  */
 781 #define ZPOOL_ERR_LIST          "error list"
 782 #define ZPOOL_ERR_DATASET       "dataset"
 783 #define ZPOOL_ERR_OBJECT        "object"
 784
 785 #define HIS_MAX_RECORD_LEN      (MAXPATHLEN + MAXPATHLEN + 1)
 786
 787 /*
 788  * The following are names used in the nvlist describing
 789  * the pool's history log.
 790  */
 791 #define ZPOOL_HIST_RECORD       "history record"
 792 #define ZPOOL_HIST_TIME         "history time"
 793 #define ZPOOL_HIST_CMD          "history command"
 794 #define ZPOOL_HIST_WHO          "history who"
 795 #define ZPOOL_HIST_ZONE         "history zone"
 796 #define ZPOOL_HIST_HOST         "history hostname"
 797 #define ZPOOL_HIST_TXG          "history txg"
 798 #define ZPOOL_HIST_INT_EVENT    "history internal event"
 799 #define ZPOOL_HIST_INT_STR      "history internal str"
 800
 801 /*
 802  * Flags for ZFS_IOC_VDEV_SET_STATE
 803  */
 804 #define ZFS_ONLINE_CHECKREMOVE  0x1
 805 #define ZFS_ONLINE_UNSPARE      0x2
 806 #define ZFS_ONLINE_FORCEFAULT   0x4
 807 #define ZFS_ONLINE_EXPAND       0x8
 808 #define ZFS_OFFLINE_TEMPORARY   0x1
 809
 810 /*
 811  * Sysevent payload members.  ZFS will generate the following sysevents with the
 812  * given payloads:
 813  *
 814  *      ESC_ZFS_RESILVER_START
 815  *      ESC_ZFS_RESILVER_END
 816  *      ESC_ZFS_POOL_DESTROY
 817  *
 818  *              ZFS_EV_POOL_NAME        DATA_TYPE_STRING
 819  *              ZFS_EV_POOL_GUID        DATA_TYPE_UINT64
 820  *
 821  *      ESC_ZFS_VDEV_REMOVE
 822  *      ESC_ZFS_VDEV_CLEAR
 823  *      ESC_ZFS_VDEV_CHECK
 824  *
 825  *              ZFS_EV_POOL_NAME        DATA_TYPE_STRING
 826  *              ZFS_EV_POOL_GUID        DATA_TYPE_UINT64
 827  *              ZFS_EV_VDEV_PATH        DATA_TYPE_STRING        (optional)
 828  *              ZFS_EV_VDEV_GUID        DATA_TYPE_UINT64
 829  */
 830 #define ZFS_EV_POOL_NAME        "pool_name"
 831 #define ZFS_EV_POOL_GUID        "pool_guid"
 832 #define ZFS_EV_VDEV_PATH        "vdev_path"
 833 #define ZFS_EV_VDEV_GUID        "vdev_guid"
 834
 835 /*
 836  * Note: This is encoded on-disk, so new events must be added to the
 837  * end, and unused events can not be removed.  Be sure to edit
 838  * libzfs_pool.c: hist_event_table[].
 839  */
 840 typedef enum history_internal_events {
 841         LOG_NO_EVENT = 0,
 842         LOG_POOL_CREATE,
 843         LOG_POOL_VDEV_ADD,
 844         LOG_POOL_REMOVE,
 845         LOG_POOL_DESTROY,
 846         LOG_POOL_EXPORT,
 847         LOG_POOL_IMPORT,
 848         LOG_POOL_VDEV_ATTACH,
 849         LOG_POOL_VDEV_REPLACE,
 850         LOG_POOL_VDEV_DETACH,
 851         LOG_POOL_VDEV_ONLINE,
 852         LOG_POOL_VDEV_OFFLINE,
 853         LOG_POOL_UPGRADE,
 854         LOG_POOL_CLEAR,
 855         LOG_POOL_SCAN,
 856         LOG_POOL_PROPSET,
 857         LOG_DS_CREATE,
 858         LOG_DS_CLONE,
 859         LOG_DS_DESTROY,
 860         LOG_DS_DESTROY_BEGIN,
 861         LOG_DS_INHERIT,
 862         LOG_DS_PROPSET,
 863         LOG_DS_QUOTA,
 864         LOG_DS_PERM_UPDATE,
 865         LOG_DS_PERM_REMOVE,
 866         LOG_DS_PERM_WHO_REMOVE,
 867         LOG_DS_PROMOTE,
 868         LOG_DS_RECEIVE,
 869         LOG_DS_RENAME,
 870         LOG_DS_RESERVATION,
 871         LOG_DS_REPLAY_INC_SYNC,
 872         LOG_DS_REPLAY_FULL_SYNC,
 873         LOG_DS_ROLLBACK,
 874         LOG_DS_SNAPSHOT,
 875         LOG_DS_UPGRADE,
 876         LOG_DS_REFQUOTA,
 877         LOG_DS_REFRESERV,
 878         LOG_POOL_SCAN_DONE,
 879         LOG_DS_USER_HOLD,
 880         LOG_DS_USER_RELEASE,
 881         LOG_POOL_SPLIT,
 882         LOG_END
 883 } history_internal_events_t;
 884
 885 #ifdef  __cplusplus
 886 }
 887 #endif
 888
 889 #endif  /* _SYS_FS_ZFS_H */