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 9 * or https://opensource.org/licenses/CDDL-1.0. 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 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 /* 27 * Copyright (c) 2012, 2015 by Delphix. All rights reserved. 28 */ 29 30 #ifndef _ZIO_IMPL_H 31 #define _ZIO_IMPL_H 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 /* 38 * XXX -- Describe ZFS I/O pipeline here. Fill in as needed. 39 * 40 * The ZFS I/O pipeline is comprised of various stages which are defined 41 * in the zio_stage enum below. The individual stages are used to construct 42 * these basic I/O operations: Read, Write, Free, Claim, and Ioctl. 43 * 44 * I/O operations: (XXX - provide detail for each of the operations) 45 * 46 * Read: 47 * Write: 48 * Free: 49 * Claim: 50 * Ioctl: 51 * 52 * Although the most common pipeline are used by the basic I/O operations 53 * above, there are some helper pipelines (one could consider them 54 * sub-pipelines) which are used internally by the ZIO module and are 55 * explained below: 56 * 57 * Interlock Pipeline: 58 * The interlock pipeline is the most basic pipeline and is used by all 59 * of the I/O operations. The interlock pipeline does not perform any I/O 60 * and is used to coordinate the dependencies between I/Os that are being 61 * issued (i.e. the parent/child relationship). 62 * 63 * Vdev child Pipeline: 64 * The vdev child pipeline is responsible for performing the physical I/O. 65 * It is in this pipeline where the I/O are queued and possibly cached. 66 * 67 * In addition to performing I/O, the pipeline is also responsible for 68 * data transformations. The transformations performed are based on the 69 * specific properties that user may have selected and modify the 70 * behavior of the pipeline. Examples of supported transformations are 71 * compression, dedup, and nop writes. Transformations will either modify 72 * the data or the pipeline. This list below further describes each of 73 * the supported transformations: 74 * 75 * Compression: 76 * ZFS supports five different flavors of compression -- gzip, lzjb, lz4, zle, 77 * and zstd. Compression occurs as part of the write pipeline and is 78 * performed in the ZIO_STAGE_WRITE_BP_INIT stage. 79 * 80 * Block cloning: 81 * The block cloning functionality introduces ZIO_STAGE_BRT_FREE stage which 82 * is called during a free pipeline. If the block is referenced in the 83 * Block Cloning Table (BRT) we will just decrease its reference counter 84 * instead of actually freeing the block. 85 * 86 * Dedup: 87 * Dedup reads are handled by the ZIO_STAGE_DDT_READ_START and 88 * ZIO_STAGE_DDT_READ_DONE stages. These stages are added to an existing 89 * read pipeline if the dedup bit is set on the block pointer. 90 * Writing a dedup block is performed by the ZIO_STAGE_DDT_WRITE stage 91 * and added to a write pipeline if a user has enabled dedup on that 92 * particular dataset. 93 * 94 * NOP Write: 95 * The NOP write feature is performed by the ZIO_STAGE_NOP_WRITE stage 96 * and is added to an existing write pipeline if a cryptographically 97 * secure checksum (i.e. SHA256) is enabled and compression is turned on. 98 * The NOP write stage will compare the checksums of the current data 99 * on-disk (level-0 blocks only) and the data that is currently being written. 100 * If the checksum values are identical then the pipeline is converted to 101 * an interlock pipeline skipping block allocation and bypassing the 102 * physical I/O. The nop write feature can handle writes in either 103 * syncing or open context (i.e. zil writes) and as a result is mutually 104 * exclusive with dedup. 105 * 106 * Encryption: 107 * Encryption and authentication is handled by the ZIO_STAGE_ENCRYPT stage. 108 * This stage determines how the encryption metadata is stored in the bp. 109 * Decryption and MAC verification is performed during zio_decrypt() as a 110 * transform callback. Encryption is mutually exclusive with nopwrite, because 111 * blocks with the same plaintext will be encrypted with different salts and 112 * IV's (if dedup is off), and therefore have different ciphertexts. For dedup 113 * blocks we deterministically generate the IV and salt by performing an HMAC 114 * of the plaintext, which is computationally expensive, but allows us to keep 115 * support for encrypted dedup. See the block comment in zio_crypt.c for 116 * details. 117 */ 118 119 /* 120 * zio pipeline stage definitions 121 */ 122 enum zio_stage { 123 ZIO_STAGE_OPEN = 1 << 0, /* RWFCI */ 124 125 ZIO_STAGE_READ_BP_INIT = 1 << 1, /* R---- */ 126 ZIO_STAGE_WRITE_BP_INIT = 1 << 2, /* -W--- */ 127 ZIO_STAGE_FREE_BP_INIT = 1 << 3, /* --F-- */ 128 ZIO_STAGE_ISSUE_ASYNC = 1 << 4, /* RWF-- */ 129 ZIO_STAGE_WRITE_COMPRESS = 1 << 5, /* -W--- */ 130 131 ZIO_STAGE_ENCRYPT = 1 << 6, /* -W--- */ 132 ZIO_STAGE_CHECKSUM_GENERATE = 1 << 7, /* -W--- */ 133 134 ZIO_STAGE_NOP_WRITE = 1 << 8, /* -W--- */ 135 136 ZIO_STAGE_BRT_FREE = 1 << 9, /* --F-- */ 137 138 ZIO_STAGE_DDT_READ_START = 1 << 10, /* R---- */ 139 ZIO_STAGE_DDT_READ_DONE = 1 << 11, /* R---- */ 140 ZIO_STAGE_DDT_WRITE = 1 << 12, /* -W--- */ 141 ZIO_STAGE_DDT_FREE = 1 << 13, /* --F-- */ 142 143 ZIO_STAGE_GANG_ASSEMBLE = 1 << 14, /* RWFC- */ 144 ZIO_STAGE_GANG_ISSUE = 1 << 15, /* RWFC- */ 145 146 ZIO_STAGE_DVA_THROTTLE = 1 << 16, /* -W--- */ 147 ZIO_STAGE_DVA_ALLOCATE = 1 << 17, /* -W--- */ 148 ZIO_STAGE_DVA_FREE = 1 << 18, /* --F-- */ 149 ZIO_STAGE_DVA_CLAIM = 1 << 19, /* ---C- */ 150 151 ZIO_STAGE_READY = 1 << 20, /* RWFCI */ 152 153 ZIO_STAGE_VDEV_IO_START = 1 << 21, /* RW--I */ 154 ZIO_STAGE_VDEV_IO_DONE = 1 << 22, /* RW--I */ 155 ZIO_STAGE_VDEV_IO_ASSESS = 1 << 23, /* RW--I */ 156 157 ZIO_STAGE_CHECKSUM_VERIFY = 1 << 24, /* R---- */ 158 159 ZIO_STAGE_DONE = 1 << 25 /* RWFCI */ 160 }; 161 162 #define ZIO_ROOT_PIPELINE \ 163 ZIO_STAGE_DONE 164 165 #define ZIO_INTERLOCK_STAGES \ 166 (ZIO_STAGE_READY | \ 167 ZIO_STAGE_DONE) 168 169 #define ZIO_INTERLOCK_PIPELINE \ 170 ZIO_INTERLOCK_STAGES 171 172 #define ZIO_VDEV_IO_STAGES \ 173 (ZIO_STAGE_VDEV_IO_START | \ 174 ZIO_STAGE_VDEV_IO_DONE | \ 175 ZIO_STAGE_VDEV_IO_ASSESS) 176 177 #define ZIO_VDEV_CHILD_PIPELINE \ 178 (ZIO_VDEV_IO_STAGES | \ 179 ZIO_STAGE_DONE) 180 181 #define ZIO_READ_COMMON_STAGES \ 182 (ZIO_INTERLOCK_STAGES | \ 183 ZIO_VDEV_IO_STAGES | \ 184 ZIO_STAGE_CHECKSUM_VERIFY) 185 186 #define ZIO_READ_PHYS_PIPELINE \ 187 ZIO_READ_COMMON_STAGES 188 189 #define ZIO_READ_PIPELINE \ 190 (ZIO_READ_COMMON_STAGES | \ 191 ZIO_STAGE_READ_BP_INIT) 192 193 #define ZIO_DDT_CHILD_READ_PIPELINE \ 194 ZIO_READ_COMMON_STAGES 195 196 #define ZIO_DDT_READ_PIPELINE \ 197 (ZIO_INTERLOCK_STAGES | \ 198 ZIO_STAGE_READ_BP_INIT | \ 199 ZIO_STAGE_DDT_READ_START | \ 200 ZIO_STAGE_DDT_READ_DONE) 201 202 #define ZIO_WRITE_COMMON_STAGES \ 203 (ZIO_INTERLOCK_STAGES | \ 204 ZIO_VDEV_IO_STAGES | \ 205 ZIO_STAGE_ISSUE_ASYNC | \ 206 ZIO_STAGE_CHECKSUM_GENERATE) 207 208 #define ZIO_WRITE_PHYS_PIPELINE \ 209 ZIO_WRITE_COMMON_STAGES 210 211 #define ZIO_REWRITE_PIPELINE \ 212 (ZIO_WRITE_COMMON_STAGES | \ 213 ZIO_STAGE_WRITE_COMPRESS | \ 214 ZIO_STAGE_ENCRYPT | \ 215 ZIO_STAGE_WRITE_BP_INIT) 216 217 #define ZIO_WRITE_PIPELINE \ 218 (ZIO_WRITE_COMMON_STAGES | \ 219 ZIO_STAGE_WRITE_BP_INIT | \ 220 ZIO_STAGE_WRITE_COMPRESS | \ 221 ZIO_STAGE_ENCRYPT | \ 222 ZIO_STAGE_DVA_THROTTLE | \ 223 ZIO_STAGE_DVA_ALLOCATE) 224 225 #define ZIO_DDT_CHILD_WRITE_PIPELINE \ 226 (ZIO_INTERLOCK_STAGES | \ 227 ZIO_VDEV_IO_STAGES | \ 228 ZIO_STAGE_DVA_THROTTLE | \ 229 ZIO_STAGE_DVA_ALLOCATE) 230 231 #define ZIO_DDT_WRITE_PIPELINE \ 232 (ZIO_INTERLOCK_STAGES | \ 233 ZIO_STAGE_WRITE_BP_INIT | \ 234 ZIO_STAGE_ISSUE_ASYNC | \ 235 ZIO_STAGE_WRITE_COMPRESS | \ 236 ZIO_STAGE_ENCRYPT | \ 237 ZIO_STAGE_CHECKSUM_GENERATE | \ 238 ZIO_STAGE_DDT_WRITE) 239 240 #define ZIO_GANG_STAGES \ 241 (ZIO_STAGE_GANG_ASSEMBLE | \ 242 ZIO_STAGE_GANG_ISSUE) 243 244 #define ZIO_FREE_PIPELINE \ 245 (ZIO_INTERLOCK_STAGES | \ 246 ZIO_STAGE_FREE_BP_INIT | \ 247 ZIO_STAGE_BRT_FREE | \ 248 ZIO_STAGE_DVA_FREE) 249 250 #define ZIO_DDT_FREE_PIPELINE \ 251 (ZIO_INTERLOCK_STAGES | \ 252 ZIO_STAGE_FREE_BP_INIT | \ 253 ZIO_STAGE_ISSUE_ASYNC | \ 254 ZIO_STAGE_DDT_FREE) 255 256 #define ZIO_CLAIM_PIPELINE \ 257 (ZIO_INTERLOCK_STAGES | \ 258 ZIO_STAGE_DVA_CLAIM) 259 260 #define ZIO_IOCTL_PIPELINE \ 261 (ZIO_INTERLOCK_STAGES | \ 262 ZIO_STAGE_VDEV_IO_START | \ 263 ZIO_STAGE_VDEV_IO_ASSESS) 264 265 #define ZIO_TRIM_PIPELINE \ 266 (ZIO_INTERLOCK_STAGES | \ 267 ZIO_STAGE_ISSUE_ASYNC | \ 268 ZIO_VDEV_IO_STAGES) 269 270 #define ZIO_BLOCKING_STAGES \ 271 (ZIO_STAGE_DVA_ALLOCATE | \ 272 ZIO_STAGE_DVA_CLAIM | \ 273 ZIO_STAGE_VDEV_IO_START) 274 275 extern void zio_inject_init(void); 276 extern void zio_inject_fini(void); 277 278 #ifdef __cplusplus 279 } 280 #endif 281 282 #endif /* _ZIO_IMPL_H */ 283