xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zio.h (revision 810e43b2eb0e320833671a403fdda51917e8b036)
1fa9e4066Sahrens /*
2fa9e4066Sahrens  * CDDL HEADER START
3fa9e4066Sahrens  *
4fa9e4066Sahrens  * The contents of this file are subject to the terms of the
5ea8dc4b6Seschrock  * Common Development and Distribution License (the "License").
6ea8dc4b6Seschrock  * You may not use this file except in compliance with the License.
7fa9e4066Sahrens  *
8fa9e4066Sahrens  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9fa9e4066Sahrens  * or http://www.opensolaris.org/os/licensing.
10fa9e4066Sahrens  * See the License for the specific language governing permissions
11fa9e4066Sahrens  * and limitations under the License.
12fa9e4066Sahrens  *
13fa9e4066Sahrens  * When distributing Covered Code, include this CDDL HEADER in each
14fa9e4066Sahrens  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15fa9e4066Sahrens  * If applicable, add the following below this CDDL HEADER, with the
16fa9e4066Sahrens  * fields enclosed by brackets "[]" replaced with your own identifying
17fa9e4066Sahrens  * information: Portions Copyright [yyyy] [name of copyright owner]
18fa9e4066Sahrens  *
19fa9e4066Sahrens  * CDDL HEADER END
20fa9e4066Sahrens  */
21c9431fa1Sahl 
22fa9e4066Sahrens /*
23c7cd2421SGeorge Wilson  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
245aeb9474SGarrett D'Amore  * Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
25ad135b5dSChristopher Siden  * Copyright (c) 2012 by Delphix. All rights reserved.
26a6f561b4SSašo Kiselkov  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27*810e43b2SBill Pijewski  * Copyright (c) 2013, Joyent, Inc. All rights reserved.
285aeb9474SGarrett D'Amore  */
29fa9e4066Sahrens 
30fa9e4066Sahrens #ifndef _ZIO_H
31fa9e4066Sahrens #define	_ZIO_H
32fa9e4066Sahrens 
33fa9e4066Sahrens #include <sys/zfs_context.h>
34fa9e4066Sahrens #include <sys/spa.h>
35fa9e4066Sahrens #include <sys/txg.h>
36fa9e4066Sahrens #include <sys/avl.h>
37fa9e4066Sahrens #include <sys/fs/zfs.h>
3844cd46caSbillm #include <sys/zio_impl.h>
39fa9e4066Sahrens 
40fa9e4066Sahrens #ifdef	__cplusplus
41fa9e4066Sahrens extern "C" {
42fa9e4066Sahrens #endif
43fa9e4066Sahrens 
446e1f5caaSNeil Perrin /*
456e1f5caaSNeil Perrin  * Embedded checksum
466e1f5caaSNeil Perrin  */
476e1f5caaSNeil Perrin #define	ZEC_MAGIC	0x210da7ab10c7a11ULL
48fa9e4066Sahrens 
496e1f5caaSNeil Perrin typedef struct zio_eck {
506e1f5caaSNeil Perrin 	uint64_t	zec_magic;	/* for validation, endianness	*/
516e1f5caaSNeil Perrin 	zio_cksum_t	zec_cksum;	/* 256-bit checksum		*/
526e1f5caaSNeil Perrin } zio_eck_t;
53fa9e4066Sahrens 
54fa9e4066Sahrens /*
55fa9e4066Sahrens  * Gang block headers are self-checksumming and contain an array
56fa9e4066Sahrens  * of block pointers.
57fa9e4066Sahrens  */
58fa9e4066Sahrens #define	SPA_GANGBLOCKSIZE	SPA_MINBLOCKSIZE
59fa9e4066Sahrens #define	SPA_GBH_NBLKPTRS	((SPA_GANGBLOCKSIZE - \
606e1f5caaSNeil Perrin 	sizeof (zio_eck_t)) / sizeof (blkptr_t))
61fa9e4066Sahrens #define	SPA_GBH_FILLER		((SPA_GANGBLOCKSIZE - \
626e1f5caaSNeil Perrin 	sizeof (zio_eck_t) - \
63fa9e4066Sahrens 	(SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
64fa9e4066Sahrens 	sizeof (uint64_t))
65fa9e4066Sahrens 
66fa9e4066Sahrens typedef struct zio_gbh {
67fa9e4066Sahrens 	blkptr_t		zg_blkptr[SPA_GBH_NBLKPTRS];
68fa9e4066Sahrens 	uint64_t		zg_filler[SPA_GBH_FILLER];
696e1f5caaSNeil Perrin 	zio_eck_t		zg_tail;
70fa9e4066Sahrens } zio_gbh_phys_t;
71fa9e4066Sahrens 
72fa9e4066Sahrens enum zio_checksum {
73fa9e4066Sahrens 	ZIO_CHECKSUM_INHERIT = 0,
74fa9e4066Sahrens 	ZIO_CHECKSUM_ON,
75fa9e4066Sahrens 	ZIO_CHECKSUM_OFF,
76fa9e4066Sahrens 	ZIO_CHECKSUM_LABEL,
77fa9e4066Sahrens 	ZIO_CHECKSUM_GANG_HEADER,
78fa9e4066Sahrens 	ZIO_CHECKSUM_ZILOG,
79fa9e4066Sahrens 	ZIO_CHECKSUM_FLETCHER_2,
80fa9e4066Sahrens 	ZIO_CHECKSUM_FLETCHER_4,
81fa9e4066Sahrens 	ZIO_CHECKSUM_SHA256,
826e1f5caaSNeil Perrin 	ZIO_CHECKSUM_ZILOG2,
83*810e43b2SBill Pijewski 	ZIO_CHECKSUM_NOPARITY,
84fa9e4066Sahrens 	ZIO_CHECKSUM_FUNCTIONS
85fa9e4066Sahrens };
86fa9e4066Sahrens 
877e322df5SJonathan Adams #define	ZIO_CHECKSUM_ON_VALUE	ZIO_CHECKSUM_FLETCHER_4
88fa9e4066Sahrens #define	ZIO_CHECKSUM_DEFAULT	ZIO_CHECKSUM_ON
89fa9e4066Sahrens 
90b24ab676SJeff Bonwick #define	ZIO_CHECKSUM_MASK	0xffULL
91b24ab676SJeff Bonwick #define	ZIO_CHECKSUM_VERIFY	(1 << 8)
92b24ab676SJeff Bonwick 
93b24ab676SJeff Bonwick #define	ZIO_DEDUPCHECKSUM	ZIO_CHECKSUM_SHA256
94b24ab676SJeff Bonwick #define	ZIO_DEDUPDITTO_MIN	100
95b24ab676SJeff Bonwick 
96fa9e4066Sahrens enum zio_compress {
97fa9e4066Sahrens 	ZIO_COMPRESS_INHERIT = 0,
98fa9e4066Sahrens 	ZIO_COMPRESS_ON,
99fa9e4066Sahrens 	ZIO_COMPRESS_OFF,
100fa9e4066Sahrens 	ZIO_COMPRESS_LZJB,
101416e0cd8Sek 	ZIO_COMPRESS_EMPTY,
102c9431fa1Sahl 	ZIO_COMPRESS_GZIP_1,
103c9431fa1Sahl 	ZIO_COMPRESS_GZIP_2,
104c9431fa1Sahl 	ZIO_COMPRESS_GZIP_3,
105c9431fa1Sahl 	ZIO_COMPRESS_GZIP_4,
106c9431fa1Sahl 	ZIO_COMPRESS_GZIP_5,
107c9431fa1Sahl 	ZIO_COMPRESS_GZIP_6,
108c9431fa1Sahl 	ZIO_COMPRESS_GZIP_7,
109c9431fa1Sahl 	ZIO_COMPRESS_GZIP_8,
110c9431fa1Sahl 	ZIO_COMPRESS_GZIP_9,
111b24ab676SJeff Bonwick 	ZIO_COMPRESS_ZLE,
112a6f561b4SSašo Kiselkov 	ZIO_COMPRESS_LZ4,
113fa9e4066Sahrens 	ZIO_COMPRESS_FUNCTIONS
114fa9e4066Sahrens };
115fa9e4066Sahrens 
116a6f561b4SSašo Kiselkov /* N.B. when altering this value, also change BOOTFS_COMPRESS_VALID below */
117fa9e4066Sahrens #define	ZIO_COMPRESS_ON_VALUE	ZIO_COMPRESS_LZJB
118fa9e4066Sahrens #define	ZIO_COMPRESS_DEFAULT	ZIO_COMPRESS_OFF
119fa9e4066Sahrens 
120b24ab676SJeff Bonwick #define	BOOTFS_COMPRESS_VALID(compress)			\
121b24ab676SJeff Bonwick 	((compress) == ZIO_COMPRESS_LZJB ||		\
122a6f561b4SSašo Kiselkov 	(compress) == ZIO_COMPRESS_LZ4 ||		\
123b24ab676SJeff Bonwick 	((compress) == ZIO_COMPRESS_ON &&		\
124b24ab676SJeff Bonwick 	ZIO_COMPRESS_ON_VALUE == ZIO_COMPRESS_LZJB) ||	\
125b24ab676SJeff Bonwick 	(compress) == ZIO_COMPRESS_OFF)
126b24ab676SJeff Bonwick 
1270a4e9518Sgw #define	ZIO_FAILURE_MODE_WAIT		0
1280a4e9518Sgw #define	ZIO_FAILURE_MODE_CONTINUE	1
1290a4e9518Sgw #define	ZIO_FAILURE_MODE_PANIC		2
1300a4e9518Sgw 
131fa9e4066Sahrens #define	ZIO_PRIORITY_NOW		(zio_priority_table[0])
132fa9e4066Sahrens #define	ZIO_PRIORITY_SYNC_READ		(zio_priority_table[1])
133fa9e4066Sahrens #define	ZIO_PRIORITY_SYNC_WRITE		(zio_priority_table[2])
13480eb36f2SGeorge Wilson #define	ZIO_PRIORITY_LOG_WRITE		(zio_priority_table[3])
13580eb36f2SGeorge Wilson #define	ZIO_PRIORITY_CACHE_FILL		(zio_priority_table[4])
13680eb36f2SGeorge Wilson #define	ZIO_PRIORITY_AGG		(zio_priority_table[5])
13780eb36f2SGeorge Wilson #define	ZIO_PRIORITY_FREE		(zio_priority_table[6])
13880eb36f2SGeorge Wilson #define	ZIO_PRIORITY_ASYNC_WRITE	(zio_priority_table[7])
13980eb36f2SGeorge Wilson #define	ZIO_PRIORITY_ASYNC_READ		(zio_priority_table[8])
14080eb36f2SGeorge Wilson #define	ZIO_PRIORITY_RESILVER		(zio_priority_table[9])
14180eb36f2SGeorge Wilson #define	ZIO_PRIORITY_SCRUB		(zio_priority_table[10])
142c7cd2421SGeorge Wilson #define	ZIO_PRIORITY_DDT_PREFETCH	(zio_priority_table[11])
143c7cd2421SGeorge Wilson #define	ZIO_PRIORITY_TABLE_SIZE		12
144fa9e4066Sahrens 
145e05725b1Sbonwick #define	ZIO_PIPELINE_CONTINUE		0x100
146e05725b1Sbonwick #define	ZIO_PIPELINE_STOP		0x101
147e05725b1Sbonwick 
148b24ab676SJeff Bonwick enum zio_flag {
149b24ab676SJeff Bonwick 	/*
150b24ab676SJeff Bonwick 	 * Flags inherited by gang, ddt, and vdev children,
151b24ab676SJeff Bonwick 	 * and that must be equal for two zios to aggregate
152b24ab676SJeff Bonwick 	 */
153b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_AGGREGATE	= 1 << 0,
154b24ab676SJeff Bonwick 	ZIO_FLAG_IO_REPAIR	= 1 << 1,
155b24ab676SJeff Bonwick 	ZIO_FLAG_SELF_HEAL	= 1 << 2,
156b24ab676SJeff Bonwick 	ZIO_FLAG_RESILVER	= 1 << 3,
157b24ab676SJeff Bonwick 	ZIO_FLAG_SCRUB		= 1 << 4,
15844ecc532SGeorge Wilson 	ZIO_FLAG_SCAN_THREAD	= 1 << 5,
159b24ab676SJeff Bonwick 
160b24ab676SJeff Bonwick #define	ZIO_FLAG_AGG_INHERIT	(ZIO_FLAG_CANFAIL - 1)
161b24ab676SJeff Bonwick 
162b24ab676SJeff Bonwick 	/*
163b24ab676SJeff Bonwick 	 * Flags inherited by ddt, gang, and vdev children.
164b24ab676SJeff Bonwick 	 */
165b24ab676SJeff Bonwick 	ZIO_FLAG_CANFAIL	= 1 << 6,	/* must be first for INHERIT */
166b24ab676SJeff Bonwick 	ZIO_FLAG_SPECULATIVE	= 1 << 7,
167b24ab676SJeff Bonwick 	ZIO_FLAG_CONFIG_WRITER	= 1 << 8,
168b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_RETRY	= 1 << 9,
169b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_CACHE	= 1 << 10,
170b24ab676SJeff Bonwick 	ZIO_FLAG_NODATA		= 1 << 11,
171b24ab676SJeff Bonwick 	ZIO_FLAG_INDUCE_DAMAGE	= 1 << 12,
172b24ab676SJeff Bonwick 
173b24ab676SJeff Bonwick #define	ZIO_FLAG_DDT_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
174b24ab676SJeff Bonwick #define	ZIO_FLAG_GANG_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
175b24ab676SJeff Bonwick 
176b24ab676SJeff Bonwick 	/*
177b24ab676SJeff Bonwick 	 * Flags inherited by vdev children.
178b24ab676SJeff Bonwick 	 */
179b24ab676SJeff Bonwick 	ZIO_FLAG_IO_RETRY	= 1 << 13,	/* must be first for INHERIT */
180b24ab676SJeff Bonwick 	ZIO_FLAG_PROBE		= 1 << 14,
181b24ab676SJeff Bonwick 	ZIO_FLAG_TRYHARD	= 1 << 15,
182b24ab676SJeff Bonwick 	ZIO_FLAG_OPTIONAL	= 1 << 16,
183b24ab676SJeff Bonwick 
184b24ab676SJeff Bonwick #define	ZIO_FLAG_VDEV_INHERIT	(ZIO_FLAG_DONT_QUEUE - 1)
185b24ab676SJeff Bonwick 
186b24ab676SJeff Bonwick 	/*
187b24ab676SJeff Bonwick 	 * Flags not inherited by any children.
188b24ab676SJeff Bonwick 	 */
189b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_QUEUE	= 1 << 17,	/* must be first for INHERIT */
190b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_PROPAGATE	= 1 << 18,
191b24ab676SJeff Bonwick 	ZIO_FLAG_IO_BYPASS	= 1 << 19,
192b24ab676SJeff Bonwick 	ZIO_FLAG_IO_REWRITE	= 1 << 20,
193b24ab676SJeff Bonwick 	ZIO_FLAG_RAW		= 1 << 21,
194b24ab676SJeff Bonwick 	ZIO_FLAG_GANG_CHILD	= 1 << 22,
195b24ab676SJeff Bonwick 	ZIO_FLAG_DDT_CHILD	= 1 << 23,
19680901aeaSGeorge Wilson 	ZIO_FLAG_GODFATHER	= 1 << 24,
19780901aeaSGeorge Wilson 	ZIO_FLAG_NOPWRITE	= 1 << 25,
19880901aeaSGeorge Wilson 	ZIO_FLAG_REEXECUTED	= 1 << 26,
199b24ab676SJeff Bonwick };
200b24ab676SJeff Bonwick 
201b24ab676SJeff Bonwick #define	ZIO_FLAG_MUSTSUCCEED		0
202b24ab676SJeff Bonwick 
203b24ab676SJeff Bonwick #define	ZIO_DDT_CHILD_FLAGS(zio)				\
204b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) |		\
205b24ab676SJeff Bonwick 	ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
206b24ab676SJeff Bonwick 
207e14bb325SJeff Bonwick #define	ZIO_GANG_CHILD_FLAGS(zio)				\
208e14bb325SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) |		\
209e14bb325SJeff Bonwick 	ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
210e14bb325SJeff Bonwick 
211b24ab676SJeff Bonwick #define	ZIO_VDEV_CHILD_FLAGS(zio)				\
212b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) |		\
213b24ab676SJeff Bonwick 	ZIO_FLAG_CANFAIL)
214b24ab676SJeff Bonwick 
215e14bb325SJeff Bonwick enum zio_child {
216e14bb325SJeff Bonwick 	ZIO_CHILD_VDEV = 0,
217e14bb325SJeff Bonwick 	ZIO_CHILD_GANG,
218b24ab676SJeff Bonwick 	ZIO_CHILD_DDT,
219e14bb325SJeff Bonwick 	ZIO_CHILD_LOGICAL,
220e14bb325SJeff Bonwick 	ZIO_CHILD_TYPES
221e14bb325SJeff Bonwick };
222e14bb325SJeff Bonwick 
223e14bb325SJeff Bonwick enum zio_wait_type {
224e14bb325SJeff Bonwick 	ZIO_WAIT_READY = 0,
225e14bb325SJeff Bonwick 	ZIO_WAIT_DONE,
226e14bb325SJeff Bonwick 	ZIO_WAIT_TYPES
227e14bb325SJeff Bonwick };
228e14bb325SJeff Bonwick 
229fa9e4066Sahrens /*
230e7cbe64fSgw  * We'll take the unused errnos, 'EBADE' and 'EBADR' (from the Convergent
231e7cbe64fSgw  * graveyard) to indicate checksum errors and fragmentation.
232fa9e4066Sahrens  */
233fa9e4066Sahrens #define	ECKSUM	EBADE
234e7cbe64fSgw #define	EFRAGS	EBADR
235fa9e4066Sahrens 
236fa9e4066Sahrens typedef void zio_done_func_t(zio_t *zio);
237fa9e4066Sahrens 
238fa9e4066Sahrens extern uint8_t zio_priority_table[ZIO_PRIORITY_TABLE_SIZE];
239fa9e4066Sahrens extern char *zio_type_name[ZIO_TYPES];
240fa9e4066Sahrens 
241ea8dc4b6Seschrock /*
242ea8dc4b6Seschrock  * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
243ea8dc4b6Seschrock  * identifies any block in the pool.  By convention, the meta-objset (MOS)
244b24ab676SJeff Bonwick  * is objset 0, and the meta-dnode is object 0.  This covers all blocks
245b24ab676SJeff Bonwick  * except root blocks and ZIL blocks, which are defined as follows:
246ea8dc4b6Seschrock  *
247b24ab676SJeff Bonwick  * Root blocks (objset_phys_t) are object 0, level -1:  <objset, 0, -1, 0>.
248b24ab676SJeff Bonwick  * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
249b24ab676SJeff Bonwick  * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
250ea8dc4b6Seschrock  *
251b24ab676SJeff Bonwick  * Note: this structure is called a bookmark because its original purpose
252b24ab676SJeff Bonwick  * was to remember where to resume a pool-wide traverse.
253ea8dc4b6Seschrock  *
254ea8dc4b6Seschrock  * Note: this structure is passed between userland and the kernel.
255ea8dc4b6Seschrock  * Therefore it must not change size or alignment between 32/64 bit
256ea8dc4b6Seschrock  * compilation options.
257ea8dc4b6Seschrock  */
258ea8dc4b6Seschrock typedef struct zbookmark {
259ea8dc4b6Seschrock 	uint64_t	zb_objset;
260ea8dc4b6Seschrock 	uint64_t	zb_object;
261ea8dc4b6Seschrock 	int64_t		zb_level;
262ea8dc4b6Seschrock 	uint64_t	zb_blkid;
263ea8dc4b6Seschrock } zbookmark_t;
264ea8dc4b6Seschrock 
265b24ab676SJeff Bonwick #define	SET_BOOKMARK(zb, objset, object, level, blkid)  \
266b24ab676SJeff Bonwick {                                                       \
267b24ab676SJeff Bonwick 	(zb)->zb_objset = objset;                       \
268b24ab676SJeff Bonwick 	(zb)->zb_object = object;                       \
269b24ab676SJeff Bonwick 	(zb)->zb_level = level;                         \
270b24ab676SJeff Bonwick 	(zb)->zb_blkid = blkid;                         \
271b24ab676SJeff Bonwick }
272b24ab676SJeff Bonwick 
273b24ab676SJeff Bonwick #define	ZB_DESTROYED_OBJSET	(-1ULL)
274b24ab676SJeff Bonwick 
275b24ab676SJeff Bonwick #define	ZB_ROOT_OBJECT		(0ULL)
276b24ab676SJeff Bonwick #define	ZB_ROOT_LEVEL		(-1LL)
277b24ab676SJeff Bonwick #define	ZB_ROOT_BLKID		(0ULL)
278b24ab676SJeff Bonwick 
279b24ab676SJeff Bonwick #define	ZB_ZIL_OBJECT		(0ULL)
280b24ab676SJeff Bonwick #define	ZB_ZIL_LEVEL		(-2LL)
281b24ab676SJeff Bonwick 
282ad135b5dSChristopher Siden #define	ZB_IS_ZERO(zb)						\
283ad135b5dSChristopher Siden 	((zb)->zb_objset == 0 && (zb)->zb_object == 0 &&	\
284ad135b5dSChristopher Siden 	(zb)->zb_level == 0 && (zb)->zb_blkid == 0)
285ad135b5dSChristopher Siden #define	ZB_IS_ROOT(zb)				\
286ad135b5dSChristopher Siden 	((zb)->zb_object == ZB_ROOT_OBJECT &&	\
287ad135b5dSChristopher Siden 	(zb)->zb_level == ZB_ROOT_LEVEL &&	\
288ad135b5dSChristopher Siden 	(zb)->zb_blkid == ZB_ROOT_BLKID)
289ad135b5dSChristopher Siden 
290e14bb325SJeff Bonwick typedef struct zio_prop {
291e14bb325SJeff Bonwick 	enum zio_checksum	zp_checksum;
292e14bb325SJeff Bonwick 	enum zio_compress	zp_compress;
293e14bb325SJeff Bonwick 	dmu_object_type_t	zp_type;
294e14bb325SJeff Bonwick 	uint8_t			zp_level;
295b24ab676SJeff Bonwick 	uint8_t			zp_copies;
29680901aeaSGeorge Wilson 	boolean_t		zp_dedup;
29780901aeaSGeorge Wilson 	boolean_t		zp_dedup_verify;
29880901aeaSGeorge Wilson 	boolean_t		zp_nopwrite;
299e14bb325SJeff Bonwick } zio_prop_t;
300e14bb325SJeff Bonwick 
30122fe2c88SJonathan Adams typedef struct zio_cksum_report zio_cksum_report_t;
30222fe2c88SJonathan Adams 
30322fe2c88SJonathan Adams typedef void zio_cksum_finish_f(zio_cksum_report_t *rep,
30422fe2c88SJonathan Adams     const void *good_data);
30522fe2c88SJonathan Adams typedef void zio_cksum_free_f(void *cbdata, size_t size);
30622fe2c88SJonathan Adams 
30722fe2c88SJonathan Adams struct zio_bad_cksum;				/* defined in zio_checksum.h */
308ad135b5dSChristopher Siden struct dnode_phys;
30922fe2c88SJonathan Adams 
31022fe2c88SJonathan Adams struct zio_cksum_report {
31122fe2c88SJonathan Adams 	struct zio_cksum_report *zcr_next;
31222fe2c88SJonathan Adams 	nvlist_t		*zcr_ereport;
31322fe2c88SJonathan Adams 	nvlist_t		*zcr_detector;
31422fe2c88SJonathan Adams 	void			*zcr_cbdata;
31522fe2c88SJonathan Adams 	size_t			zcr_cbinfo;	/* passed to zcr_free() */
316b24ab676SJeff Bonwick 	uint64_t		zcr_align;
31722fe2c88SJonathan Adams 	uint64_t		zcr_length;
31822fe2c88SJonathan Adams 	zio_cksum_finish_f	*zcr_finish;
31922fe2c88SJonathan Adams 	zio_cksum_free_f	*zcr_free;
32022fe2c88SJonathan Adams 
32122fe2c88SJonathan Adams 	/* internal use only */
32222fe2c88SJonathan Adams 	struct zio_bad_cksum	*zcr_ckinfo;	/* information from failure */
32322fe2c88SJonathan Adams };
32422fe2c88SJonathan Adams 
32522fe2c88SJonathan Adams typedef void zio_vsd_cksum_report_f(zio_t *zio, zio_cksum_report_t *zcr,
32622fe2c88SJonathan Adams     void *arg);
32722fe2c88SJonathan Adams 
32822fe2c88SJonathan Adams zio_vsd_cksum_report_f	zio_vsd_default_cksum_report;
32922fe2c88SJonathan Adams 
33022fe2c88SJonathan Adams typedef struct zio_vsd_ops {
33122fe2c88SJonathan Adams 	zio_done_func_t		*vsd_free;
33222fe2c88SJonathan Adams 	zio_vsd_cksum_report_f	*vsd_cksum_report;
33322fe2c88SJonathan Adams } zio_vsd_ops_t;
33422fe2c88SJonathan Adams 
335e14bb325SJeff Bonwick typedef struct zio_gang_node {
336e14bb325SJeff Bonwick 	zio_gbh_phys_t		*gn_gbh;
337e14bb325SJeff Bonwick 	struct zio_gang_node	*gn_child[SPA_GBH_NBLKPTRS];
338e14bb325SJeff Bonwick } zio_gang_node_t;
339e14bb325SJeff Bonwick 
340e14bb325SJeff Bonwick typedef zio_t *zio_gang_issue_func_t(zio_t *zio, blkptr_t *bp,
341e14bb325SJeff Bonwick     zio_gang_node_t *gn, void *data);
342e14bb325SJeff Bonwick 
343e14bb325SJeff Bonwick typedef void zio_transform_func_t(zio_t *zio, void *data, uint64_t size);
344e14bb325SJeff Bonwick 
345e14bb325SJeff Bonwick typedef struct zio_transform {
346e14bb325SJeff Bonwick 	void			*zt_orig_data;
347e14bb325SJeff Bonwick 	uint64_t		zt_orig_size;
348e14bb325SJeff Bonwick 	uint64_t		zt_bufsize;
349e14bb325SJeff Bonwick 	zio_transform_func_t	*zt_transform;
350e14bb325SJeff Bonwick 	struct zio_transform	*zt_next;
351e14bb325SJeff Bonwick } zio_transform_t;
352e14bb325SJeff Bonwick 
353e14bb325SJeff Bonwick typedef int zio_pipe_stage_t(zio_t *zio);
354e14bb325SJeff Bonwick 
355e14bb325SJeff Bonwick /*
356e14bb325SJeff Bonwick  * The io_reexecute flags are distinct from io_flags because the child must
357e14bb325SJeff Bonwick  * be able to propagate them to the parent.  The normal io_flags are local
358e14bb325SJeff Bonwick  * to the zio, not protected by any lock, and not modifiable by children;
359e14bb325SJeff Bonwick  * the reexecute flags are protected by io_lock, modifiable by children,
360e14bb325SJeff Bonwick  * and always propagated -- even when ZIO_FLAG_DONT_PROPAGATE is set.
361e14bb325SJeff Bonwick  */
362e14bb325SJeff Bonwick #define	ZIO_REEXECUTE_NOW	0x01
363e14bb325SJeff Bonwick #define	ZIO_REEXECUTE_SUSPEND	0x02
364e14bb325SJeff Bonwick 
365a3f829aeSBill Moore typedef struct zio_link {
366a3f829aeSBill Moore 	zio_t		*zl_parent;
367a3f829aeSBill Moore 	zio_t		*zl_child;
368a3f829aeSBill Moore 	list_node_t	zl_parent_node;
369a3f829aeSBill Moore 	list_node_t	zl_child_node;
370a3f829aeSBill Moore } zio_link_t;
371a3f829aeSBill Moore 
372fa9e4066Sahrens struct zio {
373fa9e4066Sahrens 	/* Core information about this I/O */
374ea8dc4b6Seschrock 	zbookmark_t	io_bookmark;
375e14bb325SJeff Bonwick 	zio_prop_t	io_prop;
376e14bb325SJeff Bonwick 	zio_type_t	io_type;
377e14bb325SJeff Bonwick 	enum zio_child	io_child_type;
378e14bb325SJeff Bonwick 	int		io_cmd;
379e14bb325SJeff Bonwick 	uint8_t		io_priority;
380e14bb325SJeff Bonwick 	uint8_t		io_reexecute;
381a3f829aeSBill Moore 	uint8_t		io_state[ZIO_WAIT_TYPES];
382fa9e4066Sahrens 	uint64_t	io_txg;
383e14bb325SJeff Bonwick 	spa_t		*io_spa;
384fa9e4066Sahrens 	blkptr_t	*io_bp;
385b24ab676SJeff Bonwick 	blkptr_t	*io_bp_override;
386fa9e4066Sahrens 	blkptr_t	io_bp_copy;
387a3f829aeSBill Moore 	list_t		io_parent_list;
388a3f829aeSBill Moore 	list_t		io_child_list;
389a3f829aeSBill Moore 	zio_link_t	*io_walk_link;
390ea8dc4b6Seschrock 	zio_t		*io_logical;
391e14bb325SJeff Bonwick 	zio_transform_t *io_transform_stack;
392fa9e4066Sahrens 
393fa9e4066Sahrens 	/* Callback info */
394c717a561Smaybee 	zio_done_func_t	*io_ready;
395fa9e4066Sahrens 	zio_done_func_t	*io_done;
396fa9e4066Sahrens 	void		*io_private;
397b24ab676SJeff Bonwick 	int64_t		io_prev_space_delta;	/* DMU private */
398fa9e4066Sahrens 	blkptr_t	io_bp_orig;
399fa9e4066Sahrens 
400fa9e4066Sahrens 	/* Data represented by this I/O */
401fa9e4066Sahrens 	void		*io_data;
402b24ab676SJeff Bonwick 	void		*io_orig_data;
403fa9e4066Sahrens 	uint64_t	io_size;
404b24ab676SJeff Bonwick 	uint64_t	io_orig_size;
405fa9e4066Sahrens 
406fa9e4066Sahrens 	/* Stuff for the vdev stack */
407fa9e4066Sahrens 	vdev_t		*io_vd;
408fa9e4066Sahrens 	void		*io_vsd;
40922fe2c88SJonathan Adams 	const zio_vsd_ops_t *io_vsd_ops;
41022fe2c88SJonathan Adams 
411fa9e4066Sahrens 	uint64_t	io_offset;
412fa9e4066Sahrens 	uint64_t	io_deadline;
413c55e05cbSMatthew Ahrens 	hrtime_t	io_timestamp;
414fa9e4066Sahrens 	avl_node_t	io_offset_node;
415fa9e4066Sahrens 	avl_node_t	io_deadline_node;
416fa9e4066Sahrens 	avl_tree_t	*io_vdev_tree;
417fa9e4066Sahrens 
418fa9e4066Sahrens 	/* Internal pipeline state */
419b24ab676SJeff Bonwick 	enum zio_flag	io_flags;
420b24ab676SJeff Bonwick 	enum zio_stage	io_stage;
421b24ab676SJeff Bonwick 	enum zio_stage	io_pipeline;
422b24ab676SJeff Bonwick 	enum zio_flag	io_orig_flags;
423b24ab676SJeff Bonwick 	enum zio_stage	io_orig_stage;
424b24ab676SJeff Bonwick 	enum zio_stage	io_orig_pipeline;
425e14bb325SJeff Bonwick 	int		io_error;
426e14bb325SJeff Bonwick 	int		io_child_error[ZIO_CHILD_TYPES];
427e14bb325SJeff Bonwick 	uint64_t	io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
428b24ab676SJeff Bonwick 	uint64_t	io_child_count;
429b24ab676SJeff Bonwick 	uint64_t	io_parent_count;
430e14bb325SJeff Bonwick 	uint64_t	*io_stall;
431f5383399SBill Moore 	zio_t		*io_gang_leader;
432e14bb325SJeff Bonwick 	zio_gang_node_t	*io_gang_tree;
433e14bb325SJeff Bonwick 	void		*io_executor;
434fa9e4066Sahrens 	void		*io_waiter;
435fa9e4066Sahrens 	kmutex_t	io_lock;
436fa9e4066Sahrens 	kcondvar_t	io_cv;
437ea8dc4b6Seschrock 
438ea8dc4b6Seschrock 	/* FMA state */
43922fe2c88SJonathan Adams 	zio_cksum_report_t *io_cksum_report;
440ea8dc4b6Seschrock 	uint64_t	io_ena;
4415aeb9474SGarrett D'Amore 
4425aeb9474SGarrett D'Amore 	/* Taskq dispatching state */
4435aeb9474SGarrett D'Amore 	taskq_ent_t	io_tqent;
444fa9e4066Sahrens };
445fa9e4066Sahrens 
446a3f829aeSBill Moore extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
447b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
448fa9e4066Sahrens 
449fa9e4066Sahrens extern zio_t *zio_root(spa_t *spa,
450b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
451fa9e4066Sahrens 
452088f3894Sahrens extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, void *data,
453fa9e4066Sahrens     uint64_t size, zio_done_func_t *done, void *private,
454b24ab676SJeff Bonwick     int priority, enum zio_flag flags, const zbookmark_t *zb);
455fa9e4066Sahrens 
456e14bb325SJeff Bonwick extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
457b24ab676SJeff Bonwick     void *data, uint64_t size, const zio_prop_t *zp,
458e14bb325SJeff Bonwick     zio_done_func_t *ready, zio_done_func_t *done, void *private,
459b24ab676SJeff Bonwick     int priority, enum zio_flag flags, const zbookmark_t *zb);
460fa9e4066Sahrens 
461e14bb325SJeff Bonwick extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
462e14bb325SJeff Bonwick     void *data, uint64_t size, zio_done_func_t *done, void *private,
463b24ab676SJeff Bonwick     int priority, enum zio_flag flags, zbookmark_t *zb);
464fa9e4066Sahrens 
46580901aeaSGeorge Wilson extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
46680901aeaSGeorge Wilson     boolean_t nopwrite);
46782c9918fSTim Haley 
468b24ab676SJeff Bonwick extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
469fa9e4066Sahrens 
470b24ab676SJeff Bonwick extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
471b24ab676SJeff Bonwick     const blkptr_t *bp,
472b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
473fa9e4066Sahrens 
474fa9e4066Sahrens extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
475b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, int priority, enum zio_flag flags);
476fa9e4066Sahrens 
477fa9e4066Sahrens extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
478fa9e4066Sahrens     uint64_t size, void *data, int checksum,
479b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, int priority, enum zio_flag flags,
480fa94a07fSbrendan     boolean_t labels);
481fa9e4066Sahrens 
482fa9e4066Sahrens extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
483fa9e4066Sahrens     uint64_t size, void *data, int checksum,
484b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, int priority, enum zio_flag flags,
485fa94a07fSbrendan     boolean_t labels);
486fa9e4066Sahrens 
487b24ab676SJeff Bonwick extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
488b24ab676SJeff Bonwick     const blkptr_t *bp, enum zio_flag flags);
489b24ab676SJeff Bonwick 
490b24ab676SJeff Bonwick extern int zio_alloc_zil(spa_t *spa, uint64_t txg, blkptr_t *new_bp,
491b24ab676SJeff Bonwick     blkptr_t *old_bp, uint64_t size, boolean_t use_slog);
492b24ab676SJeff Bonwick extern void zio_free_zil(spa_t *spa, uint64_t txg, blkptr_t *bp);
49317f17c2dSbonwick extern void zio_flush(zio_t *zio, vdev_t *vd);
4946e1f5caaSNeil Perrin extern void zio_shrink(zio_t *zio, uint64_t size);
495fa9e4066Sahrens 
496fa9e4066Sahrens extern int zio_wait(zio_t *zio);
497fa9e4066Sahrens extern void zio_nowait(zio_t *zio);
498e05725b1Sbonwick extern void zio_execute(zio_t *zio);
499e05725b1Sbonwick extern void zio_interrupt(zio_t *zio);
500e05725b1Sbonwick 
501a3f829aeSBill Moore extern zio_t *zio_walk_parents(zio_t *cio);
502a3f829aeSBill Moore extern zio_t *zio_walk_children(zio_t *pio);
503a3f829aeSBill Moore extern zio_t *zio_unique_parent(zio_t *cio);
504a3f829aeSBill Moore extern void zio_add_child(zio_t *pio, zio_t *cio);
505a3f829aeSBill Moore 
506fa9e4066Sahrens extern void *zio_buf_alloc(size_t size);
507fa9e4066Sahrens extern void zio_buf_free(void *buf, size_t size);
508ad23a2dbSjohansen extern void *zio_data_buf_alloc(size_t size);
509ad23a2dbSjohansen extern void zio_data_buf_free(void *buf, size_t size);
510fa9e4066Sahrens 
5110a4e9518Sgw extern void zio_resubmit_stage_async(void *);
512fa9e4066Sahrens 
513fa9e4066Sahrens extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
514fa9e4066Sahrens     uint64_t offset, void *data, uint64_t size, int type, int priority,
515b24ab676SJeff Bonwick     enum zio_flag flags, zio_done_func_t *done, void *private);
516fa9e4066Sahrens 
517e14bb325SJeff Bonwick extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
518e14bb325SJeff Bonwick     void *data, uint64_t size, int type, int priority,
519b24ab676SJeff Bonwick     enum zio_flag flags, zio_done_func_t *done, void *private);
520e14bb325SJeff Bonwick 
521fa9e4066Sahrens extern void zio_vdev_io_bypass(zio_t *zio);
522fa9e4066Sahrens extern void zio_vdev_io_reissue(zio_t *zio);
523fa9e4066Sahrens extern void zio_vdev_io_redone(zio_t *zio);
524fa9e4066Sahrens 
525fa9e4066Sahrens extern void zio_checksum_verified(zio_t *zio);
526e14bb325SJeff Bonwick extern int zio_worst_error(int e1, int e2);
527fa9e4066Sahrens 
528b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
529b24ab676SJeff Bonwick     enum zio_checksum parent);
530b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
531b24ab676SJeff Bonwick     enum zio_checksum child, enum zio_checksum parent);
532b24ab676SJeff Bonwick extern enum zio_compress zio_compress_select(enum zio_compress child,
533b24ab676SJeff Bonwick     enum zio_compress parent);
534fa9e4066Sahrens 
535e14bb325SJeff Bonwick extern void zio_suspend(spa_t *spa, zio_t *zio);
53654d692b7SGeorge Wilson extern int zio_resume(spa_t *spa);
537e14bb325SJeff Bonwick extern void zio_resume_wait(spa_t *spa);
538ea8dc4b6Seschrock 
539fa9e4066Sahrens /*
540fa9e4066Sahrens  * Initial setup and teardown.
541fa9e4066Sahrens  */
542fa9e4066Sahrens extern void zio_init(void);
543fa9e4066Sahrens extern void zio_fini(void);
544fa9e4066Sahrens 
545ea8dc4b6Seschrock /*
546ea8dc4b6Seschrock  * Fault injection
547ea8dc4b6Seschrock  */
548ea8dc4b6Seschrock struct zinject_record;
549ea8dc4b6Seschrock extern uint32_t zio_injection_enabled;
550ea8dc4b6Seschrock extern int zio_inject_fault(char *name, int flags, int *id,
551ea8dc4b6Seschrock     struct zinject_record *record);
552ea8dc4b6Seschrock extern int zio_inject_list_next(int *id, char *name, size_t buflen,
553ea8dc4b6Seschrock     struct zinject_record *record);
554ea8dc4b6Seschrock extern int zio_clear_fault(int id);
5551195e687SMark J Musante extern void zio_handle_panic_injection(spa_t *spa, char *tag, uint64_t type);
556ea8dc4b6Seschrock extern int zio_handle_fault_injection(zio_t *zio, int error);
5578956713aSEric Schrock extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
55821bf64a7Sgw extern int zio_handle_label_injection(zio_t *zio, int error);
559468c413aSTim Haley extern void zio_handle_ignored_writes(zio_t *zio);
560283b8460SGeorge.Wilson extern uint64_t zio_handle_io_delay(zio_t *zio);
561ea8dc4b6Seschrock 
56222fe2c88SJonathan Adams /*
56322fe2c88SJonathan Adams  * Checksum ereport functions
56422fe2c88SJonathan Adams  */
56522fe2c88SJonathan Adams extern void zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd, struct zio *zio,
56622fe2c88SJonathan Adams     uint64_t offset, uint64_t length, void *arg, struct zio_bad_cksum *info);
56722fe2c88SJonathan Adams extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
56822fe2c88SJonathan Adams     const void *good_data, const void *bad_data, boolean_t drop_if_identical);
56922fe2c88SJonathan Adams 
57022fe2c88SJonathan Adams extern void zfs_ereport_send_interim_checksum(zio_cksum_report_t *report);
57122fe2c88SJonathan Adams extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
57222fe2c88SJonathan Adams 
57322fe2c88SJonathan Adams /* If we have the good data in hand, this function can be used */
57422fe2c88SJonathan Adams extern void zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
57522fe2c88SJonathan Adams     struct zio *zio, uint64_t offset, uint64_t length,
57622fe2c88SJonathan Adams     const void *good_data, const void *bad_data, struct zio_bad_cksum *info);
57722fe2c88SJonathan Adams 
578468c413aSTim Haley /* Called from spa_sync(), but primarily an injection handler */
579468c413aSTim Haley extern void spa_handle_ignored_writes(spa_t *spa);
580468c413aSTim Haley 
581ad135b5dSChristopher Siden /* zbookmark functions */
582ad135b5dSChristopher Siden boolean_t zbookmark_is_before(const struct dnode_phys *dnp,
583ad135b5dSChristopher Siden     const zbookmark_t *zb1, const zbookmark_t *zb2);
584ad135b5dSChristopher Siden 
585fa9e4066Sahrens #ifdef	__cplusplus
586fa9e4066Sahrens }
587fa9e4066Sahrens #endif
588fa9e4066Sahrens 
589fa9e4066Sahrens #endif	/* _ZIO_H */
590