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