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