]> git.proxmox.com Git - mirror_zfs.git/blame - include/sys/fs/zfs.h
Change location of current symlink created by test-runner
[mirror_zfs.git] / include / sys / fs / zfs.h
CommitLineData
34dc7c2f
BB
1/*
2 * CDDL HEADER START
3 *
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.
7 *
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.
12 *
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]
18 *
19 * CDDL HEADER END
20 */
45d1cae3 21
34dc7c2f 22/*
428870ff 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
faf0f58c 24 * Copyright (c) 2011, 2014 by Delphix. All rights reserved.
3541dc6d 25 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
788eb90c 26 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
34dc7c2f
BB
27 */
28
428870ff
BB
29/* Portions Copyright 2010 Robert Milkowski */
30
34dc7c2f
BB
31#ifndef _SYS_FS_ZFS_H
32#define _SYS_FS_ZFS_H
33
45d1cae3 34#include <sys/time.h>
193a37cb 35#include <sys/zio_priority.h>
45d1cae3 36
34dc7c2f
BB
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/*
42 * Types and constants shared between userland and the kernel.
43 */
44
45/*
46 * Each dataset can be one of the following types. These constants can be
47 * combined into masks that can be passed to various functions.
48 */
49typedef enum {
da536844
MA
50 ZFS_TYPE_FILESYSTEM = (1 << 0),
51 ZFS_TYPE_SNAPSHOT = (1 << 1),
52 ZFS_TYPE_VOLUME = (1 << 2),
53 ZFS_TYPE_POOL = (1 << 3),
54 ZFS_TYPE_BOOKMARK = (1 << 4)
34dc7c2f
BB
55} zfs_type_t;
56
6f1ffb06
MA
57typedef enum dmu_objset_type {
58 DMU_OST_NONE,
59 DMU_OST_META,
60 DMU_OST_ZFS,
61 DMU_OST_ZVOL,
62 DMU_OST_OTHER, /* For testing only! */
63 DMU_OST_ANY, /* Be careful! */
64 DMU_OST_NUMTYPES
65} dmu_objset_type_t;
66
34dc7c2f
BB
67#define ZFS_TYPE_DATASET \
68 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
69
eca7b760
IK
70/*
71 * All of these include the terminating NUL byte.
72 */
9babb374
BB
73#define ZAP_MAXNAMELEN 256
74#define ZAP_MAXVALUELEN (1024 * 8)
75#define ZAP_OLDMAXVALUELEN 1024
eca7b760 76#define ZFS_MAX_DATASET_NAME_LEN 256
9babb374 77
34dc7c2f
BB
78/*
79 * Dataset properties are identified by these constants and must be added to
80 * the end of this list to ensure that external consumers are not affected
81 * by the change. If you make any changes to this list, be sure to update
e77aa730 82 * the property table in module/zcommon/zfs_prop.c.
34dc7c2f
BB
83 */
84typedef enum {
85 ZFS_PROP_TYPE,
86 ZFS_PROP_CREATION,
87 ZFS_PROP_USED,
88 ZFS_PROP_AVAILABLE,
89 ZFS_PROP_REFERENCED,
90 ZFS_PROP_COMPRESSRATIO,
91 ZFS_PROP_MOUNTED,
92 ZFS_PROP_ORIGIN,
93 ZFS_PROP_QUOTA,
94 ZFS_PROP_RESERVATION,
95 ZFS_PROP_VOLSIZE,
96 ZFS_PROP_VOLBLOCKSIZE,
97 ZFS_PROP_RECORDSIZE,
98 ZFS_PROP_MOUNTPOINT,
99 ZFS_PROP_SHARENFS,
100 ZFS_PROP_CHECKSUM,
101 ZFS_PROP_COMPRESSION,
102 ZFS_PROP_ATIME,
103 ZFS_PROP_DEVICES,
104 ZFS_PROP_EXEC,
105 ZFS_PROP_SETUID,
106 ZFS_PROP_READONLY,
107 ZFS_PROP_ZONED,
108 ZFS_PROP_SNAPDIR,
428870ff 109 ZFS_PROP_PRIVATE, /* not exposed to user, temporary */
34dc7c2f
BB
110 ZFS_PROP_ACLINHERIT,
111 ZFS_PROP_CREATETXG, /* not exposed to the user */
112 ZFS_PROP_NAME, /* not exposed to the user */
113 ZFS_PROP_CANMOUNT,
34dc7c2f
BB
114 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
115 ZFS_PROP_XATTR,
116 ZFS_PROP_NUMCLONES, /* not exposed to the user */
117 ZFS_PROP_COPIES,
118 ZFS_PROP_VERSION,
119 ZFS_PROP_UTF8ONLY,
120 ZFS_PROP_NORMALIZE,
121 ZFS_PROP_CASE,
122 ZFS_PROP_VSCAN,
123 ZFS_PROP_NBMAND,
124 ZFS_PROP_SHARESMB,
125 ZFS_PROP_REFQUOTA,
126 ZFS_PROP_REFRESERVATION,
b128c09f
BB
127 ZFS_PROP_GUID,
128 ZFS_PROP_PRIMARYCACHE,
129 ZFS_PROP_SECONDARYCACHE,
130 ZFS_PROP_USEDSNAP,
131 ZFS_PROP_USEDDS,
132 ZFS_PROP_USEDCHILD,
133 ZFS_PROP_USEDREFRESERV,
9babb374
BB
134 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
135 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
45d1cae3
BB
136 ZFS_PROP_DEFER_DESTROY,
137 ZFS_PROP_USERREFS,
428870ff
BB
138 ZFS_PROP_LOGBIAS,
139 ZFS_PROP_UNIQUE, /* not exposed to the user */
140 ZFS_PROP_OBJSETID, /* not exposed to the user */
141 ZFS_PROP_DEDUP,
142 ZFS_PROP_MLSLABEL,
143 ZFS_PROP_SYNC,
50c957f7 144 ZFS_PROP_DNODESIZE,
f5fc4aca 145 ZFS_PROP_REFRATIO,
330d06f9
MA
146 ZFS_PROP_WRITTEN,
147 ZFS_PROP_CLONES,
24a64651
MA
148 ZFS_PROP_LOGICALUSED,
149 ZFS_PROP_LOGICALREFERENCED,
96c2e961 150 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
788eb90c
JJ
151 ZFS_PROP_FILESYSTEM_LIMIT,
152 ZFS_PROP_SNAPSHOT_LIMIT,
153 ZFS_PROP_FILESYSTEM_COUNT,
154 ZFS_PROP_SNAPSHOT_COUNT,
0b4d1b58 155 ZFS_PROP_SNAPDEV,
023699cd 156 ZFS_PROP_ACLTYPE,
11b9ec23
MT
157 ZFS_PROP_SELINUX_CONTEXT,
158 ZFS_PROP_SELINUX_FSCONTEXT,
159 ZFS_PROP_SELINUX_DEFCONTEXT,
160 ZFS_PROP_SELINUX_ROOTCONTEXT,
6d111134 161 ZFS_PROP_RELATIME,
faf0f58c 162 ZFS_PROP_REDUNDANT_METADATA,
f67d7090 163 ZFS_PROP_OVERLAY,
1715493f 164 ZFS_PROP_PREV_SNAP,
47dfff3b 165 ZFS_PROP_RECEIVE_RESUME_TOKEN,
34dc7c2f
BB
166 ZFS_NUM_PROPS
167} zfs_prop_t;
168
9babb374
BB
169typedef enum {
170 ZFS_PROP_USERUSED,
171 ZFS_PROP_USERQUOTA,
172 ZFS_PROP_GROUPUSED,
173 ZFS_PROP_GROUPQUOTA,
1de321e6
JX
174 ZFS_PROP_USEROBJUSED,
175 ZFS_PROP_USEROBJQUOTA,
176 ZFS_PROP_GROUPOBJUSED,
177 ZFS_PROP_GROUPOBJQUOTA,
9babb374
BB
178 ZFS_NUM_USERQUOTA_PROPS
179} zfs_userquota_prop_t;
180
181extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
182
34dc7c2f
BB
183/*
184 * Pool properties are identified by these constants and must be added to the
b128c09f 185 * end of this list to ensure that external consumers are not affected
34dc7c2f 186 * by the change. If you make any changes to this list, be sure to update
e77aa730 187 * the property table in module/zcommon/zpool_prop.c.
34dc7c2f
BB
188 */
189typedef enum {
190 ZPOOL_PROP_NAME,
191 ZPOOL_PROP_SIZE,
34dc7c2f
BB
192 ZPOOL_PROP_CAPACITY,
193 ZPOOL_PROP_ALTROOT,
194 ZPOOL_PROP_HEALTH,
195 ZPOOL_PROP_GUID,
196 ZPOOL_PROP_VERSION,
197 ZPOOL_PROP_BOOTFS,
198 ZPOOL_PROP_DELEGATION,
199 ZPOOL_PROP_AUTOREPLACE,
200 ZPOOL_PROP_CACHEFILE,
201 ZPOOL_PROP_FAILUREMODE,
b128c09f 202 ZPOOL_PROP_LISTSNAPS,
9babb374 203 ZPOOL_PROP_AUTOEXPAND,
428870ff
BB
204 ZPOOL_PROP_DEDUPDITTO,
205 ZPOOL_PROP_DEDUPRATIO,
206 ZPOOL_PROP_FREE,
207 ZPOOL_PROP_ALLOCATED,
572e2857 208 ZPOOL_PROP_READONLY,
df30f566 209 ZPOOL_PROP_ASHIFT,
d96eb2b1 210 ZPOOL_PROP_COMMENT,
1bd201e7 211 ZPOOL_PROP_EXPANDSZ,
9ae529ec 212 ZPOOL_PROP_FREEING,
f3a7f661 213 ZPOOL_PROP_FRAGMENTATION,
fbeddd60 214 ZPOOL_PROP_LEAKED,
f1512ee6 215 ZPOOL_PROP_MAXBLOCKSIZE,
83e9986f 216 ZPOOL_PROP_TNAME,
50c957f7 217 ZPOOL_PROP_MAXDNODESIZE,
34dc7c2f
BB
218 ZPOOL_NUM_PROPS
219} zpool_prop_t;
220
d96eb2b1
DM
221/* Small enough to not hog a whole line of printout in zpool(1M). */
222#define ZPROP_MAX_COMMENT 32
223
34dc7c2f
BB
224#define ZPROP_CONT -2
225#define ZPROP_INVAL -1
226
227#define ZPROP_VALUE "value"
228#define ZPROP_SOURCE "source"
229
230typedef enum {
231 ZPROP_SRC_NONE = 0x1,
232 ZPROP_SRC_DEFAULT = 0x2,
233 ZPROP_SRC_TEMPORARY = 0x4,
234 ZPROP_SRC_LOCAL = 0x8,
428870ff
BB
235 ZPROP_SRC_INHERITED = 0x10,
236 ZPROP_SRC_RECEIVED = 0x20
34dc7c2f
BB
237} zprop_source_t;
238
428870ff
BB
239#define ZPROP_SRC_ALL 0x3f
240
241#define ZPROP_SOURCE_VAL_RECVD "$recvd"
242#define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
43e52edd 243
428870ff
BB
244/*
245 * Dataset flag implemented as a special entry in the props zap object
246 * indicating that the dataset has received properties on or after
247 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
248 * just as it did in earlier versions, and thereafter, local properties are
249 * preserved.
250 */
251#define ZPROP_HAS_RECVD "$hasrecvd"
252
253typedef enum {
254 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
255 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
256} zprop_errflags_t;
34dc7c2f
BB
257
258typedef int (*zprop_func)(int, void *);
259
b128c09f
BB
260/*
261 * Properties to be set on the root file system of a new pool
262 * are stuffed into their own nvlist, which is then included in
263 * the properties nvlist with the pool properties.
264 */
265#define ZPOOL_ROOTFS_PROPS "root-props-nvl"
266
34dc7c2f
BB
267/*
268 * Dataset property functions shared between libzfs and kernel.
269 */
270const char *zfs_prop_default_string(zfs_prop_t);
271uint64_t zfs_prop_default_numeric(zfs_prop_t);
272boolean_t zfs_prop_readonly(zfs_prop_t);
273boolean_t zfs_prop_inheritable(zfs_prop_t);
274boolean_t zfs_prop_setonce(zfs_prop_t);
275const char *zfs_prop_to_name(zfs_prop_t);
276zfs_prop_t zfs_name_to_prop(const char *);
277boolean_t zfs_prop_user(const char *);
428870ff 278boolean_t zfs_prop_userquota(const char *);
330d06f9 279boolean_t zfs_prop_written(const char *);
34dc7c2f
BB
280int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
281int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
428870ff 282uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
962d5242 283boolean_t zfs_prop_valid_for_type(int, zfs_type_t, boolean_t);
34dc7c2f
BB
284
285/*
286 * Pool property functions shared between libzfs and kernel.
287 */
288zpool_prop_t zpool_name_to_prop(const char *);
289const char *zpool_prop_to_name(zpool_prop_t);
290const char *zpool_prop_default_string(zpool_prop_t);
291uint64_t zpool_prop_default_numeric(zpool_prop_t);
292boolean_t zpool_prop_readonly(zpool_prop_t);
9ae529ec
CS
293boolean_t zpool_prop_feature(const char *);
294boolean_t zpool_prop_unsupported(const char *);
34dc7c2f
BB
295int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
296int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
428870ff 297uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
34dc7c2f
BB
298
299/*
300 * Definitions for the Delegation.
301 */
302typedef enum {
303 ZFS_DELEG_WHO_UNKNOWN = 0,
304 ZFS_DELEG_USER = 'u',
305 ZFS_DELEG_USER_SETS = 'U',
306 ZFS_DELEG_GROUP = 'g',
307 ZFS_DELEG_GROUP_SETS = 'G',
308 ZFS_DELEG_EVERYONE = 'e',
309 ZFS_DELEG_EVERYONE_SETS = 'E',
310 ZFS_DELEG_CREATE = 'c',
311 ZFS_DELEG_CREATE_SETS = 'C',
312 ZFS_DELEG_NAMED_SET = 's',
313 ZFS_DELEG_NAMED_SET_SETS = 'S'
314} zfs_deleg_who_type_t;
315
316typedef enum {
317 ZFS_DELEG_NONE = 0,
318 ZFS_DELEG_PERM_LOCAL = 1,
319 ZFS_DELEG_PERM_DESCENDENT = 2,
320 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
321 ZFS_DELEG_PERM_CREATE = 4
322} zfs_deleg_inherit_t;
323
324#define ZFS_DELEG_PERM_UID "uid"
325#define ZFS_DELEG_PERM_GID "gid"
326#define ZFS_DELEG_PERM_GROUPS "groups"
327
428870ff
BB
328#define ZFS_MLSLABEL_DEFAULT "none"
329
9babb374
BB
330#define ZFS_SMB_ACL_SRC "src"
331#define ZFS_SMB_ACL_TARGET "target"
332
34dc7c2f
BB
333typedef enum {
334 ZFS_CANMOUNT_OFF = 0,
335 ZFS_CANMOUNT_ON = 1,
336 ZFS_CANMOUNT_NOAUTO = 2
337} zfs_canmount_type_t;
338
428870ff
BB
339typedef enum {
340 ZFS_LOGBIAS_LATENCY = 0,
341 ZFS_LOGBIAS_THROUGHPUT = 1
342} zfs_logbias_op_t;
343
34dc7c2f
BB
344typedef enum zfs_share_op {
345 ZFS_SHARE_NFS = 0,
346 ZFS_UNSHARE_NFS = 1,
347 ZFS_SHARE_SMB = 2,
348 ZFS_UNSHARE_SMB = 3
349} zfs_share_op_t;
350
9babb374
BB
351typedef enum zfs_smb_acl_op {
352 ZFS_SMB_ACL_ADD,
353 ZFS_SMB_ACL_REMOVE,
354 ZFS_SMB_ACL_RENAME,
355 ZFS_SMB_ACL_PURGE
356} zfs_smb_acl_op_t;
357
b128c09f
BB
358typedef enum zfs_cache_type {
359 ZFS_CACHE_NONE = 0,
360 ZFS_CACHE_METADATA = 1,
361 ZFS_CACHE_ALL = 2
362} zfs_cache_type_t;
363
428870ff
BB
364typedef enum {
365 ZFS_SYNC_STANDARD = 0,
366 ZFS_SYNC_ALWAYS = 1,
367 ZFS_SYNC_DISABLED = 2
368} zfs_sync_type_t;
369
82a37189
BB
370typedef enum {
371 ZFS_XATTR_OFF = 0,
372 ZFS_XATTR_DIR = 1,
373 ZFS_XATTR_SA = 2
374} zfs_xattr_type_t;
b128c09f 375
50c957f7
NB
376typedef enum {
377 ZFS_DNSIZE_LEGACY = 0,
378 ZFS_DNSIZE_AUTO = 1,
379 ZFS_DNSIZE_1K = 1024,
380 ZFS_DNSIZE_2K = 2048,
381 ZFS_DNSIZE_4K = 4096,
382 ZFS_DNSIZE_8K = 8192,
383 ZFS_DNSIZE_16K = 16384
384} zfs_dnsize_type_t;
385
faf0f58c
MA
386typedef enum {
387 ZFS_REDUNDANT_METADATA_ALL,
388 ZFS_REDUNDANT_METADATA_MOST
389} zfs_redundant_metadata_type_t;
390
34dc7c2f
BB
391/*
392 * On-disk version number.
393 */
394#define SPA_VERSION_1 1ULL
395#define SPA_VERSION_2 2ULL
396#define SPA_VERSION_3 3ULL
397#define SPA_VERSION_4 4ULL
398#define SPA_VERSION_5 5ULL
399#define SPA_VERSION_6 6ULL
400#define SPA_VERSION_7 7ULL
401#define SPA_VERSION_8 8ULL
402#define SPA_VERSION_9 9ULL
403#define SPA_VERSION_10 10ULL
b128c09f
BB
404#define SPA_VERSION_11 11ULL
405#define SPA_VERSION_12 12ULL
406#define SPA_VERSION_13 13ULL
407#define SPA_VERSION_14 14ULL
9babb374
BB
408#define SPA_VERSION_15 15ULL
409#define SPA_VERSION_16 16ULL
45d1cae3
BB
410#define SPA_VERSION_17 17ULL
411#define SPA_VERSION_18 18ULL
428870ff
BB
412#define SPA_VERSION_19 19ULL
413#define SPA_VERSION_20 20ULL
414#define SPA_VERSION_21 21ULL
415#define SPA_VERSION_22 22ULL
416#define SPA_VERSION_23 23ULL
417#define SPA_VERSION_24 24ULL
418#define SPA_VERSION_25 25ULL
419#define SPA_VERSION_26 26ULL
572e2857
BB
420#define SPA_VERSION_27 27ULL
421#define SPA_VERSION_28 28ULL
9ae529ec 422#define SPA_VERSION_5000 5000ULL
572e2857 423
34dc7c2f
BB
424/*
425 * When bumping up SPA_VERSION, make sure GRUB ZFS understands the on-disk
9babb374
BB
426 * format change. Go to usr/src/grub/grub-0.97/stage2/{zfs-include/, fsys_zfs*},
427 * and do the appropriate changes. Also bump the version number in
428 * usr/src/grub/capability.
34dc7c2f 429 */
9ae529ec
CS
430#define SPA_VERSION SPA_VERSION_5000
431#define SPA_VERSION_STRING "5000"
34dc7c2f
BB
432
433/*
434 * Symbolic names for the changes that caused a SPA_VERSION switch.
435 * Used in the code when checking for presence or absence of a feature.
436 * Feel free to define multiple symbolic names for each version if there
437 * were multiple changes to on-disk structures during that version.
438 *
439 * NOTE: When checking the current SPA_VERSION in your code, be sure
440 * to use spa_version() since it reports the version of the
441 * last synced uberblock. Checking the in-flight version can
442 * be dangerous in some cases.
443 */
444#define SPA_VERSION_INITIAL SPA_VERSION_1
445#define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
446#define SPA_VERSION_SPARES SPA_VERSION_3
45d1cae3 447#define SPA_VERSION_RAIDZ2 SPA_VERSION_3
428870ff 448#define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
34dc7c2f
BB
449#define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
450#define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
451#define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
452#define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
453#define SPA_VERSION_BOOTFS SPA_VERSION_6
454#define SPA_VERSION_SLOGS SPA_VERSION_7
455#define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
456#define SPA_VERSION_FUID SPA_VERSION_9
457#define SPA_VERSION_REFRESERVATION SPA_VERSION_9
458#define SPA_VERSION_REFQUOTA SPA_VERSION_9
459#define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
460#define SPA_VERSION_L2CACHE SPA_VERSION_10
b128c09f
BB
461#define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
462#define SPA_VERSION_ORIGIN SPA_VERSION_11
463#define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
464#define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
465#define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
466#define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
9babb374
BB
467#define SPA_VERSION_USERSPACE SPA_VERSION_15
468#define SPA_VERSION_STMF_PROP SPA_VERSION_16
45d1cae3
BB
469#define SPA_VERSION_RAIDZ3 SPA_VERSION_17
470#define SPA_VERSION_USERREFS SPA_VERSION_18
428870ff
BB
471#define SPA_VERSION_HOLES SPA_VERSION_19
472#define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
473#define SPA_VERSION_DEDUP SPA_VERSION_21
474#define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
475#define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
476#define SPA_VERSION_SA SPA_VERSION_24
477#define SPA_VERSION_SCAN SPA_VERSION_25
478#define SPA_VERSION_DIR_CLONES SPA_VERSION_26
479#define SPA_VERSION_DEADLISTS SPA_VERSION_26
572e2857
BB
480#define SPA_VERSION_FAST_SNAP SPA_VERSION_27
481#define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
9ae529ec
CS
482#define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
483#define SPA_VERSION_FEATURES SPA_VERSION_5000
484
485#define SPA_VERSION_IS_SUPPORTED(v) \
486 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
487 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
34dc7c2f
BB
488
489/*
490 * ZPL version - rev'd whenever an incompatible on-disk format change
491 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
492 * also update the version_table[] and help message in zfs_prop.c.
493 *
494 * When changing, be sure to teach GRUB how to read the new format!
9babb374 495 * See usr/src/grub/grub-0.97/stage2/{zfs-include/,fsys_zfs*}
34dc7c2f
BB
496 */
497#define ZPL_VERSION_1 1ULL
498#define ZPL_VERSION_2 2ULL
499#define ZPL_VERSION_3 3ULL
9babb374 500#define ZPL_VERSION_4 4ULL
428870ff
BB
501#define ZPL_VERSION_5 5ULL
502#define ZPL_VERSION ZPL_VERSION_5
503#define ZPL_VERSION_STRING "5"
34dc7c2f
BB
504
505#define ZPL_VERSION_INITIAL ZPL_VERSION_1
506#define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
507#define ZPL_VERSION_FUID ZPL_VERSION_3
508#define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
509#define ZPL_VERSION_SYSATTR ZPL_VERSION_3
9babb374 510#define ZPL_VERSION_USERSPACE ZPL_VERSION_4
428870ff
BB
511#define ZPL_VERSION_SA ZPL_VERSION_5
512
513/* Rewind request information */
514#define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
515#define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
516#define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
517#define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
518#define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
519#define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
520#define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
521
522typedef struct zpool_rewind_policy {
523 uint32_t zrp_request; /* rewind behavior requested */
524 uint64_t zrp_maxmeta; /* max acceptable meta-data errors */
525 uint64_t zrp_maxdata; /* max acceptable data errors */
526 uint64_t zrp_txg; /* specific txg to load */
527} zpool_rewind_policy_t;
34dc7c2f
BB
528
529/*
530 * The following are configuration names used in the nvlist describing a pool's
531 * configuration.
532 */
533#define ZPOOL_CONFIG_VERSION "version"
534#define ZPOOL_CONFIG_POOL_NAME "name"
535#define ZPOOL_CONFIG_POOL_STATE "state"
536#define ZPOOL_CONFIG_POOL_TXG "txg"
537#define ZPOOL_CONFIG_POOL_GUID "pool_guid"
538#define ZPOOL_CONFIG_CREATE_TXG "create_txg"
539#define ZPOOL_CONFIG_TOP_GUID "top_guid"
540#define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
541#define ZPOOL_CONFIG_TYPE "type"
542#define ZPOOL_CONFIG_CHILDREN "children"
543#define ZPOOL_CONFIG_ID "id"
544#define ZPOOL_CONFIG_GUID "guid"
545#define ZPOOL_CONFIG_PATH "path"
546#define ZPOOL_CONFIG_DEVID "devid"
547#define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
548#define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
549#define ZPOOL_CONFIG_ASHIFT "ashift"
550#define ZPOOL_CONFIG_ASIZE "asize"
551#define ZPOOL_CONFIG_DTL "DTL"
428870ff
BB
552#define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
553#define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
193a37cb
TH
554
555/* container nvlist of extended stats */
556#define ZPOOL_CONFIG_VDEV_STATS_EX "vdev_stats_ex"
557
558/* Active queue read/write stats */
559#define ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE "vdev_sync_r_active_queue"
560#define ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE "vdev_sync_w_active_queue"
561#define ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE "vdev_async_r_active_queue"
562#define ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE "vdev_async_w_active_queue"
563#define ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE "vdev_async_scrub_active_queue"
564
565/* Queue sizes */
566#define ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE "vdev_sync_r_pend_queue"
567#define ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE "vdev_sync_w_pend_queue"
568#define ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE "vdev_async_r_pend_queue"
569#define ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE "vdev_async_w_pend_queue"
570#define ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE "vdev_async_scrub_pend_queue"
571
572/* Latency read/write histogram stats */
573#define ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO "vdev_tot_r_lat_histo"
574#define ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO "vdev_tot_w_lat_histo"
575#define ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO "vdev_disk_r_lat_histo"
576#define ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO "vdev_disk_w_lat_histo"
577#define ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO "vdev_sync_r_lat_histo"
578#define ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO "vdev_sync_w_lat_histo"
579#define ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO "vdev_async_r_lat_histo"
580#define ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO "vdev_async_w_lat_histo"
581#define ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO "vdev_scrub_histo"
582
7e945072
TH
583/* Request size histograms */
584#define ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO "vdev_sync_ind_r_histo"
585#define ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO "vdev_sync_ind_w_histo"
586#define ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO "vdev_async_ind_r_histo"
587#define ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO "vdev_async_ind_w_histo"
588#define ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO "vdev_ind_scrub_histo"
589#define ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO "vdev_sync_agg_r_histo"
590#define ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO "vdev_sync_agg_w_histo"
591#define ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO "vdev_async_agg_r_histo"
592#define ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO "vdev_async_agg_w_histo"
593#define ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO "vdev_agg_scrub_histo"
193a37cb 594
34dc7c2f
BB
595#define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
596#define ZPOOL_CONFIG_ERRCOUNT "error_count"
597#define ZPOOL_CONFIG_NOT_PRESENT "not_present"
598#define ZPOOL_CONFIG_SPARES "spares"
599#define ZPOOL_CONFIG_IS_SPARE "is_spare"
600#define ZPOOL_CONFIG_NPARITY "nparity"
601#define ZPOOL_CONFIG_HOSTID "hostid"
602#define ZPOOL_CONFIG_HOSTNAME "hostname"
572e2857 603#define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
34dc7c2f
BB
604#define ZPOOL_CONFIG_UNSPARE "unspare"
605#define ZPOOL_CONFIG_PHYS_PATH "phys_path"
606#define ZPOOL_CONFIG_IS_LOG "is_log"
607#define ZPOOL_CONFIG_L2CACHE "l2cache"
428870ff
BB
608#define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
609#define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
610#define ZPOOL_CONFIG_IS_HOLE "is_hole"
611#define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
612#define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
613#define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
614#define ZPOOL_CONFIG_SPLIT "splitcfg"
615#define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
616#define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
617#define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
618#define ZPOOL_CONFIG_REMOVING "removing"
5d1f7fb6 619#define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
d96eb2b1 620#define ZPOOL_CONFIG_COMMENT "comment"
b128c09f 621#define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
34dc7c2f
BB
622#define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
623#define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
572e2857
BB
624#define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
625#define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
9ae529ec
CS
626#define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
627#define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
b9b24bb4 628#define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
9ae529ec
CS
629#define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
630#define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
631#define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
ffe9d382 632#define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */
e0ab3ab5
JS
633#define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
634#define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
635#define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
34dc7c2f
BB
636/*
637 * The persistent vdev state is stored as separate values rather than a single
638 * 'vdev_state' entry. This is because a device can be in multiple states, such
639 * as offline and degraded.
640 */
641#define ZPOOL_CONFIG_OFFLINE "offline"
642#define ZPOOL_CONFIG_FAULTED "faulted"
643#define ZPOOL_CONFIG_DEGRADED "degraded"
644#define ZPOOL_CONFIG_REMOVED "removed"
9babb374 645#define ZPOOL_CONFIG_FRU "fru"
428870ff
BB
646#define ZPOOL_CONFIG_AUX_STATE "aux_state"
647
648/* Rewind policy parameters */
649#define ZPOOL_REWIND_POLICY "rewind-policy"
650#define ZPOOL_REWIND_REQUEST "rewind-request"
651#define ZPOOL_REWIND_REQUEST_TXG "rewind-request-txg"
652#define ZPOOL_REWIND_META_THRESH "rewind-meta-thresh"
653#define ZPOOL_REWIND_DATA_THRESH "rewind-data-thresh"
654
655/* Rewind data discovered */
656#define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
657#define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
658#define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
34dc7c2f
BB
659
660#define VDEV_TYPE_ROOT "root"
661#define VDEV_TYPE_MIRROR "mirror"
662#define VDEV_TYPE_REPLACING "replacing"
663#define VDEV_TYPE_RAIDZ "raidz"
664#define VDEV_TYPE_DISK "disk"
665#define VDEV_TYPE_FILE "file"
666#define VDEV_TYPE_MISSING "missing"
428870ff 667#define VDEV_TYPE_HOLE "hole"
34dc7c2f
BB
668#define VDEV_TYPE_SPARE "spare"
669#define VDEV_TYPE_LOG "log"
670#define VDEV_TYPE_L2CACHE "l2cache"
671
672/*
673 * This is needed in userland to report the minimum necessary device size.
674 */
675#define SPA_MINDEVSIZE (64ULL << 20)
676
f3a7f661
GW
677/*
678 * Set if the fragmentation has not yet been calculated. This can happen
679 * because the space maps have not been upgraded or the histogram feature
680 * is not enabled.
681 */
682#define ZFS_FRAG_INVALID UINT64_MAX
683
34dc7c2f
BB
684/*
685 * The location of the pool configuration repository, shared between kernel and
686 * userland.
687 */
b128c09f 688#define ZPOOL_CACHE "/etc/zfs/zpool.cache"
34dc7c2f
BB
689
690/*
691 * vdev states are ordered from least to most healthy.
692 * A vdev that's CANT_OPEN or below is considered unusable.
693 */
694typedef enum vdev_state {
695 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
696 VDEV_STATE_CLOSED, /* Not currently open */
697 VDEV_STATE_OFFLINE, /* Not allowed to open */
698 VDEV_STATE_REMOVED, /* Explicitly removed from system */
699 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
700 VDEV_STATE_FAULTED, /* External request to fault device */
701 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
702 VDEV_STATE_HEALTHY /* Presumed good */
703} vdev_state_t;
704
705#define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
706
707/*
708 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
709 * of the vdev stats structure uses these constants to distinguish why.
710 */
711typedef enum vdev_aux {
712 VDEV_AUX_NONE, /* no error */
713 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
714 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
715 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
716 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
717 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
718 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
719 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
720 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
9ae529ec 721 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
34dc7c2f 722 VDEV_AUX_SPARED, /* hot spare used in another pool */
b128c09f
BB
723 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
724 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
428870ff
BB
725 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
726 VDEV_AUX_EXTERNAL, /* external diagnosis */
727 VDEV_AUX_SPLIT_POOL /* vdev was split off into another pool */
34dc7c2f
BB
728} vdev_aux_t;
729
730/*
731 * pool state. The following states are written to disk as part of the normal
732 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
733 * states are software abstractions used at various levels to communicate
734 * pool state.
735 */
736typedef enum pool_state {
737 POOL_STATE_ACTIVE = 0, /* In active use */
738 POOL_STATE_EXPORTED, /* Explicitly exported */
739 POOL_STATE_DESTROYED, /* Explicitly destroyed */
740 POOL_STATE_SPARE, /* Reserved for hot spare use */
741 POOL_STATE_L2CACHE, /* Level 2 ARC device */
742 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
34dc7c2f
BB
743 POOL_STATE_UNAVAIL, /* Internal libzfs state */
744 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
745} pool_state_t;
746
747/*
428870ff 748 * Scan Functions.
34dc7c2f 749 */
428870ff
BB
750typedef enum pool_scan_func {
751 POOL_SCAN_NONE,
752 POOL_SCAN_SCRUB,
753 POOL_SCAN_RESILVER,
754 POOL_SCAN_FUNCS
755} pool_scan_func_t;
34dc7c2f
BB
756
757/*
758 * ZIO types. Needed to interpret vdev statistics below.
759 */
760typedef enum zio_type {
761 ZIO_TYPE_NULL = 0,
762 ZIO_TYPE_READ,
763 ZIO_TYPE_WRITE,
764 ZIO_TYPE_FREE,
765 ZIO_TYPE_CLAIM,
766 ZIO_TYPE_IOCTL,
767 ZIO_TYPES
768} zio_type_t;
769
428870ff
BB
770/*
771 * Pool statistics. Note: all fields should be 64-bit because this
772 * is passed between kernel and userland as an nvlist uint64 array.
773 */
774typedef struct pool_scan_stat {
775 /* values stored on disk */
776 uint64_t pss_func; /* pool_scan_func_t */
777 uint64_t pss_state; /* dsl_scan_state_t */
778 uint64_t pss_start_time; /* scan start time */
779 uint64_t pss_end_time; /* scan end time */
780 uint64_t pss_to_examine; /* total bytes to scan */
781 uint64_t pss_examined; /* total examined bytes */
782 uint64_t pss_to_process; /* total bytes to process */
783 uint64_t pss_processed; /* total processed bytes */
784 uint64_t pss_errors; /* scan errors */
785
786 /* values not stored on disk */
787 uint64_t pss_pass_exam; /* examined bytes per scan pass */
788 uint64_t pss_pass_start; /* start time of a scan pass */
789} pool_scan_stat_t;
790
791typedef enum dsl_scan_state {
792 DSS_NONE,
793 DSS_SCANNING,
794 DSS_FINISHED,
795 DSS_CANCELED,
796 DSS_NUM_STATES
797} dsl_scan_state_t;
798
ffe9d382
BB
799/*
800 * Errata described by http://zfsonlinux.org/msg/ZFS-8000-ER. The ordering
801 * of this enum must be maintained to ensure the errata identifiers map to
802 * the correct documentation. New errata may only be appended to the list
803 * and must contain corresponding documentation at the above link.
804 */
805typedef enum zpool_errata {
806 ZPOOL_ERRATA_NONE,
4f2dcb3e
RY
807 ZPOOL_ERRATA_ZOL_2094_SCRUB,
808 ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY,
ffe9d382 809} zpool_errata_t;
428870ff 810
34dc7c2f
BB
811/*
812 * Vdev statistics. Note: all fields should be 64-bit because this
813 * is passed between kernel and userland as an nvlist uint64 array.
814 */
815typedef struct vdev_stat {
816 hrtime_t vs_timestamp; /* time since vdev load */
817 uint64_t vs_state; /* vdev state */
818 uint64_t vs_aux; /* see vdev_aux_t */
819 uint64_t vs_alloc; /* space allocated */
820 uint64_t vs_space; /* total capacity */
821 uint64_t vs_dspace; /* deflated capacity */
822 uint64_t vs_rsize; /* replaceable dev size */
1bd201e7 823 uint64_t vs_esize; /* expandable dev size */
34dc7c2f
BB
824 uint64_t vs_ops[ZIO_TYPES]; /* operation count */
825 uint64_t vs_bytes[ZIO_TYPES]; /* bytes read/written */
826 uint64_t vs_read_errors; /* read errors */
827 uint64_t vs_write_errors; /* write errors */
828 uint64_t vs_checksum_errors; /* checksum errors */
829 uint64_t vs_self_healed; /* self-healed bytes */
428870ff
BB
830 uint64_t vs_scan_removing; /* removing? */
831 uint64_t vs_scan_processed; /* scan processed bytes */
f3a7f661 832 uint64_t vs_fragmentation; /* device fragmentation */
193a37cb 833
34dc7c2f
BB
834} vdev_stat_t;
835
193a37cb
TH
836/*
837 * Extended stats
838 *
839 * These are stats which aren't included in the original iostat output. For
840 * convenience, they are grouped together in vdev_stat_ex, although each stat
d5884c34 841 * is individually exported as an nvlist.
193a37cb
TH
842 */
843typedef struct vdev_stat_ex {
844 /* Number of ZIOs issued to disk and waiting to finish */
845 uint64_t vsx_active_queue[ZIO_PRIORITY_NUM_QUEUEABLE];
846
847 /* Number of ZIOs pending to be issued to disk */
848 uint64_t vsx_pend_queue[ZIO_PRIORITY_NUM_QUEUEABLE];
849
850 /*
851 * Below are the histograms for various latencies. Buckets are in
852 * units of nanoseconds.
853 */
854
855 /*
856 * 2^37 nanoseconds = 134s. Timeouts will probably start kicking in
857 * before this.
858 */
7e945072
TH
859#define VDEV_L_HISTO_BUCKETS 37 /* Latency histo buckets */
860#define VDEV_RQ_HISTO_BUCKETS 25 /* Request size histo buckets */
861
193a37cb
TH
862
863 /* Amount of time in ZIO queue (ns) */
864 uint64_t vsx_queue_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
7e945072 865 [VDEV_L_HISTO_BUCKETS];
193a37cb
TH
866
867 /* Total ZIO latency (ns). Includes queuing and disk access time */
7e945072 868 uint64_t vsx_total_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS];
193a37cb
TH
869
870 /* Amount of time to read/write the disk (ns) */
7e945072
TH
871 uint64_t vsx_disk_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS];
872
873 /* "lookup the bucket for a value" histogram macros */
874#define HISTO(val, buckets) (val != 0 ? MIN(highbit64(val) - 1, \
875 buckets - 1) : 0)
876#define L_HISTO(a) HISTO(a, VDEV_L_HISTO_BUCKETS)
877#define RQ_HISTO(a) HISTO(a, VDEV_RQ_HISTO_BUCKETS)
878
879 /* Physical IO histogram */
880 uint64_t vsx_ind_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
881 [VDEV_RQ_HISTO_BUCKETS];
193a37cb 882
7e945072
TH
883 /* Delegated (aggregated) physical IO histogram */
884 uint64_t vsx_agg_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
885 [VDEV_RQ_HISTO_BUCKETS];
193a37cb
TH
886
887} vdev_stat_ex_t;
888
428870ff
BB
889/*
890 * DDT statistics. Note: all fields should be 64-bit because this
891 * is passed between kernel and userland as an nvlist uint64 array.
892 */
893typedef struct ddt_object {
894 uint64_t ddo_count; /* number of elments in ddt */
895 uint64_t ddo_dspace; /* size of ddt on disk */
896 uint64_t ddo_mspace; /* size of ddt in-core */
897} ddt_object_t;
898
899typedef struct ddt_stat {
900 uint64_t dds_blocks; /* blocks */
901 uint64_t dds_lsize; /* logical size */
902 uint64_t dds_psize; /* physical size */
903 uint64_t dds_dsize; /* deflated allocated size */
904 uint64_t dds_ref_blocks; /* referenced blocks */
905 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
906 uint64_t dds_ref_psize; /* referenced psize * refcnt */
907 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
908} ddt_stat_t;
909
910typedef struct ddt_histogram {
911 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
912} ddt_histogram_t;
913
34dc7c2f
BB
914#define ZVOL_DRIVER "zvol"
915#define ZFS_DRIVER "zfs"
916#define ZFS_DEV "/dev/zfs"
917
428870ff 918/* general zvol path */
60101509
BB
919#define ZVOL_DIR "/dev"
920
921#define ZVOL_MAJOR 230
922#define ZVOL_MINOR_BITS 4
923#define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
924#define ZVOL_MINORS (1 << 4)
4c0d8e50 925#define ZVOL_DEV_NAME "zd"
34dc7c2f
BB
926
927#define ZVOL_PROP_NAME "name"
428870ff 928#define ZVOL_DEFAULT_BLOCKSIZE 8192
34dc7c2f
BB
929
930/*
931 * /dev/zfs ioctl numbers.
932 */
34dc7c2f 933typedef enum zfs_ioc {
2e0358cb 934 /*
43e52edd 935 * Illumos - 71/128 numbers reserved.
2e0358cb 936 */
6f1ffb06
MA
937 ZFS_IOC_FIRST = ('Z' << 8),
938 ZFS_IOC = ZFS_IOC_FIRST,
939 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST,
34dc7c2f
BB
940 ZFS_IOC_POOL_DESTROY,
941 ZFS_IOC_POOL_IMPORT,
942 ZFS_IOC_POOL_EXPORT,
943 ZFS_IOC_POOL_CONFIGS,
944 ZFS_IOC_POOL_STATS,
945 ZFS_IOC_POOL_TRYIMPORT,
428870ff 946 ZFS_IOC_POOL_SCAN,
34dc7c2f
BB
947 ZFS_IOC_POOL_FREEZE,
948 ZFS_IOC_POOL_UPGRADE,
949 ZFS_IOC_POOL_GET_HISTORY,
950 ZFS_IOC_VDEV_ADD,
951 ZFS_IOC_VDEV_REMOVE,
952 ZFS_IOC_VDEV_SET_STATE,
953 ZFS_IOC_VDEV_ATTACH,
954 ZFS_IOC_VDEV_DETACH,
955 ZFS_IOC_VDEV_SETPATH,
9babb374 956 ZFS_IOC_VDEV_SETFRU,
34dc7c2f
BB
957 ZFS_IOC_OBJSET_STATS,
958 ZFS_IOC_OBJSET_ZPLPROPS,
959 ZFS_IOC_DATASET_LIST_NEXT,
960 ZFS_IOC_SNAPSHOT_LIST_NEXT,
961 ZFS_IOC_SET_PROP,
34dc7c2f
BB
962 ZFS_IOC_CREATE,
963 ZFS_IOC_DESTROY,
964 ZFS_IOC_ROLLBACK,
965 ZFS_IOC_RENAME,
966 ZFS_IOC_RECV,
967 ZFS_IOC_SEND,
968 ZFS_IOC_INJECT_FAULT,
969 ZFS_IOC_CLEAR_FAULT,
970 ZFS_IOC_INJECT_LIST_NEXT,
971 ZFS_IOC_ERROR_LOG,
972 ZFS_IOC_CLEAR,
973 ZFS_IOC_PROMOTE,
34dc7c2f
BB
974 ZFS_IOC_SNAPSHOT,
975 ZFS_IOC_DSOBJ_TO_DSNAME,
976 ZFS_IOC_OBJ_TO_PATH,
977 ZFS_IOC_POOL_SET_PROPS,
978 ZFS_IOC_POOL_GET_PROPS,
979 ZFS_IOC_SET_FSACL,
980 ZFS_IOC_GET_FSACL,
34dc7c2f 981 ZFS_IOC_SHARE,
9babb374
BB
982 ZFS_IOC_INHERIT_PROP,
983 ZFS_IOC_SMB_ACL,
984 ZFS_IOC_USERSPACE_ONE,
985 ZFS_IOC_USERSPACE_MANY,
45d1cae3
BB
986 ZFS_IOC_USERSPACE_UPGRADE,
987 ZFS_IOC_HOLD,
988 ZFS_IOC_RELEASE,
428870ff
BB
989 ZFS_IOC_GET_HOLDS,
990 ZFS_IOC_OBJSET_RECVD_PROPS,
572e2857
BB
991 ZFS_IOC_VDEV_SPLIT,
992 ZFS_IOC_NEXT_OBJ,
993 ZFS_IOC_DIFF,
994 ZFS_IOC_TMP_SNAPSHOT,
26685276 995 ZFS_IOC_OBJ_TO_STATS,
330d06f9
MA
996 ZFS_IOC_SPACE_WRITTEN,
997 ZFS_IOC_SPACE_SNAPS,
2e0358cb
BB
998 ZFS_IOC_DESTROY_SNAPS,
999 ZFS_IOC_POOL_REGUID,
1bd201e7 1000 ZFS_IOC_POOL_REOPEN,
37abac6d 1001 ZFS_IOC_SEND_PROGRESS,
6f1ffb06
MA
1002 ZFS_IOC_LOG_HISTORY,
1003 ZFS_IOC_SEND_NEW,
1004 ZFS_IOC_SEND_SPACE,
1005 ZFS_IOC_CLONE,
da536844
MA
1006 ZFS_IOC_BOOKMARK,
1007 ZFS_IOC_GET_BOOKMARKS,
1008 ZFS_IOC_DESTROY_BOOKMARKS,
43e52edd 1009 ZFS_IOC_RECV_NEW,
2e0358cb
BB
1010
1011 /*
1012 * Linux - 3/64 numbers reserved.
1013 */
1014 ZFS_IOC_LINUX = ('Z' << 8) + 0x80,
1015 ZFS_IOC_EVENTS_NEXT,
1016 ZFS_IOC_EVENTS_CLEAR,
75e3ff58 1017 ZFS_IOC_EVENTS_SEEK,
2e0358cb
BB
1018
1019 /*
1020 * FreeBSD - 1/64 numbers reserved.
1021 */
1022 ZFS_IOC_FREEBSD = ('Z' << 8) + 0xC0,
1023
6f1ffb06 1024 ZFS_IOC_LAST
34dc7c2f
BB
1025} zfs_ioc_t;
1026
4c0d8e50
FN
1027/*
1028 * zvol ioctl to get dataset name
1029 */
eca7b760 1030#define BLKZNAME _IOR(0x12, 125, char[ZFS_MAX_DATASET_NAME_LEN])
4c0d8e50 1031
34dc7c2f
BB
1032/*
1033 * Internal SPA load state. Used by FMA diagnosis engine.
1034 */
1035typedef enum {
428870ff
BB
1036 SPA_LOAD_NONE, /* no load in progress */
1037 SPA_LOAD_OPEN, /* normal open */
1038 SPA_LOAD_IMPORT, /* import in progress */
1039 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
1040 SPA_LOAD_RECOVER, /* recovery requested */
3dfb57a3
DB
1041 SPA_LOAD_ERROR, /* load failed */
1042 SPA_LOAD_CREATE /* creation in progress */
34dc7c2f
BB
1043} spa_load_state_t;
1044
1045/*
1046 * Bookmark name values.
1047 */
1048#define ZPOOL_ERR_LIST "error list"
1049#define ZPOOL_ERR_DATASET "dataset"
1050#define ZPOOL_ERR_OBJECT "object"
1051
1052#define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
1053
1054/*
1055 * The following are names used in the nvlist describing
1056 * the pool's history log.
1057 */
1058#define ZPOOL_HIST_RECORD "history record"
1059#define ZPOOL_HIST_TIME "history time"
1060#define ZPOOL_HIST_CMD "history command"
1061#define ZPOOL_HIST_WHO "history who"
1062#define ZPOOL_HIST_ZONE "history zone"
1063#define ZPOOL_HIST_HOST "history hostname"
1064#define ZPOOL_HIST_TXG "history txg"
1065#define ZPOOL_HIST_INT_EVENT "history internal event"
1066#define ZPOOL_HIST_INT_STR "history internal str"
6f1ffb06
MA
1067#define ZPOOL_HIST_INT_NAME "internal_name"
1068#define ZPOOL_HIST_IOCTL "ioctl"
1069#define ZPOOL_HIST_INPUT_NVL "in_nvl"
1070#define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
1071#define ZPOOL_HIST_DSNAME "dsname"
1072#define ZPOOL_HIST_DSID "dsid"
34dc7c2f
BB
1073
1074/*
1075 * Flags for ZFS_IOC_VDEV_SET_STATE
1076 */
1077#define ZFS_ONLINE_CHECKREMOVE 0x1
1078#define ZFS_ONLINE_UNSPARE 0x2
1079#define ZFS_ONLINE_FORCEFAULT 0x4
9babb374 1080#define ZFS_ONLINE_EXPAND 0x8
34dc7c2f
BB
1081#define ZFS_OFFLINE_TEMPORARY 0x1
1082
572e2857
BB
1083/*
1084 * Flags for ZFS_IOC_POOL_IMPORT
1085 */
1086#define ZFS_IMPORT_NORMAL 0x0
1087#define ZFS_IMPORT_VERBATIM 0x1
1088#define ZFS_IMPORT_ANY_HOST 0x2
1089#define ZFS_IMPORT_MISSING_LOG 0x4
1090#define ZFS_IMPORT_ONLY 0x8
26b42f3f 1091#define ZFS_IMPORT_TEMP_NAME 0x10
572e2857 1092
34dc7c2f
BB
1093/*
1094 * Sysevent payload members. ZFS will generate the following sysevents with the
1095 * given payloads:
1096 *
1097 * ESC_ZFS_RESILVER_START
1098 * ESC_ZFS_RESILVER_END
1099 * ESC_ZFS_POOL_DESTROY
3541dc6d 1100 * ESC_ZFS_POOL_REGUID
34dc7c2f
BB
1101 *
1102 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1103 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1104 *
1105 * ESC_ZFS_VDEV_REMOVE
1106 * ESC_ZFS_VDEV_CLEAR
1107 * ESC_ZFS_VDEV_CHECK
1108 *
1109 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1110 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1111 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
1112 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
1113 */
1114#define ZFS_EV_POOL_NAME "pool_name"
1115#define ZFS_EV_POOL_GUID "pool_guid"
1116#define ZFS_EV_VDEV_PATH "vdev_path"
1117#define ZFS_EV_VDEV_GUID "vdev_guid"
1118
34dc7c2f
BB
1119#ifdef __cplusplus
1120}
1121#endif
1122
1123#endif /* _SYS_FS_ZFS_H */