1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5ea8dc4b6Seschrock * Common Development and Distribution License (the "License"). 6ea8dc4b6Seschrock * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21fa9e4066Sahrens /* 22cde58dbcSMatthew Ahrens * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 23770499e1SDan Kimmel * Copyright (c) 2014, 2016 by Delphix. All rights reserved. 2445818ee1SMatthew Ahrens * Copyright Saso Kiselkov 2013, All rights reserved. 25fa9e4066Sahrens */ 26fa9e4066Sahrens 27fa9e4066Sahrens #ifndef _SYS_ZIO_CHECKSUM_H 28fa9e4066Sahrens #define _SYS_ZIO_CHECKSUM_H 29fa9e4066Sahrens 30fa9e4066Sahrens #include <sys/zio.h> 3145818ee1SMatthew Ahrens #include <zfeature_common.h> 32*0886dcadSAndy Fiddaman #include <zfs_fletcher.h> 33fa9e4066Sahrens 34fa9e4066Sahrens #ifdef __cplusplus 35fa9e4066Sahrens extern "C" { 36fa9e4066Sahrens #endif 37fa9e4066Sahrens 38770499e1SDan Kimmel struct abd; 39770499e1SDan Kimmel 40fa9e4066Sahrens /* 41fa9e4066Sahrens * Signature for checksum functions. 42fa9e4066Sahrens */ 43770499e1SDan Kimmel typedef void zio_checksum_t(struct abd *, uint64_t size, 4445818ee1SMatthew Ahrens const void *ctx_template, zio_cksum_t *zcp); 4545818ee1SMatthew Ahrens typedef void *zio_checksum_tmpl_init_t(const zio_cksum_salt_t *salt); 4645818ee1SMatthew Ahrens typedef void zio_checksum_tmpl_free_t(void *ctx_template); 4745818ee1SMatthew Ahrens 4845818ee1SMatthew Ahrens typedef enum zio_checksum_flags { 4945818ee1SMatthew Ahrens /* Strong enough for metadata? */ 5045818ee1SMatthew Ahrens ZCHECKSUM_FLAG_METADATA = (1 << 1), 5145818ee1SMatthew Ahrens /* ZIO embedded checksum */ 5245818ee1SMatthew Ahrens ZCHECKSUM_FLAG_EMBEDDED = (1 << 2), 5345818ee1SMatthew Ahrens /* Strong enough for dedup (without verification)? */ 5445818ee1SMatthew Ahrens ZCHECKSUM_FLAG_DEDUP = (1 << 3), 5545818ee1SMatthew Ahrens /* Uses salt value */ 5645818ee1SMatthew Ahrens ZCHECKSUM_FLAG_SALTED = (1 << 4), 5745818ee1SMatthew Ahrens /* Strong enough for nopwrite? */ 58eb633035STom Caputi ZCHECKSUM_FLAG_NOPWRITE = (1 << 5), 5945818ee1SMatthew Ahrens } zio_checksum_flags_t; 60fa9e4066Sahrens 61*0886dcadSAndy Fiddaman typedef enum { 62*0886dcadSAndy Fiddaman ZIO_CHECKSUM_NATIVE, 63*0886dcadSAndy Fiddaman ZIO_CHECKSUM_BYTESWAP 64*0886dcadSAndy Fiddaman } zio_byteorder_t; 65*0886dcadSAndy Fiddaman 66*0886dcadSAndy Fiddaman typedef struct zio_abd_checksum_data { 67*0886dcadSAndy Fiddaman zio_byteorder_t acd_byteorder; 68*0886dcadSAndy Fiddaman fletcher_4_ctx_t *acd_ctx; 69*0886dcadSAndy Fiddaman zio_cksum_t *acd_zcp; 70*0886dcadSAndy Fiddaman void *acd_private; 71*0886dcadSAndy Fiddaman } zio_abd_checksum_data_t; 72*0886dcadSAndy Fiddaman 73*0886dcadSAndy Fiddaman typedef void zio_abd_checksum_init_t(zio_abd_checksum_data_t *); 74*0886dcadSAndy Fiddaman typedef void zio_abd_checksum_fini_t(zio_abd_checksum_data_t *); 75*0886dcadSAndy Fiddaman typedef int zio_abd_checksum_iter_t(void *, size_t, void *); 76*0886dcadSAndy Fiddaman 77*0886dcadSAndy Fiddaman typedef const struct zio_abd_checksum_func { 78*0886dcadSAndy Fiddaman zio_abd_checksum_init_t *acf_init; 79*0886dcadSAndy Fiddaman zio_abd_checksum_fini_t *acf_fini; 80*0886dcadSAndy Fiddaman zio_abd_checksum_iter_t *acf_iter; 81*0886dcadSAndy Fiddaman } zio_abd_checksum_func_t; 82*0886dcadSAndy Fiddaman 83fa9e4066Sahrens /* 84fa9e4066Sahrens * Information about each checksum function. 85fa9e4066Sahrens */ 86fa9e4066Sahrens typedef struct zio_checksum_info { 8745818ee1SMatthew Ahrens /* checksum function for each byteorder */ 8845818ee1SMatthew Ahrens zio_checksum_t *ci_func[2]; 8945818ee1SMatthew Ahrens zio_checksum_tmpl_init_t *ci_tmpl_init; 9045818ee1SMatthew Ahrens zio_checksum_tmpl_free_t *ci_tmpl_free; 9145818ee1SMatthew Ahrens zio_checksum_flags_t ci_flags; 9245818ee1SMatthew Ahrens char *ci_name; /* descriptive name */ 93fa9e4066Sahrens } zio_checksum_info_t; 94fa9e4066Sahrens 9522fe2c88SJonathan Adams typedef struct zio_bad_cksum { 9622fe2c88SJonathan Adams zio_cksum_t zbc_expected; 9722fe2c88SJonathan Adams zio_cksum_t zbc_actual; 9822fe2c88SJonathan Adams const char *zbc_checksum_name; 9922fe2c88SJonathan Adams uint8_t zbc_byteswapped; 10022fe2c88SJonathan Adams uint8_t zbc_injected; 10122fe2c88SJonathan Adams uint8_t zbc_has_cksum; /* expected/actual valid */ 10222fe2c88SJonathan Adams } zio_bad_cksum_t; 10322fe2c88SJonathan Adams 104fa9e4066Sahrens extern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS]; 105fa9e4066Sahrens 106fa9e4066Sahrens /* 107fa9e4066Sahrens * Checksum routines. 108fa9e4066Sahrens */ 109770499e1SDan Kimmel extern zio_checksum_t abd_checksum_SHA256; 110770499e1SDan Kimmel extern zio_checksum_t abd_checksum_SHA512_native; 111770499e1SDan Kimmel extern zio_checksum_t abd_checksum_SHA512_byteswap; 11245818ee1SMatthew Ahrens 11345818ee1SMatthew Ahrens /* Skein */ 114770499e1SDan Kimmel extern zio_checksum_t abd_checksum_skein_native; 115770499e1SDan Kimmel extern zio_checksum_t abd_checksum_skein_byteswap; 116770499e1SDan Kimmel extern zio_checksum_tmpl_init_t abd_checksum_skein_tmpl_init; 117770499e1SDan Kimmel extern zio_checksum_tmpl_free_t abd_checksum_skein_tmpl_free; 11845818ee1SMatthew Ahrens 11945818ee1SMatthew Ahrens /* Edon-R */ 120770499e1SDan Kimmel extern zio_checksum_t abd_checksum_edonr_native; 121770499e1SDan Kimmel extern zio_checksum_t abd_checksum_edonr_byteswap; 122770499e1SDan Kimmel extern zio_checksum_tmpl_init_t abd_checksum_edonr_tmpl_init; 123770499e1SDan Kimmel extern zio_checksum_tmpl_free_t abd_checksum_edonr_tmpl_free; 124fa9e4066Sahrens 125*0886dcadSAndy Fiddaman extern zio_abd_checksum_func_t fletcher_4_abd_ops; 126*0886dcadSAndy Fiddaman extern zio_checksum_t abd_fletcher_4_native; 127*0886dcadSAndy Fiddaman extern zio_checksum_t abd_fletcher_4_byteswap; 128*0886dcadSAndy Fiddaman 129dcbf3bd6SGeorge Wilson extern int zio_checksum_equal(spa_t *, blkptr_t *, enum zio_checksum, 130dcbf3bd6SGeorge Wilson void *, uint64_t, uint64_t, zio_bad_cksum_t *); 131770499e1SDan Kimmel extern void zio_checksum_compute(zio_t *, enum zio_checksum, 132770499e1SDan Kimmel struct abd *, uint64_t); 133eb633035STom Caputi extern int zio_checksum_error_impl(spa_t *, const blkptr_t *, enum zio_checksum, 134770499e1SDan Kimmel struct abd *, uint64_t, uint64_t, zio_bad_cksum_t *); 13522fe2c88SJonathan Adams extern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out); 136cde58dbcSMatthew Ahrens extern enum zio_checksum spa_dedup_checksum(spa_t *spa); 13745818ee1SMatthew Ahrens extern void zio_checksum_templates_free(spa_t *spa); 13845818ee1SMatthew Ahrens extern spa_feature_t zio_checksum_to_feature(enum zio_checksum cksum); 139fa9e4066Sahrens 140fa9e4066Sahrens #ifdef __cplusplus 141fa9e4066Sahrens } 142fa9e4066Sahrens #endif 143fa9e4066Sahrens 144fa9e4066Sahrens #endif /* _SYS_ZIO_CHECKSUM_H */ 145