aboutsummaryrefslogtreecommitdiffstats
path: root/include/crypto/compress.h
diff options
context:
space:
mode:
authorGeert Uytterhoeven <Geert.Uytterhoeven@sonycom.com>2009-03-04 02:05:33 -0500
committerHerbert Xu <herbert@gondor.apana.org.au>2009-03-04 02:05:33 -0500
commita1d2f09544065b60598b8167d94a6371bff3e892 (patch)
treecd8b88e7ea0cd44e7e369f670f9fdfcba78f4326 /include/crypto/compress.h
parente9cc8bddaea3944fabfebb968bc88d603239beed (diff)
crypto: compress - Add pcomp interface
The current "comp" crypto interface supports one-shot (de)compression only, i.e. the whole data buffer to be (de)compressed must be passed at once, and the whole (de)compressed data buffer will be received at once. In several use-cases (e.g. compressed file systems that store files in big compressed blocks), this workflow is not suitable. Furthermore, the "comp" type doesn't provide for the configuration of (de)compression parameters, and always allocates workspace memory for both compression and decompression, which may waste memory. To solve this, add a "pcomp" partial (de)compression interface that provides the following operations: - crypto_compress_{init,update,final}() for compression, - crypto_decompress_{init,update,final}() for decompression, - crypto_{,de}compress_setup(), to configure (de)compression parameters (incl. allocating workspace memory). The (de)compression methods take a struct comp_request, which was mimicked after the z_stream object in zlib, and contains buffer pointer and length pairs for input and output. The setup methods take an opaque parameter pointer and length pair. Parameters are supposed to be encoded using netlink attributes, whose meanings depend on the actual (name of the) (de)compression algorithm. Signed-off-by: Geert Uytterhoeven <Geert.Uytterhoeven@sonycom.com> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
Diffstat (limited to 'include/crypto/compress.h')
-rw-r--r--include/crypto/compress.h125
1 files changed, 125 insertions, 0 deletions
diff --git a/include/crypto/compress.h b/include/crypto/compress.h
new file mode 100644
index 000000000000..b7d228708d6b
--- /dev/null
+++ b/include/crypto/compress.h
@@ -0,0 +1,125 @@
1/*
2 * Compress: Compression algorithms under the cryptographic API.
3 *
4 * Copyright 2008 Sony Corporation
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program.
17 * If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef _CRYPTO_COMPRESS_H
21#define _CRYPTO_COMPRESS_H
22
23#include <linux/crypto.h>
24
25
26struct comp_request {
27 const void *next_in; /* next input byte */
28 void *next_out; /* next output byte */
29 unsigned int avail_in; /* bytes available at next_in */
30 unsigned int avail_out; /* bytes available at next_out */
31};
32
33struct crypto_pcomp {
34 struct crypto_tfm base;
35};
36
37struct pcomp_alg {
38 int (*compress_setup)(struct crypto_pcomp *tfm, void *params,
39 unsigned int len);
40 int (*compress_init)(struct crypto_pcomp *tfm);
41 int (*compress_update)(struct crypto_pcomp *tfm,
42 struct comp_request *req);
43 int (*compress_final)(struct crypto_pcomp *tfm,
44 struct comp_request *req);
45 int (*decompress_setup)(struct crypto_pcomp *tfm, void *params,
46 unsigned int len);
47 int (*decompress_init)(struct crypto_pcomp *tfm);
48 int (*decompress_update)(struct crypto_pcomp *tfm,
49 struct comp_request *req);
50 int (*decompress_final)(struct crypto_pcomp *tfm,
51 struct comp_request *req);
52
53 struct crypto_alg base;
54};
55
56extern struct crypto_pcomp *crypto_alloc_pcomp(const char *alg_name, u32 type,
57 u32 mask);
58
59static inline struct crypto_tfm *crypto_pcomp_tfm(struct crypto_pcomp *tfm)
60{
61 return &tfm->base;
62}
63
64static inline void crypto_free_pcomp(struct crypto_pcomp *tfm)
65{
66 crypto_destroy_tfm(tfm, crypto_pcomp_tfm(tfm));
67}
68
69static inline struct pcomp_alg *__crypto_pcomp_alg(struct crypto_alg *alg)
70{
71 return container_of(alg, struct pcomp_alg, base);
72}
73
74static inline struct pcomp_alg *crypto_pcomp_alg(struct crypto_pcomp *tfm)
75{
76 return __crypto_pcomp_alg(crypto_pcomp_tfm(tfm)->__crt_alg);
77}
78
79static inline int crypto_compress_setup(struct crypto_pcomp *tfm,
80 void *params, unsigned int len)
81{
82 return crypto_pcomp_alg(tfm)->compress_setup(tfm, params, len);
83}
84
85static inline int crypto_compress_init(struct crypto_pcomp *tfm)
86{
87 return crypto_pcomp_alg(tfm)->compress_init(tfm);
88}
89
90static inline int crypto_compress_update(struct crypto_pcomp *tfm,
91 struct comp_request *req)
92{
93 return crypto_pcomp_alg(tfm)->compress_update(tfm, req);
94}
95
96static inline int crypto_compress_final(struct crypto_pcomp *tfm,
97 struct comp_request *req)
98{
99 return crypto_pcomp_alg(tfm)->compress_final(tfm, req);
100}
101
102static inline int crypto_decompress_setup(struct crypto_pcomp *tfm,
103 void *params, unsigned int len)
104{
105 return crypto_pcomp_alg(tfm)->decompress_setup(tfm, params, len);
106}
107
108static inline int crypto_decompress_init(struct crypto_pcomp *tfm)
109{
110 return crypto_pcomp_alg(tfm)->decompress_init(tfm);
111}
112
113static inline int crypto_decompress_update(struct crypto_pcomp *tfm,
114 struct comp_request *req)
115{
116 return crypto_pcomp_alg(tfm)->decompress_update(tfm, req);
117}
118
119static inline int crypto_decompress_final(struct crypto_pcomp *tfm,
120 struct comp_request *req)
121{
122 return crypto_pcomp_alg(tfm)->decompress_final(tfm, req);
123}
124
125#endif /* _CRYPTO_COMPRESS_H */