]>
Commit | Line | Data |
---|---|---|
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 | /* | |
428870ff | 22 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
a6255b7f | 23 | * Copyright (c) 2013, 2016 by Delphix. All rights reserved. |
41425f79 | 24 | * Copyright 2013 Saso Kiselkov. All rights reserved. |
34dc7c2f BB |
25 | */ |
26 | ||
34dc7c2f BB |
27 | #include <sys/zfs_context.h> |
28 | #include <sys/spa.h> | |
3c67d83a | 29 | #include <sys/spa_impl.h> |
34dc7c2f BB |
30 | #include <sys/zio.h> |
31 | #include <sys/zio_checksum.h> | |
428870ff | 32 | #include <sys/zil.h> |
a6255b7f | 33 | #include <sys/abd.h> |
428870ff | 34 | #include <zfs_fletcher.h> |
34dc7c2f BB |
35 | |
36 | /* | |
37 | * Checksum vectors. | |
38 | * | |
39 | * In the SPA, everything is checksummed. We support checksum vectors | |
40 | * for three distinct reasons: | |
41 | * | |
42 | * 1. Different kinds of data need different levels of protection. | |
43 | * For SPA metadata, we always want a very strong checksum. | |
44 | * For user data, we let users make the trade-off between speed | |
45 | * and checksum strength. | |
46 | * | |
47 | * 2. Cryptographic hash and MAC algorithms are an area of active research. | |
48 | * It is likely that in future hash functions will be at least as strong | |
49 | * as current best-of-breed, and may be substantially faster as well. | |
50 | * We want the ability to take advantage of these new hashes as soon as | |
51 | * they become available. | |
52 | * | |
53 | * 3. If someone develops hardware that can compute a strong hash quickly, | |
54 | * we want the ability to take advantage of that hardware. | |
55 | * | |
56 | * Of course, we don't want a checksum upgrade to invalidate existing | |
428870ff BB |
57 | * data, so we store the checksum *function* in eight bits of the bp. |
58 | * This gives us room for up to 256 different checksum functions. | |
34dc7c2f BB |
59 | * |
60 | * When writing a block, we always checksum it with the latest-and-greatest | |
61 | * checksum function of the appropriate strength. When reading a block, | |
62 | * we compare the expected checksum against the actual checksum, which we | |
428870ff | 63 | * compute via the checksum function specified by BP_GET_CHECKSUM(bp). |
3c67d83a TH |
64 | * |
65 | * SALTED CHECKSUMS | |
66 | * | |
67 | * To enable the use of less secure hash algorithms with dedup, we | |
68 | * introduce the notion of salted checksums (MACs, really). A salted | |
69 | * checksum is fed both a random 256-bit value (the salt) and the data | |
70 | * to be checksummed. This salt is kept secret (stored on the pool, but | |
71 | * never shown to the user). Thus even if an attacker knew of collision | |
72 | * weaknesses in the hash algorithm, they won't be able to mount a known | |
73 | * plaintext attack on the DDT, since the actual hash value cannot be | |
74 | * known ahead of time. How the salt is used is algorithm-specific | |
75 | * (some might simply prefix it to the data block, others might need to | |
76 | * utilize a full-blown HMAC). On disk the salt is stored in a ZAP | |
77 | * object in the MOS (DMU_POOL_CHECKSUM_SALT). | |
78 | * | |
79 | * CONTEXT TEMPLATES | |
80 | * | |
81 | * Some hashing algorithms need to perform a substantial amount of | |
82 | * initialization work (e.g. salted checksums above may need to pre-hash | |
83 | * the salt) before being able to process data. Performing this | |
84 | * redundant work for each block would be wasteful, so we instead allow | |
85 | * a checksum algorithm to do the work once (the first time it's used) | |
86 | * and then keep this pre-initialized context as a template inside the | |
87 | * spa_t (spa_cksum_tmpls). If the zio_checksum_info_t contains | |
88 | * non-NULL ci_tmpl_init and ci_tmpl_free callbacks, they are used to | |
89 | * construct and destruct the pre-initialized checksum context. The | |
90 | * pre-initialized context is then reused during each checksum | |
91 | * invocation and passed to the checksum function. | |
34dc7c2f BB |
92 | */ |
93 | ||
34dc7c2f | 94 | static void |
a6255b7f | 95 | abd_checksum_off(abd_t *abd, uint64_t size, |
4ea3f864 | 96 | const void *ctx_template, zio_cksum_t *zcp) |
34dc7c2f | 97 | { |
14e4e3cb | 98 | (void) abd, (void) size, (void) ctx_template; |
34dc7c2f BB |
99 | ZIO_SET_CHECKSUM(zcp, 0, 0, 0, 0); |
100 | } | |
101 | ||
65c7cc49 | 102 | static void |
a6255b7f DQ |
103 | abd_fletcher_2_native(abd_t *abd, uint64_t size, |
104 | const void *ctx_template, zio_cksum_t *zcp) | |
105 | { | |
14e4e3cb | 106 | (void) ctx_template; |
a6255b7f DQ |
107 | fletcher_init(zcp); |
108 | (void) abd_iterate_func(abd, 0, size, | |
109 | fletcher_2_incremental_native, zcp); | |
110 | } | |
111 | ||
65c7cc49 | 112 | static void |
a6255b7f DQ |
113 | abd_fletcher_2_byteswap(abd_t *abd, uint64_t size, |
114 | const void *ctx_template, zio_cksum_t *zcp) | |
115 | { | |
14e4e3cb | 116 | (void) ctx_template; |
a6255b7f DQ |
117 | fletcher_init(zcp); |
118 | (void) abd_iterate_func(abd, 0, size, | |
119 | fletcher_2_incremental_byteswap, zcp); | |
120 | } | |
121 | ||
2fe36b0b DQ |
122 | static inline void |
123 | abd_fletcher_4_impl(abd_t *abd, uint64_t size, zio_abd_checksum_data_t *acdp) | |
124 | { | |
125 | fletcher_4_abd_ops.acf_init(acdp); | |
126 | abd_iterate_func(abd, 0, size, fletcher_4_abd_ops.acf_iter, acdp); | |
127 | fletcher_4_abd_ops.acf_fini(acdp); | |
128 | } | |
129 | ||
a6255b7f DQ |
130 | void |
131 | abd_fletcher_4_native(abd_t *abd, uint64_t size, | |
132 | const void *ctx_template, zio_cksum_t *zcp) | |
133 | { | |
14e4e3cb | 134 | (void) ctx_template; |
2fe36b0b DQ |
135 | fletcher_4_ctx_t ctx; |
136 | ||
137 | zio_abd_checksum_data_t acd = { | |
138 | .acd_byteorder = ZIO_CHECKSUM_NATIVE, | |
139 | .acd_zcp = zcp, | |
140 | .acd_ctx = &ctx | |
141 | }; | |
142 | ||
143 | abd_fletcher_4_impl(abd, size, &acd); | |
144 | ||
a6255b7f DQ |
145 | } |
146 | ||
a6255b7f DQ |
147 | void |
148 | abd_fletcher_4_byteswap(abd_t *abd, uint64_t size, | |
149 | const void *ctx_template, zio_cksum_t *zcp) | |
150 | { | |
14e4e3cb | 151 | (void) ctx_template; |
2fe36b0b DQ |
152 | fletcher_4_ctx_t ctx; |
153 | ||
154 | zio_abd_checksum_data_t acd = { | |
155 | .acd_byteorder = ZIO_CHECKSUM_BYTESWAP, | |
156 | .acd_zcp = zcp, | |
157 | .acd_ctx = &ctx | |
158 | }; | |
159 | ||
160 | abd_fletcher_4_impl(abd, size, &acd); | |
a6255b7f DQ |
161 | } |
162 | ||
a2d5643f | 163 | zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS] = { |
3c67d83a TH |
164 | {{NULL, NULL}, NULL, NULL, 0, "inherit"}, |
165 | {{NULL, NULL}, NULL, NULL, 0, "on"}, | |
a6255b7f | 166 | {{abd_checksum_off, abd_checksum_off}, |
3c67d83a | 167 | NULL, NULL, 0, "off"}, |
4c5fec01 | 168 | {{abd_checksum_sha256, abd_checksum_sha256}, |
3c67d83a TH |
169 | NULL, NULL, ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_EMBEDDED, |
170 | "label"}, | |
4c5fec01 | 171 | {{abd_checksum_sha256, abd_checksum_sha256}, |
3c67d83a TH |
172 | NULL, NULL, ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_EMBEDDED, |
173 | "gang_header"}, | |
a6255b7f | 174 | {{abd_fletcher_2_native, abd_fletcher_2_byteswap}, |
3c67d83a | 175 | NULL, NULL, ZCHECKSUM_FLAG_EMBEDDED, "zilog"}, |
a6255b7f | 176 | {{abd_fletcher_2_native, abd_fletcher_2_byteswap}, |
3c67d83a | 177 | NULL, NULL, 0, "fletcher2"}, |
a6255b7f | 178 | {{abd_fletcher_4_native, abd_fletcher_4_byteswap}, |
3c67d83a | 179 | NULL, NULL, ZCHECKSUM_FLAG_METADATA, "fletcher4"}, |
4c5fec01 | 180 | {{abd_checksum_sha256, abd_checksum_sha256}, |
3c67d83a TH |
181 | NULL, NULL, ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_DEDUP | |
182 | ZCHECKSUM_FLAG_NOPWRITE, "sha256"}, | |
a6255b7f | 183 | {{abd_fletcher_4_native, abd_fletcher_4_byteswap}, |
3c67d83a | 184 | NULL, NULL, ZCHECKSUM_FLAG_EMBEDDED, "zilog2"}, |
a6255b7f | 185 | {{abd_checksum_off, abd_checksum_off}, |
3c67d83a | 186 | NULL, NULL, 0, "noparity"}, |
4c5fec01 | 187 | {{abd_checksum_sha512_native, abd_checksum_sha512_byteswap}, |
3c67d83a TH |
188 | NULL, NULL, ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_DEDUP | |
189 | ZCHECKSUM_FLAG_NOPWRITE, "sha512"}, | |
a6255b7f DQ |
190 | {{abd_checksum_skein_native, abd_checksum_skein_byteswap}, |
191 | abd_checksum_skein_tmpl_init, abd_checksum_skein_tmpl_free, | |
3c67d83a TH |
192 | ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_DEDUP | |
193 | ZCHECKSUM_FLAG_SALTED | ZCHECKSUM_FLAG_NOPWRITE, "skein"}, | |
a6255b7f DQ |
194 | {{abd_checksum_edonr_native, abd_checksum_edonr_byteswap}, |
195 | abd_checksum_edonr_tmpl_init, abd_checksum_edonr_tmpl_free, | |
3c67d83a TH |
196 | ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_SALTED | |
197 | ZCHECKSUM_FLAG_NOPWRITE, "edonr"}, | |
985c33b1 TR |
198 | {{abd_checksum_blake3_native, abd_checksum_blake3_byteswap}, |
199 | abd_checksum_blake3_tmpl_init, abd_checksum_blake3_tmpl_free, | |
200 | ZCHECKSUM_FLAG_METADATA | ZCHECKSUM_FLAG_DEDUP | | |
201 | ZCHECKSUM_FLAG_SALTED | ZCHECKSUM_FLAG_NOPWRITE, "blake3"}, | |
34dc7c2f BB |
202 | }; |
203 | ||
4a2e9a17 | 204 | /* |
205 | * The flag corresponding to the "verify" in dedup=[checksum,]verify | |
206 | * must be cleared first, so callers should use ZIO_CHECKSUM_MASK. | |
207 | */ | |
3c67d83a TH |
208 | spa_feature_t |
209 | zio_checksum_to_feature(enum zio_checksum cksum) | |
210 | { | |
4a2e9a17 | 211 | VERIFY((cksum & ~ZIO_CHECKSUM_MASK) == 0); |
212 | ||
3c67d83a | 213 | switch (cksum) { |
985c33b1 TR |
214 | case ZIO_CHECKSUM_BLAKE3: |
215 | return (SPA_FEATURE_BLAKE3); | |
3c67d83a TH |
216 | case ZIO_CHECKSUM_SHA512: |
217 | return (SPA_FEATURE_SHA512); | |
218 | case ZIO_CHECKSUM_SKEIN: | |
219 | return (SPA_FEATURE_SKEIN); | |
220 | case ZIO_CHECKSUM_EDONR: | |
221 | return (SPA_FEATURE_EDONR); | |
222 | default: | |
223 | return (SPA_FEATURE_NONE); | |
224 | } | |
225 | } | |
226 | ||
428870ff BB |
227 | enum zio_checksum |
228 | zio_checksum_select(enum zio_checksum child, enum zio_checksum parent) | |
34dc7c2f BB |
229 | { |
230 | ASSERT(child < ZIO_CHECKSUM_FUNCTIONS); | |
231 | ASSERT(parent < ZIO_CHECKSUM_FUNCTIONS); | |
232 | ASSERT(parent != ZIO_CHECKSUM_INHERIT && parent != ZIO_CHECKSUM_ON); | |
233 | ||
234 | if (child == ZIO_CHECKSUM_INHERIT) | |
235 | return (parent); | |
236 | ||
237 | if (child == ZIO_CHECKSUM_ON) | |
238 | return (ZIO_CHECKSUM_ON_VALUE); | |
239 | ||
240 | return (child); | |
241 | } | |
242 | ||
428870ff BB |
243 | enum zio_checksum |
244 | zio_checksum_dedup_select(spa_t *spa, enum zio_checksum child, | |
245 | enum zio_checksum parent) | |
246 | { | |
247 | ASSERT((child & ZIO_CHECKSUM_MASK) < ZIO_CHECKSUM_FUNCTIONS); | |
248 | ASSERT((parent & ZIO_CHECKSUM_MASK) < ZIO_CHECKSUM_FUNCTIONS); | |
249 | ASSERT(parent != ZIO_CHECKSUM_INHERIT && parent != ZIO_CHECKSUM_ON); | |
250 | ||
251 | if (child == ZIO_CHECKSUM_INHERIT) | |
252 | return (parent); | |
253 | ||
254 | if (child == ZIO_CHECKSUM_ON) | |
255 | return (spa_dedup_checksum(spa)); | |
256 | ||
257 | if (child == (ZIO_CHECKSUM_ON | ZIO_CHECKSUM_VERIFY)) | |
258 | return (spa_dedup_checksum(spa) | ZIO_CHECKSUM_VERIFY); | |
259 | ||
3c67d83a TH |
260 | ASSERT((zio_checksum_table[child & ZIO_CHECKSUM_MASK].ci_flags & |
261 | ZCHECKSUM_FLAG_DEDUP) || | |
428870ff BB |
262 | (child & ZIO_CHECKSUM_VERIFY) || child == ZIO_CHECKSUM_OFF); |
263 | ||
264 | return (child); | |
265 | } | |
266 | ||
b128c09f BB |
267 | /* |
268 | * Set the external verifier for a gang block based on <vdev, offset, txg>, | |
269 | * a tuple which is guaranteed to be unique for the life of the pool. | |
270 | */ | |
271 | static void | |
84c07ada | 272 | zio_checksum_gang_verifier(zio_cksum_t *zcp, const blkptr_t *bp) |
b128c09f | 273 | { |
9b67f605 | 274 | const dva_t *dva = BP_IDENTITY(bp); |
428870ff | 275 | uint64_t txg = BP_PHYSICAL_BIRTH(bp); |
b128c09f BB |
276 | |
277 | ASSERT(BP_IS_GANG(bp)); | |
278 | ||
279 | ZIO_SET_CHECKSUM(zcp, DVA_GET_VDEV(dva), DVA_GET_OFFSET(dva), txg, 0); | |
280 | } | |
281 | ||
282 | /* | |
283 | * Set the external verifier for a label block based on its offset. | |
284 | * The vdev is implicit, and the txg is unknowable at pool open time -- | |
285 | * hence the logic in vdev_uberblock_load() to find the most recent copy. | |
286 | */ | |
287 | static void | |
288 | zio_checksum_label_verifier(zio_cksum_t *zcp, uint64_t offset) | |
289 | { | |
290 | ZIO_SET_CHECKSUM(zcp, offset, 0, 0, 0); | |
291 | } | |
292 | ||
3c67d83a TH |
293 | /* |
294 | * Calls the template init function of a checksum which supports context | |
295 | * templates and installs the template into the spa_t. | |
296 | */ | |
297 | static void | |
298 | zio_checksum_template_init(enum zio_checksum checksum, spa_t *spa) | |
299 | { | |
300 | zio_checksum_info_t *ci = &zio_checksum_table[checksum]; | |
301 | ||
302 | if (ci->ci_tmpl_init == NULL) | |
303 | return; | |
304 | if (spa->spa_cksum_tmpls[checksum] != NULL) | |
305 | return; | |
306 | ||
307 | VERIFY(ci->ci_tmpl_free != NULL); | |
308 | mutex_enter(&spa->spa_cksum_tmpls_lock); | |
309 | if (spa->spa_cksum_tmpls[checksum] == NULL) { | |
310 | spa->spa_cksum_tmpls[checksum] = | |
311 | ci->ci_tmpl_init(&spa->spa_cksum_salt); | |
312 | VERIFY(spa->spa_cksum_tmpls[checksum] != NULL); | |
313 | } | |
314 | mutex_exit(&spa->spa_cksum_tmpls_lock); | |
315 | } | |
316 | ||
e1cfd73f | 317 | /* convenience function to update a checksum to accommodate an encryption MAC */ |
b5256303 TC |
318 | static void |
319 | zio_checksum_handle_crypt(zio_cksum_t *cksum, zio_cksum_t *saved, boolean_t xor) | |
320 | { | |
321 | /* | |
322 | * Weak checksums do not have their entropy spread evenly | |
323 | * across the bits of the checksum. Therefore, when truncating | |
324 | * a weak checksum we XOR the first 2 words with the last 2 so | |
325 | * that we don't "lose" any entropy unnecessarily. | |
326 | */ | |
327 | if (xor) { | |
328 | cksum->zc_word[0] ^= cksum->zc_word[2]; | |
329 | cksum->zc_word[1] ^= cksum->zc_word[3]; | |
330 | } | |
331 | ||
332 | cksum->zc_word[2] = saved->zc_word[2]; | |
333 | cksum->zc_word[3] = saved->zc_word[3]; | |
334 | } | |
335 | ||
34dc7c2f BB |
336 | /* |
337 | * Generate the checksum. | |
338 | */ | |
339 | void | |
b128c09f | 340 | zio_checksum_compute(zio_t *zio, enum zio_checksum checksum, |
a6255b7f | 341 | abd_t *abd, uint64_t size) |
34dc7c2f | 342 | { |
84c07ada | 343 | static const uint64_t zec_magic = ZEC_MAGIC; |
b128c09f BB |
344 | blkptr_t *bp = zio->io_bp; |
345 | uint64_t offset = zio->io_offset; | |
34dc7c2f | 346 | zio_checksum_info_t *ci = &zio_checksum_table[checksum]; |
b5256303 | 347 | zio_cksum_t cksum, saved; |
3c67d83a | 348 | spa_t *spa = zio->io_spa; |
b5256303 | 349 | boolean_t insecure = (ci->ci_flags & ZCHECKSUM_FLAG_DEDUP) == 0; |
34dc7c2f | 350 | |
b128c09f | 351 | ASSERT((uint_t)checksum < ZIO_CHECKSUM_FUNCTIONS); |
34dc7c2f BB |
352 | ASSERT(ci->ci_func[0] != NULL); |
353 | ||
3c67d83a TH |
354 | zio_checksum_template_init(checksum, spa); |
355 | ||
356 | if (ci->ci_flags & ZCHECKSUM_FLAG_EMBEDDED) { | |
84c07ada GN |
357 | zio_eck_t eck; |
358 | size_t eck_offset; | |
428870ff | 359 | |
861166b0 | 360 | memset(&saved, 0, sizeof (zio_cksum_t)); |
b5256303 | 361 | |
428870ff | 362 | if (checksum == ZIO_CHECKSUM_ZILOG2) { |
84c07ada GN |
363 | zil_chain_t zilc; |
364 | abd_copy_to_buf(&zilc, abd, sizeof (zil_chain_t)); | |
428870ff | 365 | |
2a27fd41 AM |
366 | uint64_t nused = P2ROUNDUP_TYPED(zilc.zc_nused, |
367 | ZIL_MIN_BLKSZ, uint64_t); | |
368 | ASSERT3U(size, >=, nused); | |
369 | size = nused; | |
84c07ada GN |
370 | eck = zilc.zc_eck; |
371 | eck_offset = offsetof(zil_chain_t, zc_eck); | |
428870ff | 372 | } else { |
2a27fd41 | 373 | ASSERT3U(size, >=, sizeof (zio_eck_t)); |
84c07ada GN |
374 | eck_offset = size - sizeof (zio_eck_t); |
375 | abd_copy_to_buf_off(&eck, abd, eck_offset, | |
376 | sizeof (zio_eck_t)); | |
428870ff | 377 | } |
84c07ada GN |
378 | |
379 | if (checksum == ZIO_CHECKSUM_GANG_HEADER) { | |
380 | zio_checksum_gang_verifier(&eck.zec_cksum, bp); | |
84c07ada GN |
381 | } else if (checksum == ZIO_CHECKSUM_LABEL) { |
382 | zio_checksum_label_verifier(&eck.zec_cksum, offset); | |
84c07ada | 383 | } else { |
b5256303 TC |
384 | saved = eck.zec_cksum; |
385 | eck.zec_cksum = bp->blk_cksum; | |
84c07ada GN |
386 | } |
387 | ||
388 | abd_copy_from_buf_off(abd, &zec_magic, | |
389 | eck_offset + offsetof(zio_eck_t, zec_magic), | |
390 | sizeof (zec_magic)); | |
b5256303 TC |
391 | abd_copy_from_buf_off(abd, &eck.zec_cksum, |
392 | eck_offset + offsetof(zio_eck_t, zec_cksum), | |
393 | sizeof (zio_cksum_t)); | |
84c07ada | 394 | |
a6255b7f | 395 | ci->ci_func[0](abd, size, spa->spa_cksum_tmpls[checksum], |
3c67d83a | 396 | &cksum); |
b5256303 TC |
397 | if (bp != NULL && BP_USES_CRYPT(bp) && |
398 | BP_GET_TYPE(bp) != DMU_OT_OBJSET) | |
399 | zio_checksum_handle_crypt(&cksum, &saved, insecure); | |
84c07ada GN |
400 | |
401 | abd_copy_from_buf_off(abd, &cksum, | |
402 | eck_offset + offsetof(zio_eck_t, zec_cksum), | |
403 | sizeof (zio_cksum_t)); | |
34dc7c2f | 404 | } else { |
b5256303 | 405 | saved = bp->blk_cksum; |
a6255b7f | 406 | ci->ci_func[0](abd, size, spa->spa_cksum_tmpls[checksum], |
b5256303 TC |
407 | &cksum); |
408 | if (BP_USES_CRYPT(bp) && BP_GET_TYPE(bp) != DMU_OT_OBJSET) | |
409 | zio_checksum_handle_crypt(&cksum, &saved, insecure); | |
410 | bp->blk_cksum = cksum; | |
34dc7c2f BB |
411 | } |
412 | } | |
413 | ||
414 | int | |
84c07ada GN |
415 | zio_checksum_error_impl(spa_t *spa, const blkptr_t *bp, |
416 | enum zio_checksum checksum, abd_t *abd, uint64_t size, uint64_t offset, | |
417 | zio_bad_cksum_t *info) | |
34dc7c2f | 418 | { |
34dc7c2f | 419 | zio_checksum_info_t *ci = &zio_checksum_table[checksum]; |
3c67d83a | 420 | zio_cksum_t actual_cksum, expected_cksum; |
84c07ada GN |
421 | zio_eck_t eck; |
422 | int byteswap; | |
34dc7c2f BB |
423 | |
424 | if (checksum >= ZIO_CHECKSUM_FUNCTIONS || ci->ci_func[0] == NULL) | |
2e528b49 | 425 | return (SET_ERROR(EINVAL)); |
34dc7c2f | 426 | |
3c67d83a TH |
427 | zio_checksum_template_init(checksum, spa); |
428 | ||
4d9bb551 RY |
429 | IMPLY(bp == NULL, ci->ci_flags & ZCHECKSUM_FLAG_EMBEDDED); |
430 | IMPLY(bp == NULL, checksum == ZIO_CHECKSUM_LABEL); | |
431 | ||
3c67d83a | 432 | if (ci->ci_flags & ZCHECKSUM_FLAG_EMBEDDED) { |
d3c2ae1c | 433 | zio_cksum_t verifier; |
a6255b7f | 434 | size_t eck_offset; |
428870ff BB |
435 | |
436 | if (checksum == ZIO_CHECKSUM_ZILOG2) { | |
84c07ada | 437 | zil_chain_t zilc; |
428870ff BB |
438 | uint64_t nused; |
439 | ||
84c07ada GN |
440 | abd_copy_to_buf(&zilc, abd, sizeof (zil_chain_t)); |
441 | ||
442 | eck = zilc.zc_eck; | |
443 | eck_offset = offsetof(zil_chain_t, zc_eck) + | |
444 | offsetof(zio_eck_t, zec_cksum); | |
445 | ||
446 | if (eck.zec_magic == ZEC_MAGIC) { | |
447 | nused = zilc.zc_nused; | |
448 | } else if (eck.zec_magic == BSWAP_64(ZEC_MAGIC)) { | |
449 | nused = BSWAP_64(zilc.zc_nused); | |
a6255b7f | 450 | } else { |
2e528b49 | 451 | return (SET_ERROR(ECKSUM)); |
a6255b7f | 452 | } |
428870ff | 453 | |
2a27fd41 AM |
454 | nused = P2ROUNDUP_TYPED(nused, ZIL_MIN_BLKSZ, uint64_t); |
455 | if (size < nused) | |
2e528b49 | 456 | return (SET_ERROR(ECKSUM)); |
2a27fd41 | 457 | size = nused; |
428870ff | 458 | } else { |
2a27fd41 AM |
459 | if (size < sizeof (zio_eck_t)) |
460 | return (SET_ERROR(ECKSUM)); | |
84c07ada GN |
461 | eck_offset = size - sizeof (zio_eck_t); |
462 | abd_copy_to_buf_off(&eck, abd, eck_offset, | |
463 | sizeof (zio_eck_t)); | |
464 | eck_offset += offsetof(zio_eck_t, zec_cksum); | |
428870ff BB |
465 | } |
466 | ||
34dc7c2f | 467 | if (checksum == ZIO_CHECKSUM_GANG_HEADER) |
b128c09f BB |
468 | zio_checksum_gang_verifier(&verifier, bp); |
469 | else if (checksum == ZIO_CHECKSUM_LABEL) | |
470 | zio_checksum_label_verifier(&verifier, offset); | |
471 | else | |
472 | verifier = bp->blk_cksum; | |
473 | ||
84c07ada | 474 | byteswap = (eck.zec_magic == BSWAP_64(ZEC_MAGIC)); |
34dc7c2f | 475 | |
b128c09f BB |
476 | if (byteswap) |
477 | byteswap_uint64_array(&verifier, sizeof (zio_cksum_t)); | |
478 | ||
84c07ada GN |
479 | expected_cksum = eck.zec_cksum; |
480 | ||
481 | abd_copy_from_buf_off(abd, &verifier, eck_offset, | |
482 | sizeof (zio_cksum_t)); | |
a6255b7f DQ |
483 | |
484 | ci->ci_func[byteswap](abd, size, | |
3c67d83a | 485 | spa->spa_cksum_tmpls[checksum], &actual_cksum); |
84c07ada GN |
486 | |
487 | abd_copy_from_buf_off(abd, &expected_cksum, eck_offset, | |
488 | sizeof (zio_cksum_t)); | |
b128c09f | 489 | |
d3c2ae1c | 490 | if (byteswap) { |
34dc7c2f BB |
491 | byteswap_uint64_array(&expected_cksum, |
492 | sizeof (zio_cksum_t)); | |
d3c2ae1c | 493 | } |
34dc7c2f | 494 | } else { |
b128c09f BB |
495 | byteswap = BP_SHOULD_BYTESWAP(bp); |
496 | expected_cksum = bp->blk_cksum; | |
a6255b7f | 497 | ci->ci_func[byteswap](abd, size, |
3c67d83a | 498 | spa->spa_cksum_tmpls[checksum], &actual_cksum); |
34dc7c2f BB |
499 | } |
500 | ||
b5256303 TC |
501 | /* |
502 | * MAC checksums are a special case since half of this checksum will | |
503 | * actually be the encryption MAC. This will be verified by the | |
504 | * decryption process, so we just check the truncated checksum now. | |
505 | * Objset blocks use embedded MACs so we don't truncate the checksum | |
506 | * for them. | |
507 | */ | |
508 | if (bp != NULL && BP_USES_CRYPT(bp) && | |
509 | BP_GET_TYPE(bp) != DMU_OT_OBJSET) { | |
510 | if (!(ci->ci_flags & ZCHECKSUM_FLAG_DEDUP)) { | |
511 | actual_cksum.zc_word[0] ^= actual_cksum.zc_word[2]; | |
512 | actual_cksum.zc_word[1] ^= actual_cksum.zc_word[3]; | |
513 | } | |
514 | ||
515 | actual_cksum.zc_word[2] = 0; | |
516 | actual_cksum.zc_word[3] = 0; | |
517 | expected_cksum.zc_word[2] = 0; | |
518 | expected_cksum.zc_word[3] = 0; | |
519 | } | |
520 | ||
d3c2ae1c | 521 | if (info != NULL) { |
d3c2ae1c GW |
522 | info->zbc_checksum_name = ci->ci_name; |
523 | info->zbc_byteswapped = byteswap; | |
524 | info->zbc_injected = 0; | |
525 | info->zbc_has_cksum = 1; | |
526 | } | |
428870ff | 527 | |
b128c09f | 528 | if (!ZIO_CHECKSUM_EQUAL(actual_cksum, expected_cksum)) |
2e528b49 | 529 | return (SET_ERROR(ECKSUM)); |
34dc7c2f | 530 | |
d3c2ae1c GW |
531 | return (0); |
532 | } | |
533 | ||
534 | int | |
535 | zio_checksum_error(zio_t *zio, zio_bad_cksum_t *info) | |
536 | { | |
537 | blkptr_t *bp = zio->io_bp; | |
538 | uint_t checksum = (bp == NULL ? zio->io_prop.zp_checksum : | |
539 | (BP_IS_GANG(bp) ? ZIO_CHECKSUM_GANG_HEADER : BP_GET_CHECKSUM(bp))); | |
540 | int error; | |
541 | uint64_t size = (bp == NULL ? zio->io_size : | |
542 | (BP_IS_GANG(bp) ? SPA_GANGBLOCKSIZE : BP_GET_PSIZE(bp))); | |
543 | uint64_t offset = zio->io_offset; | |
a6255b7f | 544 | abd_t *data = zio->io_abd; |
d3c2ae1c GW |
545 | spa_t *spa = zio->io_spa; |
546 | ||
547 | error = zio_checksum_error_impl(spa, bp, checksum, data, size, | |
548 | offset, info); | |
428870ff | 549 | |
41425f79 GM |
550 | if (zio_injection_enabled && error == 0 && zio->io_error == 0) { |
551 | error = zio_handle_fault_injection(zio, ECKSUM); | |
552 | if (error != 0) | |
553 | info->zbc_injected = 1; | |
428870ff | 554 | } |
41425f79 | 555 | |
d3c2ae1c | 556 | return (error); |
34dc7c2f | 557 | } |
3c67d83a TH |
558 | |
559 | /* | |
560 | * Called by a spa_t that's about to be deallocated. This steps through | |
561 | * all of the checksum context templates and deallocates any that were | |
562 | * initialized using the algorithm-specific template init function. | |
563 | */ | |
564 | void | |
565 | zio_checksum_templates_free(spa_t *spa) | |
566 | { | |
1c27024e DB |
567 | for (enum zio_checksum checksum = 0; |
568 | checksum < ZIO_CHECKSUM_FUNCTIONS; checksum++) { | |
3c67d83a TH |
569 | if (spa->spa_cksum_tmpls[checksum] != NULL) { |
570 | zio_checksum_info_t *ci = &zio_checksum_table[checksum]; | |
571 | ||
572 | VERIFY(ci->ci_tmpl_free != NULL); | |
573 | ci->ci_tmpl_free(spa->spa_cksum_tmpls[checksum]); | |
574 | spa->spa_cksum_tmpls[checksum] = NULL; | |
575 | } | |
576 | } | |
577 | } |