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 https://opensource.org/licenses/CDDL-1.0.
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, 2016 by Delphix. All rights reserved.
24 * Copyright (c) 2013 Saso Kiselkov, All rights reserved.
25 * Copyright (c) 2021 Tino Reichardt <milky-zfs@mcmilk.de>
26 */
27
28#ifndef _SYS_ZIO_CHECKSUM_H
29#define	_SYS_ZIO_CHECKSUM_H extern __attribute__((visibility("default")))
30
31#include <sys/zio.h>
32#include <zfeature_common.h>
33#include <zfs_fletcher.h>
34
35#ifdef	__cplusplus
36extern "C" {
37#endif
38
39struct abd;
40
41/*
42 * Signature for checksum functions.
43 */
44typedef void zio_checksum_t(struct abd *abd, uint64_t size,
45    const void *ctx_template, zio_cksum_t *zcp);
46typedef void *zio_checksum_tmpl_init_t(const zio_cksum_salt_t *salt);
47typedef void zio_checksum_tmpl_free_t(void *ctx_template);
48
49typedef enum zio_checksum_flags {
50	/* Strong enough for metadata? */
51	ZCHECKSUM_FLAG_METADATA = (1 << 1),
52	/* ZIO embedded checksum */
53	ZCHECKSUM_FLAG_EMBEDDED = (1 << 2),
54	/* Strong enough for dedup (without verification)? */
55	ZCHECKSUM_FLAG_DEDUP = (1 << 3),
56	/* Uses salt value */
57	ZCHECKSUM_FLAG_SALTED = (1 << 4),
58	/* Strong enough for nopwrite? */
59	ZCHECKSUM_FLAG_NOPWRITE = (1 << 5)
60} zio_checksum_flags_t;
61
62typedef enum {
63	ZIO_CHECKSUM_NATIVE,
64	ZIO_CHECKSUM_BYTESWAP
65} zio_byteorder_t;
66
67typedef struct zio_abd_checksum_data {
68	zio_byteorder_t		acd_byteorder;
69	fletcher_4_ctx_t	*acd_ctx;
70	zio_cksum_t 		*acd_zcp;
71	void 			*acd_private;
72} zio_abd_checksum_data_t;
73
74typedef void zio_abd_checksum_init_t(zio_abd_checksum_data_t *);
75typedef void zio_abd_checksum_fini_t(zio_abd_checksum_data_t *);
76typedef int zio_abd_checksum_iter_t(void *, size_t, void *);
77
78typedef const struct zio_abd_checksum_func {
79	zio_abd_checksum_init_t *acf_init;
80	zio_abd_checksum_fini_t *acf_fini;
81	zio_abd_checksum_iter_t *acf_iter;
82} zio_abd_checksum_func_t;
83
84/*
85 * Information about each checksum function.
86 */
87typedef const struct zio_checksum_info {
88	/* checksum function for each byteorder */
89	zio_checksum_t			*ci_func[2];
90	zio_checksum_tmpl_init_t	*ci_tmpl_init;
91	zio_checksum_tmpl_free_t	*ci_tmpl_free;
92	zio_checksum_flags_t		ci_flags;
93	const char			*ci_name;	/* descriptive name */
94} zio_checksum_info_t;
95
96typedef struct zio_bad_cksum {
97	const char		*zbc_checksum_name;
98	uint8_t			zbc_byteswapped;
99	uint8_t			zbc_injected;
100	uint8_t			zbc_has_cksum;	/* expected/actual valid */
101} zio_bad_cksum_t;
102
103_SYS_ZIO_CHECKSUM_H zio_checksum_info_t
104    zio_checksum_table[ZIO_CHECKSUM_FUNCTIONS];
105
106/*
107 * Checksum routines.
108 */
109
110/* SHA2 */
111extern zio_checksum_t abd_checksum_sha256;
112extern zio_checksum_t abd_checksum_sha512_native;
113extern zio_checksum_t abd_checksum_sha512_byteswap;
114
115/* Skein */
116extern zio_checksum_t abd_checksum_skein_native;
117extern zio_checksum_t abd_checksum_skein_byteswap;
118extern zio_checksum_tmpl_init_t abd_checksum_skein_tmpl_init;
119extern zio_checksum_tmpl_free_t abd_checksum_skein_tmpl_free;
120
121/* Edon-R */
122extern zio_checksum_t abd_checksum_edonr_native;
123extern zio_checksum_t abd_checksum_edonr_byteswap;
124extern zio_checksum_tmpl_init_t abd_checksum_edonr_tmpl_init;
125extern zio_checksum_tmpl_free_t abd_checksum_edonr_tmpl_free;
126
127/* BLAKE3 */
128extern zio_checksum_t abd_checksum_blake3_native;
129extern zio_checksum_t abd_checksum_blake3_byteswap;
130extern zio_checksum_tmpl_init_t abd_checksum_blake3_tmpl_init;
131extern zio_checksum_tmpl_free_t abd_checksum_blake3_tmpl_free;
132
133/* Fletcher 4 */
134_SYS_ZIO_CHECKSUM_H zio_abd_checksum_func_t fletcher_4_abd_ops;
135extern zio_checksum_t abd_fletcher_4_native;
136extern zio_checksum_t abd_fletcher_4_byteswap;
137
138extern int zio_checksum_equal(spa_t *, blkptr_t *, enum zio_checksum,
139    void *, uint64_t, uint64_t, zio_bad_cksum_t *);
140extern void zio_checksum_compute(zio_t *, enum zio_checksum,
141    struct abd *, uint64_t);
142extern int zio_checksum_error_impl(spa_t *, const blkptr_t *, enum zio_checksum,
143    struct abd *, uint64_t, uint64_t, zio_bad_cksum_t *);
144extern int zio_checksum_error(zio_t *zio, zio_bad_cksum_t *out);
145extern enum zio_checksum spa_dedup_checksum(spa_t *spa);
146extern void zio_checksum_templates_free(spa_t *spa);
147extern spa_feature_t zio_checksum_to_feature(enum zio_checksum cksum);
148
149#ifdef	__cplusplus
150}
151#endif
152
153#endif	/* _SYS_ZIO_CHECKSUM_H */
154