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.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2012, 2014 by Delphix. All rights reserved.
26 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
32 #include <sys/zfs_context.h>
36 #include <sys/kstat.h>
37 #include <sys/fs/zfs.h>
38 #include <sys/zio_impl.h>
47 #define ZEC_MAGIC 0x210da7ab10c7a11ULL
49 typedef struct zio_eck {
50 uint64_t zec_magic; /* for validation, endianness */
51 zio_cksum_t zec_cksum; /* 256-bit checksum */
55 * Gang block headers are self-checksumming and contain an array
58 #define SPA_GANGBLOCKSIZE SPA_MINBLOCKSIZE
59 #define SPA_GBH_NBLKPTRS ((SPA_GANGBLOCKSIZE - \
60 sizeof (zio_eck_t)) / sizeof (blkptr_t))
61 #define SPA_GBH_FILLER ((SPA_GANGBLOCKSIZE - \
62 sizeof (zio_eck_t) - \
63 (SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
66 typedef struct zio_gbh {
67 blkptr_t zg_blkptr[SPA_GBH_NBLKPTRS];
68 uint64_t zg_filler[SPA_GBH_FILLER];
73 ZIO_CHECKSUM_INHERIT = 0,
77 ZIO_CHECKSUM_GANG_HEADER,
79 ZIO_CHECKSUM_FLETCHER_2,
80 ZIO_CHECKSUM_FLETCHER_4,
83 ZIO_CHECKSUM_NOPARITY,
84 ZIO_CHECKSUM_FUNCTIONS
88 * The number of "legacy" compression functions which can be set on individual
91 #define ZIO_CHECKSUM_LEGACY_FUNCTIONS ZIO_CHECKSUM_ZILOG2
93 #define ZIO_CHECKSUM_ON_VALUE ZIO_CHECKSUM_FLETCHER_4
94 #define ZIO_CHECKSUM_DEFAULT ZIO_CHECKSUM_ON
96 #define ZIO_CHECKSUM_MASK 0xffULL
97 #define ZIO_CHECKSUM_VERIFY (1 << 8)
99 #define ZIO_DEDUPCHECKSUM ZIO_CHECKSUM_SHA256
100 #define ZIO_DEDUPDITTO_MIN 100
103 ZIO_COMPRESS_INHERIT = 0,
119 ZIO_COMPRESS_FUNCTIONS
123 * The number of "legacy" compression functions which can be set on individual
126 #define ZIO_COMPRESS_LEGACY_FUNCTIONS ZIO_COMPRESS_LZ4
128 /* N.B. when altering this value, also change BOOTFS_COMPRESS_VALID below */
129 #define ZIO_COMPRESS_ON_VALUE ZIO_COMPRESS_LZJB
130 #define ZIO_COMPRESS_DEFAULT ZIO_COMPRESS_OFF
132 #define BOOTFS_COMPRESS_VALID(compress) \
133 ((compress) == ZIO_COMPRESS_LZJB || \
134 (compress) == ZIO_COMPRESS_LZ4 || \
135 ((compress) == ZIO_COMPRESS_ON && \
136 ZIO_COMPRESS_ON_VALUE == ZIO_COMPRESS_LZJB) || \
137 (compress) == ZIO_COMPRESS_OFF)
139 #define ZIO_FAILURE_MODE_WAIT 0
140 #define ZIO_FAILURE_MODE_CONTINUE 1
141 #define ZIO_FAILURE_MODE_PANIC 2
143 typedef enum zio_priority {
144 ZIO_PRIORITY_SYNC_READ,
145 ZIO_PRIORITY_SYNC_WRITE, /* ZIL */
146 ZIO_PRIORITY_ASYNC_READ, /* prefetch */
147 ZIO_PRIORITY_ASYNC_WRITE, /* spa_sync() */
148 ZIO_PRIORITY_SCRUB, /* asynchronous scrub/resilver reads */
149 ZIO_PRIORITY_TRIM, /* free requests used for TRIM */
150 ZIO_PRIORITY_NUM_QUEUEABLE,
152 ZIO_PRIORITY_NOW /* non-queued I/Os (e.g. ioctl) */
155 #define ZIO_PIPELINE_CONTINUE 0x100
156 #define ZIO_PIPELINE_STOP 0x101
160 * Flags inherited by gang, ddt, and vdev children,
161 * and that must be equal for two zios to aggregate
163 ZIO_FLAG_DONT_AGGREGATE = 1 << 0,
164 ZIO_FLAG_IO_REPAIR = 1 << 1,
165 ZIO_FLAG_SELF_HEAL = 1 << 2,
166 ZIO_FLAG_RESILVER = 1 << 3,
167 ZIO_FLAG_SCRUB = 1 << 4,
168 ZIO_FLAG_SCAN_THREAD = 1 << 5,
169 ZIO_FLAG_PHYSICAL = 1 << 6,
171 #define ZIO_FLAG_AGG_INHERIT (ZIO_FLAG_CANFAIL - 1)
174 * Flags inherited by ddt, gang, and vdev children.
176 ZIO_FLAG_CANFAIL = 1 << 7, /* must be first for INHERIT */
177 ZIO_FLAG_SPECULATIVE = 1 << 8,
178 ZIO_FLAG_CONFIG_WRITER = 1 << 9,
179 ZIO_FLAG_DONT_RETRY = 1 << 10,
180 ZIO_FLAG_DONT_CACHE = 1 << 11,
181 ZIO_FLAG_NODATA = 1 << 12,
182 ZIO_FLAG_INDUCE_DAMAGE = 1 << 13,
184 #define ZIO_FLAG_DDT_INHERIT (ZIO_FLAG_IO_RETRY - 1)
185 #define ZIO_FLAG_GANG_INHERIT (ZIO_FLAG_IO_RETRY - 1)
188 * Flags inherited by vdev children.
190 ZIO_FLAG_IO_RETRY = 1 << 14, /* must be first for INHERIT */
191 ZIO_FLAG_PROBE = 1 << 15,
192 ZIO_FLAG_TRYHARD = 1 << 16,
193 ZIO_FLAG_OPTIONAL = 1 << 17,
195 #define ZIO_FLAG_VDEV_INHERIT (ZIO_FLAG_DONT_QUEUE - 1)
198 * Flags not inherited by any children.
200 ZIO_FLAG_DONT_QUEUE = 1 << 18, /* must be first for INHERIT */
201 ZIO_FLAG_DONT_PROPAGATE = 1 << 19,
202 ZIO_FLAG_IO_BYPASS = 1 << 20,
203 ZIO_FLAG_IO_REWRITE = 1 << 21,
204 ZIO_FLAG_RAW = 1 << 22,
205 ZIO_FLAG_GANG_CHILD = 1 << 23,
206 ZIO_FLAG_DDT_CHILD = 1 << 24,
207 ZIO_FLAG_GODFATHER = 1 << 25,
208 ZIO_FLAG_NOPWRITE = 1 << 26,
209 ZIO_FLAG_REEXECUTED = 1 << 27,
210 ZIO_FLAG_DELEGATED = 1 << 28,
213 #define ZIO_FLAG_MUSTSUCCEED 0
215 #define ZIO_DDT_CHILD_FLAGS(zio) \
216 (((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) | \
217 ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
219 #define ZIO_GANG_CHILD_FLAGS(zio) \
220 (((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) | \
221 ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
223 #define ZIO_VDEV_CHILD_FLAGS(zio) \
224 (((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) | \
242 * We'll take the number 122 and 123 to indicate checksum errors and
243 * fragmentation. Those doesn't collide with any errno values as they
244 * are greater than ELAST.
249 typedef void zio_done_func_t(zio_t *zio);
251 extern const char *zio_type_name[ZIO_TYPES];
254 * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
255 * identifies any block in the pool. By convention, the meta-objset (MOS)
256 * is objset 0, and the meta-dnode is object 0. This covers all blocks
257 * except root blocks and ZIL blocks, which are defined as follows:
259 * Root blocks (objset_phys_t) are object 0, level -1: <objset, 0, -1, 0>.
260 * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
261 * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
263 * Note: this structure is called a bookmark because its original purpose
264 * was to remember where to resume a pool-wide traverse.
266 * Note: this structure is passed between userland and the kernel, and is
267 * stored on disk (by virtue of being incorporated into other on-disk
268 * structures, e.g. dsl_scan_phys_t).
270 typedef struct zbookmark_phys {
277 #define SET_BOOKMARK(zb, objset, object, level, blkid) \
279 (zb)->zb_objset = objset; \
280 (zb)->zb_object = object; \
281 (zb)->zb_level = level; \
282 (zb)->zb_blkid = blkid; \
285 #define ZB_DESTROYED_OBJSET (-1ULL)
287 #define ZB_ROOT_OBJECT (0ULL)
288 #define ZB_ROOT_LEVEL (-1LL)
289 #define ZB_ROOT_BLKID (0ULL)
291 #define ZB_ZIL_OBJECT (0ULL)
292 #define ZB_ZIL_LEVEL (-2LL)
294 #define ZB_IS_ZERO(zb) \
295 ((zb)->zb_objset == 0 && (zb)->zb_object == 0 && \
296 (zb)->zb_level == 0 && (zb)->zb_blkid == 0)
297 #define ZB_IS_ROOT(zb) \
298 ((zb)->zb_object == ZB_ROOT_OBJECT && \
299 (zb)->zb_level == ZB_ROOT_LEVEL && \
300 (zb)->zb_blkid == ZB_ROOT_BLKID)
302 typedef struct zio_prop {
303 enum zio_checksum zp_checksum;
304 enum zio_compress zp_compress;
305 dmu_object_type_t zp_type;
309 boolean_t zp_dedup_verify;
310 boolean_t zp_nopwrite;
313 typedef struct zio_cksum_report zio_cksum_report_t;
315 typedef void zio_cksum_finish_f(zio_cksum_report_t *rep,
316 const void *good_data);
317 typedef void zio_cksum_free_f(void *cbdata, size_t size);
319 struct zio_bad_cksum; /* defined in zio_checksum.h */
322 struct zio_cksum_report {
323 struct zio_cksum_report *zcr_next;
324 nvlist_t *zcr_ereport;
325 nvlist_t *zcr_detector;
327 size_t zcr_cbinfo; /* passed to zcr_free() */
330 zio_cksum_finish_f *zcr_finish;
331 zio_cksum_free_f *zcr_free;
333 /* internal use only */
334 struct zio_bad_cksum *zcr_ckinfo; /* information from failure */
337 typedef void zio_vsd_cksum_report_f(zio_t *zio, zio_cksum_report_t *zcr,
340 zio_vsd_cksum_report_f zio_vsd_default_cksum_report;
342 typedef struct zio_vsd_ops {
343 zio_done_func_t *vsd_free;
344 zio_vsd_cksum_report_f *vsd_cksum_report;
347 typedef struct zio_gang_node {
348 zio_gbh_phys_t *gn_gbh;
349 struct zio_gang_node *gn_child[SPA_GBH_NBLKPTRS];
352 typedef zio_t *zio_gang_issue_func_t(zio_t *zio, blkptr_t *bp,
353 zio_gang_node_t *gn, void *data);
355 typedef void zio_transform_func_t(zio_t *zio, void *data, uint64_t size);
357 typedef struct zio_transform {
359 uint64_t zt_orig_size;
361 zio_transform_func_t *zt_transform;
362 struct zio_transform *zt_next;
365 typedef int zio_pipe_stage_t(zio_t *zio);
368 * The io_reexecute flags are distinct from io_flags because the child must
369 * be able to propagate them to the parent. The normal io_flags are local
370 * to the zio, not protected by any lock, and not modifiable by children;
371 * the reexecute flags are protected by io_lock, modifiable by children,
372 * and always propagated -- even when ZIO_FLAG_DONT_PROPAGATE is set.
374 #define ZIO_REEXECUTE_NOW 0x01
375 #define ZIO_REEXECUTE_SUSPEND 0x02
377 typedef struct zio_link {
380 list_node_t zl_parent_node;
381 list_node_t zl_child_node;
385 * Used for TRIM kstat.
387 typedef struct zio_trim_stats {
389 * Number of bytes successfully TRIMmed.
394 * Number of successful TRIM requests.
396 kstat_named_t success;
399 * Number of TRIM requests that failed because TRIM is not
402 kstat_named_t unsupported;
405 * Number of TRIM requests that failed for other reasons.
407 kstat_named_t failed;
410 extern zio_trim_stats_t zio_trim_stats;
412 #define ZIO_TRIM_STAT_INCR(stat, val) \
413 atomic_add_64(&zio_trim_stats.stat.value.ui64, (val));
414 #define ZIO_TRIM_STAT_BUMP(stat) \
415 ZIO_TRIM_STAT_INCR(stat, 1);
418 /* Core information about this I/O */
419 zbookmark_phys_t io_bookmark;
422 enum zio_child io_child_type;
424 zio_priority_t io_priority;
425 uint8_t io_reexecute;
426 uint8_t io_state[ZIO_WAIT_TYPES];
430 blkptr_t *io_bp_override;
432 list_t io_parent_list;
433 list_t io_child_list;
434 zio_link_t *io_walk_link;
436 zio_transform_t *io_transform_stack;
439 zio_done_func_t *io_ready;
440 zio_done_func_t *io_physdone;
441 zio_done_func_t *io_done;
443 int64_t io_prev_space_delta; /* DMU private */
446 /* Data represented by this I/O */
450 uint64_t io_orig_size;
452 /* Stuff for the vdev stack */
455 const zio_vsd_ops_t *io_vsd_ops;
458 hrtime_t io_timestamp;
459 avl_node_t io_queue_node;
461 /* Internal pipeline state */
462 enum zio_flag io_flags;
463 enum zio_stage io_stage;
464 enum zio_stage io_pipeline;
465 enum zio_flag io_orig_flags;
466 enum zio_stage io_orig_stage;
467 enum zio_stage io_orig_pipeline;
469 int io_child_error[ZIO_CHILD_TYPES];
470 uint64_t io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
471 uint64_t io_child_count;
472 uint64_t io_phys_children;
473 uint64_t io_parent_count;
475 zio_t *io_gang_leader;
476 zio_gang_node_t *io_gang_tree;
483 zio_cksum_report_t *io_cksum_report;
486 /* Taskq dispatching state */
487 taskq_ent_t io_tqent;
489 avl_node_t io_trim_node;
490 list_node_t io_trim_link;
493 extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
494 zio_done_func_t *done, void *priv, enum zio_flag flags);
496 extern zio_t *zio_root(spa_t *spa,
497 zio_done_func_t *done, void *priv, enum zio_flag flags);
499 extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, void *data,
500 uint64_t size, zio_done_func_t *done, void *priv,
501 zio_priority_t priority, enum zio_flag flags, const zbookmark_phys_t *zb);
503 extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
504 void *data, uint64_t size, const zio_prop_t *zp,
505 zio_done_func_t *ready, zio_done_func_t *physdone, zio_done_func_t *done,
507 zio_priority_t priority, enum zio_flag flags, const zbookmark_phys_t *zb);
509 extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
510 void *data, uint64_t size, zio_done_func_t *done, void *priv,
511 zio_priority_t priority, enum zio_flag flags, zbookmark_phys_t *zb);
513 extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
516 extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
518 extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
520 zio_done_func_t *done, void *priv, enum zio_flag flags);
522 extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
523 uint64_t offset, uint64_t size, zio_done_func_t *done, void *priv,
524 zio_priority_t priority, enum zio_flag flags);
526 extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
527 uint64_t size, void *data, int checksum,
528 zio_done_func_t *done, void *priv, zio_priority_t priority,
529 enum zio_flag flags, boolean_t labels);
531 extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
532 uint64_t size, void *data, int checksum,
533 zio_done_func_t *done, void *priv, zio_priority_t priority,
534 enum zio_flag flags, boolean_t labels);
536 extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
537 const blkptr_t *bp, uint64_t size, enum zio_flag flags);
539 extern int zio_alloc_zil(spa_t *spa, uint64_t txg, blkptr_t *new_bp,
540 blkptr_t *old_bp, uint64_t size, boolean_t use_slog);
541 extern void zio_free_zil(spa_t *spa, uint64_t txg, blkptr_t *bp);
542 extern void zio_flush(zio_t *zio, vdev_t *vd);
543 extern zio_t *zio_trim(zio_t *zio, spa_t *spa, vdev_t *vd, uint64_t offset,
545 extern void zio_shrink(zio_t *zio, uint64_t size);
547 extern int zio_wait(zio_t *zio);
548 extern void zio_nowait(zio_t *zio);
549 extern void zio_execute(zio_t *zio);
550 extern void zio_interrupt(zio_t *zio);
552 extern zio_t *zio_walk_parents(zio_t *cio);
553 extern zio_t *zio_walk_children(zio_t *pio);
554 extern zio_t *zio_unique_parent(zio_t *cio);
555 extern void zio_add_child(zio_t *pio, zio_t *cio);
557 extern void *zio_buf_alloc(size_t size);
558 extern void zio_buf_free(void *buf, size_t size);
559 extern void *zio_data_buf_alloc(size_t size);
560 extern void zio_data_buf_free(void *buf, size_t size);
562 extern void zio_resubmit_stage_async(void *);
564 extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
565 uint64_t offset, void *data, uint64_t size, int type,
566 zio_priority_t priority, enum zio_flag flags,
567 zio_done_func_t *done, void *priv);
569 extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
570 void *data, uint64_t size, int type, zio_priority_t priority,
571 enum zio_flag flags, zio_done_func_t *done, void *priv);
573 extern void zio_vdev_io_bypass(zio_t *zio);
574 extern void zio_vdev_io_reissue(zio_t *zio);
575 extern void zio_vdev_io_redone(zio_t *zio);
577 extern void zio_checksum_verified(zio_t *zio);
578 extern int zio_worst_error(int e1, int e2);
580 extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
581 enum zio_checksum parent);
582 extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
583 enum zio_checksum child, enum zio_checksum parent);
584 extern enum zio_compress zio_compress_select(enum zio_compress child,
585 enum zio_compress parent);
587 extern void zio_suspend(spa_t *spa, zio_t *zio);
588 extern int zio_resume(spa_t *spa);
589 extern void zio_resume_wait(spa_t *spa);
592 * Initial setup and teardown.
594 extern void zio_init(void);
595 extern void zio_fini(void);
600 struct zinject_record;
601 extern uint32_t zio_injection_enabled;
602 extern int zio_inject_fault(char *name, int flags, int *id,
603 struct zinject_record *record);
604 extern int zio_inject_list_next(int *id, char *name, size_t buflen,
605 struct zinject_record *record);
606 extern int zio_clear_fault(int id);
607 extern void zio_handle_panic_injection(spa_t *spa, char *tag, uint64_t type);
608 extern int zio_handle_fault_injection(zio_t *zio, int error);
609 extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
610 extern int zio_handle_label_injection(zio_t *zio, int error);
611 extern void zio_handle_ignored_writes(zio_t *zio);
612 extern uint64_t zio_handle_io_delay(zio_t *zio);
615 * Checksum ereport functions
617 extern void zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd, struct zio *zio,
618 uint64_t offset, uint64_t length, void *arg, struct zio_bad_cksum *info);
619 extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
620 const void *good_data, const void *bad_data, boolean_t drop_if_identical);
622 extern void zfs_ereport_send_interim_checksum(zio_cksum_report_t *report);
623 extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
625 /* If we have the good data in hand, this function can be used */
626 extern void zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
627 struct zio *zio, uint64_t offset, uint64_t length,
628 const void *good_data, const void *bad_data, struct zio_bad_cksum *info);
630 /* Called from spa_sync(), but primarily an injection handler */
631 extern void spa_handle_ignored_writes(spa_t *spa);
633 /* zbookmark_phys functions */
634 boolean_t zbookmark_is_before(const struct dnode_phys *dnp,
635 const zbookmark_phys_t *zb1, const zbookmark_phys_t *zb2);