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, 2014 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2013, 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 = (1 << 0),
53 ZFS_TYPE_SNAPSHOT = (1 << 1),
54 ZFS_TYPE_VOLUME = (1 << 2),
55 ZFS_TYPE_POOL = (1 << 3),
56 ZFS_TYPE_BOOKMARK = (1 << 4)
59 typedef enum dmu_objset_type {
64 DMU_OST_OTHER, /* For testing only! */
65 DMU_OST_ANY, /* Be careful! */
69 #define ZFS_TYPE_DATASET \
70 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
72 #define ZAP_MAXNAMELEN 256
73 #define ZAP_MAXVALUELEN (1024 * 8)
74 #define ZAP_OLDMAXVALUELEN 1024
77 * Dataset properties are identified by these constants and must be added to
78 * the end of this list to ensure that external consumers are not affected
79 * by the change. If you make any changes to this list, be sure to update
80 * the property table in usr/src/common/zfs/zfs_prop.c.
88 ZFS_PROP_COMPRESSRATIO,
94 ZFS_PROP_VOLBLOCKSIZE,
109 ZFS_PROP_CREATETXG, /* not exposed to the user */
110 ZFS_PROP_NAME, /* not exposed to the user */
112 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
114 ZFS_PROP_NUMCLONES, /* not exposed to the user */
124 ZFS_PROP_REFRESERVATION,
126 ZFS_PROP_PRIMARYCACHE,
127 ZFS_PROP_SECONDARYCACHE,
131 ZFS_PROP_USEDREFRESERV,
132 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
133 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
134 ZFS_PROP_DEFER_DESTROY,
137 ZFS_PROP_UNIQUE, /* not exposed to the user */
138 ZFS_PROP_OBJSETID, /* not exposed to the user */
145 ZFS_PROP_LOGICALUSED,
146 ZFS_PROP_LOGICALREFERENCED,
147 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
149 ZFS_PROP_FILESYSTEM_LIMIT,
150 ZFS_PROP_SNAPSHOT_LIMIT,
151 ZFS_PROP_FILESYSTEM_COUNT,
152 ZFS_PROP_SNAPSHOT_COUNT,
153 ZFS_PROP_REDUNDANT_METADATA,
163 ZFS_NUM_USERQUOTA_PROPS
164 } zfs_userquota_prop_t;
166 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
169 * Pool properties are identified by these constants and must be added to the
170 * end of this list to ensure that external consumers are not affected
171 * by the change. If you make any changes to this list, be sure to update
172 * the property table in usr/src/common/zfs/zpool_prop.c.
183 ZPOOL_PROP_DELEGATION,
184 ZPOOL_PROP_AUTOREPLACE,
185 ZPOOL_PROP_CACHEFILE,
186 ZPOOL_PROP_FAILUREMODE,
187 ZPOOL_PROP_LISTSNAPS,
188 ZPOOL_PROP_AUTOEXPAND,
189 ZPOOL_PROP_DEDUPDITTO,
190 ZPOOL_PROP_DEDUPRATIO,
192 ZPOOL_PROP_ALLOCATED,
201 /* Small enough to not hog a whole line of printout in zpool(1M). */
202 #define ZPROP_MAX_COMMENT 32
204 #define ZPROP_CONT -2
205 #define ZPROP_INVAL -1
207 #define ZPROP_VALUE "value"
208 #define ZPROP_SOURCE "source"
211 ZPROP_SRC_NONE = 0x1,
212 ZPROP_SRC_DEFAULT = 0x2,
213 ZPROP_SRC_TEMPORARY = 0x4,
214 ZPROP_SRC_LOCAL = 0x8,
215 ZPROP_SRC_INHERITED = 0x10,
216 ZPROP_SRC_RECEIVED = 0x20
219 #define ZPROP_SRC_ALL 0x3f
221 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
222 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
224 * Dataset flag implemented as a special entry in the props zap object
225 * indicating that the dataset has received properties on or after
226 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
227 * just as it did in earlier versions, and thereafter, local properties are
230 #define ZPROP_HAS_RECVD "$hasrecvd"
233 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
234 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
237 typedef int (*zprop_func)(int, void *);
240 * Properties to be set on the root file system of a new pool
241 * are stuffed into their own nvlist, which is then included in
242 * the properties nvlist with the pool properties.
244 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
247 * Dataset property functions shared between libzfs and kernel.
249 const char *zfs_prop_default_string(zfs_prop_t);
250 uint64_t zfs_prop_default_numeric(zfs_prop_t);
251 boolean_t zfs_prop_readonly(zfs_prop_t);
252 boolean_t zfs_prop_inheritable(zfs_prop_t);
253 boolean_t zfs_prop_setonce(zfs_prop_t);
254 const char *zfs_prop_to_name(zfs_prop_t);
255 zfs_prop_t zfs_name_to_prop(const char *);
256 boolean_t zfs_prop_user(const char *);
257 boolean_t zfs_prop_userquota(const char *);
258 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
259 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
260 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
261 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
264 * Pool property functions shared between libzfs and kernel.
266 zpool_prop_t zpool_name_to_prop(const char *);
267 const char *zpool_prop_to_name(zpool_prop_t);
268 const char *zpool_prop_default_string(zpool_prop_t);
269 uint64_t zpool_prop_default_numeric(zpool_prop_t);
270 boolean_t zpool_prop_readonly(zpool_prop_t);
271 boolean_t zpool_prop_feature(const char *);
272 boolean_t zpool_prop_unsupported(const char *name);
273 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
274 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
275 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
278 * Definitions for the Delegation.
281 ZFS_DELEG_WHO_UNKNOWN = 0,
282 ZFS_DELEG_USER = 'u',
283 ZFS_DELEG_USER_SETS = 'U',
284 ZFS_DELEG_GROUP = 'g',
285 ZFS_DELEG_GROUP_SETS = 'G',
286 ZFS_DELEG_EVERYONE = 'e',
287 ZFS_DELEG_EVERYONE_SETS = 'E',
288 ZFS_DELEG_CREATE = 'c',
289 ZFS_DELEG_CREATE_SETS = 'C',
290 ZFS_DELEG_NAMED_SET = 's',
291 ZFS_DELEG_NAMED_SET_SETS = 'S'
292 } zfs_deleg_who_type_t;
296 ZFS_DELEG_PERM_LOCAL = 1,
297 ZFS_DELEG_PERM_DESCENDENT = 2,
298 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
299 ZFS_DELEG_PERM_CREATE = 4
300 } zfs_deleg_inherit_t;
302 #define ZFS_DELEG_PERM_UID "uid"
303 #define ZFS_DELEG_PERM_GID "gid"
304 #define ZFS_DELEG_PERM_GROUPS "groups"
306 #define ZFS_MLSLABEL_DEFAULT "none"
308 #define ZFS_SMB_ACL_SRC "src"
309 #define ZFS_SMB_ACL_TARGET "target"
312 ZFS_CANMOUNT_OFF = 0,
314 ZFS_CANMOUNT_NOAUTO = 2
315 } zfs_canmount_type_t;
318 ZFS_LOGBIAS_LATENCY = 0,
319 ZFS_LOGBIAS_THROUGHPUT = 1
322 typedef enum zfs_share_op {
329 typedef enum zfs_smb_acl_op {
336 typedef enum zfs_cache_type {
338 ZFS_CACHE_METADATA = 1,
343 ZFS_SYNC_STANDARD = 0,
345 ZFS_SYNC_DISABLED = 2
349 ZFS_VOLMODE_DEFAULT = 0,
350 ZFS_VOLMODE_GEOM = 1,
356 ZFS_REDUNDANT_METADATA_ALL,
357 ZFS_REDUNDANT_METADATA_MOST
358 } zfs_redundant_metadata_type_t;
361 * On-disk version number.
363 #define SPA_VERSION_1 1ULL
364 #define SPA_VERSION_2 2ULL
365 #define SPA_VERSION_3 3ULL
366 #define SPA_VERSION_4 4ULL
367 #define SPA_VERSION_5 5ULL
368 #define SPA_VERSION_6 6ULL
369 #define SPA_VERSION_7 7ULL
370 #define SPA_VERSION_8 8ULL
371 #define SPA_VERSION_9 9ULL
372 #define SPA_VERSION_10 10ULL
373 #define SPA_VERSION_11 11ULL
374 #define SPA_VERSION_12 12ULL
375 #define SPA_VERSION_13 13ULL
376 #define SPA_VERSION_14 14ULL
377 #define SPA_VERSION_15 15ULL
378 #define SPA_VERSION_16 16ULL
379 #define SPA_VERSION_17 17ULL
380 #define SPA_VERSION_18 18ULL
381 #define SPA_VERSION_19 19ULL
382 #define SPA_VERSION_20 20ULL
383 #define SPA_VERSION_21 21ULL
384 #define SPA_VERSION_22 22ULL
385 #define SPA_VERSION_23 23ULL
386 #define SPA_VERSION_24 24ULL
387 #define SPA_VERSION_25 25ULL
388 #define SPA_VERSION_26 26ULL
389 #define SPA_VERSION_27 27ULL
390 #define SPA_VERSION_28 28ULL
391 #define SPA_VERSION_5000 5000ULL
394 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
395 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
396 * and do the appropriate changes. Also bump the version number in
397 * usr/src/grub/capability.
399 #define SPA_VERSION SPA_VERSION_5000
400 #define SPA_VERSION_STRING "5000"
403 * Symbolic names for the changes that caused a SPA_VERSION switch.
404 * Used in the code when checking for presence or absence of a feature.
405 * Feel free to define multiple symbolic names for each version if there
406 * were multiple changes to on-disk structures during that version.
408 * NOTE: When checking the current SPA_VERSION in your code, be sure
409 * to use spa_version() since it reports the version of the
410 * last synced uberblock. Checking the in-flight version can
411 * be dangerous in some cases.
413 #define SPA_VERSION_INITIAL SPA_VERSION_1
414 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
415 #define SPA_VERSION_SPARES SPA_VERSION_3
416 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
417 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
418 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
419 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
420 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
421 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
422 #define SPA_VERSION_BOOTFS SPA_VERSION_6
423 #define SPA_VERSION_SLOGS SPA_VERSION_7
424 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
425 #define SPA_VERSION_FUID SPA_VERSION_9
426 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
427 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
428 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
429 #define SPA_VERSION_L2CACHE SPA_VERSION_10
430 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
431 #define SPA_VERSION_ORIGIN SPA_VERSION_11
432 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
433 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
434 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
435 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
436 #define SPA_VERSION_USERSPACE SPA_VERSION_15
437 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
438 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
439 #define SPA_VERSION_USERREFS SPA_VERSION_18
440 #define SPA_VERSION_HOLES SPA_VERSION_19
441 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
442 #define SPA_VERSION_DEDUP SPA_VERSION_21
443 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
444 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
445 #define SPA_VERSION_SA SPA_VERSION_24
446 #define SPA_VERSION_SCAN SPA_VERSION_25
447 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
448 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
449 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
450 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
451 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
452 #define SPA_VERSION_FEATURES SPA_VERSION_5000
454 #define SPA_VERSION_IS_SUPPORTED(v) \
455 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
456 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
459 * ZPL version - rev'd whenever an incompatible on-disk format change
460 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
461 * also update the version_table[] and help message in zfs_prop.c.
463 * When changing, be sure to teach GRUB how to read the new format!
464 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
466 #define ZPL_VERSION_1 1ULL
467 #define ZPL_VERSION_2 2ULL
468 #define ZPL_VERSION_3 3ULL
469 #define ZPL_VERSION_4 4ULL
470 #define ZPL_VERSION_5 5ULL
471 #define ZPL_VERSION ZPL_VERSION_5
472 #define ZPL_VERSION_STRING "5"
474 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
475 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
476 #define ZPL_VERSION_FUID ZPL_VERSION_3
477 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
478 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
479 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
480 #define ZPL_VERSION_SA ZPL_VERSION_5
482 /* Rewind request information */
483 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
484 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
485 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
486 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
487 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
488 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
489 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
491 typedef struct zpool_rewind_policy {
492 uint32_t zrp_request; /* rewind behavior requested */
493 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
494 uint64_t zrp_maxdata; /* max acceptable data errors */
495 uint64_t zrp_txg; /* specific txg to load */
496 } zpool_rewind_policy_t;
499 * The following are configuration names used in the nvlist describing a pool's
502 #define ZPOOL_CONFIG_VERSION "version"
503 #define ZPOOL_CONFIG_POOL_NAME "name"
504 #define ZPOOL_CONFIG_POOL_STATE "state"
505 #define ZPOOL_CONFIG_POOL_TXG "txg"
506 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
507 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
508 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
509 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
510 #define ZPOOL_CONFIG_TYPE "type"
511 #define ZPOOL_CONFIG_CHILDREN "children"
512 #define ZPOOL_CONFIG_ID "id"
513 #define ZPOOL_CONFIG_GUID "guid"
514 #define ZPOOL_CONFIG_PATH "path"
515 #define ZPOOL_CONFIG_DEVID "devid"
516 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
517 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
518 #define ZPOOL_CONFIG_ASHIFT "ashift"
519 #define ZPOOL_CONFIG_ASIZE "asize"
520 #define ZPOOL_CONFIG_DTL "DTL"
521 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
522 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
523 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
524 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
525 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
526 #define ZPOOL_CONFIG_SPARES "spares"
527 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
528 #define ZPOOL_CONFIG_NPARITY "nparity"
529 #define ZPOOL_CONFIG_HOSTID "hostid"
530 #define ZPOOL_CONFIG_HOSTNAME "hostname"
531 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
532 #define ZPOOL_CONFIG_UNSPARE "unspare"
533 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
534 #define ZPOOL_CONFIG_IS_LOG "is_log"
535 #define ZPOOL_CONFIG_L2CACHE "l2cache"
536 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
537 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
538 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
539 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
540 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
541 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
542 #define ZPOOL_CONFIG_SPLIT "splitcfg"
543 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
544 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
545 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
546 #define ZPOOL_CONFIG_REMOVING "removing"
547 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
548 #define ZPOOL_CONFIG_COMMENT "comment"
549 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
550 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
551 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
552 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
553 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
554 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
555 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
556 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
557 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
558 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
559 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
561 * The persistent vdev state is stored as separate values rather than a single
562 * 'vdev_state' entry. This is because a device can be in multiple states, such
563 * as offline and degraded.
565 #define ZPOOL_CONFIG_OFFLINE "offline"
566 #define ZPOOL_CONFIG_FAULTED "faulted"
567 #define ZPOOL_CONFIG_DEGRADED "degraded"
568 #define ZPOOL_CONFIG_REMOVED "removed"
569 #define ZPOOL_CONFIG_FRU "fru"
570 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
572 /* Rewind policy parameters */
573 #define ZPOOL_REWIND_POLICY "rewind-policy"
574 #define ZPOOL_REWIND_REQUEST "rewind-request"
575 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
576 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
577 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
579 /* Rewind data discovered */
580 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
581 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
582 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
584 #define VDEV_TYPE_ROOT "root"
585 #define VDEV_TYPE_MIRROR "mirror"
586 #define VDEV_TYPE_REPLACING "replacing"
587 #define VDEV_TYPE_RAIDZ "raidz"
588 #define VDEV_TYPE_DISK "disk"
589 #define VDEV_TYPE_FILE "file"
590 #define VDEV_TYPE_MISSING "missing"
591 #define VDEV_TYPE_HOLE "hole"
592 #define VDEV_TYPE_SPARE "spare"
593 #define VDEV_TYPE_LOG "log"
594 #define VDEV_TYPE_L2CACHE "l2cache"
597 * This is needed in userland to report the minimum necessary device size.
599 #define SPA_MINDEVSIZE (64ULL << 20)
602 * The location of the pool configuration repository, shared between kernel and
605 #define ZPOOL_CACHE "/boot/zfs/zpool.cache"
608 * vdev states are ordered from least to most healthy.
609 * A vdev that's CANT_OPEN or below is considered unusable.
611 typedef enum vdev_state {
612 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
613 VDEV_STATE_CLOSED, /* Not currently open */
614 VDEV_STATE_OFFLINE, /* Not allowed to open */
615 VDEV_STATE_REMOVED, /* Explicitly removed from system */
616 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
617 VDEV_STATE_FAULTED, /* External request to fault device */
618 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
619 VDEV_STATE_HEALTHY /* Presumed good */
622 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
625 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
626 * of the vdev stats structure uses these constants to distinguish why.
628 typedef enum vdev_aux {
629 VDEV_AUX_NONE, /* no error */
630 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
631 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
632 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
633 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
634 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
635 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
636 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
637 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
638 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
639 VDEV_AUX_SPARED, /* hot spare used in another pool */
640 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
641 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
642 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
643 VDEV_AUX_EXTERNAL, /* external diagnosis */
644 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */
645 VDEV_AUX_ASHIFT_TOO_BIG /* vdev's min block size is too large */
649 * pool state. The following states are written to disk as part of the normal
650 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
651 * states are software abstractions used at various levels to communicate
654 typedef enum pool_state {
655 POOL_STATE_ACTIVE = 0, /* In active use */
656 POOL_STATE_EXPORTED, /* Explicitly exported */
657 POOL_STATE_DESTROYED, /* Explicitly destroyed */
658 POOL_STATE_SPARE, /* Reserved for hot spare use */
659 POOL_STATE_L2CACHE, /* Level 2 ARC device */
660 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
661 POOL_STATE_UNAVAIL, /* Internal libzfs state */
662 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
668 typedef enum pool_scan_func {
676 * ZIO types. Needed to interpret vdev statistics below.
678 typedef enum zio_type {
689 * Pool statistics. Note: all fields should be 64-bit because this
690 * is passed between kernel and userland as an nvlist uint64 array.
692 typedef struct pool_scan_stat {
693 /* values stored on disk */
694 uint64_t pss_func; /* pool_scan_func_t */
695 uint64_t pss_state; /* dsl_scan_state_t */
696 uint64_t pss_start_time; /* scan start time */
697 uint64_t pss_end_time; /* scan end time */
698 uint64_t pss_to_examine; /* total bytes to scan */
699 uint64_t pss_examined; /* total examined bytes */
700 uint64_t pss_to_process; /* total bytes to process */
701 uint64_t pss_processed; /* total processed bytes */
702 uint64_t pss_errors; /* scan errors */
704 /* values not stored on disk */
705 uint64_t pss_pass_exam; /* examined bytes per scan pass */
706 uint64_t pss_pass_start; /* start time of a scan pass */
709 typedef enum dsl_scan_state {
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 */
739 uint64_t vs_configured_ashift; /* TLV vdev_ashift */
740 uint64_t vs_logical_ashift; /* vdev_logical_ashift */
741 uint64_t vs_physical_ashift; /* vdev_physical_ashift */
743 #define VDEV_STAT_VALID(field, uint64_t_field_count) \
744 ((uint64_t_field_count * sizeof(uint64_t)) >= \
745 (offsetof(vdev_stat_t, field) + sizeof(((vdev_stat_t *)NULL)->field)))
748 * DDT statistics. Note: all fields should be 64-bit because this
749 * is passed between kernel and userland as an nvlist uint64 array.
751 typedef struct ddt_object {
752 uint64_t ddo_count; /* number of elments in ddt */
753 uint64_t ddo_dspace; /* size of ddt on disk */
754 uint64_t ddo_mspace; /* size of ddt in-core */
757 typedef struct ddt_stat {
758 uint64_t dds_blocks; /* blocks */
759 uint64_t dds_lsize; /* logical size */
760 uint64_t dds_psize; /* physical size */
761 uint64_t dds_dsize; /* deflated allocated size */
762 uint64_t dds_ref_blocks; /* referenced blocks */
763 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
764 uint64_t dds_ref_psize; /* referenced psize * refcnt */
765 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
768 typedef struct ddt_histogram {
769 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
772 #define ZVOL_DRIVER "zvol"
773 #define ZFS_DRIVER "zfs"
774 #define ZFS_DEV_NAME "zfs"
775 #define ZFS_DEV "/dev/" ZFS_DEV_NAME
777 /* general zvol path */
778 #define ZVOL_DIR "/dev/zvol"
780 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
781 /* for dump and swap */
782 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
783 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
785 #define ZVOL_PROP_NAME "name"
786 #define ZVOL_DEFAULT_BLOCKSIZE 8192
789 * /dev/zfs ioctl numbers.
791 typedef enum zfs_ioc {
793 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
794 ZFS_IOC_POOL_DESTROY,
797 ZFS_IOC_POOL_CONFIGS,
799 ZFS_IOC_POOL_TRYIMPORT,
802 ZFS_IOC_POOL_UPGRADE,
803 ZFS_IOC_POOL_GET_HISTORY,
806 ZFS_IOC_VDEV_SET_STATE,
809 ZFS_IOC_VDEV_SETPATH,
811 ZFS_IOC_OBJSET_STATS,
812 ZFS_IOC_OBJSET_ZPLPROPS,
813 ZFS_IOC_DATASET_LIST_NEXT,
814 ZFS_IOC_SNAPSHOT_LIST_NEXT,
822 ZFS_IOC_INJECT_FAULT,
824 ZFS_IOC_INJECT_LIST_NEXT,
828 ZFS_IOC_DESTROY_SNAPS,
830 ZFS_IOC_DSOBJ_TO_DSNAME,
832 ZFS_IOC_POOL_SET_PROPS,
833 ZFS_IOC_POOL_GET_PROPS,
837 ZFS_IOC_INHERIT_PROP,
839 ZFS_IOC_USERSPACE_ONE,
840 ZFS_IOC_USERSPACE_MANY,
841 ZFS_IOC_USERSPACE_UPGRADE,
845 ZFS_IOC_OBJSET_RECVD_PROPS,
849 ZFS_IOC_TMP_SNAPSHOT,
850 ZFS_IOC_OBJ_TO_STATS,
854 ZFS_IOC_SPACE_WRITTEN,
856 ZFS_IOC_SEND_PROGRESS,
863 ZFS_IOC_GET_BOOKMARKS,
864 ZFS_IOC_DESTROY_BOOKMARKS,
869 * Internal SPA load state. Used by FMA diagnosis engine.
872 SPA_LOAD_NONE, /* no load in progress */
873 SPA_LOAD_OPEN, /* normal open */
874 SPA_LOAD_IMPORT, /* import in progress */
875 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
876 SPA_LOAD_RECOVER, /* recovery requested */
877 SPA_LOAD_ERROR /* load failed */
881 * Bookmark name values.
883 #define ZPOOL_ERR_LIST "error list"
884 #define ZPOOL_ERR_DATASET "dataset"
885 #define ZPOOL_ERR_OBJECT "object"
887 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
890 * The following are names used in the nvlist describing
891 * the pool's history log.
893 #define ZPOOL_HIST_RECORD "history record"
894 #define ZPOOL_HIST_TIME "history time"
895 #define ZPOOL_HIST_CMD "history command"
896 #define ZPOOL_HIST_WHO "history who"
897 #define ZPOOL_HIST_ZONE "history zone"
898 #define ZPOOL_HIST_HOST "history hostname"
899 #define ZPOOL_HIST_TXG "history txg"
900 #define ZPOOL_HIST_INT_EVENT "history internal event"
901 #define ZPOOL_HIST_INT_STR "history internal str"
902 #define ZPOOL_HIST_INT_NAME "internal_name"
903 #define ZPOOL_HIST_IOCTL "ioctl"
904 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
905 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
906 #define ZPOOL_HIST_DSNAME "dsname"
907 #define ZPOOL_HIST_DSID "dsid"
910 * Flags for ZFS_IOC_VDEV_SET_STATE
912 #define ZFS_ONLINE_CHECKREMOVE 0x1
913 #define ZFS_ONLINE_UNSPARE 0x2
914 #define ZFS_ONLINE_FORCEFAULT 0x4
915 #define ZFS_ONLINE_EXPAND 0x8
916 #define ZFS_OFFLINE_TEMPORARY 0x1
919 * Flags for ZFS_IOC_POOL_IMPORT
921 #define ZFS_IMPORT_NORMAL 0x0
922 #define ZFS_IMPORT_VERBATIM 0x1
923 #define ZFS_IMPORT_ANY_HOST 0x2
924 #define ZFS_IMPORT_MISSING_LOG 0x4
925 #define ZFS_IMPORT_ONLY 0x8
928 * Sysevent payload members. ZFS will generate the following sysevents with the
931 * ESC_ZFS_RESILVER_START
932 * ESC_ZFS_RESILVER_END
933 * ESC_ZFS_POOL_DESTROY
934 * ESC_ZFS_POOL_REGUID
936 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
937 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
939 * ESC_ZFS_VDEV_REMOVE
943 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
944 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
945 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
946 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
948 #define ZFS_EV_POOL_NAME "pool_name"
949 #define ZFS_EV_POOL_GUID "pool_guid"
950 #define ZFS_EV_VDEV_PATH "vdev_path"
951 #define ZFS_EV_VDEV_GUID "vdev_guid"
957 #endif /* _SYS_FS_ZFS_H */