xref: /openbsd-src/gnu/usr.bin/perl/cpan/Compress-Raw-Zlib/zlib-src/inflate.c (revision 8550894424f8a4aa4aafb6cd57229dd6ed7cd9dd)
1 /* inflate.c -- zlib decompression
2  * Copyright (C) 1995-2016 Mark Adler
3  * 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
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
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 */
95 local int inflateStateCheck OF((z_streamp strm));
96 local void fixedtables OF((struct inflate_state FAR *state));
97 local int updatewindow OF((z_streamp strm, const unsigned char FAR *end,
98                            unsigned copy));
99 #ifdef BUILDFIXED
100    void makefixed OF((void));
101 #endif
102 local unsigned syncsearch OF((unsigned FAR *have, const unsigned char FAR *buf,
103                               unsigned len));
104 
105 local int inflateStateCheck(
106     z_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 
119 int ZEXPORT inflateResetKeep(
120     z_streamp strm)
121 {
122     struct inflate_state FAR *state;
123 
124     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
125     state = (struct inflate_state FAR *)strm->state;
126     strm->total_in = strm->total_out = state->total = 0;
127     strm->msg = Z_NULL;
128     if (state->wrap)        /* to support ill-conceived Java test suite */
129         strm->adler = state->wrap & 1;
130     state->mode = HEAD;
131     state->last = 0;
132     state->havedict = 0;
133     state->dmax = 32768U;
134     state->head = Z_NULL;
135     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;
142 }
143 
144 int ZEXPORT inflateReset(
145     z_streamp strm)
146 {
147     struct inflate_state FAR *state;
148 
149     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
150     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 
157 int ZEXPORT inflateReset2(
158     z_streamp strm,
159     int windowBits)
160 {
161     int wrap;
162     struct inflate_state FAR *state;
163 
164     /* get the state */
165     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
166     state = (struct inflate_state FAR *)strm->state;
167 
168     /* extract wrap request from windowBits parameter */
169     if (windowBits < 0) {
170         wrap = 0;
171         windowBits = -windowBits;
172     }
173     else {
174         wrap = (windowBits >> 4) + 5;
175 #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);
193 }
194 
195 int ZEXPORT inflateInit2_(
196     z_streamp strm,
197     int windowBits,
198     const char *version,
199     int stream_size)
200 {
201     int ret;
202     struct inflate_state FAR *state;
203 
204     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) {
210 #ifdef Z_SOLO
211         return Z_STREAM_ERROR;
212 #else
213         strm->zalloc = zcalloc;
214         strm->opaque = (voidpf)0;
215 #endif
216     }
217     if (strm->zfree == (free_func)0)
218 #ifdef Z_SOLO
219         return Z_STREAM_ERROR;
220 #else
221         strm->zfree = zcfree;
222 #endif
223     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;
228     state->strm = strm;
229     state->window = Z_NULL;
230     state->mode = HEAD;     /* to pass state test in inflateReset2() */
231     ret = inflateReset2(strm, windowBits);
232     if (ret != Z_OK) {
233         ZFREE(strm, state);
234         strm->state = Z_NULL;
235     }
236     return ret;
237 }
238 
239 int ZEXPORT inflateInit_(
240     z_streamp strm,
241     const char *version,
242     int stream_size)
243 {
244     return inflateInit2_(strm, DEF_WBITS, version, stream_size);
245 }
246 
247 int ZEXPORT inflatePrime(
248     z_streamp strm,
249     int bits,
250     int value)
251 {
252     struct inflate_state FAR *state;
253 
254     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
255     state = (struct inflate_state FAR *)strm->state;
256     if (bits < 0) {
257         state->hold = 0;
258         state->bits = 0;
259         return Z_OK;
260     }
261     if (bits > 16 || state->bits + (uInt)bits > 32) return Z_STREAM_ERROR;
262     value &= (1L << bits) - 1;
263     state->hold += (unsigned)value << state->bits;
264     state->bits += (uInt)bits;
265     return Z_OK;
266 }
267 
268 /*
269    Return state with length and distance decoding tables and index sizes set to
270    fixed code decoding.  Normally this returns fixed tables from inffixed.h.
271    If BUILDFIXED is defined, then instead this routine builds the tables the
272    first time it's called, and returns those tables the first time and
273    thereafter.  This reduces the size of the code by about 2K bytes, in
274    exchange for a little execution time.  However, BUILDFIXED should not be
275    used for threaded applications, since the rewriting of the tables and virgin
276    may not be thread-safe.
277  */
278 local void fixedtables(
279     struct inflate_state FAR *state)
280 {
281 #ifdef BUILDFIXED
282     static int virgin = 1;
283     static code *lenfix, *distfix;
284     static code fixed[544];
285 
286     /* build fixed huffman tables if first call (may not be thread safe) */
287     if (virgin) {
288         unsigned sym, bits;
289         static code *next;
290 
291         /* literal/length table */
292         sym = 0;
293         while (sym < 144) state->lens[sym++] = 8;
294         while (sym < 256) state->lens[sym++] = 9;
295         while (sym < 280) state->lens[sym++] = 7;
296         while (sym < 288) state->lens[sym++] = 8;
297         next = fixed;
298         lenfix = next;
299         bits = 9;
300         inflate_table(LENS, state->lens, 288, &(next), &(bits), state->work);
301 
302         /* distance table */
303         sym = 0;
304         while (sym < 32) state->lens[sym++] = 5;
305         distfix = next;
306         bits = 5;
307         inflate_table(DISTS, state->lens, 32, &(next), &(bits), state->work);
308 
309         /* do this just once */
310         virgin = 0;
311     }
312 #else /* !BUILDFIXED */
313 #   include "inffixed.h"
314 #endif /* BUILDFIXED */
315     state->lencode = lenfix;
316     state->lenbits = 9;
317     state->distcode = distfix;
318     state->distbits = 5;
319 }
320 
321 #ifdef MAKEFIXED
322 #include <stdio.h>
323 
324 /*
325    Write out the inffixed.h that is #include'd above.  Defining MAKEFIXED also
326    defines BUILDFIXED, so the tables are built on the fly.  makefixed() writes
327    those tables to stdout, which would be piped to inffixed.h.  A small program
328    can simply call makefixed to do this:
329 
330     void makefixed(void);
331 
332     int main(void)
333     {
334         makefixed();
335         return 0;
336     }
337 
338    Then that can be linked with zlib built with MAKEFIXED defined and run:
339 
340     a.out > inffixed.h
341  */
342 void makefixed()
343 {
344     unsigned low, size;
345     struct inflate_state state;
346 
347     fixedtables(&state);
348     puts("    /* inffixed.h -- table for decoding fixed codes");
349     puts("     * Generated automatically by makefixed().");
350     puts("     */");
351     puts("");
352     puts("    /* WARNING: this file should *not* be used by applications.");
353     puts("       It is part of the implementation of this library and is");
354     puts("       subject to change. Applications should only use zlib.h.");
355     puts("     */");
356     puts("");
357     size = 1U << 9;
358     printf("    static const code lenfix[%u] = {", size);
359     low = 0;
360     for (;;) {
361         if ((low % 7) == 0) printf("\n        ");
362         printf("{%u,%u,%d}", (low & 127) == 99 ? 64 : state.lencode[low].op,
363                state.lencode[low].bits, state.lencode[low].val);
364         if (++low == size) break;
365         putchar(',');
366     }
367     puts("\n    };");
368     size = 1U << 5;
369     printf("\n    static const code distfix[%u] = {", size);
370     low = 0;
371     for (;;) {
372         if ((low % 6) == 0) printf("\n        ");
373         printf("{%u,%u,%d}", state.distcode[low].op, state.distcode[low].bits,
374                state.distcode[low].val);
375         if (++low == size) break;
376         putchar(',');
377     }
378     puts("\n    };");
379 }
380 #endif /* MAKEFIXED */
381 
382 /*
383    Update the window with the last wsize (normally 32K) bytes written before
384    returning.  If window does not exist yet, create it.  This is only called
385    when a window is already in use, or when output has been written during this
386    inflate call, but the end of the deflate stream has not been reached yet.
387    It is also called to create a window for dictionary data when a dictionary
388    is loaded.
389 
390    Providing output buffers larger than 32K to inflate() should provide a speed
391    advantage, since only the last 32K of output is copied to the sliding window
392    upon return from inflate(), and since all distances after the first 32K of
393    output will fall in the output data, making match copies simpler and faster.
394    The advantage may be dependent on the size of the processor's data caches.
395  */
396 local int updatewindow(
397     z_streamp strm,
398     const Bytef *end,
399     unsigned copy)
400 {
401     struct inflate_state FAR *state;
402     unsigned dist;
403 
404     state = (struct inflate_state FAR *)strm->state;
405 
406     /* if it hasn't been done already, allocate space for the window */
407     if (state->window == Z_NULL) {
408         state->window = (unsigned char FAR *)
409                         ZALLOC(strm, 1U << state->wbits,
410                                sizeof(unsigned char));
411         if (state->window == Z_NULL) return 1;
412     }
413 
414     /* if window not in use yet, initialize */
415     if (state->wsize == 0) {
416         state->wsize = 1U << state->wbits;
417         state->wnext = 0;
418         state->whave = 0;
419     }
420 
421     /* copy state->wsize or less output bytes into the circular window */
422     if (copy >= state->wsize) {
423         zmemcpy(state->window, end - state->wsize, state->wsize);
424         state->wnext = 0;
425         state->whave = state->wsize;
426     }
427     else {
428         dist = state->wsize - state->wnext;
429         if (dist > copy) dist = copy;
430         zmemcpy(state->window + state->wnext, end - copy, dist);
431         copy -= dist;
432         if (copy) {
433             zmemcpy(state->window, end - copy, copy);
434             state->wnext = copy;
435             state->whave = state->wsize;
436         }
437         else {
438             state->wnext += dist;
439             if (state->wnext == state->wsize) state->wnext = 0;
440             if (state->whave < state->wsize) state->whave += dist;
441         }
442     }
443     return 0;
444 }
445 
446 /* Macros for inflate(): */
447 
448 /* check function to use adler32() for zlib or crc32() for gzip */
449 #ifdef GUNZIP
450 #  define UPDATE(check, buf, len) \
451     (state->flags ? crc32(check, buf, len) : adler32(check, buf, len))
452 #else
453 #  define UPDATE(check, buf, len) adler32(check, buf, len)
454 #endif
455 
456 /* check macros for header crc */
457 #ifdef GUNZIP
458 #  define CRC2(check, word) \
459     do { \
460         hbuf[0] = (unsigned char)(word); \
461         hbuf[1] = (unsigned char)((word) >> 8); \
462         check = crc32(check, hbuf, 2); \
463     } while (0)
464 
465 #  define CRC4(check, word) \
466     do { \
467         hbuf[0] = (unsigned char)(word); \
468         hbuf[1] = (unsigned char)((word) >> 8); \
469         hbuf[2] = (unsigned char)((word) >> 16); \
470         hbuf[3] = (unsigned char)((word) >> 24); \
471         check = crc32(check, hbuf, 4); \
472     } while (0)
473 #endif
474 
475 /* Load registers with state in inflate() for speed */
476 #define LOAD() \
477     do { \
478         put = strm->next_out; \
479         left = strm->avail_out; \
480         next = strm->next_in; \
481         have = strm->avail_in; \
482         hold = state->hold; \
483         bits = state->bits; \
484     } while (0)
485 
486 /* Restore state from registers in inflate() */
487 #define RESTORE() \
488     do { \
489         strm->next_out = put; \
490         strm->avail_out = left; \
491         strm->next_in = next; \
492         strm->avail_in = have; \
493         state->hold = hold; \
494         state->bits = bits; \
495     } while (0)
496 
497 /* Clear the input bit accumulator */
498 #define INITBITS() \
499     do { \
500         hold = 0; \
501         bits = 0; \
502     } while (0)
503 
504 /* Get a byte of input into the bit accumulator, or return from inflate()
505    if there is no input available. */
506 #define PULLBYTE() \
507     do { \
508         if (have == 0) goto inf_leave; \
509         have--; \
510         hold += (unsigned long)(*next++) << bits; \
511         bits += 8; \
512     } while (0)
513 
514 /* Assure that there are at least n bits in the bit accumulator.  If there is
515    not enough available input to do that, then return from inflate(). */
516 #define NEEDBITS(n) \
517     do { \
518         while (bits < (unsigned)(n)) \
519             PULLBYTE(); \
520     } while (0)
521 
522 /* Return the low n bits of the bit accumulator (n < 16) */
523 #define BITS(n) \
524     ((unsigned)hold & ((1U << (n)) - 1))
525 
526 /* Remove n bits from the bit accumulator */
527 #define DROPBITS(n) \
528     do { \
529         hold >>= (n); \
530         bits -= (unsigned)(n); \
531     } while (0)
532 
533 /* Remove zero to seven bits as needed to go to a byte boundary */
534 #define BYTEBITS() \
535     do { \
536         hold >>= bits & 7; \
537         bits -= bits & 7; \
538     } while (0)
539 
540 /*
541    inflate() uses a state machine to process as much input data and generate as
542    much output data as possible before returning.  The state machine is
543    structured roughly as follows:
544 
545     for (;;) switch (state) {
546     ...
547     case STATEn:
548         if (not enough input data or output space to make progress)
549             return;
550         ... make progress ...
551         state = STATEm;
552         break;
553     ...
554     }
555 
556    so when inflate() is called again, the same case is attempted again, and
557    if the appropriate resources are provided, the machine proceeds to the
558    next state.  The NEEDBITS() macro is usually the way the state evaluates
559    whether it can proceed or should return.  NEEDBITS() does the return if
560    the requested bits are not available.  The typical use of the BITS macros
561    is:
562 
563         NEEDBITS(n);
564         ... do something with BITS(n) ...
565         DROPBITS(n);
566 
567    where NEEDBITS(n) either returns from inflate() if there isn't enough
568    input left to load n bits into the accumulator, or it continues.  BITS(n)
569    gives the low n bits in the accumulator.  When done, DROPBITS(n) drops
570    the low n bits off the accumulator.  INITBITS() clears the accumulator
571    and sets the number of available bits to zero.  BYTEBITS() discards just
572    enough bits to put the accumulator on a byte boundary.  After BYTEBITS()
573    and a NEEDBITS(8), then BITS(8) would return the next byte in the stream.
574 
575    NEEDBITS(n) uses PULLBYTE() to get an available byte of input, or to return
576    if there is no input available.  The decoding of variable length codes uses
577    PULLBYTE() directly in order to pull just enough bytes to decode the next
578    code, and no more.
579 
580    Some states loop until they get enough input, making sure that enough
581    state information is maintained to continue the loop where it left off
582    if NEEDBITS() returns in the loop.  For example, want, need, and keep
583    would all have to actually be part of the saved state in case NEEDBITS()
584    returns:
585 
586     case STATEw:
587         while (want < need) {
588             NEEDBITS(n);
589             keep[want++] = BITS(n);
590             DROPBITS(n);
591         }
592         state = STATEx;
593     case STATEx:
594 
595    As shown above, if the next state is also the next case, then the break
596    is omitted.
597 
598    A state may also return if there is not enough output space available to
599    complete that state.  Those states are copying stored data, writing a
600    literal byte, and copying a matching string.
601 
602    When returning, a "goto inf_leave" is used to update the total counters,
603    update the check value, and determine whether any progress has been made
604    during that inflate() call in order to return the proper return code.
605    Progress is defined as a change in either strm->avail_in or strm->avail_out.
606    When there is a window, goto inf_leave will update the window with the last
607    output written.  If a goto inf_leave occurs in the middle of decompression
608    and there is no window currently, goto inf_leave will create one and copy
609    output to the window for the next call of inflate().
610 
611    In this implementation, the flush parameter of inflate() only affects the
612    return code (per zlib.h).  inflate() always writes as much as possible to
613    strm->next_out, given the space available and the provided input--the effect
614    documented in zlib.h of Z_SYNC_FLUSH.  Furthermore, inflate() always defers
615    the allocation of and copying into a sliding window until necessary, which
616    provides the effect documented in zlib.h for Z_FINISH when the entire input
617    stream available.  So the only thing the flush parameter actually does is:
618    when flush is set to Z_FINISH, inflate() cannot return Z_OK.  Instead it
619    will return Z_BUF_ERROR if it has not reached the end of the stream.
620  */
621 
622 int ZEXPORT inflate(
623     z_streamp strm,
624     int flush)
625 {
626     struct inflate_state FAR *state;
627     z_const unsigned char FAR *next;    /* next input */
628     unsigned char FAR *put;     /* next output */
629     unsigned have, left;        /* available input and output */
630     unsigned long hold;         /* bit buffer */
631     unsigned bits;              /* bits in bit buffer */
632     unsigned in, out;           /* save starting available input and output */
633     unsigned copy;              /* number of stored or match bytes to copy */
634     unsigned char FAR *from;    /* where to copy match bytes from */
635     code here;                  /* current decoding table entry */
636     code last;                  /* parent table entry */
637     unsigned len;               /* length to copy for repeats, bits to drop */
638     int ret;                    /* return code */
639 #ifdef GUNZIP
640     unsigned char hbuf[4];      /* buffer for gzip header crc calculation */
641 #endif
642     static const unsigned short order[19] = /* permutation of code lengths */
643         {16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15};
644 
645     if (inflateStateCheck(strm) || strm->next_out == Z_NULL ||
646         (strm->next_in == Z_NULL && strm->avail_in != 0))
647         return Z_STREAM_ERROR;
648 
649     state = (struct inflate_state FAR *)strm->state;
650     if (state->mode == TYPE) state->mode = TYPEDO;      /* skip check */
651     LOAD();
652     in = have;
653     out = left;
654     ret = Z_OK;
655     for (;;)
656         switch (state->mode) {
657         case HEAD:
658             if (state->wrap == 0) {
659                 state->mode = TYPEDO;
660                 break;
661             }
662             NEEDBITS(16);
663 #ifdef GUNZIP
664             if ((state->wrap & 2) && hold == 0x8b1f) {  /* gzip header */
665                 if (state->wbits == 0)
666                     state->wbits = 15;
667                 state->check = crc32(0L, Z_NULL, 0);
668                 CRC2(state->check, hold);
669                 INITBITS();
670                 state->mode = FLAGS;
671                 break;
672             }
673             state->flags = 0;           /* expect zlib header */
674             if (state->head != Z_NULL)
675                 state->head->done = -1;
676             if (!(state->wrap & 1) ||   /* check if zlib header allowed */
677 #else
678             if (
679 #endif
680                 ((BITS(8) << 8) + (hold >> 8)) % 31) {
681                 strm->msg = (char *)"incorrect header check";
682                 state->mode = BAD;
683                 break;
684             }
685             if (BITS(4) != Z_DEFLATED) {
686                 strm->msg = (char *)"unknown compression method";
687                 state->mode = BAD;
688                 break;
689             }
690             DROPBITS(4);
691             len = BITS(4) + 8;
692             if (state->wbits == 0)
693                 state->wbits = len;
694             if (len > 15 || len > state->wbits) {
695                 strm->msg = (char *)"invalid window size";
696                 state->mode = BAD;
697                 break;
698             }
699             state->dmax = 1U << len;
700             Tracev((stderr, "inflate:   zlib header ok\n"));
701             strm->adler = state->check = adler32(0L, Z_NULL, 0);
702             state->mode = hold & 0x200 ? DICTID : TYPE;
703             INITBITS();
704             break;
705 #ifdef GUNZIP
706         case FLAGS:
707             NEEDBITS(16);
708             state->flags = (int)(hold);
709             if ((state->flags & 0xff) != Z_DEFLATED) {
710                 strm->msg = (char *)"unknown compression method";
711                 state->mode = BAD;
712                 break;
713             }
714             if (state->flags & 0xe000) {
715                 strm->msg = (char *)"unknown header flags set";
716                 state->mode = BAD;
717                 break;
718             }
719             if (state->head != Z_NULL)
720                 state->head->text = (int)((hold >> 8) & 1);
721             if ((state->flags & 0x0200) && (state->wrap & 4))
722                 CRC2(state->check, hold);
723             INITBITS();
724             state->mode = TIME;
725         case TIME:
726             NEEDBITS(32);
727             if (state->head != Z_NULL)
728                 state->head->time = hold;
729             if ((state->flags & 0x0200) && (state->wrap & 4))
730                 CRC4(state->check, hold);
731             INITBITS();
732             state->mode = OS;
733         case OS:
734             NEEDBITS(16);
735             if (state->head != Z_NULL) {
736                 state->head->xflags = (int)(hold & 0xff);
737                 state->head->os = (int)(hold >> 8);
738             }
739             if ((state->flags & 0x0200) && (state->wrap & 4))
740                 CRC2(state->check, hold);
741             INITBITS();
742             state->mode = EXLEN;
743             /* FALLTHROUGH */
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;
750                 if ((state->flags & 0x0200) && (state->wrap & 4))
751                     CRC2(state->check, hold);
752                 INITBITS();
753             }
754             else if (state->head != Z_NULL)
755                 state->head->extra = Z_NULL;
756             state->mode = EXTRA;
757             /* FALLTHROUGH */
758         case EXTRA:
759             if (state->flags & 0x0400) {
760                 copy = state->length;
761                 if (copy > have) copy = have;
762                 if (copy) {
763                     if (state->head != Z_NULL &&
764                         state->head->extra != Z_NULL &&
765                         (len = state->head->extra_len - state->length) <
766 			    state->head->extra_max) {
767                         zmemcpy(state->head->extra + len, next,
768                                 len + copy > state->head->extra_max ?
769                                 state->head->extra_max - len : copy);
770                     }
771                     if ((state->flags & 0x0200) && (state->wrap & 4))
772                         state->check = crc32(state->check, next, copy);
773                     have -= copy;
774                     next += copy;
775                     state->length -= copy;
776                 }
777                 if (state->length) goto inf_leave;
778             }
779             state->length = 0;
780             state->mode = NAME;
781             /* FALLTHROUGH */
782         case NAME:
783             if (state->flags & 0x0800) {
784                 if (have == 0) goto inf_leave;
785                 copy = 0;
786                 do {
787                     len = (unsigned)(next[copy++]);
788                     if (state->head != Z_NULL &&
789                             state->head->name != Z_NULL &&
790                             state->length < state->head->name_max)
791                         state->head->name[state->length++] = (Bytef)len;
792                 } while (len && copy < have);
793                 if ((state->flags & 0x0200) && (state->wrap & 4))
794                     state->check = crc32(state->check, next, copy);
795                 have -= copy;
796                 next += copy;
797                 if (len) goto inf_leave;
798             }
799             else if (state->head != Z_NULL)
800                 state->head->name = Z_NULL;
801             state->length = 0;
802             state->mode = COMMENT;
803             /* FALLTHROUGH */
804         case COMMENT:
805             if (state->flags & 0x1000) {
806                 if (have == 0) goto inf_leave;
807                 copy = 0;
808                 do {
809                     len = (unsigned)(next[copy++]);
810                     if (state->head != Z_NULL &&
811                             state->head->comment != Z_NULL &&
812                             state->length < state->head->comm_max)
813                         state->head->comment[state->length++] = (Bytef)len;
814                 } while (len && copy < have);
815                 if ((state->flags & 0x0200) && (state->wrap & 4))
816                     state->check = crc32(state->check, next, copy);
817                 have -= copy;
818                 next += copy;
819                 if (len) goto inf_leave;
820             }
821             else if (state->head != Z_NULL)
822                 state->head->comment = Z_NULL;
823             state->mode = HCRC;
824             /* FALLTHROUGH */
825         case HCRC:
826             if (state->flags & 0x0200) {
827                 NEEDBITS(16);
828                 if ((state->wrap & 4) && hold != (state->check & 0xffff)) {
829                     strm->msg = (char *)"header crc mismatch";
830                     state->mode = BAD;
831                     break;
832                 }
833                 INITBITS();
834             }
835             if (state->head != Z_NULL) {
836                 state->head->hcrc = (int)((state->flags >> 9) & 1);
837                 state->head->done = 1;
838             }
839             strm->adler = state->check = crc32(0L, Z_NULL, 0);
840             state->mode = TYPE;
841             break;
842 #endif
843         case DICTID:
844             NEEDBITS(32);
845             strm->adler = state->check = ZSWAP32(hold);
846             INITBITS();
847             state->mode = DICT;
848             /* FALLTHROUGH */
849         case DICT:
850             if (state->havedict == 0) {
851                 RESTORE();
852                 return Z_NEED_DICT;
853             }
854             strm->adler = state->check = adler32(0L, Z_NULL, 0);
855             state->mode = TYPE;
856             /* FALLTHROUGH */
857         case TYPE:
858             if (flush == Z_BLOCK || flush == Z_TREES) goto inf_leave;
859             /* FALLTHROUGH */
860         case TYPEDO:
861             if (state->last) {
862                 BYTEBITS();
863                 state->mode = CHECK;
864                 break;
865             }
866             NEEDBITS(3);
867             state->last = BITS(1);
868             DROPBITS(1);
869             switch (BITS(2)) {
870             case 0:                             /* stored block */
871                 Tracev((stderr, "inflate:     stored block%s\n",
872                         state->last ? " (last)" : ""));
873                 state->mode = STORED;
874                 break;
875             case 1:                             /* fixed block */
876                 fixedtables(state);
877                 Tracev((stderr, "inflate:     fixed codes block%s\n",
878                         state->last ? " (last)" : ""));
879                 state->mode = LEN_;             /* decode codes */
880                 if (flush == Z_TREES) {
881                     DROPBITS(2);
882                     goto inf_leave;
883                 }
884                 break;
885             case 2:                             /* dynamic block */
886                 Tracev((stderr, "inflate:     dynamic codes block%s\n",
887                         state->last ? " (last)" : ""));
888                 state->mode = TABLE;
889                 break;
890             case 3:
891                 strm->msg = (char *)"invalid block type";
892                 state->mode = BAD;
893             }
894             DROPBITS(2);
895             break;
896         case STORED:
897             BYTEBITS();                         /* go to byte boundary */
898             NEEDBITS(32);
899             if ((hold & 0xffff) != ((hold >> 16) ^ 0xffff)) {
900                 strm->msg = (char *)"invalid stored block lengths";
901                 state->mode = BAD;
902                 break;
903             }
904             state->length = (unsigned)hold & 0xffff;
905             Tracev((stderr, "inflate:       stored length %u\n",
906                     state->length));
907             INITBITS();
908             state->mode = COPY_;
909             if (flush == Z_TREES) goto inf_leave;
910             /* FALLTHROUGH */
911         case COPY_:
912             state->mode = COPY;
913             /* FALLTHROUGH */
914         case COPY:
915             copy = state->length;
916             if (copy) {
917                 if (copy > have) copy = have;
918                 if (copy > left) copy = left;
919                 if (copy == 0) goto inf_leave;
920                 zmemcpy(put, next, copy);
921                 have -= copy;
922                 next += copy;
923                 left -= copy;
924                 put += copy;
925                 state->length -= copy;
926                 break;
927             }
928             Tracev((stderr, "inflate:       stored end\n"));
929             state->mode = TYPE;
930             break;
931         case TABLE:
932             NEEDBITS(14);
933             state->nlen = BITS(5) + 257;
934             DROPBITS(5);
935             state->ndist = BITS(5) + 1;
936             DROPBITS(5);
937             state->ncode = BITS(4) + 4;
938             DROPBITS(4);
939 #ifndef PKZIP_BUG_WORKAROUND
940             if (state->nlen > 286 || state->ndist > 30) {
941                 strm->msg = (char *)"too many length or distance symbols";
942                 state->mode = BAD;
943                 break;
944             }
945 #endif
946             Tracev((stderr, "inflate:       table sizes ok\n"));
947             state->have = 0;
948             state->mode = LENLENS;
949         case LENLENS:
950             while (state->have < state->ncode) {
951                 NEEDBITS(3);
952                 state->lens[order[state->have++]] = (unsigned short)BITS(3);
953                 DROPBITS(3);
954             }
955             while (state->have < 19)
956                 state->lens[order[state->have++]] = 0;
957             state->next = state->codes;
958             state->lencode = (const code FAR *)(state->next);
959             state->lenbits = 7;
960             ret = inflate_table(CODES, state->lens, 19, &(state->next),
961                                 &(state->lenbits), state->work);
962             if (ret) {
963                 strm->msg = (char *)"invalid code lengths set";
964                 state->mode = BAD;
965                 break;
966             }
967             Tracev((stderr, "inflate:       code lengths ok\n"));
968             state->have = 0;
969             state->mode = CODELENS;
970         case CODELENS:
971             while (state->have < state->nlen + state->ndist) {
972                 for (;;) {
973                     here = state->lencode[BITS(state->lenbits)];
974                     if ((unsigned)(here.bits) <= bits) break;
975                     PULLBYTE();
976                 }
977                 if (here.val < 16) {
978                     DROPBITS(here.bits);
979                     state->lens[state->have++] = here.val;
980                 }
981                 else {
982                     if (here.val == 16) {
983                         NEEDBITS(here.bits + 2);
984                         DROPBITS(here.bits);
985                         if (state->have == 0) {
986                             strm->msg = (char *)"invalid bit length repeat";
987                             state->mode = BAD;
988                             break;
989                         }
990                         len = state->lens[state->have - 1];
991                         copy = 3 + BITS(2);
992                         DROPBITS(2);
993                     }
994                     else if (here.val == 17) {
995                         NEEDBITS(here.bits + 3);
996                         DROPBITS(here.bits);
997                         len = 0;
998                         copy = 3 + BITS(3);
999                         DROPBITS(3);
1000                     }
1001                     else {
1002                         NEEDBITS(here.bits + 7);
1003                         DROPBITS(here.bits);
1004                         len = 0;
1005                         copy = 11 + BITS(7);
1006                         DROPBITS(7);
1007                     }
1008                     if (state->have + copy > state->nlen + state->ndist) {
1009                         strm->msg = (char *)"invalid bit length repeat";
1010                         state->mode = BAD;
1011                         break;
1012                     }
1013                     while (copy--)
1014                         state->lens[state->have++] = (unsigned short)len;
1015                 }
1016             }
1017 
1018             /* handle error breaks in while */
1019             if (state->mode == BAD) break;
1020 
1021             /* check for end-of-block code (better have one) */
1022             if (state->lens[256] == 0) {
1023                 strm->msg = (char *)"invalid code -- missing end-of-block";
1024                 state->mode = BAD;
1025                 break;
1026             }
1027 
1028             /* build code tables -- note: do not change the lenbits or distbits
1029                values here (9 and 6) without reading the comments in inftrees.h
1030                concerning the ENOUGH constants, which depend on those values */
1031             state->next = state->codes;
1032             state->lencode = (const code FAR *)(state->next);
1033             state->lenbits = 9;
1034             ret = inflate_table(LENS, state->lens, state->nlen, &(state->next),
1035                                 &(state->lenbits), state->work);
1036             if (ret) {
1037                 strm->msg = (char *)"invalid literal/lengths set";
1038                 state->mode = BAD;
1039                 break;
1040             }
1041             state->distcode = (const code FAR *)(state->next);
1042             state->distbits = 6;
1043             ret = inflate_table(DISTS, state->lens + state->nlen, state->ndist,
1044                             &(state->next), &(state->distbits), state->work);
1045             if (ret) {
1046                 strm->msg = (char *)"invalid distances set";
1047                 state->mode = BAD;
1048                 break;
1049             }
1050             Tracev((stderr, "inflate:       codes ok\n"));
1051             state->mode = LEN_;
1052             if (flush == Z_TREES) goto inf_leave;
1053             /* FALLTHROUGH */
1054         case LEN_:
1055             state->mode = LEN;
1056             /* FALLTHROUGH */
1057         case LEN:
1058             if (have >= 6 && left >= 258) {
1059                 RESTORE();
1060                 inflate_fast(strm, out);
1061                 LOAD();
1062                 if (state->mode == TYPE)
1063                     state->back = -1;
1064                 break;
1065             }
1066             state->back = 0;
1067             for (;;) {
1068                 here = state->lencode[BITS(state->lenbits)];
1069                 if ((unsigned)(here.bits) <= bits) break;
1070                 PULLBYTE();
1071             }
1072             if (here.op && (here.op & 0xf0) == 0) {
1073                 last = here;
1074                 for (;;) {
1075                     here = state->lencode[last.val +
1076                             (BITS(last.bits + last.op) >> last.bits)];
1077                     if ((unsigned)(last.bits + here.bits) <= bits) break;
1078                     PULLBYTE();
1079                 }
1080                 DROPBITS(last.bits);
1081                 state->back += last.bits;
1082             }
1083             DROPBITS(here.bits);
1084             state->back += here.bits;
1085             state->length = (unsigned)here.val;
1086             if ((int)(here.op) == 0) {
1087                 Tracevv((stderr, here.val >= 0x20 && here.val < 0x7f ?
1088                         "inflate:         literal '%c'\n" :
1089                         "inflate:         literal 0x%02x\n", here.val));
1090                 state->mode = LIT;
1091                 break;
1092             }
1093             if (here.op & 32) {
1094                 Tracevv((stderr, "inflate:         end of block\n"));
1095                 state->back = -1;
1096                 state->mode = TYPE;
1097                 break;
1098             }
1099             if (here.op & 64) {
1100                 strm->msg = (char *)"invalid literal/length code";
1101                 state->mode = BAD;
1102                 break;
1103             }
1104             state->extra = (unsigned)(here.op) & 15;
1105             state->mode = LENEXT;
1106             /* FALLTHROUGH */
1107         case LENEXT:
1108             if (state->extra) {
1109                 NEEDBITS(state->extra);
1110                 state->length += BITS(state->extra);
1111                 DROPBITS(state->extra);
1112                 state->back += state->extra;
1113             }
1114             Tracevv((stderr, "inflate:         length %u\n", state->length));
1115             state->was = state->length;
1116             state->mode = DIST;
1117             /* FALLTHROUGH */
1118         case DIST:
1119             for (;;) {
1120                 here = state->distcode[BITS(state->distbits)];
1121                 if ((unsigned)(here.bits) <= bits) break;
1122                 PULLBYTE();
1123             }
1124             if ((here.op & 0xf0) == 0) {
1125                 last = here;
1126                 for (;;) {
1127                     here = state->distcode[last.val +
1128                             (BITS(last.bits + last.op) >> last.bits)];
1129                     if ((unsigned)(last.bits + here.bits) <= bits) break;
1130                     PULLBYTE();
1131                 }
1132                 DROPBITS(last.bits);
1133                 state->back += last.bits;
1134             }
1135             DROPBITS(here.bits);
1136             state->back += here.bits;
1137             if (here.op & 64) {
1138                 strm->msg = (char *)"invalid distance code";
1139                 state->mode = BAD;
1140                 break;
1141             }
1142             state->offset = (unsigned)here.val;
1143             state->extra = (unsigned)(here.op) & 15;
1144             state->mode = DISTEXT;
1145             /* FALLTHROUGH */
1146         case DISTEXT:
1147             if (state->extra) {
1148                 NEEDBITS(state->extra);
1149                 state->offset += BITS(state->extra);
1150                 DROPBITS(state->extra);
1151                 state->back += state->extra;
1152             }
1153 #ifdef INFLATE_STRICT
1154             if (state->offset > state->dmax) {
1155                 strm->msg = (char *)"invalid distance too far back";
1156                 state->mode = BAD;
1157                 break;
1158             }
1159 #endif
1160             Tracevv((stderr, "inflate:         distance %u\n", state->offset));
1161             state->mode = MATCH;
1162             /* FALLTHROUGH */
1163         case MATCH:
1164             if (left == 0) goto inf_leave;
1165             copy = out - left;
1166             if (state->offset > copy) {         /* copy from window */
1167                 copy = state->offset - copy;
1168                 if (copy > state->whave) {
1169                     if (state->sane) {
1170                         strm->msg = (char *)"invalid distance too far back";
1171                         state->mode = BAD;
1172                         break;
1173                     }
1174 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1175                     Trace((stderr, "inflate.c too far\n"));
1176                     copy -= state->whave;
1177                     if (copy > state->length) copy = state->length;
1178                     if (copy > left) copy = left;
1179                     left -= copy;
1180                     state->length -= copy;
1181                     do {
1182                         *put++ = 0;
1183                     } while (--copy);
1184                     if (state->length == 0) state->mode = LEN;
1185                     break;
1186 #endif
1187                 }
1188                 if (copy > state->wnext) {
1189                     copy -= state->wnext;
1190                     from = state->window + (state->wsize - copy);
1191                 }
1192                 else
1193                     from = state->window + (state->wnext - copy);
1194                 if (copy > state->length) copy = state->length;
1195             }
1196             else {                              /* copy from output */
1197                 from = put - state->offset;
1198                 copy = state->length;
1199             }
1200             if (copy > left) copy = left;
1201             left -= copy;
1202             state->length -= copy;
1203             do {
1204                 *put++ = *from++;
1205             } while (--copy);
1206             if (state->length == 0) state->mode = LEN;
1207             break;
1208         case LIT:
1209             if (left == 0) goto inf_leave;
1210             *put++ = (unsigned char)(state->length);
1211             left--;
1212             state->mode = LEN;
1213             break;
1214         case CHECK:
1215             if (state->wrap) {
1216                 NEEDBITS(32);
1217                 out -= left;
1218                 strm->total_out += out;
1219                 state->total += out;
1220                 if ((state->wrap & 4) && out)
1221                     strm->adler = state->check =
1222                         UPDATE(state->check, put - out, out);
1223                 out = left;
1224                 if ((state->wrap & 4) && (
1225 #ifdef GUNZIP
1226                      state->flags ? hold :
1227 #endif
1228                      ZSWAP32(hold)) != state->check) {
1229                     strm->msg = (char *)"incorrect data check";
1230                     state->mode = BAD;
1231                     break;
1232                 }
1233                 INITBITS();
1234                 Tracev((stderr, "inflate:   check matches trailer\n"));
1235             }
1236 #ifdef GUNZIP
1237             state->mode = LENGTH;
1238             /* FALLTHROUGH */
1239         case LENGTH:
1240             if (state->wrap && state->flags) {
1241                 NEEDBITS(32);
1242                 if (hold != (state->total & 0xffffffffUL)) {
1243                     strm->msg = (char *)"incorrect length check";
1244                     state->mode = BAD;
1245                     break;
1246                 }
1247                 INITBITS();
1248                 Tracev((stderr, "inflate:   length matches trailer\n"));
1249             }
1250 #endif
1251             state->mode = DONE;
1252             /* FALLTHROUGH */
1253         case DONE:
1254             ret = Z_STREAM_END;
1255             goto inf_leave;
1256         case BAD:
1257             ret = Z_DATA_ERROR;
1258             goto inf_leave;
1259         case MEM:
1260             return Z_MEM_ERROR;
1261         case SYNC:
1262         default:
1263             return Z_STREAM_ERROR;
1264         }
1265 
1266     /*
1267        Return from inflate(), updating the total counts and the check value.
1268        If there was no progress during the inflate() call, return a buffer
1269        error.  Call updatewindow() to create and/or update the window state.
1270        Note: a memory error from inflate() is non-recoverable.
1271      */
1272   inf_leave:
1273     RESTORE();
1274     if (state->wsize || (out != strm->avail_out && state->mode < BAD &&
1275             (state->mode < CHECK || flush != Z_FINISH)))
1276         if (updatewindow(strm, strm->next_out, out - strm->avail_out)) {
1277             state->mode = MEM;
1278             return Z_MEM_ERROR;
1279         }
1280     in -= strm->avail_in;
1281     out -= strm->avail_out;
1282     strm->total_in += in;
1283     strm->total_out += out;
1284     state->total += out;
1285     if ((state->wrap & 4) && out)
1286         strm->adler = state->check =
1287             UPDATE(state->check, strm->next_out - out, out);
1288     strm->data_type = (int)state->bits + (state->last ? 64 : 0) +
1289                       (state->mode == TYPE ? 128 : 0) +
1290                       (state->mode == LEN_ || state->mode == COPY_ ? 256 : 0);
1291     if (((in == 0 && out == 0) || flush == Z_FINISH) && ret == Z_OK)
1292         ret = Z_BUF_ERROR;
1293     return ret;
1294 }
1295 
1296 int ZEXPORT inflateEnd(
1297     z_streamp strm)
1298 {
1299     struct inflate_state FAR *state;
1300     if (inflateStateCheck(strm))
1301         return Z_STREAM_ERROR;
1302     state = (struct inflate_state FAR *)strm->state;
1303     if (state->window != Z_NULL) ZFREE(strm, state->window);
1304     ZFREE(strm, strm->state);
1305     strm->state = Z_NULL;
1306     Tracev((stderr, "inflate: end\n"));
1307     return Z_OK;
1308 }
1309 
1310 int ZEXPORT inflateGetDictionary(
1311     z_streamp strm,
1312     Bytef *dictionary,
1313     uInt *dictLength)
1314 {
1315     struct inflate_state FAR *state;
1316 
1317     /* check state */
1318     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1319     state = (struct inflate_state FAR *)strm->state;
1320 
1321     /* copy dictionary */
1322     if (state->whave && dictionary != Z_NULL) {
1323         zmemcpy(dictionary, state->window + state->wnext,
1324                 state->whave - state->wnext);
1325         zmemcpy(dictionary + state->whave - state->wnext,
1326                 state->window, state->wnext);
1327     }
1328     if (dictLength != Z_NULL)
1329         *dictLength = state->whave;
1330     return Z_OK;
1331 }
1332 
1333 int ZEXPORT inflateSetDictionary(
1334     z_streamp strm,
1335     const Bytef *dictionary,
1336     uInt dictLength)
1337 {
1338     struct inflate_state FAR *state;
1339     unsigned long dictid;
1340     int ret;
1341 
1342     /* check state */
1343     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1344     state = (struct inflate_state FAR *)strm->state;
1345     if (state->wrap != 0 && state->mode != DICT)
1346         return Z_STREAM_ERROR;
1347 
1348     /* check for correct dictionary identifier */
1349     if (state->mode == DICT) {
1350         dictid = adler32(0L, Z_NULL, 0);
1351         dictid = adler32(dictid, dictionary, dictLength);
1352         if (dictid != state->check)
1353             return Z_DATA_ERROR;
1354     }
1355 
1356     /* copy dictionary to window using updatewindow(), which will amend the
1357        existing dictionary if appropriate */
1358     ret = updatewindow(strm, dictionary + dictLength, dictLength);
1359     if (ret) {
1360         state->mode = MEM;
1361         return Z_MEM_ERROR;
1362     }
1363     state->havedict = 1;
1364     Tracev((stderr, "inflate:   dictionary set\n"));
1365     return Z_OK;
1366 }
1367 
1368 int ZEXPORT inflateGetHeader(
1369     z_streamp strm,
1370     gz_headerp head)
1371 {
1372     struct inflate_state FAR *state;
1373 
1374     /* check state */
1375     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1376     state = (struct inflate_state FAR *)strm->state;
1377     if ((state->wrap & 2) == 0) return Z_STREAM_ERROR;
1378 
1379     /* save header structure */
1380     state->head = head;
1381     head->done = 0;
1382     return Z_OK;
1383 }
1384 
1385 /*
1386    Search buf[0..len-1] for the pattern: 0, 0, 0xff, 0xff.  Return when found
1387    or when out of input.  When called, *have is the number of pattern bytes
1388    found in order so far, in 0..3.  On return *have is updated to the new
1389    state.  If on return *have equals four, then the pattern was found and the
1390    return value is how many bytes were read including the last byte of the
1391    pattern.  If *have is less than four, then the pattern has not been found
1392    yet and the return value is len.  In the latter case, syncsearch() can be
1393    called again with more data and the *have state.  *have is initialized to
1394    zero for the first call.
1395  */
1396 local unsigned syncsearch(
1397     unsigned FAR *have,
1398     const unsigned char FAR *buf,
1399     unsigned len)
1400 {
1401     unsigned got;
1402     unsigned next;
1403 
1404     got = *have;
1405     next = 0;
1406     while (next < len && got < 4) {
1407         if ((int)(buf[next]) == (got < 2 ? 0 : 0xff))
1408             got++;
1409         else if (buf[next])
1410             got = 0;
1411         else
1412             got = 4 - got;
1413         next++;
1414     }
1415     *have = got;
1416     return next;
1417 }
1418 
1419 int ZEXPORT inflateSync(
1420     z_streamp strm)
1421 {
1422     unsigned len;               /* number of bytes to look at or looked at */
1423     unsigned long in, out;      /* temporary to save total_in and total_out */
1424     unsigned char buf[4];       /* to restore bit buffer to byte string */
1425     struct inflate_state FAR *state;
1426 
1427     /* check parameters */
1428     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1429     state = (struct inflate_state FAR *)strm->state;
1430     if (strm->avail_in == 0 && state->bits < 8) return Z_BUF_ERROR;
1431 
1432     /* if first time, start search in bit buffer */
1433     if (state->mode != SYNC) {
1434         state->mode = SYNC;
1435         state->hold <<= state->bits & 7;
1436         state->bits -= state->bits & 7;
1437         len = 0;
1438         while (state->bits >= 8) {
1439             buf[len++] = (unsigned char)(state->hold);
1440             state->hold >>= 8;
1441             state->bits -= 8;
1442         }
1443         state->have = 0;
1444         syncsearch(&(state->have), buf, len);
1445     }
1446 
1447     /* search available input */
1448     len = syncsearch(&(state->have), strm->next_in, strm->avail_in);
1449     strm->avail_in -= len;
1450     strm->next_in += len;
1451     strm->total_in += len;
1452 
1453     /* return no joy or set up to restart inflate() on a new block */
1454     if (state->have != 4) return Z_DATA_ERROR;
1455     in = strm->total_in;  out = strm->total_out;
1456     inflateReset(strm);
1457     strm->total_in = in;  strm->total_out = out;
1458     state->mode = TYPE;
1459     return Z_OK;
1460 }
1461 
1462 /*
1463    Returns true if inflate is currently at the end of a block generated by
1464    Z_SYNC_FLUSH or Z_FULL_FLUSH. This function is used by one PPP
1465    implementation to provide an additional safety check. PPP uses
1466    Z_SYNC_FLUSH but removes the length bytes of the resulting empty stored
1467    block. When decompressing, PPP checks that at the end of input packet,
1468    inflate is waiting for these length bytes.
1469  */
1470 int ZEXPORT inflateSyncPoint(
1471     z_streamp strm)
1472 {
1473     struct inflate_state FAR *state;
1474 
1475     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1476     state = (struct inflate_state FAR *)strm->state;
1477     return state->mode == STORED && state->bits == 0;
1478 }
1479 
1480 int ZEXPORT inflateCopy(
1481     z_streamp dest,
1482     z_streamp source)
1483 {
1484     struct inflate_state FAR *state;
1485     struct inflate_state FAR *copy;
1486     unsigned char FAR *window;
1487     unsigned wsize;
1488 
1489     /* check input */
1490     if (inflateStateCheck(source) || dest == Z_NULL)
1491         return Z_STREAM_ERROR;
1492     state = (struct inflate_state FAR *)source->state;
1493 
1494     /* allocate space */
1495     copy = (struct inflate_state FAR *)
1496            ZALLOC(source, 1, sizeof(struct inflate_state));
1497     if (copy == Z_NULL) return Z_MEM_ERROR;
1498     window = Z_NULL;
1499     if (state->window != Z_NULL) {
1500         window = (unsigned char FAR *)
1501                  ZALLOC(source, 1U << state->wbits, sizeof(unsigned char));
1502         if (window == Z_NULL) {
1503             ZFREE(source, copy);
1504             return Z_MEM_ERROR;
1505         }
1506     }
1507 
1508     /* copy state */
1509     zmemcpy((Bytef*)dest, (Bytef*)source, sizeof(z_stream));
1510     zmemcpy((Bytef*)copy, (Bytef*)state, sizeof(struct inflate_state));
1511     copy->strm = dest;
1512     if (state->lencode >= state->codes &&
1513         state->lencode <= state->codes + ENOUGH - 1) {
1514         copy->lencode = copy->codes + (state->lencode - state->codes);
1515         copy->distcode = copy->codes + (state->distcode - state->codes);
1516     }
1517     copy->next = copy->codes + (state->next - state->codes);
1518     if (window != Z_NULL) {
1519         wsize = 1U << state->wbits;
1520         zmemcpy(window, state->window, wsize);
1521     }
1522     copy->window = window;
1523     dest->state = (struct internal_state FAR *)copy;
1524     return Z_OK;
1525 }
1526 
1527 int ZEXPORT inflateUndermine(
1528     z_streamp strm,
1529     int subvert)
1530 {
1531     struct inflate_state FAR *state;
1532 
1533     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1534     state = (struct inflate_state FAR *)strm->state;
1535 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1536     state->sane = !subvert;
1537     return Z_OK;
1538 #else
1539     (void)subvert;
1540     state->sane = 1;
1541     return Z_DATA_ERROR;
1542 #endif
1543 }
1544 
1545 int ZEXPORT inflateValidate(
1546     z_streamp strm,
1547     int check)
1548 {
1549     struct inflate_state FAR *state;
1550 
1551     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1552     state = (struct inflate_state FAR *)strm->state;
1553     if (check)
1554         state->wrap |= 4;
1555     else
1556         state->wrap &= ~4;
1557     return Z_OK;
1558 }
1559 
1560 long ZEXPORT inflateMark(
1561     z_streamp strm)
1562 {
1563     struct inflate_state FAR *state;
1564 
1565     if (inflateStateCheck(strm))
1566         return -(1L << 16);
1567     state = (struct inflate_state FAR *)strm->state;
1568     return (long)(((unsigned long)((long)state->back)) << 16) +
1569         (state->mode == COPY ? state->length :
1570             (state->mode == MATCH ? state->was - state->length : 0));
1571 }
1572 
1573 unsigned long ZEXPORT inflateCodesUsed(
1574     z_streamp strm)
1575 {
1576     struct inflate_state FAR *state;
1577     if (inflateStateCheck(strm)) return (unsigned long)-1;
1578     state = (struct inflate_state FAR *)strm->state;
1579     return (unsigned long)(state->next - state->codes);
1580 }
1581