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