maint: limit scope of several functions
[gzip.git] / inflate.c
blobd7dbebeb1ca45c9d4331a0feed782a904bbb7e32
1 /* Inflate deflated data
3 Copyright (C) 1997-1999, 2002, 2006, 2009-2011 Free Software Foundation,
4 Inc.
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.
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.
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. */
20 /* Not copyrighted 1992 by Mark Adler
21 version c10p1, 10 January 1993 */
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.]
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.
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.
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.
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.
74 Notes beyond the 1.93a appnote.txt:
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.
118 #include <config.h>
119 #include "tailor.h"
121 #include <stdlib.h>
123 #include "gzip.h"
124 #define slide window
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;
143 /* Function prototypes */
144 static int huft_free (struct huft *);
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())
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};
180 /* Macros for inflate() bit peeking and grabbing.
181 The usage is:
183 NEEDBITS(j)
184 x = b & mask_bits[j];
185 DUMPBITS(j)
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.
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.
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.
211 ulg bb; /* bit buffer */
212 unsigned bk; /* bits in bit buffer */
214 ush mask_bits[] = {
215 0x0000,
216 0x0001, 0x0003, 0x0007, 0x000f, 0x001f, 0x003f, 0x007f, 0x00ff,
217 0x01ff, 0x03ff, 0x07ff, 0x0fff, 0x1fff, 0x3fff, 0x7fff, 0xffff
220 #define GETBYTE() (inptr < insize ? inbuf[inptr++] : (wp = w, fill_inbuf(0)))
222 #ifdef CRYPT
223 uch cc;
224 # define NEXTBYTE() \
225 (decrypt ? (cc = GETBYTE(), zdecode(cc), cc) : GETBYTE())
226 #else
227 # define NEXTBYTE() (uch)GETBYTE()
228 #endif
229 #define NEEDBITS(n) {while(k<(n)){b|=((ulg)NEXTBYTE())<<k;k+=8;}}
230 #define DUMPBITS(n) {b>>=(n);k-=(n);}
234 Huffman code decoding is performed using a multi-level table lookup.
235 The fastest way to decode is to simply build a lookup table whose
236 size is determined by the longest code. However, the time it takes
237 to build this table can also be a factor if the data being decoded
238 is not very long. The most common codes are necessarily the
239 shortest codes, so those codes dominate the decoding time, and hence
240 the speed. The idea is you can have a shorter table that decodes the
241 shorter, more probable codes, and then point to subsidiary tables for
242 the longer codes. The time it costs to decode the longer codes is
243 then traded against the time it takes to make longer tables.
245 This results of this trade are in the variables lbits and dbits
246 below. lbits is the number of bits the first level table for literal/
247 length codes can decode in one step, and dbits is the same thing for
248 the distance codes. Subsequent tables are also less than or equal to
249 those sizes. These values may be adjusted either when all of the
250 codes are shorter than that, in which case the longest code length in
251 bits is used, or when the shortest code is *longer* than the requested
252 table size, in which case the length of the shortest code in bits is
253 used.
255 There are two different values for the two tables, since they code a
256 different number of possibilities each. The literal/length table
257 codes 286 possible values, or in a flat code, a little over eight
258 bits. The distance table codes 30 possible values, or a little less
259 than five bits, flat. The optimum values for speed end up being
260 about one bit more than those, so lbits is 8+1 and dbits is 5+1.
261 The optimum values may differ though from machine to machine, and
262 possibly even between compilers. Your mileage may vary.
266 int lbits = 9; /* bits in base literal/length lookup table */
267 int dbits = 6; /* bits in base distance lookup table */
270 /* If BMAX needs to be larger than 16, then h and x[] should be ulg. */
271 #define BMAX 16 /* maximum bit length of any code (16 for explode) */
272 #define N_MAX 288 /* maximum number of codes in any set */
275 unsigned hufts; /* track memory usage */
278 static int
279 huft_build(
280 unsigned *b, /* code lengths in bits (all assumed <= BMAX) */
281 unsigned n, /* number of codes (assumed <= N_MAX) */
282 unsigned s, /* number of simple-valued codes (0..s-1) */
283 ush *d, /* list of base values for non-simple codes */
284 ush *e, /* list of extra bits for non-simple codes */
285 struct huft **t, /* result: starting table */
286 int *m /* maximum lookup bits, returns actual */
288 /* Given a list of code lengths and a maximum table size, make a set of
289 tables to decode that set of codes. Return zero on success, one if
290 the given code set is incomplete (the tables are still built in this
291 case), two if the input is invalid (all zero length codes or an
292 oversubscribed set of lengths), and three if not enough memory. */
294 unsigned a; /* counter for codes of length k */
295 unsigned c[BMAX+1]; /* bit length count table */
296 unsigned f; /* i repeats in table every f entries */
297 int g; /* maximum code length */
298 int h; /* table level */
299 register unsigned i; /* counter, current code */
300 register unsigned j; /* counter */
301 register int k; /* number of bits in current code */
302 int l; /* bits per table (returned in m) */
303 register unsigned *p; /* pointer into c[], b[], or v[] */
304 register struct huft *q; /* points to current table */
305 struct huft r; /* table entry for structure assignment */
306 struct huft *u[BMAX]; /* table stack */
307 unsigned v[N_MAX]; /* values in order of bit length */
308 register int w; /* bits before this table == (l * h) */
309 unsigned x[BMAX+1]; /* bit offsets, then code stack */
310 unsigned *xp; /* pointer into x */
311 int y; /* number of dummy codes added */
312 unsigned z; /* number of entries in current table */
315 /* Generate counts for each bit length */
316 memzero(c, sizeof(c));
317 p = b; i = n;
318 do {
319 Tracecv(*p, (stderr, (n-i >= ' ' && n-i <= '~' ? "%c %d\n" : "0x%x %d\n"),
320 n-i, *p));
321 c[*p]++; /* assume all entries <= BMAX */
322 p++; /* Can't combine with above line (Solaris bug) */
323 } while (--i);
324 if (c[0] == n) /* null input--all zero length codes */
326 q = (struct huft *) malloc (3 * sizeof *q);
327 if (!q)
328 return 3;
329 hufts += 3;
330 q[0].v.t = (struct huft *) NULL;
331 q[1].e = 99; /* invalid code marker */
332 q[1].b = 1;
333 q[2].e = 99; /* invalid code marker */
334 q[2].b = 1;
335 *t = q + 1;
336 *m = 1;
337 return 0;
341 /* Find minimum and maximum length, bound *m by those */
342 l = *m;
343 for (j = 1; j <= BMAX; j++)
344 if (c[j])
345 break;
346 k = j; /* minimum code length */
347 if ((unsigned)l < j)
348 l = j;
349 for (i = BMAX; i; i--)
350 if (c[i])
351 break;
352 g = i; /* maximum code length */
353 if ((unsigned)l > i)
354 l = i;
355 *m = l;
358 /* Adjust last length count to fill out codes, if needed */
359 for (y = 1 << j; j < i; j++, y <<= 1)
360 if ((y -= c[j]) < 0)
361 return 2; /* bad input: more codes than bits */
362 if ((y -= c[i]) < 0)
363 return 2;
364 c[i] += y;
367 /* Generate starting offsets into the value table for each length */
368 x[1] = j = 0;
369 p = c + 1; xp = x + 2;
370 while (--i) { /* note that i == g from above */
371 *xp++ = (j += *p++);
375 /* Make a table of values in order of bit lengths */
376 p = b; i = 0;
377 do {
378 if ((j = *p++) != 0)
379 v[x[j]++] = i;
380 } while (++i < n);
381 n = x[g]; /* set n to length of v */
384 /* Generate the Huffman codes and for each, make the table entries */
385 x[0] = i = 0; /* first Huffman code is zero */
386 p = v; /* grab values in bit order */
387 h = -1; /* no tables yet--level -1 */
388 w = -l; /* bits decoded == (l * h) */
389 u[0] = (struct huft *)NULL; /* just to keep compilers happy */
390 q = (struct huft *)NULL; /* ditto */
391 z = 0; /* ditto */
393 /* go through the bit lengths (k already is bits in shortest code) */
394 for (; k <= g; k++)
396 a = c[k];
397 while (a--)
399 /* here i is the Huffman code of length k bits for value *p */
400 /* make tables up to required level */
401 while (k > w + l)
403 h++;
404 w += l; /* previous table always l bits */
406 /* compute minimum size table less than or equal to l bits */
407 z = (z = g - w) > (unsigned)l ? l : z; /* upper limit on table size */
408 if ((f = 1 << (j = k - w)) > a + 1) /* try a k-w bit table */
409 { /* too few codes for k-w bit table */
410 f -= a + 1; /* deduct codes from patterns left */
411 xp = c + k;
412 if (j < z)
413 while (++j < z) /* try smaller tables up to z bits */
415 if ((f <<= 1) <= *++xp)
416 break; /* enough codes to use up j bits */
417 f -= *xp; /* else deduct codes from patterns */
420 z = 1 << j; /* table entries for j-bit table */
422 /* allocate and link in new table */
423 if ((q = (struct huft *)malloc((z + 1)*sizeof(struct huft))) ==
424 (struct huft *)NULL)
426 if (h)
427 huft_free(u[0]);
428 return 3; /* not enough memory */
430 hufts += z + 1; /* track memory usage */
431 *t = q + 1; /* link to list for huft_free() */
432 *(t = &(q->v.t)) = (struct huft *)NULL;
433 u[h] = ++q; /* table starts after link */
435 /* connect to last table, if there is one */
436 if (h)
438 x[h] = i; /* save pattern for backing up */
439 r.b = (uch)l; /* bits to dump before this table */
440 r.e = (uch)(16 + j); /* bits in this table */
441 r.v.t = q; /* pointer to this table */
442 j = i >> (w - l); /* (get around Turbo C bug) */
443 u[h-1][j] = r; /* connect to last table */
447 /* set up table entry in r */
448 r.b = (uch)(k - w);
449 if (p >= v + n)
450 r.e = 99; /* out of values--invalid code */
451 else if (*p < s)
453 r.e = (uch)(*p < 256 ? 16 : 15); /* 256 is end-of-block code */
454 r.v.n = (ush)(*p); /* simple code is just the value */
455 p++; /* one compiler does not like *p++ */
457 else
459 r.e = (uch)e[*p - s]; /* non-simple--look up in lists */
460 r.v.n = d[*p++ - s];
463 /* fill code-like entries with r */
464 f = 1 << (k - w);
465 for (j = i >> w; j < z; j += f)
466 q[j] = r;
468 /* backwards increment the k-bit code i */
469 for (j = 1 << (k - 1); i & j; j >>= 1)
470 i ^= j;
471 i ^= j;
473 /* backup over finished tables */
474 while ((i & ((1 << w) - 1)) != x[h])
476 h--; /* don't need to update q */
477 w -= l;
483 /* Return true (1) if we were given an incomplete table */
484 return y != 0 && g != 1;
489 /* Free the malloc'ed tables T built by huft_build(), which makes a linked
490 list of the tables it made, with the links in a dummy first entry of
491 each table. */
492 static int
493 huft_free(struct huft *t)
495 register struct huft *p, *q;
498 /* Go through linked list, freeing from the malloced (t[-1]) address. */
499 p = t;
500 while (p != (struct huft *)NULL)
502 q = (--p)->v.t;
503 free(p);
504 p = q;
506 return 0;
510 /* tl, td: literal/length and distance decoder tables */
511 /* bl, bd: number of bits decoded by tl[] and td[] */
512 /* inflate (decompress) the codes in a deflated (compressed) block.
513 Return an error code or zero if it all goes ok. */
514 static int
515 inflate_codes(struct huft *tl, struct huft *td, int bl, int bd)
517 register unsigned e; /* table entry flag/number of extra bits */
518 unsigned n, d; /* length and index for copy */
519 unsigned w; /* current window position */
520 struct huft *t; /* pointer to table entry */
521 unsigned ml, md; /* masks for bl and bd bits */
522 register ulg b; /* bit buffer */
523 register unsigned k; /* number of bits in bit buffer */
526 /* make local copies of globals */
527 b = bb; /* initialize bit buffer */
528 k = bk;
529 w = wp; /* initialize window position */
531 /* inflate the coded data */
532 ml = mask_bits[bl]; /* precompute masks for speed */
533 md = mask_bits[bd];
534 for (;;) /* do until end of block */
536 NEEDBITS((unsigned)bl)
537 if ((e = (t = tl + ((unsigned)b & ml))->e) > 16)
538 do {
539 if (e == 99)
540 return 1;
541 DUMPBITS(t->b)
542 e -= 16;
543 NEEDBITS(e)
544 } while ((e = (t = t->v.t + ((unsigned)b & mask_bits[e]))->e) > 16);
545 DUMPBITS(t->b)
546 if (e == 16) /* then it's a literal */
548 slide[w++] = (uch)t->v.n;
549 Tracevv((stderr, "%c", slide[w-1]));
550 if (w == WSIZE)
552 flush_output(w);
553 w = 0;
556 else /* it's an EOB or a length */
558 /* exit if end of block */
559 if (e == 15)
560 break;
562 /* get length of block to copy */
563 NEEDBITS(e)
564 n = t->v.n + ((unsigned)b & mask_bits[e]);
565 DUMPBITS(e);
567 /* decode distance of block to copy */
568 NEEDBITS((unsigned)bd)
569 if ((e = (t = td + ((unsigned)b & md))->e) > 16)
570 do {
571 if (e == 99)
572 return 1;
573 DUMPBITS(t->b)
574 e -= 16;
575 NEEDBITS(e)
576 } while ((e = (t = t->v.t + ((unsigned)b & mask_bits[e]))->e) > 16);
577 DUMPBITS(t->b)
578 NEEDBITS(e)
579 d = w - t->v.n - ((unsigned)b & mask_bits[e]);
580 DUMPBITS(e)
581 Tracevv((stderr,"\\[%d,%d]", w-d, n));
583 /* do the copy */
584 do {
585 n -= (e = (e = WSIZE - ((d &= WSIZE-1) > w ? d : w)) > n ? n : e);
586 #ifndef DEBUG
587 if (e <= (d < w ? w - d : d - w))
589 memcpy(slide + w, slide + d, e);
590 w += e;
591 d += e;
593 else /* do it slow to avoid memcpy() overlap */
594 #endif
595 do {
596 slide[w++] = slide[d++];
597 Tracevv((stderr, "%c", slide[w-1]));
598 } while (--e);
599 if (w == WSIZE)
601 flush_output(w);
602 w = 0;
604 } while (n);
609 /* restore the globals from the locals */
610 wp = w; /* restore global window pointer */
611 bb = b; /* restore global bit buffer */
612 bk = k;
614 /* done */
615 return 0;
620 /* "decompress" an inflated type 0 (stored) block. */
621 static int
622 inflate_stored(void)
624 unsigned n; /* number of bytes in block */
625 unsigned w; /* current window position */
626 register ulg b; /* bit buffer */
627 register unsigned k; /* number of bits in bit buffer */
630 /* make local copies of globals */
631 b = bb; /* initialize bit buffer */
632 k = bk;
633 w = wp; /* initialize window position */
636 /* go to byte boundary */
637 n = k & 7;
638 DUMPBITS(n);
641 /* get the length and its complement */
642 NEEDBITS(16)
643 n = ((unsigned)b & 0xffff);
644 DUMPBITS(16)
645 NEEDBITS(16)
646 if (n != (unsigned)((~b) & 0xffff))
647 return 1; /* error in compressed data */
648 DUMPBITS(16)
651 /* read and output the compressed data */
652 while (n--)
654 NEEDBITS(8)
655 slide[w++] = (uch)b;
656 if (w == WSIZE)
658 flush_output(w);
659 w = 0;
661 DUMPBITS(8)
665 /* restore the globals from the locals */
666 wp = w; /* restore global window pointer */
667 bb = b; /* restore global bit buffer */
668 bk = k;
669 return 0;
674 /* decompress an inflated type 1 (fixed Huffman codes) block. We should
675 either replace this with a custom decoder, or at least precompute the
676 Huffman tables. */
677 static int
678 inflate_fixed(void)
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 */
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;
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)
708 huft_free(tl);
709 return i;
713 /* decompress until an end-of-block code */
714 if (inflate_codes(tl, td, bl, bd))
715 return 1;
718 /* free the decoding tables, return */
719 huft_free(tl);
720 huft_free(td);
721 return 0;
726 /* decompress an inflated type 2 (dynamic Huffman codes) block. */
727 static int
728 inflate_dynamic(void)
730 int i; /* temporary variables */
731 unsigned j;
732 unsigned l; /* last length */
733 unsigned m; /* mask for bit lengths table */
734 unsigned n; /* number of lengths to get */
735 unsigned w; /* current window position */
736 struct huft *tl; /* literal/length code table */
737 struct huft *td; /* distance code table */
738 int bl; /* lookup bits for tl */
739 int bd; /* lookup bits for td */
740 unsigned nb; /* number of bit length codes */
741 unsigned nl; /* number of literal/length codes */
742 unsigned nd; /* number of distance codes */
743 #ifdef PKZIP_BUG_WORKAROUND
744 unsigned ll[288+32]; /* literal/length and distance code lengths */
745 #else
746 unsigned ll[286+30]; /* literal/length and distance code lengths */
747 #endif
748 register ulg b; /* bit buffer */
749 register unsigned k; /* number of bits in bit buffer */
752 /* make local bit buffer */
753 b = bb;
754 k = bk;
755 w = wp;
758 /* read in table lengths */
759 NEEDBITS(5)
760 nl = 257 + ((unsigned)b & 0x1f); /* number of literal/length codes */
761 DUMPBITS(5)
762 NEEDBITS(5)
763 nd = 1 + ((unsigned)b & 0x1f); /* number of distance codes */
764 DUMPBITS(5)
765 NEEDBITS(4)
766 nb = 4 + ((unsigned)b & 0xf); /* number of bit length codes */
767 DUMPBITS(4)
768 #ifdef PKZIP_BUG_WORKAROUND
769 if (nl > 288 || nd > 32)
770 #else
771 if (nl > 286 || nd > 30)
772 #endif
773 return 1; /* bad lengths */
776 /* read in bit-length-code lengths */
777 for (j = 0; j < nb; j++)
779 NEEDBITS(3)
780 ll[border[j]] = (unsigned)b & 7;
781 DUMPBITS(3)
783 for (; j < 19; j++)
784 ll[border[j]] = 0;
787 /* build decoding table for trees--single level, 7 bit lookup */
788 bl = 7;
789 if ((i = huft_build(ll, 19, 19, NULL, NULL, &tl, &bl)) != 0)
791 if (i == 1)
792 huft_free(tl);
793 return i; /* incomplete code set */
796 if (tl == NULL) /* Grrrhhh */
797 return 2;
799 /* read in literal and distance code lengths */
800 n = nl + nd;
801 m = mask_bits[bl];
802 i = l = 0;
803 while ((unsigned)i < n)
805 NEEDBITS((unsigned)bl)
806 j = (td = tl + ((unsigned)b & m))->b;
807 DUMPBITS(j)
808 j = td->v.n;
809 if (j < 16) /* length of code in bits (0..15) */
810 ll[i++] = l = j; /* save last length in l */
811 else if (j == 16) /* repeat last length 3 to 6 times */
813 NEEDBITS(2)
814 j = 3 + ((unsigned)b & 3);
815 DUMPBITS(2)
816 if ((unsigned)i + j > n)
817 return 1;
818 while (j--)
819 ll[i++] = l;
821 else if (j == 17) /* 3 to 10 zero length codes */
823 NEEDBITS(3)
824 j = 3 + ((unsigned)b & 7);
825 DUMPBITS(3)
826 if ((unsigned)i + j > n)
827 return 1;
828 while (j--)
829 ll[i++] = 0;
830 l = 0;
832 else /* j == 18: 11 to 138 zero length codes */
834 NEEDBITS(7)
835 j = 11 + ((unsigned)b & 0x7f);
836 DUMPBITS(7)
837 if ((unsigned)i + j > n)
838 return 1;
839 while (j--)
840 ll[i++] = 0;
841 l = 0;
846 /* free decoding table for trees */
847 huft_free(tl);
850 /* restore the global bit buffer */
851 bb = b;
852 bk = k;
855 /* build the decoding tables for literal/length and distance codes */
856 bl = lbits;
857 if ((i = huft_build(ll, nl, 257, cplens, cplext, &tl, &bl)) != 0)
859 if (i == 1) {
860 Trace ((stderr, " incomplete literal tree\n"));
861 huft_free(tl);
863 return i; /* incomplete code set */
865 bd = dbits;
866 if ((i = huft_build(ll + nl, nd, 0, cpdist, cpdext, &td, &bd)) != 0)
868 if (i == 1) {
869 Trace ((stderr, " incomplete distance tree\n"));
870 #ifdef PKZIP_BUG_WORKAROUND
871 i = 0;
873 #else
874 huft_free(td);
876 huft_free(tl);
877 return i; /* incomplete code set */
878 #endif
883 /* decompress until an end-of-block code */
884 int err = inflate_codes(tl, td, bl, bd) ? 1 : 0;
886 /* free the decoding tables */
887 huft_free(tl);
888 huft_free(td);
890 return err;
896 /* decompress an inflated block */
897 /* E is the last block flag */
898 static int inflate_block(int *e)
900 unsigned t; /* block type */
901 unsigned w; /* current window position */
902 register ulg b; /* bit buffer */
903 register unsigned k; /* number of bits in bit buffer */
906 /* make local bit buffer */
907 b = bb;
908 k = bk;
909 w = wp;
912 /* read in last block bit */
913 NEEDBITS(1)
914 *e = (int)b & 1;
915 DUMPBITS(1)
918 /* read in block type */
919 NEEDBITS(2)
920 t = (unsigned)b & 3;
921 DUMPBITS(2)
924 /* restore the global bit buffer */
925 bb = b;
926 bk = k;
929 /* inflate that block type */
930 if (t == 2)
931 return inflate_dynamic();
932 if (t == 0)
933 return inflate_stored();
934 if (t == 1)
935 return inflate_fixed();
938 /* bad block type */
939 return 2;
945 inflate(void)
946 /* decompress an inflated entry */
948 int e; /* last block flag */
949 int r; /* result code */
950 unsigned h; /* maximum struct huft's malloc'ed */
953 /* initialize window, bit buffer */
954 wp = 0;
955 bk = 0;
956 bb = 0;
959 /* decompress until the last block */
960 h = 0;
961 do {
962 hufts = 0;
963 if ((r = inflate_block(&e)) != 0)
964 return r;
965 if (hufts > h)
966 h = hufts;
967 } while (!e);
969 /* Undo too much lookahead. The next read will be byte aligned so we
970 * can discard unused bits in the last meaningful byte.
972 while (bk >= 8) {
973 bk -= 8;
974 inptr--;
977 /* flush out slide */
978 flush_output(wp);
981 /* return success */
982 Trace ((stderr, "<%u> ", h));
983 return 0;