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 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_FS_ZFS_H 27 #define _SYS_FS_ZFS_H 28 29 #ifdef __cplusplus 30 extern "C" { 31 #endif 32 33 /* 34 * Types and constants shared between userland and the kernel. 35 */ 36 37 /* 38 * Each dataset can be one of the following types. These constants can be 39 * combined into masks that can be passed to various functions. 40 */ 41 typedef enum { 42 ZFS_TYPE_FILESYSTEM = 0x1, 43 ZFS_TYPE_SNAPSHOT = 0x2, 44 ZFS_TYPE_VOLUME = 0x4, 45 ZFS_TYPE_POOL = 0x8 46 } zfs_type_t; 47 48 #define ZFS_TYPE_DATASET \ 49 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT) 50 51 /* 52 * Dataset properties are identified by these constants and must be added to 53 * the end of this list to ensure that external consumers are not affected 54 * by the change. If you make any changes to this list, be sure to update 55 * the property table in usr/src/common/zfs/zfs_prop.c. 56 */ 57 typedef enum { 58 ZFS_PROP_TYPE, 59 ZFS_PROP_CREATION, 60 ZFS_PROP_USED, 61 ZFS_PROP_AVAILABLE, 62 ZFS_PROP_REFERENCED, 63 ZFS_PROP_COMPRESSRATIO, 64 ZFS_PROP_MOUNTED, 65 ZFS_PROP_ORIGIN, 66 ZFS_PROP_QUOTA, 67 ZFS_PROP_RESERVATION, 68 ZFS_PROP_VOLSIZE, 69 ZFS_PROP_VOLBLOCKSIZE, 70 ZFS_PROP_RECORDSIZE, 71 ZFS_PROP_MOUNTPOINT, 72 ZFS_PROP_SHARENFS, 73 ZFS_PROP_CHECKSUM, 74 ZFS_PROP_COMPRESSION, 75 ZFS_PROP_ATIME, 76 ZFS_PROP_DEVICES, 77 ZFS_PROP_EXEC, 78 ZFS_PROP_SETUID, 79 ZFS_PROP_READONLY, 80 ZFS_PROP_ZONED, 81 ZFS_PROP_SNAPDIR, 82 ZFS_PROP_ACLMODE, 83 ZFS_PROP_ACLINHERIT, 84 ZFS_PROP_CREATETXG, /* not exposed to the user */ 85 ZFS_PROP_NAME, /* not exposed to the user */ 86 ZFS_PROP_CANMOUNT, 87 ZFS_PROP_SHAREISCSI, 88 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */ 89 ZFS_PROP_XATTR, 90 ZFS_PROP_NUMCLONES, /* not exposed to the user */ 91 ZFS_PROP_COPIES, 92 ZFS_PROP_VERSION, 93 ZFS_PROP_UTF8ONLY, 94 ZFS_PROP_NORMALIZE, 95 ZFS_PROP_CASE, 96 ZFS_PROP_VSCAN, 97 ZFS_PROP_NBMAND, 98 ZFS_PROP_SHARESMB, 99 ZFS_PROP_REFQUOTA, 100 ZFS_PROP_REFRESERVATION, 101 ZFS_PROP_GUID, 102 ZFS_PROP_PRIMARYCACHE, 103 ZFS_PROP_SECONDARYCACHE, 104 ZFS_PROP_USEDSNAP, 105 ZFS_PROP_USEDDS, 106 ZFS_PROP_USEDCHILD, 107 ZFS_PROP_USEDREFRESERV, 108 ZFS_NUM_PROPS 109 } zfs_prop_t; 110 111 /* 112 * Pool properties are identified by these constants and must be added to the 113 * end of this list to ensure that external consumers are not affected 114 * by the change. If you make any changes to this list, be sure to update 115 * the property table in usr/src/common/zfs/zpool_prop.c. 116 */ 117 typedef enum { 118 ZPOOL_PROP_NAME, 119 ZPOOL_PROP_SIZE, 120 ZPOOL_PROP_USED, 121 ZPOOL_PROP_AVAILABLE, 122 ZPOOL_PROP_CAPACITY, 123 ZPOOL_PROP_ALTROOT, 124 ZPOOL_PROP_HEALTH, 125 ZPOOL_PROP_GUID, 126 ZPOOL_PROP_VERSION, 127 ZPOOL_PROP_BOOTFS, 128 ZPOOL_PROP_DELEGATION, 129 ZPOOL_PROP_AUTOREPLACE, 130 ZPOOL_PROP_CACHEFILE, 131 ZPOOL_PROP_FAILUREMODE, 132 ZPOOL_PROP_LISTSNAPS, 133 ZPOOL_NUM_PROPS 134 } zpool_prop_t; 135 136 #define ZPROP_CONT -2 137 #define ZPROP_INVAL -1 138 139 #define ZPROP_VALUE "value" 140 #define ZPROP_SOURCE "source" 141 142 typedef enum { 143 ZPROP_SRC_NONE = 0x1, 144 ZPROP_SRC_DEFAULT = 0x2, 145 ZPROP_SRC_TEMPORARY = 0x4, 146 ZPROP_SRC_LOCAL = 0x8, 147 ZPROP_SRC_INHERITED = 0x10 148 } zprop_source_t; 149 150 #define ZPROP_SRC_ALL 0x1f 151 152 typedef int (*zprop_func)(int, void *); 153 154 /* 155 * Properties to be set on the root file system of a new pool 156 * are stuffed into their own nvlist, which is then included in 157 * the properties nvlist with the pool properties. 158 */ 159 #define ZPOOL_ROOTFS_PROPS "root-props-nvl" 160 161 /* 162 * Dataset property functions shared between libzfs and kernel. 163 */ 164 const char *zfs_prop_default_string(zfs_prop_t); 165 uint64_t zfs_prop_default_numeric(zfs_prop_t); 166 boolean_t zfs_prop_readonly(zfs_prop_t); 167 boolean_t zfs_prop_inheritable(zfs_prop_t); 168 boolean_t zfs_prop_setonce(zfs_prop_t); 169 const char *zfs_prop_to_name(zfs_prop_t); 170 zfs_prop_t zfs_name_to_prop(const char *); 171 boolean_t zfs_prop_user(const char *); 172 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **); 173 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *); 174 boolean_t zfs_prop_valid_for_type(int, zfs_type_t); 175 176 /* 177 * Pool property functions shared between libzfs and kernel. 178 */ 179 zpool_prop_t zpool_name_to_prop(const char *); 180 const char *zpool_prop_to_name(zpool_prop_t); 181 const char *zpool_prop_default_string(zpool_prop_t); 182 uint64_t zpool_prop_default_numeric(zpool_prop_t); 183 boolean_t zpool_prop_readonly(zpool_prop_t); 184 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **); 185 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *); 186 187 /* 188 * Definitions for the Delegation. 189 */ 190 typedef enum { 191 ZFS_DELEG_WHO_UNKNOWN = 0, 192 ZFS_DELEG_USER = 'u', 193 ZFS_DELEG_USER_SETS = 'U', 194 ZFS_DELEG_GROUP = 'g', 195 ZFS_DELEG_GROUP_SETS = 'G', 196 ZFS_DELEG_EVERYONE = 'e', 197 ZFS_DELEG_EVERYONE_SETS = 'E', 198 ZFS_DELEG_CREATE = 'c', 199 ZFS_DELEG_CREATE_SETS = 'C', 200 ZFS_DELEG_NAMED_SET = 's', 201 ZFS_DELEG_NAMED_SET_SETS = 'S' 202 } zfs_deleg_who_type_t; 203 204 typedef enum { 205 ZFS_DELEG_NONE = 0, 206 ZFS_DELEG_PERM_LOCAL = 1, 207 ZFS_DELEG_PERM_DESCENDENT = 2, 208 ZFS_DELEG_PERM_LOCALDESCENDENT = 3, 209 ZFS_DELEG_PERM_CREATE = 4 210 } zfs_deleg_inherit_t; 211 212 #define ZFS_DELEG_PERM_UID "uid" 213 #define ZFS_DELEG_PERM_GID "gid" 214 #define ZFS_DELEG_PERM_GROUPS "groups" 215 216 typedef enum { 217 ZFS_CANMOUNT_OFF = 0, 218 ZFS_CANMOUNT_ON = 1, 219 ZFS_CANMOUNT_NOAUTO = 2 220 } zfs_canmount_type_t; 221 222 typedef enum zfs_share_op { 223 ZFS_SHARE_NFS = 0, 224 ZFS_UNSHARE_NFS = 1, 225 ZFS_SHARE_SMB = 2, 226 ZFS_UNSHARE_SMB = 3 227 } zfs_share_op_t; 228 229 typedef enum zfs_cache_type { 230 ZFS_CACHE_NONE = 0, 231 ZFS_CACHE_METADATA = 1, 232 ZFS_CACHE_ALL = 2 233 } zfs_cache_type_t; 234 235 236 /* 237 * On-disk version number. 238 */ 239 #define SPA_VERSION_1 1ULL 240 #define SPA_VERSION_2 2ULL 241 #define SPA_VERSION_3 3ULL 242 #define SPA_VERSION_4 4ULL 243 #define SPA_VERSION_5 5ULL 244 #define SPA_VERSION_6 6ULL 245 #define SPA_VERSION_7 7ULL 246 #define SPA_VERSION_8 8ULL 247 #define SPA_VERSION_9 9ULL 248 #define SPA_VERSION_10 10ULL 249 #define SPA_VERSION_11 11ULL 250 #define SPA_VERSION_12 12ULL 251 #define SPA_VERSION_13 13ULL 252 /* 253 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk 254 * format change. Go to usr/src/grub/grub-0.95/stage2/{zfs-include/, fsys_zfs*}, 255 * and do the appropriate changes. 256 */ 257 #define SPA_VERSION SPA_VERSION_13 258 #define SPA_VERSION_STRING "13" 259 260 /* 261 * Symbolic names for the changes that caused a SPA_VERSION switch. 262 * Used in the code when checking for presence or absence of a feature. 263 * Feel free to define multiple symbolic names for each version if there 264 * were multiple changes to on-disk structures during that version. 265 * 266 * NOTE: When checking the current SPA_VERSION in your code, be sure 267 * to use spa_version() since it reports the version of the 268 * last synced uberblock. Checking the in-flight version can 269 * be dangerous in some cases. 270 */ 271 #define SPA_VERSION_INITIAL SPA_VERSION_1 272 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2 273 #define SPA_VERSION_SPARES SPA_VERSION_3 274 #define SPA_VERSION_RAID6 SPA_VERSION_3 275 #define SPA_VERSION_BPLIST_ACCOUNT SPA_VERSION_3 276 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3 277 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3 278 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4 279 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5 280 #define SPA_VERSION_BOOTFS SPA_VERSION_6 281 #define SPA_VERSION_SLOGS SPA_VERSION_7 282 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8 283 #define SPA_VERSION_FUID SPA_VERSION_9 284 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9 285 #define SPA_VERSION_REFQUOTA SPA_VERSION_9 286 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9 287 #define SPA_VERSION_L2CACHE SPA_VERSION_10 288 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11 289 #define SPA_VERSION_ORIGIN SPA_VERSION_11 290 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11 291 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12 292 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13 293 294 /* 295 * ZPL version - rev'd whenever an incompatible on-disk format change 296 * occurs. This is independent of SPA/DMU/ZAP versioning. You must 297 * also update the version_table[] and help message in zfs_prop.c. 298 * 299 * When changing, be sure to teach GRUB how to read the new format! 300 * See usr/src/grub/grub-0.95/stage2/{zfs-include/,fsys_zfs*} 301 */ 302 #define ZPL_VERSION_1 1ULL 303 #define ZPL_VERSION_2 2ULL 304 #define ZPL_VERSION_3 3ULL 305 #define ZPL_VERSION ZPL_VERSION_3 306 #define ZPL_VERSION_STRING "3" 307 308 #define ZPL_VERSION_INITIAL ZPL_VERSION_1 309 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2 310 #define ZPL_VERSION_FUID ZPL_VERSION_3 311 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3 312 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3 313 314 /* 315 * The following are configuration names used in the nvlist describing a pool's 316 * configuration. 317 */ 318 #define ZPOOL_CONFIG_VERSION "version" 319 #define ZPOOL_CONFIG_POOL_NAME "name" 320 #define ZPOOL_CONFIG_POOL_STATE "state" 321 #define ZPOOL_CONFIG_POOL_TXG "txg" 322 #define ZPOOL_CONFIG_POOL_GUID "pool_guid" 323 #define ZPOOL_CONFIG_CREATE_TXG "create_txg" 324 #define ZPOOL_CONFIG_TOP_GUID "top_guid" 325 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree" 326 #define ZPOOL_CONFIG_TYPE "type" 327 #define ZPOOL_CONFIG_CHILDREN "children" 328 #define ZPOOL_CONFIG_ID "id" 329 #define ZPOOL_CONFIG_GUID "guid" 330 #define ZPOOL_CONFIG_PATH "path" 331 #define ZPOOL_CONFIG_DEVID "devid" 332 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array" 333 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift" 334 #define ZPOOL_CONFIG_ASHIFT "ashift" 335 #define ZPOOL_CONFIG_ASIZE "asize" 336 #define ZPOOL_CONFIG_DTL "DTL" 337 #define ZPOOL_CONFIG_STATS "stats" 338 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk" 339 #define ZPOOL_CONFIG_ERRCOUNT "error_count" 340 #define ZPOOL_CONFIG_NOT_PRESENT "not_present" 341 #define ZPOOL_CONFIG_SPARES "spares" 342 #define ZPOOL_CONFIG_IS_SPARE "is_spare" 343 #define ZPOOL_CONFIG_NPARITY "nparity" 344 #define ZPOOL_CONFIG_HOSTID "hostid" 345 #define ZPOOL_CONFIG_HOSTNAME "hostname" 346 #define ZPOOL_CONFIG_UNSPARE "unspare" 347 #define ZPOOL_CONFIG_PHYS_PATH "phys_path" 348 #define ZPOOL_CONFIG_IS_LOG "is_log" 349 #define ZPOOL_CONFIG_L2CACHE "l2cache" 350 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */ 351 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */ 352 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */ 353 /* 354 * The persistent vdev state is stored as separate values rather than a single 355 * 'vdev_state' entry. This is because a device can be in multiple states, such 356 * as offline and degraded. 357 */ 358 #define ZPOOL_CONFIG_OFFLINE "offline" 359 #define ZPOOL_CONFIG_FAULTED "faulted" 360 #define ZPOOL_CONFIG_DEGRADED "degraded" 361 #define ZPOOL_CONFIG_REMOVED "removed" 362 363 #define VDEV_TYPE_ROOT "root" 364 #define VDEV_TYPE_MIRROR "mirror" 365 #define VDEV_TYPE_REPLACING "replacing" 366 #define VDEV_TYPE_RAIDZ "raidz" 367 #define VDEV_TYPE_DISK "disk" 368 #define VDEV_TYPE_FILE "file" 369 #define VDEV_TYPE_MISSING "missing" 370 #define VDEV_TYPE_SPARE "spare" 371 #define VDEV_TYPE_LOG "log" 372 #define VDEV_TYPE_L2CACHE "l2cache" 373 374 /* 375 * This is needed in userland to report the minimum necessary device size. 376 */ 377 #define SPA_MINDEVSIZE (64ULL << 20) 378 379 /* 380 * The location of the pool configuration repository, shared between kernel and 381 * userland. 382 */ 383 #define ZPOOL_CACHE "/etc/zfs/zpool.cache" 384 385 /* 386 * vdev states are ordered from least to most healthy. 387 * A vdev that's CANT_OPEN or below is considered unusable. 388 */ 389 typedef enum vdev_state { 390 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */ 391 VDEV_STATE_CLOSED, /* Not currently open */ 392 VDEV_STATE_OFFLINE, /* Not allowed to open */ 393 VDEV_STATE_REMOVED, /* Explicitly removed from system */ 394 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */ 395 VDEV_STATE_FAULTED, /* External request to fault device */ 396 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */ 397 VDEV_STATE_HEALTHY /* Presumed good */ 398 } vdev_state_t; 399 400 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY 401 402 /* 403 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field 404 * of the vdev stats structure uses these constants to distinguish why. 405 */ 406 typedef enum vdev_aux { 407 VDEV_AUX_NONE, /* no error */ 408 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */ 409 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */ 410 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */ 411 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */ 412 VDEV_AUX_TOO_SMALL, /* vdev size is too small */ 413 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */ 414 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */ 415 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */ 416 VDEV_AUX_SPARED, /* hot spare used in another pool */ 417 VDEV_AUX_ERR_EXCEEDED, /* too many errors */ 418 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */ 419 VDEV_AUX_BAD_LOG /* cannot read log chain(s) */ 420 } vdev_aux_t; 421 422 /* 423 * pool state. The following states are written to disk as part of the normal 424 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining 425 * states are software abstractions used at various levels to communicate 426 * pool state. 427 */ 428 typedef enum pool_state { 429 POOL_STATE_ACTIVE = 0, /* In active use */ 430 POOL_STATE_EXPORTED, /* Explicitly exported */ 431 POOL_STATE_DESTROYED, /* Explicitly destroyed */ 432 POOL_STATE_SPARE, /* Reserved for hot spare use */ 433 POOL_STATE_L2CACHE, /* Level 2 ARC device */ 434 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */ 435 POOL_STATE_UNAVAIL, /* Internal libzfs state */ 436 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */ 437 } pool_state_t; 438 439 /* 440 * Scrub types. 441 */ 442 typedef enum pool_scrub_type { 443 POOL_SCRUB_NONE, 444 POOL_SCRUB_RESILVER, 445 POOL_SCRUB_EVERYTHING, 446 POOL_SCRUB_TYPES 447 } pool_scrub_type_t; 448 449 /* 450 * ZIO types. Needed to interpret vdev statistics below. 451 */ 452 typedef enum zio_type { 453 ZIO_TYPE_NULL = 0, 454 ZIO_TYPE_READ, 455 ZIO_TYPE_WRITE, 456 ZIO_TYPE_FREE, 457 ZIO_TYPE_CLAIM, 458 ZIO_TYPE_IOCTL, 459 ZIO_TYPES 460 } zio_type_t; 461 462 /* 463 * Vdev statistics. Note: all fields should be 64-bit because this 464 * is passed between kernel and userland as an nvlist uint64 array. 465 */ 466 typedef struct vdev_stat { 467 hrtime_t vs_timestamp; /* time since vdev load */ 468 uint64_t vs_state; /* vdev state */ 469 uint64_t vs_aux; /* see vdev_aux_t */ 470 uint64_t vs_alloc; /* space allocated */ 471 uint64_t vs_space; /* total capacity */ 472 uint64_t vs_dspace; /* deflated capacity */ 473 uint64_t vs_rsize; /* replaceable dev size */ 474 uint64_t vs_ops[ZIO_TYPES]; /* operation count */ 475 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */ 476 uint64_t vs_read_errors; /* read errors */ 477 uint64_t vs_write_errors; /* write errors */ 478 uint64_t vs_checksum_errors; /* checksum errors */ 479 uint64_t vs_self_healed; /* self-healed bytes */ 480 uint64_t vs_scrub_type; /* pool_scrub_type_t */ 481 uint64_t vs_scrub_complete; /* completed? */ 482 uint64_t vs_scrub_examined; /* bytes examined; top */ 483 uint64_t vs_scrub_repaired; /* bytes repaired; leaf */ 484 uint64_t vs_scrub_errors; /* errors during scrub */ 485 uint64_t vs_scrub_start; /* UTC scrub start time */ 486 uint64_t vs_scrub_end; /* UTC scrub end time */ 487 } vdev_stat_t; 488 489 #define ZVOL_DRIVER "zvol" 490 #define ZFS_DRIVER "zfs" 491 #define ZFS_DEV "/dev/zfs" 492 493 /* 494 * zvol paths. Irritatingly, the devfsadm interfaces want all these 495 * paths without the /dev prefix, but for some things, we want the 496 * /dev prefix. Below are the names without /dev. 497 */ 498 #define ZVOL_DEV_DIR "zvol/dsk" 499 #define ZVOL_RDEV_DIR "zvol/rdsk" 500 501 /* 502 * And here are the things we need with /dev, etc. in front of them. 503 */ 504 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zvol@0:" 505 #define ZVOL_FULL_DEV_DIR "/dev/" ZVOL_DEV_DIR "/" 506 507 #define ZVOL_PROP_NAME "name" 508 509 /* 510 * /dev/zfs ioctl numbers. 511 */ 512 #define ZFS_IOC ('Z' << 8) 513 514 typedef enum zfs_ioc { 515 ZFS_IOC_POOL_CREATE = ZFS_IOC, 516 ZFS_IOC_POOL_DESTROY, 517 ZFS_IOC_POOL_IMPORT, 518 ZFS_IOC_POOL_EXPORT, 519 ZFS_IOC_POOL_CONFIGS, 520 ZFS_IOC_POOL_STATS, 521 ZFS_IOC_POOL_TRYIMPORT, 522 ZFS_IOC_POOL_SCRUB, 523 ZFS_IOC_POOL_FREEZE, 524 ZFS_IOC_POOL_UPGRADE, 525 ZFS_IOC_POOL_GET_HISTORY, 526 ZFS_IOC_VDEV_ADD, 527 ZFS_IOC_VDEV_REMOVE, 528 ZFS_IOC_VDEV_SET_STATE, 529 ZFS_IOC_VDEV_ATTACH, 530 ZFS_IOC_VDEV_DETACH, 531 ZFS_IOC_VDEV_SETPATH, 532 ZFS_IOC_OBJSET_STATS, 533 ZFS_IOC_OBJSET_ZPLPROPS, 534 ZFS_IOC_DATASET_LIST_NEXT, 535 ZFS_IOC_SNAPSHOT_LIST_NEXT, 536 ZFS_IOC_SET_PROP, 537 ZFS_IOC_CREATE_MINOR, 538 ZFS_IOC_REMOVE_MINOR, 539 ZFS_IOC_CREATE, 540 ZFS_IOC_DESTROY, 541 ZFS_IOC_ROLLBACK, 542 ZFS_IOC_RENAME, 543 ZFS_IOC_RECV, 544 ZFS_IOC_SEND, 545 ZFS_IOC_INJECT_FAULT, 546 ZFS_IOC_CLEAR_FAULT, 547 ZFS_IOC_INJECT_LIST_NEXT, 548 ZFS_IOC_ERROR_LOG, 549 ZFS_IOC_CLEAR, 550 ZFS_IOC_PROMOTE, 551 ZFS_IOC_DESTROY_SNAPS, 552 ZFS_IOC_SNAPSHOT, 553 ZFS_IOC_DSOBJ_TO_DSNAME, 554 ZFS_IOC_OBJ_TO_PATH, 555 ZFS_IOC_POOL_SET_PROPS, 556 ZFS_IOC_POOL_GET_PROPS, 557 ZFS_IOC_SET_FSACL, 558 ZFS_IOC_GET_FSACL, 559 ZFS_IOC_ISCSI_PERM_CHECK, 560 ZFS_IOC_SHARE, 561 ZFS_IOC_INHERIT_PROP 562 } zfs_ioc_t; 563 564 /* 565 * Internal SPA load state. Used by FMA diagnosis engine. 566 */ 567 typedef enum { 568 SPA_LOAD_NONE, /* no load in progress */ 569 SPA_LOAD_OPEN, /* normal open */ 570 SPA_LOAD_IMPORT, /* import in progress */ 571 SPA_LOAD_TRYIMPORT /* tryimport in progress */ 572 } spa_load_state_t; 573 574 /* 575 * Bookmark name values. 576 */ 577 #define ZPOOL_ERR_LIST "error list" 578 #define ZPOOL_ERR_DATASET "dataset" 579 #define ZPOOL_ERR_OBJECT "object" 580 581 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1) 582 583 /* 584 * The following are names used in the nvlist describing 585 * the pool's history log. 586 */ 587 #define ZPOOL_HIST_RECORD "history record" 588 #define ZPOOL_HIST_TIME "history time" 589 #define ZPOOL_HIST_CMD "history command" 590 #define ZPOOL_HIST_WHO "history who" 591 #define ZPOOL_HIST_ZONE "history zone" 592 #define ZPOOL_HIST_HOST "history hostname" 593 #define ZPOOL_HIST_TXG "history txg" 594 #define ZPOOL_HIST_INT_EVENT "history internal event" 595 #define ZPOOL_HIST_INT_STR "history internal str" 596 597 /* 598 * Flags for ZFS_IOC_VDEV_SET_STATE 599 */ 600 #define ZFS_ONLINE_CHECKREMOVE 0x1 601 #define ZFS_ONLINE_UNSPARE 0x2 602 #define ZFS_ONLINE_FORCEFAULT 0x4 603 #define ZFS_OFFLINE_TEMPORARY 0x1 604 605 /* 606 * Sysevent payload members. ZFS will generate the following sysevents with the 607 * given payloads: 608 * 609 * ESC_ZFS_RESILVER_START 610 * ESC_ZFS_RESILVER_END 611 * ESC_ZFS_POOL_DESTROY 612 * 613 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 614 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 615 * 616 * ESC_ZFS_VDEV_REMOVE 617 * ESC_ZFS_VDEV_CLEAR 618 * ESC_ZFS_VDEV_CHECK 619 * 620 * ZFS_EV_POOL_NAME DATA_TYPE_STRING 621 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64 622 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional) 623 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64 624 */ 625 #define ZFS_EV_POOL_NAME "pool_name" 626 #define ZFS_EV_POOL_GUID "pool_guid" 627 #define ZFS_EV_VDEV_PATH "vdev_path" 628 #define ZFS_EV_VDEV_GUID "vdev_guid" 629 630 /* 631 * Note: This is encoded on-disk, so new events must be added to the 632 * end, and unused events can not be removed. Be sure to edit 633 * zpool_main.c: hist_event_table[]. 634 */ 635 typedef enum history_internal_events { 636 LOG_NO_EVENT = 0, 637 LOG_POOL_CREATE, 638 LOG_POOL_VDEV_ADD, 639 LOG_POOL_REMOVE, 640 LOG_POOL_DESTROY, 641 LOG_POOL_EXPORT, 642 LOG_POOL_IMPORT, 643 LOG_POOL_VDEV_ATTACH, 644 LOG_POOL_VDEV_REPLACE, 645 LOG_POOL_VDEV_DETACH, 646 LOG_POOL_VDEV_ONLINE, 647 LOG_POOL_VDEV_OFFLINE, 648 LOG_POOL_UPGRADE, 649 LOG_POOL_CLEAR, 650 LOG_POOL_SCRUB, 651 LOG_POOL_PROPSET, 652 LOG_DS_CREATE, 653 LOG_DS_CLONE, 654 LOG_DS_DESTROY, 655 LOG_DS_DESTROY_BEGIN, 656 LOG_DS_INHERIT, 657 LOG_DS_PROPSET, 658 LOG_DS_QUOTA, 659 LOG_DS_PERM_UPDATE, 660 LOG_DS_PERM_REMOVE, 661 LOG_DS_PERM_WHO_REMOVE, 662 LOG_DS_PROMOTE, 663 LOG_DS_RECEIVE, 664 LOG_DS_RENAME, 665 LOG_DS_RESERVATION, 666 LOG_DS_REPLAY_INC_SYNC, 667 LOG_DS_REPLAY_FULL_SYNC, 668 LOG_DS_ROLLBACK, 669 LOG_DS_SNAPSHOT, 670 LOG_DS_UPGRADE, 671 LOG_DS_REFQUOTA, 672 LOG_DS_REFRESERV, 673 LOG_POOL_SCRUB_DONE, 674 LOG_END 675 } history_internal_events_t; 676 677 #ifdef __cplusplus 678 } 679 #endif 680 681 #endif /* _SYS_FS_ZFS_H */ 682