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