xref: /freebsd/sys/contrib/openzfs/include/sys/zio.h (revision 4d846d26)
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 https://opensource.org/licenses/CDDL-1.0.
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 2011 Nexenta Systems, Inc. All rights reserved.
25  * Copyright (c) 2012, 2020 by Delphix. All rights reserved.
26  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27  * Copyright (c) 2013, Joyent, Inc. All rights reserved.
28  * Copyright 2016 Toomas Soome <tsoome@me.com>
29  * Copyright (c) 2019, Allan Jude
30  * Copyright (c) 2019, Klara Inc.
31  * Copyright (c) 2019-2020, Michael Niewöhner
32  */
33 
34 #ifndef _ZIO_H
35 #define	_ZIO_H
36 
37 #include <sys/zio_priority.h>
38 #include <sys/zfs_context.h>
39 #include <sys/spa.h>
40 #include <sys/txg.h>
41 #include <sys/avl.h>
42 #include <sys/fs/zfs.h>
43 #include <sys/zio_impl.h>
44 
45 #ifdef	__cplusplus
46 extern "C" {
47 #endif
48 
49 /*
50  * Embedded checksum
51  */
52 #define	ZEC_MAGIC	0x210da7ab10c7a11ULL
53 
54 typedef struct zio_eck {
55 	uint64_t	zec_magic;	/* for validation, endianness	*/
56 	zio_cksum_t	zec_cksum;	/* 256-bit checksum		*/
57 } zio_eck_t;
58 
59 /*
60  * Gang block headers are self-checksumming and contain an array
61  * of block pointers.
62  */
63 #define	SPA_GANGBLOCKSIZE	SPA_MINBLOCKSIZE
64 #define	SPA_GBH_NBLKPTRS	((SPA_GANGBLOCKSIZE - \
65 	sizeof (zio_eck_t)) / sizeof (blkptr_t))
66 #define	SPA_GBH_FILLER		((SPA_GANGBLOCKSIZE - \
67 	sizeof (zio_eck_t) - \
68 	(SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
69 	sizeof (uint64_t))
70 
71 typedef struct zio_gbh {
72 	blkptr_t		zg_blkptr[SPA_GBH_NBLKPTRS];
73 	uint64_t		zg_filler[SPA_GBH_FILLER];
74 	zio_eck_t		zg_tail;
75 } zio_gbh_phys_t;
76 
77 enum zio_checksum {
78 	ZIO_CHECKSUM_INHERIT = 0,
79 	ZIO_CHECKSUM_ON,
80 	ZIO_CHECKSUM_OFF,
81 	ZIO_CHECKSUM_LABEL,
82 	ZIO_CHECKSUM_GANG_HEADER,
83 	ZIO_CHECKSUM_ZILOG,
84 	ZIO_CHECKSUM_FLETCHER_2,
85 	ZIO_CHECKSUM_FLETCHER_4,
86 	ZIO_CHECKSUM_SHA256,
87 	ZIO_CHECKSUM_ZILOG2,
88 	ZIO_CHECKSUM_NOPARITY,
89 	ZIO_CHECKSUM_SHA512,
90 	ZIO_CHECKSUM_SKEIN,
91 	ZIO_CHECKSUM_EDONR,
92 	ZIO_CHECKSUM_BLAKE3,
93 	ZIO_CHECKSUM_FUNCTIONS
94 };
95 
96 /*
97  * The number of "legacy" compression functions which can be set on individual
98  * objects.
99  */
100 #define	ZIO_CHECKSUM_LEGACY_FUNCTIONS ZIO_CHECKSUM_ZILOG2
101 
102 #define	ZIO_CHECKSUM_ON_VALUE	ZIO_CHECKSUM_FLETCHER_4
103 #define	ZIO_CHECKSUM_DEFAULT	ZIO_CHECKSUM_ON
104 
105 #define	ZIO_CHECKSUM_MASK	0xffULL
106 #define	ZIO_CHECKSUM_VERIFY	(1U << 8)
107 
108 #define	ZIO_DEDUPCHECKSUM	ZIO_CHECKSUM_SHA256
109 
110 /* macros defining encryption lengths */
111 #define	ZIO_OBJSET_MAC_LEN		32
112 #define	ZIO_DATA_IV_LEN			12
113 #define	ZIO_DATA_SALT_LEN		8
114 #define	ZIO_DATA_MAC_LEN		16
115 
116 /*
117  * The number of "legacy" compression functions which can be set on individual
118  * objects.
119  */
120 #define	ZIO_COMPRESS_LEGACY_FUNCTIONS ZIO_COMPRESS_LZ4
121 
122 /*
123  * The meaning of "compress = on" selected by the compression features enabled
124  * on a given pool.
125  */
126 #define	ZIO_COMPRESS_LEGACY_ON_VALUE	ZIO_COMPRESS_LZJB
127 #define	ZIO_COMPRESS_LZ4_ON_VALUE	ZIO_COMPRESS_LZ4
128 
129 #define	ZIO_COMPRESS_DEFAULT		ZIO_COMPRESS_ON
130 
131 #define	BOOTFS_COMPRESS_VALID(compress)			\
132 	((compress) == ZIO_COMPRESS_LZJB ||		\
133 	(compress) == ZIO_COMPRESS_LZ4 ||		\
134 	(compress) == ZIO_COMPRESS_GZIP_1 ||		\
135 	(compress) == ZIO_COMPRESS_GZIP_2 ||		\
136 	(compress) == ZIO_COMPRESS_GZIP_3 ||		\
137 	(compress) == ZIO_COMPRESS_GZIP_4 ||		\
138 	(compress) == ZIO_COMPRESS_GZIP_5 ||		\
139 	(compress) == ZIO_COMPRESS_GZIP_6 ||		\
140 	(compress) == ZIO_COMPRESS_GZIP_7 ||		\
141 	(compress) == ZIO_COMPRESS_GZIP_8 ||		\
142 	(compress) == ZIO_COMPRESS_GZIP_9 ||		\
143 	(compress) == ZIO_COMPRESS_ZLE ||		\
144 	(compress) == ZIO_COMPRESS_ZSTD ||		\
145 	(compress) == ZIO_COMPRESS_ON ||		\
146 	(compress) == ZIO_COMPRESS_OFF)
147 
148 
149 #define	ZIO_COMPRESS_ALGO(x)	(x & SPA_COMPRESSMASK)
150 #define	ZIO_COMPRESS_LEVEL(x)	((x & ~SPA_COMPRESSMASK) >> SPA_COMPRESSBITS)
151 #define	ZIO_COMPRESS_RAW(type, level)	(type | ((level) << SPA_COMPRESSBITS))
152 
153 #define	ZIO_COMPLEVEL_ZSTD(level)	\
154 	ZIO_COMPRESS_RAW(ZIO_COMPRESS_ZSTD, level)
155 
156 #define	ZIO_FAILURE_MODE_WAIT		0
157 #define	ZIO_FAILURE_MODE_CONTINUE	1
158 #define	ZIO_FAILURE_MODE_PANIC		2
159 
160 typedef enum zio_suspend_reason {
161 	ZIO_SUSPEND_NONE = 0,
162 	ZIO_SUSPEND_IOERR,
163 	ZIO_SUSPEND_MMP,
164 } zio_suspend_reason_t;
165 
166 /*
167  * This was originally an enum type. However, those are 32-bit and there is no
168  * way to make a 64-bit enum type. Since we ran out of bits for flags, we were
169  * forced to upgrade it to a uint64_t.
170  */
171 typedef uint64_t zio_flag_t;
172 	/*
173 	 * Flags inherited by gang, ddt, and vdev children,
174 	 * and that must be equal for two zios to aggregate
175 	 */
176 #define	ZIO_FLAG_DONT_AGGREGATE	(1ULL << 0)
177 #define	ZIO_FLAG_IO_REPAIR	(1ULL << 1)
178 #define	ZIO_FLAG_SELF_HEAL	(1ULL << 2)
179 #define	ZIO_FLAG_RESILVER	(1ULL << 3)
180 #define	ZIO_FLAG_SCRUB		(1ULL << 4)
181 #define	ZIO_FLAG_SCAN_THREAD	(1ULL << 5)
182 #define	ZIO_FLAG_PHYSICAL	(1ULL << 6)
183 
184 #define	ZIO_FLAG_AGG_INHERIT	(ZIO_FLAG_CANFAIL - 1)
185 
186 	/*
187 	 * Flags inherited by ddt, gang, and vdev children.
188 	 */
189 #define	ZIO_FLAG_CANFAIL	(1ULL << 7)	/* must be first for INHERIT */
190 #define	ZIO_FLAG_SPECULATIVE	(1ULL << 8)
191 #define	ZIO_FLAG_CONFIG_WRITER	(1ULL << 9)
192 #define	ZIO_FLAG_DONT_RETRY	(1ULL << 10)
193 #define	ZIO_FLAG_DONT_CACHE	(1ULL << 11)
194 #define	ZIO_FLAG_NODATA		(1ULL << 12)
195 #define	ZIO_FLAG_INDUCE_DAMAGE	(1ULL << 13)
196 #define	ZIO_FLAG_IO_ALLOCATING	(1ULL << 14)
197 
198 #define	ZIO_FLAG_DDT_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
199 #define	ZIO_FLAG_GANG_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
200 
201 	/*
202 	 * Flags inherited by vdev children.
203 	 */
204 #define	ZIO_FLAG_IO_RETRY	(1ULL << 15)	/* must be first for INHERIT */
205 #define	ZIO_FLAG_PROBE		(1ULL << 16)
206 #define	ZIO_FLAG_TRYHARD	(1ULL << 17)
207 #define	ZIO_FLAG_OPTIONAL	(1ULL << 18)
208 
209 #define	ZIO_FLAG_VDEV_INHERIT	(ZIO_FLAG_DONT_QUEUE - 1)
210 
211 	/*
212 	 * Flags not inherited by any children.
213 	 */
214 #define	ZIO_FLAG_DONT_QUEUE	(1ULL << 19)	/* must be first for INHERIT */
215 #define	ZIO_FLAG_DONT_PROPAGATE	(1ULL << 20)
216 #define	ZIO_FLAG_IO_BYPASS	(1ULL << 21)
217 #define	ZIO_FLAG_IO_REWRITE	(1ULL << 22)
218 #define	ZIO_FLAG_RAW_COMPRESS	(1ULL << 23)
219 #define	ZIO_FLAG_RAW_ENCRYPT	(1ULL << 24)
220 #define	ZIO_FLAG_GANG_CHILD	(1ULL << 25)
221 #define	ZIO_FLAG_DDT_CHILD	(1ULL << 26)
222 #define	ZIO_FLAG_GODFATHER	(1ULL << 27)
223 #define	ZIO_FLAG_NOPWRITE	(1ULL << 28)
224 #define	ZIO_FLAG_REEXECUTED	(1ULL << 29)
225 #define	ZIO_FLAG_DELEGATED	(1ULL << 30)
226 #define	ZIO_FLAG_FASTWRITE	(1ULL << 31)
227 
228 #define	ZIO_FLAG_MUSTSUCCEED		0
229 #define	ZIO_FLAG_RAW	(ZIO_FLAG_RAW_COMPRESS | ZIO_FLAG_RAW_ENCRYPT)
230 
231 #define	ZIO_DDT_CHILD_FLAGS(zio)				\
232 	(((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) |		\
233 	ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
234 
235 #define	ZIO_GANG_CHILD_FLAGS(zio)				\
236 	(((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) |		\
237 	ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
238 
239 #define	ZIO_VDEV_CHILD_FLAGS(zio)				\
240 	(((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) |		\
241 	ZIO_FLAG_DONT_PROPAGATE | ZIO_FLAG_CANFAIL)
242 
243 #define	ZIO_CHILD_BIT(x)		(1U << (x))
244 #define	ZIO_CHILD_BIT_IS_SET(val, x)	((val) & (1U << (x)))
245 
246 enum zio_child {
247 	ZIO_CHILD_VDEV = 0,
248 	ZIO_CHILD_GANG,
249 	ZIO_CHILD_DDT,
250 	ZIO_CHILD_LOGICAL,
251 	ZIO_CHILD_TYPES
252 };
253 
254 #define	ZIO_CHILD_VDEV_BIT		ZIO_CHILD_BIT(ZIO_CHILD_VDEV)
255 #define	ZIO_CHILD_GANG_BIT		ZIO_CHILD_BIT(ZIO_CHILD_GANG)
256 #define	ZIO_CHILD_DDT_BIT		ZIO_CHILD_BIT(ZIO_CHILD_DDT)
257 #define	ZIO_CHILD_LOGICAL_BIT		ZIO_CHILD_BIT(ZIO_CHILD_LOGICAL)
258 #define	ZIO_CHILD_ALL_BITS					\
259 	(ZIO_CHILD_VDEV_BIT | ZIO_CHILD_GANG_BIT |		\
260 	ZIO_CHILD_DDT_BIT | ZIO_CHILD_LOGICAL_BIT)
261 
262 enum zio_wait_type {
263 	ZIO_WAIT_READY = 0,
264 	ZIO_WAIT_DONE,
265 	ZIO_WAIT_TYPES
266 };
267 
268 typedef void zio_done_func_t(zio_t *zio);
269 
270 extern int zio_exclude_metadata;
271 extern int zio_dva_throttle_enabled;
272 extern const char *const zio_type_name[ZIO_TYPES];
273 
274 /*
275  * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
276  * identifies any block in the pool.  By convention, the meta-objset (MOS)
277  * is objset 0, and the meta-dnode is object 0.  This covers all blocks
278  * except root blocks and ZIL blocks, which are defined as follows:
279  *
280  * Root blocks (objset_phys_t) are object 0, level -1:  <objset, 0, -1, 0>.
281  * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
282  * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
283  * dnode visit bookmarks are <objset, object id of dnode, -3, 0>.
284  *
285  * Note: this structure is called a bookmark because its original purpose
286  * was to remember where to resume a pool-wide traverse.
287  *
288  * Note: this structure is passed between userland and the kernel, and is
289  * stored on disk (by virtue of being incorporated into other on-disk
290  * structures, e.g. dsl_scan_phys_t).
291  *
292  * If the head_errlog feature is enabled a different on-disk format for error
293  * logs is used. This introduces the use of an error bookmark, a four-tuple
294  * <object, level, blkid, birth> that uniquely identifies any error block
295  * in the pool. The birth transaction group is used to track whether the block
296  * has been overwritten by newer data or added to a snapshot since its marking
297  * as an error.
298  */
299 struct zbookmark_phys {
300 	uint64_t	zb_objset;
301 	uint64_t	zb_object;
302 	int64_t		zb_level;
303 	uint64_t	zb_blkid;
304 };
305 
306 struct zbookmark_err_phys {
307 	uint64_t	zb_object;
308 	int64_t		zb_level;
309 	uint64_t	zb_blkid;
310 	uint64_t	zb_birth;
311 };
312 
313 #define	SET_BOOKMARK(zb, objset, object, level, blkid)  \
314 {                                                       \
315 	(zb)->zb_objset = objset;                       \
316 	(zb)->zb_object = object;                       \
317 	(zb)->zb_level = level;                         \
318 	(zb)->zb_blkid = blkid;                         \
319 }
320 
321 #define	ZB_DESTROYED_OBJSET	(-1ULL)
322 
323 #define	ZB_ROOT_OBJECT		(0ULL)
324 #define	ZB_ROOT_LEVEL		(-1LL)
325 #define	ZB_ROOT_BLKID		(0ULL)
326 
327 #define	ZB_ZIL_OBJECT		(0ULL)
328 #define	ZB_ZIL_LEVEL		(-2LL)
329 
330 #define	ZB_DNODE_LEVEL		(-3LL)
331 #define	ZB_DNODE_BLKID		(0ULL)
332 
333 #define	ZB_IS_ZERO(zb)						\
334 	((zb)->zb_objset == 0 && (zb)->zb_object == 0 &&	\
335 	(zb)->zb_level == 0 && (zb)->zb_blkid == 0)
336 #define	ZB_IS_ROOT(zb)				\
337 	((zb)->zb_object == ZB_ROOT_OBJECT &&	\
338 	(zb)->zb_level == ZB_ROOT_LEVEL &&	\
339 	(zb)->zb_blkid == ZB_ROOT_BLKID)
340 
341 typedef struct zio_prop {
342 	enum zio_checksum	zp_checksum;
343 	enum zio_compress	zp_compress;
344 	uint8_t			zp_complevel;
345 	dmu_object_type_t	zp_type;
346 	uint8_t			zp_level;
347 	uint8_t			zp_copies;
348 	boolean_t		zp_dedup;
349 	boolean_t		zp_dedup_verify;
350 	boolean_t		zp_nopwrite;
351 	boolean_t		zp_brtwrite;
352 	boolean_t		zp_encrypt;
353 	boolean_t		zp_byteorder;
354 	uint8_t			zp_salt[ZIO_DATA_SALT_LEN];
355 	uint8_t			zp_iv[ZIO_DATA_IV_LEN];
356 	uint8_t			zp_mac[ZIO_DATA_MAC_LEN];
357 	uint32_t		zp_zpl_smallblk;
358 } zio_prop_t;
359 
360 typedef struct zio_cksum_report zio_cksum_report_t;
361 
362 typedef void zio_cksum_finish_f(zio_cksum_report_t *rep,
363     const abd_t *good_data);
364 typedef void zio_cksum_free_f(void *cbdata, size_t size);
365 
366 struct zio_bad_cksum;				/* defined in zio_checksum.h */
367 struct dnode_phys;
368 struct abd;
369 
370 struct zio_cksum_report {
371 	struct zio_cksum_report *zcr_next;
372 	nvlist_t		*zcr_ereport;
373 	nvlist_t		*zcr_detector;
374 	void			*zcr_cbdata;
375 	size_t			zcr_cbinfo;	/* passed to zcr_free() */
376 	uint64_t		zcr_sector;
377 	uint64_t		zcr_align;
378 	uint64_t		zcr_length;
379 	zio_cksum_finish_f	*zcr_finish;
380 	zio_cksum_free_f	*zcr_free;
381 
382 	/* internal use only */
383 	struct zio_bad_cksum	*zcr_ckinfo;	/* information from failure */
384 };
385 
386 typedef struct zio_vsd_ops {
387 	zio_done_func_t		*vsd_free;
388 } zio_vsd_ops_t;
389 
390 typedef struct zio_gang_node {
391 	zio_gbh_phys_t		*gn_gbh;
392 	struct zio_gang_node	*gn_child[SPA_GBH_NBLKPTRS];
393 } zio_gang_node_t;
394 
395 typedef zio_t *zio_gang_issue_func_t(zio_t *zio, blkptr_t *bp,
396     zio_gang_node_t *gn, struct abd *data, uint64_t offset);
397 
398 typedef void zio_transform_func_t(zio_t *zio, struct abd *data, uint64_t size);
399 
400 typedef struct zio_transform {
401 	struct abd		*zt_orig_abd;
402 	uint64_t		zt_orig_size;
403 	uint64_t		zt_bufsize;
404 	zio_transform_func_t	*zt_transform;
405 	struct zio_transform	*zt_next;
406 } zio_transform_t;
407 
408 typedef zio_t *zio_pipe_stage_t(zio_t *zio);
409 
410 /*
411  * The io_reexecute flags are distinct from io_flags because the child must
412  * be able to propagate them to the parent.  The normal io_flags are local
413  * to the zio, not protected by any lock, and not modifiable by children;
414  * the reexecute flags are protected by io_lock, modifiable by children,
415  * and always propagated -- even when ZIO_FLAG_DONT_PROPAGATE is set.
416  */
417 #define	ZIO_REEXECUTE_NOW	0x01
418 #define	ZIO_REEXECUTE_SUSPEND	0x02
419 
420 /*
421  * The io_trim flags are used to specify the type of TRIM to perform.  They
422  * only apply to ZIO_TYPE_TRIM zios are distinct from io_flags.
423  */
424 enum trim_flag {
425 	ZIO_TRIM_SECURE		= 1U << 0,
426 };
427 
428 typedef struct zio_alloc_list {
429 	list_t  zal_list;
430 	uint64_t zal_size;
431 } zio_alloc_list_t;
432 
433 typedef struct zio_link {
434 	zio_t		*zl_parent;
435 	zio_t		*zl_child;
436 	list_node_t	zl_parent_node;
437 	list_node_t	zl_child_node;
438 } zio_link_t;
439 
440 struct zio {
441 	/* Core information about this I/O */
442 	zbookmark_phys_t	io_bookmark;
443 	zio_prop_t	io_prop;
444 	zio_type_t	io_type;
445 	enum zio_child	io_child_type;
446 	enum trim_flag	io_trim_flags;
447 	int		io_cmd;
448 	zio_priority_t	io_priority;
449 	uint8_t		io_reexecute;
450 	uint8_t		io_state[ZIO_WAIT_TYPES];
451 	uint64_t	io_txg;
452 	spa_t		*io_spa;
453 	blkptr_t	*io_bp;
454 	blkptr_t	*io_bp_override;
455 	blkptr_t	io_bp_copy;
456 	list_t		io_parent_list;
457 	list_t		io_child_list;
458 	zio_t		*io_logical;
459 	zio_transform_t *io_transform_stack;
460 
461 	/* Callback info */
462 	zio_done_func_t	*io_ready;
463 	zio_done_func_t	*io_children_ready;
464 	zio_done_func_t	*io_physdone;
465 	zio_done_func_t	*io_done;
466 	void		*io_private;
467 	int64_t		io_prev_space_delta;	/* DMU private */
468 	blkptr_t	io_bp_orig;
469 	/* io_lsize != io_orig_size iff this is a raw write */
470 	uint64_t	io_lsize;
471 
472 	/* Data represented by this I/O */
473 	struct abd	*io_abd;
474 	struct abd	*io_orig_abd;
475 	uint64_t	io_size;
476 	uint64_t	io_orig_size;
477 
478 	/* Stuff for the vdev stack */
479 	vdev_t		*io_vd;
480 	void		*io_vsd;
481 	const zio_vsd_ops_t *io_vsd_ops;
482 	metaslab_class_t *io_metaslab_class;	/* dva throttle class */
483 
484 	uint64_t	io_offset;
485 	hrtime_t	io_timestamp;	/* submitted at */
486 	hrtime_t	io_queued_timestamp;
487 	hrtime_t	io_target_timestamp;
488 	hrtime_t	io_delta;	/* vdev queue service delta */
489 	hrtime_t	io_delay;	/* Device access time (disk or */
490 					/* file). */
491 	avl_node_t	io_queue_node;
492 	avl_node_t	io_offset_node;
493 	avl_node_t	io_alloc_node;
494 	zio_alloc_list_t 	io_alloc_list;
495 
496 	/* Internal pipeline state */
497 	zio_flag_t	io_flags;
498 	enum zio_stage	io_stage;
499 	enum zio_stage	io_pipeline;
500 	zio_flag_t	io_orig_flags;
501 	enum zio_stage	io_orig_stage;
502 	enum zio_stage	io_orig_pipeline;
503 	enum zio_stage	io_pipeline_trace;
504 	int		io_error;
505 	int		io_child_error[ZIO_CHILD_TYPES];
506 	uint64_t	io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
507 	uint64_t	io_child_count;
508 	uint64_t	io_phys_children;
509 	uint64_t	io_parent_count;
510 	uint64_t	*io_stall;
511 	zio_t		*io_gang_leader;
512 	zio_gang_node_t	*io_gang_tree;
513 	void		*io_executor;
514 	void		*io_waiter;
515 	void		*io_bio;
516 	kmutex_t	io_lock;
517 	kcondvar_t	io_cv;
518 	int		io_allocator;
519 
520 	/* FMA state */
521 	zio_cksum_report_t *io_cksum_report;
522 	uint64_t	io_ena;
523 
524 	/* Taskq dispatching state */
525 	taskq_ent_t	io_tqent;
526 };
527 
528 enum blk_verify_flag {
529 	BLK_VERIFY_ONLY,
530 	BLK_VERIFY_LOG,
531 	BLK_VERIFY_HALT
532 };
533 
534 enum blk_config_flag {
535 	BLK_CONFIG_HELD,   // SCL_VDEV held for writer
536 	BLK_CONFIG_NEEDED, // SCL_VDEV should be obtained for reader
537 	BLK_CONFIG_SKIP,   // skip checks which require SCL_VDEV
538 };
539 
540 extern int zio_bookmark_compare(const void *, const void *);
541 
542 extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
543     zio_done_func_t *done, void *priv, zio_flag_t flags);
544 
545 extern zio_t *zio_root(spa_t *spa,
546     zio_done_func_t *done, void *priv, zio_flag_t flags);
547 
548 extern void zio_destroy(zio_t *zio);
549 
550 extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp,
551     struct abd *data, uint64_t lsize, zio_done_func_t *done, void *priv,
552     zio_priority_t priority, zio_flag_t flags, const zbookmark_phys_t *zb);
553 
554 extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
555     struct abd *data, uint64_t size, uint64_t psize, const zio_prop_t *zp,
556     zio_done_func_t *ready, zio_done_func_t *children_ready,
557     zio_done_func_t *physdone, zio_done_func_t *done,
558     void *priv, zio_priority_t priority, zio_flag_t flags,
559     const zbookmark_phys_t *zb);
560 
561 extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
562     struct abd *data, uint64_t size, zio_done_func_t *done, void *priv,
563     zio_priority_t priority, zio_flag_t flags, zbookmark_phys_t *zb);
564 
565 extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
566     boolean_t nopwrite, boolean_t brtwrite);
567 
568 extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
569 
570 extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
571     const blkptr_t *bp,
572     zio_done_func_t *done, void *priv, zio_flag_t flags);
573 
574 extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
575     zio_done_func_t *done, void *priv, zio_flag_t flags);
576 
577 extern zio_t *zio_trim(zio_t *pio, vdev_t *vd, uint64_t offset, uint64_t size,
578     zio_done_func_t *done, void *priv, zio_priority_t priority,
579     zio_flag_t flags, enum trim_flag trim_flags);
580 
581 extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
582     uint64_t size, struct abd *data, int checksum,
583     zio_done_func_t *done, void *priv, zio_priority_t priority,
584     zio_flag_t flags, boolean_t labels);
585 
586 extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
587     uint64_t size, struct abd *data, int checksum,
588     zio_done_func_t *done, void *priv, zio_priority_t priority,
589     zio_flag_t flags, boolean_t labels);
590 
591 extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
592     const blkptr_t *bp, zio_flag_t flags);
593 
594 extern int zio_alloc_zil(spa_t *spa, objset_t *os, uint64_t txg,
595     blkptr_t *new_bp, uint64_t size, boolean_t *slog);
596 extern void zio_flush(zio_t *zio, vdev_t *vd);
597 extern void zio_shrink(zio_t *zio, uint64_t size);
598 
599 extern int zio_wait(zio_t *zio);
600 extern void zio_nowait(zio_t *zio);
601 extern void zio_execute(void *zio);
602 extern void zio_interrupt(void *zio);
603 extern void zio_delay_init(zio_t *zio);
604 extern void zio_delay_interrupt(zio_t *zio);
605 extern void zio_deadman(zio_t *zio, const char *tag);
606 
607 extern zio_t *zio_walk_parents(zio_t *cio, zio_link_t **);
608 extern zio_t *zio_walk_children(zio_t *pio, zio_link_t **);
609 extern zio_t *zio_unique_parent(zio_t *cio);
610 extern void zio_add_child(zio_t *pio, zio_t *cio);
611 
612 extern void *zio_buf_alloc(size_t size);
613 extern void zio_buf_free(void *buf, size_t size);
614 extern void *zio_data_buf_alloc(size_t size);
615 extern void zio_data_buf_free(void *buf, size_t size);
616 
617 extern void zio_push_transform(zio_t *zio, struct abd *abd, uint64_t size,
618     uint64_t bufsize, zio_transform_func_t *transform);
619 extern void zio_pop_transforms(zio_t *zio);
620 
621 extern void zio_resubmit_stage_async(void *);
622 
623 extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
624     uint64_t offset, struct abd *data, uint64_t size, int type,
625     zio_priority_t priority, zio_flag_t flags,
626     zio_done_func_t *done, void *priv);
627 
628 extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
629     struct abd *data, uint64_t size, zio_type_t type, zio_priority_t priority,
630     zio_flag_t flags, zio_done_func_t *done, void *priv);
631 
632 extern void zio_vdev_io_bypass(zio_t *zio);
633 extern void zio_vdev_io_reissue(zio_t *zio);
634 extern void zio_vdev_io_redone(zio_t *zio);
635 
636 extern void zio_change_priority(zio_t *pio, zio_priority_t priority);
637 
638 extern void zio_checksum_verified(zio_t *zio);
639 extern int zio_worst_error(int e1, int e2);
640 
641 extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
642     enum zio_checksum parent);
643 extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
644     enum zio_checksum child, enum zio_checksum parent);
645 extern enum zio_compress zio_compress_select(spa_t *spa,
646     enum zio_compress child, enum zio_compress parent);
647 extern uint8_t zio_complevel_select(spa_t *spa, enum zio_compress compress,
648     uint8_t child, uint8_t parent);
649 
650 extern void zio_suspend(spa_t *spa, zio_t *zio, zio_suspend_reason_t);
651 extern int zio_resume(spa_t *spa);
652 extern void zio_resume_wait(spa_t *spa);
653 
654 extern boolean_t zfs_blkptr_verify(spa_t *spa, const blkptr_t *bp,
655     enum blk_config_flag blk_config, enum blk_verify_flag blk_verify);
656 
657 /*
658  * Initial setup and teardown.
659  */
660 extern void zio_init(void);
661 extern void zio_fini(void);
662 
663 /*
664  * Fault injection
665  */
666 struct zinject_record;
667 extern uint32_t zio_injection_enabled;
668 extern int zio_inject_fault(char *name, int flags, int *id,
669     struct zinject_record *record);
670 extern int zio_inject_list_next(int *id, char *name, size_t buflen,
671     struct zinject_record *record);
672 extern int zio_clear_fault(int id);
673 extern void zio_handle_panic_injection(spa_t *spa, const char *tag,
674     uint64_t type);
675 extern int zio_handle_decrypt_injection(spa_t *spa, const zbookmark_phys_t *zb,
676     uint64_t type, int error);
677 extern int zio_handle_fault_injection(zio_t *zio, int error);
678 extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
679 extern int zio_handle_device_injections(vdev_t *vd, zio_t *zio, int err1,
680     int err2);
681 extern int zio_handle_label_injection(zio_t *zio, int error);
682 extern void zio_handle_ignored_writes(zio_t *zio);
683 extern hrtime_t zio_handle_io_delay(zio_t *zio);
684 
685 /*
686  * Checksum ereport functions
687  */
688 extern int zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd,
689     const zbookmark_phys_t *zb, struct zio *zio, uint64_t offset,
690     uint64_t length, struct zio_bad_cksum *info);
691 extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
692     const abd_t *good_data, const abd_t *bad_data, boolean_t drop_if_identical);
693 
694 extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
695 
696 /* If we have the good data in hand, this function can be used */
697 extern int zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
698     const zbookmark_phys_t *zb, struct zio *zio, uint64_t offset,
699     uint64_t length, const abd_t *good_data, const abd_t *bad_data,
700     struct zio_bad_cksum *info);
701 
702 void zio_vsd_default_cksum_report(zio_t *zio, zio_cksum_report_t *zcr);
703 extern void zfs_ereport_snapshot_post(const char *subclass, spa_t *spa,
704     const char *name);
705 
706 /* Called from spa_sync(), but primarily an injection handler */
707 extern void spa_handle_ignored_writes(spa_t *spa);
708 
709 /* zbookmark_phys functions */
710 boolean_t zbookmark_subtree_completed(const struct dnode_phys *dnp,
711     const zbookmark_phys_t *subtree_root, const zbookmark_phys_t *last_block);
712 boolean_t zbookmark_subtree_tbd(const struct dnode_phys *dnp,
713     const zbookmark_phys_t *subtree_root, const zbookmark_phys_t *last_block);
714 int zbookmark_compare(uint16_t dbss1, uint8_t ibs1, uint16_t dbss2,
715     uint8_t ibs2, const zbookmark_phys_t *zb1, const zbookmark_phys_t *zb2);
716 
717 #ifdef	__cplusplus
718 }
719 #endif
720 
721 #endif	/* _ZIO_H */
722