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) 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)
60 * NB: lzc_dataset_type should be updated whenever a new objset type is added,
61 * if it represents a real type of a dataset that can be created from userland.
63 typedef enum dmu_objset_type {
68 DMU_OST_OTHER, /* For testing only! */
69 DMU_OST_ANY, /* Be careful! */
73 #define ZFS_TYPE_DATASET \
74 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
76 #define ZAP_MAXNAMELEN 256
77 #define ZAP_MAXVALUELEN (1024 * 8)
78 #define ZAP_OLDMAXVALUELEN 1024
81 * Dataset properties are identified by these constants and must be added to
82 * the end of this list to ensure that external consumers are not affected
83 * by the change. If you make any changes to this list, be sure to update
84 * the property table in usr/src/common/zfs/zfs_prop.c.
92 ZFS_PROP_COMPRESSRATIO,
98 ZFS_PROP_VOLBLOCKSIZE,
103 ZFS_PROP_COMPRESSION,
113 ZFS_PROP_CREATETXG, /* not exposed to the user */
114 ZFS_PROP_NAME, /* not exposed to the user */
116 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
118 ZFS_PROP_NUMCLONES, /* not exposed to the user */
128 ZFS_PROP_REFRESERVATION,
130 ZFS_PROP_PRIMARYCACHE,
131 ZFS_PROP_SECONDARYCACHE,
135 ZFS_PROP_USEDREFRESERV,
136 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
137 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
138 ZFS_PROP_DEFER_DESTROY,
141 ZFS_PROP_UNIQUE, /* not exposed to the user */
142 ZFS_PROP_OBJSETID, /* not exposed to the user */
149 ZFS_PROP_LOGICALUSED,
150 ZFS_PROP_LOGICALREFERENCED,
151 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
152 ZFS_PROP_FILESYSTEM_LIMIT,
153 ZFS_PROP_SNAPSHOT_LIMIT,
154 ZFS_PROP_FILESYSTEM_COUNT,
155 ZFS_PROP_SNAPSHOT_COUNT,
164 ZFS_NUM_USERQUOTA_PROPS
165 } zfs_userquota_prop_t;
167 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
170 * Pool properties are identified by these constants and must be added to the
171 * end of this list to ensure that external consumers are not affected
172 * by the change. If you make any changes to this list, be sure to update
173 * the property table in usr/src/common/zfs/zpool_prop.c.
184 ZPOOL_PROP_DELEGATION,
185 ZPOOL_PROP_AUTOREPLACE,
186 ZPOOL_PROP_CACHEFILE,
187 ZPOOL_PROP_FAILUREMODE,
188 ZPOOL_PROP_LISTSNAPS,
189 ZPOOL_PROP_AUTOEXPAND,
190 ZPOOL_PROP_DEDUPDITTO,
191 ZPOOL_PROP_DEDUPRATIO,
193 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
350 * On-disk version number.
352 #define SPA_VERSION_1 1ULL
353 #define SPA_VERSION_2 2ULL
354 #define SPA_VERSION_3 3ULL
355 #define SPA_VERSION_4 4ULL
356 #define SPA_VERSION_5 5ULL
357 #define SPA_VERSION_6 6ULL
358 #define SPA_VERSION_7 7ULL
359 #define SPA_VERSION_8 8ULL
360 #define SPA_VERSION_9 9ULL
361 #define SPA_VERSION_10 10ULL
362 #define SPA_VERSION_11 11ULL
363 #define SPA_VERSION_12 12ULL
364 #define SPA_VERSION_13 13ULL
365 #define SPA_VERSION_14 14ULL
366 #define SPA_VERSION_15 15ULL
367 #define SPA_VERSION_16 16ULL
368 #define SPA_VERSION_17 17ULL
369 #define SPA_VERSION_18 18ULL
370 #define SPA_VERSION_19 19ULL
371 #define SPA_VERSION_20 20ULL
372 #define SPA_VERSION_21 21ULL
373 #define SPA_VERSION_22 22ULL
374 #define SPA_VERSION_23 23ULL
375 #define SPA_VERSION_24 24ULL
376 #define SPA_VERSION_25 25ULL
377 #define SPA_VERSION_26 26ULL
378 #define SPA_VERSION_27 27ULL
379 #define SPA_VERSION_28 28ULL
380 #define SPA_VERSION_5000 5000ULL
383 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
384 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
385 * and do the appropriate changes. Also bump the version number in
386 * usr/src/grub/capability.
388 #define SPA_VERSION SPA_VERSION_5000
389 #define SPA_VERSION_STRING "5000"
392 * Symbolic names for the changes that caused a SPA_VERSION switch.
393 * Used in the code when checking for presence or absence of a feature.
394 * Feel free to define multiple symbolic names for each version if there
395 * were multiple changes to on-disk structures during that version.
397 * NOTE: When checking the current SPA_VERSION in your code, be sure
398 * to use spa_version() since it reports the version of the
399 * last synced uberblock. Checking the in-flight version can
400 * be dangerous in some cases.
402 #define SPA_VERSION_INITIAL SPA_VERSION_1
403 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
404 #define SPA_VERSION_SPARES SPA_VERSION_3
405 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
406 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
407 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
408 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
409 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
410 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
411 #define SPA_VERSION_BOOTFS SPA_VERSION_6
412 #define SPA_VERSION_SLOGS SPA_VERSION_7
413 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
414 #define SPA_VERSION_FUID SPA_VERSION_9
415 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
416 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
417 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
418 #define SPA_VERSION_L2CACHE SPA_VERSION_10
419 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
420 #define SPA_VERSION_ORIGIN SPA_VERSION_11
421 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
422 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
423 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
424 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
425 #define SPA_VERSION_USERSPACE SPA_VERSION_15
426 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
427 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
428 #define SPA_VERSION_USERREFS SPA_VERSION_18
429 #define SPA_VERSION_HOLES SPA_VERSION_19
430 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
431 #define SPA_VERSION_DEDUP SPA_VERSION_21
432 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
433 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
434 #define SPA_VERSION_SA SPA_VERSION_24
435 #define SPA_VERSION_SCAN SPA_VERSION_25
436 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
437 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
438 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
439 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
440 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
441 #define SPA_VERSION_FEATURES SPA_VERSION_5000
443 #define SPA_VERSION_IS_SUPPORTED(v) \
444 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
445 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
448 * ZPL version - rev'd whenever an incompatible on-disk format change
449 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
450 * also update the version_table[] and help message in zfs_prop.c.
452 * When changing, be sure to teach GRUB how to read the new format!
453 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
455 #define ZPL_VERSION_1 1ULL
456 #define ZPL_VERSION_2 2ULL
457 #define ZPL_VERSION_3 3ULL
458 #define ZPL_VERSION_4 4ULL
459 #define ZPL_VERSION_5 5ULL
460 #define ZPL_VERSION ZPL_VERSION_5
461 #define ZPL_VERSION_STRING "5"
463 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
464 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
465 #define ZPL_VERSION_FUID ZPL_VERSION_3
466 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
467 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
468 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
469 #define ZPL_VERSION_SA ZPL_VERSION_5
471 /* Rewind request information */
472 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
473 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
474 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
475 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
476 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
477 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
478 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
480 typedef struct zpool_rewind_policy {
481 uint32_t zrp_request; /* rewind behavior requested */
482 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
483 uint64_t zrp_maxdata; /* max acceptable data errors */
484 uint64_t zrp_txg; /* specific txg to load */
485 } zpool_rewind_policy_t;
488 * The following are configuration names used in the nvlist describing a pool's
491 #define ZPOOL_CONFIG_VERSION "version"
492 #define ZPOOL_CONFIG_POOL_NAME "name"
493 #define ZPOOL_CONFIG_POOL_STATE "state"
494 #define ZPOOL_CONFIG_POOL_TXG "txg"
495 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
496 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
497 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
498 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
499 #define ZPOOL_CONFIG_TYPE "type"
500 #define ZPOOL_CONFIG_CHILDREN "children"
501 #define ZPOOL_CONFIG_ID "id"
502 #define ZPOOL_CONFIG_GUID "guid"
503 #define ZPOOL_CONFIG_PATH "path"
504 #define ZPOOL_CONFIG_DEVID "devid"
505 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
506 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
507 #define ZPOOL_CONFIG_ASHIFT "ashift"
508 #define ZPOOL_CONFIG_ASIZE "asize"
509 #define ZPOOL_CONFIG_DTL "DTL"
510 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
511 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
512 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
513 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
514 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
515 #define ZPOOL_CONFIG_SPARES "spares"
516 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
517 #define ZPOOL_CONFIG_NPARITY "nparity"
518 #define ZPOOL_CONFIG_HOSTID "hostid"
519 #define ZPOOL_CONFIG_HOSTNAME "hostname"
520 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
521 #define ZPOOL_CONFIG_UNSPARE "unspare"
522 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
523 #define ZPOOL_CONFIG_IS_LOG "is_log"
524 #define ZPOOL_CONFIG_L2CACHE "l2cache"
525 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
526 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
527 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
528 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
529 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
530 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
531 #define ZPOOL_CONFIG_SPLIT "splitcfg"
532 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
533 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
534 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
535 #define ZPOOL_CONFIG_REMOVING "removing"
536 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
537 #define ZPOOL_CONFIG_COMMENT "comment"
538 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
539 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
540 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
541 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
542 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
543 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
544 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
545 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
546 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
547 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
548 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
550 * The persistent vdev state is stored as separate values rather than a single
551 * 'vdev_state' entry. This is because a device can be in multiple states, such
552 * as offline and degraded.
554 #define ZPOOL_CONFIG_OFFLINE "offline"
555 #define ZPOOL_CONFIG_FAULTED "faulted"
556 #define ZPOOL_CONFIG_DEGRADED "degraded"
557 #define ZPOOL_CONFIG_REMOVED "removed"
558 #define ZPOOL_CONFIG_FRU "fru"
559 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
561 /* Rewind policy parameters */
562 #define ZPOOL_REWIND_POLICY "rewind-policy"
563 #define ZPOOL_REWIND_REQUEST "rewind-request"
564 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
565 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
566 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
568 /* Rewind data discovered */
569 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
570 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
571 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
573 #define VDEV_TYPE_ROOT "root"
574 #define VDEV_TYPE_MIRROR "mirror"
575 #define VDEV_TYPE_REPLACING "replacing"
576 #define VDEV_TYPE_RAIDZ "raidz"
577 #define VDEV_TYPE_DISK "disk"
578 #define VDEV_TYPE_FILE "file"
579 #define VDEV_TYPE_MISSING "missing"
580 #define VDEV_TYPE_HOLE "hole"
581 #define VDEV_TYPE_SPARE "spare"
582 #define VDEV_TYPE_LOG "log"
583 #define VDEV_TYPE_L2CACHE "l2cache"
586 * This is needed in userland to report the minimum necessary device size.
588 #define SPA_MINDEVSIZE (64ULL << 20)
591 * The location of the pool configuration repository, shared between kernel and
594 #define ZPOOL_CACHE "/boot/zfs/zpool.cache"
597 * vdev states are ordered from least to most healthy.
598 * A vdev that's CANT_OPEN or below is considered unusable.
600 typedef enum vdev_state {
601 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
602 VDEV_STATE_CLOSED, /* Not currently open */
603 VDEV_STATE_OFFLINE, /* Not allowed to open */
604 VDEV_STATE_REMOVED, /* Explicitly removed from system */
605 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
606 VDEV_STATE_FAULTED, /* External request to fault device */
607 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
608 VDEV_STATE_HEALTHY /* Presumed good */
611 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
614 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
615 * of the vdev stats structure uses these constants to distinguish why.
617 typedef enum vdev_aux {
618 VDEV_AUX_NONE, /* no error */
619 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
620 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
621 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
622 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
623 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
624 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
625 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
626 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
627 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
628 VDEV_AUX_SPARED, /* hot spare used in another pool */
629 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
630 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
631 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
632 VDEV_AUX_EXTERNAL, /* external diagnosis */
633 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */
634 VDEV_AUX_ASHIFT_TOO_BIG /* vdev's min block size is too large */
638 * pool state. The following states are written to disk as part of the normal
639 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
640 * states are software abstractions used at various levels to communicate
643 typedef enum pool_state {
644 POOL_STATE_ACTIVE = 0, /* In active use */
645 POOL_STATE_EXPORTED, /* Explicitly exported */
646 POOL_STATE_DESTROYED, /* Explicitly destroyed */
647 POOL_STATE_SPARE, /* Reserved for hot spare use */
648 POOL_STATE_L2CACHE, /* Level 2 ARC device */
649 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
650 POOL_STATE_UNAVAIL, /* Internal libzfs state */
651 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
657 typedef enum pool_scan_func {
665 * ZIO types. Needed to interpret vdev statistics below.
667 typedef enum zio_type {
678 * Pool statistics. Note: all fields should be 64-bit because this
679 * is passed between kernel and userland as an nvlist uint64 array.
681 typedef struct pool_scan_stat {
682 /* values stored on disk */
683 uint64_t pss_func; /* pool_scan_func_t */
684 uint64_t pss_state; /* dsl_scan_state_t */
685 uint64_t pss_start_time; /* scan start time */
686 uint64_t pss_end_time; /* scan end time */
687 uint64_t pss_to_examine; /* total bytes to scan */
688 uint64_t pss_examined; /* total examined bytes */
689 uint64_t pss_to_process; /* total bytes to process */
690 uint64_t pss_processed; /* total processed bytes */
691 uint64_t pss_errors; /* scan errors */
693 /* values not stored on disk */
694 uint64_t pss_pass_exam; /* examined bytes per scan pass */
695 uint64_t pss_pass_start; /* start time of a scan pass */
698 typedef enum dsl_scan_state {
708 * Vdev statistics. Note: all fields should be 64-bit because this
709 * is passed between kernel and userland as an nvlist uint64 array.
711 typedef struct vdev_stat {
712 hrtime_t vs_timestamp; /* time since vdev load */
713 uint64_t vs_state; /* vdev state */
714 uint64_t vs_aux; /* see vdev_aux_t */
715 uint64_t vs_alloc; /* space allocated */
716 uint64_t vs_space; /* total capacity */
717 uint64_t vs_dspace; /* deflated capacity */
718 uint64_t vs_rsize; /* replaceable dev size */
719 uint64_t vs_esize; /* expandable dev size */
720 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
721 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
722 uint64_t vs_read_errors; /* read errors */
723 uint64_t vs_write_errors; /* write errors */
724 uint64_t vs_checksum_errors; /* checksum errors */
725 uint64_t vs_self_healed; /* self-healed bytes */
726 uint64_t vs_scan_removing; /* removing? */
727 uint64_t vs_scan_processed; /* scan processed bytes */
728 uint64_t vs_configured_ashift; /* TLV vdev_ashift */
729 uint64_t vs_logical_ashift; /* vdev_logical_ashift */
730 uint64_t vs_physical_ashift; /* vdev_physical_ashift */
732 #define VDEV_STAT_VALID(field, uint64_t_field_count) \
733 ((uint64_t_field_count * sizeof(uint64_t)) >= \
734 (offsetof(vdev_stat_t, field) + sizeof(((vdev_stat_t *)NULL)->field)))
737 * DDT statistics. Note: all fields should be 64-bit because this
738 * is passed between kernel and userland as an nvlist uint64 array.
740 typedef struct ddt_object {
741 uint64_t ddo_count; /* number of elments in ddt */
742 uint64_t ddo_dspace; /* size of ddt on disk */
743 uint64_t ddo_mspace; /* size of ddt in-core */
746 typedef struct ddt_stat {
747 uint64_t dds_blocks; /* blocks */
748 uint64_t dds_lsize; /* logical size */
749 uint64_t dds_psize; /* physical size */
750 uint64_t dds_dsize; /* deflated allocated size */
751 uint64_t dds_ref_blocks; /* referenced blocks */
752 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
753 uint64_t dds_ref_psize; /* referenced psize * refcnt */
754 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
757 typedef struct ddt_histogram {
758 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
761 #define ZVOL_DRIVER "zvol"
762 #define ZFS_DRIVER "zfs"
763 #define ZFS_DEV_NAME "zfs"
764 #define ZFS_DEV "/dev/" ZFS_DEV_NAME
766 /* general zvol path */
767 #define ZVOL_DIR "/dev/zvol"
769 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
770 /* for dump and swap */
771 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
772 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
774 #define ZVOL_PROP_NAME "name"
775 #define ZVOL_DEFAULT_BLOCKSIZE 8192
778 * /dev/zfs ioctl numbers.
780 typedef enum zfs_ioc {
782 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
783 ZFS_IOC_POOL_DESTROY,
786 ZFS_IOC_POOL_CONFIGS,
788 ZFS_IOC_POOL_TRYIMPORT,
791 ZFS_IOC_POOL_UPGRADE,
792 ZFS_IOC_POOL_GET_HISTORY,
795 ZFS_IOC_VDEV_SET_STATE,
798 ZFS_IOC_VDEV_SETPATH,
800 ZFS_IOC_OBJSET_STATS,
801 ZFS_IOC_OBJSET_ZPLPROPS,
802 ZFS_IOC_DATASET_LIST_NEXT,
803 ZFS_IOC_SNAPSHOT_LIST_NEXT,
811 ZFS_IOC_INJECT_FAULT,
813 ZFS_IOC_INJECT_LIST_NEXT,
817 ZFS_IOC_DESTROY_SNAPS,
819 ZFS_IOC_DSOBJ_TO_DSNAME,
821 ZFS_IOC_POOL_SET_PROPS,
822 ZFS_IOC_POOL_GET_PROPS,
826 ZFS_IOC_INHERIT_PROP,
828 ZFS_IOC_USERSPACE_ONE,
829 ZFS_IOC_USERSPACE_MANY,
830 ZFS_IOC_USERSPACE_UPGRADE,
834 ZFS_IOC_OBJSET_RECVD_PROPS,
838 ZFS_IOC_TMP_SNAPSHOT,
839 ZFS_IOC_OBJ_TO_STATS,
843 ZFS_IOC_SPACE_WRITTEN,
845 ZFS_IOC_SEND_PROGRESS,
852 ZFS_IOC_GET_BOOKMARKS,
853 ZFS_IOC_DESTROY_BOOKMARKS,
858 * Internal SPA load state. Used by FMA diagnosis engine.
861 SPA_LOAD_NONE, /* no load in progress */
862 SPA_LOAD_OPEN, /* normal open */
863 SPA_LOAD_IMPORT, /* import in progress */
864 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
865 SPA_LOAD_RECOVER, /* recovery requested */
866 SPA_LOAD_ERROR /* load failed */
870 * Bookmark name values.
872 #define ZPOOL_ERR_LIST "error list"
873 #define ZPOOL_ERR_DATASET "dataset"
874 #define ZPOOL_ERR_OBJECT "object"
876 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
879 * The following are names used in the nvlist describing
880 * the pool's history log.
882 #define ZPOOL_HIST_RECORD "history record"
883 #define ZPOOL_HIST_TIME "history time"
884 #define ZPOOL_HIST_CMD "history command"
885 #define ZPOOL_HIST_WHO "history who"
886 #define ZPOOL_HIST_ZONE "history zone"
887 #define ZPOOL_HIST_HOST "history hostname"
888 #define ZPOOL_HIST_TXG "history txg"
889 #define ZPOOL_HIST_INT_EVENT "history internal event"
890 #define ZPOOL_HIST_INT_STR "history internal str"
891 #define ZPOOL_HIST_INT_NAME "internal_name"
892 #define ZPOOL_HIST_IOCTL "ioctl"
893 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
894 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
895 #define ZPOOL_HIST_DSNAME "dsname"
896 #define ZPOOL_HIST_DSID "dsid"
899 * Flags for ZFS_IOC_VDEV_SET_STATE
901 #define ZFS_ONLINE_CHECKREMOVE 0x1
902 #define ZFS_ONLINE_UNSPARE 0x2
903 #define ZFS_ONLINE_FORCEFAULT 0x4
904 #define ZFS_ONLINE_EXPAND 0x8
905 #define ZFS_OFFLINE_TEMPORARY 0x1
908 * Flags for ZFS_IOC_POOL_IMPORT
910 #define ZFS_IMPORT_NORMAL 0x0
911 #define ZFS_IMPORT_VERBATIM 0x1
912 #define ZFS_IMPORT_ANY_HOST 0x2
913 #define ZFS_IMPORT_MISSING_LOG 0x4
914 #define ZFS_IMPORT_ONLY 0x8
917 * Sysevent payload members. ZFS will generate the following sysevents with the
920 * ESC_ZFS_RESILVER_START
921 * ESC_ZFS_RESILVER_END
922 * ESC_ZFS_POOL_DESTROY
923 * ESC_ZFS_POOL_REGUID
925 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
926 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
928 * ESC_ZFS_VDEV_REMOVE
932 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
933 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
934 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
935 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
937 #define ZFS_EV_POOL_NAME "pool_name"
938 #define ZFS_EV_POOL_GUID "pool_guid"
939 #define ZFS_EV_VDEV_PATH "vdev_path"
940 #define ZFS_EV_VDEV_GUID "vdev_guid"
946 #endif /* _SYS_FS_ZFS_H */