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, 2016 by Delphix. All rights reserved. 25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved. 26 * Copyright (c) 2014 Integros [integros.com] 27 * Copyright 2017 Joyent, Inc. 28 * Copyright (c) 2017 Datto Inc. 29 * Copyright (c) 2017, Intel Corporation. 30 */ 31 32 /* Portions Copyright 2010 Robert Milkowski */ 33 34 #ifndef _SYS_FS_ZFS_H 35 #define _SYS_FS_ZFS_H 36 37 #include <sys/time.h> 38 39 #ifdef __cplusplus 40 extern "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 */ 51 typedef 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 59 /* 60 * NB: lzc_dataset_type should be updated whenever a new objset type is added, 61 * if it represents a real type of a dataset that can be created from userland. 62 */ 63 typedef enum dmu_objset_type { 64 DMU_OST_NONE, 65 DMU_OST_META, 66 DMU_OST_ZFS, 67 DMU_OST_ZVOL, 68 DMU_OST_OTHER, /* For testing only! */ 69 DMU_OST_ANY, /* Be careful! */ 70 DMU_OST_NUMTYPES 71 } dmu_objset_type_t; 72 73 #define ZFS_TYPE_DATASET \ 74 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 75 76 /* 77 * All of these include the terminating NUL byte. 78 */ 79 #define ZAP_MAXNAMELEN 256 80 #define ZAP_MAXVALUELEN (1024 * 8) 81 #define ZAP_OLDMAXVALUELEN 1024 82 #define ZFS_MAX_DATASET_NAME_LEN 256 83 84 /* 85 * Dataset properties are identified by these constants and must be added to 86 * the end of this list to ensure that external consumers are not affected 87 * by the change. If you make any changes to this list, be sure to update 88 * the property table in usr/src/common/zfs/zfs_prop.c. 89 */ 90 typedef enum { 91 ZPROP_CONT = -2, 92 ZPROP_INVAL = -1, 93 ZFS_PROP_TYPE = 0, 94 ZFS_PROP_CREATION, 95 ZFS_PROP_USED, 96 ZFS_PROP_AVAILABLE, 97 ZFS_PROP_REFERENCED, 98 ZFS_PROP_COMPRESSRATIO, 99 ZFS_PROP_MOUNTED, 100 ZFS_PROP_ORIGIN, 101 ZFS_PROP_QUOTA, 102 ZFS_PROP_RESERVATION, 103 ZFS_PROP_VOLSIZE, 104 ZFS_PROP_VOLBLOCKSIZE, 105 ZFS_PROP_RECORDSIZE, 106 ZFS_PROP_MOUNTPOINT, 107 ZFS_PROP_SHARENFS, 108 ZFS_PROP_CHECKSUM, 109 ZFS_PROP_COMPRESSION, 110 ZFS_PROP_ATIME, 111 ZFS_PROP_DEVICES, 112 ZFS_PROP_EXEC, 113 ZFS_PROP_SETUID, 114 ZFS_PROP_READONLY, 115 ZFS_PROP_ZONED, 116 ZFS_PROP_SNAPDIR, 117 ZFS_PROP_ACLMODE, 118 ZFS_PROP_ACLINHERIT, 119 ZFS_PROP_CREATETXG, 120 ZFS_PROP_NAME, /* not exposed to the user */ 121 ZFS_PROP_CANMOUNT, 122 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 123 ZFS_PROP_XATTR, 124 ZFS_PROP_NUMCLONES, /* not exposed to the user */ 125 ZFS_PROP_COPIES, 126 ZFS_PROP_VERSION, 127 ZFS_PROP_UTF8ONLY, 128 ZFS_PROP_NORMALIZE, 129 ZFS_PROP_CASE, 130 ZFS_PROP_VSCAN, 131 ZFS_PROP_NBMAND, 132 ZFS_PROP_SHARESMB, 133 ZFS_PROP_REFQUOTA, 134 ZFS_PROP_REFRESERVATION, 135 ZFS_PROP_GUID, 136 ZFS_PROP_PRIMARYCACHE, 137 ZFS_PROP_SECONDARYCACHE, 138 ZFS_PROP_USEDSNAP, 139 ZFS_PROP_USEDDS, 140 ZFS_PROP_USEDCHILD, 141 ZFS_PROP_USEDREFRESERV, 142 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */ 143 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */ 144 ZFS_PROP_DEFER_DESTROY, 145 ZFS_PROP_USERREFS, 146 ZFS_PROP_LOGBIAS, 147 ZFS_PROP_UNIQUE, /* not exposed to the user */ 148 ZFS_PROP_OBJSETID, /* not exposed to the user */ 149 ZFS_PROP_DEDUP, 150 ZFS_PROP_MLSLABEL, 151 ZFS_PROP_SYNC, 152 ZFS_PROP_DNODESIZE, 153 ZFS_PROP_REFRATIO, 154 ZFS_PROP_WRITTEN, 155 ZFS_PROP_CLONES, 156 ZFS_PROP_LOGICALUSED, 157 ZFS_PROP_LOGICALREFERENCED, 158 ZFS_PROP_INCONSISTENT, /* not exposed to the user */ 159 ZFS_PROP_FILESYSTEM_LIMIT, 160 ZFS_PROP_SNAPSHOT_LIMIT, 161 ZFS_PROP_FILESYSTEM_COUNT, 162 ZFS_PROP_SNAPSHOT_COUNT, 163 ZFS_PROP_REDUNDANT_METADATA, 164 ZFS_PROP_PREV_SNAP, 165 ZFS_PROP_RECEIVE_RESUME_TOKEN, 166 ZFS_PROP_REMAPTXG, /* not exposed to the user */ 167 ZFS_PROP_SPECIAL_SMALL_BLOCKS, 168 ZFS_NUM_PROPS 169 } zfs_prop_t; 170 171 typedef enum { 172 ZFS_PROP_USERUSED, 173 ZFS_PROP_USERQUOTA, 174 ZFS_PROP_GROUPUSED, 175 ZFS_PROP_GROUPQUOTA, 176 ZFS_NUM_USERQUOTA_PROPS 177 } zfs_userquota_prop_t; 178 179 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS]; 180 181 /* 182 * Pool properties are identified by these constants and must be added to the 183 * end of this list to ensure that external consumers are not affected 184 * by the change. If you make any changes to this list, be sure to update 185 * the property table in usr/src/common/zfs/zpool_prop.c. 186 */ 187 typedef enum { 188 ZPOOL_PROP_INVAL = -1, 189 ZPOOL_PROP_NAME, 190 ZPOOL_PROP_SIZE, 191 ZPOOL_PROP_CAPACITY, 192 ZPOOL_PROP_ALTROOT, 193 ZPOOL_PROP_HEALTH, 194 ZPOOL_PROP_GUID, 195 ZPOOL_PROP_VERSION, 196 ZPOOL_PROP_BOOTFS, 197 ZPOOL_PROP_DELEGATION, 198 ZPOOL_PROP_AUTOREPLACE, 199 ZPOOL_PROP_CACHEFILE, 200 ZPOOL_PROP_FAILUREMODE, 201 ZPOOL_PROP_LISTSNAPS, 202 ZPOOL_PROP_AUTOEXPAND, 203 ZPOOL_PROP_DEDUPDITTO, 204 ZPOOL_PROP_DEDUPRATIO, 205 ZPOOL_PROP_FREE, 206 ZPOOL_PROP_ALLOCATED, 207 ZPOOL_PROP_READONLY, 208 ZPOOL_PROP_COMMENT, 209 ZPOOL_PROP_EXPANDSZ, 210 ZPOOL_PROP_FREEING, 211 ZPOOL_PROP_FRAGMENTATION, 212 ZPOOL_PROP_LEAKED, 213 ZPOOL_PROP_MAXBLOCKSIZE, 214 ZPOOL_PROP_BOOTSIZE, 215 ZPOOL_PROP_CHECKPOINT, 216 ZPOOL_PROP_TNAME, 217 ZPOOL_PROP_MAXDNODESIZE, 218 ZPOOL_PROP_MULTIHOST, 219 ZPOOL_NUM_PROPS 220 } zpool_prop_t; 221 222 /* Small enough to not hog a whole line of printout in zpool(1M). */ 223 #define ZPROP_MAX_COMMENT 32 224 225 #define ZPROP_VALUE "value" 226 #define ZPROP_SOURCE "source" 227 228 typedef enum { 229 ZPROP_SRC_NONE = 0x1, 230 ZPROP_SRC_DEFAULT = 0x2, 231 ZPROP_SRC_TEMPORARY = 0x4, 232 ZPROP_SRC_LOCAL = 0x8, 233 ZPROP_SRC_INHERITED = 0x10, 234 ZPROP_SRC_RECEIVED = 0x20 235 } zprop_source_t; 236 237 #define ZPROP_SRC_ALL 0x3f 238 239 #define ZPROP_SOURCE_VAL_RECVD "$recvd" 240 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS" 241 /* 242 * Dataset flag implemented as a special entry in the props zap object 243 * indicating that the dataset has received properties on or after 244 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties 245 * just as it did in earlier versions, and thereafter, local properties are 246 * preserved. 247 */ 248 #define ZPROP_HAS_RECVD "$hasrecvd" 249 250 typedef enum { 251 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */ 252 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */ 253 } zprop_errflags_t; 254 255 typedef int (*zprop_func)(int, void *); 256 257 /* 258 * Properties to be set on the root file system of a new pool 259 * are stuffed into their own nvlist, which is then included in 260 * the properties nvlist with the pool properties. 261 */ 262 #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 263 264 /* 265 * Length of 'written@' and 'written#' 266 */ 267 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8 268 269 /* 270 * Dataset property functions shared between libzfs and kernel. 271 */ 272 const char *zfs_prop_default_string(zfs_prop_t); 273 uint64_t zfs_prop_default_numeric(zfs_prop_t); 274 boolean_t zfs_prop_readonly(zfs_prop_t); 275 boolean_t zfs_prop_visible(zfs_prop_t prop); 276 boolean_t zfs_prop_inheritable(zfs_prop_t); 277 boolean_t zfs_prop_setonce(zfs_prop_t); 278 const char *zfs_prop_to_name(zfs_prop_t); 279 zfs_prop_t zfs_name_to_prop(const char *); 280 boolean_t zfs_prop_user(const char *); 281 boolean_t zfs_prop_userquota(const char *); 282 boolean_t zfs_prop_written(const char *); 283 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 284 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 285 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed); 286 boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 287 288 /* 289 * Pool property functions shared between libzfs and kernel. 290 */ 291 zpool_prop_t zpool_name_to_prop(const char *); 292 const char *zpool_prop_to_name(zpool_prop_t); 293 const char *zpool_prop_default_string(zpool_prop_t); 294 uint64_t zpool_prop_default_numeric(zpool_prop_t); 295 boolean_t zpool_prop_readonly(zpool_prop_t); 296 boolean_t zpool_prop_feature(const char *); 297 boolean_t zpool_prop_unsupported(const char *name); 298 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 299 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 300 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed); 301 302 /* 303 * Definitions for the Delegation. 304 */ 305 typedef enum { 306 ZFS_DELEG_WHO_UNKNOWN = 0, 307 ZFS_DELEG_USER = 'u', 308 ZFS_DELEG_USER_SETS = 'U', 309 ZFS_DELEG_GROUP = 'g', 310 ZFS_DELEG_GROUP_SETS = 'G', 311 ZFS_DELEG_EVERYONE = 'e', 312 ZFS_DELEG_EVERYONE_SETS = 'E', 313 ZFS_DELEG_CREATE = 'c', 314 ZFS_DELEG_CREATE_SETS = 'C', 315 ZFS_DELEG_NAMED_SET = 's', 316 ZFS_DELEG_NAMED_SET_SETS = 'S' 317 } zfs_deleg_who_type_t; 318 319 typedef enum { 320 ZFS_DELEG_NONE = 0, 321 ZFS_DELEG_PERM_LOCAL = 1, 322 ZFS_DELEG_PERM_DESCENDENT = 2, 323 ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 324 ZFS_DELEG_PERM_CREATE = 4 325 } zfs_deleg_inherit_t; 326 327 #define ZFS_DELEG_PERM_UID "uid" 328 #define ZFS_DELEG_PERM_GID "gid" 329 #define ZFS_DELEG_PERM_GROUPS "groups" 330 331 #define ZFS_MLSLABEL_DEFAULT "none" 332 333 #define ZFS_SMB_ACL_SRC "src" 334 #define ZFS_SMB_ACL_TARGET "target" 335 336 typedef enum { 337 ZFS_CANMOUNT_OFF = 0, 338 ZFS_CANMOUNT_ON = 1, 339 ZFS_CANMOUNT_NOAUTO = 2 340 } zfs_canmount_type_t; 341 342 typedef enum { 343 ZFS_LOGBIAS_LATENCY = 0, 344 ZFS_LOGBIAS_THROUGHPUT = 1 345 } zfs_logbias_op_t; 346 347 typedef enum zfs_share_op { 348 ZFS_SHARE_NFS = 0, 349 ZFS_UNSHARE_NFS = 1, 350 ZFS_SHARE_SMB = 2, 351 ZFS_UNSHARE_SMB = 3 352 } zfs_share_op_t; 353 354 typedef enum zfs_smb_acl_op { 355 ZFS_SMB_ACL_ADD, 356 ZFS_SMB_ACL_REMOVE, 357 ZFS_SMB_ACL_RENAME, 358 ZFS_SMB_ACL_PURGE 359 } zfs_smb_acl_op_t; 360 361 typedef enum zfs_cache_type { 362 ZFS_CACHE_NONE = 0, 363 ZFS_CACHE_METADATA = 1, 364 ZFS_CACHE_ALL = 2 365 } zfs_cache_type_t; 366 367 typedef enum { 368 ZFS_SYNC_STANDARD = 0, 369 ZFS_SYNC_ALWAYS = 1, 370 ZFS_SYNC_DISABLED = 2 371 } zfs_sync_type_t; 372 373 typedef enum { 374 ZFS_DNSIZE_LEGACY = 0, 375 ZFS_DNSIZE_AUTO = 1, 376 ZFS_DNSIZE_1K = 1024, 377 ZFS_DNSIZE_2K = 2048, 378 ZFS_DNSIZE_4K = 4096, 379 ZFS_DNSIZE_8K = 8192, 380 ZFS_DNSIZE_16K = 16384 381 } zfs_dnsize_type_t; 382 383 typedef enum { 384 ZFS_REDUNDANT_METADATA_ALL, 385 ZFS_REDUNDANT_METADATA_MOST 386 } zfs_redundant_metadata_type_t; 387 388 /* 389 * On-disk version number. 390 */ 391 #define SPA_VERSION_1 1ULL 392 #define SPA_VERSION_2 2ULL 393 #define SPA_VERSION_3 3ULL 394 #define SPA_VERSION_4 4ULL 395 #define SPA_VERSION_5 5ULL 396 #define SPA_VERSION_6 6ULL 397 #define SPA_VERSION_7 7ULL 398 #define SPA_VERSION_8 8ULL 399 #define SPA_VERSION_9 9ULL 400 #define SPA_VERSION_10 10ULL 401 #define SPA_VERSION_11 11ULL 402 #define SPA_VERSION_12 12ULL 403 #define SPA_VERSION_13 13ULL 404 #define SPA_VERSION_14 14ULL 405 #define SPA_VERSION_15 15ULL 406 #define SPA_VERSION_16 16ULL 407 #define SPA_VERSION_17 17ULL 408 #define SPA_VERSION_18 18ULL 409 #define SPA_VERSION_19 19ULL 410 #define SPA_VERSION_20 20ULL 411 #define SPA_VERSION_21 21ULL 412 #define SPA_VERSION_22 22ULL 413 #define SPA_VERSION_23 23ULL 414 #define SPA_VERSION_24 24ULL 415 #define SPA_VERSION_25 25ULL 416 #define SPA_VERSION_26 26ULL 417 #define SPA_VERSION_27 27ULL 418 #define SPA_VERSION_28 28ULL 419 #define SPA_VERSION_5000 5000ULL 420 421 /* 422 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 423 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*}, 424 * and do the appropriate changes. Also bump the version number in 425 * usr/src/grub/capability. 426 */ 427 #define SPA_VERSION SPA_VERSION_5000 428 #define SPA_VERSION_STRING "5000" 429 430 /* 431 * Symbolic names for the changes that caused a SPA_VERSION switch. 432 * Used in the code when checking for presence or absence of a feature. 433 * Feel free to define multiple symbolic names for each version if there 434 * were multiple changes to on-disk structures during that version. 435 * 436 * NOTE: When checking the current SPA_VERSION in your code, be sure 437 * to use spa_version() since it reports the version of the 438 * last synced uberblock. Checking the in-flight version can 439 * be dangerous in some cases. 440 */ 441 #define SPA_VERSION_INITIAL SPA_VERSION_1 442 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 443 #define SPA_VERSION_SPARES SPA_VERSION_3 444 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3 445 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3 446 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 447 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 448 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 449 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 450 #define SPA_VERSION_BOOTFS SPA_VERSION_6 451 #define SPA_VERSION_SLOGS SPA_VERSION_7 452 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 453 #define SPA_VERSION_FUID SPA_VERSION_9 454 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 455 #define SPA_VERSION_REFQUOTA SPA_VERSION_9 456 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 457 #define SPA_VERSION_L2CACHE SPA_VERSION_10 458 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 459 #define SPA_VERSION_ORIGIN SPA_VERSION_11 460 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 461 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 462 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 463 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14 464 #define SPA_VERSION_USERSPACE SPA_VERSION_15 465 #define SPA_VERSION_STMF_PROP SPA_VERSION_16 466 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17 467 #define SPA_VERSION_USERREFS SPA_VERSION_18 468 #define SPA_VERSION_HOLES SPA_VERSION_19 469 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20 470 #define SPA_VERSION_DEDUP SPA_VERSION_21 471 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22 472 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23 473 #define SPA_VERSION_SA SPA_VERSION_24 474 #define SPA_VERSION_SCAN SPA_VERSION_25 475 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26 476 #define SPA_VERSION_DEADLISTS SPA_VERSION_26 477 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27 478 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28 479 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28 480 #define SPA_VERSION_FEATURES SPA_VERSION_5000 481 482 #define SPA_VERSION_IS_SUPPORTED(v) \ 483 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \ 484 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION)) 485 486 /* 487 * ZPL version - rev'd whenever an incompatible on-disk format change 488 * occurs. This is independent of SPA/DMU/ZAP versioning. You must 489 * also update the version_table[] and help message in zfs_prop.c. 490 * 491 * When changing, be sure to teach GRUB how to read the new format! 492 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*} 493 */ 494 #define ZPL_VERSION_1 1ULL 495 #define ZPL_VERSION_2 2ULL 496 #define ZPL_VERSION_3 3ULL 497 #define ZPL_VERSION_4 4ULL 498 #define ZPL_VERSION_5 5ULL 499 #define ZPL_VERSION ZPL_VERSION_5 500 #define ZPL_VERSION_STRING "5" 501 502 #define ZPL_VERSION_INITIAL ZPL_VERSION_1 503 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 504 #define ZPL_VERSION_FUID ZPL_VERSION_3 505 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 506 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 507 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4 508 #define ZPL_VERSION_SA ZPL_VERSION_5 509 510 /* Rewind policy information */ 511 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */ 512 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */ 513 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */ 514 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */ 515 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */ 516 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */ 517 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */ 518 519 typedef struct zpool_load_policy { 520 uint32_t zlp_rewind; /* rewind policy requested */ 521 uint64_t zlp_maxmeta; /* max acceptable meta-data errors */ 522 uint64_t zlp_maxdata; /* max acceptable data errors */ 523 uint64_t zlp_txg; /* specific txg to load */ 524 } zpool_load_policy_t; 525 526 /* 527 * The following are configuration names used in the nvlist describing a pool's 528 * configuration. New on-disk names should be prefixed with "<reverse-DNS>:" 529 * (e.g. "org.open-zfs:") to avoid conflicting names being developed 530 * independently. 531 */ 532 #define ZPOOL_CONFIG_VERSION "version" 533 #define ZPOOL_CONFIG_POOL_NAME "name" 534 #define ZPOOL_CONFIG_POOL_STATE "state" 535 #define ZPOOL_CONFIG_POOL_TXG "txg" 536 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 537 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 538 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 539 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 540 #define ZPOOL_CONFIG_TYPE "type" 541 #define ZPOOL_CONFIG_CHILDREN "children" 542 #define ZPOOL_CONFIG_ID "id" 543 #define ZPOOL_CONFIG_GUID "guid" 544 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object" 545 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births" 546 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev" 547 #define ZPOOL_CONFIG_PATH "path" 548 #define ZPOOL_CONFIG_DEVID "devid" 549 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 550 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 551 #define ZPOOL_CONFIG_ASHIFT "ashift" 552 #define ZPOOL_CONFIG_ASIZE "asize" 553 #define ZPOOL_CONFIG_DTL "DTL" 554 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */ 555 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */ 556 #define ZPOOL_CONFIG_CHECKPOINT_STATS "checkpoint_stats" /* not on disk */ 557 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */ 558 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */ 559 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 560 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 561 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 562 #define ZPOOL_CONFIG_SPARES "spares" 563 #define ZPOOL_CONFIG_IS_SPARE "is_spare" 564 #define ZPOOL_CONFIG_NPARITY "nparity" 565 #define ZPOOL_CONFIG_HOSTID "hostid" 566 #define ZPOOL_CONFIG_HOSTNAME "hostname" 567 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time" 568 #define ZPOOL_CONFIG_UNSPARE "unspare" 569 #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 570 #define ZPOOL_CONFIG_IS_LOG "is_log" 571 #define ZPOOL_CONFIG_L2CACHE "l2cache" 572 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array" 573 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children" 574 #define ZPOOL_CONFIG_IS_HOLE "is_hole" 575 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram" 576 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats" 577 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats" 578 #define ZPOOL_CONFIG_SPLIT "splitcfg" 579 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid" 580 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid" 581 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list" 582 #define ZPOOL_CONFIG_REMOVING "removing" 583 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg" 584 #define ZPOOL_CONFIG_COMMENT "comment" 585 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 586 #define ZPOOL_CONFIG_SUSPENDED_REASON "suspended_reason" /* not stored */ 587 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 588 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 589 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */ 590 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */ 591 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */ 592 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */ 593 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */ 594 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */ 595 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read" 596 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */ 597 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top" 598 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf" 599 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps" 600 #define ZPOOL_CONFIG_RESILVER_DEFER "com.datto:resilver_defer" 601 #define ZPOOL_CONFIG_CACHEFILE "cachefile" /* not stored on disk */ 602 #define ZPOOL_CONFIG_MMP_STATE "mmp_state" /* not stored on disk */ 603 #define ZPOOL_CONFIG_MMP_TXG "mmp_txg" /* not stored on disk */ 604 #define ZPOOL_CONFIG_MMP_HOSTNAME "mmp_hostname" /* not stored on disk */ 605 #define ZPOOL_CONFIG_MMP_HOSTID "mmp_hostid" /* not stored on disk */ 606 #define ZPOOL_CONFIG_ALLOCATION_BIAS "alloc_bias" /* not stored on disk */ 607 608 /* 609 * The persistent vdev state is stored as separate values rather than a single 610 * 'vdev_state' entry. This is because a device can be in multiple states, such 611 * as offline and degraded. 612 */ 613 #define ZPOOL_CONFIG_OFFLINE "offline" 614 #define ZPOOL_CONFIG_FAULTED "faulted" 615 #define ZPOOL_CONFIG_DEGRADED "degraded" 616 #define ZPOOL_CONFIG_REMOVED "removed" 617 #define ZPOOL_CONFIG_FRU "fru" 618 #define ZPOOL_CONFIG_AUX_STATE "aux_state" 619 620 /* Pool load policy parameters */ 621 #define ZPOOL_LOAD_POLICY "load-policy" 622 #define ZPOOL_LOAD_REWIND_POLICY "load-rewind-policy" 623 #define ZPOOL_LOAD_REQUEST_TXG "load-request-txg" 624 #define ZPOOL_LOAD_META_THRESH "load-meta-thresh" 625 #define ZPOOL_LOAD_DATA_THRESH "load-data-thresh" 626 627 /* Rewind data discovered */ 628 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts" 629 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors" 630 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind" 631 632 #define VDEV_TYPE_ROOT "root" 633 #define VDEV_TYPE_MIRROR "mirror" 634 #define VDEV_TYPE_REPLACING "replacing" 635 #define VDEV_TYPE_RAIDZ "raidz" 636 #define VDEV_TYPE_DISK "disk" 637 #define VDEV_TYPE_FILE "file" 638 #define VDEV_TYPE_MISSING "missing" 639 #define VDEV_TYPE_HOLE "hole" 640 #define VDEV_TYPE_SPARE "spare" 641 #define VDEV_TYPE_LOG "log" 642 #define VDEV_TYPE_L2CACHE "l2cache" 643 #define VDEV_TYPE_INDIRECT "indirect" 644 645 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */ 646 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \ 647 "com.delphix:indirect_obsolete_sm" 648 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \ 649 "com.delphix:obsolete_counts_are_precise" 650 #define VDEV_TOP_ZAP_POOL_CHECKPOINT_SM \ 651 "com.delphix:pool_checkpoint_sm" 652 653 #define VDEV_TOP_ZAP_ALLOCATION_BIAS \ 654 "org.zfsonlinux:allocation_bias" 655 656 /* vdev metaslab allocation bias */ 657 #define VDEV_ALLOC_BIAS_LOG "log" 658 #define VDEV_ALLOC_BIAS_SPECIAL "special" 659 #define VDEV_ALLOC_BIAS_DEDUP "dedup" 660 661 #define VDEV_LEAF_ZAP_INITIALIZE_LAST_OFFSET \ 662 "com.delphix:next_offset_to_initialize" 663 #define VDEV_LEAF_ZAP_INITIALIZE_STATE \ 664 "com.delphix:vdev_initialize_state" 665 #define VDEV_LEAF_ZAP_INITIALIZE_ACTION_TIME \ 666 "com.delphix:vdev_initialize_action_time" 667 668 /* 669 * This is needed in userland to report the minimum necessary device size. 670 * 671 * Note that the zfs test suite uses 64MB vdevs. 672 */ 673 #define SPA_MINDEVSIZE (64ULL << 20) 674 675 /* 676 * Set if the fragmentation has not yet been calculated. This can happen 677 * because the space maps have not been upgraded or the histogram feature 678 * is not enabled. 679 */ 680 #define ZFS_FRAG_INVALID UINT64_MAX 681 682 /* 683 * The location of the pool configuration repository, shared between kernel and 684 * userland. 685 */ 686 #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 687 688 /* 689 * vdev states are ordered from least to most healthy. 690 * A vdev that's CANT_OPEN or below is considered unusable. 691 */ 692 typedef enum vdev_state { 693 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 694 VDEV_STATE_CLOSED, /* Not currently open */ 695 VDEV_STATE_OFFLINE, /* Not allowed to open */ 696 VDEV_STATE_REMOVED, /* Explicitly removed from system */ 697 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 698 VDEV_STATE_FAULTED, /* External request to fault device */ 699 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 700 VDEV_STATE_HEALTHY /* Presumed good */ 701 } vdev_state_t; 702 703 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 704 705 /* 706 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 707 * of the vdev stats structure uses these constants to distinguish why. 708 */ 709 typedef enum vdev_aux { 710 VDEV_AUX_NONE, /* no error */ 711 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 712 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 713 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 714 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 715 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 716 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 717 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 718 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 719 VDEV_AUX_UNSUP_FEAT, /* unsupported features */ 720 VDEV_AUX_SPARED, /* hot spare used in another pool */ 721 VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 722 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 723 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */ 724 VDEV_AUX_EXTERNAL, /* external diagnosis */ 725 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */ 726 VDEV_AUX_ACTIVE, /* vdev active on a different host */ 727 VDEV_AUX_CHILDREN_OFFLINE /* all children are offline */ 728 } vdev_aux_t; 729 730 /* 731 * pool state. The following states are written to disk as part of the normal 732 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 733 * states are software abstractions used at various levels to communicate 734 * pool state. 735 */ 736 typedef enum pool_state { 737 POOL_STATE_ACTIVE = 0, /* In active use */ 738 POOL_STATE_EXPORTED, /* Explicitly exported */ 739 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 740 POOL_STATE_SPARE, /* Reserved for hot spare use */ 741 POOL_STATE_L2CACHE, /* Level 2 ARC device */ 742 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 743 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 744 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 745 } pool_state_t; 746 747 /* 748 * mmp state. The following states provide additional detail describing 749 * why a pool couldn't be safely imported. 750 */ 751 typedef enum mmp_state { 752 MMP_STATE_ACTIVE = 0, /* In active use */ 753 MMP_STATE_INACTIVE, /* Inactive and safe to import */ 754 MMP_STATE_NO_HOSTID /* System hostid is not set */ 755 } mmp_state_t; 756 757 /* 758 * Scan Functions. 759 */ 760 typedef enum pool_scan_func { 761 POOL_SCAN_NONE, 762 POOL_SCAN_SCRUB, 763 POOL_SCAN_RESILVER, 764 POOL_SCAN_FUNCS 765 } pool_scan_func_t; 766 767 /* 768 * Used to control scrub pause and resume. 769 */ 770 typedef enum pool_scrub_cmd { 771 POOL_SCRUB_NORMAL = 0, 772 POOL_SCRUB_PAUSE, 773 POOL_SCRUB_FLAGS_END 774 } pool_scrub_cmd_t; 775 776 /* 777 * Initialize functions. 778 */ 779 typedef enum pool_initialize_func { 780 POOL_INITIALIZE_DO, 781 POOL_INITIALIZE_CANCEL, 782 POOL_INITIALIZE_SUSPEND, 783 POOL_INITIALIZE_FUNCS 784 } pool_initialize_func_t; 785 786 /* 787 * ZIO types. Needed to interpret vdev statistics below. 788 */ 789 typedef enum zio_type { 790 ZIO_TYPE_NULL = 0, 791 ZIO_TYPE_READ, 792 ZIO_TYPE_WRITE, 793 ZIO_TYPE_FREE, 794 ZIO_TYPE_CLAIM, 795 ZIO_TYPE_IOCTL, 796 ZIO_TYPES 797 } zio_type_t; 798 799 /* 800 * Pool statistics. Note: all fields should be 64-bit because this 801 * is passed between kernel and userland as an nvlist uint64 array. 802 */ 803 typedef struct pool_scan_stat { 804 /* values stored on disk */ 805 uint64_t pss_func; /* pool_scan_func_t */ 806 uint64_t pss_state; /* dsl_scan_state_t */ 807 uint64_t pss_start_time; /* scan start time */ 808 uint64_t pss_end_time; /* scan end time */ 809 uint64_t pss_to_examine; /* total bytes to scan */ 810 uint64_t pss_examined; /* total bytes located by scanner */ 811 uint64_t pss_to_process; /* total bytes to process */ 812 uint64_t pss_processed; /* total processed bytes */ 813 uint64_t pss_errors; /* scan errors */ 814 815 /* values not stored on disk */ 816 uint64_t pss_pass_exam; /* examined bytes per scan pass */ 817 uint64_t pss_pass_issued; /* issued bytes per scan pass */ 818 uint64_t pss_pass_start; /* start time of a scan pass */ 819 uint64_t pss_pass_scrub_pause; /* pause time of a scurb pass */ 820 /* cumulative time scrub spent paused, needed for rate calculation */ 821 uint64_t pss_pass_scrub_spent_paused; 822 823 /* Sorted scrubbing new fields */ 824 /* Stored on disk */ 825 uint64_t pss_issued; /* total bytes checked by scanner */ 826 } pool_scan_stat_t; 827 828 typedef struct pool_removal_stat { 829 uint64_t prs_state; /* dsl_scan_state_t */ 830 uint64_t prs_removing_vdev; 831 uint64_t prs_start_time; 832 uint64_t prs_end_time; 833 uint64_t prs_to_copy; /* bytes that need to be copied */ 834 uint64_t prs_copied; /* bytes copied so far */ 835 /* 836 * bytes of memory used for indirect mappings. 837 * This includes all removed vdevs. 838 */ 839 uint64_t prs_mapping_memory; 840 } pool_removal_stat_t; 841 842 typedef enum dsl_scan_state { 843 DSS_NONE, 844 DSS_SCANNING, 845 DSS_FINISHED, 846 DSS_CANCELED, 847 DSS_NUM_STATES 848 } dsl_scan_state_t; 849 850 typedef enum { 851 CS_NONE, 852 CS_CHECKPOINT_EXISTS, 853 CS_CHECKPOINT_DISCARDING, 854 CS_NUM_STATES 855 } checkpoint_state_t; 856 857 typedef struct pool_checkpoint_stat { 858 uint64_t pcs_state; /* checkpoint_state_t */ 859 uint64_t pcs_start_time; /* time checkpoint/discard started */ 860 uint64_t pcs_space; /* checkpointed space */ 861 } pool_checkpoint_stat_t; 862 863 typedef enum { 864 VDEV_INITIALIZE_NONE, 865 VDEV_INITIALIZE_ACTIVE, 866 VDEV_INITIALIZE_CANCELED, 867 VDEV_INITIALIZE_SUSPENDED, 868 VDEV_INITIALIZE_COMPLETE 869 } vdev_initializing_state_t; 870 871 /* 872 * Vdev statistics. Note: all fields should be 64-bit because this 873 * is passed between kernel and userland as an nvlist uint64 array. 874 */ 875 typedef struct vdev_stat { 876 hrtime_t vs_timestamp; /* time since vdev load */ 877 uint64_t vs_state; /* vdev state */ 878 uint64_t vs_aux; /* see vdev_aux_t */ 879 uint64_t vs_alloc; /* space allocated */ 880 uint64_t vs_space; /* total capacity */ 881 uint64_t vs_dspace; /* deflated capacity */ 882 uint64_t vs_rsize; /* replaceable dev size */ 883 uint64_t vs_esize; /* expandable dev size */ 884 uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 885 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 886 uint64_t vs_read_errors; /* read errors */ 887 uint64_t vs_write_errors; /* write errors */ 888 uint64_t vs_checksum_errors; /* checksum errors */ 889 uint64_t vs_initialize_errors; /* initializing errors */ 890 uint64_t vs_self_healed; /* self-healed bytes */ 891 uint64_t vs_scan_removing; /* removing? */ 892 uint64_t vs_scan_processed; /* scan processed bytes */ 893 uint64_t vs_fragmentation; /* device fragmentation */ 894 uint64_t vs_initialize_bytes_done; /* bytes initialized */ 895 uint64_t vs_initialize_bytes_est; /* total bytes to initialize */ 896 uint64_t vs_initialize_state; /* vdev_initialzing_state_t */ 897 uint64_t vs_initialize_action_time; /* time_t */ 898 uint64_t vs_checkpoint_space; /* checkpoint-consumed space */ 899 uint64_t vs_resilver_deferred; /* resilver deferred */ 900 } vdev_stat_t; 901 902 /* 903 * DDT statistics. Note: all fields should be 64-bit because this 904 * is passed between kernel and userland as an nvlist uint64 array. 905 */ 906 typedef struct ddt_object { 907 uint64_t ddo_count; /* number of elments in ddt */ 908 uint64_t ddo_dspace; /* size of ddt on disk */ 909 uint64_t ddo_mspace; /* size of ddt in-core */ 910 } ddt_object_t; 911 912 typedef struct ddt_stat { 913 uint64_t dds_blocks; /* blocks */ 914 uint64_t dds_lsize; /* logical size */ 915 uint64_t dds_psize; /* physical size */ 916 uint64_t dds_dsize; /* deflated allocated size */ 917 uint64_t dds_ref_blocks; /* referenced blocks */ 918 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */ 919 uint64_t dds_ref_psize; /* referenced psize * refcnt */ 920 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */ 921 } ddt_stat_t; 922 923 typedef struct ddt_histogram { 924 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */ 925 } ddt_histogram_t; 926 927 #define ZVOL_DRIVER "zvol" 928 #define ZFS_DRIVER "zfs" 929 #define ZFS_DEV "/dev/zfs" 930 #define ZFS_DISK_ROOT "/dev/dsk" 931 #define ZFS_DISK_ROOTD ZFS_DISK_ROOT "/" 932 #define ZFS_RDISK_ROOT "/dev/rdsk" 933 #define ZFS_RDISK_ROOTD ZFS_RDISK_ROOT "/" 934 935 /* general zvol path */ 936 #define ZVOL_DIR "/dev/zvol" 937 /* expansion */ 938 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:" 939 /* for dump and swap */ 940 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/" 941 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/" 942 943 #define ZVOL_PROP_NAME "name" 944 #define ZVOL_DEFAULT_BLOCKSIZE 8192 945 946 /* 947 * /dev/zfs ioctl numbers. 948 */ 949 typedef enum zfs_ioc { 950 ZFS_IOC_FIRST = ('Z' << 8), 951 ZFS_IOC = ZFS_IOC_FIRST, 952 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, 953 ZFS_IOC_POOL_DESTROY, 954 ZFS_IOC_POOL_IMPORT, 955 ZFS_IOC_POOL_EXPORT, 956 ZFS_IOC_POOL_CONFIGS, 957 ZFS_IOC_POOL_STATS, 958 ZFS_IOC_POOL_TRYIMPORT, 959 ZFS_IOC_POOL_SCAN, 960 ZFS_IOC_POOL_FREEZE, 961 ZFS_IOC_POOL_UPGRADE, 962 ZFS_IOC_POOL_GET_HISTORY, 963 ZFS_IOC_VDEV_ADD, 964 ZFS_IOC_VDEV_REMOVE, 965 ZFS_IOC_VDEV_SET_STATE, 966 ZFS_IOC_VDEV_ATTACH, 967 ZFS_IOC_VDEV_DETACH, 968 ZFS_IOC_VDEV_SETPATH, 969 ZFS_IOC_VDEV_SETFRU, 970 ZFS_IOC_OBJSET_STATS, 971 ZFS_IOC_OBJSET_ZPLPROPS, 972 ZFS_IOC_DATASET_LIST_NEXT, 973 ZFS_IOC_SNAPSHOT_LIST_NEXT, 974 ZFS_IOC_SET_PROP, 975 ZFS_IOC_CREATE, 976 ZFS_IOC_DESTROY, 977 ZFS_IOC_ROLLBACK, 978 ZFS_IOC_RENAME, 979 ZFS_IOC_RECV, 980 ZFS_IOC_SEND, 981 ZFS_IOC_INJECT_FAULT, 982 ZFS_IOC_CLEAR_FAULT, 983 ZFS_IOC_INJECT_LIST_NEXT, 984 ZFS_IOC_ERROR_LOG, 985 ZFS_IOC_CLEAR, 986 ZFS_IOC_PROMOTE, 987 ZFS_IOC_SNAPSHOT, 988 ZFS_IOC_DSOBJ_TO_DSNAME, 989 ZFS_IOC_OBJ_TO_PATH, 990 ZFS_IOC_POOL_SET_PROPS, 991 ZFS_IOC_POOL_GET_PROPS, 992 ZFS_IOC_SET_FSACL, 993 ZFS_IOC_GET_FSACL, 994 ZFS_IOC_SHARE, 995 ZFS_IOC_INHERIT_PROP, 996 ZFS_IOC_SMB_ACL, 997 ZFS_IOC_USERSPACE_ONE, 998 ZFS_IOC_USERSPACE_MANY, 999 ZFS_IOC_USERSPACE_UPGRADE, 1000 ZFS_IOC_HOLD, 1001 ZFS_IOC_RELEASE, 1002 ZFS_IOC_GET_HOLDS, 1003 ZFS_IOC_OBJSET_RECVD_PROPS, 1004 ZFS_IOC_VDEV_SPLIT, 1005 ZFS_IOC_NEXT_OBJ, 1006 ZFS_IOC_DIFF, 1007 ZFS_IOC_TMP_SNAPSHOT, 1008 ZFS_IOC_OBJ_TO_STATS, 1009 ZFS_IOC_SPACE_WRITTEN, 1010 ZFS_IOC_SPACE_SNAPS, 1011 ZFS_IOC_DESTROY_SNAPS, 1012 ZFS_IOC_POOL_REGUID, 1013 ZFS_IOC_POOL_REOPEN, 1014 ZFS_IOC_SEND_PROGRESS, 1015 ZFS_IOC_LOG_HISTORY, 1016 ZFS_IOC_SEND_NEW, 1017 ZFS_IOC_SEND_SPACE, 1018 ZFS_IOC_CLONE, 1019 ZFS_IOC_BOOKMARK, 1020 ZFS_IOC_GET_BOOKMARKS, 1021 ZFS_IOC_DESTROY_BOOKMARKS, 1022 ZFS_IOC_CHANNEL_PROGRAM, 1023 ZFS_IOC_REMAP, 1024 ZFS_IOC_POOL_CHECKPOINT, 1025 ZFS_IOC_POOL_DISCARD_CHECKPOINT, 1026 ZFS_IOC_POOL_INITIALIZE, 1027 ZFS_IOC_POOL_SYNC, 1028 ZFS_IOC_LAST 1029 } zfs_ioc_t; 1030 1031 /* 1032 * ZFS-specific error codes used for returning descriptive errors 1033 * to the userland through zfs ioctls. 1034 * 1035 * The enum implicitly includes all the error codes from errno.h. 1036 * New code should use and extend this enum for errors that are 1037 * not described precisely by generic errno codes. 1038 */ 1039 typedef enum { 1040 ZFS_ERR_CHECKPOINT_EXISTS = 1024, 1041 ZFS_ERR_DISCARDING_CHECKPOINT, 1042 ZFS_ERR_NO_CHECKPOINT, 1043 ZFS_ERR_DEVRM_IN_PROGRESS, 1044 ZFS_ERR_VDEV_TOO_BIG 1045 } zfs_errno_t; 1046 1047 /* 1048 * Internal SPA load state. Used by FMA diagnosis engine. 1049 */ 1050 typedef enum { 1051 SPA_LOAD_NONE, /* no load in progress */ 1052 SPA_LOAD_OPEN, /* normal open */ 1053 SPA_LOAD_IMPORT, /* import in progress */ 1054 SPA_LOAD_TRYIMPORT, /* tryimport in progress */ 1055 SPA_LOAD_RECOVER, /* recovery requested */ 1056 SPA_LOAD_ERROR, /* load failed */ 1057 SPA_LOAD_CREATE /* creation in progress */ 1058 } spa_load_state_t; 1059 1060 /* 1061 * Bookmark name values. 1062 */ 1063 #define ZPOOL_ERR_LIST "error list" 1064 #define ZPOOL_ERR_DATASET "dataset" 1065 #define ZPOOL_ERR_OBJECT "object" 1066 1067 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 1068 1069 /* 1070 * The following are names used in the nvlist describing 1071 * the pool's history log. 1072 */ 1073 #define ZPOOL_HIST_RECORD "history record" 1074 #define ZPOOL_HIST_TIME "history time" 1075 #define ZPOOL_HIST_CMD "history command" 1076 #define ZPOOL_HIST_WHO "history who" 1077 #define ZPOOL_HIST_ZONE "history zone" 1078 #define ZPOOL_HIST_HOST "history hostname" 1079 #define ZPOOL_HIST_TXG "history txg" 1080 #define ZPOOL_HIST_INT_EVENT "history internal event" 1081 #define ZPOOL_HIST_INT_STR "history internal str" 1082 #define ZPOOL_HIST_INT_NAME "internal_name" 1083 #define ZPOOL_HIST_IOCTL "ioctl" 1084 #define ZPOOL_HIST_INPUT_NVL "in_nvl" 1085 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl" 1086 #define ZPOOL_HIST_DSNAME "dsname" 1087 #define ZPOOL_HIST_DSID "dsid" 1088 #define ZPOOL_HIST_ERRNO "errno" 1089 1090 /* 1091 * The following are names used when invoking ZFS_IOC_POOL_INITIALIZE. 1092 */ 1093 #define ZPOOL_INITIALIZE_COMMAND "initialize_command" 1094 #define ZPOOL_INITIALIZE_VDEVS "initialize_vdevs" 1095 1096 /* 1097 * Flags for ZFS_IOC_VDEV_SET_STATE 1098 */ 1099 #define ZFS_ONLINE_CHECKREMOVE 0x1 1100 #define ZFS_ONLINE_UNSPARE 0x2 1101 #define ZFS_ONLINE_FORCEFAULT 0x4 1102 #define ZFS_ONLINE_EXPAND 0x8 1103 #define ZFS_OFFLINE_TEMPORARY 0x1 1104 1105 /* 1106 * Flags for ZFS_IOC_POOL_IMPORT 1107 */ 1108 #define ZFS_IMPORT_NORMAL 0x0 1109 #define ZFS_IMPORT_VERBATIM 0x1 1110 #define ZFS_IMPORT_ANY_HOST 0x2 1111 #define ZFS_IMPORT_MISSING_LOG 0x4 1112 #define ZFS_IMPORT_ONLY 0x8 1113 #define ZFS_IMPORT_CHECKPOINT 0x10 1114 #define ZFS_IMPORT_TEMP_NAME 0x20 1115 #define ZFS_IMPORT_SKIP_MMP 0x40 1116 1117 /* 1118 * Channel program argument/return nvlist keys and defaults. 1119 */ 1120 #define ZCP_ARG_PROGRAM "program" 1121 #define ZCP_ARG_ARGLIST "arg" 1122 #define ZCP_ARG_SYNC "sync" 1123 #define ZCP_ARG_INSTRLIMIT "instrlimit" 1124 #define ZCP_ARG_MEMLIMIT "memlimit" 1125 1126 #define ZCP_ARG_CLIARGV "argv" 1127 1128 #define ZCP_RET_ERROR "error" 1129 #define ZCP_RET_RETURN "return" 1130 1131 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000) 1132 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT) 1133 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024) 1134 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT) 1135 1136 /* 1137 * Sysevent payload members. ZFS will generate the following sysevents with the 1138 * given payloads: 1139 * 1140 * ESC_ZFS_RESILVER_START 1141 * ESC_ZFS_RESILVER_END 1142 * ESC_ZFS_POOL_DESTROY 1143 * ESC_ZFS_POOL_REGUID 1144 * 1145 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1146 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1147 * 1148 * ESC_ZFS_VDEV_REMOVE 1149 * ESC_ZFS_VDEV_CLEAR 1150 * ESC_ZFS_VDEV_CHECK 1151 * 1152 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1153 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1154 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 1155 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 1156 * 1157 * ESC_ZFS_HISTORY_EVENT 1158 * 1159 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 1160 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 1161 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional) 1162 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional) 1163 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional) 1164 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional) 1165 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional) 1166 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional) 1167 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional) 1168 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional) 1169 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional) 1170 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional) 1171 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional) 1172 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional) 1173 * 1174 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the 1175 * history log nvlist. The keynames will be free of any spaces or other 1176 * characters that could be potentially unexpected to consumers of the 1177 * sysevents. 1178 */ 1179 #define ZFS_EV_POOL_NAME "pool_name" 1180 #define ZFS_EV_POOL_GUID "pool_guid" 1181 #define ZFS_EV_VDEV_PATH "vdev_path" 1182 #define ZFS_EV_VDEV_GUID "vdev_guid" 1183 #define ZFS_EV_HIST_TIME "history_time" 1184 #define ZFS_EV_HIST_CMD "history_command" 1185 #define ZFS_EV_HIST_WHO "history_who" 1186 #define ZFS_EV_HIST_ZONE "history_zone" 1187 #define ZFS_EV_HIST_HOST "history_hostname" 1188 #define ZFS_EV_HIST_TXG "history_txg" 1189 #define ZFS_EV_HIST_INT_EVENT "history_internal_event" 1190 #define ZFS_EV_HIST_INT_STR "history_internal_str" 1191 #define ZFS_EV_HIST_INT_NAME "history_internal_name" 1192 #define ZFS_EV_HIST_IOCTL "history_ioctl" 1193 #define ZFS_EV_HIST_DSNAME "history_dsname" 1194 #define ZFS_EV_HIST_DSID "history_dsid" 1195 1196 #ifdef __cplusplus 1197 } 1198 #endif 1199 1200 #endif /* _SYS_FS_ZFS_H */ 1201