gnu/usr.bin/gzip/inflate.c

   1 /* inflate.c -- Not copyrighted 1992 by Mark Adler
   2    version c10p1, 10 January 1993 */
   3
   4 /* You can do whatever you like with this source file, though I would
   5    prefer that if you modify it and redistribute it that you include
   6    comments to that effect with your name and the date.  Thank you.
   7    [The history has been moved to the file ChangeLog.]
   8  */
   9
  10 /*
  11    Inflate deflated (PKZIP's method 8 compressed) data.  The compression
  12    method searches for as much of the current string of bytes (up to a
  13    length of 258) in the previous 32K bytes.  If it doesn't find any
  14    matches (of at least length 3), it codes the next byte.  Otherwise, it
  15    codes the length of the matched string and its distance backwards from
  16    the current position.  There is a single Huffman code that codes both
  17    single bytes (called "literals") and match lengths.  A second Huffman
  18    code codes the distance information, which follows a length code.  Each
  19    length or distance code actually represents a base value and a number
  20    of "extra" (sometimes zero) bits to get to add to the base value.  At
  21    the end of each deflated block is a special end-of-block (EOB) literal/
  22    length code.  The decoding process is basically: get a literal/length
  23    code; if EOB then done; if a literal, emit the decoded byte; if a
  24    length then get the distance and emit the referred-to bytes from the
  25    sliding window of previously emitted data.
  26
  27    There are (currently) three kinds of inflate blocks: stored, fixed, and
  28    dynamic.  The compressor deals with some chunk of data at a time, and
  29    decides which method to use on a chunk-by-chunk basis.  A chunk might
  30    typically be 32K or 64K.  If the chunk is uncompressible, then the
  31    "stored" method is used.  In this case, the bytes are simply stored as
  32    is, eight bits per byte, with none of the above coding.  The bytes are
  33    preceded by a count, since there is no longer an EOB code.
  34
  35    If the data is compressible, then either the fixed or dynamic methods
  36    are used.  In the dynamic method, the compressed data is preceded by
  37    an encoding of the literal/length and distance Huffman codes that are
  38    to be used to decode this block.  The representation is itself Huffman
  39    coded, and so is preceded by a description of that code.  These code
  40    descriptions take up a little space, and so for small blocks, there is
  41    a predefined set of codes, called the fixed codes.  The fixed method is
  42    used if the block codes up smaller that way (usually for quite small
  43    chunks), otherwise the dynamic method is used.  In the latter case, the
  44    codes are customized to the probabilities in the current block, and so
  45    can code it much better than the pre-determined fixed codes.
  46
  47    The Huffman codes themselves are decoded using a mutli-level table
  48    lookup, in order to maximize the speed of decoding plus the speed of
  49    building the decoding tables.  See the comments below that precede the
  50    lbits and dbits tuning parameters.
  51  */
  52
  53
  54 /*
  55    Notes beyond the 1.93a appnote.txt:
  56
  57    1. Distance pointers never point before the beginning of the output
  58       stream.
  59    2. Distance pointers can point back across blocks, up to 32k away.
  60    3. There is an implied maximum of 7 bits for the bit length table and
  61       15 bits for the actual data.
  62    4. If only one code exists, then it is encoded using one bit.  (Zero
  63       would be more efficient, but perhaps a little confusing.)  If two
  64       codes exist, they are coded using one bit each (0 and 1).
  65    5. There is no way of sending zero distance codes--a dummy must be
  66       sent if there are none.  (History: a pre 2.0 version of PKZIP would
  67       store blocks with no distance codes, but this was discovered to be
  68       too harsh a criterion.)  Valid only for 1.93a.  2.04c does allow
  69       zero distance codes, which is sent as one code of zero bits in
  70       length.
  71    6. There are up to 286 literal/length codes.  Code 256 represents the
  72       end-of-block.  Note however that the static length tree defines
  73       288 codes just to fill out the Huffman codes.  Codes 286 and 287
  74       cannot be used though, since there is no length base or extra bits
  75       defined for them.  Similarly, there are up to 30 distance codes.
  76       However, static trees define 32 codes (all 5 bits) to fill out the
  77       Huffman codes, but the last two had better not show up in the data.
  78    7. Unzip can check dynamic Huffman blocks for complete code sets.
  79       The exception is that a single code would not be complete (see #4).
  80    8. The five bits following the block type is really the number of
  81       literal codes sent minus 257.
  82    9. Length codes 8,16,16 are interpreted as 13 length codes of 8 bits
  83       (1+6+6).  Therefore, to output three times the length, you output
  84       three codes (1+1+1), whereas to output four times the same length,
  85       you only need two codes (1+3).  Hmm.
  86   10. In the tree reconstruction algorithm, Code = Code + Increment
  87       only if BitLength(i) is not zero.  (Pretty obvious.)
  88   11. Correction: 4 Bits: # of Bit Length codes - 4     (4 - 19)
  89   12. Note: length code 284 can represent 227-258, but length code 285
  90       really is 258.  The last length deserves its own, short code
  91       since it gets used a lot in very redundant files.  The length
  92       258 is special since 258 - 3 (the min match length) is 255.
  93   13. The literal/length and distance code bit lengths are read as a
  94       single stream of lengths.  It is possible (and advantageous) for
  95       a repeat code (16, 17, or 18) to go across the boundary between
  96       the two sets of lengths.
  97  */
  98
  99 #ifdef RCSID
 100 static char rcsid[] = "$FreeBSD$";
 101 #endif
 102
 103 #include <sys/types.h>
 104
 105 #include "tailor.h"
 106
 107 #if defined(STDC_HEADERS) || !defined(NO_STDLIB_H)
 108 #  include <stdlib.h>
 109 #endif
 110
 111 #include "gzip.h"
 112 #define slide window
 113
 114 /* Huffman code lookup table entry--this entry is four bytes for machines
 115    that have 16-bit pointers (e.g. PC's in the small or medium model).
 116    Valid extra bits are 0..13.  e == 15 is EOB (end of block), e == 16
 117    means that v is a literal, 16 < e < 32 means that v is a pointer to
 118    the next table, which codes e - 16 bits, and lastly e == 99 indicates
 119    an unused code.  If a code with e == 99 is looked up, this implies an
 120    error in the data. */
 121 struct huft {
 122   uch e;                /* number of extra bits or operation */
 123   uch b;                /* number of bits in this code or subcode */
 124   union {
 125     ush n;              /* literal, length base, or distance base */
 126     struct huft *t;     /* pointer to next level of table */
 127   } v;
 128 };
 129
 130
 131 /* Function prototypes */
 132 int huft_build OF((unsigned *, unsigned, unsigned, ush *, ush *,
 133                    struct huft **, int *));
 134 int huft_free OF((struct huft *));
 135 int inflate_codes OF((struct huft *, struct huft *, int, int));
 136 int inflate_stored OF((void));
 137 int inflate_fixed OF((void));
 138 int inflate_dynamic OF((void));
 139 int inflate_block OF((int *));
 140 int inflate OF((void));
 141
 142
 143 /* The inflate algorithm uses a sliding 32K byte window on the uncompressed
 144    stream to find repeated byte strings.  This is implemented here as a
 145    circular buffer.  The index is updated simply by incrementing and then
 146    and'ing with 0x7fff (32K-1). */
 147 /* It is left to other modules to supply the 32K area.  It is assumed
 148    to be usable as if it were declared "uch slide[32768];" or as just
 149    "uch *slide;" and then malloc'ed in the latter case.  The definition
 150    must be in unzip.h, included above. */
 151 /* unsigned wp;             current position in slide */
 152 #define wp outcnt
 153 #define flush_output(w) (wp=(w),flush_window())
 154
 155 /* Tables for deflate from PKZIP's appnote.txt. */
 156 static unsigned border[] = {    /* Order of the bit length code lengths */
 157         16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15};
 158 static ush cplens[] = {         /* Copy lengths for literal codes 257..285 */
 159         3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31,
 160         35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, 258, 0, 0};
 161         /* note: see note #13 above about the 258 in this list. */
 162 static ush cplext[] = {         /* Extra bits for literal codes 257..285 */
 163         0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2,
 164         3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 0, 99, 99}; /* 99==invalid */
 165 static ush cpdist[] = {         /* Copy offsets for distance codes 0..29 */
 166         1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193,
 167         257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145,
 168         8193, 12289, 16385, 24577};
 169 static ush cpdext[] = {         /* Extra bits for distance codes */
 170         0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6,
 171         7, 7, 8, 8, 9, 9, 10, 10, 11, 11,
 172         12, 12, 13, 13};
 173
 174
 175
 176 /* Macros for inflate() bit peeking and grabbing.
 177    The usage is:
 178
 179         NEEDBITS(j)
 180         x = b & mask_bits[j];
 181         DUMPBITS(j)
 182
 183    where NEEDBITS makes sure that b has at least j bits in it, and
 184    DUMPBITS removes the bits from b.  The macros use the variable k
 185    for the number of bits in b.  Normally, b and k are register
 186    variables for speed, and are initialized at the beginning of a
 187    routine that uses these macros from a global bit buffer and count.
 188
 189    If we assume that EOB will be the longest code, then we will never
 190    ask for bits with NEEDBITS that are beyond the end of the stream.
 191    So, NEEDBITS should not read any more bytes than are needed to
 192    meet the request.  Then no bytes need to be "returned" to the buffer
 193    at the end of the last block.
 194
 195    However, this assumption is not true for fixed blocks--the EOB code
 196    is 7 bits, but the other literal/length codes can be 8 or 9 bits.
 197    (The EOB code is shorter than other codes because fixed blocks are
 198    generally short.  So, while a block always has an EOB, many other
 199    literal/length codes have a significantly lower probability of
 200    showing up at all.)  However, by making the first table have a
 201    lookup of seven bits, the EOB code will be found in that first
 202    lookup, and so will not require that too many bits be pulled from
 203    the stream.
 204  */
 205
 206 ulg bb;                         /* bit buffer */
 207 unsigned bk;                    /* bits in bit buffer */
 208
 209 ush mask_bits[] = {
 210     0x0000,
 211     0x0001, 0x0003, 0x0007, 0x000f, 0x001f, 0x003f, 0x007f, 0x00ff,
 212     0x01ff, 0x03ff, 0x07ff, 0x0fff, 0x1fff, 0x3fff, 0x7fff, 0xffff
 213 };
 214
 215 #ifdef CRYPT
 216   uch cc;
 217 #  define NEXTBYTE() \
 218      (decrypt ? (cc = get_byte(), zdecode(cc), cc) : get_byte())
 219 #else
 220 #  define NEXTBYTE()  (uch)get_byte()
 221 #endif
 222 #define NEEDBITS(n) {while(k<(n)){b|=((ulg)NEXTBYTE())<<k;k+=8;}}
 223 #define DUMPBITS(n) {b>>=(n);k-=(n);}
 224
 225
 226 /*
 227    Huffman code decoding is performed using a multi-level table lookup.
 228    The fastest way to decode is to simply build a lookup table whose
 229    size is determined by the longest code.  However, the time it takes
 230    to build this table can also be a factor if the data being decoded
 231    is not very long.  The most common codes are necessarily the
 232    shortest codes, so those codes dominate the decoding time, and hence
 233    the speed.  The idea is you can have a shorter table that decodes the
 234    shorter, more probable codes, and then point to subsidiary tables for
 235    the longer codes.  The time it costs to decode the longer codes is
 236    then traded against the time it takes to make longer tables.
 237
 238    This results of this trade are in the variables lbits and dbits
 239    below.  lbits is the number of bits the first level table for literal/
 240    length codes can decode in one step, and dbits is the same thing for
 241    the distance codes.  Subsequent tables are also less than or equal to
 242    those sizes.  These values may be adjusted either when all of the
 243    codes are shorter than that, in which case the longest code length in
 244    bits is used, or when the shortest code is *longer* than the requested
 245    table size, in which case the length of the shortest code in bits is
 246    used.
 247
 248    There are two different values for the two tables, since they code a
 249    different number of possibilities each.  The literal/length table
 250    codes 286 possible values, or in a flat code, a little over eight
 251    bits.  The distance table codes 30 possible values, or a little less
 252    than five bits, flat.  The optimum values for speed end up being
 253    about one bit more than those, so lbits is 8+1 and dbits is 5+1.
 254    The optimum values may differ though from machine to machine, and
 255    possibly even between compilers.  Your mileage may vary.
 256  */
 257
 258
 259 int lbits = 9;          /* bits in base literal/length lookup table */
 260 int dbits = 6;          /* bits in base distance lookup table */
 261
 262
 263 /* If BMAX needs to be larger than 16, then h and x[] should be ulg. */
 264 #define BMAX 16         /* maximum bit length of any code (16 for explode) */
 265 #define N_MAX 288       /* maximum number of codes in any set */
 266
 267
 268 unsigned hufts;         /* track memory usage */
 269
 270
 271 int huft_build(b, n, s, d, e, t, m)
 272 unsigned *b;            /* code lengths in bits (all assumed <= BMAX) */
 273 unsigned n;             /* number of codes (assumed <= N_MAX) */
 274 unsigned s;             /* number of simple-valued codes (0..s-1) */
 275 ush *d;                 /* list of base values for non-simple codes */
 276 ush *e;                 /* list of extra bits for non-simple codes */
 277 struct huft **t;        /* result: starting table */
 278 int *m;                 /* maximum lookup bits, returns actual */
 279 /* Given a list of code lengths and a maximum table size, make a set of
 280    tables to decode that set of codes.  Return zero on success, one if
 281    the given code set is incomplete (the tables are still built in this
 282    case), two if the input is invalid (all zero length codes or an
 283    oversubscribed set of lengths), and three if not enough memory. */
 284 {
 285   unsigned a;                   /* counter for codes of length k */
 286   unsigned c[BMAX+1];           /* bit length count table */
 287   unsigned f;                   /* i repeats in table every f entries */
 288   int g;                        /* maximum code length */
 289   int h;                        /* table level */
 290   register unsigned i;          /* counter, current code */
 291   register unsigned j;          /* counter */
 292   register int k;               /* number of bits in current code */
 293   int l;                        /* bits per table (returned in m) */
 294   register unsigned *p;         /* pointer into c[], b[], or v[] */
 295   register struct huft *q;      /* points to current table */
 296   struct huft r;                /* table entry for structure assignment */
 297   struct huft *u[BMAX];         /* table stack */
 298   unsigned v[N_MAX];            /* values in order of bit length */
 299   register int w;               /* bits before this table == (l * h) */
 300   unsigned x[BMAX+1];           /* bit offsets, then code stack */
 301   unsigned *xp;                 /* pointer into x */
 302   int y;                        /* number of dummy codes added */
 303   unsigned z;                   /* number of entries in current table */
 304
 305
 306   /* Generate counts for each bit length */
 307   memzero(c, sizeof(c));
 308   p = b;  i = n;
 309   do {
 310     Tracecv(*p, (stderr, (n-i >= ' ' && n-i <= '~' ? "%c %d\n" : "0x%x %d\n"),
 311             n-i, *p));
 312     c[*p]++;                    /* assume all entries <= BMAX */
 313     p++;                      /* Can't combine with above line (Solaris bug) */
 314   } while (--i);
 315   if (c[0] == n)                /* null input--all zero length codes */
 316   {
 317     *t = (struct huft *)NULL;
 318     *m = 0;
 319     return 0;
 320   }
 321
 322
 323   /* Find minimum and maximum length, bound *m by those */
 324   l = *m;
 325   for (j = 1; j <= BMAX; j++)
 326     if (c[j])
 327       break;
 328   k = j;                        /* minimum code length */
 329   if ((unsigned)l < j)
 330     l = j;
 331   for (i = BMAX; i; i--)
 332     if (c[i])
 333       break;
 334   g = i;                        /* maximum code length */
 335   if ((unsigned)l > i)
 336     l = i;
 337   *m = l;
 338
 339
 340   /* Adjust last length count to fill out codes, if needed */
 341   for (y = 1 << j; j < i; j++, y <<= 1)
 342     if ((y -= c[j]) < 0)
 343       return 2;                 /* bad input: more codes than bits */
 344   if ((y -= c[i]) < 0)
 345     return 2;
 346   c[i] += y;
 347
 348
 349   /* Generate starting offsets into the value table for each length */
 350   x[1] = j = 0;
 351   p = c + 1;  xp = x + 2;
 352   while (--i) {                 /* note that i == g from above */
 353     *xp++ = (j += *p++);
 354   }
 355
 356
 357   /* Make a table of values in order of bit lengths */
 358   p = b;  i = 0;
 359   do {
 360     if ((j = *p++) != 0)
 361       v[x[j]++] = i;
 362   } while (++i < n);
 363   n = x[g];                   /* set n to length of v */
 364
 365
 366   /* Generate the Huffman codes and for each, make the table entries */
 367   x[0] = i = 0;                 /* first Huffman code is zero */
 368   p = v;                        /* grab values in bit order */
 369   h = -1;                       /* no tables yet--level -1 */
 370   w = -l;                       /* bits decoded == (l * h) */
 371   u[0] = (struct huft *)NULL;   /* just to keep compilers happy */
 372   q = (struct huft *)NULL;      /* ditto */
 373   z = 0;                        /* ditto */
 374
 375   /* go through the bit lengths (k already is bits in shortest code) */
 376   for (; k <= g; k++)
 377   {
 378     a = c[k];
 379     while (a--)
 380     {
 381       /* here i is the Huffman code of length k bits for value *p */
 382       /* make tables up to required level */
 383       while (k > w + l)
 384       {
 385         h++;
 386         w += l;                 /* previous table always l bits */
 387
 388         /* compute minimum size table less than or equal to l bits */
 389         z = (z = g - w) > (unsigned)l ? l : z;  /* upper limit on table size */
 390         if ((f = 1 << (j = k - w)) > a + 1)     /* try a k-w bit table */
 391         {                       /* too few codes for k-w bit table */
 392           f -= a + 1;           /* deduct codes from patterns left */
 393           xp = c + k;
 394           if (j < z)
 395             while (++j < z)       /* try smaller tables up to z bits */
 396             {
 397               if ((f <<= 1) <= *++xp)
 398                 break;            /* enough codes to use up j bits */
 399               f -= *xp;           /* else deduct codes from patterns */
 400             }
 401         }
 402         z = 1 << j;             /* table entries for j-bit table */
 403
 404         /* allocate and link in new table */
 405         if ((q = (struct huft *)malloc((z + 1)*sizeof(struct huft))) ==
 406             (struct huft *)NULL)
 407         {
 408           if (h)
 409             huft_free(u[0]);
 410           return 3;             /* not enough memory */
 411         }
 412         hufts += z + 1;         /* track memory usage */
 413         *t = q + 1;             /* link to list for huft_free() */
 414         *(t = &(q->v.t)) = (struct huft *)NULL;
 415         u[h] = ++q;             /* table starts after link */
 416
 417         /* connect to last table, if there is one */
 418         if (h)
 419         {
 420           x[h] = i;             /* save pattern for backing up */
 421           r.b = (uch)l;         /* bits to dump before this table */
 422           r.e = (uch)(16 + j);  /* bits in this table */
 423           r.v.t = q;            /* pointer to this table */
 424           j = i >> (w - l);     /* (get around Turbo C bug) */
 425           u[h-1][j] = r;        /* connect to last table */
 426         }
 427       }
 428
 429       /* set up table entry in r */
 430       r.b = (uch)(k - w);
 431       if (p >= v + n)
 432         r.e = 99;               /* out of values--invalid code */
 433       else if (*p < s)
 434       {
 435         r.e = (uch)(*p < 256 ? 16 : 15);    /* 256 is end-of-block code */
 436         r.v.n = (ush)(*p);             /* simple code is just the value */
 437         p++;                           /* one compiler does not like *p++ */
 438       }
 439       else
 440       {
 441         r.e = (uch)e[*p - s];   /* non-simple--look up in lists */
 442         r.v.n = d[*p++ - s];
 443       }
 444
 445       /* fill code-like entries with r */
 446       f = 1 << (k - w);
 447       for (j = i >> w; j < z; j += f)
 448         q[j] = r;
 449
 450       /* backwards increment the k-bit code i */
 451       for (j = 1 << (k - 1); i & j; j >>= 1)
 452         i ^= j;
 453       i ^= j;
 454
 455       /* backup over finished tables */
 456       while ((i & ((1 << w) - 1)) != x[h])
 457       {
 458         h--;                    /* don't need to update q */
 459         w -= l;
 460       }
 461     }
 462   }
 463
 464
 465   /* Return true (1) if we were given an incomplete table */
 466   return y != 0 && g != 1;
 467 }
 468
 469
 470
 471 int huft_free(t)
 472 struct huft *t;         /* table to free */
 473 /* Free the malloc'ed tables built by huft_build(), which makes a linked
 474    list of the tables it made, with the links in a dummy first entry of
 475    each table. */
 476 {
 477   register struct huft *p, *q;
 478
 479
 480   /* Go through linked list, freeing from the malloced (t[-1]) address. */
 481   p = t;
 482   while (p != (struct huft *)NULL)
 483   {
 484     q = (--p)->v.t;
 485     free((char*)p);
 486     p = q;
 487   }
 488   return 0;
 489 }
 490
 491
 492 int inflate_codes(tl, td, bl, bd)
 493 struct huft *tl, *td;   /* literal/length and distance decoder tables */
 494 int bl, bd;             /* number of bits decoded by tl[] and td[] */
 495 /* inflate (decompress) the codes in a deflated (compressed) block.
 496    Return an error code or zero if it all goes ok. */
 497 {
 498   register unsigned e;  /* table entry flag/number of extra bits */
 499   unsigned n, d;        /* length and index for copy */
 500   unsigned w;           /* current window position */
 501   struct huft *t;       /* pointer to table entry */
 502   unsigned ml, md;      /* masks for bl and bd bits */
 503   register ulg b;       /* bit buffer */
 504   register unsigned k;  /* number of bits in bit buffer */
 505
 506
 507   /* make local copies of globals */
 508   b = bb;                       /* initialize bit buffer */
 509   k = bk;
 510   w = wp;                       /* initialize window position */
 511
 512   /* inflate the coded data */
 513   ml = mask_bits[bl];           /* precompute masks for speed */
 514   md = mask_bits[bd];
 515   for (;;)                      /* do until end of block */
 516   {
 517     NEEDBITS((unsigned)bl)
 518     if ((e = (t = tl + ((unsigned)b & ml))->e) > 16)
 519       do {
 520         if (e == 99)
 521           return 1;
 522         DUMPBITS(t->b)
 523         e -= 16;
 524         NEEDBITS(e)
 525       } while ((e = (t = t->v.t + ((unsigned)b & mask_bits[e]))->e) > 16);
 526     DUMPBITS(t->b)
 527     if (e == 16)                /* then it's a literal */
 528     {
 529       slide[w++] = (uch)t->v.n;
 530       Tracevv((stderr, "%c", slide[w-1]));
 531       if (w == WSIZE)
 532       {
 533         flush_output(w);
 534         w = 0;
 535       }
 536     }
 537     else                        /* it's an EOB or a length */
 538     {
 539       /* exit if end of block */
 540       if (e == 15)
 541         break;
 542
 543       /* get length of block to copy */
 544       NEEDBITS(e)
 545       n = t->v.n + ((unsigned)b & mask_bits[e]);
 546       DUMPBITS(e);
 547
 548       /* decode distance of block to copy */
 549       NEEDBITS((unsigned)bd)
 550       if ((e = (t = td + ((unsigned)b & md))->e) > 16)
 551         do {
 552           if (e == 99)
 553             return 1;
 554           DUMPBITS(t->b)
 555           e -= 16;
 556           NEEDBITS(e)
 557         } while ((e = (t = t->v.t + ((unsigned)b & mask_bits[e]))->e) > 16);
 558       DUMPBITS(t->b)
 559       NEEDBITS(e)
 560       d = w - t->v.n - ((unsigned)b & mask_bits[e]);
 561       DUMPBITS(e)
 562       Tracevv((stderr,"\\[%d,%d]", w-d, n));
 563
 564       /* do the copy */
 565       do {
 566         n -= (e = (e = WSIZE - ((d &= WSIZE-1) > w ? d : w)) > n ? n : e);
 567 #if !defined(NOMEMCPY) && !defined(DEBUG)
 568         if (w - d >= e)         /* (this test assumes unsigned comparison) */
 569         {
 570           memcpy(slide + w, slide + d, e);
 571           w += e;
 572           d += e;
 573         }
 574         else                      /* do it slow to avoid memcpy() overlap */
 575 #endif /* !NOMEMCPY */
 576           do {
 577             slide[w++] = slide[d++];
 578             Tracevv((stderr, "%c", slide[w-1]));
 579           } while (--e);
 580         if (w == WSIZE)
 581         {
 582           flush_output(w);
 583           w = 0;
 584         }
 585       } while (n);
 586     }
 587   }
 588
 589
 590   /* restore the globals from the locals */
 591   wp = w;                       /* restore global window pointer */
 592   bb = b;                       /* restore global bit buffer */
 593   bk = k;
 594
 595   /* done */
 596   return 0;
 597 }
 598
 599
 600
 601 int inflate_stored()
 602 /* "decompress" an inflated type 0 (stored) block. */
 603 {
 604   unsigned n;           /* number of bytes in block */
 605   unsigned w;           /* current window position */
 606   register ulg b;       /* bit buffer */
 607   register unsigned k;  /* number of bits in bit buffer */
 608
 609
 610   /* make local copies of globals */
 611   b = bb;                       /* initialize bit buffer */
 612   k = bk;
 613   w = wp;                       /* initialize window position */
 614
 615
 616   /* go to byte boundary */
 617   n = k & 7;
 618   DUMPBITS(n);
 619
 620
 621   /* get the length and its complement */
 622   NEEDBITS(16)
 623   n = ((unsigned)b & 0xffff);
 624   DUMPBITS(16)
 625   NEEDBITS(16)
 626   if (n != (unsigned)((~b) & 0xffff))
 627     return 1;                   /* error in compressed data */
 628   DUMPBITS(16)
 629
 630
 631   /* read and output the compressed data */
 632   while (n--)
 633   {
 634     NEEDBITS(8)
 635     slide[w++] = (uch)b;
 636     if (w == WSIZE)
 637     {
 638       flush_output(w);
 639       w = 0;
 640     }
 641     DUMPBITS(8)
 642   }
 643
 644
 645   /* restore the globals from the locals */
 646   wp = w;                       /* restore global window pointer */
 647   bb = b;                       /* restore global bit buffer */
 648   bk = k;
 649   return 0;
 650 }
 651
 652
 653
 654 int inflate_fixed()
 655 /* decompress an inflated type 1 (fixed Huffman codes) block.  We should
 656    either replace this with a custom decoder, or at least precompute the
 657    Huffman tables. */
 658 {
 659   int i;                /* temporary variable */
 660   struct huft *tl;      /* literal/length code table */
 661   struct huft *td;      /* distance code table */
 662   int bl;               /* lookup bits for tl */
 663   int bd;               /* lookup bits for td */
 664   unsigned l[288];      /* length list for huft_build */
 665
 666
 667   /* set up literal table */
 668   for (i = 0; i < 144; i++)
 669     l[i] = 8;
 670   for (; i < 256; i++)
 671     l[i] = 9;
 672   for (; i < 280; i++)
 673     l[i] = 7;
 674   for (; i < 288; i++)          /* make a complete, but wrong code set */
 675     l[i] = 8;
 676   bl = 7;
 677   if ((i = huft_build(l, 288, 257, cplens, cplext, &tl, &bl)) != 0)
 678     return i;
 679
 680
 681   /* set up distance table */
 682   for (i = 0; i < 30; i++)      /* make an incomplete code set */
 683     l[i] = 5;
 684   bd = 5;
 685   if ((i = huft_build(l, 30, 0, cpdist, cpdext, &td, &bd)) > 1)
 686   {
 687     huft_free(tl);
 688     return i;
 689   }
 690
 691
 692   /* decompress until an end-of-block code */
 693   if (inflate_codes(tl, td, bl, bd))
 694     return 1;
 695
 696
 697   /* free the decoding tables, return */
 698   huft_free(tl);
 699   huft_free(td);
 700   return 0;
 701 }
 702
 703
 704
 705 int inflate_dynamic()
 706 /* decompress an inflated type 2 (dynamic Huffman codes) block. */
 707 {
 708   int i;                /* temporary variables */
 709   unsigned j;
 710   unsigned l;           /* last length */
 711   unsigned m;           /* mask for bit lengths table */
 712   unsigned n;           /* number of lengths to get */
 713   struct huft *tl;      /* literal/length code table */
 714   struct huft *td;      /* distance code table */
 715   int bl;               /* lookup bits for tl */
 716   int bd;               /* lookup bits for td */
 717   unsigned nb;          /* number of bit length codes */
 718   unsigned nl;          /* number of literal/length codes */
 719   unsigned nd;          /* number of distance codes */
 720 #ifdef PKZIP_BUG_WORKAROUND
 721   unsigned ll[288+32];  /* literal/length and distance code lengths */
 722 #else
 723   unsigned ll[286+30];  /* literal/length and distance code lengths */
 724 #endif
 725   register ulg b;       /* bit buffer */
 726   register unsigned k;  /* number of bits in bit buffer */
 727
 728
 729   /* make local bit buffer */
 730   b = bb;
 731   k = bk;
 732
 733
 734   /* read in table lengths */
 735   NEEDBITS(5)
 736   nl = 257 + ((unsigned)b & 0x1f);      /* number of literal/length codes */
 737   DUMPBITS(5)
 738   NEEDBITS(5)
 739   nd = 1 + ((unsigned)b & 0x1f);        /* number of distance codes */
 740   DUMPBITS(5)
 741   NEEDBITS(4)
 742   nb = 4 + ((unsigned)b & 0xf);         /* number of bit length codes */
 743   DUMPBITS(4)
 744 #ifdef PKZIP_BUG_WORKAROUND
 745   if (nl > 288 || nd > 32)
 746 #else
 747   if (nl > 286 || nd > 30)
 748 #endif
 749     return 1;                   /* bad lengths */
 750
 751
 752   /* read in bit-length-code lengths */
 753   for (j = 0; j < nb; j++)
 754   {
 755     NEEDBITS(3)
 756     ll[border[j]] = (unsigned)b & 7;
 757     DUMPBITS(3)
 758   }
 759   for (; j < 19; j++)
 760     ll[border[j]] = 0;
 761
 762
 763   /* build decoding table for trees--single level, 7 bit lookup */
 764   bl = 7;
 765   if ((i = huft_build(ll, 19, 19, NULL, NULL, &tl, &bl)) != 0)
 766   {
 767     if (i == 1)
 768       huft_free(tl);
 769     return i;                   /* incomplete code set */
 770   }
 771
 772   if (tl == NULL) /* Grrrhhh */
 773         return 2;
 774
 775   /* read in literal and distance code lengths */
 776   n = nl + nd;
 777   m = mask_bits[bl];
 778   i = l = 0;
 779   while ((unsigned)i < n)
 780   {
 781     NEEDBITS((unsigned)bl)
 782     j = (td = tl + ((unsigned)b & m))->b;
 783     DUMPBITS(j)
 784     j = td->v.n;
 785     if (j < 16)                 /* length of code in bits (0..15) */
 786       ll[i++] = l = j;          /* save last length in l */
 787     else if (j == 16)           /* repeat last length 3 to 6 times */
 788     {
 789       NEEDBITS(2)
 790       j = 3 + ((unsigned)b & 3);
 791       DUMPBITS(2)
 792       if ((unsigned)i + j > n)
 793         return 1;
 794       while (j--)
 795         ll[i++] = l;
 796     }
 797     else if (j == 17)           /* 3 to 10 zero length codes */
 798     {
 799       NEEDBITS(3)
 800       j = 3 + ((unsigned)b & 7);
 801       DUMPBITS(3)
 802       if ((unsigned)i + j > n)
 803         return 1;
 804       while (j--)
 805         ll[i++] = 0;
 806       l = 0;
 807     }
 808     else                        /* j == 18: 11 to 138 zero length codes */
 809     {
 810       NEEDBITS(7)
 811       j = 11 + ((unsigned)b & 0x7f);
 812       DUMPBITS(7)
 813       if ((unsigned)i + j > n)
 814         return 1;
 815       while (j--)
 816         ll[i++] = 0;
 817       l = 0;
 818     }
 819   }
 820
 821
 822   /* free decoding table for trees */
 823   huft_free(tl);
 824
 825
 826   /* restore the global bit buffer */
 827   bb = b;
 828   bk = k;
 829
 830
 831   /* build the decoding tables for literal/length and distance codes */
 832   bl = lbits;
 833   if ((i = huft_build(ll, nl, 257, cplens, cplext, &tl, &bl)) != 0)
 834   {
 835     if (i == 1) {
 836       fprintf(stderr, " incomplete literal tree\n");
 837       huft_free(tl);
 838     }
 839     return i;                   /* incomplete code set */
 840   }
 841   bd = dbits;
 842   if ((i = huft_build(ll + nl, nd, 0, cpdist, cpdext, &td, &bd)) != 0)
 843   {
 844     if (i == 1) {
 845       fprintf(stderr, " incomplete distance tree\n");
 846 #ifdef PKZIP_BUG_WORKAROUND
 847       i = 0;
 848     }
 849 #else
 850       huft_free(td);
 851     }
 852     huft_free(tl);
 853     return i;                   /* incomplete code set */
 854 #endif
 855   }
 856
 857
 858   /* decompress until an end-of-block code */
 859   if (inflate_codes(tl, td, bl, bd))
 860     return 1;
 861
 862
 863   /* free the decoding tables, return */
 864   huft_free(tl);
 865   huft_free(td);
 866   return 0;
 867 }
 868
 869
 870
 871 int inflate_block(e)
 872 int *e;                 /* last block flag */
 873 /* decompress an inflated block */
 874 {
 875   unsigned t;           /* block type */
 876   register ulg b;       /* bit buffer */
 877   register unsigned k;  /* number of bits in bit buffer */
 878
 879
 880   /* make local bit buffer */
 881   b = bb;
 882   k = bk;
 883
 884
 885   /* read in last block bit */
 886   NEEDBITS(1)
 887   *e = (int)b & 1;
 888   DUMPBITS(1)
 889
 890
 891   /* read in block type */
 892   NEEDBITS(2)
 893   t = (unsigned)b & 3;
 894   DUMPBITS(2)
 895
 896
 897   /* restore the global bit buffer */
 898   bb = b;
 899   bk = k;
 900
 901
 902   /* inflate that block type */
 903   if (t == 2)
 904     return inflate_dynamic();
 905   if (t == 0)
 906     return inflate_stored();
 907   if (t == 1)
 908     return inflate_fixed();
 909
 910
 911   /* bad block type */
 912   return 2;
 913 }
 914
 915
 916
 917 int inflate()
 918 /* decompress an inflated entry */
 919 {
 920   int e;                /* last block flag */
 921   int r;                /* result code */
 922   unsigned h;           /* maximum struct huft's malloc'ed */
 923
 924
 925   /* initialize window, bit buffer */
 926   wp = 0;
 927   bk = 0;
 928   bb = 0;
 929
 930
 931   /* decompress until the last block */
 932   h = 0;
 933   do {
 934     hufts = 0;
 935     if ((r = inflate_block(&e)) != 0)
 936       return r;
 937     if (hufts > h)
 938       h = hufts;
 939   } while (!e);
 940
 941   /* Undo too much lookahead. The next read will be byte aligned so we
 942    * can discard unused bits in the last meaningful byte.
 943    */
 944   while (bk >= 8) {
 945     bk -= 8;
 946     inptr--;
 947   }
 948
 949   /* flush out slide */
 950   flush_output(wp);
 951
 952
 953   /* return success */
 954 #ifdef DEBUG
 955   fprintf(stderr, "<%u> ", h);
 956 #endif /* DEBUG */
 957   return 0;
 958 }