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 */
146 ZFS_PROP_SELINUX_CONTEXT
,
147 ZFS_PROP_SELINUX_FSCONTEXT
,
148 ZFS_PROP_SELINUX_DEFCONTEXT
,
149 ZFS_PROP_SELINUX_ROOTCONTEXT
,
159 ZFS_NUM_USERQUOTA_PROPS
160 } zfs_userquota_prop_t
;
162 extern const char *zfs_userquota_prop_prefixes
[ZFS_NUM_USERQUOTA_PROPS
];
165 * Pool properties are identified by these constants and must be added to the
166 * end of this list to ensure that external consumers are not affected
167 * by the change. If you make any changes to this list, be sure to update
168 * the property table in module/zcommon/zpool_prop.c.
179 ZPOOL_PROP_DELEGATION
,
180 ZPOOL_PROP_AUTOREPLACE
,
181 ZPOOL_PROP_CACHEFILE
,
182 ZPOOL_PROP_FAILUREMODE
,
183 ZPOOL_PROP_LISTSNAPS
,
184 ZPOOL_PROP_AUTOEXPAND
,
185 ZPOOL_PROP_DEDUPDITTO
,
186 ZPOOL_PROP_DEDUPRATIO
,
188 ZPOOL_PROP_ALLOCATED
,
197 /* Small enough to not hog a whole line of printout in zpool(1M). */
198 #define ZPROP_MAX_COMMENT 32
200 #define ZPROP_CONT -2
201 #define ZPROP_INVAL -1
203 #define ZPROP_VALUE "value"
204 #define ZPROP_SOURCE "source"
207 ZPROP_SRC_NONE
= 0x1,
208 ZPROP_SRC_DEFAULT
= 0x2,
209 ZPROP_SRC_TEMPORARY
= 0x4,
210 ZPROP_SRC_LOCAL
= 0x8,
211 ZPROP_SRC_INHERITED
= 0x10,
212 ZPROP_SRC_RECEIVED
= 0x20
215 #define ZPROP_SRC_ALL 0x3f
217 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
218 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
220 * Dataset flag implemented as a special entry in the props zap object
221 * indicating that the dataset has received properties on or after
222 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
223 * just as it did in earlier versions, and thereafter, local properties are
226 #define ZPROP_HAS_RECVD "$hasrecvd"
229 ZPROP_ERR_NOCLEAR
= 0x1, /* failure to clear existing props */
230 ZPROP_ERR_NORESTORE
= 0x2 /* failure to restore props on error */
233 typedef int (*zprop_func
)(int, void *);
236 * Properties to be set on the root file system of a new pool
237 * are stuffed into their own nvlist, which is then included in
238 * the properties nvlist with the pool properties.
240 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
243 * Dataset property functions shared between libzfs and kernel.
245 const char *zfs_prop_default_string(zfs_prop_t
);
246 uint64_t zfs_prop_default_numeric(zfs_prop_t
);
247 boolean_t
zfs_prop_readonly(zfs_prop_t
);
248 boolean_t
zfs_prop_inheritable(zfs_prop_t
);
249 boolean_t
zfs_prop_setonce(zfs_prop_t
);
250 const char *zfs_prop_to_name(zfs_prop_t
);
251 zfs_prop_t
zfs_name_to_prop(const char *);
252 boolean_t
zfs_prop_user(const char *);
253 boolean_t
zfs_prop_userquota(const char *);
254 boolean_t
zfs_prop_written(const char *);
255 int zfs_prop_index_to_string(zfs_prop_t
, uint64_t, const char **);
256 int zfs_prop_string_to_index(zfs_prop_t
, const char *, uint64_t *);
257 uint64_t zfs_prop_random_value(zfs_prop_t
, uint64_t seed
);
258 boolean_t
zfs_prop_valid_for_type(int, zfs_type_t
);
261 * Pool property functions shared between libzfs and kernel.
263 zpool_prop_t
zpool_name_to_prop(const char *);
264 const char *zpool_prop_to_name(zpool_prop_t
);
265 const char *zpool_prop_default_string(zpool_prop_t
);
266 uint64_t zpool_prop_default_numeric(zpool_prop_t
);
267 boolean_t
zpool_prop_readonly(zpool_prop_t
);
268 boolean_t
zpool_prop_feature(const char *);
269 boolean_t
zpool_prop_unsupported(const char *);
270 int zpool_prop_index_to_string(zpool_prop_t
, uint64_t, const char **);
271 int zpool_prop_string_to_index(zpool_prop_t
, const char *, uint64_t *);
272 uint64_t zpool_prop_random_value(zpool_prop_t
, uint64_t seed
);
275 * Definitions for the Delegation.
278 ZFS_DELEG_WHO_UNKNOWN
= 0,
279 ZFS_DELEG_USER
= 'u',
280 ZFS_DELEG_USER_SETS
= 'U',
281 ZFS_DELEG_GROUP
= 'g',
282 ZFS_DELEG_GROUP_SETS
= 'G',
283 ZFS_DELEG_EVERYONE
= 'e',
284 ZFS_DELEG_EVERYONE_SETS
= 'E',
285 ZFS_DELEG_CREATE
= 'c',
286 ZFS_DELEG_CREATE_SETS
= 'C',
287 ZFS_DELEG_NAMED_SET
= 's',
288 ZFS_DELEG_NAMED_SET_SETS
= 'S'
289 } zfs_deleg_who_type_t
;
293 ZFS_DELEG_PERM_LOCAL
= 1,
294 ZFS_DELEG_PERM_DESCENDENT
= 2,
295 ZFS_DELEG_PERM_LOCALDESCENDENT
= 3,
296 ZFS_DELEG_PERM_CREATE
= 4
297 } zfs_deleg_inherit_t
;
299 #define ZFS_DELEG_PERM_UID "uid"
300 #define ZFS_DELEG_PERM_GID "gid"
301 #define ZFS_DELEG_PERM_GROUPS "groups"
303 #define ZFS_MLSLABEL_DEFAULT "none"
305 #define ZFS_SMB_ACL_SRC "src"
306 #define ZFS_SMB_ACL_TARGET "target"
309 ZFS_CANMOUNT_OFF
= 0,
311 ZFS_CANMOUNT_NOAUTO
= 2
312 } zfs_canmount_type_t
;
315 ZFS_LOGBIAS_LATENCY
= 0,
316 ZFS_LOGBIAS_THROUGHPUT
= 1
319 typedef enum zfs_share_op
{
326 typedef enum zfs_smb_acl_op
{
333 typedef enum zfs_cache_type
{
335 ZFS_CACHE_METADATA
= 1,
340 ZFS_SYNC_STANDARD
= 0,
342 ZFS_SYNC_DISABLED
= 2
352 * On-disk version number.
354 #define SPA_VERSION_1 1ULL
355 #define SPA_VERSION_2 2ULL
356 #define SPA_VERSION_3 3ULL
357 #define SPA_VERSION_4 4ULL
358 #define SPA_VERSION_5 5ULL
359 #define SPA_VERSION_6 6ULL
360 #define SPA_VERSION_7 7ULL
361 #define SPA_VERSION_8 8ULL
362 #define SPA_VERSION_9 9ULL
363 #define SPA_VERSION_10 10ULL
364 #define SPA_VERSION_11 11ULL
365 #define SPA_VERSION_12 12ULL
366 #define SPA_VERSION_13 13ULL
367 #define SPA_VERSION_14 14ULL
368 #define SPA_VERSION_15 15ULL
369 #define SPA_VERSION_16 16ULL
370 #define SPA_VERSION_17 17ULL
371 #define SPA_VERSION_18 18ULL
372 #define SPA_VERSION_19 19ULL
373 #define SPA_VERSION_20 20ULL
374 #define SPA_VERSION_21 21ULL
375 #define SPA_VERSION_22 22ULL
376 #define SPA_VERSION_23 23ULL
377 #define SPA_VERSION_24 24ULL
378 #define SPA_VERSION_25 25ULL
379 #define SPA_VERSION_26 26ULL
380 #define SPA_VERSION_27 27ULL
381 #define SPA_VERSION_28 28ULL
382 #define SPA_VERSION_5000 5000ULL
385 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
386 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
387 * and do the appropriate changes. Also bump the version number in
388 * usr/src/grub/capability.
390 #define SPA_VERSION SPA_VERSION_5000
391 #define SPA_VERSION_STRING "5000"
394 * Symbolic names for the changes that caused a SPA_VERSION switch.
395 * Used in the code when checking for presence or absence of a feature.
396 * Feel free to define multiple symbolic names for each version if there
397 * were multiple changes to on-disk structures during that version.
399 * NOTE: When checking the current SPA_VERSION in your code, be sure
400 * to use spa_version() since it reports the version of the
401 * last synced uberblock. Checking the in-flight version can
402 * be dangerous in some cases.
404 #define SPA_VERSION_INITIAL SPA_VERSION_1
405 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
406 #define SPA_VERSION_SPARES SPA_VERSION_3
407 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
408 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
409 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
410 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
411 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
412 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
413 #define SPA_VERSION_BOOTFS SPA_VERSION_6
414 #define SPA_VERSION_SLOGS SPA_VERSION_7
415 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
416 #define SPA_VERSION_FUID SPA_VERSION_9
417 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
418 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
419 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
420 #define SPA_VERSION_L2CACHE SPA_VERSION_10
421 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
422 #define SPA_VERSION_ORIGIN SPA_VERSION_11
423 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
424 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
425 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
426 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
427 #define SPA_VERSION_USERSPACE SPA_VERSION_15
428 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
429 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
430 #define SPA_VERSION_USERREFS SPA_VERSION_18
431 #define SPA_VERSION_HOLES SPA_VERSION_19
432 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
433 #define SPA_VERSION_DEDUP SPA_VERSION_21
434 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
435 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
436 #define SPA_VERSION_SA SPA_VERSION_24
437 #define SPA_VERSION_SCAN SPA_VERSION_25
438 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
439 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
440 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
441 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
442 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
443 #define SPA_VERSION_FEATURES SPA_VERSION_5000
445 #define SPA_VERSION_IS_SUPPORTED(v) \
446 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
447 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
450 * ZPL version - rev'd whenever an incompatible on-disk format change
451 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
452 * also update the version_table[] and help message in zfs_prop.c.
454 * When changing, be sure to teach GRUB how to read the new format!
455 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
457 #define ZPL_VERSION_1 1ULL
458 #define ZPL_VERSION_2 2ULL
459 #define ZPL_VERSION_3 3ULL
460 #define ZPL_VERSION_4 4ULL
461 #define ZPL_VERSION_5 5ULL
462 #define ZPL_VERSION ZPL_VERSION_5
463 #define ZPL_VERSION_STRING "5"
465 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
466 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
467 #define ZPL_VERSION_FUID ZPL_VERSION_3
468 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
469 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
470 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
471 #define ZPL_VERSION_SA ZPL_VERSION_5
473 /* Rewind request information */
474 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
475 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
476 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
477 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
478 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
479 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
480 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
482 typedef struct zpool_rewind_policy
{
483 uint32_t zrp_request
; /* rewind behavior requested */
484 uint64_t zrp_maxmeta
; /* max acceptable meta-data errors */
485 uint64_t zrp_maxdata
; /* max acceptable data errors */
486 uint64_t zrp_txg
; /* specific txg to load */
487 } zpool_rewind_policy_t
;
490 * The following are configuration names used in the nvlist describing a pool's
493 #define ZPOOL_CONFIG_VERSION "version"
494 #define ZPOOL_CONFIG_POOL_NAME "name"
495 #define ZPOOL_CONFIG_POOL_STATE "state"
496 #define ZPOOL_CONFIG_POOL_TXG "txg"
497 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
498 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
499 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
500 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
501 #define ZPOOL_CONFIG_TYPE "type"
502 #define ZPOOL_CONFIG_CHILDREN "children"
503 #define ZPOOL_CONFIG_ID "id"
504 #define ZPOOL_CONFIG_GUID "guid"
505 #define ZPOOL_CONFIG_PATH "path"
506 #define ZPOOL_CONFIG_DEVID "devid"
507 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
508 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
509 #define ZPOOL_CONFIG_ASHIFT "ashift"
510 #define ZPOOL_CONFIG_ASIZE "asize"
511 #define ZPOOL_CONFIG_DTL "DTL"
512 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
513 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
514 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
515 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
516 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
517 #define ZPOOL_CONFIG_SPARES "spares"
518 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
519 #define ZPOOL_CONFIG_NPARITY "nparity"
520 #define ZPOOL_CONFIG_HOSTID "hostid"
521 #define ZPOOL_CONFIG_HOSTNAME "hostname"
522 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
523 #define ZPOOL_CONFIG_UNSPARE "unspare"
524 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
525 #define ZPOOL_CONFIG_IS_LOG "is_log"
526 #define ZPOOL_CONFIG_L2CACHE "l2cache"
527 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
528 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
529 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
530 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
531 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
532 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
533 #define ZPOOL_CONFIG_SPLIT "splitcfg"
534 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
535 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
536 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
537 #define ZPOOL_CONFIG_REMOVING "removing"
538 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
539 #define ZPOOL_CONFIG_COMMENT "comment"
540 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
541 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
542 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
543 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
544 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
545 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
546 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
547 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
548 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
549 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
550 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
551 #define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */
553 * The persistent vdev state is stored as separate values rather than a single
554 * 'vdev_state' entry. This is because a device can be in multiple states, such
555 * as offline and degraded.
557 #define ZPOOL_CONFIG_OFFLINE "offline"
558 #define ZPOOL_CONFIG_FAULTED "faulted"
559 #define ZPOOL_CONFIG_DEGRADED "degraded"
560 #define ZPOOL_CONFIG_REMOVED "removed"
561 #define ZPOOL_CONFIG_FRU "fru"
562 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
564 /* Rewind policy parameters */
565 #define ZPOOL_REWIND_POLICY "rewind-policy"
566 #define ZPOOL_REWIND_REQUEST "rewind-request"
567 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
568 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
569 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
571 /* Rewind data discovered */
572 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
573 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
574 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
576 #define VDEV_TYPE_ROOT "root"
577 #define VDEV_TYPE_MIRROR "mirror"
578 #define VDEV_TYPE_REPLACING "replacing"
579 #define VDEV_TYPE_RAIDZ "raidz"
580 #define VDEV_TYPE_DISK "disk"
581 #define VDEV_TYPE_FILE "file"
582 #define VDEV_TYPE_MISSING "missing"
583 #define VDEV_TYPE_HOLE "hole"
584 #define VDEV_TYPE_SPARE "spare"
585 #define VDEV_TYPE_LOG "log"
586 #define VDEV_TYPE_L2CACHE "l2cache"
589 * This is needed in userland to report the minimum necessary device size.
591 #define SPA_MINDEVSIZE (64ULL << 20)
594 * The location of the pool configuration repository, shared between kernel and
597 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
600 * vdev states are ordered from least to most healthy.
601 * A vdev that's CANT_OPEN or below is considered unusable.
603 typedef enum vdev_state
{
604 VDEV_STATE_UNKNOWN
= 0, /* Uninitialized vdev */
605 VDEV_STATE_CLOSED
, /* Not currently open */
606 VDEV_STATE_OFFLINE
, /* Not allowed to open */
607 VDEV_STATE_REMOVED
, /* Explicitly removed from system */
608 VDEV_STATE_CANT_OPEN
, /* Tried to open, but failed */
609 VDEV_STATE_FAULTED
, /* External request to fault device */
610 VDEV_STATE_DEGRADED
, /* Replicated vdev with unhealthy kids */
611 VDEV_STATE_HEALTHY
/* Presumed good */
614 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
617 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
618 * of the vdev stats structure uses these constants to distinguish why.
620 typedef enum vdev_aux
{
621 VDEV_AUX_NONE
, /* no error */
622 VDEV_AUX_OPEN_FAILED
, /* ldi_open_*() or vn_open() failed */
623 VDEV_AUX_CORRUPT_DATA
, /* bad label or disk contents */
624 VDEV_AUX_NO_REPLICAS
, /* insufficient number of replicas */
625 VDEV_AUX_BAD_GUID_SUM
, /* vdev guid sum doesn't match */
626 VDEV_AUX_TOO_SMALL
, /* vdev size is too small */
627 VDEV_AUX_BAD_LABEL
, /* the label is OK but invalid */
628 VDEV_AUX_VERSION_NEWER
, /* on-disk version is too new */
629 VDEV_AUX_VERSION_OLDER
, /* on-disk version is too old */
630 VDEV_AUX_UNSUP_FEAT
, /* unsupported features */
631 VDEV_AUX_SPARED
, /* hot spare used in another pool */
632 VDEV_AUX_ERR_EXCEEDED
, /* too many errors */
633 VDEV_AUX_IO_FAILURE
, /* experienced I/O failure */
634 VDEV_AUX_BAD_LOG
, /* cannot read log chain(s) */
635 VDEV_AUX_EXTERNAL
, /* external diagnosis */
636 VDEV_AUX_SPLIT_POOL
/* vdev was split off into another pool */
640 * pool state. The following states are written to disk as part of the normal
641 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
642 * states are software abstractions used at various levels to communicate
645 typedef enum pool_state
{
646 POOL_STATE_ACTIVE
= 0, /* In active use */
647 POOL_STATE_EXPORTED
, /* Explicitly exported */
648 POOL_STATE_DESTROYED
, /* Explicitly destroyed */
649 POOL_STATE_SPARE
, /* Reserved for hot spare use */
650 POOL_STATE_L2CACHE
, /* Level 2 ARC device */
651 POOL_STATE_UNINITIALIZED
, /* Internal spa_t state */
652 POOL_STATE_UNAVAIL
, /* Internal libzfs state */
653 POOL_STATE_POTENTIALLY_ACTIVE
/* Internal libzfs state */
659 typedef enum pool_scan_func
{
667 * ZIO types. Needed to interpret vdev statistics below.
669 typedef enum zio_type
{
680 * Pool statistics. Note: all fields should be 64-bit because this
681 * is passed between kernel and userland as an nvlist uint64 array.
683 typedef struct pool_scan_stat
{
684 /* values stored on disk */
685 uint64_t pss_func
; /* pool_scan_func_t */
686 uint64_t pss_state
; /* dsl_scan_state_t */
687 uint64_t pss_start_time
; /* scan start time */
688 uint64_t pss_end_time
; /* scan end time */
689 uint64_t pss_to_examine
; /* total bytes to scan */
690 uint64_t pss_examined
; /* total examined bytes */
691 uint64_t pss_to_process
; /* total bytes to process */
692 uint64_t pss_processed
; /* total processed bytes */
693 uint64_t pss_errors
; /* scan errors */
695 /* values not stored on disk */
696 uint64_t pss_pass_exam
; /* examined bytes per scan pass */
697 uint64_t pss_pass_start
; /* start time of a scan pass */
700 typedef enum dsl_scan_state
{
709 * Errata described by http://zfsonlinux.org/msg/ZFS-8000-ER. The ordering
710 * of this enum must be maintained to ensure the errata identifiers map to
711 * the correct documentation. New errata may only be appended to the list
712 * and must contain corresponding documentation at the above link.
714 typedef enum zpool_errata
{
719 * Vdev statistics. Note: all fields should be 64-bit because this
720 * is passed between kernel and userland as an nvlist uint64 array.
722 typedef struct vdev_stat
{
723 hrtime_t vs_timestamp
; /* time since vdev load */
724 uint64_t vs_state
; /* vdev state */
725 uint64_t vs_aux
; /* see vdev_aux_t */
726 uint64_t vs_alloc
; /* space allocated */
727 uint64_t vs_space
; /* total capacity */
728 uint64_t vs_dspace
; /* deflated capacity */
729 uint64_t vs_rsize
; /* replaceable dev size */
730 uint64_t vs_esize
; /* expandable dev size */
731 uint64_t vs_ops
[ZIO_TYPES
]; /* operation count */
732 uint64_t vs_bytes
[ZIO_TYPES
]; /* bytes read/written */
733 uint64_t vs_read_errors
; /* read errors */
734 uint64_t vs_write_errors
; /* write errors */
735 uint64_t vs_checksum_errors
; /* checksum errors */
736 uint64_t vs_self_healed
; /* self-healed bytes */
737 uint64_t vs_scan_removing
; /* removing? */
738 uint64_t vs_scan_processed
; /* scan processed bytes */
742 * DDT statistics. Note: all fields should be 64-bit because this
743 * is passed between kernel and userland as an nvlist uint64 array.
745 typedef struct ddt_object
{
746 uint64_t ddo_count
; /* number of elments in ddt */
747 uint64_t ddo_dspace
; /* size of ddt on disk */
748 uint64_t ddo_mspace
; /* size of ddt in-core */
751 typedef struct ddt_stat
{
752 uint64_t dds_blocks
; /* blocks */
753 uint64_t dds_lsize
; /* logical size */
754 uint64_t dds_psize
; /* physical size */
755 uint64_t dds_dsize
; /* deflated allocated size */
756 uint64_t dds_ref_blocks
; /* referenced blocks */
757 uint64_t dds_ref_lsize
; /* referenced lsize * refcnt */
758 uint64_t dds_ref_psize
; /* referenced psize * refcnt */
759 uint64_t dds_ref_dsize
; /* referenced dsize * refcnt */
762 typedef struct ddt_histogram
{
763 ddt_stat_t ddh_stat
[64]; /* power-of-two histogram buckets */
766 #define ZVOL_DRIVER "zvol"
767 #define ZFS_DRIVER "zfs"
768 #define ZFS_DEV "/dev/zfs"
770 /* general zvol path */
771 #define ZVOL_DIR "/dev"
773 #define ZVOL_MAJOR 230
774 #define ZVOL_MINOR_BITS 4
775 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
776 #define ZVOL_MINORS (1 << 4)
777 #define ZVOL_DEV_NAME "zd"
779 #define ZVOL_PROP_NAME "name"
780 #define ZVOL_DEFAULT_BLOCKSIZE 8192
783 * /dev/zfs ioctl numbers.
785 typedef enum zfs_ioc
{
787 * Illumos - 69/128 numbers reserved.
789 ZFS_IOC_FIRST
= ('Z' << 8),
790 ZFS_IOC
= ZFS_IOC_FIRST
,
791 ZFS_IOC_POOL_CREATE
= ZFS_IOC_FIRST
,
792 ZFS_IOC_POOL_DESTROY
,
795 ZFS_IOC_POOL_CONFIGS
,
797 ZFS_IOC_POOL_TRYIMPORT
,
800 ZFS_IOC_POOL_UPGRADE
,
801 ZFS_IOC_POOL_GET_HISTORY
,
804 ZFS_IOC_VDEV_SET_STATE
,
807 ZFS_IOC_VDEV_SETPATH
,
809 ZFS_IOC_OBJSET_STATS
,
810 ZFS_IOC_OBJSET_ZPLPROPS
,
811 ZFS_IOC_DATASET_LIST_NEXT
,
812 ZFS_IOC_SNAPSHOT_LIST_NEXT
,
820 ZFS_IOC_INJECT_FAULT
,
822 ZFS_IOC_INJECT_LIST_NEXT
,
827 ZFS_IOC_DSOBJ_TO_DSNAME
,
829 ZFS_IOC_POOL_SET_PROPS
,
830 ZFS_IOC_POOL_GET_PROPS
,
834 ZFS_IOC_INHERIT_PROP
,
836 ZFS_IOC_USERSPACE_ONE
,
837 ZFS_IOC_USERSPACE_MANY
,
838 ZFS_IOC_USERSPACE_UPGRADE
,
842 ZFS_IOC_OBJSET_RECVD_PROPS
,
846 ZFS_IOC_TMP_SNAPSHOT
,
847 ZFS_IOC_OBJ_TO_STATS
,
848 ZFS_IOC_SPACE_WRITTEN
,
850 ZFS_IOC_DESTROY_SNAPS
,
853 ZFS_IOC_SEND_PROGRESS
,
860 * Linux - 3/64 numbers reserved.
862 ZFS_IOC_LINUX
= ('Z' << 8) + 0x80,
864 ZFS_IOC_EVENTS_CLEAR
,
867 * FreeBSD - 1/64 numbers reserved.
869 ZFS_IOC_FREEBSD
= ('Z' << 8) + 0xC0,
875 * zvol ioctl to get dataset name
877 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAXNAMELEN])
880 * Internal SPA load state. Used by FMA diagnosis engine.
883 SPA_LOAD_NONE
, /* no load in progress */
884 SPA_LOAD_OPEN
, /* normal open */
885 SPA_LOAD_IMPORT
, /* import in progress */
886 SPA_LOAD_TRYIMPORT
, /* tryimport in progress */
887 SPA_LOAD_RECOVER
, /* recovery requested */
888 SPA_LOAD_ERROR
/* load failed */
892 * Bookmark name values.
894 #define ZPOOL_ERR_LIST "error list"
895 #define ZPOOL_ERR_DATASET "dataset"
896 #define ZPOOL_ERR_OBJECT "object"
898 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
901 * The following are names used in the nvlist describing
902 * the pool's history log.
904 #define ZPOOL_HIST_RECORD "history record"
905 #define ZPOOL_HIST_TIME "history time"
906 #define ZPOOL_HIST_CMD "history command"
907 #define ZPOOL_HIST_WHO "history who"
908 #define ZPOOL_HIST_ZONE "history zone"
909 #define ZPOOL_HIST_HOST "history hostname"
910 #define ZPOOL_HIST_TXG "history txg"
911 #define ZPOOL_HIST_INT_EVENT "history internal event"
912 #define ZPOOL_HIST_INT_STR "history internal str"
913 #define ZPOOL_HIST_INT_NAME "internal_name"
914 #define ZPOOL_HIST_IOCTL "ioctl"
915 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
916 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
917 #define ZPOOL_HIST_DSNAME "dsname"
918 #define ZPOOL_HIST_DSID "dsid"
921 * Flags for ZFS_IOC_VDEV_SET_STATE
923 #define ZFS_ONLINE_CHECKREMOVE 0x1
924 #define ZFS_ONLINE_UNSPARE 0x2
925 #define ZFS_ONLINE_FORCEFAULT 0x4
926 #define ZFS_ONLINE_EXPAND 0x8
927 #define ZFS_OFFLINE_TEMPORARY 0x1
930 * Flags for ZFS_IOC_POOL_IMPORT
932 #define ZFS_IMPORT_NORMAL 0x0
933 #define ZFS_IMPORT_VERBATIM 0x1
934 #define ZFS_IMPORT_ANY_HOST 0x2
935 #define ZFS_IMPORT_MISSING_LOG 0x4
936 #define ZFS_IMPORT_ONLY 0x8
939 * Sysevent payload members. ZFS will generate the following sysevents with the
942 * ESC_ZFS_RESILVER_START
943 * ESC_ZFS_RESILVER_END
944 * ESC_ZFS_POOL_DESTROY
945 * ESC_ZFS_POOL_REGUID
947 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
948 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
950 * ESC_ZFS_VDEV_REMOVE
954 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
955 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
956 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
957 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
959 #define ZFS_EV_POOL_NAME "pool_name"
960 #define ZFS_EV_POOL_GUID "pool_guid"
961 #define ZFS_EV_VDEV_PATH "vdev_path"
962 #define ZFS_EV_VDEV_GUID "vdev_guid"
968 #endif /* _SYS_FS_ZFS_H */