crypto: api - Move type exit function into crypto_tfm
[safe/jmp/linux-2.6] / include / crypto / algapi.h
1 /*
2  * Cryptographic API for algorithms (i.e., low-level API).
3  *
4  * Copyright (c) 2006 Herbert Xu <herbert@gondor.apana.org.au>
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the Free
8  * Software Foundation; either version 2 of the License, or (at your option) 
9  * any later version.
10  *
11  */
12 #ifndef _CRYPTO_ALGAPI_H
13 #define _CRYPTO_ALGAPI_H
14
15 #include <linux/crypto.h>
16 #include <linux/list.h>
17 #include <linux/kernel.h>
18
19 struct module;
20 struct rtattr;
21 struct seq_file;
22
23 struct crypto_type {
24         unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
25         int (*init)(struct crypto_tfm *tfm, u32 type, u32 mask);
26         void (*show)(struct seq_file *m, struct crypto_alg *alg);
27 };
28
29 struct crypto_instance {
30         struct crypto_alg alg;
31
32         struct crypto_template *tmpl;
33         struct hlist_node list;
34
35         void *__ctx[] CRYPTO_MINALIGN_ATTR;
36 };
37
38 struct crypto_template {
39         struct list_head list;
40         struct hlist_head instances;
41         struct module *module;
42
43         struct crypto_instance *(*alloc)(struct rtattr **tb);
44         void (*free)(struct crypto_instance *inst);
45
46         char name[CRYPTO_MAX_ALG_NAME];
47 };
48
49 struct crypto_spawn {
50         struct list_head list;
51         struct crypto_alg *alg;
52         struct crypto_instance *inst;
53         u32 mask;
54 };
55
56 struct crypto_queue {
57         struct list_head list;
58         struct list_head *backlog;
59
60         unsigned int qlen;
61         unsigned int max_qlen;
62 };
63
64 struct scatter_walk {
65         struct scatterlist *sg;
66         unsigned int offset;
67 };
68
69 struct blkcipher_walk {
70         union {
71                 struct {
72                         struct page *page;
73                         unsigned long offset;
74                 } phys;
75
76                 struct {
77                         u8 *page;
78                         u8 *addr;
79                 } virt;
80         } src, dst;
81
82         struct scatter_walk in;
83         unsigned int nbytes;
84
85         struct scatter_walk out;
86         unsigned int total;
87
88         void *page;
89         u8 *buffer;
90         u8 *iv;
91
92         int flags;
93         unsigned int blocksize;
94 };
95
96 extern const struct crypto_type crypto_ablkcipher_type;
97 extern const struct crypto_type crypto_aead_type;
98 extern const struct crypto_type crypto_blkcipher_type;
99 extern const struct crypto_type crypto_hash_type;
100
101 void crypto_mod_put(struct crypto_alg *alg);
102
103 int crypto_register_template(struct crypto_template *tmpl);
104 void crypto_unregister_template(struct crypto_template *tmpl);
105 struct crypto_template *crypto_lookup_template(const char *name);
106
107 int crypto_init_spawn(struct crypto_spawn *spawn, struct crypto_alg *alg,
108                       struct crypto_instance *inst, u32 mask);
109 void crypto_drop_spawn(struct crypto_spawn *spawn);
110 struct crypto_tfm *crypto_spawn_tfm(struct crypto_spawn *spawn, u32 type,
111                                     u32 mask);
112
113 static inline void crypto_set_spawn(struct crypto_spawn *spawn,
114                                     struct crypto_instance *inst)
115 {
116         spawn->inst = inst;
117 }
118
119 struct crypto_attr_type *crypto_get_attr_type(struct rtattr **tb);
120 int crypto_check_attr_type(struct rtattr **tb, u32 type);
121 const char *crypto_attr_alg_name(struct rtattr *rta);
122 struct crypto_alg *crypto_attr_alg(struct rtattr *rta, u32 type, u32 mask);
123 int crypto_attr_u32(struct rtattr *rta, u32 *num);
124 struct crypto_instance *crypto_alloc_instance(const char *name,
125                                               struct crypto_alg *alg);
126
127 void crypto_init_queue(struct crypto_queue *queue, unsigned int max_qlen);
128 int crypto_enqueue_request(struct crypto_queue *queue,
129                            struct crypto_async_request *request);
130 struct crypto_async_request *crypto_dequeue_request(struct crypto_queue *queue);
131 int crypto_tfm_in_queue(struct crypto_queue *queue, struct crypto_tfm *tfm);
132
133 /* These functions require the input/output to be aligned as u32. */
134 void crypto_inc(u8 *a, unsigned int size);
135 void crypto_xor(u8 *dst, const u8 *src, unsigned int size);
136
137 int blkcipher_walk_done(struct blkcipher_desc *desc,
138                         struct blkcipher_walk *walk, int err);
139 int blkcipher_walk_virt(struct blkcipher_desc *desc,
140                         struct blkcipher_walk *walk);
141 int blkcipher_walk_phys(struct blkcipher_desc *desc,
142                         struct blkcipher_walk *walk);
143 int blkcipher_walk_virt_block(struct blkcipher_desc *desc,
144                               struct blkcipher_walk *walk,
145                               unsigned int blocksize);
146
147 static inline void *crypto_tfm_ctx_aligned(struct crypto_tfm *tfm)
148 {
149         unsigned long addr = (unsigned long)crypto_tfm_ctx(tfm);
150         unsigned long align = crypto_tfm_alg_alignmask(tfm);
151
152         if (align <= crypto_tfm_ctx_alignment())
153                 align = 1;
154         return (void *)ALIGN(addr, align);
155 }
156
157 static inline struct crypto_instance *crypto_tfm_alg_instance(
158         struct crypto_tfm *tfm)
159 {
160         return container_of(tfm->__crt_alg, struct crypto_instance, alg);
161 }
162
163 static inline void *crypto_instance_ctx(struct crypto_instance *inst)
164 {
165         return inst->__ctx;
166 }
167
168 static inline struct ablkcipher_alg *crypto_ablkcipher_alg(
169         struct crypto_ablkcipher *tfm)
170 {
171         return &crypto_ablkcipher_tfm(tfm)->__crt_alg->cra_ablkcipher;
172 }
173
174 static inline void *crypto_ablkcipher_ctx(struct crypto_ablkcipher *tfm)
175 {
176         return crypto_tfm_ctx(&tfm->base);
177 }
178
179 static inline void *crypto_ablkcipher_ctx_aligned(struct crypto_ablkcipher *tfm)
180 {
181         return crypto_tfm_ctx_aligned(&tfm->base);
182 }
183
184 static inline struct aead_alg *crypto_aead_alg(struct crypto_aead *tfm)
185 {
186         return &crypto_aead_tfm(tfm)->__crt_alg->cra_aead;
187 }
188
189 static inline void *crypto_aead_ctx(struct crypto_aead *tfm)
190 {
191         return crypto_tfm_ctx(&tfm->base);
192 }
193
194 static inline struct crypto_instance *crypto_aead_alg_instance(
195         struct crypto_aead *aead)
196 {
197         return crypto_tfm_alg_instance(&aead->base);
198 }
199
200 static inline struct crypto_blkcipher *crypto_spawn_blkcipher(
201         struct crypto_spawn *spawn)
202 {
203         u32 type = CRYPTO_ALG_TYPE_BLKCIPHER;
204         u32 mask = CRYPTO_ALG_TYPE_MASK;
205
206         return __crypto_blkcipher_cast(crypto_spawn_tfm(spawn, type, mask));
207 }
208
209 static inline void *crypto_blkcipher_ctx(struct crypto_blkcipher *tfm)
210 {
211         return crypto_tfm_ctx(&tfm->base);
212 }
213
214 static inline void *crypto_blkcipher_ctx_aligned(struct crypto_blkcipher *tfm)
215 {
216         return crypto_tfm_ctx_aligned(&tfm->base);
217 }
218
219 static inline struct crypto_cipher *crypto_spawn_cipher(
220         struct crypto_spawn *spawn)
221 {
222         u32 type = CRYPTO_ALG_TYPE_CIPHER;
223         u32 mask = CRYPTO_ALG_TYPE_MASK;
224
225         return __crypto_cipher_cast(crypto_spawn_tfm(spawn, type, mask));
226 }
227
228 static inline struct cipher_alg *crypto_cipher_alg(struct crypto_cipher *tfm)
229 {
230         return &crypto_cipher_tfm(tfm)->__crt_alg->cra_cipher;
231 }
232
233 static inline struct crypto_hash *crypto_spawn_hash(struct crypto_spawn *spawn)
234 {
235         u32 type = CRYPTO_ALG_TYPE_HASH;
236         u32 mask = CRYPTO_ALG_TYPE_HASH_MASK;
237
238         return __crypto_hash_cast(crypto_spawn_tfm(spawn, type, mask));
239 }
240
241 static inline void *crypto_hash_ctx_aligned(struct crypto_hash *tfm)
242 {
243         return crypto_tfm_ctx_aligned(&tfm->base);
244 }
245
246 static inline void blkcipher_walk_init(struct blkcipher_walk *walk,
247                                        struct scatterlist *dst,
248                                        struct scatterlist *src,
249                                        unsigned int nbytes)
250 {
251         walk->in.sg = src;
252         walk->out.sg = dst;
253         walk->total = nbytes;
254 }
255
256 static inline struct crypto_async_request *crypto_get_backlog(
257         struct crypto_queue *queue)
258 {
259         return queue->backlog == &queue->list ? NULL :
260                container_of(queue->backlog, struct crypto_async_request, list);
261 }
262
263 static inline int ablkcipher_enqueue_request(struct crypto_queue *queue,
264                                              struct ablkcipher_request *request)
265 {
266         return crypto_enqueue_request(queue, &request->base);
267 }
268
269 static inline struct ablkcipher_request *ablkcipher_dequeue_request(
270         struct crypto_queue *queue)
271 {
272         return ablkcipher_request_cast(crypto_dequeue_request(queue));
273 }
274
275 static inline void *ablkcipher_request_ctx(struct ablkcipher_request *req)
276 {
277         return req->__ctx;
278 }
279
280 static inline int ablkcipher_tfm_in_queue(struct crypto_queue *queue,
281                                           struct crypto_ablkcipher *tfm)
282 {
283         return crypto_tfm_in_queue(queue, crypto_ablkcipher_tfm(tfm));
284 }
285
286 static inline void *aead_request_ctx(struct aead_request *req)
287 {
288         return req->__ctx;
289 }
290
291 static inline void aead_request_complete(struct aead_request *req, int err)
292 {
293         req->base.complete(&req->base, err);
294 }
295
296 static inline u32 aead_request_flags(struct aead_request *req)
297 {
298         return req->base.flags;
299 }
300
301 static inline struct crypto_alg *crypto_get_attr_alg(struct rtattr **tb,
302                                                      u32 type, u32 mask)
303 {
304         return crypto_attr_alg(tb[1], type, mask);
305 }
306
307 /*
308  * Returns CRYPTO_ALG_ASYNC if type/mask requires the use of sync algorithms.
309  * Otherwise returns zero.
310  */
311 static inline int crypto_requires_sync(u32 type, u32 mask)
312 {
313         return (type ^ CRYPTO_ALG_ASYNC) & mask & CRYPTO_ALG_ASYNC;
314 }
315
316 #endif  /* _CRYPTO_ALGAPI_H */
317