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