1#define DEBG(x) 2#define DEBG1(x) 3/* inflate.c -- Not copyrighted 1992 by Mark Adler 4 version c10p1, 10 January 1993 */ 5 6/* 7 * Adapted for booting Linux by Hannu Savolainen 1993 8 * based on gzip-1.0.3 9 * 10 * Nicolas Pitre <nico@cam.org>, 1999/04/14 : 11 * Little mods for all variable to reside either into rodata or bss segments 12 * by marking constant variables with 'const' and initializing all the others 13 * at run-time only. This allows for the kernel uncompressor to run 14 * directly from Flash or ROM memory on embedded systems. 15 */ 16 17/* 18 Inflate deflated (PKZIP's method 8 compressed) data. The compression 19 method searches for as much of the current string of bytes (up to a 20 length of 258) in the previous 32 K bytes. If it doesn't find any 21 matches (of at least length 3), it codes the next byte. Otherwise, it 22 codes the length of the matched string and its distance backwards from 23 the current position. There is a single Huffman code that codes both 24 single bytes (called "literals") and match lengths. A second Huffman 25 code codes the distance information, which follows a length code. Each 26 length or distance code actually represents a base value and a number 27 of "extra" (sometimes zero) bits to get to add to the base value. At 28 the end of each deflated block is a special end-of-block (EOB) literal/ 29 length code. The decoding process is basically: get a literal/length 30 code; if EOB then done; if a literal, emit the decoded byte; if a 31 length then get the distance and emit the referred-to bytes from the 32 sliding window of previously emitted data. 33 34 There are (currently) three kinds of inflate blocks: stored, fixed, and 35 dynamic. The compressor deals with some chunk of data at a time, and 36 decides which method to use on a chunk-by-chunk basis. A chunk might 37 typically be 32 K or 64 K. If the chunk is incompressible, then the 38 "stored" method is used. In this case, the bytes are simply stored as 39 is, eight bits per byte, with none of the above coding. The bytes are 40 preceded by a count, since there is no longer an EOB code. 41 42 If the data is compressible, then either the fixed or dynamic methods 43 are used. In the dynamic method, the compressed data is preceded by 44 an encoding of the literal/length and distance Huffman codes that are 45 to be used to decode this block. The representation is itself Huffman 46 coded, and so is preceded by a description of that code. These code 47 descriptions take up a little space, and so for small blocks, there is 48 a predefined set of codes, called the fixed codes. The fixed method is 49 used if the block codes up smaller that way (usually for quite small 50 chunks), otherwise the dynamic method is used. In the latter case, the 51 codes are customized to the probabilities in the current block, and so 52 can code it much better than the pre-determined fixed codes. 53 54 The Huffman codes themselves are decoded using a multi-level table 55 lookup, in order to maximize the speed of decoding plus the speed of 56 building the decoding tables. See the comments below that precede the 57 lbits and dbits tuning parameters. 58 */ 59 60 61/* 62 Notes beyond the 1.93a appnote.txt: 63 64 1. Distance pointers never point before the beginning of the output 65 stream. 66 2. Distance pointers can point back across blocks, up to 32k away. 67 3. There is an implied maximum of 7 bits for the bit length table and 68 15 bits for the actual data. 69 4. If only one code exists, then it is encoded using one bit. (Zero 70 would be more efficient, but perhaps a little confusing.) If two 71 codes exist, they are coded using one bit each (0 and 1). 72 5. There is no way of sending zero distance codes--a dummy must be 73 sent if there are none. (History: a pre 2.0 version of PKZIP would 74 store blocks with no distance codes, but this was discovered to be 75 too harsh a criterion.) Valid only for 1.93a. 2.04c does allow 76 zero distance codes, which is sent as one code of zero bits in 77 length. 78 6. There are up to 286 literal/length codes. Code 256 represents the 79 end-of-block. Note however that the static length tree defines 80 288 codes just to fill out the Huffman codes. Codes 286 and 287 81 cannot be used though, since there is no length base or extra bits 82 defined for them. Similarly, there are up to 30 distance codes. 83 However, static trees define 32 codes (all 5 bits) to fill out the 84 Huffman codes, but the last two had better not show up in the data. 85 7. Unzip can check dynamic Huffman blocks for complete code sets. 86 The exception is that a single code would not be complete (see #4). 87 8. The five bits following the block type is really the number of 88 literal codes sent minus 257. 89 9. Length codes 8,16,16 are interpreted as 13 length codes of 8 bits 90 (1+6+6). Therefore, to output three times the length, you output 91 three codes (1+1+1), whereas to output four times the same length, 92 you only need two codes (1+3). Hmm. 93 10. In the tree reconstruction algorithm, Code = Code + Increment 94 only if BitLength(i) is not zero. (Pretty obvious.) 95 11. Correction: 4 Bits: # of Bit Length codes - 4 (4 - 19) 96 12. Note: length code 284 can represent 227-258, but length code 285 97 really is 258. The last length deserves its own, short code 98 since it gets used a lot in very redundant files. The length 99 258 is special since 258 - 3 (the min match length) is 255. 100 13. The literal/length and distance code bit lengths are read as a 101 single stream of lengths. It is possible (and advantageous) for 102 a repeat code (16, 17, or 18) to go across the boundary between 103 the two sets of lengths. 104 */ 105 106#ifdef RCSID 107static char rcsid[] = "#Id: inflate.c,v 0.14 1993/06/10 13:27:04 jloup Exp #"; 108#endif 109 110#ifndef STATIC 111 112#if defined(STDC_HEADERS) || defined(HAVE_STDLIB_H) 113# include <sys/types.h> 114# include <stdlib.h> 115#endif 116 117#include "gzip.h" 118#define STATIC 119#endif /* !STATIC */ 120 121#define slide window 122 123/* Huffman code lookup table entry--this entry is four bytes for machines 124 that have 16-bit pointers (e.g. PC's in the small or medium model). 125 Valid extra bits are 0..13. e == 15 is EOB (end of block), e == 16 126 means that v is a literal, 16 < e < 32 means that v is a pointer to 127 the next table, which codes e - 16 bits, and lastly e == 99 indicates 128 an unused code. If a code with e == 99 is looked up, this implies an 129 error in the data. */ 130struct huft { 131 uch e; /* number of extra bits or operation */ 132 uch b; /* number of bits in this code or subcode */ 133 union { 134 ush n; /* literal, length base, or distance base */ 135 struct huft *t; /* pointer to next level of table */ 136 } v; 137}; 138 139 140/* Function prototypes */ 141STATIC int huft_build OF((unsigned *, unsigned, unsigned, 142 const ush *, const ush *, struct huft **, int *)); 143STATIC int huft_free OF((struct huft *)); 144STATIC int inflate_codes OF((struct huft *, struct huft *, int, int)); 145STATIC int inflate_stored OF((void)); 146STATIC int inflate_fixed OF((void)); 147STATIC int inflate_dynamic OF((void)); 148STATIC int inflate_block OF((int *)); 149STATIC int inflate OF((void)); 150 151 152/* The inflate algorithm uses a sliding 32 K byte window on the uncompressed 153 stream to find repeated byte strings. This is implemented here as a 154 circular buffer. The index is updated simply by incrementing and then 155 ANDing with 0x7fff (32K-1). */ 156/* It is left to other modules to supply the 32 K area. It is assumed 157 to be usable as if it were declared "uch slide[32768];" or as just 158 "uch *slide;" and then malloc'ed in the latter case. The definition 159 must be in unzip.h, included above. */ 160/* unsigned wp; current position in slide */ 161#define wp outcnt 162#define flush_output(w) (wp=(w),flush_window()) 163 164/* Tables for deflate from PKZIP's appnote.txt. */ 165static const unsigned border[] = { /* Order of the bit length code lengths */ 166 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15}; 167static const ush cplens[] = { /* Copy lengths for literal codes 257..285 */ 168 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31, 169 35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, 258, 0, 0}; 170 /* note: see note #13 above about the 258 in this list. */ 171static const ush cplext[] = { /* Extra bits for literal codes 257..285 */ 172 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 173 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 0, 99, 99}; /* 99==invalid */ 174static const ush cpdist[] = { /* Copy offsets for distance codes 0..29 */ 175 1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193, 176 257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145, 177 8193, 12289, 16385, 24577}; 178static const ush cpdext[] = { /* Extra bits for distance codes */ 179 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 180 7, 7, 8, 8, 9, 9, 10, 10, 11, 11, 181 12, 12, 13, 13}; 182 183 184 185/* Macros for inflate() bit peeking and grabbing. 186 The usage is: 187 188 NEEDBITS(j) 189 x = b & mask_bits[j]; 190 DUMPBITS(j) 191 192 where NEEDBITS makes sure that b has at least j bits in it, and 193 DUMPBITS removes the bits from b. The macros use the variable k 194 for the number of bits in b. Normally, b and k are register 195 variables for speed, and are initialized at the beginning of a 196 routine that uses these macros from a global bit buffer and count. 197 198 If we assume that EOB will be the longest code, then we will never 199 ask for bits with NEEDBITS that are beyond the end of the stream. 200 So, NEEDBITS should not read any more bytes than are needed to 201 meet the request. Then no bytes need to be "returned" to the buffer 202 at the end of the last block. 203 204 However, this assumption is not true for fixed blocks--the EOB code 205 is 7 bits, but the other literal/length codes can be 8 or 9 bits. 206 (The EOB code is shorter than other codes because fixed blocks are 207 generally short. So, while a block always has an EOB, many other 208 literal/length codes have a significantly lower probability of 209 showing up at all.) However, by making the first table have a 210 lookup of seven bits, the EOB code will be found in that first 211 lookup, and so will not require that too many bits be pulled from 212 the stream. 213 */ 214 215STATIC ulg bb; /* bit buffer */ 216STATIC unsigned bk; /* bits in bit buffer */ 217 218STATIC const ush mask_bits[] = { 219 0x0000, 220 0x0001, 0x0003, 0x0007, 0x000f, 0x001f, 0x003f, 0x007f, 0x00ff, 221 0x01ff, 0x03ff, 0x07ff, 0x0fff, 0x1fff, 0x3fff, 0x7fff, 0xffff 222}; 223 224#define NEXTBYTE() ({ int v = get_byte(); if (v < 0) goto underrun; (uch)v; }) 225#define NEEDBITS(n) {while(k<(n)){b|=((ulg)NEXTBYTE())<<k;k+=8;}} 226#define DUMPBITS(n) {b>>=(n);k-=(n);} 227 228 229/* 230 Huffman code decoding is performed using a multi-level table lookup. 231 The fastest way to decode is to simply build a lookup table whose 232 size is determined by the longest code. However, the time it takes 233 to build this table can also be a factor if the data being decoded 234 is not very long. The most common codes are necessarily the 235 shortest codes, so those codes dominate the decoding time, and hence 236 the speed. The idea is you can have a shorter table that decodes the 237 shorter, more probable codes, and then point to subsidiary tables for 238 the longer codes. The time it costs to decode the longer codes is 239 then traded against the time it takes to make longer tables. 240 241 This results of this trade are in the variables lbits and dbits 242 below. lbits is the number of bits the first level table for literal/ 243 length codes can decode in one step, and dbits is the same thing for 244 the distance codes. Subsequent tables are also less than or equal to 245 those sizes. These values may be adjusted either when all of the 246 codes are shorter than that, in which case the longest code length in 247 bits is used, or when the shortest code is *longer* than the requested 248 table size, in which case the length of the shortest code in bits is 249 used. 250 251 There are two different values for the two tables, since they code a 252 different number of possibilities each. The literal/length table 253 codes 286 possible values, or in a flat code, a little over eight 254 bits. The distance table codes 30 possible values, or a little less 255 than five bits, flat. The optimum values for speed end up being 256 about one bit more than those, so lbits is 8+1 and dbits is 5+1. 257 The optimum values may differ though from machine to machine, and 258 possibly even between compilers. Your mileage may vary. 259 */ 260 261 262STATIC const int lbits = 9; /* bits in base literal/length lookup table */ 263STATIC const int dbits = 6; /* bits in base distance lookup table */ 264 265 266/* If BMAX needs to be larger than 16, then h and x[] should be ulg. */ 267#define BMAX 16 /* maximum bit length of any code (16 for explode) */ 268#define N_MAX 288 /* maximum number of codes in any set */ 269 270 271STATIC unsigned hufts; /* track memory usage */ 272 273 274STATIC int huft_build( 275 unsigned *b, /* code lengths in bits (all assumed <= BMAX) */ 276 unsigned n, /* number of codes (assumed <= N_MAX) */ 277 unsigned s, /* number of simple-valued codes (0..s-1) */ 278 const ush *d, /* list of base values for non-simple codes */ 279 const ush *e, /* list of extra bits for non-simple codes */ 280 struct huft **t, /* result: starting table */ 281 int *m /* maximum lookup bits, returns actual */ 282 ) 283/* Given a list of code lengths and a maximum table size, make a set of 284 tables to decode that set of codes. Return zero on success, one if 285 the given code set is incomplete (the tables are still built in this 286 case), two if the input is invalid (all zero length codes or an 287 oversubscribed set of lengths), and three if not enough memory. */ 288{ 289 unsigned a; /* counter for codes of length k */ 290 unsigned c[BMAX+1]; /* bit length count table */ 291 unsigned f; /* i repeats in table every f entries */ 292 int g; /* maximum code length */ 293 int h; /* table level */ 294 register unsigned i; /* counter, current code */ 295 register unsigned j; /* counter */ 296 register int k; /* number of bits in current code */ 297 int l; /* bits per table (returned in m) */ 298 register unsigned *p; /* pointer into c[], b[], or v[] */ 299 register struct huft *q; /* points to current table */ 300 struct huft r; /* table entry for structure assignment */ 301 struct huft *u[BMAX]; /* table stack */ 302 unsigned v[N_MAX]; /* values in order of bit length */ 303 register int w; /* bits before this table == (l * h) */ 304 unsigned x[BMAX+1]; /* bit offsets, then code stack */ 305 unsigned *xp; /* pointer into x */ 306 int y; /* number of dummy codes added */ 307 unsigned z; /* number of entries in current table */ 308 309DEBG("huft1 "); 310 311 /* Generate counts for each bit length */ 312 memzero(c, sizeof(c)); 313 p = b; i = n; 314 do { 315 Tracecv(*p, (stderr, (n-i >= ' ' && n-i <= '~' ? "%c %d\n" : "0x%x %d\n"), 316 n-i, *p)); 317 c[*p]++; /* assume all entries <= BMAX */ 318 p++; /* Can't combine with above line (Solaris bug) */ 319 } while (--i); 320 if (c[0] == n) /* null input--all zero length codes */ 321 { 322 *t = (struct huft *)NULL; 323 *m = 0; 324 return 0; 325 } 326 327DEBG("huft2 "); 328 329 /* Find minimum and maximum length, bound *m by those */ 330 l = *m; 331 for (j = 1; j <= BMAX; j++) 332 if (c[j]) 333 break; 334 k = j; /* minimum code length */ 335 if ((unsigned)l < j) 336 l = j; 337 for (i = BMAX; i; i--) 338 if (c[i]) 339 break; 340 g = i; /* maximum code length */ 341 if ((unsigned)l > i) 342 l = i; 343 *m = l; 344 345DEBG("huft3 "); 346 347 /* Adjust last length count to fill out codes, if needed */ 348 for (y = 1 << j; j < i; j++, y <<= 1) 349 if ((y -= c[j]) < 0) 350 return 2; /* bad input: more codes than bits */ 351 if ((y -= c[i]) < 0) 352 return 2; 353 c[i] += y; 354 355DEBG("huft4 "); 356 357 /* Generate starting offsets into the value table for each length */ 358 x[1] = j = 0; 359 p = c + 1; xp = x + 2; 360 while (--i) { /* note that i == g from above */ 361 *xp++ = (j += *p++); 362 } 363 364DEBG("huft5 "); 365 366 /* Make a table of values in order of bit lengths */ 367 p = b; i = 0; 368 do { 369 if ((j = *p++) != 0) 370 v[x[j]++] = i; 371 } while (++i < n); 372 373DEBG("h6 "); 374 375 /* Generate the Huffman codes and for each, make the table entries */ 376 x[0] = i = 0; /* first Huffman code is zero */ 377 p = v; /* grab values in bit order */ 378 h = -1; /* no tables yet--level -1 */ 379 w = -l; /* bits decoded == (l * h) */ 380 u[0] = (struct huft *)NULL; /* just to keep compilers happy */ 381 q = (struct huft *)NULL; /* ditto */ 382 z = 0; /* ditto */ 383DEBG("h6a "); 384 385 /* go through the bit lengths (k already is bits in shortest code) */ 386 for (; k <= g; k++) 387 { 388DEBG("h6b "); 389 a = c[k]; 390 while (a--) 391 { 392DEBG("h6b1 "); 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 { 397DEBG1("1 "); 398 h++; 399 w += l; /* previous table always l bits */ 400 401 /* compute minimum size table less than or equal to l bits */ 402 z = (z = g - w) > (unsigned)l ? l : z; /* upper limit on table size */ 403 if ((f = 1 << (j = k - w)) > a + 1) /* try a k-w bit table */ 404 { /* too few codes for k-w bit table */ 405DEBG1("2 "); 406 f -= a + 1; /* deduct codes from patterns left */ 407 xp = c + k; 408 while (++j < z) /* try smaller tables up to z bits */ 409 { 410 if ((f <<= 1) <= *++xp) 411 break; /* enough codes to use up j bits */ 412 f -= *xp; /* else deduct codes from patterns */ 413 } 414 } 415DEBG1("3 "); 416 z = 1 << j; /* table entries for j-bit table */ 417 418 /* allocate and link in new table */ 419 if ((q = (struct huft *)malloc((z + 1)*sizeof(struct huft))) == 420 (struct huft *)NULL) 421 { 422 if (h) 423 huft_free(u[0]); 424 return 3; /* not enough memory */ 425 } 426DEBG1("4 "); 427 hufts += z + 1; /* track memory usage */ 428 *t = q + 1; /* link to list for huft_free() */ 429 *(t = &(q->v.t)) = (struct huft *)NULL; 430 u[h] = ++q; /* table starts after link */ 431 432DEBG1("5 "); 433 /* connect to last table, if there is one */ 434 if (h) 435 { 436 x[h] = i; /* save pattern for backing up */ 437 r.b = (uch)l; /* bits to dump before this table */ 438 r.e = (uch)(16 + j); /* bits in this table */ 439 r.v.t = q; /* pointer to this table */ 440 j = i >> (w - l); /* (get around Turbo C bug) */ 441 u[h-1][j] = r; /* connect to last table */ 442 } 443DEBG1("6 "); 444 } 445DEBG("h6c "); 446 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) 452 { 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++ */ 456 } 457 else 458 { 459 r.e = (uch)e[*p - s]; /* non-simple--look up in lists */ 460 r.v.n = d[*p++ - s]; 461 } 462DEBG("h6d "); 463 464 /* fill code-like entries with r */ 465 f = 1 << (k - w); 466 for (j = i >> w; j < z; j += f) 467 q[j] = r; 468 469 /* backwards increment the k-bit code i */ 470 for (j = 1 << (k - 1); i & j; j >>= 1) 471 i ^= j; 472 i ^= j; 473 474 /* backup over finished tables */ 475 while ((i & ((1 << w) - 1)) != x[h]) 476 { 477 h--; /* don't need to update q */ 478 w -= l; 479 } 480DEBG("h6e "); 481 } 482DEBG("h6f "); 483 } 484 485DEBG("huft7 "); 486 487 /* Return true (1) if we were given an incomplete table */ 488 return y != 0 && g != 1; 489} 490 491 492 493STATIC int huft_free( 494 struct huft *t /* table to free */ 495 ) 496/* Free the malloc'ed tables built by huft_build(), which makes a linked 497 list of the tables it made, with the links in a dummy first entry of 498 each table. */ 499{ 500 register struct huft *p, *q; 501 502 503 /* Go through linked list, freeing from the malloced (t[-1]) address. */ 504 p = t; 505 while (p != (struct huft *)NULL) 506 { 507 q = (--p)->v.t; 508 free((char*)p); 509 p = q; 510 } 511 return 0; 512} 513 514 515STATIC int inflate_codes( 516 struct huft *tl, /* literal/length decoder tables */ 517 struct huft *td, /* distance decoder tables */ 518 int bl, /* number of bits decoded by tl[] */ 519 int bd /* number of bits decoded by td[] */ 520 ) 521/* inflate (decompress) the codes in a deflated (compressed) block. 522 Return an error code or zero if it all goes ok. */ 523{ 524 register unsigned e; /* table entry flag/number of extra bits */ 525 unsigned n, d; /* length and index for copy */ 526 unsigned w; /* current window position */ 527 struct huft *t; /* pointer to table entry */ 528 unsigned ml, md; /* masks for bl and bd bits */ 529 register ulg b; /* bit buffer */ 530 register unsigned k; /* number of bits in bit buffer */ 531 532 533 /* make local copies of globals */ 534 b = bb; /* initialize bit buffer */ 535 k = bk; 536 w = wp; /* initialize window position */ 537 538 /* inflate the coded data */ 539 ml = mask_bits[bl]; /* precompute masks for speed */ 540 md = mask_bits[bd]; 541 for (;;) /* do until end of block */ 542 { 543 NEEDBITS((unsigned)bl) 544 if ((e = (t = tl + ((unsigned)b & ml))->e) > 16) 545 do { 546 if (e == 99) 547 return 1; 548 DUMPBITS(t->b) 549 e -= 16; 550 NEEDBITS(e) 551 } while ((e = (t = t->v.t + ((unsigned)b & mask_bits[e]))->e) > 16); 552 DUMPBITS(t->b) 553 if (e == 16) /* then it's a literal */ 554 { 555 slide[w++] = (uch)t->v.n; 556 Tracevv((stderr, "%c", slide[w-1])); 557 if (w == WSIZE) 558 { 559 flush_output(w); 560 w = 0; 561 } 562 } 563 else /* it's an EOB or a length */ 564 { 565 /* exit if end of block */ 566 if (e == 15) 567 break; 568 569 /* get length of block to copy */ 570 NEEDBITS(e) 571 n = t->v.n + ((unsigned)b & mask_bits[e]); 572 DUMPBITS(e); 573 574 /* decode distance of block to copy */ 575 NEEDBITS((unsigned)bd) 576 if ((e = (t = td + ((unsigned)b & md))->e) > 16) 577 do { 578 if (e == 99) 579 return 1; 580 DUMPBITS(t->b) 581 e -= 16; 582 NEEDBITS(e) 583 } while ((e = (t = t->v.t + ((unsigned)b & mask_bits[e]))->e) > 16); 584 DUMPBITS(t->b) 585 NEEDBITS(e) 586 d = w - t->v.n - ((unsigned)b & mask_bits[e]); 587 DUMPBITS(e) 588 Tracevv((stderr,"\\[%d,%d]", w-d, n)); 589 590 /* do the copy */ 591 do { 592 n -= (e = (e = WSIZE - ((d &= WSIZE-1) > w ? d : w)) > n ? n : e); 593#if !defined(NOMEMCPY) && !defined(DEBUG) 594 if (w - d >= e) /* (this test assumes unsigned comparison) */ 595 { 596 memcpy(slide + w, slide + d, e); 597 w += e; 598 d += e; 599 } 600 else /* do it slow to avoid memcpy() overlap */ 601#endif /* !NOMEMCPY */ 602 do { 603 slide[w++] = slide[d++]; 604 Tracevv((stderr, "%c", slide[w-1])); 605 } while (--e); 606 if (w == WSIZE) 607 { 608 flush_output(w); 609 w = 0; 610 } 611 } while (n); 612 } 613 } 614 615 616 /* restore the globals from the locals */ 617 wp = w; /* restore global window pointer */ 618 bb = b; /* restore global bit buffer */ 619 bk = k; 620 621 /* done */ 622 return 0; 623 624 underrun: 625 return 4; /* Input underrun */ 626} 627 628 629 630STATIC int inflate_stored(void) 631/* "decompress" an inflated type 0 (stored) block. */ 632{ 633 unsigned n; /* number of bytes in block */ 634 unsigned w; /* current window position */ 635 register ulg b; /* bit buffer */ 636 register unsigned k; /* number of bits in bit buffer */ 637 638DEBG("<stor"); 639 640 /* make local copies of globals */ 641 b = bb; /* initialize bit buffer */ 642 k = bk; 643 w = wp; /* initialize window position */ 644 645 646 /* go to byte boundary */ 647 n = k & 7; 648 DUMPBITS(n); 649 650 651 /* get the length and its complement */ 652 NEEDBITS(16) 653 n = ((unsigned)b & 0xffff); 654 DUMPBITS(16) 655 NEEDBITS(16) 656 if (n != (unsigned)((~b) & 0xffff)) 657 return 1; /* error in compressed data */ 658 DUMPBITS(16) 659 660 661 /* read and output the compressed data */ 662 while (n--) 663 { 664 NEEDBITS(8) 665 slide[w++] = (uch)b; 666 if (w == WSIZE) 667 { 668 flush_output(w); 669 w = 0; 670 } 671 DUMPBITS(8) 672 } 673 674 675 /* restore the globals from the locals */ 676 wp = w; /* restore global window pointer */ 677 bb = b; /* restore global bit buffer */ 678 bk = k; 679 680 DEBG(">"); 681 return 0; 682 683 underrun: 684 return 4; /* Input underrun */ 685} 686 687 688 689STATIC int inflate_fixed(void) 690/* decompress an inflated type 1 (fixed Huffman codes) block. We should 691 either replace this with a custom decoder, or at least precompute the 692 Huffman tables. */ 693{ 694 int i; /* temporary variable */ 695 struct huft *tl; /* literal/length code table */ 696 struct huft *td; /* distance code table */ 697 int bl; /* lookup bits for tl */ 698 int bd; /* lookup bits for td */ 699 unsigned l[288]; /* length list for huft_build */ 700 701DEBG("<fix"); 702 703 /* set up literal table */ 704 for (i = 0; i < 144; i++) 705 l[i] = 8; 706 for (; i < 256; i++) 707 l[i] = 9; 708 for (; i < 280; i++) 709 l[i] = 7; 710 for (; i < 288; i++) /* make a complete, but wrong code set */ 711 l[i] = 8; 712 bl = 7; 713 if ((i = huft_build(l, 288, 257, cplens, cplext, &tl, &bl)) != 0) 714 return i; 715 716 717 /* set up distance table */ 718 for (i = 0; i < 30; i++) /* make an incomplete code set */ 719 l[i] = 5; 720 bd = 5; 721 if ((i = huft_build(l, 30, 0, cpdist, cpdext, &td, &bd)) > 1) 722 { 723 huft_free(tl); 724 725 DEBG(">"); 726 return i; 727 } 728 729 730 /* decompress until an end-of-block code */ 731 if (inflate_codes(tl, td, bl, bd)) 732 return 1; 733 734 735 /* free the decoding tables, return */ 736 huft_free(tl); 737 huft_free(td); 738 return 0; 739} 740 741 742 743STATIC int inflate_dynamic(void) 744/* decompress an inflated type 2 (dynamic Huffman codes) block. */ 745{ 746 int i; /* temporary variables */ 747 unsigned j; 748 unsigned l; /* last length */ 749 unsigned m; /* mask for bit lengths table */ 750 unsigned n; /* number of lengths to get */ 751 struct huft *tl; /* literal/length code table */ 752 struct huft *td; /* distance code table */ 753 int bl; /* lookup bits for tl */ 754 int bd; /* lookup bits for td */ 755 unsigned nb; /* number of bit length codes */ 756 unsigned nl; /* number of literal/length codes */ 757 unsigned nd; /* number of distance codes */ 758#ifdef PKZIP_BUG_WORKAROUND 759 unsigned ll[288+32]; /* literal/length and distance code lengths */ 760#else 761 unsigned ll[286+30]; /* literal/length and distance code lengths */ 762#endif 763 register ulg b; /* bit buffer */ 764 register unsigned k; /* number of bits in bit buffer */ 765 766DEBG("<dyn"); 767 768 /* make local bit buffer */ 769 b = bb; 770 k = bk; 771 772 773 /* read in table lengths */ 774 NEEDBITS(5) 775 nl = 257 + ((unsigned)b & 0x1f); /* number of literal/length codes */ 776 DUMPBITS(5) 777 NEEDBITS(5) 778 nd = 1 + ((unsigned)b & 0x1f); /* number of distance codes */ 779 DUMPBITS(5) 780 NEEDBITS(4) 781 nb = 4 + ((unsigned)b & 0xf); /* number of bit length codes */ 782 DUMPBITS(4) 783#ifdef PKZIP_BUG_WORKAROUND 784 if (nl > 288 || nd > 32) 785#else 786 if (nl > 286 || nd > 30) 787#endif 788 return 1; /* bad lengths */ 789 790DEBG("dyn1 "); 791 792 /* read in bit-length-code lengths */ 793 for (j = 0; j < nb; j++) 794 { 795 NEEDBITS(3) 796 ll[border[j]] = (unsigned)b & 7; 797 DUMPBITS(3) 798 } 799 for (; j < 19; j++) 800 ll[border[j]] = 0; 801 802DEBG("dyn2 "); 803 804 /* build decoding table for trees--single level, 7 bit lookup */ 805 bl = 7; 806 if ((i = huft_build(ll, 19, 19, NULL, NULL, &tl, &bl)) != 0) 807 { 808 if (i == 1) 809 huft_free(tl); 810 return i; /* incomplete code set */ 811 } 812 813DEBG("dyn3 "); 814 815 /* read in literal and distance code lengths */ 816 n = nl + nd; 817 m = mask_bits[bl]; 818 i = l = 0; 819 while ((unsigned)i < n) 820 { 821 NEEDBITS((unsigned)bl) 822 j = (td = tl + ((unsigned)b & m))->b; 823 DUMPBITS(j) 824 j = td->v.n; 825 if (j < 16) /* length of code in bits (0..15) */ 826 ll[i++] = l = j; /* save last length in l */ 827 else if (j == 16) /* repeat last length 3 to 6 times */ 828 { 829 NEEDBITS(2) 830 j = 3 + ((unsigned)b & 3); 831 DUMPBITS(2) 832 if ((unsigned)i + j > n) 833 return 1; 834 while (j--) 835 ll[i++] = l; 836 } 837 else if (j == 17) /* 3 to 10 zero length codes */ 838 { 839 NEEDBITS(3) 840 j = 3 + ((unsigned)b & 7); 841 DUMPBITS(3) 842 if ((unsigned)i + j > n) 843 return 1; 844 while (j--) 845 ll[i++] = 0; 846 l = 0; 847 } 848 else /* j == 18: 11 to 138 zero length codes */ 849 { 850 NEEDBITS(7) 851 j = 11 + ((unsigned)b & 0x7f); 852 DUMPBITS(7) 853 if ((unsigned)i + j > n) 854 return 1; 855 while (j--) 856 ll[i++] = 0; 857 l = 0; 858 } 859 } 860 861DEBG("dyn4 "); 862 863 /* free decoding table for trees */ 864 huft_free(tl); 865 866DEBG("dyn5 "); 867 868 /* restore the global bit buffer */ 869 bb = b; 870 bk = k; 871 872DEBG("dyn5a "); 873 874 /* build the decoding tables for literal/length and distance codes */ 875 bl = lbits; 876 if ((i = huft_build(ll, nl, 257, cplens, cplext, &tl, &bl)) != 0) 877 { 878DEBG("dyn5b "); 879 if (i == 1) { 880 error("incomplete literal tree"); 881 huft_free(tl); 882 } 883 return i; /* incomplete code set */ 884 } 885DEBG("dyn5c "); 886 bd = dbits; 887 if ((i = huft_build(ll + nl, nd, 0, cpdist, cpdext, &td, &bd)) != 0) 888 { 889DEBG("dyn5d "); 890 if (i == 1) { 891 error("incomplete distance tree"); 892#ifdef PKZIP_BUG_WORKAROUND 893 i = 0; 894 } 895#else 896 huft_free(td); 897 } 898 huft_free(tl); 899 return i; /* incomplete code set */ 900#endif 901 } 902 903DEBG("dyn6 "); 904 905 /* decompress until an end-of-block code */ 906 if (inflate_codes(tl, td, bl, bd)) 907 return 1; 908 909DEBG("dyn7 "); 910 911 /* free the decoding tables, return */ 912 huft_free(tl); 913 huft_free(td); 914 915 DEBG(">"); 916 return 0; 917 918 underrun: 919 return 4; /* Input underrun */ 920} 921 922 923 924STATIC int inflate_block( 925 int *e /* last block flag */ 926 ) 927/* decompress an inflated block */ 928{ 929 unsigned t; /* block type */ 930 register ulg b; /* bit buffer */ 931 register unsigned k; /* number of bits in bit buffer */ 932 933 DEBG("<blk"); 934 935 /* make local bit buffer */ 936 b = bb; 937 k = bk; 938 939 940 /* read in last block bit */ 941 NEEDBITS(1) 942 *e = (int)b & 1; 943 DUMPBITS(1) 944 945 946 /* read in block type */ 947 NEEDBITS(2) 948 t = (unsigned)b & 3; 949 DUMPBITS(2) 950 951 952 /* restore the global bit buffer */ 953 bb = b; 954 bk = k; 955 956 /* inflate that block type */ 957 if (t == 2) 958 return inflate_dynamic(); 959 if (t == 0) 960 return inflate_stored(); 961 if (t == 1) 962 return inflate_fixed(); 963 964 DEBG(">"); 965 966 /* bad block type */ 967 return 2; 968 969 underrun: 970 return 4; /* Input underrun */ 971} 972 973 974 975STATIC int inflate(void) 976/* decompress an inflated entry */ 977{ 978 int e; /* last block flag */ 979 int r; /* result code */ 980 unsigned h; /* maximum struct huft's malloc'ed */ 981 void *ptr; 982 983 /* initialize window, bit buffer */ 984 wp = 0; 985 bk = 0; 986 bb = 0; 987 988 989 /* decompress until the last block */ 990 h = 0; 991 do { 992 hufts = 0; 993 gzip_mark(&ptr); 994 if ((r = inflate_block(&e)) != 0) { 995 gzip_release(&ptr); 996 return r; 997 } 998 gzip_release(&ptr); 999 if (hufts > h) 1000 h = hufts;
1001 } while (!e); 1002 1003 /* Undo too much lookahead. The next read will be byte aligned so we 1004 * can discard unused bits in the last meaningful byte. 1005 */ 1006 while (bk >= 8) { 1007 bk -= 8; 1008 inptr--; 1009 } 1010 1011 /* flush out slide */ 1012 flush_output(wp); 1013 1014 1015 /* return success */ 1016#ifdef DEBUG 1017 fprintf(stderr, "<%u> ", h); 1018#endif /* DEBUG */ 1019 return 0; 1020} 1021 1022/********************************************************************** 1023 * 1024 * The following are support routines for inflate.c 1025 * 1026 **********************************************************************/ 1027 1028static ulg crc_32_tab[256]; 1029static ulg crc; /* initialized in makecrc() so it'll reside in bss */ 1030#define CRC_VALUE (crc ^ 0xffffffffUL) 1031 1032/* 1033 * Code to compute the CRC-32 table. Borrowed from 1034 * gzip-1.0.3/makecrc.c. 1035 */ 1036 1037static void 1038makecrc(void) 1039{ 1040/* Not copyrighted 1990 Mark Adler */ 1041 1042 unsigned long c; /* crc shift register */ 1043 unsigned long e; /* polynomial exclusive-or pattern */ 1044 int i; /* counter for all possible eight bit values */ 1045 int k; /* byte being shifted into crc apparatus */ 1046 1047 /* terms of polynomial defining this crc (except x^32): */ 1048 static const int p[] = {0,1,2,4,5,7,8,10,11,12,16,22,23,26}; 1049 1050 /* Make exclusive-or pattern from polynomial */ 1051 e = 0; 1052 for (i = 0; i < sizeof(p)/sizeof(int); i++) 1053 e |= 1L << (31 - p[i]); 1054 1055 crc_32_tab[0] = 0; 1056 1057 for (i = 1; i < 256; i++) 1058 { 1059 c = 0; 1060 for (k = i | 256; k != 1; k >>= 1) 1061 { 1062 c = c & 1 ? (c >> 1) ^ e : c >> 1; 1063 if (k & 1) 1064 c ^= e; 1065 } 1066 crc_32_tab[i] = c; 1067 } 1068 1069 /* this is initialized here so this code could reside in ROM */ 1070 crc = (ulg)0xffffffffUL; /* shift register contents */ 1071} 1072 1073/* gzip flag byte */ 1074#define ASCII_FLAG 0x01 /* bit 0 set: file probably ASCII text */ 1075#define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */ 1076#define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */ 1077#define ORIG_NAME 0x08 /* bit 3 set: original file name present */ 1078#define COMMENT 0x10 /* bit 4 set: file comment present */ 1079#define ENCRYPTED 0x20 /* bit 5 set: file is encrypted */ 1080#define RESERVED 0xC0 /* bit 6,7: reserved */ 1081 1082/* 1083 * Do the uncompression! 1084 */ 1085static int gunzip(void) 1086{ 1087 uch flags; 1088 unsigned char magic[2]; /* magic header */ 1089 char method; 1090 ulg orig_crc = 0; /* original crc */ 1091 ulg orig_len = 0; /* original uncompressed length */ 1092 int res; 1093 1094 magic[0] = NEXTBYTE(); 1095 magic[1] = NEXTBYTE(); 1096 method = NEXTBYTE(); 1097 1098 if (magic[0] != 037 || 1099 ((magic[1] != 0213) && (magic[1] != 0236))) { 1100 error("bad gzip magic numbers"); 1101 return -1; 1102 } 1103 1104 /* We only support method #8, DEFLATED */ 1105 if (method != 8) { 1106 error("internal error, invalid method"); 1107 return -1; 1108 } 1109 1110 flags = (uch)get_byte(); 1111 if ((flags & ENCRYPTED) != 0) { 1112 error("Input is encrypted"); 1113 return -1; 1114 } 1115 if ((flags & CONTINUATION) != 0) { 1116 error("Multi part input"); 1117 return -1; 1118 } 1119 if ((flags & RESERVED) != 0) { 1120 error("Input has invalid flags"); 1121 return -1; 1122 } 1123 NEXTBYTE(); /* Get timestamp */ 1124 NEXTBYTE(); 1125 NEXTBYTE(); 1126 NEXTBYTE(); 1127 1128 (void)NEXTBYTE(); /* Ignore extra flags for the moment */ 1129 (void)NEXTBYTE(); /* Ignore OS type for the moment */ 1130 1131 if ((flags & EXTRA_FIELD) != 0) { 1132 unsigned len = (unsigned)NEXTBYTE(); 1133 len |= ((unsigned)NEXTBYTE())<<8; 1134 while (len--) (void)NEXTBYTE(); 1135 } 1136 1137 /* Get original file name if it was truncated */ 1138 if ((flags & ORIG_NAME) != 0) { 1139 /* Discard the old name */ 1140 while (NEXTBYTE() != 0) /* null */ ; 1141 } 1142 1143 /* Discard file comment if any */ 1144 if ((flags & COMMENT) != 0) { 1145 while (NEXTBYTE() != 0) /* null */ ; 1146 } 1147 1148 /* Decompress */ 1149 if ((res = inflate())) { 1150 switch (res) { 1151 case 0: 1152 break; 1153 case 1: 1154 error("invalid compressed format (err=1)"); 1155 break; 1156 case 2: 1157 error("invalid compressed format (err=2)"); 1158 break; 1159 case 3: 1160 error("out of memory"); 1161 break; 1162 case 4: 1163 error("out of input data"); 1164 break; 1165 default: 1166 error("invalid compressed format (other)"); 1167 } 1168 return -1; 1169 } 1170 1171 /* Get the crc and original length */ 1172 /* crc32 (see algorithm.doc) 1173 * uncompressed input size modulo 2^32 1174 */ 1175 orig_crc = (ulg) NEXTBYTE(); 1176 orig_crc |= (ulg) NEXTBYTE() << 8; 1177 orig_crc |= (ulg) NEXTBYTE() << 16; 1178 orig_crc |= (ulg) NEXTBYTE() << 24; 1179 1180 orig_len = (ulg) NEXTBYTE(); 1181 orig_len |= (ulg) NEXTBYTE() << 8; 1182 orig_len |= (ulg) NEXTBYTE() << 16; 1183 orig_len |= (ulg) NEXTBYTE() << 24; 1184 1185 /* Validate decompression */ 1186 if (orig_crc != CRC_VALUE) { 1187 error("crc error"); 1188 return -1; 1189 } 1190 if (orig_len != bytes_out) { 1191 error("length error"); 1192 return -1; 1193 } 1194 return 0; 1195 1196 underrun: /* NEXTBYTE() goto's here if needed */ 1197 error("out of input data"); 1198 return -1; 1199} 1200 1201 1202

