blob: de4247021d25a0dae391d4c2e93f16f8b882d41e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * JFFS2 -- Journalling Flash File System, Version 2.
3 *
David Woodhousec00c3102007-04-25 14:16:47 +01004 * Copyright © 2001-2007 Red Hat, Inc.
David Woodhouse6088c052010-08-08 14:15:22 +01005 * Copyright © 2004-2010 David Woodhouse <dwmw2@infradead.org>
David Woodhousec00c3102007-04-25 14:16:47 +01006 * Copyright © 2004 Ferenc Havasi <havasi@inf.u-szeged.hu>,
David Woodhouseef53cb02007-07-10 10:01:22 +01007 * University of Szeged, Hungary
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 *
David Woodhouse6088c052010-08-08 14:15:22 +01009 * Created by Arjan van de Ven <arjan@infradead.org>
10 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 * For licensing information, see the file 'LICENCE' in this directory.
12 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
14
15#include "compr.h"
16
17static DEFINE_SPINLOCK(jffs2_compressor_list_lock);
18
19/* Available compressors are on this list */
20static LIST_HEAD(jffs2_compressor_list);
21
22/* Actual compression mode */
23static int jffs2_compression_mode = JFFS2_COMPR_MODE_PRIORITY;
24
25/* Statistics for blocks stored without compression */
26static uint32_t none_stat_compr_blocks=0,none_stat_decompr_blocks=0,none_stat_compr_size=0;
27
Richard Purdie3b23c1f2007-07-10 10:28:42 +010028
29/*
30 * Return 1 to use this compression
31 */
32static int jffs2_is_best_compression(struct jffs2_compressor *this,
33 struct jffs2_compressor *best, uint32_t size, uint32_t bestsize)
34{
35 switch (jffs2_compression_mode) {
36 case JFFS2_COMPR_MODE_SIZE:
37 if (bestsize > size)
38 return 1;
39 return 0;
40 case JFFS2_COMPR_MODE_FAVOURLZO:
41 if ((this->compr == JFFS2_COMPR_LZO) && (bestsize > size))
42 return 1;
43 if ((best->compr != JFFS2_COMPR_LZO) && (bestsize > size))
44 return 1;
45 if ((this->compr == JFFS2_COMPR_LZO) && (bestsize > (size * FAVOUR_LZO_PERCENT / 100)))
46 return 1;
47 if ((bestsize * FAVOUR_LZO_PERCENT / 100) > size)
48 return 1;
49
50 return 0;
51 }
52 /* Shouldn't happen */
53 return 0;
54}
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/* jffs2_compress:
Geert Uytterhoevenfaa5c2a2008-10-17 16:19:45 +020057 * @data_in: Pointer to uncompressed data
58 * @cpage_out: Pointer to returned pointer to buffer for compressed data
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 * @datalen: On entry, holds the amount of data available for compression.
60 * On exit, expected to hold the amount of data actually compressed.
61 * @cdatalen: On entry, holds the amount of space available for compressed
62 * data. On exit, expected to hold the actual size of the compressed
63 * data.
64 *
65 * Returns: Lower byte to be stored with data indicating compression type used.
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000066 * Zero is used to show that the data could not be compressed - the
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * compressed version was actually larger than the original.
68 * Upper byte will be used later. (soon)
69 *
70 * If the cdata buffer isn't large enough to hold all the uncompressed data,
Thomas Gleixner182ec4e2005-11-07 11:16:07 +000071 * jffs2_compress should compress as much as will fit, and should set
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * *datalen accordingly to show the amount of data which were compressed.
73 */
74uint16_t jffs2_compress(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
David Woodhouseef53cb02007-07-10 10:01:22 +010075 unsigned char *data_in, unsigned char **cpage_out,
76 uint32_t *datalen, uint32_t *cdatalen)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077{
78 int ret = JFFS2_COMPR_NONE;
David Woodhouseef53cb02007-07-10 10:01:22 +010079 int compr_ret;
80 struct jffs2_compressor *this, *best=NULL;
81 unsigned char *output_buf = NULL, *tmp_buf;
82 uint32_t orig_slen, orig_dlen;
83 uint32_t best_slen=0, best_dlen=0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
David Woodhouseef53cb02007-07-10 10:01:22 +010085 switch (jffs2_compression_mode) {
86 case JFFS2_COMPR_MODE_NONE:
87 break;
88 case JFFS2_COMPR_MODE_PRIORITY:
89 output_buf = kmalloc(*cdatalen,GFP_KERNEL);
90 if (!output_buf) {
91 printk(KERN_WARNING "JFFS2: No memory for compressor allocation. Compression failed.\n");
92 goto out;
93 }
94 orig_slen = *datalen;
95 orig_dlen = *cdatalen;
96 spin_lock(&jffs2_compressor_list_lock);
97 list_for_each_entry(this, &jffs2_compressor_list, list) {
98 /* Skip decompress-only backwards-compatibility and disabled modules */
99 if ((!this->compress)||(this->disabled))
100 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
David Woodhouseef53cb02007-07-10 10:01:22 +0100102 this->usecount++;
103 spin_unlock(&jffs2_compressor_list_lock);
104 *datalen = orig_slen;
105 *cdatalen = orig_dlen;
Mike Frysinger088bd452010-09-22 22:52:33 -0400106 compr_ret = this->compress(data_in, output_buf, datalen, cdatalen);
David Woodhouseef53cb02007-07-10 10:01:22 +0100107 spin_lock(&jffs2_compressor_list_lock);
108 this->usecount--;
109 if (!compr_ret) {
110 ret = this->compr;
111 this->stat_compr_blocks++;
112 this->stat_compr_orig_size += *datalen;
113 this->stat_compr_new_size += *cdatalen;
114 break;
115 }
116 }
117 spin_unlock(&jffs2_compressor_list_lock);
118 if (ret == JFFS2_COMPR_NONE)
119 kfree(output_buf);
120 break;
121 case JFFS2_COMPR_MODE_SIZE:
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100122 case JFFS2_COMPR_MODE_FAVOURLZO:
David Woodhouseef53cb02007-07-10 10:01:22 +0100123 orig_slen = *datalen;
124 orig_dlen = *cdatalen;
125 spin_lock(&jffs2_compressor_list_lock);
126 list_for_each_entry(this, &jffs2_compressor_list, list) {
127 /* Skip decompress-only backwards-compatibility and disabled modules */
128 if ((!this->compress)||(this->disabled))
129 continue;
130 /* Allocating memory for output buffer if necessary */
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100131 if ((this->compr_buf_size < orig_slen) && (this->compr_buf)) {
David Woodhouseef53cb02007-07-10 10:01:22 +0100132 spin_unlock(&jffs2_compressor_list_lock);
133 kfree(this->compr_buf);
134 spin_lock(&jffs2_compressor_list_lock);
135 this->compr_buf_size=0;
136 this->compr_buf=NULL;
137 }
138 if (!this->compr_buf) {
139 spin_unlock(&jffs2_compressor_list_lock);
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100140 tmp_buf = kmalloc(orig_slen, GFP_KERNEL);
David Woodhouseef53cb02007-07-10 10:01:22 +0100141 spin_lock(&jffs2_compressor_list_lock);
142 if (!tmp_buf) {
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100143 printk(KERN_WARNING "JFFS2: No memory for compressor allocation. (%d bytes)\n", orig_slen);
David Woodhouseef53cb02007-07-10 10:01:22 +0100144 continue;
145 }
146 else {
147 this->compr_buf = tmp_buf;
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100148 this->compr_buf_size = orig_slen;
David Woodhouseef53cb02007-07-10 10:01:22 +0100149 }
150 }
151 this->usecount++;
152 spin_unlock(&jffs2_compressor_list_lock);
153 *datalen = orig_slen;
154 *cdatalen = orig_dlen;
Mike Frysinger088bd452010-09-22 22:52:33 -0400155 compr_ret = this->compress(data_in, this->compr_buf, datalen, cdatalen);
David Woodhouseef53cb02007-07-10 10:01:22 +0100156 spin_lock(&jffs2_compressor_list_lock);
157 this->usecount--;
158 if (!compr_ret) {
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100159 if (((!best_dlen) || jffs2_is_best_compression(this, best, *cdatalen, best_dlen))
160 && (*cdatalen < *datalen)) {
David Woodhouseef53cb02007-07-10 10:01:22 +0100161 best_dlen = *cdatalen;
162 best_slen = *datalen;
163 best = this;
164 }
165 }
166 }
167 if (best_dlen) {
168 *cdatalen = best_dlen;
169 *datalen = best_slen;
170 output_buf = best->compr_buf;
171 best->compr_buf = NULL;
172 best->compr_buf_size = 0;
173 best->stat_compr_blocks++;
174 best->stat_compr_orig_size += best_slen;
175 best->stat_compr_new_size += best_dlen;
176 ret = best->compr;
177 }
178 spin_unlock(&jffs2_compressor_list_lock);
179 break;
180 default:
André Goddard Rosaaf901ca2009-11-14 13:09:05 -0200181 printk(KERN_ERR "JFFS2: unknown compression mode.\n");
David Woodhouseef53cb02007-07-10 10:01:22 +0100182 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 out:
David Woodhouseef53cb02007-07-10 10:01:22 +0100184 if (ret == JFFS2_COMPR_NONE) {
185 *cpage_out = data_in;
186 *datalen = *cdatalen;
187 none_stat_compr_blocks++;
188 none_stat_compr_size += *datalen;
189 }
190 else {
191 *cpage_out = output_buf;
192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 return ret;
194}
195
196int jffs2_decompress(struct jffs2_sb_info *c, struct jffs2_inode_info *f,
Thomas Gleixner182ec4e2005-11-07 11:16:07 +0000197 uint16_t comprtype, unsigned char *cdata_in,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 unsigned char *data_out, uint32_t cdatalen, uint32_t datalen)
199{
David Woodhouseef53cb02007-07-10 10:01:22 +0100200 struct jffs2_compressor *this;
201 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203 /* Older code had a bug where it would write non-zero 'usercompr'
204 fields. Deal with it. */
205 if ((comprtype & 0xff) <= JFFS2_COMPR_ZLIB)
206 comprtype &= 0xff;
207
208 switch (comprtype & 0xff) {
209 case JFFS2_COMPR_NONE:
210 /* This should be special-cased elsewhere, but we might as well deal with it */
211 memcpy(data_out, cdata_in, datalen);
David Woodhouseef53cb02007-07-10 10:01:22 +0100212 none_stat_decompr_blocks++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 break;
214 case JFFS2_COMPR_ZERO:
215 memset(data_out, 0, datalen);
216 break;
217 default:
David Woodhouseef53cb02007-07-10 10:01:22 +0100218 spin_lock(&jffs2_compressor_list_lock);
219 list_for_each_entry(this, &jffs2_compressor_list, list) {
220 if (comprtype == this->compr) {
221 this->usecount++;
222 spin_unlock(&jffs2_compressor_list_lock);
Mike Frysinger088bd452010-09-22 22:52:33 -0400223 ret = this->decompress(cdata_in, data_out, cdatalen, datalen);
David Woodhouseef53cb02007-07-10 10:01:22 +0100224 spin_lock(&jffs2_compressor_list_lock);
225 if (ret) {
226 printk(KERN_WARNING "Decompressor \"%s\" returned %d\n", this->name, ret);
227 }
228 else {
229 this->stat_decompr_blocks++;
230 }
231 this->usecount--;
232 spin_unlock(&jffs2_compressor_list_lock);
233 return ret;
234 }
235 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 printk(KERN_WARNING "JFFS2 compression type 0x%02x not available.\n", comprtype);
David Woodhouseef53cb02007-07-10 10:01:22 +0100237 spin_unlock(&jffs2_compressor_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 return -EIO;
239 }
240 return 0;
241}
242
243int jffs2_register_compressor(struct jffs2_compressor *comp)
244{
David Woodhouseef53cb02007-07-10 10:01:22 +0100245 struct jffs2_compressor *this;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
David Woodhouseef53cb02007-07-10 10:01:22 +0100247 if (!comp->name) {
248 printk(KERN_WARNING "NULL compressor name at registering JFFS2 compressor. Failed.\n");
249 return -1;
250 }
251 comp->compr_buf_size=0;
252 comp->compr_buf=NULL;
253 comp->usecount=0;
254 comp->stat_compr_orig_size=0;
255 comp->stat_compr_new_size=0;
256 comp->stat_compr_blocks=0;
257 comp->stat_decompr_blocks=0;
258 D1(printk(KERN_DEBUG "Registering JFFS2 compressor \"%s\"\n", comp->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
David Woodhouseef53cb02007-07-10 10:01:22 +0100260 spin_lock(&jffs2_compressor_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
David Woodhouseef53cb02007-07-10 10:01:22 +0100262 list_for_each_entry(this, &jffs2_compressor_list, list) {
263 if (this->priority < comp->priority) {
264 list_add(&comp->list, this->list.prev);
265 goto out;
266 }
267 }
268 list_add_tail(&comp->list, &jffs2_compressor_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269out:
David Woodhouseef53cb02007-07-10 10:01:22 +0100270 D2(list_for_each_entry(this, &jffs2_compressor_list, list) {
271 printk(KERN_DEBUG "Compressor \"%s\", prio %d\n", this->name, this->priority);
272 })
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
David Woodhouseef53cb02007-07-10 10:01:22 +0100274 spin_unlock(&jffs2_compressor_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
David Woodhouseef53cb02007-07-10 10:01:22 +0100276 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277}
278
279int jffs2_unregister_compressor(struct jffs2_compressor *comp)
280{
David Woodhouseef53cb02007-07-10 10:01:22 +0100281 D2(struct jffs2_compressor *this;)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
David Woodhouseef53cb02007-07-10 10:01:22 +0100283 D1(printk(KERN_DEBUG "Unregistering JFFS2 compressor \"%s\"\n", comp->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
David Woodhouseef53cb02007-07-10 10:01:22 +0100285 spin_lock(&jffs2_compressor_list_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
David Woodhouseef53cb02007-07-10 10:01:22 +0100287 if (comp->usecount) {
288 spin_unlock(&jffs2_compressor_list_lock);
289 printk(KERN_WARNING "JFFS2: Compressor modul is in use. Unregister failed.\n");
290 return -1;
291 }
292 list_del(&comp->list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
David Woodhouseef53cb02007-07-10 10:01:22 +0100294 D2(list_for_each_entry(this, &jffs2_compressor_list, list) {
295 printk(KERN_DEBUG "Compressor \"%s\", prio %d\n", this->name, this->priority);
296 })
297 spin_unlock(&jffs2_compressor_list_lock);
298 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301void jffs2_free_comprbuf(unsigned char *comprbuf, unsigned char *orig)
302{
David Woodhouseef53cb02007-07-10 10:01:22 +0100303 if (orig != comprbuf)
304 kfree(comprbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305}
306
David Brownell7d2beb12006-05-16 16:08:10 +0100307int __init jffs2_compressors_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308{
309/* Registering compressors */
310#ifdef CONFIG_JFFS2_ZLIB
David Woodhouseef53cb02007-07-10 10:01:22 +0100311 jffs2_zlib_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312#endif
313#ifdef CONFIG_JFFS2_RTIME
David Woodhouseef53cb02007-07-10 10:01:22 +0100314 jffs2_rtime_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315#endif
316#ifdef CONFIG_JFFS2_RUBIN
David Woodhouseef53cb02007-07-10 10:01:22 +0100317 jffs2_rubinmips_init();
318 jffs2_dynrubin_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319#endif
Richard Purdiec799aca2007-07-10 10:28:36 +0100320#ifdef CONFIG_JFFS2_LZO
321 jffs2_lzo_init();
322#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323/* Setting default compression mode */
324#ifdef CONFIG_JFFS2_CMODE_NONE
David Woodhouseef53cb02007-07-10 10:01:22 +0100325 jffs2_compression_mode = JFFS2_COMPR_MODE_NONE;
326 D1(printk(KERN_INFO "JFFS2: default compression mode: none\n");)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327#else
328#ifdef CONFIG_JFFS2_CMODE_SIZE
David Woodhouseef53cb02007-07-10 10:01:22 +0100329 jffs2_compression_mode = JFFS2_COMPR_MODE_SIZE;
330 D1(printk(KERN_INFO "JFFS2: default compression mode: size\n");)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331#else
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100332#ifdef CONFIG_JFFS2_CMODE_FAVOURLZO
333 jffs2_compression_mode = JFFS2_COMPR_MODE_FAVOURLZO;
334 D1(printk(KERN_INFO "JFFS2: default compression mode: favourlzo\n");)
335#else
David Woodhouseef53cb02007-07-10 10:01:22 +0100336 D1(printk(KERN_INFO "JFFS2: default compression mode: priority\n");)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337#endif
338#endif
Richard Purdie3b23c1f2007-07-10 10:28:42 +0100339#endif
David Woodhouseef53cb02007-07-10 10:01:22 +0100340 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341}
342
David Woodhouse3bcc86f2006-06-03 00:25:50 +0100343int jffs2_compressors_exit(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344{
345/* Unregistering compressors */
Richard Purdiec799aca2007-07-10 10:28:36 +0100346#ifdef CONFIG_JFFS2_LZO
347 jffs2_lzo_exit();
348#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349#ifdef CONFIG_JFFS2_RUBIN
David Woodhouseef53cb02007-07-10 10:01:22 +0100350 jffs2_dynrubin_exit();
351 jffs2_rubinmips_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352#endif
353#ifdef CONFIG_JFFS2_RTIME
David Woodhouseef53cb02007-07-10 10:01:22 +0100354 jffs2_rtime_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355#endif
356#ifdef CONFIG_JFFS2_ZLIB
David Woodhouseef53cb02007-07-10 10:01:22 +0100357 jffs2_zlib_exit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358#endif
David Woodhouseef53cb02007-07-10 10:01:22 +0100359 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360}