1 /* inflate.c -- zlib decompression
2 * Copyright (C) 1995-2012 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 wnext == 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
, const unsigned char FAR
*end
,
99 void makefixed
OF((void));
101 local
unsigned syncsearch
OF((unsigned FAR
*have
, const unsigned char FAR
*buf
,
104 int ZEXPORT
inflateResetKeep(strm
)
107 struct inflate_state FAR
*state
;
109 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
110 state
= (struct inflate_state FAR
*)strm
->state
;
111 strm
->total_in
= strm
->total_out
= state
->total
= 0;
113 if (state
->wrap
) /* to support ill-conceived Java test suite */
114 strm
->adler
= state
->wrap
& 1;
118 state
->dmax
= 32768U;
119 state
->head
= Z_NULL
;
122 state
->lencode
= state
->distcode
= state
->next
= state
->codes
;
125 Tracev((stderr
, "inflate: reset\n"));
129 int ZEXPORT
inflateReset(strm
)
132 struct inflate_state FAR
*state
;
134 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
135 state
= (struct inflate_state FAR
*)strm
->state
;
139 return inflateResetKeep(strm
);
142 int ZEXPORT
inflateReset2(strm
, windowBits
)
147 struct inflate_state FAR
*state
;
150 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
151 state
= (struct inflate_state FAR
*)strm
->state
;
153 /* extract wrap request from windowBits parameter */
154 if (windowBits
< 0) {
156 windowBits
= -windowBits
;
159 wrap
= (windowBits
>> 4) + 1;
166 /* set number of window bits, free window if different */
167 if (windowBits
&& (windowBits
< 8 || windowBits
> 15))
168 return Z_STREAM_ERROR
;
169 if (state
->window
!= Z_NULL
&& state
->wbits
!= (unsigned)windowBits
) {
170 ZFREE(strm
, state
->window
);
171 state
->window
= Z_NULL
;
174 /* update state and reset the rest of it */
176 state
->wbits
= (unsigned)windowBits
;
177 return inflateReset(strm
);
180 int ZEXPORT
inflateInit2_(strm
, windowBits
, version
, stream_size
)
187 struct inflate_state FAR
*state
;
189 if (version
== Z_NULL
|| version
[0] != ZLIB_VERSION
[0] ||
190 stream_size
!= (int)(sizeof(z_stream
)))
191 return Z_VERSION_ERROR
;
192 if (strm
== Z_NULL
) return Z_STREAM_ERROR
;
193 strm
->msg
= Z_NULL
; /* in case we return an error */
194 if (strm
->zalloc
== (alloc_func
)0) {
196 return Z_STREAM_ERROR
;
198 strm
->zalloc
= zcalloc
;
199 strm
->opaque
= (voidpf
)0;
202 if (strm
->zfree
== (free_func
)0)
204 return Z_STREAM_ERROR
;
206 strm
->zfree
= zcfree
;
208 state
= (struct inflate_state FAR
*)
209 ZALLOC(strm
, 1, sizeof(struct inflate_state
));
210 if (state
== Z_NULL
) return Z_MEM_ERROR
;
211 Tracev((stderr
, "inflate: allocated\n"));
212 strm
->state
= (struct internal_state FAR
*)state
;
213 state
->window
= Z_NULL
;
214 ret
= inflateReset2(strm
, windowBits
);
217 strm
->state
= Z_NULL
;
222 int ZEXPORT
inflateInit_(strm
, version
, stream_size
)
227 return inflateInit2_(strm
, DEF_WBITS
, version
, stream_size
);
230 int ZEXPORT
inflatePrime(strm
, bits
, value
)
235 struct inflate_state FAR
*state
;
237 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
238 state
= (struct inflate_state FAR
*)strm
->state
;
244 if (bits
> 16 || state
->bits
+ bits
> 32) return Z_STREAM_ERROR
;
245 value
&= (1L << bits
) - 1;
246 state
->hold
+= value
<< state
->bits
;
252 Return state with length and distance decoding tables and index sizes set to
253 fixed code decoding. Normally this returns fixed tables from inffixed.h.
254 If BUILDFIXED is defined, then instead this routine builds the tables the
255 first time it's called, and returns those tables the first time and
256 thereafter. This reduces the size of the code by about 2K bytes, in
257 exchange for a little execution time. However, BUILDFIXED should not be
258 used for threaded applications, since the rewriting of the tables and virgin
259 may not be thread-safe.
261 local
void fixedtables(state
)
262 struct inflate_state FAR
*state
;
265 static int virgin
= 1;
266 static code
*lenfix
, *distfix
;
267 static code fixed
[544];
269 /* build fixed huffman tables if first call (may not be thread safe) */
274 /* literal/length table */
276 while (sym
< 144) state
->lens
[sym
++] = 8;
277 while (sym
< 256) state
->lens
[sym
++] = 9;
278 while (sym
< 280) state
->lens
[sym
++] = 7;
279 while (sym
< 288) state
->lens
[sym
++] = 8;
283 inflate_table(LENS
, state
->lens
, 288, &(next
), &(bits
), state
->work
);
287 while (sym
< 32) state
->lens
[sym
++] = 5;
290 inflate_table(DISTS
, state
->lens
, 32, &(next
), &(bits
), state
->work
);
292 /* do this just once */
295 #else /* !BUILDFIXED */
296 # include "inffixed.h"
297 #endif /* BUILDFIXED */
298 state
->lencode
= lenfix
;
300 state
->distcode
= distfix
;
308 Write out the inffixed.h that is #include'd above. Defining MAKEFIXED also
309 defines BUILDFIXED, so the tables are built on the fly. makefixed() writes
310 those tables to stdout, which would be piped to inffixed.h. A small program
311 can simply call makefixed to do this:
313 void makefixed(void);
321 Then that can be linked with zlib built with MAKEFIXED defined and run:
328 struct inflate_state state
;
331 puts(" /* inffixed.h -- table for decoding fixed codes");
332 puts(" * Generated automatically by makefixed().");
335 puts(" /* WARNING: this file should *not* be used by applications.");
336 puts(" It is part of the implementation of this library and is");
337 puts(" subject to change. Applications should only use zlib.h.");
341 printf(" static const code lenfix[%u] = {", size
);
344 if ((low
% 7) == 0) printf("\n ");
345 printf("{%u,%u,%d}", (low
& 127) == 99 ? 64 : state
.lencode
[low
].op
,
346 state
.lencode
[low
].bits
, state
.lencode
[low
].val
);
347 if (++low
== size
) break;
352 printf("\n static const code distfix[%u] = {", size
);
355 if ((low
% 6) == 0) printf("\n ");
356 printf("{%u,%u,%d}", state
.distcode
[low
].op
, state
.distcode
[low
].bits
,
357 state
.distcode
[low
].val
);
358 if (++low
== size
) break;
363 #endif /* MAKEFIXED */
366 Update the window with the last wsize (normally 32K) bytes written before
367 returning. If window does not exist yet, create it. This is only called
368 when a window is already in use, or when output has been written during this
369 inflate call, but the end of the deflate stream has not been reached yet.
370 It is also called to create a window for dictionary data when a dictionary
373 Providing output buffers larger than 32K to inflate() should provide a speed
374 advantage, since only the last 32K of output is copied to the sliding window
375 upon return from inflate(), and since all distances after the first 32K of
376 output will fall in the output data, making match copies simpler and faster.
377 The advantage may be dependent on the size of the processor's data caches.
379 local
int updatewindow(strm
, end
, copy
)
384 struct inflate_state FAR
*state
;
387 state
= (struct inflate_state FAR
*)strm
->state
;
389 /* if it hasn't been done already, allocate space for the window */
390 if (state
->window
== Z_NULL
) {
391 state
->window
= (unsigned char FAR
*)
392 ZALLOC(strm
, 1U << state
->wbits
,
393 sizeof(unsigned char));
394 if (state
->window
== Z_NULL
) return 1;
397 /* if window not in use yet, initialize */
398 if (state
->wsize
== 0) {
399 state
->wsize
= 1U << state
->wbits
;
404 /* copy state->wsize or less output bytes into the circular window */
405 if (copy
>= state
->wsize
) {
406 zmemcpy(state
->window
, end
- state
->wsize
, state
->wsize
);
408 state
->whave
= state
->wsize
;
411 dist
= state
->wsize
- state
->wnext
;
412 if (dist
> copy
) dist
= copy
;
413 zmemcpy(state
->window
+ state
->wnext
, end
- copy
, dist
);
416 zmemcpy(state
->window
, end
- copy
, copy
);
418 state
->whave
= state
->wsize
;
421 state
->wnext
+= dist
;
422 if (state
->wnext
== state
->wsize
) state
->wnext
= 0;
423 if (state
->whave
< state
->wsize
) state
->whave
+= dist
;
429 /* Macros for inflate(): */
431 /* check function to use adler32() for zlib or crc32() for gzip */
433 # define UPDATE(check, buf, len) \
434 (state->flags ? crc32(check, buf, len) : adler32(check, buf, len))
436 # define UPDATE(check, buf, len) adler32(check, buf, len)
439 /* check macros for header crc */
441 # define CRC2(check, word) \
443 hbuf[0] = (unsigned char)(word); \
444 hbuf[1] = (unsigned char)((word) >> 8); \
445 check = crc32(check, hbuf, 2); \
448 # define CRC4(check, word) \
450 hbuf[0] = (unsigned char)(word); \
451 hbuf[1] = (unsigned char)((word) >> 8); \
452 hbuf[2] = (unsigned char)((word) >> 16); \
453 hbuf[3] = (unsigned char)((word) >> 24); \
454 check = crc32(check, hbuf, 4); \
458 /* Load registers with state in inflate() for speed */
461 put = strm->next_out; \
462 left = strm->avail_out; \
463 next = strm->next_in; \
464 have = strm->avail_in; \
465 hold = state->hold; \
466 bits = state->bits; \
469 /* Restore state from registers in inflate() */
472 strm->next_out = put; \
473 strm->avail_out = left; \
474 strm->next_in = next; \
475 strm->avail_in = have; \
476 state->hold = hold; \
477 state->bits = bits; \
480 /* Clear the input bit accumulator */
487 /* Get a byte of input into the bit accumulator, or return from inflate()
488 if there is no input available. */
491 if (have == 0) goto inf_leave; \
493 hold += (unsigned long)(*next++) << bits; \
497 /* Assure that there are at least n bits in the bit accumulator. If there is
498 not enough available input to do that, then return from inflate(). */
499 #define NEEDBITS(n) \
501 while (bits < (unsigned)(n)) \
505 /* Return the low n bits of the bit accumulator (n < 16) */
507 ((unsigned)hold & ((1U << (n)) - 1))
509 /* Remove n bits from the bit accumulator */
510 #define DROPBITS(n) \
513 bits -= (unsigned)(n); \
516 /* Remove zero to seven bits as needed to go to a byte boundary */
524 inflate() uses a state machine to process as much input data and generate as
525 much output data as possible before returning. The state machine is
526 structured roughly as follows:
528 for (;;) switch (state) {
531 if (not enough input data or output space to make progress)
533 ... make progress ...
539 so when inflate() is called again, the same case is attempted again, and
540 if the appropriate resources are provided, the machine proceeds to the
541 next state. The NEEDBITS() macro is usually the way the state evaluates
542 whether it can proceed or should return. NEEDBITS() does the return if
543 the requested bits are not available. The typical use of the BITS macros
547 ... do something with BITS(n) ...
550 where NEEDBITS(n) either returns from inflate() if there isn't enough
551 input left to load n bits into the accumulator, or it continues. BITS(n)
552 gives the low n bits in the accumulator. When done, DROPBITS(n) drops
553 the low n bits off the accumulator. INITBITS() clears the accumulator
554 and sets the number of available bits to zero. BYTEBITS() discards just
555 enough bits to put the accumulator on a byte boundary. After BYTEBITS()
556 and a NEEDBITS(8), then BITS(8) would return the next byte in the stream.
558 NEEDBITS(n) uses PULLBYTE() to get an available byte of input, or to return
559 if there is no input available. The decoding of variable length codes uses
560 PULLBYTE() directly in order to pull just enough bytes to decode the next
563 Some states loop until they get enough input, making sure that enough
564 state information is maintained to continue the loop where it left off
565 if NEEDBITS() returns in the loop. For example, want, need, and keep
566 would all have to actually be part of the saved state in case NEEDBITS()
570 while (want < need) {
572 keep[want++] = BITS(n);
578 As shown above, if the next state is also the next case, then the break
581 A state may also return if there is not enough output space available to
582 complete that state. Those states are copying stored data, writing a
583 literal byte, and copying a matching string.
585 When returning, a "goto inf_leave" is used to update the total counters,
586 update the check value, and determine whether any progress has been made
587 during that inflate() call in order to return the proper return code.
588 Progress is defined as a change in either strm->avail_in or strm->avail_out.
589 When there is a window, goto inf_leave will update the window with the last
590 output written. If a goto inf_leave occurs in the middle of decompression
591 and there is no window currently, goto inf_leave will create one and copy
592 output to the window for the next call of inflate().
594 In this implementation, the flush parameter of inflate() only affects the
595 return code (per zlib.h). inflate() always writes as much as possible to
596 strm->next_out, given the space available and the provided input--the effect
597 documented in zlib.h of Z_SYNC_FLUSH. Furthermore, inflate() always defers
598 the allocation of and copying into a sliding window until necessary, which
599 provides the effect documented in zlib.h for Z_FINISH when the entire input
600 stream available. So the only thing the flush parameter actually does is:
601 when flush is set to Z_FINISH, inflate() cannot return Z_OK. Instead it
602 will return Z_BUF_ERROR if it has not reached the end of the stream.
605 int ZEXPORT
inflate(strm
, flush
)
609 struct inflate_state FAR
*state
;
610 z_const
unsigned char FAR
*next
; /* next input */
611 unsigned char FAR
*put
; /* next output */
612 unsigned have
, left
; /* available input and output */
613 unsigned long hold
; /* bit buffer */
614 unsigned bits
; /* bits in bit buffer */
615 unsigned in
, out
; /* save starting available input and output */
616 unsigned copy
; /* number of stored or match bytes to copy */
617 unsigned char FAR
*from
; /* where to copy match bytes from */
618 code here
; /* current decoding table entry */
619 code last
; /* parent table entry */
620 unsigned len
; /* length to copy for repeats, bits to drop */
621 int ret
; /* return code */
623 unsigned char hbuf
[4]; /* buffer for gzip header crc calculation */
625 static const unsigned short order
[19] = /* permutation of code lengths */
626 {16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15};
628 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
|| strm
->next_out
== Z_NULL
||
629 (strm
->next_in
== Z_NULL
&& strm
->avail_in
!= 0))
630 return Z_STREAM_ERROR
;
632 state
= (struct inflate_state FAR
*)strm
->state
;
633 if (state
->mode
== TYPE
) state
->mode
= TYPEDO
; /* skip check */
639 switch (state
->mode
) {
641 if (state
->wrap
== 0) {
642 state
->mode
= TYPEDO
;
647 if ((state
->wrap
& 2) && hold
== 0x8b1f) { /* gzip header */
648 state
->check
= crc32(0L, Z_NULL
, 0);
649 CRC2(state
->check
, hold
);
654 state
->flags
= 0; /* expect zlib header */
655 if (state
->head
!= Z_NULL
)
656 state
->head
->done
= -1;
657 if (!(state
->wrap
& 1) || /* check if zlib header allowed */
661 ((BITS(8) << 8) + (hold
>> 8)) % 31) {
662 strm
->msg
= (char *)"incorrect header check";
666 if (BITS(4) != Z_DEFLATED
) {
667 strm
->msg
= (char *)"unknown compression method";
673 if (state
->wbits
== 0)
675 else if (len
> state
->wbits
) {
676 strm
->msg
= (char *)"invalid window size";
680 state
->dmax
= 1U << len
;
681 Tracev((stderr
, "inflate: zlib header ok\n"));
682 strm
->adler
= state
->check
= adler32(0L, Z_NULL
, 0);
683 state
->mode
= hold
& 0x200 ? DICTID
: TYPE
;
689 state
->flags
= (int)(hold
);
690 if ((state
->flags
& 0xff) != Z_DEFLATED
) {
691 strm
->msg
= (char *)"unknown compression method";
695 if (state
->flags
& 0xe000) {
696 strm
->msg
= (char *)"unknown header flags set";
700 if (state
->head
!= Z_NULL
)
701 state
->head
->text
= (int)((hold
>> 8) & 1);
702 if (state
->flags
& 0x0200) CRC2(state
->check
, hold
);
707 if (state
->head
!= Z_NULL
)
708 state
->head
->time
= hold
;
709 if (state
->flags
& 0x0200) CRC4(state
->check
, hold
);
714 if (state
->head
!= Z_NULL
) {
715 state
->head
->xflags
= (int)(hold
& 0xff);
716 state
->head
->os
= (int)(hold
>> 8);
718 if (state
->flags
& 0x0200) CRC2(state
->check
, hold
);
722 if (state
->flags
& 0x0400) {
724 state
->length
= (unsigned)(hold
);
725 if (state
->head
!= Z_NULL
)
726 state
->head
->extra_len
= (unsigned)hold
;
727 if (state
->flags
& 0x0200) CRC2(state
->check
, hold
);
730 else if (state
->head
!= Z_NULL
)
731 state
->head
->extra
= Z_NULL
;
734 if (state
->flags
& 0x0400) {
735 copy
= state
->length
;
736 if (copy
> have
) copy
= have
;
738 if (state
->head
!= Z_NULL
&&
739 state
->head
->extra
!= Z_NULL
) {
740 len
= state
->head
->extra_len
- state
->length
;
741 zmemcpy(state
->head
->extra
+ len
, next
,
742 len
+ copy
> state
->head
->extra_max
?
743 state
->head
->extra_max
- len
: copy
);
745 if (state
->flags
& 0x0200)
746 state
->check
= crc32(state
->check
, next
, copy
);
749 state
->length
-= copy
;
751 if (state
->length
) goto inf_leave
;
756 if (state
->flags
& 0x0800) {
757 if (have
== 0) goto inf_leave
;
760 len
= (unsigned)(next
[copy
++]);
761 if (state
->head
!= Z_NULL
&&
762 state
->head
->name
!= Z_NULL
&&
763 state
->length
< state
->head
->name_max
)
764 state
->head
->name
[state
->length
++] = len
;
765 } while (len
&& copy
< have
);
766 if (state
->flags
& 0x0200)
767 state
->check
= crc32(state
->check
, next
, copy
);
770 if (len
) goto inf_leave
;
772 else if (state
->head
!= Z_NULL
)
773 state
->head
->name
= Z_NULL
;
775 state
->mode
= COMMENT
;
777 if (state
->flags
& 0x1000) {
778 if (have
== 0) goto inf_leave
;
781 len
= (unsigned)(next
[copy
++]);
782 if (state
->head
!= Z_NULL
&&
783 state
->head
->comment
!= Z_NULL
&&
784 state
->length
< state
->head
->comm_max
)
785 state
->head
->comment
[state
->length
++] = len
;
786 } while (len
&& copy
< have
);
787 if (state
->flags
& 0x0200)
788 state
->check
= crc32(state
->check
, next
, copy
);
791 if (len
) goto inf_leave
;
793 else if (state
->head
!= Z_NULL
)
794 state
->head
->comment
= Z_NULL
;
797 if (state
->flags
& 0x0200) {
799 if (hold
!= (state
->check
& 0xffff)) {
800 strm
->msg
= (char *)"header crc mismatch";
806 if (state
->head
!= Z_NULL
) {
807 state
->head
->hcrc
= (int)((state
->flags
>> 9) & 1);
808 state
->head
->done
= 1;
810 strm
->adler
= state
->check
= crc32(0L, Z_NULL
, 0);
816 strm
->adler
= state
->check
= ZSWAP32(hold
);
820 if (state
->havedict
== 0) {
824 strm
->adler
= state
->check
= adler32(0L, Z_NULL
, 0);
827 if (flush
== Z_BLOCK
|| flush
== Z_TREES
) goto inf_leave
;
835 state
->last
= BITS(1);
838 case 0: /* stored block */
839 Tracev((stderr
, "inflate: stored block%s\n",
840 state
->last
? " (last)" : ""));
841 state
->mode
= STORED
;
843 case 1: /* fixed block */
845 Tracev((stderr
, "inflate: fixed codes block%s\n",
846 state
->last
? " (last)" : ""));
847 state
->mode
= LEN_
; /* decode codes */
848 if (flush
== Z_TREES
) {
853 case 2: /* dynamic block */
854 Tracev((stderr
, "inflate: dynamic codes block%s\n",
855 state
->last
? " (last)" : ""));
859 strm
->msg
= (char *)"invalid block type";
865 BYTEBITS(); /* go to byte boundary */
867 if ((hold
& 0xffff) != ((hold
>> 16) ^ 0xffff)) {
868 strm
->msg
= (char *)"invalid stored block lengths";
872 state
->length
= (unsigned)hold
& 0xffff;
873 Tracev((stderr
, "inflate: stored length %u\n",
877 if (flush
== Z_TREES
) goto inf_leave
;
881 copy
= state
->length
;
883 if (copy
> have
) copy
= have
;
884 if (copy
> left
) copy
= left
;
885 if (copy
== 0) goto inf_leave
;
886 zmemcpy(put
, next
, copy
);
891 state
->length
-= copy
;
894 Tracev((stderr
, "inflate: stored end\n"));
899 state
->nlen
= BITS(5) + 257;
901 state
->ndist
= BITS(5) + 1;
903 state
->ncode
= BITS(4) + 4;
905 #ifndef PKZIP_BUG_WORKAROUND
906 if (state
->nlen
> 286 || state
->ndist
> 30) {
907 strm
->msg
= (char *)"too many length or distance symbols";
912 Tracev((stderr
, "inflate: table sizes ok\n"));
914 state
->mode
= LENLENS
;
916 while (state
->have
< state
->ncode
) {
918 state
->lens
[order
[state
->have
++]] = (unsigned short)BITS(3);
921 while (state
->have
< 19)
922 state
->lens
[order
[state
->have
++]] = 0;
923 state
->next
= state
->codes
;
924 state
->lencode
= (const code FAR
*)(state
->next
);
926 ret
= inflate_table(CODES
, state
->lens
, 19, &(state
->next
),
927 &(state
->lenbits
), state
->work
);
929 strm
->msg
= (char *)"invalid code lengths set";
933 Tracev((stderr
, "inflate: code lengths ok\n"));
935 state
->mode
= CODELENS
;
937 while (state
->have
< state
->nlen
+ state
->ndist
) {
939 here
= state
->lencode
[BITS(state
->lenbits
)];
940 if ((unsigned)(here
.bits
) <= bits
) break;
945 state
->lens
[state
->have
++] = here
.val
;
948 if (here
.val
== 16) {
949 NEEDBITS(here
.bits
+ 2);
951 if (state
->have
== 0) {
952 strm
->msg
= (char *)"invalid bit length repeat";
956 len
= state
->lens
[state
->have
- 1];
960 else if (here
.val
== 17) {
961 NEEDBITS(here
.bits
+ 3);
968 NEEDBITS(here
.bits
+ 7);
974 if (state
->have
+ copy
> state
->nlen
+ state
->ndist
) {
975 strm
->msg
= (char *)"invalid bit length repeat";
980 state
->lens
[state
->have
++] = (unsigned short)len
;
984 /* handle error breaks in while */
985 if (state
->mode
== BAD
) break;
987 /* check for end-of-block code (better have one) */
988 if (state
->lens
[256] == 0) {
989 strm
->msg
= (char *)"invalid code -- missing end-of-block";
994 /* build code tables -- note: do not change the lenbits or distbits
995 values here (9 and 6) without reading the comments in inftrees.h
996 concerning the ENOUGH constants, which depend on those values */
997 state
->next
= state
->codes
;
998 state
->lencode
= (const code FAR
*)(state
->next
);
1000 ret
= inflate_table(LENS
, state
->lens
, state
->nlen
, &(state
->next
),
1001 &(state
->lenbits
), state
->work
);
1003 strm
->msg
= (char *)"invalid literal/lengths set";
1007 state
->distcode
= (const code FAR
*)(state
->next
);
1008 state
->distbits
= 6;
1009 ret
= inflate_table(DISTS
, state
->lens
+ state
->nlen
, state
->ndist
,
1010 &(state
->next
), &(state
->distbits
), state
->work
);
1012 strm
->msg
= (char *)"invalid distances set";
1016 Tracev((stderr
, "inflate: codes ok\n"));
1018 if (flush
== Z_TREES
) goto inf_leave
;
1022 if (have
>= 6 && left
>= 258) {
1024 inflate_fast(strm
, out
);
1026 if (state
->mode
== TYPE
)
1032 here
= state
->lencode
[BITS(state
->lenbits
)];
1033 if ((unsigned)(here
.bits
) <= bits
) break;
1036 if (here
.op
&& (here
.op
& 0xf0) == 0) {
1039 here
= state
->lencode
[last
.val
+
1040 (BITS(last
.bits
+ last
.op
) >> last
.bits
)];
1041 if ((unsigned)(last
.bits
+ here
.bits
) <= bits
) break;
1044 DROPBITS(last
.bits
);
1045 state
->back
+= last
.bits
;
1047 DROPBITS(here
.bits
);
1048 state
->back
+= here
.bits
;
1049 state
->length
= (unsigned)here
.val
;
1050 if ((int)(here
.op
) == 0) {
1051 Tracevv((stderr
, here
.val
>= 0x20 && here
.val
< 0x7f ?
1052 "inflate: literal '%c'\n" :
1053 "inflate: literal 0x%02x\n", here
.val
));
1058 Tracevv((stderr
, "inflate: end of block\n"));
1064 strm
->msg
= (char *)"invalid literal/length code";
1068 state
->extra
= (unsigned)(here
.op
) & 15;
1069 state
->mode
= LENEXT
;
1072 NEEDBITS(state
->extra
);
1073 state
->length
+= BITS(state
->extra
);
1074 DROPBITS(state
->extra
);
1075 state
->back
+= state
->extra
;
1077 Tracevv((stderr
, "inflate: length %u\n", state
->length
));
1078 state
->was
= state
->length
;
1082 here
= state
->distcode
[BITS(state
->distbits
)];
1083 if ((unsigned)(here
.bits
) <= bits
) break;
1086 if ((here
.op
& 0xf0) == 0) {
1089 here
= state
->distcode
[last
.val
+
1090 (BITS(last
.bits
+ last
.op
) >> last
.bits
)];
1091 if ((unsigned)(last
.bits
+ here
.bits
) <= bits
) break;
1094 DROPBITS(last
.bits
);
1095 state
->back
+= last
.bits
;
1097 DROPBITS(here
.bits
);
1098 state
->back
+= here
.bits
;
1100 strm
->msg
= (char *)"invalid distance code";
1104 state
->offset
= (unsigned)here
.val
;
1105 state
->extra
= (unsigned)(here
.op
) & 15;
1106 state
->mode
= DISTEXT
;
1109 NEEDBITS(state
->extra
);
1110 state
->offset
+= BITS(state
->extra
);
1111 DROPBITS(state
->extra
);
1112 state
->back
+= state
->extra
;
1114 #ifdef INFLATE_STRICT
1115 if (state
->offset
> state
->dmax
) {
1116 strm
->msg
= (char *)"invalid distance too far back";
1121 Tracevv((stderr
, "inflate: distance %u\n", state
->offset
));
1122 state
->mode
= MATCH
;
1124 if (left
== 0) goto inf_leave
;
1126 if (state
->offset
> copy
) { /* copy from window */
1127 copy
= state
->offset
- copy
;
1128 if (copy
> state
->whave
) {
1130 strm
->msg
= (char *)"invalid distance too far back";
1134 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1135 Trace((stderr
, "inflate.c too far\n"));
1136 copy
-= state
->whave
;
1137 if (copy
> state
->length
) copy
= state
->length
;
1138 if (copy
> left
) copy
= left
;
1140 state
->length
-= copy
;
1144 if (state
->length
== 0) state
->mode
= LEN
;
1148 if (copy
> state
->wnext
) {
1149 copy
-= state
->wnext
;
1150 from
= state
->window
+ (state
->wsize
- copy
);
1153 from
= state
->window
+ (state
->wnext
- copy
);
1154 if (copy
> state
->length
) copy
= state
->length
;
1156 else { /* copy from output */
1157 from
= put
- state
->offset
;
1158 copy
= state
->length
;
1160 if (copy
> left
) copy
= left
;
1162 state
->length
-= copy
;
1166 if (state
->length
== 0) state
->mode
= LEN
;
1169 if (left
== 0) goto inf_leave
;
1170 *put
++ = (unsigned char)(state
->length
);
1178 strm
->total_out
+= out
;
1179 state
->total
+= out
;
1181 strm
->adler
= state
->check
=
1182 UPDATE(state
->check
, put
- out
, out
);
1186 state
->flags
? hold
:
1188 ZSWAP32(hold
)) != state
->check
) {
1189 strm
->msg
= (char *)"incorrect data check";
1194 Tracev((stderr
, "inflate: check matches trailer\n"));
1197 state
->mode
= LENGTH
;
1199 if (state
->wrap
&& state
->flags
) {
1201 if (hold
!= (state
->total
& 0xffffffffUL
)) {
1202 strm
->msg
= (char *)"incorrect length check";
1207 Tracev((stderr
, "inflate: length matches trailer\n"));
1221 return Z_STREAM_ERROR
;
1225 Return from inflate(), updating the total counts and the check value.
1226 If there was no progress during the inflate() call, return a buffer
1227 error. Call updatewindow() to create and/or update the window state.
1228 Note: a memory error from inflate() is non-recoverable.
1232 if (state
->wsize
|| (out
!= strm
->avail_out
&& state
->mode
< BAD
&&
1233 (state
->mode
< CHECK
|| flush
!= Z_FINISH
)))
1234 if (updatewindow(strm
, strm
->next_out
, out
- strm
->avail_out
)) {
1238 in
-= strm
->avail_in
;
1239 out
-= strm
->avail_out
;
1240 strm
->total_in
+= in
;
1241 strm
->total_out
+= out
;
1242 state
->total
+= out
;
1243 if (state
->wrap
&& out
)
1244 strm
->adler
= state
->check
=
1245 UPDATE(state
->check
, strm
->next_out
- out
, out
);
1246 strm
->data_type
= state
->bits
+ (state
->last
? 64 : 0) +
1247 (state
->mode
== TYPE
? 128 : 0) +
1248 (state
->mode
== LEN_
|| state
->mode
== COPY_
? 256 : 0);
1249 if (((in
== 0 && out
== 0) || flush
== Z_FINISH
) && ret
== Z_OK
)
1254 int ZEXPORT
inflateEnd(strm
)
1257 struct inflate_state FAR
*state
;
1258 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
|| strm
->zfree
== (free_func
)0)
1259 return Z_STREAM_ERROR
;
1260 state
= (struct inflate_state FAR
*)strm
->state
;
1261 if (state
->window
!= Z_NULL
) ZFREE(strm
, state
->window
);
1262 ZFREE(strm
, strm
->state
);
1263 strm
->state
= Z_NULL
;
1264 Tracev((stderr
, "inflate: end\n"));
1268 int ZEXPORT
inflateGetDictionary(strm
, dictionary
, dictLength
)
1273 struct inflate_state FAR
*state
;
1276 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
1277 state
= (struct inflate_state FAR
*)strm
->state
;
1279 /* copy dictionary */
1280 if (state
->whave
&& dictionary
!= Z_NULL
) {
1281 zmemcpy(dictionary
, state
->window
+ state
->wnext
,
1282 state
->whave
- state
->wnext
);
1283 zmemcpy(dictionary
+ state
->whave
- state
->wnext
,
1284 state
->window
, state
->wnext
);
1286 if (dictLength
!= Z_NULL
)
1287 *dictLength
= state
->whave
;
1291 int ZEXPORT
inflateSetDictionary(strm
, dictionary
, dictLength
)
1293 const Bytef
*dictionary
;
1296 struct inflate_state FAR
*state
;
1297 unsigned long dictid
;
1301 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
1302 state
= (struct inflate_state FAR
*)strm
->state
;
1303 if (state
->wrap
!= 0 && state
->mode
!= DICT
)
1304 return Z_STREAM_ERROR
;
1306 /* check for correct dictionary identifier */
1307 if (state
->mode
== DICT
) {
1308 dictid
= adler32(0L, Z_NULL
, 0);
1309 dictid
= adler32(dictid
, dictionary
, dictLength
);
1310 if (dictid
!= state
->check
)
1311 return Z_DATA_ERROR
;
1314 /* copy dictionary to window using updatewindow(), which will amend the
1315 existing dictionary if appropriate */
1316 ret
= updatewindow(strm
, dictionary
+ dictLength
, dictLength
);
1321 state
->havedict
= 1;
1322 Tracev((stderr
, "inflate: dictionary set\n"));
1326 int ZEXPORT
inflateGetHeader(strm
, head
)
1330 struct inflate_state FAR
*state
;
1333 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
1334 state
= (struct inflate_state FAR
*)strm
->state
;
1335 if ((state
->wrap
& 2) == 0) return Z_STREAM_ERROR
;
1337 /* save header structure */
1344 Search buf[0..len-1] for the pattern: 0, 0, 0xff, 0xff. Return when found
1345 or when out of input. When called, *have is the number of pattern bytes
1346 found in order so far, in 0..3. On return *have is updated to the new
1347 state. If on return *have equals four, then the pattern was found and the
1348 return value is how many bytes were read including the last byte of the
1349 pattern. If *have is less than four, then the pattern has not been found
1350 yet and the return value is len. In the latter case, syncsearch() can be
1351 called again with more data and the *have state. *have is initialized to
1352 zero for the first call.
1354 local
unsigned syncsearch(have
, buf
, len
)
1356 const unsigned char FAR
*buf
;
1364 while (next
< len
&& got
< 4) {
1365 if ((int)(buf
[next
]) == (got
< 2 ? 0 : 0xff))
1377 int ZEXPORT
inflateSync(strm
)
1380 unsigned len
; /* number of bytes to look at or looked at */
1381 unsigned long in
, out
; /* temporary to save total_in and total_out */
1382 unsigned char buf
[4]; /* to restore bit buffer to byte string */
1383 struct inflate_state FAR
*state
;
1385 /* check parameters */
1386 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
1387 state
= (struct inflate_state FAR
*)strm
->state
;
1388 if (strm
->avail_in
== 0 && state
->bits
< 8) return Z_BUF_ERROR
;
1390 /* if first time, start search in bit buffer */
1391 if (state
->mode
!= SYNC
) {
1393 state
->hold
<<= state
->bits
& 7;
1394 state
->bits
-= state
->bits
& 7;
1396 while (state
->bits
>= 8) {
1397 buf
[len
++] = (unsigned char)(state
->hold
);
1402 syncsearch(&(state
->have
), buf
, len
);
1405 /* search available input */
1406 len
= syncsearch(&(state
->have
), strm
->next_in
, strm
->avail_in
);
1407 strm
->avail_in
-= len
;
1408 strm
->next_in
+= len
;
1409 strm
->total_in
+= len
;
1411 /* return no joy or set up to restart inflate() on a new block */
1412 if (state
->have
!= 4) return Z_DATA_ERROR
;
1413 in
= strm
->total_in
; out
= strm
->total_out
;
1415 strm
->total_in
= in
; strm
->total_out
= out
;
1421 Returns true if inflate is currently at the end of a block generated by
1422 Z_SYNC_FLUSH or Z_FULL_FLUSH. This function is used by one PPP
1423 implementation to provide an additional safety check. PPP uses
1424 Z_SYNC_FLUSH but removes the length bytes of the resulting empty stored
1425 block. When decompressing, PPP checks that at the end of input packet,
1426 inflate is waiting for these length bytes.
1428 int ZEXPORT
inflateSyncPoint(strm
)
1431 struct inflate_state FAR
*state
;
1433 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
1434 state
= (struct inflate_state FAR
*)strm
->state
;
1435 return state
->mode
== STORED
&& state
->bits
== 0;
1438 int ZEXPORT
inflateCopy(dest
, source
)
1442 struct inflate_state FAR
*state
;
1443 struct inflate_state FAR
*copy
;
1444 unsigned char FAR
*window
;
1448 if (dest
== Z_NULL
|| source
== Z_NULL
|| source
->state
== Z_NULL
||
1449 source
->zalloc
== (alloc_func
)0 || source
->zfree
== (free_func
)0)
1450 return Z_STREAM_ERROR
;
1451 state
= (struct inflate_state FAR
*)source
->state
;
1453 /* allocate space */
1454 copy
= (struct inflate_state FAR
*)
1455 ZALLOC(source
, 1, sizeof(struct inflate_state
));
1456 if (copy
== Z_NULL
) return Z_MEM_ERROR
;
1458 if (state
->window
!= Z_NULL
) {
1459 window
= (unsigned char FAR
*)
1460 ZALLOC(source
, 1U << state
->wbits
, sizeof(unsigned char));
1461 if (window
== Z_NULL
) {
1462 ZFREE(source
, copy
);
1468 zmemcpy((voidpf
)dest
, (voidpf
)source
, sizeof(z_stream
));
1469 zmemcpy((voidpf
)copy
, (voidpf
)state
, sizeof(struct inflate_state
));
1470 if (state
->lencode
>= state
->codes
&&
1471 state
->lencode
<= state
->codes
+ ENOUGH
- 1) {
1472 copy
->lencode
= copy
->codes
+ (state
->lencode
- state
->codes
);
1473 copy
->distcode
= copy
->codes
+ (state
->distcode
- state
->codes
);
1475 copy
->next
= copy
->codes
+ (state
->next
- state
->codes
);
1476 if (window
!= Z_NULL
) {
1477 wsize
= 1U << state
->wbits
;
1478 zmemcpy(window
, state
->window
, wsize
);
1480 copy
->window
= window
;
1481 dest
->state
= (struct internal_state FAR
*)copy
;
1485 int ZEXPORT
inflateUndermine(strm
, subvert
)
1489 struct inflate_state FAR
*state
;
1491 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return Z_STREAM_ERROR
;
1492 state
= (struct inflate_state FAR
*)strm
->state
;
1493 state
->sane
= !subvert
;
1494 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1498 return Z_DATA_ERROR
;
1502 long ZEXPORT
inflateMark(strm
)
1505 struct inflate_state FAR
*state
;
1507 if (strm
== Z_NULL
|| strm
->state
== Z_NULL
) return (long)(((unsigned long)-1L) << 16);
1508 state
= (struct inflate_state FAR
*)strm
->state
;
1509 return ((long)(state
->back
) << 16) +
1510 (state
->mode
== COPY
? state
->length
:
1511 (state
->mode
== MATCH
? state
->was
- state
->length
: 0));