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