?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
config/dracut/90zfs: handle cases where hostid(1) returns all zeros
[zfs.git] / include / sys / fs / zfs.h
blob60c1b84602a3ba6716d1d80de26c7cd159d89219
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 */
21
22 /*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011, 2020 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, Intel Corporation.
29 * Copyright (c) 2019 Datto Inc.
30 */
31
32 /* Portions Copyright 2010 Robert Milkowski */
33
34 #ifndef _SYS_FS_ZFS_H
35 #define _SYS_FS_ZFS_H
36
37 #include <sys/time.h>
38 #include <sys/zio_priority.h>
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /*
45 * Types and constants shared between userland and the kernel.
46 */
47
48 /*
49 * Each dataset can be one of the following types. These constants can be
50 * combined into masks that can be passed to various functions.
51 */
52 typedef enum {
53 ZFS_TYPE_FILESYSTEM = (1 << 0),
54 ZFS_TYPE_SNAPSHOT = (1 << 1),
55 ZFS_TYPE_VOLUME = (1 << 2),
56 ZFS_TYPE_POOL = (1 << 3),
57 ZFS_TYPE_BOOKMARK = (1 << 4)
58 } zfs_type_t;
59
60 /*
61 * NB: lzc_dataset_type should be updated whenever a new objset type is added,
62 * if it represents a real type of a dataset that can be created from userland.
63 */
64 typedef enum dmu_objset_type {
65 DMU_OST_NONE,
66 DMU_OST_META,
67 DMU_OST_ZFS,
68 DMU_OST_ZVOL,
69 DMU_OST_OTHER, /* For testing only! */
70 DMU_OST_ANY, /* Be careful! */
71 DMU_OST_NUMTYPES
72 } dmu_objset_type_t;
73
74 #define ZFS_TYPE_DATASET \
75 (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME | ZFS_TYPE_SNAPSHOT)
76
77 /*
78 * All of these include the terminating NUL byte.
79 */
80 #define ZAP_MAXNAMELEN 256
81 #define ZAP_MAXVALUELEN (1024 * 8)
82 #define ZAP_OLDMAXVALUELEN 1024
83 #define ZFS_MAX_DATASET_NAME_LEN 256
84
85 /*
86 * Dataset properties are identified by these constants and must be added to
87 * the end of this list to ensure that external consumers are not affected
88 * by the change. If you make any changes to this list, be sure to update
89 * the property table in module/zcommon/zfs_prop.c.
90 */
91 typedef enum {
92 ZPROP_CONT = -2,
93 ZPROP_INVAL = -1,
94 ZFS_PROP_TYPE = 0,
95 ZFS_PROP_CREATION,
96 ZFS_PROP_USED,
97 ZFS_PROP_AVAILABLE,
98 ZFS_PROP_REFERENCED,
99 ZFS_PROP_COMPRESSRATIO,
100 ZFS_PROP_MOUNTED,
101 ZFS_PROP_ORIGIN,
102 ZFS_PROP_QUOTA,
103 ZFS_PROP_RESERVATION,
104 ZFS_PROP_VOLSIZE,
105 ZFS_PROP_VOLBLOCKSIZE,
106 ZFS_PROP_RECORDSIZE,
107 ZFS_PROP_MOUNTPOINT,
108 ZFS_PROP_SHARENFS,
109 ZFS_PROP_CHECKSUM,
110 ZFS_PROP_COMPRESSION,
111 ZFS_PROP_ATIME,
112 ZFS_PROP_DEVICES,
113 ZFS_PROP_EXEC,
114 ZFS_PROP_SETUID,
115 ZFS_PROP_READONLY,
116 ZFS_PROP_ZONED,
117 ZFS_PROP_SNAPDIR,
118 ZFS_PROP_ACLMODE,
119 ZFS_PROP_ACLINHERIT,
120 ZFS_PROP_CREATETXG,
121 ZFS_PROP_NAME, /* not exposed to the user */
122 ZFS_PROP_CANMOUNT,
123 ZFS_PROP_ISCSIOPTIONS, /* not exposed to the user */
124 ZFS_PROP_XATTR,
125 ZFS_PROP_NUMCLONES, /* not exposed to the user */
126 ZFS_PROP_COPIES,
127 ZFS_PROP_VERSION,
128 ZFS_PROP_UTF8ONLY,
129 ZFS_PROP_NORMALIZE,
130 ZFS_PROP_CASE,
131 ZFS_PROP_VSCAN,
132 ZFS_PROP_NBMAND,
133 ZFS_PROP_SHARESMB,
134 ZFS_PROP_REFQUOTA,
135 ZFS_PROP_REFRESERVATION,
136 ZFS_PROP_GUID,
137 ZFS_PROP_PRIMARYCACHE,
138 ZFS_PROP_SECONDARYCACHE,
139 ZFS_PROP_USEDSNAP,
140 ZFS_PROP_USEDDS,
141 ZFS_PROP_USEDCHILD,
142 ZFS_PROP_USEDREFRESERV,
143 ZFS_PROP_USERACCOUNTING, /* not exposed to the user */
144 ZFS_PROP_STMF_SHAREINFO, /* not exposed to the user */
145 ZFS_PROP_DEFER_DESTROY,
146 ZFS_PROP_USERREFS,
147 ZFS_PROP_LOGBIAS,
148 ZFS_PROP_UNIQUE, /* not exposed to the user */
149 ZFS_PROP_OBJSETID,
150 ZFS_PROP_DEDUP,
151 ZFS_PROP_MLSLABEL,
152 ZFS_PROP_SYNC,
153 ZFS_PROP_DNODESIZE,
154 ZFS_PROP_REFRATIO,
155 ZFS_PROP_WRITTEN,
156 ZFS_PROP_CLONES,
157 ZFS_PROP_LOGICALUSED,
158 ZFS_PROP_LOGICALREFERENCED,
159 ZFS_PROP_INCONSISTENT, /* not exposed to the user */
160 ZFS_PROP_VOLMODE,
161 ZFS_PROP_FILESYSTEM_LIMIT,
162 ZFS_PROP_SNAPSHOT_LIMIT,
163 ZFS_PROP_FILESYSTEM_COUNT,
164 ZFS_PROP_SNAPSHOT_COUNT,
165 ZFS_PROP_SNAPDEV,
166 ZFS_PROP_ACLTYPE,
167 ZFS_PROP_SELINUX_CONTEXT,
168 ZFS_PROP_SELINUX_FSCONTEXT,
169 ZFS_PROP_SELINUX_DEFCONTEXT,
170 ZFS_PROP_SELINUX_ROOTCONTEXT,
171 ZFS_PROP_RELATIME,
172 ZFS_PROP_REDUNDANT_METADATA,
173 ZFS_PROP_OVERLAY,
174 ZFS_PROP_PREV_SNAP,
175 ZFS_PROP_RECEIVE_RESUME_TOKEN,
176 ZFS_PROP_ENCRYPTION,
177 ZFS_PROP_KEYLOCATION,
178 ZFS_PROP_KEYFORMAT,
179 ZFS_PROP_PBKDF2_SALT,
180 ZFS_PROP_PBKDF2_ITERS,
181 ZFS_PROP_ENCRYPTION_ROOT,
182 ZFS_PROP_KEY_GUID,
183 ZFS_PROP_KEYSTATUS,
184 ZFS_PROP_REMAPTXG, /* obsolete - no longer used */
185 ZFS_PROP_SPECIAL_SMALL_BLOCKS,
186 ZFS_PROP_IVSET_GUID, /* not exposed to the user */
187 ZFS_PROP_REDACTED,
188 ZFS_PROP_REDACT_SNAPS,
189 ZFS_NUM_PROPS
190 } zfs_prop_t;
191
192 typedef enum {
193 ZFS_PROP_USERUSED,
194 ZFS_PROP_USERQUOTA,
195 ZFS_PROP_GROUPUSED,
196 ZFS_PROP_GROUPQUOTA,
197 ZFS_PROP_USEROBJUSED,
198 ZFS_PROP_USEROBJQUOTA,
199 ZFS_PROP_GROUPOBJUSED,
200 ZFS_PROP_GROUPOBJQUOTA,
201 ZFS_PROP_PROJECTUSED,
202 ZFS_PROP_PROJECTQUOTA,
203 ZFS_PROP_PROJECTOBJUSED,
204 ZFS_PROP_PROJECTOBJQUOTA,
205 ZFS_NUM_USERQUOTA_PROPS
206 } zfs_userquota_prop_t;
207
208 extern const char *zfs_userquota_prop_prefixes[ZFS_NUM_USERQUOTA_PROPS];
209
210 /*
211 * Pool properties are identified by these constants and must be added to the
212 * end of this list to ensure that external consumers are not affected
213 * by the change. Properties must be registered in zfs_prop_init().
214 */
215 typedef enum {
216 ZPOOL_PROP_INVAL = -1,
217 ZPOOL_PROP_NAME,
218 ZPOOL_PROP_SIZE,
219 ZPOOL_PROP_CAPACITY,
220 ZPOOL_PROP_ALTROOT,
221 ZPOOL_PROP_HEALTH,
222 ZPOOL_PROP_GUID,
223 ZPOOL_PROP_VERSION,
224 ZPOOL_PROP_BOOTFS,
225 ZPOOL_PROP_DELEGATION,
226 ZPOOL_PROP_AUTOREPLACE,
227 ZPOOL_PROP_CACHEFILE,
228 ZPOOL_PROP_FAILUREMODE,
229 ZPOOL_PROP_LISTSNAPS,
230 ZPOOL_PROP_AUTOEXPAND,
231 ZPOOL_PROP_DEDUPDITTO,
232 ZPOOL_PROP_DEDUPRATIO,
233 ZPOOL_PROP_FREE,
234 ZPOOL_PROP_ALLOCATED,
235 ZPOOL_PROP_READONLY,
236 ZPOOL_PROP_ASHIFT,
237 ZPOOL_PROP_COMMENT,
238 ZPOOL_PROP_EXPANDSZ,
239 ZPOOL_PROP_FREEING,
240 ZPOOL_PROP_FRAGMENTATION,
241 ZPOOL_PROP_LEAKED,
242 ZPOOL_PROP_MAXBLOCKSIZE,
243 ZPOOL_PROP_TNAME,
244 ZPOOL_PROP_MAXDNODESIZE,
245 ZPOOL_PROP_MULTIHOST,
246 ZPOOL_PROP_CHECKPOINT,
247 ZPOOL_PROP_LOAD_GUID,
248 ZPOOL_PROP_AUTOTRIM,
249 ZPOOL_NUM_PROPS
250 } zpool_prop_t;
251
252 /* Small enough to not hog a whole line of printout in zpool(8). */
253 #define ZPROP_MAX_COMMENT 32
254
255 #define ZPROP_VALUE "value"
256 #define ZPROP_SOURCE "source"
257
258 typedef enum {
259 ZPROP_SRC_NONE = 0x1,
260 ZPROP_SRC_DEFAULT = 0x2,
261 ZPROP_SRC_TEMPORARY = 0x4,
262 ZPROP_SRC_LOCAL = 0x8,
263 ZPROP_SRC_INHERITED = 0x10,
264 ZPROP_SRC_RECEIVED = 0x20
265 } zprop_source_t;
266
267 #define ZPROP_SRC_ALL 0x3f
268
269 #define ZPROP_SOURCE_VAL_RECVD "$recvd"
270 #define ZPROP_N_MORE_ERRORS "N_MORE_ERRORS"
271
272 /*
273 * Dataset flag implemented as a special entry in the props zap object
274 * indicating that the dataset has received properties on or after
275 * SPA_VERSION_RECVD_PROPS. The first such receive blows away local properties
276 * just as it did in earlier versions, and thereafter, local properties are
277 * preserved.
278 */
279 #define ZPROP_HAS_RECVD "$hasrecvd"
280
281 typedef enum {
282 ZPROP_ERR_NOCLEAR = 0x1, /* failure to clear existing props */
283 ZPROP_ERR_NORESTORE = 0x2 /* failure to restore props on error */
284 } zprop_errflags_t;
285
286 typedef int (*zprop_func)(int, void *);
287
288 /*
289 * Properties to be set on the root file system of a new pool
290 * are stuffed into their own nvlist, which is then included in
291 * the properties nvlist with the pool properties.
292 */
293 #define ZPOOL_ROOTFS_PROPS "root-props-nvl"
294
295 /*
296 * Length of 'written@' and 'written#'
297 */
298 #define ZFS_WRITTEN_PROP_PREFIX_LEN 8
299
300 /*
301 * Dataset property functions shared between libzfs and kernel.
302 */
303 const char *zfs_prop_default_string(zfs_prop_t);
304 uint64_t zfs_prop_default_numeric(zfs_prop_t);
305 boolean_t zfs_prop_readonly(zfs_prop_t);
306 boolean_t zfs_prop_visible(zfs_prop_t prop);
307 boolean_t zfs_prop_inheritable(zfs_prop_t);
308 boolean_t zfs_prop_setonce(zfs_prop_t);
309 boolean_t zfs_prop_encryption_key_param(zfs_prop_t);
310 boolean_t zfs_prop_valid_keylocation(const char *, boolean_t);
311 const char *zfs_prop_to_name(zfs_prop_t);
312 zfs_prop_t zfs_name_to_prop(const char *);
313 boolean_t zfs_prop_user(const char *);
314 boolean_t zfs_prop_userquota(const char *);
315 boolean_t zfs_prop_written(const char *);
316 int zfs_prop_index_to_string(zfs_prop_t, uint64_t, const char **);
317 int zfs_prop_string_to_index(zfs_prop_t, const char *, uint64_t *);
318 uint64_t zfs_prop_random_value(zfs_prop_t, uint64_t seed);
319 boolean_t zfs_prop_valid_for_type(int, zfs_type_t, boolean_t);
320
321 /*
322 * Pool property functions shared between libzfs and kernel.
323 */
324 zpool_prop_t zpool_name_to_prop(const char *);
325 const char *zpool_prop_to_name(zpool_prop_t);
326 const char *zpool_prop_default_string(zpool_prop_t);
327 uint64_t zpool_prop_default_numeric(zpool_prop_t);
328 boolean_t zpool_prop_readonly(zpool_prop_t);
329 boolean_t zpool_prop_setonce(zpool_prop_t);
330 boolean_t zpool_prop_feature(const char *);
331 boolean_t zpool_prop_unsupported(const char *);
332 int zpool_prop_index_to_string(zpool_prop_t, uint64_t, const char **);
333 int zpool_prop_string_to_index(zpool_prop_t, const char *, uint64_t *);
334 uint64_t zpool_prop_random_value(zpool_prop_t, uint64_t seed);
335
336 /*
337 * Definitions for the Delegation.
338 */
339 typedef enum {
340 ZFS_DELEG_WHO_UNKNOWN = 0,
341 ZFS_DELEG_USER = 'u',
342 ZFS_DELEG_USER_SETS = 'U',
343 ZFS_DELEG_GROUP = 'g',
344 ZFS_DELEG_GROUP_SETS = 'G',
345 ZFS_DELEG_EVERYONE = 'e',
346 ZFS_DELEG_EVERYONE_SETS = 'E',
347 ZFS_DELEG_CREATE = 'c',
348 ZFS_DELEG_CREATE_SETS = 'C',
349 ZFS_DELEG_NAMED_SET = 's',
350 ZFS_DELEG_NAMED_SET_SETS = 'S'
351 } zfs_deleg_who_type_t;
352
353 typedef enum {
354 ZFS_DELEG_NONE = 0,
355 ZFS_DELEG_PERM_LOCAL = 1,
356 ZFS_DELEG_PERM_DESCENDENT = 2,
357 ZFS_DELEG_PERM_LOCALDESCENDENT = 3,
358 ZFS_DELEG_PERM_CREATE = 4
359 } zfs_deleg_inherit_t;
360
361 #define ZFS_DELEG_PERM_UID "uid"
362 #define ZFS_DELEG_PERM_GID "gid"
363 #define ZFS_DELEG_PERM_GROUPS "groups"
364
365 #define ZFS_MLSLABEL_DEFAULT "none"
366
367 #define ZFS_SMB_ACL_SRC "src"
368 #define ZFS_SMB_ACL_TARGET "target"
369
370 typedef enum {
371 ZFS_CANMOUNT_OFF = 0,
372 ZFS_CANMOUNT_ON = 1,
373 ZFS_CANMOUNT_NOAUTO = 2
374 } zfs_canmount_type_t;
375
376 typedef enum {
377 ZFS_LOGBIAS_LATENCY = 0,
378 ZFS_LOGBIAS_THROUGHPUT = 1
379 } zfs_logbias_op_t;
380
381 typedef enum zfs_share_op {
382 ZFS_SHARE_NFS = 0,
383 ZFS_UNSHARE_NFS = 1,
384 ZFS_SHARE_SMB = 2,
385 ZFS_UNSHARE_SMB = 3
386 } zfs_share_op_t;
387
388 typedef enum zfs_smb_acl_op {
389 ZFS_SMB_ACL_ADD,
390 ZFS_SMB_ACL_REMOVE,
391 ZFS_SMB_ACL_RENAME,
392 ZFS_SMB_ACL_PURGE
393 } zfs_smb_acl_op_t;
394
395 typedef enum zfs_cache_type {
396 ZFS_CACHE_NONE = 0,
397 ZFS_CACHE_METADATA = 1,
398 ZFS_CACHE_ALL = 2
399 } zfs_cache_type_t;
400
401 typedef enum {
402 ZFS_SYNC_STANDARD = 0,
403 ZFS_SYNC_ALWAYS = 1,
404 ZFS_SYNC_DISABLED = 2
405 } zfs_sync_type_t;
406
407 typedef enum {
408 ZFS_XATTR_OFF = 0,
409 ZFS_XATTR_DIR = 1,
410 ZFS_XATTR_SA = 2
411 } zfs_xattr_type_t;
412
413 typedef enum {
414 ZFS_DNSIZE_LEGACY = 0,
415 ZFS_DNSIZE_AUTO = 1,
416 ZFS_DNSIZE_1K = 1024,
417 ZFS_DNSIZE_2K = 2048,
418 ZFS_DNSIZE_4K = 4096,
419 ZFS_DNSIZE_8K = 8192,
420 ZFS_DNSIZE_16K = 16384
421 } zfs_dnsize_type_t;
422
423 typedef enum {
424 ZFS_REDUNDANT_METADATA_ALL,
425 ZFS_REDUNDANT_METADATA_MOST
426 } zfs_redundant_metadata_type_t;
427
428 typedef enum {
429 ZFS_VOLMODE_DEFAULT = 0,
430 ZFS_VOLMODE_GEOM = 1,
431 ZFS_VOLMODE_DEV = 2,
432 ZFS_VOLMODE_NONE = 3
433 } zfs_volmode_t;
434
435 typedef enum zfs_keystatus {
436 ZFS_KEYSTATUS_NONE = 0,
437 ZFS_KEYSTATUS_UNAVAILABLE,
438 ZFS_KEYSTATUS_AVAILABLE,
439 } zfs_keystatus_t;
440
441 typedef enum zfs_keyformat {
442 ZFS_KEYFORMAT_NONE = 0,
443 ZFS_KEYFORMAT_RAW,
444 ZFS_KEYFORMAT_HEX,
445 ZFS_KEYFORMAT_PASSPHRASE,
446 ZFS_KEYFORMAT_FORMATS
447 } zfs_keyformat_t;
448
449 typedef enum zfs_key_location {
450 ZFS_KEYLOCATION_NONE = 0,
451 ZFS_KEYLOCATION_PROMPT,
452 ZFS_KEYLOCATION_URI,
453 ZFS_KEYLOCATION_LOCATIONS
454 } zfs_keylocation_t;
455
456 #define DEFAULT_PBKDF2_ITERATIONS 350000
457 #define MIN_PBKDF2_ITERATIONS 100000
458
459 /*
460 * On-disk version number.
461 */
462 #define SPA_VERSION_1 1ULL
463 #define SPA_VERSION_2 2ULL
464 #define SPA_VERSION_3 3ULL
465 #define SPA_VERSION_4 4ULL
466 #define SPA_VERSION_5 5ULL
467 #define SPA_VERSION_6 6ULL
468 #define SPA_VERSION_7 7ULL
469 #define SPA_VERSION_8 8ULL
470 #define SPA_VERSION_9 9ULL
471 #define SPA_VERSION_10 10ULL
472 #define SPA_VERSION_11 11ULL
473 #define SPA_VERSION_12 12ULL
474 #define SPA_VERSION_13 13ULL
475 #define SPA_VERSION_14 14ULL
476 #define SPA_VERSION_15 15ULL
477 #define SPA_VERSION_16 16ULL
478 #define SPA_VERSION_17 17ULL
479 #define SPA_VERSION_18 18ULL
480 #define SPA_VERSION_19 19ULL
481 #define SPA_VERSION_20 20ULL
482 #define SPA_VERSION_21 21ULL
483 #define SPA_VERSION_22 22ULL
484 #define SPA_VERSION_23 23ULL
485 #define SPA_VERSION_24 24ULL
486 #define SPA_VERSION_25 25ULL
487 #define SPA_VERSION_26 26ULL
488 #define SPA_VERSION_27 27ULL
489 #define SPA_VERSION_28 28ULL
490 #define SPA_VERSION_5000 5000ULL
491
492 /*
493 * The incrementing pool version number has been replaced by pool feature
494 * flags. For more details, see zfeature.c.
495 */
496 #define SPA_VERSION SPA_VERSION_5000
497 #define SPA_VERSION_STRING "5000"
498
499 /*
500 * Symbolic names for the changes that caused a SPA_VERSION switch.
501 * Used in the code when checking for presence or absence of a feature.
502 * Feel free to define multiple symbolic names for each version if there
503 * were multiple changes to on-disk structures during that version.
504 *
505 * NOTE: When checking the current SPA_VERSION in your code, be sure
506 * to use spa_version() since it reports the version of the
507 * last synced uberblock. Checking the in-flight version can
508 * be dangerous in some cases.
509 */
510 #define SPA_VERSION_INITIAL SPA_VERSION_1
511 #define SPA_VERSION_DITTO_BLOCKS SPA_VERSION_2
512 #define SPA_VERSION_SPARES SPA_VERSION_3
513 #define SPA_VERSION_RAIDZ2 SPA_VERSION_3
514 #define SPA_VERSION_BPOBJ_ACCOUNT SPA_VERSION_3
515 #define SPA_VERSION_RAIDZ_DEFLATE SPA_VERSION_3
516 #define SPA_VERSION_DNODE_BYTES SPA_VERSION_3
517 #define SPA_VERSION_ZPOOL_HISTORY SPA_VERSION_4
518 #define SPA_VERSION_GZIP_COMPRESSION SPA_VERSION_5
519 #define SPA_VERSION_BOOTFS SPA_VERSION_6
520 #define SPA_VERSION_SLOGS SPA_VERSION_7
521 #define SPA_VERSION_DELEGATED_PERMS SPA_VERSION_8
522 #define SPA_VERSION_FUID SPA_VERSION_9
523 #define SPA_VERSION_REFRESERVATION SPA_VERSION_9
524 #define SPA_VERSION_REFQUOTA SPA_VERSION_9
525 #define SPA_VERSION_UNIQUE_ACCURATE SPA_VERSION_9
526 #define SPA_VERSION_L2CACHE SPA_VERSION_10
527 #define SPA_VERSION_NEXT_CLONES SPA_VERSION_11
528 #define SPA_VERSION_ORIGIN SPA_VERSION_11
529 #define SPA_VERSION_DSL_SCRUB SPA_VERSION_11
530 #define SPA_VERSION_SNAP_PROPS SPA_VERSION_12
531 #define SPA_VERSION_USED_BREAKDOWN SPA_VERSION_13
532 #define SPA_VERSION_PASSTHROUGH_X SPA_VERSION_14
533 #define SPA_VERSION_USERSPACE SPA_VERSION_15
534 #define SPA_VERSION_STMF_PROP SPA_VERSION_16
535 #define SPA_VERSION_RAIDZ3 SPA_VERSION_17
536 #define SPA_VERSION_USERREFS SPA_VERSION_18
537 #define SPA_VERSION_HOLES SPA_VERSION_19
538 #define SPA_VERSION_ZLE_COMPRESSION SPA_VERSION_20
539 #define SPA_VERSION_DEDUP SPA_VERSION_21
540 #define SPA_VERSION_RECVD_PROPS SPA_VERSION_22
541 #define SPA_VERSION_SLIM_ZIL SPA_VERSION_23
542 #define SPA_VERSION_SA SPA_VERSION_24
543 #define SPA_VERSION_SCAN SPA_VERSION_25
544 #define SPA_VERSION_DIR_CLONES SPA_VERSION_26
545 #define SPA_VERSION_DEADLISTS SPA_VERSION_26
546 #define SPA_VERSION_FAST_SNAP SPA_VERSION_27
547 #define SPA_VERSION_MULTI_REPLACE SPA_VERSION_28
548 #define SPA_VERSION_BEFORE_FEATURES SPA_VERSION_28
549 #define SPA_VERSION_FEATURES SPA_VERSION_5000
550
551 #define SPA_VERSION_IS_SUPPORTED(v) \
552 (((v) >= SPA_VERSION_INITIAL && (v) <= SPA_VERSION_BEFORE_FEATURES) || \
553 ((v) >= SPA_VERSION_FEATURES && (v) <= SPA_VERSION))
554
555 /*
556 * ZPL version - rev'd whenever an incompatible on-disk format change
557 * occurs. This is independent of SPA/DMU/ZAP versioning. You must
558 * also update the version_table[] and help message in zfs_prop.c.
559 */
560 #define ZPL_VERSION_1 1ULL
561 #define ZPL_VERSION_2 2ULL
562 #define ZPL_VERSION_3 3ULL
563 #define ZPL_VERSION_4 4ULL
564 #define ZPL_VERSION_5 5ULL
565 #define ZPL_VERSION ZPL_VERSION_5
566 #define ZPL_VERSION_STRING "5"
567
568 #define ZPL_VERSION_INITIAL ZPL_VERSION_1
569 #define ZPL_VERSION_DIRENT_TYPE ZPL_VERSION_2
570 #define ZPL_VERSION_FUID ZPL_VERSION_3
571 #define ZPL_VERSION_NORMALIZATION ZPL_VERSION_3
572 #define ZPL_VERSION_SYSATTR ZPL_VERSION_3
573 #define ZPL_VERSION_USERSPACE ZPL_VERSION_4
574 #define ZPL_VERSION_SA ZPL_VERSION_5
575
576 /* Persistent L2ARC version */
577 #define L2ARC_PERSISTENT_VERSION_1 1ULL
578 #define L2ARC_PERSISTENT_VERSION L2ARC_PERSISTENT_VERSION_1
579 #define L2ARC_PERSISTENT_VERSION_STRING "1"
580
581 /* Rewind policy information */
582 #define ZPOOL_NO_REWIND 1 /* No policy - default behavior */
583 #define ZPOOL_NEVER_REWIND 2 /* Do not search for best txg or rewind */
584 #define ZPOOL_TRY_REWIND 4 /* Search for best txg, but do not rewind */
585 #define ZPOOL_DO_REWIND 8 /* Rewind to best txg w/in deferred frees */
586 #define ZPOOL_EXTREME_REWIND 16 /* Allow extreme measures to find best txg */
587 #define ZPOOL_REWIND_MASK 28 /* All the possible rewind bits */
588 #define ZPOOL_REWIND_POLICIES 31 /* All the possible policy bits */
589
590 typedef struct zpool_load_policy {
591 uint32_t zlp_rewind; /* rewind policy requested */
592 uint64_t zlp_maxmeta; /* max acceptable meta-data errors */
593 uint64_t zlp_maxdata; /* max acceptable data errors */
594 uint64_t zlp_txg; /* specific txg to load */
595 } zpool_load_policy_t;
596
597 /*
598 * The following are configuration names used in the nvlist describing a pool's
599 * configuration. New on-disk names should be prefixed with "<reversed-DNS>:"
600 * (e.g. "org.openzfs:") to avoid conflicting names being developed
601 * independently.
602 */
603 #define ZPOOL_CONFIG_VERSION "version"
604 #define ZPOOL_CONFIG_POOL_NAME "name"
605 #define ZPOOL_CONFIG_POOL_STATE "state"
606 #define ZPOOL_CONFIG_POOL_TXG "txg"
607 #define ZPOOL_CONFIG_POOL_GUID "pool_guid"
608 #define ZPOOL_CONFIG_CREATE_TXG "create_txg"
609 #define ZPOOL_CONFIG_TOP_GUID "top_guid"
610 #define ZPOOL_CONFIG_VDEV_TREE "vdev_tree"
611 #define ZPOOL_CONFIG_TYPE "type"
612 #define ZPOOL_CONFIG_CHILDREN "children"
613 #define ZPOOL_CONFIG_ID "id"
614 #define ZPOOL_CONFIG_GUID "guid"
615 #define ZPOOL_CONFIG_INDIRECT_OBJECT "com.delphix:indirect_object"
616 #define ZPOOL_CONFIG_INDIRECT_BIRTHS "com.delphix:indirect_births"
617 #define ZPOOL_CONFIG_PREV_INDIRECT_VDEV "com.delphix:prev_indirect_vdev"
618 #define ZPOOL_CONFIG_PATH "path"
619 #define ZPOOL_CONFIG_DEVID "devid"
620 #define ZPOOL_CONFIG_SPARE_ID "spareid"
621 #define ZPOOL_CONFIG_METASLAB_ARRAY "metaslab_array"
622 #define ZPOOL_CONFIG_METASLAB_SHIFT "metaslab_shift"
623 #define ZPOOL_CONFIG_ASHIFT "ashift"
624 #define ZPOOL_CONFIG_ASIZE "asize"
625 #define ZPOOL_CONFIG_DTL "DTL"
626 #define ZPOOL_CONFIG_SCAN_STATS "scan_stats" /* not stored on disk */
627 #define ZPOOL_CONFIG_REMOVAL_STATS "removal_stats" /* not stored on disk */
628 #define ZPOOL_CONFIG_CHECKPOINT_STATS "checkpoint_stats" /* not on disk */
629 #define ZPOOL_CONFIG_VDEV_STATS "vdev_stats" /* not stored on disk */
630 #define ZPOOL_CONFIG_INDIRECT_SIZE "indirect_size" /* not stored on disk */
631
632 /* container nvlist of extended stats */
633 #define ZPOOL_CONFIG_VDEV_STATS_EX "vdev_stats_ex"
634
635 /* Active queue read/write stats */
636 #define ZPOOL_CONFIG_VDEV_SYNC_R_ACTIVE_QUEUE "vdev_sync_r_active_queue"
637 #define ZPOOL_CONFIG_VDEV_SYNC_W_ACTIVE_QUEUE "vdev_sync_w_active_queue"
638 #define ZPOOL_CONFIG_VDEV_ASYNC_R_ACTIVE_QUEUE "vdev_async_r_active_queue"
639 #define ZPOOL_CONFIG_VDEV_ASYNC_W_ACTIVE_QUEUE "vdev_async_w_active_queue"
640 #define ZPOOL_CONFIG_VDEV_SCRUB_ACTIVE_QUEUE "vdev_async_scrub_active_queue"
641 #define ZPOOL_CONFIG_VDEV_TRIM_ACTIVE_QUEUE "vdev_async_trim_active_queue"
642
643 /* Queue sizes */
644 #define ZPOOL_CONFIG_VDEV_SYNC_R_PEND_QUEUE "vdev_sync_r_pend_queue"
645 #define ZPOOL_CONFIG_VDEV_SYNC_W_PEND_QUEUE "vdev_sync_w_pend_queue"
646 #define ZPOOL_CONFIG_VDEV_ASYNC_R_PEND_QUEUE "vdev_async_r_pend_queue"
647 #define ZPOOL_CONFIG_VDEV_ASYNC_W_PEND_QUEUE "vdev_async_w_pend_queue"
648 #define ZPOOL_CONFIG_VDEV_SCRUB_PEND_QUEUE "vdev_async_scrub_pend_queue"
649 #define ZPOOL_CONFIG_VDEV_TRIM_PEND_QUEUE "vdev_async_trim_pend_queue"
650
651 /* Latency read/write histogram stats */
652 #define ZPOOL_CONFIG_VDEV_TOT_R_LAT_HISTO "vdev_tot_r_lat_histo"
653 #define ZPOOL_CONFIG_VDEV_TOT_W_LAT_HISTO "vdev_tot_w_lat_histo"
654 #define ZPOOL_CONFIG_VDEV_DISK_R_LAT_HISTO "vdev_disk_r_lat_histo"
655 #define ZPOOL_CONFIG_VDEV_DISK_W_LAT_HISTO "vdev_disk_w_lat_histo"
656 #define ZPOOL_CONFIG_VDEV_SYNC_R_LAT_HISTO "vdev_sync_r_lat_histo"
657 #define ZPOOL_CONFIG_VDEV_SYNC_W_LAT_HISTO "vdev_sync_w_lat_histo"
658 #define ZPOOL_CONFIG_VDEV_ASYNC_R_LAT_HISTO "vdev_async_r_lat_histo"
659 #define ZPOOL_CONFIG_VDEV_ASYNC_W_LAT_HISTO "vdev_async_w_lat_histo"
660 #define ZPOOL_CONFIG_VDEV_SCRUB_LAT_HISTO "vdev_scrub_histo"
661 #define ZPOOL_CONFIG_VDEV_TRIM_LAT_HISTO "vdev_trim_histo"
662
663 /* Request size histograms */
664 #define ZPOOL_CONFIG_VDEV_SYNC_IND_R_HISTO "vdev_sync_ind_r_histo"
665 #define ZPOOL_CONFIG_VDEV_SYNC_IND_W_HISTO "vdev_sync_ind_w_histo"
666 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_R_HISTO "vdev_async_ind_r_histo"
667 #define ZPOOL_CONFIG_VDEV_ASYNC_IND_W_HISTO "vdev_async_ind_w_histo"
668 #define ZPOOL_CONFIG_VDEV_IND_SCRUB_HISTO "vdev_ind_scrub_histo"
669 #define ZPOOL_CONFIG_VDEV_IND_TRIM_HISTO "vdev_ind_trim_histo"
670 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_R_HISTO "vdev_sync_agg_r_histo"
671 #define ZPOOL_CONFIG_VDEV_SYNC_AGG_W_HISTO "vdev_sync_agg_w_histo"
672 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_R_HISTO "vdev_async_agg_r_histo"
673 #define ZPOOL_CONFIG_VDEV_ASYNC_AGG_W_HISTO "vdev_async_agg_w_histo"
674 #define ZPOOL_CONFIG_VDEV_AGG_SCRUB_HISTO "vdev_agg_scrub_histo"
675 #define ZPOOL_CONFIG_VDEV_AGG_TRIM_HISTO "vdev_agg_trim_histo"
676
677 /* Number of slow IOs */
678 #define ZPOOL_CONFIG_VDEV_SLOW_IOS "vdev_slow_ios"
679
680 /* vdev enclosure sysfs path */
681 #define ZPOOL_CONFIG_VDEV_ENC_SYSFS_PATH "vdev_enc_sysfs_path"
682
683 #define ZPOOL_CONFIG_WHOLE_DISK "whole_disk"
684 #define ZPOOL_CONFIG_ERRCOUNT "error_count"
685 #define ZPOOL_CONFIG_NOT_PRESENT "not_present"
686 #define ZPOOL_CONFIG_SPARES "spares"
687 #define ZPOOL_CONFIG_IS_SPARE "is_spare"
688 #define ZPOOL_CONFIG_NPARITY "nparity"
689 #define ZPOOL_CONFIG_HOSTID "hostid"
690 #define ZPOOL_CONFIG_HOSTNAME "hostname"
691 #define ZPOOL_CONFIG_LOADED_TIME "initial_load_time"
692 #define ZPOOL_CONFIG_UNSPARE "unspare"
693 #define ZPOOL_CONFIG_PHYS_PATH "phys_path"
694 #define ZPOOL_CONFIG_IS_LOG "is_log"
695 #define ZPOOL_CONFIG_L2CACHE "l2cache"
696 #define ZPOOL_CONFIG_HOLE_ARRAY "hole_array"
697 #define ZPOOL_CONFIG_VDEV_CHILDREN "vdev_children"
698 #define ZPOOL_CONFIG_IS_HOLE "is_hole"
699 #define ZPOOL_CONFIG_DDT_HISTOGRAM "ddt_histogram"
700 #define ZPOOL_CONFIG_DDT_OBJ_STATS "ddt_object_stats"
701 #define ZPOOL_CONFIG_DDT_STATS "ddt_stats"
702 #define ZPOOL_CONFIG_SPLIT "splitcfg"
703 #define ZPOOL_CONFIG_ORIG_GUID "orig_guid"
704 #define ZPOOL_CONFIG_SPLIT_GUID "split_guid"
705 #define ZPOOL_CONFIG_SPLIT_LIST "guid_list"
706 #define ZPOOL_CONFIG_REMOVING "removing"
707 #define ZPOOL_CONFIG_RESILVER_TXG "resilver_txg"
708 #define ZPOOL_CONFIG_REBUILD_TXG "rebuild_txg"
709 #define ZPOOL_CONFIG_COMMENT "comment"
710 #define ZPOOL_CONFIG_SUSPENDED "suspended" /* not stored on disk */
711 #define ZPOOL_CONFIG_SUSPENDED_REASON "suspended_reason" /* not stored */
712 #define ZPOOL_CONFIG_TIMESTAMP "timestamp" /* not stored on disk */
713 #define ZPOOL_CONFIG_BOOTFS "bootfs" /* not stored on disk */
714 #define ZPOOL_CONFIG_MISSING_DEVICES "missing_vdevs" /* not stored on disk */
715 #define ZPOOL_CONFIG_LOAD_INFO "load_info" /* not stored on disk */
716 #define ZPOOL_CONFIG_REWIND_INFO "rewind_info" /* not stored on disk */
717 #define ZPOOL_CONFIG_UNSUP_FEAT "unsup_feat" /* not stored on disk */
718 #define ZPOOL_CONFIG_ENABLED_FEAT "enabled_feat" /* not stored on disk */
719 #define ZPOOL_CONFIG_CAN_RDONLY "can_rdonly" /* not stored on disk */
720 #define ZPOOL_CONFIG_FEATURES_FOR_READ "features_for_read"
721 #define ZPOOL_CONFIG_FEATURE_STATS "feature_stats" /* not stored on disk */
722 #define ZPOOL_CONFIG_ERRATA "errata" /* not stored on disk */
723 #define ZPOOL_CONFIG_VDEV_TOP_ZAP "com.delphix:vdev_zap_top"
724 #define ZPOOL_CONFIG_VDEV_LEAF_ZAP "com.delphix:vdev_zap_leaf"
725 #define ZPOOL_CONFIG_HAS_PER_VDEV_ZAPS "com.delphix:has_per_vdev_zaps"
726 #define ZPOOL_CONFIG_RESILVER_DEFER "com.datto:resilver_defer"
727 #define ZPOOL_CONFIG_CACHEFILE "cachefile" /* not stored on disk */
728 #define ZPOOL_CONFIG_MMP_STATE "mmp_state" /* not stored on disk */
729 #define ZPOOL_CONFIG_MMP_TXG "mmp_txg" /* not stored on disk */
730 #define ZPOOL_CONFIG_MMP_SEQ "mmp_seq" /* not stored on disk */
731 #define ZPOOL_CONFIG_MMP_HOSTNAME "mmp_hostname" /* not stored on disk */
732 #define ZPOOL_CONFIG_MMP_HOSTID "mmp_hostid" /* not stored on disk */
733 #define ZPOOL_CONFIG_ALLOCATION_BIAS "alloc_bias" /* not stored on disk */
734 #define ZPOOL_CONFIG_EXPANSION_TIME "expansion_time" /* not stored */
735 #define ZPOOL_CONFIG_REBUILD_STATS "org.openzfs:rebuild_stats"
736
737 /*
738 * The persistent vdev state is stored as separate values rather than a single
739 * 'vdev_state' entry. This is because a device can be in multiple states, such
740 * as offline and degraded.
741 */
742 #define ZPOOL_CONFIG_OFFLINE "offline"
743 #define ZPOOL_CONFIG_FAULTED "faulted"
744 #define ZPOOL_CONFIG_DEGRADED "degraded"
745 #define ZPOOL_CONFIG_REMOVED "removed"
746 #define ZPOOL_CONFIG_FRU "fru"
747 #define ZPOOL_CONFIG_AUX_STATE "aux_state"
748
749 /* Pool load policy parameters */
750 #define ZPOOL_LOAD_POLICY "load-policy"
751 #define ZPOOL_LOAD_REWIND_POLICY "load-rewind-policy"
752 #define ZPOOL_LOAD_REQUEST_TXG "load-request-txg"
753 #define ZPOOL_LOAD_META_THRESH "load-meta-thresh"
754 #define ZPOOL_LOAD_DATA_THRESH "load-data-thresh"
755
756 /* Rewind data discovered */
757 #define ZPOOL_CONFIG_LOAD_TIME "rewind_txg_ts"
758 #define ZPOOL_CONFIG_LOAD_DATA_ERRORS "verify_data_errors"
759 #define ZPOOL_CONFIG_REWIND_TIME "seconds_of_rewind"
760
761 /* dRAID configuration */
762 #define ZPOOL_CONFIG_DRAID_NDATA "draid_ndata"
763 #define ZPOOL_CONFIG_DRAID_NSPARES "draid_nspares"
764 #define ZPOOL_CONFIG_DRAID_NGROUPS "draid_ngroups"
765
766 #define VDEV_TYPE_ROOT "root"
767 #define VDEV_TYPE_MIRROR "mirror"
768 #define VDEV_TYPE_REPLACING "replacing"
769 #define VDEV_TYPE_RAIDZ "raidz"
770 #define VDEV_TYPE_DRAID "draid"
771 #define VDEV_TYPE_DRAID_SPARE "dspare"
772 #define VDEV_TYPE_DISK "disk"
773 #define VDEV_TYPE_FILE "file"
774 #define VDEV_TYPE_MISSING "missing"
775 #define VDEV_TYPE_HOLE "hole"
776 #define VDEV_TYPE_SPARE "spare"
777 #define VDEV_TYPE_LOG "log"
778 #define VDEV_TYPE_L2CACHE "l2cache"
779 #define VDEV_TYPE_INDIRECT "indirect"
780
781 #define VDEV_RAIDZ_MAXPARITY 3
782
783 #define VDEV_DRAID_MAXPARITY 3
784 #define VDEV_DRAID_MIN_CHILDREN 2
785 #define VDEV_DRAID_MAX_CHILDREN UINT8_MAX
786
787 /* VDEV_TOP_ZAP_* are used in top-level vdev ZAP objects. */
788 #define VDEV_TOP_ZAP_INDIRECT_OBSOLETE_SM \
789 "com.delphix:indirect_obsolete_sm"
790 #define VDEV_TOP_ZAP_OBSOLETE_COUNTS_ARE_PRECISE \
791 "com.delphix:obsolete_counts_are_precise"
792 #define VDEV_TOP_ZAP_POOL_CHECKPOINT_SM \
793 "com.delphix:pool_checkpoint_sm"
794 #define VDEV_TOP_ZAP_MS_UNFLUSHED_PHYS_TXGS \
795 "com.delphix:ms_unflushed_phys_txgs"
796
797 #define VDEV_TOP_ZAP_VDEV_REBUILD_PHYS \
798 "org.openzfs:vdev_rebuild"
799
800 #define VDEV_TOP_ZAP_ALLOCATION_BIAS \
801 "org.zfsonlinux:allocation_bias"
802
803 /* vdev metaslab allocation bias */
804 #define VDEV_ALLOC_BIAS_LOG "log"
805 #define VDEV_ALLOC_BIAS_SPECIAL "special"
806 #define VDEV_ALLOC_BIAS_DEDUP "dedup"
807
808 /* vdev initialize state */
809 #define VDEV_LEAF_ZAP_INITIALIZE_LAST_OFFSET \
810 "com.delphix:next_offset_to_initialize"
811 #define VDEV_LEAF_ZAP_INITIALIZE_STATE \
812 "com.delphix:vdev_initialize_state"
813 #define VDEV_LEAF_ZAP_INITIALIZE_ACTION_TIME \
814 "com.delphix:vdev_initialize_action_time"
815
816 /* vdev TRIM state */
817 #define VDEV_LEAF_ZAP_TRIM_LAST_OFFSET \
818 "org.zfsonlinux:next_offset_to_trim"
819 #define VDEV_LEAF_ZAP_TRIM_STATE \
820 "org.zfsonlinux:vdev_trim_state"
821 #define VDEV_LEAF_ZAP_TRIM_ACTION_TIME \
822 "org.zfsonlinux:vdev_trim_action_time"
823 #define VDEV_LEAF_ZAP_TRIM_RATE \
824 "org.zfsonlinux:vdev_trim_rate"
825 #define VDEV_LEAF_ZAP_TRIM_PARTIAL \
826 "org.zfsonlinux:vdev_trim_partial"
827 #define VDEV_LEAF_ZAP_TRIM_SECURE \
828 "org.zfsonlinux:vdev_trim_secure"
829
830 /*
831 * This is needed in userland to report the minimum necessary device size.
832 */
833 #define SPA_MINDEVSIZE (64ULL << 20)
834
835 /*
836 * Set if the fragmentation has not yet been calculated. This can happen
837 * because the space maps have not been upgraded or the histogram feature
838 * is not enabled.
839 */
840 #define ZFS_FRAG_INVALID UINT64_MAX
841
842 /*
843 * The location of the pool configuration repository, shared between kernel and
844 * userland.
845 */
846 #define ZPOOL_CACHE_BOOT "/boot/zfs/zpool.cache"
847 #define ZPOOL_CACHE "/etc/zfs/zpool.cache"
848 /*
849 * vdev states are ordered from least to most healthy.
850 * A vdev that's CANT_OPEN or below is considered unusable.
851 */
852 typedef enum vdev_state {
853 VDEV_STATE_UNKNOWN = 0, /* Uninitialized vdev */
854 VDEV_STATE_CLOSED, /* Not currently open */
855 VDEV_STATE_OFFLINE, /* Not allowed to open */
856 VDEV_STATE_REMOVED, /* Explicitly removed from system */
857 VDEV_STATE_CANT_OPEN, /* Tried to open, but failed */
858 VDEV_STATE_FAULTED, /* External request to fault device */
859 VDEV_STATE_DEGRADED, /* Replicated vdev with unhealthy kids */
860 VDEV_STATE_HEALTHY /* Presumed good */
861 } vdev_state_t;
862
863 #define VDEV_STATE_ONLINE VDEV_STATE_HEALTHY
864
865 /*
866 * vdev aux states. When a vdev is in the CANT_OPEN state, the aux field
867 * of the vdev stats structure uses these constants to distinguish why.
868 */
869 typedef enum vdev_aux {
870 VDEV_AUX_NONE, /* no error */
871 VDEV_AUX_OPEN_FAILED, /* ldi_open_*() or vn_open() failed */
872 VDEV_AUX_CORRUPT_DATA, /* bad label or disk contents */
873 VDEV_AUX_NO_REPLICAS, /* insufficient number of replicas */
874 VDEV_AUX_BAD_GUID_SUM, /* vdev guid sum doesn't match */
875 VDEV_AUX_TOO_SMALL, /* vdev size is too small */
876 VDEV_AUX_BAD_LABEL, /* the label is OK but invalid */
877 VDEV_AUX_VERSION_NEWER, /* on-disk version is too new */
878 VDEV_AUX_VERSION_OLDER, /* on-disk version is too old */
879 VDEV_AUX_UNSUP_FEAT, /* unsupported features */
880 VDEV_AUX_SPARED, /* hot spare used in another pool */
881 VDEV_AUX_ERR_EXCEEDED, /* too many errors */
882 VDEV_AUX_IO_FAILURE, /* experienced I/O failure */
883 VDEV_AUX_BAD_LOG, /* cannot read log chain(s) */
884 VDEV_AUX_EXTERNAL, /* external diagnosis or forced fault */
885 VDEV_AUX_SPLIT_POOL, /* vdev was split off into another pool */
886 VDEV_AUX_BAD_ASHIFT, /* vdev ashift is invalid */
887 VDEV_AUX_EXTERNAL_PERSIST, /* persistent forced fault */
888 VDEV_AUX_ACTIVE, /* vdev active on a different host */
889 VDEV_AUX_CHILDREN_OFFLINE, /* all children are offline */
890 VDEV_AUX_ASHIFT_TOO_BIG, /* vdev's min block size is too large */
891 } vdev_aux_t;
892
893 /*
894 * pool state. The following states are written to disk as part of the normal
895 * SPA lifecycle: ACTIVE, EXPORTED, DESTROYED, SPARE, L2CACHE. The remaining
896 * states are software abstractions used at various levels to communicate
897 * pool state.
898 */
899 typedef enum pool_state {
900 POOL_STATE_ACTIVE = 0, /* In active use */
901 POOL_STATE_EXPORTED, /* Explicitly exported */
902 POOL_STATE_DESTROYED, /* Explicitly destroyed */
903 POOL_STATE_SPARE, /* Reserved for hot spare use */
904 POOL_STATE_L2CACHE, /* Level 2 ARC device */
905 POOL_STATE_UNINITIALIZED, /* Internal spa_t state */
906 POOL_STATE_UNAVAIL, /* Internal libzfs state */
907 POOL_STATE_POTENTIALLY_ACTIVE /* Internal libzfs state */
908 } pool_state_t;
909
910 /*
911 * mmp state. The following states provide additional detail describing
912 * why a pool couldn't be safely imported.
913 */
914 typedef enum mmp_state {
915 MMP_STATE_ACTIVE = 0, /* In active use */
916 MMP_STATE_INACTIVE, /* Inactive and safe to import */
917 MMP_STATE_NO_HOSTID /* System hostid is not set */
918 } mmp_state_t;
919
920 /*
921 * Scan Functions.
922 */
923 typedef enum pool_scan_func {
924 POOL_SCAN_NONE,
925 POOL_SCAN_SCRUB,
926 POOL_SCAN_RESILVER,
927 POOL_SCAN_FUNCS
928 } pool_scan_func_t;
929
930 /*
931 * Used to control scrub pause and resume.
932 */
933 typedef enum pool_scrub_cmd {
934 POOL_SCRUB_NORMAL = 0,
935 POOL_SCRUB_PAUSE,
936 POOL_SCRUB_FLAGS_END
937 } pool_scrub_cmd_t;
938
939 typedef enum {
940 CS_NONE,
941 CS_CHECKPOINT_EXISTS,
942 CS_CHECKPOINT_DISCARDING,
943 CS_NUM_STATES
944 } checkpoint_state_t;
945
946 typedef struct pool_checkpoint_stat {
947 uint64_t pcs_state; /* checkpoint_state_t */
948 uint64_t pcs_start_time; /* time checkpoint/discard started */
949 uint64_t pcs_space; /* checkpointed space */
950 } pool_checkpoint_stat_t;
951
952 /*
953 * ZIO types. Needed to interpret vdev statistics below.
954 */
955 typedef enum zio_type {
956 ZIO_TYPE_NULL = 0,
957 ZIO_TYPE_READ,
958 ZIO_TYPE_WRITE,
959 ZIO_TYPE_FREE,
960 ZIO_TYPE_CLAIM,
961 ZIO_TYPE_IOCTL,
962 ZIO_TYPE_TRIM,
963 ZIO_TYPES
964 } zio_type_t;
965
966 /*
967 * Pool statistics. Note: all fields should be 64-bit because this
968 * is passed between kernel and userland as an nvlist uint64 array.
969 */
970 typedef struct pool_scan_stat {
971 /* values stored on disk */
972 uint64_t pss_func; /* pool_scan_func_t */
973 uint64_t pss_state; /* dsl_scan_state_t */
974 uint64_t pss_start_time; /* scan start time */
975 uint64_t pss_end_time; /* scan end time */
976 uint64_t pss_to_examine; /* total bytes to scan */
977 uint64_t pss_examined; /* total bytes located by scanner */
978 uint64_t pss_to_process; /* total bytes to process */
979 uint64_t pss_processed; /* total processed bytes */
980 uint64_t pss_errors; /* scan errors */
981
982 /* values not stored on disk */
983 uint64_t pss_pass_exam; /* examined bytes per scan pass */
984 uint64_t pss_pass_start; /* start time of a scan pass */
985 uint64_t pss_pass_scrub_pause; /* pause time of a scrub pass */
986 /* cumulative time scrub spent paused, needed for rate calculation */
987 uint64_t pss_pass_scrub_spent_paused;
988 uint64_t pss_pass_issued; /* issued bytes per scan pass */
989 uint64_t pss_issued; /* total bytes checked by scanner */
990 } pool_scan_stat_t;
991
992 typedef struct pool_removal_stat {
993 uint64_t prs_state; /* dsl_scan_state_t */
994 uint64_t prs_removing_vdev;
995 uint64_t prs_start_time;
996 uint64_t prs_end_time;
997 uint64_t prs_to_copy; /* bytes that need to be copied */
998 uint64_t prs_copied; /* bytes copied so far */
999 /*
1000 * bytes of memory used for indirect mappings.
1001 * This includes all removed vdevs.
1002 */
1003 uint64_t prs_mapping_memory;
1004 } pool_removal_stat_t;
1005
1006 typedef enum dsl_scan_state {
1007 DSS_NONE,
1008 DSS_SCANNING,
1009 DSS_FINISHED,
1010 DSS_CANCELED,
1011 DSS_NUM_STATES
1012 } dsl_scan_state_t;
1013
1014 typedef struct vdev_rebuild_stat {
1015 uint64_t vrs_state; /* vdev_rebuild_state_t */
1016 uint64_t vrs_start_time; /* time_t */
1017 uint64_t vrs_end_time; /* time_t */
1018 uint64_t vrs_scan_time_ms; /* total run time (millisecs) */
1019 uint64_t vrs_bytes_scanned; /* allocated bytes scanned */
1020 uint64_t vrs_bytes_issued; /* read bytes issued */
1021 uint64_t vrs_bytes_rebuilt; /* rebuilt bytes */
1022 uint64_t vrs_bytes_est; /* total bytes to scan */
1023 uint64_t vrs_errors; /* scanning errors */
1024 uint64_t vrs_pass_time_ms; /* pass run time (millisecs) */
1025 uint64_t vrs_pass_bytes_scanned; /* bytes scanned since start/resume */
1026 uint64_t vrs_pass_bytes_issued; /* bytes rebuilt since start/resume */
1027 } vdev_rebuild_stat_t;
1028
1029 /*
1030 * Errata described by https://openzfs.github.io/openzfs-docs/msg/ZFS-8000-ER.
1031 * The ordering of this enum must be maintained to ensure the errata identifiers
1032 * map to the correct documentation. New errata may only be appended to the
1033 * list and must contain corresponding documentation at the above link.
1034 */
1035 typedef enum zpool_errata {
1036 ZPOOL_ERRATA_NONE,
1037 ZPOOL_ERRATA_ZOL_2094_SCRUB,
1038 ZPOOL_ERRATA_ZOL_2094_ASYNC_DESTROY,
1039 ZPOOL_ERRATA_ZOL_6845_ENCRYPTION,
1040 ZPOOL_ERRATA_ZOL_8308_ENCRYPTION,
1041 } zpool_errata_t;
1042
1043 /*
1044 * Vdev statistics. Note: all fields should be 64-bit because this
1045 * is passed between kernel and user land as an nvlist uint64 array.
1046 *
1047 * The vs_ops[] and vs_bytes[] arrays must always be an array size of 6 in
1048 * order to keep subsequent members at their known fixed offsets. When
1049 * adding a new field it must be added to the end the structure.
1050 */
1051 #define VS_ZIO_TYPES 6
1052
1053 typedef struct vdev_stat {
1054 hrtime_t vs_timestamp; /* time since vdev load */
1055 uint64_t vs_state; /* vdev state */
1056 uint64_t vs_aux; /* see vdev_aux_t */
1057 uint64_t vs_alloc; /* space allocated */
1058 uint64_t vs_space; /* total capacity */
1059 uint64_t vs_dspace; /* deflated capacity */
1060 uint64_t vs_rsize; /* replaceable dev size */
1061 uint64_t vs_esize; /* expandable dev size */
1062 uint64_t vs_ops[VS_ZIO_TYPES]; /* operation count */
1063 uint64_t vs_bytes[VS_ZIO_TYPES]; /* bytes read/written */
1064 uint64_t vs_read_errors; /* read errors */
1065 uint64_t vs_write_errors; /* write errors */
1066 uint64_t vs_checksum_errors; /* checksum errors */
1067 uint64_t vs_initialize_errors; /* initializing errors */
1068 uint64_t vs_self_healed; /* self-healed bytes */
1069 uint64_t vs_scan_removing; /* removing? */
1070 uint64_t vs_scan_processed; /* scan processed bytes */
1071 uint64_t vs_fragmentation; /* device fragmentation */
1072 uint64_t vs_initialize_bytes_done; /* bytes initialized */
1073 uint64_t vs_initialize_bytes_est; /* total bytes to initialize */
1074 uint64_t vs_initialize_state; /* vdev_initializing_state_t */
1075 uint64_t vs_initialize_action_time; /* time_t */
1076 uint64_t vs_checkpoint_space; /* checkpoint-consumed space */
1077 uint64_t vs_resilver_deferred; /* resilver deferred */
1078 uint64_t vs_slow_ios; /* slow IOs */
1079 uint64_t vs_trim_errors; /* trimming errors */
1080 uint64_t vs_trim_notsup; /* supported by device */
1081 uint64_t vs_trim_bytes_done; /* bytes trimmed */
1082 uint64_t vs_trim_bytes_est; /* total bytes to trim */
1083 uint64_t vs_trim_state; /* vdev_trim_state_t */
1084 uint64_t vs_trim_action_time; /* time_t */
1085 uint64_t vs_rebuild_processed; /* bytes rebuilt */
1086 uint64_t vs_configured_ashift; /* TLV vdev_ashift */
1087 uint64_t vs_logical_ashift; /* vdev_logical_ashift */
1088 uint64_t vs_physical_ashift; /* vdev_physical_ashift */
1089 } vdev_stat_t;
1090
1091 /* BEGIN CSTYLED */
1092 #define VDEV_STAT_VALID(field, uint64_t_field_count) \
1093 ((uint64_t_field_count * sizeof (uint64_t)) >= \
1094 (offsetof(vdev_stat_t, field) + sizeof (((vdev_stat_t *)NULL)->field)))
1095 /* END CSTYLED */
1096
1097 /*
1098 * Extended stats
1099 *
1100 * These are stats which aren't included in the original iostat output. For
1101 * convenience, they are grouped together in vdev_stat_ex, although each stat
1102 * is individually exported as an nvlist.
1103 */
1104 typedef struct vdev_stat_ex {
1105 /* Number of ZIOs issued to disk and waiting to finish */
1106 uint64_t vsx_active_queue[ZIO_PRIORITY_NUM_QUEUEABLE];
1107
1108 /* Number of ZIOs pending to be issued to disk */
1109 uint64_t vsx_pend_queue[ZIO_PRIORITY_NUM_QUEUEABLE];
1110
1111 /*
1112 * Below are the histograms for various latencies. Buckets are in
1113 * units of nanoseconds.
1114 */
1115
1116 /*
1117 * 2^37 nanoseconds = 134s. Timeouts will probably start kicking in
1118 * before this.
1119 */
1120 #define VDEV_L_HISTO_BUCKETS 37 /* Latency histo buckets */
1121 #define VDEV_RQ_HISTO_BUCKETS 25 /* Request size histo buckets */
1122
1123 /* Amount of time in ZIO queue (ns) */
1124 uint64_t vsx_queue_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
1125 [VDEV_L_HISTO_BUCKETS];
1126
1127 /* Total ZIO latency (ns). Includes queuing and disk access time */
1128 uint64_t vsx_total_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS];
1129
1130 /* Amount of time to read/write the disk (ns) */
1131 uint64_t vsx_disk_histo[ZIO_TYPES][VDEV_L_HISTO_BUCKETS];
1132
1133 /* "lookup the bucket for a value" histogram macros */
1134 #define HISTO(val, buckets) (val != 0 ? MIN(highbit64(val) - 1, \
1135 buckets - 1) : 0)
1136 #define L_HISTO(a) HISTO(a, VDEV_L_HISTO_BUCKETS)
1137 #define RQ_HISTO(a) HISTO(a, VDEV_RQ_HISTO_BUCKETS)
1138
1139 /* Physical IO histogram */
1140 uint64_t vsx_ind_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
1141 [VDEV_RQ_HISTO_BUCKETS];
1142
1143 /* Delegated (aggregated) physical IO histogram */
1144 uint64_t vsx_agg_histo[ZIO_PRIORITY_NUM_QUEUEABLE]
1145 [VDEV_RQ_HISTO_BUCKETS];
1146
1147 } vdev_stat_ex_t;
1148
1149 /*
1150 * Initialize functions.
1151 */
1152 typedef enum pool_initialize_func {
1153 POOL_INITIALIZE_START,
1154 POOL_INITIALIZE_CANCEL,
1155 POOL_INITIALIZE_SUSPEND,
1156 POOL_INITIALIZE_FUNCS
1157 } pool_initialize_func_t;
1158
1159 /*
1160 * TRIM functions.
1161 */
1162 typedef enum pool_trim_func {
1163 POOL_TRIM_START,
1164 POOL_TRIM_CANCEL,
1165 POOL_TRIM_SUSPEND,
1166 POOL_TRIM_FUNCS
1167 } pool_trim_func_t;
1168
1169 /*
1170 * DDT statistics. Note: all fields should be 64-bit because this
1171 * is passed between kernel and userland as an nvlist uint64 array.
1172 */
1173 typedef struct ddt_object {
1174 uint64_t ddo_count; /* number of elements in ddt */
1175 uint64_t ddo_dspace; /* size of ddt on disk */
1176 uint64_t ddo_mspace; /* size of ddt in-core */
1177 } ddt_object_t;
1178
1179 typedef struct ddt_stat {
1180 uint64_t dds_blocks; /* blocks */
1181 uint64_t dds_lsize; /* logical size */
1182 uint64_t dds_psize; /* physical size */
1183 uint64_t dds_dsize; /* deflated allocated size */
1184 uint64_t dds_ref_blocks; /* referenced blocks */
1185 uint64_t dds_ref_lsize; /* referenced lsize * refcnt */
1186 uint64_t dds_ref_psize; /* referenced psize * refcnt */
1187 uint64_t dds_ref_dsize; /* referenced dsize * refcnt */
1188 } ddt_stat_t;
1189
1190 typedef struct ddt_histogram {
1191 ddt_stat_t ddh_stat[64]; /* power-of-two histogram buckets */
1192 } ddt_histogram_t;
1193
1194 #define ZVOL_DRIVER "zvol"
1195 #define ZFS_DRIVER "zfs"
1196 #define ZFS_DEV "/dev/zfs"
1197
1198 #define ZFS_SUPER_MAGIC 0x2fc12fc1
1199
1200 /* general zvol path */
1201 #define ZVOL_DIR "/dev/zvol/"
1202
1203 #define ZVOL_MAJOR 230
1204 #define ZVOL_MINOR_BITS 4
1205 #define ZVOL_MINOR_MASK ((1U << ZVOL_MINOR_BITS) - 1)
1206 #define ZVOL_MINORS (1 << 4)
1207 #define ZVOL_DEV_NAME "zd"
1208
1209 #define ZVOL_PROP_NAME "name"
1210 #define ZVOL_DEFAULT_BLOCKSIZE 8192
1211
1212 typedef enum {
1213 VDEV_INITIALIZE_NONE,
1214 VDEV_INITIALIZE_ACTIVE,
1215 VDEV_INITIALIZE_CANCELED,
1216 VDEV_INITIALIZE_SUSPENDED,
1217 VDEV_INITIALIZE_COMPLETE
1218 } vdev_initializing_state_t;
1219
1220 typedef enum {
1221 VDEV_TRIM_NONE,
1222 VDEV_TRIM_ACTIVE,
1223 VDEV_TRIM_CANCELED,
1224 VDEV_TRIM_SUSPENDED,
1225 VDEV_TRIM_COMPLETE,
1226 } vdev_trim_state_t;
1227
1228 typedef enum {
1229 VDEV_REBUILD_NONE,
1230 VDEV_REBUILD_ACTIVE,
1231 VDEV_REBUILD_CANCELED,
1232 VDEV_REBUILD_COMPLETE,
1233 } vdev_rebuild_state_t;
1234
1235 /*
1236 * nvlist name constants. Facilitate restricting snapshot iteration range for
1237 * the "list next snapshot" ioctl
1238 */
1239 #define SNAP_ITER_MIN_TXG "snap_iter_min_txg"
1240 #define SNAP_ITER_MAX_TXG "snap_iter_max_txg"
1241
1242 /*
1243 * /dev/zfs ioctl numbers.
1244 *
1245 * These numbers cannot change over time. New ioctl numbers must be appended.
1246 */
1247 typedef enum zfs_ioc {
1248 /*
1249 * Core features - 81/128 numbers reserved.
1250 */
1251 #ifdef __FreeBSD__
1252 ZFS_IOC_FIRST = 0,
1253 #else
1254 ZFS_IOC_FIRST = ('Z' << 8),
1255 #endif
1256 ZFS_IOC = ZFS_IOC_FIRST,
1257 ZFS_IOC_POOL_CREATE = ZFS_IOC_FIRST, /* 0x5a00 */
1258 ZFS_IOC_POOL_DESTROY, /* 0x5a01 */
1259 ZFS_IOC_POOL_IMPORT, /* 0x5a02 */
1260 ZFS_IOC_POOL_EXPORT, /* 0x5a03 */
1261 ZFS_IOC_POOL_CONFIGS, /* 0x5a04 */
1262 ZFS_IOC_POOL_STATS, /* 0x5a05 */
1263 ZFS_IOC_POOL_TRYIMPORT, /* 0x5a06 */
1264 ZFS_IOC_POOL_SCAN, /* 0x5a07 */
1265 ZFS_IOC_POOL_FREEZE, /* 0x5a08 */
1266 ZFS_IOC_POOL_UPGRADE, /* 0x5a09 */
1267 ZFS_IOC_POOL_GET_HISTORY, /* 0x5a0a */
1268 ZFS_IOC_VDEV_ADD, /* 0x5a0b */
1269 ZFS_IOC_VDEV_REMOVE, /* 0x5a0c */
1270 ZFS_IOC_VDEV_SET_STATE, /* 0x5a0d */
1271 ZFS_IOC_VDEV_ATTACH, /* 0x5a0e */
1272 ZFS_IOC_VDEV_DETACH, /* 0x5a0f */
1273 ZFS_IOC_VDEV_SETPATH, /* 0x5a10 */
1274 ZFS_IOC_VDEV_SETFRU, /* 0x5a11 */
1275 ZFS_IOC_OBJSET_STATS, /* 0x5a12 */
1276 ZFS_IOC_OBJSET_ZPLPROPS, /* 0x5a13 */
1277 ZFS_IOC_DATASET_LIST_NEXT, /* 0x5a14 */
1278 ZFS_IOC_SNAPSHOT_LIST_NEXT, /* 0x5a15 */
1279 ZFS_IOC_SET_PROP, /* 0x5a16 */
1280 ZFS_IOC_CREATE, /* 0x5a17 */
1281 ZFS_IOC_DESTROY, /* 0x5a18 */
1282 ZFS_IOC_ROLLBACK, /* 0x5a19 */
1283 ZFS_IOC_RENAME, /* 0x5a1a */
1284 ZFS_IOC_RECV, /* 0x5a1b */
1285 ZFS_IOC_SEND, /* 0x5a1c */
1286 ZFS_IOC_INJECT_FAULT, /* 0x5a1d */
1287 ZFS_IOC_CLEAR_FAULT, /* 0x5a1e */
1288 ZFS_IOC_INJECT_LIST_NEXT, /* 0x5a1f */
1289 ZFS_IOC_ERROR_LOG, /* 0x5a20 */
1290 ZFS_IOC_CLEAR, /* 0x5a21 */
1291 ZFS_IOC_PROMOTE, /* 0x5a22 */
1292 ZFS_IOC_SNAPSHOT, /* 0x5a23 */
1293 ZFS_IOC_DSOBJ_TO_DSNAME, /* 0x5a24 */
1294 ZFS_IOC_OBJ_TO_PATH, /* 0x5a25 */
1295 ZFS_IOC_POOL_SET_PROPS, /* 0x5a26 */
1296 ZFS_IOC_POOL_GET_PROPS, /* 0x5a27 */
1297 ZFS_IOC_SET_FSACL, /* 0x5a28 */
1298 ZFS_IOC_GET_FSACL, /* 0x5a29 */
1299 ZFS_IOC_SHARE, /* 0x5a2a */
1300 ZFS_IOC_INHERIT_PROP, /* 0x5a2b */
1301 ZFS_IOC_SMB_ACL, /* 0x5a2c */
1302 ZFS_IOC_USERSPACE_ONE, /* 0x5a2d */
1303 ZFS_IOC_USERSPACE_MANY, /* 0x5a2e */
1304 ZFS_IOC_USERSPACE_UPGRADE, /* 0x5a2f */
1305 ZFS_IOC_HOLD, /* 0x5a30 */
1306 ZFS_IOC_RELEASE, /* 0x5a31 */
1307 ZFS_IOC_GET_HOLDS, /* 0x5a32 */
1308 ZFS_IOC_OBJSET_RECVD_PROPS, /* 0x5a33 */
1309 ZFS_IOC_VDEV_SPLIT, /* 0x5a34 */
1310 ZFS_IOC_NEXT_OBJ, /* 0x5a35 */
1311 ZFS_IOC_DIFF, /* 0x5a36 */
1312 ZFS_IOC_TMP_SNAPSHOT, /* 0x5a37 */
1313 ZFS_IOC_OBJ_TO_STATS, /* 0x5a38 */
1314 ZFS_IOC_SPACE_WRITTEN, /* 0x5a39 */
1315 ZFS_IOC_SPACE_SNAPS, /* 0x5a3a */
1316 ZFS_IOC_DESTROY_SNAPS, /* 0x5a3b */
1317 ZFS_IOC_POOL_REGUID, /* 0x5a3c */
1318 ZFS_IOC_POOL_REOPEN, /* 0x5a3d */
1319 ZFS_IOC_SEND_PROGRESS, /* 0x5a3e */
1320 ZFS_IOC_LOG_HISTORY, /* 0x5a3f */
1321 ZFS_IOC_SEND_NEW, /* 0x5a40 */
1322 ZFS_IOC_SEND_SPACE, /* 0x5a41 */
1323 ZFS_IOC_CLONE, /* 0x5a42 */
1324 ZFS_IOC_BOOKMARK, /* 0x5a43 */
1325 ZFS_IOC_GET_BOOKMARKS, /* 0x5a44 */
1326 ZFS_IOC_DESTROY_BOOKMARKS, /* 0x5a45 */
1327 ZFS_IOC_RECV_NEW, /* 0x5a46 */
1328 ZFS_IOC_POOL_SYNC, /* 0x5a47 */
1329 ZFS_IOC_CHANNEL_PROGRAM, /* 0x5a48 */
1330 ZFS_IOC_LOAD_KEY, /* 0x5a49 */
1331 ZFS_IOC_UNLOAD_KEY, /* 0x5a4a */
1332 ZFS_IOC_CHANGE_KEY, /* 0x5a4b */
1333 ZFS_IOC_REMAP, /* 0x5a4c */
1334 ZFS_IOC_POOL_CHECKPOINT, /* 0x5a4d */
1335 ZFS_IOC_POOL_DISCARD_CHECKPOINT, /* 0x5a4e */
1336 ZFS_IOC_POOL_INITIALIZE, /* 0x5a4f */
1337 ZFS_IOC_POOL_TRIM, /* 0x5a50 */
1338 ZFS_IOC_REDACT, /* 0x5a51 */
1339 ZFS_IOC_GET_BOOKMARK_PROPS, /* 0x5a52 */
1340 ZFS_IOC_WAIT, /* 0x5a53 */
1341 ZFS_IOC_WAIT_FS, /* 0x5a54 */
1342
1343 /*
1344 * Per-platform (Optional) - 8/128 numbers reserved.
1345 */
1346 ZFS_IOC_PLATFORM = ZFS_IOC_FIRST + 0x80,
1347 ZFS_IOC_EVENTS_NEXT, /* 0x81 (Linux) */
1348 ZFS_IOC_EVENTS_CLEAR, /* 0x82 (Linux) */
1349 ZFS_IOC_EVENTS_SEEK, /* 0x83 (Linux) */
1350 ZFS_IOC_NEXTBOOT, /* 0x84 (FreeBSD) */
1351 ZFS_IOC_JAIL, /* 0x85 (FreeBSD) */
1352 ZFS_IOC_UNJAIL, /* 0x86 (FreeBSD) */
1353 ZFS_IOC_SET_BOOTENV, /* 0x87 */
1354 ZFS_IOC_GET_BOOTENV, /* 0x88 */
1355 ZFS_IOC_LAST
1356 } zfs_ioc_t;
1357
1358 /*
1359 * zvol ioctl to get dataset name
1360 */
1361 #define BLKZNAME _IOR(0x12, 125, char[ZFS_MAX_DATASET_NAME_LEN])
1362
1363 /*
1364 * ZFS-specific error codes used for returning descriptive errors
1365 * to the userland through zfs ioctls.
1366 *
1367 * The enum implicitly includes all the error codes from errno.h.
1368 * New code should use and extend this enum for errors that are
1369 * not described precisely by generic errno codes.
1370 *
1371 * These numbers should not change over time. New entries should be appended.
1372 *
1373 * (Keep in sync with contrib/pyzfs/libzfs_core/_constants.py)
1374 */
1375 typedef enum {
1376 ZFS_ERR_CHECKPOINT_EXISTS = 1024,
1377 ZFS_ERR_DISCARDING_CHECKPOINT,
1378 ZFS_ERR_NO_CHECKPOINT,
1379 ZFS_ERR_DEVRM_IN_PROGRESS,
1380 ZFS_ERR_VDEV_TOO_BIG,
1381 ZFS_ERR_IOC_CMD_UNAVAIL,
1382 ZFS_ERR_IOC_ARG_UNAVAIL,
1383 ZFS_ERR_IOC_ARG_REQUIRED,
1384 ZFS_ERR_IOC_ARG_BADTYPE,
1385 ZFS_ERR_WRONG_PARENT,
1386 ZFS_ERR_FROM_IVSET_GUID_MISSING,
1387 ZFS_ERR_FROM_IVSET_GUID_MISMATCH,
1388 ZFS_ERR_SPILL_BLOCK_FLAG_MISSING,
1389 ZFS_ERR_UNKNOWN_SEND_STREAM_FEATURE,
1390 ZFS_ERR_EXPORT_IN_PROGRESS,
1391 ZFS_ERR_BOOKMARK_SOURCE_NOT_ANCESTOR,
1392 ZFS_ERR_STREAM_TRUNCATED,
1393 ZFS_ERR_STREAM_LARGE_BLOCK_MISMATCH,
1394 ZFS_ERR_RESILVER_IN_PROGRESS,
1395 ZFS_ERR_REBUILD_IN_PROGRESS,
1396 ZFS_ERR_BADPROP,
1397 } zfs_errno_t;
1398
1399 /*
1400 * Internal SPA load state. Used by FMA diagnosis engine.
1401 */
1402 typedef enum {
1403 SPA_LOAD_NONE, /* no load in progress */
1404 SPA_LOAD_OPEN, /* normal open */
1405 SPA_LOAD_IMPORT, /* import in progress */
1406 SPA_LOAD_TRYIMPORT, /* tryimport in progress */
1407 SPA_LOAD_RECOVER, /* recovery requested */
1408 SPA_LOAD_ERROR, /* load failed */
1409 SPA_LOAD_CREATE /* creation in progress */
1410 } spa_load_state_t;
1411
1412 typedef enum {
1413 ZPOOL_WAIT_CKPT_DISCARD,
1414 ZPOOL_WAIT_FREE,
1415 ZPOOL_WAIT_INITIALIZE,
1416 ZPOOL_WAIT_REPLACE,
1417 ZPOOL_WAIT_REMOVE,
1418 ZPOOL_WAIT_RESILVER,
1419 ZPOOL_WAIT_SCRUB,
1420 ZPOOL_WAIT_TRIM,
1421 ZPOOL_WAIT_NUM_ACTIVITIES
1422 } zpool_wait_activity_t;
1423
1424 typedef enum {
1425 ZFS_WAIT_DELETEQ,
1426 ZFS_WAIT_NUM_ACTIVITIES
1427 } zfs_wait_activity_t;
1428
1429 /*
1430 * Bookmark name values.
1431 */
1432 #define ZPOOL_ERR_LIST "error list"
1433 #define ZPOOL_ERR_DATASET "dataset"
1434 #define ZPOOL_ERR_OBJECT "object"
1435
1436 #define HIS_MAX_RECORD_LEN (MAXPATHLEN + MAXPATHLEN + 1)
1437
1438 /*
1439 * The following are names used in the nvlist describing
1440 * the pool's history log.
1441 */
1442 #define ZPOOL_HIST_RECORD "history record"
1443 #define ZPOOL_HIST_TIME "history time"
1444 #define ZPOOL_HIST_CMD "history command"
1445 #define ZPOOL_HIST_WHO "history who"
1446 #define ZPOOL_HIST_ZONE "history zone"
1447 #define ZPOOL_HIST_HOST "history hostname"
1448 #define ZPOOL_HIST_TXG "history txg"
1449 #define ZPOOL_HIST_INT_EVENT "history internal event"
1450 #define ZPOOL_HIST_INT_STR "history internal str"
1451 #define ZPOOL_HIST_INT_NAME "internal_name"
1452 #define ZPOOL_HIST_IOCTL "ioctl"
1453 #define ZPOOL_HIST_INPUT_NVL "in_nvl"
1454 #define ZPOOL_HIST_OUTPUT_NVL "out_nvl"
1455 #define ZPOOL_HIST_OUTPUT_SIZE "out_size"
1456 #define ZPOOL_HIST_DSNAME "dsname"
1457 #define ZPOOL_HIST_DSID "dsid"
1458 #define ZPOOL_HIST_ERRNO "errno"
1459
1460 /*
1461 * Special nvlist name that will not have its args recorded in the pool's
1462 * history log.
1463 */
1464 #define ZPOOL_HIDDEN_ARGS "hidden_args"
1465
1466 /*
1467 * The following are names used when invoking ZFS_IOC_POOL_INITIALIZE.
1468 */
1469 #define ZPOOL_INITIALIZE_COMMAND "initialize_command"
1470 #define ZPOOL_INITIALIZE_VDEVS "initialize_vdevs"
1471
1472 /*
1473 * The following are names used when invoking ZFS_IOC_POOL_TRIM.
1474 */
1475 #define ZPOOL_TRIM_COMMAND "trim_command"
1476 #define ZPOOL_TRIM_VDEVS "trim_vdevs"
1477 #define ZPOOL_TRIM_RATE "trim_rate"
1478 #define ZPOOL_TRIM_SECURE "trim_secure"
1479
1480 /*
1481 * The following are names used when invoking ZFS_IOC_POOL_WAIT.
1482 */
1483 #define ZPOOL_WAIT_ACTIVITY "wait_activity"
1484 #define ZPOOL_WAIT_TAG "wait_tag"
1485 #define ZPOOL_WAIT_WAITED "wait_waited"
1486
1487 /*
1488 * The following are names used when invoking ZFS_IOC_WAIT_FS.
1489 */
1490 #define ZFS_WAIT_ACTIVITY "wait_activity"
1491 #define ZFS_WAIT_WAITED "wait_waited"
1492
1493 /*
1494 * Flags for ZFS_IOC_VDEV_SET_STATE
1495 */
1496 #define ZFS_ONLINE_CHECKREMOVE 0x1
1497 #define ZFS_ONLINE_UNSPARE 0x2
1498 #define ZFS_ONLINE_FORCEFAULT 0x4
1499 #define ZFS_ONLINE_EXPAND 0x8
1500 #define ZFS_OFFLINE_TEMPORARY 0x1
1501
1502 /*
1503 * Flags for ZFS_IOC_POOL_IMPORT
1504 */
1505 #define ZFS_IMPORT_NORMAL 0x0
1506 #define ZFS_IMPORT_VERBATIM 0x1
1507 #define ZFS_IMPORT_ANY_HOST 0x2
1508 #define ZFS_IMPORT_MISSING_LOG 0x4
1509 #define ZFS_IMPORT_ONLY 0x8
1510 #define ZFS_IMPORT_TEMP_NAME 0x10
1511 #define ZFS_IMPORT_SKIP_MMP 0x20
1512 #define ZFS_IMPORT_LOAD_KEYS 0x40
1513 #define ZFS_IMPORT_CHECKPOINT 0x80
1514
1515 /*
1516 * Channel program argument/return nvlist keys and defaults.
1517 */
1518 #define ZCP_ARG_PROGRAM "program"
1519 #define ZCP_ARG_ARGLIST "arg"
1520 #define ZCP_ARG_SYNC "sync"
1521 #define ZCP_ARG_INSTRLIMIT "instrlimit"
1522 #define ZCP_ARG_MEMLIMIT "memlimit"
1523
1524 #define ZCP_ARG_CLIARGV "argv"
1525
1526 #define ZCP_RET_ERROR "error"
1527 #define ZCP_RET_RETURN "return"
1528
1529 #define ZCP_DEFAULT_INSTRLIMIT (10 * 1000 * 1000)
1530 #define ZCP_MAX_INSTRLIMIT (10 * ZCP_DEFAULT_INSTRLIMIT)
1531 #define ZCP_DEFAULT_MEMLIMIT (10 * 1024 * 1024)
1532 #define ZCP_MAX_MEMLIMIT (10 * ZCP_DEFAULT_MEMLIMIT)
1533
1534 /*
1535 * Sysevent payload members. ZFS will generate the following sysevents with the
1536 * given payloads:
1537 *
1538 * ESC_ZFS_RESILVER_START
1539 * ESC_ZFS_RESILVER_FINISH
1540 *
1541 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1542 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1543 * ZFS_EV_RESILVER_TYPE DATA_TYPE_STRING
1544 *
1545 * ESC_ZFS_POOL_DESTROY
1546 * ESC_ZFS_POOL_REGUID
1547 *
1548 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1549 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1550 *
1551 * ESC_ZFS_VDEV_REMOVE
1552 * ESC_ZFS_VDEV_CLEAR
1553 * ESC_ZFS_VDEV_CHECK
1554 *
1555 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1556 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1557 * ZFS_EV_VDEV_PATH DATA_TYPE_STRING (optional)
1558 * ZFS_EV_VDEV_GUID DATA_TYPE_UINT64
1559 *
1560 * ESC_ZFS_HISTORY_EVENT
1561 *
1562 * ZFS_EV_POOL_NAME DATA_TYPE_STRING
1563 * ZFS_EV_POOL_GUID DATA_TYPE_UINT64
1564 * ZFS_EV_HIST_TIME DATA_TYPE_UINT64 (optional)
1565 * ZFS_EV_HIST_CMD DATA_TYPE_STRING (optional)
1566 * ZFS_EV_HIST_WHO DATA_TYPE_UINT64 (optional)
1567 * ZFS_EV_HIST_ZONE DATA_TYPE_STRING (optional)
1568 * ZFS_EV_HIST_HOST DATA_TYPE_STRING (optional)
1569 * ZFS_EV_HIST_TXG DATA_TYPE_UINT64 (optional)
1570 * ZFS_EV_HIST_INT_EVENT DATA_TYPE_UINT64 (optional)
1571 * ZFS_EV_HIST_INT_STR DATA_TYPE_STRING (optional)
1572 * ZFS_EV_HIST_INT_NAME DATA_TYPE_STRING (optional)
1573 * ZFS_EV_HIST_IOCTL DATA_TYPE_STRING (optional)
1574 * ZFS_EV_HIST_DSNAME DATA_TYPE_STRING (optional)
1575 * ZFS_EV_HIST_DSID DATA_TYPE_UINT64 (optional)
1576 *
1577 * The ZFS_EV_HIST_* members will correspond to the ZPOOL_HIST_* members in the
1578 * history log nvlist. The keynames will be free of any spaces or other
1579 * characters that could be potentially unexpected to consumers of the
1580 * sysevents.
1581 */
1582 #define ZFS_EV_POOL_NAME "pool_name"
1583 #define ZFS_EV_POOL_GUID "pool_guid"
1584 #define ZFS_EV_VDEV_PATH "vdev_path"
1585 #define ZFS_EV_VDEV_GUID "vdev_guid"
1586 #define ZFS_EV_HIST_TIME "history_time"
1587 #define ZFS_EV_HIST_CMD "history_command"
1588 #define ZFS_EV_HIST_WHO "history_who"
1589 #define ZFS_EV_HIST_ZONE "history_zone"
1590 #define ZFS_EV_HIST_HOST "history_hostname"
1591 #define ZFS_EV_HIST_TXG "history_txg"
1592 #define ZFS_EV_HIST_INT_EVENT "history_internal_event"
1593 #define ZFS_EV_HIST_INT_STR "history_internal_str"
1594 #define ZFS_EV_HIST_INT_NAME "history_internal_name"
1595 #define ZFS_EV_HIST_IOCTL "history_ioctl"
1596 #define ZFS_EV_HIST_DSNAME "history_dsname"
1597 #define ZFS_EV_HIST_DSID "history_dsid"
1598 #define ZFS_EV_RESILVER_TYPE "resilver_type"
1599
1600 #ifdef __cplusplus
1601 }
1602 #endif
1603
1604 #endif /* _SYS_FS_ZFS_H */
OpenZFS on Linux and FreeBSD