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