1 /* inflate.c -- zlib decompression
2 * Copyright (C) 1995-2009 Mark Adler
3 * For conditions of distribution and use, see copyright notice in zlib.h
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
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
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
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
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
48 * - Pull out common write == 0 case for speed in inflate_fast()
49 * - 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
57 * 1.2.beta5 1 Jan 2003
58 * - Improved inflateBack() interface to allow the caller to provide initial
60 * - Fixed stored blocks bug in inflateBack()
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 *
69 * 1.2.beta7 27 Jan 2003
70 * - Changed many types to unsigned or unsigned short to avoid warnings
71 * - Added inflateCopy() function
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()
80 * The history for versions after 1.2.0 are in ChangeLog in zlib distribution.
94 /* function prototypes */
95 local void fixedtables OF((struct inflate_state FAR *state));
96 local int updatewindow OF((z_streamp strm, unsigned out));
98 void makefixed OF((void));
100 local unsigned syncsearch OF((unsigned FAR *have, unsigned char FAR *buf,
103 int ZEXPORT inflateReset(strm)
106 struct inflate_state FAR *state;
108 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
109 state = (struct inflate_state FAR *)strm->state;
110 strm->total_in = strm->total_out = state->total = 0;
112 strm->adler = 1; /* to support ill-conceived Java test suite */
116 state->dmax = 32768U;
117 state->head = Z_NULL;
123 state->lencode = state->distcode = state->next = state->codes;
126 Tracev((stderr, "inflate: reset\n"));
130 int ZEXPORT inflateReset2(strm, windowBits)
135 struct inflate_state FAR *state;
138 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
139 state = (struct inflate_state FAR *)strm->state;
141 /* extract wrap request from windowBits parameter */
142 if (windowBits < 0) {
144 windowBits = -windowBits;
147 wrap = (windowBits >> 4) + 1;
154 /* set number of window bits, free window if different */
155 if (windowBits < 8 || windowBits > 15)
156 return Z_STREAM_ERROR;
157 if (state->wbits != windowBits && state->window != Z_NULL) {
158 ZFREE(strm, state->window);
159 state->window = Z_NULL;
162 /* update state and reset the rest of it */
164 state->wbits = (unsigned)windowBits;
165 return inflateReset(strm);
168 int ZEXPORT inflateInit2_(strm, windowBits, version, stream_size)
175 struct inflate_state FAR *state;
177 if (version == Z_NULL || version[0] != ZLIB_VERSION[0] ||
178 stream_size != (int)(sizeof(z_stream)))
179 return Z_VERSION_ERROR;
180 if (strm == Z_NULL) return Z_STREAM_ERROR;
181 strm->msg = Z_NULL; /* in case we return an error */
182 if (strm->zalloc == (alloc_func)0) {
183 strm->zalloc = zcalloc;
184 strm->opaque = (voidpf)0;
186 if (strm->zfree == (free_func)0) strm->zfree = zcfree;
187 state = (struct inflate_state FAR *)
188 ZALLOC(strm, 1, sizeof(struct inflate_state));
189 if (state == Z_NULL) return Z_MEM_ERROR;
190 Tracev((stderr, "inflate: allocated\n"));
191 strm->state = (struct internal_state FAR *)state;
192 state->window = Z_NULL;
193 ret = inflateReset2(strm, windowBits);
196 strm->state = Z_NULL;
201 int ZEXPORT inflateInit_(strm, version, stream_size)
206 return inflateInit2_(strm, DEF_WBITS, version, stream_size);
209 int ZEXPORT inflatePrime(strm, bits, value)
214 struct inflate_state FAR *state;
216 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
217 state = (struct inflate_state FAR *)strm->state;
223 if (bits > 16 || state->bits + bits > 32) return Z_STREAM_ERROR;
224 value &= (1L << bits) - 1;
225 state->hold += value << state->bits;
231 Return state with length and distance decoding tables and index sizes set to
232 fixed code decoding. Normally this returns fixed tables from inffixed.h.
233 If BUILDFIXED is defined, then instead this routine builds the tables the
234 first time it's called, and returns those tables the first time and
235 thereafter. This reduces the size of the code by about 2K bytes, in
236 exchange for a little execution time. However, BUILDFIXED should not be
237 used for threaded applications, since the rewriting of the tables and virgin
238 may not be thread-safe.
240 local void fixedtables(state)
241 struct inflate_state FAR *state;
244 static int virgin = 1;
245 static code *lenfix, *distfix;
246 static code fixed[544];
248 /* build fixed huffman tables if first call (may not be thread safe) */
253 /* literal/length table */
255 while (sym < 144) state->lens[sym++] = 8;
256 while (sym < 256) state->lens[sym++] = 9;
257 while (sym < 280) state->lens[sym++] = 7;
258 while (sym < 288) state->lens[sym++] = 8;
262 inflate_table(LENS, state->lens, 288, &(next), &(bits), state->work);
266 while (sym < 32) state->lens[sym++] = 5;
269 inflate_table(DISTS, state->lens, 32, &(next), &(bits), state->work);
271 /* do this just once */
274 #else /* !BUILDFIXED */
275 # include "inffixed.h"
276 #endif /* BUILDFIXED */
277 state->lencode = lenfix;
279 state->distcode = distfix;
287 Write out the inffixed.h that is #include'd above. Defining MAKEFIXED also
288 defines BUILDFIXED, so the tables are built on the fly. makefixed() writes
289 those tables to stdout, which would be piped to inffixed.h. A small program
290 can simply call makefixed to do this:
292 void makefixed(void);
300 Then that can be linked with zlib built with MAKEFIXED defined and run:
307 struct inflate_state state;
310 puts(" /* inffixed.h -- table for decoding fixed codes");
311 puts(" * Generated automatically by makefixed().");
314 puts(" /* WARNING: this file should *not* be used by applications.");
315 puts(" It is part of the implementation of this library and is");
316 puts(" subject to change. Applications should only use zlib.h.");
320 printf(" static const code lenfix[%u] = {", size);
323 if ((low % 7) == 0) printf("\n ");
324 printf("{%u,%u,%d}", state.lencode[low].op, state.lencode[low].bits,
325 state.lencode[low].val);
326 if (++low == size) break;
331 printf("\n static const code distfix[%u] = {", size);
334 if ((low % 6) == 0) printf("\n ");
335 printf("{%u,%u,%d}", state.distcode[low].op, state.distcode[low].bits,
336 state.distcode[low].val);
337 if (++low == size) break;
342 #endif /* MAKEFIXED */
345 Update the window with the last wsize (normally 32K) bytes written before
346 returning. If window does not exist yet, create it. This is only called
347 when a window is already in use, or when output has been written during this
348 inflate call, but the end of the deflate stream has not been reached yet.
349 It is also called to create a window for dictionary data when a dictionary
352 Providing output buffers larger than 32K to inflate() should provide a speed
353 advantage, since only the last 32K of output is copied to the sliding window
354 upon return from inflate(), and since all distances after the first 32K of
355 output will fall in the output data, making match copies simpler and faster.
356 The advantage may be dependent on the size of the processor's data caches.
358 local int updatewindow(strm, out)
362 struct inflate_state FAR *state;
365 state = (struct inflate_state FAR *)strm->state;
367 /* if it hasn't been done already, allocate space for the window */
368 if (state->window == Z_NULL) {
369 state->window = (unsigned char FAR *)
370 ZALLOC(strm, 1U << state->wbits,
371 sizeof(unsigned char));
372 if (state->window == Z_NULL) return 1;
375 /* if window not in use yet, initialize */
376 if (state->wsize == 0) {
377 state->wsize = 1U << state->wbits;
382 /* copy state->wsize or less output bytes into the circular window */
383 copy = out - strm->avail_out;
384 if (copy >= state->wsize) {
385 zmemcpy(state->window, strm->next_out - state->wsize, state->wsize);
387 state->whave = state->wsize;
390 dist = state->wsize - state->write;
391 if (dist > copy) dist = copy;
392 zmemcpy(state->window + state->write, strm->next_out - copy, dist);
395 zmemcpy(state->window, strm->next_out - copy, copy);
397 state->whave = state->wsize;
400 state->write += dist;
401 if (state->write == state->wsize) state->write = 0;
402 if (state->whave < state->wsize) state->whave += dist;
408 /* Macros for inflate(): */
410 /* check function to use adler32() for zlib or crc32() for gzip */
412 # define UPDATE(check, buf, len) \
413 (state->flags ? crc32(check, buf, len) : adler32(check, buf, len))
415 # define UPDATE(check, buf, len) adler32(check, buf, len)
418 /* check macros for header crc */
420 # define CRC2(check, word) \
422 hbuf[0] = (unsigned char)(word); \
423 hbuf[1] = (unsigned char)((word) >> 8); \
424 check = crc32(check, hbuf, 2); \
427 # define CRC4(check, word) \
429 hbuf[0] = (unsigned char)(word); \
430 hbuf[1] = (unsigned char)((word) >> 8); \
431 hbuf[2] = (unsigned char)((word) >> 16); \
432 hbuf[3] = (unsigned char)((word) >> 24); \
433 check = crc32(check, hbuf, 4); \
437 /* Load registers with state in inflate() for speed */
440 put = strm->next_out; \
441 left = strm->avail_out; \
442 next = strm->next_in; \
443 have = strm->avail_in; \
444 hold = state->hold; \
445 bits = state->bits; \
448 /* Restore state from registers in inflate() */
451 strm->next_out = put; \
452 strm->avail_out = left; \
453 strm->next_in = next; \
454 strm->avail_in = have; \
455 state->hold = hold; \
456 state->bits = bits; \
459 /* Clear the input bit accumulator */
466 /* Get a byte of input into the bit accumulator, or return from inflate()
467 if there is no input available. */
470 if (have == 0) goto inf_leave; \
472 hold += (unsigned long)(*next++) << bits; \
476 /* Assure that there are at least n bits in the bit accumulator. If there is
477 not enough available input to do that, then return from inflate(). */
478 #define NEEDBITS(n) \
480 while (bits < (unsigned)(n)) \
484 /* Return the low n bits of the bit accumulator (n < 16) */
486 ((unsigned)hold & ((1U << (n)) - 1))
488 /* Remove n bits from the bit accumulator */
489 #define DROPBITS(n) \
492 bits -= (unsigned)(n); \
495 /* Remove zero to seven bits as needed to go to a byte boundary */
502 /* Reverse the bytes in a 32-bit value */
504 ((((q) >> 24) & 0xff) + (((q) >> 8) & 0xff00) + \
505 (((q) & 0xff00) << 8) + (((q) & 0xff) << 24))
508 inflate() uses a state machine to process as much input data and generate as
509 much output data as possible before returning. The state machine is
510 structured roughly as follows:
512 for (;;) switch (state) {
515 if (not enough input data or output space to make progress)
517 ... make progress ...
523 so when inflate() is called again, the same case is attempted again, and
524 if the appropriate resources are provided, the machine proceeds to the
525 next state. The NEEDBITS() macro is usually the way the state evaluates
526 whether it can proceed or should return. NEEDBITS() does the return if
527 the requested bits are not available. The typical use of the BITS macros
531 ... do something with BITS(n) ...
534 where NEEDBITS(n) either returns from inflate() if there isn't enough
535 input left to load n bits into the accumulator, or it continues. BITS(n)
536 gives the low n bits in the accumulator. When done, DROPBITS(n) drops
537 the low n bits off the accumulator. INITBITS() clears the accumulator
538 and sets the number of available bits to zero. BYTEBITS() discards just
539 enough bits to put the accumulator on a byte boundary. After BYTEBITS()
540 and a NEEDBITS(8), then BITS(8) would return the next byte in the stream.
542 NEEDBITS(n) uses PULLBYTE() to get an available byte of input, or to return
543 if there is no input available. The decoding of variable length codes uses
544 PULLBYTE() directly in order to pull just enough bytes to decode the next
547 Some states loop until they get enough input, making sure that enough
548 state information is maintained to continue the loop where it left off
549 if NEEDBITS() returns in the loop. For example, want, need, and keep
550 would all have to actually be part of the saved state in case NEEDBITS()
554 while (want < need) {
556 keep[want++] = BITS(n);
562 As shown above, if the next state is also the next case, then the break
565 A state may also return if there is not enough output space available to
566 complete that state. Those states are copying stored data, writing a
567 literal byte, and copying a matching string.
569 When returning, a "goto inf_leave" is used to update the total counters,
570 update the check value, and determine whether any progress has been made
571 during that inflate() call in order to return the proper return code.
572 Progress is defined as a change in either strm->avail_in or strm->avail_out.
573 When there is a window, goto inf_leave will update the window with the last
574 output written. If a goto inf_leave occurs in the middle of decompression
575 and there is no window currently, goto inf_leave will create one and copy
576 output to the window for the next call of inflate().
578 In this implementation, the flush parameter of inflate() only affects the
579 return code (per zlib.h). inflate() always writes as much as possible to
580 strm->next_out, given the space available and the provided input--the effect
581 documented in zlib.h of Z_SYNC_FLUSH. Furthermore, inflate() always defers
582 the allocation of and copying into a sliding window until necessary, which
583 provides the effect documented in zlib.h for Z_FINISH when the entire input
584 stream available. So the only thing the flush parameter actually does is:
585 when flush is set to Z_FINISH, inflate() cannot return Z_OK. Instead it
586 will return Z_BUF_ERROR if it has not reached the end of the stream.
589 int ZEXPORT inflate(strm, flush)
593 struct inflate_state FAR *state;
594 unsigned char FAR *next; /* next input */
595 unsigned char FAR *put; /* next output */
596 unsigned have, left; /* available input and output */
597 unsigned long hold; /* bit buffer */
598 unsigned bits; /* bits in bit buffer */
599 unsigned in, out; /* save starting available input and output */
600 unsigned copy; /* number of stored or match bytes to copy */
601 unsigned char FAR *from; /* where to copy match bytes from */
602 code here; /* current decoding table entry */
603 code last; /* parent table entry */
604 unsigned len; /* length to copy for repeats, bits to drop */
605 int ret; /* return code */
607 unsigned char hbuf[4]; /* buffer for gzip header crc calculation */
609 static const unsigned short order[19] = /* permutation of code lengths */
610 {16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15};
612 if (strm == Z_NULL || strm->state == Z_NULL || strm->next_out == Z_NULL ||
613 (strm->next_in == Z_NULL && strm->avail_in != 0))
614 return Z_STREAM_ERROR;
616 state = (struct inflate_state FAR *)strm->state;
617 if (state->mode == TYPE) state->mode = TYPEDO; /* skip check */
623 switch (state->mode) {
625 if (state->wrap == 0) {
626 state->mode = TYPEDO;
631 if ((state->wrap & 2) && hold == 0x8b1f) { /* gzip header */
632 state->check = crc32(0L, Z_NULL, 0);
633 CRC2(state->check, hold);
638 state->flags = 0; /* expect zlib header */
639 if (state->head != Z_NULL)
640 state->head->done = -1;
641 if (!(state->wrap & 1) || /* check if zlib header allowed */
645 ((BITS(8) << 8) + (hold >> 8)) % 31) {
646 strm->msg = (char *)"incorrect header check";
650 if (BITS(4) != Z_DEFLATED) {
651 strm->msg = (char *)"unknown compression method";
657 if (len > state->wbits) {
658 strm->msg = (char *)"invalid window size";
662 state->dmax = 1U << len;
663 Tracev((stderr, "inflate: zlib header ok\n"));
664 strm->adler = state->check = adler32(0L, Z_NULL, 0);
665 state->mode = hold & 0x200 ? DICTID : TYPE;
671 state->flags = (int)(hold);
672 if ((state->flags & 0xff) != Z_DEFLATED) {
673 strm->msg = (char *)"unknown compression method";
677 if (state->flags & 0xe000) {
678 strm->msg = (char *)"unknown header flags set";
682 if (state->head != Z_NULL)
683 state->head->text = (int)((hold >> 8) & 1);
684 if (state->flags & 0x0200) CRC2(state->check, hold);
689 if (state->head != Z_NULL)
690 state->head->time = hold;
691 if (state->flags & 0x0200) CRC4(state->check, hold);
696 if (state->head != Z_NULL) {
697 state->head->xflags = (int)(hold & 0xff);
698 state->head->os = (int)(hold >> 8);
700 if (state->flags & 0x0200) CRC2(state->check, hold);
704 if (state->flags & 0x0400) {
706 state->length = (unsigned)(hold);
707 if (state->head != Z_NULL)
708 state->head->extra_len = (unsigned)hold;
709 if (state->flags & 0x0200) CRC2(state->check, hold);
712 else if (state->head != Z_NULL)
713 state->head->extra = Z_NULL;
716 if (state->flags & 0x0400) {
717 copy = state->length;
718 if (copy > have) copy = have;
720 if (state->head != Z_NULL &&
721 state->head->extra != Z_NULL) {
722 len = state->head->extra_len - state->length;
723 zmemcpy(state->head->extra + len, next,
724 len + copy > state->head->extra_max ?
725 state->head->extra_max - len : copy);
727 if (state->flags & 0x0200)
728 state->check = crc32(state->check, next, copy);
731 state->length -= copy;
733 if (state->length) goto inf_leave;
738 if (state->flags & 0x0800) {
739 if (have == 0) goto inf_leave;
742 len = (unsigned)(next[copy++]);
743 if (state->head != Z_NULL &&
744 state->head->name != Z_NULL &&
745 state->length < state->head->name_max)
746 state->head->name[state->length++] = len;
747 } while (len && copy < have);
748 if (state->flags & 0x0200)
749 state->check = crc32(state->check, next, copy);
752 if (len) goto inf_leave;
754 else if (state->head != Z_NULL)
755 state->head->name = Z_NULL;
757 state->mode = COMMENT;
759 if (state->flags & 0x1000) {
760 if (have == 0) goto inf_leave;
763 len = (unsigned)(next[copy++]);
764 if (state->head != Z_NULL &&
765 state->head->comment != Z_NULL &&
766 state->length < state->head->comm_max)
767 state->head->comment[state->length++] = len;
768 } while (len && copy < have);
769 if (state->flags & 0x0200)
770 state->check = crc32(state->check, next, copy);
773 if (len) goto inf_leave;
775 else if (state->head != Z_NULL)
776 state->head->comment = Z_NULL;
779 if (state->flags & 0x0200) {
781 if (hold != (state->check & 0xffff)) {
782 strm->msg = (char *)"header crc mismatch";
788 if (state->head != Z_NULL) {
789 state->head->hcrc = (int)((state->flags >> 9) & 1);
790 state->head->done = 1;
792 strm->adler = state->check = crc32(0L, Z_NULL, 0);
798 strm->adler = state->check = REVERSE(hold);
802 if (state->havedict == 0) {
806 strm->adler = state->check = adler32(0L, Z_NULL, 0);
809 if (flush == Z_BLOCK || flush == Z_TREES) goto inf_leave;
817 state->last = BITS(1);
820 case 0: /* stored block */
821 Tracev((stderr, "inflate: stored block%s\n",
822 state->last ? " (last)" : ""));
823 state->mode = STORED;
825 case 1: /* fixed block */
827 Tracev((stderr, "inflate: fixed codes block%s\n",
828 state->last ? " (last)" : ""));
829 state->mode = LEN_; /* decode codes */
830 if (flush == Z_TREES) {
835 case 2: /* dynamic block */
836 Tracev((stderr, "inflate: dynamic codes block%s\n",
837 state->last ? " (last)" : ""));
841 strm->msg = (char *)"invalid block type";
847 BYTEBITS(); /* go to byte boundary */
849 if ((hold & 0xffff) != ((hold >> 16) ^ 0xffff)) {
850 strm->msg = (char *)"invalid stored block lengths";
854 state->length = (unsigned)hold & 0xffff;
855 Tracev((stderr, "inflate: stored length %u\n",
859 if (flush == Z_TREES) goto inf_leave;
863 copy = state->length;
865 if (copy > have) copy = have;
866 if (copy > left) copy = left;
867 if (copy == 0) goto inf_leave;
868 zmemcpy(put, next, copy);
873 state->length -= copy;
876 Tracev((stderr, "inflate: stored end\n"));
881 state->nlen = BITS(5) + 257;
883 state->ndist = BITS(5) + 1;
885 state->ncode = BITS(4) + 4;
887 #ifndef PKZIP_BUG_WORKAROUND
888 if (state->nlen > 286 || state->ndist > 30) {
889 strm->msg = (char *)"too many length or distance symbols";
894 Tracev((stderr, "inflate: table sizes ok\n"));
896 state->mode = LENLENS;
898 while (state->have < state->ncode) {
900 state->lens[order[state->have++]] = (unsigned short)BITS(3);
903 while (state->have < 19)
904 state->lens[order[state->have++]] = 0;
905 state->next = state->codes;
906 state->lencode = (code const FAR *)(state->next);
908 ret = inflate_table(CODES, state->lens, 19, &(state->next),
909 &(state->lenbits), state->work);
911 strm->msg = (char *)"invalid code lengths set";
915 Tracev((stderr, "inflate: code lengths ok\n"));
917 state->mode = CODELENS;
919 while (state->have < state->nlen + state->ndist) {
921 here = state->lencode[BITS(state->lenbits)];
922 if ((unsigned)(here.bits) <= bits) break;
928 state->lens[state->have++] = here.val;
931 if (here.val == 16) {
932 NEEDBITS(here.bits + 2);
934 if (state->have == 0) {
935 strm->msg = (char *)"invalid bit length repeat";
939 len = state->lens[state->have - 1];
943 else if (here.val == 17) {
944 NEEDBITS(here.bits + 3);
951 NEEDBITS(here.bits + 7);
957 if (state->have + copy > state->nlen + state->ndist) {
958 strm->msg = (char *)"invalid bit length repeat";
963 state->lens[state->have++] = (unsigned short)len;
967 /* handle error breaks in while */
968 if (state->mode == BAD) break;
970 /* check for end-of-block code (better have one) */
971 if (state->lens[256] == 0) {
972 strm->msg = (char *)"invalid code -- missing end-of-block";
977 /* build code tables -- note: do not change the lenbits or distbits
978 values here (9 and 6) without reading the comments in inftrees.h
979 concerning the ENOUGH constants, which depend on those values */
980 state->next = state->codes;
981 state->lencode = (code const FAR *)(state->next);
983 ret = inflate_table(LENS, state->lens, state->nlen, &(state->next),
984 &(state->lenbits), state->work);
986 strm->msg = (char *)"invalid literal/lengths set";
990 state->distcode = (code const FAR *)(state->next);
992 ret = inflate_table(DISTS, state->lens + state->nlen, state->ndist,
993 &(state->next), &(state->distbits), state->work);
995 strm->msg = (char *)"invalid distances set";
999 Tracev((stderr, "inflate: codes ok\n"));
1001 if (flush == Z_TREES) goto inf_leave;
1005 if (have >= 6 && left >= 258) {
1007 inflate_fast(strm, out);
1009 if (state->mode == TYPE)
1015 here = state->lencode[BITS(state->lenbits)];
1016 if ((unsigned)(here.bits) <= bits) break;
1019 if (here.op && (here.op & 0xf0) == 0) {
1022 here = state->lencode[last.val +
1023 (BITS(last.bits + last.op) >> last.bits)];
1024 if ((unsigned)(last.bits + here.bits) <= bits) break;
1027 DROPBITS(last.bits);
1028 state->back += last.bits;
1030 DROPBITS(here.bits);
1031 state->back += here.bits;
1032 state->length = (unsigned)here.val;
1033 if ((int)(here.op) == 0) {
1034 Tracevv((stderr, here.val >= 0x20 && here.val < 0x7f ?
1035 "inflate: literal '%c'\n" :
1036 "inflate: literal 0x%02x\n", here.val));
1041 Tracevv((stderr, "inflate: end of block\n"));
1047 strm->msg = (char *)"invalid literal/length code";
1051 state->extra = (unsigned)(here.op) & 15;
1052 state->mode = LENEXT;
1055 NEEDBITS(state->extra);
1056 state->length += BITS(state->extra);
1057 DROPBITS(state->extra);
1058 state->back += state->extra;
1060 Tracevv((stderr, "inflate: length %u\n", state->length));
1061 state->was = state->length;
1065 here = state->distcode[BITS(state->distbits)];
1066 if ((unsigned)(here.bits) <= bits) break;
1069 if ((here.op & 0xf0) == 0) {
1072 here = state->distcode[last.val +
1073 (BITS(last.bits + last.op) >> last.bits)];
1074 if ((unsigned)(last.bits + here.bits) <= bits) break;
1077 DROPBITS(last.bits);
1078 state->back += last.bits;
1080 DROPBITS(here.bits);
1081 state->back += here.bits;
1083 strm->msg = (char *)"invalid distance code";
1087 state->offset = (unsigned)here.val;
1088 state->extra = (unsigned)(here.op) & 15;
1089 state->mode = DISTEXT;
1092 NEEDBITS(state->extra);
1093 state->offset += BITS(state->extra);
1094 DROPBITS(state->extra);
1095 state->back += state->extra;
1097 #ifdef INFLATE_STRICT
1098 if (state->offset > state->dmax) {
1099 strm->msg = (char *)"invalid distance too far back";
1104 Tracevv((stderr, "inflate: distance %u\n", state->offset));
1105 state->mode = MATCH;
1107 if (left == 0) goto inf_leave;
1109 if (state->offset > copy) { /* copy from window */
1110 copy = state->offset - copy;
1111 if (copy > state->whave) {
1113 strm->msg = (char *)"invalid distance too far back";
1117 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1118 Trace((stderr, "inflate.c too far\n"));
1119 copy -= state->whave;
1120 if (copy > state->length) copy = state->length;
1121 if (copy > left) copy = left;
1123 state->length -= copy;
1127 if (state->length == 0) state->mode = LEN;
1131 if (copy > state->write) {
1132 copy -= state->write;
1133 /* %% problem here if copy > state->wsize -- avoid? */
1134 /* %% or can (state->window + state->wsize) - copy */
1135 /* %% but really should detect and reject this case */
1136 from = state->window + (state->wsize - copy);
1139 from = state->window + (state->write - copy);
1140 if (copy > state->length) copy = state->length;
1142 else { /* copy from output */
1143 from = put - state->offset;
1144 copy = state->length;
1146 if (copy > left) copy = left;
1148 state->length -= copy;
1152 if (state->length == 0) state->mode = LEN;
1155 if (left == 0) goto inf_leave;
1156 *put++ = (unsigned char)(state->length);
1164 strm->total_out += out;
1165 state->total += out;
1167 strm->adler = state->check =
1168 UPDATE(state->check, put - out, out);
1172 state->flags ? hold :
1174 REVERSE(hold)) != state->check) {
1175 strm->msg = (char *)"incorrect data check";
1180 Tracev((stderr, "inflate: check matches trailer\n"));
1183 state->mode = LENGTH;
1185 if (state->wrap && state->flags) {
1187 if (hold != (state->total & 0xffffffffUL)) {
1188 strm->msg = (char *)"incorrect length check";
1193 Tracev((stderr, "inflate: length matches trailer\n"));
1207 return Z_STREAM_ERROR;
1211 Return from inflate(), updating the total counts and the check value.
1212 If there was no progress during the inflate() call, return a buffer
1213 error. Call updatewindow() to create and/or update the window state.
1214 Note: a memory error from inflate() is non-recoverable.
1218 if (state->wsize || (state->mode < CHECK && out != strm->avail_out))
1219 if (updatewindow(strm, out)) {
1223 in -= strm->avail_in;
1224 out -= strm->avail_out;
1225 strm->total_in += in;
1226 strm->total_out += out;
1227 state->total += out;
1228 if (state->wrap && out)
1229 strm->adler = state->check =
1230 UPDATE(state->check, strm->next_out - out, out);
1231 strm->data_type = state->bits + (state->last ? 64 : 0) +
1232 (state->mode == TYPE ? 128 : 0) +
1233 (state->mode == LEN_ || state->mode == COPY_ ? 256 : 0);
1234 if (((in == 0 && out == 0) || flush == Z_FINISH) && ret == Z_OK)
1239 int ZEXPORT inflateEnd(strm)
1242 struct inflate_state FAR *state;
1243 if (strm == Z_NULL || strm->state == Z_NULL || strm->zfree == (free_func)0)
1244 return Z_STREAM_ERROR;
1245 state = (struct inflate_state FAR *)strm->state;
1246 if (state->window != Z_NULL) ZFREE(strm, state->window);
1247 ZFREE(strm, strm->state);
1248 strm->state = Z_NULL;
1249 Tracev((stderr, "inflate: end\n"));
1253 int ZEXPORT inflateSetDictionary(strm, dictionary, dictLength)
1255 const Bytef *dictionary;
1258 struct inflate_state FAR *state;
1262 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
1263 state = (struct inflate_state FAR *)strm->state;
1264 if (state->wrap != 0 && state->mode != DICT)
1265 return Z_STREAM_ERROR;
1267 /* check for correct dictionary id */
1268 if (state->mode == DICT) {
1269 id = adler32(0L, Z_NULL, 0);
1270 id = adler32(id, dictionary, dictLength);
1271 if (id != state->check)
1272 return Z_DATA_ERROR;
1275 /* copy dictionary to window */
1276 if (updatewindow(strm, strm->avail_out)) {
1280 if (dictLength > state->wsize) {
1281 zmemcpy(state->window, dictionary + dictLength - state->wsize,
1283 state->whave = state->wsize;
1286 zmemcpy(state->window + state->wsize - dictLength, dictionary,
1288 state->whave = dictLength;
1290 state->havedict = 1;
1291 Tracev((stderr, "inflate: dictionary set\n"));
1295 int ZEXPORT inflateGetHeader(strm, head)
1299 struct inflate_state FAR *state;
1302 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
1303 state = (struct inflate_state FAR *)strm->state;
1304 if ((state->wrap & 2) == 0) return Z_STREAM_ERROR;
1306 /* save header structure */
1313 Search buf[0..len-1] for the pattern: 0, 0, 0xff, 0xff. Return when found
1314 or when out of input. When called, *have is the number of pattern bytes
1315 found in order so far, in 0..3. On return *have is updated to the new
1316 state. If on return *have equals four, then the pattern was found and the
1317 return value is how many bytes were read including the last byte of the
1318 pattern. If *have is less than four, then the pattern has not been found
1319 yet and the return value is len. In the latter case, syncsearch() can be
1320 called again with more data and the *have state. *have is initialized to
1321 zero for the first call.
1323 local unsigned syncsearch(have, buf, len)
1325 unsigned char FAR *buf;
1333 while (next < len && got < 4) {
1334 if ((int)(buf[next]) == (got < 2 ? 0 : 0xff))
1346 int ZEXPORT inflateSync(strm)
1349 unsigned len; /* number of bytes to look at or looked at */
1350 unsigned long in, out; /* temporary to save total_in and total_out */
1351 unsigned char buf[4]; /* to restore bit buffer to byte string */
1352 struct inflate_state FAR *state;
1354 /* check parameters */
1355 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
1356 state = (struct inflate_state FAR *)strm->state;
1357 if (strm->avail_in == 0 && state->bits < 8) return Z_BUF_ERROR;
1359 /* if first time, start search in bit buffer */
1360 if (state->mode != SYNC) {
1362 state->hold <<= state->bits & 7;
1363 state->bits -= state->bits & 7;
1365 while (state->bits >= 8) {
1366 buf[len++] = (unsigned char)(state->hold);
1371 syncsearch(&(state->have), buf, len);
1374 /* search available input */
1375 len = syncsearch(&(state->have), strm->next_in, strm->avail_in);
1376 strm->avail_in -= len;
1377 strm->next_in += len;
1378 strm->total_in += len;
1380 /* return no joy or set up to restart inflate() on a new block */
1381 if (state->have != 4) return Z_DATA_ERROR;
1382 in = strm->total_in; out = strm->total_out;
1384 strm->total_in = in; strm->total_out = out;
1390 Returns true if inflate is currently at the end of a block generated by
1391 Z_SYNC_FLUSH or Z_FULL_FLUSH. This function is used by one PPP
1392 implementation to provide an additional safety check. PPP uses
1393 Z_SYNC_FLUSH but removes the length bytes of the resulting empty stored
1394 block. When decompressing, PPP checks that at the end of input packet,
1395 inflate is waiting for these length bytes.
1397 int ZEXPORT inflateSyncPoint(strm)
1400 struct inflate_state FAR *state;
1402 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
1403 state = (struct inflate_state FAR *)strm->state;
1404 return state->mode == STORED && state->bits == 0;
1407 int ZEXPORT inflateCopy(dest, source)
1411 struct inflate_state FAR *state;
1412 struct inflate_state FAR *copy;
1413 unsigned char FAR *window;
1417 if (dest == Z_NULL || source == Z_NULL || source->state == Z_NULL ||
1418 source->zalloc == (alloc_func)0 || source->zfree == (free_func)0)
1419 return Z_STREAM_ERROR;
1420 state = (struct inflate_state FAR *)source->state;
1422 /* allocate space */
1423 copy = (struct inflate_state FAR *)
1424 ZALLOC(source, 1, sizeof(struct inflate_state));
1425 if (copy == Z_NULL) return Z_MEM_ERROR;
1427 if (state->window != Z_NULL) {
1428 window = (unsigned char FAR *)
1429 ZALLOC(source, 1U << state->wbits, sizeof(unsigned char));
1430 if (window == Z_NULL) {
1431 ZFREE(source, copy);
1437 zmemcpy(dest, source, sizeof(z_stream));
1438 zmemcpy(copy, state, sizeof(struct inflate_state));
1439 if (state->lencode >= state->codes &&
1440 state->lencode <= state->codes + ENOUGH - 1) {
1441 copy->lencode = copy->codes + (state->lencode - state->codes);
1442 copy->distcode = copy->codes + (state->distcode - state->codes);
1444 copy->next = copy->codes + (state->next - state->codes);
1445 if (window != Z_NULL) {
1446 wsize = 1U << state->wbits;
1447 zmemcpy(window, state->window, wsize);
1449 copy->window = window;
1450 dest->state = (struct internal_state FAR *)copy;
1454 int ZEXPORT inflateUndermine(strm, subvert)
1458 struct inflate_state FAR *state;
1460 if (strm == Z_NULL || strm->state == Z_NULL) return Z_STREAM_ERROR;
1461 state = (struct inflate_state FAR *)strm->state;
1462 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1463 state->sane = !subvert;
1467 return Z_DATA_ERROR;
1471 long ZEXPORT inflateMark(strm)
1474 struct inflate_state FAR *state;
1476 if (strm == Z_NULL || strm->state == Z_NULL) return -1L << 16;
1477 state = (struct inflate_state FAR *)strm->state;
1478 return ((long)(state->back) << 16) +
1479 (state->mode == COPY ? state->length :
1480 (state->mode == MATCH ? state->was - state->length : 0));