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, 2017 by Delphix. All rights reserved.
25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2013, 2017 Joyent, Inc. All rights reserved.
27 * Copyright (c) 2014 Integros [integros.com]
28 * Copyright (c) 2017 Datto Inc.
31 /* Portions Copyright 2010 Robert Milkowski */
37 #include <sys/zio_priority.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)
77 * All of these include the terminating NUL byte.
79 #define ZAP_MAXNAMELEN 256
80 #define ZAP_MAXVALUELEN (1024 * 8)
81 #define ZAP_OLDMAXVALUELEN 1024
82 #define ZFS_MAX_DATASET_NAME_LEN 256
85 * Dataset properties are identified by these constants and must be added to
86 * the end of this list to ensure that external consumers are not affected
87 * by the change. If you make any changes to this list, be sure to update
88 * the property table in module/zcommon/zfs_prop.c.
98 ZFS_PROP_COMPRESSRATIO
,
102 ZFS_PROP_RESERVATION
,
104 ZFS_PROP_VOLBLOCKSIZE
,
109 ZFS_PROP_COMPRESSION
,
117 ZFS_PROP_PRIVATE
, /* not exposed to user, temporary */
120 ZFS_PROP_NAME
, /* not exposed to the user */
122 ZFS_PROP_ISCSIOPTIONS
, /* not exposed to the user */
124 ZFS_PROP_NUMCLONES
, /* not exposed to the user */
134 ZFS_PROP_REFRESERVATION
,
136 ZFS_PROP_PRIMARYCACHE
,
137 ZFS_PROP_SECONDARYCACHE
,
141 ZFS_PROP_USEDREFRESERV
,
142 ZFS_PROP_USERACCOUNTING
, /* not exposed to the user */
143 ZFS_PROP_STMF_SHAREINFO
, /* not exposed to the user */
144 ZFS_PROP_DEFER_DESTROY
,
147 ZFS_PROP_UNIQUE
, /* not exposed to the user */
148 ZFS_PROP_OBJSETID
, /* not exposed to the user */
156 ZFS_PROP_LOGICALUSED
,
157 ZFS_PROP_LOGICALREFERENCED
,
158 ZFS_PROP_INCONSISTENT
, /* not exposed to the user */
160 ZFS_PROP_FILESYSTEM_LIMIT
,
161 ZFS_PROP_SNAPSHOT_LIMIT
,
162 ZFS_PROP_FILESYSTEM_COUNT
,
163 ZFS_PROP_SNAPSHOT_COUNT
,
166 ZFS_PROP_SELINUX_CONTEXT
,
167 ZFS_PROP_SELINUX_FSCONTEXT
,
168 ZFS_PROP_SELINUX_DEFCONTEXT
,
169 ZFS_PROP_SELINUX_ROOTCONTEXT
,
171 ZFS_PROP_REDUNDANT_METADATA
,
174 ZFS_PROP_RECEIVE_RESUME_TOKEN
,
176 ZFS_PROP_KEYLOCATION
,
178 ZFS_PROP_PBKDF2_SALT
,
179 ZFS_PROP_PBKDF2_ITERS
,
180 ZFS_PROP_ENCRYPTION_ROOT
,
183 ZFS_PROP_REMAPTXG
, /* not exposed to the user */
192 ZFS_PROP_USEROBJUSED
,
193 ZFS_PROP_USEROBJQUOTA
,
194 ZFS_PROP_GROUPOBJUSED
,
195 ZFS_PROP_GROUPOBJQUOTA
,
196 ZFS_PROP_PROJECTUSED
,
197 ZFS_PROP_PROJECTQUOTA
,
198 ZFS_PROP_PROJECTOBJUSED
,
199 ZFS_PROP_PROJECTOBJQUOTA
,
200 ZFS_NUM_USERQUOTA_PROPS
201 } zfs_userquota_prop_t
;
203 extern const char *zfs_userquota_prop_prefixes
[ZFS_NUM_USERQUOTA_PROPS
];
206 * Pool properties are identified by these constants and must be added to the
207 * end of this list to ensure that external consumers are not affected
208 * by the change. If you make any changes to this list, be sure to update
209 * the property table in module/zcommon/zpool_prop.c.
212 ZPOOL_PROP_INVAL
= -1,
221 ZPOOL_PROP_DELEGATION
,
222 ZPOOL_PROP_AUTOREPLACE
,
223 ZPOOL_PROP_CACHEFILE
,
224 ZPOOL_PROP_FAILUREMODE
,
225 ZPOOL_PROP_LISTSNAPS
,
226 ZPOOL_PROP_AUTOEXPAND
,
227 ZPOOL_PROP_DEDUPDITTO
,
228 ZPOOL_PROP_DEDUPRATIO
,
230 ZPOOL_PROP_ALLOCATED
,
236 ZPOOL_PROP_FRAGMENTATION
,
238 ZPOOL_PROP_MAXBLOCKSIZE
,
240 ZPOOL_PROP_MAXDNODESIZE
,
241 ZPOOL_PROP_MULTIHOST
,
245 /* Small enough to not hog a whole line of printout in zpool(1M). */
246 #define ZPROP_MAX_COMMENT 32
248 #define ZPROP_VALUE "value"
249 #define ZPROP_SOURCE "source"
252 ZPROP_SRC_NONE
= 0x1,
253 ZPROP_SRC_DEFAULT
= 0x2,
254 ZPROP_SRC_TEMPORARY
= 0x4,
255 ZPROP_SRC_LOCAL
= 0x8,
256 ZPROP_SRC_INHERITED
= 0x10,
257 ZPROP_SRC_RECEIVED
= 0x20
260 #define ZPROP_SRC_ALL 0x3f
262 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
263 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
266 * Dataset flag implemented as a special entry in the props zap object
267 * indicating that the dataset has received properties on or after
268 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
269 * just as it did in earlier versions, and thereafter, local properties are
272 #define ZPROP_HAS_RECVD "$hasrecvd"
275 ZPROP_ERR_NOCLEAR
= 0x1, /* failure to clear existing props */
276 ZPROP_ERR_NORESTORE
= 0x2 /* failure to restore props on error */
279 typedef int (*zprop_func
)(int, void *);
282 * Properties to be set on the root file system of a new pool
283 * are stuffed into their own nvlist, which is then included in
284 * the properties nvlist with the pool properties.
286 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
289 * Length of 'written@' and 'written#'
291 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8
294 * Dataset property functions shared between libzfs and kernel.
296 const char *zfs_prop_default_string(zfs_prop_t
);
297 uint64_t zfs_prop_default_numeric(zfs_prop_t
);
298 boolean_t
zfs_prop_readonly(zfs_prop_t
);
299 boolean_t
zfs_prop_visible(zfs_prop_t prop
);
300 boolean_t
zfs_prop_inheritable(zfs_prop_t
);
301 boolean_t
zfs_prop_setonce(zfs_prop_t
);
302 boolean_t
zfs_prop_encryption_key_param(zfs_prop_t
);
303 boolean_t
zfs_prop_valid_keylocation(const char *, boolean_t
);
304 const char *zfs_prop_to_name(zfs_prop_t
);
305 zfs_prop_t
zfs_name_to_prop(const char *);
306 boolean_t
zfs_prop_user(const char *);
307 boolean_t
zfs_prop_userquota(const char *);
308 boolean_t
zfs_prop_written(const char *);
309 int zfs_prop_index_to_string(zfs_prop_t
, uint64_t, const char **);
310 int zfs_prop_string_to_index(zfs_prop_t
, const char *, uint64_t *);
311 uint64_t zfs_prop_random_value(zfs_prop_t
, uint64_t seed
);
312 boolean_t
zfs_prop_valid_for_type(int, zfs_type_t
, boolean_t
);
315 * Pool property functions shared between libzfs and kernel.
317 zpool_prop_t
zpool_name_to_prop(const char *);
318 const char *zpool_prop_to_name(zpool_prop_t
);
319 const char *zpool_prop_default_string(zpool_prop_t
);
320 uint64_t zpool_prop_default_numeric(zpool_prop_t
);
321 boolean_t
zpool_prop_readonly(zpool_prop_t
);
322 boolean_t
zpool_prop_feature(const char *);
323 boolean_t
zpool_prop_unsupported(const char *);
324 int zpool_prop_index_to_string(zpool_prop_t
, uint64_t, const char **);
325 int zpool_prop_string_to_index(zpool_prop_t
, const char *, uint64_t *);
326 uint64_t zpool_prop_random_value(zpool_prop_t
, uint64_t seed
);
329 * Definitions for the Delegation.
332 ZFS_DELEG_WHO_UNKNOWN
= 0,
333 ZFS_DELEG_USER
= 'u',
334 ZFS_DELEG_USER_SETS
= 'U',
335 ZFS_DELEG_GROUP
= 'g',
336 ZFS_DELEG_GROUP_SETS
= 'G',
337 ZFS_DELEG_EVERYONE
= 'e',
338 ZFS_DELEG_EVERYONE_SETS
= 'E',
339 ZFS_DELEG_CREATE
= 'c',
340 ZFS_DELEG_CREATE_SETS
= 'C',
341 ZFS_DELEG_NAMED_SET
= 's',
342 ZFS_DELEG_NAMED_SET_SETS
= 'S'
343 } zfs_deleg_who_type_t
;
347 ZFS_DELEG_PERM_LOCAL
= 1,
348 ZFS_DELEG_PERM_DESCENDENT
= 2,
349 ZFS_DELEG_PERM_LOCALDESCENDENT
= 3,
350 ZFS_DELEG_PERM_CREATE
= 4
351 } zfs_deleg_inherit_t
;
353 #define ZFS_DELEG_PERM_UID "uid"
354 #define ZFS_DELEG_PERM_GID "gid"
355 #define ZFS_DELEG_PERM_GROUPS "groups"
357 #define ZFS_MLSLABEL_DEFAULT "none"
359 #define ZFS_SMB_ACL_SRC "src"
360 #define ZFS_SMB_ACL_TARGET "target"
363 ZFS_CANMOUNT_OFF
= 0,
365 ZFS_CANMOUNT_NOAUTO
= 2
366 } zfs_canmount_type_t
;
369 ZFS_LOGBIAS_LATENCY
= 0,
370 ZFS_LOGBIAS_THROUGHPUT
= 1
373 typedef enum zfs_share_op
{
380 typedef enum zfs_smb_acl_op
{
387 typedef enum zfs_cache_type
{
389 ZFS_CACHE_METADATA
= 1,
394 ZFS_SYNC_STANDARD
= 0,
396 ZFS_SYNC_DISABLED
= 2
406 ZFS_DNSIZE_LEGACY
= 0,
408 ZFS_DNSIZE_1K
= 1024,
409 ZFS_DNSIZE_2K
= 2048,
410 ZFS_DNSIZE_4K
= 4096,
411 ZFS_DNSIZE_8K
= 8192,
412 ZFS_DNSIZE_16K
= 16384
416 ZFS_REDUNDANT_METADATA_ALL
,
417 ZFS_REDUNDANT_METADATA_MOST
418 } zfs_redundant_metadata_type_t
;
421 ZFS_VOLMODE_DEFAULT
= 0,
422 ZFS_VOLMODE_GEOM
= 1,
427 typedef enum zfs_keystatus
{
428 ZFS_KEYSTATUS_NONE
= 0,
429 ZFS_KEYSTATUS_UNAVAILABLE
,
430 ZFS_KEYSTATUS_AVAILABLE
,
433 typedef enum zfs_keyformat
{
434 ZFS_KEYFORMAT_NONE
= 0,
437 ZFS_KEYFORMAT_PASSPHRASE
,
438 ZFS_KEYFORMAT_FORMATS
441 typedef enum zfs_key_location
{
442 ZFS_KEYLOCATION_NONE
= 0,
443 ZFS_KEYLOCATION_PROMPT
,
445 ZFS_KEYLOCATION_LOCATIONS
448 #define DEFAULT_PBKDF2_ITERATIONS 350000
449 #define MIN_PBKDF2_ITERATIONS 100000
452 * On-disk version number.
454 #define SPA_VERSION_1 1ULL
455 #define SPA_VERSION_2 2ULL
456 #define SPA_VERSION_3 3ULL
457 #define SPA_VERSION_4 4ULL
458 #define SPA_VERSION_5 5ULL
459 #define SPA_VERSION_6 6ULL
460 #define SPA_VERSION_7 7ULL
461 #define SPA_VERSION_8 8ULL
462 #define SPA_VERSION_9 9ULL
463 #define SPA_VERSION_10 10ULL
464 #define SPA_VERSION_11 11ULL
465 #define SPA_VERSION_12 12ULL
466 #define SPA_VERSION_13 13ULL
467 #define SPA_VERSION_14 14ULL
468 #define SPA_VERSION_15 15ULL
469 #define SPA_VERSION_16 16ULL
470 #define SPA_VERSION_17 17ULL
471 #define SPA_VERSION_18 18ULL
472 #define SPA_VERSION_19 19ULL
473 #define SPA_VERSION_20 20ULL
474 #define SPA_VERSION_21 21ULL
475 #define SPA_VERSION_22 22ULL
476 #define SPA_VERSION_23 23ULL
477 #define SPA_VERSION_24 24ULL
478 #define SPA_VERSION_25 25ULL
479 #define SPA_VERSION_26 26ULL
480 #define SPA_VERSION_27 27ULL
481 #define SPA_VERSION_28 28ULL
482 #define SPA_VERSION_5000 5000ULL
485 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
486 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
487 * and do the appropriate changes. Also bump the version number in
488 * usr/src/grub/capability.
490 #define SPA_VERSION SPA_VERSION_5000
491 #define SPA_VERSION_STRING "5000"
494 * Symbolic names for the changes that caused a SPA_VERSION switch.
495 * Used in the code when checking for presence or absence of a feature.
496 * Feel free to define multiple symbolic names for each version if there
497 * were multiple changes to on-disk structures during that version.
499 * NOTE: When checking the current SPA_VERSION in your code, be sure
500 * to use spa_version() since it reports the version of the
501 * last synced uberblock. Checking the in-flight version can
502 * be dangerous in some cases.
504 #define SPA_VERSION_INITIAL SPA_VERSION_1
505 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
506 #define SPA_VERSION_SPARES SPA_VERSION_3
507 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
508 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
509 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
510 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
511 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
512 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
513 #define SPA_VERSION_BOOTFS SPA_VERSION_6
514 #define SPA_VERSION_SLOGS SPA_VERSION_7
515 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
516 #define SPA_VERSION_FUID SPA_VERSION_9
517 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
518 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
519 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
520 #define SPA_VERSION_L2CACHE SPA_VERSION_10
521 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
522 #define SPA_VERSION_ORIGIN SPA_VERSION_11
523 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
524 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
525 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
526 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
527 #define SPA_VERSION_USERSPACE SPA_VERSION_15
528 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
529 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
530 #define SPA_VERSION_USERREFS SPA_VERSION_18
531 #define SPA_VERSION_HOLES SPA_VERSION_19
532 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
533 #define SPA_VERSION_DEDUP SPA_VERSION_21
534 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
535 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
536 #define SPA_VERSION_SA SPA_VERSION_24
537 #define SPA_VERSION_SCAN SPA_VERSION_25
538 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
539 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
540 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
541 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
542 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
543 #define SPA_VERSION_FEATURES SPA_VERSION_5000
545 #define SPA_VERSION_IS_SUPPORTED(v) \
546 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
547 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
550 * ZPL version - rev'd whenever an incompatible on-disk format change
551 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
552 * also update the version_table[] and help message in zfs_prop.c.
554 * When changing, be sure to teach GRUB how to read the new format!
555 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
557 #define ZPL_VERSION_1 1ULL
558 #define ZPL_VERSION_2 2ULL
559 #define ZPL_VERSION_3 3ULL
560 #define ZPL_VERSION_4 4ULL
561 #define ZPL_VERSION_5 5ULL
562 #define ZPL_VERSION ZPL_VERSION_5
563 #define ZPL_VERSION_STRING "5"
565 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
566 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
567 #define ZPL_VERSION_FUID ZPL_VERSION_3
568 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
569 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
570 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
571 #define ZPL_VERSION_SA ZPL_VERSION_5
573 /* Rewind request information */
574 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
575 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
576 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
577 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
578 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
579 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
580 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
582 typedef struct zpool_rewind_policy
{
583 uint32_t zrp_request
; /* rewind behavior requested */
584 uint64_t zrp_maxmeta
; /* max acceptable meta-data errors */
585 uint64_t zrp_maxdata
; /* max acceptable data errors */
586 uint64_t zrp_txg
; /* specific txg to load */
587 } zpool_rewind_policy_t
;
590 * The following are configuration names used in the nvlist describing a pool's
591 * configuration. New on-disk names should be prefixed with "<reverse-DNS>:"
592 * (e.g. "org.open-zfs:") to avoid conflicting names being developed
595 #define ZPOOL_CONFIG_VERSION "version"
596 #define ZPOOL_CONFIG_POOL_NAME "name"
597 #define ZPOOL_CONFIG_POOL_STATE "state"
598 #define ZPOOL_CONFIG_POOL_TXG "txg"
599 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
600 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
601 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
602 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
603 #define ZPOOL_CONFIG_TYPE "type"
604 #define ZPOOL_CONFIG_CHILDREN "children"
605 #define ZPOOL_CONFIG_ID "id"
606 #define ZPOOL_CONFIG_GUID "guid"
607 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object"
608 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births"
609 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev"
610 #define ZPOOL_CONFIG_PATH "path"
611 #define ZPOOL_CONFIG_DEVID "devid"
612 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
613 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
614 #define ZPOOL_CONFIG_ASHIFT "ashift"
615 #define ZPOOL_CONFIG_ASIZE "asize"
616 #define ZPOOL_CONFIG_DTL "DTL"
617 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
618 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */
619 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
620 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */
622 /* container nvlist of extended stats */
623 #define ZPOOL_CONFIG_VDEV_STATS_EX "vdev_stats_ex"
625 /* Active queue read/write stats */
626 #define ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE "vdev_sync_r_active_queue"
627 #define ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE "vdev_sync_w_active_queue"
628 #define ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE "vdev_async_r_active_queue"
629 #define ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE "vdev_async_w_active_queue"
630 #define ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE "vdev_async_scrub_active_queue"
633 #define ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE "vdev_sync_r_pend_queue"
634 #define ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE "vdev_sync_w_pend_queue"
635 #define ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE "vdev_async_r_pend_queue"
636 #define ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE "vdev_async_w_pend_queue"
637 #define ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE "vdev_async_scrub_pend_queue"
639 /* Latency read/write histogram stats */
640 #define ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO "vdev_tot_r_lat_histo"
641 #define ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO "vdev_tot_w_lat_histo"
642 #define ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO "vdev_disk_r_lat_histo"
643 #define ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO "vdev_disk_w_lat_histo"
644 #define ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO "vdev_sync_r_lat_histo"
645 #define ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO "vdev_sync_w_lat_histo"
646 #define ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO "vdev_async_r_lat_histo"
647 #define ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO "vdev_async_w_lat_histo"
648 #define ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO "vdev_scrub_histo"
650 /* Request size histograms */
651 #define ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO "vdev_sync_ind_r_histo"
652 #define ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO "vdev_sync_ind_w_histo"
653 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO "vdev_async_ind_r_histo"
654 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO "vdev_async_ind_w_histo"
655 #define ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO "vdev_ind_scrub_histo"
656 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO "vdev_sync_agg_r_histo"
657 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO "vdev_sync_agg_w_histo"
658 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO "vdev_async_agg_r_histo"
659 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO "vdev_async_agg_w_histo"
660 #define ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO "vdev_agg_scrub_histo"
662 /* vdev enclosure sysfs path */
663 #define ZPOOL_CONFIG_VDEV_ENC_SYSFS_PATH "vdev_enc_sysfs_path"
665 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
666 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
667 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
668 #define ZPOOL_CONFIG_SPARES "spares"
669 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
670 #define ZPOOL_CONFIG_NPARITY "nparity"
671 #define ZPOOL_CONFIG_HOSTID "hostid"
672 #define ZPOOL_CONFIG_HOSTNAME "hostname"
673 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
674 #define ZPOOL_CONFIG_UNSPARE "unspare"
675 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
676 #define ZPOOL_CONFIG_IS_LOG "is_log"
677 #define ZPOOL_CONFIG_L2CACHE "l2cache"
678 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
679 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
680 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
681 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
682 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
683 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
684 #define ZPOOL_CONFIG_SPLIT "splitcfg"
685 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
686 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
687 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
688 #define ZPOOL_CONFIG_REMOVING "removing"
689 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
690 #define ZPOOL_CONFIG_COMMENT "comment"
691 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
692 #define ZPOOL_CONFIG_SUSPENDED_REASON "suspended_reason" /* not stored */
693 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
694 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
695 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
696 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
697 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
698 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
699 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
700 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
701 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
702 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
703 #define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */
704 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
705 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
706 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
707 #define ZPOOL_CONFIG_CACHEFILE "cachefile" /* not stored on disk */
708 #define ZPOOL_CONFIG_MMP_STATE "mmp_state" /* not stored on disk */
709 #define ZPOOL_CONFIG_MMP_TXG "mmp_txg" /* not stored on disk */
710 #define ZPOOL_CONFIG_MMP_HOSTNAME "mmp_hostname" /* not stored on disk */
711 #define ZPOOL_CONFIG_MMP_HOSTID "mmp_hostid" /* not stored on disk */
714 * The persistent vdev state is stored as separate values rather than a single
715 * 'vdev_state' entry. This is because a device can be in multiple states, such
716 * as offline and degraded.
718 #define ZPOOL_CONFIG_OFFLINE "offline"
719 #define ZPOOL_CONFIG_FAULTED "faulted"
720 #define ZPOOL_CONFIG_DEGRADED "degraded"
721 #define ZPOOL_CONFIG_REMOVED "removed"
722 #define ZPOOL_CONFIG_FRU "fru"
723 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
725 /* Rewind policy parameters */
726 #define ZPOOL_REWIND_POLICY "rewind-policy"
727 #define ZPOOL_REWIND_REQUEST "rewind-request"
728 #define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
729 #define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
730 #define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
732 /* Rewind data discovered */
733 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
734 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
735 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
737 #define VDEV_TYPE_ROOT "root"
738 #define VDEV_TYPE_MIRROR "mirror"
739 #define VDEV_TYPE_REPLACING "replacing"
740 #define VDEV_TYPE_RAIDZ "raidz"
741 #define VDEV_TYPE_DISK "disk"
742 #define VDEV_TYPE_FILE "file"
743 #define VDEV_TYPE_MISSING "missing"
744 #define VDEV_TYPE_HOLE "hole"
745 #define VDEV_TYPE_SPARE "spare"
746 #define VDEV_TYPE_LOG "log"
747 #define VDEV_TYPE_L2CACHE "l2cache"
748 #define VDEV_TYPE_INDIRECT "indirect"
750 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */
751 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \
752 "com.delphix:indirect_obsolete_sm"
753 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \
754 "com.delphix:obsolete_counts_are_precise"
757 * This is needed in userland to report the minimum necessary device size.
759 #define SPA_MINDEVSIZE (64ULL << 20)
762 * Set if the fragmentation has not yet been calculated. This can happen
763 * because the space maps have not been upgraded or the histogram feature
766 #define ZFS_FRAG_INVALID UINT64_MAX
769 * The location of the pool configuration repository, shared between kernel and
772 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
775 * vdev states are ordered from least to most healthy.
776 * A vdev that's CANT_OPEN or below is considered unusable.
778 typedef enum vdev_state
{
779 VDEV_STATE_UNKNOWN
= 0, /* Uninitialized vdev */
780 VDEV_STATE_CLOSED
, /* Not currently open */
781 VDEV_STATE_OFFLINE
, /* Not allowed to open */
782 VDEV_STATE_REMOVED
, /* Explicitly removed from system */
783 VDEV_STATE_CANT_OPEN
, /* Tried to open, but failed */
784 VDEV_STATE_FAULTED
, /* External request to fault device */
785 VDEV_STATE_DEGRADED
, /* Replicated vdev with unhealthy kids */
786 VDEV_STATE_HEALTHY
/* Presumed good */
789 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
792 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
793 * of the vdev stats structure uses these constants to distinguish why.
795 typedef enum vdev_aux
{
796 VDEV_AUX_NONE
, /* no error */
797 VDEV_AUX_OPEN_FAILED
, /* ldi_open_*() or vn_open() failed */
798 VDEV_AUX_CORRUPT_DATA
, /* bad label or disk contents */
799 VDEV_AUX_NO_REPLICAS
, /* insufficient number of replicas */
800 VDEV_AUX_BAD_GUID_SUM
, /* vdev guid sum doesn't match */
801 VDEV_AUX_TOO_SMALL
, /* vdev size is too small */
802 VDEV_AUX_BAD_LABEL
, /* the label is OK but invalid */
803 VDEV_AUX_VERSION_NEWER
, /* on-disk version is too new */
804 VDEV_AUX_VERSION_OLDER
, /* on-disk version is too old */
805 VDEV_AUX_UNSUP_FEAT
, /* unsupported features */
806 VDEV_AUX_SPARED
, /* hot spare used in another pool */
807 VDEV_AUX_ERR_EXCEEDED
, /* too many errors */
808 VDEV_AUX_IO_FAILURE
, /* experienced I/O failure */
809 VDEV_AUX_BAD_LOG
, /* cannot read log chain(s) */
810 VDEV_AUX_EXTERNAL
, /* external diagnosis or forced fault */
811 VDEV_AUX_SPLIT_POOL
, /* vdev was split off into another pool */
812 VDEV_AUX_BAD_ASHIFT
, /* vdev ashift is invalid */
813 VDEV_AUX_EXTERNAL_PERSIST
, /* persistent forced fault */
814 VDEV_AUX_ACTIVE
, /* vdev active on a different host */
815 VDEV_AUX_CHILDREN_OFFLINE
, /* all children are offline */
819 * pool state. The following states are written to disk as part of the normal
820 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
821 * states are software abstractions used at various levels to communicate
824 typedef enum pool_state
{
825 POOL_STATE_ACTIVE
= 0, /* In active use */
826 POOL_STATE_EXPORTED
, /* Explicitly exported */
827 POOL_STATE_DESTROYED
, /* Explicitly destroyed */
828 POOL_STATE_SPARE
, /* Reserved for hot spare use */
829 POOL_STATE_L2CACHE
, /* Level 2 ARC device */
830 POOL_STATE_UNINITIALIZED
, /* Internal spa_t state */
831 POOL_STATE_UNAVAIL
, /* Internal libzfs state */
832 POOL_STATE_POTENTIALLY_ACTIVE
/* Internal libzfs state */
836 * mmp state. The following states provide additional detail describing
837 * why a pool couldn't be safely imported.
839 typedef enum mmp_state
{
840 MMP_STATE_ACTIVE
= 0, /* In active use */
841 MMP_STATE_INACTIVE
, /* Inactive and safe to import */
842 MMP_STATE_NO_HOSTID
/* System hostid is not set */
848 typedef enum pool_scan_func
{
856 * Used to control scrub pause and resume.
858 typedef enum pool_scrub_cmd
{
859 POOL_SCRUB_NORMAL
= 0,
866 * ZIO types. Needed to interpret vdev statistics below.
868 typedef enum zio_type
{
879 * Pool statistics. Note: all fields should be 64-bit because this
880 * is passed between kernel and userland as an nvlist uint64 array.
882 typedef struct pool_scan_stat
{
883 /* values stored on disk */
884 uint64_t pss_func
; /* pool_scan_func_t */
885 uint64_t pss_state
; /* dsl_scan_state_t */
886 uint64_t pss_start_time
; /* scan start time */
887 uint64_t pss_end_time
; /* scan end time */
888 uint64_t pss_to_examine
; /* total bytes to scan */
889 uint64_t pss_examined
; /* total bytes located by scanner */
890 uint64_t pss_to_process
; /* total bytes to process */
891 uint64_t pss_processed
; /* total processed bytes */
892 uint64_t pss_errors
; /* scan errors */
894 /* values not stored on disk */
895 uint64_t pss_pass_exam
; /* examined bytes per scan pass */
896 uint64_t pss_pass_start
; /* start time of a scan pass */
897 uint64_t pss_pass_scrub_pause
; /* pause time of a scurb pass */
898 /* cumulative time scrub spent paused, needed for rate calculation */
899 uint64_t pss_pass_scrub_spent_paused
;
900 uint64_t pss_pass_issued
; /* issued bytes per scan pass */
901 uint64_t pss_issued
; /* total bytes checked by scanner */
904 typedef struct pool_removal_stat
{
905 uint64_t prs_state
; /* dsl_scan_state_t */
906 uint64_t prs_removing_vdev
;
907 uint64_t prs_start_time
;
908 uint64_t prs_end_time
;
909 uint64_t prs_to_copy
; /* bytes that need to be copied */
910 uint64_t prs_copied
; /* bytes copied so far */
912 * bytes of memory used for indirect mappings.
913 * This includes all removed vdevs.
915 uint64_t prs_mapping_memory
;
916 } pool_removal_stat_t
;
918 typedef enum dsl_scan_state
{
927 * Errata described by http://zfsonlinux.org/msg/ZFS-8000-ER. The ordering
928 * of this enum must be maintained to ensure the errata identifiers map to
929 * the correct documentation. New errata may only be appended to the list
930 * and must contain corresponding documentation at the above link.
932 typedef enum zpool_errata
{
934 ZPOOL_ERRATA_ZOL_2094_SCRUB
,
935 ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY
,
936 ZPOOL_ERRATA_ZOL_6845_ENCRYPTION
,
940 * Vdev statistics. Note: all fields should be 64-bit because this
941 * is passed between kernel and userland as an nvlist uint64 array.
943 typedef struct vdev_stat
{
944 hrtime_t vs_timestamp
; /* time since vdev load */
945 uint64_t vs_state
; /* vdev state */
946 uint64_t vs_aux
; /* see vdev_aux_t */
947 uint64_t vs_alloc
; /* space allocated */
948 uint64_t vs_space
; /* total capacity */
949 uint64_t vs_dspace
; /* deflated capacity */
950 uint64_t vs_rsize
; /* replaceable dev size */
951 uint64_t vs_esize
; /* expandable dev size */
952 uint64_t vs_ops
[ZIO_TYPES
]; /* operation count */
953 uint64_t vs_bytes
[ZIO_TYPES
]; /* bytes read/written */
954 uint64_t vs_read_errors
; /* read errors */
955 uint64_t vs_write_errors
; /* write errors */
956 uint64_t vs_checksum_errors
; /* checksum errors */
957 uint64_t vs_self_healed
; /* self-healed bytes */
958 uint64_t vs_scan_removing
; /* removing? */
959 uint64_t vs_scan_processed
; /* scan processed bytes */
960 uint64_t vs_fragmentation
; /* device fragmentation */
967 * These are stats which aren't included in the original iostat output. For
968 * convenience, they are grouped together in vdev_stat_ex, although each stat
969 * is individually exported as an nvlist.
971 typedef struct vdev_stat_ex
{
972 /* Number of ZIOs issued to disk and waiting to finish */
973 uint64_t vsx_active_queue
[ZIO_PRIORITY_NUM_QUEUEABLE
];
975 /* Number of ZIOs pending to be issued to disk */
976 uint64_t vsx_pend_queue
[ZIO_PRIORITY_NUM_QUEUEABLE
];
979 * Below are the histograms for various latencies. Buckets are in
980 * units of nanoseconds.
984 * 2^37 nanoseconds = 134s. Timeouts will probably start kicking in
987 #define VDEV_L_HISTO_BUCKETS 37 /* Latency histo buckets */
988 #define VDEV_RQ_HISTO_BUCKETS 25 /* Request size histo buckets */
991 /* Amount of time in ZIO queue (ns) */
992 uint64_t vsx_queue_histo
[ZIO_PRIORITY_NUM_QUEUEABLE
]
993 [VDEV_L_HISTO_BUCKETS
];
995 /* Total ZIO latency (ns). Includes queuing and disk access time */
996 uint64_t vsx_total_histo
[ZIO_TYPES
][VDEV_L_HISTO_BUCKETS
];
998 /* Amount of time to read/write the disk (ns) */
999 uint64_t vsx_disk_histo
[ZIO_TYPES
][VDEV_L_HISTO_BUCKETS
];
1001 /* "lookup the bucket for a value" histogram macros */
1002 #define HISTO(val, buckets) (val != 0 ? MIN(highbit64(val) - 1, \
1004 #define L_HISTO(a) HISTO(a, VDEV_L_HISTO_BUCKETS)
1005 #define RQ_HISTO(a) HISTO(a, VDEV_RQ_HISTO_BUCKETS)
1007 /* Physical IO histogram */
1008 uint64_t vsx_ind_histo
[ZIO_PRIORITY_NUM_QUEUEABLE
]
1009 [VDEV_RQ_HISTO_BUCKETS
];
1011 /* Delegated (aggregated) physical IO histogram */
1012 uint64_t vsx_agg_histo
[ZIO_PRIORITY_NUM_QUEUEABLE
]
1013 [VDEV_RQ_HISTO_BUCKETS
];
1018 * DDT statistics. Note: all fields should be 64-bit because this
1019 * is passed between kernel and userland as an nvlist uint64 array.
1021 typedef struct ddt_object
{
1022 uint64_t ddo_count
; /* number of elements in ddt */
1023 uint64_t ddo_dspace
; /* size of ddt on disk */
1024 uint64_t ddo_mspace
; /* size of ddt in-core */
1027 typedef struct ddt_stat
{
1028 uint64_t dds_blocks
; /* blocks */
1029 uint64_t dds_lsize
; /* logical size */
1030 uint64_t dds_psize
; /* physical size */
1031 uint64_t dds_dsize
; /* deflated allocated size */
1032 uint64_t dds_ref_blocks
; /* referenced blocks */
1033 uint64_t dds_ref_lsize
; /* referenced lsize * refcnt */
1034 uint64_t dds_ref_psize
; /* referenced psize * refcnt */
1035 uint64_t dds_ref_dsize
; /* referenced dsize * refcnt */
1038 typedef struct ddt_histogram
{
1039 ddt_stat_t ddh_stat
[64]; /* power-of-two histogram buckets */
1042 #define ZVOL_DRIVER "zvol"
1043 #define ZFS_DRIVER "zfs"
1044 #define ZFS_DEV "/dev/zfs"
1045 #define ZFS_SHARETAB "/etc/dfs/sharetab"
1047 #define ZFS_SUPER_MAGIC 0x2fc12fc1
1049 /* general zvol path */
1050 #define ZVOL_DIR "/dev"
1052 #define ZVOL_MAJOR 230
1053 #define ZVOL_MINOR_BITS 4
1054 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
1055 #define ZVOL_MINORS (1 << 4)
1056 #define ZVOL_DEV_NAME "zd"
1058 #define ZVOL_PROP_NAME "name"
1059 #define ZVOL_DEFAULT_BLOCKSIZE 8192
1062 * /dev/zfs ioctl numbers.
1064 typedef enum zfs_ioc
{
1066 * Illumos - 71/128 numbers reserved.
1068 ZFS_IOC_FIRST
= ('Z' << 8),
1069 ZFS_IOC
= ZFS_IOC_FIRST
,
1070 ZFS_IOC_POOL_CREATE
= ZFS_IOC_FIRST
,
1071 ZFS_IOC_POOL_DESTROY
,
1072 ZFS_IOC_POOL_IMPORT
,
1073 ZFS_IOC_POOL_EXPORT
,
1074 ZFS_IOC_POOL_CONFIGS
,
1076 ZFS_IOC_POOL_TRYIMPORT
,
1078 ZFS_IOC_POOL_FREEZE
,
1079 ZFS_IOC_POOL_UPGRADE
,
1080 ZFS_IOC_POOL_GET_HISTORY
,
1082 ZFS_IOC_VDEV_REMOVE
,
1083 ZFS_IOC_VDEV_SET_STATE
,
1084 ZFS_IOC_VDEV_ATTACH
,
1085 ZFS_IOC_VDEV_DETACH
,
1086 ZFS_IOC_VDEV_SETPATH
,
1087 ZFS_IOC_VDEV_SETFRU
,
1088 ZFS_IOC_OBJSET_STATS
,
1089 ZFS_IOC_OBJSET_ZPLPROPS
,
1090 ZFS_IOC_DATASET_LIST_NEXT
,
1091 ZFS_IOC_SNAPSHOT_LIST_NEXT
,
1099 ZFS_IOC_INJECT_FAULT
,
1100 ZFS_IOC_CLEAR_FAULT
,
1101 ZFS_IOC_INJECT_LIST_NEXT
,
1106 ZFS_IOC_DSOBJ_TO_DSNAME
,
1107 ZFS_IOC_OBJ_TO_PATH
,
1108 ZFS_IOC_POOL_SET_PROPS
,
1109 ZFS_IOC_POOL_GET_PROPS
,
1113 ZFS_IOC_INHERIT_PROP
,
1115 ZFS_IOC_USERSPACE_ONE
,
1116 ZFS_IOC_USERSPACE_MANY
,
1117 ZFS_IOC_USERSPACE_UPGRADE
,
1121 ZFS_IOC_OBJSET_RECVD_PROPS
,
1125 ZFS_IOC_TMP_SNAPSHOT
,
1126 ZFS_IOC_OBJ_TO_STATS
,
1127 ZFS_IOC_SPACE_WRITTEN
,
1128 ZFS_IOC_SPACE_SNAPS
,
1129 ZFS_IOC_DESTROY_SNAPS
,
1130 ZFS_IOC_POOL_REGUID
,
1131 ZFS_IOC_POOL_REOPEN
,
1132 ZFS_IOC_SEND_PROGRESS
,
1133 ZFS_IOC_LOG_HISTORY
,
1138 ZFS_IOC_GET_BOOKMARKS
,
1139 ZFS_IOC_DESTROY_BOOKMARKS
,
1140 ZFS_IOC_CHANNEL_PROGRAM
,
1149 * Linux - 3/64 numbers reserved.
1151 ZFS_IOC_LINUX
= ('Z' << 8) + 0x80,
1152 ZFS_IOC_EVENTS_NEXT
,
1153 ZFS_IOC_EVENTS_CLEAR
,
1154 ZFS_IOC_EVENTS_SEEK
,
1157 * FreeBSD - 1/64 numbers reserved.
1159 ZFS_IOC_FREEBSD
= ('Z' << 8) + 0xC0,
1165 * zvol ioctl to get dataset name
1167 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAX_DATASET_NAME_LEN])
1170 * Internal SPA load state. Used by FMA diagnosis engine.
1173 SPA_LOAD_NONE
, /* no load in progress */
1174 SPA_LOAD_OPEN
, /* normal open */
1175 SPA_LOAD_IMPORT
, /* import in progress */
1176 SPA_LOAD_TRYIMPORT
, /* tryimport in progress */
1177 SPA_LOAD_RECOVER
, /* recovery requested */
1178 SPA_LOAD_ERROR
, /* load failed */
1179 SPA_LOAD_CREATE
/* creation in progress */
1183 * Bookmark name values.
1185 #define ZPOOL_ERR_LIST "error list"
1186 #define ZPOOL_ERR_DATASET "dataset"
1187 #define ZPOOL_ERR_OBJECT "object"
1189 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
1192 * The following are names used in the nvlist describing
1193 * the pool's history log.
1195 #define ZPOOL_HIST_RECORD "history record"
1196 #define ZPOOL_HIST_TIME "history time"
1197 #define ZPOOL_HIST_CMD "history command"
1198 #define ZPOOL_HIST_WHO "history who"
1199 #define ZPOOL_HIST_ZONE "history zone"
1200 #define ZPOOL_HIST_HOST "history hostname"
1201 #define ZPOOL_HIST_TXG "history txg"
1202 #define ZPOOL_HIST_INT_EVENT "history internal event"
1203 #define ZPOOL_HIST_INT_STR "history internal str"
1204 #define ZPOOL_HIST_INT_NAME "internal_name"
1205 #define ZPOOL_HIST_IOCTL "ioctl"
1206 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
1207 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
1208 #define ZPOOL_HIST_DSNAME "dsname"
1209 #define ZPOOL_HIST_DSID "dsid"
1210 #define ZPOOL_HIST_ERRNO "errno"
1213 * Special nvlist name that will not have its args recorded in the pool's
1216 #define ZPOOL_HIDDEN_ARGS "hidden_args"
1219 * Flags for ZFS_IOC_VDEV_SET_STATE
1221 #define ZFS_ONLINE_CHECKREMOVE 0x1
1222 #define ZFS_ONLINE_UNSPARE 0x2
1223 #define ZFS_ONLINE_FORCEFAULT 0x4
1224 #define ZFS_ONLINE_EXPAND 0x8
1225 #define ZFS_OFFLINE_TEMPORARY 0x1
1228 * Flags for ZFS_IOC_POOL_IMPORT
1230 #define ZFS_IMPORT_NORMAL 0x0
1231 #define ZFS_IMPORT_VERBATIM 0x1
1232 #define ZFS_IMPORT_ANY_HOST 0x2
1233 #define ZFS_IMPORT_MISSING_LOG 0x4
1234 #define ZFS_IMPORT_ONLY 0x8
1235 #define ZFS_IMPORT_TEMP_NAME 0x10
1236 #define ZFS_IMPORT_SKIP_MMP 0x20
1237 #define ZFS_IMPORT_LOAD_KEYS 0x40
1240 * Channel program argument/return nvlist keys and defaults.
1242 #define ZCP_ARG_PROGRAM "program"
1243 #define ZCP_ARG_ARGLIST "arg"
1244 #define ZCP_ARG_SYNC "sync"
1245 #define ZCP_ARG_INSTRLIMIT "instrlimit"
1246 #define ZCP_ARG_MEMLIMIT "memlimit"
1248 #define ZCP_ARG_CLIARGV "argv"
1250 #define ZCP_RET_ERROR "error"
1251 #define ZCP_RET_RETURN "return"
1253 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000)
1254 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT)
1255 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024)
1256 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT)
1259 * Sysevent payload members. ZFS will generate the following sysevents with the
1262 * ESC_ZFS_RESILVER_START
1263 * ESC_ZFS_RESILVER_END
1264 * ESC_ZFS_POOL_DESTROY
1265 * ESC_ZFS_POOL_REGUID
1267 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1268 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1270 * ESC_ZFS_VDEV_REMOVE
1271 * ESC_ZFS_VDEV_CLEAR
1272 * ESC_ZFS_VDEV_CHECK
1274 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1275 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1276 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
1277 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
1279 * ESC_ZFS_HISTORY_EVENT
1281 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1282 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1283 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional)
1284 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional)
1285 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional)
1286 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional)
1287 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional)
1288 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional)
1289 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional)
1290 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional)
1291 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional)
1292 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional)
1293 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional)
1294 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional)
1296 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1297 * history log nvlist. The keynames will be free of any spaces or other
1298 * characters that could be potentially unexpected to consumers of the
1301 #define ZFS_EV_POOL_NAME "pool_name"
1302 #define ZFS_EV_POOL_GUID "pool_guid"
1303 #define ZFS_EV_VDEV_PATH "vdev_path"
1304 #define ZFS_EV_VDEV_GUID "vdev_guid"
1305 #define ZFS_EV_HIST_TIME "history_time"
1306 #define ZFS_EV_HIST_CMD "history_command"
1307 #define ZFS_EV_HIST_WHO "history_who"
1308 #define ZFS_EV_HIST_ZONE "history_zone"
1309 #define ZFS_EV_HIST_HOST "history_hostname"
1310 #define ZFS_EV_HIST_TXG "history_txg"
1311 #define ZFS_EV_HIST_INT_EVENT "history_internal_event"
1312 #define ZFS_EV_HIST_INT_STR "history_internal_str"
1313 #define ZFS_EV_HIST_INT_NAME "history_internal_name"
1314 #define ZFS_EV_HIST_IOCTL "history_ioctl"
1315 #define ZFS_EV_HIST_DSNAME "history_dsname"
1316 #define ZFS_EV_HIST_DSID "history_dsid"
1322 #endif /* _SYS_FS_ZFS_H */