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