4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2012 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>. All rights reserved.
30 /* Portions Copyright 2010 Robert Milkowski */
35 #include <sys/types.h>
36 #include <sys/ioccom.h>
44 * Types and constants shared between userland and the kernel.
48 * Each dataset can be one of the following types. These constants can be
49 * combined into masks that can be passed to various functions.
52 ZFS_TYPE_FILESYSTEM = 0x1,
53 ZFS_TYPE_SNAPSHOT = 0x2,
54 ZFS_TYPE_VOLUME = 0x4,
58 typedef enum dmu_objset_type {
63 DMU_OST_OTHER, /* For testing only! */
64 DMU_OST_ANY, /* Be careful! */
68 #define ZFS_TYPE_DATASET \
69 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
71 #define ZAP_MAXNAMELEN 256
72 #define ZAP_MAXVALUELEN (1024 * 8)
73 #define ZAP_OLDMAXVALUELEN 1024
76 * Dataset properties are identified by these constants and must be added to
77 * the end of this list to ensure that external consumers are not affected
78 * by the change. If you make any changes to this list, be sure to update
79 * the property table in usr/src/common/zfs/zfs_prop.c.
87 ZFS_PROP_COMPRESSRATIO,
93 ZFS_PROP_VOLBLOCKSIZE,
108 ZFS_PROP_CREATETXG, /* not exposed to the user */
109 ZFS_PROP_NAME, /* not exposed to the user */
111 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
113 ZFS_PROP_NUMCLONES, /* not exposed to the user */
123 ZFS_PROP_REFRESERVATION,
125 ZFS_PROP_PRIMARYCACHE,
126 ZFS_PROP_SECONDARYCACHE,
130 ZFS_PROP_USEDREFRESERV,
131 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
132 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
133 ZFS_PROP_DEFER_DESTROY,
136 ZFS_PROP_UNIQUE, /* not exposed to the user */
137 ZFS_PROP_OBJSETID, /* not exposed to the user */
144 ZFS_PROP_LOGICALUSED,
145 ZFS_PROP_LOGICALREFERENCED,
154 ZFS_NUM_USERQUOTA_PROPS
155 } zfs_userquota_prop_t;
157 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
160 * Pool properties are identified by these constants and must be added to the
161 * end of this list to ensure that external consumers are not affected
162 * by the change. If you make any changes to this list, be sure to update
163 * the property table in usr/src/common/zfs/zpool_prop.c.
174 ZPOOL_PROP_DELEGATION,
175 ZPOOL_PROP_AUTOREPLACE,
176 ZPOOL_PROP_CACHEFILE,
177 ZPOOL_PROP_FAILUREMODE,
178 ZPOOL_PROP_LISTSNAPS,
179 ZPOOL_PROP_AUTOEXPAND,
180 ZPOOL_PROP_DEDUPDITTO,
181 ZPOOL_PROP_DEDUPRATIO,
183 ZPOOL_PROP_ALLOCATED,
191 /* Small enough to not hog a whole line of printout in zpool(1M). */
192 #define ZPROP_MAX_COMMENT 32
194 #define ZPROP_CONT -2
195 #define ZPROP_INVAL -1
197 #define ZPROP_VALUE "value"
198 #define ZPROP_SOURCE "source"
201 ZPROP_SRC_NONE = 0x1,
202 ZPROP_SRC_DEFAULT = 0x2,
203 ZPROP_SRC_TEMPORARY = 0x4,
204 ZPROP_SRC_LOCAL = 0x8,
205 ZPROP_SRC_INHERITED = 0x10,
206 ZPROP_SRC_RECEIVED = 0x20
209 #define ZPROP_SRC_ALL 0x3f
211 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
212 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
214 * Dataset flag implemented as a special entry in the props zap object
215 * indicating that the dataset has received properties on or after
216 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
217 * just as it did in earlier versions, and thereafter, local properties are
220 #define ZPROP_HAS_RECVD "$hasrecvd"
223 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
224 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
227 typedef int (*zprop_func)(int, void *);
230 * Properties to be set on the root file system of a new pool
231 * are stuffed into their own nvlist, which is then included in
232 * the properties nvlist with the pool properties.
234 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
237 * Dataset property functions shared between libzfs and kernel.
239 const char *zfs_prop_default_string(zfs_prop_t);
240 uint64_t zfs_prop_default_numeric(zfs_prop_t);
241 boolean_t zfs_prop_readonly(zfs_prop_t);
242 boolean_t zfs_prop_inheritable(zfs_prop_t);
243 boolean_t zfs_prop_setonce(zfs_prop_t);
244 const char *zfs_prop_to_name(zfs_prop_t);
245 zfs_prop_t zfs_name_to_prop(const char *);
246 boolean_t zfs_prop_user(const char *);
247 boolean_t zfs_prop_userquota(const char *);
248 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
249 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
250 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
251 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
254 * Pool property functions shared between libzfs and kernel.
256 zpool_prop_t zpool_name_to_prop(const char *);
257 const char *zpool_prop_to_name(zpool_prop_t);
258 const char *zpool_prop_default_string(zpool_prop_t);
259 uint64_t zpool_prop_default_numeric(zpool_prop_t);
260 boolean_t zpool_prop_readonly(zpool_prop_t);
261 boolean_t zpool_prop_feature(const char *);
262 boolean_t zpool_prop_unsupported(const char *name);
263 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
264 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
265 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
268 * Definitions for the Delegation.
271 ZFS_DELEG_WHO_UNKNOWN = 0,
272 ZFS_DELEG_USER = 'u',
273 ZFS_DELEG_USER_SETS = 'U',
274 ZFS_DELEG_GROUP = 'g',
275 ZFS_DELEG_GROUP_SETS = 'G',
276 ZFS_DELEG_EVERYONE = 'e',
277 ZFS_DELEG_EVERYONE_SETS = 'E',
278 ZFS_DELEG_CREATE = 'c',
279 ZFS_DELEG_CREATE_SETS = 'C',
280 ZFS_DELEG_NAMED_SET = 's',
281 ZFS_DELEG_NAMED_SET_SETS = 'S'
282 } zfs_deleg_who_type_t;
286 ZFS_DELEG_PERM_LOCAL = 1,
287 ZFS_DELEG_PERM_DESCENDENT = 2,
288 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
289 ZFS_DELEG_PERM_CREATE = 4
290 } zfs_deleg_inherit_t;
292 #define ZFS_DELEG_PERM_UID "uid"
293 #define ZFS_DELEG_PERM_GID "gid"
294 #define ZFS_DELEG_PERM_GROUPS "groups"
296 #define ZFS_MLSLABEL_DEFAULT "none"
298 #define ZFS_SMB_ACL_SRC "src"
299 #define ZFS_SMB_ACL_TARGET "target"
302 ZFS_CANMOUNT_OFF = 0,
304 ZFS_CANMOUNT_NOAUTO = 2
305 } zfs_canmount_type_t;
308 ZFS_LOGBIAS_LATENCY = 0,
309 ZFS_LOGBIAS_THROUGHPUT = 1
312 typedef enum zfs_share_op {
319 typedef enum zfs_smb_acl_op {
326 typedef enum zfs_cache_type {
328 ZFS_CACHE_METADATA = 1,
333 ZFS_SYNC_STANDARD = 0,
335 ZFS_SYNC_DISABLED = 2
340 * On-disk version number.
342 #define SPA_VERSION_1 1ULL
343 #define SPA_VERSION_2 2ULL
344 #define SPA_VERSION_3 3ULL
345 #define SPA_VERSION_4 4ULL
346 #define SPA_VERSION_5 5ULL
347 #define SPA_VERSION_6 6ULL
348 #define SPA_VERSION_7 7ULL
349 #define SPA_VERSION_8 8ULL
350 #define SPA_VERSION_9 9ULL
351 #define SPA_VERSION_10 10ULL
352 #define SPA_VERSION_11 11ULL
353 #define SPA_VERSION_12 12ULL
354 #define SPA_VERSION_13 13ULL
355 #define SPA_VERSION_14 14ULL
356 #define SPA_VERSION_15 15ULL
357 #define SPA_VERSION_16 16ULL
358 #define SPA_VERSION_17 17ULL
359 #define SPA_VERSION_18 18ULL
360 #define SPA_VERSION_19 19ULL
361 #define SPA_VERSION_20 20ULL
362 #define SPA_VERSION_21 21ULL
363 #define SPA_VERSION_22 22ULL
364 #define SPA_VERSION_23 23ULL
365 #define SPA_VERSION_24 24ULL
366 #define SPA_VERSION_25 25ULL
367 #define SPA_VERSION_26 26ULL
368 #define SPA_VERSION_27 27ULL
369 #define SPA_VERSION_28 28ULL
370 #define SPA_VERSION_5000 5000ULL
373 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
374 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
375 * and do the appropriate changes. Also bump the version number in
376 * usr/src/grub/capability.
378 #define SPA_VERSION SPA_VERSION_5000
379 #define SPA_VERSION_STRING "5000"
382 * Symbolic names for the changes that caused a SPA_VERSION switch.
383 * Used in the code when checking for presence or absence of a feature.
384 * Feel free to define multiple symbolic names for each version if there
385 * were multiple changes to on-disk structures during that version.
387 * NOTE: When checking the current SPA_VERSION in your code, be sure
388 * to use spa_version() since it reports the version of the
389 * last synced uberblock. Checking the in-flight version can
390 * be dangerous in some cases.
392 #define SPA_VERSION_INITIAL SPA_VERSION_1
393 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
394 #define SPA_VERSION_SPARES SPA_VERSION_3
395 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
396 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
397 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
398 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
399 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
400 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
401 #define SPA_VERSION_BOOTFS SPA_VERSION_6
402 #define SPA_VERSION_SLOGS SPA_VERSION_7
403 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
404 #define SPA_VERSION_FUID SPA_VERSION_9
405 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
406 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
407 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
408 #define SPA_VERSION_L2CACHE SPA_VERSION_10
409 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
410 #define SPA_VERSION_ORIGIN SPA_VERSION_11
411 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
412 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
413 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
414 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
415 #define SPA_VERSION_USERSPACE SPA_VERSION_15
416 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
417 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
418 #define SPA_VERSION_USERREFS SPA_VERSION_18
419 #define SPA_VERSION_HOLES SPA_VERSION_19
420 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
421 #define SPA_VERSION_DEDUP SPA_VERSION_21
422 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
423 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
424 #define SPA_VERSION_SA SPA_VERSION_24
425 #define SPA_VERSION_SCAN SPA_VERSION_25
426 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
427 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
428 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
429 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
430 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
431 #define SPA_VERSION_FEATURES SPA_VERSION_5000
433 #define SPA_VERSION_IS_SUPPORTED(v) \
434 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
435 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
438 * ZPL version - rev'd whenever an incompatible on-disk format change
439 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
440 * also update the version_table[] and help message in zfs_prop.c.
442 * When changing, be sure to teach GRUB how to read the new format!
443 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
445 #define ZPL_VERSION_1 1ULL
446 #define ZPL_VERSION_2 2ULL
447 #define ZPL_VERSION_3 3ULL
448 #define ZPL_VERSION_4 4ULL
449 #define ZPL_VERSION_5 5ULL
450 #define ZPL_VERSION ZPL_VERSION_5
451 #define ZPL_VERSION_STRING "5"
453 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
454 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
455 #define ZPL_VERSION_FUID ZPL_VERSION_3
456 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
457 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
458 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
459 #define ZPL_VERSION_SA ZPL_VERSION_5
461 /* Rewind request information */
462 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
463 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
464 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
465 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
466 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
467 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
468 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
470 typedef struct zpool_rewind_policy {
471 uint32_t zrp_request; /* rewind behavior requested */
472 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
473 uint64_t zrp_maxdata; /* max acceptable data errors */
474 uint64_t zrp_txg; /* specific txg to load */
475 } zpool_rewind_policy_t;
478 * The following are configuration names used in the nvlist describing a pool's
481 #define ZPOOL_CONFIG_VERSION "version"
482 #define ZPOOL_CONFIG_POOL_NAME "name"
483 #define ZPOOL_CONFIG_POOL_STATE "state"
484 #define ZPOOL_CONFIG_POOL_TXG "txg"
485 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
486 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
487 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
488 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
489 #define ZPOOL_CONFIG_TYPE "type"
490 #define ZPOOL_CONFIG_CHILDREN "children"
491 #define ZPOOL_CONFIG_ID "id"
492 #define ZPOOL_CONFIG_GUID "guid"
493 #define ZPOOL_CONFIG_PATH "path"
494 #define ZPOOL_CONFIG_DEVID "devid"
495 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
496 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
497 #define ZPOOL_CONFIG_ASHIFT "ashift"
498 #define ZPOOL_CONFIG_ASIZE "asize"
499 #define ZPOOL_CONFIG_DTL "DTL"
500 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
501 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
502 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
503 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
504 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
505 #define ZPOOL_CONFIG_SPARES "spares"
506 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
507 #define ZPOOL_CONFIG_NPARITY "nparity"
508 #define ZPOOL_CONFIG_HOSTID "hostid"
509 #define ZPOOL_CONFIG_HOSTNAME "hostname"
510 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
511 #define ZPOOL_CONFIG_UNSPARE "unspare"
512 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
513 #define ZPOOL_CONFIG_IS_LOG "is_log"
514 #define ZPOOL_CONFIG_L2CACHE "l2cache"
515 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
516 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
517 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
518 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
519 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
520 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
521 #define ZPOOL_CONFIG_SPLIT "splitcfg"
522 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
523 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
524 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
525 #define ZPOOL_CONFIG_REMOVING "removing"
526 #define ZPOOL_CONFIG_RESILVERING "resilvering"
527 #define ZPOOL_CONFIG_COMMENT "comment"
528 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
529 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
530 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
531 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
532 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
533 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
534 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
535 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
536 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
537 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
538 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
540 * The persistent vdev state is stored as separate values rather than a single
541 * 'vdev_state' entry. This is because a device can be in multiple states, such
542 * as offline and degraded.
544 #define ZPOOL_CONFIG_OFFLINE "offline"
545 #define ZPOOL_CONFIG_FAULTED "faulted"
546 #define ZPOOL_CONFIG_DEGRADED "degraded"
547 #define ZPOOL_CONFIG_REMOVED "removed"
548 #define ZPOOL_CONFIG_FRU "fru"
549 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
551 /* Rewind policy parameters */
552 #define ZPOOL_REWIND_POLICY "rewind-policy"
553 #define ZPOOL_REWIND_REQUEST "rewind-request"
554 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
555 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
556 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
558 /* Rewind data discovered */
559 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
560 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
561 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
563 #define VDEV_TYPE_ROOT "root"
564 #define VDEV_TYPE_MIRROR "mirror"
565 #define VDEV_TYPE_REPLACING "replacing"
566 #define VDEV_TYPE_RAIDZ "raidz"
567 #define VDEV_TYPE_DISK "disk"
568 #define VDEV_TYPE_FILE "file"
569 #define VDEV_TYPE_MISSING "missing"
570 #define VDEV_TYPE_HOLE "hole"
571 #define VDEV_TYPE_SPARE "spare"
572 #define VDEV_TYPE_LOG "log"
573 #define VDEV_TYPE_L2CACHE "l2cache"
576 * This is needed in userland to report the minimum necessary device size.
578 #define SPA_MINDEVSIZE (64ULL << 20)
581 * The location of the pool configuration repository, shared between kernel and
584 #define ZPOOL_CACHE "/boot/zfs/zpool.cache"
587 * vdev states are ordered from least to most healthy.
588 * A vdev that's CANT_OPEN or below is considered unusable.
590 typedef enum vdev_state {
591 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
592 VDEV_STATE_CLOSED, /* Not currently open */
593 VDEV_STATE_OFFLINE, /* Not allowed to open */
594 VDEV_STATE_REMOVED, /* Explicitly removed from system */
595 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
596 VDEV_STATE_FAULTED, /* External request to fault device */
597 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
598 VDEV_STATE_HEALTHY /* Presumed good */
601 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
604 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
605 * of the vdev stats structure uses these constants to distinguish why.
607 typedef enum vdev_aux {
608 VDEV_AUX_NONE, /* no error */
609 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
610 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
611 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
612 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
613 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
614 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
615 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
616 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
617 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
618 VDEV_AUX_SPARED, /* hot spare used in another pool */
619 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
620 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
621 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
622 VDEV_AUX_EXTERNAL, /* external diagnosis */
623 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */
627 * pool state. The following states are written to disk as part of the normal
628 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
629 * states are software abstractions used at various levels to communicate
632 typedef enum pool_state {
633 POOL_STATE_ACTIVE = 0, /* In active use */
634 POOL_STATE_EXPORTED, /* Explicitly exported */
635 POOL_STATE_DESTROYED, /* Explicitly destroyed */
636 POOL_STATE_SPARE, /* Reserved for hot spare use */
637 POOL_STATE_L2CACHE, /* Level 2 ARC device */
638 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
639 POOL_STATE_UNAVAIL, /* Internal libzfs state */
640 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
646 typedef enum pool_scan_func {
654 * ZIO types. Needed to interpret vdev statistics below.
656 typedef enum zio_type {
667 * Pool statistics. Note: all fields should be 64-bit because this
668 * is passed between kernel and userland as an nvlist uint64 array.
670 typedef struct pool_scan_stat {
671 /* values stored on disk */
672 uint64_t pss_func; /* pool_scan_func_t */
673 uint64_t pss_state; /* dsl_scan_state_t */
674 uint64_t pss_start_time; /* scan start time */
675 uint64_t pss_end_time; /* scan end time */
676 uint64_t pss_to_examine; /* total bytes to scan */
677 uint64_t pss_examined; /* total examined bytes */
678 uint64_t pss_to_process; /* total bytes to process */
679 uint64_t pss_processed; /* total processed bytes */
680 uint64_t pss_errors; /* scan errors */
682 /* values not stored on disk */
683 uint64_t pss_pass_exam; /* examined bytes per scan pass */
684 uint64_t pss_pass_start; /* start time of a scan pass */
687 typedef enum dsl_scan_state {
697 * Vdev statistics. Note: all fields should be 64-bit because this
698 * is passed between kernel and userland as an nvlist uint64 array.
700 typedef struct vdev_stat {
701 hrtime_t vs_timestamp; /* time since vdev load */
702 uint64_t vs_state; /* vdev state */
703 uint64_t vs_aux; /* see vdev_aux_t */
704 uint64_t vs_alloc; /* space allocated */
705 uint64_t vs_space; /* total capacity */
706 uint64_t vs_dspace; /* deflated capacity */
707 uint64_t vs_rsize; /* replaceable dev size */
708 uint64_t vs_esize; /* expandable dev size */
709 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
710 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
711 uint64_t vs_read_errors; /* read errors */
712 uint64_t vs_write_errors; /* write errors */
713 uint64_t vs_checksum_errors; /* checksum errors */
714 uint64_t vs_self_healed; /* self-healed bytes */
715 uint64_t vs_scan_removing; /* removing? */
716 uint64_t vs_scan_processed; /* scan processed bytes */
720 * DDT statistics. Note: all fields should be 64-bit because this
721 * is passed between kernel and userland as an nvlist uint64 array.
723 typedef struct ddt_object {
724 uint64_t ddo_count; /* number of elments in ddt */
725 uint64_t ddo_dspace; /* size of ddt on disk */
726 uint64_t ddo_mspace; /* size of ddt in-core */
729 typedef struct ddt_stat {
730 uint64_t dds_blocks; /* blocks */
731 uint64_t dds_lsize; /* logical size */
732 uint64_t dds_psize; /* physical size */
733 uint64_t dds_dsize; /* deflated allocated size */
734 uint64_t dds_ref_blocks; /* referenced blocks */
735 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
736 uint64_t dds_ref_psize; /* referenced psize * refcnt */
737 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
740 typedef struct ddt_histogram {
741 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
744 #define ZVOL_DRIVER "zvol"
745 #define ZFS_DRIVER "zfs"
746 #define ZFS_DEV_NAME "zfs"
747 #define ZFS_DEV "/dev/" ZFS_DEV_NAME
749 /* general zvol path */
750 #define ZVOL_DIR "/dev/zvol"
752 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
753 /* for dump and swap */
754 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
755 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
757 #define ZVOL_PROP_NAME "name"
758 #define ZVOL_DEFAULT_BLOCKSIZE 8192
761 * /dev/zfs ioctl numbers.
763 typedef enum zfs_ioc {
765 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
766 ZFS_IOC_POOL_DESTROY,
769 ZFS_IOC_POOL_CONFIGS,
771 ZFS_IOC_POOL_TRYIMPORT,
774 ZFS_IOC_POOL_UPGRADE,
775 ZFS_IOC_POOL_GET_HISTORY,
778 ZFS_IOC_VDEV_SET_STATE,
781 ZFS_IOC_VDEV_SETPATH,
783 ZFS_IOC_OBJSET_STATS,
784 ZFS_IOC_OBJSET_ZPLPROPS,
785 ZFS_IOC_DATASET_LIST_NEXT,
786 ZFS_IOC_SNAPSHOT_LIST_NEXT,
794 ZFS_IOC_INJECT_FAULT,
796 ZFS_IOC_INJECT_LIST_NEXT,
800 ZFS_IOC_DESTROY_SNAPS,
802 ZFS_IOC_DSOBJ_TO_DSNAME,
804 ZFS_IOC_POOL_SET_PROPS,
805 ZFS_IOC_POOL_GET_PROPS,
809 ZFS_IOC_INHERIT_PROP,
811 ZFS_IOC_USERSPACE_ONE,
812 ZFS_IOC_USERSPACE_MANY,
813 ZFS_IOC_USERSPACE_UPGRADE,
817 ZFS_IOC_OBJSET_RECVD_PROPS,
821 ZFS_IOC_TMP_SNAPSHOT,
822 ZFS_IOC_OBJ_TO_STATS,
826 ZFS_IOC_SPACE_WRITTEN,
828 ZFS_IOC_SEND_PROGRESS,
838 * Internal SPA load state. Used by FMA diagnosis engine.
841 SPA_LOAD_NONE, /* no load in progress */
842 SPA_LOAD_OPEN, /* normal open */
843 SPA_LOAD_IMPORT, /* import in progress */
844 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
845 SPA_LOAD_RECOVER, /* recovery requested */
846 SPA_LOAD_ERROR /* load failed */
850 * Bookmark name values.
852 #define ZPOOL_ERR_LIST "error list"
853 #define ZPOOL_ERR_DATASET "dataset"
854 #define ZPOOL_ERR_OBJECT "object"
856 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
859 * The following are names used in the nvlist describing
860 * the pool's history log.
862 #define ZPOOL_HIST_RECORD "history record"
863 #define ZPOOL_HIST_TIME "history time"
864 #define ZPOOL_HIST_CMD "history command"
865 #define ZPOOL_HIST_WHO "history who"
866 #define ZPOOL_HIST_ZONE "history zone"
867 #define ZPOOL_HIST_HOST "history hostname"
868 #define ZPOOL_HIST_TXG "history txg"
869 #define ZPOOL_HIST_INT_EVENT "history internal event"
870 #define ZPOOL_HIST_INT_STR "history internal str"
871 #define ZPOOL_HIST_INT_NAME "internal_name"
872 #define ZPOOL_HIST_IOCTL "ioctl"
873 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
874 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
875 #define ZPOOL_HIST_DSNAME "dsname"
876 #define ZPOOL_HIST_DSID "dsid"
879 * Flags for ZFS_IOC_VDEV_SET_STATE
881 #define ZFS_ONLINE_CHECKREMOVE 0x1
882 #define ZFS_ONLINE_UNSPARE 0x2
883 #define ZFS_ONLINE_FORCEFAULT 0x4
884 #define ZFS_ONLINE_EXPAND 0x8
885 #define ZFS_OFFLINE_TEMPORARY 0x1
888 * Flags for ZFS_IOC_POOL_IMPORT
890 #define ZFS_IMPORT_NORMAL 0x0
891 #define ZFS_IMPORT_VERBATIM 0x1
892 #define ZFS_IMPORT_ANY_HOST 0x2
893 #define ZFS_IMPORT_MISSING_LOG 0x4
894 #define ZFS_IMPORT_ONLY 0x8
897 * Sysevent payload members. ZFS will generate the following sysevents with the
900 * ESC_ZFS_RESILVER_START
901 * ESC_ZFS_RESILVER_END
902 * ESC_ZFS_POOL_DESTROY
903 * ESC_ZFS_POOL_REGUID
905 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
906 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
908 * ESC_ZFS_VDEV_REMOVE
912 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
913 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
914 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
915 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
917 #define ZFS_EV_POOL_NAME "pool_name"
918 #define ZFS_EV_POOL_GUID "pool_guid"
919 #define ZFS_EV_VDEV_PATH "vdev_path"
920 #define ZFS_EV_VDEV_GUID "vdev_guid"
926 #endif /* _SYS_FS_ZFS_H */