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