blob: 7892a40cf765b980038d139ca8fb707e48f25409 [file] [log] [blame]
Thomas Gleixner09c434b2019-05-19 13:08:20 +01001// SPDX-License-Identifier: GPL-2.0-only
Richard Purdie64c70b12007-07-10 17:22:24 -07002/*
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +02003 * LZO1X Decompressor from LZO
Richard Purdie64c70b12007-07-10 17:22:24 -07004 *
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +02005 * Copyright (C) 1996-2012 Markus F.X.J. Oberhumer <markus@oberhumer.com>
Richard Purdie64c70b12007-07-10 17:22:24 -07006 *
7 * The full LZO package can be found at:
8 * http://www.oberhumer.com/opensource/lzo/
9 *
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020010 * Changed for Linux kernel use by:
Richard Purdie64c70b12007-07-10 17:22:24 -070011 * Nitin Gupta <nitingupta910@gmail.com>
12 * Richard Purdie <rpurdie@openedhand.com>
13 */
14
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080015#ifndef STATIC
Richard Purdie64c70b12007-07-10 17:22:24 -070016#include <linux/module.h>
17#include <linux/kernel.h>
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080018#endif
Richard Purdie64c70b12007-07-10 17:22:24 -070019#include <asm/unaligned.h>
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -080020#include <linux/lzo.h>
Richard Purdie64c70b12007-07-10 17:22:24 -070021#include "lzodefs.h"
22
Willy Tarreauaf958a32014-09-27 12:31:36 +020023#define HAVE_IP(x) ((size_t)(ip_end - ip) >= (size_t)(x))
24#define HAVE_OP(x) ((size_t)(op_end - op) >= (size_t)(x))
25#define NEED_IP(x) if (!HAVE_IP(x)) goto input_overrun
26#define NEED_OP(x) if (!HAVE_OP(x)) goto output_overrun
27#define TEST_LB(m_pos) if ((m_pos) < out) goto lookbehind_overrun
Richard Purdie64c70b12007-07-10 17:22:24 -070028
Willy Tarreau72cf9012014-09-27 12:31:37 +020029/* This MAX_255_COUNT is the maximum number of times we can add 255 to a base
30 * count without overflowing an integer. The multiply will overflow when
31 * multiplying 255 by more than MAXINT/255. The sum will overflow earlier
32 * depending on the base count. Since the base count is taken from a u8
33 * and a few bits, it is safe to assume that it will always be lower than
34 * or equal to 2*255, thus we can always prevent any overflow by accepting
Mauro Carvalho Chehab8e2a46a2020-06-15 08:50:25 +020035 * two less 255 steps. See Documentation/staging/lzo.rst for more information.
Willy Tarreau72cf9012014-09-27 12:31:37 +020036 */
37#define MAX_255_COUNT ((((size_t)~0) / 255) - 2)
38
Richard Purdie64c70b12007-07-10 17:22:24 -070039int lzo1x_decompress_safe(const unsigned char *in, size_t in_len,
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020040 unsigned char *out, size_t *out_len)
Richard Purdie64c70b12007-07-10 17:22:24 -070041{
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020042 unsigned char *op;
43 const unsigned char *ip;
44 size_t t, next;
45 size_t state = 0;
46 const unsigned char *m_pos;
Richard Purdie64c70b12007-07-10 17:22:24 -070047 const unsigned char * const ip_end = in + in_len;
48 unsigned char * const op_end = out + *out_len;
Richard Purdie64c70b12007-07-10 17:22:24 -070049
Dave Rodgman5ee40142019-03-07 16:30:40 -080050 unsigned char bitstream_version;
51
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020052 op = out;
53 ip = in;
Richard Purdie64c70b12007-07-10 17:22:24 -070054
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020055 if (unlikely(in_len < 3))
56 goto input_overrun;
Dave Rodgman5ee40142019-03-07 16:30:40 -080057
Dave Rodgmanb11ed182019-04-05 18:38:58 -070058 if (likely(in_len >= 5) && likely(*ip == 17)) {
Dave Rodgman5ee40142019-03-07 16:30:40 -080059 bitstream_version = ip[1];
60 ip += 2;
Dave Rodgman5ee40142019-03-07 16:30:40 -080061 } else {
62 bitstream_version = 0;
63 }
64
Richard Purdie64c70b12007-07-10 17:22:24 -070065 if (*ip > 17) {
66 t = *ip++ - 17;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020067 if (t < 4) {
68 next = t;
Richard Purdie64c70b12007-07-10 17:22:24 -070069 goto match_next;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020070 }
71 goto copy_literal_run;
Richard Purdie64c70b12007-07-10 17:22:24 -070072 }
73
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020074 for (;;) {
Richard Purdie64c70b12007-07-10 17:22:24 -070075 t = *ip++;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020076 if (t < 16) {
77 if (likely(state == 0)) {
78 if (unlikely(t == 0)) {
Willy Tarreau72cf9012014-09-27 12:31:37 +020079 size_t offset;
80 const unsigned char *ip_last = ip;
81
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020082 while (unlikely(*ip == 0)) {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020083 ip++;
Willy Tarreauaf958a32014-09-27 12:31:36 +020084 NEED_IP(1);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020085 }
Willy Tarreau72cf9012014-09-27 12:31:37 +020086 offset = ip - ip_last;
87 if (unlikely(offset > MAX_255_COUNT))
88 return LZO_E_ERROR;
89
90 offset = (offset << 8) - offset;
91 t += offset + 15 + *ip++;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020092 }
93 t += 3;
94copy_literal_run:
95#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
Willy Tarreauaf958a32014-09-27 12:31:36 +020096 if (likely(HAVE_IP(t + 15) && HAVE_OP(t + 15))) {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +020097 const unsigned char *ie = ip + t;
98 unsigned char *oe = op + t;
99 do {
100 COPY8(op, ip);
101 op += 8;
102 ip += 8;
103 COPY8(op, ip);
104 op += 8;
105 ip += 8;
106 } while (ip < ie);
107 ip = ie;
108 op = oe;
109 } else
110#endif
111 {
Willy Tarreauaf958a32014-09-27 12:31:36 +0200112 NEED_OP(t);
113 NEED_IP(t + 3);
Richard Purdie64c70b12007-07-10 17:22:24 -0700114 do {
115 *op++ = *ip++;
116 } while (--t > 0);
117 }
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200118 state = 4;
119 continue;
120 } else if (state != 4) {
121 next = t & 3;
Richard Purdie64c70b12007-07-10 17:22:24 -0700122 m_pos = op - 1;
123 m_pos -= t >> 2;
124 m_pos -= *ip++ << 2;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200125 TEST_LB(m_pos);
Willy Tarreauaf958a32014-09-27 12:31:36 +0200126 NEED_OP(2);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200127 op[0] = m_pos[0];
128 op[1] = m_pos[1];
129 op += 2;
130 goto match_next;
Richard Purdie64c70b12007-07-10 17:22:24 -0700131 } else {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200132 next = t & 3;
133 m_pos = op - (1 + M2_MAX_OFFSET);
134 m_pos -= t >> 2;
135 m_pos -= *ip++ << 2;
136 t = 3;
137 }
138 } else if (t >= 64) {
139 next = t & 3;
140 m_pos = op - 1;
141 m_pos -= (t >> 2) & 7;
142 m_pos -= *ip++ << 3;
143 t = (t >> 5) - 1 + (3 - 1);
144 } else if (t >= 32) {
145 t = (t & 31) + (3 - 1);
146 if (unlikely(t == 2)) {
Willy Tarreau72cf9012014-09-27 12:31:37 +0200147 size_t offset;
148 const unsigned char *ip_last = ip;
149
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200150 while (unlikely(*ip == 0)) {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200151 ip++;
Willy Tarreauaf958a32014-09-27 12:31:36 +0200152 NEED_IP(1);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200153 }
Willy Tarreau72cf9012014-09-27 12:31:37 +0200154 offset = ip - ip_last;
155 if (unlikely(offset > MAX_255_COUNT))
156 return LZO_E_ERROR;
157
158 offset = (offset << 8) - offset;
159 t += offset + 31 + *ip++;
Willy Tarreauaf958a32014-09-27 12:31:36 +0200160 NEED_IP(2);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200161 }
162 m_pos = op - 1;
163 next = get_unaligned_le16(ip);
164 ip += 2;
165 m_pos -= next >> 2;
166 next &= 3;
167 } else {
Dave Rodgman5ee40142019-03-07 16:30:40 -0800168 NEED_IP(2);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200169 next = get_unaligned_le16(ip);
Dave Rodgman5ee40142019-03-07 16:30:40 -0800170 if (((next & 0xfffc) == 0xfffc) &&
171 ((t & 0xf8) == 0x18) &&
172 likely(bitstream_version)) {
173 NEED_IP(3);
174 t &= 7;
175 t |= ip[2] << 3;
176 t += MIN_ZERO_RUN_LENGTH;
177 NEED_OP(t);
178 memset(op, 0, t);
179 op += t;
180 next &= 3;
181 ip += 3;
182 goto match_next;
183 } else {
184 m_pos = op;
185 m_pos -= (t & 8) << 11;
186 t = (t & 7) + (3 - 1);
187 if (unlikely(t == 2)) {
188 size_t offset;
189 const unsigned char *ip_last = ip;
190
191 while (unlikely(*ip == 0)) {
192 ip++;
193 NEED_IP(1);
194 }
195 offset = ip - ip_last;
196 if (unlikely(offset > MAX_255_COUNT))
197 return LZO_E_ERROR;
198
199 offset = (offset << 8) - offset;
200 t += offset + 7 + *ip++;
201 NEED_IP(2);
202 next = get_unaligned_le16(ip);
203 }
204 ip += 2;
205 m_pos -= next >> 2;
206 next &= 3;
207 if (m_pos == op)
208 goto eof_found;
209 m_pos -= 0x4000;
210 }
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200211 }
212 TEST_LB(m_pos);
213#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
214 if (op - m_pos >= 8) {
215 unsigned char *oe = op + t;
Willy Tarreauaf958a32014-09-27 12:31:36 +0200216 if (likely(HAVE_OP(t + 15))) {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200217 do {
218 COPY8(op, m_pos);
219 op += 8;
220 m_pos += 8;
221 COPY8(op, m_pos);
222 op += 8;
223 m_pos += 8;
224 } while (op < oe);
225 op = oe;
Willy Tarreauaf958a32014-09-27 12:31:36 +0200226 if (HAVE_IP(6)) {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200227 state = next;
228 COPY4(op, ip);
229 op += next;
230 ip += next;
231 continue;
232 }
233 } else {
Willy Tarreauaf958a32014-09-27 12:31:36 +0200234 NEED_OP(t);
Richard Purdie64c70b12007-07-10 17:22:24 -0700235 do {
236 *op++ = *m_pos++;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200237 } while (op < oe);
Richard Purdie64c70b12007-07-10 17:22:24 -0700238 }
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200239 } else
240#endif
241 {
242 unsigned char *oe = op + t;
Willy Tarreauaf958a32014-09-27 12:31:36 +0200243 NEED_OP(t);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200244 op[0] = m_pos[0];
245 op[1] = m_pos[1];
246 op += 2;
247 m_pos += 2;
248 do {
249 *op++ = *m_pos++;
250 } while (op < oe);
251 }
Richard Purdie64c70b12007-07-10 17:22:24 -0700252match_next:
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200253 state = next;
254 t = next;
255#if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
Willy Tarreauaf958a32014-09-27 12:31:36 +0200256 if (likely(HAVE_IP(6) && HAVE_OP(4))) {
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200257 COPY4(op, ip);
258 op += t;
259 ip += t;
260 } else
261#endif
262 {
Willy Tarreauaf958a32014-09-27 12:31:36 +0200263 NEED_IP(t + 3);
264 NEED_OP(t);
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200265 while (t > 0) {
Richard Purdie64c70b12007-07-10 17:22:24 -0700266 *op++ = *ip++;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200267 t--;
Richard Purdie64c70b12007-07-10 17:22:24 -0700268 }
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200269 }
Richard Purdie64c70b12007-07-10 17:22:24 -0700270 }
271
Richard Purdie64c70b12007-07-10 17:22:24 -0700272eof_found:
273 *out_len = op - out;
Markus F.X.J. Oberhumer8b975bd2012-08-13 17:25:44 +0200274 return (t != 3 ? LZO_E_ERROR :
275 ip == ip_end ? LZO_E_OK :
276 ip < ip_end ? LZO_E_INPUT_NOT_CONSUMED : LZO_E_INPUT_OVERRUN);
277
Richard Purdie64c70b12007-07-10 17:22:24 -0700278input_overrun:
279 *out_len = op - out;
280 return LZO_E_INPUT_OVERRUN;
281
282output_overrun:
283 *out_len = op - out;
284 return LZO_E_OUTPUT_OVERRUN;
285
286lookbehind_overrun:
287 *out_len = op - out;
288 return LZO_E_LOOKBEHIND_OVERRUN;
289}
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800290#ifndef STATIC
Richard Purdie64c70b12007-07-10 17:22:24 -0700291EXPORT_SYMBOL_GPL(lzo1x_decompress_safe);
292
293MODULE_LICENSE("GPL");
294MODULE_DESCRIPTION("LZO1X Decompressor");
295
Albin Tonnerre7dd65fe2010-01-08 14:42:42 -0800296#endif