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) 2013 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 typedef enum dmu_objset_type
{
60 DMU_OST_OTHER
, /* For testing only! */
61 DMU_OST_ANY
, /* Be careful! */
65 #define ZFS_TYPE_DATASET \
66 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
68 #define ZAP_MAXNAMELEN 256
69 #define ZAP_MAXVALUELEN (1024 * 8)
70 #define ZAP_OLDMAXVALUELEN 1024
73 * Dataset properties are identified by these constants and must be added to
74 * the end of this list to ensure that external consumers are not affected
75 * by the change. If you make any changes to this list, be sure to update
76 * the property table in module/zcommon/zfs_prop.c.
84 ZFS_PROP_COMPRESSRATIO
,
90 ZFS_PROP_VOLBLOCKSIZE
,
103 ZFS_PROP_PRIVATE
, /* not exposed to user, temporary */
105 ZFS_PROP_CREATETXG
, /* not exposed to the user */
106 ZFS_PROP_NAME
, /* not exposed to the user */
108 ZFS_PROP_ISCSIOPTIONS
, /* not exposed to the user */
110 ZFS_PROP_NUMCLONES
, /* not exposed to the user */
120 ZFS_PROP_REFRESERVATION
,
122 ZFS_PROP_PRIMARYCACHE
,
123 ZFS_PROP_SECONDARYCACHE
,
127 ZFS_PROP_USEDREFRESERV
,
128 ZFS_PROP_USERACCOUNTING
, /* not exposed to the user */
129 ZFS_PROP_STMF_SHAREINFO
, /* not exposed to the user */
130 ZFS_PROP_DEFER_DESTROY
,
133 ZFS_PROP_UNIQUE
, /* not exposed to the user */
134 ZFS_PROP_OBJSETID
, /* not exposed to the user */
141 ZFS_PROP_LOGICALUSED
,
142 ZFS_PROP_LOGICALREFERENCED
,
143 ZFS_PROP_INCONSISTENT
, /* not exposed to the user */
154 ZFS_NUM_USERQUOTA_PROPS
155 } zfs_userquota_prop_t
;
157 extern const char *zfs_userquota_prop_prefixes
[ZFS_NUM_USERQUOTA_PROPS
];
160 * Pool properties are identified by these constants and must be added to the
161 * end of this list to ensure that external consumers are not affected
162 * by the change. If you make any changes to this list, be sure to update
163 * the property table in module/zcommon/zpool_prop.c.
174 ZPOOL_PROP_DELEGATION
,
175 ZPOOL_PROP_AUTOREPLACE
,
176 ZPOOL_PROP_CACHEFILE
,
177 ZPOOL_PROP_FAILUREMODE
,
178 ZPOOL_PROP_LISTSNAPS
,
179 ZPOOL_PROP_AUTOEXPAND
,
180 ZPOOL_PROP_DEDUPDITTO
,
181 ZPOOL_PROP_DEDUPRATIO
,
183 ZPOOL_PROP_ALLOCATED
,
192 /* Small enough to not hog a whole line of printout in zpool(1M). */
193 #define ZPROP_MAX_COMMENT 32
195 #define ZPROP_CONT -2
196 #define ZPROP_INVAL -1
198 #define ZPROP_VALUE "value"
199 #define ZPROP_SOURCE "source"
202 ZPROP_SRC_NONE
= 0x1,
203 ZPROP_SRC_DEFAULT
= 0x2,
204 ZPROP_SRC_TEMPORARY
= 0x4,
205 ZPROP_SRC_LOCAL
= 0x8,
206 ZPROP_SRC_INHERITED
= 0x10,
207 ZPROP_SRC_RECEIVED
= 0x20
210 #define ZPROP_SRC_ALL 0x3f
212 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
213 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
215 * Dataset flag implemented as a special entry in the props zap object
216 * indicating that the dataset has received properties on or after
217 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
218 * just as it did in earlier versions, and thereafter, local properties are
221 #define ZPROP_HAS_RECVD "$hasrecvd"
224 ZPROP_ERR_NOCLEAR
= 0x1, /* failure to clear existing props */
225 ZPROP_ERR_NORESTORE
= 0x2 /* failure to restore props on error */
228 typedef int (*zprop_func
)(int, void *);
231 * Properties to be set on the root file system of a new pool
232 * are stuffed into their own nvlist, which is then included in
233 * the properties nvlist with the pool properties.
235 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
238 * Dataset property functions shared between libzfs and kernel.
240 const char *zfs_prop_default_string(zfs_prop_t
);
241 uint64_t zfs_prop_default_numeric(zfs_prop_t
);
242 boolean_t
zfs_prop_readonly(zfs_prop_t
);
243 boolean_t
zfs_prop_inheritable(zfs_prop_t
);
244 boolean_t
zfs_prop_setonce(zfs_prop_t
);
245 const char *zfs_prop_to_name(zfs_prop_t
);
246 zfs_prop_t
zfs_name_to_prop(const char *);
247 boolean_t
zfs_prop_user(const char *);
248 boolean_t
zfs_prop_userquota(const char *);
249 boolean_t
zfs_prop_written(const char *);
250 int zfs_prop_index_to_string(zfs_prop_t
, uint64_t, const char **);
251 int zfs_prop_string_to_index(zfs_prop_t
, const char *, uint64_t *);
252 uint64_t zfs_prop_random_value(zfs_prop_t
, uint64_t seed
);
253 boolean_t
zfs_prop_valid_for_type(int, zfs_type_t
);
256 * Pool property functions shared between libzfs and kernel.
258 zpool_prop_t
zpool_name_to_prop(const char *);
259 const char *zpool_prop_to_name(zpool_prop_t
);
260 const char *zpool_prop_default_string(zpool_prop_t
);
261 uint64_t zpool_prop_default_numeric(zpool_prop_t
);
262 boolean_t
zpool_prop_readonly(zpool_prop_t
);
263 boolean_t
zpool_prop_feature(const char *);
264 boolean_t
zpool_prop_unsupported(const char *);
265 int zpool_prop_index_to_string(zpool_prop_t
, uint64_t, const char **);
266 int zpool_prop_string_to_index(zpool_prop_t
, const char *, uint64_t *);
267 uint64_t zpool_prop_random_value(zpool_prop_t
, uint64_t seed
);
270 * Definitions for the Delegation.
273 ZFS_DELEG_WHO_UNKNOWN
= 0,
274 ZFS_DELEG_USER
= 'u',
275 ZFS_DELEG_USER_SETS
= 'U',
276 ZFS_DELEG_GROUP
= 'g',
277 ZFS_DELEG_GROUP_SETS
= 'G',
278 ZFS_DELEG_EVERYONE
= 'e',
279 ZFS_DELEG_EVERYONE_SETS
= 'E',
280 ZFS_DELEG_CREATE
= 'c',
281 ZFS_DELEG_CREATE_SETS
= 'C',
282 ZFS_DELEG_NAMED_SET
= 's',
283 ZFS_DELEG_NAMED_SET_SETS
= 'S'
284 } zfs_deleg_who_type_t
;
288 ZFS_DELEG_PERM_LOCAL
= 1,
289 ZFS_DELEG_PERM_DESCENDENT
= 2,
290 ZFS_DELEG_PERM_LOCALDESCENDENT
= 3,
291 ZFS_DELEG_PERM_CREATE
= 4
292 } zfs_deleg_inherit_t
;
294 #define ZFS_DELEG_PERM_UID "uid"
295 #define ZFS_DELEG_PERM_GID "gid"
296 #define ZFS_DELEG_PERM_GROUPS "groups"
298 #define ZFS_MLSLABEL_DEFAULT "none"
300 #define ZFS_SMB_ACL_SRC "src"
301 #define ZFS_SMB_ACL_TARGET "target"
304 ZFS_CANMOUNT_OFF
= 0,
306 ZFS_CANMOUNT_NOAUTO
= 2
307 } zfs_canmount_type_t
;
310 ZFS_LOGBIAS_LATENCY
= 0,
311 ZFS_LOGBIAS_THROUGHPUT
= 1
314 typedef enum zfs_share_op
{
321 typedef enum zfs_smb_acl_op
{
328 typedef enum zfs_cache_type
{
330 ZFS_CACHE_METADATA
= 1,
335 ZFS_SYNC_STANDARD
= 0,
337 ZFS_SYNC_DISABLED
= 2
347 * On-disk version number.
349 #define SPA_VERSION_1 1ULL
350 #define SPA_VERSION_2 2ULL
351 #define SPA_VERSION_3 3ULL
352 #define SPA_VERSION_4 4ULL
353 #define SPA_VERSION_5 5ULL
354 #define SPA_VERSION_6 6ULL
355 #define SPA_VERSION_7 7ULL
356 #define SPA_VERSION_8 8ULL
357 #define SPA_VERSION_9 9ULL
358 #define SPA_VERSION_10 10ULL
359 #define SPA_VERSION_11 11ULL
360 #define SPA_VERSION_12 12ULL
361 #define SPA_VERSION_13 13ULL
362 #define SPA_VERSION_14 14ULL
363 #define SPA_VERSION_15 15ULL
364 #define SPA_VERSION_16 16ULL
365 #define SPA_VERSION_17 17ULL
366 #define SPA_VERSION_18 18ULL
367 #define SPA_VERSION_19 19ULL
368 #define SPA_VERSION_20 20ULL
369 #define SPA_VERSION_21 21ULL
370 #define SPA_VERSION_22 22ULL
371 #define SPA_VERSION_23 23ULL
372 #define SPA_VERSION_24 24ULL
373 #define SPA_VERSION_25 25ULL
374 #define SPA_VERSION_26 26ULL
375 #define SPA_VERSION_27 27ULL
376 #define SPA_VERSION_28 28ULL
377 #define SPA_VERSION_5000 5000ULL
380 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
381 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
382 * and do the appropriate changes. Also bump the version number in
383 * usr/src/grub/capability.
385 #define SPA_VERSION SPA_VERSION_5000
386 #define SPA_VERSION_STRING "5000"
389 * Symbolic names for the changes that caused a SPA_VERSION switch.
390 * Used in the code when checking for presence or absence of a feature.
391 * Feel free to define multiple symbolic names for each version if there
392 * were multiple changes to on-disk structures during that version.
394 * NOTE: When checking the current SPA_VERSION in your code, be sure
395 * to use spa_version() since it reports the version of the
396 * last synced uberblock. Checking the in-flight version can
397 * be dangerous in some cases.
399 #define SPA_VERSION_INITIAL SPA_VERSION_1
400 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
401 #define SPA_VERSION_SPARES SPA_VERSION_3
402 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
403 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
404 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
405 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
406 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
407 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
408 #define SPA_VERSION_BOOTFS SPA_VERSION_6
409 #define SPA_VERSION_SLOGS SPA_VERSION_7
410 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
411 #define SPA_VERSION_FUID SPA_VERSION_9
412 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
413 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
414 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
415 #define SPA_VERSION_L2CACHE SPA_VERSION_10
416 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
417 #define SPA_VERSION_ORIGIN SPA_VERSION_11
418 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
419 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
420 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
421 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
422 #define SPA_VERSION_USERSPACE SPA_VERSION_15
423 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
424 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
425 #define SPA_VERSION_USERREFS SPA_VERSION_18
426 #define SPA_VERSION_HOLES SPA_VERSION_19
427 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
428 #define SPA_VERSION_DEDUP SPA_VERSION_21
429 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
430 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
431 #define SPA_VERSION_SA SPA_VERSION_24
432 #define SPA_VERSION_SCAN SPA_VERSION_25
433 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
434 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
435 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
436 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
437 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
438 #define SPA_VERSION_FEATURES SPA_VERSION_5000
440 #define SPA_VERSION_IS_SUPPORTED(v) \
441 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
442 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
445 * ZPL version - rev'd whenever an incompatible on-disk format change
446 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
447 * also update the version_table[] and help message in zfs_prop.c.
449 * When changing, be sure to teach GRUB how to read the new format!
450 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
452 #define ZPL_VERSION_1 1ULL
453 #define ZPL_VERSION_2 2ULL
454 #define ZPL_VERSION_3 3ULL
455 #define ZPL_VERSION_4 4ULL
456 #define ZPL_VERSION_5 5ULL
457 #define ZPL_VERSION ZPL_VERSION_5
458 #define ZPL_VERSION_STRING "5"
460 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
461 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
462 #define ZPL_VERSION_FUID ZPL_VERSION_3
463 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
464 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
465 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
466 #define ZPL_VERSION_SA ZPL_VERSION_5
468 /* Rewind request information */
469 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
470 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
471 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
472 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
473 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
474 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
475 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
477 typedef struct zpool_rewind_policy
{
478 uint32_t zrp_request
; /* rewind behavior requested */
479 uint64_t zrp_maxmeta
; /* max acceptable meta-data errors */
480 uint64_t zrp_maxdata
; /* max acceptable data errors */
481 uint64_t zrp_txg
; /* specific txg to load */
482 } zpool_rewind_policy_t
;
485 * The following are configuration names used in the nvlist describing a pool's
488 #define ZPOOL_CONFIG_VERSION "version"
489 #define ZPOOL_CONFIG_POOL_NAME "name"
490 #define ZPOOL_CONFIG_POOL_STATE "state"
491 #define ZPOOL_CONFIG_POOL_TXG "txg"
492 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
493 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
494 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
495 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
496 #define ZPOOL_CONFIG_TYPE "type"
497 #define ZPOOL_CONFIG_CHILDREN "children"
498 #define ZPOOL_CONFIG_ID "id"
499 #define ZPOOL_CONFIG_GUID "guid"
500 #define ZPOOL_CONFIG_PATH "path"
501 #define ZPOOL_CONFIG_DEVID "devid"
502 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
503 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
504 #define ZPOOL_CONFIG_ASHIFT "ashift"
505 #define ZPOOL_CONFIG_ASIZE "asize"
506 #define ZPOOL_CONFIG_DTL "DTL"
507 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
508 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
509 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
510 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
511 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
512 #define ZPOOL_CONFIG_SPARES "spares"
513 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
514 #define ZPOOL_CONFIG_NPARITY "nparity"
515 #define ZPOOL_CONFIG_HOSTID "hostid"
516 #define ZPOOL_CONFIG_HOSTNAME "hostname"
517 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
518 #define ZPOOL_CONFIG_UNSPARE "unspare"
519 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
520 #define ZPOOL_CONFIG_IS_LOG "is_log"
521 #define ZPOOL_CONFIG_L2CACHE "l2cache"
522 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
523 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
524 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
525 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
526 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
527 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
528 #define ZPOOL_CONFIG_SPLIT "splitcfg"
529 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
530 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
531 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
532 #define ZPOOL_CONFIG_REMOVING "removing"
533 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
534 #define ZPOOL_CONFIG_COMMENT "comment"
535 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
536 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
537 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
538 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
539 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
540 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
541 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
542 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
543 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
544 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
545 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
547 * The persistent vdev state is stored as separate values rather than a single
548 * 'vdev_state' entry. This is because a device can be in multiple states, such
549 * as offline and degraded.
551 #define ZPOOL_CONFIG_OFFLINE "offline"
552 #define ZPOOL_CONFIG_FAULTED "faulted"
553 #define ZPOOL_CONFIG_DEGRADED "degraded"
554 #define ZPOOL_CONFIG_REMOVED "removed"
555 #define ZPOOL_CONFIG_FRU "fru"
556 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
558 /* Rewind policy parameters */
559 #define ZPOOL_REWIND_POLICY "rewind-policy"
560 #define ZPOOL_REWIND_REQUEST "rewind-request"
561 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
562 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
563 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
565 /* Rewind data discovered */
566 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
567 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
568 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
570 #define VDEV_TYPE_ROOT "root"
571 #define VDEV_TYPE_MIRROR "mirror"
572 #define VDEV_TYPE_REPLACING "replacing"
573 #define VDEV_TYPE_RAIDZ "raidz"
574 #define VDEV_TYPE_DISK "disk"
575 #define VDEV_TYPE_FILE "file"
576 #define VDEV_TYPE_MISSING "missing"
577 #define VDEV_TYPE_HOLE "hole"
578 #define VDEV_TYPE_SPARE "spare"
579 #define VDEV_TYPE_LOG "log"
580 #define VDEV_TYPE_L2CACHE "l2cache"
583 * This is needed in userland to report the minimum necessary device size.
585 #define SPA_MINDEVSIZE (64ULL << 20)
588 * The location of the pool configuration repository, shared between kernel and
591 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
594 * vdev states are ordered from least to most healthy.
595 * A vdev that's CANT_OPEN or below is considered unusable.
597 typedef enum vdev_state
{
598 VDEV_STATE_UNKNOWN
= 0, /* Uninitialized vdev */
599 VDEV_STATE_CLOSED
, /* Not currently open */
600 VDEV_STATE_OFFLINE
, /* Not allowed to open */
601 VDEV_STATE_REMOVED
, /* Explicitly removed from system */
602 VDEV_STATE_CANT_OPEN
, /* Tried to open, but failed */
603 VDEV_STATE_FAULTED
, /* External request to fault device */
604 VDEV_STATE_DEGRADED
, /* Replicated vdev with unhealthy kids */
605 VDEV_STATE_HEALTHY
/* Presumed good */
608 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
611 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
612 * of the vdev stats structure uses these constants to distinguish why.
614 typedef enum vdev_aux
{
615 VDEV_AUX_NONE
, /* no error */
616 VDEV_AUX_OPEN_FAILED
, /* ldi_open_*() or vn_open() failed */
617 VDEV_AUX_CORRUPT_DATA
, /* bad label or disk contents */
618 VDEV_AUX_NO_REPLICAS
, /* insufficient number of replicas */
619 VDEV_AUX_BAD_GUID_SUM
, /* vdev guid sum doesn't match */
620 VDEV_AUX_TOO_SMALL
, /* vdev size is too small */
621 VDEV_AUX_BAD_LABEL
, /* the label is OK but invalid */
622 VDEV_AUX_VERSION_NEWER
, /* on-disk version is too new */
623 VDEV_AUX_VERSION_OLDER
, /* on-disk version is too old */
624 VDEV_AUX_UNSUP_FEAT
, /* unsupported features */
625 VDEV_AUX_SPARED
, /* hot spare used in another pool */
626 VDEV_AUX_ERR_EXCEEDED
, /* too many errors */
627 VDEV_AUX_IO_FAILURE
, /* experienced I/O failure */
628 VDEV_AUX_BAD_LOG
, /* cannot read log chain(s) */
629 VDEV_AUX_EXTERNAL
, /* external diagnosis */
630 VDEV_AUX_SPLIT_POOL
/* vdev was split off into another pool */
634 * pool state. The following states are written to disk as part of the normal
635 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
636 * states are software abstractions used at various levels to communicate
639 typedef enum pool_state
{
640 POOL_STATE_ACTIVE
= 0, /* In active use */
641 POOL_STATE_EXPORTED
, /* Explicitly exported */
642 POOL_STATE_DESTROYED
, /* Explicitly destroyed */
643 POOL_STATE_SPARE
, /* Reserved for hot spare use */
644 POOL_STATE_L2CACHE
, /* Level 2 ARC device */
645 POOL_STATE_UNINITIALIZED
, /* Internal spa_t state */
646 POOL_STATE_UNAVAIL
, /* Internal libzfs state */
647 POOL_STATE_POTENTIALLY_ACTIVE
/* Internal libzfs state */
653 typedef enum pool_scan_func
{
661 * ZIO types. Needed to interpret vdev statistics below.
663 typedef enum zio_type
{
674 * Pool statistics. Note: all fields should be 64-bit because this
675 * is passed between kernel and userland as an nvlist uint64 array.
677 typedef struct pool_scan_stat
{
678 /* values stored on disk */
679 uint64_t pss_func
; /* pool_scan_func_t */
680 uint64_t pss_state
; /* dsl_scan_state_t */
681 uint64_t pss_start_time
; /* scan start time */
682 uint64_t pss_end_time
; /* scan end time */
683 uint64_t pss_to_examine
; /* total bytes to scan */
684 uint64_t pss_examined
; /* total examined bytes */
685 uint64_t pss_to_process
; /* total bytes to process */
686 uint64_t pss_processed
; /* total processed bytes */
687 uint64_t pss_errors
; /* scan errors */
689 /* values not stored on disk */
690 uint64_t pss_pass_exam
; /* examined bytes per scan pass */
691 uint64_t pss_pass_start
; /* start time of a scan pass */
694 typedef enum dsl_scan_state
{
704 * Vdev statistics. Note: all fields should be 64-bit because this
705 * is passed between kernel and userland as an nvlist uint64 array.
707 typedef struct vdev_stat
{
708 hrtime_t vs_timestamp
; /* time since vdev load */
709 uint64_t vs_state
; /* vdev state */
710 uint64_t vs_aux
; /* see vdev_aux_t */
711 uint64_t vs_alloc
; /* space allocated */
712 uint64_t vs_space
; /* total capacity */
713 uint64_t vs_dspace
; /* deflated capacity */
714 uint64_t vs_rsize
; /* replaceable dev size */
715 uint64_t vs_esize
; /* expandable dev size */
716 uint64_t vs_ops
[ZIO_TYPES
]; /* operation count */
717 uint64_t vs_bytes
[ZIO_TYPES
]; /* bytes read/written */
718 uint64_t vs_read_errors
; /* read errors */
719 uint64_t vs_write_errors
; /* write errors */
720 uint64_t vs_checksum_errors
; /* checksum errors */
721 uint64_t vs_self_healed
; /* self-healed bytes */
722 uint64_t vs_scan_removing
; /* removing? */
723 uint64_t vs_scan_processed
; /* scan processed bytes */
727 * DDT statistics. Note: all fields should be 64-bit because this
728 * is passed between kernel and userland as an nvlist uint64 array.
730 typedef struct ddt_object
{
731 uint64_t ddo_count
; /* number of elments in ddt */
732 uint64_t ddo_dspace
; /* size of ddt on disk */
733 uint64_t ddo_mspace
; /* size of ddt in-core */
736 typedef struct ddt_stat
{
737 uint64_t dds_blocks
; /* blocks */
738 uint64_t dds_lsize
; /* logical size */
739 uint64_t dds_psize
; /* physical size */
740 uint64_t dds_dsize
; /* deflated allocated size */
741 uint64_t dds_ref_blocks
; /* referenced blocks */
742 uint64_t dds_ref_lsize
; /* referenced lsize * refcnt */
743 uint64_t dds_ref_psize
; /* referenced psize * refcnt */
744 uint64_t dds_ref_dsize
; /* referenced dsize * refcnt */
747 typedef struct ddt_histogram
{
748 ddt_stat_t ddh_stat
[64]; /* power-of-two histogram buckets */
751 #define ZVOL_DRIVER "zvol"
752 #define ZFS_DRIVER "zfs"
753 #define ZFS_DEV "/dev/zfs"
755 /* general zvol path */
756 #define ZVOL_DIR "/dev"
758 #define ZVOL_MAJOR 230
759 #define ZVOL_MINOR_BITS 4
760 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
761 #define ZVOL_MINORS (1 << 4)
762 #define ZVOL_DEV_NAME "zd"
764 #define ZVOL_PROP_NAME "name"
765 #define ZVOL_DEFAULT_BLOCKSIZE 8192
768 * /dev/zfs ioctl numbers.
770 typedef enum zfs_ioc
{
772 * Illumos - 69/128 numbers reserved.
774 ZFS_IOC_FIRST
= ('Z' << 8),
775 ZFS_IOC
= ZFS_IOC_FIRST
,
776 ZFS_IOC_POOL_CREATE
= ZFS_IOC_FIRST
,
777 ZFS_IOC_POOL_DESTROY
,
780 ZFS_IOC_POOL_CONFIGS
,
782 ZFS_IOC_POOL_TRYIMPORT
,
785 ZFS_IOC_POOL_UPGRADE
,
786 ZFS_IOC_POOL_GET_HISTORY
,
789 ZFS_IOC_VDEV_SET_STATE
,
792 ZFS_IOC_VDEV_SETPATH
,
794 ZFS_IOC_OBJSET_STATS
,
795 ZFS_IOC_OBJSET_ZPLPROPS
,
796 ZFS_IOC_DATASET_LIST_NEXT
,
797 ZFS_IOC_SNAPSHOT_LIST_NEXT
,
805 ZFS_IOC_INJECT_FAULT
,
807 ZFS_IOC_INJECT_LIST_NEXT
,
812 ZFS_IOC_DSOBJ_TO_DSNAME
,
814 ZFS_IOC_POOL_SET_PROPS
,
815 ZFS_IOC_POOL_GET_PROPS
,
819 ZFS_IOC_INHERIT_PROP
,
821 ZFS_IOC_USERSPACE_ONE
,
822 ZFS_IOC_USERSPACE_MANY
,
823 ZFS_IOC_USERSPACE_UPGRADE
,
827 ZFS_IOC_OBJSET_RECVD_PROPS
,
831 ZFS_IOC_TMP_SNAPSHOT
,
832 ZFS_IOC_OBJ_TO_STATS
,
833 ZFS_IOC_SPACE_WRITTEN
,
835 ZFS_IOC_DESTROY_SNAPS
,
838 ZFS_IOC_SEND_PROGRESS
,
845 * Linux - 3/64 numbers reserved.
847 ZFS_IOC_LINUX
= ('Z' << 8) + 0x80,
849 ZFS_IOC_EVENTS_CLEAR
,
852 * FreeBSD - 1/64 numbers reserved.
854 ZFS_IOC_FREEBSD
= ('Z' << 8) + 0xC0,
860 * zvol ioctl to get dataset name
862 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAXNAMELEN])
865 * Internal SPA load state. Used by FMA diagnosis engine.
868 SPA_LOAD_NONE
, /* no load in progress */
869 SPA_LOAD_OPEN
, /* normal open */
870 SPA_LOAD_IMPORT
, /* import in progress */
871 SPA_LOAD_TRYIMPORT
, /* tryimport in progress */
872 SPA_LOAD_RECOVER
, /* recovery requested */
873 SPA_LOAD_ERROR
/* load failed */
877 * Bookmark name values.
879 #define ZPOOL_ERR_LIST "error list"
880 #define ZPOOL_ERR_DATASET "dataset"
881 #define ZPOOL_ERR_OBJECT "object"
883 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
886 * The following are names used in the nvlist describing
887 * the pool's history log.
889 #define ZPOOL_HIST_RECORD "history record"
890 #define ZPOOL_HIST_TIME "history time"
891 #define ZPOOL_HIST_CMD "history command"
892 #define ZPOOL_HIST_WHO "history who"
893 #define ZPOOL_HIST_ZONE "history zone"
894 #define ZPOOL_HIST_HOST "history hostname"
895 #define ZPOOL_HIST_TXG "history txg"
896 #define ZPOOL_HIST_INT_EVENT "history internal event"
897 #define ZPOOL_HIST_INT_STR "history internal str"
898 #define ZPOOL_HIST_INT_NAME "internal_name"
899 #define ZPOOL_HIST_IOCTL "ioctl"
900 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
901 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
902 #define ZPOOL_HIST_DSNAME "dsname"
903 #define ZPOOL_HIST_DSID "dsid"
906 * Flags for ZFS_IOC_VDEV_SET_STATE
908 #define ZFS_ONLINE_CHECKREMOVE 0x1
909 #define ZFS_ONLINE_UNSPARE 0x2
910 #define ZFS_ONLINE_FORCEFAULT 0x4
911 #define ZFS_ONLINE_EXPAND 0x8
912 #define ZFS_OFFLINE_TEMPORARY 0x1
915 * Flags for ZFS_IOC_POOL_IMPORT
917 #define ZFS_IMPORT_NORMAL 0x0
918 #define ZFS_IMPORT_VERBATIM 0x1
919 #define ZFS_IMPORT_ANY_HOST 0x2
920 #define ZFS_IMPORT_MISSING_LOG 0x4
921 #define ZFS_IMPORT_ONLY 0x8
924 * Sysevent payload members. ZFS will generate the following sysevents with the
927 * ESC_ZFS_RESILVER_START
928 * ESC_ZFS_RESILVER_END
929 * ESC_ZFS_POOL_DESTROY
930 * ESC_ZFS_POOL_REGUID
932 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
933 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
935 * ESC_ZFS_VDEV_REMOVE
939 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
940 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
941 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
942 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
944 #define ZFS_EV_POOL_NAME "pool_name"
945 #define ZFS_EV_POOL_GUID "pool_guid"
946 #define ZFS_EV_VDEV_PATH "vdev_path"
947 #define ZFS_EV_VDEV_GUID "vdev_guid"
953 #endif /* _SYS_FS_ZFS_H */