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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
26 /* Portions Copyright 2010 Robert Milkowski */
38 * Types and constants shared between userland and the kernel.
42 * Each dataset can be one of the following types. These constants can be
43 * combined into masks that can be passed to various functions.
46 ZFS_TYPE_FILESYSTEM = 0x1,
47 ZFS_TYPE_SNAPSHOT = 0x2,
48 ZFS_TYPE_VOLUME = 0x4,
52 #define ZFS_TYPE_DATASET \
53 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
55 #define ZAP_MAXNAMELEN 256
56 #define ZAP_MAXVALUELEN (1024 * 8)
57 #define ZAP_OLDMAXVALUELEN 1024
60 * Dataset properties are identified by these constants and must be added to
61 * the end of this list to ensure that external consumers are not affected
62 * by the change. If you make any changes to this list, be sure to update
63 * the property table in usr/src/common/zfs/zfs_prop.c.
71 ZFS_PROP_COMPRESSRATIO,
77 ZFS_PROP_VOLBLOCKSIZE,
90 ZFS_PROP_PRIVATE, /* not exposed to user, temporary */
92 ZFS_PROP_CREATETXG, /* not exposed to the user */
93 ZFS_PROP_NAME, /* not exposed to the user */
95 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
97 ZFS_PROP_NUMCLONES, /* not exposed to the user */
107 ZFS_PROP_REFRESERVATION,
109 ZFS_PROP_PRIMARYCACHE,
110 ZFS_PROP_SECONDARYCACHE,
114 ZFS_PROP_USEDREFRESERV,
115 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
116 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
117 ZFS_PROP_DEFER_DESTROY,
120 ZFS_PROP_UNIQUE, /* not exposed to the user */
121 ZFS_PROP_OBJSETID, /* not exposed to the user */
133 ZFS_NUM_USERQUOTA_PROPS
134 } zfs_userquota_prop_t;
136 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
139 * Pool properties are identified by these constants and must be added to the
140 * end of this list to ensure that external consumers are not affected
141 * by the change. If you make any changes to this list, be sure to update
142 * the property table in usr/src/common/zfs/zpool_prop.c.
153 ZPOOL_PROP_DELEGATION,
154 ZPOOL_PROP_AUTOREPLACE,
155 ZPOOL_PROP_CACHEFILE,
156 ZPOOL_PROP_FAILUREMODE,
157 ZPOOL_PROP_LISTSNAPS,
158 ZPOOL_PROP_AUTOEXPAND,
159 ZPOOL_PROP_DEDUPDITTO,
160 ZPOOL_PROP_DEDUPRATIO,
162 ZPOOL_PROP_ALLOCATED,
168 #define ZPROP_CONT -2
169 #define ZPROP_INVAL -1
171 #define ZPROP_VALUE "value"
172 #define ZPROP_SOURCE "source"
175 ZPROP_SRC_NONE = 0x1,
176 ZPROP_SRC_DEFAULT = 0x2,
177 ZPROP_SRC_TEMPORARY = 0x4,
178 ZPROP_SRC_LOCAL = 0x8,
179 ZPROP_SRC_INHERITED = 0x10,
180 ZPROP_SRC_RECEIVED = 0x20
183 #define ZPROP_SRC_ALL 0x3f
185 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
186 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
188 * Dataset flag implemented as a special entry in the props zap object
189 * indicating that the dataset has received properties on or after
190 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
191 * just as it did in earlier versions, and thereafter, local properties are
194 #define ZPROP_HAS_RECVD "$hasrecvd"
197 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
198 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
201 typedef int (*zprop_func)(int, void *);
204 * Properties to be set on the root file system of a new pool
205 * are stuffed into their own nvlist, which is then included in
206 * the properties nvlist with the pool properties.
208 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
211 * Dataset property functions shared between libzfs and kernel.
213 const char *zfs_prop_default_string(zfs_prop_t);
214 uint64_t zfs_prop_default_numeric(zfs_prop_t);
215 boolean_t zfs_prop_readonly(zfs_prop_t);
216 boolean_t zfs_prop_inheritable(zfs_prop_t);
217 boolean_t zfs_prop_setonce(zfs_prop_t);
218 const char *zfs_prop_to_name(zfs_prop_t);
219 zfs_prop_t zfs_name_to_prop(const char *);
220 boolean_t zfs_prop_user(const char *);
221 boolean_t zfs_prop_userquota(const char *);
222 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
223 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
224 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
225 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
228 * Pool property functions shared between libzfs and kernel.
230 zpool_prop_t zpool_name_to_prop(const char *);
231 const char *zpool_prop_to_name(zpool_prop_t);
232 const char *zpool_prop_default_string(zpool_prop_t);
233 uint64_t zpool_prop_default_numeric(zpool_prop_t);
234 boolean_t zpool_prop_readonly(zpool_prop_t);
235 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
236 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
237 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
240 * Definitions for the Delegation.
243 ZFS_DELEG_WHO_UNKNOWN = 0,
244 ZFS_DELEG_USER = 'u',
245 ZFS_DELEG_USER_SETS = 'U',
246 ZFS_DELEG_GROUP = 'g',
247 ZFS_DELEG_GROUP_SETS = 'G',
248 ZFS_DELEG_EVERYONE = 'e',
249 ZFS_DELEG_EVERYONE_SETS = 'E',
250 ZFS_DELEG_CREATE = 'c',
251 ZFS_DELEG_CREATE_SETS = 'C',
252 ZFS_DELEG_NAMED_SET = 's',
253 ZFS_DELEG_NAMED_SET_SETS = 'S'
254 } zfs_deleg_who_type_t;
258 ZFS_DELEG_PERM_LOCAL = 1,
259 ZFS_DELEG_PERM_DESCENDENT = 2,
260 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
261 ZFS_DELEG_PERM_CREATE = 4
262 } zfs_deleg_inherit_t;
264 #define ZFS_DELEG_PERM_UID "uid"
265 #define ZFS_DELEG_PERM_GID "gid"
266 #define ZFS_DELEG_PERM_GROUPS "groups"
268 #define ZFS_MLSLABEL_DEFAULT "none"
270 #define ZFS_SMB_ACL_SRC "src"
271 #define ZFS_SMB_ACL_TARGET "target"
274 ZFS_CANMOUNT_OFF = 0,
276 ZFS_CANMOUNT_NOAUTO = 2
277 } zfs_canmount_type_t;
280 ZFS_LOGBIAS_LATENCY = 0,
281 ZFS_LOGBIAS_THROUGHPUT = 1
284 typedef enum zfs_share_op {
291 typedef enum zfs_smb_acl_op {
298 typedef enum zfs_cache_type {
300 ZFS_CACHE_METADATA = 1,
305 ZFS_SYNC_STANDARD = 0,
307 ZFS_SYNC_DISABLED = 2
312 * On-disk version number.
314 #define SPA_VERSION_1 1ULL
315 #define SPA_VERSION_2 2ULL
316 #define SPA_VERSION_3 3ULL
317 #define SPA_VERSION_4 4ULL
318 #define SPA_VERSION_5 5ULL
319 #define SPA_VERSION_6 6ULL
320 #define SPA_VERSION_7 7ULL
321 #define SPA_VERSION_8 8ULL
322 #define SPA_VERSION_9 9ULL
323 #define SPA_VERSION_10 10ULL
324 #define SPA_VERSION_11 11ULL
325 #define SPA_VERSION_12 12ULL
326 #define SPA_VERSION_13 13ULL
327 #define SPA_VERSION_14 14ULL
328 #define SPA_VERSION_15 15ULL
329 #define SPA_VERSION_16 16ULL
330 #define SPA_VERSION_17 17ULL
331 #define SPA_VERSION_18 18ULL
332 #define SPA_VERSION_19 19ULL
333 #define SPA_VERSION_20 20ULL
334 #define SPA_VERSION_21 21ULL
335 #define SPA_VERSION_22 22ULL
336 #define SPA_VERSION_23 23ULL
337 #define SPA_VERSION_24 24ULL
338 #define SPA_VERSION_25 25ULL
339 #define SPA_VERSION_26 26ULL
340 #define SPA_VERSION_27 27ULL
341 #define SPA_VERSION_28 28ULL
344 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
345 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
346 * and do the appropriate changes. Also bump the version number in
347 * usr/src/grub/capability.
349 #define SPA_VERSION SPA_VERSION_28
350 #define SPA_VERSION_STRING "28"
353 * Symbolic names for the changes that caused a SPA_VERSION switch.
354 * Used in the code when checking for presence or absence of a feature.
355 * Feel free to define multiple symbolic names for each version if there
356 * were multiple changes to on-disk structures during that version.
358 * NOTE: When checking the current SPA_VERSION in your code, be sure
359 * to use spa_version() since it reports the version of the
360 * last synced uberblock. Checking the in-flight version can
361 * be dangerous in some cases.
363 #define SPA_VERSION_INITIAL SPA_VERSION_1
364 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
365 #define SPA_VERSION_SPARES SPA_VERSION_3
366 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
367 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
368 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
369 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
370 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
371 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
372 #define SPA_VERSION_BOOTFS SPA_VERSION_6
373 #define SPA_VERSION_SLOGS SPA_VERSION_7
374 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
375 #define SPA_VERSION_FUID SPA_VERSION_9
376 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
377 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
378 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
379 #define SPA_VERSION_L2CACHE SPA_VERSION_10
380 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
381 #define SPA_VERSION_ORIGIN SPA_VERSION_11
382 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
383 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
384 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
385 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
386 #define SPA_VERSION_USERSPACE SPA_VERSION_15
387 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
388 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
389 #define SPA_VERSION_USERREFS SPA_VERSION_18
390 #define SPA_VERSION_HOLES SPA_VERSION_19
391 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
392 #define SPA_VERSION_DEDUP SPA_VERSION_21
393 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
394 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
395 #define SPA_VERSION_SA SPA_VERSION_24
396 #define SPA_VERSION_SCAN SPA_VERSION_25
397 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
398 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
399 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
400 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
403 * ZPL version - rev'd whenever an incompatible on-disk format change
404 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
405 * also update the version_table[] and help message in zfs_prop.c.
407 * When changing, be sure to teach GRUB how to read the new format!
408 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
410 #define ZPL_VERSION_1 1ULL
411 #define ZPL_VERSION_2 2ULL
412 #define ZPL_VERSION_3 3ULL
413 #define ZPL_VERSION_4 4ULL
414 #define ZPL_VERSION_5 5ULL
415 #define ZPL_VERSION ZPL_VERSION_5
416 #define ZPL_VERSION_STRING "5"
418 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
419 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
420 #define ZPL_VERSION_FUID ZPL_VERSION_3
421 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
422 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
423 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
424 #define ZPL_VERSION_SA ZPL_VERSION_5
426 /* Rewind request information */
427 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
428 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
429 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
430 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
431 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
432 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
433 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
435 typedef struct zpool_rewind_policy {
436 uint32_t zrp_request; /* rewind behavior requested */
437 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
438 uint64_t zrp_maxdata; /* max acceptable data errors */
439 uint64_t zrp_txg; /* specific txg to load */
440 } zpool_rewind_policy_t;
443 * The following are configuration names used in the nvlist describing a pool's
446 #define ZPOOL_CONFIG_VERSION "version"
447 #define ZPOOL_CONFIG_POOL_NAME "name"
448 #define ZPOOL_CONFIG_POOL_STATE "state"
449 #define ZPOOL_CONFIG_POOL_TXG "txg"
450 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
451 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
452 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
453 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
454 #define ZPOOL_CONFIG_TYPE "type"
455 #define ZPOOL_CONFIG_CHILDREN "children"
456 #define ZPOOL_CONFIG_ID "id"
457 #define ZPOOL_CONFIG_GUID "guid"
458 #define ZPOOL_CONFIG_PATH "path"
459 #define ZPOOL_CONFIG_DEVID "devid"
460 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
461 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
462 #define ZPOOL_CONFIG_ASHIFT "ashift"
463 #define ZPOOL_CONFIG_ASIZE "asize"
464 #define ZPOOL_CONFIG_DTL "DTL"
465 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
466 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
467 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
468 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
469 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
470 #define ZPOOL_CONFIG_SPARES "spares"
471 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
472 #define ZPOOL_CONFIG_NPARITY "nparity"
473 #define ZPOOL_CONFIG_HOSTID "hostid"
474 #define ZPOOL_CONFIG_HOSTNAME "hostname"
475 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
476 #define ZPOOL_CONFIG_UNSPARE "unspare"
477 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
478 #define ZPOOL_CONFIG_IS_LOG "is_log"
479 #define ZPOOL_CONFIG_L2CACHE "l2cache"
480 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
481 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
482 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
483 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
484 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
485 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
486 #define ZPOOL_CONFIG_SPLIT "splitcfg"
487 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
488 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
489 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
490 #define ZPOOL_CONFIG_REMOVING "removing"
491 #define ZPOOL_CONFIG_RESILVERING "resilvering"
492 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
493 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
494 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
495 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
496 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
498 * The persistent vdev state is stored as separate values rather than a single
499 * 'vdev_state' entry. This is because a device can be in multiple states, such
500 * as offline and degraded.
502 #define ZPOOL_CONFIG_OFFLINE "offline"
503 #define ZPOOL_CONFIG_FAULTED "faulted"
504 #define ZPOOL_CONFIG_DEGRADED "degraded"
505 #define ZPOOL_CONFIG_REMOVED "removed"
506 #define ZPOOL_CONFIG_FRU "fru"
507 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
509 /* Rewind policy parameters */
510 #define ZPOOL_REWIND_POLICY "rewind-policy"
511 #define ZPOOL_REWIND_REQUEST "rewind-request"
512 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
513 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
514 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
516 /* Rewind data discovered */
517 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
518 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
519 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
521 #define VDEV_TYPE_ROOT "root"
522 #define VDEV_TYPE_MIRROR "mirror"
523 #define VDEV_TYPE_REPLACING "replacing"
524 #define VDEV_TYPE_RAIDZ "raidz"
525 #define VDEV_TYPE_DISK "disk"
526 #define VDEV_TYPE_FILE "file"
527 #define VDEV_TYPE_MISSING "missing"
528 #define VDEV_TYPE_HOLE "hole"
529 #define VDEV_TYPE_SPARE "spare"
530 #define VDEV_TYPE_LOG "log"
531 #define VDEV_TYPE_L2CACHE "l2cache"
534 * This is needed in userland to report the minimum necessary device size.
536 #define SPA_MINDEVSIZE (64ULL << 20)
539 * The location of the pool configuration repository, shared between kernel and
542 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
545 * vdev states are ordered from least to most healthy.
546 * A vdev that's CANT_OPEN or below is considered unusable.
548 typedef enum vdev_state {
549 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
550 VDEV_STATE_CLOSED, /* Not currently open */
551 VDEV_STATE_OFFLINE, /* Not allowed to open */
552 VDEV_STATE_REMOVED, /* Explicitly removed from system */
553 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
554 VDEV_STATE_FAULTED, /* External request to fault device */
555 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
556 VDEV_STATE_HEALTHY /* Presumed good */
559 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
562 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
563 * of the vdev stats structure uses these constants to distinguish why.
565 typedef enum vdev_aux {
566 VDEV_AUX_NONE, /* no error */
567 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
568 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
569 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
570 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
571 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
572 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
573 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
574 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
575 VDEV_AUX_SPARED, /* hot spare used in another pool */
576 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
577 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
578 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
579 VDEV_AUX_EXTERNAL, /* external diagnosis */
580 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */
584 * pool state. The following states are written to disk as part of the normal
585 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
586 * states are software abstractions used at various levels to communicate
589 typedef enum pool_state {
590 POOL_STATE_ACTIVE = 0, /* In active use */
591 POOL_STATE_EXPORTED, /* Explicitly exported */
592 POOL_STATE_DESTROYED, /* Explicitly destroyed */
593 POOL_STATE_SPARE, /* Reserved for hot spare use */
594 POOL_STATE_L2CACHE, /* Level 2 ARC device */
595 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
596 POOL_STATE_UNAVAIL, /* Internal libzfs state */
597 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
603 typedef enum pool_scan_func {
611 * ZIO types. Needed to interpret vdev statistics below.
613 typedef enum zio_type {
624 * Pool statistics. Note: all fields should be 64-bit because this
625 * is passed between kernel and userland as an nvlist uint64 array.
627 typedef struct pool_scan_stat {
628 /* values stored on disk */
629 uint64_t pss_func; /* pool_scan_func_t */
630 uint64_t pss_state; /* dsl_scan_state_t */
631 uint64_t pss_start_time; /* scan start time */
632 uint64_t pss_end_time; /* scan end time */
633 uint64_t pss_to_examine; /* total bytes to scan */
634 uint64_t pss_examined; /* total examined bytes */
635 uint64_t pss_to_process; /* total bytes to process */
636 uint64_t pss_processed; /* total processed bytes */
637 uint64_t pss_errors; /* scan errors */
639 /* values not stored on disk */
640 uint64_t pss_pass_exam; /* examined bytes per scan pass */
641 uint64_t pss_pass_start; /* start time of a scan pass */
644 typedef enum dsl_scan_state {
654 * Vdev statistics. Note: all fields should be 64-bit because this
655 * is passed between kernel and userland as an nvlist uint64 array.
657 typedef struct vdev_stat {
658 hrtime_t vs_timestamp; /* time since vdev load */
659 uint64_t vs_state; /* vdev state */
660 uint64_t vs_aux; /* see vdev_aux_t */
661 uint64_t vs_alloc; /* space allocated */
662 uint64_t vs_space; /* total capacity */
663 uint64_t vs_dspace; /* deflated capacity */
664 uint64_t vs_rsize; /* replaceable dev size */
665 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
666 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
667 uint64_t vs_read_errors; /* read errors */
668 uint64_t vs_write_errors; /* write errors */
669 uint64_t vs_checksum_errors; /* checksum errors */
670 uint64_t vs_self_healed; /* self-healed bytes */
671 uint64_t vs_scan_removing; /* removing? */
672 uint64_t vs_scan_processed; /* scan processed bytes */
676 * DDT statistics. Note: all fields should be 64-bit because this
677 * is passed between kernel and userland as an nvlist uint64 array.
679 typedef struct ddt_object {
680 uint64_t ddo_count; /* number of elments in ddt */
681 uint64_t ddo_dspace; /* size of ddt on disk */
682 uint64_t ddo_mspace; /* size of ddt in-core */
685 typedef struct ddt_stat {
686 uint64_t dds_blocks; /* blocks */
687 uint64_t dds_lsize; /* logical size */
688 uint64_t dds_psize; /* physical size */
689 uint64_t dds_dsize; /* deflated allocated size */
690 uint64_t dds_ref_blocks; /* referenced blocks */
691 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
692 uint64_t dds_ref_psize; /* referenced psize * refcnt */
693 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
696 typedef struct ddt_histogram {
697 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
700 #define ZVOL_DRIVER "zvol"
701 #define ZFS_DRIVER "zfs"
702 #define ZFS_DEV "/dev/zfs"
704 /* general zvol path */
705 #define ZVOL_DIR "/dev"
707 #define ZVOL_MAJOR 230
708 #define ZVOL_MINOR_BITS 4
709 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
710 #define ZVOL_MINORS (1 << 4)
711 #define ZVOL_DEV_NAME "zd"
713 #define ZVOL_PROP_NAME "name"
714 #define ZVOL_DEFAULT_BLOCKSIZE 8192
717 * /dev/zfs ioctl numbers.
719 #define ZFS_IOC ('Z' << 8)
721 typedef enum zfs_ioc {
722 ZFS_IOC_POOL_CREATE = ZFS_IOC,
723 ZFS_IOC_POOL_DESTROY,
726 ZFS_IOC_POOL_CONFIGS,
728 ZFS_IOC_POOL_TRYIMPORT,
731 ZFS_IOC_POOL_UPGRADE,
732 ZFS_IOC_POOL_GET_HISTORY,
735 ZFS_IOC_VDEV_SET_STATE,
738 ZFS_IOC_VDEV_SETPATH,
740 ZFS_IOC_OBJSET_STATS,
741 ZFS_IOC_OBJSET_ZPLPROPS,
742 ZFS_IOC_DATASET_LIST_NEXT,
743 ZFS_IOC_SNAPSHOT_LIST_NEXT,
745 ZFS_IOC_CREATE_MINOR,
746 ZFS_IOC_REMOVE_MINOR,
753 ZFS_IOC_INJECT_FAULT,
755 ZFS_IOC_INJECT_LIST_NEXT,
759 ZFS_IOC_DESTROY_SNAPS,
761 ZFS_IOC_DSOBJ_TO_DSNAME,
763 ZFS_IOC_POOL_SET_PROPS,
764 ZFS_IOC_POOL_GET_PROPS,
768 ZFS_IOC_INHERIT_PROP,
770 ZFS_IOC_USERSPACE_ONE,
771 ZFS_IOC_USERSPACE_MANY,
772 ZFS_IOC_USERSPACE_UPGRADE,
776 ZFS_IOC_OBJSET_RECVD_PROPS,
780 ZFS_IOC_TMP_SNAPSHOT,
781 ZFS_IOC_OBJ_TO_STATS,
783 ZFS_IOC_EVENTS_CLEAR,
787 * zvol ioctl to get dataset name
789 #define BLKZNAME _IOR(0x12,125,char[ZFS_MAXNAMELEN])
792 * Internal SPA load state. Used by FMA diagnosis engine.
795 SPA_LOAD_NONE, /* no load in progress */
796 SPA_LOAD_OPEN, /* normal open */
797 SPA_LOAD_IMPORT, /* import in progress */
798 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
799 SPA_LOAD_RECOVER, /* recovery requested */
800 SPA_LOAD_ERROR /* load failed */
804 * Bookmark name values.
806 #define ZPOOL_ERR_LIST "error list"
807 #define ZPOOL_ERR_DATASET "dataset"
808 #define ZPOOL_ERR_OBJECT "object"
810 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
813 * The following are names used in the nvlist describing
814 * the pool's history log.
816 #define ZPOOL_HIST_RECORD "history record"
817 #define ZPOOL_HIST_TIME "history time"
818 #define ZPOOL_HIST_CMD "history command"
819 #define ZPOOL_HIST_WHO "history who"
820 #define ZPOOL_HIST_ZONE "history zone"
821 #define ZPOOL_HIST_HOST "history hostname"
822 #define ZPOOL_HIST_TXG "history txg"
823 #define ZPOOL_HIST_INT_EVENT "history internal event"
824 #define ZPOOL_HIST_INT_STR "history internal str"
827 * Flags for ZFS_IOC_VDEV_SET_STATE
829 #define ZFS_ONLINE_CHECKREMOVE 0x1
830 #define ZFS_ONLINE_UNSPARE 0x2
831 #define ZFS_ONLINE_FORCEFAULT 0x4
832 #define ZFS_ONLINE_EXPAND 0x8
833 #define ZFS_OFFLINE_TEMPORARY 0x1
836 * Flags for ZFS_IOC_POOL_IMPORT
838 #define ZFS_IMPORT_NORMAL 0x0
839 #define ZFS_IMPORT_VERBATIM 0x1
840 #define ZFS_IMPORT_ANY_HOST 0x2
841 #define ZFS_IMPORT_MISSING_LOG 0x4
842 #define ZFS_IMPORT_ONLY 0x8
845 * Sysevent payload members. ZFS will generate the following sysevents with the
848 * ESC_ZFS_RESILVER_START
849 * ESC_ZFS_RESILVER_END
850 * ESC_ZFS_POOL_DESTROY
852 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
853 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
855 * ESC_ZFS_VDEV_REMOVE
859 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
860 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
861 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
862 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
864 #define ZFS_EV_POOL_NAME "pool_name"
865 #define ZFS_EV_POOL_GUID "pool_guid"
866 #define ZFS_EV_VDEV_PATH "vdev_path"
867 #define ZFS_EV_VDEV_GUID "vdev_guid"
870 * Note: This is encoded on-disk, so new events must be added to the
871 * end, and unused events can not be removed. Be sure to edit
872 * libzfs_pool.c: hist_event_table[].
874 typedef enum history_internal_events {
882 LOG_POOL_VDEV_ATTACH,
883 LOG_POOL_VDEV_REPLACE,
884 LOG_POOL_VDEV_DETACH,
885 LOG_POOL_VDEV_ONLINE,
886 LOG_POOL_VDEV_OFFLINE,
894 LOG_DS_DESTROY_BEGIN,
900 LOG_DS_PERM_WHO_REMOVE,
905 LOG_DS_REPLAY_INC_SYNC,
906 LOG_DS_REPLAY_FULL_SYNC,
917 } history_internal_events_t;
923 #endif /* _SYS_FS_ZFS_H */