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 (c) 2012 by Delphix. All rights reserved.
30 #include <sys/zfs_context.h>
34 #include <sys/kstat.h>
35 #include <sys/fs/zfs.h>
36 #include <sys/zio_impl.h>
45 #define ZEC_MAGIC 0x210da7ab10c7a11ULL
47 typedef struct zio_eck {
48 uint64_t zec_magic; /* for validation, endianness */
49 zio_cksum_t zec_cksum; /* 256-bit checksum */
53 * Gang block headers are self-checksumming and contain an array
56 #define SPA_GANGBLOCKSIZE SPA_MINBLOCKSIZE
57 #define SPA_GBH_NBLKPTRS ((SPA_GANGBLOCKSIZE - \
58 sizeof (zio_eck_t)) / sizeof (blkptr_t))
59 #define SPA_GBH_FILLER ((SPA_GANGBLOCKSIZE - \
60 sizeof (zio_eck_t) - \
61 (SPA_GBH_NBLKPTRS * sizeof (blkptr_t))) /\
64 typedef struct zio_gbh {
65 blkptr_t zg_blkptr[SPA_GBH_NBLKPTRS];
66 uint64_t zg_filler[SPA_GBH_FILLER];
71 ZIO_CHECKSUM_INHERIT = 0,
75 ZIO_CHECKSUM_GANG_HEADER,
77 ZIO_CHECKSUM_FLETCHER_2,
78 ZIO_CHECKSUM_FLETCHER_4,
81 ZIO_CHECKSUM_FUNCTIONS
84 #define ZIO_CHECKSUM_ON_VALUE ZIO_CHECKSUM_FLETCHER_4
85 #define ZIO_CHECKSUM_DEFAULT ZIO_CHECKSUM_ON
87 #define ZIO_CHECKSUM_MASK 0xffULL
88 #define ZIO_CHECKSUM_VERIFY (1 << 8)
90 #define ZIO_DEDUPCHECKSUM ZIO_CHECKSUM_SHA256
91 #define ZIO_DEDUPDITTO_MIN 100
94 ZIO_COMPRESS_INHERIT = 0,
109 ZIO_COMPRESS_FUNCTIONS
112 #define ZIO_COMPRESS_ON_VALUE ZIO_COMPRESS_LZJB
113 #define ZIO_COMPRESS_DEFAULT ZIO_COMPRESS_OFF
115 #define BOOTFS_COMPRESS_VALID(compress) \
116 ((compress) == ZIO_COMPRESS_LZJB || \
117 ((compress) == ZIO_COMPRESS_ON && \
118 ZIO_COMPRESS_ON_VALUE == ZIO_COMPRESS_LZJB) || \
119 (compress) == ZIO_COMPRESS_OFF)
121 #define ZIO_FAILURE_MODE_WAIT 0
122 #define ZIO_FAILURE_MODE_CONTINUE 1
123 #define ZIO_FAILURE_MODE_PANIC 2
125 #define ZIO_PRIORITY_NOW (zio_priority_table[0])
126 #define ZIO_PRIORITY_SYNC_READ (zio_priority_table[1])
127 #define ZIO_PRIORITY_SYNC_WRITE (zio_priority_table[2])
128 #define ZIO_PRIORITY_LOG_WRITE (zio_priority_table[3])
129 #define ZIO_PRIORITY_CACHE_FILL (zio_priority_table[4])
130 #define ZIO_PRIORITY_AGG (zio_priority_table[5])
131 #define ZIO_PRIORITY_FREE (zio_priority_table[6])
132 #define ZIO_PRIORITY_ASYNC_WRITE (zio_priority_table[7])
133 #define ZIO_PRIORITY_ASYNC_READ (zio_priority_table[8])
134 #define ZIO_PRIORITY_RESILVER (zio_priority_table[9])
135 #define ZIO_PRIORITY_SCRUB (zio_priority_table[10])
136 #define ZIO_PRIORITY_DDT_PREFETCH (zio_priority_table[11])
137 #define ZIO_PRIORITY_TRIM (zio_priority_table[12])
138 #define ZIO_PRIORITY_TABLE_SIZE 13
140 #define ZIO_PIPELINE_CONTINUE 0x100
141 #define ZIO_PIPELINE_STOP 0x101
145 * Flags inherited by gang, ddt, and vdev children,
146 * and that must be equal for two zios to aggregate
148 ZIO_FLAG_DONT_AGGREGATE = 1 << 0,
149 ZIO_FLAG_IO_REPAIR = 1 << 1,
150 ZIO_FLAG_SELF_HEAL = 1 << 2,
151 ZIO_FLAG_RESILVER = 1 << 3,
152 ZIO_FLAG_SCRUB = 1 << 4,
153 ZIO_FLAG_SCAN_THREAD = 1 << 5,
155 #define ZIO_FLAG_AGG_INHERIT (ZIO_FLAG_CANFAIL - 1)
158 * Flags inherited by ddt, gang, and vdev children.
160 ZIO_FLAG_CANFAIL = 1 << 6, /* must be first for INHERIT */
161 ZIO_FLAG_SPECULATIVE = 1 << 7,
162 ZIO_FLAG_CONFIG_WRITER = 1 << 8,
163 ZIO_FLAG_DONT_RETRY = 1 << 9,
164 ZIO_FLAG_DONT_CACHE = 1 << 10,
165 ZIO_FLAG_NODATA = 1 << 11,
166 ZIO_FLAG_INDUCE_DAMAGE = 1 << 12,
168 #define ZIO_FLAG_DDT_INHERIT (ZIO_FLAG_IO_RETRY - 1)
169 #define ZIO_FLAG_GANG_INHERIT (ZIO_FLAG_IO_RETRY - 1)
172 * Flags inherited by vdev children.
174 ZIO_FLAG_IO_RETRY = 1 << 13, /* must be first for INHERIT */
175 ZIO_FLAG_PROBE = 1 << 14,
176 ZIO_FLAG_TRYHARD = 1 << 15,
177 ZIO_FLAG_OPTIONAL = 1 << 16,
179 #define ZIO_FLAG_VDEV_INHERIT (ZIO_FLAG_DONT_QUEUE - 1)
182 * Flags not inherited by any children.
184 ZIO_FLAG_DONT_QUEUE = 1 << 17, /* must be first for INHERIT */
185 ZIO_FLAG_DONT_PROPAGATE = 1 << 18,
186 ZIO_FLAG_IO_BYPASS = 1 << 19,
187 ZIO_FLAG_IO_REWRITE = 1 << 20,
188 ZIO_FLAG_RAW = 1 << 21,
189 ZIO_FLAG_GANG_CHILD = 1 << 22,
190 ZIO_FLAG_DDT_CHILD = 1 << 23,
191 ZIO_FLAG_GODFATHER = 1 << 24,
192 ZIO_FLAG_NOPWRITE = 1 << 25,
193 ZIO_FLAG_REEXECUTED = 1 << 26,
196 #define ZIO_FLAG_MUSTSUCCEED 0
198 #define ZIO_DDT_CHILD_FLAGS(zio) \
199 (((zio)->io_flags & ZIO_FLAG_DDT_INHERIT) | \
200 ZIO_FLAG_DDT_CHILD | ZIO_FLAG_CANFAIL)
202 #define ZIO_GANG_CHILD_FLAGS(zio) \
203 (((zio)->io_flags & ZIO_FLAG_GANG_INHERIT) | \
204 ZIO_FLAG_GANG_CHILD | ZIO_FLAG_CANFAIL)
206 #define ZIO_VDEV_CHILD_FLAGS(zio) \
207 (((zio)->io_flags & ZIO_FLAG_VDEV_INHERIT) | \
225 * We'll take the number 122 and 123 to indicate checksum errors and
226 * fragmentation. Those doesn't collide with any errno values as they
227 * are greater than ELAST.
232 typedef void zio_done_func_t(zio_t *zio);
234 extern uint8_t zio_priority_table[ZIO_PRIORITY_TABLE_SIZE];
235 extern char *zio_type_name[ZIO_TYPES];
238 * A bookmark is a four-tuple <objset, object, level, blkid> that uniquely
239 * identifies any block in the pool. By convention, the meta-objset (MOS)
240 * is objset 0, and the meta-dnode is object 0. This covers all blocks
241 * except root blocks and ZIL blocks, which are defined as follows:
243 * Root blocks (objset_phys_t) are object 0, level -1: <objset, 0, -1, 0>.
244 * ZIL blocks are bookmarked <objset, 0, -2, blkid == ZIL sequence number>.
245 * dmu_sync()ed ZIL data blocks are bookmarked <objset, object, -2, blkid>.
247 * Note: this structure is called a bookmark because its original purpose
248 * was to remember where to resume a pool-wide traverse.
250 * Note: this structure is passed between userland and the kernel.
251 * Therefore it must not change size or alignment between 32/64 bit
252 * compilation options.
254 typedef struct zbookmark {
261 #define SET_BOOKMARK(zb, objset, object, level, blkid) \
263 (zb)->zb_objset = objset; \
264 (zb)->zb_object = object; \
265 (zb)->zb_level = level; \
266 (zb)->zb_blkid = blkid; \
269 #define ZB_DESTROYED_OBJSET (-1ULL)
271 #define ZB_ROOT_OBJECT (0ULL)
272 #define ZB_ROOT_LEVEL (-1LL)
273 #define ZB_ROOT_BLKID (0ULL)
275 #define ZB_ZIL_OBJECT (0ULL)
276 #define ZB_ZIL_LEVEL (-2LL)
278 #define ZB_IS_ZERO(zb) \
279 ((zb)->zb_objset == 0 && (zb)->zb_object == 0 && \
280 (zb)->zb_level == 0 && (zb)->zb_blkid == 0)
281 #define ZB_IS_ROOT(zb) \
282 ((zb)->zb_object == ZB_ROOT_OBJECT && \
283 (zb)->zb_level == ZB_ROOT_LEVEL && \
284 (zb)->zb_blkid == ZB_ROOT_BLKID)
286 typedef struct zio_prop {
287 enum zio_checksum zp_checksum;
288 enum zio_compress zp_compress;
289 dmu_object_type_t zp_type;
293 boolean_t zp_dedup_verify;
294 boolean_t zp_nopwrite;
297 typedef struct zio_cksum_report zio_cksum_report_t;
299 typedef void zio_cksum_finish_f(zio_cksum_report_t *rep,
300 const void *good_data);
301 typedef void zio_cksum_free_f(void *cbdata, size_t size);
303 struct zio_bad_cksum; /* defined in zio_checksum.h */
306 struct zio_cksum_report {
307 struct zio_cksum_report *zcr_next;
308 nvlist_t *zcr_ereport;
309 nvlist_t *zcr_detector;
311 size_t zcr_cbinfo; /* passed to zcr_free() */
314 zio_cksum_finish_f *zcr_finish;
315 zio_cksum_free_f *zcr_free;
317 /* internal use only */
318 struct zio_bad_cksum *zcr_ckinfo; /* information from failure */
321 typedef void zio_vsd_cksum_report_f(zio_t *zio, zio_cksum_report_t *zcr,
324 zio_vsd_cksum_report_f zio_vsd_default_cksum_report;
326 typedef struct zio_vsd_ops {
327 zio_done_func_t *vsd_free;
328 zio_vsd_cksum_report_f *vsd_cksum_report;
331 typedef struct zio_gang_node {
332 zio_gbh_phys_t *gn_gbh;
333 struct zio_gang_node *gn_child[SPA_GBH_NBLKPTRS];
336 typedef zio_t *zio_gang_issue_func_t(zio_t *zio, blkptr_t *bp,
337 zio_gang_node_t *gn, void *data);
339 typedef void zio_transform_func_t(zio_t *zio, void *data, uint64_t size);
341 typedef struct zio_transform {
343 uint64_t zt_orig_size;
345 zio_transform_func_t *zt_transform;
346 struct zio_transform *zt_next;
349 typedef int zio_pipe_stage_t(zio_t *zio);
352 * The io_reexecute flags are distinct from io_flags because the child must
353 * be able to propagate them to the parent. The normal io_flags are local
354 * to the zio, not protected by any lock, and not modifiable by children;
355 * the reexecute flags are protected by io_lock, modifiable by children,
356 * and always propagated -- even when ZIO_FLAG_DONT_PROPAGATE is set.
358 #define ZIO_REEXECUTE_NOW 0x01
359 #define ZIO_REEXECUTE_SUSPEND 0x02
361 typedef struct zio_link {
364 list_node_t zl_parent_node;
365 list_node_t zl_child_node;
369 * Used for TRIM kstat.
371 typedef struct zio_trim_stats {
373 * Number of bytes successfully TRIMmed.
375 kstat_named_t zio_trim_bytes;
378 * Number of successful TRIM requests.
380 kstat_named_t zio_trim_success;
383 * Number of TRIM requests that failed because TRIM is not
386 kstat_named_t zio_trim_unsupported;
389 * Number of TRIM requests that failed for other reasons.
391 kstat_named_t zio_trim_failed;
394 extern zio_trim_stats_t zio_trim_stats;
396 #define ZIO_TRIM_STAT_INCR(stat, val) \
397 atomic_add_64(&zio_trim_stats.stat.value.ui64, (val));
398 #define ZIO_TRIM_STAT_BUMP(stat) \
399 ZIO_TRIM_STAT_INCR(stat, 1);
402 /* Core information about this I/O */
403 zbookmark_t io_bookmark;
406 enum zio_child io_child_type;
409 uint8_t io_reexecute;
410 uint8_t io_state[ZIO_WAIT_TYPES];
414 blkptr_t *io_bp_override;
416 list_t io_parent_list;
417 list_t io_child_list;
418 zio_link_t *io_walk_link;
420 zio_transform_t *io_transform_stack;
423 zio_done_func_t *io_ready;
424 zio_done_func_t *io_done;
426 int64_t io_prev_space_delta; /* DMU private */
429 /* Data represented by this I/O */
433 uint64_t io_orig_size;
435 /* Stuff for the vdev stack */
438 const zio_vsd_ops_t *io_vsd_ops;
441 uint64_t io_deadline;
442 avl_node_t io_offset_node;
443 avl_node_t io_deadline_node;
444 avl_tree_t *io_vdev_tree;
446 /* Internal pipeline state */
447 enum zio_flag io_flags;
448 enum zio_stage io_stage;
449 enum zio_stage io_pipeline;
450 enum zio_flag io_orig_flags;
451 enum zio_stage io_orig_stage;
452 enum zio_stage io_orig_pipeline;
454 int io_child_error[ZIO_CHILD_TYPES];
455 uint64_t io_children[ZIO_CHILD_TYPES][ZIO_WAIT_TYPES];
456 uint64_t io_child_count;
457 uint64_t io_parent_count;
459 zio_t *io_gang_leader;
460 zio_gang_node_t *io_gang_tree;
467 zio_cksum_report_t *io_cksum_report;
472 struct ostask io_task;
474 avl_node_t io_trim_node;
475 list_node_t io_trim_link;
478 extern zio_t *zio_null(zio_t *pio, spa_t *spa, vdev_t *vd,
479 zio_done_func_t *done, void *priv, enum zio_flag flags);
481 extern zio_t *zio_root(spa_t *spa,
482 zio_done_func_t *done, void *priv, enum zio_flag flags);
484 extern zio_t *zio_read(zio_t *pio, spa_t *spa, const blkptr_t *bp, void *data,
485 uint64_t size, zio_done_func_t *done, void *priv,
486 int priority, enum zio_flag flags, const zbookmark_t *zb);
488 extern zio_t *zio_write(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
489 void *data, uint64_t size, const zio_prop_t *zp,
490 zio_done_func_t *ready, zio_done_func_t *done, void *priv,
491 int priority, enum zio_flag flags, const zbookmark_t *zb);
493 extern zio_t *zio_rewrite(zio_t *pio, spa_t *spa, uint64_t txg, blkptr_t *bp,
494 void *data, uint64_t size, zio_done_func_t *done, void *priv,
495 int priority, enum zio_flag flags, zbookmark_t *zb);
497 extern void zio_write_override(zio_t *zio, blkptr_t *bp, int copies,
500 extern void zio_free(spa_t *spa, uint64_t txg, const blkptr_t *bp);
502 extern zio_t *zio_claim(zio_t *pio, spa_t *spa, uint64_t txg,
504 zio_done_func_t *done, void *priv, enum zio_flag flags);
506 extern zio_t *zio_ioctl(zio_t *pio, spa_t *spa, vdev_t *vd, int cmd,
507 uint64_t offset, uint64_t size, zio_done_func_t *done, void *priv,
508 int priority, enum zio_flag flags);
510 extern zio_t *zio_read_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
511 uint64_t size, void *data, int checksum,
512 zio_done_func_t *done, void *priv, int priority, enum zio_flag flags,
515 extern zio_t *zio_write_phys(zio_t *pio, vdev_t *vd, uint64_t offset,
516 uint64_t size, void *data, int checksum,
517 zio_done_func_t *done, void *priv, int priority, enum zio_flag flags,
520 extern zio_t *zio_free_sync(zio_t *pio, spa_t *spa, uint64_t txg,
521 const blkptr_t *bp, uint64_t size, enum zio_flag flags);
523 extern int zio_alloc_zil(spa_t *spa, uint64_t txg, blkptr_t *new_bp,
524 blkptr_t *old_bp, uint64_t size, boolean_t use_slog);
525 extern void zio_free_zil(spa_t *spa, uint64_t txg, blkptr_t *bp);
526 extern void zio_flush(zio_t *zio, vdev_t *vd);
527 extern zio_t *zio_trim(zio_t *zio, spa_t *spa, vdev_t *vd, uint64_t offset,
529 extern void zio_shrink(zio_t *zio, uint64_t size);
531 extern int zio_wait(zio_t *zio);
532 extern void zio_nowait(zio_t *zio);
533 extern void zio_execute(zio_t *zio);
534 extern void zio_interrupt(zio_t *zio);
536 extern zio_t *zio_walk_parents(zio_t *cio);
537 extern zio_t *zio_walk_children(zio_t *pio);
538 extern zio_t *zio_unique_parent(zio_t *cio);
539 extern void zio_add_child(zio_t *pio, zio_t *cio);
541 extern void *zio_buf_alloc(size_t size);
542 extern void zio_buf_free(void *buf, size_t size);
543 extern void *zio_data_buf_alloc(size_t size);
544 extern void zio_data_buf_free(void *buf, size_t size);
546 extern void zio_resubmit_stage_async(void *);
548 extern zio_t *zio_vdev_child_io(zio_t *zio, blkptr_t *bp, vdev_t *vd,
549 uint64_t offset, void *data, uint64_t size, int type, int priority,
550 enum zio_flag flags, zio_done_func_t *done, void *priv);
552 extern zio_t *zio_vdev_delegated_io(vdev_t *vd, uint64_t offset,
553 void *data, uint64_t size, int type, int priority,
554 enum zio_flag flags, zio_done_func_t *done, void *priv);
556 extern void zio_vdev_io_bypass(zio_t *zio);
557 extern void zio_vdev_io_reissue(zio_t *zio);
558 extern void zio_vdev_io_redone(zio_t *zio);
560 extern void zio_checksum_verified(zio_t *zio);
561 extern int zio_worst_error(int e1, int e2);
563 extern enum zio_checksum zio_checksum_select(enum zio_checksum child,
564 enum zio_checksum parent);
565 extern enum zio_checksum zio_checksum_dedup_select(spa_t *spa,
566 enum zio_checksum child, enum zio_checksum parent);
567 extern enum zio_compress zio_compress_select(enum zio_compress child,
568 enum zio_compress parent);
570 extern void zio_suspend(spa_t *spa, zio_t *zio);
571 extern int zio_resume(spa_t *spa);
572 extern void zio_resume_wait(spa_t *spa);
575 * Initial setup and teardown.
577 extern void zio_init(void);
578 extern void zio_fini(void);
583 struct zinject_record;
584 extern uint32_t zio_injection_enabled;
585 extern int zio_inject_fault(char *name, int flags, int *id,
586 struct zinject_record *record);
587 extern int zio_inject_list_next(int *id, char *name, size_t buflen,
588 struct zinject_record *record);
589 extern int zio_clear_fault(int id);
590 extern void zio_handle_panic_injection(spa_t *spa, char *tag, uint64_t type);
591 extern int zio_handle_fault_injection(zio_t *zio, int error);
592 extern int zio_handle_device_injection(vdev_t *vd, zio_t *zio, int error);
593 extern int zio_handle_label_injection(zio_t *zio, int error);
594 extern void zio_handle_ignored_writes(zio_t *zio);
597 * Checksum ereport functions
599 extern void zfs_ereport_start_checksum(spa_t *spa, vdev_t *vd, struct zio *zio,
600 uint64_t offset, uint64_t length, void *arg, struct zio_bad_cksum *info);
601 extern void zfs_ereport_finish_checksum(zio_cksum_report_t *report,
602 const void *good_data, const void *bad_data, boolean_t drop_if_identical);
604 extern void zfs_ereport_send_interim_checksum(zio_cksum_report_t *report);
605 extern void zfs_ereport_free_checksum(zio_cksum_report_t *report);
607 /* If we have the good data in hand, this function can be used */
608 extern void zfs_ereport_post_checksum(spa_t *spa, vdev_t *vd,
609 struct zio *zio, uint64_t offset, uint64_t length,
610 const void *good_data, const void *bad_data, struct zio_bad_cksum *info);
612 /* Called from spa_sync(), but primarily an injection handler */
613 extern void spa_handle_ignored_writes(spa_t *spa);
615 /* zbookmark functions */
616 boolean_t zbookmark_is_before(const struct dnode_phys *dnp,
617 const zbookmark_t *zb1, const zbookmark_t *zb2);