blob: b94a31bdd87d15f34a7f4902eb6170f800c01206 [file] [log] [blame]
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -08001/*
2 * LZO decompressor for the Linux kernel. Code borrowed from the lzo
3 * implementation by Markus Franz Xaver Johannes Oberhumer.
4 *
5 * Linux kernel adaptation:
6 * Copyright (C) 2009
7 * Albin Tonnerre, Free Electrons <albin.tonnerre@free-electrons.com>
8 *
9 * Original code:
10 * Copyright (C) 1996-2005 Markus Franz Xaver Johannes Oberhumer
11 * All Rights Reserved.
12 *
13 * lzop and the LZO library are free software; you can redistribute them
14 * and/or modify them under the terms of the GNU General Public License as
15 * published by the Free Software Foundation; either version 2 of
16 * the License, or (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with this program; see the file COPYING.
25 * If not, write to the Free Software Foundation, Inc.,
26 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 *
28 * Markus F.X.J. Oberhumer
29 * <markus@oberhumer.com>
30 * http://www.oberhumer.com/opensource/lzop/
31 */
32
33#ifdef STATIC
Markus F.X.J. Oberhumerb6bec262012-08-13 17:24:24 +020034#include "lzo/lzo1x_decompress_safe.c"
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080035#else
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080036#include <linux/decompress/unlzo.h>
37#endif
38
39#include <linux/types.h>
40#include <linux/lzo.h>
41#include <linux/decompress/mm.h>
42
43#include <linux/compiler.h>
44#include <asm/unaligned.h>
45
46static const unsigned char lzop_magic[] = {
47 0x89, 0x4c, 0x5a, 0x4f, 0x00, 0x0d, 0x0a, 0x1a, 0x0a };
48
49#define LZO_BLOCK_SIZE (256*1024l)
50#define HEADER_HAS_FILTER 0x00000800L
Lasse Collin5a3f81a2011-01-12 17:01:21 -080051#define HEADER_SIZE_MIN (9 + 7 + 4 + 8 + 1 + 4)
52#define HEADER_SIZE_MAX (9 + 7 + 1 + 8 + 8 + 4 + 1 + 255 + 4)
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080053
Yinghai Lud97b07c2014-08-08 14:23:14 -070054STATIC inline long INIT parse_header(u8 *input, long *skip, long in_len)
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080055{
56 int l;
57 u8 *parse = input;
Lasse Collin5a3f81a2011-01-12 17:01:21 -080058 u8 *end = input + in_len;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080059 u8 level = 0;
60 u16 version;
61
Lasse Collin5a3f81a2011-01-12 17:01:21 -080062 /*
63 * Check that there's enough input to possibly have a valid header.
64 * Then it is possible to parse several fields until the minimum
65 * size may have been used.
66 */
67 if (in_len < HEADER_SIZE_MIN)
68 return 0;
69
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080070 /* read magic: 9 first bits */
71 for (l = 0; l < 9; l++) {
72 if (*parse++ != lzop_magic[l])
73 return 0;
74 }
75 /* get version (2bytes), skip library version (2),
76 * 'need to be extracted' version (2) and
77 * method (1) */
78 version = get_unaligned_be16(parse);
79 parse += 7;
80 if (version >= 0x0940)
81 level = *parse++;
82 if (get_unaligned_be32(parse) & HEADER_HAS_FILTER)
83 parse += 8; /* flags + filter info */
84 else
85 parse += 4; /* flags */
86
Lasse Collin5a3f81a2011-01-12 17:01:21 -080087 /*
88 * At least mode, mtime_low, filename length, and checksum must
89 * be left to be parsed. If also mtime_high is present, it's OK
90 * because the next input buffer check is after reading the
91 * filename length.
92 */
93 if (end - parse < 8 + 1 + 4)
94 return 0;
95
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080096 /* skip mode and mtime_low */
97 parse += 8;
98 if (version >= 0x0940)
99 parse += 4; /* skip mtime_high */
100
101 l = *parse++;
102 /* don't care about the file name, and skip checksum */
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800103 if (end - parse < l + 4)
104 return 0;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800105 parse += l + 4;
106
107 *skip = parse - input;
108 return 1;
109}
110
Yinghai Lud97b07c2014-08-08 14:23:14 -0700111STATIC int INIT unlzo(u8 *input, long in_len,
112 long (*fill)(void *, unsigned long),
113 long (*flush)(void *, unsigned long),
114 u8 *output, long *posp,
Lasse Collin93685ad22011-01-12 17:01:14 -0800115 void (*error) (char *x))
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800116{
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800117 u8 r = 0;
Yinghai Lud97b07c2014-08-08 14:23:14 -0700118 long skip = 0;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800119 u32 src_len, dst_len;
120 size_t tmp;
121 u8 *in_buf, *in_buf_save, *out_buf;
Albin Tonnerreccdb4002010-04-23 13:17:58 -0400122 int ret = -1;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800123
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800124 if (output) {
125 out_buf = output;
126 } else if (!flush) {
127 error("NULL output pointer and no flush function provided");
128 goto exit;
129 } else {
130 out_buf = malloc(LZO_BLOCK_SIZE);
131 if (!out_buf) {
132 error("Could not allocate output buffer");
133 goto exit;
134 }
135 }
136
137 if (input && fill) {
138 error("Both input pointer and fill function provided, don't know what to do");
139 goto exit_1;
140 } else if (input) {
141 in_buf = input;
Lasse Collinfb7fa582011-01-12 17:01:21 -0800142 } else if (!fill) {
143 error("NULL input pointer and missing fill function");
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800144 goto exit_1;
145 } else {
146 in_buf = malloc(lzo1x_worst_compress(LZO_BLOCK_SIZE));
147 if (!in_buf) {
148 error("Could not allocate input buffer");
149 goto exit_1;
150 }
151 }
152 in_buf_save = in_buf;
153
154 if (posp)
155 *posp = 0;
156
Lasse Collinfb7fa582011-01-12 17:01:21 -0800157 if (fill) {
158 /*
159 * Start from in_buf + HEADER_SIZE_MAX to make it possible
160 * to use memcpy() to copy the unused data to the beginning
161 * of the buffer. This way memmove() isn't needed which
162 * is missing from pre-boot environments of most archs.
163 */
164 in_buf += HEADER_SIZE_MAX;
165 in_len = fill(in_buf, HEADER_SIZE_MAX);
166 }
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800167
Lasse Collinfb7fa582011-01-12 17:01:21 -0800168 if (!parse_header(in_buf, &skip, in_len)) {
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800169 error("invalid header");
170 goto exit_2;
171 }
172 in_buf += skip;
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800173 in_len -= skip;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800174
Lasse Collinfb7fa582011-01-12 17:01:21 -0800175 if (fill) {
176 /* Move the unused data to the beginning of the buffer. */
177 memcpy(in_buf_save, in_buf, in_len);
178 in_buf = in_buf_save;
179 }
180
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800181 if (posp)
182 *posp = skip;
183
184 for (;;) {
185 /* read uncompressed block size */
Lasse Collinfb7fa582011-01-12 17:01:21 -0800186 if (fill && in_len < 4) {
187 skip = fill(in_buf + in_len, 4 - in_len);
188 if (skip > 0)
189 in_len += skip;
190 }
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800191 if (in_len < 4) {
192 error("file corrupted");
193 goto exit_2;
194 }
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800195 dst_len = get_unaligned_be32(in_buf);
196 in_buf += 4;
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800197 in_len -= 4;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800198
199 /* exit if last block */
200 if (dst_len == 0) {
201 if (posp)
202 *posp += 4;
203 break;
204 }
205
206 if (dst_len > LZO_BLOCK_SIZE) {
207 error("dest len longer than block size");
208 goto exit_2;
209 }
210
211 /* read compressed block size, and skip block checksum info */
Lasse Collinfb7fa582011-01-12 17:01:21 -0800212 if (fill && in_len < 8) {
213 skip = fill(in_buf + in_len, 8 - in_len);
214 if (skip > 0)
215 in_len += skip;
216 }
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800217 if (in_len < 8) {
218 error("file corrupted");
219 goto exit_2;
220 }
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800221 src_len = get_unaligned_be32(in_buf);
222 in_buf += 8;
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800223 in_len -= 8;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800224
Lasse Collinfb7fa582011-01-12 17:01:21 -0800225 if (src_len <= 0 || src_len > dst_len) {
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800226 error("file corrupted");
227 goto exit_2;
228 }
229
230 /* decompress */
Lasse Collinfb7fa582011-01-12 17:01:21 -0800231 if (fill && in_len < src_len) {
232 skip = fill(in_buf + in_len, src_len - in_len);
233 if (skip > 0)
234 in_len += skip;
235 }
236 if (in_len < src_len) {
237 error("file corrupted");
238 goto exit_2;
239 }
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800240 tmp = dst_len;
Albin Tonnerreccdb4002010-04-23 13:17:58 -0400241
242 /* When the input data is not compressed at all,
243 * lzo1x_decompress_safe will fail, so call memcpy()
244 * instead */
245 if (unlikely(dst_len == src_len))
246 memcpy(out_buf, in_buf, src_len);
247 else {
248 r = lzo1x_decompress_safe((u8 *) in_buf, src_len,
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800249 out_buf, &tmp);
250
Albin Tonnerreccdb4002010-04-23 13:17:58 -0400251 if (r != LZO_E_OK || dst_len != tmp) {
252 error("Compressed data violation");
253 goto exit_2;
254 }
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800255 }
256
Lasse Collin8f9b54a2011-01-12 17:01:20 -0800257 if (flush && flush(out_buf, dst_len) != dst_len)
258 goto exit_2;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800259 if (output)
260 out_buf += dst_len;
261 if (posp)
262 *posp += src_len + 12;
Lasse Collinfb7fa582011-01-12 17:01:21 -0800263
264 in_buf += src_len;
265 in_len -= src_len;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800266 if (fill) {
Lasse Collinfb7fa582011-01-12 17:01:21 -0800267 /*
268 * If there happens to still be unused data left in
269 * in_buf, move it to the beginning of the buffer.
270 * Use a loop to avoid memmove() dependency.
271 */
272 if (in_len > 0)
273 for (skip = 0; skip < in_len; ++skip)
274 in_buf_save[skip] = in_buf[skip];
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800275 in_buf = in_buf_save;
Lasse Collin5a3f81a2011-01-12 17:01:21 -0800276 }
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800277 }
278
Albin Tonnerreccdb4002010-04-23 13:17:58 -0400279 ret = 0;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800280exit_2:
281 if (!input)
Sascha Hauer35f15262012-01-12 17:21:01 -0800282 free(in_buf_save);
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800283exit_1:
284 if (!output)
285 free(out_buf);
286exit:
Albin Tonnerreccdb4002010-04-23 13:17:58 -0400287 return ret;
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800288}
289
290#define decompress unlzo