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