xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zio.h (revision 0f7643c7376dd69a08acbfc9d1d7d548b10c846a)
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.
258df0bcf0SPaul Dagnelie  * Copyright (c) 2012, 2016 by Delphix. All rights reserved.
26a6f561b4SSašo Kiselkov  * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
27810e43b2SBill Pijewski  * Copyright (c) 2013, Joyent, Inc. All rights reserved.
285aeb9474SGarrett D'Amore  */
29fa9e4066Sahrens 
30fa9e4066Sahrens #ifndef _ZIO_H
31fa9e4066Sahrens #define	_ZIO_H
32fa9e4066Sahrens 
33a2cdcdd2SPaul Dagnelie #include <sys/zio_priority.h>
34fa9e4066Sahrens #include <sys/zfs_context.h>
35fa9e4066Sahrens #include <sys/spa.h>
36fa9e4066Sahrens #include <sys/txg.h>
37fa9e4066Sahrens #include <sys/avl.h>
38fa9e4066Sahrens #include <sys/fs/zfs.h>
3944cd46caSbillm #include <sys/zio_impl.h>
40fa9e4066Sahrens 
41fa9e4066Sahrens #ifdef	__cplusplus
42fa9e4066Sahrens extern "C" {
43fa9e4066Sahrens #endif
44fa9e4066Sahrens 
456e1f5caaSNeil Perrin /*
466e1f5caaSNeil Perrin  * Embedded checksum
476e1f5caaSNeil Perrin  */
486e1f5caaSNeil Perrin #define	ZEC_MAGIC	0x210da7ab10c7a11ULL
49fa9e4066Sahrens 
506e1f5caaSNeil Perrin typedef struct zio_eck {
516e1f5caaSNeil Perrin 	uint64_t	zec_magic;	/* for validation, endianness	*/
526e1f5caaSNeil Perrin 	zio_cksum_t	zec_cksum;	/* 256-bit checksum		*/
536e1f5caaSNeil Perrin } zio_eck_t;
54fa9e4066Sahrens 
55fa9e4066Sahrens /*
56fa9e4066Sahrens  * Gang block headers are self-checksumming and contain an array
57fa9e4066Sahrens  * of block pointers.
58fa9e4066Sahrens  */
59fa9e4066Sahrens #define	SPA_GANGBLOCKSIZE	SPA_MINBLOCKSIZE
60fa9e4066Sahrens #define	SPA_GBH_NBLKPTRS	((SPA_GANGBLOCKSIZE - \
616e1f5caaSNeil Perrin 	sizeof (zio_eck_t)) / sizeof (blkptr_t))
62fa9e4066Sahrens #define	SPA_GBH_FILLER		((SPA_GANGBLOCKSIZE - \
636e1f5caaSNeil Perrin 	sizeof (zio_eck_t) - \
64fa9e4066Sahrens 	(SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
65fa9e4066Sahrens 	sizeof (uint64_t))
66fa9e4066Sahrens 
67fa9e4066Sahrens typedef struct zio_gbh {
68fa9e4066Sahrens 	blkptr_t		zg_blkptr[SPA_GBH_NBLKPTRS];
69fa9e4066Sahrens 	uint64_t		zg_filler[SPA_GBH_FILLER];
706e1f5caaSNeil Perrin 	zio_eck_t		zg_tail;
71fa9e4066Sahrens } zio_gbh_phys_t;
72fa9e4066Sahrens 
73fa9e4066Sahrens enum zio_checksum {
74fa9e4066Sahrens 	ZIO_CHECKSUM_INHERIT = 0,
75fa9e4066Sahrens 	ZIO_CHECKSUM_ON,
76fa9e4066Sahrens 	ZIO_CHECKSUM_OFF,
77fa9e4066Sahrens 	ZIO_CHECKSUM_LABEL,
78fa9e4066Sahrens 	ZIO_CHECKSUM_GANG_HEADER,
79fa9e4066Sahrens 	ZIO_CHECKSUM_ZILOG,
80fa9e4066Sahrens 	ZIO_CHECKSUM_FLETCHER_2,
81fa9e4066Sahrens 	ZIO_CHECKSUM_FLETCHER_4,
82fa9e4066Sahrens 	ZIO_CHECKSUM_SHA256,
836e1f5caaSNeil Perrin 	ZIO_CHECKSUM_ZILOG2,
84810e43b2SBill Pijewski 	ZIO_CHECKSUM_NOPARITY,
8545818ee1SMatthew Ahrens 	ZIO_CHECKSUM_SHA512,
8645818ee1SMatthew Ahrens 	ZIO_CHECKSUM_SKEIN,
8745818ee1SMatthew Ahrens 	ZIO_CHECKSUM_EDONR,
88fa9e4066Sahrens 	ZIO_CHECKSUM_FUNCTIONS
89fa9e4066Sahrens };
90fa9e4066Sahrens 
915d7b4d43SMatthew Ahrens /*
925d7b4d43SMatthew Ahrens  * The number of "legacy" compression functions which can be set on individual
935d7b4d43SMatthew Ahrens  * objects.
945d7b4d43SMatthew Ahrens  */
955d7b4d43SMatthew Ahrens #define	ZIO_CHECKSUM_LEGACY_FUNCTIONS ZIO_CHECKSUM_ZILOG2
965d7b4d43SMatthew Ahrens 
977e322df5SJonathan Adams #define	ZIO_CHECKSUM_ON_VALUE	ZIO_CHECKSUM_FLETCHER_4
98fa9e4066Sahrens #define	ZIO_CHECKSUM_DEFAULT	ZIO_CHECKSUM_ON
99fa9e4066Sahrens 
100b24ab676SJeff Bonwick #define	ZIO_CHECKSUM_MASK	0xffULL
101b24ab676SJeff Bonwick #define	ZIO_CHECKSUM_VERIFY	(1 << 8)
102b24ab676SJeff Bonwick 
103b24ab676SJeff Bonwick #define	ZIO_DEDUPCHECKSUM	ZIO_CHECKSUM_SHA256
104b24ab676SJeff Bonwick #define	ZIO_DEDUPDITTO_MIN	100
105b24ab676SJeff Bonwick 
106fa9e4066Sahrens enum zio_compress {
107fa9e4066Sahrens 	ZIO_COMPRESS_INHERIT = 0,
108fa9e4066Sahrens 	ZIO_COMPRESS_ON,
109fa9e4066Sahrens 	ZIO_COMPRESS_OFF,
110fa9e4066Sahrens 	ZIO_COMPRESS_LZJB,
111416e0cd8Sek 	ZIO_COMPRESS_EMPTY,
112c9431fa1Sahl 	ZIO_COMPRESS_GZIP_1,
113c9431fa1Sahl 	ZIO_COMPRESS_GZIP_2,
114c9431fa1Sahl 	ZIO_COMPRESS_GZIP_3,
115c9431fa1Sahl 	ZIO_COMPRESS_GZIP_4,
116c9431fa1Sahl 	ZIO_COMPRESS_GZIP_5,
117c9431fa1Sahl 	ZIO_COMPRESS_GZIP_6,
118c9431fa1Sahl 	ZIO_COMPRESS_GZIP_7,
119c9431fa1Sahl 	ZIO_COMPRESS_GZIP_8,
120c9431fa1Sahl 	ZIO_COMPRESS_GZIP_9,
121b24ab676SJeff Bonwick 	ZIO_COMPRESS_ZLE,
122a6f561b4SSašo Kiselkov 	ZIO_COMPRESS_LZ4,
123fa9e4066Sahrens 	ZIO_COMPRESS_FUNCTIONS
124fa9e4066Sahrens };
125fa9e4066Sahrens 
1265d7b4d43SMatthew Ahrens /*
1275d7b4d43SMatthew Ahrens  * The number of "legacy" compression functions which can be set on individual
1285d7b4d43SMatthew Ahrens  * objects.
1295d7b4d43SMatthew Ahrens  */
1305d7b4d43SMatthew Ahrens #define	ZIO_COMPRESS_LEGACY_FUNCTIONS ZIO_COMPRESS_LZ4
1315d7b4d43SMatthew Ahrens 
132db1741f5SJustin T. Gibbs /*
133db1741f5SJustin T. Gibbs  * The meaning of "compress = on" selected by the compression features enabled
134db1741f5SJustin T. Gibbs  * on a given pool.
135db1741f5SJustin T. Gibbs  */
136db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_LEGACY_ON_VALUE	ZIO_COMPRESS_LZJB
137db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_LZ4_ON_VALUE	ZIO_COMPRESS_LZ4
138db1741f5SJustin T. Gibbs 
139db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_DEFAULT		ZIO_COMPRESS_OFF
140fa9e4066Sahrens 
141b24ab676SJeff Bonwick #define	BOOTFS_COMPRESS_VALID(compress)			\
142b24ab676SJeff Bonwick 	((compress) == ZIO_COMPRESS_LZJB ||		\
143a6f561b4SSašo Kiselkov 	(compress) == ZIO_COMPRESS_LZ4 ||		\
144db1741f5SJustin T. Gibbs 	(compress) == ZIO_COMPRESS_ON ||		\
145b24ab676SJeff Bonwick 	(compress) == ZIO_COMPRESS_OFF)
146b24ab676SJeff Bonwick 
1470a4e9518Sgw #define	ZIO_FAILURE_MODE_WAIT		0
1480a4e9518Sgw #define	ZIO_FAILURE_MODE_CONTINUE	1
1490a4e9518Sgw #define	ZIO_FAILURE_MODE_PANIC		2
1500a4e9518Sgw 
151b24ab676SJeff Bonwick enum zio_flag {
152b24ab676SJeff Bonwick 	/*
153b24ab676SJeff Bonwick 	 * Flags inherited by gang, ddt, and vdev children,
154b24ab676SJeff Bonwick 	 * and that must be equal for two zios to aggregate
155b24ab676SJeff Bonwick 	 */
156b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_AGGREGATE	= 1 << 0,
157b24ab676SJeff Bonwick 	ZIO_FLAG_IO_REPAIR	= 1 << 1,
158b24ab676SJeff Bonwick 	ZIO_FLAG_SELF_HEAL	= 1 << 2,
159b24ab676SJeff Bonwick 	ZIO_FLAG_RESILVER	= 1 << 3,
160b24ab676SJeff Bonwick 	ZIO_FLAG_SCRUB		= 1 << 4,
16144ecc532SGeorge Wilson 	ZIO_FLAG_SCAN_THREAD	= 1 << 5,
1622a104a52SAlex Reece 	ZIO_FLAG_PHYSICAL	= 1 << 6,
163b24ab676SJeff Bonwick 
164b24ab676SJeff Bonwick #define	ZIO_FLAG_AGG_INHERIT	(ZIO_FLAG_CANFAIL - 1)
165b24ab676SJeff Bonwick 
166b24ab676SJeff Bonwick 	/*
167b24ab676SJeff Bonwick 	 * Flags inherited by ddt, gang, and vdev children.
168b24ab676SJeff Bonwick 	 */
1692a104a52SAlex Reece 	ZIO_FLAG_CANFAIL	= 1 << 7,	/* must be first for INHERIT */
1702a104a52SAlex Reece 	ZIO_FLAG_SPECULATIVE	= 1 << 8,
1712a104a52SAlex Reece 	ZIO_FLAG_CONFIG_WRITER	= 1 << 9,
1722a104a52SAlex Reece 	ZIO_FLAG_DONT_RETRY	= 1 << 10,
1732a104a52SAlex Reece 	ZIO_FLAG_DONT_CACHE	= 1 << 11,
1742a104a52SAlex Reece 	ZIO_FLAG_NODATA		= 1 << 12,
1752a104a52SAlex Reece 	ZIO_FLAG_INDUCE_DAMAGE	= 1 << 13,
176*0f7643c7SGeorge Wilson 	ZIO_FLAG_IO_ALLOCATING	= 1 << 14,
177b24ab676SJeff Bonwick 
178b24ab676SJeff Bonwick #define	ZIO_FLAG_DDT_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
179b24ab676SJeff Bonwick #define	ZIO_FLAG_GANG_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
180b24ab676SJeff Bonwick 
181b24ab676SJeff Bonwick 	/*
182b24ab676SJeff Bonwick 	 * Flags inherited by vdev children.
183b24ab676SJeff Bonwick 	 */
184*0f7643c7SGeorge Wilson 	ZIO_FLAG_IO_RETRY	= 1 << 15,	/* must be first for INHERIT */
185*0f7643c7SGeorge Wilson 	ZIO_FLAG_PROBE		= 1 << 16,
186*0f7643c7SGeorge Wilson 	ZIO_FLAG_TRYHARD	= 1 << 17,
187*0f7643c7SGeorge Wilson 	ZIO_FLAG_OPTIONAL	= 1 << 18,
188b24ab676SJeff Bonwick 
189b24ab676SJeff Bonwick #define	ZIO_FLAG_VDEV_INHERIT	(ZIO_FLAG_DONT_QUEUE - 1)
190b24ab676SJeff Bonwick 
191b24ab676SJeff Bonwick 	/*
192b24ab676SJeff Bonwick 	 * Flags not inherited by any children.
193b24ab676SJeff Bonwick 	 */
194*0f7643c7SGeorge Wilson 	ZIO_FLAG_DONT_QUEUE	= 1 << 19,	/* must be first for INHERIT */
195*0f7643c7SGeorge Wilson 	ZIO_FLAG_DONT_PROPAGATE	= 1 << 20,
196*0f7643c7SGeorge Wilson 	ZIO_FLAG_IO_BYPASS	= 1 << 21,
197*0f7643c7SGeorge Wilson 	ZIO_FLAG_IO_REWRITE	= 1 << 22,
198*0f7643c7SGeorge Wilson 	ZIO_FLAG_RAW		= 1 << 23,
199*0f7643c7SGeorge Wilson 	ZIO_FLAG_GANG_CHILD	= 1 << 24,
200*0f7643c7SGeorge Wilson 	ZIO_FLAG_DDT_CHILD	= 1 << 25,
201*0f7643c7SGeorge Wilson 	ZIO_FLAG_GODFATHER	= 1 << 26,
202*0f7643c7SGeorge Wilson 	ZIO_FLAG_NOPWRITE	= 1 << 27,
203*0f7643c7SGeorge Wilson 	ZIO_FLAG_REEXECUTED	= 1 << 28,
204*0f7643c7SGeorge Wilson 	ZIO_FLAG_DELEGATED	= 1 << 29,
205b24ab676SJeff Bonwick };
206b24ab676SJeff Bonwick 
207b24ab676SJeff Bonwick #define	ZIO_FLAG_MUSTSUCCEED		0
208b24ab676SJeff Bonwick 
209b24ab676SJeff Bonwick #define	ZIO_DDT_CHILD_FLAGS(zio)				\
210b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) |		\
211b24ab676SJeff Bonwick 	ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
212b24ab676SJeff Bonwick 
213e14bb325SJeff Bonwick #define	ZIO_GANG_CHILD_FLAGS(zio)				\
214e14bb325SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) |		\
215e14bb325SJeff Bonwick 	ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
216e14bb325SJeff Bonwick 
217b24ab676SJeff Bonwick #define	ZIO_VDEV_CHILD_FLAGS(zio)				\
218b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) |		\
219b24ab676SJeff Bonwick 	ZIO_FLAG_CANFAIL)
220b24ab676SJeff Bonwick 
221e14bb325SJeff Bonwick enum zio_child {
222e14bb325SJeff Bonwick 	ZIO_CHILD_VDEV = 0,
223e14bb325SJeff Bonwick 	ZIO_CHILD_GANG,
224b24ab676SJeff Bonwick 	ZIO_CHILD_DDT,
225e14bb325SJeff Bonwick 	ZIO_CHILD_LOGICAL,
226e14bb325SJeff Bonwick 	ZIO_CHILD_TYPES
227e14bb325SJeff Bonwick };
228e14bb325SJeff Bonwick 
229e14bb325SJeff Bonwick enum zio_wait_type {
230e14bb325SJeff Bonwick 	ZIO_WAIT_READY = 0,
231e14bb325SJeff Bonwick 	ZIO_WAIT_DONE,
232e14bb325SJeff Bonwick 	ZIO_WAIT_TYPES
233e14bb325SJeff Bonwick };
234e14bb325SJeff Bonwick 
235fa9e4066Sahrens /*
236e7cbe64fSgw  * We'll take the unused errnos, 'EBADE' and 'EBADR' (from the Convergent
237e7cbe64fSgw  * graveyard) to indicate checksum errors and fragmentation.
238fa9e4066Sahrens  */
239fa9e4066Sahrens #define	ECKSUM	EBADE
240e7cbe64fSgw #define	EFRAGS	EBADR
241fa9e4066Sahrens 
242fa9e4066Sahrens typedef void zio_done_func_t(zio_t *zio);
243fa9e4066Sahrens 
244*0f7643c7SGeorge Wilson extern boolean_t zio_dva_throttle_enabled;
24569962b56SMatthew Ahrens extern const char *zio_type_name[ZIO_TYPES];
246fa9e4066Sahrens 
247ea8dc4b6Seschrock /*
248ea8dc4b6Seschrock  * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
249ea8dc4b6Seschrock  * identifies any block in the pool.  By convention, the meta-objset (MOS)
250b24ab676SJeff Bonwick  * is objset 0, and the meta-dnode is object 0.  This covers all blocks
251b24ab676SJeff Bonwick  * except root blocks and ZIL blocks, which are defined as follows:
252ea8dc4b6Seschrock  *
253b24ab676SJeff Bonwick  * Root blocks (objset_phys_t) are object 0, level -1:  <objset, 0, -1, 0>.
254b24ab676SJeff Bonwick  * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
255b24ab676SJeff Bonwick  * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
256a2cdcdd2SPaul Dagnelie  * dnode visit bookmarks are <objset, object id of dnode, -3, 0>.
257ea8dc4b6Seschrock  *
258b24ab676SJeff Bonwick  * Note: this structure is called a bookmark because its original purpose
259b24ab676SJeff Bonwick  * was to remember where to resume a pool-wide traverse.
260ea8dc4b6Seschrock  *
2617802d7bfSMatthew Ahrens  * Note: this structure is passed between userland and the kernel, and is
2627802d7bfSMatthew Ahrens  * stored on disk (by virtue of being incorporated into other on-disk
2637802d7bfSMatthew Ahrens  * structures, e.g. dsl_scan_phys_t).
264ea8dc4b6Seschrock  */
2657802d7bfSMatthew Ahrens typedef struct zbookmark_phys {
266ea8dc4b6Seschrock 	uint64_t	zb_objset;
267ea8dc4b6Seschrock 	uint64_t	zb_object;
268ea8dc4b6Seschrock 	int64_t		zb_level;
269ea8dc4b6Seschrock 	uint64_t	zb_blkid;
2707802d7bfSMatthew Ahrens } zbookmark_phys_t;
271ea8dc4b6Seschrock 
272b24ab676SJeff Bonwick #define	SET_BOOKMARK(zb, objset, object, level, blkid)  \
273b24ab676SJeff Bonwick {                                                       \
274b24ab676SJeff Bonwick 	(zb)->zb_objset = objset;                       \
275b24ab676SJeff Bonwick 	(zb)->zb_object = object;                       \
276b24ab676SJeff Bonwick 	(zb)->zb_level = level;                         \
277b24ab676SJeff Bonwick 	(zb)->zb_blkid = blkid;                         \
278b24ab676SJeff Bonwick }
279b24ab676SJeff Bonwick 
280b24ab676SJeff Bonwick #define	ZB_DESTROYED_OBJSET	(-1ULL)
281b24ab676SJeff Bonwick 
282b24ab676SJeff Bonwick #define	ZB_ROOT_OBJECT		(0ULL)
283b24ab676SJeff Bonwick #define	ZB_ROOT_LEVEL		(-1LL)
284b24ab676SJeff Bonwick #define	ZB_ROOT_BLKID		(0ULL)
285b24ab676SJeff Bonwick 
286b24ab676SJeff Bonwick #define	ZB_ZIL_OBJECT		(0ULL)
287b24ab676SJeff Bonwick #define	ZB_ZIL_LEVEL		(-2LL)
288b24ab676SJeff Bonwick 
289a2cdcdd2SPaul Dagnelie #define	ZB_DNODE_LEVEL		(-3LL)
290a2cdcdd2SPaul Dagnelie #define	ZB_DNODE_BLKID		(0ULL)
291a2cdcdd2SPaul Dagnelie 
292ad135b5dSChristopher Siden #define	ZB_IS_ZERO(zb)						\
293ad135b5dSChristopher Siden 	((zb)->zb_objset == 0 && (zb)->zb_object == 0 &&	\
294ad135b5dSChristopher Siden 	(zb)->zb_level == 0 && (zb)->zb_blkid == 0)
295ad135b5dSChristopher Siden #define	ZB_IS_ROOT(zb)				\
296ad135b5dSChristopher Siden 	((zb)->zb_object == ZB_ROOT_OBJECT &&	\
297ad135b5dSChristopher Siden 	(zb)->zb_level == ZB_ROOT_LEVEL &&	\
298ad135b5dSChristopher Siden 	(zb)->zb_blkid == ZB_ROOT_BLKID)
299ad135b5dSChristopher Siden 
300e14bb325SJeff Bonwick typedef struct zio_prop {
301e14bb325SJeff Bonwick 	enum zio_checksum	zp_checksum;
302e14bb325SJeff Bonwick 	enum zio_compress	zp_compress;
303e14bb325SJeff Bonwick 	dmu_object_type_t	zp_type;
304e14bb325SJeff Bonwick 	uint8_t			zp_level;
305b24ab676SJeff Bonwick 	uint8_t			zp_copies;
30680901aeaSGeorge Wilson 	boolean_t		zp_dedup;
30780901aeaSGeorge Wilson 	boolean_t		zp_dedup_verify;
30880901aeaSGeorge Wilson 	boolean_t		zp_nopwrite;
309e14bb325SJeff Bonwick } zio_prop_t;
310e14bb325SJeff Bonwick 
31122fe2c88SJonathan Adams typedef struct zio_cksum_report zio_cksum_report_t;
31222fe2c88SJonathan Adams 
31322fe2c88SJonathan Adams typedef void zio_cksum_finish_f(zio_cksum_report_t *rep,
31422fe2c88SJonathan Adams     const void *good_data);
31522fe2c88SJonathan Adams typedef void zio_cksum_free_f(void *cbdata, size_t size);
31622fe2c88SJonathan Adams 
31722fe2c88SJonathan Adams struct zio_bad_cksum;				/* defined in zio_checksum.h */
318ad135b5dSChristopher Siden struct dnode_phys;
31922fe2c88SJonathan Adams 
32022fe2c88SJonathan Adams struct zio_cksum_report {
32122fe2c88SJonathan Adams 	struct zio_cksum_report *zcr_next;
32222fe2c88SJonathan Adams 	nvlist_t		*zcr_ereport;
32322fe2c88SJonathan Adams 	nvlist_t		*zcr_detector;
32422fe2c88SJonathan Adams 	void			*zcr_cbdata;
32522fe2c88SJonathan Adams 	size_t			zcr_cbinfo;	/* passed to zcr_free() */
326b24ab676SJeff Bonwick 	uint64_t		zcr_align;
32722fe2c88SJonathan Adams 	uint64_t		zcr_length;
32822fe2c88SJonathan Adams 	zio_cksum_finish_f	*zcr_finish;
32922fe2c88SJonathan Adams 	zio_cksum_free_f	*zcr_free;
33022fe2c88SJonathan Adams 
33122fe2c88SJonathan Adams 	/* internal use only */
33222fe2c88SJonathan Adams 	struct zio_bad_cksum	*zcr_ckinfo;	/* information from failure */
33322fe2c88SJonathan Adams };
33422fe2c88SJonathan Adams 
33522fe2c88SJonathan Adams typedef void zio_vsd_cksum_report_f(zio_t *zio, zio_cksum_report_t *zcr,
33622fe2c88SJonathan Adams     void *arg);
33722fe2c88SJonathan Adams 
33822fe2c88SJonathan Adams zio_vsd_cksum_report_f	zio_vsd_default_cksum_report;
33922fe2c88SJonathan Adams 
34022fe2c88SJonathan Adams typedef struct zio_vsd_ops {
34122fe2c88SJonathan Adams 	zio_done_func_t		*vsd_free;
34222fe2c88SJonathan Adams 	zio_vsd_cksum_report_f	*vsd_cksum_report;
34322fe2c88SJonathan Adams } zio_vsd_ops_t;
34422fe2c88SJonathan Adams 
345e14bb325SJeff Bonwick typedef struct zio_gang_node {
346e14bb325SJeff Bonwick 	zio_gbh_phys_t		*gn_gbh;
347e14bb325SJeff Bonwick 	struct zio_gang_node	*gn_child[SPA_GBH_NBLKPTRS];
348e14bb325SJeff Bonwick } zio_gang_node_t;
349e14bb325SJeff Bonwick 
350e14bb325SJeff Bonwick typedef zio_t *zio_gang_issue_func_t(zio_t *zio, blkptr_t *bp,
351e14bb325SJeff Bonwick     zio_gang_node_t *gn, void *data);
352e14bb325SJeff Bonwick 
353e14bb325SJeff Bonwick typedef void zio_transform_func_t(zio_t *zio, void *data, uint64_t size);
354e14bb325SJeff Bonwick 
355e14bb325SJeff Bonwick typedef struct zio_transform {
356e14bb325SJeff Bonwick 	void			*zt_orig_data;
357e14bb325SJeff Bonwick 	uint64_t		zt_orig_size;
358e14bb325SJeff Bonwick 	uint64_t		zt_bufsize;
359e14bb325SJeff Bonwick 	zio_transform_func_t	*zt_transform;
360e14bb325SJeff Bonwick 	struct zio_transform	*zt_next;
361e14bb325SJeff Bonwick } zio_transform_t;
362e14bb325SJeff Bonwick 
363e14bb325SJeff Bonwick typedef int zio_pipe_stage_t(zio_t *zio);
364e14bb325SJeff Bonwick 
365e14bb325SJeff Bonwick /*
366e14bb325SJeff Bonwick  * The io_reexecute flags are distinct from io_flags because the child must
367e14bb325SJeff Bonwick  * be able to propagate them to the parent.  The normal io_flags are local
368e14bb325SJeff Bonwick  * to the zio, not protected by any lock, and not modifiable by children;
369e14bb325SJeff Bonwick  * the reexecute flags are protected by io_lock, modifiable by children,
370e14bb325SJeff Bonwick  * and always propagated -- even when ZIO_FLAG_DONT_PROPAGATE is set.
371e14bb325SJeff Bonwick  */
372e14bb325SJeff Bonwick #define	ZIO_REEXECUTE_NOW	0x01
373e14bb325SJeff Bonwick #define	ZIO_REEXECUTE_SUSPEND	0x02
374e14bb325SJeff Bonwick 
375a3f829aeSBill Moore typedef struct zio_link {
376a3f829aeSBill Moore 	zio_t		*zl_parent;
377a3f829aeSBill Moore 	zio_t		*zl_child;
378a3f829aeSBill Moore 	list_node_t	zl_parent_node;
379a3f829aeSBill Moore 	list_node_t	zl_child_node;
380a3f829aeSBill Moore } zio_link_t;
381a3f829aeSBill Moore 
382fa9e4066Sahrens struct zio {
383fa9e4066Sahrens 	/* Core information about this I/O */
3847802d7bfSMatthew Ahrens 	zbookmark_phys_t	io_bookmark;
385e14bb325SJeff Bonwick 	zio_prop_t	io_prop;
386e14bb325SJeff Bonwick 	zio_type_t	io_type;
387e14bb325SJeff Bonwick 	enum zio_child	io_child_type;
388e14bb325SJeff Bonwick 	int		io_cmd;
38969962b56SMatthew Ahrens 	zio_priority_t	io_priority;
390e14bb325SJeff Bonwick 	uint8_t		io_reexecute;
391a3f829aeSBill Moore 	uint8_t		io_state[ZIO_WAIT_TYPES];
392fa9e4066Sahrens 	uint64_t	io_txg;
393e14bb325SJeff Bonwick 	spa_t		*io_spa;
394fa9e4066Sahrens 	blkptr_t	*io_bp;
395b24ab676SJeff Bonwick 	blkptr_t	*io_bp_override;
396fa9e4066Sahrens 	blkptr_t	io_bp_copy;
397a3f829aeSBill Moore 	list_t		io_parent_list;
398a3f829aeSBill Moore 	list_t		io_child_list;
399ea8dc4b6Seschrock 	zio_t		*io_logical;
400e14bb325SJeff Bonwick 	zio_transform_t *io_transform_stack;
401fa9e4066Sahrens 
402fa9e4066Sahrens 	/* Callback info */
403c717a561Smaybee 	zio_done_func_t	*io_ready;
4048df0bcf0SPaul Dagnelie 	zio_done_func_t	*io_children_ready;
40569962b56SMatthew Ahrens 	zio_done_func_t	*io_physdone;
406fa9e4066Sahrens 	zio_done_func_t	*io_done;
407fa9e4066Sahrens 	void		*io_private;
408b24ab676SJeff Bonwick 	int64_t		io_prev_space_delta;	/* DMU private */
409fa9e4066Sahrens 	blkptr_t	io_bp_orig;
410fa9e4066Sahrens 
411fa9e4066Sahrens 	/* Data represented by this I/O */
412fa9e4066Sahrens 	void		*io_data;
413b24ab676SJeff Bonwick 	void		*io_orig_data;
414fa9e4066Sahrens 	uint64_t	io_size;
415b24ab676SJeff Bonwick 	uint64_t	io_orig_size;
416fa9e4066Sahrens 
417fa9e4066Sahrens 	/* Stuff for the vdev stack */
418fa9e4066Sahrens 	vdev_t		*io_vd;
419fa9e4066Sahrens 	void		*io_vsd;
42022fe2c88SJonathan Adams 	const zio_vsd_ops_t *io_vsd_ops;
42122fe2c88SJonathan Adams 
422fa9e4066Sahrens 	uint64_t	io_offset;
423c55e05cbSMatthew Ahrens 	hrtime_t	io_timestamp;
424*0f7643c7SGeorge Wilson 	hrtime_t	io_queued_timestamp;
42597e81309SPrakash Surya 	hrtime_t	io_target_timestamp;
42669962b56SMatthew Ahrens 	avl_node_t	io_queue_node;
427fe319232SJustin T. Gibbs 	avl_node_t	io_offset_node;
428*0f7643c7SGeorge Wilson 	avl_node_t	io_alloc_node;
429fa9e4066Sahrens 
430fa9e4066Sahrens 	/* Internal pipeline state */
431b24ab676SJeff Bonwick 	enum zio_flag	io_flags;
432b24ab676SJeff Bonwick 	enum zio_stage	io_stage;
433b24ab676SJeff Bonwick 	enum zio_stage	io_pipeline;
434b24ab676SJeff Bonwick 	enum zio_flag	io_orig_flags;
435b24ab676SJeff Bonwick 	enum zio_stage	io_orig_stage;
436b24ab676SJeff Bonwick 	enum zio_stage	io_orig_pipeline;
437*0f7643c7SGeorge Wilson 	enum zio_stage	io_pipeline_trace;
438e14bb325SJeff Bonwick 	int		io_error;
439e14bb325SJeff Bonwick 	int		io_child_error[ZIO_CHILD_TYPES];
440e14bb325SJeff Bonwick 	uint64_t	io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
441b24ab676SJeff Bonwick 	uint64_t	io_child_count;
44269962b56SMatthew Ahrens 	uint64_t	io_phys_children;
443b24ab676SJeff Bonwick 	uint64_t	io_parent_count;
444e14bb325SJeff Bonwick 	uint64_t	*io_stall;
445f5383399SBill Moore 	zio_t		*io_gang_leader;
446e14bb325SJeff Bonwick 	zio_gang_node_t	*io_gang_tree;
447e14bb325SJeff Bonwick 	void		*io_executor;
448fa9e4066Sahrens 	void		*io_waiter;
449fa9e4066Sahrens 	kmutex_t	io_lock;
450fa9e4066Sahrens 	kcondvar_t	io_cv;
451ea8dc4b6Seschrock 
452ea8dc4b6Seschrock 	/* FMA state */
45322fe2c88SJonathan Adams 	zio_cksum_report_t *io_cksum_report;
454ea8dc4b6Seschrock 	uint64_t	io_ena;
4555aeb9474SGarrett D'Amore 
4565aeb9474SGarrett D'Amore 	/* Taskq dispatching state */
4575aeb9474SGarrett D'Amore 	taskq_ent_t	io_tqent;
458fa9e4066Sahrens };
459fa9e4066Sahrens 
460*0f7643c7SGeorge Wilson extern int zio_timestamp_compare(const void *, const void *);
461*0f7643c7SGeorge Wilson 
462a3f829aeSBill Moore extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
463b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
464fa9e4066Sahrens 
465fa9e4066Sahrens extern zio_t *zio_root(spa_t *spa,
466b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
467fa9e4066Sahrens 
468088f3894Sahrens extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, void *data,
469fa9e4066Sahrens     uint64_t size, zio_done_func_t *done, void *private,
4707802d7bfSMatthew Ahrens     zio_priority_t priority, enum zio_flag flags, const zbookmark_phys_t *zb);
471fa9e4066Sahrens 
472e14bb325SJeff Bonwick extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
473b24ab676SJeff Bonwick     void *data, uint64_t size, const zio_prop_t *zp,
4748df0bcf0SPaul Dagnelie     zio_done_func_t *ready, zio_done_func_t *children_ready,
4758df0bcf0SPaul Dagnelie     zio_done_func_t *physdone, zio_done_func_t *done,
4768df0bcf0SPaul Dagnelie     void *private, zio_priority_t priority, enum zio_flag flags,
4778df0bcf0SPaul Dagnelie     const zbookmark_phys_t *zb);
478fa9e4066Sahrens 
479e14bb325SJeff Bonwick extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
480e14bb325SJeff Bonwick     void *data, uint64_t size, zio_done_func_t *done, void *private,
4817802d7bfSMatthew Ahrens     zio_priority_t priority, enum zio_flag flags, zbookmark_phys_t *zb);
482fa9e4066Sahrens 
48380901aeaSGeorge Wilson extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
48480901aeaSGeorge Wilson     boolean_t nopwrite);
48582c9918fSTim Haley 
486b24ab676SJeff Bonwick extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
487fa9e4066Sahrens 
488b24ab676SJeff Bonwick extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
489b24ab676SJeff Bonwick     const blkptr_t *bp,
490b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
491fa9e4066Sahrens 
492fa9e4066Sahrens extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
49369962b56SMatthew Ahrens     zio_done_func_t *done, void *private, enum zio_flag flags);
494fa9e4066Sahrens 
495fa9e4066Sahrens extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
496fa9e4066Sahrens     uint64_t size, void *data, int checksum,
49769962b56SMatthew Ahrens     zio_done_func_t *done, void *private, zio_priority_t priority,
49869962b56SMatthew Ahrens     enum zio_flag flags, boolean_t labels);
499fa9e4066Sahrens 
500fa9e4066Sahrens extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
501fa9e4066Sahrens     uint64_t size, void *data, int checksum,
50269962b56SMatthew Ahrens     zio_done_func_t *done, void *private, zio_priority_t priority,
50369962b56SMatthew Ahrens     enum zio_flag flags, boolean_t labels);
504fa9e4066Sahrens 
505b24ab676SJeff Bonwick extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
506b24ab676SJeff Bonwick     const blkptr_t *bp, enum zio_flag flags);
507b24ab676SJeff Bonwick 
508b24ab676SJeff Bonwick extern int zio_alloc_zil(spa_t *spa, uint64_t txg, blkptr_t *new_bp,
509b24ab676SJeff Bonwick     blkptr_t *old_bp, uint64_t size, boolean_t use_slog);
510b24ab676SJeff Bonwick extern void zio_free_zil(spa_t *spa, uint64_t txg, blkptr_t *bp);
51117f17c2dSbonwick extern void zio_flush(zio_t *zio, vdev_t *vd);
5126e1f5caaSNeil Perrin extern void zio_shrink(zio_t *zio, uint64_t size);
513fa9e4066Sahrens 
514fa9e4066Sahrens extern int zio_wait(zio_t *zio);
515fa9e4066Sahrens extern void zio_nowait(zio_t *zio);
516e05725b1Sbonwick extern void zio_execute(zio_t *zio);
517e05725b1Sbonwick extern void zio_interrupt(zio_t *zio);
51897e81309SPrakash Surya extern void zio_delay_init(zio_t *zio);
51997e81309SPrakash Surya extern void zio_delay_interrupt(zio_t *zio);
520e05725b1Sbonwick 
521*0f7643c7SGeorge Wilson extern zio_t *zio_walk_parents(zio_t *cio, zio_link_t **);
522*0f7643c7SGeorge Wilson extern zio_t *zio_walk_children(zio_t *pio, zio_link_t **);
523a3f829aeSBill Moore extern zio_t *zio_unique_parent(zio_t *cio);
524a3f829aeSBill Moore extern void zio_add_child(zio_t *pio, zio_t *cio);
525a3f829aeSBill Moore 
526fa9e4066Sahrens extern void *zio_buf_alloc(size_t size);
527fa9e4066Sahrens extern void zio_buf_free(void *buf, size_t size);
528ad23a2dbSjohansen extern void *zio_data_buf_alloc(size_t size);
529ad23a2dbSjohansen extern void zio_data_buf_free(void *buf, size_t size);
530fa9e4066Sahrens 
531dcbf3bd6SGeorge Wilson extern void zio_push_transform(zio_t *zio, void *data, uint64_t size,
532dcbf3bd6SGeorge Wilson     uint64_t bufsize, zio_transform_func_t *transform);
533dcbf3bd6SGeorge Wilson extern void zio_pop_transforms(zio_t *zio);
534dcbf3bd6SGeorge Wilson 
5350a4e9518Sgw extern void zio_resubmit_stage_async(void *);
536fa9e4066Sahrens 
537fa9e4066Sahrens extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
53869962b56SMatthew Ahrens     uint64_t offset, void *data, uint64_t size, int type,
53969962b56SMatthew Ahrens     zio_priority_t priority, enum zio_flag flags,
54069962b56SMatthew Ahrens     zio_done_func_t *done, void *private);
541fa9e4066Sahrens 
542e14bb325SJeff Bonwick extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
54369962b56SMatthew Ahrens     void *data, uint64_t size, int type, zio_priority_t priority,
544b24ab676SJeff Bonwick     enum zio_flag flags, zio_done_func_t *done, void *private);
545e14bb325SJeff Bonwick 
546fa9e4066Sahrens extern void zio_vdev_io_bypass(zio_t *zio);
547fa9e4066Sahrens extern void zio_vdev_io_reissue(zio_t *zio);
548fa9e4066Sahrens extern void zio_vdev_io_redone(zio_t *zio);
549fa9e4066Sahrens 
550fa9e4066Sahrens extern void zio_checksum_verified(zio_t *zio);
551e14bb325SJeff Bonwick extern int zio_worst_error(int e1, int e2);
552fa9e4066Sahrens 
553b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
554b24ab676SJeff Bonwick     enum zio_checksum parent);
555b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
556b24ab676SJeff Bonwick     enum zio_checksum child, enum zio_checksum parent);
557db1741f5SJustin T. Gibbs extern enum zio_compress zio_compress_select(spa_t *spa,
558db1741f5SJustin T. Gibbs     enum zio_compress child, enum zio_compress parent);
559fa9e4066Sahrens 
560e14bb325SJeff Bonwick extern void zio_suspend(spa_t *spa, zio_t *zio);
56154d692b7SGeorge Wilson extern int zio_resume(spa_t *spa);
562e14bb325SJeff Bonwick extern void zio_resume_wait(spa_t *spa);
563ea8dc4b6Seschrock 
564fa9e4066Sahrens /*
565fa9e4066Sahrens  * Initial setup and teardown.
566fa9e4066Sahrens  */
567fa9e4066Sahrens extern void zio_init(void);
568fa9e4066Sahrens extern void zio_fini(void);
569fa9e4066Sahrens 
570ea8dc4b6Seschrock /*
571ea8dc4b6Seschrock  * Fault injection
572ea8dc4b6Seschrock  */
573ea8dc4b6Seschrock struct zinject_record;
574ea8dc4b6Seschrock extern uint32_t zio_injection_enabled;
575ea8dc4b6Seschrock extern int zio_inject_fault(char *name, int flags, int *id,
576ea8dc4b6Seschrock     struct zinject_record *record);
577ea8dc4b6Seschrock extern int zio_inject_list_next(int *id, char *name, size_t buflen,
578ea8dc4b6Seschrock     struct zinject_record *record);
579ea8dc4b6Seschrock extern int zio_clear_fault(int id);
5801195e687SMark J Musante extern void zio_handle_panic_injection(spa_t *spa, char *tag, uint64_t type);
581ea8dc4b6Seschrock extern int zio_handle_fault_injection(zio_t *zio, int error);
5828956713aSEric Schrock extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
58321bf64a7Sgw extern int zio_handle_label_injection(zio_t *zio, int error);
584468c413aSTim Haley extern void zio_handle_ignored_writes(zio_t *zio);
58597e81309SPrakash Surya extern hrtime_t zio_handle_io_delay(zio_t *zio);
586ea8dc4b6Seschrock 
58722fe2c88SJonathan Adams /*
58822fe2c88SJonathan Adams  * Checksum ereport functions
58922fe2c88SJonathan Adams  */
59022fe2c88SJonathan Adams extern void zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd, struct zio *zio,
59122fe2c88SJonathan Adams     uint64_t offset, uint64_t length, void *arg, struct zio_bad_cksum *info);
59222fe2c88SJonathan Adams extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
59322fe2c88SJonathan Adams     const void *good_data, const void *bad_data, boolean_t drop_if_identical);
59422fe2c88SJonathan Adams 
59522fe2c88SJonathan Adams extern void zfs_ereport_send_interim_checksum(zio_cksum_report_t *report);
59622fe2c88SJonathan Adams extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
59722fe2c88SJonathan Adams 
59822fe2c88SJonathan Adams /* If we have the good data in hand, this function can be used */
59922fe2c88SJonathan Adams extern void zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
60022fe2c88SJonathan Adams     struct zio *zio, uint64_t offset, uint64_t length,
60122fe2c88SJonathan Adams     const void *good_data, const void *bad_data, struct zio_bad_cksum *info);
60222fe2c88SJonathan Adams 
603468c413aSTim Haley /* Called from spa_sync(), but primarily an injection handler */
604468c413aSTim Haley extern void spa_handle_ignored_writes(spa_t *spa);
605468c413aSTim Haley 
6067802d7bfSMatthew Ahrens /* zbookmark_phys functions */
607a2cdcdd2SPaul Dagnelie boolean_t zbookmark_subtree_completed(const struct dnode_phys *dnp,
608a2cdcdd2SPaul Dagnelie     const zbookmark_phys_t *subtree_root, const zbookmark_phys_t *last_block);
609a2cdcdd2SPaul Dagnelie int zbookmark_compare(uint16_t dbss1, uint8_t ibs1, uint16_t dbss2,
610a2cdcdd2SPaul Dagnelie     uint8_t ibs2, const zbookmark_phys_t *zb1, const zbookmark_phys_t *zb2);
611ad135b5dSChristopher Siden 
612fa9e4066Sahrens #ifdef	__cplusplus
613fa9e4066Sahrens }
614fa9e4066Sahrens #endif
615fa9e4066Sahrens 
616fa9e4066Sahrens #endif	/* _ZIO_H */
617