xref: /linux/crypto/internal.h (revision bf80eef2212a1e8451df13b52533f4bc31bb4f8e)
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/jump_label.h>
14 #include <linux/list.h>
15 #include <linux/module.h>
16 #include <linux/notifier.h>
17 #include <linux/numa.h>
18 #include <linux/refcount.h>
19 #include <linux/rwsem.h>
20 #include <linux/sched.h>
21 #include <linux/types.h>
22 
23 struct crypto_instance;
24 struct crypto_template;
25 
26 struct crypto_larval {
27 	struct crypto_alg alg;
28 	struct crypto_alg *adult;
29 	struct completion completion;
30 	u32 mask;
31 	bool test_started;
32 };
33 
34 enum {
35 	CRYPTOA_UNSPEC,
36 	CRYPTOA_ALG,
37 	CRYPTOA_TYPE,
38 	__CRYPTOA_MAX,
39 };
40 
41 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
42 
43 /* Maximum number of (rtattr) parameters for each template. */
44 #define CRYPTO_MAX_ATTRS 32
45 
46 extern struct list_head crypto_alg_list;
47 extern struct rw_semaphore crypto_alg_sem;
48 extern struct blocking_notifier_head crypto_chain;
49 
50 DECLARE_STATIC_KEY_FALSE(crypto_boot_test_finished);
51 
52 #ifdef CONFIG_PROC_FS
53 void __init crypto_init_proc(void);
54 void __exit crypto_exit_proc(void);
55 #else
56 static inline void crypto_init_proc(void)
57 { }
58 static inline void crypto_exit_proc(void)
59 { }
60 #endif
61 
62 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
63 {
64 	return alg->cra_ctxsize;
65 }
66 
67 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
68 {
69 	return alg->cra_ctxsize;
70 }
71 
72 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
73 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
74 
75 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
76 void crypto_larval_kill(struct crypto_alg *alg);
77 void crypto_wait_for_test(struct crypto_larval *larval);
78 void crypto_alg_tested(const char *name, int err);
79 
80 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
81 			  struct crypto_alg *nalg);
82 void crypto_remove_final(struct list_head *list);
83 void crypto_shoot_alg(struct crypto_alg *alg);
84 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
85 				      u32 mask);
86 void *crypto_create_tfm_node(struct crypto_alg *alg,
87 			const struct crypto_type *frontend, int node);
88 
89 static inline void *crypto_create_tfm(struct crypto_alg *alg,
90 			const struct crypto_type *frontend)
91 {
92 	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
93 }
94 
95 struct crypto_alg *crypto_find_alg(const char *alg_name,
96 				   const struct crypto_type *frontend,
97 				   u32 type, u32 mask);
98 
99 void *crypto_alloc_tfm_node(const char *alg_name,
100 		       const struct crypto_type *frontend, u32 type, u32 mask,
101 		       int node);
102 
103 static inline void *crypto_alloc_tfm(const char *alg_name,
104 		       const struct crypto_type *frontend, u32 type, u32 mask)
105 {
106 	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
107 }
108 
109 int crypto_probing_notify(unsigned long val, void *v);
110 
111 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
112 
113 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
114 			u32 type, u32 mask);
115 
116 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
117 {
118 	refcount_inc(&alg->cra_refcnt);
119 	return alg;
120 }
121 
122 static inline void crypto_alg_put(struct crypto_alg *alg)
123 {
124 	if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
125 		alg->cra_destroy(alg);
126 }
127 
128 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
129 {
130 	return try_module_get(tmpl->module);
131 }
132 
133 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
134 {
135 	module_put(tmpl->module);
136 }
137 
138 static inline int crypto_is_larval(struct crypto_alg *alg)
139 {
140 	return alg->cra_flags & CRYPTO_ALG_LARVAL;
141 }
142 
143 static inline int crypto_is_dead(struct crypto_alg *alg)
144 {
145 	return alg->cra_flags & CRYPTO_ALG_DEAD;
146 }
147 
148 static inline int crypto_is_moribund(struct crypto_alg *alg)
149 {
150 	return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
151 }
152 
153 static inline void crypto_notify(unsigned long val, void *v)
154 {
155 	blocking_notifier_call_chain(&crypto_chain, val, v);
156 }
157 
158 static inline void crypto_yield(u32 flags)
159 {
160 	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
161 		cond_resched();
162 }
163 
164 static inline int crypto_is_test_larval(struct crypto_larval *larval)
165 {
166 	return larval->alg.cra_driver_name[0];
167 }
168 
169 #endif	/* _CRYPTO_INTERNAL_H */
170 
171