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 http://www.opensolaris.org/os/licensing. 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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23 * Copyright (c) 2014, 2016 by Delphix. All rights reserved. 24 * Copyright Saso Kiselkov 2013, All rights reserved. 25 */ 26 27 #ifndef _SYS_ZIO_CHECKSUM_H 28 #define _SYS_ZIO_CHECKSUM_H 29 30 #include <sys/zio.h> 31 #include <zfeature_common.h> 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 struct abd; 38 39 /* 40 * Signature for checksum functions. 41 */ 42 typedef void zio_checksum_t(struct abd *, uint64_t size, 43 const void *ctx_template, zio_cksum_t *zcp); 44 typedef void *zio_checksum_tmpl_init_t(const zio_cksum_salt_t *salt); 45 typedef void zio_checksum_tmpl_free_t(void *ctx_template); 46 47 typedef enum zio_checksum_flags { 48 /* Strong enough for metadata? */ 49 ZCHECKSUM_FLAG_METADATA = (1 << 1), 50 /* ZIO embedded checksum */ 51 ZCHECKSUM_FLAG_EMBEDDED = (1 << 2), 52 /* Strong enough for dedup (without verification)? */ 53 ZCHECKSUM_FLAG_DEDUP = (1 << 3), 54 /* Uses salt value */ 55 ZCHECKSUM_FLAG_SALTED = (1 << 4), 56 /* Strong enough for nopwrite? */ 57 ZCHECKSUM_FLAG_NOPWRITE = (1 << 5) 58 } zio_checksum_flags_t; 59 60 /* 61 * Information about each checksum function. 62 */ 63 typedef struct zio_checksum_info { 64 /* checksum function for each byteorder */ 65 zio_checksum_t *ci_func[2]; 66 zio_checksum_tmpl_init_t *ci_tmpl_init; 67 zio_checksum_tmpl_free_t *ci_tmpl_free; 68 zio_checksum_flags_t ci_flags; 69 char *ci_name; /* descriptive name */ 70 } zio_checksum_info_t; 71 72 typedef struct zio_bad_cksum { 73 zio_cksum_t zbc_expected; 74 zio_cksum_t zbc_actual; 75 const char *zbc_checksum_name; 76 uint8_t zbc_byteswapped; 77 uint8_t zbc_injected; 78 uint8_t zbc_has_cksum; /* expected/actual valid */ 79 } zio_bad_cksum_t; 80 81 extern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS]; 82 83 /* 84 * Checksum routines. 85 */ 86 extern zio_checksum_t abd_checksum_SHA256; 87 extern zio_checksum_t abd_checksum_SHA512_native; 88 extern zio_checksum_t abd_checksum_SHA512_byteswap; 89 90 /* Skein */ 91 extern zio_checksum_t abd_checksum_skein_native; 92 extern zio_checksum_t abd_checksum_skein_byteswap; 93 extern zio_checksum_tmpl_init_t abd_checksum_skein_tmpl_init; 94 extern zio_checksum_tmpl_free_t abd_checksum_skein_tmpl_free; 95 96 /* Edon-R */ 97 extern zio_checksum_t abd_checksum_edonr_native; 98 extern zio_checksum_t abd_checksum_edonr_byteswap; 99 extern zio_checksum_tmpl_init_t abd_checksum_edonr_tmpl_init; 100 extern zio_checksum_tmpl_free_t abd_checksum_edonr_tmpl_free; 101 102 extern int zio_checksum_equal(spa_t *, blkptr_t *, enum zio_checksum, 103 void *, uint64_t, uint64_t, zio_bad_cksum_t *); 104 extern void zio_checksum_compute(zio_t *, enum zio_checksum, 105 struct abd *, uint64_t); 106 extern int zio_checksum_error_impl(spa_t *, blkptr_t *, enum zio_checksum, 107 struct abd *, uint64_t, uint64_t, zio_bad_cksum_t *); 108 extern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out); 109 extern enum zio_checksum spa_dedup_checksum(spa_t *spa); 110 extern void zio_checksum_templates_free(spa_t *spa); 111 extern spa_feature_t zio_checksum_to_feature(enum zio_checksum cksum); 112 113 #ifdef __cplusplus 114 } 115 #endif 116 117 #endif /* _SYS_ZIO_CHECKSUM_H */ 118