blob: ae96ea3753b3ddf00e1d9de9811f380ba88b67a1 [file] [log] [blame]
Eric Andersen0d6d88a2003-10-18 01:58:35 +00001/* vi: set sw=4 ts=4: */
Rob Landleye66c7ef2006-04-14 19:25:01 +00002/* Small bzip2 deflate implementation, by Rob Landley (rob@landley.net).
Glenn L McGrath60bce492002-11-03 07:28:38 +00003
Rob Landleye66c7ef2006-04-14 19:25:01 +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
Rob Landleye66c7ef2006-04-14 19:25:01 +00009 Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
Eric Andersen0d6d88a2003-10-18 01:58:35 +000010*/
Glenn L McGrath60bce492002-11-03 07:28:38 +000011
Eric Andersen5fa4db22003-10-23 06:52:01 +000012/*
13 Size and speed optimizations by Manuel Novoa III (mjn3@codepoet.org).
14
Eric Andersenaff114c2004-04-14 17:51:38 +000015 More efficient reading of Huffman codes, a streamlined read_bunzip()
Eric Andersen5fa4db22003-10-23 06:52:01 +000016 function, and various other tweaks. In (limited) tests, approximately
17 20% faster than bzcat on x86 and about 10% faster on arm.
18
19 Note that about 2/3 of the time is spent in read_unzip() reversing
20 the Burrows-Wheeler transformation. Much of that time is delay
21 resulting from cache misses.
22
23 I would ask that anyone benefiting from this work, especially those
24 using it in commercial products, consider making a donation to my local
Rob Landleyf856eab2006-02-17 03:43:49 +000025 non-profit hospice organization (www.hospiceacadiana.com) in the name of
Bernhard Reutner-Fischercfb53df2006-04-02 21:50:01 +000026 the woman I loved, Toni W. Hagan, who passed away Feb. 12, 2003.
Eric Andersen5fa4db22003-10-23 06:52:01 +000027
28 Manuel
29 */
30
Eric Andersen0d6d88a2003-10-18 01:58:35 +000031#include <setjmp.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000032#include <stdio.h>
Eric Andersen0d6d88a2003-10-18 01:58:35 +000033#include <stdlib.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000034#include <string.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000035#include <unistd.h>
Eric Andersen1acfb722003-10-18 01:59:46 +000036#include <limits.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000037
Glenn L McGrath1c834402003-10-28 23:32:12 +000038#include "libbb.h"
39
Bernhard Reutner-Fischercfb53df2006-04-02 21:50:01 +000040#include "unarchive.h"
41
Eric Andersenaff114c2004-04-14 17:51:38 +000042/* Constants for Huffman coding */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000043#define MAX_GROUPS 6
Tim Rikerc1ef7bd2006-01-25 00:08:53 +000044#define GROUP_SIZE 50 /* 64 would have been more efficient */
45#define MAX_HUFCODE_BITS 20 /* Longest Huffman code allowed */
46#define MAX_SYMBOLS 258 /* 256 literals + RUNA + RUNB */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000047#define SYMBOL_RUNA 0
48#define SYMBOL_RUNB 1
Glenn L McGrath60bce492002-11-03 07:28:38 +000049
Eric Andersen0d6d88a2003-10-18 01:58:35 +000050/* Status return values */
51#define RETVAL_OK 0
52#define RETVAL_LAST_BLOCK (-1)
53#define RETVAL_NOT_BZIP_DATA (-2)
54#define RETVAL_UNEXPECTED_INPUT_EOF (-3)
55#define RETVAL_UNEXPECTED_OUTPUT_EOF (-4)
56#define RETVAL_DATA_ERROR (-5)
57#define RETVAL_OUT_OF_MEMORY (-6)
58#define RETVAL_OBSOLETE_INPUT (-7)
Glenn L McGrath60bce492002-11-03 07:28:38 +000059
Eric Andersen0d6d88a2003-10-18 01:58:35 +000060/* Other housekeeping constants */
61#define IOBUF_SIZE 4096
Glenn L McGrath60bce492002-11-03 07:28:38 +000062
Eric Andersenaff114c2004-04-14 17:51:38 +000063/* This is what we know about each Huffman coding group */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000064struct group_data {
Eric Andersen1acfb722003-10-18 01:59:46 +000065 /* We have an extra slot at the end of limit[] for a sentinal value. */
66 int limit[MAX_HUFCODE_BITS+1],base[MAX_HUFCODE_BITS],permute[MAX_SYMBOLS];
Eric Andersen5fa4db22003-10-23 06:52:01 +000067 int minLen, maxLen;
Glenn L McGrath60bce492002-11-03 07:28:38 +000068};
69
Eric Andersen0d6d88a2003-10-18 01:58:35 +000070/* Structure holding all the housekeeping data, including IO buffers and
71 memory that persists between calls to bunzip */
Rob Landleyf856eab2006-02-17 03:43:49 +000072
Eric Andersen0d6d88a2003-10-18 01:58:35 +000073typedef struct {
Eric Andersen5fa4db22003-10-23 06:52:01 +000074 /* State for interrupting output loop */
Rob Landley2c98c402006-02-17 05:12:03 +000075
Eric Andersen5fa4db22003-10-23 06:52:01 +000076 int writeCopies,writePos,writeRunCountdown,writeCount,writeCurrent;
Rob Landleyf856eab2006-02-17 03:43:49 +000077
Eric Andersen5fa4db22003-10-23 06:52:01 +000078 /* I/O tracking data (file handles, buffers, positions, etc.) */
Rob Landleyf856eab2006-02-17 03:43:49 +000079
Eric Andersen5fa4db22003-10-23 06:52:01 +000080 int in_fd,out_fd,inbufCount,inbufPos /*,outbufPos*/;
81 unsigned char *inbuf /*,*outbuf*/;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000082 unsigned int inbufBitCount, inbufBits;
Rob Landleyf856eab2006-02-17 03:43:49 +000083
Eric Andersen0d6d88a2003-10-18 01:58:35 +000084 /* The CRC values stored in the block header and calculated from the data */
Rob Landleyf856eab2006-02-17 03:43:49 +000085
Rob Landleyc57ec372006-04-10 17:07:15 +000086 uint32_t headerCRC, totalCRC, writeCRC;
87 uint32_t *crc32Table;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000088 /* Intermediate buffer and its size (in bytes) */
Rob Landleyf856eab2006-02-17 03:43:49 +000089
Eric Andersen0d6d88a2003-10-18 01:58:35 +000090 unsigned int *dbuf, dbufSize;
Rob Landleyf856eab2006-02-17 03:43:49 +000091
Eric Andersen0d6d88a2003-10-18 01:58:35 +000092 /* These things are a bit too big to go on the stack */
Rob Landleyf856eab2006-02-17 03:43:49 +000093
Eric Andersen0d6d88a2003-10-18 01:58:35 +000094 unsigned char selectors[32768]; /* nSelectors=15 bits */
Eric Andersenaff114c2004-04-14 17:51:38 +000095 struct group_data groups[MAX_GROUPS]; /* Huffman coding tables */
Rob Landleyf856eab2006-02-17 03:43:49 +000096
Eric Andersen5fa4db22003-10-23 06:52:01 +000097 /* For I/O error handling */
Rob Landleyf856eab2006-02-17 03:43:49 +000098
Eric Andersen5fa4db22003-10-23 06:52:01 +000099 jmp_buf jmpbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000100} bunzip_data;
101
102/* Return the next nnn bits of input. All reads from the compressed input
103 are done through this function. All reads are big endian */
Rob Landleyf856eab2006-02-17 03:43:49 +0000104
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000105static unsigned int get_bits(bunzip_data *bd, char bits_wanted)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000106{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000107 unsigned int bits=0;
108
109 /* If we need to get more data from the byte buffer, do so. (Loop getting
110 one byte at a time to enforce endianness and avoid unaligned access.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000111
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000112 while (bd->inbufBitCount<bits_wanted) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000113
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000114 /* If we need to read more data from file into byte buffer, do so */
Rob Landleyf856eab2006-02-17 03:43:49 +0000115
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000116 if(bd->inbufPos==bd->inbufCount) {
Eric Andersen1acfb722003-10-18 01:59:46 +0000117 if((bd->inbufCount = read(bd->in_fd, bd->inbuf, IOBUF_SIZE)) <= 0)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000118 longjmp(bd->jmpbuf,RETVAL_UNEXPECTED_INPUT_EOF);
119 bd->inbufPos=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000120 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000121
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000122 /* Avoid 32-bit overflow (dump bit buffer to top of output) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000123
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000124 if(bd->inbufBitCount>=24) {
125 bits=bd->inbufBits&((1<<bd->inbufBitCount)-1);
126 bits_wanted-=bd->inbufBitCount;
127 bits<<=bits_wanted;
128 bd->inbufBitCount=0;
129 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000130
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000131 /* Grab next 8 bits of input from buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000132
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000133 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
134 bd->inbufBitCount+=8;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000135 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000136
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000137 /* Calculate result */
Rob Landleyf856eab2006-02-17 03:43:49 +0000138
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000139 bd->inbufBitCount-=bits_wanted;
140 bits|=(bd->inbufBits>>bd->inbufBitCount)&((1<<bits_wanted)-1);
141
142 return bits;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000143}
144
Eric Andersen5fa4db22003-10-23 06:52:01 +0000145/* Unpacks the next block and sets up for the inverse burrows-wheeler step. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000146
Eric Andersen5fa4db22003-10-23 06:52:01 +0000147static int get_next_block(bunzip_data *bd)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000148{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000149 struct group_data *hufGroup;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000150 int dbufCount,nextSym,dbufSize,groupCount,*base,*limit,selector,
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000151 i,j,k,t,runPos,symCount,symTotal,nSelectors,byteCount[256];
152 unsigned char uc, symToByte[256], mtfSymbol[256], *selectors;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000153 unsigned int *dbuf,origPtr;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000154
155 dbuf=bd->dbuf;
156 dbufSize=bd->dbufSize;
157 selectors=bd->selectors;
Rob Landley2c98c402006-02-17 05:12:03 +0000158
Eric Andersen5fa4db22003-10-23 06:52:01 +0000159 /* Reset longjmp I/O error handling */
Rob Landley2c98c402006-02-17 05:12:03 +0000160
Eric Andersen5fa4db22003-10-23 06:52:01 +0000161 i=setjmp(bd->jmpbuf);
162 if(i) return i;
Rob Landley2c98c402006-02-17 05:12:03 +0000163
Eric Andersen5fa4db22003-10-23 06:52:01 +0000164 /* Read in header signature and CRC, then validate signature.
165 (last block signature means CRC is for whole file, return now) */
Rob Landley2c98c402006-02-17 05:12:03 +0000166
Eric Andersen5fa4db22003-10-23 06:52:01 +0000167 i = get_bits(bd,24);
168 j = get_bits(bd,24);
169 bd->headerCRC=get_bits(bd,32);
170 if ((i == 0x177245) && (j == 0x385090)) return RETVAL_LAST_BLOCK;
171 if ((i != 0x314159) || (j != 0x265359)) return RETVAL_NOT_BZIP_DATA;
Rob Landley2c98c402006-02-17 05:12:03 +0000172
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000173 /* We can add support for blockRandomised if anybody complains. There was
174 some code for this in busybox 1.0.0-pre3, but nobody ever noticed that
175 it didn't actually work. */
Rob Landley2c98c402006-02-17 05:12:03 +0000176
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000177 if(get_bits(bd,1)) return RETVAL_OBSOLETE_INPUT;
178 if((origPtr=get_bits(bd,24)) > dbufSize) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000179
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000180 /* mapping table: if some byte values are never used (encoding things
181 like ascii text), the compression code removes the gaps to have fewer
182 symbols to deal with, and writes a sparse bitfield indicating which
183 values were present. We make a translation table to convert the symbols
184 back to the corresponding bytes. */
Rob Landley2c98c402006-02-17 05:12:03 +0000185
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000186 t=get_bits(bd, 16);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000187 symTotal=0;
188 for (i=0;i<16;i++) {
189 if(t&(1<<(15-i))) {
190 k=get_bits(bd,16);
191 for(j=0;j<16;j++)
192 if(k&(1<<(15-j))) symToByte[symTotal++]=(16*i)+j;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000193 }
194 }
Rob Landley2c98c402006-02-17 05:12:03 +0000195
Eric Andersenaff114c2004-04-14 17:51:38 +0000196 /* How many different Huffman coding groups does this block use? */
Rob Landley2c98c402006-02-17 05:12:03 +0000197
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000198 groupCount=get_bits(bd,3);
199 if (groupCount<2 || groupCount>MAX_GROUPS) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000200
Eric Andersenaff114c2004-04-14 17:51:38 +0000201 /* nSelectors: Every GROUP_SIZE many symbols we select a new Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000202 group. Read in the group selector list, which is stored as MTF encoded
Eric Andersen5fa4db22003-10-23 06:52:01 +0000203 bit runs. (MTF=Move To Front, as each value is used it's moved to the
204 start of the list.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000205
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000206 if(!(nSelectors=get_bits(bd, 15))) return RETVAL_DATA_ERROR;
207 for(i=0; i<groupCount; i++) mtfSymbol[i] = i;
208 for(i=0; i<nSelectors; i++) {
Rob Landley2c98c402006-02-17 05:12:03 +0000209
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000210 /* Get next value */
Rob Landley2c98c402006-02-17 05:12:03 +0000211
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000212 for(j=0;get_bits(bd,1);j++) if (j>=groupCount) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000213
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000214 /* Decode MTF to get the next selector */
Rob Landley2c98c402006-02-17 05:12:03 +0000215
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000216 uc = mtfSymbol[j];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000217 for(;j;j--) mtfSymbol[j] = mtfSymbol[j-1];
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000218 mtfSymbol[0]=selectors[i]=uc;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000219 }
Rob Landley2c98c402006-02-17 05:12:03 +0000220
Eric Andersenaff114c2004-04-14 17:51:38 +0000221 /* Read the Huffman coding tables for each group, which code for symTotal
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000222 literal symbols, plus two run symbols (RUNA, RUNB) */
Rob Landley2c98c402006-02-17 05:12:03 +0000223
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000224 symCount=symTotal+2;
225 for (j=0; j<groupCount; j++) {
226 unsigned char length[MAX_SYMBOLS],temp[MAX_HUFCODE_BITS+1];
227 int minLen, maxLen, pp;
Rob Landley2c98c402006-02-17 05:12:03 +0000228
Eric Andersenaff114c2004-04-14 17:51:38 +0000229 /* Read Huffman code lengths for each symbol. They're stored in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000230 a way similar to mtf; record a starting value for the first symbol,
231 and an offset from the previous value for everys symbol after that.
232 (Subtracting 1 before the loop and then adding it back at the end is
233 an optimization that makes the test inside the loop simpler: symbol
234 length 0 becomes negative, so an unsigned inequality catches it.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000235
Eric Andersen5fa4db22003-10-23 06:52:01 +0000236 t=get_bits(bd, 5)-1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000237 for (i = 0; i < symCount; i++) {
238 for(;;) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000239 if (((unsigned)t) > (MAX_HUFCODE_BITS-1))
240 return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000241
Eric Andersen5fa4db22003-10-23 06:52:01 +0000242 /* If first bit is 0, stop. Else second bit indicates whether
243 to increment or decrement the value. Optimization: grab 2
244 bits and unget the second if the first was 0. */
Rob Landley2c98c402006-02-17 05:12:03 +0000245
Eric Andersen5fa4db22003-10-23 06:52:01 +0000246 k = get_bits(bd,2);
247 if (k < 2) {
248 bd->inbufBitCount++;
249 break;
250 }
Rob Landley2c98c402006-02-17 05:12:03 +0000251
Eric Andersen5fa4db22003-10-23 06:52:01 +0000252 /* Add one if second bit 1, else subtract 1. Avoids if/else */
Rob Landley2c98c402006-02-17 05:12:03 +0000253
Eric Andersen5fa4db22003-10-23 06:52:01 +0000254 t+=(((k+1)&2)-1);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000255 }
Rob Landley2c98c402006-02-17 05:12:03 +0000256
Eric Andersen5fa4db22003-10-23 06:52:01 +0000257 /* Correct for the initial -1, to get the final symbol length */
Rob Landley2c98c402006-02-17 05:12:03 +0000258
Eric Andersen5fa4db22003-10-23 06:52:01 +0000259 length[i]=t+1;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000260 }
Rob Landley2c98c402006-02-17 05:12:03 +0000261
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000262 /* Find largest and smallest lengths in this group */
Rob Landley2c98c402006-02-17 05:12:03 +0000263
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000264 minLen=maxLen=length[0];
265 for(i = 1; i < symCount; i++) {
266 if(length[i] > maxLen) maxLen = length[i];
267 else if(length[i] < minLen) minLen = length[i];
Glenn L McGrath60bce492002-11-03 07:28:38 +0000268 }
Rob Landley2c98c402006-02-17 05:12:03 +0000269
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000270 /* Calculate permute[], base[], and limit[] tables from length[].
271 *
Eric Andersenaff114c2004-04-14 17:51:38 +0000272 * permute[] is the lookup table for converting Huffman coded symbols
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000273 * into decoded symbols. base[] is the amount to subtract from the
Eric Andersenaff114c2004-04-14 17:51:38 +0000274 * value of a Huffman symbol of a given length when using permute[].
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000275 *
276 * limit[] indicates the largest numerical value a symbol with a given
Eric Andersenaff114c2004-04-14 17:51:38 +0000277 * number of bits can have. This is how the Huffman codes can vary in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000278 * length: each code with a value>limit[length] needs another bit.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000279 */
Rob Landley2c98c402006-02-17 05:12:03 +0000280
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000281 hufGroup=bd->groups+j;
282 hufGroup->minLen = minLen;
283 hufGroup->maxLen = maxLen;
Rob Landley2c98c402006-02-17 05:12:03 +0000284
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000285 /* Note that minLen can't be smaller than 1, so we adjust the base
286 and limit array pointers so we're not always wasting the first
287 entry. We do this again when using them (during symbol decoding).*/
Rob Landley2c98c402006-02-17 05:12:03 +0000288
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000289 base=hufGroup->base-1;
290 limit=hufGroup->limit-1;
Rob Landley2c98c402006-02-17 05:12:03 +0000291
Eric Andersen5fa4db22003-10-23 06:52:01 +0000292 /* Calculate permute[]. Concurently, initialize temp[] and limit[]. */
Rob Landley2c98c402006-02-17 05:12:03 +0000293
Eric Andersen5fa4db22003-10-23 06:52:01 +0000294 pp=0;
295 for(i=minLen;i<=maxLen;i++) {
296 temp[i]=limit[i]=0;
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000297 for(t=0;t<symCount;t++)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000298 if(length[t]==i) hufGroup->permute[pp++] = t;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000299 }
Rob Landley2c98c402006-02-17 05:12:03 +0000300
Eric Andersen5fa4db22003-10-23 06:52:01 +0000301 /* Count symbols coded for at each bit length */
Rob Landley2c98c402006-02-17 05:12:03 +0000302
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000303 for (i=0;i<symCount;i++) temp[length[i]]++;
Rob Landley2c98c402006-02-17 05:12:03 +0000304
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000305 /* Calculate limit[] (the largest symbol-coding value at each bit
306 * length, which is (previous limit<<1)+symbols at this level), and
307 * base[] (number of symbols to ignore at each bit length, which is
Eric Andersen5fa4db22003-10-23 06:52:01 +0000308 * limit minus the cumulative count of symbols coded for already). */
Rob Landley2c98c402006-02-17 05:12:03 +0000309
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000310 pp=t=0;
311 for (i=minLen; i<maxLen; i++) {
312 pp+=temp[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000313
Eric Andersen5fa4db22003-10-23 06:52:01 +0000314 /* We read the largest possible symbol size and then unget bits
315 after determining how many we need, and those extra bits could
316 be set to anything. (They're noise from future symbols.) At
317 each level we're really only interested in the first few bits,
318 so here we set all the trailing to-be-ignored bits to 1 so they
319 don't affect the value>limit[length] comparison. */
Rob Landley2c98c402006-02-17 05:12:03 +0000320
Eric Andersen5fa4db22003-10-23 06:52:01 +0000321 limit[i]= (pp << (maxLen - i)) - 1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000322 pp<<=1;
323 base[i+1]=pp-(t+=temp[i]);
324 }
Eric Andersen1acfb722003-10-18 01:59:46 +0000325 limit[maxLen+1] = INT_MAX; /* Sentinal value for reading next sym. */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000326 limit[maxLen]=pp+temp[maxLen]-1;
327 base[minLen]=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000328 }
Rob Landley2c98c402006-02-17 05:12:03 +0000329
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000330 /* We've finished reading and digesting the block header. Now read this
Eric Andersenaff114c2004-04-14 17:51:38 +0000331 block's Huffman coded symbols from the file and undo the Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000332 and run length encoding, saving the result into dbuf[dbufCount++]=uc */
Glenn L McGrath60bce492002-11-03 07:28:38 +0000333
Eric Andersen5fa4db22003-10-23 06:52:01 +0000334 /* Initialize symbol occurrence counters and symbol Move To Front table */
Rob Landley2c98c402006-02-17 05:12:03 +0000335
Eric Andersen5fa4db22003-10-23 06:52:01 +0000336 for(i=0;i<256;i++) {
337 byteCount[i] = 0;
338 mtfSymbol[i]=(unsigned char)i;
339 }
Rob Landley2c98c402006-02-17 05:12:03 +0000340
Eric Andersen5fa4db22003-10-23 06:52:01 +0000341 /* Loop through compressed symbols. */
Rob Landley2c98c402006-02-17 05:12:03 +0000342
Rob Landleya8b98d62004-11-16 12:07:04 +0000343 runPos=dbufCount=selector=0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000344 for(;;) {
Rob Landley2c98c402006-02-17 05:12:03 +0000345
Rob Landleya8b98d62004-11-16 12:07:04 +0000346 /* fetch next Huffman coding group from list. */
Rob Landley2c98c402006-02-17 05:12:03 +0000347
Rob Landleya8b98d62004-11-16 12:07:04 +0000348 symCount=GROUP_SIZE-1;
349 if(selector>=nSelectors) return RETVAL_DATA_ERROR;
350 hufGroup=bd->groups+selectors[selector++];
351 base=hufGroup->base-1;
352 limit=hufGroup->limit-1;
353continue_this_group:
Rob Landley2c98c402006-02-17 05:12:03 +0000354
Eric Andersenaff114c2004-04-14 17:51:38 +0000355 /* Read next Huffman-coded symbol. */
Rob Landley2c98c402006-02-17 05:12:03 +0000356
Eric Andersen5fa4db22003-10-23 06:52:01 +0000357 /* Note: It is far cheaper to read maxLen bits and back up than it is
358 to read minLen bits and then an additional bit at a time, testing
359 as we go. Because there is a trailing last block (with file CRC),
360 there is no danger of the overread causing an unexpected EOF for a
361 valid compressed file. As a further optimization, we do the read
362 inline (falling back to a call to get_bits if the buffer runs
363 dry). The following (up to got_huff_bits:) is equivalent to
364 j=get_bits(bd,hufGroup->maxLen);
365 */
Rob Landley2c98c402006-02-17 05:12:03 +0000366
Eric Andersen5fa4db22003-10-23 06:52:01 +0000367 while (bd->inbufBitCount<hufGroup->maxLen) {
368 if(bd->inbufPos==bd->inbufCount) {
369 j = get_bits(bd,hufGroup->maxLen);
370 goto got_huff_bits;
371 }
372 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
373 bd->inbufBitCount+=8;
374 };
375 bd->inbufBitCount-=hufGroup->maxLen;
376 j = (bd->inbufBits>>bd->inbufBitCount)&((1<<hufGroup->maxLen)-1);
Rob Landley2c98c402006-02-17 05:12:03 +0000377
Eric Andersen5fa4db22003-10-23 06:52:01 +0000378got_huff_bits:
Rob Landley2c98c402006-02-17 05:12:03 +0000379
Eric Andersen5fa4db22003-10-23 06:52:01 +0000380 /* Figure how how many bits are in next symbol and unget extras */
Rob Landley2c98c402006-02-17 05:12:03 +0000381
Eric Andersen5fa4db22003-10-23 06:52:01 +0000382 i=hufGroup->minLen;
383 while(j>limit[i]) ++i;
384 bd->inbufBitCount += (hufGroup->maxLen - i);
Rob Landley2c98c402006-02-17 05:12:03 +0000385
Eric Andersen5fa4db22003-10-23 06:52:01 +0000386 /* Huffman decode value to get nextSym (with bounds checking) */
Rob Landley2c98c402006-02-17 05:12:03 +0000387
Eric Andersen5fa4db22003-10-23 06:52:01 +0000388 if ((i > hufGroup->maxLen)
389 || (((unsigned)(j=(j>>(hufGroup->maxLen-i))-base[i]))
390 >= MAX_SYMBOLS))
391 return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000392 nextSym = hufGroup->permute[j];
Rob Landley2c98c402006-02-17 05:12:03 +0000393
Eric Andersen5fa4db22003-10-23 06:52:01 +0000394 /* We have now decoded the symbol, which indicates either a new literal
395 byte, or a repeated run of the most recent literal byte. First,
396 check if nextSym indicates a repeated run, and if so loop collecting
397 how many times to repeat the last literal. */
Rob Landley2c98c402006-02-17 05:12:03 +0000398
Eric Andersen1acfb722003-10-18 01:59:46 +0000399 if (((unsigned)nextSym) <= SYMBOL_RUNB) { /* RUNA or RUNB */
Rob Landley2c98c402006-02-17 05:12:03 +0000400
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000401 /* If this is the start of a new run, zero out counter */
Rob Landley2c98c402006-02-17 05:12:03 +0000402
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000403 if(!runPos) {
404 runPos = 1;
405 t = 0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000406 }
Rob Landley2c98c402006-02-17 05:12:03 +0000407
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000408 /* Neat trick that saves 1 symbol: instead of or-ing 0 or 1 at
409 each bit position, add 1 or 2 instead. For example,
410 1011 is 1<<0 + 1<<1 + 2<<2. 1010 is 2<<0 + 2<<1 + 1<<2.
411 You can make any bit pattern that way using 1 less symbol than
412 the basic or 0/1 method (except all bits 0, which would use no
413 symbols, but a run of length 0 doesn't mean anything in this
414 context). Thus space is saved. */
Rob Landley2c98c402006-02-17 05:12:03 +0000415
Eric Andersen1acfb722003-10-18 01:59:46 +0000416 t += (runPos << nextSym); /* +runPos if RUNA; +2*runPos if RUNB */
Rob Landleyefae2942006-02-17 05:19:40 +0000417 if(runPos < dbufSize) runPos <<= 1;
Rob Landleya8b98d62004-11-16 12:07:04 +0000418 goto end_of_huffman_loop;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000419 }
Rob Landley2c98c402006-02-17 05:12:03 +0000420
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000421 /* When we hit the first non-run symbol after a run, we now know
422 how many times to repeat the last literal, so append that many
423 copies to our buffer of decoded symbols (dbuf) now. (The last
424 literal used is the one at the head of the mtfSymbol array.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000425
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000426 if(runPos) {
427 runPos=0;
428 if(dbufCount+t>=dbufSize) return RETVAL_DATA_ERROR;
429
430 uc = symToByte[mtfSymbol[0]];
431 byteCount[uc] += t;
432 while(t--) dbuf[dbufCount++]=uc;
433 }
Rob Landley2c98c402006-02-17 05:12:03 +0000434
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000435 /* Is this the terminating symbol? */
Rob Landley2c98c402006-02-17 05:12:03 +0000436
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000437 if(nextSym>symTotal) break;
Rob Landley2c98c402006-02-17 05:12:03 +0000438
Eric Andersen5fa4db22003-10-23 06:52:01 +0000439 /* At this point, nextSym indicates a new literal character. Subtract
440 one to get the position in the MTF array at which this literal is
441 currently to be found. (Note that the result can't be -1 or 0,
442 because 0 and 1 are RUNA and RUNB. But another instance of the
443 first symbol in the mtf array, position 0, would have been handled
444 as part of a run above. Therefore 1 unused mtf position minus
445 2 non-literal nextSym values equals -1.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000446
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000447 if(dbufCount>=dbufSize) return RETVAL_DATA_ERROR;
448 i = nextSym - 1;
449 uc = mtfSymbol[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000450
Eric Andersen5fa4db22003-10-23 06:52:01 +0000451 /* Adjust the MTF array. Since we typically expect to move only a
452 * small number of symbols, and are bound by 256 in any case, using
453 * memmove here would typically be bigger and slower due to function
454 * call overhead and other assorted setup costs. */
Rob Landley2c98c402006-02-17 05:12:03 +0000455
Eric Andersen1acfb722003-10-18 01:59:46 +0000456 do {
457 mtfSymbol[i] = mtfSymbol[i-1];
458 } while (--i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000459 mtfSymbol[0] = uc;
460 uc=symToByte[uc];
Rob Landley2c98c402006-02-17 05:12:03 +0000461
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000462 /* We have our literal byte. Save it into dbuf. */
Rob Landley2c98c402006-02-17 05:12:03 +0000463
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000464 byteCount[uc]++;
465 dbuf[dbufCount++] = (unsigned int)uc;
Rob Landley2c98c402006-02-17 05:12:03 +0000466
Rob Landleyf856eab2006-02-17 03:43:49 +0000467 /* Skip group initialization if we're not done with this group. Done
468 * this way to avoid compiler warning. */
Rob Landley2c98c402006-02-17 05:12:03 +0000469
Rob Landleya8b98d62004-11-16 12:07:04 +0000470end_of_huffman_loop:
471 if(symCount--) goto continue_this_group;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000472 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000473
Eric Andersenaff114c2004-04-14 17:51:38 +0000474 /* At this point, we've read all the Huffman-coded symbols (and repeated
Eric Andersen5fa4db22003-10-23 06:52:01 +0000475 runs) for this block from the input stream, and decoded them into the
476 intermediate buffer. There are dbufCount many decoded bytes in dbuf[].
477 Now undo the Burrows-Wheeler transform on dbuf.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000478 See http://dogma.net/markn/articles/bwt/bwt.htm
479 */
Rob Landley2c98c402006-02-17 05:12:03 +0000480
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000481 /* Turn byteCount into cumulative occurrence counts of 0 to n-1. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000482
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000483 j=0;
484 for(i=0;i<256;i++) {
485 k=j+byteCount[i];
486 byteCount[i] = j;
487 j=k;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000488 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000489
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000490 /* Figure out what order dbuf would be in if we sorted it. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000491
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000492 for (i=0;i<dbufCount;i++) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000493 uc=(unsigned char)(dbuf[i] & 0xff);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000494 dbuf[byteCount[uc]] |= (i << 8);
495 byteCount[uc]++;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000496 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000497
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000498 /* Decode first byte by hand to initialize "previous" byte. Note that it
499 doesn't get output, and if the first three characters are identical
Eric Andersen5fa4db22003-10-23 06:52:01 +0000500 it doesn't qualify as a run (hence writeRunCountdown=5). */
Rob Landley2c98c402006-02-17 05:12:03 +0000501
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000502 if(dbufCount) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000503 if(origPtr>=dbufCount) return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000504 bd->writePos=dbuf[origPtr];
505 bd->writeCurrent=(unsigned char)(bd->writePos&0xff);
506 bd->writePos>>=8;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000507 bd->writeRunCountdown=5;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000508 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000509 bd->writeCount=dbufCount;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000510
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000511 return RETVAL_OK;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000512}
513
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000514/* Undo burrows-wheeler transform on intermediate buffer to produce output.
Eric Andersen5fa4db22003-10-23 06:52:01 +0000515 If start_bunzip was initialized with out_fd=-1, then up to len bytes of
516 data are written to outbuf. Return value is number of bytes written or
517 error (all errors are negative numbers). If out_fd!=-1, outbuf and len
518 are ignored, data is written to out_fd and return is RETVAL_OK or error.
519*/
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000520
Glenn L McGrath5699b852003-11-15 23:19:05 +0000521static int read_bunzip(bunzip_data *bd, char *outbuf, int len)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000522{
523 const unsigned int *dbuf;
524 int pos,current,previous,gotcount;
525
526 /* If last read was short due to end of file, return last block now */
527 if(bd->writeCount<0) return bd->writeCount;
528
529 gotcount = 0;
530 dbuf=bd->dbuf;
531 pos=bd->writePos;
532 current=bd->writeCurrent;
533
534 /* We will always have pending decoded data to write into the output
535 buffer unless this is the very first call (in which case we haven't
Eric Andersenaff114c2004-04-14 17:51:38 +0000536 Huffman-decoded a block into the intermediate buffer yet). */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000537
538 if (bd->writeCopies) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000539
Eric Andersen5fa4db22003-10-23 06:52:01 +0000540 /* Inside the loop, writeCopies means extra copies (beyond 1) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000541
Eric Andersen5fa4db22003-10-23 06:52:01 +0000542 --bd->writeCopies;
Rob Landleyf856eab2006-02-17 03:43:49 +0000543
Eric Andersen5fa4db22003-10-23 06:52:01 +0000544 /* Loop outputting bytes */
Rob Landleyf856eab2006-02-17 03:43:49 +0000545
Eric Andersen5fa4db22003-10-23 06:52:01 +0000546 for(;;) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000547
Eric Andersen5fa4db22003-10-23 06:52:01 +0000548 /* If the output buffer is full, snapshot state and return */
Rob Landleyf856eab2006-02-17 03:43:49 +0000549
Eric Andersen5fa4db22003-10-23 06:52:01 +0000550 if(gotcount >= len) {
551 bd->writePos=pos;
552 bd->writeCurrent=current;
553 bd->writeCopies++;
554 return len;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000555 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000556
Eric Andersen5fa4db22003-10-23 06:52:01 +0000557 /* Write next byte into output buffer, updating CRC */
Rob Landleyf856eab2006-02-17 03:43:49 +0000558
Eric Andersen5fa4db22003-10-23 06:52:01 +0000559 outbuf[gotcount++] = current;
560 bd->writeCRC=(((bd->writeCRC)<<8)
561 ^bd->crc32Table[((bd->writeCRC)>>24)^current]);
Rob Landleyf856eab2006-02-17 03:43:49 +0000562
Eric Andersen5fa4db22003-10-23 06:52:01 +0000563 /* Loop now if we're outputting multiple copies of this byte */
Rob Landleyf856eab2006-02-17 03:43:49 +0000564
Eric Andersen5fa4db22003-10-23 06:52:01 +0000565 if (bd->writeCopies) {
566 --bd->writeCopies;
567 continue;
568 }
569decode_next_byte:
570 if (!bd->writeCount--) break;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000571 /* Follow sequence vector to undo Burrows-Wheeler transform */
572 previous=current;
573 pos=dbuf[pos];
574 current=pos&0xff;
575 pos>>=8;
Rob Landleyf856eab2006-02-17 03:43:49 +0000576
Eric Andersen5fa4db22003-10-23 06:52:01 +0000577 /* After 3 consecutive copies of the same byte, the 4th is a repeat
578 count. We count down from 4 instead
579 * of counting up because testing for non-zero is faster */
Rob Landleyf856eab2006-02-17 03:43:49 +0000580
Eric Andersen5fa4db22003-10-23 06:52:01 +0000581 if(--bd->writeRunCountdown) {
582 if(current!=previous) bd->writeRunCountdown=4;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000583 } else {
Rob Landleyf856eab2006-02-17 03:43:49 +0000584
Eric Andersen5fa4db22003-10-23 06:52:01 +0000585 /* We have a repeated run, this byte indicates the count */
Rob Landleyf856eab2006-02-17 03:43:49 +0000586
Eric Andersen5fa4db22003-10-23 06:52:01 +0000587 bd->writeCopies=current;
588 current=previous;
589 bd->writeRunCountdown=5;
Rob Landleyf856eab2006-02-17 03:43:49 +0000590
Eric Andersen5fa4db22003-10-23 06:52:01 +0000591 /* Sometimes there are just 3 bytes (run length 0) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000592
Eric Andersen5fa4db22003-10-23 06:52:01 +0000593 if(!bd->writeCopies) goto decode_next_byte;
Rob Landleyf856eab2006-02-17 03:43:49 +0000594
Eric Andersen5fa4db22003-10-23 06:52:01 +0000595 /* Subtract the 1 copy we'd output anyway to get extras */
Rob Landleyf856eab2006-02-17 03:43:49 +0000596
Eric Andersen5fa4db22003-10-23 06:52:01 +0000597 --bd->writeCopies;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000598 }
599 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000600
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000601 /* Decompression of this block completed successfully */
Rob Landleyf856eab2006-02-17 03:43:49 +0000602
Eric Andersen5fa4db22003-10-23 06:52:01 +0000603 bd->writeCRC=~bd->writeCRC;
604 bd->totalCRC=((bd->totalCRC<<1) | (bd->totalCRC>>31)) ^ bd->writeCRC;
Rob Landleyf856eab2006-02-17 03:43:49 +0000605
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000606 /* If this block had a CRC error, force file level CRC error. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000607
Eric Andersen5fa4db22003-10-23 06:52:01 +0000608 if(bd->writeCRC!=bd->headerCRC) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000609 bd->totalCRC=bd->headerCRC+1;
610 return RETVAL_LAST_BLOCK;
611 }
Glenn L McGrath60bce492002-11-03 07:28:38 +0000612 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000613
Eric Andersenaff114c2004-04-14 17:51:38 +0000614 /* Refill the intermediate buffer by Huffman-decoding next block of input */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000615 /* (previous is just a convenient unused temp variable here) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000616
Eric Andersen5fa4db22003-10-23 06:52:01 +0000617 previous=get_next_block(bd);
618 if(previous) {
619 bd->writeCount=previous;
620 return (previous!=RETVAL_LAST_BLOCK) ? previous : gotcount;
621 }
Rob Landleyc57ec372006-04-10 17:07:15 +0000622 bd->writeCRC=~0;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000623 pos=bd->writePos;
624 current=bd->writeCurrent;
625 goto decode_next_byte;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000626}
627
Eric Andersen5fa4db22003-10-23 06:52:01 +0000628/* Allocate the structure, read file header. If in_fd==-1, inbuf must contain
629 a complete bunzip file (len bytes long). If in_fd!=-1, inbuf and len are
630 ignored, and data is read from file handle into temporary buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000631
Rob Landley1ff789c2005-09-25 03:12:26 +0000632static int start_bunzip(bunzip_data **bdp, int in_fd, unsigned char *inbuf,
633 int len)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000634{
635 bunzip_data *bd;
Rob Landleyc57ec372006-04-10 17:07:15 +0000636 unsigned int i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000637 const unsigned int BZh0=(((unsigned int)'B')<<24)+(((unsigned int)'Z')<<16)
638 +(((unsigned int)'h')<<8)+(unsigned int)'0';
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000639
640 /* Figure out how much data to allocate */
Rob Landleyf856eab2006-02-17 03:43:49 +0000641
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000642 i=sizeof(bunzip_data);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000643 if(in_fd!=-1) i+=IOBUF_SIZE;
Rob Landleyf856eab2006-02-17 03:43:49 +0000644
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000645 /* Allocate bunzip_data. Most fields initialize to zero. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000646
Rob Landley1ec5b292006-05-29 07:42:02 +0000647 bd=*bdp=xzalloc(i);
Rob Landleyf856eab2006-02-17 03:43:49 +0000648
Eric Andersen5fa4db22003-10-23 06:52:01 +0000649 /* Setup input buffer */
Rob Landleyf856eab2006-02-17 03:43:49 +0000650
Eric Andersen5fa4db22003-10-23 06:52:01 +0000651 if(-1==(bd->in_fd=in_fd)) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000652 bd->inbuf=inbuf;
653 bd->inbufCount=len;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000654 } else bd->inbuf=(unsigned char *)(bd+1);
Rob Landleyf856eab2006-02-17 03:43:49 +0000655
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000656 /* Init the CRC32 table (big endian) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000657
Rob Landleyc57ec372006-04-10 17:07:15 +0000658 bd->crc32Table = bb_crc32_filltable(1);
Rob Landleyf856eab2006-02-17 03:43:49 +0000659
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000660 /* Setup for I/O error handling via longjmp */
Rob Landleyf856eab2006-02-17 03:43:49 +0000661
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000662 i=setjmp(bd->jmpbuf);
663 if(i) return i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000664
665 /* Ensure that file starts with "BZh['1'-'9']." */
Rob Landleyf856eab2006-02-17 03:43:49 +0000666
Eric Andersen5fa4db22003-10-23 06:52:01 +0000667 i = get_bits(bd,32);
668 if (((unsigned int)(i-BZh0-1)) >= 9) return RETVAL_NOT_BZIP_DATA;
669
670 /* Fourth byte (ascii '1'-'9'), indicates block size in units of 100k of
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000671 uncompressed data. Allocate intermediate buffer for block. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000672
Eric Andersen5fa4db22003-10-23 06:52:01 +0000673 bd->dbufSize=100000*(i-BZh0);
674
Glenn L McGrath1c834402003-10-28 23:32:12 +0000675 bd->dbuf=xmalloc(bd->dbufSize * sizeof(int));
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000676 return RETVAL_OK;
677}
678
Eric Andersen5fa4db22003-10-23 06:52:01 +0000679/* Example usage: decompress src_fd to dst_fd. (Stops at end of bzip data,
680 not end of file.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000681
Rob Landleydfba7412006-03-06 20:47:33 +0000682int uncompressStream(int src_fd, int dst_fd)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000683{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000684 char *outbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000685 bunzip_data *bd;
686 int i;
687
Glenn L McGrath1c834402003-10-28 23:32:12 +0000688 outbuf=xmalloc(IOBUF_SIZE);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000689 if(!(i=start_bunzip(&bd,src_fd,0,0))) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000690 for(;;) {
691 if((i=read_bunzip(bd,outbuf,IOBUF_SIZE)) <= 0) break;
692 if(i!=write(dst_fd,outbuf,i)) {
693 i=RETVAL_UNEXPECTED_OUTPUT_EOF;
694 break;
695 }
696 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000697 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000698
Eric Andersen5fa4db22003-10-23 06:52:01 +0000699 /* Check CRC and release memory */
Rob Landleyf856eab2006-02-17 03:43:49 +0000700
Glenn L McGrath1c834402003-10-28 23:32:12 +0000701 if(i==RETVAL_LAST_BLOCK) {
702 if (bd->headerCRC!=bd->totalCRC) {
703 bb_error_msg("Data integrity error when decompressing.");
704 } else {
705 i=RETVAL_OK;
706 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000707 } else if (i==RETVAL_UNEXPECTED_OUTPUT_EOF) {
Glenn L McGrath1c834402003-10-28 23:32:12 +0000708 bb_error_msg("Compressed file ends unexpectedly");
709 } else {
710 bb_error_msg("Decompression failed");
711 }
Rob Landleye7c43b62006-03-01 16:39:45 +0000712 free(bd->dbuf);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000713 free(bd);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000714 free(outbuf);
Glenn L McGrath1c834402003-10-28 23:32:12 +0000715
Eric Andersen5fa4db22003-10-23 06:52:01 +0000716 return i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000717}
718
Eric Andersen5fa4db22003-10-23 06:52:01 +0000719#ifdef TESTING
Glenn L McGrath60bce492002-11-03 07:28:38 +0000720
Eric Andersen5fa4db22003-10-23 06:52:01 +0000721static char * const bunzip_errors[]={NULL,"Bad file checksum","Not bzip data",
722 "Unexpected input EOF","Unexpected output EOF","Data error",
723 "Out of memory","Obsolete (pre 0.9.5) bzip format not supported."};
Glenn L McGrath237ae422002-11-03 14:05:15 +0000724
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000725/* Dumb little test thing, decompress stdin to stdout */
726int main(int argc, char *argv[])
727{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000728 int i=uncompressStream(0,1);
729 char c;
730
731 if(i) fprintf(stderr,"%s\n", bunzip_errors[-i]);
732 else if(read(0,&c,1)) fprintf(stderr,"Trailing garbage ignored\n");
733 return -i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000734}
735#endif