sys/contrib/zlib/inflate.c

   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(strm)
 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(strm)
 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(strm)
 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(strm, windowBits)
 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_(strm, windowBits, version, stream_size)
 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 #if defined(Z_SOLO) && !defined(_KERNEL)
 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 #if defined(Z_SOLO) && !defined(_KERNEL)
 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_(strm, version, stream_size)
 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(strm, bits, value)
 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(state)
 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(strm, end, copy)
 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(strm, flush)
 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         case EXLEN:
 744             if (state->flags & 0x0400) {
 745                 NEEDBITS(16);
 746                 state->length = (unsigned)(hold);
 747                 if (state->head != Z_NULL)
 748                     state->head->extra_len = (unsigned)hold;
 749                 if ((state->flags & 0x0200) && (state->wrap & 4))
 750                     CRC2(state->check, hold);
 751                 INITBITS();
 752             }
 753             else if (state->head != Z_NULL)
 754                 state->head->extra = Z_NULL;
 755             state->mode = EXTRA;
 756         case EXTRA:
 757             if (state->flags & 0x0400) {
 758                 copy = state->length;
 759                 if (copy > have) copy = have;
 760                 if (copy) {
 761                     if (state->head != Z_NULL &&
 762                         state->head->extra != Z_NULL &&
 763                         (len = state->head->extra_len - state->length) <
 764                             state->head->extra_max) {
 765                         zmemcpy(state->head->extra + len, next,
 766                                 len + copy > state->head->extra_max ?
 767                                 state->head->extra_max - len : copy);
 768                     }
 769                     if ((state->flags & 0x0200) && (state->wrap & 4))
 770                         state->check = crc32(state->check, next, copy);
 771                     have -= copy;
 772                     next += copy;
 773                     state->length -= copy;
 774                 }
 775                 if (state->length) goto inf_leave;
 776             }
 777             state->length = 0;
 778             state->mode = NAME;
 779         case NAME:
 780             if (state->flags & 0x0800) {
 781                 if (have == 0) goto inf_leave;
 782                 copy = 0;
 783                 do {
 784                     len = (unsigned)(next[copy++]);
 785                     if (state->head != Z_NULL &&
 786                             state->head->name != Z_NULL &&
 787                             state->length < state->head->name_max)
 788                         state->head->name[state->length++] = (Bytef)len;
 789                 } while (len && copy < have);
 790                 if ((state->flags & 0x0200) && (state->wrap & 4))
 791                     state->check = crc32(state->check, next, copy);
 792                 have -= copy;
 793                 next += copy;
 794                 if (len) goto inf_leave;
 795             }
 796             else if (state->head != Z_NULL)
 797                 state->head->name = Z_NULL;
 798             state->length = 0;
 799             state->mode = COMMENT;
 800         case COMMENT:
 801             if (state->flags & 0x1000) {
 802                 if (have == 0) goto inf_leave;
 803                 copy = 0;
 804                 do {
 805                     len = (unsigned)(next[copy++]);
 806                     if (state->head != Z_NULL &&
 807                             state->head->comment != Z_NULL &&
 808                             state->length < state->head->comm_max)
 809                         state->head->comment[state->length++] = (Bytef)len;
 810                 } while (len && copy < have);
 811                 if ((state->flags & 0x0200) && (state->wrap & 4))
 812                     state->check = crc32(state->check, next, copy);
 813                 have -= copy;
 814                 next += copy;
 815                 if (len) goto inf_leave;
 816             }
 817             else if (state->head != Z_NULL)
 818                 state->head->comment = Z_NULL;
 819             state->mode = HCRC;
 820         case HCRC:
 821             if (state->flags & 0x0200) {
 822                 NEEDBITS(16);
 823                 if ((state->wrap & 4) && hold != (state->check & 0xffff)) {
 824                     strm->msg = (char *)"header crc mismatch";
 825                     state->mode = BAD;
 826                     break;
 827                 }
 828                 INITBITS();
 829             }
 830             if (state->head != Z_NULL) {
 831                 state->head->hcrc = (int)((state->flags >> 9) & 1);
 832                 state->head->done = 1;
 833             }
 834             strm->adler = state->check = crc32(0L, Z_NULL, 0);
 835             state->mode = TYPE;
 836             break;
 837 #endif
 838         case DICTID:
 839             NEEDBITS(32);
 840             strm->adler = state->check = ZSWAP32(hold);
 841             INITBITS();
 842             state->mode = DICT;
 843         case DICT:
 844             if (state->havedict == 0) {
 845                 RESTORE();
 846                 return Z_NEED_DICT;
 847             }
 848             strm->adler = state->check = adler32(0L, Z_NULL, 0);
 849             state->mode = TYPE;
 850         case TYPE:
 851             if (flush == Z_BLOCK || flush == Z_TREES) goto inf_leave;
 852         case TYPEDO:
 853             if (state->last) {
 854                 BYTEBITS();
 855                 state->mode = CHECK;
 856                 break;
 857             }
 858             NEEDBITS(3);
 859             state->last = BITS(1);
 860             DROPBITS(1);
 861             switch (BITS(2)) {
 862             case 0:                             /* stored block */
 863                 Tracev((stderr, "inflate:     stored block%s\n",
 864                         state->last ? " (last)" : ""));
 865                 state->mode = STORED;
 866                 break;
 867             case 1:                             /* fixed block */
 868                 fixedtables(state);
 869                 Tracev((stderr, "inflate:     fixed codes block%s\n",
 870                         state->last ? " (last)" : ""));
 871                 state->mode = LEN_;             /* decode codes */
 872                 if (flush == Z_TREES) {
 873                     DROPBITS(2);
 874                     goto inf_leave;
 875                 }
 876                 break;
 877             case 2:                             /* dynamic block */
 878                 Tracev((stderr, "inflate:     dynamic codes block%s\n",
 879                         state->last ? " (last)" : ""));
 880                 state->mode = TABLE;
 881                 break;
 882             case 3:
 883                 strm->msg = (char *)"invalid block type";
 884                 state->mode = BAD;
 885             }
 886             DROPBITS(2);
 887             break;
 888         case STORED:
 889             BYTEBITS();                         /* go to byte boundary */
 890             NEEDBITS(32);
 891             if ((hold & 0xffff) != ((hold >> 16) ^ 0xffff)) {
 892                 strm->msg = (char *)"invalid stored block lengths";
 893                 state->mode = BAD;
 894                 break;
 895             }
 896             state->length = (unsigned)hold & 0xffff;
 897             Tracev((stderr, "inflate:       stored length %u\n",
 898                     state->length));
 899             INITBITS();
 900             state->mode = COPY_;
 901             if (flush == Z_TREES) goto inf_leave;
 902         case COPY_:
 903             state->mode = COPY;
 904         case COPY:
 905             copy = state->length;
 906             if (copy) {
 907                 if (copy > have) copy = have;
 908                 if (copy > left) copy = left;
 909                 if (copy == 0) goto inf_leave;
 910                 zmemcpy(put, next, copy);
 911                 have -= copy;
 912                 next += copy;
 913                 left -= copy;
 914                 put += copy;
 915                 state->length -= copy;
 916                 break;
 917             }
 918             Tracev((stderr, "inflate:       stored end\n"));
 919             state->mode = TYPE;
 920             break;
 921         case TABLE:
 922             NEEDBITS(14);
 923             state->nlen = BITS(5) + 257;
 924             DROPBITS(5);
 925             state->ndist = BITS(5) + 1;
 926             DROPBITS(5);
 927             state->ncode = BITS(4) + 4;
 928             DROPBITS(4);
 929 #ifndef PKZIP_BUG_WORKAROUND
 930             if (state->nlen > 286 || state->ndist > 30) {
 931                 strm->msg = (char *)"too many length or distance symbols";
 932                 state->mode = BAD;
 933                 break;
 934             }
 935 #endif
 936             Tracev((stderr, "inflate:       table sizes ok\n"));
 937             state->have = 0;
 938             state->mode = LENLENS;
 939         case LENLENS:
 940             while (state->have < state->ncode) {
 941                 NEEDBITS(3);
 942                 state->lens[order[state->have++]] = (unsigned short)BITS(3);
 943                 DROPBITS(3);
 944             }
 945             while (state->have < 19)
 946                 state->lens[order[state->have++]] = 0;
 947             state->next = state->codes;
 948             state->lencode = (const code FAR *)(state->next);
 949             state->lenbits = 7;
 950             ret = inflate_table(CODES, state->lens, 19, &(state->next),
 951                                 &(state->lenbits), state->work);
 952             if (ret) {
 953                 strm->msg = (char *)"invalid code lengths set";
 954                 state->mode = BAD;
 955                 break;
 956             }
 957             Tracev((stderr, "inflate:       code lengths ok\n"));
 958             state->have = 0;
 959             state->mode = CODELENS;
 960         case CODELENS:
 961             while (state->have < state->nlen + state->ndist) {
 962                 for (;;) {
 963                     here = state->lencode[BITS(state->lenbits)];
 964                     if ((unsigned)(here.bits) <= bits) break;
 965                     PULLBYTE();
 966                 }
 967                 if (here.val < 16) {
 968                     DROPBITS(here.bits);
 969                     state->lens[state->have++] = here.val;
 970                 }
 971                 else {
 972                     if (here.val == 16) {
 973                         NEEDBITS(here.bits + 2);
 974                         DROPBITS(here.bits);
 975                         if (state->have == 0) {
 976                             strm->msg = (char *)"invalid bit length repeat";
 977                             state->mode = BAD;
 978                             break;
 979                         }
 980                         len = state->lens[state->have - 1];
 981                         copy = 3 + BITS(2);
 982                         DROPBITS(2);
 983                     }
 984                     else if (here.val == 17) {
 985                         NEEDBITS(here.bits + 3);
 986                         DROPBITS(here.bits);
 987                         len = 0;
 988                         copy = 3 + BITS(3);
 989                         DROPBITS(3);
 990                     }
 991                     else {
 992                         NEEDBITS(here.bits + 7);
 993                         DROPBITS(here.bits);
 994                         len = 0;
 995                         copy = 11 + BITS(7);
 996                         DROPBITS(7);
 997                     }
 998                     if (state->have + copy > state->nlen + state->ndist) {
 999                         strm->msg = (char *)"invalid bit length repeat";
1000                         state->mode = BAD;
1001                         break;
1002                     }
1003                     while (copy--)
1004                         state->lens[state->have++] = (unsigned short)len;
1005                 }
1006             }
1007
1008             /* handle error breaks in while */
1009             if (state->mode == BAD) break;
1010
1011             /* check for end-of-block code (better have one) */
1012             if (state->lens[256] == 0) {
1013                 strm->msg = (char *)"invalid code -- missing end-of-block";
1014                 state->mode = BAD;
1015                 break;
1016             }
1017
1018             /* build code tables -- note: do not change the lenbits or distbits
1019                values here (9 and 6) without reading the comments in inftrees.h
1020                concerning the ENOUGH constants, which depend on those values */
1021             state->next = state->codes;
1022             state->lencode = (const code FAR *)(state->next);
1023             state->lenbits = 9;
1024             ret = inflate_table(LENS, state->lens, state->nlen, &(state->next),
1025                                 &(state->lenbits), state->work);
1026             if (ret) {
1027                 strm->msg = (char *)"invalid literal/lengths set";
1028                 state->mode = BAD;
1029                 break;
1030             }
1031             state->distcode = (const code FAR *)(state->next);
1032             state->distbits = 6;
1033             ret = inflate_table(DISTS, state->lens + state->nlen, state->ndist,
1034                             &(state->next), &(state->distbits), state->work);
1035             if (ret) {
1036                 strm->msg = (char *)"invalid distances set";
1037                 state->mode = BAD;
1038                 break;
1039             }
1040             Tracev((stderr, "inflate:       codes ok\n"));
1041             state->mode = LEN_;
1042             if (flush == Z_TREES) goto inf_leave;
1043         case LEN_:
1044             state->mode = LEN;
1045         case LEN:
1046             if (have >= 6 && left >= 258) {
1047                 RESTORE();
1048                 inflate_fast(strm, out);
1049                 LOAD();
1050                 if (state->mode == TYPE)
1051                     state->back = -1;
1052                 break;
1053             }
1054             state->back = 0;
1055             for (;;) {
1056                 here = state->lencode[BITS(state->lenbits)];
1057                 if ((unsigned)(here.bits) <= bits) break;
1058                 PULLBYTE();
1059             }
1060             if (here.op && (here.op & 0xf0) == 0) {
1061                 last = here;
1062                 for (;;) {
1063                     here = state->lencode[last.val +
1064                             (BITS(last.bits + last.op) >> last.bits)];
1065                     if ((unsigned)(last.bits + here.bits) <= bits) break;
1066                     PULLBYTE();
1067                 }
1068                 DROPBITS(last.bits);
1069                 state->back += last.bits;
1070             }
1071             DROPBITS(here.bits);
1072             state->back += here.bits;
1073             state->length = (unsigned)here.val;
1074             if ((int)(here.op) == 0) {
1075                 Tracevv((stderr, here.val >= 0x20 && here.val < 0x7f ?
1076                         "inflate:         literal '%c'\n" :
1077                         "inflate:         literal 0x%02x\n", here.val));
1078                 state->mode = LIT;
1079                 break;
1080             }
1081             if (here.op & 32) {
1082                 Tracevv((stderr, "inflate:         end of block\n"));
1083                 state->back = -1;
1084                 state->mode = TYPE;
1085                 break;
1086             }
1087             if (here.op & 64) {
1088                 strm->msg = (char *)"invalid literal/length code";
1089                 state->mode = BAD;
1090                 break;
1091             }
1092             state->extra = (unsigned)(here.op) & 15;
1093             state->mode = LENEXT;
1094         case LENEXT:
1095             if (state->extra) {
1096                 NEEDBITS(state->extra);
1097                 state->length += BITS(state->extra);
1098                 DROPBITS(state->extra);
1099                 state->back += state->extra;
1100             }
1101             Tracevv((stderr, "inflate:         length %u\n", state->length));
1102             state->was = state->length;
1103             state->mode = DIST;
1104         case DIST:
1105             for (;;) {
1106                 here = state->distcode[BITS(state->distbits)];
1107                 if ((unsigned)(here.bits) <= bits) break;
1108                 PULLBYTE();
1109             }
1110             if ((here.op & 0xf0) == 0) {
1111                 last = here;
1112                 for (;;) {
1113                     here = state->distcode[last.val +
1114                             (BITS(last.bits + last.op) >> last.bits)];
1115                     if ((unsigned)(last.bits + here.bits) <= bits) break;
1116                     PULLBYTE();
1117                 }
1118                 DROPBITS(last.bits);
1119                 state->back += last.bits;
1120             }
1121             DROPBITS(here.bits);
1122             state->back += here.bits;
1123             if (here.op & 64) {
1124                 strm->msg = (char *)"invalid distance code";
1125                 state->mode = BAD;
1126                 break;
1127             }
1128             state->offset = (unsigned)here.val;
1129             state->extra = (unsigned)(here.op) & 15;
1130             state->mode = DISTEXT;
1131         case DISTEXT:
1132             if (state->extra) {
1133                 NEEDBITS(state->extra);
1134                 state->offset += BITS(state->extra);
1135                 DROPBITS(state->extra);
1136                 state->back += state->extra;
1137             }
1138 #ifdef INFLATE_STRICT
1139             if (state->offset > state->dmax) {
1140                 strm->msg = (char *)"invalid distance too far back";
1141                 state->mode = BAD;
1142                 break;
1143             }
1144 #endif
1145             Tracevv((stderr, "inflate:         distance %u\n", state->offset));
1146             state->mode = MATCH;
1147         case MATCH:
1148             if (left == 0) goto inf_leave;
1149             copy = out - left;
1150             if (state->offset > copy) {         /* copy from window */
1151                 copy = state->offset - copy;
1152                 if (copy > state->whave) {
1153                     if (state->sane) {
1154                         strm->msg = (char *)"invalid distance too far back";
1155                         state->mode = BAD;
1156                         break;
1157                     }
1158 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1159                     Trace((stderr, "inflate.c too far\n"));
1160                     copy -= state->whave;
1161                     if (copy > state->length) copy = state->length;
1162                     if (copy > left) copy = left;
1163                     left -= copy;
1164                     state->length -= copy;
1165                     do {
1166                         *put++ = 0;
1167                     } while (--copy);
1168                     if (state->length == 0) state->mode = LEN;
1169                     break;
1170 #endif
1171                 }
1172                 if (copy > state->wnext) {
1173                     copy -= state->wnext;
1174                     from = state->window + (state->wsize - copy);
1175                 }
1176                 else
1177                     from = state->window + (state->wnext - copy);
1178                 if (copy > state->length) copy = state->length;
1179             }
1180             else {                              /* copy from output */
1181                 from = put - state->offset;
1182                 copy = state->length;
1183             }
1184             if (copy > left) copy = left;
1185             left -= copy;
1186             state->length -= copy;
1187             do {
1188                 *put++ = *from++;
1189             } while (--copy);
1190             if (state->length == 0) state->mode = LEN;
1191             break;
1192         case LIT:
1193             if (left == 0) goto inf_leave;
1194             *put++ = (unsigned char)(state->length);
1195             left--;
1196             state->mode = LEN;
1197             break;
1198         case CHECK:
1199             if (state->wrap) {
1200                 NEEDBITS(32);
1201                 out -= left;
1202                 strm->total_out += out;
1203                 state->total += out;
1204                 if ((state->wrap & 4) && out)
1205                     strm->adler = state->check =
1206                         UPDATE(state->check, put - out, out);
1207                 out = left;
1208                 if ((state->wrap & 4) && (
1209 #ifdef GUNZIP
1210                      state->flags ? hold :
1211 #endif
1212                      ZSWAP32(hold)) != state->check) {
1213                     strm->msg = (char *)"incorrect data check";
1214                     state->mode = BAD;
1215                     break;
1216                 }
1217                 INITBITS();
1218                 Tracev((stderr, "inflate:   check matches trailer\n"));
1219             }
1220 #ifdef GUNZIP
1221             state->mode = LENGTH;
1222         case LENGTH:
1223             if (state->wrap && state->flags) {
1224                 NEEDBITS(32);
1225                 if (hold != (state->total & 0xffffffffUL)) {
1226                     strm->msg = (char *)"incorrect length check";
1227                     state->mode = BAD;
1228                     break;
1229                 }
1230                 INITBITS();
1231                 Tracev((stderr, "inflate:   length matches trailer\n"));
1232             }
1233 #endif
1234             state->mode = DONE;
1235         case DONE:
1236             ret = Z_STREAM_END;
1237             goto inf_leave;
1238         case BAD:
1239             ret = Z_DATA_ERROR;
1240             goto inf_leave;
1241         case MEM:
1242             return Z_MEM_ERROR;
1243         case SYNC:
1244         default:
1245             return Z_STREAM_ERROR;
1246         }
1247
1248     /*
1249        Return from inflate(), updating the total counts and the check value.
1250        If there was no progress during the inflate() call, return a buffer
1251        error.  Call updatewindow() to create and/or update the window state.
1252        Note: a memory error from inflate() is non-recoverable.
1253      */
1254   inf_leave:
1255     RESTORE();
1256     if (state->wsize || (out != strm->avail_out && state->mode < BAD &&
1257             (state->mode < CHECK || flush != Z_FINISH)))
1258         if (updatewindow(strm, strm->next_out, out - strm->avail_out)) {
1259             state->mode = MEM;
1260             return Z_MEM_ERROR;
1261         }
1262     in -= strm->avail_in;
1263     out -= strm->avail_out;
1264     strm->total_in += in;
1265     strm->total_out += out;
1266     state->total += out;
1267     if ((state->wrap & 4) && out)
1268         strm->adler = state->check =
1269             UPDATE(state->check, strm->next_out - out, out);
1270     strm->data_type = (int)state->bits + (state->last ? 64 : 0) +
1271                       (state->mode == TYPE ? 128 : 0) +
1272                       (state->mode == LEN_ || state->mode == COPY_ ? 256 : 0);
1273     if (((in == 0 && out == 0) || flush == Z_FINISH) && ret == Z_OK)
1274         ret = Z_BUF_ERROR;
1275     return ret;
1276 }
1277
1278 int ZEXPORT inflateEnd(strm)
1279 z_streamp strm;
1280 {
1281     struct inflate_state FAR *state;
1282     if (inflateStateCheck(strm))
1283         return Z_STREAM_ERROR;
1284     state = (struct inflate_state FAR *)strm->state;
1285     if (state->window != Z_NULL) ZFREE(strm, state->window);
1286     ZFREE(strm, strm->state);
1287     strm->state = Z_NULL;
1288     Tracev((stderr, "inflate: end\n"));
1289     return Z_OK;
1290 }
1291
1292 int ZEXPORT inflateGetDictionary(strm, dictionary, dictLength)
1293 z_streamp strm;
1294 Bytef *dictionary;
1295 uInt *dictLength;
1296 {
1297     struct inflate_state FAR *state;
1298
1299     /* check state */
1300     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1301     state = (struct inflate_state FAR *)strm->state;
1302
1303     /* copy dictionary */
1304     if (state->whave && dictionary != Z_NULL) {
1305         zmemcpy(dictionary, state->window + state->wnext,
1306                 state->whave - state->wnext);
1307         zmemcpy(dictionary + state->whave - state->wnext,
1308                 state->window, state->wnext);
1309     }
1310     if (dictLength != Z_NULL)
1311         *dictLength = state->whave;
1312     return Z_OK;
1313 }
1314
1315 int ZEXPORT inflateSetDictionary(strm, dictionary, dictLength)
1316 z_streamp strm;
1317 const Bytef *dictionary;
1318 uInt dictLength;
1319 {
1320     struct inflate_state FAR *state;
1321     unsigned long dictid;
1322     int ret;
1323
1324     /* check state */
1325     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1326     state = (struct inflate_state FAR *)strm->state;
1327     if (state->wrap != 0 && state->mode != DICT)
1328         return Z_STREAM_ERROR;
1329
1330     /* check for correct dictionary identifier */
1331     if (state->mode == DICT) {
1332         dictid = adler32(0L, Z_NULL, 0);
1333         dictid = adler32(dictid, dictionary, dictLength);
1334         if (dictid != state->check)
1335             return Z_DATA_ERROR;
1336     }
1337
1338     /* copy dictionary to window using updatewindow(), which will amend the
1339        existing dictionary if appropriate */
1340     ret = updatewindow(strm, dictionary + dictLength, dictLength);
1341     if (ret) {
1342         state->mode = MEM;
1343         return Z_MEM_ERROR;
1344     }
1345     state->havedict = 1;
1346     Tracev((stderr, "inflate:   dictionary set\n"));
1347     return Z_OK;
1348 }
1349
1350 int ZEXPORT inflateGetHeader(strm, head)
1351 z_streamp strm;
1352 gz_headerp head;
1353 {
1354     struct inflate_state FAR *state;
1355
1356     /* check state */
1357     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1358     state = (struct inflate_state FAR *)strm->state;
1359     if ((state->wrap & 2) == 0) return Z_STREAM_ERROR;
1360
1361     /* save header structure */
1362     state->head = head;
1363     head->done = 0;
1364     return Z_OK;
1365 }
1366
1367 /*
1368    Search buf[0..len-1] for the pattern: 0, 0, 0xff, 0xff.  Return when found
1369    or when out of input.  When called, *have is the number of pattern bytes
1370    found in order so far, in 0..3.  On return *have is updated to the new
1371    state.  If on return *have equals four, then the pattern was found and the
1372    return value is how many bytes were read including the last byte of the
1373    pattern.  If *have is less than four, then the pattern has not been found
1374    yet and the return value is len.  In the latter case, syncsearch() can be
1375    called again with more data and the *have state.  *have is initialized to
1376    zero for the first call.
1377  */
1378 local unsigned syncsearch(have, buf, len)
1379 unsigned FAR *have;
1380 const unsigned char FAR *buf;
1381 unsigned len;
1382 {
1383     unsigned got;
1384     unsigned next;
1385
1386     got = *have;
1387     next = 0;
1388     while (next < len && got < 4) {
1389         if ((int)(buf[next]) == (got < 2 ? 0 : 0xff))
1390             got++;
1391         else if (buf[next])
1392             got = 0;
1393         else
1394             got = 4 - got;
1395         next++;
1396     }
1397     *have = got;
1398     return next;
1399 }
1400
1401 int ZEXPORT inflateSync(strm)
1402 z_streamp strm;
1403 {
1404     unsigned len;               /* number of bytes to look at or looked at */
1405     unsigned long in, out;      /* temporary to save total_in and total_out */
1406     unsigned char buf[4];       /* to restore bit buffer to byte string */
1407     struct inflate_state FAR *state;
1408
1409     /* check parameters */
1410     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1411     state = (struct inflate_state FAR *)strm->state;
1412     if (strm->avail_in == 0 && state->bits < 8) return Z_BUF_ERROR;
1413
1414     /* if first time, start search in bit buffer */
1415     if (state->mode != SYNC) {
1416         state->mode = SYNC;
1417         state->hold <<= state->bits & 7;
1418         state->bits -= state->bits & 7;
1419         len = 0;
1420         while (state->bits >= 8) {
1421             buf[len++] = (unsigned char)(state->hold);
1422             state->hold >>= 8;
1423             state->bits -= 8;
1424         }
1425         state->have = 0;
1426         syncsearch(&(state->have), buf, len);
1427     }
1428
1429     /* search available input */
1430     len = syncsearch(&(state->have), strm->next_in, strm->avail_in);
1431     strm->avail_in -= len;
1432     strm->next_in += len;
1433     strm->total_in += len;
1434
1435     /* return no joy or set up to restart inflate() on a new block */
1436     if (state->have != 4) return Z_DATA_ERROR;
1437     in = strm->total_in;  out = strm->total_out;
1438     inflateReset(strm);
1439     strm->total_in = in;  strm->total_out = out;
1440     state->mode = TYPE;
1441     return Z_OK;
1442 }
1443
1444 /*
1445    Returns true if inflate is currently at the end of a block generated by
1446    Z_SYNC_FLUSH or Z_FULL_FLUSH. This function is used by one PPP
1447    implementation to provide an additional safety check. PPP uses
1448    Z_SYNC_FLUSH but removes the length bytes of the resulting empty stored
1449    block. When decompressing, PPP checks that at the end of input packet,
1450    inflate is waiting for these length bytes.
1451  */
1452 int ZEXPORT inflateSyncPoint(strm)
1453 z_streamp strm;
1454 {
1455     struct inflate_state FAR *state;
1456
1457     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1458     state = (struct inflate_state FAR *)strm->state;
1459     return state->mode == STORED && state->bits == 0;
1460 }
1461
1462 int ZEXPORT inflateCopy(dest, source)
1463 z_streamp dest;
1464 z_streamp source;
1465 {
1466     struct inflate_state FAR *state;
1467     struct inflate_state FAR *copy;
1468     unsigned char FAR *window;
1469     unsigned wsize;
1470
1471     /* check input */
1472     if (inflateStateCheck(source) || dest == Z_NULL)
1473         return Z_STREAM_ERROR;
1474     state = (struct inflate_state FAR *)source->state;
1475
1476     /* allocate space */
1477     copy = (struct inflate_state FAR *)
1478            ZALLOC(source, 1, sizeof(struct inflate_state));
1479     if (copy == Z_NULL) return Z_MEM_ERROR;
1480     window = Z_NULL;
1481     if (state->window != Z_NULL) {
1482         window = (unsigned char FAR *)
1483                  ZALLOC(source, 1U << state->wbits, sizeof(unsigned char));
1484         if (window == Z_NULL) {
1485             ZFREE(source, copy);
1486             return Z_MEM_ERROR;
1487         }
1488     }
1489
1490     /* copy state */
1491     zmemcpy((voidpf)dest, (voidpf)source, sizeof(z_stream));
1492     zmemcpy((voidpf)copy, (voidpf)state, sizeof(struct inflate_state));
1493     copy->strm = dest;
1494     if (state->lencode >= state->codes &&
1495         state->lencode <= state->codes + ENOUGH - 1) {
1496         copy->lencode = copy->codes + (state->lencode - state->codes);
1497         copy->distcode = copy->codes + (state->distcode - state->codes);
1498     }
1499     copy->next = copy->codes + (state->next - state->codes);
1500     if (window != Z_NULL) {
1501         wsize = 1U << state->wbits;
1502         zmemcpy(window, state->window, wsize);
1503     }
1504     copy->window = window;
1505     dest->state = (struct internal_state FAR *)copy;
1506     return Z_OK;
1507 }
1508
1509 int ZEXPORT inflateUndermine(strm, subvert)
1510 z_streamp strm;
1511 int subvert;
1512 {
1513     struct inflate_state FAR *state;
1514
1515     if (inflateStateCheck(strm)) return Z_STREAM_ERROR;
1516     state = (struct inflate_state FAR *)strm->state;
1517 #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
1518     state->sane = !subvert;
1519     return Z_OK;
1520 #else
1521     (void)subvert;
1522     state->sane = 1;
1523     return Z_DATA_ERROR;
1524 #endif
1525 }
1526
1527 int ZEXPORT inflateValidate(strm, check)
1528 z_streamp strm;
1529 int check;
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     if (check)
1536         state->wrap |= 4;
1537     else
1538         state->wrap &= ~4;
1539     return Z_OK;
1540 }
1541
1542 long ZEXPORT inflateMark(strm)
1543 z_streamp strm;
1544 {
1545     struct inflate_state FAR *state;
1546
1547     if (inflateStateCheck(strm))
1548         return -(1L << 16);
1549     state = (struct inflate_state FAR *)strm->state;
1550     return (long)(((unsigned long)((long)state->back)) << 16) +
1551         (state->mode == COPY ? state->length :
1552             (state->mode == MATCH ? state->was - state->length : 0));
1553 }
1554
1555 unsigned long ZEXPORT inflateCodesUsed(strm)
1556 z_streamp strm;
1557 {
1558     struct inflate_state FAR *state;
1559     if (inflateStateCheck(strm)) return (unsigned long)-1;
1560     state = (struct inflate_state FAR *)strm->state;
1561     return (unsigned long)(state->next - state->codes);
1562 }