blob: 07e3cf01890469582a970a956a6ad4f05bfb2860 [file] [log] [blame]
Eric Andersen0d6d88a2003-10-18 01:58:35 +00001/* vi: set sw=4 ts=4: */
2/* Small bzip2 deflate implementation, by Rob Landley (rob@landley.net).
Glenn L McGrath60bce492002-11-03 07:28:38 +00003
Eric Andersen0d6d88a2003-10-18 01:58:35 +00004 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.
Glenn L McGrath60bce492002-11-03 07:28:38 +00008
Eric Andersen0d6d88a2003-10-18 01:58:35 +00009 This code is licensed under the LGPLv2:
10 LGPL (http://www.gnu.org/copyleft/lgpl.html
11*/
Glenn L McGrath60bce492002-11-03 07:28:38 +000012
Eric Andersen5fa4db22003-10-23 06:52:01 +000013/*
14 Size and speed optimizations by Manuel Novoa III (mjn3@codepoet.org).
15
Eric Andersenaff114c2004-04-14 17:51:38 +000016 More efficient reading of Huffman codes, a streamlined read_bunzip()
Eric Andersen5fa4db22003-10-23 06:52:01 +000017 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
Eric Andersen0d6d88a2003-10-18 01:58:35 +000043#include <setjmp.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000044#include <stdio.h>
Eric Andersen0d6d88a2003-10-18 01:58:35 +000045#include <stdlib.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000046#include <string.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000047#include <unistd.h>
Eric Andersen1acfb722003-10-18 01:59:46 +000048#include <limits.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000049
Glenn L McGrath1c834402003-10-28 23:32:12 +000050#include "libbb.h"
51
Eric Andersenaff114c2004-04-14 17:51:38 +000052/* Constants for Huffman coding */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000053#define MAX_GROUPS 6
54#define GROUP_SIZE 50 /* 64 would have been more efficient */
Eric Andersenaff114c2004-04-14 17:51:38 +000055#define MAX_HUFCODE_BITS 20 /* Longest Huffman code allowed */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000056#define MAX_SYMBOLS 258 /* 256 literals + RUNA + RUNB */
57#define SYMBOL_RUNA 0
58#define SYMBOL_RUNB 1
Glenn L McGrath60bce492002-11-03 07:28:38 +000059
Eric Andersen0d6d88a2003-10-18 01:58:35 +000060/* 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)
Glenn L McGrath60bce492002-11-03 07:28:38 +000069
Eric Andersen0d6d88a2003-10-18 01:58:35 +000070/* Other housekeeping constants */
71#define IOBUF_SIZE 4096
Glenn L McGrath60bce492002-11-03 07:28:38 +000072
Eric Andersenaff114c2004-04-14 17:51:38 +000073/* This is what we know about each Huffman coding group */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000074struct group_data {
Eric Andersen1acfb722003-10-18 01:59:46 +000075 /* 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];
Eric Andersen5fa4db22003-10-23 06:52:01 +000077 int minLen, maxLen;
Glenn L McGrath60bce492002-11-03 07:28:38 +000078};
79
Eric Andersen0d6d88a2003-10-18 01:58:35 +000080/* Structure holding all the housekeeping data, including IO buffers and
81 memory that persists between calls to bunzip */
82typedef struct {
Eric Andersen5fa4db22003-10-23 06:52:01 +000083 /* 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*/;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000088 unsigned int inbufBitCount, inbufBits;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000089 /* The CRC values stored in the block header and calculated from the data */
Eric Andersen5fa4db22003-10-23 06:52:01 +000090 unsigned int crc32Table[256],headerCRC, totalCRC, writeCRC;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000091 /* Intermediate buffer and its size (in bytes) */
92 unsigned int *dbuf, dbufSize;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000093 /* These things are a bit too big to go on the stack */
94 unsigned char selectors[32768]; /* nSelectors=15 bits */
Eric Andersenaff114c2004-04-14 17:51:38 +000095 struct group_data groups[MAX_GROUPS]; /* Huffman coding tables */
Eric Andersen5fa4db22003-10-23 06:52:01 +000096 /* For I/O error handling */
97 jmp_buf jmpbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000098} 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 */
102static unsigned int get_bits(bunzip_data *bd, char bits_wanted)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000103{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000104 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) {
Eric Andersen1acfb722003-10-18 01:59:46 +0000111 if((bd->inbufCount = read(bd->in_fd, bd->inbuf, IOBUF_SIZE)) <= 0)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000112 longjmp(bd->jmpbuf,RETVAL_UNEXPECTED_INPUT_EOF);
113 bd->inbufPos=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000114 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000115 /* 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;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000125 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000126 /* Calculate result */
127 bd->inbufBitCount-=bits_wanted;
128 bits|=(bd->inbufBits>>bd->inbufBitCount)&((1<<bits_wanted)-1);
129
130 return bits;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000131}
132
Eric Andersen5fa4db22003-10-23 06:52:01 +0000133/* Unpacks the next block and sets up for the inverse burrows-wheeler step. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000134
Eric Andersen5fa4db22003-10-23 06:52:01 +0000135static int get_next_block(bunzip_data *bd)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000136{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000137 struct group_data *hufGroup;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000138 int dbufCount,nextSym,dbufSize,groupCount,*base,*limit,selector,
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000139 i,j,k,t,runPos,symCount,symTotal,nSelectors,byteCount[256];
140 unsigned char uc, symToByte[256], mtfSymbol[256], *selectors;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000141 unsigned int *dbuf,origPtr;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000142
143 dbuf=bd->dbuf;
144 dbufSize=bd->dbufSize;
145 selectors=bd->selectors;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000146 /* 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;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000156 /* 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);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000167 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;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000173 }
174 }
Eric Andersenaff114c2004-04-14 17:51:38 +0000175 /* How many different Huffman coding groups does this block use? */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000176 groupCount=get_bits(bd,3);
177 if (groupCount<2 || groupCount>MAX_GROUPS) return RETVAL_DATA_ERROR;
Eric Andersenaff114c2004-04-14 17:51:38 +0000178 /* nSelectors: Every GROUP_SIZE many symbols we select a new Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000179 group. Read in the group selector list, which is stored as MTF encoded
Eric Andersen5fa4db22003-10-23 06:52:01 +0000180 bit runs. (MTF=Move To Front, as each value is used it's moved to the
181 start of the list.) */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000182 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];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000189 for(;j;j--) mtfSymbol[j] = mtfSymbol[j-1];
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000190 mtfSymbol[0]=selectors[i]=uc;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000191 }
Eric Andersenaff114c2004-04-14 17:51:38 +0000192 /* Read the Huffman coding tables for each group, which code for symTotal
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000193 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;
Eric Andersenaff114c2004-04-14 17:51:38 +0000198 /* Read Huffman code lengths for each symbol. They're stored in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000199 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;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000205 for (i = 0; i < symCount; i++) {
206 for(;;) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000207 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);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000219 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000220 /* Correct for the initial -1, to get the final symbol length */
221 length[i]=t+1;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000222 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000223 /* 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];
Glenn L McGrath60bce492002-11-03 07:28:38 +0000228 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000229 /* Calculate permute[], base[], and limit[] tables from length[].
230 *
Eric Andersenaff114c2004-04-14 17:51:38 +0000231 * permute[] is the lookup table for converting Huffman coded symbols
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000232 * into decoded symbols. base[] is the amount to subtract from the
Eric Andersenaff114c2004-04-14 17:51:38 +0000233 * value of a Huffman symbol of a given length when using permute[].
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000234 *
235 * limit[] indicates the largest numerical value a symbol with a given
Eric Andersenaff114c2004-04-14 17:51:38 +0000236 * number of bits can have. This is how the Huffman codes can vary in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000237 * length: each code with a value>limit[length] needs another bit.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000238 */
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;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000247 /* Calculate permute[]. Concurently, initialize temp[] and limit[]. */
248 pp=0;
249 for(i=minLen;i<=maxLen;i++) {
250 temp[i]=limit[i]=0;
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000251 for(t=0;t<symCount;t++)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000252 if(length[t]==i) hufGroup->permute[pp++] = t;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000253 }
254 /* Count symbols coded for at each bit length */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000255 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
Eric Andersen5fa4db22003-10-23 06:52:01 +0000259 * limit minus the cumulative count of symbols coded for already). */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000260 pp=t=0;
261 for (i=minLen; i<maxLen; i++) {
262 pp+=temp[i];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000263 /* 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;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000270 pp<<=1;
271 base[i+1]=pp-(t+=temp[i]);
272 }
Eric Andersen1acfb722003-10-18 01:59:46 +0000273 limit[maxLen+1] = INT_MAX; /* Sentinal value for reading next sym. */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000274 limit[maxLen]=pp+temp[maxLen]-1;
275 base[minLen]=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000276 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000277 /* We've finished reading and digesting the block header. Now read this
Eric Andersenaff114c2004-04-14 17:51:38 +0000278 block's Huffman coded symbols from the file and undo the Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000279 and run length encoding, saving the result into dbuf[dbufCount++]=uc */
Glenn L McGrath60bce492002-11-03 07:28:38 +0000280
Eric Andersen5fa4db22003-10-23 06:52:01 +0000281 /* 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. */
Rob Landleya8b98d62004-11-16 12:07:04 +0000287 runPos=dbufCount=selector=0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000288 for(;;) {
Rob Landleya8b98d62004-11-16 12:07:04 +0000289 /* fetch next Huffman coding group from list. */
290 symCount=GROUP_SIZE-1;
291 if(selector>=nSelectors) return RETVAL_DATA_ERROR;
292 hufGroup=bd->groups+selectors[selector++];
293 base=hufGroup->base-1;
294 limit=hufGroup->limit-1;
295continue_this_group:
Eric Andersenaff114c2004-04-14 17:51:38 +0000296 /* Read next Huffman-coded symbol. */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000297 /* Note: It is far cheaper to read maxLen bits and back up than it is
298 to read minLen bits and then an additional bit at a time, testing
299 as we go. Because there is a trailing last block (with file CRC),
300 there is no danger of the overread causing an unexpected EOF for a
301 valid compressed file. As a further optimization, we do the read
302 inline (falling back to a call to get_bits if the buffer runs
303 dry). The following (up to got_huff_bits:) is equivalent to
304 j=get_bits(bd,hufGroup->maxLen);
305 */
306 while (bd->inbufBitCount<hufGroup->maxLen) {
307 if(bd->inbufPos==bd->inbufCount) {
308 j = get_bits(bd,hufGroup->maxLen);
309 goto got_huff_bits;
310 }
311 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
312 bd->inbufBitCount+=8;
313 };
314 bd->inbufBitCount-=hufGroup->maxLen;
315 j = (bd->inbufBits>>bd->inbufBitCount)&((1<<hufGroup->maxLen)-1);
316got_huff_bits:
317 /* Figure how how many bits are in next symbol and unget extras */
318 i=hufGroup->minLen;
319 while(j>limit[i]) ++i;
320 bd->inbufBitCount += (hufGroup->maxLen - i);
321 /* Huffman decode value to get nextSym (with bounds checking) */
322 if ((i > hufGroup->maxLen)
323 || (((unsigned)(j=(j>>(hufGroup->maxLen-i))-base[i]))
324 >= MAX_SYMBOLS))
325 return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000326 nextSym = hufGroup->permute[j];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000327 /* We have now decoded the symbol, which indicates either a new literal
328 byte, or a repeated run of the most recent literal byte. First,
329 check if nextSym indicates a repeated run, and if so loop collecting
330 how many times to repeat the last literal. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000331 if (((unsigned)nextSym) <= SYMBOL_RUNB) { /* RUNA or RUNB */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000332 /* If this is the start of a new run, zero out counter */
333 if(!runPos) {
334 runPos = 1;
335 t = 0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000336 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000337 /* Neat trick that saves 1 symbol: instead of or-ing 0 or 1 at
338 each bit position, add 1 or 2 instead. For example,
339 1011 is 1<<0 + 1<<1 + 2<<2. 1010 is 2<<0 + 2<<1 + 1<<2.
340 You can make any bit pattern that way using 1 less symbol than
341 the basic or 0/1 method (except all bits 0, which would use no
342 symbols, but a run of length 0 doesn't mean anything in this
343 context). Thus space is saved. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000344 t += (runPos << nextSym); /* +runPos if RUNA; +2*runPos if RUNB */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000345 runPos <<= 1;
Rob Landleya8b98d62004-11-16 12:07:04 +0000346 goto end_of_huffman_loop;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000347 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000348 /* When we hit the first non-run symbol after a run, we now know
349 how many times to repeat the last literal, so append that many
350 copies to our buffer of decoded symbols (dbuf) now. (The last
351 literal used is the one at the head of the mtfSymbol array.) */
352 if(runPos) {
353 runPos=0;
354 if(dbufCount+t>=dbufSize) return RETVAL_DATA_ERROR;
355
356 uc = symToByte[mtfSymbol[0]];
357 byteCount[uc] += t;
358 while(t--) dbuf[dbufCount++]=uc;
359 }
360 /* Is this the terminating symbol? */
361 if(nextSym>symTotal) break;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000362 /* At this point, nextSym indicates a new literal character. Subtract
363 one to get the position in the MTF array at which this literal is
364 currently to be found. (Note that the result can't be -1 or 0,
365 because 0 and 1 are RUNA and RUNB. But another instance of the
366 first symbol in the mtf array, position 0, would have been handled
367 as part of a run above. Therefore 1 unused mtf position minus
368 2 non-literal nextSym values equals -1.) */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000369 if(dbufCount>=dbufSize) return RETVAL_DATA_ERROR;
370 i = nextSym - 1;
371 uc = mtfSymbol[i];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000372 /* Adjust the MTF array. Since we typically expect to move only a
373 * small number of symbols, and are bound by 256 in any case, using
374 * memmove here would typically be bigger and slower due to function
375 * call overhead and other assorted setup costs. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000376 do {
377 mtfSymbol[i] = mtfSymbol[i-1];
378 } while (--i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000379 mtfSymbol[0] = uc;
380 uc=symToByte[uc];
381 /* We have our literal byte. Save it into dbuf. */
382 byteCount[uc]++;
383 dbuf[dbufCount++] = (unsigned int)uc;
Rob Landleya8b98d62004-11-16 12:07:04 +0000384 /* Skip group initialization if we're not done with this group. Done this
385 * way to avoid compiler warning. */
386end_of_huffman_loop:
387 if(symCount--) goto continue_this_group;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000388 }
Eric Andersenaff114c2004-04-14 17:51:38 +0000389 /* At this point, we've read all the Huffman-coded symbols (and repeated
Eric Andersen5fa4db22003-10-23 06:52:01 +0000390 runs) for this block from the input stream, and decoded them into the
391 intermediate buffer. There are dbufCount many decoded bytes in dbuf[].
392 Now undo the Burrows-Wheeler transform on dbuf.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000393 See http://dogma.net/markn/articles/bwt/bwt.htm
394 */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000395 /* Turn byteCount into cumulative occurrence counts of 0 to n-1. */
396 j=0;
397 for(i=0;i<256;i++) {
398 k=j+byteCount[i];
399 byteCount[i] = j;
400 j=k;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000401 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000402 /* Figure out what order dbuf would be in if we sorted it. */
403 for (i=0;i<dbufCount;i++) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000404 uc=(unsigned char)(dbuf[i] & 0xff);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000405 dbuf[byteCount[uc]] |= (i << 8);
406 byteCount[uc]++;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000407 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000408 /* Decode first byte by hand to initialize "previous" byte. Note that it
409 doesn't get output, and if the first three characters are identical
Eric Andersen5fa4db22003-10-23 06:52:01 +0000410 it doesn't qualify as a run (hence writeRunCountdown=5). */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000411 if(dbufCount) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000412 if(origPtr>=dbufCount) return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000413 bd->writePos=dbuf[origPtr];
414 bd->writeCurrent=(unsigned char)(bd->writePos&0xff);
415 bd->writePos>>=8;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000416 bd->writeRunCountdown=5;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000417 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000418 bd->writeCount=dbufCount;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000419
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000420 return RETVAL_OK;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000421}
422
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000423/* Undo burrows-wheeler transform on intermediate buffer to produce output.
Eric Andersen5fa4db22003-10-23 06:52:01 +0000424 If start_bunzip was initialized with out_fd=-1, then up to len bytes of
425 data are written to outbuf. Return value is number of bytes written or
426 error (all errors are negative numbers). If out_fd!=-1, outbuf and len
427 are ignored, data is written to out_fd and return is RETVAL_OK or error.
428*/
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000429
Glenn L McGrath5699b852003-11-15 23:19:05 +0000430static int read_bunzip(bunzip_data *bd, char *outbuf, int len)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000431{
432 const unsigned int *dbuf;
433 int pos,current,previous,gotcount;
434
435 /* If last read was short due to end of file, return last block now */
436 if(bd->writeCount<0) return bd->writeCount;
437
438 gotcount = 0;
439 dbuf=bd->dbuf;
440 pos=bd->writePos;
441 current=bd->writeCurrent;
442
443 /* We will always have pending decoded data to write into the output
444 buffer unless this is the very first call (in which case we haven't
Eric Andersenaff114c2004-04-14 17:51:38 +0000445 Huffman-decoded a block into the intermediate buffer yet). */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000446
447 if (bd->writeCopies) {
448 /* Inside the loop, writeCopies means extra copies (beyond 1) */
449 --bd->writeCopies;
450 /* Loop outputting bytes */
451 for(;;) {
452 /* If the output buffer is full, snapshot state and return */
453 if(gotcount >= len) {
454 bd->writePos=pos;
455 bd->writeCurrent=current;
456 bd->writeCopies++;
457 return len;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000458 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000459 /* Write next byte into output buffer, updating CRC */
460 outbuf[gotcount++] = current;
461 bd->writeCRC=(((bd->writeCRC)<<8)
462 ^bd->crc32Table[((bd->writeCRC)>>24)^current]);
463 /* Loop now if we're outputting multiple copies of this byte */
464 if (bd->writeCopies) {
465 --bd->writeCopies;
466 continue;
467 }
468decode_next_byte:
469 if (!bd->writeCount--) break;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000470 /* Follow sequence vector to undo Burrows-Wheeler transform */
471 previous=current;
472 pos=dbuf[pos];
473 current=pos&0xff;
474 pos>>=8;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000475 /* After 3 consecutive copies of the same byte, the 4th is a repeat
476 count. We count down from 4 instead
477 * of counting up because testing for non-zero is faster */
478 if(--bd->writeRunCountdown) {
479 if(current!=previous) bd->writeRunCountdown=4;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000480 } else {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000481 /* We have a repeated run, this byte indicates the count */
482 bd->writeCopies=current;
483 current=previous;
484 bd->writeRunCountdown=5;
485 /* Sometimes there are just 3 bytes (run length 0) */
486 if(!bd->writeCopies) goto decode_next_byte;
487 /* Subtract the 1 copy we'd output anyway to get extras */
488 --bd->writeCopies;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000489 }
490 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000491 /* Decompression of this block completed successfully */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000492 bd->writeCRC=~bd->writeCRC;
493 bd->totalCRC=((bd->totalCRC<<1) | (bd->totalCRC>>31)) ^ bd->writeCRC;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000494 /* If this block had a CRC error, force file level CRC error. */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000495 if(bd->writeCRC!=bd->headerCRC) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000496 bd->totalCRC=bd->headerCRC+1;
497 return RETVAL_LAST_BLOCK;
498 }
Glenn L McGrath60bce492002-11-03 07:28:38 +0000499 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000500
Eric Andersenaff114c2004-04-14 17:51:38 +0000501 /* Refill the intermediate buffer by Huffman-decoding next block of input */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000502 /* (previous is just a convenient unused temp variable here) */
503 previous=get_next_block(bd);
504 if(previous) {
505 bd->writeCount=previous;
506 return (previous!=RETVAL_LAST_BLOCK) ? previous : gotcount;
507 }
508 bd->writeCRC=0xffffffffUL;
509 pos=bd->writePos;
510 current=bd->writeCurrent;
511 goto decode_next_byte;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000512}
513
Eric Andersen5fa4db22003-10-23 06:52:01 +0000514/* Allocate the structure, read file header. If in_fd==-1, inbuf must contain
515 a complete bunzip file (len bytes long). If in_fd!=-1, inbuf and len are
516 ignored, and data is read from file handle into temporary buffer. */
Glenn L McGrath5699b852003-11-15 23:19:05 +0000517static int start_bunzip(bunzip_data **bdp, int in_fd, char *inbuf, int len)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000518{
519 bunzip_data *bd;
520 unsigned int i,j,c;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000521 const unsigned int BZh0=(((unsigned int)'B')<<24)+(((unsigned int)'Z')<<16)
522 +(((unsigned int)'h')<<8)+(unsigned int)'0';
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000523
524 /* Figure out how much data to allocate */
525 i=sizeof(bunzip_data);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000526 if(in_fd!=-1) i+=IOBUF_SIZE;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000527 /* Allocate bunzip_data. Most fields initialize to zero. */
Glenn L McGrath1c834402003-10-28 23:32:12 +0000528 bd=*bdp=xmalloc(i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000529 memset(bd,0,sizeof(bunzip_data));
Eric Andersen5fa4db22003-10-23 06:52:01 +0000530 /* Setup input buffer */
531 if(-1==(bd->in_fd=in_fd)) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000532 bd->inbuf=inbuf;
533 bd->inbufCount=len;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000534 } else bd->inbuf=(unsigned char *)(bd+1);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000535 /* Init the CRC32 table (big endian) */
536 for(i=0;i<256;i++) {
537 c=i<<24;
538 for(j=8;j;j--)
539 c=c&0x80000000 ? (c<<1)^0x04c11db7 : (c<<1);
540 bd->crc32Table[i]=c;
541 }
542 /* Setup for I/O error handling via longjmp */
543 i=setjmp(bd->jmpbuf);
544 if(i) return i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000545
546 /* Ensure that file starts with "BZh['1'-'9']." */
547 i = get_bits(bd,32);
548 if (((unsigned int)(i-BZh0-1)) >= 9) return RETVAL_NOT_BZIP_DATA;
549
550 /* Fourth byte (ascii '1'-'9'), indicates block size in units of 100k of
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000551 uncompressed data. Allocate intermediate buffer for block. */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000552 bd->dbufSize=100000*(i-BZh0);
553
Glenn L McGrath1c834402003-10-28 23:32:12 +0000554 bd->dbuf=xmalloc(bd->dbufSize * sizeof(int));
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000555 return RETVAL_OK;
556}
557
Eric Andersen5fa4db22003-10-23 06:52:01 +0000558/* Example usage: decompress src_fd to dst_fd. (Stops at end of bzip data,
559 not end of file.) */
560extern int uncompressStream(int src_fd, int dst_fd)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000561{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000562 char *outbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000563 bunzip_data *bd;
564 int i;
565
Glenn L McGrath1c834402003-10-28 23:32:12 +0000566 outbuf=xmalloc(IOBUF_SIZE);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000567 if(!(i=start_bunzip(&bd,src_fd,0,0))) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000568 for(;;) {
569 if((i=read_bunzip(bd,outbuf,IOBUF_SIZE)) <= 0) break;
570 if(i!=write(dst_fd,outbuf,i)) {
571 i=RETVAL_UNEXPECTED_OUTPUT_EOF;
572 break;
573 }
574 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000575 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000576 /* Check CRC and release memory */
Glenn L McGrath1c834402003-10-28 23:32:12 +0000577 if(i==RETVAL_LAST_BLOCK) {
578 if (bd->headerCRC!=bd->totalCRC) {
579 bb_error_msg("Data integrity error when decompressing.");
580 } else {
581 i=RETVAL_OK;
582 }
583 }
584 else if (i==RETVAL_UNEXPECTED_OUTPUT_EOF) {
585 bb_error_msg("Compressed file ends unexpectedly");
586 } else {
587 bb_error_msg("Decompression failed");
588 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000589 if(bd->dbuf) free(bd->dbuf);
590 free(bd);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000591 free(outbuf);
Glenn L McGrath1c834402003-10-28 23:32:12 +0000592
Eric Andersen5fa4db22003-10-23 06:52:01 +0000593 return i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000594}
595
Eric Andersen5fa4db22003-10-23 06:52:01 +0000596#ifdef TESTING
Glenn L McGrath60bce492002-11-03 07:28:38 +0000597
Eric Andersen5fa4db22003-10-23 06:52:01 +0000598static char * const bunzip_errors[]={NULL,"Bad file checksum","Not bzip data",
599 "Unexpected input EOF","Unexpected output EOF","Data error",
600 "Out of memory","Obsolete (pre 0.9.5) bzip format not supported."};
Glenn L McGrath237ae422002-11-03 14:05:15 +0000601
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000602/* Dumb little test thing, decompress stdin to stdout */
603int main(int argc, char *argv[])
604{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000605 int i=uncompressStream(0,1);
606 char c;
607
608 if(i) fprintf(stderr,"%s\n", bunzip_errors[-i]);
609 else if(read(0,&c,1)) fprintf(stderr,"Trailing garbage ignored\n");
610 return -i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000611}
612#endif