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 2010 Sun Microsystems, Inc.  All rights reserved.
23 * Use is subject to license terms.
24 */
25
26#ifndef _SYS_ZIO_CHECKSUM_H
27#define	_SYS_ZIO_CHECKSUM_H
28
29#include <sys/zio.h>
30#include <zfs_fletcher.h>
31
32#ifdef	__cplusplus
33extern "C" {
34#endif
35
36/*
37 * Signature for checksum functions.
38 */
39typedef void zio_checksum_t(const void *data, uint64_t size, zio_cksum_t *zcp);
40
41/*
42 * Information about each checksum function.
43 */
44typedef struct zio_checksum_info {
45	zio_checksum_t	*ci_func[2]; /* checksum function for each byteorder */
46	int		ci_correctable;	/* number of correctable bits	*/
47	int		ci_eck;		/* uses zio embedded checksum? */
48	int		ci_dedup;	/* strong enough for dedup? */
49	char		*ci_name;	/* descriptive name */
50} zio_checksum_info_t;
51
52typedef struct zio_bad_cksum {
53	zio_cksum_t		zbc_expected;
54	zio_cksum_t		zbc_actual;
55	const char		*zbc_checksum_name;
56	uint8_t			zbc_byteswapped;
57	uint8_t			zbc_injected;
58	uint8_t			zbc_has_cksum;	/* expected/actual valid */
59} zio_bad_cksum_t;
60
61extern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS];
62
63/*
64 * Checksum routines.
65 */
66extern zio_checksum_t zio_checksum_SHA256;
67
68extern void zio_checksum_compute(zio_t *zio, enum zio_checksum checksum,
69    void *data, uint64_t size);
70extern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out);
71
72#ifdef	__cplusplus
73}
74#endif
75
76#endif	/* _SYS_ZIO_CHECKSUM_H */
77