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