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.
28 * Copyright (c) 2014 Integros [integros.com]
31 /* Portions Copyright 2010 Robert Milkowski */
36 #include <sys/types.h>
37 #include <sys/ioccom.h>
45 * Types and constants shared between userland and the kernel.
49 * Each dataset can be one of the following types. These constants can be
50 * combined into masks that can be passed to various functions.
53 ZFS_TYPE_FILESYSTEM = (1 << 0),
54 ZFS_TYPE_SNAPSHOT = (1 << 1),
55 ZFS_TYPE_VOLUME = (1 << 2),
56 ZFS_TYPE_POOL = (1 << 3),
57 ZFS_TYPE_BOOKMARK = (1 << 4)
60 typedef enum dmu_objset_type {
65 DMU_OST_OTHER, /* For testing only! */
66 DMU_OST_ANY, /* Be careful! */
70 #define ZFS_TYPE_DATASET \
71 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
73 #define ZAP_MAXNAMELEN 256
74 #define ZAP_MAXVALUELEN (1024 * 8)
75 #define ZAP_OLDMAXVALUELEN 1024
78 * Dataset properties are identified by these constants and must be added to
79 * the end of this list to ensure that external consumers are not affected
80 * by the change. If you make any changes to this list, be sure to update
81 * the property table in usr/src/common/zfs/zfs_prop.c.
89 ZFS_PROP_COMPRESSRATIO,
95 ZFS_PROP_VOLBLOCKSIZE,
100 ZFS_PROP_COMPRESSION,
110 ZFS_PROP_CREATETXG, /* not exposed to the user */
111 ZFS_PROP_NAME, /* not exposed to the user */
113 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
115 ZFS_PROP_NUMCLONES, /* not exposed to the user */
125 ZFS_PROP_REFRESERVATION,
127 ZFS_PROP_PRIMARYCACHE,
128 ZFS_PROP_SECONDARYCACHE,
132 ZFS_PROP_USEDREFRESERV,
133 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
134 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
135 ZFS_PROP_DEFER_DESTROY,
138 ZFS_PROP_UNIQUE, /* not exposed to the user */
139 ZFS_PROP_OBJSETID, /* not exposed to the user */
146 ZFS_PROP_LOGICALUSED,
147 ZFS_PROP_LOGICALREFERENCED,
148 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
150 ZFS_PROP_FILESYSTEM_LIMIT,
151 ZFS_PROP_SNAPSHOT_LIMIT,
152 ZFS_PROP_FILESYSTEM_COUNT,
153 ZFS_PROP_SNAPSHOT_COUNT,
154 ZFS_PROP_REDUNDANT_METADATA,
156 ZFS_PROP_RECEIVE_RESUME_TOKEN,
165 ZFS_NUM_USERQUOTA_PROPS
166 } zfs_userquota_prop_t;
168 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
171 * Pool properties are identified by these constants and must be added to the
172 * end of this list to ensure that external consumers are not affected
173 * by the change. If you make any changes to this list, be sure to update
174 * the property table in usr/src/common/zfs/zpool_prop.c.
185 ZPOOL_PROP_DELEGATION,
186 ZPOOL_PROP_AUTOREPLACE,
187 ZPOOL_PROP_CACHEFILE,
188 ZPOOL_PROP_FAILUREMODE,
189 ZPOOL_PROP_LISTSNAPS,
190 ZPOOL_PROP_AUTOEXPAND,
191 ZPOOL_PROP_DEDUPDITTO,
192 ZPOOL_PROP_DEDUPRATIO,
194 ZPOOL_PROP_ALLOCATED,
199 ZPOOL_PROP_FRAGMENTATION,
201 ZPOOL_PROP_MAXBLOCKSIZE,
205 /* Small enough to not hog a whole line of printout in zpool(1M). */
206 #define ZPROP_MAX_COMMENT 32
208 #define ZPROP_CONT -2
209 #define ZPROP_INVAL -1
211 #define ZPROP_VALUE "value"
212 #define ZPROP_SOURCE "source"
215 ZPROP_SRC_NONE = 0x1,
216 ZPROP_SRC_DEFAULT = 0x2,
217 ZPROP_SRC_TEMPORARY = 0x4,
218 ZPROP_SRC_LOCAL = 0x8,
219 ZPROP_SRC_INHERITED = 0x10,
220 ZPROP_SRC_RECEIVED = 0x20
223 #define ZPROP_SRC_ALL 0x3f
225 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
226 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
228 * Dataset flag implemented as a special entry in the props zap object
229 * indicating that the dataset has received properties on or after
230 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
231 * just as it did in earlier versions, and thereafter, local properties are
234 #define ZPROP_HAS_RECVD "$hasrecvd"
237 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
238 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
241 typedef int (*zprop_func)(int, void *);
244 * Properties to be set on the root file system of a new pool
245 * are stuffed into their own nvlist, which is then included in
246 * the properties nvlist with the pool properties.
248 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
251 * Dataset property functions shared between libzfs and kernel.
253 const char *zfs_prop_default_string(zfs_prop_t);
254 uint64_t zfs_prop_default_numeric(zfs_prop_t);
255 boolean_t zfs_prop_readonly(zfs_prop_t);
256 boolean_t zfs_prop_inheritable(zfs_prop_t);
257 boolean_t zfs_prop_setonce(zfs_prop_t);
258 const char *zfs_prop_to_name(zfs_prop_t);
259 zfs_prop_t zfs_name_to_prop(const char *);
260 boolean_t zfs_prop_user(const char *);
261 boolean_t zfs_prop_userquota(const char *);
262 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
263 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
264 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
265 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
268 * Pool property functions shared between libzfs and kernel.
270 zpool_prop_t zpool_name_to_prop(const char *);
271 const char *zpool_prop_to_name(zpool_prop_t);
272 const char *zpool_prop_default_string(zpool_prop_t);
273 uint64_t zpool_prop_default_numeric(zpool_prop_t);
274 boolean_t zpool_prop_readonly(zpool_prop_t);
275 boolean_t zpool_prop_feature(const char *);
276 boolean_t zpool_prop_unsupported(const char *name);
277 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
278 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
279 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
282 * Definitions for the Delegation.
285 ZFS_DELEG_WHO_UNKNOWN = 0,
286 ZFS_DELEG_USER = 'u',
287 ZFS_DELEG_USER_SETS = 'U',
288 ZFS_DELEG_GROUP = 'g',
289 ZFS_DELEG_GROUP_SETS = 'G',
290 ZFS_DELEG_EVERYONE = 'e',
291 ZFS_DELEG_EVERYONE_SETS = 'E',
292 ZFS_DELEG_CREATE = 'c',
293 ZFS_DELEG_CREATE_SETS = 'C',
294 ZFS_DELEG_NAMED_SET = 's',
295 ZFS_DELEG_NAMED_SET_SETS = 'S'
296 } zfs_deleg_who_type_t;
300 ZFS_DELEG_PERM_LOCAL = 1,
301 ZFS_DELEG_PERM_DESCENDENT = 2,
302 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
303 ZFS_DELEG_PERM_CREATE = 4
304 } zfs_deleg_inherit_t;
306 #define ZFS_DELEG_PERM_UID "uid"
307 #define ZFS_DELEG_PERM_GID "gid"
308 #define ZFS_DELEG_PERM_GROUPS "groups"
310 #define ZFS_MLSLABEL_DEFAULT "none"
312 #define ZFS_SMB_ACL_SRC "src"
313 #define ZFS_SMB_ACL_TARGET "target"
316 ZFS_CANMOUNT_OFF = 0,
318 ZFS_CANMOUNT_NOAUTO = 2
319 } zfs_canmount_type_t;
322 ZFS_LOGBIAS_LATENCY = 0,
323 ZFS_LOGBIAS_THROUGHPUT = 1
326 typedef enum zfs_share_op {
333 typedef enum zfs_smb_acl_op {
340 typedef enum zfs_cache_type {
342 ZFS_CACHE_METADATA = 1,
347 ZFS_SYNC_STANDARD = 0,
349 ZFS_SYNC_DISABLED = 2
353 ZFS_VOLMODE_DEFAULT = 0,
354 ZFS_VOLMODE_GEOM = 1,
360 ZFS_REDUNDANT_METADATA_ALL,
361 ZFS_REDUNDANT_METADATA_MOST
362 } zfs_redundant_metadata_type_t;
365 * On-disk version number.
367 #define SPA_VERSION_1 1ULL
368 #define SPA_VERSION_2 2ULL
369 #define SPA_VERSION_3 3ULL
370 #define SPA_VERSION_4 4ULL
371 #define SPA_VERSION_5 5ULL
372 #define SPA_VERSION_6 6ULL
373 #define SPA_VERSION_7 7ULL
374 #define SPA_VERSION_8 8ULL
375 #define SPA_VERSION_9 9ULL
376 #define SPA_VERSION_10 10ULL
377 #define SPA_VERSION_11 11ULL
378 #define SPA_VERSION_12 12ULL
379 #define SPA_VERSION_13 13ULL
380 #define SPA_VERSION_14 14ULL
381 #define SPA_VERSION_15 15ULL
382 #define SPA_VERSION_16 16ULL
383 #define SPA_VERSION_17 17ULL
384 #define SPA_VERSION_18 18ULL
385 #define SPA_VERSION_19 19ULL
386 #define SPA_VERSION_20 20ULL
387 #define SPA_VERSION_21 21ULL
388 #define SPA_VERSION_22 22ULL
389 #define SPA_VERSION_23 23ULL
390 #define SPA_VERSION_24 24ULL
391 #define SPA_VERSION_25 25ULL
392 #define SPA_VERSION_26 26ULL
393 #define SPA_VERSION_27 27ULL
394 #define SPA_VERSION_28 28ULL
395 #define SPA_VERSION_5000 5000ULL
398 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
399 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
400 * and do the appropriate changes. Also bump the version number in
401 * usr/src/grub/capability.
403 #define SPA_VERSION SPA_VERSION_5000
404 #define SPA_VERSION_STRING "5000"
407 * Symbolic names for the changes that caused a SPA_VERSION switch.
408 * Used in the code when checking for presence or absence of a feature.
409 * Feel free to define multiple symbolic names for each version if there
410 * were multiple changes to on-disk structures during that version.
412 * NOTE: When checking the current SPA_VERSION in your code, be sure
413 * to use spa_version() since it reports the version of the
414 * last synced uberblock. Checking the in-flight version can
415 * be dangerous in some cases.
417 #define SPA_VERSION_INITIAL SPA_VERSION_1
418 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
419 #define SPA_VERSION_SPARES SPA_VERSION_3
420 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
421 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
422 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
423 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
424 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
425 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
426 #define SPA_VERSION_BOOTFS SPA_VERSION_6
427 #define SPA_VERSION_SLOGS SPA_VERSION_7
428 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
429 #define SPA_VERSION_FUID SPA_VERSION_9
430 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
431 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
432 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
433 #define SPA_VERSION_L2CACHE SPA_VERSION_10
434 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
435 #define SPA_VERSION_ORIGIN SPA_VERSION_11
436 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
437 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
438 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
439 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
440 #define SPA_VERSION_USERSPACE SPA_VERSION_15
441 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
442 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
443 #define SPA_VERSION_USERREFS SPA_VERSION_18
444 #define SPA_VERSION_HOLES SPA_VERSION_19
445 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
446 #define SPA_VERSION_DEDUP SPA_VERSION_21
447 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
448 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
449 #define SPA_VERSION_SA SPA_VERSION_24
450 #define SPA_VERSION_SCAN SPA_VERSION_25
451 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
452 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
453 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
454 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
455 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
456 #define SPA_VERSION_FEATURES SPA_VERSION_5000
458 #define SPA_VERSION_IS_SUPPORTED(v) \
459 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
460 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
463 * ZPL version - rev'd whenever an incompatible on-disk format change
464 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
465 * also update the version_table[] and help message in zfs_prop.c.
467 * When changing, be sure to teach GRUB how to read the new format!
468 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
470 #define ZPL_VERSION_1 1ULL
471 #define ZPL_VERSION_2 2ULL
472 #define ZPL_VERSION_3 3ULL
473 #define ZPL_VERSION_4 4ULL
474 #define ZPL_VERSION_5 5ULL
475 #define ZPL_VERSION ZPL_VERSION_5
476 #define ZPL_VERSION_STRING "5"
478 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
479 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
480 #define ZPL_VERSION_FUID ZPL_VERSION_3
481 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
482 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
483 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
484 #define ZPL_VERSION_SA ZPL_VERSION_5
486 /* Rewind request information */
487 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
488 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
489 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
490 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
491 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
492 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
493 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
495 typedef struct zpool_rewind_policy {
496 uint32_t zrp_request; /* rewind behavior requested */
497 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
498 uint64_t zrp_maxdata; /* max acceptable data errors */
499 uint64_t zrp_txg; /* specific txg to load */
500 } zpool_rewind_policy_t;
503 * The following are configuration names used in the nvlist describing a pool's
506 #define ZPOOL_CONFIG_VERSION "version"
507 #define ZPOOL_CONFIG_POOL_NAME "name"
508 #define ZPOOL_CONFIG_POOL_STATE "state"
509 #define ZPOOL_CONFIG_POOL_TXG "txg"
510 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
511 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
512 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
513 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
514 #define ZPOOL_CONFIG_TYPE "type"
515 #define ZPOOL_CONFIG_CHILDREN "children"
516 #define ZPOOL_CONFIG_ID "id"
517 #define ZPOOL_CONFIG_GUID "guid"
518 #define ZPOOL_CONFIG_PATH "path"
519 #define ZPOOL_CONFIG_DEVID "devid"
520 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
521 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
522 #define ZPOOL_CONFIG_ASHIFT "ashift"
523 #define ZPOOL_CONFIG_ASIZE "asize"
524 #define ZPOOL_CONFIG_DTL "DTL"
525 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
526 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
527 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
528 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
529 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
530 #define ZPOOL_CONFIG_SPARES "spares"
531 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
532 #define ZPOOL_CONFIG_NPARITY "nparity"
533 #define ZPOOL_CONFIG_HOSTID "hostid"
534 #define ZPOOL_CONFIG_HOSTNAME "hostname"
535 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
536 #define ZPOOL_CONFIG_UNSPARE "unspare"
537 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
538 #define ZPOOL_CONFIG_IS_LOG "is_log"
539 #define ZPOOL_CONFIG_L2CACHE "l2cache"
540 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
541 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
542 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
543 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
544 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
545 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
546 #define ZPOOL_CONFIG_SPLIT "splitcfg"
547 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
548 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
549 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
550 #define ZPOOL_CONFIG_REMOVING "removing"
551 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
552 #define ZPOOL_CONFIG_COMMENT "comment"
553 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
554 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
555 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
556 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
557 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
558 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
559 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
560 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
561 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
562 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
563 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
565 * The persistent vdev state is stored as separate values rather than a single
566 * 'vdev_state' entry. This is because a device can be in multiple states, such
567 * as offline and degraded.
569 #define ZPOOL_CONFIG_OFFLINE "offline"
570 #define ZPOOL_CONFIG_FAULTED "faulted"
571 #define ZPOOL_CONFIG_DEGRADED "degraded"
572 #define ZPOOL_CONFIG_REMOVED "removed"
573 #define ZPOOL_CONFIG_FRU "fru"
574 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
576 /* Rewind policy parameters */
577 #define ZPOOL_REWIND_POLICY "rewind-policy"
578 #define ZPOOL_REWIND_REQUEST "rewind-request"
579 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
580 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
581 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
583 /* Rewind data discovered */
584 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
585 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
586 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
588 #define VDEV_TYPE_ROOT "root"
589 #define VDEV_TYPE_MIRROR "mirror"
590 #define VDEV_TYPE_REPLACING "replacing"
591 #define VDEV_TYPE_RAIDZ "raidz"
592 #define VDEV_TYPE_DISK "disk"
593 #define VDEV_TYPE_FILE "file"
594 #define VDEV_TYPE_MISSING "missing"
595 #define VDEV_TYPE_HOLE "hole"
596 #define VDEV_TYPE_SPARE "spare"
597 #define VDEV_TYPE_LOG "log"
598 #define VDEV_TYPE_L2CACHE "l2cache"
601 * This is needed in userland to report the minimum necessary device size.
603 #define SPA_MINDEVSIZE (64ULL << 20)
606 * Set if the fragmentation has not yet been calculated. This can happen
607 * because the space maps have not been upgraded or the histogram feature
610 #define ZFS_FRAG_INVALID UINT64_MAX
613 * The location of the pool configuration repository, shared between kernel and
616 #define ZPOOL_CACHE "/boot/zfs/zpool.cache"
619 * vdev states are ordered from least to most healthy.
620 * A vdev that's CANT_OPEN or below is considered unusable.
622 typedef enum vdev_state {
623 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
624 VDEV_STATE_CLOSED, /* Not currently open */
625 VDEV_STATE_OFFLINE, /* Not allowed to open */
626 VDEV_STATE_REMOVED, /* Explicitly removed from system */
627 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
628 VDEV_STATE_FAULTED, /* External request to fault device */
629 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
630 VDEV_STATE_HEALTHY /* Presumed good */
633 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
636 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
637 * of the vdev stats structure uses these constants to distinguish why.
639 typedef enum vdev_aux {
640 VDEV_AUX_NONE, /* no error */
641 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
642 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
643 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
644 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
645 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
646 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
647 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
648 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
649 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
650 VDEV_AUX_SPARED, /* hot spare used in another pool */
651 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
652 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
653 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
654 VDEV_AUX_EXTERNAL, /* external diagnosis */
655 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */
656 VDEV_AUX_ASHIFT_TOO_BIG /* vdev's min block size is too large */
660 * pool state. The following states are written to disk as part of the normal
661 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
662 * states are software abstractions used at various levels to communicate
665 typedef enum pool_state {
666 POOL_STATE_ACTIVE = 0, /* In active use */
667 POOL_STATE_EXPORTED, /* Explicitly exported */
668 POOL_STATE_DESTROYED, /* Explicitly destroyed */
669 POOL_STATE_SPARE, /* Reserved for hot spare use */
670 POOL_STATE_L2CACHE, /* Level 2 ARC device */
671 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
672 POOL_STATE_UNAVAIL, /* Internal libzfs state */
673 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
679 typedef enum pool_scan_func {
687 * ZIO types. Needed to interpret vdev statistics below.
689 typedef enum zio_type {
700 * Pool statistics. Note: all fields should be 64-bit because this
701 * is passed between kernel and userland as an nvlist uint64 array.
703 typedef struct pool_scan_stat {
704 /* values stored on disk */
705 uint64_t pss_func; /* pool_scan_func_t */
706 uint64_t pss_state; /* dsl_scan_state_t */
707 uint64_t pss_start_time; /* scan start time */
708 uint64_t pss_end_time; /* scan end time */
709 uint64_t pss_to_examine; /* total bytes to scan */
710 uint64_t pss_examined; /* total examined bytes */
711 uint64_t pss_to_process; /* total bytes to process */
712 uint64_t pss_processed; /* total processed bytes */
713 uint64_t pss_errors; /* scan errors */
715 /* values not stored on disk */
716 uint64_t pss_pass_exam; /* examined bytes per scan pass */
717 uint64_t pss_pass_start; /* start time of a scan pass */
720 typedef enum dsl_scan_state {
730 * Vdev statistics. Note: all fields should be 64-bit because this
731 * is passed between kernel and userland as an nvlist uint64 array.
733 typedef struct vdev_stat {
734 hrtime_t vs_timestamp; /* time since vdev load */
735 uint64_t vs_state; /* vdev state */
736 uint64_t vs_aux; /* see vdev_aux_t */
737 uint64_t vs_alloc; /* space allocated */
738 uint64_t vs_space; /* total capacity */
739 uint64_t vs_dspace; /* deflated capacity */
740 uint64_t vs_rsize; /* replaceable dev size */
741 uint64_t vs_esize; /* expandable dev size */
742 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
743 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
744 uint64_t vs_read_errors; /* read errors */
745 uint64_t vs_write_errors; /* write errors */
746 uint64_t vs_checksum_errors; /* checksum errors */
747 uint64_t vs_self_healed; /* self-healed bytes */
748 uint64_t vs_scan_removing; /* removing? */
749 uint64_t vs_scan_processed; /* scan processed bytes */
750 uint64_t vs_configured_ashift; /* TLV vdev_ashift */
751 uint64_t vs_logical_ashift; /* vdev_logical_ashift */
752 uint64_t vs_physical_ashift; /* vdev_physical_ashift */
753 uint64_t vs_fragmentation; /* device fragmentation */
755 #define VDEV_STAT_VALID(field, uint64_t_field_count) \
756 ((uint64_t_field_count * sizeof(uint64_t)) >= \
757 (offsetof(vdev_stat_t, field) + sizeof(((vdev_stat_t *)NULL)->field)))
760 * DDT statistics. Note: all fields should be 64-bit because this
761 * is passed between kernel and userland as an nvlist uint64 array.
763 typedef struct ddt_object {
764 uint64_t ddo_count; /* number of elments in ddt */
765 uint64_t ddo_dspace; /* size of ddt on disk */
766 uint64_t ddo_mspace; /* size of ddt in-core */
769 typedef struct ddt_stat {
770 uint64_t dds_blocks; /* blocks */
771 uint64_t dds_lsize; /* logical size */
772 uint64_t dds_psize; /* physical size */
773 uint64_t dds_dsize; /* deflated allocated size */
774 uint64_t dds_ref_blocks; /* referenced blocks */
775 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
776 uint64_t dds_ref_psize; /* referenced psize * refcnt */
777 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
780 typedef struct ddt_histogram {
781 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
784 #define ZVOL_DRIVER "zvol"
785 #define ZFS_DRIVER "zfs"
786 #define ZFS_DEV_NAME "zfs"
787 #define ZFS_DEV "/dev/" ZFS_DEV_NAME
789 /* general zvol path */
790 #define ZVOL_DIR "/dev/zvol"
792 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
793 /* for dump and swap */
794 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
795 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
797 #define ZVOL_PROP_NAME "name"
798 #define ZVOL_DEFAULT_BLOCKSIZE 8192
801 * /dev/zfs ioctl numbers.
803 typedef enum zfs_ioc {
805 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
806 ZFS_IOC_POOL_DESTROY,
809 ZFS_IOC_POOL_CONFIGS,
811 ZFS_IOC_POOL_TRYIMPORT,
814 ZFS_IOC_POOL_UPGRADE,
815 ZFS_IOC_POOL_GET_HISTORY,
818 ZFS_IOC_VDEV_SET_STATE,
821 ZFS_IOC_VDEV_SETPATH,
823 ZFS_IOC_OBJSET_STATS,
824 ZFS_IOC_OBJSET_ZPLPROPS,
825 ZFS_IOC_DATASET_LIST_NEXT,
826 ZFS_IOC_SNAPSHOT_LIST_NEXT,
834 ZFS_IOC_INJECT_FAULT,
836 ZFS_IOC_INJECT_LIST_NEXT,
840 ZFS_IOC_DESTROY_SNAPS,
842 ZFS_IOC_DSOBJ_TO_DSNAME,
844 ZFS_IOC_POOL_SET_PROPS,
845 ZFS_IOC_POOL_GET_PROPS,
849 ZFS_IOC_INHERIT_PROP,
851 ZFS_IOC_USERSPACE_ONE,
852 ZFS_IOC_USERSPACE_MANY,
853 ZFS_IOC_USERSPACE_UPGRADE,
857 ZFS_IOC_OBJSET_RECVD_PROPS,
861 ZFS_IOC_TMP_SNAPSHOT,
862 ZFS_IOC_OBJ_TO_STATS,
866 ZFS_IOC_SPACE_WRITTEN,
868 ZFS_IOC_SEND_PROGRESS,
875 ZFS_IOC_GET_BOOKMARKS,
876 ZFS_IOC_DESTROY_BOOKMARKS,
881 * Internal SPA load state. Used by FMA diagnosis engine.
884 SPA_LOAD_NONE, /* no load in progress */
885 SPA_LOAD_OPEN, /* normal open */
886 SPA_LOAD_IMPORT, /* import in progress */
887 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
888 SPA_LOAD_RECOVER, /* recovery requested */
889 SPA_LOAD_ERROR /* load failed */
893 * Bookmark name values.
895 #define ZPOOL_ERR_LIST "error list"
896 #define ZPOOL_ERR_DATASET "dataset"
897 #define ZPOOL_ERR_OBJECT "object"
899 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
902 * The following are names used in the nvlist describing
903 * the pool's history log.
905 #define ZPOOL_HIST_RECORD "history record"
906 #define ZPOOL_HIST_TIME "history time"
907 #define ZPOOL_HIST_CMD "history command"
908 #define ZPOOL_HIST_WHO "history who"
909 #define ZPOOL_HIST_ZONE "history zone"
910 #define ZPOOL_HIST_HOST "history hostname"
911 #define ZPOOL_HIST_TXG "history txg"
912 #define ZPOOL_HIST_INT_EVENT "history internal event"
913 #define ZPOOL_HIST_INT_STR "history internal str"
914 #define ZPOOL_HIST_INT_NAME "internal_name"
915 #define ZPOOL_HIST_IOCTL "ioctl"
916 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
917 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
918 #define ZPOOL_HIST_DSNAME "dsname"
919 #define ZPOOL_HIST_DSID "dsid"
922 * Flags for ZFS_IOC_VDEV_SET_STATE
924 #define ZFS_ONLINE_CHECKREMOVE 0x1
925 #define ZFS_ONLINE_UNSPARE 0x2
926 #define ZFS_ONLINE_FORCEFAULT 0x4
927 #define ZFS_ONLINE_EXPAND 0x8
928 #define ZFS_OFFLINE_TEMPORARY 0x1
931 * Flags for ZFS_IOC_POOL_IMPORT
933 #define ZFS_IMPORT_NORMAL 0x0
934 #define ZFS_IMPORT_VERBATIM 0x1
935 #define ZFS_IMPORT_ANY_HOST 0x2
936 #define ZFS_IMPORT_MISSING_LOG 0x4
937 #define ZFS_IMPORT_ONLY 0x8
940 * Sysevent payload members. ZFS will generate the following sysevents with the
943 * ESC_ZFS_RESILVER_START
944 * ESC_ZFS_RESILVER_END
945 * ESC_ZFS_POOL_DESTROY
946 * ESC_ZFS_POOL_REGUID
948 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
949 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
951 * ESC_ZFS_VDEV_REMOVE
955 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
956 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
957 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
958 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
960 #define ZFS_EV_POOL_NAME "pool_name"
961 #define ZFS_EV_POOL_GUID "pool_guid"
962 #define ZFS_EV_VDEV_PATH "vdev_path"
963 #define ZFS_EV_VDEV_GUID "vdev_guid"
969 #endif /* _SYS_FS_ZFS_H */