xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zio.h (revision c8811bd3e2427dddbac6c05a59cfe117d8fea370)
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.
28*c8811bd3SToomas Soome  * Copyright 2016 Toomas Soome <tsoome@me.com>
295aeb9474SGarrett D'Amore  */
30fa9e4066Sahrens 
31fa9e4066Sahrens #ifndef _ZIO_H
32fa9e4066Sahrens #define	_ZIO_H
33fa9e4066Sahrens 
34a2cdcdd2SPaul Dagnelie #include <sys/zio_priority.h>
35fa9e4066Sahrens #include <sys/zfs_context.h>
36fa9e4066Sahrens #include <sys/spa.h>
37fa9e4066Sahrens #include <sys/txg.h>
38fa9e4066Sahrens #include <sys/avl.h>
39fa9e4066Sahrens #include <sys/fs/zfs.h>
4044cd46caSbillm #include <sys/zio_impl.h>
41fa9e4066Sahrens 
42fa9e4066Sahrens #ifdef	__cplusplus
43fa9e4066Sahrens extern "C" {
44fa9e4066Sahrens #endif
45fa9e4066Sahrens 
466e1f5caaSNeil Perrin /*
476e1f5caaSNeil Perrin  * Embedded checksum
486e1f5caaSNeil Perrin  */
496e1f5caaSNeil Perrin #define	ZEC_MAGIC	0x210da7ab10c7a11ULL
50fa9e4066Sahrens 
516e1f5caaSNeil Perrin typedef struct zio_eck {
526e1f5caaSNeil Perrin 	uint64_t	zec_magic;	/* for validation, endianness	*/
536e1f5caaSNeil Perrin 	zio_cksum_t	zec_cksum;	/* 256-bit checksum		*/
546e1f5caaSNeil Perrin } zio_eck_t;
55fa9e4066Sahrens 
56fa9e4066Sahrens /*
57fa9e4066Sahrens  * Gang block headers are self-checksumming and contain an array
58fa9e4066Sahrens  * of block pointers.
59fa9e4066Sahrens  */
60fa9e4066Sahrens #define	SPA_GANGBLOCKSIZE	SPA_MINBLOCKSIZE
61fa9e4066Sahrens #define	SPA_GBH_NBLKPTRS	((SPA_GANGBLOCKSIZE - \
626e1f5caaSNeil Perrin 	sizeof (zio_eck_t)) / sizeof (blkptr_t))
63fa9e4066Sahrens #define	SPA_GBH_FILLER		((SPA_GANGBLOCKSIZE - \
646e1f5caaSNeil Perrin 	sizeof (zio_eck_t) - \
65fa9e4066Sahrens 	(SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
66fa9e4066Sahrens 	sizeof (uint64_t))
67fa9e4066Sahrens 
68fa9e4066Sahrens typedef struct zio_gbh {
69fa9e4066Sahrens 	blkptr_t		zg_blkptr[SPA_GBH_NBLKPTRS];
70fa9e4066Sahrens 	uint64_t		zg_filler[SPA_GBH_FILLER];
716e1f5caaSNeil Perrin 	zio_eck_t		zg_tail;
72fa9e4066Sahrens } zio_gbh_phys_t;
73fa9e4066Sahrens 
74fa9e4066Sahrens enum zio_checksum {
75fa9e4066Sahrens 	ZIO_CHECKSUM_INHERIT = 0,
76fa9e4066Sahrens 	ZIO_CHECKSUM_ON,
77fa9e4066Sahrens 	ZIO_CHECKSUM_OFF,
78fa9e4066Sahrens 	ZIO_CHECKSUM_LABEL,
79fa9e4066Sahrens 	ZIO_CHECKSUM_GANG_HEADER,
80fa9e4066Sahrens 	ZIO_CHECKSUM_ZILOG,
81fa9e4066Sahrens 	ZIO_CHECKSUM_FLETCHER_2,
82fa9e4066Sahrens 	ZIO_CHECKSUM_FLETCHER_4,
83fa9e4066Sahrens 	ZIO_CHECKSUM_SHA256,
846e1f5caaSNeil Perrin 	ZIO_CHECKSUM_ZILOG2,
85810e43b2SBill Pijewski 	ZIO_CHECKSUM_NOPARITY,
8645818ee1SMatthew Ahrens 	ZIO_CHECKSUM_SHA512,
8745818ee1SMatthew Ahrens 	ZIO_CHECKSUM_SKEIN,
8845818ee1SMatthew Ahrens 	ZIO_CHECKSUM_EDONR,
89fa9e4066Sahrens 	ZIO_CHECKSUM_FUNCTIONS
90fa9e4066Sahrens };
91fa9e4066Sahrens 
925d7b4d43SMatthew Ahrens /*
935d7b4d43SMatthew Ahrens  * The number of "legacy" compression functions which can be set on individual
945d7b4d43SMatthew Ahrens  * objects.
955d7b4d43SMatthew Ahrens  */
965d7b4d43SMatthew Ahrens #define	ZIO_CHECKSUM_LEGACY_FUNCTIONS ZIO_CHECKSUM_ZILOG2
975d7b4d43SMatthew Ahrens 
987e322df5SJonathan Adams #define	ZIO_CHECKSUM_ON_VALUE	ZIO_CHECKSUM_FLETCHER_4
99fa9e4066Sahrens #define	ZIO_CHECKSUM_DEFAULT	ZIO_CHECKSUM_ON
100fa9e4066Sahrens 
101b24ab676SJeff Bonwick #define	ZIO_CHECKSUM_MASK	0xffULL
102b24ab676SJeff Bonwick #define	ZIO_CHECKSUM_VERIFY	(1 << 8)
103b24ab676SJeff Bonwick 
104b24ab676SJeff Bonwick #define	ZIO_DEDUPCHECKSUM	ZIO_CHECKSUM_SHA256
105b24ab676SJeff Bonwick #define	ZIO_DEDUPDITTO_MIN	100
106b24ab676SJeff Bonwick 
107fa9e4066Sahrens enum zio_compress {
108fa9e4066Sahrens 	ZIO_COMPRESS_INHERIT = 0,
109fa9e4066Sahrens 	ZIO_COMPRESS_ON,
110fa9e4066Sahrens 	ZIO_COMPRESS_OFF,
111fa9e4066Sahrens 	ZIO_COMPRESS_LZJB,
112416e0cd8Sek 	ZIO_COMPRESS_EMPTY,
113c9431fa1Sahl 	ZIO_COMPRESS_GZIP_1,
114c9431fa1Sahl 	ZIO_COMPRESS_GZIP_2,
115c9431fa1Sahl 	ZIO_COMPRESS_GZIP_3,
116c9431fa1Sahl 	ZIO_COMPRESS_GZIP_4,
117c9431fa1Sahl 	ZIO_COMPRESS_GZIP_5,
118c9431fa1Sahl 	ZIO_COMPRESS_GZIP_6,
119c9431fa1Sahl 	ZIO_COMPRESS_GZIP_7,
120c9431fa1Sahl 	ZIO_COMPRESS_GZIP_8,
121c9431fa1Sahl 	ZIO_COMPRESS_GZIP_9,
122b24ab676SJeff Bonwick 	ZIO_COMPRESS_ZLE,
123a6f561b4SSašo Kiselkov 	ZIO_COMPRESS_LZ4,
124fa9e4066Sahrens 	ZIO_COMPRESS_FUNCTIONS
125fa9e4066Sahrens };
126fa9e4066Sahrens 
1275d7b4d43SMatthew Ahrens /*
1285d7b4d43SMatthew Ahrens  * The number of "legacy" compression functions which can be set on individual
1295d7b4d43SMatthew Ahrens  * objects.
1305d7b4d43SMatthew Ahrens  */
1315d7b4d43SMatthew Ahrens #define	ZIO_COMPRESS_LEGACY_FUNCTIONS ZIO_COMPRESS_LZ4
1325d7b4d43SMatthew Ahrens 
133db1741f5SJustin T. Gibbs /*
134db1741f5SJustin T. Gibbs  * The meaning of "compress = on" selected by the compression features enabled
135db1741f5SJustin T. Gibbs  * on a given pool.
136db1741f5SJustin T. Gibbs  */
137db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_LEGACY_ON_VALUE	ZIO_COMPRESS_LZJB
138db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_LZ4_ON_VALUE	ZIO_COMPRESS_LZ4
139db1741f5SJustin T. Gibbs 
140db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_DEFAULT		ZIO_COMPRESS_OFF
141fa9e4066Sahrens 
142b24ab676SJeff Bonwick #define	BOOTFS_COMPRESS_VALID(compress)			\
143b24ab676SJeff Bonwick 	((compress) == ZIO_COMPRESS_LZJB ||		\
144a6f561b4SSašo Kiselkov 	(compress) == ZIO_COMPRESS_LZ4 ||		\
145*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_1 ||		\
146*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_2 ||		\
147*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_3 ||		\
148*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_4 ||		\
149*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_5 ||		\
150*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_6 ||		\
151*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_7 ||		\
152*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_8 ||		\
153*c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_9 ||		\
154db1741f5SJustin T. Gibbs 	(compress) == ZIO_COMPRESS_ON ||		\
155b24ab676SJeff Bonwick 	(compress) == ZIO_COMPRESS_OFF)
156b24ab676SJeff Bonwick 
1570a4e9518Sgw #define	ZIO_FAILURE_MODE_WAIT		0
1580a4e9518Sgw #define	ZIO_FAILURE_MODE_CONTINUE	1
1590a4e9518Sgw #define	ZIO_FAILURE_MODE_PANIC		2
1600a4e9518Sgw 
161b24ab676SJeff Bonwick enum zio_flag {
162b24ab676SJeff Bonwick 	/*
163b24ab676SJeff Bonwick 	 * Flags inherited by gang, ddt, and vdev children,
164b24ab676SJeff Bonwick 	 * and that must be equal for two zios to aggregate
165b24ab676SJeff Bonwick 	 */
166b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_AGGREGATE	= 1 << 0,
167b24ab676SJeff Bonwick 	ZIO_FLAG_IO_REPAIR	= 1 << 1,
168b24ab676SJeff Bonwick 	ZIO_FLAG_SELF_HEAL	= 1 << 2,
169b24ab676SJeff Bonwick 	ZIO_FLAG_RESILVER	= 1 << 3,
170b24ab676SJeff Bonwick 	ZIO_FLAG_SCRUB		= 1 << 4,
17144ecc532SGeorge Wilson 	ZIO_FLAG_SCAN_THREAD	= 1 << 5,
1722a104a52SAlex Reece 	ZIO_FLAG_PHYSICAL	= 1 << 6,
173b24ab676SJeff Bonwick 
174b24ab676SJeff Bonwick #define	ZIO_FLAG_AGG_INHERIT	(ZIO_FLAG_CANFAIL - 1)
175b24ab676SJeff Bonwick 
176b24ab676SJeff Bonwick 	/*
177b24ab676SJeff Bonwick 	 * Flags inherited by ddt, gang, and vdev children.
178b24ab676SJeff Bonwick 	 */
1792a104a52SAlex Reece 	ZIO_FLAG_CANFAIL	= 1 << 7,	/* must be first for INHERIT */
1802a104a52SAlex Reece 	ZIO_FLAG_SPECULATIVE	= 1 << 8,
1812a104a52SAlex Reece 	ZIO_FLAG_CONFIG_WRITER	= 1 << 9,
1822a104a52SAlex Reece 	ZIO_FLAG_DONT_RETRY	= 1 << 10,
1832a104a52SAlex Reece 	ZIO_FLAG_DONT_CACHE	= 1 << 11,
1842a104a52SAlex Reece 	ZIO_FLAG_NODATA		= 1 << 12,
1852a104a52SAlex Reece 	ZIO_FLAG_INDUCE_DAMAGE	= 1 << 13,
1860f7643c7SGeorge Wilson 	ZIO_FLAG_IO_ALLOCATING	= 1 << 14,
187b24ab676SJeff Bonwick 
188b24ab676SJeff Bonwick #define	ZIO_FLAG_DDT_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
189b24ab676SJeff Bonwick #define	ZIO_FLAG_GANG_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
190b24ab676SJeff Bonwick 
191b24ab676SJeff Bonwick 	/*
192b24ab676SJeff Bonwick 	 * Flags inherited by vdev children.
193b24ab676SJeff Bonwick 	 */
1940f7643c7SGeorge Wilson 	ZIO_FLAG_IO_RETRY	= 1 << 15,	/* must be first for INHERIT */
1950f7643c7SGeorge Wilson 	ZIO_FLAG_PROBE		= 1 << 16,
1960f7643c7SGeorge Wilson 	ZIO_FLAG_TRYHARD	= 1 << 17,
1970f7643c7SGeorge Wilson 	ZIO_FLAG_OPTIONAL	= 1 << 18,
198b24ab676SJeff Bonwick 
199b24ab676SJeff Bonwick #define	ZIO_FLAG_VDEV_INHERIT	(ZIO_FLAG_DONT_QUEUE - 1)
200b24ab676SJeff Bonwick 
201b24ab676SJeff Bonwick 	/*
202b24ab676SJeff Bonwick 	 * Flags not inherited by any children.
203b24ab676SJeff Bonwick 	 */
2040f7643c7SGeorge Wilson 	ZIO_FLAG_DONT_QUEUE	= 1 << 19,	/* must be first for INHERIT */
2050f7643c7SGeorge Wilson 	ZIO_FLAG_DONT_PROPAGATE	= 1 << 20,
2060f7643c7SGeorge Wilson 	ZIO_FLAG_IO_BYPASS	= 1 << 21,
2070f7643c7SGeorge Wilson 	ZIO_FLAG_IO_REWRITE	= 1 << 22,
2080f7643c7SGeorge Wilson 	ZIO_FLAG_RAW		= 1 << 23,
2090f7643c7SGeorge Wilson 	ZIO_FLAG_GANG_CHILD	= 1 << 24,
2100f7643c7SGeorge Wilson 	ZIO_FLAG_DDT_CHILD	= 1 << 25,
2110f7643c7SGeorge Wilson 	ZIO_FLAG_GODFATHER	= 1 << 26,
2120f7643c7SGeorge Wilson 	ZIO_FLAG_NOPWRITE	= 1 << 27,
2130f7643c7SGeorge Wilson 	ZIO_FLAG_REEXECUTED	= 1 << 28,
2140f7643c7SGeorge Wilson 	ZIO_FLAG_DELEGATED	= 1 << 29,
215b24ab676SJeff Bonwick };
216b24ab676SJeff Bonwick 
217b24ab676SJeff Bonwick #define	ZIO_FLAG_MUSTSUCCEED		0
218b24ab676SJeff Bonwick 
219b24ab676SJeff Bonwick #define	ZIO_DDT_CHILD_FLAGS(zio)				\
220b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) |		\
221b24ab676SJeff Bonwick 	ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
222b24ab676SJeff Bonwick 
223e14bb325SJeff Bonwick #define	ZIO_GANG_CHILD_FLAGS(zio)				\
224e14bb325SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) |		\
225e14bb325SJeff Bonwick 	ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
226e14bb325SJeff Bonwick 
227b24ab676SJeff Bonwick #define	ZIO_VDEV_CHILD_FLAGS(zio)				\
228b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) |		\
229b24ab676SJeff Bonwick 	ZIO_FLAG_CANFAIL)
230b24ab676SJeff Bonwick 
231e14bb325SJeff Bonwick enum zio_child {
232e14bb325SJeff Bonwick 	ZIO_CHILD_VDEV = 0,
233e14bb325SJeff Bonwick 	ZIO_CHILD_GANG,
234b24ab676SJeff Bonwick 	ZIO_CHILD_DDT,
235e14bb325SJeff Bonwick 	ZIO_CHILD_LOGICAL,
236e14bb325SJeff Bonwick 	ZIO_CHILD_TYPES
237e14bb325SJeff Bonwick };
238e14bb325SJeff Bonwick 
239e14bb325SJeff Bonwick enum zio_wait_type {
240e14bb325SJeff Bonwick 	ZIO_WAIT_READY = 0,
241e14bb325SJeff Bonwick 	ZIO_WAIT_DONE,
242e14bb325SJeff Bonwick 	ZIO_WAIT_TYPES
243e14bb325SJeff Bonwick };
244e14bb325SJeff Bonwick 
245fa9e4066Sahrens /*
246e7cbe64fSgw  * We'll take the unused errnos, 'EBADE' and 'EBADR' (from the Convergent
247e7cbe64fSgw  * graveyard) to indicate checksum errors and fragmentation.
248fa9e4066Sahrens  */
249fa9e4066Sahrens #define	ECKSUM	EBADE
250e7cbe64fSgw #define	EFRAGS	EBADR
251fa9e4066Sahrens 
252fa9e4066Sahrens typedef void zio_done_func_t(zio_t *zio);
253fa9e4066Sahrens 
2540f7643c7SGeorge Wilson extern boolean_t zio_dva_throttle_enabled;
25569962b56SMatthew Ahrens extern const char *zio_type_name[ZIO_TYPES];
256fa9e4066Sahrens 
257ea8dc4b6Seschrock /*
258ea8dc4b6Seschrock  * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
259ea8dc4b6Seschrock  * identifies any block in the pool.  By convention, the meta-objset (MOS)
260b24ab676SJeff Bonwick  * is objset 0, and the meta-dnode is object 0.  This covers all blocks
261b24ab676SJeff Bonwick  * except root blocks and ZIL blocks, which are defined as follows:
262ea8dc4b6Seschrock  *
263b24ab676SJeff Bonwick  * Root blocks (objset_phys_t) are object 0, level -1:  <objset, 0, -1, 0>.
264b24ab676SJeff Bonwick  * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
265b24ab676SJeff Bonwick  * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
266a2cdcdd2SPaul Dagnelie  * dnode visit bookmarks are <objset, object id of dnode, -3, 0>.
267ea8dc4b6Seschrock  *
268b24ab676SJeff Bonwick  * Note: this structure is called a bookmark because its original purpose
269b24ab676SJeff Bonwick  * was to remember where to resume a pool-wide traverse.
270ea8dc4b6Seschrock  *
2717802d7bfSMatthew Ahrens  * Note: this structure is passed between userland and the kernel, and is
2727802d7bfSMatthew Ahrens  * stored on disk (by virtue of being incorporated into other on-disk
2737802d7bfSMatthew Ahrens  * structures, e.g. dsl_scan_phys_t).
274ea8dc4b6Seschrock  */
2757802d7bfSMatthew Ahrens typedef struct zbookmark_phys {
276ea8dc4b6Seschrock 	uint64_t	zb_objset;
277ea8dc4b6Seschrock 	uint64_t	zb_object;
278ea8dc4b6Seschrock 	int64_t		zb_level;
279ea8dc4b6Seschrock 	uint64_t	zb_blkid;
2807802d7bfSMatthew Ahrens } zbookmark_phys_t;
281ea8dc4b6Seschrock 
282b24ab676SJeff Bonwick #define	SET_BOOKMARK(zb, objset, object, level, blkid)  \
283b24ab676SJeff Bonwick {                                                       \
284b24ab676SJeff Bonwick 	(zb)->zb_objset = objset;                       \
285b24ab676SJeff Bonwick 	(zb)->zb_object = object;                       \
286b24ab676SJeff Bonwick 	(zb)->zb_level = level;                         \
287b24ab676SJeff Bonwick 	(zb)->zb_blkid = blkid;                         \
288b24ab676SJeff Bonwick }
289b24ab676SJeff Bonwick 
290b24ab676SJeff Bonwick #define	ZB_DESTROYED_OBJSET	(-1ULL)
291b24ab676SJeff Bonwick 
292b24ab676SJeff Bonwick #define	ZB_ROOT_OBJECT		(0ULL)
293b24ab676SJeff Bonwick #define	ZB_ROOT_LEVEL		(-1LL)
294b24ab676SJeff Bonwick #define	ZB_ROOT_BLKID		(0ULL)
295b24ab676SJeff Bonwick 
296b24ab676SJeff Bonwick #define	ZB_ZIL_OBJECT		(0ULL)
297b24ab676SJeff Bonwick #define	ZB_ZIL_LEVEL		(-2LL)
298b24ab676SJeff Bonwick 
299a2cdcdd2SPaul Dagnelie #define	ZB_DNODE_LEVEL		(-3LL)
300a2cdcdd2SPaul Dagnelie #define	ZB_DNODE_BLKID		(0ULL)
301a2cdcdd2SPaul Dagnelie 
302ad135b5dSChristopher Siden #define	ZB_IS_ZERO(zb)						\
303ad135b5dSChristopher Siden 	((zb)->zb_objset == 0 && (zb)->zb_object == 0 &&	\
304ad135b5dSChristopher Siden 	(zb)->zb_level == 0 && (zb)->zb_blkid == 0)
305ad135b5dSChristopher Siden #define	ZB_IS_ROOT(zb)				\
306ad135b5dSChristopher Siden 	((zb)->zb_object == ZB_ROOT_OBJECT &&	\
307ad135b5dSChristopher Siden 	(zb)->zb_level == ZB_ROOT_LEVEL &&	\
308ad135b5dSChristopher Siden 	(zb)->zb_blkid == ZB_ROOT_BLKID)
309ad135b5dSChristopher Siden 
310e14bb325SJeff Bonwick typedef struct zio_prop {
311e14bb325SJeff Bonwick 	enum zio_checksum	zp_checksum;
312e14bb325SJeff Bonwick 	enum zio_compress	zp_compress;
313e14bb325SJeff Bonwick 	dmu_object_type_t	zp_type;
314e14bb325SJeff Bonwick 	uint8_t			zp_level;
315b24ab676SJeff Bonwick 	uint8_t			zp_copies;
31680901aeaSGeorge Wilson 	boolean_t		zp_dedup;
31780901aeaSGeorge Wilson 	boolean_t		zp_dedup_verify;
31880901aeaSGeorge Wilson 	boolean_t		zp_nopwrite;
319e14bb325SJeff Bonwick } zio_prop_t;
320e14bb325SJeff Bonwick 
32122fe2c88SJonathan Adams typedef struct zio_cksum_report zio_cksum_report_t;
32222fe2c88SJonathan Adams 
32322fe2c88SJonathan Adams typedef void zio_cksum_finish_f(zio_cksum_report_t *rep,
32422fe2c88SJonathan Adams     const void *good_data);
32522fe2c88SJonathan Adams typedef void zio_cksum_free_f(void *cbdata, size_t size);
32622fe2c88SJonathan Adams 
32722fe2c88SJonathan Adams struct zio_bad_cksum;				/* defined in zio_checksum.h */
328ad135b5dSChristopher Siden struct dnode_phys;
32922fe2c88SJonathan Adams 
33022fe2c88SJonathan Adams struct zio_cksum_report {
33122fe2c88SJonathan Adams 	struct zio_cksum_report *zcr_next;
33222fe2c88SJonathan Adams 	nvlist_t		*zcr_ereport;
33322fe2c88SJonathan Adams 	nvlist_t		*zcr_detector;
33422fe2c88SJonathan Adams 	void			*zcr_cbdata;
33522fe2c88SJonathan Adams 	size_t			zcr_cbinfo;	/* passed to zcr_free() */
336b24ab676SJeff Bonwick 	uint64_t		zcr_align;
33722fe2c88SJonathan Adams 	uint64_t		zcr_length;
33822fe2c88SJonathan Adams 	zio_cksum_finish_f	*zcr_finish;
33922fe2c88SJonathan Adams 	zio_cksum_free_f	*zcr_free;
34022fe2c88SJonathan Adams 
34122fe2c88SJonathan Adams 	/* internal use only */
34222fe2c88SJonathan Adams 	struct zio_bad_cksum	*zcr_ckinfo;	/* information from failure */
34322fe2c88SJonathan Adams };
34422fe2c88SJonathan Adams 
34522fe2c88SJonathan Adams typedef void zio_vsd_cksum_report_f(zio_t *zio, zio_cksum_report_t *zcr,
34622fe2c88SJonathan Adams     void *arg);
34722fe2c88SJonathan Adams 
34822fe2c88SJonathan Adams zio_vsd_cksum_report_f	zio_vsd_default_cksum_report;
34922fe2c88SJonathan Adams 
35022fe2c88SJonathan Adams typedef struct zio_vsd_ops {
35122fe2c88SJonathan Adams 	zio_done_func_t		*vsd_free;
35222fe2c88SJonathan Adams 	zio_vsd_cksum_report_f	*vsd_cksum_report;
35322fe2c88SJonathan Adams } zio_vsd_ops_t;
35422fe2c88SJonathan Adams 
355e14bb325SJeff Bonwick typedef struct zio_gang_node {
356e14bb325SJeff Bonwick 	zio_gbh_phys_t		*gn_gbh;
357e14bb325SJeff Bonwick 	struct zio_gang_node	*gn_child[SPA_GBH_NBLKPTRS];
358e14bb325SJeff Bonwick } zio_gang_node_t;
359e14bb325SJeff Bonwick 
360e14bb325SJeff Bonwick typedef zio_t *zio_gang_issue_func_t(zio_t *zio, blkptr_t *bp,
361e14bb325SJeff Bonwick     zio_gang_node_t *gn, void *data);
362e14bb325SJeff Bonwick 
363e14bb325SJeff Bonwick typedef void zio_transform_func_t(zio_t *zio, void *data, uint64_t size);
364e14bb325SJeff Bonwick 
365e14bb325SJeff Bonwick typedef struct zio_transform {
366e14bb325SJeff Bonwick 	void			*zt_orig_data;
367e14bb325SJeff Bonwick 	uint64_t		zt_orig_size;
368e14bb325SJeff Bonwick 	uint64_t		zt_bufsize;
369e14bb325SJeff Bonwick 	zio_transform_func_t	*zt_transform;
370e14bb325SJeff Bonwick 	struct zio_transform	*zt_next;
371e14bb325SJeff Bonwick } zio_transform_t;
372e14bb325SJeff Bonwick 
373e14bb325SJeff Bonwick typedef int zio_pipe_stage_t(zio_t *zio);
374e14bb325SJeff Bonwick 
375e14bb325SJeff Bonwick /*
376e14bb325SJeff Bonwick  * The io_reexecute flags are distinct from io_flags because the child must
377e14bb325SJeff Bonwick  * be able to propagate them to the parent.  The normal io_flags are local
378e14bb325SJeff Bonwick  * to the zio, not protected by any lock, and not modifiable by children;
379e14bb325SJeff Bonwick  * the reexecute flags are protected by io_lock, modifiable by children,
380e14bb325SJeff Bonwick  * and always propagated -- even when ZIO_FLAG_DONT_PROPAGATE is set.
381e14bb325SJeff Bonwick  */
382e14bb325SJeff Bonwick #define	ZIO_REEXECUTE_NOW	0x01
383e14bb325SJeff Bonwick #define	ZIO_REEXECUTE_SUSPEND	0x02
384e14bb325SJeff Bonwick 
385a3f829aeSBill Moore typedef struct zio_link {
386a3f829aeSBill Moore 	zio_t		*zl_parent;
387a3f829aeSBill Moore 	zio_t		*zl_child;
388a3f829aeSBill Moore 	list_node_t	zl_parent_node;
389a3f829aeSBill Moore 	list_node_t	zl_child_node;
390a3f829aeSBill Moore } zio_link_t;
391a3f829aeSBill Moore 
392fa9e4066Sahrens struct zio {
393fa9e4066Sahrens 	/* Core information about this I/O */
3947802d7bfSMatthew Ahrens 	zbookmark_phys_t	io_bookmark;
395e14bb325SJeff Bonwick 	zio_prop_t	io_prop;
396e14bb325SJeff Bonwick 	zio_type_t	io_type;
397e14bb325SJeff Bonwick 	enum zio_child	io_child_type;
398e14bb325SJeff Bonwick 	int		io_cmd;
39969962b56SMatthew Ahrens 	zio_priority_t	io_priority;
400e14bb325SJeff Bonwick 	uint8_t		io_reexecute;
401a3f829aeSBill Moore 	uint8_t		io_state[ZIO_WAIT_TYPES];
402fa9e4066Sahrens 	uint64_t	io_txg;
403e14bb325SJeff Bonwick 	spa_t		*io_spa;
404fa9e4066Sahrens 	blkptr_t	*io_bp;
405b24ab676SJeff Bonwick 	blkptr_t	*io_bp_override;
406fa9e4066Sahrens 	blkptr_t	io_bp_copy;
407a3f829aeSBill Moore 	list_t		io_parent_list;
408a3f829aeSBill Moore 	list_t		io_child_list;
409ea8dc4b6Seschrock 	zio_t		*io_logical;
410e14bb325SJeff Bonwick 	zio_transform_t *io_transform_stack;
411fa9e4066Sahrens 
412fa9e4066Sahrens 	/* Callback info */
413c717a561Smaybee 	zio_done_func_t	*io_ready;
4148df0bcf0SPaul Dagnelie 	zio_done_func_t	*io_children_ready;
41569962b56SMatthew Ahrens 	zio_done_func_t	*io_physdone;
416fa9e4066Sahrens 	zio_done_func_t	*io_done;
417fa9e4066Sahrens 	void		*io_private;
418b24ab676SJeff Bonwick 	int64_t		io_prev_space_delta;	/* DMU private */
419fa9e4066Sahrens 	blkptr_t	io_bp_orig;
420fa9e4066Sahrens 
421fa9e4066Sahrens 	/* Data represented by this I/O */
422fa9e4066Sahrens 	void		*io_data;
423b24ab676SJeff Bonwick 	void		*io_orig_data;
424fa9e4066Sahrens 	uint64_t	io_size;
425b24ab676SJeff Bonwick 	uint64_t	io_orig_size;
426fa9e4066Sahrens 
427fa9e4066Sahrens 	/* Stuff for the vdev stack */
428fa9e4066Sahrens 	vdev_t		*io_vd;
429fa9e4066Sahrens 	void		*io_vsd;
43022fe2c88SJonathan Adams 	const zio_vsd_ops_t *io_vsd_ops;
43122fe2c88SJonathan Adams 
432fa9e4066Sahrens 	uint64_t	io_offset;
433c55e05cbSMatthew Ahrens 	hrtime_t	io_timestamp;
4340f7643c7SGeorge Wilson 	hrtime_t	io_queued_timestamp;
43597e81309SPrakash Surya 	hrtime_t	io_target_timestamp;
43669962b56SMatthew Ahrens 	avl_node_t	io_queue_node;
437fe319232SJustin T. Gibbs 	avl_node_t	io_offset_node;
4380f7643c7SGeorge Wilson 	avl_node_t	io_alloc_node;
439fa9e4066Sahrens 
440fa9e4066Sahrens 	/* Internal pipeline state */
441b24ab676SJeff Bonwick 	enum zio_flag	io_flags;
442b24ab676SJeff Bonwick 	enum zio_stage	io_stage;
443b24ab676SJeff Bonwick 	enum zio_stage	io_pipeline;
444b24ab676SJeff Bonwick 	enum zio_flag	io_orig_flags;
445b24ab676SJeff Bonwick 	enum zio_stage	io_orig_stage;
446b24ab676SJeff Bonwick 	enum zio_stage	io_orig_pipeline;
4470f7643c7SGeorge Wilson 	enum zio_stage	io_pipeline_trace;
448e14bb325SJeff Bonwick 	int		io_error;
449e14bb325SJeff Bonwick 	int		io_child_error[ZIO_CHILD_TYPES];
450e14bb325SJeff Bonwick 	uint64_t	io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
451b24ab676SJeff Bonwick 	uint64_t	io_child_count;
45269962b56SMatthew Ahrens 	uint64_t	io_phys_children;
453b24ab676SJeff Bonwick 	uint64_t	io_parent_count;
454e14bb325SJeff Bonwick 	uint64_t	*io_stall;
455f5383399SBill Moore 	zio_t		*io_gang_leader;
456e14bb325SJeff Bonwick 	zio_gang_node_t	*io_gang_tree;
457e14bb325SJeff Bonwick 	void		*io_executor;
458fa9e4066Sahrens 	void		*io_waiter;
459fa9e4066Sahrens 	kmutex_t	io_lock;
460fa9e4066Sahrens 	kcondvar_t	io_cv;
461ea8dc4b6Seschrock 
462ea8dc4b6Seschrock 	/* FMA state */
46322fe2c88SJonathan Adams 	zio_cksum_report_t *io_cksum_report;
464ea8dc4b6Seschrock 	uint64_t	io_ena;
4655aeb9474SGarrett D'Amore 
4665aeb9474SGarrett D'Amore 	/* Taskq dispatching state */
4675aeb9474SGarrett D'Amore 	taskq_ent_t	io_tqent;
468fa9e4066Sahrens };
469fa9e4066Sahrens 
4700f7643c7SGeorge Wilson extern int zio_timestamp_compare(const void *, const void *);
4710f7643c7SGeorge Wilson 
472a3f829aeSBill Moore extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
473b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
474fa9e4066Sahrens 
475fa9e4066Sahrens extern zio_t *zio_root(spa_t *spa,
476b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
477fa9e4066Sahrens 
478088f3894Sahrens extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, void *data,
479fa9e4066Sahrens     uint64_t size, zio_done_func_t *done, void *private,
4807802d7bfSMatthew Ahrens     zio_priority_t priority, enum zio_flag flags, const zbookmark_phys_t *zb);
481fa9e4066Sahrens 
482e14bb325SJeff Bonwick extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
483b24ab676SJeff Bonwick     void *data, uint64_t size, const zio_prop_t *zp,
4848df0bcf0SPaul Dagnelie     zio_done_func_t *ready, zio_done_func_t *children_ready,
4858df0bcf0SPaul Dagnelie     zio_done_func_t *physdone, zio_done_func_t *done,
4868df0bcf0SPaul Dagnelie     void *private, zio_priority_t priority, enum zio_flag flags,
4878df0bcf0SPaul Dagnelie     const zbookmark_phys_t *zb);
488fa9e4066Sahrens 
489e14bb325SJeff Bonwick extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
490e14bb325SJeff Bonwick     void *data, uint64_t size, zio_done_func_t *done, void *private,
4917802d7bfSMatthew Ahrens     zio_priority_t priority, enum zio_flag flags, zbookmark_phys_t *zb);
492fa9e4066Sahrens 
49380901aeaSGeorge Wilson extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
49480901aeaSGeorge Wilson     boolean_t nopwrite);
49582c9918fSTim Haley 
496b24ab676SJeff Bonwick extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
497fa9e4066Sahrens 
498b24ab676SJeff Bonwick extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
499b24ab676SJeff Bonwick     const blkptr_t *bp,
500b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
501fa9e4066Sahrens 
502fa9e4066Sahrens extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
50369962b56SMatthew Ahrens     zio_done_func_t *done, void *private, enum zio_flag flags);
504fa9e4066Sahrens 
505fa9e4066Sahrens extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
506fa9e4066Sahrens     uint64_t size, void *data, int checksum,
50769962b56SMatthew Ahrens     zio_done_func_t *done, void *private, zio_priority_t priority,
50869962b56SMatthew Ahrens     enum zio_flag flags, boolean_t labels);
509fa9e4066Sahrens 
510fa9e4066Sahrens extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
511fa9e4066Sahrens     uint64_t size, void *data, int checksum,
51269962b56SMatthew Ahrens     zio_done_func_t *done, void *private, zio_priority_t priority,
51369962b56SMatthew Ahrens     enum zio_flag flags, boolean_t labels);
514fa9e4066Sahrens 
515b24ab676SJeff Bonwick extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
516b24ab676SJeff Bonwick     const blkptr_t *bp, enum zio_flag flags);
517b24ab676SJeff Bonwick 
518b24ab676SJeff Bonwick extern int zio_alloc_zil(spa_t *spa, uint64_t txg, blkptr_t *new_bp,
519b24ab676SJeff Bonwick     blkptr_t *old_bp, uint64_t size, boolean_t use_slog);
520b24ab676SJeff Bonwick extern void zio_free_zil(spa_t *spa, uint64_t txg, blkptr_t *bp);
52117f17c2dSbonwick extern void zio_flush(zio_t *zio, vdev_t *vd);
5226e1f5caaSNeil Perrin extern void zio_shrink(zio_t *zio, uint64_t size);
523fa9e4066Sahrens 
524fa9e4066Sahrens extern int zio_wait(zio_t *zio);
525fa9e4066Sahrens extern void zio_nowait(zio_t *zio);
526e05725b1Sbonwick extern void zio_execute(zio_t *zio);
527e05725b1Sbonwick extern void zio_interrupt(zio_t *zio);
52897e81309SPrakash Surya extern void zio_delay_init(zio_t *zio);
52997e81309SPrakash Surya extern void zio_delay_interrupt(zio_t *zio);
530e05725b1Sbonwick 
5310f7643c7SGeorge Wilson extern zio_t *zio_walk_parents(zio_t *cio, zio_link_t **);
5320f7643c7SGeorge Wilson extern zio_t *zio_walk_children(zio_t *pio, zio_link_t **);
533a3f829aeSBill Moore extern zio_t *zio_unique_parent(zio_t *cio);
534a3f829aeSBill Moore extern void zio_add_child(zio_t *pio, zio_t *cio);
535a3f829aeSBill Moore 
536fa9e4066Sahrens extern void *zio_buf_alloc(size_t size);
537fa9e4066Sahrens extern void zio_buf_free(void *buf, size_t size);
538ad23a2dbSjohansen extern void *zio_data_buf_alloc(size_t size);
539ad23a2dbSjohansen extern void zio_data_buf_free(void *buf, size_t size);
540fa9e4066Sahrens 
541dcbf3bd6SGeorge Wilson extern void zio_push_transform(zio_t *zio, void *data, uint64_t size,
542dcbf3bd6SGeorge Wilson     uint64_t bufsize, zio_transform_func_t *transform);
543dcbf3bd6SGeorge Wilson extern void zio_pop_transforms(zio_t *zio);
544dcbf3bd6SGeorge Wilson 
5450a4e9518Sgw extern void zio_resubmit_stage_async(void *);
546fa9e4066Sahrens 
547fa9e4066Sahrens extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
54869962b56SMatthew Ahrens     uint64_t offset, void *data, uint64_t size, int type,
54969962b56SMatthew Ahrens     zio_priority_t priority, enum zio_flag flags,
55069962b56SMatthew Ahrens     zio_done_func_t *done, void *private);
551fa9e4066Sahrens 
552e14bb325SJeff Bonwick extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
55369962b56SMatthew Ahrens     void *data, uint64_t size, int type, zio_priority_t priority,
554b24ab676SJeff Bonwick     enum zio_flag flags, zio_done_func_t *done, void *private);
555e14bb325SJeff Bonwick 
556fa9e4066Sahrens extern void zio_vdev_io_bypass(zio_t *zio);
557fa9e4066Sahrens extern void zio_vdev_io_reissue(zio_t *zio);
558fa9e4066Sahrens extern void zio_vdev_io_redone(zio_t *zio);
559fa9e4066Sahrens 
560fa9e4066Sahrens extern void zio_checksum_verified(zio_t *zio);
561e14bb325SJeff Bonwick extern int zio_worst_error(int e1, int e2);
562fa9e4066Sahrens 
563b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
564b24ab676SJeff Bonwick     enum zio_checksum parent);
565b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
566b24ab676SJeff Bonwick     enum zio_checksum child, enum zio_checksum parent);
567db1741f5SJustin T. Gibbs extern enum zio_compress zio_compress_select(spa_t *spa,
568db1741f5SJustin T. Gibbs     enum zio_compress child, enum zio_compress parent);
569fa9e4066Sahrens 
570e14bb325SJeff Bonwick extern void zio_suspend(spa_t *spa, zio_t *zio);
57154d692b7SGeorge Wilson extern int zio_resume(spa_t *spa);
572e14bb325SJeff Bonwick extern void zio_resume_wait(spa_t *spa);
573ea8dc4b6Seschrock 
574fa9e4066Sahrens /*
575fa9e4066Sahrens  * Initial setup and teardown.
576fa9e4066Sahrens  */
577fa9e4066Sahrens extern void zio_init(void);
578fa9e4066Sahrens extern void zio_fini(void);
579fa9e4066Sahrens 
580ea8dc4b6Seschrock /*
581ea8dc4b6Seschrock  * Fault injection
582ea8dc4b6Seschrock  */
583ea8dc4b6Seschrock struct zinject_record;
584ea8dc4b6Seschrock extern uint32_t zio_injection_enabled;
585ea8dc4b6Seschrock extern int zio_inject_fault(char *name, int flags, int *id,
586ea8dc4b6Seschrock     struct zinject_record *record);
587ea8dc4b6Seschrock extern int zio_inject_list_next(int *id, char *name, size_t buflen,
588ea8dc4b6Seschrock     struct zinject_record *record);
589ea8dc4b6Seschrock extern int zio_clear_fault(int id);
5901195e687SMark J Musante extern void zio_handle_panic_injection(spa_t *spa, char *tag, uint64_t type);
591ea8dc4b6Seschrock extern int zio_handle_fault_injection(zio_t *zio, int error);
5928956713aSEric Schrock extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
59321bf64a7Sgw extern int zio_handle_label_injection(zio_t *zio, int error);
594468c413aSTim Haley extern void zio_handle_ignored_writes(zio_t *zio);
59597e81309SPrakash Surya extern hrtime_t zio_handle_io_delay(zio_t *zio);
596ea8dc4b6Seschrock 
59722fe2c88SJonathan Adams /*
59822fe2c88SJonathan Adams  * Checksum ereport functions
59922fe2c88SJonathan Adams  */
60022fe2c88SJonathan Adams extern void zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd, struct zio *zio,
60122fe2c88SJonathan Adams     uint64_t offset, uint64_t length, void *arg, struct zio_bad_cksum *info);
60222fe2c88SJonathan Adams extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
60322fe2c88SJonathan Adams     const void *good_data, const void *bad_data, boolean_t drop_if_identical);
60422fe2c88SJonathan Adams 
60522fe2c88SJonathan Adams extern void zfs_ereport_send_interim_checksum(zio_cksum_report_t *report);
60622fe2c88SJonathan Adams extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
60722fe2c88SJonathan Adams 
60822fe2c88SJonathan Adams /* If we have the good data in hand, this function can be used */
60922fe2c88SJonathan Adams extern void zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
61022fe2c88SJonathan Adams     struct zio *zio, uint64_t offset, uint64_t length,
61122fe2c88SJonathan Adams     const void *good_data, const void *bad_data, struct zio_bad_cksum *info);
61222fe2c88SJonathan Adams 
613468c413aSTim Haley /* Called from spa_sync(), but primarily an injection handler */
614468c413aSTim Haley extern void spa_handle_ignored_writes(spa_t *spa);
615468c413aSTim Haley 
6167802d7bfSMatthew Ahrens /* zbookmark_phys functions */
617a2cdcdd2SPaul Dagnelie boolean_t zbookmark_subtree_completed(const struct dnode_phys *dnp,
618a2cdcdd2SPaul Dagnelie     const zbookmark_phys_t *subtree_root, const zbookmark_phys_t *last_block);
619a2cdcdd2SPaul Dagnelie int zbookmark_compare(uint16_t dbss1, uint8_t ibs1, uint16_t dbss2,
620a2cdcdd2SPaul Dagnelie     uint8_t ibs2, const zbookmark_phys_t *zb1, const zbookmark_phys_t *zb2);
621ad135b5dSChristopher Siden 
622fa9e4066Sahrens #ifdef	__cplusplus
623fa9e4066Sahrens }
624fa9e4066Sahrens #endif
625fa9e4066Sahrens 
626fa9e4066Sahrens #endif	/* _ZIO_H */
627