af165336e9d0bd25dee9f8deb364f237c9135ac6
[people/mcb30/busybox.git] / archival / libunarchive / decompress_bunzip2.c
1 /* vi: set sw=4 ts=4: */
2 /*      Small bzip2 deflate implementation, by Rob Landley (rob@landley.net).
3
4         Based on bzip2 decompression code by Julian R Seward (jseward@acm.org),
5         which also acknowledges contributions by Mike Burrows, David Wheeler,
6         Peter Fenwick, Alistair Moffat, Radford Neal, Ian H. Witten,
7         Robert Sedgewick, and Jon L. Bentley.
8
9         This code is licensed under the LGPLv2:
10                 LGPL (http://www.gnu.org/copyleft/lgpl.html
11 */
12
13 /*
14         Size and speed optimizations by Manuel Novoa III  (mjn3@codepoet.org).
15
16         More efficient reading of huffman codes, a streamlined read_bunzip()
17         function, and various other tweaks.  In (limited) tests, approximately
18         20% faster than bzcat on x86 and about 10% faster on arm.
19
20         Note that about 2/3 of the time is spent in read_unzip() reversing
21         the Burrows-Wheeler transformation.  Much of that time is delay
22         resulting from cache misses.
23
24         I would ask that anyone benefiting from this work, especially those
25         using it in commercial products, consider making a donation to my local
26         non-profit hospice organization in the name of the woman I loved, who
27         passed away Feb. 12, 2003.
28
29                 In memory of Toni W. Hagan
30
31                 Hospice of Acadiana, Inc.
32                 2600 Johnston St., Suite 200
33                 Lafayette, LA 70503-3240
34
35                 Phone (337) 232-1234 or 1-800-738-2226
36                 Fax   (337) 232-1297
37
38                 http://www.hospiceacadiana.com/
39
40         Manuel
41  */
42
43 #include <setjmp.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <string.h>
47 #include <unistd.h>
48 #include <limits.h>
49
50 #include "libbb.h"
51
52 /* Constants for huffman coding */
53 #define MAX_GROUPS                      6
54 #define GROUP_SIZE              50              /* 64 would have been more efficient */
55 #define MAX_HUFCODE_BITS        20              /* Longest huffman code allowed */
56 #define MAX_SYMBOLS             258             /* 256 literals + RUNA + RUNB */
57 #define SYMBOL_RUNA                     0
58 #define SYMBOL_RUNB                     1
59
60 /* Status return values */
61 #define RETVAL_OK                                               0
62 #define RETVAL_LAST_BLOCK                               (-1)
63 #define RETVAL_NOT_BZIP_DATA                    (-2)
64 #define RETVAL_UNEXPECTED_INPUT_EOF             (-3)
65 #define RETVAL_UNEXPECTED_OUTPUT_EOF    (-4)
66 #define RETVAL_DATA_ERROR                               (-5)
67 #define RETVAL_OUT_OF_MEMORY                    (-6)
68 #define RETVAL_OBSOLETE_INPUT                   (-7)
69
70 /* Other housekeeping constants */
71 #define IOBUF_SIZE                      4096
72
73 /* This is what we know about each huffman coding group */
74 struct group_data {
75         /* We have an extra slot at the end of limit[] for a sentinal value. */
76         int limit[MAX_HUFCODE_BITS+1],base[MAX_HUFCODE_BITS],permute[MAX_SYMBOLS];
77         int minLen, maxLen;
78 };
79
80 /* Structure holding all the housekeeping data, including IO buffers and
81    memory that persists between calls to bunzip */
82 typedef struct {
83         /* State for interrupting output loop */
84         int writeCopies,writePos,writeRunCountdown,writeCount,writeCurrent;
85         /* I/O tracking data (file handles, buffers, positions, etc.) */
86         int in_fd,out_fd,inbufCount,inbufPos /*,outbufPos*/;
87         unsigned char *inbuf /*,*outbuf*/;
88         unsigned int inbufBitCount, inbufBits;
89         /* The CRC values stored in the block header and calculated from the data */
90         unsigned int crc32Table[256],headerCRC, totalCRC, writeCRC;
91         /* Intermediate buffer and its size (in bytes) */
92         unsigned int *dbuf, dbufSize;
93         /* These things are a bit too big to go on the stack */
94         unsigned char selectors[32768];                 /* nSelectors=15 bits */
95         struct group_data groups[MAX_GROUPS];   /* huffman coding tables */
96         /* For I/O error handling */
97         jmp_buf jmpbuf;
98 } bunzip_data;
99
100 /* Return the next nnn bits of input.  All reads from the compressed input
101    are done through this function.  All reads are big endian */
102 static unsigned int get_bits(bunzip_data *bd, char bits_wanted)
103 {
104         unsigned int bits=0;
105
106         /* If we need to get more data from the byte buffer, do so.  (Loop getting
107            one byte at a time to enforce endianness and avoid unaligned access.) */
108         while (bd->inbufBitCount<bits_wanted) {
109                 /* If we need to read more data from file into byte buffer, do so */
110                 if(bd->inbufPos==bd->inbufCount) {
111                         if((bd->inbufCount = read(bd->in_fd, bd->inbuf, IOBUF_SIZE)) <= 0)
112                                 longjmp(bd->jmpbuf,RETVAL_UNEXPECTED_INPUT_EOF);
113                         bd->inbufPos=0;
114                 }
115                 /* Avoid 32-bit overflow (dump bit buffer to top of output) */
116                 if(bd->inbufBitCount>=24) {
117                         bits=bd->inbufBits&((1<<bd->inbufBitCount)-1);
118                         bits_wanted-=bd->inbufBitCount;
119                         bits<<=bits_wanted;
120                         bd->inbufBitCount=0;
121                 }
122                 /* Grab next 8 bits of input from buffer. */
123                 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
124                 bd->inbufBitCount+=8;
125         }
126         /* Calculate result */
127         bd->inbufBitCount-=bits_wanted;
128         bits|=(bd->inbufBits>>bd->inbufBitCount)&((1<<bits_wanted)-1);
129
130         return bits;
131 }
132
133 /* Unpacks the next block and sets up for the inverse burrows-wheeler step. */
134
135 static int get_next_block(bunzip_data *bd)
136 {
137         struct group_data *hufGroup;
138         int dbufCount,nextSym,dbufSize,groupCount,*base,*limit,selector,
139                 i,j,k,t,runPos,symCount,symTotal,nSelectors,byteCount[256];
140         unsigned char uc, symToByte[256], mtfSymbol[256], *selectors;
141         unsigned int *dbuf,origPtr;
142
143         dbuf=bd->dbuf;
144         dbufSize=bd->dbufSize;
145         selectors=bd->selectors;
146         /* Reset longjmp I/O error handling */
147         i=setjmp(bd->jmpbuf);
148         if(i) return i;
149         /* Read in header signature and CRC, then validate signature.
150            (last block signature means CRC is for whole file, return now) */
151         i = get_bits(bd,24);
152         j = get_bits(bd,24);
153         bd->headerCRC=get_bits(bd,32);
154         if ((i == 0x177245) && (j == 0x385090)) return RETVAL_LAST_BLOCK;
155         if ((i != 0x314159) || (j != 0x265359)) return RETVAL_NOT_BZIP_DATA;
156         /* We can add support for blockRandomised if anybody complains.  There was
157            some code for this in busybox 1.0.0-pre3, but nobody ever noticed that
158            it didn't actually work. */
159         if(get_bits(bd,1)) return RETVAL_OBSOLETE_INPUT;
160         if((origPtr=get_bits(bd,24)) > dbufSize) return RETVAL_DATA_ERROR;
161         /* mapping table: if some byte values are never used (encoding things
162            like ascii text), the compression code removes the gaps to have fewer
163            symbols to deal with, and writes a sparse bitfield indicating which
164            values were present.  We make a translation table to convert the symbols
165            back to the corresponding bytes. */
166         t=get_bits(bd, 16);
167         symTotal=0;
168         for (i=0;i<16;i++) {
169                 if(t&(1<<(15-i))) {
170                         k=get_bits(bd,16);
171                         for(j=0;j<16;j++)
172                                 if(k&(1<<(15-j))) symToByte[symTotal++]=(16*i)+j;
173                 }
174         }
175         /* How many different huffman coding groups does this block use? */
176         groupCount=get_bits(bd,3);
177         if (groupCount<2 || groupCount>MAX_GROUPS) return RETVAL_DATA_ERROR;
178         /* nSelectors: Every GROUP_SIZE many symbols we select a new huffman coding
179            group.  Read in the group selector list, which is stored as MTF encoded
180            bit runs.  (MTF=Move To Front, as each value is used it's moved to the
181            start of the list.) */
182         if(!(nSelectors=get_bits(bd, 15))) return RETVAL_DATA_ERROR;
183         for(i=0; i<groupCount; i++) mtfSymbol[i] = i;
184         for(i=0; i<nSelectors; i++) {
185                 /* Get next value */
186                 for(j=0;get_bits(bd,1);j++) if (j>=groupCount) return RETVAL_DATA_ERROR;
187                 /* Decode MTF to get the next selector */
188                 uc = mtfSymbol[j];
189                 for(;j;j--) mtfSymbol[j] = mtfSymbol[j-1];
190                 mtfSymbol[0]=selectors[i]=uc;
191         }
192         /* Read the huffman coding tables for each group, which code for symTotal
193            literal symbols, plus two run symbols (RUNA, RUNB) */
194         symCount=symTotal+2;
195         for (j=0; j<groupCount; j++) {
196                 unsigned char length[MAX_SYMBOLS],temp[MAX_HUFCODE_BITS+1];
197                 int     minLen, maxLen, pp;
198                 /* Read huffman code lengths for each symbol.  They're stored in
199                    a way similar to mtf; record a starting value for the first symbol,
200                    and an offset from the previous value for everys symbol after that.
201                    (Subtracting 1 before the loop and then adding it back at the end is
202                    an optimization that makes the test inside the loop simpler: symbol
203                    length 0 becomes negative, so an unsigned inequality catches it.) */
204                 t=get_bits(bd, 5)-1;
205                 for (i = 0; i < symCount; i++) {
206                         for(;;) {
207                                 if (((unsigned)t) > (MAX_HUFCODE_BITS-1))
208                                         return RETVAL_DATA_ERROR;
209                                 /* If first bit is 0, stop.  Else second bit indicates whether
210                                    to increment or decrement the value.  Optimization: grab 2
211                                    bits and unget the second if the first was 0. */
212                                 k = get_bits(bd,2);
213                                 if (k < 2) {
214                                         bd->inbufBitCount++;
215                                         break;
216                                 }
217                                 /* Add one if second bit 1, else subtract 1.  Avoids if/else */
218                                 t+=(((k+1)&2)-1);
219                         }
220                         /* Correct for the initial -1, to get the final symbol length */
221                         length[i]=t+1;
222                 }
223                 /* Find largest and smallest lengths in this group */
224                 minLen=maxLen=length[0];
225                 for(i = 1; i < symCount; i++) {
226                         if(length[i] > maxLen) maxLen = length[i];
227                         else if(length[i] < minLen) minLen = length[i];
228                 }
229                 /* Calculate permute[], base[], and limit[] tables from length[].
230                  *
231                  * permute[] is the lookup table for converting huffman coded symbols
232                  * into decoded symbols.  base[] is the amount to subtract from the
233                  * value of a huffman symbol of a given length when using permute[].
234                  *
235                  * limit[] indicates the largest numerical value a symbol with a given
236                  * number of bits can have.  This is how the huffman codes can vary in
237                  * length: each code with a value>limit[length] needs another bit.
238                  */
239                 hufGroup=bd->groups+j;
240                 hufGroup->minLen = minLen;
241                 hufGroup->maxLen = maxLen;
242                 /* Note that minLen can't be smaller than 1, so we adjust the base
243                    and limit array pointers so we're not always wasting the first
244                    entry.  We do this again when using them (during symbol decoding).*/
245                 base=hufGroup->base-1;
246                 limit=hufGroup->limit-1;
247                 /* Calculate permute[].  Concurently, initialize temp[] and limit[]. */
248                 pp=0;
249                 for(i=minLen;i<=maxLen;i++) {
250                         temp[i]=limit[i]=0;
251                         for(t=0;t<symCount;t++)
252                                 if(length[t]==i) hufGroup->permute[pp++] = t;
253                 }
254                 /* Count symbols coded for at each bit length */
255                 for (i=0;i<symCount;i++) temp[length[i]]++;
256                 /* Calculate limit[] (the largest symbol-coding value at each bit
257                  * length, which is (previous limit<<1)+symbols at this level), and
258                  * base[] (number of symbols to ignore at each bit length, which is
259                  * limit minus the cumulative count of symbols coded for already). */
260                 pp=t=0;
261                 for (i=minLen; i<maxLen; i++) {
262                         pp+=temp[i];
263                         /* We read the largest possible symbol size and then unget bits
264                            after determining how many we need, and those extra bits could
265                            be set to anything.  (They're noise from future symbols.)  At
266                            each level we're really only interested in the first few bits,
267                            so here we set all the trailing to-be-ignored bits to 1 so they
268                            don't affect the value>limit[length] comparison. */
269                         limit[i]= (pp << (maxLen - i)) - 1;
270                         pp<<=1;
271                         base[i+1]=pp-(t+=temp[i]);
272                 }
273                 limit[maxLen+1] = INT_MAX; /* Sentinal value for reading next sym. */
274                 limit[maxLen]=pp+temp[maxLen]-1;
275                 base[minLen]=0;
276         }
277         /* We've finished reading and digesting the block header.  Now read this
278            block's huffman coded symbols from the file and undo the huffman coding
279            and run length encoding, saving the result into dbuf[dbufCount++]=uc */
280
281         /* Initialize symbol occurrence counters and symbol Move To Front table */
282         for(i=0;i<256;i++) {
283                 byteCount[i] = 0;
284                 mtfSymbol[i]=(unsigned char)i;
285         }
286         /* Loop through compressed symbols. */
287         runPos=dbufCount=symCount=selector=0;
288         for(;;) {
289                 /* Determine which huffman coding group to use. */
290                 if(!(symCount--)) {
291                         symCount=GROUP_SIZE-1;
292                         if(selector>=nSelectors) return RETVAL_DATA_ERROR;
293                         hufGroup=bd->groups+selectors[selector++];
294                         base=hufGroup->base-1;
295                         limit=hufGroup->limit-1;
296                 }
297                 /* Read next huffman-coded symbol. */
298                 /* Note: It is far cheaper to read maxLen bits and back up than it is
299                    to read minLen bits and then an additional bit at a time, testing
300                    as we go.  Because there is a trailing last block (with file CRC),
301                    there is no danger of the overread causing an unexpected EOF for a
302                    valid compressed file.  As a further optimization, we do the read
303                    inline (falling back to a call to get_bits if the buffer runs
304                    dry).  The following (up to got_huff_bits:) is equivalent to
305                    j=get_bits(bd,hufGroup->maxLen);
306                  */
307                 while (bd->inbufBitCount<hufGroup->maxLen) {
308                         if(bd->inbufPos==bd->inbufCount) {
309                                 j = get_bits(bd,hufGroup->maxLen);
310                                 goto got_huff_bits;
311                         }
312                         bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
313                         bd->inbufBitCount+=8;
314                 };
315                 bd->inbufBitCount-=hufGroup->maxLen;
316                 j = (bd->inbufBits>>bd->inbufBitCount)&((1<<hufGroup->maxLen)-1);
317 got_huff_bits:
318                 /* Figure how how many bits are in next symbol and unget extras */
319                 i=hufGroup->minLen;
320                 while(j>limit[i]) ++i;
321                 bd->inbufBitCount += (hufGroup->maxLen - i);
322                 /* Huffman decode value to get nextSym (with bounds checking) */
323                 if ((i > hufGroup->maxLen)
324                         || (((unsigned)(j=(j>>(hufGroup->maxLen-i))-base[i]))
325                                 >= MAX_SYMBOLS))
326                         return RETVAL_DATA_ERROR;
327                 nextSym = hufGroup->permute[j];
328                 /* We have now decoded the symbol, which indicates either a new literal
329                    byte, or a repeated run of the most recent literal byte.  First,
330                    check if nextSym indicates a repeated run, and if so loop collecting
331                    how many times to repeat the last literal. */
332                 if (((unsigned)nextSym) <= SYMBOL_RUNB) { /* RUNA or RUNB */
333                         /* If this is the start of a new run, zero out counter */
334                         if(!runPos) {
335                                 runPos = 1;
336                                 t = 0;
337                         }
338                         /* Neat trick that saves 1 symbol: instead of or-ing 0 or 1 at
339                            each bit position, add 1 or 2 instead.  For example,
340                            1011 is 1<<0 + 1<<1 + 2<<2.  1010 is 2<<0 + 2<<1 + 1<<2.
341                            You can make any bit pattern that way using 1 less symbol than
342                            the basic or 0/1 method (except all bits 0, which would use no
343                            symbols, but a run of length 0 doesn't mean anything in this
344                            context).  Thus space is saved. */
345                         t += (runPos << nextSym); /* +runPos if RUNA; +2*runPos if RUNB */
346                         runPos <<= 1;
347                         continue;
348                 }
349                 /* When we hit the first non-run symbol after a run, we now know
350                    how many times to repeat the last literal, so append that many
351                    copies to our buffer of decoded symbols (dbuf) now.  (The last
352                    literal used is the one at the head of the mtfSymbol array.) */
353                 if(runPos) {
354                         runPos=0;
355                         if(dbufCount+t>=dbufSize) return RETVAL_DATA_ERROR;
356
357                         uc = symToByte[mtfSymbol[0]];
358                         byteCount[uc] += t;
359                         while(t--) dbuf[dbufCount++]=uc;
360                 }
361                 /* Is this the terminating symbol? */
362                 if(nextSym>symTotal) break;
363                 /* At this point, nextSym indicates a new literal character.  Subtract
364                    one to get the position in the MTF array at which this literal is
365                    currently to be found.  (Note that the result can't be -1 or 0,
366                    because 0 and 1 are RUNA and RUNB.  But another instance of the
367                    first symbol in the mtf array, position 0, would have been handled
368                    as part of a run above.  Therefore 1 unused mtf position minus
369                    2 non-literal nextSym values equals -1.) */
370                 if(dbufCount>=dbufSize) return RETVAL_DATA_ERROR;
371                 i = nextSym - 1;
372                 uc = mtfSymbol[i];
373                 /* Adjust the MTF array.  Since we typically expect to move only a
374                  * small number of symbols, and are bound by 256 in any case, using
375                  * memmove here would typically be bigger and slower due to function
376                  * call overhead and other assorted setup costs. */
377                 do {
378                         mtfSymbol[i] = mtfSymbol[i-1];
379                 } while (--i);
380                 mtfSymbol[0] = uc;
381                 uc=symToByte[uc];
382                 /* We have our literal byte.  Save it into dbuf. */
383                 byteCount[uc]++;
384                 dbuf[dbufCount++] = (unsigned int)uc;
385         }
386         /* At this point, we've read all the huffman-coded symbols (and repeated
387        runs) for this block from the input stream, and decoded them into the
388            intermediate buffer.  There are dbufCount many decoded bytes in dbuf[].
389            Now undo the Burrows-Wheeler transform on dbuf.
390            See http://dogma.net/markn/articles/bwt/bwt.htm
391          */
392         /* Turn byteCount into cumulative occurrence counts of 0 to n-1. */
393         j=0;
394         for(i=0;i<256;i++) {
395                 k=j+byteCount[i];
396                 byteCount[i] = j;
397                 j=k;
398         }
399         /* Figure out what order dbuf would be in if we sorted it. */
400         for (i=0;i<dbufCount;i++) {
401                 uc=(unsigned char)(dbuf[i] & 0xff);
402                 dbuf[byteCount[uc]] |= (i << 8);
403                 byteCount[uc]++;
404         }
405         /* Decode first byte by hand to initialize "previous" byte.  Note that it
406            doesn't get output, and if the first three characters are identical
407            it doesn't qualify as a run (hence writeRunCountdown=5). */
408         if(dbufCount) {
409                 if(origPtr>=dbufCount) return RETVAL_DATA_ERROR;
410                 bd->writePos=dbuf[origPtr];
411             bd->writeCurrent=(unsigned char)(bd->writePos&0xff);
412                 bd->writePos>>=8;
413                 bd->writeRunCountdown=5;
414         }
415         bd->writeCount=dbufCount;
416
417         return RETVAL_OK;
418 }
419
420 /* Undo burrows-wheeler transform on intermediate buffer to produce output.
421    If start_bunzip was initialized with out_fd=-1, then up to len bytes of
422    data are written to outbuf.  Return value is number of bytes written or
423    error (all errors are negative numbers).  If out_fd!=-1, outbuf and len
424    are ignored, data is written to out_fd and return is RETVAL_OK or error.
425 */
426
427 static int read_bunzip(bunzip_data *bd, char *outbuf, int len)
428 {
429         const unsigned int *dbuf;
430         int pos,current,previous,gotcount;
431
432         /* If last read was short due to end of file, return last block now */
433         if(bd->writeCount<0) return bd->writeCount;
434
435         gotcount = 0;
436         dbuf=bd->dbuf;
437         pos=bd->writePos;
438         current=bd->writeCurrent;
439
440         /* We will always have pending decoded data to write into the output
441            buffer unless this is the very first call (in which case we haven't
442            huffman-decoded a block into the intermediate buffer yet). */
443
444         if (bd->writeCopies) {
445                 /* Inside the loop, writeCopies means extra copies (beyond 1) */
446                 --bd->writeCopies;
447                 /* Loop outputting bytes */
448                 for(;;) {
449                         /* If the output buffer is full, snapshot state and return */
450                         if(gotcount >= len) {
451                                 bd->writePos=pos;
452                                 bd->writeCurrent=current;
453                                 bd->writeCopies++;
454                                 return len;
455                         }
456                         /* Write next byte into output buffer, updating CRC */
457                         outbuf[gotcount++] = current;
458                         bd->writeCRC=(((bd->writeCRC)<<8)
459                                                   ^bd->crc32Table[((bd->writeCRC)>>24)^current]);
460                         /* Loop now if we're outputting multiple copies of this byte */
461                         if (bd->writeCopies) {
462                                 --bd->writeCopies;
463                                 continue;
464                         }
465 decode_next_byte:
466                         if (!bd->writeCount--) break;
467                         /* Follow sequence vector to undo Burrows-Wheeler transform */
468                         previous=current;
469                         pos=dbuf[pos];
470                         current=pos&0xff;
471                         pos>>=8;
472                         /* After 3 consecutive copies of the same byte, the 4th is a repeat
473                            count.  We count down from 4 instead
474                          * of counting up because testing for non-zero is faster */
475                         if(--bd->writeRunCountdown) {
476                                 if(current!=previous) bd->writeRunCountdown=4;
477                         } else {
478                                 /* We have a repeated run, this byte indicates the count */
479                                 bd->writeCopies=current;
480                                 current=previous;
481                                 bd->writeRunCountdown=5;
482                                 /* Sometimes there are just 3 bytes (run length 0) */
483                                 if(!bd->writeCopies) goto decode_next_byte;
484                                 /* Subtract the 1 copy we'd output anyway to get extras */
485                                 --bd->writeCopies;
486                         }
487                 }
488                 /* Decompression of this block completed successfully */
489                 bd->writeCRC=~bd->writeCRC;
490                 bd->totalCRC=((bd->totalCRC<<1) | (bd->totalCRC>>31)) ^ bd->writeCRC;
491                 /* If this block had a CRC error, force file level CRC error. */
492                 if(bd->writeCRC!=bd->headerCRC) {
493                         bd->totalCRC=bd->headerCRC+1;
494                         return RETVAL_LAST_BLOCK;
495                 }
496         }
497
498         /* Refill the intermediate buffer by huffman-decoding next block of input */
499         /* (previous is just a convenient unused temp variable here) */
500         previous=get_next_block(bd);
501         if(previous) {
502                 bd->writeCount=previous;
503                 return (previous!=RETVAL_LAST_BLOCK) ? previous : gotcount;
504         }
505         bd->writeCRC=0xffffffffUL;
506         pos=bd->writePos;
507         current=bd->writeCurrent;
508         goto decode_next_byte;
509 }
510
511 /* Allocate the structure, read file header.  If in_fd==-1, inbuf must contain
512    a complete bunzip file (len bytes long).  If in_fd!=-1, inbuf and len are
513    ignored, and data is read from file handle into temporary buffer. */
514 static int start_bunzip(bunzip_data **bdp, int in_fd, char *inbuf, int len)
515 {
516         bunzip_data *bd;
517         unsigned int i,j,c;
518         const unsigned int BZh0=(((unsigned int)'B')<<24)+(((unsigned int)'Z')<<16)
519                                                         +(((unsigned int)'h')<<8)+(unsigned int)'0';
520
521         /* Figure out how much data to allocate */
522         i=sizeof(bunzip_data);
523         if(in_fd!=-1) i+=IOBUF_SIZE;
524         /* Allocate bunzip_data.  Most fields initialize to zero. */
525         bd=*bdp=xmalloc(i);
526         memset(bd,0,sizeof(bunzip_data));
527         /* Setup input buffer */
528         if(-1==(bd->in_fd=in_fd)) {
529                 bd->inbuf=inbuf;
530                 bd->inbufCount=len;
531         } else bd->inbuf=(unsigned char *)(bd+1);
532         /* Init the CRC32 table (big endian) */
533         for(i=0;i<256;i++) {
534                 c=i<<24;
535                 for(j=8;j;j--)
536                         c=c&0x80000000 ? (c<<1)^0x04c11db7 : (c<<1);
537                 bd->crc32Table[i]=c;
538         }
539         /* Setup for I/O error handling via longjmp */
540         i=setjmp(bd->jmpbuf);
541         if(i) return i;
542
543         /* Ensure that file starts with "BZh['1'-'9']." */
544         i = get_bits(bd,32);
545         if (((unsigned int)(i-BZh0-1)) >= 9) return RETVAL_NOT_BZIP_DATA;
546
547         /* Fourth byte (ascii '1'-'9'), indicates block size in units of 100k of
548            uncompressed data.  Allocate intermediate buffer for block. */
549         bd->dbufSize=100000*(i-BZh0);
550
551         bd->dbuf=xmalloc(bd->dbufSize * sizeof(int));
552         return RETVAL_OK;
553 }
554
555 /* Example usage: decompress src_fd to dst_fd.  (Stops at end of bzip data,
556    not end of file.) */
557 extern int uncompressStream(int src_fd, int dst_fd)
558 {
559         char *outbuf;
560         bunzip_data *bd;
561         int i;
562
563         outbuf=xmalloc(IOBUF_SIZE);
564         if(!(i=start_bunzip(&bd,src_fd,0,0))) {
565                 for(;;) {
566                         if((i=read_bunzip(bd,outbuf,IOBUF_SIZE)) <= 0) break;
567                         if(i!=write(dst_fd,outbuf,i)) {
568                                 i=RETVAL_UNEXPECTED_OUTPUT_EOF;
569                                 break;
570                         }
571                 }
572         }
573         /* Check CRC and release memory */
574         if(i==RETVAL_LAST_BLOCK) {
575                 if (bd->headerCRC!=bd->totalCRC) {
576                         bb_error_msg("Data integrity error when decompressing.");
577                 } else {
578                         i=RETVAL_OK;
579                 }
580         }
581         else if (i==RETVAL_UNEXPECTED_OUTPUT_EOF) {
582                 bb_error_msg("Compressed file ends unexpectedly");
583         } else {
584                 bb_error_msg("Decompression failed");
585         }
586         if(bd->dbuf) free(bd->dbuf);
587         free(bd);
588         free(outbuf);
589
590         return i;
591 }
592
593 #ifdef TESTING
594
595 static char * const bunzip_errors[]={NULL,"Bad file checksum","Not bzip data",
596                 "Unexpected input EOF","Unexpected output EOF","Data error",
597                  "Out of memory","Obsolete (pre 0.9.5) bzip format not supported."};
598
599 /* Dumb little test thing, decompress stdin to stdout */
600 int main(int argc, char *argv[])
601 {
602         int i=uncompressStream(0,1);
603         char c;
604
605         if(i) fprintf(stderr,"%s\n", bunzip_errors[-i]);
606     else if(read(0,&c,1)) fprintf(stderr,"Trailing garbage ignored\n");
607         return -i;
608 }
609 #endif