[mirror_zfs.git] / include / sys / zio_checksum.h

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
 * Copyright (c) 2014 by Delphix. All rights reserved.
 */

#ifndef _SYS_ZIO_CHECKSUM_H
#define	_SYS_ZIO_CHECKSUM_H

#include <sys/zio.h>

#ifdef	__cplusplus
extern "C" {
#endif

/*
 * Signature for checksum functions.
 */
typedef void zio_checksum_func_t(const void *, uint64_t, zio_cksum_t *);

/*
 * Information about each checksum function.
 */
typedef const struct zio_checksum_info {
	zio_checksum_func_t *ci_func[2]; /* checksum function per byteorder */
	int		ci_correctable;	/* number of correctable bits	*/
	int		ci_eck;		/* uses zio embedded checksum? */
	boolean_t	ci_dedup;	/* strong enough for dedup? */
	char		*ci_name;	/* descriptive name */
} zio_checksum_info_t;

typedef struct zio_bad_cksum {
	zio_cksum_t		zbc_expected;
	zio_cksum_t		zbc_actual;
	const char		*zbc_checksum_name;
	uint8_t			zbc_byteswapped;
	uint8_t			zbc_injected;
	uint8_t			zbc_has_cksum;	/* expected/actual valid */
} zio_bad_cksum_t;

extern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS];

/*
 * Checksum routines.
 */
extern zio_checksum_func_t zio_checksum_SHA256;

extern int zio_checksum_equal(spa_t *, blkptr_t *, enum zio_checksum,
    void *, uint64_t, uint64_t, zio_bad_cksum_t *);
extern void zio_checksum_compute(zio_t *zio, enum zio_checksum checksum,
    void *data, uint64_t size);
extern int zio_checksum_error_impl(spa_t *, blkptr_t *, enum zio_checksum,
    void *, uint64_t, uint64_t, zio_bad_cksum_t *);
extern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out);
extern enum zio_checksum spa_dedup_checksum(spa_t *spa);

#ifdef	__cplusplus
}
#endif

#endif	/* _SYS_ZIO_CHECKSUM_H */
Commit	Line	Data
34dc7c2f BB	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	/*
428870ff	22	* Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
37f8a883	23	* Copyright (c) 2014 by Delphix. All rights reserved.
34dc7c2f BB	24	*/
	25
	26	#ifndef _SYS_ZIO_CHECKSUM_H
	27	#define _SYS_ZIO_CHECKSUM_H
	28
34dc7c2f BB	29	#include <sys/zio.h>
	30
	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
	35	/*
	36	* Signature for checksum functions.
	37	*/
37f8a883	38	typedef void zio_checksum_func_t(const void , uint64_t, zio_cksum_t );
34dc7c2f BB	39
	40	/*
	41	* Information about each checksum function.
	42	*/
b01615d5	43	typedef const struct zio_checksum_info {
37f8a883	44	zio_checksum_func_t ci_func[2]; / checksum function per byteorder */
34dc7c2f	45	int ci_correctable; /* number of correctable bits */
428870ff	46	int ci_eck; /* uses zio embedded checksum? */
fcff0f35	47	boolean_t ci_dedup; /* strong enough for dedup? */
34dc7c2f BB	48	char ci_name; / descriptive name */
	49	} zio_checksum_info_t;
	50
428870ff BB	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
34dc7c2f BB	60	extern zio_checksum_info_t zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS];
	61
	62	/*
	63	* Checksum routines.
	64	*/
37f8a883	65	extern zio_checksum_func_t zio_checksum_SHA256;
34dc7c2f	66
d3c2ae1c GW	67	extern int zio_checksum_equal(spa_t , blkptr_t , enum zio_checksum,
d3c2ae1c GW	68	void , uint64_t, uint64_t, zio_bad_cksum_t );
b128c09f	69	extern void zio_checksum_compute(zio_t *zio, enum zio_checksum checksum,
34dc7c2f	70	void *data, uint64_t size);
d3c2ae1c GW	71	extern int zio_checksum_error_impl(spa_t , blkptr_t , enum zio_checksum,
d3c2ae1c GW	72	void , uint64_t, uint64_t, zio_bad_cksum_t );
428870ff BB	73	extern int zio_checksum_error(zio_t zio, zio_bad_cksum_t out);
428870ff BB	74	extern enum zio_checksum spa_dedup_checksum(spa_t *spa);
34dc7c2f BB	75
	76	#ifdef __cplusplus
	77	}
	78	#endif
	79
	80	#endif /* _SYS_ZIO_CHECKSUM_H */