xref: /freebsd/sys/contrib/openzfs/module/icp/include/modes/gcm_impl.h (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3  * CDDL HEADER START
4  *
5  * The contents of this file are subject to the terms of the
6  * Common Development and Distribution License (the "License").
7  * You may not use this file except in compliance with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or https://opensource.org/licenses/CDDL-1.0.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25 
26 #ifndef	_GCM_IMPL_H
27 #define	_GCM_IMPL_H
28 
29 /*
30  * GCM function dispatcher.
31  */
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 #include <sys/zfs_context.h>
38 #include <sys/crypto/common.h>
39 
40 /*
41  * Methods used to define GCM implementation
42  *
43  * @gcm_mul_f Perform carry-less multiplication
44  * @gcm_will_work_f Function tests whether implementation will function
45  */
46 typedef void		(*gcm_mul_f)(uint64_t *, uint64_t *, uint64_t *);
47 typedef boolean_t	(*gcm_will_work_f)(void);
48 
49 #define	GCM_IMPL_NAME_MAX (16)
50 
51 typedef struct gcm_impl_ops {
52 	gcm_mul_f mul;
53 	gcm_will_work_f is_supported;
54 	char name[GCM_IMPL_NAME_MAX];
55 } gcm_impl_ops_t;
56 
57 extern const gcm_impl_ops_t gcm_generic_impl;
58 #if defined(__x86_64) && defined(HAVE_PCLMULQDQ)
59 extern const gcm_impl_ops_t gcm_pclmulqdq_impl;
60 #endif
61 
62 /*
63  * Initializes fastest implementation
64  */
65 void gcm_impl_init(void);
66 
67 /*
68  * Returns optimal allowed GCM implementation
69  */
70 const struct gcm_impl_ops *gcm_impl_get_ops(void);
71 
72 #ifdef	__cplusplus
73 }
74 #endif
75 
76 #endif	/* _GCM_IMPL_H */
77