fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * Common Development and Distribution License (the "License").
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrock * You may not use this file except in compliance with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * or http://www.opensolaris.org/os/licensing.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens *
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
cde58dbc6a23d4d38db7c8866312be83221c765fMatthew Ahrens * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Copyright (c) 2014, 2015 by Delphix. All rights reserved.
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens * Copyright Saso Kiselkov 2013, All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifndef _SYS_ZIO_CHECKSUM_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens#define _SYS_ZIO_CHECKSUM_H
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#include <sys/zio.h>
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens#include <zfeature_common.h>
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Signature for checksum functions.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrenstypedef void zio_checksum_t(const void *data, uint64_t size,
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens const void *ctx_template, zio_cksum_t *zcp);
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrenstypedef void *zio_checksum_tmpl_init_t(const zio_cksum_salt_t *salt);
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrenstypedef void zio_checksum_tmpl_free_t(void *ctx_template);
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrenstypedef enum zio_checksum_flags {
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Strong enough for metadata? */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens ZCHECKSUM_FLAG_METADATA = (1 << 1),
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* ZIO embedded checksum */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens ZCHECKSUM_FLAG_EMBEDDED = (1 << 2),
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Strong enough for dedup (without verification)? */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens ZCHECKSUM_FLAG_DEDUP = (1 << 3),
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Uses salt value */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens ZCHECKSUM_FLAG_SALTED = (1 << 4),
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* Strong enough for nopwrite? */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens ZCHECKSUM_FLAG_NOPWRITE = (1 << 5)
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens} zio_checksum_flags_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Information about each checksum function.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef struct zio_checksum_info {
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens /* checksum function for each byteorder */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens zio_checksum_t *ci_func[2];
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens zio_checksum_tmpl_init_t *ci_tmpl_init;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens zio_checksum_tmpl_free_t *ci_tmpl_free;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens zio_checksum_flags_t ci_flags;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens char *ci_name; /* descriptive name */
fa9e4066f08beec538e775443c5be79dd423fcabahrens} zio_checksum_info_t;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adamstypedef struct zio_bad_cksum {
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams zio_cksum_t zbc_expected;
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams zio_cksum_t zbc_actual;
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams const char *zbc_checksum_name;
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams uint8_t zbc_byteswapped;
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams uint8_t zbc_injected;
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams uint8_t zbc_has_cksum; /* expected/actual valid */
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams} zio_bad_cksum_t;
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adams
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS];
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens/*
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Checksum routines.
fa9e4066f08beec538e775443c5be79dd423fcabahrens */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_SHA256;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_SHA512_native;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_SHA512_byteswap;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* Skein */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_skein_native;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_skein_byteswap;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_tmpl_init_t zio_checksum_skein_tmpl_init;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_tmpl_free_t zio_checksum_skein_tmpl_free;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrens/* Edon-R */
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_edonr_native;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_t zio_checksum_edonr_byteswap;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_tmpl_init_t zio_checksum_edonr_tmpl_init;
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern zio_checksum_tmpl_free_t zio_checksum_edonr_tmpl_free;
fa9e4066f08beec538e775443c5be79dd423fcabahrens
dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2George Wilsonextern int zio_checksum_equal(spa_t *, blkptr_t *, enum zio_checksum,
dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2George Wilson void *, uint64_t, uint64_t, zio_bad_cksum_t *);
e14bb3258d05c1b1077e2db7cf77088924e56919Jeff Bonwickextern void zio_checksum_compute(zio_t *zio, enum zio_checksum checksum,
fa9e4066f08beec538e775443c5be79dd423fcabahrens void *data, uint64_t size);
dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2George Wilsonextern int zio_checksum_error_impl(spa_t *, blkptr_t *, enum zio_checksum,
dcbf3bd6a1f1360fc1afcee9e22c6dcff7844bf2George Wilson void *, uint64_t, uint64_t, zio_bad_cksum_t *);
22fe2c8844be88ebae6478ca1b0b92c8ec2aef54Jonathan Adamsextern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out);
cde58dbc6a23d4d38db7c8866312be83221c765fMatthew Ahrensextern enum zio_checksum spa_dedup_checksum(spa_t *spa);
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern void zio_checksum_templates_free(spa_t *spa);
45818ee124adeaaf947698996b4f4c722afc6d1fMatthew Ahrensextern spa_feature_t zio_checksum_to_feature(enum zio_checksum cksum);
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#ifdef __cplusplus
fa9e4066f08beec538e775443c5be79dd423fcabahrens}
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif
fa9e4066f08beec538e775443c5be79dd423fcabahrens
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _SYS_ZIO_CHECKSUM_H */