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) 2012 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
29 /* Portions Copyright 2010 Robert Milkowski */
41 * Types and constants shared between userland and the kernel.
45 * Each dataset can be one of the following types. These constants can be
46 * combined into masks that can be passed to various functions.
49 ZFS_TYPE_FILESYSTEM
= 0x1,
50 ZFS_TYPE_SNAPSHOT
= 0x2,
51 ZFS_TYPE_VOLUME
= 0x4,
55 #define ZFS_TYPE_DATASET \
56 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
58 #define ZAP_MAXNAMELEN 256
59 #define ZAP_MAXVALUELEN (1024 * 8)
60 #define ZAP_OLDMAXVALUELEN 1024
63 * Dataset properties are identified by these constants and must be added to
64 * the end of this list to ensure that external consumers are not affected
65 * by the change. If you make any changes to this list, be sure to update
66 * the property table in module/zcommon/zfs_prop.c.
74 ZFS_PROP_COMPRESSRATIO
,
80 ZFS_PROP_VOLBLOCKSIZE
,
93 ZFS_PROP_PRIVATE
, /* not exposed to user, temporary */
95 ZFS_PROP_CREATETXG
, /* not exposed to the user */
96 ZFS_PROP_NAME
, /* not exposed to the user */
98 ZFS_PROP_ISCSIOPTIONS
, /* not exposed to the user */
100 ZFS_PROP_NUMCLONES
, /* not exposed to the user */
110 ZFS_PROP_REFRESERVATION
,
112 ZFS_PROP_PRIMARYCACHE
,
113 ZFS_PROP_SECONDARYCACHE
,
117 ZFS_PROP_USEDREFRESERV
,
118 ZFS_PROP_USERACCOUNTING
, /* not exposed to the user */
119 ZFS_PROP_STMF_SHAREINFO
, /* not exposed to the user */
120 ZFS_PROP_DEFER_DESTROY
,
123 ZFS_PROP_UNIQUE
, /* not exposed to the user */
124 ZFS_PROP_OBJSETID
, /* not exposed to the user */
140 ZFS_NUM_USERQUOTA_PROPS
141 } zfs_userquota_prop_t
;
143 extern const char *zfs_userquota_prop_prefixes
[ZFS_NUM_USERQUOTA_PROPS
];
146 * Pool properties are identified by these constants and must be added to the
147 * end of this list to ensure that external consumers are not affected
148 * by the change. If you make any changes to this list, be sure to update
149 * the property table in module/zcommon/zpool_prop.c.
160 ZPOOL_PROP_DELEGATION
,
161 ZPOOL_PROP_AUTOREPLACE
,
162 ZPOOL_PROP_CACHEFILE
,
163 ZPOOL_PROP_FAILUREMODE
,
164 ZPOOL_PROP_LISTSNAPS
,
165 ZPOOL_PROP_AUTOEXPAND
,
166 ZPOOL_PROP_DEDUPDITTO
,
167 ZPOOL_PROP_DEDUPRATIO
,
169 ZPOOL_PROP_ALLOCATED
,
178 /* Small enough to not hog a whole line of printout in zpool(1M). */
179 #define ZPROP_MAX_COMMENT 32
181 #define ZPROP_CONT -2
182 #define ZPROP_INVAL -1
184 #define ZPROP_VALUE "value"
185 #define ZPROP_SOURCE "source"
188 ZPROP_SRC_NONE
= 0x1,
189 ZPROP_SRC_DEFAULT
= 0x2,
190 ZPROP_SRC_TEMPORARY
= 0x4,
191 ZPROP_SRC_LOCAL
= 0x8,
192 ZPROP_SRC_INHERITED
= 0x10,
193 ZPROP_SRC_RECEIVED
= 0x20
196 #define ZPROP_SRC_ALL 0x3f
198 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
199 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
201 * Dataset flag implemented as a special entry in the props zap object
202 * indicating that the dataset has received properties on or after
203 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
204 * just as it did in earlier versions, and thereafter, local properties are
207 #define ZPROP_HAS_RECVD "$hasrecvd"
210 ZPROP_ERR_NOCLEAR
= 0x1, /* failure to clear existing props */
211 ZPROP_ERR_NORESTORE
= 0x2 /* failure to restore props on error */
214 typedef int (*zprop_func
)(int, void *);
217 * Properties to be set on the root file system of a new pool
218 * are stuffed into their own nvlist, which is then included in
219 * the properties nvlist with the pool properties.
221 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
224 * Dataset property functions shared between libzfs and kernel.
226 const char *zfs_prop_default_string(zfs_prop_t
);
227 uint64_t zfs_prop_default_numeric(zfs_prop_t
);
228 boolean_t
zfs_prop_readonly(zfs_prop_t
);
229 boolean_t
zfs_prop_inheritable(zfs_prop_t
);
230 boolean_t
zfs_prop_setonce(zfs_prop_t
);
231 const char *zfs_prop_to_name(zfs_prop_t
);
232 zfs_prop_t
zfs_name_to_prop(const char *);
233 boolean_t
zfs_prop_user(const char *);
234 boolean_t
zfs_prop_userquota(const char *);
235 boolean_t
zfs_prop_written(const char *);
236 int zfs_prop_index_to_string(zfs_prop_t
, uint64_t, const char **);
237 int zfs_prop_string_to_index(zfs_prop_t
, const char *, uint64_t *);
238 uint64_t zfs_prop_random_value(zfs_prop_t
, uint64_t seed
);
239 boolean_t
zfs_prop_valid_for_type(int, zfs_type_t
);
242 * Pool property functions shared between libzfs and kernel.
244 zpool_prop_t
zpool_name_to_prop(const char *);
245 const char *zpool_prop_to_name(zpool_prop_t
);
246 const char *zpool_prop_default_string(zpool_prop_t
);
247 uint64_t zpool_prop_default_numeric(zpool_prop_t
);
248 boolean_t
zpool_prop_readonly(zpool_prop_t
);
249 boolean_t
zpool_prop_feature(const char *);
250 boolean_t
zpool_prop_unsupported(const char *);
251 int zpool_prop_index_to_string(zpool_prop_t
, uint64_t, const char **);
252 int zpool_prop_string_to_index(zpool_prop_t
, const char *, uint64_t *);
253 uint64_t zpool_prop_random_value(zpool_prop_t
, uint64_t seed
);
256 * Definitions for the Delegation.
259 ZFS_DELEG_WHO_UNKNOWN
= 0,
260 ZFS_DELEG_USER
= 'u',
261 ZFS_DELEG_USER_SETS
= 'U',
262 ZFS_DELEG_GROUP
= 'g',
263 ZFS_DELEG_GROUP_SETS
= 'G',
264 ZFS_DELEG_EVERYONE
= 'e',
265 ZFS_DELEG_EVERYONE_SETS
= 'E',
266 ZFS_DELEG_CREATE
= 'c',
267 ZFS_DELEG_CREATE_SETS
= 'C',
268 ZFS_DELEG_NAMED_SET
= 's',
269 ZFS_DELEG_NAMED_SET_SETS
= 'S'
270 } zfs_deleg_who_type_t
;
274 ZFS_DELEG_PERM_LOCAL
= 1,
275 ZFS_DELEG_PERM_DESCENDENT
= 2,
276 ZFS_DELEG_PERM_LOCALDESCENDENT
= 3,
277 ZFS_DELEG_PERM_CREATE
= 4
278 } zfs_deleg_inherit_t
;
280 #define ZFS_DELEG_PERM_UID "uid"
281 #define ZFS_DELEG_PERM_GID "gid"
282 #define ZFS_DELEG_PERM_GROUPS "groups"
284 #define ZFS_MLSLABEL_DEFAULT "none"
286 #define ZFS_SMB_ACL_SRC "src"
287 #define ZFS_SMB_ACL_TARGET "target"
290 ZFS_CANMOUNT_OFF
= 0,
292 ZFS_CANMOUNT_NOAUTO
= 2
293 } zfs_canmount_type_t
;
296 ZFS_LOGBIAS_LATENCY
= 0,
297 ZFS_LOGBIAS_THROUGHPUT
= 1
300 typedef enum zfs_share_op
{
307 typedef enum zfs_smb_acl_op
{
314 typedef enum zfs_cache_type
{
316 ZFS_CACHE_METADATA
= 1,
321 ZFS_SYNC_STANDARD
= 0,
323 ZFS_SYNC_DISABLED
= 2
333 * On-disk version number.
335 #define SPA_VERSION_1 1ULL
336 #define SPA_VERSION_2 2ULL
337 #define SPA_VERSION_3 3ULL
338 #define SPA_VERSION_4 4ULL
339 #define SPA_VERSION_5 5ULL
340 #define SPA_VERSION_6 6ULL
341 #define SPA_VERSION_7 7ULL
342 #define SPA_VERSION_8 8ULL
343 #define SPA_VERSION_9 9ULL
344 #define SPA_VERSION_10 10ULL
345 #define SPA_VERSION_11 11ULL
346 #define SPA_VERSION_12 12ULL
347 #define SPA_VERSION_13 13ULL
348 #define SPA_VERSION_14 14ULL
349 #define SPA_VERSION_15 15ULL
350 #define SPA_VERSION_16 16ULL
351 #define SPA_VERSION_17 17ULL
352 #define SPA_VERSION_18 18ULL
353 #define SPA_VERSION_19 19ULL
354 #define SPA_VERSION_20 20ULL
355 #define SPA_VERSION_21 21ULL
356 #define SPA_VERSION_22 22ULL
357 #define SPA_VERSION_23 23ULL
358 #define SPA_VERSION_24 24ULL
359 #define SPA_VERSION_25 25ULL
360 #define SPA_VERSION_26 26ULL
361 #define SPA_VERSION_27 27ULL
362 #define SPA_VERSION_28 28ULL
363 #define SPA_VERSION_5000 5000ULL
366 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
367 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
368 * and do the appropriate changes. Also bump the version number in
369 * usr/src/grub/capability.
371 #define SPA_VERSION SPA_VERSION_5000
372 #define SPA_VERSION_STRING "5000"
375 * Symbolic names for the changes that caused a SPA_VERSION switch.
376 * Used in the code when checking for presence or absence of a feature.
377 * Feel free to define multiple symbolic names for each version if there
378 * were multiple changes to on-disk structures during that version.
380 * NOTE: When checking the current SPA_VERSION in your code, be sure
381 * to use spa_version() since it reports the version of the
382 * last synced uberblock. Checking the in-flight version can
383 * be dangerous in some cases.
385 #define SPA_VERSION_INITIAL SPA_VERSION_1
386 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
387 #define SPA_VERSION_SPARES SPA_VERSION_3
388 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
389 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
390 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
391 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
392 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
393 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
394 #define SPA_VERSION_BOOTFS SPA_VERSION_6
395 #define SPA_VERSION_SLOGS SPA_VERSION_7
396 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
397 #define SPA_VERSION_FUID SPA_VERSION_9
398 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
399 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
400 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
401 #define SPA_VERSION_L2CACHE SPA_VERSION_10
402 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
403 #define SPA_VERSION_ORIGIN SPA_VERSION_11
404 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
405 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
406 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
407 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
408 #define SPA_VERSION_USERSPACE SPA_VERSION_15
409 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
410 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
411 #define SPA_VERSION_USERREFS SPA_VERSION_18
412 #define SPA_VERSION_HOLES SPA_VERSION_19
413 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
414 #define SPA_VERSION_DEDUP SPA_VERSION_21
415 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
416 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
417 #define SPA_VERSION_SA SPA_VERSION_24
418 #define SPA_VERSION_SCAN SPA_VERSION_25
419 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
420 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
421 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
422 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
423 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
424 #define SPA_VERSION_FEATURES SPA_VERSION_5000
426 #define SPA_VERSION_IS_SUPPORTED(v) \
427 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
428 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
431 * ZPL version - rev'd whenever an incompatible on-disk format change
432 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
433 * also update the version_table[] and help message in zfs_prop.c.
435 * When changing, be sure to teach GRUB how to read the new format!
436 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
438 #define ZPL_VERSION_1 1ULL
439 #define ZPL_VERSION_2 2ULL
440 #define ZPL_VERSION_3 3ULL
441 #define ZPL_VERSION_4 4ULL
442 #define ZPL_VERSION_5 5ULL
443 #define ZPL_VERSION ZPL_VERSION_5
444 #define ZPL_VERSION_STRING "5"
446 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
447 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
448 #define ZPL_VERSION_FUID ZPL_VERSION_3
449 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
450 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
451 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
452 #define ZPL_VERSION_SA ZPL_VERSION_5
454 /* Rewind request information */
455 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
456 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
457 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
458 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
459 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
460 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
461 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
463 typedef struct zpool_rewind_policy
{
464 uint32_t zrp_request
; /* rewind behavior requested */
465 uint64_t zrp_maxmeta
; /* max acceptable meta-data errors */
466 uint64_t zrp_maxdata
; /* max acceptable data errors */
467 uint64_t zrp_txg
; /* specific txg to load */
468 } zpool_rewind_policy_t
;
471 * The following are configuration names used in the nvlist describing a pool's
474 #define ZPOOL_CONFIG_VERSION "version"
475 #define ZPOOL_CONFIG_POOL_NAME "name"
476 #define ZPOOL_CONFIG_POOL_STATE "state"
477 #define ZPOOL_CONFIG_POOL_TXG "txg"
478 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
479 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
480 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
481 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
482 #define ZPOOL_CONFIG_TYPE "type"
483 #define ZPOOL_CONFIG_CHILDREN "children"
484 #define ZPOOL_CONFIG_ID "id"
485 #define ZPOOL_CONFIG_GUID "guid"
486 #define ZPOOL_CONFIG_PATH "path"
487 #define ZPOOL_CONFIG_DEVID "devid"
488 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
489 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
490 #define ZPOOL_CONFIG_ASHIFT "ashift"
491 #define ZPOOL_CONFIG_ASIZE "asize"
492 #define ZPOOL_CONFIG_DTL "DTL"
493 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
494 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
495 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
496 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
497 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
498 #define ZPOOL_CONFIG_SPARES "spares"
499 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
500 #define ZPOOL_CONFIG_NPARITY "nparity"
501 #define ZPOOL_CONFIG_HOSTID "hostid"
502 #define ZPOOL_CONFIG_HOSTNAME "hostname"
503 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
504 #define ZPOOL_CONFIG_UNSPARE "unspare"
505 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
506 #define ZPOOL_CONFIG_IS_LOG "is_log"
507 #define ZPOOL_CONFIG_L2CACHE "l2cache"
508 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
509 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
510 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
511 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
512 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
513 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
514 #define ZPOOL_CONFIG_SPLIT "splitcfg"
515 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
516 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
517 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
518 #define ZPOOL_CONFIG_REMOVING "removing"
519 #define ZPOOL_CONFIG_RESILVERING "resilvering"
520 #define ZPOOL_CONFIG_COMMENT "comment"
521 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
522 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
523 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
524 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
525 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
526 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
527 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
528 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
529 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
530 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
531 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
533 * The persistent vdev state is stored as separate values rather than a single
534 * 'vdev_state' entry. This is because a device can be in multiple states, such
535 * as offline and degraded.
537 #define ZPOOL_CONFIG_OFFLINE "offline"
538 #define ZPOOL_CONFIG_FAULTED "faulted"
539 #define ZPOOL_CONFIG_DEGRADED "degraded"
540 #define ZPOOL_CONFIG_REMOVED "removed"
541 #define ZPOOL_CONFIG_FRU "fru"
542 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
544 /* Rewind policy parameters */
545 #define ZPOOL_REWIND_POLICY "rewind-policy"
546 #define ZPOOL_REWIND_REQUEST "rewind-request"
547 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
548 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
549 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
551 /* Rewind data discovered */
552 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
553 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
554 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
556 #define VDEV_TYPE_ROOT "root"
557 #define VDEV_TYPE_MIRROR "mirror"
558 #define VDEV_TYPE_REPLACING "replacing"
559 #define VDEV_TYPE_RAIDZ "raidz"
560 #define VDEV_TYPE_DISK "disk"
561 #define VDEV_TYPE_FILE "file"
562 #define VDEV_TYPE_MISSING "missing"
563 #define VDEV_TYPE_HOLE "hole"
564 #define VDEV_TYPE_SPARE "spare"
565 #define VDEV_TYPE_LOG "log"
566 #define VDEV_TYPE_L2CACHE "l2cache"
569 * This is needed in userland to report the minimum necessary device size.
571 #define SPA_MINDEVSIZE (64ULL << 20)
574 * The location of the pool configuration repository, shared between kernel and
577 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
580 * vdev states are ordered from least to most healthy.
581 * A vdev that's CANT_OPEN or below is considered unusable.
583 typedef enum vdev_state
{
584 VDEV_STATE_UNKNOWN
= 0, /* Uninitialized vdev */
585 VDEV_STATE_CLOSED
, /* Not currently open */
586 VDEV_STATE_OFFLINE
, /* Not allowed to open */
587 VDEV_STATE_REMOVED
, /* Explicitly removed from system */
588 VDEV_STATE_CANT_OPEN
, /* Tried to open, but failed */
589 VDEV_STATE_FAULTED
, /* External request to fault device */
590 VDEV_STATE_DEGRADED
, /* Replicated vdev with unhealthy kids */
591 VDEV_STATE_HEALTHY
/* Presumed good */
594 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
597 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
598 * of the vdev stats structure uses these constants to distinguish why.
600 typedef enum vdev_aux
{
601 VDEV_AUX_NONE
, /* no error */
602 VDEV_AUX_OPEN_FAILED
, /* ldi_open_*() or vn_open() failed */
603 VDEV_AUX_CORRUPT_DATA
, /* bad label or disk contents */
604 VDEV_AUX_NO_REPLICAS
, /* insufficient number of replicas */
605 VDEV_AUX_BAD_GUID_SUM
, /* vdev guid sum doesn't match */
606 VDEV_AUX_TOO_SMALL
, /* vdev size is too small */
607 VDEV_AUX_BAD_LABEL
, /* the label is OK but invalid */
608 VDEV_AUX_VERSION_NEWER
, /* on-disk version is too new */
609 VDEV_AUX_VERSION_OLDER
, /* on-disk version is too old */
610 VDEV_AUX_UNSUP_FEAT
, /* unsupported features */
611 VDEV_AUX_SPARED
, /* hot spare used in another pool */
612 VDEV_AUX_ERR_EXCEEDED
, /* too many errors */
613 VDEV_AUX_IO_FAILURE
, /* experienced I/O failure */
614 VDEV_AUX_BAD_LOG
, /* cannot read log chain(s) */
615 VDEV_AUX_EXTERNAL
, /* external diagnosis */
616 VDEV_AUX_SPLIT_POOL
/* vdev was split off into another pool */
620 * pool state. The following states are written to disk as part of the normal
621 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
622 * states are software abstractions used at various levels to communicate
625 typedef enum pool_state
{
626 POOL_STATE_ACTIVE
= 0, /* In active use */
627 POOL_STATE_EXPORTED
, /* Explicitly exported */
628 POOL_STATE_DESTROYED
, /* Explicitly destroyed */
629 POOL_STATE_SPARE
, /* Reserved for hot spare use */
630 POOL_STATE_L2CACHE
, /* Level 2 ARC device */
631 POOL_STATE_UNINITIALIZED
, /* Internal spa_t state */
632 POOL_STATE_UNAVAIL
, /* Internal libzfs state */
633 POOL_STATE_POTENTIALLY_ACTIVE
/* Internal libzfs state */
639 typedef enum pool_scan_func
{
647 * ZIO types. Needed to interpret vdev statistics below.
649 typedef enum zio_type
{
660 * Pool statistics. Note: all fields should be 64-bit because this
661 * is passed between kernel and userland as an nvlist uint64 array.
663 typedef struct pool_scan_stat
{
664 /* values stored on disk */
665 uint64_t pss_func
; /* pool_scan_func_t */
666 uint64_t pss_state
; /* dsl_scan_state_t */
667 uint64_t pss_start_time
; /* scan start time */
668 uint64_t pss_end_time
; /* scan end time */
669 uint64_t pss_to_examine
; /* total bytes to scan */
670 uint64_t pss_examined
; /* total examined bytes */
671 uint64_t pss_to_process
; /* total bytes to process */
672 uint64_t pss_processed
; /* total processed bytes */
673 uint64_t pss_errors
; /* scan errors */
675 /* values not stored on disk */
676 uint64_t pss_pass_exam
; /* examined bytes per scan pass */
677 uint64_t pss_pass_start
; /* start time of a scan pass */
680 typedef enum dsl_scan_state
{
690 * Vdev statistics. Note: all fields should be 64-bit because this
691 * is passed between kernel and userland as an nvlist uint64 array.
693 typedef struct vdev_stat
{
694 hrtime_t vs_timestamp
; /* time since vdev load */
695 uint64_t vs_state
; /* vdev state */
696 uint64_t vs_aux
; /* see vdev_aux_t */
697 uint64_t vs_alloc
; /* space allocated */
698 uint64_t vs_space
; /* total capacity */
699 uint64_t vs_dspace
; /* deflated capacity */
700 uint64_t vs_rsize
; /* replaceable dev size */
701 uint64_t vs_esize
; /* expandable dev size */
702 uint64_t vs_ops
[ZIO_TYPES
]; /* operation count */
703 uint64_t vs_bytes
[ZIO_TYPES
]; /* bytes read/written */
704 uint64_t vs_read_errors
; /* read errors */
705 uint64_t vs_write_errors
; /* write errors */
706 uint64_t vs_checksum_errors
; /* checksum errors */
707 uint64_t vs_self_healed
; /* self-healed bytes */
708 uint64_t vs_scan_removing
; /* removing? */
709 uint64_t vs_scan_processed
; /* scan processed bytes */
713 * DDT statistics. Note: all fields should be 64-bit because this
714 * is passed between kernel and userland as an nvlist uint64 array.
716 typedef struct ddt_object
{
717 uint64_t ddo_count
; /* number of elments in ddt */
718 uint64_t ddo_dspace
; /* size of ddt on disk */
719 uint64_t ddo_mspace
; /* size of ddt in-core */
722 typedef struct ddt_stat
{
723 uint64_t dds_blocks
; /* blocks */
724 uint64_t dds_lsize
; /* logical size */
725 uint64_t dds_psize
; /* physical size */
726 uint64_t dds_dsize
; /* deflated allocated size */
727 uint64_t dds_ref_blocks
; /* referenced blocks */
728 uint64_t dds_ref_lsize
; /* referenced lsize * refcnt */
729 uint64_t dds_ref_psize
; /* referenced psize * refcnt */
730 uint64_t dds_ref_dsize
; /* referenced dsize * refcnt */
733 typedef struct ddt_histogram
{
734 ddt_stat_t ddh_stat
[64]; /* power-of-two histogram buckets */
737 #define ZVOL_DRIVER "zvol"
738 #define ZFS_DRIVER "zfs"
739 #define ZFS_DEV "/dev/zfs"
741 /* general zvol path */
742 #define ZVOL_DIR "/dev"
744 #define ZVOL_MAJOR 230
745 #define ZVOL_MINOR_BITS 4
746 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
747 #define ZVOL_MINORS (1 << 4)
748 #define ZVOL_DEV_NAME "zd"
750 #define ZVOL_PROP_NAME "name"
751 #define ZVOL_DEFAULT_BLOCKSIZE 8192
754 * /dev/zfs ioctl numbers.
756 #define ZFS_IOC ('Z' << 8)
758 typedef enum zfs_ioc
{
759 ZFS_IOC_POOL_CREATE
= ZFS_IOC
,
760 ZFS_IOC_POOL_DESTROY
,
763 ZFS_IOC_POOL_CONFIGS
,
765 ZFS_IOC_POOL_TRYIMPORT
,
768 ZFS_IOC_POOL_UPGRADE
,
769 ZFS_IOC_POOL_GET_HISTORY
,
772 ZFS_IOC_VDEV_SET_STATE
,
775 ZFS_IOC_VDEV_SETPATH
,
777 ZFS_IOC_OBJSET_STATS
,
778 ZFS_IOC_OBJSET_ZPLPROPS
,
779 ZFS_IOC_DATASET_LIST_NEXT
,
780 ZFS_IOC_SNAPSHOT_LIST_NEXT
,
782 ZFS_IOC_CREATE_MINOR
,
783 ZFS_IOC_REMOVE_MINOR
,
790 ZFS_IOC_INJECT_FAULT
,
792 ZFS_IOC_INJECT_LIST_NEXT
,
796 ZFS_IOC_DESTROY_SNAPS_NVL
,
798 ZFS_IOC_DSOBJ_TO_DSNAME
,
800 ZFS_IOC_POOL_SET_PROPS
,
801 ZFS_IOC_POOL_GET_PROPS
,
805 ZFS_IOC_INHERIT_PROP
,
807 ZFS_IOC_USERSPACE_ONE
,
808 ZFS_IOC_USERSPACE_MANY
,
809 ZFS_IOC_USERSPACE_UPGRADE
,
813 ZFS_IOC_OBJSET_RECVD_PROPS
,
817 ZFS_IOC_TMP_SNAPSHOT
,
818 ZFS_IOC_OBJ_TO_STATS
,
820 ZFS_IOC_EVENTS_CLEAR
,
822 ZFS_IOC_SPACE_WRITTEN
,
825 ZFS_IOC_SEND_PROGRESS
,
829 * zvol ioctl to get dataset name
831 #define BLKZNAME _IOR(0x12,125,char[ZFS_MAXNAMELEN])
834 * Internal SPA load state. Used by FMA diagnosis engine.
837 SPA_LOAD_NONE
, /* no load in progress */
838 SPA_LOAD_OPEN
, /* normal open */
839 SPA_LOAD_IMPORT
, /* import in progress */
840 SPA_LOAD_TRYIMPORT
, /* tryimport in progress */
841 SPA_LOAD_RECOVER
, /* recovery requested */
842 SPA_LOAD_ERROR
/* load failed */
846 * Bookmark name values.
848 #define ZPOOL_ERR_LIST "error list"
849 #define ZPOOL_ERR_DATASET "dataset"
850 #define ZPOOL_ERR_OBJECT "object"
852 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
855 * The following are names used in the nvlist describing
856 * the pool's history log.
858 #define ZPOOL_HIST_RECORD "history record"
859 #define ZPOOL_HIST_TIME "history time"
860 #define ZPOOL_HIST_CMD "history command"
861 #define ZPOOL_HIST_WHO "history who"
862 #define ZPOOL_HIST_ZONE "history zone"
863 #define ZPOOL_HIST_HOST "history hostname"
864 #define ZPOOL_HIST_TXG "history txg"
865 #define ZPOOL_HIST_INT_EVENT "history internal event"
866 #define ZPOOL_HIST_INT_STR "history internal str"
869 * Flags for ZFS_IOC_VDEV_SET_STATE
871 #define ZFS_ONLINE_CHECKREMOVE 0x1
872 #define ZFS_ONLINE_UNSPARE 0x2
873 #define ZFS_ONLINE_FORCEFAULT 0x4
874 #define ZFS_ONLINE_EXPAND 0x8
875 #define ZFS_OFFLINE_TEMPORARY 0x1
878 * Flags for ZFS_IOC_POOL_IMPORT
880 #define ZFS_IMPORT_NORMAL 0x0
881 #define ZFS_IMPORT_VERBATIM 0x1
882 #define ZFS_IMPORT_ANY_HOST 0x2
883 #define ZFS_IMPORT_MISSING_LOG 0x4
884 #define ZFS_IMPORT_ONLY 0x8
887 * Sysevent payload members. ZFS will generate the following sysevents with the
890 * ESC_ZFS_RESILVER_START
891 * ESC_ZFS_RESILVER_END
892 * ESC_ZFS_POOL_DESTROY
893 * ESC_ZFS_POOL_REGUID
895 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
896 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
898 * ESC_ZFS_VDEV_REMOVE
902 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
903 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
904 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
905 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
907 #define ZFS_EV_POOL_NAME "pool_name"
908 #define ZFS_EV_POOL_GUID "pool_guid"
909 #define ZFS_EV_VDEV_PATH "vdev_path"
910 #define ZFS_EV_VDEV_GUID "vdev_guid"
913 * Note: This is encoded on-disk, so new events must be added to the
914 * end, and unused events can not be removed. Be sure to edit
915 * libzfs_pool.c: hist_event_table[].
917 typedef enum history_internal_events
{
925 LOG_POOL_VDEV_ATTACH
,
926 LOG_POOL_VDEV_REPLACE
,
927 LOG_POOL_VDEV_DETACH
,
928 LOG_POOL_VDEV_ONLINE
,
929 LOG_POOL_VDEV_OFFLINE
,
937 LOG_DS_DESTROY_BEGIN
,
943 LOG_DS_PERM_WHO_REMOVE
,
948 LOG_DS_REPLAY_INC_SYNC
,
949 LOG_DS_REPLAY_FULL_SYNC
,
959 LOG_POOL_GUID_CHANGE
,
961 } history_internal_events_t
;
967 #endif /* _SYS_FS_ZFS_H */