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, 2018 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2013, 2017 Joyent, Inc. All rights reserved.
27 * Copyright (c) 2014 Integros [integros.com]
28 * Copyright (c) 2017, Intel Corporation.
29 * Copyright (c) 2019 Datto Inc.
32 /* Portions Copyright 2010 Robert Milkowski */
38 #include <sys/zio_priority.h>
45 * Types and constants shared between userland and the kernel.
49 * Each dataset can be one of the following types. These constants can be
50 * combined into masks that can be passed to various functions.
53 ZFS_TYPE_FILESYSTEM
= (1 << 0),
54 ZFS_TYPE_SNAPSHOT
= (1 << 1),
55 ZFS_TYPE_VOLUME
= (1 << 2),
56 ZFS_TYPE_POOL
= (1 << 3),
57 ZFS_TYPE_BOOKMARK
= (1 << 4)
61 * NB: lzc_dataset_type should be updated whenever a new objset type is added,
62 * if it represents a real type of a dataset that can be created from userland.
64 typedef enum dmu_objset_type
{
69 DMU_OST_OTHER
, /* For testing only! */
70 DMU_OST_ANY
, /* Be careful! */
74 #define ZFS_TYPE_DATASET \
75 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
78 * All of these include the terminating NUL byte.
80 #define ZAP_MAXNAMELEN 256
81 #define ZAP_MAXVALUELEN (1024 * 8)
82 #define ZAP_OLDMAXVALUELEN 1024
83 #define ZFS_MAX_DATASET_NAME_LEN 256
86 * Dataset properties are identified by these constants and must be added to
87 * the end of this list to ensure that external consumers are not affected
88 * by the change. If you make any changes to this list, be sure to update
89 * the property table in module/zcommon/zfs_prop.c.
99 ZFS_PROP_COMPRESSRATIO
,
103 ZFS_PROP_RESERVATION
,
105 ZFS_PROP_VOLBLOCKSIZE
,
110 ZFS_PROP_COMPRESSION
,
121 ZFS_PROP_NAME
, /* not exposed to the user */
123 ZFS_PROP_ISCSIOPTIONS
, /* not exposed to the user */
125 ZFS_PROP_NUMCLONES
, /* not exposed to the user */
135 ZFS_PROP_REFRESERVATION
,
137 ZFS_PROP_PRIMARYCACHE
,
138 ZFS_PROP_SECONDARYCACHE
,
142 ZFS_PROP_USEDREFRESERV
,
143 ZFS_PROP_USERACCOUNTING
, /* not exposed to the user */
144 ZFS_PROP_STMF_SHAREINFO
, /* not exposed to the user */
145 ZFS_PROP_DEFER_DESTROY
,
148 ZFS_PROP_UNIQUE
, /* not exposed to the user */
157 ZFS_PROP_LOGICALUSED
,
158 ZFS_PROP_LOGICALREFERENCED
,
159 ZFS_PROP_INCONSISTENT
, /* not exposed to the user */
161 ZFS_PROP_FILESYSTEM_LIMIT
,
162 ZFS_PROP_SNAPSHOT_LIMIT
,
163 ZFS_PROP_FILESYSTEM_COUNT
,
164 ZFS_PROP_SNAPSHOT_COUNT
,
167 ZFS_PROP_SELINUX_CONTEXT
,
168 ZFS_PROP_SELINUX_FSCONTEXT
,
169 ZFS_PROP_SELINUX_DEFCONTEXT
,
170 ZFS_PROP_SELINUX_ROOTCONTEXT
,
172 ZFS_PROP_REDUNDANT_METADATA
,
175 ZFS_PROP_RECEIVE_RESUME_TOKEN
,
177 ZFS_PROP_KEYLOCATION
,
179 ZFS_PROP_PBKDF2_SALT
,
180 ZFS_PROP_PBKDF2_ITERS
,
181 ZFS_PROP_ENCRYPTION_ROOT
,
184 ZFS_PROP_REMAPTXG
, /* obsolete - no longer used */
185 ZFS_PROP_SPECIAL_SMALL_BLOCKS
,
186 ZFS_PROP_IVSET_GUID
, /* not exposed to the user */
188 ZFS_PROP_REDACT_SNAPS
,
197 ZFS_PROP_USEROBJUSED
,
198 ZFS_PROP_USEROBJQUOTA
,
199 ZFS_PROP_GROUPOBJUSED
,
200 ZFS_PROP_GROUPOBJQUOTA
,
201 ZFS_PROP_PROJECTUSED
,
202 ZFS_PROP_PROJECTQUOTA
,
203 ZFS_PROP_PROJECTOBJUSED
,
204 ZFS_PROP_PROJECTOBJQUOTA
,
205 ZFS_NUM_USERQUOTA_PROPS
206 } zfs_userquota_prop_t
;
208 extern const char *zfs_userquota_prop_prefixes
[ZFS_NUM_USERQUOTA_PROPS
];
211 * Pool properties are identified by these constants and must be added to the
212 * end of this list to ensure that external consumers are not affected
213 * by the change. Properties must be registered in zfs_prop_init().
216 ZPOOL_PROP_INVAL
= -1,
225 ZPOOL_PROP_DELEGATION
,
226 ZPOOL_PROP_AUTOREPLACE
,
227 ZPOOL_PROP_CACHEFILE
,
228 ZPOOL_PROP_FAILUREMODE
,
229 ZPOOL_PROP_LISTSNAPS
,
230 ZPOOL_PROP_AUTOEXPAND
,
231 ZPOOL_PROP_DEDUPDITTO
,
232 ZPOOL_PROP_DEDUPRATIO
,
234 ZPOOL_PROP_ALLOCATED
,
240 ZPOOL_PROP_FRAGMENTATION
,
242 ZPOOL_PROP_MAXBLOCKSIZE
,
244 ZPOOL_PROP_MAXDNODESIZE
,
245 ZPOOL_PROP_MULTIHOST
,
246 ZPOOL_PROP_CHECKPOINT
,
247 ZPOOL_PROP_LOAD_GUID
,
252 /* Small enough to not hog a whole line of printout in zpool(1M). */
253 #define ZPROP_MAX_COMMENT 32
255 #define ZPROP_VALUE "value"
256 #define ZPROP_SOURCE "source"
259 ZPROP_SRC_NONE
= 0x1,
260 ZPROP_SRC_DEFAULT
= 0x2,
261 ZPROP_SRC_TEMPORARY
= 0x4,
262 ZPROP_SRC_LOCAL
= 0x8,
263 ZPROP_SRC_INHERITED
= 0x10,
264 ZPROP_SRC_RECEIVED
= 0x20
267 #define ZPROP_SRC_ALL 0x3f
269 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
270 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
273 * Dataset flag implemented as a special entry in the props zap object
274 * indicating that the dataset has received properties on or after
275 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
276 * just as it did in earlier versions, and thereafter, local properties are
279 #define ZPROP_HAS_RECVD "$hasrecvd"
282 ZPROP_ERR_NOCLEAR
= 0x1, /* failure to clear existing props */
283 ZPROP_ERR_NORESTORE
= 0x2 /* failure to restore props on error */
286 typedef int (*zprop_func
)(int, void *);
289 * Properties to be set on the root file system of a new pool
290 * are stuffed into their own nvlist, which is then included in
291 * the properties nvlist with the pool properties.
293 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
296 * Length of 'written@' and 'written#'
298 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8
301 * Dataset property functions shared between libzfs and kernel.
303 const char *zfs_prop_default_string(zfs_prop_t
);
304 uint64_t zfs_prop_default_numeric(zfs_prop_t
);
305 boolean_t
zfs_prop_readonly(zfs_prop_t
);
306 boolean_t
zfs_prop_visible(zfs_prop_t prop
);
307 boolean_t
zfs_prop_inheritable(zfs_prop_t
);
308 boolean_t
zfs_prop_setonce(zfs_prop_t
);
309 boolean_t
zfs_prop_encryption_key_param(zfs_prop_t
);
310 boolean_t
zfs_prop_valid_keylocation(const char *, boolean_t
);
311 const char *zfs_prop_to_name(zfs_prop_t
);
312 zfs_prop_t
zfs_name_to_prop(const char *);
313 boolean_t
zfs_prop_user(const char *);
314 boolean_t
zfs_prop_userquota(const char *);
315 boolean_t
zfs_prop_written(const char *);
316 int zfs_prop_index_to_string(zfs_prop_t
, uint64_t, const char **);
317 int zfs_prop_string_to_index(zfs_prop_t
, const char *, uint64_t *);
318 uint64_t zfs_prop_random_value(zfs_prop_t
, uint64_t seed
);
319 boolean_t
zfs_prop_valid_for_type(int, zfs_type_t
, boolean_t
);
322 * Pool property functions shared between libzfs and kernel.
324 zpool_prop_t
zpool_name_to_prop(const char *);
325 const char *zpool_prop_to_name(zpool_prop_t
);
326 const char *zpool_prop_default_string(zpool_prop_t
);
327 uint64_t zpool_prop_default_numeric(zpool_prop_t
);
328 boolean_t
zpool_prop_readonly(zpool_prop_t
);
329 boolean_t
zpool_prop_setonce(zpool_prop_t
);
330 boolean_t
zpool_prop_feature(const char *);
331 boolean_t
zpool_prop_unsupported(const char *);
332 int zpool_prop_index_to_string(zpool_prop_t
, uint64_t, const char **);
333 int zpool_prop_string_to_index(zpool_prop_t
, const char *, uint64_t *);
334 uint64_t zpool_prop_random_value(zpool_prop_t
, uint64_t seed
);
337 * Definitions for the Delegation.
340 ZFS_DELEG_WHO_UNKNOWN
= 0,
341 ZFS_DELEG_USER
= 'u',
342 ZFS_DELEG_USER_SETS
= 'U',
343 ZFS_DELEG_GROUP
= 'g',
344 ZFS_DELEG_GROUP_SETS
= 'G',
345 ZFS_DELEG_EVERYONE
= 'e',
346 ZFS_DELEG_EVERYONE_SETS
= 'E',
347 ZFS_DELEG_CREATE
= 'c',
348 ZFS_DELEG_CREATE_SETS
= 'C',
349 ZFS_DELEG_NAMED_SET
= 's',
350 ZFS_DELEG_NAMED_SET_SETS
= 'S'
351 } zfs_deleg_who_type_t
;
355 ZFS_DELEG_PERM_LOCAL
= 1,
356 ZFS_DELEG_PERM_DESCENDENT
= 2,
357 ZFS_DELEG_PERM_LOCALDESCENDENT
= 3,
358 ZFS_DELEG_PERM_CREATE
= 4
359 } zfs_deleg_inherit_t
;
361 #define ZFS_DELEG_PERM_UID "uid"
362 #define ZFS_DELEG_PERM_GID "gid"
363 #define ZFS_DELEG_PERM_GROUPS "groups"
365 #define ZFS_MLSLABEL_DEFAULT "none"
367 #define ZFS_SMB_ACL_SRC "src"
368 #define ZFS_SMB_ACL_TARGET "target"
371 ZFS_CANMOUNT_OFF
= 0,
373 ZFS_CANMOUNT_NOAUTO
= 2
374 } zfs_canmount_type_t
;
377 ZFS_LOGBIAS_LATENCY
= 0,
378 ZFS_LOGBIAS_THROUGHPUT
= 1
381 typedef enum zfs_share_op
{
388 typedef enum zfs_smb_acl_op
{
395 typedef enum zfs_cache_type
{
397 ZFS_CACHE_METADATA
= 1,
402 ZFS_SYNC_STANDARD
= 0,
404 ZFS_SYNC_DISABLED
= 2
414 ZFS_DNSIZE_LEGACY
= 0,
416 ZFS_DNSIZE_1K
= 1024,
417 ZFS_DNSIZE_2K
= 2048,
418 ZFS_DNSIZE_4K
= 4096,
419 ZFS_DNSIZE_8K
= 8192,
420 ZFS_DNSIZE_16K
= 16384
424 ZFS_REDUNDANT_METADATA_ALL
,
425 ZFS_REDUNDANT_METADATA_MOST
426 } zfs_redundant_metadata_type_t
;
429 ZFS_VOLMODE_DEFAULT
= 0,
430 ZFS_VOLMODE_GEOM
= 1,
435 typedef enum zfs_keystatus
{
436 ZFS_KEYSTATUS_NONE
= 0,
437 ZFS_KEYSTATUS_UNAVAILABLE
,
438 ZFS_KEYSTATUS_AVAILABLE
,
441 typedef enum zfs_keyformat
{
442 ZFS_KEYFORMAT_NONE
= 0,
445 ZFS_KEYFORMAT_PASSPHRASE
,
446 ZFS_KEYFORMAT_FORMATS
449 typedef enum zfs_key_location
{
450 ZFS_KEYLOCATION_NONE
= 0,
451 ZFS_KEYLOCATION_PROMPT
,
453 ZFS_KEYLOCATION_LOCATIONS
456 #define DEFAULT_PBKDF2_ITERATIONS 350000
457 #define MIN_PBKDF2_ITERATIONS 100000
460 * On-disk version number.
462 #define SPA_VERSION_1 1ULL
463 #define SPA_VERSION_2 2ULL
464 #define SPA_VERSION_3 3ULL
465 #define SPA_VERSION_4 4ULL
466 #define SPA_VERSION_5 5ULL
467 #define SPA_VERSION_6 6ULL
468 #define SPA_VERSION_7 7ULL
469 #define SPA_VERSION_8 8ULL
470 #define SPA_VERSION_9 9ULL
471 #define SPA_VERSION_10 10ULL
472 #define SPA_VERSION_11 11ULL
473 #define SPA_VERSION_12 12ULL
474 #define SPA_VERSION_13 13ULL
475 #define SPA_VERSION_14 14ULL
476 #define SPA_VERSION_15 15ULL
477 #define SPA_VERSION_16 16ULL
478 #define SPA_VERSION_17 17ULL
479 #define SPA_VERSION_18 18ULL
480 #define SPA_VERSION_19 19ULL
481 #define SPA_VERSION_20 20ULL
482 #define SPA_VERSION_21 21ULL
483 #define SPA_VERSION_22 22ULL
484 #define SPA_VERSION_23 23ULL
485 #define SPA_VERSION_24 24ULL
486 #define SPA_VERSION_25 25ULL
487 #define SPA_VERSION_26 26ULL
488 #define SPA_VERSION_27 27ULL
489 #define SPA_VERSION_28 28ULL
490 #define SPA_VERSION_5000 5000ULL
493 * The incrementing pool version number has been replaced by pool feature
494 * flags. For more details, see zfeature.c.
496 #define SPA_VERSION SPA_VERSION_5000
497 #define SPA_VERSION_STRING "5000"
500 * Symbolic names for the changes that caused a SPA_VERSION switch.
501 * Used in the code when checking for presence or absence of a feature.
502 * Feel free to define multiple symbolic names for each version if there
503 * were multiple changes to on-disk structures during that version.
505 * NOTE: When checking the current SPA_VERSION in your code, be sure
506 * to use spa_version() since it reports the version of the
507 * last synced uberblock. Checking the in-flight version can
508 * be dangerous in some cases.
510 #define SPA_VERSION_INITIAL SPA_VERSION_1
511 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
512 #define SPA_VERSION_SPARES SPA_VERSION_3
513 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
514 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
515 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
516 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
517 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
518 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
519 #define SPA_VERSION_BOOTFS SPA_VERSION_6
520 #define SPA_VERSION_SLOGS SPA_VERSION_7
521 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
522 #define SPA_VERSION_FUID SPA_VERSION_9
523 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
524 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
525 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
526 #define SPA_VERSION_L2CACHE SPA_VERSION_10
527 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
528 #define SPA_VERSION_ORIGIN SPA_VERSION_11
529 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
530 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
531 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
532 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
533 #define SPA_VERSION_USERSPACE SPA_VERSION_15
534 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
535 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
536 #define SPA_VERSION_USERREFS SPA_VERSION_18
537 #define SPA_VERSION_HOLES SPA_VERSION_19
538 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
539 #define SPA_VERSION_DEDUP SPA_VERSION_21
540 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
541 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
542 #define SPA_VERSION_SA SPA_VERSION_24
543 #define SPA_VERSION_SCAN SPA_VERSION_25
544 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
545 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
546 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
547 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
548 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
549 #define SPA_VERSION_FEATURES SPA_VERSION_5000
551 #define SPA_VERSION_IS_SUPPORTED(v) \
552 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
553 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
556 * ZPL version - rev'd whenever an incompatible on-disk format change
557 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
558 * also update the version_table[] and help message in zfs_prop.c.
560 #define ZPL_VERSION_1 1ULL
561 #define ZPL_VERSION_2 2ULL
562 #define ZPL_VERSION_3 3ULL
563 #define ZPL_VERSION_4 4ULL
564 #define ZPL_VERSION_5 5ULL
565 #define ZPL_VERSION ZPL_VERSION_5
566 #define ZPL_VERSION_STRING "5"
568 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
569 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
570 #define ZPL_VERSION_FUID ZPL_VERSION_3
571 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
572 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
573 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
574 #define ZPL_VERSION_SA ZPL_VERSION_5
576 /* Rewind policy information */
577 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
578 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
579 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
580 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
581 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
582 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
583 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
585 typedef struct zpool_load_policy
{
586 uint32_t zlp_rewind
; /* rewind policy requested */
587 uint64_t zlp_maxmeta
; /* max acceptable meta-data errors */
588 uint64_t zlp_maxdata
; /* max acceptable data errors */
589 uint64_t zlp_txg
; /* specific txg to load */
590 } zpool_load_policy_t
;
593 * The following are configuration names used in the nvlist describing a pool's
594 * configuration. New on-disk names should be prefixed with "<reversed-DNS>:"
595 * (e.g. "org.openzfs:") to avoid conflicting names being developed
598 #define ZPOOL_CONFIG_VERSION "version"
599 #define ZPOOL_CONFIG_POOL_NAME "name"
600 #define ZPOOL_CONFIG_POOL_STATE "state"
601 #define ZPOOL_CONFIG_POOL_TXG "txg"
602 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
603 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
604 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
605 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
606 #define ZPOOL_CONFIG_TYPE "type"
607 #define ZPOOL_CONFIG_CHILDREN "children"
608 #define ZPOOL_CONFIG_ID "id"
609 #define ZPOOL_CONFIG_GUID "guid"
610 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object"
611 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births"
612 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev"
613 #define ZPOOL_CONFIG_PATH "path"
614 #define ZPOOL_CONFIG_DEVID "devid"
615 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
616 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
617 #define ZPOOL_CONFIG_ASHIFT "ashift"
618 #define ZPOOL_CONFIG_ASIZE "asize"
619 #define ZPOOL_CONFIG_DTL "DTL"
620 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
621 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */
622 #define ZPOOL_CONFIG_CHECKPOINT_STATS "checkpoint_stats" /* not on disk */
623 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
624 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */
626 /* container nvlist of extended stats */
627 #define ZPOOL_CONFIG_VDEV_STATS_EX "vdev_stats_ex"
629 /* Active queue read/write stats */
630 #define ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE "vdev_sync_r_active_queue"
631 #define ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE "vdev_sync_w_active_queue"
632 #define ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE "vdev_async_r_active_queue"
633 #define ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE "vdev_async_w_active_queue"
634 #define ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE "vdev_async_scrub_active_queue"
635 #define ZPOOL_CONFIG_VDEV_TRIM_ACTIVE_QUEUE "vdev_async_trim_active_queue"
638 #define ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE "vdev_sync_r_pend_queue"
639 #define ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE "vdev_sync_w_pend_queue"
640 #define ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE "vdev_async_r_pend_queue"
641 #define ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE "vdev_async_w_pend_queue"
642 #define ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE "vdev_async_scrub_pend_queue"
643 #define ZPOOL_CONFIG_VDEV_TRIM_PEND_QUEUE "vdev_async_trim_pend_queue"
645 /* Latency read/write histogram stats */
646 #define ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO "vdev_tot_r_lat_histo"
647 #define ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO "vdev_tot_w_lat_histo"
648 #define ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO "vdev_disk_r_lat_histo"
649 #define ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO "vdev_disk_w_lat_histo"
650 #define ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO "vdev_sync_r_lat_histo"
651 #define ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO "vdev_sync_w_lat_histo"
652 #define ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO "vdev_async_r_lat_histo"
653 #define ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO "vdev_async_w_lat_histo"
654 #define ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO "vdev_scrub_histo"
655 #define ZPOOL_CONFIG_VDEV_TRIM_LAT_HISTO "vdev_trim_histo"
657 /* Request size histograms */
658 #define ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO "vdev_sync_ind_r_histo"
659 #define ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO "vdev_sync_ind_w_histo"
660 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO "vdev_async_ind_r_histo"
661 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO "vdev_async_ind_w_histo"
662 #define ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO "vdev_ind_scrub_histo"
663 #define ZPOOL_CONFIG_VDEV_IND_TRIM_HISTO "vdev_ind_trim_histo"
664 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO "vdev_sync_agg_r_histo"
665 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO "vdev_sync_agg_w_histo"
666 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO "vdev_async_agg_r_histo"
667 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO "vdev_async_agg_w_histo"
668 #define ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO "vdev_agg_scrub_histo"
669 #define ZPOOL_CONFIG_VDEV_AGG_TRIM_HISTO "vdev_agg_trim_histo"
671 /* Number of slow IOs */
672 #define ZPOOL_CONFIG_VDEV_SLOW_IOS "vdev_slow_ios"
674 /* vdev enclosure sysfs path */
675 #define ZPOOL_CONFIG_VDEV_ENC_SYSFS_PATH "vdev_enc_sysfs_path"
677 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
678 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
679 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
680 #define ZPOOL_CONFIG_SPARES "spares"
681 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
682 #define ZPOOL_CONFIG_NPARITY "nparity"
683 #define ZPOOL_CONFIG_HOSTID "hostid"
684 #define ZPOOL_CONFIG_HOSTNAME "hostname"
685 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
686 #define ZPOOL_CONFIG_UNSPARE "unspare"
687 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
688 #define ZPOOL_CONFIG_IS_LOG "is_log"
689 #define ZPOOL_CONFIG_L2CACHE "l2cache"
690 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
691 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
692 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
693 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
694 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
695 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
696 #define ZPOOL_CONFIG_SPLIT "splitcfg"
697 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
698 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
699 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
700 #define ZPOOL_CONFIG_REMOVING "removing"
701 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
702 #define ZPOOL_CONFIG_COMMENT "comment"
703 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
704 #define ZPOOL_CONFIG_SUSPENDED_REASON "suspended_reason" /* not stored */
705 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
706 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
707 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
708 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
709 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
710 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
711 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
712 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
713 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
714 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
715 #define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */
716 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
717 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
718 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
719 #define ZPOOL_CONFIG_RESILVER_DEFER "com.datto:resilver_defer"
720 #define ZPOOL_CONFIG_CACHEFILE "cachefile" /* not stored on disk */
721 #define ZPOOL_CONFIG_MMP_STATE "mmp_state" /* not stored on disk */
722 #define ZPOOL_CONFIG_MMP_TXG "mmp_txg" /* not stored on disk */
723 #define ZPOOL_CONFIG_MMP_SEQ "mmp_seq" /* not stored on disk */
724 #define ZPOOL_CONFIG_MMP_HOSTNAME "mmp_hostname" /* not stored on disk */
725 #define ZPOOL_CONFIG_MMP_HOSTID "mmp_hostid" /* not stored on disk */
726 #define ZPOOL_CONFIG_ALLOCATION_BIAS "alloc_bias" /* not stored on disk */
727 #define ZPOOL_CONFIG_EXPANSION_TIME "expansion_time" /* not stored */
730 * The persistent vdev state is stored as separate values rather than a single
731 * 'vdev_state' entry. This is because a device can be in multiple states, such
732 * as offline and degraded.
734 #define ZPOOL_CONFIG_OFFLINE "offline"
735 #define ZPOOL_CONFIG_FAULTED "faulted"
736 #define ZPOOL_CONFIG_DEGRADED "degraded"
737 #define ZPOOL_CONFIG_REMOVED "removed"
738 #define ZPOOL_CONFIG_FRU "fru"
739 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
741 /* Pool load policy parameters */
742 #define ZPOOL_LOAD_POLICY "load-policy"
743 #define ZPOOL_LOAD_REWIND_POLICY "load-rewind-policy"
744 #define ZPOOL_LOAD_REQUEST_TXG "load-request-txg"
745 #define ZPOOL_LOAD_META_THRESH "load-meta-thresh"
746 #define ZPOOL_LOAD_DATA_THRESH "load-data-thresh"
748 /* Rewind data discovered */
749 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
750 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
751 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
753 #define VDEV_TYPE_ROOT "root"
754 #define VDEV_TYPE_MIRROR "mirror"
755 #define VDEV_TYPE_REPLACING "replacing"
756 #define VDEV_TYPE_RAIDZ "raidz"
757 #define VDEV_TYPE_DISK "disk"
758 #define VDEV_TYPE_FILE "file"
759 #define VDEV_TYPE_MISSING "missing"
760 #define VDEV_TYPE_HOLE "hole"
761 #define VDEV_TYPE_SPARE "spare"
762 #define VDEV_TYPE_LOG "log"
763 #define VDEV_TYPE_L2CACHE "l2cache"
764 #define VDEV_TYPE_INDIRECT "indirect"
766 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */
767 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \
768 "com.delphix:indirect_obsolete_sm"
769 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \
770 "com.delphix:obsolete_counts_are_precise"
771 #define VDEV_TOP_ZAP_POOL_CHECKPOINT_SM \
772 "com.delphix:pool_checkpoint_sm"
773 #define VDEV_TOP_ZAP_MS_UNFLUSHED_PHYS_TXGS \
774 "com.delphix:ms_unflushed_phys_txgs"
776 #define VDEV_TOP_ZAP_ALLOCATION_BIAS \
777 "org.zfsonlinux:allocation_bias"
779 /* vdev metaslab allocation bias */
780 #define VDEV_ALLOC_BIAS_LOG "log"
781 #define VDEV_ALLOC_BIAS_SPECIAL "special"
782 #define VDEV_ALLOC_BIAS_DEDUP "dedup"
784 /* vdev initialize state */
785 #define VDEV_LEAF_ZAP_INITIALIZE_LAST_OFFSET \
786 "com.delphix:next_offset_to_initialize"
787 #define VDEV_LEAF_ZAP_INITIALIZE_STATE \
788 "com.delphix:vdev_initialize_state"
789 #define VDEV_LEAF_ZAP_INITIALIZE_ACTION_TIME \
790 "com.delphix:vdev_initialize_action_time"
792 /* vdev TRIM state */
793 #define VDEV_LEAF_ZAP_TRIM_LAST_OFFSET \
794 "org.zfsonlinux:next_offset_to_trim"
795 #define VDEV_LEAF_ZAP_TRIM_STATE \
796 "org.zfsonlinux:vdev_trim_state"
797 #define VDEV_LEAF_ZAP_TRIM_ACTION_TIME \
798 "org.zfsonlinux:vdev_trim_action_time"
799 #define VDEV_LEAF_ZAP_TRIM_RATE \
800 "org.zfsonlinux:vdev_trim_rate"
801 #define VDEV_LEAF_ZAP_TRIM_PARTIAL \
802 "org.zfsonlinux:vdev_trim_partial"
803 #define VDEV_LEAF_ZAP_TRIM_SECURE \
804 "org.zfsonlinux:vdev_trim_secure"
807 * This is needed in userland to report the minimum necessary device size.
809 #define SPA_MINDEVSIZE (64ULL << 20)
812 * Set if the fragmentation has not yet been calculated. This can happen
813 * because the space maps have not been upgraded or the histogram feature
816 #define ZFS_FRAG_INVALID UINT64_MAX
819 * The location of the pool configuration repository, shared between kernel and
822 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
825 * vdev states are ordered from least to most healthy.
826 * A vdev that's CANT_OPEN or below is considered unusable.
828 typedef enum vdev_state
{
829 VDEV_STATE_UNKNOWN
= 0, /* Uninitialized vdev */
830 VDEV_STATE_CLOSED
, /* Not currently open */
831 VDEV_STATE_OFFLINE
, /* Not allowed to open */
832 VDEV_STATE_REMOVED
, /* Explicitly removed from system */
833 VDEV_STATE_CANT_OPEN
, /* Tried to open, but failed */
834 VDEV_STATE_FAULTED
, /* External request to fault device */
835 VDEV_STATE_DEGRADED
, /* Replicated vdev with unhealthy kids */
836 VDEV_STATE_HEALTHY
/* Presumed good */
839 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
842 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
843 * of the vdev stats structure uses these constants to distinguish why.
845 typedef enum vdev_aux
{
846 VDEV_AUX_NONE
, /* no error */
847 VDEV_AUX_OPEN_FAILED
, /* ldi_open_*() or vn_open() failed */
848 VDEV_AUX_CORRUPT_DATA
, /* bad label or disk contents */
849 VDEV_AUX_NO_REPLICAS
, /* insufficient number of replicas */
850 VDEV_AUX_BAD_GUID_SUM
, /* vdev guid sum doesn't match */
851 VDEV_AUX_TOO_SMALL
, /* vdev size is too small */
852 VDEV_AUX_BAD_LABEL
, /* the label is OK but invalid */
853 VDEV_AUX_VERSION_NEWER
, /* on-disk version is too new */
854 VDEV_AUX_VERSION_OLDER
, /* on-disk version is too old */
855 VDEV_AUX_UNSUP_FEAT
, /* unsupported features */
856 VDEV_AUX_SPARED
, /* hot spare used in another pool */
857 VDEV_AUX_ERR_EXCEEDED
, /* too many errors */
858 VDEV_AUX_IO_FAILURE
, /* experienced I/O failure */
859 VDEV_AUX_BAD_LOG
, /* cannot read log chain(s) */
860 VDEV_AUX_EXTERNAL
, /* external diagnosis or forced fault */
861 VDEV_AUX_SPLIT_POOL
, /* vdev was split off into another pool */
862 VDEV_AUX_BAD_ASHIFT
, /* vdev ashift is invalid */
863 VDEV_AUX_EXTERNAL_PERSIST
, /* persistent forced fault */
864 VDEV_AUX_ACTIVE
, /* vdev active on a different host */
865 VDEV_AUX_CHILDREN_OFFLINE
, /* all children are offline */
869 * pool state. The following states are written to disk as part of the normal
870 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
871 * states are software abstractions used at various levels to communicate
874 typedef enum pool_state
{
875 POOL_STATE_ACTIVE
= 0, /* In active use */
876 POOL_STATE_EXPORTED
, /* Explicitly exported */
877 POOL_STATE_DESTROYED
, /* Explicitly destroyed */
878 POOL_STATE_SPARE
, /* Reserved for hot spare use */
879 POOL_STATE_L2CACHE
, /* Level 2 ARC device */
880 POOL_STATE_UNINITIALIZED
, /* Internal spa_t state */
881 POOL_STATE_UNAVAIL
, /* Internal libzfs state */
882 POOL_STATE_POTENTIALLY_ACTIVE
/* Internal libzfs state */
886 * mmp state. The following states provide additional detail describing
887 * why a pool couldn't be safely imported.
889 typedef enum mmp_state
{
890 MMP_STATE_ACTIVE
= 0, /* In active use */
891 MMP_STATE_INACTIVE
, /* Inactive and safe to import */
892 MMP_STATE_NO_HOSTID
/* System hostid is not set */
898 typedef enum pool_scan_func
{
906 * Used to control scrub pause and resume.
908 typedef enum pool_scrub_cmd
{
909 POOL_SCRUB_NORMAL
= 0,
916 CS_CHECKPOINT_EXISTS
,
917 CS_CHECKPOINT_DISCARDING
,
919 } checkpoint_state_t
;
921 typedef struct pool_checkpoint_stat
{
922 uint64_t pcs_state
; /* checkpoint_state_t */
923 uint64_t pcs_start_time
; /* time checkpoint/discard started */
924 uint64_t pcs_space
; /* checkpointed space */
925 } pool_checkpoint_stat_t
;
928 * ZIO types. Needed to interpret vdev statistics below.
930 typedef enum zio_type
{
942 * Pool statistics. Note: all fields should be 64-bit because this
943 * is passed between kernel and userland as an nvlist uint64 array.
945 typedef struct pool_scan_stat
{
946 /* values stored on disk */
947 uint64_t pss_func
; /* pool_scan_func_t */
948 uint64_t pss_state
; /* dsl_scan_state_t */
949 uint64_t pss_start_time
; /* scan start time */
950 uint64_t pss_end_time
; /* scan end time */
951 uint64_t pss_to_examine
; /* total bytes to scan */
952 uint64_t pss_examined
; /* total bytes located by scanner */
953 uint64_t pss_to_process
; /* total bytes to process */
954 uint64_t pss_processed
; /* total processed bytes */
955 uint64_t pss_errors
; /* scan errors */
957 /* values not stored on disk */
958 uint64_t pss_pass_exam
; /* examined bytes per scan pass */
959 uint64_t pss_pass_start
; /* start time of a scan pass */
960 uint64_t pss_pass_scrub_pause
; /* pause time of a scrub pass */
961 /* cumulative time scrub spent paused, needed for rate calculation */
962 uint64_t pss_pass_scrub_spent_paused
;
963 uint64_t pss_pass_issued
; /* issued bytes per scan pass */
964 uint64_t pss_issued
; /* total bytes checked by scanner */
967 typedef struct pool_removal_stat
{
968 uint64_t prs_state
; /* dsl_scan_state_t */
969 uint64_t prs_removing_vdev
;
970 uint64_t prs_start_time
;
971 uint64_t prs_end_time
;
972 uint64_t prs_to_copy
; /* bytes that need to be copied */
973 uint64_t prs_copied
; /* bytes copied so far */
975 * bytes of memory used for indirect mappings.
976 * This includes all removed vdevs.
978 uint64_t prs_mapping_memory
;
979 } pool_removal_stat_t
;
981 typedef enum dsl_scan_state
{
990 * Errata described by https://zfsonlinux.org/msg/ZFS-8000-ER. The ordering
991 * of this enum must be maintained to ensure the errata identifiers map to
992 * the correct documentation. New errata may only be appended to the list
993 * and must contain corresponding documentation at the above link.
995 typedef enum zpool_errata
{
997 ZPOOL_ERRATA_ZOL_2094_SCRUB
,
998 ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY
,
999 ZPOOL_ERRATA_ZOL_6845_ENCRYPTION
,
1000 ZPOOL_ERRATA_ZOL_8308_ENCRYPTION
,
1004 * Vdev statistics. Note: all fields should be 64-bit because this
1005 * is passed between kernel and user land as an nvlist uint64 array.
1007 * The vs_ops[] and vs_bytes[] arrays must always be an array size of 6 in
1008 * order to keep subsequent members at their known fixed offsets. When
1009 * adding a new field it must be added to the end the structure.
1011 #define VS_ZIO_TYPES 6
1013 typedef struct vdev_stat
{
1014 hrtime_t vs_timestamp
; /* time since vdev load */
1015 uint64_t vs_state
; /* vdev state */
1016 uint64_t vs_aux
; /* see vdev_aux_t */
1017 uint64_t vs_alloc
; /* space allocated */
1018 uint64_t vs_space
; /* total capacity */
1019 uint64_t vs_dspace
; /* deflated capacity */
1020 uint64_t vs_rsize
; /* replaceable dev size */
1021 uint64_t vs_esize
; /* expandable dev size */
1022 uint64_t vs_ops
[VS_ZIO_TYPES
]; /* operation count */
1023 uint64_t vs_bytes
[VS_ZIO_TYPES
]; /* bytes read/written */
1024 uint64_t vs_read_errors
; /* read errors */
1025 uint64_t vs_write_errors
; /* write errors */
1026 uint64_t vs_checksum_errors
; /* checksum errors */
1027 uint64_t vs_initialize_errors
; /* initializing errors */
1028 uint64_t vs_self_healed
; /* self-healed bytes */
1029 uint64_t vs_scan_removing
; /* removing? */
1030 uint64_t vs_scan_processed
; /* scan processed bytes */
1031 uint64_t vs_fragmentation
; /* device fragmentation */
1032 uint64_t vs_initialize_bytes_done
; /* bytes initialized */
1033 uint64_t vs_initialize_bytes_est
; /* total bytes to initialize */
1034 uint64_t vs_initialize_state
; /* vdev_initializing_state_t */
1035 uint64_t vs_initialize_action_time
; /* time_t */
1036 uint64_t vs_checkpoint_space
; /* checkpoint-consumed space */
1037 uint64_t vs_resilver_deferred
; /* resilver deferred */
1038 uint64_t vs_slow_ios
; /* slow IOs */
1039 uint64_t vs_trim_errors
; /* trimming errors */
1040 uint64_t vs_trim_notsup
; /* supported by device */
1041 uint64_t vs_trim_bytes_done
; /* bytes trimmed */
1042 uint64_t vs_trim_bytes_est
; /* total bytes to trim */
1043 uint64_t vs_trim_state
; /* vdev_trim_state_t */
1044 uint64_t vs_trim_action_time
; /* time_t */
1050 * These are stats which aren't included in the original iostat output. For
1051 * convenience, they are grouped together in vdev_stat_ex, although each stat
1052 * is individually exported as an nvlist.
1054 typedef struct vdev_stat_ex
{
1055 /* Number of ZIOs issued to disk and waiting to finish */
1056 uint64_t vsx_active_queue
[ZIO_PRIORITY_NUM_QUEUEABLE
];
1058 /* Number of ZIOs pending to be issued to disk */
1059 uint64_t vsx_pend_queue
[ZIO_PRIORITY_NUM_QUEUEABLE
];
1062 * Below are the histograms for various latencies. Buckets are in
1063 * units of nanoseconds.
1067 * 2^37 nanoseconds = 134s. Timeouts will probably start kicking in
1070 #define VDEV_L_HISTO_BUCKETS 37 /* Latency histo buckets */
1071 #define VDEV_RQ_HISTO_BUCKETS 25 /* Request size histo buckets */
1073 /* Amount of time in ZIO queue (ns) */
1074 uint64_t vsx_queue_histo
[ZIO_PRIORITY_NUM_QUEUEABLE
]
1075 [VDEV_L_HISTO_BUCKETS
];
1077 /* Total ZIO latency (ns). Includes queuing and disk access time */
1078 uint64_t vsx_total_histo
[ZIO_TYPES
][VDEV_L_HISTO_BUCKETS
];
1080 /* Amount of time to read/write the disk (ns) */
1081 uint64_t vsx_disk_histo
[ZIO_TYPES
][VDEV_L_HISTO_BUCKETS
];
1083 /* "lookup the bucket for a value" histogram macros */
1084 #define HISTO(val, buckets) (val != 0 ? MIN(highbit64(val) - 1, \
1086 #define L_HISTO(a) HISTO(a, VDEV_L_HISTO_BUCKETS)
1087 #define RQ_HISTO(a) HISTO(a, VDEV_RQ_HISTO_BUCKETS)
1089 /* Physical IO histogram */
1090 uint64_t vsx_ind_histo
[ZIO_PRIORITY_NUM_QUEUEABLE
]
1091 [VDEV_RQ_HISTO_BUCKETS
];
1093 /* Delegated (aggregated) physical IO histogram */
1094 uint64_t vsx_agg_histo
[ZIO_PRIORITY_NUM_QUEUEABLE
]
1095 [VDEV_RQ_HISTO_BUCKETS
];
1100 * Initialize functions.
1102 typedef enum pool_initialize_func
{
1103 POOL_INITIALIZE_START
,
1104 POOL_INITIALIZE_CANCEL
,
1105 POOL_INITIALIZE_SUSPEND
,
1106 POOL_INITIALIZE_FUNCS
1107 } pool_initialize_func_t
;
1112 typedef enum pool_trim_func
{
1120 * DDT statistics. Note: all fields should be 64-bit because this
1121 * is passed between kernel and userland as an nvlist uint64 array.
1123 typedef struct ddt_object
{
1124 uint64_t ddo_count
; /* number of elements in ddt */
1125 uint64_t ddo_dspace
; /* size of ddt on disk */
1126 uint64_t ddo_mspace
; /* size of ddt in-core */
1129 typedef struct ddt_stat
{
1130 uint64_t dds_blocks
; /* blocks */
1131 uint64_t dds_lsize
; /* logical size */
1132 uint64_t dds_psize
; /* physical size */
1133 uint64_t dds_dsize
; /* deflated allocated size */
1134 uint64_t dds_ref_blocks
; /* referenced blocks */
1135 uint64_t dds_ref_lsize
; /* referenced lsize * refcnt */
1136 uint64_t dds_ref_psize
; /* referenced psize * refcnt */
1137 uint64_t dds_ref_dsize
; /* referenced dsize * refcnt */
1140 typedef struct ddt_histogram
{
1141 ddt_stat_t ddh_stat
[64]; /* power-of-two histogram buckets */
1144 #define ZVOL_DRIVER "zvol"
1145 #define ZFS_DRIVER "zfs"
1146 #define ZFS_DEV "/dev/zfs"
1147 #define ZFS_SHARETAB "/etc/dfs/sharetab"
1149 #define ZFS_SUPER_MAGIC 0x2fc12fc1
1151 /* general zvol path */
1152 #define ZVOL_DIR "/dev"
1154 #define ZVOL_MAJOR 230
1155 #define ZVOL_MINOR_BITS 4
1156 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
1157 #define ZVOL_MINORS (1 << 4)
1158 #define ZVOL_DEV_NAME "zd"
1160 #define ZVOL_PROP_NAME "name"
1161 #define ZVOL_DEFAULT_BLOCKSIZE 8192
1164 VDEV_INITIALIZE_NONE
,
1165 VDEV_INITIALIZE_ACTIVE
,
1166 VDEV_INITIALIZE_CANCELED
,
1167 VDEV_INITIALIZE_SUSPENDED
,
1168 VDEV_INITIALIZE_COMPLETE
1169 } vdev_initializing_state_t
;
1175 VDEV_TRIM_SUSPENDED
,
1177 } vdev_trim_state_t
;
1180 * nvlist name constants. Facilitate restricting snapshot iteration range for
1181 * the "list next snapshot" ioctl
1183 #define SNAP_ITER_MIN_TXG "snap_iter_min_txg"
1184 #define SNAP_ITER_MAX_TXG "snap_iter_max_txg"
1187 * /dev/zfs ioctl numbers.
1189 * These numbers cannot change over time. New ioctl numbers must be appended.
1191 typedef enum zfs_ioc
{
1193 * Core features - 81/128 numbers reserved.
1198 ZFS_IOC_FIRST
= ('Z' << 8),
1200 ZFS_IOC
= ZFS_IOC_FIRST
,
1201 ZFS_IOC_POOL_CREATE
= ZFS_IOC_FIRST
, /* 0x5a00 */
1202 ZFS_IOC_POOL_DESTROY
, /* 0x5a01 */
1203 ZFS_IOC_POOL_IMPORT
, /* 0x5a02 */
1204 ZFS_IOC_POOL_EXPORT
, /* 0x5a03 */
1205 ZFS_IOC_POOL_CONFIGS
, /* 0x5a04 */
1206 ZFS_IOC_POOL_STATS
, /* 0x5a05 */
1207 ZFS_IOC_POOL_TRYIMPORT
, /* 0x5a06 */
1208 ZFS_IOC_POOL_SCAN
, /* 0x5a07 */
1209 ZFS_IOC_POOL_FREEZE
, /* 0x5a08 */
1210 ZFS_IOC_POOL_UPGRADE
, /* 0x5a09 */
1211 ZFS_IOC_POOL_GET_HISTORY
, /* 0x5a0a */
1212 ZFS_IOC_VDEV_ADD
, /* 0x5a0b */
1213 ZFS_IOC_VDEV_REMOVE
, /* 0x5a0c */
1214 ZFS_IOC_VDEV_SET_STATE
, /* 0x5a0d */
1215 ZFS_IOC_VDEV_ATTACH
, /* 0x5a0e */
1216 ZFS_IOC_VDEV_DETACH
, /* 0x5a0f */
1217 ZFS_IOC_VDEV_SETPATH
, /* 0x5a10 */
1218 ZFS_IOC_VDEV_SETFRU
, /* 0x5a11 */
1219 ZFS_IOC_OBJSET_STATS
, /* 0x5a12 */
1220 ZFS_IOC_OBJSET_ZPLPROPS
, /* 0x5a13 */
1221 ZFS_IOC_DATASET_LIST_NEXT
, /* 0x5a14 */
1222 ZFS_IOC_SNAPSHOT_LIST_NEXT
, /* 0x5a15 */
1223 ZFS_IOC_SET_PROP
, /* 0x5a16 */
1224 ZFS_IOC_CREATE
, /* 0x5a17 */
1225 ZFS_IOC_DESTROY
, /* 0x5a18 */
1226 ZFS_IOC_ROLLBACK
, /* 0x5a19 */
1227 ZFS_IOC_RENAME
, /* 0x5a1a */
1228 ZFS_IOC_RECV
, /* 0x5a1b */
1229 ZFS_IOC_SEND
, /* 0x5a1c */
1230 ZFS_IOC_INJECT_FAULT
, /* 0x5a1d */
1231 ZFS_IOC_CLEAR_FAULT
, /* 0x5a1e */
1232 ZFS_IOC_INJECT_LIST_NEXT
, /* 0x5a1f */
1233 ZFS_IOC_ERROR_LOG
, /* 0x5a20 */
1234 ZFS_IOC_CLEAR
, /* 0x5a21 */
1235 ZFS_IOC_PROMOTE
, /* 0x5a22 */
1236 ZFS_IOC_SNAPSHOT
, /* 0x5a23 */
1237 ZFS_IOC_DSOBJ_TO_DSNAME
, /* 0x5a24 */
1238 ZFS_IOC_OBJ_TO_PATH
, /* 0x5a25 */
1239 ZFS_IOC_POOL_SET_PROPS
, /* 0x5a26 */
1240 ZFS_IOC_POOL_GET_PROPS
, /* 0x5a27 */
1241 ZFS_IOC_SET_FSACL
, /* 0x5a28 */
1242 ZFS_IOC_GET_FSACL
, /* 0x5a29 */
1243 ZFS_IOC_SHARE
, /* 0x5a2a */
1244 ZFS_IOC_INHERIT_PROP
, /* 0x5a2b */
1245 ZFS_IOC_SMB_ACL
, /* 0x5a2c */
1246 ZFS_IOC_USERSPACE_ONE
, /* 0x5a2d */
1247 ZFS_IOC_USERSPACE_MANY
, /* 0x5a2e */
1248 ZFS_IOC_USERSPACE_UPGRADE
, /* 0x5a2f */
1249 ZFS_IOC_HOLD
, /* 0x5a30 */
1250 ZFS_IOC_RELEASE
, /* 0x5a31 */
1251 ZFS_IOC_GET_HOLDS
, /* 0x5a32 */
1252 ZFS_IOC_OBJSET_RECVD_PROPS
, /* 0x5a33 */
1253 ZFS_IOC_VDEV_SPLIT
, /* 0x5a34 */
1254 ZFS_IOC_NEXT_OBJ
, /* 0x5a35 */
1255 ZFS_IOC_DIFF
, /* 0x5a36 */
1256 ZFS_IOC_TMP_SNAPSHOT
, /* 0x5a37 */
1257 ZFS_IOC_OBJ_TO_STATS
, /* 0x5a38 */
1258 ZFS_IOC_SPACE_WRITTEN
, /* 0x5a39 */
1259 ZFS_IOC_SPACE_SNAPS
, /* 0x5a3a */
1260 ZFS_IOC_DESTROY_SNAPS
, /* 0x5a3b */
1261 ZFS_IOC_POOL_REGUID
, /* 0x5a3c */
1262 ZFS_IOC_POOL_REOPEN
, /* 0x5a3d */
1263 ZFS_IOC_SEND_PROGRESS
, /* 0x5a3e */
1264 ZFS_IOC_LOG_HISTORY
, /* 0x5a3f */
1265 ZFS_IOC_SEND_NEW
, /* 0x5a40 */
1266 ZFS_IOC_SEND_SPACE
, /* 0x5a41 */
1267 ZFS_IOC_CLONE
, /* 0x5a42 */
1268 ZFS_IOC_BOOKMARK
, /* 0x5a43 */
1269 ZFS_IOC_GET_BOOKMARKS
, /* 0x5a44 */
1270 ZFS_IOC_DESTROY_BOOKMARKS
, /* 0x5a45 */
1271 ZFS_IOC_RECV_NEW
, /* 0x5a46 */
1272 ZFS_IOC_POOL_SYNC
, /* 0x5a47 */
1273 ZFS_IOC_CHANNEL_PROGRAM
, /* 0x5a48 */
1274 ZFS_IOC_LOAD_KEY
, /* 0x5a49 */
1275 ZFS_IOC_UNLOAD_KEY
, /* 0x5a4a */
1276 ZFS_IOC_CHANGE_KEY
, /* 0x5a4b */
1277 ZFS_IOC_REMAP
, /* 0x5a4c */
1278 ZFS_IOC_POOL_CHECKPOINT
, /* 0x5a4d */
1279 ZFS_IOC_POOL_DISCARD_CHECKPOINT
, /* 0x5a4e */
1280 ZFS_IOC_POOL_INITIALIZE
, /* 0x5a4f */
1281 ZFS_IOC_POOL_TRIM
, /* 0x5a50 */
1282 ZFS_IOC_REDACT
, /* 0x5a51 */
1283 ZFS_IOC_GET_BOOKMARK_PROPS
, /* 0x5a52 */
1284 ZFS_IOC_WAIT
, /* 0x5a53 */
1287 * Per-platform (Optional) - 6/128 numbers reserved.
1289 ZFS_IOC_PLATFORM
= ZFS_IOC_FIRST
+ 0x80,
1290 ZFS_IOC_EVENTS_NEXT
, /* 0x81 (Linux) */
1291 ZFS_IOC_EVENTS_CLEAR
, /* 0x82 (Linux) */
1292 ZFS_IOC_EVENTS_SEEK
, /* 0x83 (Linux) */
1293 ZFS_IOC_NEXTBOOT
, /* 0x84 (FreeBSD) */
1294 ZFS_IOC_JAIL
, /* 0x85 (FreeBSD) */
1295 ZFS_IOC_UNJAIL
, /* 0x86 (FreeBSD) */
1300 * zvol ioctl to get dataset name
1302 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAX_DATASET_NAME_LEN])
1305 * ZFS-specific error codes used for returning descriptive errors
1306 * to the userland through zfs ioctls.
1308 * The enum implicitly includes all the error codes from errno.h.
1309 * New code should use and extend this enum for errors that are
1310 * not described precisely by generic errno codes.
1312 * These numbers should not change over time. New entries should be appended.
1314 * (Keep in sync with contrib/pyzfs/libzfs_core/_constants.py)
1317 ZFS_ERR_CHECKPOINT_EXISTS
= 1024,
1318 ZFS_ERR_DISCARDING_CHECKPOINT
,
1319 ZFS_ERR_NO_CHECKPOINT
,
1320 ZFS_ERR_DEVRM_IN_PROGRESS
,
1321 ZFS_ERR_VDEV_TOO_BIG
,
1322 ZFS_ERR_IOC_CMD_UNAVAIL
,
1323 ZFS_ERR_IOC_ARG_UNAVAIL
,
1324 ZFS_ERR_IOC_ARG_REQUIRED
,
1325 ZFS_ERR_IOC_ARG_BADTYPE
,
1326 ZFS_ERR_WRONG_PARENT
,
1327 ZFS_ERR_FROM_IVSET_GUID_MISSING
,
1328 ZFS_ERR_FROM_IVSET_GUID_MISMATCH
,
1329 ZFS_ERR_SPILL_BLOCK_FLAG_MISSING
,
1330 ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE
,
1331 ZFS_ERR_EXPORT_IN_PROGRESS
,
1332 ZFS_ERR_BOOKMARK_SOURCE_NOT_ANCESTOR
,
1336 * Internal SPA load state. Used by FMA diagnosis engine.
1339 SPA_LOAD_NONE
, /* no load in progress */
1340 SPA_LOAD_OPEN
, /* normal open */
1341 SPA_LOAD_IMPORT
, /* import in progress */
1342 SPA_LOAD_TRYIMPORT
, /* tryimport in progress */
1343 SPA_LOAD_RECOVER
, /* recovery requested */
1344 SPA_LOAD_ERROR
, /* load failed */
1345 SPA_LOAD_CREATE
/* creation in progress */
1349 ZPOOL_WAIT_CKPT_DISCARD
,
1351 ZPOOL_WAIT_INITIALIZE
,
1354 ZPOOL_WAIT_RESILVER
,
1357 ZPOOL_WAIT_NUM_ACTIVITIES
1358 } zpool_wait_activity_t
;
1361 * Bookmark name values.
1363 #define ZPOOL_ERR_LIST "error list"
1364 #define ZPOOL_ERR_DATASET "dataset"
1365 #define ZPOOL_ERR_OBJECT "object"
1367 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
1370 * The following are names used in the nvlist describing
1371 * the pool's history log.
1373 #define ZPOOL_HIST_RECORD "history record"
1374 #define ZPOOL_HIST_TIME "history time"
1375 #define ZPOOL_HIST_CMD "history command"
1376 #define ZPOOL_HIST_WHO "history who"
1377 #define ZPOOL_HIST_ZONE "history zone"
1378 #define ZPOOL_HIST_HOST "history hostname"
1379 #define ZPOOL_HIST_TXG "history txg"
1380 #define ZPOOL_HIST_INT_EVENT "history internal event"
1381 #define ZPOOL_HIST_INT_STR "history internal str"
1382 #define ZPOOL_HIST_INT_NAME "internal_name"
1383 #define ZPOOL_HIST_IOCTL "ioctl"
1384 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
1385 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
1386 #define ZPOOL_HIST_DSNAME "dsname"
1387 #define ZPOOL_HIST_DSID "dsid"
1388 #define ZPOOL_HIST_ERRNO "errno"
1391 * Special nvlist name that will not have its args recorded in the pool's
1394 #define ZPOOL_HIDDEN_ARGS "hidden_args"
1397 * The following are names used when invoking ZFS_IOC_POOL_INITIALIZE.
1399 #define ZPOOL_INITIALIZE_COMMAND "initialize_command"
1400 #define ZPOOL_INITIALIZE_VDEVS "initialize_vdevs"
1403 * The following are names used when invoking ZFS_IOC_POOL_TRIM.
1405 #define ZPOOL_TRIM_COMMAND "trim_command"
1406 #define ZPOOL_TRIM_VDEVS "trim_vdevs"
1407 #define ZPOOL_TRIM_RATE "trim_rate"
1408 #define ZPOOL_TRIM_SECURE "trim_secure"
1411 * The following are names used when invoking ZFS_IOC_POOL_WAIT.
1413 #define ZPOOL_WAIT_ACTIVITY "wait_activity"
1414 #define ZPOOL_WAIT_TAG "wait_tag"
1415 #define ZPOOL_WAIT_WAITED "wait_waited"
1418 * Flags for ZFS_IOC_VDEV_SET_STATE
1420 #define ZFS_ONLINE_CHECKREMOVE 0x1
1421 #define ZFS_ONLINE_UNSPARE 0x2
1422 #define ZFS_ONLINE_FORCEFAULT 0x4
1423 #define ZFS_ONLINE_EXPAND 0x8
1424 #define ZFS_OFFLINE_TEMPORARY 0x1
1427 * Flags for ZFS_IOC_POOL_IMPORT
1429 #define ZFS_IMPORT_NORMAL 0x0
1430 #define ZFS_IMPORT_VERBATIM 0x1
1431 #define ZFS_IMPORT_ANY_HOST 0x2
1432 #define ZFS_IMPORT_MISSING_LOG 0x4
1433 #define ZFS_IMPORT_ONLY 0x8
1434 #define ZFS_IMPORT_TEMP_NAME 0x10
1435 #define ZFS_IMPORT_SKIP_MMP 0x20
1436 #define ZFS_IMPORT_LOAD_KEYS 0x40
1437 #define ZFS_IMPORT_CHECKPOINT 0x80
1440 * Channel program argument/return nvlist keys and defaults.
1442 #define ZCP_ARG_PROGRAM "program"
1443 #define ZCP_ARG_ARGLIST "arg"
1444 #define ZCP_ARG_SYNC "sync"
1445 #define ZCP_ARG_INSTRLIMIT "instrlimit"
1446 #define ZCP_ARG_MEMLIMIT "memlimit"
1448 #define ZCP_ARG_CLIARGV "argv"
1450 #define ZCP_RET_ERROR "error"
1451 #define ZCP_RET_RETURN "return"
1453 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000)
1454 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT)
1455 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024)
1456 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT)
1459 * Sysevent payload members. ZFS will generate the following sysevents with the
1462 * ESC_ZFS_RESILVER_START
1463 * ESC_ZFS_RESILVER_END
1464 * ESC_ZFS_POOL_DESTROY
1465 * ESC_ZFS_POOL_REGUID
1467 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1468 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1470 * ESC_ZFS_VDEV_REMOVE
1471 * ESC_ZFS_VDEV_CLEAR
1472 * ESC_ZFS_VDEV_CHECK
1474 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1475 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1476 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
1477 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
1479 * ESC_ZFS_HISTORY_EVENT
1481 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1482 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1483 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional)
1484 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional)
1485 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional)
1486 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional)
1487 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional)
1488 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional)
1489 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional)
1490 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional)
1491 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional)
1492 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional)
1493 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional)
1494 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional)
1496 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1497 * history log nvlist. The keynames will be free of any spaces or other
1498 * characters that could be potentially unexpected to consumers of the
1501 #define ZFS_EV_POOL_NAME "pool_name"
1502 #define ZFS_EV_POOL_GUID "pool_guid"
1503 #define ZFS_EV_VDEV_PATH "vdev_path"
1504 #define ZFS_EV_VDEV_GUID "vdev_guid"
1505 #define ZFS_EV_HIST_TIME "history_time"
1506 #define ZFS_EV_HIST_CMD "history_command"
1507 #define ZFS_EV_HIST_WHO "history_who"
1508 #define ZFS_EV_HIST_ZONE "history_zone"
1509 #define ZFS_EV_HIST_HOST "history_hostname"
1510 #define ZFS_EV_HIST_TXG "history_txg"
1511 #define ZFS_EV_HIST_INT_EVENT "history_internal_event"
1512 #define ZFS_EV_HIST_INT_STR "history_internal_str"
1513 #define ZFS_EV_HIST_INT_NAME "history_internal_name"
1514 #define ZFS_EV_HIST_IOCTL "history_ioctl"
1515 #define ZFS_EV_HIST_DSNAME "history_dsname"
1516 #define ZFS_EV_HIST_DSID "history_dsid"
1522 #endif /* _SYS_FS_ZFS_H */