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