blob: 9057a574bb6c6b14cbe447165cf2791e89cb40b8 [file] [log] [blame]
initial.commit3d533e02008-07-27 00:38:33 +00001/* inflate.c -- zlib decompression
mark13dc2462017-02-14 22:15:29 -08002 * Copyright (C) 1995-2016 Mark Adler
initial.commit3d533e02008-07-27 00:38:33 +00003 * For conditions of distribution and use, see copyright notice in zlib.h
4 */
5
6/*
7 * Change history:
8 *
9 * 1.2.beta0 24 Nov 2002
10 * - First version -- complete rewrite of inflate to simplify code, avoid
11 * creation of window when not needed, minimize use of window when it is
12 * needed, make inffast.c even faster, implement gzip decoding, and to
13 * improve code readability and style over the previous zlib inflate code
14 *
15 * 1.2.beta1 25 Nov 2002
16 * - Use pointers for available input and output checking in inffast.c
17 * - Remove input and output counters in inffast.c
18 * - Change inffast.c entry and loop from avail_in >= 7 to >= 6
19 * - Remove unnecessary second byte pull from length extra in inffast.c
20 * - Unroll direct copy to three copies per loop in inffast.c
21 *
22 * 1.2.beta2 4 Dec 2002
23 * - Change external routine names to reduce potential conflicts
24 * - Correct filename to inffixed.h for fixed tables in inflate.c
25 * - Make hbuf[] unsigned char to match parameter type in inflate.c
26 * - Change strm->next_out[-state->offset] to *(strm->next_out - state->offset)
27 * to avoid negation problem on Alphas (64 bit) in inflate.c
28 *
29 * 1.2.beta3 22 Dec 2002
30 * - Add comments on state->bits assertion in inffast.c
31 * - Add comments on op field in inftrees.h
32 * - Fix bug in reuse of allocated window after inflateReset()
33 * - Remove bit fields--back to byte structure for speed
34 * - Remove distance extra == 0 check in inflate_fast()--only helps for lengths
35 * - Change post-increments to pre-increments in inflate_fast(), PPC biased?
36 * - Add compile time option, POSTINC, to use post-increments instead (Intel?)
37 * - Make MATCH copy in inflate() much faster for when inflate_fast() not used
38 * - Use local copies of stream next and avail values, as well as local bit
39 * buffer and bit count in inflate()--for speed when inflate_fast() not used
40 *
41 * 1.2.beta4 1 Jan 2003
42 * - Split ptr - 257 statements in inflate_table() to avoid compiler warnings
43 * - Move a comment on output buffer sizes from inffast.c to inflate.c
44 * - Add comments in inffast.c to introduce the inflate_fast() routine
45 * - Rearrange window copies in inflate_fast() for speed and simplification
46 * - Unroll last copy for window match in inflate_fast()
47 * - Use local copies of window variables in inflate_fast() for speed
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +000048 * - Pull out common wnext == 0 case for speed in inflate_fast()
initial.commit3d533e02008-07-27 00:38:33 +000049 * - Make op and len in inflate_fast() unsigned for consistency
50 * - Add FAR to lcode and dcode declarations in inflate_fast()
51 * - Simplified bad distance check in inflate_fast()
52 * - Added inflateBackInit(), inflateBack(), and inflateBackEnd() in new
53 * source file infback.c to provide a call-back interface to inflate for
54 * programs like gzip and unzip -- uses window as output buffer to avoid
55 * window copying
56 *
57 * 1.2.beta5 1 Jan 2003
58 * - Improved inflateBack() interface to allow the caller to provide initial
59 * input in strm.
60 * - Fixed stored blocks bug in inflateBack()
61 *
62 * 1.2.beta6 4 Jan 2003
63 * - Added comments in inffast.c on effectiveness of POSTINC
64 * - Typecasting all around to reduce compiler warnings
65 * - Changed loops from while (1) or do {} while (1) to for (;;), again to
66 * make compilers happy
67 * - Changed type of window in inflateBackInit() to unsigned char *
68 *
69 * 1.2.beta7 27 Jan 2003
70 * - Changed many types to unsigned or unsigned short to avoid warnings
71 * - Added inflateCopy() function
72 *
73 * 1.2.0 9 Mar 2003
74 * - Changed inflateBack() interface to provide separate opaque descriptors
75 * for the in() and out() functions
76 * - Changed inflateBack() argument and in_func typedef to swap the length
77 * and buffer address return values for the input function
78 * - Check next_in and next_out for Z_NULL on entry to inflate()
79 *
80 * The history for versions after 1.2.0 are in ChangeLog in zlib distribution.
81 */
82
83#include "zutil.h"
84#include "inftrees.h"
85#include "inflate.h"
86#include "inffast.h"
87
88#ifdef MAKEFIXED
89# ifndef BUILDFIXED
90# define BUILDFIXED
91# endif
92#endif
93
94/* function prototypes */
mark13dc2462017-02-14 22:15:29 -080095local int inflateStateCheck OF((z_streamp strm));
initial.commit3d533e02008-07-27 00:38:33 +000096local void fixedtables OF((struct inflate_state FAR *state));
jiadong.zhu6c142162016-06-22 21:22:18 -070097local int updatewindow OF((z_streamp strm, const unsigned char FAR *end,
98 unsigned copy));
initial.commit3d533e02008-07-27 00:38:33 +000099#ifdef BUILDFIXED
100 void makefixed OF((void));
101#endif
jiadong.zhu6c142162016-06-22 21:22:18 -0700102local unsigned syncsearch OF((unsigned FAR *have, const unsigned char FAR *buf,
initial.commit3d533e02008-07-27 00:38:33 +0000103 unsigned len));
104
mark13dc2462017-02-14 22:15:29 -0800105local int inflateStateCheck(strm)
106z_streamp strm;
107{
108 struct inflate_state FAR *state;
109 if (strm == Z_NULL ||
110 strm->zalloc == (alloc_func)0 || strm->zfree == (free_func)0)
111 return 1;
112 state = (struct inflate_state FAR *)strm->state;
113 if (state == Z_NULL || state->strm != strm ||
114 state->mode < HEAD || state->mode > SYNC)
115 return 1;
116 return 0;
117}
118
jiadong.zhu6c142162016-06-22 21:22:18 -0700119int ZEXPORT inflateResetKeep(strm)
jiadong.zhu90f7dad2016-06-20 04:09:43 -0700120z_streamp strm;
121{
122 struct inflate_state FAR *state;
123
mark13dc2462017-02-14 22:15:29 -0800124 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
jiadong.zhu90f7dad2016-06-20 04:09:43 -0700125 state = (struct inflate_state FAR *)strm->state;
jmadillbf2aebe2016-06-20 06:58:52 -0700126 strm->total_in = strm->total_out = state->total = 0;
127 strm->msg = Z_NULL;
jiadong.zhu6c142162016-06-22 21:22:18 -0700128 if (state->wrap) /* to support ill-conceived Java test suite */
129 strm->adler = state->wrap & 1;
jmadillbf2aebe2016-06-20 06:58:52 -0700130 state->mode = HEAD;
131 state->last = 0;
132 state->havedict = 0;
133 state->dmax = 32768U;
134 state->head = Z_NULL;
jmadillbf2aebe2016-06-20 06:58:52 -0700135 state->hold = 0;
136 state->bits = 0;
137 state->lencode = state->distcode = state->next = state->codes;
138 state->sane = 1;
139 state->back = -1;
140 Tracev((stderr, "inflate: reset\n"));
141 return Z_OK;
jiadong.zhu90f7dad2016-06-20 04:09:43 -0700142}
143
jiadong.zhu6c142162016-06-22 21:22:18 -0700144int ZEXPORT inflateReset(strm)
145z_streamp strm;
146{
147 struct inflate_state FAR *state;
148
mark13dc2462017-02-14 22:15:29 -0800149 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
jiadong.zhu6c142162016-06-22 21:22:18 -0700150 state = (struct inflate_state FAR *)strm->state;
151 state->wsize = 0;
152 state->whave = 0;
153 state->wnext = 0;
154 return inflateResetKeep(strm);
155}
156
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000157int ZEXPORT inflateReset2(strm, windowBits)
initial.commit3d533e02008-07-27 00:38:33 +0000158z_streamp strm;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000159int windowBits;
initial.commit3d533e02008-07-27 00:38:33 +0000160{
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000161 int wrap;
initial.commit3d533e02008-07-27 00:38:33 +0000162 struct inflate_state FAR *state;
163
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000164 /* get the state */
mark13dc2462017-02-14 22:15:29 -0800165 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
initial.commit3d533e02008-07-27 00:38:33 +0000166 state = (struct inflate_state FAR *)strm->state;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000167
168 /* extract wrap request from windowBits parameter */
169 if (windowBits < 0) {
170 wrap = 0;
171 windowBits = -windowBits;
172 }
173 else {
mark13dc2462017-02-14 22:15:29 -0800174 wrap = (windowBits >> 4) + 5;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000175#ifdef GUNZIP
176 if (windowBits < 48)
177 windowBits &= 15;
178#endif
179 }
180
181 /* set number of window bits, free window if different */
182 if (windowBits && (windowBits < 8 || windowBits > 15))
183 return Z_STREAM_ERROR;
184 if (state->window != Z_NULL && state->wbits != (unsigned)windowBits) {
185 ZFREE(strm, state->window);
186 state->window = Z_NULL;
187 }
188
189 /* update state and reset the rest of it */
190 state->wrap = wrap;
191 state->wbits = (unsigned)windowBits;
192 return inflateReset(strm);
initial.commit3d533e02008-07-27 00:38:33 +0000193}
194
195int ZEXPORT inflateInit2_(strm, windowBits, version, stream_size)
196z_streamp strm;
197int windowBits;
198const char *version;
199int stream_size;
200{
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000201 int ret;
initial.commit3d533e02008-07-27 00:38:33 +0000202 struct inflate_state FAR *state;
Boris Sazonov0f473a12017-11-30 10:01:30 +0000203
initial.commit3d533e02008-07-27 00:38:33 +0000204 if (version == Z_NULL || version[0] != ZLIB_VERSION[0] ||
205 stream_size != (int)(sizeof(z_stream)))
206 return Z_VERSION_ERROR;
207 if (strm == Z_NULL) return Z_STREAM_ERROR;
208 strm->msg = Z_NULL; /* in case we return an error */
209 if (strm->zalloc == (alloc_func)0) {
jiadong.zhu6c142162016-06-22 21:22:18 -0700210#ifdef Z_SOLO
211 return Z_STREAM_ERROR;
212#else
initial.commit3d533e02008-07-27 00:38:33 +0000213 strm->zalloc = zcalloc;
214 strm->opaque = (voidpf)0;
jiadong.zhu6c142162016-06-22 21:22:18 -0700215#endif
initial.commit3d533e02008-07-27 00:38:33 +0000216 }
jiadong.zhu6c142162016-06-22 21:22:18 -0700217 if (strm->zfree == (free_func)0)
218#ifdef Z_SOLO
219 return Z_STREAM_ERROR;
220#else
221 strm->zfree = zcfree;
222#endif
initial.commit3d533e02008-07-27 00:38:33 +0000223 state = (struct inflate_state FAR *)
224 ZALLOC(strm, 1, sizeof(struct inflate_state));
225 if (state == Z_NULL) return Z_MEM_ERROR;
226 Tracev((stderr, "inflate: allocated\n"));
227 strm->state = (struct internal_state FAR *)state;
mark13dc2462017-02-14 22:15:29 -0800228 state->strm = strm;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000229 state->window = Z_NULL;
mark13dc2462017-02-14 22:15:29 -0800230 state->mode = HEAD; /* to pass state test in inflateReset2() */
Adenilson Cavalcanti3086c3e2017-09-28 04:31:06 +0000231 state->check = 1L; /* 1L is the result of adler32() zero length data */
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000232 ret = inflateReset2(strm, windowBits);
233 if (ret != Z_OK) {
initial.commit3d533e02008-07-27 00:38:33 +0000234 ZFREE(strm, state);
235 strm->state = Z_NULL;
initial.commit3d533e02008-07-27 00:38:33 +0000236 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000237 return ret;
initial.commit3d533e02008-07-27 00:38:33 +0000238}
239
240int ZEXPORT inflateInit_(strm, version, stream_size)
241z_streamp strm;
242const char *version;
243int stream_size;
244{
245 return inflateInit2_(strm, DEF_WBITS, version, stream_size);
246}
247
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000248int ZEXPORT inflatePrime(strm, bits, value)
249z_streamp strm;
250int bits;
251int value;
252{
253 struct inflate_state FAR *state;
254
mark13dc2462017-02-14 22:15:29 -0800255 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000256 state = (struct inflate_state FAR *)strm->state;
257 if (bits < 0) {
258 state->hold = 0;
259 state->bits = 0;
260 return Z_OK;
261 }
mark13dc2462017-02-14 22:15:29 -0800262 if (bits > 16 || state->bits + (uInt)bits > 32) return Z_STREAM_ERROR;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000263 value &= (1L << bits) - 1;
mark13dc2462017-02-14 22:15:29 -0800264 state->hold += (unsigned)value << state->bits;
265 state->bits += (uInt)bits;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000266 return Z_OK;
267}
268
initial.commit3d533e02008-07-27 00:38:33 +0000269/*
270 Return state with length and distance decoding tables and index sizes set to
271 fixed code decoding. Normally this returns fixed tables from inffixed.h.
272 If BUILDFIXED is defined, then instead this routine builds the tables the
273 first time it's called, and returns those tables the first time and
274 thereafter. This reduces the size of the code by about 2K bytes, in
275 exchange for a little execution time. However, BUILDFIXED should not be
276 used for threaded applications, since the rewriting of the tables and virgin
277 may not be thread-safe.
278 */
279local void fixedtables(state)
280struct inflate_state FAR *state;
281{
282#ifdef BUILDFIXED
283 static int virgin = 1;
284 static code *lenfix, *distfix;
285 static code fixed[544];
286
287 /* build fixed huffman tables if first call (may not be thread safe) */
288 if (virgin) {
289 unsigned sym, bits;
290 static code *next;
291
292 /* literal/length table */
293 sym = 0;
294 while (sym < 144) state->lens[sym++] = 8;
295 while (sym < 256) state->lens[sym++] = 9;
296 while (sym < 280) state->lens[sym++] = 7;
297 while (sym < 288) state->lens[sym++] = 8;
298 next = fixed;
299 lenfix = next;
300 bits = 9;
301 inflate_table(LENS, state->lens, 288, &(next), &(bits), state->work);
302
303 /* distance table */
304 sym = 0;
305 while (sym < 32) state->lens[sym++] = 5;
306 distfix = next;
307 bits = 5;
308 inflate_table(DISTS, state->lens, 32, &(next), &(bits), state->work);
309
310 /* do this just once */
311 virgin = 0;
312 }
313#else /* !BUILDFIXED */
314# include "inffixed.h"
315#endif /* BUILDFIXED */
316 state->lencode = lenfix;
317 state->lenbits = 9;
318 state->distcode = distfix;
319 state->distbits = 5;
320}
321
322#ifdef MAKEFIXED
323#include <stdio.h>
324
325/*
326 Write out the inffixed.h that is #include'd above. Defining MAKEFIXED also
327 defines BUILDFIXED, so the tables are built on the fly. makefixed() writes
328 those tables to stdout, which would be piped to inffixed.h. A small program
329 can simply call makefixed to do this:
330
331 void makefixed(void);
332
333 int main(void)
334 {
335 makefixed();
336 return 0;
337 }
338
339 Then that can be linked with zlib built with MAKEFIXED defined and run:
340
341 a.out > inffixed.h
342 */
343void makefixed()
344{
345 unsigned low, size;
346 struct inflate_state state;
347
348 fixedtables(&state);
349 puts(" /* inffixed.h -- table for decoding fixed codes");
350 puts(" * Generated automatically by makefixed().");
351 puts(" */");
352 puts("");
353 puts(" /* WARNING: this file should *not* be used by applications.");
354 puts(" It is part of the implementation of this library and is");
355 puts(" subject to change. Applications should only use zlib.h.");
356 puts(" */");
357 puts("");
358 size = 1U << 9;
359 printf(" static const code lenfix[%u] = {", size);
360 low = 0;
361 for (;;) {
362 if ((low % 7) == 0) printf("\n ");
jiadong.zhu6c142162016-06-22 21:22:18 -0700363 printf("{%u,%u,%d}", (low & 127) == 99 ? 64 : state.lencode[low].op,
364 state.lencode[low].bits, state.lencode[low].val);
initial.commit3d533e02008-07-27 00:38:33 +0000365 if (++low == size) break;
366 putchar(',');
367 }
368 puts("\n };");
369 size = 1U << 5;
370 printf("\n static const code distfix[%u] = {", size);
371 low = 0;
372 for (;;) {
373 if ((low % 6) == 0) printf("\n ");
374 printf("{%u,%u,%d}", state.distcode[low].op, state.distcode[low].bits,
375 state.distcode[low].val);
376 if (++low == size) break;
377 putchar(',');
378 }
379 puts("\n };");
380}
381#endif /* MAKEFIXED */
382
383/*
384 Update the window with the last wsize (normally 32K) bytes written before
385 returning. If window does not exist yet, create it. This is only called
386 when a window is already in use, or when output has been written during this
387 inflate call, but the end of the deflate stream has not been reached yet.
388 It is also called to create a window for dictionary data when a dictionary
389 is loaded.
390
391 Providing output buffers larger than 32K to inflate() should provide a speed
392 advantage, since only the last 32K of output is copied to the sliding window
393 upon return from inflate(), and since all distances after the first 32K of
394 output will fall in the output data, making match copies simpler and faster.
395 The advantage may be dependent on the size of the processor's data caches.
396 */
jiadong.zhu6c142162016-06-22 21:22:18 -0700397local int updatewindow(strm, end, copy)
initial.commit3d533e02008-07-27 00:38:33 +0000398z_streamp strm;
jiadong.zhu6c142162016-06-22 21:22:18 -0700399const Bytef *end;
400unsigned copy;
initial.commit3d533e02008-07-27 00:38:33 +0000401{
402 struct inflate_state FAR *state;
jiadong.zhu6c142162016-06-22 21:22:18 -0700403 unsigned dist;
initial.commit3d533e02008-07-27 00:38:33 +0000404
405 state = (struct inflate_state FAR *)strm->state;
406
407 /* if it hasn't been done already, allocate space for the window */
408 if (state->window == Z_NULL) {
409 state->window = (unsigned char FAR *)
410 ZALLOC(strm, 1U << state->wbits,
411 sizeof(unsigned char));
412 if (state->window == Z_NULL) return 1;
413 }
414
415 /* if window not in use yet, initialize */
416 if (state->wsize == 0) {
417 state->wsize = 1U << state->wbits;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000418 state->wnext = 0;
initial.commit3d533e02008-07-27 00:38:33 +0000419 state->whave = 0;
420 }
421
422 /* copy state->wsize or less output bytes into the circular window */
initial.commit3d533e02008-07-27 00:38:33 +0000423 if (copy >= state->wsize) {
jiadong.zhu6c142162016-06-22 21:22:18 -0700424 zmemcpy(state->window, end - state->wsize, state->wsize);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000425 state->wnext = 0;
initial.commit3d533e02008-07-27 00:38:33 +0000426 state->whave = state->wsize;
427 }
428 else {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000429 dist = state->wsize - state->wnext;
initial.commit3d533e02008-07-27 00:38:33 +0000430 if (dist > copy) dist = copy;
jiadong.zhu6c142162016-06-22 21:22:18 -0700431 zmemcpy(state->window + state->wnext, end - copy, dist);
initial.commit3d533e02008-07-27 00:38:33 +0000432 copy -= dist;
433 if (copy) {
jiadong.zhu6c142162016-06-22 21:22:18 -0700434 zmemcpy(state->window, end - copy, copy);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000435 state->wnext = copy;
initial.commit3d533e02008-07-27 00:38:33 +0000436 state->whave = state->wsize;
437 }
438 else {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000439 state->wnext += dist;
440 if (state->wnext == state->wsize) state->wnext = 0;
initial.commit3d533e02008-07-27 00:38:33 +0000441 if (state->whave < state->wsize) state->whave += dist;
442 }
443 }
444 return 0;
445}
446
447/* Macros for inflate(): */
448
449/* check function to use adler32() for zlib or crc32() for gzip */
450#ifdef GUNZIP
451# define UPDATE(check, buf, len) \
452 (state->flags ? crc32(check, buf, len) : adler32(check, buf, len))
453#else
454# define UPDATE(check, buf, len) adler32(check, buf, len)
455#endif
456
457/* check macros for header crc */
458#ifdef GUNZIP
459# define CRC2(check, word) \
460 do { \
461 hbuf[0] = (unsigned char)(word); \
462 hbuf[1] = (unsigned char)((word) >> 8); \
463 check = crc32(check, hbuf, 2); \
464 } while (0)
465
466# define CRC4(check, word) \
467 do { \
468 hbuf[0] = (unsigned char)(word); \
469 hbuf[1] = (unsigned char)((word) >> 8); \
470 hbuf[2] = (unsigned char)((word) >> 16); \
471 hbuf[3] = (unsigned char)((word) >> 24); \
472 check = crc32(check, hbuf, 4); \
473 } while (0)
474#endif
475
476/* Load registers with state in inflate() for speed */
477#define LOAD() \
478 do { \
479 put = strm->next_out; \
480 left = strm->avail_out; \
481 next = strm->next_in; \
482 have = strm->avail_in; \
483 hold = state->hold; \
484 bits = state->bits; \
485 } while (0)
486
487/* Restore state from registers in inflate() */
488#define RESTORE() \
489 do { \
490 strm->next_out = put; \
491 strm->avail_out = left; \
492 strm->next_in = next; \
493 strm->avail_in = have; \
494 state->hold = hold; \
495 state->bits = bits; \
496 } while (0)
497
498/* Clear the input bit accumulator */
499#define INITBITS() \
500 do { \
501 hold = 0; \
502 bits = 0; \
503 } while (0)
504
505/* Get a byte of input into the bit accumulator, or return from inflate()
506 if there is no input available. */
507#define PULLBYTE() \
508 do { \
509 if (have == 0) goto inf_leave; \
510 have--; \
511 hold += (unsigned long)(*next++) << bits; \
512 bits += 8; \
513 } while (0)
514
515/* Assure that there are at least n bits in the bit accumulator. If there is
516 not enough available input to do that, then return from inflate(). */
517#define NEEDBITS(n) \
518 do { \
519 while (bits < (unsigned)(n)) \
520 PULLBYTE(); \
521 } while (0)
522
523/* Return the low n bits of the bit accumulator (n < 16) */
524#define BITS(n) \
525 ((unsigned)hold & ((1U << (n)) - 1))
526
527/* Remove n bits from the bit accumulator */
528#define DROPBITS(n) \
529 do { \
530 hold >>= (n); \
531 bits -= (unsigned)(n); \
532 } while (0)
533
534/* Remove zero to seven bits as needed to go to a byte boundary */
535#define BYTEBITS() \
536 do { \
537 hold >>= bits & 7; \
538 bits -= bits & 7; \
539 } while (0)
540
initial.commit3d533e02008-07-27 00:38:33 +0000541/*
542 inflate() uses a state machine to process as much input data and generate as
543 much output data as possible before returning. The state machine is
544 structured roughly as follows:
545
546 for (;;) switch (state) {
547 ...
548 case STATEn:
549 if (not enough input data or output space to make progress)
550 return;
551 ... make progress ...
552 state = STATEm;
553 break;
554 ...
555 }
556
557 so when inflate() is called again, the same case is attempted again, and
558 if the appropriate resources are provided, the machine proceeds to the
559 next state. The NEEDBITS() macro is usually the way the state evaluates
560 whether it can proceed or should return. NEEDBITS() does the return if
561 the requested bits are not available. The typical use of the BITS macros
562 is:
563
564 NEEDBITS(n);
565 ... do something with BITS(n) ...
566 DROPBITS(n);
567
568 where NEEDBITS(n) either returns from inflate() if there isn't enough
569 input left to load n bits into the accumulator, or it continues. BITS(n)
570 gives the low n bits in the accumulator. When done, DROPBITS(n) drops
571 the low n bits off the accumulator. INITBITS() clears the accumulator
572 and sets the number of available bits to zero. BYTEBITS() discards just
573 enough bits to put the accumulator on a byte boundary. After BYTEBITS()
574 and a NEEDBITS(8), then BITS(8) would return the next byte in the stream.
575
576 NEEDBITS(n) uses PULLBYTE() to get an available byte of input, or to return
577 if there is no input available. The decoding of variable length codes uses
578 PULLBYTE() directly in order to pull just enough bytes to decode the next
579 code, and no more.
580
581 Some states loop until they get enough input, making sure that enough
582 state information is maintained to continue the loop where it left off
583 if NEEDBITS() returns in the loop. For example, want, need, and keep
584 would all have to actually be part of the saved state in case NEEDBITS()
585 returns:
586
587 case STATEw:
588 while (want < need) {
589 NEEDBITS(n);
590 keep[want++] = BITS(n);
591 DROPBITS(n);
592 }
593 state = STATEx;
594 case STATEx:
595
596 As shown above, if the next state is also the next case, then the break
597 is omitted.
598
599 A state may also return if there is not enough output space available to
600 complete that state. Those states are copying stored data, writing a
601 literal byte, and copying a matching string.
602
603 When returning, a "goto inf_leave" is used to update the total counters,
604 update the check value, and determine whether any progress has been made
605 during that inflate() call in order to return the proper return code.
606 Progress is defined as a change in either strm->avail_in or strm->avail_out.
607 When there is a window, goto inf_leave will update the window with the last
608 output written. If a goto inf_leave occurs in the middle of decompression
609 and there is no window currently, goto inf_leave will create one and copy
610 output to the window for the next call of inflate().
611
612 In this implementation, the flush parameter of inflate() only affects the
613 return code (per zlib.h). inflate() always writes as much as possible to
614 strm->next_out, given the space available and the provided input--the effect
615 documented in zlib.h of Z_SYNC_FLUSH. Furthermore, inflate() always defers
616 the allocation of and copying into a sliding window until necessary, which
617 provides the effect documented in zlib.h for Z_FINISH when the entire input
618 stream available. So the only thing the flush parameter actually does is:
619 when flush is set to Z_FINISH, inflate() cannot return Z_OK. Instead it
620 will return Z_BUF_ERROR if it has not reached the end of the stream.
621 */
622
623int ZEXPORT inflate(strm, flush)
624z_streamp strm;
625int flush;
626{
627 struct inflate_state FAR *state;
jiadong.zhu6c142162016-06-22 21:22:18 -0700628 z_const unsigned char FAR *next; /* next input */
initial.commit3d533e02008-07-27 00:38:33 +0000629 unsigned char FAR *put; /* next output */
630 unsigned have, left; /* available input and output */
631 unsigned long hold; /* bit buffer */
632 unsigned bits; /* bits in bit buffer */
633 unsigned in, out; /* save starting available input and output */
634 unsigned copy; /* number of stored or match bytes to copy */
635 unsigned char FAR *from; /* where to copy match bytes from */
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000636 code here; /* current decoding table entry */
initial.commit3d533e02008-07-27 00:38:33 +0000637 code last; /* parent table entry */
638 unsigned len; /* length to copy for repeats, bits to drop */
639 int ret; /* return code */
640#ifdef GUNZIP
641 unsigned char hbuf[4]; /* buffer for gzip header crc calculation */
642#endif
643 static const unsigned short order[19] = /* permutation of code lengths */
644 {16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15};
645
mark13dc2462017-02-14 22:15:29 -0800646 if (inflateStateCheck(strm) || strm->next_out == Z_NULL ||
initial.commit3d533e02008-07-27 00:38:33 +0000647 (strm->next_in == Z_NULL && strm->avail_in != 0))
648 return Z_STREAM_ERROR;
649
650 state = (struct inflate_state FAR *)strm->state;
651 if (state->mode == TYPE) state->mode = TYPEDO; /* skip check */
652 LOAD();
653 in = have;
654 out = left;
655 ret = Z_OK;
656 for (;;)
657 switch (state->mode) {
658 case HEAD:
659 if (state->wrap == 0) {
660 state->mode = TYPEDO;
661 break;
662 }
663 NEEDBITS(16);
664#ifdef GUNZIP
665 if ((state->wrap & 2) && hold == 0x8b1f) { /* gzip header */
mark13dc2462017-02-14 22:15:29 -0800666 if (state->wbits == 0)
667 state->wbits = 15;
initial.commit3d533e02008-07-27 00:38:33 +0000668 state->check = crc32(0L, Z_NULL, 0);
669 CRC2(state->check, hold);
670 INITBITS();
671 state->mode = FLAGS;
672 break;
673 }
674 state->flags = 0; /* expect zlib header */
675 if (state->head != Z_NULL)
676 state->head->done = -1;
677 if (!(state->wrap & 1) || /* check if zlib header allowed */
678#else
679 if (
680#endif
681 ((BITS(8) << 8) + (hold >> 8)) % 31) {
682 strm->msg = (char *)"incorrect header check";
683 state->mode = BAD;
684 break;
685 }
686 if (BITS(4) != Z_DEFLATED) {
687 strm->msg = (char *)"unknown compression method";
688 state->mode = BAD;
689 break;
690 }
691 DROPBITS(4);
692 len = BITS(4) + 8;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000693 if (state->wbits == 0)
694 state->wbits = len;
mark13dc2462017-02-14 22:15:29 -0800695 if (len > 15 || len > state->wbits) {
initial.commit3d533e02008-07-27 00:38:33 +0000696 strm->msg = (char *)"invalid window size";
697 state->mode = BAD;
698 break;
699 }
700 state->dmax = 1U << len;
701 Tracev((stderr, "inflate: zlib header ok\n"));
702 strm->adler = state->check = adler32(0L, Z_NULL, 0);
703 state->mode = hold & 0x200 ? DICTID : TYPE;
704 INITBITS();
705 break;
706#ifdef GUNZIP
707 case FLAGS:
708 NEEDBITS(16);
709 state->flags = (int)(hold);
710 if ((state->flags & 0xff) != Z_DEFLATED) {
711 strm->msg = (char *)"unknown compression method";
712 state->mode = BAD;
713 break;
714 }
715 if (state->flags & 0xe000) {
716 strm->msg = (char *)"unknown header flags set";
717 state->mode = BAD;
718 break;
719 }
720 if (state->head != Z_NULL)
721 state->head->text = (int)((hold >> 8) & 1);
mark13dc2462017-02-14 22:15:29 -0800722 if ((state->flags & 0x0200) && (state->wrap & 4))
723 CRC2(state->check, hold);
initial.commit3d533e02008-07-27 00:38:33 +0000724 INITBITS();
725 state->mode = TIME;
726 case TIME:
727 NEEDBITS(32);
728 if (state->head != Z_NULL)
729 state->head->time = hold;
mark13dc2462017-02-14 22:15:29 -0800730 if ((state->flags & 0x0200) && (state->wrap & 4))
731 CRC4(state->check, hold);
initial.commit3d533e02008-07-27 00:38:33 +0000732 INITBITS();
733 state->mode = OS;
734 case OS:
735 NEEDBITS(16);
736 if (state->head != Z_NULL) {
737 state->head->xflags = (int)(hold & 0xff);
738 state->head->os = (int)(hold >> 8);
739 }
mark13dc2462017-02-14 22:15:29 -0800740 if ((state->flags & 0x0200) && (state->wrap & 4))
741 CRC2(state->check, hold);
initial.commit3d533e02008-07-27 00:38:33 +0000742 INITBITS();
743 state->mode = EXLEN;
744 case EXLEN:
745 if (state->flags & 0x0400) {
746 NEEDBITS(16);
747 state->length = (unsigned)(hold);
748 if (state->head != Z_NULL)
749 state->head->extra_len = (unsigned)hold;
mark13dc2462017-02-14 22:15:29 -0800750 if ((state->flags & 0x0200) && (state->wrap & 4))
751 CRC2(state->check, hold);
initial.commit3d533e02008-07-27 00:38:33 +0000752 INITBITS();
753 }
754 else if (state->head != Z_NULL)
755 state->head->extra = Z_NULL;
756 state->mode = EXTRA;
757 case EXTRA:
758 if (state->flags & 0x0400) {
759 copy = state->length;
760 if (copy > have) copy = have;
761 if (copy) {
762 if (state->head != Z_NULL &&
Sadaf Ebrahimi2db659e2022-11-22 22:00:13 +0000763 state->head->extra != Z_NULL &&
764 (len = state->head->extra_len - state->length) <
765 state->head->extra_max) {
initial.commit3d533e02008-07-27 00:38:33 +0000766 zmemcpy(state->head->extra + len, next,
767 len + copy > state->head->extra_max ?
768 state->head->extra_max - len : copy);
769 }
mark13dc2462017-02-14 22:15:29 -0800770 if ((state->flags & 0x0200) && (state->wrap & 4))
initial.commit3d533e02008-07-27 00:38:33 +0000771 state->check = crc32(state->check, next, copy);
772 have -= copy;
773 next += copy;
774 state->length -= copy;
775 }
776 if (state->length) goto inf_leave;
777 }
778 state->length = 0;
779 state->mode = NAME;
780 case NAME:
781 if (state->flags & 0x0800) {
782 if (have == 0) goto inf_leave;
783 copy = 0;
784 do {
785 len = (unsigned)(next[copy++]);
786 if (state->head != Z_NULL &&
787 state->head->name != Z_NULL &&
788 state->length < state->head->name_max)
mark13dc2462017-02-14 22:15:29 -0800789 state->head->name[state->length++] = (Bytef)len;
initial.commit3d533e02008-07-27 00:38:33 +0000790 } while (len && copy < have);
mark13dc2462017-02-14 22:15:29 -0800791 if ((state->flags & 0x0200) && (state->wrap & 4))
initial.commit3d533e02008-07-27 00:38:33 +0000792 state->check = crc32(state->check, next, copy);
793 have -= copy;
794 next += copy;
795 if (len) goto inf_leave;
796 }
797 else if (state->head != Z_NULL)
798 state->head->name = Z_NULL;
799 state->length = 0;
800 state->mode = COMMENT;
801 case COMMENT:
802 if (state->flags & 0x1000) {
803 if (have == 0) goto inf_leave;
804 copy = 0;
805 do {
806 len = (unsigned)(next[copy++]);
807 if (state->head != Z_NULL &&
808 state->head->comment != Z_NULL &&
809 state->length < state->head->comm_max)
mark13dc2462017-02-14 22:15:29 -0800810 state->head->comment[state->length++] = (Bytef)len;
initial.commit3d533e02008-07-27 00:38:33 +0000811 } while (len && copy < have);
mark13dc2462017-02-14 22:15:29 -0800812 if ((state->flags & 0x0200) && (state->wrap & 4))
initial.commit3d533e02008-07-27 00:38:33 +0000813 state->check = crc32(state->check, next, copy);
814 have -= copy;
815 next += copy;
816 if (len) goto inf_leave;
817 }
818 else if (state->head != Z_NULL)
819 state->head->comment = Z_NULL;
820 state->mode = HCRC;
821 case HCRC:
822 if (state->flags & 0x0200) {
823 NEEDBITS(16);
mark13dc2462017-02-14 22:15:29 -0800824 if ((state->wrap & 4) && hold != (state->check & 0xffff)) {
initial.commit3d533e02008-07-27 00:38:33 +0000825 strm->msg = (char *)"header crc mismatch";
826 state->mode = BAD;
827 break;
828 }
829 INITBITS();
830 }
831 if (state->head != Z_NULL) {
832 state->head->hcrc = (int)((state->flags >> 9) & 1);
833 state->head->done = 1;
834 }
835 strm->adler = state->check = crc32(0L, Z_NULL, 0);
836 state->mode = TYPE;
837 break;
838#endif
839 case DICTID:
840 NEEDBITS(32);
jiadong.zhu6c142162016-06-22 21:22:18 -0700841 strm->adler = state->check = ZSWAP32(hold);
initial.commit3d533e02008-07-27 00:38:33 +0000842 INITBITS();
843 state->mode = DICT;
844 case DICT:
845 if (state->havedict == 0) {
846 RESTORE();
847 return Z_NEED_DICT;
848 }
849 strm->adler = state->check = adler32(0L, Z_NULL, 0);
850 state->mode = TYPE;
851 case TYPE:
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000852 if (flush == Z_BLOCK || flush == Z_TREES) goto inf_leave;
initial.commit3d533e02008-07-27 00:38:33 +0000853 case TYPEDO:
854 if (state->last) {
855 BYTEBITS();
856 state->mode = CHECK;
857 break;
858 }
859 NEEDBITS(3);
860 state->last = BITS(1);
861 DROPBITS(1);
862 switch (BITS(2)) {
863 case 0: /* stored block */
864 Tracev((stderr, "inflate: stored block%s\n",
865 state->last ? " (last)" : ""));
866 state->mode = STORED;
867 break;
868 case 1: /* fixed block */
869 fixedtables(state);
870 Tracev((stderr, "inflate: fixed codes block%s\n",
871 state->last ? " (last)" : ""));
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000872 state->mode = LEN_; /* decode codes */
873 if (flush == Z_TREES) {
874 DROPBITS(2);
875 goto inf_leave;
876 }
initial.commit3d533e02008-07-27 00:38:33 +0000877 break;
878 case 2: /* dynamic block */
879 Tracev((stderr, "inflate: dynamic codes block%s\n",
880 state->last ? " (last)" : ""));
881 state->mode = TABLE;
882 break;
883 case 3:
884 strm->msg = (char *)"invalid block type";
885 state->mode = BAD;
886 }
887 DROPBITS(2);
888 break;
889 case STORED:
890 BYTEBITS(); /* go to byte boundary */
891 NEEDBITS(32);
892 if ((hold & 0xffff) != ((hold >> 16) ^ 0xffff)) {
893 strm->msg = (char *)"invalid stored block lengths";
894 state->mode = BAD;
895 break;
896 }
897 state->length = (unsigned)hold & 0xffff;
898 Tracev((stderr, "inflate: stored length %u\n",
899 state->length));
900 INITBITS();
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000901 state->mode = COPY_;
902 if (flush == Z_TREES) goto inf_leave;
903 case COPY_:
initial.commit3d533e02008-07-27 00:38:33 +0000904 state->mode = COPY;
905 case COPY:
906 copy = state->length;
907 if (copy) {
908 if (copy > have) copy = have;
909 if (copy > left) copy = left;
910 if (copy == 0) goto inf_leave;
911 zmemcpy(put, next, copy);
912 have -= copy;
913 next += copy;
914 left -= copy;
915 put += copy;
916 state->length -= copy;
917 break;
918 }
919 Tracev((stderr, "inflate: stored end\n"));
920 state->mode = TYPE;
921 break;
922 case TABLE:
923 NEEDBITS(14);
924 state->nlen = BITS(5) + 257;
925 DROPBITS(5);
926 state->ndist = BITS(5) + 1;
927 DROPBITS(5);
928 state->ncode = BITS(4) + 4;
929 DROPBITS(4);
930#ifndef PKZIP_BUG_WORKAROUND
931 if (state->nlen > 286 || state->ndist > 30) {
932 strm->msg = (char *)"too many length or distance symbols";
933 state->mode = BAD;
934 break;
935 }
936#endif
937 Tracev((stderr, "inflate: table sizes ok\n"));
938 state->have = 0;
939 state->mode = LENLENS;
940 case LENLENS:
941 while (state->have < state->ncode) {
942 NEEDBITS(3);
943 state->lens[order[state->have++]] = (unsigned short)BITS(3);
944 DROPBITS(3);
945 }
946 while (state->have < 19)
947 state->lens[order[state->have++]] = 0;
948 state->next = state->codes;
jiadong.zhu6c142162016-06-22 21:22:18 -0700949 state->lencode = (const code FAR *)(state->next);
initial.commit3d533e02008-07-27 00:38:33 +0000950 state->lenbits = 7;
951 ret = inflate_table(CODES, state->lens, 19, &(state->next),
952 &(state->lenbits), state->work);
953 if (ret) {
954 strm->msg = (char *)"invalid code lengths set";
955 state->mode = BAD;
956 break;
957 }
958 Tracev((stderr, "inflate: code lengths ok\n"));
959 state->have = 0;
960 state->mode = CODELENS;
961 case CODELENS:
962 while (state->have < state->nlen + state->ndist) {
963 for (;;) {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000964 here = state->lencode[BITS(state->lenbits)];
965 if ((unsigned)(here.bits) <= bits) break;
initial.commit3d533e02008-07-27 00:38:33 +0000966 PULLBYTE();
967 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000968 if (here.val < 16) {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000969 DROPBITS(here.bits);
970 state->lens[state->have++] = here.val;
initial.commit3d533e02008-07-27 00:38:33 +0000971 }
972 else {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000973 if (here.val == 16) {
974 NEEDBITS(here.bits + 2);
975 DROPBITS(here.bits);
initial.commit3d533e02008-07-27 00:38:33 +0000976 if (state->have == 0) {
977 strm->msg = (char *)"invalid bit length repeat";
978 state->mode = BAD;
979 break;
980 }
981 len = state->lens[state->have - 1];
982 copy = 3 + BITS(2);
983 DROPBITS(2);
984 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000985 else if (here.val == 17) {
986 NEEDBITS(here.bits + 3);
987 DROPBITS(here.bits);
initial.commit3d533e02008-07-27 00:38:33 +0000988 len = 0;
989 copy = 3 + BITS(3);
990 DROPBITS(3);
991 }
992 else {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +0000993 NEEDBITS(here.bits + 7);
994 DROPBITS(here.bits);
initial.commit3d533e02008-07-27 00:38:33 +0000995 len = 0;
996 copy = 11 + BITS(7);
997 DROPBITS(7);
998 }
999 if (state->have + copy > state->nlen + state->ndist) {
1000 strm->msg = (char *)"invalid bit length repeat";
1001 state->mode = BAD;
1002 break;
1003 }
1004 while (copy--)
1005 state->lens[state->have++] = (unsigned short)len;
1006 }
1007 }
1008
1009 /* handle error breaks in while */
1010 if (state->mode == BAD) break;
1011
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001012 /* check for end-of-block code (better have one) */
1013 if (state->lens[256] == 0) {
1014 strm->msg = (char *)"invalid code -- missing end-of-block";
1015 state->mode = BAD;
1016 break;
1017 }
1018
1019 /* build code tables -- note: do not change the lenbits or distbits
1020 values here (9 and 6) without reading the comments in inftrees.h
1021 concerning the ENOUGH constants, which depend on those values */
initial.commit3d533e02008-07-27 00:38:33 +00001022 state->next = state->codes;
jiadong.zhu6c142162016-06-22 21:22:18 -07001023 state->lencode = (const code FAR *)(state->next);
initial.commit3d533e02008-07-27 00:38:33 +00001024 state->lenbits = 9;
1025 ret = inflate_table(LENS, state->lens, state->nlen, &(state->next),
1026 &(state->lenbits), state->work);
1027 if (ret) {
1028 strm->msg = (char *)"invalid literal/lengths set";
1029 state->mode = BAD;
1030 break;
1031 }
jiadong.zhu6c142162016-06-22 21:22:18 -07001032 state->distcode = (const code FAR *)(state->next);
initial.commit3d533e02008-07-27 00:38:33 +00001033 state->distbits = 6;
1034 ret = inflate_table(DISTS, state->lens + state->nlen, state->ndist,
1035 &(state->next), &(state->distbits), state->work);
1036 if (ret) {
1037 strm->msg = (char *)"invalid distances set";
1038 state->mode = BAD;
1039 break;
1040 }
1041 Tracev((stderr, "inflate: codes ok\n"));
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001042 state->mode = LEN_;
1043 if (flush == Z_TREES) goto inf_leave;
1044 case LEN_:
initial.commit3d533e02008-07-27 00:38:33 +00001045 state->mode = LEN;
1046 case LEN:
Chris Blumeb9c15662018-02-13 19:57:43 +00001047 if (have >= INFLATE_FAST_MIN_INPUT &&
1048 left >= INFLATE_FAST_MIN_OUTPUT) {
initial.commit3d533e02008-07-27 00:38:33 +00001049 RESTORE();
1050 inflate_fast(strm, out);
1051 LOAD();
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001052 if (state->mode == TYPE)
1053 state->back = -1;
initial.commit3d533e02008-07-27 00:38:33 +00001054 break;
1055 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001056 state->back = 0;
initial.commit3d533e02008-07-27 00:38:33 +00001057 for (;;) {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001058 here = state->lencode[BITS(state->lenbits)];
1059 if ((unsigned)(here.bits) <= bits) break;
initial.commit3d533e02008-07-27 00:38:33 +00001060 PULLBYTE();
1061 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001062 if (here.op && (here.op & 0xf0) == 0) {
1063 last = here;
initial.commit3d533e02008-07-27 00:38:33 +00001064 for (;;) {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001065 here = state->lencode[last.val +
initial.commit3d533e02008-07-27 00:38:33 +00001066 (BITS(last.bits + last.op) >> last.bits)];
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001067 if ((unsigned)(last.bits + here.bits) <= bits) break;
initial.commit3d533e02008-07-27 00:38:33 +00001068 PULLBYTE();
1069 }
1070 DROPBITS(last.bits);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001071 state->back += last.bits;
initial.commit3d533e02008-07-27 00:38:33 +00001072 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001073 DROPBITS(here.bits);
1074 state->back += here.bits;
1075 state->length = (unsigned)here.val;
1076 if ((int)(here.op) == 0) {
1077 Tracevv((stderr, here.val >= 0x20 && here.val < 0x7f ?
initial.commit3d533e02008-07-27 00:38:33 +00001078 "inflate: literal '%c'\n" :
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001079 "inflate: literal 0x%02x\n", here.val));
initial.commit3d533e02008-07-27 00:38:33 +00001080 state->mode = LIT;
1081 break;
1082 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001083 if (here.op & 32) {
initial.commit3d533e02008-07-27 00:38:33 +00001084 Tracevv((stderr, "inflate: end of block\n"));
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001085 state->back = -1;
initial.commit3d533e02008-07-27 00:38:33 +00001086 state->mode = TYPE;
1087 break;
1088 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001089 if (here.op & 64) {
initial.commit3d533e02008-07-27 00:38:33 +00001090 strm->msg = (char *)"invalid literal/length code";
1091 state->mode = BAD;
1092 break;
1093 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001094 state->extra = (unsigned)(here.op) & 15;
initial.commit3d533e02008-07-27 00:38:33 +00001095 state->mode = LENEXT;
1096 case LENEXT:
1097 if (state->extra) {
1098 NEEDBITS(state->extra);
1099 state->length += BITS(state->extra);
1100 DROPBITS(state->extra);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001101 state->back += state->extra;
initial.commit3d533e02008-07-27 00:38:33 +00001102 }
1103 Tracevv((stderr, "inflate: length %u\n", state->length));
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001104 state->was = state->length;
initial.commit3d533e02008-07-27 00:38:33 +00001105 state->mode = DIST;
1106 case DIST:
1107 for (;;) {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001108 here = state->distcode[BITS(state->distbits)];
1109 if ((unsigned)(here.bits) <= bits) break;
initial.commit3d533e02008-07-27 00:38:33 +00001110 PULLBYTE();
1111 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001112 if ((here.op & 0xf0) == 0) {
1113 last = here;
initial.commit3d533e02008-07-27 00:38:33 +00001114 for (;;) {
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001115 here = state->distcode[last.val +
initial.commit3d533e02008-07-27 00:38:33 +00001116 (BITS(last.bits + last.op) >> last.bits)];
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001117 if ((unsigned)(last.bits + here.bits) <= bits) break;
initial.commit3d533e02008-07-27 00:38:33 +00001118 PULLBYTE();
1119 }
1120 DROPBITS(last.bits);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001121 state->back += last.bits;
initial.commit3d533e02008-07-27 00:38:33 +00001122 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001123 DROPBITS(here.bits);
1124 state->back += here.bits;
1125 if (here.op & 64) {
initial.commit3d533e02008-07-27 00:38:33 +00001126 strm->msg = (char *)"invalid distance code";
1127 state->mode = BAD;
1128 break;
1129 }
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001130 state->offset = (unsigned)here.val;
1131 state->extra = (unsigned)(here.op) & 15;
initial.commit3d533e02008-07-27 00:38:33 +00001132 state->mode = DISTEXT;
1133 case DISTEXT:
1134 if (state->extra) {
1135 NEEDBITS(state->extra);
1136 state->offset += BITS(state->extra);
1137 DROPBITS(state->extra);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001138 state->back += state->extra;
initial.commit3d533e02008-07-27 00:38:33 +00001139 }
1140#ifdef INFLATE_STRICT
1141 if (state->offset > state->dmax) {
1142 strm->msg = (char *)"invalid distance too far back";
1143 state->mode = BAD;
1144 break;
1145 }
1146#endif
initial.commit3d533e02008-07-27 00:38:33 +00001147 Tracevv((stderr, "inflate: distance %u\n", state->offset));
1148 state->mode = MATCH;
1149 case MATCH:
1150 if (left == 0) goto inf_leave;
1151 copy = out - left;
1152 if (state->offset > copy) { /* copy from window */
1153 copy = state->offset - copy;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001154 if (copy > state->whave) {
1155 if (state->sane) {
1156 strm->msg = (char *)"invalid distance too far back";
1157 state->mode = BAD;
1158 break;
1159 }
1160#ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1161 Trace((stderr, "inflate.c too far\n"));
1162 copy -= state->whave;
1163 if (copy > state->length) copy = state->length;
1164 if (copy > left) copy = left;
1165 left -= copy;
1166 state->length -= copy;
1167 do {
1168 *put++ = 0;
1169 } while (--copy);
1170 if (state->length == 0) state->mode = LEN;
1171 break;
1172#endif
1173 }
1174 if (copy > state->wnext) {
1175 copy -= state->wnext;
initial.commit3d533e02008-07-27 00:38:33 +00001176 from = state->window + (state->wsize - copy);
1177 }
1178 else
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001179 from = state->window + (state->wnext - copy);
initial.commit3d533e02008-07-27 00:38:33 +00001180 if (copy > state->length) copy = state->length;
1181 }
1182 else { /* copy from output */
1183 from = put - state->offset;
1184 copy = state->length;
1185 }
1186 if (copy > left) copy = left;
1187 left -= copy;
1188 state->length -= copy;
1189 do {
1190 *put++ = *from++;
1191 } while (--copy);
1192 if (state->length == 0) state->mode = LEN;
1193 break;
1194 case LIT:
1195 if (left == 0) goto inf_leave;
1196 *put++ = (unsigned char)(state->length);
1197 left--;
1198 state->mode = LEN;
1199 break;
1200 case CHECK:
1201 if (state->wrap) {
1202 NEEDBITS(32);
1203 out -= left;
1204 strm->total_out += out;
1205 state->total += out;
mark13dc2462017-02-14 22:15:29 -08001206 if ((state->wrap & 4) && out)
initial.commit3d533e02008-07-27 00:38:33 +00001207 strm->adler = state->check =
1208 UPDATE(state->check, put - out, out);
1209 out = left;
mark13dc2462017-02-14 22:15:29 -08001210 if ((state->wrap & 4) && (
initial.commit3d533e02008-07-27 00:38:33 +00001211#ifdef GUNZIP
1212 state->flags ? hold :
1213#endif
jiadong.zhu6c142162016-06-22 21:22:18 -07001214 ZSWAP32(hold)) != state->check) {
initial.commit3d533e02008-07-27 00:38:33 +00001215 strm->msg = (char *)"incorrect data check";
1216 state->mode = BAD;
1217 break;
1218 }
1219 INITBITS();
1220 Tracev((stderr, "inflate: check matches trailer\n"));
1221 }
1222#ifdef GUNZIP
1223 state->mode = LENGTH;
1224 case LENGTH:
1225 if (state->wrap && state->flags) {
1226 NEEDBITS(32);
1227 if (hold != (state->total & 0xffffffffUL)) {
1228 strm->msg = (char *)"incorrect length check";
1229 state->mode = BAD;
1230 break;
1231 }
1232 INITBITS();
1233 Tracev((stderr, "inflate: length matches trailer\n"));
1234 }
1235#endif
1236 state->mode = DONE;
1237 case DONE:
1238 ret = Z_STREAM_END;
1239 goto inf_leave;
1240 case BAD:
1241 ret = Z_DATA_ERROR;
1242 goto inf_leave;
1243 case MEM:
1244 return Z_MEM_ERROR;
1245 case SYNC:
1246 default:
1247 return Z_STREAM_ERROR;
1248 }
1249
1250 /*
1251 Return from inflate(), updating the total counts and the check value.
1252 If there was no progress during the inflate() call, return a buffer
1253 error. Call updatewindow() to create and/or update the window state.
1254 Note: a memory error from inflate() is non-recoverable.
1255 */
1256 inf_leave:
1257 RESTORE();
jiadong.zhu6c142162016-06-22 21:22:18 -07001258 if (state->wsize || (out != strm->avail_out && state->mode < BAD &&
1259 (state->mode < CHECK || flush != Z_FINISH)))
1260 if (updatewindow(strm, strm->next_out, out - strm->avail_out)) {
initial.commit3d533e02008-07-27 00:38:33 +00001261 state->mode = MEM;
1262 return Z_MEM_ERROR;
1263 }
1264 in -= strm->avail_in;
1265 out -= strm->avail_out;
1266 strm->total_in += in;
1267 strm->total_out += out;
1268 state->total += out;
mark13dc2462017-02-14 22:15:29 -08001269 if ((state->wrap & 4) && out)
initial.commit3d533e02008-07-27 00:38:33 +00001270 strm->adler = state->check =
1271 UPDATE(state->check, strm->next_out - out, out);
mark13dc2462017-02-14 22:15:29 -08001272 strm->data_type = (int)state->bits + (state->last ? 64 : 0) +
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001273 (state->mode == TYPE ? 128 : 0) +
1274 (state->mode == LEN_ || state->mode == COPY_ ? 256 : 0);
initial.commit3d533e02008-07-27 00:38:33 +00001275 if (((in == 0 && out == 0) || flush == Z_FINISH) && ret == Z_OK)
1276 ret = Z_BUF_ERROR;
1277 return ret;
1278}
1279
1280int ZEXPORT inflateEnd(strm)
1281z_streamp strm;
1282{
1283 struct inflate_state FAR *state;
mark13dc2462017-02-14 22:15:29 -08001284 if (inflateStateCheck(strm))
initial.commit3d533e02008-07-27 00:38:33 +00001285 return Z_STREAM_ERROR;
1286 state = (struct inflate_state FAR *)strm->state;
1287 if (state->window != Z_NULL) ZFREE(strm, state->window);
1288 ZFREE(strm, strm->state);
1289 strm->state = Z_NULL;
1290 Tracev((stderr, "inflate: end\n"));
1291 return Z_OK;
1292}
1293
jiadong.zhu6c142162016-06-22 21:22:18 -07001294int ZEXPORT inflateGetDictionary(strm, dictionary, dictLength)
1295z_streamp strm;
1296Bytef *dictionary;
1297uInt *dictLength;
1298{
1299 struct inflate_state FAR *state;
1300
1301 /* check state */
mark13dc2462017-02-14 22:15:29 -08001302 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
jiadong.zhu6c142162016-06-22 21:22:18 -07001303 state = (struct inflate_state FAR *)strm->state;
1304
1305 /* copy dictionary */
1306 if (state->whave && dictionary != Z_NULL) {
1307 zmemcpy(dictionary, state->window + state->wnext,
1308 state->whave - state->wnext);
1309 zmemcpy(dictionary + state->whave - state->wnext,
1310 state->window, state->wnext);
1311 }
1312 if (dictLength != Z_NULL)
1313 *dictLength = state->whave;
1314 return Z_OK;
1315}
1316
initial.commit3d533e02008-07-27 00:38:33 +00001317int ZEXPORT inflateSetDictionary(strm, dictionary, dictLength)
1318z_streamp strm;
1319const Bytef *dictionary;
1320uInt dictLength;
1321{
1322 struct inflate_state FAR *state;
jiadong.zhu6c142162016-06-22 21:22:18 -07001323 unsigned long dictid;
1324 int ret;
initial.commit3d533e02008-07-27 00:38:33 +00001325
1326 /* check state */
mark13dc2462017-02-14 22:15:29 -08001327 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
initial.commit3d533e02008-07-27 00:38:33 +00001328 state = (struct inflate_state FAR *)strm->state;
1329 if (state->wrap != 0 && state->mode != DICT)
1330 return Z_STREAM_ERROR;
1331
jiadong.zhu6c142162016-06-22 21:22:18 -07001332 /* check for correct dictionary identifier */
initial.commit3d533e02008-07-27 00:38:33 +00001333 if (state->mode == DICT) {
jiadong.zhu6c142162016-06-22 21:22:18 -07001334 dictid = adler32(0L, Z_NULL, 0);
1335 dictid = adler32(dictid, dictionary, dictLength);
1336 if (dictid != state->check)
initial.commit3d533e02008-07-27 00:38:33 +00001337 return Z_DATA_ERROR;
1338 }
1339
jiadong.zhu6c142162016-06-22 21:22:18 -07001340 /* copy dictionary to window using updatewindow(), which will amend the
1341 existing dictionary if appropriate */
1342 ret = updatewindow(strm, dictionary + dictLength, dictLength);
1343 if (ret) {
initial.commit3d533e02008-07-27 00:38:33 +00001344 state->mode = MEM;
1345 return Z_MEM_ERROR;
1346 }
initial.commit3d533e02008-07-27 00:38:33 +00001347 state->havedict = 1;
1348 Tracev((stderr, "inflate: dictionary set\n"));
1349 return Z_OK;
1350}
1351
1352int ZEXPORT inflateGetHeader(strm, head)
1353z_streamp strm;
1354gz_headerp head;
1355{
1356 struct inflate_state FAR *state;
1357
1358 /* check state */
mark13dc2462017-02-14 22:15:29 -08001359 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
initial.commit3d533e02008-07-27 00:38:33 +00001360 state = (struct inflate_state FAR *)strm->state;
1361 if ((state->wrap & 2) == 0) return Z_STREAM_ERROR;
1362
1363 /* save header structure */
1364 state->head = head;
1365 head->done = 0;
1366 return Z_OK;
1367}
1368
1369/*
1370 Search buf[0..len-1] for the pattern: 0, 0, 0xff, 0xff. Return when found
1371 or when out of input. When called, *have is the number of pattern bytes
1372 found in order so far, in 0..3. On return *have is updated to the new
1373 state. If on return *have equals four, then the pattern was found and the
1374 return value is how many bytes were read including the last byte of the
1375 pattern. If *have is less than four, then the pattern has not been found
1376 yet and the return value is len. In the latter case, syncsearch() can be
1377 called again with more data and the *have state. *have is initialized to
1378 zero for the first call.
1379 */
1380local unsigned syncsearch(have, buf, len)
1381unsigned FAR *have;
jiadong.zhu6c142162016-06-22 21:22:18 -07001382const unsigned char FAR *buf;
initial.commit3d533e02008-07-27 00:38:33 +00001383unsigned len;
1384{
1385 unsigned got;
1386 unsigned next;
1387
1388 got = *have;
1389 next = 0;
1390 while (next < len && got < 4) {
1391 if ((int)(buf[next]) == (got < 2 ? 0 : 0xff))
1392 got++;
1393 else if (buf[next])
1394 got = 0;
1395 else
1396 got = 4 - got;
1397 next++;
1398 }
1399 *have = got;
1400 return next;
1401}
1402
1403int ZEXPORT inflateSync(strm)
1404z_streamp strm;
1405{
1406 unsigned len; /* number of bytes to look at or looked at */
1407 unsigned long in, out; /* temporary to save total_in and total_out */
1408 unsigned char buf[4]; /* to restore bit buffer to byte string */
1409 struct inflate_state FAR *state;
1410
1411 /* check parameters */
mark13dc2462017-02-14 22:15:29 -08001412 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
initial.commit3d533e02008-07-27 00:38:33 +00001413 state = (struct inflate_state FAR *)strm->state;
1414 if (strm->avail_in == 0 && state->bits < 8) return Z_BUF_ERROR;
1415
1416 /* if first time, start search in bit buffer */
1417 if (state->mode != SYNC) {
1418 state->mode = SYNC;
1419 state->hold <<= state->bits & 7;
1420 state->bits -= state->bits & 7;
1421 len = 0;
1422 while (state->bits >= 8) {
1423 buf[len++] = (unsigned char)(state->hold);
1424 state->hold >>= 8;
1425 state->bits -= 8;
1426 }
1427 state->have = 0;
1428 syncsearch(&(state->have), buf, len);
1429 }
1430
1431 /* search available input */
1432 len = syncsearch(&(state->have), strm->next_in, strm->avail_in);
1433 strm->avail_in -= len;
1434 strm->next_in += len;
1435 strm->total_in += len;
1436
1437 /* return no joy or set up to restart inflate() on a new block */
1438 if (state->have != 4) return Z_DATA_ERROR;
1439 in = strm->total_in; out = strm->total_out;
1440 inflateReset(strm);
1441 strm->total_in = in; strm->total_out = out;
1442 state->mode = TYPE;
1443 return Z_OK;
1444}
1445
1446/*
1447 Returns true if inflate is currently at the end of a block generated by
1448 Z_SYNC_FLUSH or Z_FULL_FLUSH. This function is used by one PPP
1449 implementation to provide an additional safety check. PPP uses
1450 Z_SYNC_FLUSH but removes the length bytes of the resulting empty stored
1451 block. When decompressing, PPP checks that at the end of input packet,
1452 inflate is waiting for these length bytes.
1453 */
1454int ZEXPORT inflateSyncPoint(strm)
1455z_streamp strm;
1456{
1457 struct inflate_state FAR *state;
1458
mark13dc2462017-02-14 22:15:29 -08001459 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
initial.commit3d533e02008-07-27 00:38:33 +00001460 state = (struct inflate_state FAR *)strm->state;
1461 return state->mode == STORED && state->bits == 0;
1462}
1463
1464int ZEXPORT inflateCopy(dest, source)
1465z_streamp dest;
1466z_streamp source;
1467{
1468 struct inflate_state FAR *state;
1469 struct inflate_state FAR *copy;
1470 unsigned char FAR *window;
1471 unsigned wsize;
1472
1473 /* check input */
mark13dc2462017-02-14 22:15:29 -08001474 if (inflateStateCheck(source) || dest == Z_NULL)
initial.commit3d533e02008-07-27 00:38:33 +00001475 return Z_STREAM_ERROR;
1476 state = (struct inflate_state FAR *)source->state;
1477
1478 /* allocate space */
1479 copy = (struct inflate_state FAR *)
1480 ZALLOC(source, 1, sizeof(struct inflate_state));
1481 if (copy == Z_NULL) return Z_MEM_ERROR;
1482 window = Z_NULL;
1483 if (state->window != Z_NULL) {
1484 window = (unsigned char FAR *)
1485 ZALLOC(source, 1U << state->wbits, sizeof(unsigned char));
1486 if (window == Z_NULL) {
1487 ZFREE(source, copy);
1488 return Z_MEM_ERROR;
1489 }
1490 }
1491
1492 /* copy state */
jiadong.zhu6c142162016-06-22 21:22:18 -07001493 zmemcpy((voidpf)dest, (voidpf)source, sizeof(z_stream));
1494 zmemcpy((voidpf)copy, (voidpf)state, sizeof(struct inflate_state));
mark13dc2462017-02-14 22:15:29 -08001495 copy->strm = dest;
initial.commit3d533e02008-07-27 00:38:33 +00001496 if (state->lencode >= state->codes &&
1497 state->lencode <= state->codes + ENOUGH - 1) {
1498 copy->lencode = copy->codes + (state->lencode - state->codes);
1499 copy->distcode = copy->codes + (state->distcode - state->codes);
1500 }
1501 copy->next = copy->codes + (state->next - state->codes);
1502 if (window != Z_NULL) {
1503 wsize = 1U << state->wbits;
1504 zmemcpy(window, state->window, wsize);
1505 }
1506 copy->window = window;
1507 dest->state = (struct internal_state FAR *)copy;
1508 return Z_OK;
1509}
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001510
1511int ZEXPORT inflateUndermine(strm, subvert)
1512z_streamp strm;
1513int subvert;
1514{
1515 struct inflate_state FAR *state;
1516
mark13dc2462017-02-14 22:15:29 -08001517 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001518 state = (struct inflate_state FAR *)strm->state;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001519#ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
mark13dc2462017-02-14 22:15:29 -08001520 state->sane = !subvert;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001521 return Z_OK;
1522#else
mark13dc2462017-02-14 22:15:29 -08001523 (void)subvert;
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001524 state->sane = 1;
1525 return Z_DATA_ERROR;
1526#endif
1527}
1528
mark13dc2462017-02-14 22:15:29 -08001529int ZEXPORT inflateValidate(strm, check)
1530z_streamp strm;
1531int check;
1532{
1533 struct inflate_state FAR *state;
1534
1535 if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1536 state = (struct inflate_state FAR *)strm->state;
1537 if (check)
1538 state->wrap |= 4;
1539 else
1540 state->wrap &= ~4;
1541 return Z_OK;
1542}
1543
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001544long ZEXPORT inflateMark(strm)
1545z_streamp strm;
1546{
1547 struct inflate_state FAR *state;
1548
mark13dc2462017-02-14 22:15:29 -08001549 if (inflateStateCheck(strm))
1550 return -(1L << 16);
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001551 state = (struct inflate_state FAR *)strm->state;
mark13dc2462017-02-14 22:15:29 -08001552 return (long)(((unsigned long)((long)state->back)) << 16) +
hbono@chromium.orgd2dc2092011-12-12 08:48:38 +00001553 (state->mode == COPY ? state->length :
1554 (state->mode == MATCH ? state->was - state->length : 0));
1555}
mark13dc2462017-02-14 22:15:29 -08001556
1557unsigned long ZEXPORT inflateCodesUsed(strm)
1558z_streamp strm;
1559{
1560 struct inflate_state FAR *state;
1561 if (inflateStateCheck(strm)) return (unsigned long)-1;
1562 state = (struct inflate_state FAR *)strm->state;
1563 return (unsigned long)(state->next - state->codes);
1564}