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 by Delphix. All rights reserved.
27 /* Portions Copyright 2010 Robert Milkowski */
32 #include <sys/types.h>
33 #include <sys/ioccom.h>
41 * Types and constants shared between userland and the kernel.
45 * Each dataset can be one of the following types. These constants can be
46 * combined into masks that can be passed to various functions.
49 ZFS_TYPE_FILESYSTEM = 0x1,
50 ZFS_TYPE_SNAPSHOT = 0x2,
51 ZFS_TYPE_VOLUME = 0x4,
55 #define ZFS_TYPE_DATASET \
56 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
58 #define ZAP_MAXNAMELEN 256
59 #define ZAP_MAXVALUELEN (1024 * 8)
60 #define ZAP_OLDMAXVALUELEN 1024
63 * Dataset properties are identified by these constants and must be added to
64 * the end of this list to ensure that external consumers are not affected
65 * by the change. If you make any changes to this list, be sure to update
66 * the property table in usr/src/common/zfs/zfs_prop.c.
74 ZFS_PROP_COMPRESSRATIO,
80 ZFS_PROP_VOLBLOCKSIZE,
95 ZFS_PROP_CREATETXG, /* not exposed to the user */
96 ZFS_PROP_NAME, /* not exposed to the user */
98 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
100 ZFS_PROP_NUMCLONES, /* not exposed to the user */
110 ZFS_PROP_REFRESERVATION,
112 ZFS_PROP_PRIMARYCACHE,
113 ZFS_PROP_SECONDARYCACHE,
117 ZFS_PROP_USEDREFRESERV,
118 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
119 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
120 ZFS_PROP_DEFER_DESTROY,
123 ZFS_PROP_UNIQUE, /* not exposed to the user */
124 ZFS_PROP_OBJSETID, /* not exposed to the user */
137 ZFS_NUM_USERQUOTA_PROPS
138 } zfs_userquota_prop_t;
140 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
143 * Pool properties are identified by these constants and must be added to the
144 * end of this list to ensure that external consumers are not affected
145 * by the change. If you make any changes to this list, be sure to update
146 * the property table in usr/src/common/zfs/zpool_prop.c.
157 ZPOOL_PROP_DELEGATION,
158 ZPOOL_PROP_AUTOREPLACE,
159 ZPOOL_PROP_CACHEFILE,
160 ZPOOL_PROP_FAILUREMODE,
161 ZPOOL_PROP_LISTSNAPS,
162 ZPOOL_PROP_AUTOEXPAND,
163 ZPOOL_PROP_DEDUPDITTO,
164 ZPOOL_PROP_DEDUPRATIO,
166 ZPOOL_PROP_ALLOCATED,
171 #define ZPROP_CONT -2
172 #define ZPROP_INVAL -1
174 #define ZPROP_VALUE "value"
175 #define ZPROP_SOURCE "source"
178 ZPROP_SRC_NONE = 0x1,
179 ZPROP_SRC_DEFAULT = 0x2,
180 ZPROP_SRC_TEMPORARY = 0x4,
181 ZPROP_SRC_LOCAL = 0x8,
182 ZPROP_SRC_INHERITED = 0x10,
183 ZPROP_SRC_RECEIVED = 0x20
186 #define ZPROP_SRC_ALL 0x3f
188 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
189 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
191 * Dataset flag implemented as a special entry in the props zap object
192 * indicating that the dataset has received properties on or after
193 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
194 * just as it did in earlier versions, and thereafter, local properties are
197 #define ZPROP_HAS_RECVD "$hasrecvd"
200 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
201 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
204 typedef int (*zprop_func)(int, void *);
207 * Properties to be set on the root file system of a new pool
208 * are stuffed into their own nvlist, which is then included in
209 * the properties nvlist with the pool properties.
211 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
214 * Dataset property functions shared between libzfs and kernel.
216 const char *zfs_prop_default_string(zfs_prop_t);
217 uint64_t zfs_prop_default_numeric(zfs_prop_t);
218 boolean_t zfs_prop_readonly(zfs_prop_t);
219 boolean_t zfs_prop_inheritable(zfs_prop_t);
220 boolean_t zfs_prop_setonce(zfs_prop_t);
221 const char *zfs_prop_to_name(zfs_prop_t);
222 zfs_prop_t zfs_name_to_prop(const char *);
223 boolean_t zfs_prop_user(const char *);
224 boolean_t zfs_prop_userquota(const char *);
225 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
226 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
227 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
228 boolean_t zfs_prop_valid_for_type(int, zfs_type_t);
231 * Pool property functions shared between libzfs and kernel.
233 zpool_prop_t zpool_name_to_prop(const char *);
234 const char *zpool_prop_to_name(zpool_prop_t);
235 const char *zpool_prop_default_string(zpool_prop_t);
236 uint64_t zpool_prop_default_numeric(zpool_prop_t);
237 boolean_t zpool_prop_readonly(zpool_prop_t);
238 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
239 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
240 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
243 * Definitions for the Delegation.
246 ZFS_DELEG_WHO_UNKNOWN = 0,
247 ZFS_DELEG_USER = 'u',
248 ZFS_DELEG_USER_SETS = 'U',
249 ZFS_DELEG_GROUP = 'g',
250 ZFS_DELEG_GROUP_SETS = 'G',
251 ZFS_DELEG_EVERYONE = 'e',
252 ZFS_DELEG_EVERYONE_SETS = 'E',
253 ZFS_DELEG_CREATE = 'c',
254 ZFS_DELEG_CREATE_SETS = 'C',
255 ZFS_DELEG_NAMED_SET = 's',
256 ZFS_DELEG_NAMED_SET_SETS = 'S'
257 } zfs_deleg_who_type_t;
261 ZFS_DELEG_PERM_LOCAL = 1,
262 ZFS_DELEG_PERM_DESCENDENT = 2,
263 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
264 ZFS_DELEG_PERM_CREATE = 4
265 } zfs_deleg_inherit_t;
267 #define ZFS_DELEG_PERM_UID "uid"
268 #define ZFS_DELEG_PERM_GID "gid"
269 #define ZFS_DELEG_PERM_GROUPS "groups"
271 #define ZFS_MLSLABEL_DEFAULT "none"
273 #define ZFS_SMB_ACL_SRC "src"
274 #define ZFS_SMB_ACL_TARGET "target"
277 ZFS_CANMOUNT_OFF = 0,
279 ZFS_CANMOUNT_NOAUTO = 2
280 } zfs_canmount_type_t;
283 ZFS_LOGBIAS_LATENCY = 0,
284 ZFS_LOGBIAS_THROUGHPUT = 1
287 typedef enum zfs_share_op {
294 typedef enum zfs_smb_acl_op {
301 typedef enum zfs_cache_type {
303 ZFS_CACHE_METADATA = 1,
308 ZFS_SYNC_STANDARD = 0,
310 ZFS_SYNC_DISABLED = 2
315 * On-disk version number.
317 #define SPA_VERSION_1 1ULL
318 #define SPA_VERSION_2 2ULL
319 #define SPA_VERSION_3 3ULL
320 #define SPA_VERSION_4 4ULL
321 #define SPA_VERSION_5 5ULL
322 #define SPA_VERSION_6 6ULL
323 #define SPA_VERSION_7 7ULL
324 #define SPA_VERSION_8 8ULL
325 #define SPA_VERSION_9 9ULL
326 #define SPA_VERSION_10 10ULL
327 #define SPA_VERSION_11 11ULL
328 #define SPA_VERSION_12 12ULL
329 #define SPA_VERSION_13 13ULL
330 #define SPA_VERSION_14 14ULL
331 #define SPA_VERSION_15 15ULL
332 #define SPA_VERSION_16 16ULL
333 #define SPA_VERSION_17 17ULL
334 #define SPA_VERSION_18 18ULL
335 #define SPA_VERSION_19 19ULL
336 #define SPA_VERSION_20 20ULL
337 #define SPA_VERSION_21 21ULL
338 #define SPA_VERSION_22 22ULL
339 #define SPA_VERSION_23 23ULL
340 #define SPA_VERSION_24 24ULL
341 #define SPA_VERSION_25 25ULL
342 #define SPA_VERSION_26 26ULL
343 #define SPA_VERSION_27 27ULL
344 #define SPA_VERSION_28 28ULL
347 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
348 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
349 * and do the appropriate changes. Also bump the version number in
350 * usr/src/grub/capability.
352 #define SPA_VERSION SPA_VERSION_28
353 #define SPA_VERSION_STRING "28"
356 * Symbolic names for the changes that caused a SPA_VERSION switch.
357 * Used in the code when checking for presence or absence of a feature.
358 * Feel free to define multiple symbolic names for each version if there
359 * were multiple changes to on-disk structures during that version.
361 * NOTE: When checking the current SPA_VERSION in your code, be sure
362 * to use spa_version() since it reports the version of the
363 * last synced uberblock. Checking the in-flight version can
364 * be dangerous in some cases.
366 #define SPA_VERSION_INITIAL SPA_VERSION_1
367 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
368 #define SPA_VERSION_SPARES SPA_VERSION_3
369 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
370 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
371 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
372 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
373 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
374 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
375 #define SPA_VERSION_BOOTFS SPA_VERSION_6
376 #define SPA_VERSION_SLOGS SPA_VERSION_7
377 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
378 #define SPA_VERSION_FUID SPA_VERSION_9
379 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
380 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
381 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
382 #define SPA_VERSION_L2CACHE SPA_VERSION_10
383 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
384 #define SPA_VERSION_ORIGIN SPA_VERSION_11
385 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
386 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
387 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
388 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
389 #define SPA_VERSION_USERSPACE SPA_VERSION_15
390 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
391 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
392 #define SPA_VERSION_USERREFS SPA_VERSION_18
393 #define SPA_VERSION_HOLES SPA_VERSION_19
394 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
395 #define SPA_VERSION_DEDUP SPA_VERSION_21
396 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
397 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
398 #define SPA_VERSION_SA SPA_VERSION_24
399 #define SPA_VERSION_SCAN SPA_VERSION_25
400 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
401 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
402 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
403 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
406 * ZPL version - rev'd whenever an incompatible on-disk format change
407 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
408 * also update the version_table[] and help message in zfs_prop.c.
410 * When changing, be sure to teach GRUB how to read the new format!
411 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
413 #define ZPL_VERSION_1 1ULL
414 #define ZPL_VERSION_2 2ULL
415 #define ZPL_VERSION_3 3ULL
416 #define ZPL_VERSION_4 4ULL
417 #define ZPL_VERSION_5 5ULL
418 #define ZPL_VERSION ZPL_VERSION_5
419 #define ZPL_VERSION_STRING "5"
421 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
422 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
423 #define ZPL_VERSION_FUID ZPL_VERSION_3
424 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
425 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
426 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
427 #define ZPL_VERSION_SA ZPL_VERSION_5
429 /* Rewind request information */
430 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
431 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
432 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
433 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
434 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
435 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
436 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
438 typedef struct zpool_rewind_policy {
439 uint32_t zrp_request; /* rewind behavior requested */
440 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
441 uint64_t zrp_maxdata; /* max acceptable data errors */
442 uint64_t zrp_txg; /* specific txg to load */
443 } zpool_rewind_policy_t;
446 * The following are configuration names used in the nvlist describing a pool's
449 #define ZPOOL_CONFIG_VERSION "version"
450 #define ZPOOL_CONFIG_POOL_NAME "name"
451 #define ZPOOL_CONFIG_POOL_STATE "state"
452 #define ZPOOL_CONFIG_POOL_TXG "txg"
453 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
454 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
455 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
456 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
457 #define ZPOOL_CONFIG_TYPE "type"
458 #define ZPOOL_CONFIG_CHILDREN "children"
459 #define ZPOOL_CONFIG_ID "id"
460 #define ZPOOL_CONFIG_GUID "guid"
461 #define ZPOOL_CONFIG_PATH "path"
462 #define ZPOOL_CONFIG_DEVID "devid"
463 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
464 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
465 #define ZPOOL_CONFIG_ASHIFT "ashift"
466 #define ZPOOL_CONFIG_ASIZE "asize"
467 #define ZPOOL_CONFIG_DTL "DTL"
468 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
469 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
470 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
471 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
472 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
473 #define ZPOOL_CONFIG_SPARES "spares"
474 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
475 #define ZPOOL_CONFIG_NPARITY "nparity"
476 #define ZPOOL_CONFIG_HOSTID "hostid"
477 #define ZPOOL_CONFIG_HOSTNAME "hostname"
478 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
479 #define ZPOOL_CONFIG_UNSPARE "unspare"
480 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
481 #define ZPOOL_CONFIG_IS_LOG "is_log"
482 #define ZPOOL_CONFIG_L2CACHE "l2cache"
483 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
484 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
485 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
486 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
487 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
488 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
489 #define ZPOOL_CONFIG_SPLIT "splitcfg"
490 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
491 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
492 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
493 #define ZPOOL_CONFIG_REMOVING "removing"
494 #define ZPOOL_CONFIG_RESILVERING "resilvering"
495 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
496 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
497 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
498 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
499 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
501 * The persistent vdev state is stored as separate values rather than a single
502 * 'vdev_state' entry. This is because a device can be in multiple states, such
503 * as offline and degraded.
505 #define ZPOOL_CONFIG_OFFLINE "offline"
506 #define ZPOOL_CONFIG_FAULTED "faulted"
507 #define ZPOOL_CONFIG_DEGRADED "degraded"
508 #define ZPOOL_CONFIG_REMOVED "removed"
509 #define ZPOOL_CONFIG_FRU "fru"
510 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
512 /* Rewind policy parameters */
513 #define ZPOOL_REWIND_POLICY "rewind-policy"
514 #define ZPOOL_REWIND_REQUEST "rewind-request"
515 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
516 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
517 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
519 /* Rewind data discovered */
520 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
521 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
522 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
524 #define VDEV_TYPE_ROOT "root"
525 #define VDEV_TYPE_MIRROR "mirror"
526 #define VDEV_TYPE_REPLACING "replacing"
527 #define VDEV_TYPE_RAIDZ "raidz"
528 #define VDEV_TYPE_DISK "disk"
529 #define VDEV_TYPE_FILE "file"
530 #define VDEV_TYPE_MISSING "missing"
531 #define VDEV_TYPE_HOLE "hole"
532 #define VDEV_TYPE_SPARE "spare"
533 #define VDEV_TYPE_LOG "log"
534 #define VDEV_TYPE_L2CACHE "l2cache"
537 * This is needed in userland to report the minimum necessary device size.
539 #define SPA_MINDEVSIZE (64ULL << 20)
542 * The location of the pool configuration repository, shared between kernel and
545 #define ZPOOL_CACHE "/boot/zfs/zpool.cache"
548 * vdev states are ordered from least to most healthy.
549 * A vdev that's CANT_OPEN or below is considered unusable.
551 typedef enum vdev_state {
552 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
553 VDEV_STATE_CLOSED, /* Not currently open */
554 VDEV_STATE_OFFLINE, /* Not allowed to open */
555 VDEV_STATE_REMOVED, /* Explicitly removed from system */
556 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
557 VDEV_STATE_FAULTED, /* External request to fault device */
558 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
559 VDEV_STATE_HEALTHY /* Presumed good */
562 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
565 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
566 * of the vdev stats structure uses these constants to distinguish why.
568 typedef enum vdev_aux {
569 VDEV_AUX_NONE, /* no error */
570 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
571 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
572 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
573 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
574 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
575 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
576 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
577 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
578 VDEV_AUX_SPARED, /* hot spare used in another pool */
579 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
580 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
581 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
582 VDEV_AUX_EXTERNAL, /* external diagnosis */
583 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */
587 * pool state. The following states are written to disk as part of the normal
588 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
589 * states are software abstractions used at various levels to communicate
592 typedef enum pool_state {
593 POOL_STATE_ACTIVE = 0, /* In active use */
594 POOL_STATE_EXPORTED, /* Explicitly exported */
595 POOL_STATE_DESTROYED, /* Explicitly destroyed */
596 POOL_STATE_SPARE, /* Reserved for hot spare use */
597 POOL_STATE_L2CACHE, /* Level 2 ARC device */
598 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
599 POOL_STATE_UNAVAIL, /* Internal libzfs state */
600 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
606 typedef enum pool_scan_func {
614 * ZIO types. Needed to interpret vdev statistics below.
616 typedef enum zio_type {
627 * Pool statistics. Note: all fields should be 64-bit because this
628 * is passed between kernel and userland as an nvlist uint64 array.
630 typedef struct pool_scan_stat {
631 /* values stored on disk */
632 uint64_t pss_func; /* pool_scan_func_t */
633 uint64_t pss_state; /* dsl_scan_state_t */
634 uint64_t pss_start_time; /* scan start time */
635 uint64_t pss_end_time; /* scan end time */
636 uint64_t pss_to_examine; /* total bytes to scan */
637 uint64_t pss_examined; /* total examined bytes */
638 uint64_t pss_to_process; /* total bytes to process */
639 uint64_t pss_processed; /* total processed bytes */
640 uint64_t pss_errors; /* scan errors */
642 /* values not stored on disk */
643 uint64_t pss_pass_exam; /* examined bytes per scan pass */
644 uint64_t pss_pass_start; /* start time of a scan pass */
647 typedef enum dsl_scan_state {
657 * Vdev statistics. Note: all fields should be 64-bit because this
658 * is passed between kernel and userland as an nvlist uint64 array.
660 typedef struct vdev_stat {
661 hrtime_t vs_timestamp; /* time since vdev load */
662 uint64_t vs_state; /* vdev state */
663 uint64_t vs_aux; /* see vdev_aux_t */
664 uint64_t vs_alloc; /* space allocated */
665 uint64_t vs_space; /* total capacity */
666 uint64_t vs_dspace; /* deflated capacity */
667 uint64_t vs_rsize; /* replaceable dev size */
668 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
669 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
670 uint64_t vs_read_errors; /* read errors */
671 uint64_t vs_write_errors; /* write errors */
672 uint64_t vs_checksum_errors; /* checksum errors */
673 uint64_t vs_self_healed; /* self-healed bytes */
674 uint64_t vs_scan_removing; /* removing? */
675 uint64_t vs_scan_processed; /* scan processed bytes */
679 * DDT statistics. Note: all fields should be 64-bit because this
680 * is passed between kernel and userland as an nvlist uint64 array.
682 typedef struct ddt_object {
683 uint64_t ddo_count; /* number of elments in ddt */
684 uint64_t ddo_dspace; /* size of ddt on disk */
685 uint64_t ddo_mspace; /* size of ddt in-core */
688 typedef struct ddt_stat {
689 uint64_t dds_blocks; /* blocks */
690 uint64_t dds_lsize; /* logical size */
691 uint64_t dds_psize; /* physical size */
692 uint64_t dds_dsize; /* deflated allocated size */
693 uint64_t dds_ref_blocks; /* referenced blocks */
694 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
695 uint64_t dds_ref_psize; /* referenced psize * refcnt */
696 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
699 typedef struct ddt_histogram {
700 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
703 #define ZVOL_DRIVER "zvol"
704 #define ZFS_DRIVER "zfs"
705 #define ZFS_DEV_NAME "zfs"
706 #define ZFS_DEV "/dev/" ZFS_DEV_NAME
708 /* general zvol path */
709 #define ZVOL_DIR "/dev/zvol"
711 #define ZVOL_PSEUDO_DEV "/devices/pseudo/zfs@0:"
712 /* for dump and swap */
713 #define ZVOL_FULL_DEV_DIR ZVOL_DIR "/dsk/"
714 #define ZVOL_FULL_RDEV_DIR ZVOL_DIR "/rdsk/"
716 #define ZVOL_PROP_NAME "name"
717 #define ZVOL_DEFAULT_BLOCKSIZE 8192
720 * /dev/zfs ioctl numbers.
722 typedef unsigned long zfs_ioc_t;
724 #define ZFS_IOC(ioreq) ((ioreq) & 0xff)
726 #define ZFS_IOC_POOL_CREATE _IOWR('Z', 0, struct zfs_cmd)
727 #define ZFS_IOC_POOL_DESTROY _IOWR('Z', 1, struct zfs_cmd)
728 #define ZFS_IOC_POOL_IMPORT _IOWR('Z', 2, struct zfs_cmd)
729 #define ZFS_IOC_POOL_EXPORT _IOWR('Z', 3, struct zfs_cmd)
730 #define ZFS_IOC_POOL_CONFIGS _IOWR('Z', 4, struct zfs_cmd)
731 #define ZFS_IOC_POOL_STATS _IOWR('Z', 5, struct zfs_cmd)
732 #define ZFS_IOC_POOL_TRYIMPORT _IOWR('Z', 6, struct zfs_cmd)
733 #define ZFS_IOC_POOL_SCAN _IOWR('Z', 7, struct zfs_cmd)
734 #define ZFS_IOC_POOL_FREEZE _IOWR('Z', 8, struct zfs_cmd)
735 #define ZFS_IOC_POOL_UPGRADE _IOWR('Z', 9, struct zfs_cmd)
736 #define ZFS_IOC_POOL_GET_HISTORY _IOWR('Z', 10, struct zfs_cmd)
737 #define ZFS_IOC_VDEV_ADD _IOWR('Z', 11, struct zfs_cmd)
738 #define ZFS_IOC_VDEV_REMOVE _IOWR('Z', 12, struct zfs_cmd)
739 #define ZFS_IOC_VDEV_SET_STATE _IOWR('Z', 13, struct zfs_cmd)
740 #define ZFS_IOC_VDEV_ATTACH _IOWR('Z', 14, struct zfs_cmd)
741 #define ZFS_IOC_VDEV_DETACH _IOWR('Z', 15, struct zfs_cmd)
742 #define ZFS_IOC_VDEV_SETPATH _IOWR('Z', 16, struct zfs_cmd)
743 #define ZFS_IOC_VDEV_SETFRU _IOWR('Z', 17, struct zfs_cmd)
744 #define ZFS_IOC_OBJSET_STATS _IOWR('Z', 18, struct zfs_cmd)
745 #define ZFS_IOC_OBJSET_ZPLPROPS _IOWR('Z', 19, struct zfs_cmd)
746 #define ZFS_IOC_DATASET_LIST_NEXT _IOWR('Z', 20, struct zfs_cmd)
747 #define ZFS_IOC_SNAPSHOT_LIST_NEXT _IOWR('Z', 21, struct zfs_cmd)
748 #define ZFS_IOC_SET_PROP _IOWR('Z', 22, struct zfs_cmd)
749 #define ZFS_IOC_CREATE _IOWR('Z', 23, struct zfs_cmd)
750 #define ZFS_IOC_DESTROY _IOWR('Z', 24, struct zfs_cmd)
751 #define ZFS_IOC_ROLLBACK _IOWR('Z', 25, struct zfs_cmd)
752 #define ZFS_IOC_RENAME _IOWR('Z', 26, struct zfs_cmd)
753 #define ZFS_IOC_RECV _IOWR('Z', 27, struct zfs_cmd)
754 #define ZFS_IOC_SEND _IOWR('Z', 28, struct zfs_cmd)
755 #define ZFS_IOC_INJECT_FAULT _IOWR('Z', 29, struct zfs_cmd)
756 #define ZFS_IOC_CLEAR_FAULT _IOWR('Z', 30, struct zfs_cmd)
757 #define ZFS_IOC_INJECT_LIST_NEXT _IOWR('Z', 31, struct zfs_cmd)
758 #define ZFS_IOC_ERROR_LOG _IOWR('Z', 32, struct zfs_cmd)
759 #define ZFS_IOC_CLEAR _IOWR('Z', 33, struct zfs_cmd)
760 #define ZFS_IOC_PROMOTE _IOWR('Z', 34, struct zfs_cmd)
761 #define ZFS_IOC_DESTROY_SNAPS _IOWR('Z', 35, struct zfs_cmd)
762 #define ZFS_IOC_SNAPSHOT _IOWR('Z', 36, struct zfs_cmd)
763 #define ZFS_IOC_DSOBJ_TO_DSNAME _IOWR('Z', 37, struct zfs_cmd)
764 #define ZFS_IOC_OBJ_TO_PATH _IOWR('Z', 38, struct zfs_cmd)
765 #define ZFS_IOC_POOL_SET_PROPS _IOWR('Z', 39, struct zfs_cmd)
766 #define ZFS_IOC_POOL_GET_PROPS _IOWR('Z', 40, struct zfs_cmd)
767 #define ZFS_IOC_SET_FSACL _IOWR('Z', 41, struct zfs_cmd)
768 #define ZFS_IOC_GET_FSACL _IOWR('Z', 42, struct zfs_cmd)
769 #define ZFS_IOC_SHARE _IOWR('Z', 43, struct zfs_cmd)
770 #define ZFS_IOC_INHERIT_PROP _IOWR('Z', 44, struct zfs_cmd)
771 #define ZFS_IOC_SMB_ACL _IOWR('Z', 45, struct zfs_cmd)
772 #define ZFS_IOC_USERSPACE_ONE _IOWR('Z', 46, struct zfs_cmd)
773 #define ZFS_IOC_USERSPACE_MANY _IOWR('Z', 47, struct zfs_cmd)
774 #define ZFS_IOC_USERSPACE_UPGRADE _IOWR('Z', 48, struct zfs_cmd)
775 #define ZFS_IOC_HOLD _IOWR('Z', 49, struct zfs_cmd)
776 #define ZFS_IOC_RELEASE _IOWR('Z', 50, struct zfs_cmd)
777 #define ZFS_IOC_GET_HOLDS _IOWR('Z', 51, struct zfs_cmd)
778 #define ZFS_IOC_OBJSET_RECVD_PROPS _IOWR('Z', 52, struct zfs_cmd)
779 #define ZFS_IOC_VDEV_SPLIT _IOWR('Z', 53, struct zfs_cmd)
780 #define ZFS_IOC_NEXT_OBJ _IOWR('Z', 54, struct zfs_cmd)
781 #define ZFS_IOC_DIFF _IOWR('Z', 55, struct zfs_cmd)
782 #define ZFS_IOC_TMP_SNAPSHOT _IOWR('Z', 56, struct zfs_cmd)
783 #define ZFS_IOC_OBJ_TO_STATS _IOWR('Z', 57, struct zfs_cmd)
784 #define ZFS_IOC_JAIL _IOWR('Z', 58, struct zfs_cmd)
785 #define ZFS_IOC_UNJAIL _IOWR('Z', 59, struct zfs_cmd)
788 * Internal SPA load state. Used by FMA diagnosis engine.
791 SPA_LOAD_NONE, /* no load in progress */
792 SPA_LOAD_OPEN, /* normal open */
793 SPA_LOAD_IMPORT, /* import in progress */
794 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
795 SPA_LOAD_RECOVER, /* recovery requested */
796 SPA_LOAD_ERROR /* load failed */
800 * Bookmark name values.
802 #define ZPOOL_ERR_LIST "error list"
803 #define ZPOOL_ERR_DATASET "dataset"
804 #define ZPOOL_ERR_OBJECT "object"
806 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
809 * The following are names used in the nvlist describing
810 * the pool's history log.
812 #define ZPOOL_HIST_RECORD "history record"
813 #define ZPOOL_HIST_TIME "history time"
814 #define ZPOOL_HIST_CMD "history command"
815 #define ZPOOL_HIST_WHO "history who"
816 #define ZPOOL_HIST_ZONE "history zone"
817 #define ZPOOL_HIST_HOST "history hostname"
818 #define ZPOOL_HIST_TXG "history txg"
819 #define ZPOOL_HIST_INT_EVENT "history internal event"
820 #define ZPOOL_HIST_INT_STR "history internal str"
823 * Flags for ZFS_IOC_VDEV_SET_STATE
825 #define ZFS_ONLINE_CHECKREMOVE 0x1
826 #define ZFS_ONLINE_UNSPARE 0x2
827 #define ZFS_ONLINE_FORCEFAULT 0x4
828 #define ZFS_ONLINE_EXPAND 0x8
829 #define ZFS_OFFLINE_TEMPORARY 0x1
832 * Flags for ZFS_IOC_POOL_IMPORT
834 #define ZFS_IMPORT_NORMAL 0x0
835 #define ZFS_IMPORT_VERBATIM 0x1
836 #define ZFS_IMPORT_ANY_HOST 0x2
837 #define ZFS_IMPORT_MISSING_LOG 0x4
838 #define ZFS_IMPORT_ONLY 0x8
841 * Sysevent payload members. ZFS will generate the following sysevents with the
844 * ESC_ZFS_RESILVER_START
845 * ESC_ZFS_RESILVER_END
846 * ESC_ZFS_POOL_DESTROY
848 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
849 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
851 * ESC_ZFS_VDEV_REMOVE
855 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
856 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
857 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
858 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
860 #define ZFS_EV_POOL_NAME "pool_name"
861 #define ZFS_EV_POOL_GUID "pool_guid"
862 #define ZFS_EV_VDEV_PATH "vdev_path"
863 #define ZFS_EV_VDEV_GUID "vdev_guid"
866 * Note: This is encoded on-disk, so new events must be added to the
867 * end, and unused events can not be removed. Be sure to edit
868 * libzfs_pool.c: hist_event_table[].
870 typedef enum history_internal_events {
878 LOG_POOL_VDEV_ATTACH,
879 LOG_POOL_VDEV_REPLACE,
880 LOG_POOL_VDEV_DETACH,
881 LOG_POOL_VDEV_ONLINE,
882 LOG_POOL_VDEV_OFFLINE,
890 LOG_DS_DESTROY_BEGIN,
896 LOG_DS_PERM_WHO_REMOVE,
901 LOG_DS_REPLAY_INC_SYNC,
902 LOG_DS_REPLAY_FULL_SYNC,
913 } history_internal_events_t;
919 #endif /* _SYS_FS_ZFS_H */