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