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