zfs/include/sys/fs/zfs.h

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