xref: /freebsd/sys/contrib/openzfs/module/icp/include/modes/gcm_impl.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
23  */
24 
25 #ifndef	_GCM_IMPL_H
26 #define	_GCM_IMPL_H
27 
28 /*
29  * GCM function dispatcher.
30  */
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 #include <sys/zfs_context.h>
37 #include <sys/crypto/common.h>
38 
39 /*
40  * Methods used to define GCM implementation
41  *
42  * @gcm_mul_f Perform carry-less multiplication
43  * @gcm_will_work_f Function tests whether implementation will function
44  */
45 typedef void		(*gcm_mul_f)(uint64_t *, uint64_t *, uint64_t *);
46 typedef boolean_t	(*gcm_will_work_f)(void);
47 
48 #define	GCM_IMPL_NAME_MAX (16)
49 
50 typedef struct gcm_impl_ops {
51 	gcm_mul_f mul;
52 	gcm_will_work_f is_supported;
53 	char name[GCM_IMPL_NAME_MAX];
54 } gcm_impl_ops_t;
55 
56 extern const gcm_impl_ops_t gcm_generic_impl;
57 #if defined(__x86_64) && defined(HAVE_PCLMULQDQ)
58 extern const gcm_impl_ops_t gcm_pclmulqdq_impl;
59 #endif
60 
61 /*
62  * Initializes fastest implementation
63  */
64 void gcm_impl_init(void);
65 
66 /*
67  * Returns optimal allowed GCM implementation
68  */
69 const struct gcm_impl_ops *gcm_impl_get_ops(void);
70 
71 #ifdef	__cplusplus
72 }
73 #endif
74 
75 #endif	/* _GCM_IMPL_H */
76