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