xref: /openbmc/linux/crypto/internal.h (revision 86878f14)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Cryptographic API.
4  *
5  * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
6  * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
7  */
8 #ifndef _CRYPTO_INTERNAL_H
9 #define _CRYPTO_INTERNAL_H
10 
11 #include <crypto/algapi.h>
12 #include <linux/completion.h>
13 #include <linux/err.h>
14 #include <linux/jump_label.h>
15 #include <linux/list.h>
16 #include <linux/module.h>
17 #include <linux/notifier.h>
18 #include <linux/numa.h>
19 #include <linux/refcount.h>
20 #include <linux/rwsem.h>
21 #include <linux/sched.h>
22 #include <linux/types.h>
23 
24 struct crypto_instance;
25 struct crypto_template;
26 
27 struct crypto_larval {
28 	struct crypto_alg alg;
29 	struct crypto_alg *adult;
30 	struct completion completion;
31 	u32 mask;
32 	bool test_started;
33 };
34 
35 enum {
36 	CRYPTOA_UNSPEC,
37 	CRYPTOA_ALG,
38 	CRYPTOA_TYPE,
39 	__CRYPTOA_MAX,
40 };
41 
42 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
43 
44 /* Maximum number of (rtattr) parameters for each template. */
45 #define CRYPTO_MAX_ATTRS 32
46 
47 extern struct list_head crypto_alg_list;
48 extern struct rw_semaphore crypto_alg_sem;
49 extern struct blocking_notifier_head crypto_chain;
50 
51 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
52 
53 #ifdef CONFIG_CRYPTO_MANAGER_DISABLE_TESTS
54 static inline bool crypto_boot_test_finished(void)
55 {
56 	return true;
57 }
58 static inline void set_crypto_boot_test_finished(void)
59 {
60 }
61 #else
62 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
63 static inline bool crypto_boot_test_finished(void)
64 {
65 	return static_branch_likely(&__crypto_boot_test_finished);
66 }
67 static inline void set_crypto_boot_test_finished(void)
68 {
69 	static_branch_enable(&__crypto_boot_test_finished);
70 }
71 #endif /* !CONFIG_CRYPTO_MANAGER_DISABLE_TESTS */
72 
73 #ifdef CONFIG_PROC_FS
74 void __init crypto_init_proc(void);
75 void __exit crypto_exit_proc(void);
76 #else
77 static inline void crypto_init_proc(void)
78 { }
79 static inline void crypto_exit_proc(void)
80 { }
81 #endif
82 
83 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
84 {
85 	return alg->cra_ctxsize;
86 }
87 
88 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
89 {
90 	return alg->cra_ctxsize;
91 }
92 
93 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
94 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
95 
96 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
97 void crypto_larval_kill(struct crypto_alg *alg);
98 void crypto_wait_for_test(struct crypto_larval *larval);
99 void crypto_alg_tested(const char *name, int err);
100 
101 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
102 			  struct crypto_alg *nalg);
103 void crypto_remove_final(struct list_head *list);
104 void crypto_shoot_alg(struct crypto_alg *alg);
105 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
106 				      u32 mask);
107 void *crypto_create_tfm_node(struct crypto_alg *alg,
108 			const struct crypto_type *frontend, int node);
109 void *crypto_clone_tfm(const struct crypto_type *frontend,
110 		       struct crypto_tfm *otfm);
111 
112 static inline void *crypto_create_tfm(struct crypto_alg *alg,
113 			const struct crypto_type *frontend)
114 {
115 	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
116 }
117 
118 struct crypto_alg *crypto_find_alg(const char *alg_name,
119 				   const struct crypto_type *frontend,
120 				   u32 type, u32 mask);
121 
122 void *crypto_alloc_tfm_node(const char *alg_name,
123 		       const struct crypto_type *frontend, u32 type, u32 mask,
124 		       int node);
125 
126 static inline void *crypto_alloc_tfm(const char *alg_name,
127 		       const struct crypto_type *frontend, u32 type, u32 mask)
128 {
129 	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
130 }
131 
132 int crypto_probing_notify(unsigned long val, void *v);
133 
134 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
135 
136 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
137 			u32 type, u32 mask);
138 
139 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
140 {
141 	refcount_inc(&alg->cra_refcnt);
142 	return alg;
143 }
144 
145 static inline void crypto_alg_put(struct crypto_alg *alg)
146 {
147 	if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
148 		alg->cra_destroy(alg);
149 }
150 
151 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
152 {
153 	return try_module_get(tmpl->module);
154 }
155 
156 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
157 {
158 	module_put(tmpl->module);
159 }
160 
161 static inline int crypto_is_larval(struct crypto_alg *alg)
162 {
163 	return alg->cra_flags & CRYPTO_ALG_LARVAL;
164 }
165 
166 static inline int crypto_is_dead(struct crypto_alg *alg)
167 {
168 	return alg->cra_flags & CRYPTO_ALG_DEAD;
169 }
170 
171 static inline int crypto_is_moribund(struct crypto_alg *alg)
172 {
173 	return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
174 }
175 
176 static inline void crypto_notify(unsigned long val, void *v)
177 {
178 	blocking_notifier_call_chain(&crypto_chain, val, v);
179 }
180 
181 static inline void crypto_yield(u32 flags)
182 {
183 	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
184 		cond_resched();
185 }
186 
187 static inline int crypto_is_test_larval(struct crypto_larval *larval)
188 {
189 	return larval->alg.cra_driver_name[0];
190 }
191 
192 static inline struct crypto_tfm *crypto_tfm_get(struct crypto_tfm *tfm)
193 {
194 	return refcount_inc_not_zero(&tfm->refcnt) ? tfm : ERR_PTR(-EOVERFLOW);
195 }
196 
197 #endif	/* _CRYPTO_INTERNAL_H */
198 
199