2 * LZ4 Decompressor for Linux kernel
4 * Copyright (C) 2013, LG Electronics, Kyungsik Lee <kyungsik.lee@lge.com>
6 * Based on LZ4 implementation by Yann Collet.
8 * LZ4 - Fast LZ compression algorithm
9 * Copyright (C) 2011-2012, Yann Collet.
10 * BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are
16 * * Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * * Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following disclaimer
20 * in the documentation and/or other materials provided with the
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * You can contact the author at :
36 * - LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html
37 * - LZ4 source repository : http://code.google.com/p/lz4/
41 #include <linux/module.h>
42 #include <linux/kernel.h>
44 #include <linux/lz4.h>
46 #include <asm/unaligned.h>
50 static int lz4_uncompress(const char *source, char *dest, int osize)
52 const BYTE *ip = (const BYTE *) source;
54 BYTE *op = (BYTE *) dest;
55 BYTE * const oend = op + osize;
59 size_t dec32table[] = {0, 3, 2, 3, 0, 0, 0, 0};
61 size_t dec64table[] = {0, 0, 0, -1, 0, 1, 2, 3};
68 length = (token >> ML_BITS);
69 if (length == RUN_MASK) {
73 for (; len == 255; length += 255)
75 if (unlikely(length > (size_t)(length + len)))
82 if (unlikely(cpy > oend - COPYLENGTH)) {
84 * Error: not enough place for another match
85 * (min 4) + 5 literals
90 memcpy(op, ip, length);
94 LZ4_WILDCOPY(ip, op, cpy);
99 LZ4_READ_LITTLEENDIAN_16(ref, cpy, ip);
102 /* Error: offset create reference outside destination buffer */
103 if (unlikely(ref < (BYTE *const) dest))
106 /* get matchlength */
107 length = token & ML_MASK;
108 if (length == ML_MASK) {
109 for (; *ip == 255; length += 255)
111 if (unlikely(length > (size_t)(length + *ip)))
116 /* copy repeated sequence */
117 if (unlikely((op - ref) < STEPSIZE)) {
119 size_t dec64 = dec64table[op - ref];
129 ref -= dec32table[op-ref];
134 LZ4_COPYSTEP(ref, op);
136 cpy = op + length - (STEPSIZE - 4);
137 if (cpy > (oend - COPYLENGTH)) {
139 /* Error: request to write beyond destination buffer */
143 if ((ref + COPYLENGTH) > oend)
145 if ((ref + COPYLENGTH) > oend ||
146 (op + COPYLENGTH) > oend)
149 LZ4_SECURECOPY(ref, op, (oend - COPYLENGTH));
154 * Check EOF (should never happen, since last 5 bytes
155 * are supposed to be literals)
161 LZ4_SECURECOPY(ref, op, cpy);
162 op = cpy; /* correction */
164 /* end of decoding */
165 return (int) (((char *)ip) - source);
167 /* write overflow error detected */
172 static int lz4_uncompress_unknownoutputsize(const char *source, char *dest,
173 int isize, size_t maxoutputsize)
175 const BYTE *ip = (const BYTE *) source;
176 const BYTE *const iend = ip + isize;
180 BYTE *op = (BYTE *) dest;
181 BYTE * const oend = op + maxoutputsize;
184 size_t dec32table[] = {0, 3, 2, 3, 0, 0, 0, 0};
186 size_t dec64table[] = {0, 0, 0, -1, 0, 1, 2, 3};
197 length = (token >> ML_BITS);
198 if (length == RUN_MASK) {
200 while ((ip < iend) && (s == 255)) {
202 if (unlikely(length > (size_t)(length + s)))
209 if ((cpy > oend - COPYLENGTH) ||
210 (ip + length > iend - COPYLENGTH)) {
213 goto _output_error;/* writes beyond buffer */
215 if (ip + length != iend)
216 goto _output_error;/*
217 * Error: LZ4 format requires
218 * to consume all input
221 memcpy(op, ip, length);
223 break;/* Necessarily EOF, due to parsing restrictions */
225 LZ4_WILDCOPY(ip, op, cpy);
230 LZ4_READ_LITTLEENDIAN_16(ref, cpy, ip);
232 if (ref < (BYTE * const) dest)
235 * Error : offset creates reference
236 * outside of destination buffer
239 /* get matchlength */
240 length = (token & ML_MASK);
241 if (length == ML_MASK) {
244 if (unlikely(length > (size_t)(length + s)))
253 /* copy repeated sequence */
254 if (unlikely((op - ref) < STEPSIZE)) {
256 size_t dec64 = dec64table[op - ref];
266 ref -= dec32table[op - ref];
271 LZ4_COPYSTEP(ref, op);
273 cpy = op + length - (STEPSIZE-4);
274 if (cpy > oend - COPYLENGTH) {
276 goto _output_error; /* write outside of buf */
278 if ((ref + COPYLENGTH) > oend)
280 if ((ref + COPYLENGTH) > oend ||
281 (op + COPYLENGTH) > oend)
284 LZ4_SECURECOPY(ref, op, (oend - COPYLENGTH));
289 * Check EOF (should never happen, since last 5 bytes
290 * are supposed to be literals)
296 LZ4_SECURECOPY(ref, op, cpy);
297 op = cpy; /* correction */
299 /* end of decoding */
300 return (int) (((char *) op) - dest);
302 /* write overflow error detected */
307 int lz4_decompress(const unsigned char *src, size_t *src_len,
308 unsigned char *dest, size_t actual_dest_len)
313 input_len = lz4_uncompress(src, dest, actual_dest_len);
316 *src_len = input_len;
323 EXPORT_SYMBOL(lz4_decompress);
326 int lz4_decompress_unknownoutputsize(const unsigned char *src, size_t src_len,
327 unsigned char *dest, size_t *dest_len)
332 out_len = lz4_uncompress_unknownoutputsize(src, dest, src_len,
343 EXPORT_SYMBOL(lz4_decompress_unknownoutputsize);
345 MODULE_LICENSE("Dual BSD/GPL");
346 MODULE_DESCRIPTION("LZ4 Decompressor");