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