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, 2016 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2014 Integros [integros.com]
27 * Copyright 2017 Joyent, Inc.
28 * Copyright (c) 2017 Datto Inc.
31 /* Portions Copyright 2010 Robert Milkowski */
43 * Types and constants shared between userland and the kernel.
47 * Each dataset can be one of the following types. These constants can be
48 * combined into masks that can be passed to various functions.
51 ZFS_TYPE_FILESYSTEM
= (1 << 0),
52 ZFS_TYPE_SNAPSHOT
= (1 << 1),
53 ZFS_TYPE_VOLUME
= (1 << 2),
54 ZFS_TYPE_POOL
= (1 << 3),
55 ZFS_TYPE_BOOKMARK
= (1 << 4)
59 * NB: lzc_dataset_type should be updated whenever a new objset type is added,
60 * if it represents a real type of a dataset that can be created from userland.
62 typedef enum dmu_objset_type
{
67 DMU_OST_OTHER
, /* For testing only! */
68 DMU_OST_ANY
, /* Be careful! */
72 #define ZFS_TYPE_DATASET \
73 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
76 * All of these include the terminating NUL byte.
78 #define ZAP_MAXNAMELEN 256
79 #define ZAP_MAXVALUELEN (1024 * 8)
80 #define ZAP_OLDMAXVALUELEN 1024
81 #define ZFS_MAX_DATASET_NAME_LEN 256
84 * Dataset properties are identified by these constants and must be added to
85 * the end of this list to ensure that external consumers are not affected
86 * by the change. If you make any changes to this list, be sure to update
87 * the property table in usr/src/common/zfs/zfs_prop.c.
96 ZFS_PROP_COMPRESSRATIO
,
100 ZFS_PROP_RESERVATION
,
102 ZFS_PROP_VOLBLOCKSIZE
,
107 ZFS_PROP_COMPRESSION
,
117 ZFS_PROP_CREATETXG
, /* not exposed to the user */
118 ZFS_PROP_NAME
, /* not exposed to the user */
120 ZFS_PROP_ISCSIOPTIONS
, /* not exposed to the user */
122 ZFS_PROP_NUMCLONES
, /* not exposed to the user */
132 ZFS_PROP_REFRESERVATION
,
134 ZFS_PROP_PRIMARYCACHE
,
135 ZFS_PROP_SECONDARYCACHE
,
139 ZFS_PROP_USEDREFRESERV
,
140 ZFS_PROP_USERACCOUNTING
, /* not exposed to the user */
141 ZFS_PROP_STMF_SHAREINFO
, /* not exposed to the user */
142 ZFS_PROP_DEFER_DESTROY
,
145 ZFS_PROP_UNIQUE
, /* not exposed to the user */
146 ZFS_PROP_OBJSETID
, /* not exposed to the user */
152 ZFS_PROP_LOGICALUSED
,
153 ZFS_PROP_LOGICALREFERENCED
,
154 ZFS_PROP_INCONSISTENT
, /* not exposed to the user */
155 ZFS_PROP_FILESYSTEM_LIMIT
,
156 ZFS_PROP_SNAPSHOT_LIMIT
,
157 ZFS_PROP_FILESYSTEM_COUNT
,
158 ZFS_PROP_SNAPSHOT_COUNT
,
159 ZFS_PROP_REDUNDANT_METADATA
,
161 ZFS_PROP_RECEIVE_RESUME_TOKEN
,
170 ZFS_NUM_USERQUOTA_PROPS
171 } zfs_userquota_prop_t
;
173 extern const char *zfs_userquota_prop_prefixes
[ZFS_NUM_USERQUOTA_PROPS
];
176 * Pool properties are identified by these constants and must be added to the
177 * end of this list to ensure that external consumers are not affected
178 * by the change. If you make any changes to this list, be sure to update
179 * the property table in usr/src/common/zfs/zpool_prop.c.
190 ZPOOL_PROP_DELEGATION
,
191 ZPOOL_PROP_AUTOREPLACE
,
192 ZPOOL_PROP_CACHEFILE
,
193 ZPOOL_PROP_FAILUREMODE
,
194 ZPOOL_PROP_LISTSNAPS
,
195 ZPOOL_PROP_AUTOEXPAND
,
196 ZPOOL_PROP_DEDUPDITTO
,
197 ZPOOL_PROP_DEDUPRATIO
,
199 ZPOOL_PROP_ALLOCATED
,
204 ZPOOL_PROP_FRAGMENTATION
,
206 ZPOOL_PROP_MAXBLOCKSIZE
,
211 /* Small enough to not hog a whole line of printout in zpool(8). */
212 #define ZPROP_MAX_COMMENT 32
214 #define ZPROP_CONT -2
215 #define ZPROP_INVAL -1
217 #define ZPROP_VALUE "value"
218 #define ZPROP_SOURCE "source"
221 ZPROP_SRC_NONE
= 0x1,
222 ZPROP_SRC_DEFAULT
= 0x2,
223 ZPROP_SRC_TEMPORARY
= 0x4,
224 ZPROP_SRC_LOCAL
= 0x8,
225 ZPROP_SRC_INHERITED
= 0x10,
226 ZPROP_SRC_RECEIVED
= 0x20
229 #define ZPROP_SRC_ALL 0x3f
231 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
232 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
234 * Dataset flag implemented as a special entry in the props zap object
235 * indicating that the dataset has received properties on or after
236 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
237 * just as it did in earlier versions, and thereafter, local properties are
240 #define ZPROP_HAS_RECVD "$hasrecvd"
243 ZPROP_ERR_NOCLEAR
= 0x1, /* failure to clear existing props */
244 ZPROP_ERR_NORESTORE
= 0x2 /* failure to restore props on error */
247 typedef int (*zprop_func
)(int, void *);
250 * Properties to be set on the root file system of a new pool
251 * are stuffed into their own nvlist, which is then included in
252 * the properties nvlist with the pool properties.
254 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
257 * Length of 'written@' and 'written#'
259 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8
262 * Dataset property functions shared between libzfs and kernel.
264 const char *zfs_prop_default_string(zfs_prop_t
);
265 uint64_t zfs_prop_default_numeric(zfs_prop_t
);
266 boolean_t
zfs_prop_readonly(zfs_prop_t
);
267 boolean_t
zfs_prop_visible(zfs_prop_t prop
);
268 boolean_t
zfs_prop_inheritable(zfs_prop_t
);
269 boolean_t
zfs_prop_setonce(zfs_prop_t
);
270 const char *zfs_prop_to_name(zfs_prop_t
);
271 zfs_prop_t
zfs_name_to_prop(const char *);
272 boolean_t
zfs_prop_user(const char *);
273 boolean_t
zfs_prop_userquota(const char *);
274 boolean_t
zfs_prop_written(const char *);
275 int zfs_prop_index_to_string(zfs_prop_t
, uint64_t, const char **);
276 int zfs_prop_string_to_index(zfs_prop_t
, const char *, uint64_t *);
277 uint64_t zfs_prop_random_value(zfs_prop_t
, uint64_t seed
);
278 boolean_t
zfs_prop_valid_for_type(int, zfs_type_t
);
281 * Pool property functions shared between libzfs and kernel.
283 zpool_prop_t
zpool_name_to_prop(const char *);
284 const char *zpool_prop_to_name(zpool_prop_t
);
285 const char *zpool_prop_default_string(zpool_prop_t
);
286 uint64_t zpool_prop_default_numeric(zpool_prop_t
);
287 boolean_t
zpool_prop_readonly(zpool_prop_t
);
288 boolean_t
zpool_prop_feature(const char *);
289 boolean_t
zpool_prop_unsupported(const char *name
);
290 int zpool_prop_index_to_string(zpool_prop_t
, uint64_t, const char **);
291 int zpool_prop_string_to_index(zpool_prop_t
, const char *, uint64_t *);
292 uint64_t zpool_prop_random_value(zpool_prop_t
, uint64_t seed
);
295 * Definitions for the Delegation.
298 ZFS_DELEG_WHO_UNKNOWN
= 0,
299 ZFS_DELEG_USER
= 'u',
300 ZFS_DELEG_USER_SETS
= 'U',
301 ZFS_DELEG_GROUP
= 'g',
302 ZFS_DELEG_GROUP_SETS
= 'G',
303 ZFS_DELEG_EVERYONE
= 'e',
304 ZFS_DELEG_EVERYONE_SETS
= 'E',
305 ZFS_DELEG_CREATE
= 'c',
306 ZFS_DELEG_CREATE_SETS
= 'C',
307 ZFS_DELEG_NAMED_SET
= 's',
308 ZFS_DELEG_NAMED_SET_SETS
= 'S'
309 } zfs_deleg_who_type_t
;
313 ZFS_DELEG_PERM_LOCAL
= 1,
314 ZFS_DELEG_PERM_DESCENDENT
= 2,
315 ZFS_DELEG_PERM_LOCALDESCENDENT
= 3,
316 ZFS_DELEG_PERM_CREATE
= 4
317 } zfs_deleg_inherit_t
;
319 #define ZFS_DELEG_PERM_UID "uid"
320 #define ZFS_DELEG_PERM_GID "gid"
321 #define ZFS_DELEG_PERM_GROUPS "groups"
323 #define ZFS_SMB_ACL_SRC "src"
324 #define ZFS_SMB_ACL_TARGET "target"
327 ZFS_CANMOUNT_OFF
= 0,
329 ZFS_CANMOUNT_NOAUTO
= 2
330 } zfs_canmount_type_t
;
333 ZFS_LOGBIAS_LATENCY
= 0,
334 ZFS_LOGBIAS_THROUGHPUT
= 1
337 typedef enum zfs_share_op
{
344 typedef enum zfs_smb_acl_op
{
351 typedef enum zfs_cache_type
{
353 ZFS_CACHE_METADATA
= 1,
358 ZFS_SYNC_STANDARD
= 0,
360 ZFS_SYNC_DISABLED
= 2
364 ZFS_REDUNDANT_METADATA_ALL
,
365 ZFS_REDUNDANT_METADATA_MOST
366 } zfs_redundant_metadata_type_t
;
369 * On-disk version number.
371 #define SPA_VERSION_1 1ULL
372 #define SPA_VERSION_2 2ULL
373 #define SPA_VERSION_3 3ULL
374 #define SPA_VERSION_4 4ULL
375 #define SPA_VERSION_5 5ULL
376 #define SPA_VERSION_6 6ULL
377 #define SPA_VERSION_7 7ULL
378 #define SPA_VERSION_8 8ULL
379 #define SPA_VERSION_9 9ULL
380 #define SPA_VERSION_10 10ULL
381 #define SPA_VERSION_11 11ULL
382 #define SPA_VERSION_12 12ULL
383 #define SPA_VERSION_13 13ULL
384 #define SPA_VERSION_14 14ULL
385 #define SPA_VERSION_15 15ULL
386 #define SPA_VERSION_16 16ULL
387 #define SPA_VERSION_17 17ULL
388 #define SPA_VERSION_18 18ULL
389 #define SPA_VERSION_19 19ULL
390 #define SPA_VERSION_20 20ULL
391 #define SPA_VERSION_21 21ULL
392 #define SPA_VERSION_22 22ULL
393 #define SPA_VERSION_23 23ULL
394 #define SPA_VERSION_24 24ULL
395 #define SPA_VERSION_25 25ULL
396 #define SPA_VERSION_26 26ULL
397 #define SPA_VERSION_27 27ULL
398 #define SPA_VERSION_28 28ULL
399 #define SPA_VERSION_5000 5000ULL
402 * When bumping up SPA_VERSION, make sure the boot loader ZFS understands
403 * the on-disk format change.
405 #define SPA_VERSION SPA_VERSION_5000
406 #define SPA_VERSION_STRING "5000"
409 * Symbolic names for the changes that caused a SPA_VERSION switch.
410 * Used in the code when checking for presence or absence of a feature.
411 * Feel free to define multiple symbolic names for each version if there
412 * were multiple changes to on-disk structures during that version.
414 * NOTE: When checking the current SPA_VERSION in your code, be sure
415 * to use spa_version() since it reports the version of the
416 * last synced uberblock. Checking the in-flight version can
417 * be dangerous in some cases.
419 #define SPA_VERSION_INITIAL SPA_VERSION_1
420 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
421 #define SPA_VERSION_SPARES SPA_VERSION_3
422 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
423 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
424 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
425 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
426 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
427 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
428 #define SPA_VERSION_BOOTFS SPA_VERSION_6
429 #define SPA_VERSION_SLOGS SPA_VERSION_7
430 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
431 #define SPA_VERSION_FUID SPA_VERSION_9
432 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
433 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
434 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
435 #define SPA_VERSION_L2CACHE SPA_VERSION_10
436 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
437 #define SPA_VERSION_ORIGIN SPA_VERSION_11
438 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
439 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
440 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
441 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
442 #define SPA_VERSION_USERSPACE SPA_VERSION_15
443 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
444 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
445 #define SPA_VERSION_USERREFS SPA_VERSION_18
446 #define SPA_VERSION_HOLES SPA_VERSION_19
447 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
448 #define SPA_VERSION_DEDUP SPA_VERSION_21
449 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
450 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
451 #define SPA_VERSION_SA SPA_VERSION_24
452 #define SPA_VERSION_SCAN SPA_VERSION_25
453 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
454 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
455 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
456 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
457 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
458 #define SPA_VERSION_FEATURES SPA_VERSION_5000
460 #define SPA_VERSION_IS_SUPPORTED(v) \
461 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
462 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
465 * ZPL version - rev'd whenever an incompatible on-disk format change
466 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
467 * also update the version_table[] and help message in zfs_prop.c.
469 * When changing, be sure to teach boot loader ZFS how to read
472 #define ZPL_VERSION_1 1ULL
473 #define ZPL_VERSION_2 2ULL
474 #define ZPL_VERSION_3 3ULL
475 #define ZPL_VERSION_4 4ULL
476 #define ZPL_VERSION_5 5ULL
477 #define ZPL_VERSION ZPL_VERSION_5
478 #define ZPL_VERSION_STRING "5"
480 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
481 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
482 #define ZPL_VERSION_FUID ZPL_VERSION_3
483 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
484 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
485 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
486 #define ZPL_VERSION_SA ZPL_VERSION_5
488 /* Rewind request information */
489 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
490 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
491 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
492 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
493 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
494 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
495 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
497 typedef struct zpool_rewind_policy
{
498 uint32_t zrp_request
; /* rewind behavior requested */
499 uint64_t zrp_maxmeta
; /* max acceptable meta-data errors */
500 uint64_t zrp_maxdata
; /* max acceptable data errors */
501 uint64_t zrp_txg
; /* specific txg to load */
502 } zpool_rewind_policy_t
;
505 * The following are configuration names used in the nvlist describing a pool's
508 #define ZPOOL_CONFIG_VERSION "version"
509 #define ZPOOL_CONFIG_POOL_NAME "name"
510 #define ZPOOL_CONFIG_POOL_STATE "state"
511 #define ZPOOL_CONFIG_POOL_TXG "txg"
512 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
513 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
514 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
515 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
516 #define ZPOOL_CONFIG_TYPE "type"
517 #define ZPOOL_CONFIG_CHILDREN "children"
518 #define ZPOOL_CONFIG_ID "id"
519 #define ZPOOL_CONFIG_GUID "guid"
520 #define ZPOOL_CONFIG_PATH "path"
521 #define ZPOOL_CONFIG_DEVID "devid"
522 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
523 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
524 #define ZPOOL_CONFIG_ASHIFT "ashift"
525 #define ZPOOL_CONFIG_ASIZE "asize"
526 #define ZPOOL_CONFIG_DTL "DTL"
527 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
528 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
529 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
530 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
531 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
532 #define ZPOOL_CONFIG_SPARES "spares"
533 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
534 #define ZPOOL_CONFIG_NPARITY "nparity"
535 #define ZPOOL_CONFIG_HOSTID "hostid"
536 #define ZPOOL_CONFIG_HOSTNAME "hostname"
537 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
538 #define ZPOOL_CONFIG_UNSPARE "unspare"
539 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
540 #define ZPOOL_CONFIG_IS_LOG "is_log"
541 #define ZPOOL_CONFIG_L2CACHE "l2cache"
542 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
543 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
544 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
545 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
546 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
547 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
548 #define ZPOOL_CONFIG_SPLIT "splitcfg"
549 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
550 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
551 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
552 #define ZPOOL_CONFIG_REMOVING "removing"
553 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
554 #define ZPOOL_CONFIG_COMMENT "comment"
555 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
556 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
557 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
558 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
559 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
560 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
561 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
562 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
563 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
564 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
565 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
566 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
567 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
568 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
570 * The persistent vdev state is stored as separate values rather than a single
571 * 'vdev_state' entry. This is because a device can be in multiple states, such
572 * as offline and degraded.
574 #define ZPOOL_CONFIG_OFFLINE "offline"
575 #define ZPOOL_CONFIG_FAULTED "faulted"
576 #define ZPOOL_CONFIG_DEGRADED "degraded"
577 #define ZPOOL_CONFIG_REMOVED "removed"
578 #define ZPOOL_CONFIG_FRU "fru"
579 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
581 /* Rewind policy parameters */
582 #define ZPOOL_REWIND_POLICY "rewind-policy"
583 #define ZPOOL_REWIND_REQUEST "rewind-request"
584 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
585 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
586 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
588 /* Rewind data discovered */
589 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
590 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
591 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
593 #define VDEV_TYPE_ROOT "root"
594 #define VDEV_TYPE_MIRROR "mirror"
595 #define VDEV_TYPE_REPLACING "replacing"
596 #define VDEV_TYPE_RAIDZ "raidz"
597 #define VDEV_TYPE_DISK "disk"
598 #define VDEV_TYPE_FILE "file"
599 #define VDEV_TYPE_MISSING "missing"
600 #define VDEV_TYPE_HOLE "hole"
601 #define VDEV_TYPE_SPARE "spare"
602 #define VDEV_TYPE_LOG "log"
603 #define VDEV_TYPE_L2CACHE "l2cache"
604 #define VDEV_TYPE_INDIRECT "indirect"
607 * This is needed in userland to report the minimum necessary device size.
609 * Note that the zfs test suite uses 64MB vdevs.
611 #define SPA_MINDEVSIZE (64ULL << 20)
614 * Set if the fragmentation has not yet been calculated. This can happen
615 * because the space maps have not been upgraded or the histogram feature
618 #define ZFS_FRAG_INVALID UINT64_MAX
621 * The location of the pool configuration repository, shared between kernel and
624 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
627 * vdev states are ordered from least to most healthy.
628 * A vdev that's CANT_OPEN or below is considered unusable.
630 typedef enum vdev_state
{
631 VDEV_STATE_UNKNOWN
= 0, /* Uninitialized vdev */
632 VDEV_STATE_CLOSED
, /* Not currently open */
633 VDEV_STATE_OFFLINE
, /* Not allowed to open */
634 VDEV_STATE_REMOVED
, /* Explicitly removed from system */
635 VDEV_STATE_CANT_OPEN
, /* Tried to open, but failed */
636 VDEV_STATE_FAULTED
, /* External request to fault device */
637 VDEV_STATE_DEGRADED
, /* Replicated vdev with unhealthy kids */
638 VDEV_STATE_HEALTHY
/* Presumed good */
641 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
644 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
645 * of the vdev stats structure uses these constants to distinguish why.
647 typedef enum vdev_aux
{
648 VDEV_AUX_NONE
, /* no error */
649 VDEV_AUX_OPEN_FAILED
, /* ldi_open_*() or vn_open() failed */
650 VDEV_AUX_CORRUPT_DATA
, /* bad label or disk contents */
651 VDEV_AUX_NO_REPLICAS
, /* insufficient number of replicas */
652 VDEV_AUX_BAD_GUID_SUM
, /* vdev guid sum doesn't match */
653 VDEV_AUX_TOO_SMALL
, /* vdev size is too small */
654 VDEV_AUX_BAD_LABEL
, /* the label is OK but invalid */
655 VDEV_AUX_VERSION_NEWER
, /* on-disk version is too new */
656 VDEV_AUX_VERSION_OLDER
, /* on-disk version is too old */
657 VDEV_AUX_UNSUP_FEAT
, /* unsupported features */
658 VDEV_AUX_SPARED
, /* hot spare used in another pool */
659 VDEV_AUX_ERR_EXCEEDED
, /* too many errors */
660 VDEV_AUX_IO_FAILURE
, /* experienced I/O failure */
661 VDEV_AUX_BAD_LOG
, /* cannot read log chain(s) */
662 VDEV_AUX_EXTERNAL
, /* external diagnosis */
663 VDEV_AUX_SPLIT_POOL
/* vdev was split off into another pool */
667 * pool state. The following states are written to disk as part of the normal
668 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
669 * states are software abstractions used at various levels to communicate
672 typedef enum pool_state
{
673 POOL_STATE_ACTIVE
= 0, /* In active use */
674 POOL_STATE_EXPORTED
, /* Explicitly exported */
675 POOL_STATE_DESTROYED
, /* Explicitly destroyed */
676 POOL_STATE_SPARE
, /* Reserved for hot spare use */
677 POOL_STATE_L2CACHE
, /* Level 2 ARC device */
678 POOL_STATE_UNINITIALIZED
, /* Internal spa_t state */
679 POOL_STATE_UNAVAIL
, /* Internal libzfs state */
680 POOL_STATE_POTENTIALLY_ACTIVE
/* Internal libzfs state */
686 typedef enum pool_scan_func
{
694 * Used to control scrub pause and resume.
696 typedef enum pool_scrub_cmd
{
697 POOL_SCRUB_NORMAL
= 0,
704 * ZIO types. Needed to interpret vdev statistics below.
706 typedef enum zio_type
{
717 * Pool statistics. Note: all fields should be 64-bit because this
718 * is passed between kernel and userland as an nvlist uint64 array.
720 typedef struct pool_scan_stat
{
721 /* values stored on disk */
722 uint64_t pss_func
; /* pool_scan_func_t */
723 uint64_t pss_state
; /* dsl_scan_state_t */
724 uint64_t pss_start_time
; /* scan start time */
725 uint64_t pss_end_time
; /* scan end time */
726 uint64_t pss_to_examine
; /* total bytes to scan */
727 uint64_t pss_examined
; /* total examined bytes */
728 uint64_t pss_to_process
; /* total bytes to process */
729 uint64_t pss_processed
; /* total processed bytes */
730 uint64_t pss_errors
; /* scan errors */
732 /* values not stored on disk */
733 uint64_t pss_pass_exam
; /* examined bytes per scan pass */
734 uint64_t pss_pass_start
; /* start time of a scan pass */
735 uint64_t pss_pass_scrub_pause
; /* pause time of a scurb pass */
736 /* cumulative time scrub spent paused, needed for rate calculation */
737 uint64_t pss_pass_scrub_spent_paused
;
740 typedef enum dsl_scan_state
{
750 * Vdev statistics. Note: all fields should be 64-bit because this
751 * is passed between kernel and userland as an nvlist uint64 array.
753 typedef struct vdev_stat
{
754 hrtime_t vs_timestamp
; /* time since vdev load */
755 uint64_t vs_state
; /* vdev state */
756 uint64_t vs_aux
; /* see vdev_aux_t */
757 uint64_t vs_alloc
; /* space allocated */
758 uint64_t vs_space
; /* total capacity */
759 uint64_t vs_dspace
; /* deflated capacity */
760 uint64_t vs_rsize
; /* replaceable dev size */
761 uint64_t vs_esize
; /* expandable dev size */
762 uint64_t vs_ops
[ZIO_TYPES
]; /* operation count */
763 uint64_t vs_bytes
[ZIO_TYPES
]; /* bytes read/written */
764 uint64_t vs_read_errors
; /* read errors */
765 uint64_t vs_write_errors
; /* write errors */
766 uint64_t vs_checksum_errors
; /* checksum errors */
767 uint64_t vs_self_healed
; /* self-healed bytes */
768 uint64_t vs_scan_removing
; /* removing? */
769 uint64_t vs_scan_processed
; /* scan processed bytes */
770 uint64_t vs_fragmentation
; /* device fragmentation */
774 * DDT statistics. Note: all fields should be 64-bit because this
775 * is passed between kernel and userland as an nvlist uint64 array.
777 typedef struct ddt_object
{
778 uint64_t ddo_count
; /* number of elments in ddt */
779 uint64_t ddo_dspace
; /* size of ddt on disk */
780 uint64_t ddo_mspace
; /* size of ddt in-core */
783 typedef struct ddt_stat
{
784 uint64_t dds_blocks
; /* blocks */
785 uint64_t dds_lsize
; /* logical size */
786 uint64_t dds_psize
; /* physical size */
787 uint64_t dds_dsize
; /* deflated allocated size */
788 uint64_t dds_ref_blocks
; /* referenced blocks */
789 uint64_t dds_ref_lsize
; /* referenced lsize * refcnt */
790 uint64_t dds_ref_psize
; /* referenced psize * refcnt */
791 uint64_t dds_ref_dsize
; /* referenced dsize * refcnt */
794 typedef struct ddt_histogram
{
795 ddt_stat_t ddh_stat
[64]; /* power-of-two histogram buckets */
798 #define ZVOL_DRIVER "zvol"
799 #define ZFS_DRIVER "zfs"
800 #define ZFS_DEV "/dev/zfs"
801 #define ZFS_DISK_ROOT "/dev/dsk"
802 #define ZFS_DISK_ROOTD ZFS_DISK_ROOT "/"
803 #define ZFS_RDISK_ROOT "/dev/rdsk"
804 #define ZFS_RDISK_ROOTD ZFS_RDISK_ROOT "/"
806 /* general zvol path */
807 #define ZVOL_DIR "/dev/zvol"
809 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
810 /* for dump and swap */
811 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
812 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
814 #define ZVOL_PROP_NAME "name"
815 #define ZVOL_DEFAULT_BLOCKSIZE 8192
818 * /dev/zfs ioctl numbers.
820 typedef enum zfs_ioc
{
821 ZFS_IOC_FIRST
= ('Z' << 8),
822 ZFS_IOC
= ZFS_IOC_FIRST
,
823 ZFS_IOC_POOL_CREATE
= ZFS_IOC_FIRST
,
824 ZFS_IOC_POOL_DESTROY
,
827 ZFS_IOC_POOL_CONFIGS
,
829 ZFS_IOC_POOL_TRYIMPORT
,
832 ZFS_IOC_POOL_UPGRADE
,
833 ZFS_IOC_POOL_GET_HISTORY
,
836 ZFS_IOC_VDEV_SET_STATE
,
839 ZFS_IOC_VDEV_SETPATH
,
841 ZFS_IOC_OBJSET_STATS
,
842 ZFS_IOC_OBJSET_ZPLPROPS
,
843 ZFS_IOC_DATASET_LIST_NEXT
,
844 ZFS_IOC_SNAPSHOT_LIST_NEXT
,
852 ZFS_IOC_INJECT_FAULT
,
854 ZFS_IOC_INJECT_LIST_NEXT
,
859 ZFS_IOC_DSOBJ_TO_DSNAME
,
861 ZFS_IOC_POOL_SET_PROPS
,
862 ZFS_IOC_POOL_GET_PROPS
,
866 ZFS_IOC_INHERIT_PROP
,
868 ZFS_IOC_USERSPACE_ONE
,
869 ZFS_IOC_USERSPACE_MANY
,
870 ZFS_IOC_USERSPACE_UPGRADE
,
874 ZFS_IOC_OBJSET_RECVD_PROPS
,
878 ZFS_IOC_TMP_SNAPSHOT
,
879 ZFS_IOC_OBJ_TO_STATS
,
880 ZFS_IOC_SPACE_WRITTEN
,
882 ZFS_IOC_DESTROY_SNAPS
,
885 ZFS_IOC_SEND_PROGRESS
,
891 ZFS_IOC_GET_BOOKMARKS
,
892 ZFS_IOC_DESTROY_BOOKMARKS
,
893 ZFS_IOC_CHANNEL_PROGRAM
,
898 * Internal SPA load state. Used by FMA diagnosis engine.
901 SPA_LOAD_NONE
, /* no load in progress */
902 SPA_LOAD_OPEN
, /* normal open */
903 SPA_LOAD_IMPORT
, /* import in progress */
904 SPA_LOAD_TRYIMPORT
, /* tryimport in progress */
905 SPA_LOAD_RECOVER
, /* recovery requested */
906 SPA_LOAD_ERROR
, /* load failed */
907 SPA_LOAD_CREATE
/* creation in progress */
911 * Bookmark name values.
913 #define ZPOOL_ERR_LIST "error list"
914 #define ZPOOL_ERR_DATASET "dataset"
915 #define ZPOOL_ERR_OBJECT "object"
917 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
920 * The following are names used in the nvlist describing
921 * the pool's history log.
923 #define ZPOOL_HIST_RECORD "history record"
924 #define ZPOOL_HIST_TIME "history time"
925 #define ZPOOL_HIST_CMD "history command"
926 #define ZPOOL_HIST_WHO "history who"
927 #define ZPOOL_HIST_ZONE "history zone"
928 #define ZPOOL_HIST_HOST "history hostname"
929 #define ZPOOL_HIST_TXG "history txg"
930 #define ZPOOL_HIST_INT_EVENT "history internal event"
931 #define ZPOOL_HIST_INT_STR "history internal str"
932 #define ZPOOL_HIST_INT_NAME "internal_name"
933 #define ZPOOL_HIST_IOCTL "ioctl"
934 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
935 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
936 #define ZPOOL_HIST_DSNAME "dsname"
937 #define ZPOOL_HIST_DSID "dsid"
938 #define ZPOOL_HIST_ERRNO "errno"
941 * Flags for ZFS_IOC_VDEV_SET_STATE
943 #define ZFS_ONLINE_CHECKREMOVE 0x1
944 #define ZFS_ONLINE_UNSPARE 0x2
945 #define ZFS_ONLINE_FORCEFAULT 0x4
946 #define ZFS_ONLINE_EXPAND 0x8
947 #define ZFS_OFFLINE_TEMPORARY 0x1
950 * Flags for ZFS_IOC_POOL_IMPORT
952 #define ZFS_IMPORT_NORMAL 0x0
953 #define ZFS_IMPORT_VERBATIM 0x1
954 #define ZFS_IMPORT_ANY_HOST 0x2
955 #define ZFS_IMPORT_MISSING_LOG 0x4
956 #define ZFS_IMPORT_ONLY 0x8
959 * Channel program argument/return nvlist keys and defaults.
961 #define ZCP_ARG_PROGRAM "program"
962 #define ZCP_ARG_ARGLIST "arg"
963 #define ZCP_ARG_INSTRLIMIT "instrlimit"
964 #define ZCP_ARG_MEMLIMIT "memlimit"
966 #define ZCP_ARG_CLIARGV "argv"
968 #define ZCP_RET_ERROR "error"
969 #define ZCP_RET_RETURN "return"
971 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000)
972 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT)
973 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024)
974 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT)
977 * Sysevent payload members. ZFS will generate the following sysevents with the
980 * ESC_ZFS_RESILVER_START
981 * ESC_ZFS_RESILVER_END
982 * ESC_ZFS_POOL_DESTROY
983 * ESC_ZFS_POOL_REGUID
985 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
986 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
988 * ESC_ZFS_VDEV_REMOVE
992 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
993 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
994 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
995 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
997 * ESC_ZFS_HISTORY_EVENT
999 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1000 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1001 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional)
1002 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional)
1003 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional)
1004 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional)
1005 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional)
1006 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional)
1007 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional)
1008 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional)
1009 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional)
1010 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional)
1011 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional)
1012 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional)
1014 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1015 * history log nvlist. The keynames will be free of any spaces or other
1016 * characters that could be potentially unexpected to consumers of the
1019 #define ZFS_EV_POOL_NAME "pool_name"
1020 #define ZFS_EV_POOL_GUID "pool_guid"
1021 #define ZFS_EV_VDEV_PATH "vdev_path"
1022 #define ZFS_EV_VDEV_GUID "vdev_guid"
1023 #define ZFS_EV_HIST_TIME "history_time"
1024 #define ZFS_EV_HIST_CMD "history_command"
1025 #define ZFS_EV_HIST_WHO "history_who"
1026 #define ZFS_EV_HIST_ZONE "history_zone"
1027 #define ZFS_EV_HIST_HOST "history_hostname"
1028 #define ZFS_EV_HIST_TXG "history_txg"
1029 #define ZFS_EV_HIST_INT_EVENT "history_internal_event"
1030 #define ZFS_EV_HIST_INT_STR "history_internal_str"
1031 #define ZFS_EV_HIST_INT_NAME "history_internal_name"
1032 #define ZFS_EV_HIST_IOCTL "history_ioctl"
1033 #define ZFS_EV_HIST_DSNAME "history_dsname"
1034 #define ZFS_EV_HIST_DSID "history_dsid"
1040 #endif /* _SYS_FS_ZFS_H */