xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zio.h (revision 94c2d0eb22e9624151ee84a7edbf7178e1bf4087)
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.
25*94c2d0ebSMatthew Ahrens  * Copyright (c) 2012, 2017 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.
28c8811bd3SToomas 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 
1075d7b4d43SMatthew Ahrens /*
1085d7b4d43SMatthew Ahrens  * The number of "legacy" compression functions which can be set on individual
1095d7b4d43SMatthew Ahrens  * objects.
1105d7b4d43SMatthew Ahrens  */
1115d7b4d43SMatthew Ahrens #define	ZIO_COMPRESS_LEGACY_FUNCTIONS ZIO_COMPRESS_LZ4
1125d7b4d43SMatthew Ahrens 
113db1741f5SJustin T. Gibbs /*
114db1741f5SJustin T. Gibbs  * The meaning of "compress = on" selected by the compression features enabled
115db1741f5SJustin T. Gibbs  * on a given pool.
116db1741f5SJustin T. Gibbs  */
117db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_LEGACY_ON_VALUE	ZIO_COMPRESS_LZJB
118db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_LZ4_ON_VALUE	ZIO_COMPRESS_LZ4
119db1741f5SJustin T. Gibbs 
120db1741f5SJustin T. Gibbs #define	ZIO_COMPRESS_DEFAULT		ZIO_COMPRESS_OFF
121fa9e4066Sahrens 
122b24ab676SJeff Bonwick #define	BOOTFS_COMPRESS_VALID(compress)			\
123b24ab676SJeff Bonwick 	((compress) == ZIO_COMPRESS_LZJB ||		\
124a6f561b4SSašo Kiselkov 	(compress) == ZIO_COMPRESS_LZ4 ||		\
125c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_1 ||		\
126c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_2 ||		\
127c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_3 ||		\
128c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_4 ||		\
129c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_5 ||		\
130c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_6 ||		\
131c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_7 ||		\
132c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_8 ||		\
133c8811bd3SToomas Soome 	(compress) == ZIO_COMPRESS_GZIP_9 ||		\
134db1741f5SJustin T. Gibbs 	(compress) == ZIO_COMPRESS_ON ||		\
135b24ab676SJeff Bonwick 	(compress) == ZIO_COMPRESS_OFF)
136b24ab676SJeff Bonwick 
1370a4e9518Sgw #define	ZIO_FAILURE_MODE_WAIT		0
1380a4e9518Sgw #define	ZIO_FAILURE_MODE_CONTINUE	1
1390a4e9518Sgw #define	ZIO_FAILURE_MODE_PANIC		2
1400a4e9518Sgw 
141b24ab676SJeff Bonwick enum zio_flag {
142b24ab676SJeff Bonwick 	/*
143b24ab676SJeff Bonwick 	 * Flags inherited by gang, ddt, and vdev children,
144b24ab676SJeff Bonwick 	 * and that must be equal for two zios to aggregate
145b24ab676SJeff Bonwick 	 */
146b24ab676SJeff Bonwick 	ZIO_FLAG_DONT_AGGREGATE	= 1 << 0,
147b24ab676SJeff Bonwick 	ZIO_FLAG_IO_REPAIR	= 1 << 1,
148b24ab676SJeff Bonwick 	ZIO_FLAG_SELF_HEAL	= 1 << 2,
149b24ab676SJeff Bonwick 	ZIO_FLAG_RESILVER	= 1 << 3,
150b24ab676SJeff Bonwick 	ZIO_FLAG_SCRUB		= 1 << 4,
15144ecc532SGeorge Wilson 	ZIO_FLAG_SCAN_THREAD	= 1 << 5,
1522a104a52SAlex Reece 	ZIO_FLAG_PHYSICAL	= 1 << 6,
153b24ab676SJeff Bonwick 
154b24ab676SJeff Bonwick #define	ZIO_FLAG_AGG_INHERIT	(ZIO_FLAG_CANFAIL - 1)
155b24ab676SJeff Bonwick 
156b24ab676SJeff Bonwick 	/*
157b24ab676SJeff Bonwick 	 * Flags inherited by ddt, gang, and vdev children.
158b24ab676SJeff Bonwick 	 */
1592a104a52SAlex Reece 	ZIO_FLAG_CANFAIL	= 1 << 7,	/* must be first for INHERIT */
1602a104a52SAlex Reece 	ZIO_FLAG_SPECULATIVE	= 1 << 8,
1612a104a52SAlex Reece 	ZIO_FLAG_CONFIG_WRITER	= 1 << 9,
1622a104a52SAlex Reece 	ZIO_FLAG_DONT_RETRY	= 1 << 10,
1632a104a52SAlex Reece 	ZIO_FLAG_DONT_CACHE	= 1 << 11,
1642a104a52SAlex Reece 	ZIO_FLAG_NODATA		= 1 << 12,
1652a104a52SAlex Reece 	ZIO_FLAG_INDUCE_DAMAGE	= 1 << 13,
1660f7643c7SGeorge Wilson 	ZIO_FLAG_IO_ALLOCATING	= 1 << 14,
167b24ab676SJeff Bonwick 
168b24ab676SJeff Bonwick #define	ZIO_FLAG_DDT_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
169b24ab676SJeff Bonwick #define	ZIO_FLAG_GANG_INHERIT	(ZIO_FLAG_IO_RETRY - 1)
170b24ab676SJeff Bonwick 
171b24ab676SJeff Bonwick 	/*
172b24ab676SJeff Bonwick 	 * Flags inherited by vdev children.
173b24ab676SJeff Bonwick 	 */
1740f7643c7SGeorge Wilson 	ZIO_FLAG_IO_RETRY	= 1 << 15,	/* must be first for INHERIT */
1750f7643c7SGeorge Wilson 	ZIO_FLAG_PROBE		= 1 << 16,
1760f7643c7SGeorge Wilson 	ZIO_FLAG_TRYHARD	= 1 << 17,
1770f7643c7SGeorge Wilson 	ZIO_FLAG_OPTIONAL	= 1 << 18,
178b24ab676SJeff Bonwick 
179b24ab676SJeff Bonwick #define	ZIO_FLAG_VDEV_INHERIT	(ZIO_FLAG_DONT_QUEUE - 1)
180b24ab676SJeff Bonwick 
181b24ab676SJeff Bonwick 	/*
182b24ab676SJeff Bonwick 	 * Flags not inherited by any children.
183b24ab676SJeff Bonwick 	 */
1840f7643c7SGeorge Wilson 	ZIO_FLAG_DONT_QUEUE	= 1 << 19,	/* must be first for INHERIT */
1850f7643c7SGeorge Wilson 	ZIO_FLAG_DONT_PROPAGATE	= 1 << 20,
1860f7643c7SGeorge Wilson 	ZIO_FLAG_IO_BYPASS	= 1 << 21,
1870f7643c7SGeorge Wilson 	ZIO_FLAG_IO_REWRITE	= 1 << 22,
1880f7643c7SGeorge Wilson 	ZIO_FLAG_RAW		= 1 << 23,
1890f7643c7SGeorge Wilson 	ZIO_FLAG_GANG_CHILD	= 1 << 24,
1900f7643c7SGeorge Wilson 	ZIO_FLAG_DDT_CHILD	= 1 << 25,
1910f7643c7SGeorge Wilson 	ZIO_FLAG_GODFATHER	= 1 << 26,
1920f7643c7SGeorge Wilson 	ZIO_FLAG_NOPWRITE	= 1 << 27,
1930f7643c7SGeorge Wilson 	ZIO_FLAG_REEXECUTED	= 1 << 28,
1940f7643c7SGeorge Wilson 	ZIO_FLAG_DELEGATED	= 1 << 29,
195b24ab676SJeff Bonwick };
196b24ab676SJeff Bonwick 
197b24ab676SJeff Bonwick #define	ZIO_FLAG_MUSTSUCCEED		0
198b24ab676SJeff Bonwick 
199b24ab676SJeff Bonwick #define	ZIO_DDT_CHILD_FLAGS(zio)				\
200b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) |		\
201b24ab676SJeff Bonwick 	ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
202b24ab676SJeff Bonwick 
203e14bb325SJeff Bonwick #define	ZIO_GANG_CHILD_FLAGS(zio)				\
204e14bb325SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) |		\
205e14bb325SJeff Bonwick 	ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
206e14bb325SJeff Bonwick 
207b24ab676SJeff Bonwick #define	ZIO_VDEV_CHILD_FLAGS(zio)				\
208b24ab676SJeff Bonwick 	(((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) |		\
209b24ab676SJeff Bonwick 	ZIO_FLAG_CANFAIL)
210b24ab676SJeff Bonwick 
211e14bb325SJeff Bonwick enum zio_child {
212e14bb325SJeff Bonwick 	ZIO_CHILD_VDEV = 0,
213e14bb325SJeff Bonwick 	ZIO_CHILD_GANG,
214b24ab676SJeff Bonwick 	ZIO_CHILD_DDT,
215e14bb325SJeff Bonwick 	ZIO_CHILD_LOGICAL,
216e14bb325SJeff Bonwick 	ZIO_CHILD_TYPES
217e14bb325SJeff Bonwick };
218e14bb325SJeff Bonwick 
219e14bb325SJeff Bonwick enum zio_wait_type {
220e14bb325SJeff Bonwick 	ZIO_WAIT_READY = 0,
221e14bb325SJeff Bonwick 	ZIO_WAIT_DONE,
222e14bb325SJeff Bonwick 	ZIO_WAIT_TYPES
223e14bb325SJeff Bonwick };
224e14bb325SJeff Bonwick 
225fa9e4066Sahrens /*
226e7cbe64fSgw  * We'll take the unused errnos, 'EBADE' and 'EBADR' (from the Convergent
227e7cbe64fSgw  * graveyard) to indicate checksum errors and fragmentation.
228fa9e4066Sahrens  */
229fa9e4066Sahrens #define	ECKSUM	EBADE
230e7cbe64fSgw #define	EFRAGS	EBADR
231fa9e4066Sahrens 
232fa9e4066Sahrens typedef void zio_done_func_t(zio_t *zio);
233fa9e4066Sahrens 
2340f7643c7SGeorge Wilson extern boolean_t zio_dva_throttle_enabled;
23569962b56SMatthew Ahrens extern const char *zio_type_name[ZIO_TYPES];
236fa9e4066Sahrens 
237ea8dc4b6Seschrock /*
238ea8dc4b6Seschrock  * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
239ea8dc4b6Seschrock  * identifies any block in the pool.  By convention, the meta-objset (MOS)
240b24ab676SJeff Bonwick  * is objset 0, and the meta-dnode is object 0.  This covers all blocks
241b24ab676SJeff Bonwick  * except root blocks and ZIL blocks, which are defined as follows:
242ea8dc4b6Seschrock  *
243b24ab676SJeff Bonwick  * Root blocks (objset_phys_t) are object 0, level -1:  <objset, 0, -1, 0>.
244b24ab676SJeff Bonwick  * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
245b24ab676SJeff Bonwick  * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
246a2cdcdd2SPaul Dagnelie  * dnode visit bookmarks are <objset, object id of dnode, -3, 0>.
247ea8dc4b6Seschrock  *
248b24ab676SJeff Bonwick  * Note: this structure is called a bookmark because its original purpose
249b24ab676SJeff Bonwick  * was to remember where to resume a pool-wide traverse.
250ea8dc4b6Seschrock  *
2517802d7bfSMatthew Ahrens  * Note: this structure is passed between userland and the kernel, and is
2527802d7bfSMatthew Ahrens  * stored on disk (by virtue of being incorporated into other on-disk
2537802d7bfSMatthew Ahrens  * structures, e.g. dsl_scan_phys_t).
254ea8dc4b6Seschrock  */
2557802d7bfSMatthew Ahrens typedef struct zbookmark_phys {
256ea8dc4b6Seschrock 	uint64_t	zb_objset;
257ea8dc4b6Seschrock 	uint64_t	zb_object;
258ea8dc4b6Seschrock 	int64_t		zb_level;
259ea8dc4b6Seschrock 	uint64_t	zb_blkid;
2607802d7bfSMatthew Ahrens } zbookmark_phys_t;
261ea8dc4b6Seschrock 
262b24ab676SJeff Bonwick #define	SET_BOOKMARK(zb, objset, object, level, blkid)  \
263b24ab676SJeff Bonwick {                                                       \
264b24ab676SJeff Bonwick 	(zb)->zb_objset = objset;                       \
265b24ab676SJeff Bonwick 	(zb)->zb_object = object;                       \
266b24ab676SJeff Bonwick 	(zb)->zb_level = level;                         \
267b24ab676SJeff Bonwick 	(zb)->zb_blkid = blkid;                         \
268b24ab676SJeff Bonwick }
269b24ab676SJeff Bonwick 
270b24ab676SJeff Bonwick #define	ZB_DESTROYED_OBJSET	(-1ULL)
271b24ab676SJeff Bonwick 
272b24ab676SJeff Bonwick #define	ZB_ROOT_OBJECT		(0ULL)
273b24ab676SJeff Bonwick #define	ZB_ROOT_LEVEL		(-1LL)
274b24ab676SJeff Bonwick #define	ZB_ROOT_BLKID		(0ULL)
275b24ab676SJeff Bonwick 
276b24ab676SJeff Bonwick #define	ZB_ZIL_OBJECT		(0ULL)
277b24ab676SJeff Bonwick #define	ZB_ZIL_LEVEL		(-2LL)
278b24ab676SJeff Bonwick 
279a2cdcdd2SPaul Dagnelie #define	ZB_DNODE_LEVEL		(-3LL)
280a2cdcdd2SPaul Dagnelie #define	ZB_DNODE_BLKID		(0ULL)
281a2cdcdd2SPaul Dagnelie 
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 
3658363e80aSGeorge Wilson typedef struct zio_alloc_list {
3668363e80aSGeorge Wilson 	list_t  zal_list;
3678363e80aSGeorge Wilson 	uint64_t zal_size;
3688363e80aSGeorge Wilson } zio_alloc_list_t;
3698363e80aSGeorge Wilson 
370a3f829aeSBill Moore typedef struct zio_link {
371a3f829aeSBill Moore 	zio_t		*zl_parent;
372a3f829aeSBill Moore 	zio_t		*zl_child;
373a3f829aeSBill Moore 	list_node_t	zl_parent_node;
374a3f829aeSBill Moore 	list_node_t	zl_child_node;
375a3f829aeSBill Moore } zio_link_t;
376a3f829aeSBill Moore 
377fa9e4066Sahrens struct zio {
378fa9e4066Sahrens 	/* Core information about this I/O */
3797802d7bfSMatthew Ahrens 	zbookmark_phys_t	io_bookmark;
380e14bb325SJeff Bonwick 	zio_prop_t	io_prop;
381e14bb325SJeff Bonwick 	zio_type_t	io_type;
382e14bb325SJeff Bonwick 	enum zio_child	io_child_type;
383e14bb325SJeff Bonwick 	int		io_cmd;
38469962b56SMatthew Ahrens 	zio_priority_t	io_priority;
385e14bb325SJeff Bonwick 	uint8_t		io_reexecute;
386a3f829aeSBill Moore 	uint8_t		io_state[ZIO_WAIT_TYPES];
387fa9e4066Sahrens 	uint64_t	io_txg;
388e14bb325SJeff Bonwick 	spa_t		*io_spa;
389fa9e4066Sahrens 	blkptr_t	*io_bp;
390b24ab676SJeff Bonwick 	blkptr_t	*io_bp_override;
391fa9e4066Sahrens 	blkptr_t	io_bp_copy;
392a3f829aeSBill Moore 	list_t		io_parent_list;
393a3f829aeSBill Moore 	list_t		io_child_list;
394ea8dc4b6Seschrock 	zio_t		*io_logical;
395e14bb325SJeff Bonwick 	zio_transform_t *io_transform_stack;
396fa9e4066Sahrens 
397fa9e4066Sahrens 	/* Callback info */
398c717a561Smaybee 	zio_done_func_t	*io_ready;
3998df0bcf0SPaul Dagnelie 	zio_done_func_t	*io_children_ready;
40069962b56SMatthew Ahrens 	zio_done_func_t	*io_physdone;
401fa9e4066Sahrens 	zio_done_func_t	*io_done;
402fa9e4066Sahrens 	void		*io_private;
403b24ab676SJeff Bonwick 	int64_t		io_prev_space_delta;	/* DMU private */
404fa9e4066Sahrens 	blkptr_t	io_bp_orig;
405fa9e4066Sahrens 
406fa9e4066Sahrens 	/* Data represented by this I/O */
407fa9e4066Sahrens 	void		*io_data;
408b24ab676SJeff Bonwick 	void		*io_orig_data;
409fa9e4066Sahrens 	uint64_t	io_size;
410b24ab676SJeff Bonwick 	uint64_t	io_orig_size;
4115602294fSDan Kimmel 	/* io_lsize != io_orig_size iff this is a raw write */
4125602294fSDan Kimmel 	uint64_t	io_lsize;
413fa9e4066Sahrens 
414fa9e4066Sahrens 	/* Stuff for the vdev stack */
415fa9e4066Sahrens 	vdev_t		*io_vd;
416fa9e4066Sahrens 	void		*io_vsd;
41722fe2c88SJonathan Adams 	const zio_vsd_ops_t *io_vsd_ops;
41822fe2c88SJonathan Adams 
419fa9e4066Sahrens 	uint64_t	io_offset;
420c55e05cbSMatthew Ahrens 	hrtime_t	io_timestamp;
4210f7643c7SGeorge Wilson 	hrtime_t	io_queued_timestamp;
42297e81309SPrakash Surya 	hrtime_t	io_target_timestamp;
42369962b56SMatthew Ahrens 	avl_node_t	io_queue_node;
424fe319232SJustin T. Gibbs 	avl_node_t	io_offset_node;
4250f7643c7SGeorge Wilson 	avl_node_t	io_alloc_node;
4268363e80aSGeorge Wilson 	zio_alloc_list_t 	io_alloc_list;
427fa9e4066Sahrens 
428fa9e4066Sahrens 	/* Internal pipeline state */
429b24ab676SJeff Bonwick 	enum zio_flag	io_flags;
430b24ab676SJeff Bonwick 	enum zio_stage	io_stage;
431b24ab676SJeff Bonwick 	enum zio_stage	io_pipeline;
432b24ab676SJeff Bonwick 	enum zio_flag	io_orig_flags;
433b24ab676SJeff Bonwick 	enum zio_stage	io_orig_stage;
434b24ab676SJeff Bonwick 	enum zio_stage	io_orig_pipeline;
4350f7643c7SGeorge Wilson 	enum zio_stage	io_pipeline_trace;
436e14bb325SJeff Bonwick 	int		io_error;
437e14bb325SJeff Bonwick 	int		io_child_error[ZIO_CHILD_TYPES];
438e14bb325SJeff Bonwick 	uint64_t	io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
439b24ab676SJeff Bonwick 	uint64_t	io_child_count;
44069962b56SMatthew Ahrens 	uint64_t	io_phys_children;
441b24ab676SJeff Bonwick 	uint64_t	io_parent_count;
442e14bb325SJeff Bonwick 	uint64_t	*io_stall;
443f5383399SBill Moore 	zio_t		*io_gang_leader;
444e14bb325SJeff Bonwick 	zio_gang_node_t	*io_gang_tree;
445e14bb325SJeff Bonwick 	void		*io_executor;
446fa9e4066Sahrens 	void		*io_waiter;
447fa9e4066Sahrens 	kmutex_t	io_lock;
448fa9e4066Sahrens 	kcondvar_t	io_cv;
449ea8dc4b6Seschrock 
450ea8dc4b6Seschrock 	/* FMA state */
45122fe2c88SJonathan Adams 	zio_cksum_report_t *io_cksum_report;
452ea8dc4b6Seschrock 	uint64_t	io_ena;
4535aeb9474SGarrett D'Amore 
4545aeb9474SGarrett D'Amore 	/* Taskq dispatching state */
4555aeb9474SGarrett D'Amore 	taskq_ent_t	io_tqent;
456fa9e4066Sahrens };
457fa9e4066Sahrens 
458*94c2d0ebSMatthew Ahrens extern int zio_bookmark_compare(const void *, const void *);
4590f7643c7SGeorge Wilson 
460a3f829aeSBill Moore extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
461b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
462fa9e4066Sahrens 
463fa9e4066Sahrens extern zio_t *zio_root(spa_t *spa,
464b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
465fa9e4066Sahrens 
466088f3894Sahrens extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, void *data,
4675602294fSDan Kimmel     uint64_t lsize, zio_done_func_t *done, void *private,
4687802d7bfSMatthew Ahrens     zio_priority_t priority, enum zio_flag flags, const zbookmark_phys_t *zb);
469fa9e4066Sahrens 
470e14bb325SJeff Bonwick extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
4715602294fSDan Kimmel     void *data, uint64_t size, uint64_t psize, const zio_prop_t *zp,
4728df0bcf0SPaul Dagnelie     zio_done_func_t *ready, zio_done_func_t *children_ready,
4738df0bcf0SPaul Dagnelie     zio_done_func_t *physdone, zio_done_func_t *done,
4748df0bcf0SPaul Dagnelie     void *private, zio_priority_t priority, enum zio_flag flags,
4758df0bcf0SPaul Dagnelie     const zbookmark_phys_t *zb);
476fa9e4066Sahrens 
477e14bb325SJeff Bonwick extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
478e14bb325SJeff Bonwick     void *data, uint64_t size, zio_done_func_t *done, void *private,
4797802d7bfSMatthew Ahrens     zio_priority_t priority, enum zio_flag flags, zbookmark_phys_t *zb);
480fa9e4066Sahrens 
48180901aeaSGeorge Wilson extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
48280901aeaSGeorge Wilson     boolean_t nopwrite);
48382c9918fSTim Haley 
484b24ab676SJeff Bonwick extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
485fa9e4066Sahrens 
486b24ab676SJeff Bonwick extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
487b24ab676SJeff Bonwick     const blkptr_t *bp,
488b24ab676SJeff Bonwick     zio_done_func_t *done, void *private, enum zio_flag flags);
489fa9e4066Sahrens 
490fa9e4066Sahrens extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
49169962b56SMatthew Ahrens     zio_done_func_t *done, void *private, enum zio_flag flags);
492fa9e4066Sahrens 
493fa9e4066Sahrens extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
494fa9e4066Sahrens     uint64_t size, void *data, int checksum,
49569962b56SMatthew Ahrens     zio_done_func_t *done, void *private, zio_priority_t priority,
49669962b56SMatthew Ahrens     enum zio_flag flags, boolean_t labels);
497fa9e4066Sahrens 
498fa9e4066Sahrens extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
499fa9e4066Sahrens     uint64_t size, void *data, int checksum,
50069962b56SMatthew Ahrens     zio_done_func_t *done, void *private, zio_priority_t priority,
50169962b56SMatthew Ahrens     enum zio_flag flags, boolean_t labels);
502fa9e4066Sahrens 
503b24ab676SJeff Bonwick extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
504b24ab676SJeff Bonwick     const blkptr_t *bp, enum zio_flag flags);
505b24ab676SJeff Bonwick 
506b24ab676SJeff Bonwick extern int zio_alloc_zil(spa_t *spa, uint64_t txg, blkptr_t *new_bp,
507b24ab676SJeff Bonwick     blkptr_t *old_bp, uint64_t size, boolean_t use_slog);
508b24ab676SJeff Bonwick extern void zio_free_zil(spa_t *spa, uint64_t txg, blkptr_t *bp);
50917f17c2dSbonwick extern void zio_flush(zio_t *zio, vdev_t *vd);
5106e1f5caaSNeil Perrin extern void zio_shrink(zio_t *zio, uint64_t size);
511fa9e4066Sahrens 
512fa9e4066Sahrens extern int zio_wait(zio_t *zio);
513fa9e4066Sahrens extern void zio_nowait(zio_t *zio);
514e05725b1Sbonwick extern void zio_execute(zio_t *zio);
515e05725b1Sbonwick extern void zio_interrupt(zio_t *zio);
51697e81309SPrakash Surya extern void zio_delay_init(zio_t *zio);
51797e81309SPrakash Surya extern void zio_delay_interrupt(zio_t *zio);
518e05725b1Sbonwick 
5190f7643c7SGeorge Wilson extern zio_t *zio_walk_parents(zio_t *cio, zio_link_t **);
5200f7643c7SGeorge Wilson extern zio_t *zio_walk_children(zio_t *pio, zio_link_t **);
521a3f829aeSBill Moore extern zio_t *zio_unique_parent(zio_t *cio);
522a3f829aeSBill Moore extern void zio_add_child(zio_t *pio, zio_t *cio);
523a3f829aeSBill Moore 
524fa9e4066Sahrens extern void *zio_buf_alloc(size_t size);
525fa9e4066Sahrens extern void zio_buf_free(void *buf, size_t size);
526ad23a2dbSjohansen extern void *zio_data_buf_alloc(size_t size);
527ad23a2dbSjohansen extern void zio_data_buf_free(void *buf, size_t size);
528fa9e4066Sahrens 
529dcbf3bd6SGeorge Wilson extern void zio_push_transform(zio_t *zio, void *data, uint64_t size,
530dcbf3bd6SGeorge Wilson     uint64_t bufsize, zio_transform_func_t *transform);
531dcbf3bd6SGeorge Wilson extern void zio_pop_transforms(zio_t *zio);
532dcbf3bd6SGeorge Wilson 
5330a4e9518Sgw extern void zio_resubmit_stage_async(void *);
534fa9e4066Sahrens 
535fa9e4066Sahrens extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
53669962b56SMatthew Ahrens     uint64_t offset, void *data, uint64_t size, int type,
53769962b56SMatthew Ahrens     zio_priority_t priority, enum zio_flag flags,
53869962b56SMatthew Ahrens     zio_done_func_t *done, void *private);
539fa9e4066Sahrens 
540e14bb325SJeff Bonwick extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
54169962b56SMatthew Ahrens     void *data, uint64_t size, int type, zio_priority_t priority,
542b24ab676SJeff Bonwick     enum zio_flag flags, zio_done_func_t *done, void *private);
543e14bb325SJeff Bonwick 
544fa9e4066Sahrens extern void zio_vdev_io_bypass(zio_t *zio);
545fa9e4066Sahrens extern void zio_vdev_io_reissue(zio_t *zio);
546fa9e4066Sahrens extern void zio_vdev_io_redone(zio_t *zio);
547fa9e4066Sahrens 
548fa9e4066Sahrens extern void zio_checksum_verified(zio_t *zio);
549e14bb325SJeff Bonwick extern int zio_worst_error(int e1, int e2);
550fa9e4066Sahrens 
551b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
552b24ab676SJeff Bonwick     enum zio_checksum parent);
553b24ab676SJeff Bonwick extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
554b24ab676SJeff Bonwick     enum zio_checksum child, enum zio_checksum parent);
555db1741f5SJustin T. Gibbs extern enum zio_compress zio_compress_select(spa_t *spa,
556db1741f5SJustin T. Gibbs     enum zio_compress child, enum zio_compress parent);
557fa9e4066Sahrens 
558e14bb325SJeff Bonwick extern void zio_suspend(spa_t *spa, zio_t *zio);
55954d692b7SGeorge Wilson extern int zio_resume(spa_t *spa);
560e14bb325SJeff Bonwick extern void zio_resume_wait(spa_t *spa);
561ea8dc4b6Seschrock 
562fa9e4066Sahrens /*
563fa9e4066Sahrens  * Initial setup and teardown.
564fa9e4066Sahrens  */
565fa9e4066Sahrens extern void zio_init(void);
566fa9e4066Sahrens extern void zio_fini(void);
567fa9e4066Sahrens 
568ea8dc4b6Seschrock /*
569ea8dc4b6Seschrock  * Fault injection
570ea8dc4b6Seschrock  */
571ea8dc4b6Seschrock struct zinject_record;
572ea8dc4b6Seschrock extern uint32_t zio_injection_enabled;
573ea8dc4b6Seschrock extern int zio_inject_fault(char *name, int flags, int *id,
574ea8dc4b6Seschrock     struct zinject_record *record);
575ea8dc4b6Seschrock extern int zio_inject_list_next(int *id, char *name, size_t buflen,
576ea8dc4b6Seschrock     struct zinject_record *record);
577ea8dc4b6Seschrock extern int zio_clear_fault(int id);
5781195e687SMark J Musante extern void zio_handle_panic_injection(spa_t *spa, char *tag, uint64_t type);
579ea8dc4b6Seschrock extern int zio_handle_fault_injection(zio_t *zio, int error);
5808956713aSEric Schrock extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
58121bf64a7Sgw extern int zio_handle_label_injection(zio_t *zio, int error);
582468c413aSTim Haley extern void zio_handle_ignored_writes(zio_t *zio);
58397e81309SPrakash Surya extern hrtime_t zio_handle_io_delay(zio_t *zio);
584ea8dc4b6Seschrock 
58522fe2c88SJonathan Adams /*
58622fe2c88SJonathan Adams  * Checksum ereport functions
58722fe2c88SJonathan Adams  */
58822fe2c88SJonathan Adams extern void zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd, struct zio *zio,
58922fe2c88SJonathan Adams     uint64_t offset, uint64_t length, void *arg, struct zio_bad_cksum *info);
59022fe2c88SJonathan Adams extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
59122fe2c88SJonathan Adams     const void *good_data, const void *bad_data, boolean_t drop_if_identical);
59222fe2c88SJonathan Adams 
59322fe2c88SJonathan Adams extern void zfs_ereport_send_interim_checksum(zio_cksum_report_t *report);
59422fe2c88SJonathan Adams extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
59522fe2c88SJonathan Adams 
59622fe2c88SJonathan Adams /* If we have the good data in hand, this function can be used */
59722fe2c88SJonathan Adams extern void zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
59822fe2c88SJonathan Adams     struct zio *zio, uint64_t offset, uint64_t length,
59922fe2c88SJonathan Adams     const void *good_data, const void *bad_data, struct zio_bad_cksum *info);
60022fe2c88SJonathan Adams 
601468c413aSTim Haley /* Called from spa_sync(), but primarily an injection handler */
602468c413aSTim Haley extern void spa_handle_ignored_writes(spa_t *spa);
603468c413aSTim Haley 
6047802d7bfSMatthew Ahrens /* zbookmark_phys functions */
605a2cdcdd2SPaul Dagnelie boolean_t zbookmark_subtree_completed(const struct dnode_phys *dnp,
606a2cdcdd2SPaul Dagnelie     const zbookmark_phys_t *subtree_root, const zbookmark_phys_t *last_block);
607a2cdcdd2SPaul Dagnelie int zbookmark_compare(uint16_t dbss1, uint8_t ibs1, uint16_t dbss2,
608a2cdcdd2SPaul Dagnelie     uint8_t ibs2, const zbookmark_phys_t *zb1, const zbookmark_phys_t *zb2);
609ad135b5dSChristopher Siden 
610fa9e4066Sahrens #ifdef	__cplusplus
611fa9e4066Sahrens }
612fa9e4066Sahrens #endif
613fa9e4066Sahrens 
614fa9e4066Sahrens #endif	/* _ZIO_H */
615