blob: 34afd6f99c6c77768e3e223a47a4cecc5b699bdd [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:
Rob Landleyf856eab2006-02-17 03:43:49 +000010 LGPL http://www.gnu.org/copyleft/lgpl.html
Eric Andersen0d6d88a2003-10-18 01:58:35 +000011*/
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
Rob Landleyf856eab2006-02-17 03:43:49 +000026 non-profit hospice organization (www.hospiceacadiana.com) in the name of
27 the woman I loved, Toni W. Hagan, who passed away Feb. 12, 2003.
Eric Andersen5fa4db22003-10-23 06:52:01 +000028
29 Manuel
30 */
31
Eric Andersen0d6d88a2003-10-18 01:58:35 +000032#include <setjmp.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000033#include <stdio.h>
Eric Andersen0d6d88a2003-10-18 01:58:35 +000034#include <stdlib.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000035#include <string.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000036#include <unistd.h>
Eric Andersen1acfb722003-10-18 01:59:46 +000037#include <limits.h>
Glenn L McGrath60bce492002-11-03 07:28:38 +000038
Glenn L McGrath1c834402003-10-28 23:32:12 +000039#include "libbb.h"
40
Eric Andersenaff114c2004-04-14 17:51:38 +000041/* Constants for Huffman coding */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000042#define MAX_GROUPS 6
Tim Rikerc1ef7bd2006-01-25 00:08:53 +000043#define GROUP_SIZE 50 /* 64 would have been more efficient */
44#define MAX_HUFCODE_BITS 20 /* Longest Huffman code allowed */
45#define MAX_SYMBOLS 258 /* 256 literals + RUNA + RUNB */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000046#define SYMBOL_RUNA 0
47#define SYMBOL_RUNB 1
Glenn L McGrath60bce492002-11-03 07:28:38 +000048
Eric Andersen0d6d88a2003-10-18 01:58:35 +000049/* Status return values */
50#define RETVAL_OK 0
51#define RETVAL_LAST_BLOCK (-1)
52#define RETVAL_NOT_BZIP_DATA (-2)
53#define RETVAL_UNEXPECTED_INPUT_EOF (-3)
54#define RETVAL_UNEXPECTED_OUTPUT_EOF (-4)
55#define RETVAL_DATA_ERROR (-5)
56#define RETVAL_OUT_OF_MEMORY (-6)
57#define RETVAL_OBSOLETE_INPUT (-7)
Glenn L McGrath60bce492002-11-03 07:28:38 +000058
Eric Andersen0d6d88a2003-10-18 01:58:35 +000059/* Other housekeeping constants */
60#define IOBUF_SIZE 4096
Glenn L McGrath60bce492002-11-03 07:28:38 +000061
Eric Andersenaff114c2004-04-14 17:51:38 +000062/* This is what we know about each Huffman coding group */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000063struct group_data {
Eric Andersen1acfb722003-10-18 01:59:46 +000064 /* We have an extra slot at the end of limit[] for a sentinal value. */
65 int limit[MAX_HUFCODE_BITS+1],base[MAX_HUFCODE_BITS],permute[MAX_SYMBOLS];
Eric Andersen5fa4db22003-10-23 06:52:01 +000066 int minLen, maxLen;
Glenn L McGrath60bce492002-11-03 07:28:38 +000067};
68
Eric Andersen0d6d88a2003-10-18 01:58:35 +000069/* Structure holding all the housekeeping data, including IO buffers and
70 memory that persists between calls to bunzip */
Rob Landleyf856eab2006-02-17 03:43:49 +000071
Eric Andersen0d6d88a2003-10-18 01:58:35 +000072typedef struct {
Eric Andersen5fa4db22003-10-23 06:52:01 +000073 /* State for interrupting output loop */
Rob Landley2c98c402006-02-17 05:12:03 +000074
Eric Andersen5fa4db22003-10-23 06:52:01 +000075 int writeCopies,writePos,writeRunCountdown,writeCount,writeCurrent;
Rob Landleyf856eab2006-02-17 03:43:49 +000076
Eric Andersen5fa4db22003-10-23 06:52:01 +000077 /* I/O tracking data (file handles, buffers, positions, etc.) */
Rob Landleyf856eab2006-02-17 03:43:49 +000078
Eric Andersen5fa4db22003-10-23 06:52:01 +000079 int in_fd,out_fd,inbufCount,inbufPos /*,outbufPos*/;
80 unsigned char *inbuf /*,*outbuf*/;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000081 unsigned int inbufBitCount, inbufBits;
Rob Landleyf856eab2006-02-17 03:43:49 +000082
Eric Andersen0d6d88a2003-10-18 01:58:35 +000083 /* The CRC values stored in the block header and calculated from the data */
Rob Landleyf856eab2006-02-17 03:43:49 +000084
Eric Andersen5fa4db22003-10-23 06:52:01 +000085 unsigned int crc32Table[256],headerCRC, totalCRC, writeCRC;
Rob Landleyf856eab2006-02-17 03:43:49 +000086
Eric Andersen0d6d88a2003-10-18 01:58:35 +000087 /* Intermediate buffer and its size (in bytes) */
Rob Landleyf856eab2006-02-17 03:43:49 +000088
Eric Andersen0d6d88a2003-10-18 01:58:35 +000089 unsigned int *dbuf, dbufSize;
Rob Landleyf856eab2006-02-17 03:43:49 +000090
Eric Andersen0d6d88a2003-10-18 01:58:35 +000091 /* These things are a bit too big to go on the stack */
Rob Landleyf856eab2006-02-17 03:43:49 +000092
Eric Andersen0d6d88a2003-10-18 01:58:35 +000093 unsigned char selectors[32768]; /* nSelectors=15 bits */
Eric Andersenaff114c2004-04-14 17:51:38 +000094 struct group_data groups[MAX_GROUPS]; /* Huffman coding tables */
Rob Landleyf856eab2006-02-17 03:43:49 +000095
Eric Andersen5fa4db22003-10-23 06:52:01 +000096 /* For I/O error handling */
Rob Landleyf856eab2006-02-17 03:43:49 +000097
Eric Andersen5fa4db22003-10-23 06:52:01 +000098 jmp_buf jmpbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000099} bunzip_data;
100
101/* Return the next nnn bits of input. All reads from the compressed input
102 are done through this function. All reads are big endian */
Rob Landleyf856eab2006-02-17 03:43:49 +0000103
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000104static unsigned int get_bits(bunzip_data *bd, char bits_wanted)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000105{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000106 unsigned int bits=0;
107
108 /* If we need to get more data from the byte buffer, do so. (Loop getting
109 one byte at a time to enforce endianness and avoid unaligned access.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000110
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000111 while (bd->inbufBitCount<bits_wanted) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000112
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000113 /* If we need to read more data from file into byte buffer, do so */
Rob Landleyf856eab2006-02-17 03:43:49 +0000114
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000115 if(bd->inbufPos==bd->inbufCount) {
Eric Andersen1acfb722003-10-18 01:59:46 +0000116 if((bd->inbufCount = read(bd->in_fd, bd->inbuf, IOBUF_SIZE)) <= 0)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000117 longjmp(bd->jmpbuf,RETVAL_UNEXPECTED_INPUT_EOF);
118 bd->inbufPos=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000119 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000120
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000121 /* Avoid 32-bit overflow (dump bit buffer to top of output) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000122
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000123 if(bd->inbufBitCount>=24) {
124 bits=bd->inbufBits&((1<<bd->inbufBitCount)-1);
125 bits_wanted-=bd->inbufBitCount;
126 bits<<=bits_wanted;
127 bd->inbufBitCount=0;
128 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000129
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000130 /* Grab next 8 bits of input from buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000131
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000132 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
133 bd->inbufBitCount+=8;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000134 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000135
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000136 /* Calculate result */
Rob Landleyf856eab2006-02-17 03:43:49 +0000137
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000138 bd->inbufBitCount-=bits_wanted;
139 bits|=(bd->inbufBits>>bd->inbufBitCount)&((1<<bits_wanted)-1);
140
141 return bits;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000142}
143
Eric Andersen5fa4db22003-10-23 06:52:01 +0000144/* Unpacks the next block and sets up for the inverse burrows-wheeler step. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000145
Eric Andersen5fa4db22003-10-23 06:52:01 +0000146static int get_next_block(bunzip_data *bd)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000147{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000148 struct group_data *hufGroup;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000149 int dbufCount,nextSym,dbufSize,groupCount,*base,*limit,selector,
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000150 i,j,k,t,runPos,symCount,symTotal,nSelectors,byteCount[256];
151 unsigned char uc, symToByte[256], mtfSymbol[256], *selectors;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000152 unsigned int *dbuf,origPtr;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000153
154 dbuf=bd->dbuf;
155 dbufSize=bd->dbufSize;
156 selectors=bd->selectors;
Rob Landley2c98c402006-02-17 05:12:03 +0000157
Eric Andersen5fa4db22003-10-23 06:52:01 +0000158 /* Reset longjmp I/O error handling */
Rob Landley2c98c402006-02-17 05:12:03 +0000159
Eric Andersen5fa4db22003-10-23 06:52:01 +0000160 i=setjmp(bd->jmpbuf);
161 if(i) return i;
Rob Landley2c98c402006-02-17 05:12:03 +0000162
Eric Andersen5fa4db22003-10-23 06:52:01 +0000163 /* Read in header signature and CRC, then validate signature.
164 (last block signature means CRC is for whole file, return now) */
Rob Landley2c98c402006-02-17 05:12:03 +0000165
Eric Andersen5fa4db22003-10-23 06:52:01 +0000166 i = get_bits(bd,24);
167 j = get_bits(bd,24);
168 bd->headerCRC=get_bits(bd,32);
169 if ((i == 0x177245) && (j == 0x385090)) return RETVAL_LAST_BLOCK;
170 if ((i != 0x314159) || (j != 0x265359)) return RETVAL_NOT_BZIP_DATA;
Rob Landley2c98c402006-02-17 05:12:03 +0000171
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000172 /* We can add support for blockRandomised if anybody complains. There was
173 some code for this in busybox 1.0.0-pre3, but nobody ever noticed that
174 it didn't actually work. */
Rob Landley2c98c402006-02-17 05:12:03 +0000175
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000176 if(get_bits(bd,1)) return RETVAL_OBSOLETE_INPUT;
177 if((origPtr=get_bits(bd,24)) > dbufSize) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000178
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000179 /* mapping table: if some byte values are never used (encoding things
180 like ascii text), the compression code removes the gaps to have fewer
181 symbols to deal with, and writes a sparse bitfield indicating which
182 values were present. We make a translation table to convert the symbols
183 back to the corresponding bytes. */
Rob Landley2c98c402006-02-17 05:12:03 +0000184
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000185 t=get_bits(bd, 16);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000186 symTotal=0;
187 for (i=0;i<16;i++) {
188 if(t&(1<<(15-i))) {
189 k=get_bits(bd,16);
190 for(j=0;j<16;j++)
191 if(k&(1<<(15-j))) symToByte[symTotal++]=(16*i)+j;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000192 }
193 }
Rob Landley2c98c402006-02-17 05:12:03 +0000194
Eric Andersenaff114c2004-04-14 17:51:38 +0000195 /* How many different Huffman coding groups does this block use? */
Rob Landley2c98c402006-02-17 05:12:03 +0000196
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000197 groupCount=get_bits(bd,3);
198 if (groupCount<2 || groupCount>MAX_GROUPS) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000199
Eric Andersenaff114c2004-04-14 17:51:38 +0000200 /* nSelectors: Every GROUP_SIZE many symbols we select a new Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000201 group. Read in the group selector list, which is stored as MTF encoded
Eric Andersen5fa4db22003-10-23 06:52:01 +0000202 bit runs. (MTF=Move To Front, as each value is used it's moved to the
203 start of the list.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000204
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000205 if(!(nSelectors=get_bits(bd, 15))) return RETVAL_DATA_ERROR;
206 for(i=0; i<groupCount; i++) mtfSymbol[i] = i;
207 for(i=0; i<nSelectors; i++) {
Rob Landley2c98c402006-02-17 05:12:03 +0000208
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000209 /* Get next value */
Rob Landley2c98c402006-02-17 05:12:03 +0000210
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000211 for(j=0;get_bits(bd,1);j++) if (j>=groupCount) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000212
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000213 /* Decode MTF to get the next selector */
Rob Landley2c98c402006-02-17 05:12:03 +0000214
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000215 uc = mtfSymbol[j];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000216 for(;j;j--) mtfSymbol[j] = mtfSymbol[j-1];
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000217 mtfSymbol[0]=selectors[i]=uc;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000218 }
Rob Landley2c98c402006-02-17 05:12:03 +0000219
Eric Andersenaff114c2004-04-14 17:51:38 +0000220 /* Read the Huffman coding tables for each group, which code for symTotal
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000221 literal symbols, plus two run symbols (RUNA, RUNB) */
Rob Landley2c98c402006-02-17 05:12:03 +0000222
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000223 symCount=symTotal+2;
224 for (j=0; j<groupCount; j++) {
225 unsigned char length[MAX_SYMBOLS],temp[MAX_HUFCODE_BITS+1];
226 int minLen, maxLen, pp;
Rob Landley2c98c402006-02-17 05:12:03 +0000227
Eric Andersenaff114c2004-04-14 17:51:38 +0000228 /* Read Huffman code lengths for each symbol. They're stored in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000229 a way similar to mtf; record a starting value for the first symbol,
230 and an offset from the previous value for everys symbol after that.
231 (Subtracting 1 before the loop and then adding it back at the end is
232 an optimization that makes the test inside the loop simpler: symbol
233 length 0 becomes negative, so an unsigned inequality catches it.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000234
Eric Andersen5fa4db22003-10-23 06:52:01 +0000235 t=get_bits(bd, 5)-1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000236 for (i = 0; i < symCount; i++) {
237 for(;;) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000238 if (((unsigned)t) > (MAX_HUFCODE_BITS-1))
239 return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000240
Eric Andersen5fa4db22003-10-23 06:52:01 +0000241 /* If first bit is 0, stop. Else second bit indicates whether
242 to increment or decrement the value. Optimization: grab 2
243 bits and unget the second if the first was 0. */
Rob Landley2c98c402006-02-17 05:12:03 +0000244
Eric Andersen5fa4db22003-10-23 06:52:01 +0000245 k = get_bits(bd,2);
246 if (k < 2) {
247 bd->inbufBitCount++;
248 break;
249 }
Rob Landley2c98c402006-02-17 05:12:03 +0000250
Eric Andersen5fa4db22003-10-23 06:52:01 +0000251 /* Add one if second bit 1, else subtract 1. Avoids if/else */
Rob Landley2c98c402006-02-17 05:12:03 +0000252
Eric Andersen5fa4db22003-10-23 06:52:01 +0000253 t+=(((k+1)&2)-1);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000254 }
Rob Landley2c98c402006-02-17 05:12:03 +0000255
Eric Andersen5fa4db22003-10-23 06:52:01 +0000256 /* Correct for the initial -1, to get the final symbol length */
Rob Landley2c98c402006-02-17 05:12:03 +0000257
Eric Andersen5fa4db22003-10-23 06:52:01 +0000258 length[i]=t+1;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000259 }
Rob Landley2c98c402006-02-17 05:12:03 +0000260
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000261 /* Find largest and smallest lengths in this group */
Rob Landley2c98c402006-02-17 05:12:03 +0000262
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000263 minLen=maxLen=length[0];
264 for(i = 1; i < symCount; i++) {
265 if(length[i] > maxLen) maxLen = length[i];
266 else if(length[i] < minLen) minLen = length[i];
Glenn L McGrath60bce492002-11-03 07:28:38 +0000267 }
Rob Landley2c98c402006-02-17 05:12:03 +0000268
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000269 /* Calculate permute[], base[], and limit[] tables from length[].
270 *
Eric Andersenaff114c2004-04-14 17:51:38 +0000271 * permute[] is the lookup table for converting Huffman coded symbols
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000272 * into decoded symbols. base[] is the amount to subtract from the
Eric Andersenaff114c2004-04-14 17:51:38 +0000273 * value of a Huffman symbol of a given length when using permute[].
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000274 *
275 * limit[] indicates the largest numerical value a symbol with a given
Eric Andersenaff114c2004-04-14 17:51:38 +0000276 * number of bits can have. This is how the Huffman codes can vary in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000277 * length: each code with a value>limit[length] needs another bit.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000278 */
Rob Landley2c98c402006-02-17 05:12:03 +0000279
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000280 hufGroup=bd->groups+j;
281 hufGroup->minLen = minLen;
282 hufGroup->maxLen = maxLen;
Rob Landley2c98c402006-02-17 05:12:03 +0000283
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000284 /* Note that minLen can't be smaller than 1, so we adjust the base
285 and limit array pointers so we're not always wasting the first
286 entry. We do this again when using them (during symbol decoding).*/
Rob Landley2c98c402006-02-17 05:12:03 +0000287
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000288 base=hufGroup->base-1;
289 limit=hufGroup->limit-1;
Rob Landley2c98c402006-02-17 05:12:03 +0000290
Eric Andersen5fa4db22003-10-23 06:52:01 +0000291 /* Calculate permute[]. Concurently, initialize temp[] and limit[]. */
Rob Landley2c98c402006-02-17 05:12:03 +0000292
Eric Andersen5fa4db22003-10-23 06:52:01 +0000293 pp=0;
294 for(i=minLen;i<=maxLen;i++) {
295 temp[i]=limit[i]=0;
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000296 for(t=0;t<symCount;t++)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000297 if(length[t]==i) hufGroup->permute[pp++] = t;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000298 }
Rob Landley2c98c402006-02-17 05:12:03 +0000299
Eric Andersen5fa4db22003-10-23 06:52:01 +0000300 /* Count symbols coded for at each bit length */
Rob Landley2c98c402006-02-17 05:12:03 +0000301
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000302 for (i=0;i<symCount;i++) temp[length[i]]++;
Rob Landley2c98c402006-02-17 05:12:03 +0000303
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000304 /* Calculate limit[] (the largest symbol-coding value at each bit
305 * length, which is (previous limit<<1)+symbols at this level), and
306 * base[] (number of symbols to ignore at each bit length, which is
Eric Andersen5fa4db22003-10-23 06:52:01 +0000307 * limit minus the cumulative count of symbols coded for already). */
Rob Landley2c98c402006-02-17 05:12:03 +0000308
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000309 pp=t=0;
310 for (i=minLen; i<maxLen; i++) {
311 pp+=temp[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000312
Eric Andersen5fa4db22003-10-23 06:52:01 +0000313 /* We read the largest possible symbol size and then unget bits
314 after determining how many we need, and those extra bits could
315 be set to anything. (They're noise from future symbols.) At
316 each level we're really only interested in the first few bits,
317 so here we set all the trailing to-be-ignored bits to 1 so they
318 don't affect the value>limit[length] comparison. */
Rob Landley2c98c402006-02-17 05:12:03 +0000319
Eric Andersen5fa4db22003-10-23 06:52:01 +0000320 limit[i]= (pp << (maxLen - i)) - 1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000321 pp<<=1;
322 base[i+1]=pp-(t+=temp[i]);
323 }
Eric Andersen1acfb722003-10-18 01:59:46 +0000324 limit[maxLen+1] = INT_MAX; /* Sentinal value for reading next sym. */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000325 limit[maxLen]=pp+temp[maxLen]-1;
326 base[minLen]=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000327 }
Rob Landley2c98c402006-02-17 05:12:03 +0000328
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000329 /* We've finished reading and digesting the block header. Now read this
Eric Andersenaff114c2004-04-14 17:51:38 +0000330 block's Huffman coded symbols from the file and undo the Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000331 and run length encoding, saving the result into dbuf[dbufCount++]=uc */
Glenn L McGrath60bce492002-11-03 07:28:38 +0000332
Eric Andersen5fa4db22003-10-23 06:52:01 +0000333 /* Initialize symbol occurrence counters and symbol Move To Front table */
Rob Landley2c98c402006-02-17 05:12:03 +0000334
Eric Andersen5fa4db22003-10-23 06:52:01 +0000335 for(i=0;i<256;i++) {
336 byteCount[i] = 0;
337 mtfSymbol[i]=(unsigned char)i;
338 }
Rob Landley2c98c402006-02-17 05:12:03 +0000339
Eric Andersen5fa4db22003-10-23 06:52:01 +0000340 /* Loop through compressed symbols. */
Rob Landley2c98c402006-02-17 05:12:03 +0000341
Rob Landleya8b98d62004-11-16 12:07:04 +0000342 runPos=dbufCount=selector=0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000343 for(;;) {
Rob Landley2c98c402006-02-17 05:12:03 +0000344
Rob Landleya8b98d62004-11-16 12:07:04 +0000345 /* fetch next Huffman coding group from list. */
Rob Landley2c98c402006-02-17 05:12:03 +0000346
Rob Landleya8b98d62004-11-16 12:07:04 +0000347 symCount=GROUP_SIZE-1;
348 if(selector>=nSelectors) return RETVAL_DATA_ERROR;
349 hufGroup=bd->groups+selectors[selector++];
350 base=hufGroup->base-1;
351 limit=hufGroup->limit-1;
352continue_this_group:
Rob Landley2c98c402006-02-17 05:12:03 +0000353
Eric Andersenaff114c2004-04-14 17:51:38 +0000354 /* Read next Huffman-coded symbol. */
Rob Landley2c98c402006-02-17 05:12:03 +0000355
Eric Andersen5fa4db22003-10-23 06:52:01 +0000356 /* Note: It is far cheaper to read maxLen bits and back up than it is
357 to read minLen bits and then an additional bit at a time, testing
358 as we go. Because there is a trailing last block (with file CRC),
359 there is no danger of the overread causing an unexpected EOF for a
360 valid compressed file. As a further optimization, we do the read
361 inline (falling back to a call to get_bits if the buffer runs
362 dry). The following (up to got_huff_bits:) is equivalent to
363 j=get_bits(bd,hufGroup->maxLen);
364 */
Rob Landley2c98c402006-02-17 05:12:03 +0000365
Eric Andersen5fa4db22003-10-23 06:52:01 +0000366 while (bd->inbufBitCount<hufGroup->maxLen) {
367 if(bd->inbufPos==bd->inbufCount) {
368 j = get_bits(bd,hufGroup->maxLen);
369 goto got_huff_bits;
370 }
371 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
372 bd->inbufBitCount+=8;
373 };
374 bd->inbufBitCount-=hufGroup->maxLen;
375 j = (bd->inbufBits>>bd->inbufBitCount)&((1<<hufGroup->maxLen)-1);
Rob Landley2c98c402006-02-17 05:12:03 +0000376
Eric Andersen5fa4db22003-10-23 06:52:01 +0000377got_huff_bits:
Rob Landley2c98c402006-02-17 05:12:03 +0000378
Eric Andersen5fa4db22003-10-23 06:52:01 +0000379 /* Figure how how many bits are in next symbol and unget extras */
Rob Landley2c98c402006-02-17 05:12:03 +0000380
Eric Andersen5fa4db22003-10-23 06:52:01 +0000381 i=hufGroup->minLen;
382 while(j>limit[i]) ++i;
383 bd->inbufBitCount += (hufGroup->maxLen - i);
Rob Landley2c98c402006-02-17 05:12:03 +0000384
Eric Andersen5fa4db22003-10-23 06:52:01 +0000385 /* Huffman decode value to get nextSym (with bounds checking) */
Rob Landley2c98c402006-02-17 05:12:03 +0000386
Eric Andersen5fa4db22003-10-23 06:52:01 +0000387 if ((i > hufGroup->maxLen)
388 || (((unsigned)(j=(j>>(hufGroup->maxLen-i))-base[i]))
389 >= MAX_SYMBOLS))
390 return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000391 nextSym = hufGroup->permute[j];
Rob Landley2c98c402006-02-17 05:12:03 +0000392
Eric Andersen5fa4db22003-10-23 06:52:01 +0000393 /* We have now decoded the symbol, which indicates either a new literal
394 byte, or a repeated run of the most recent literal byte. First,
395 check if nextSym indicates a repeated run, and if so loop collecting
396 how many times to repeat the last literal. */
Rob Landley2c98c402006-02-17 05:12:03 +0000397
Eric Andersen1acfb722003-10-18 01:59:46 +0000398 if (((unsigned)nextSym) <= SYMBOL_RUNB) { /* RUNA or RUNB */
Rob Landley2c98c402006-02-17 05:12:03 +0000399
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000400 /* If this is the start of a new run, zero out counter */
Rob Landley2c98c402006-02-17 05:12:03 +0000401
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000402 if(!runPos) {
403 runPos = 1;
404 t = 0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000405 }
Rob Landley2c98c402006-02-17 05:12:03 +0000406
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000407 /* Neat trick that saves 1 symbol: instead of or-ing 0 or 1 at
408 each bit position, add 1 or 2 instead. For example,
409 1011 is 1<<0 + 1<<1 + 2<<2. 1010 is 2<<0 + 2<<1 + 1<<2.
410 You can make any bit pattern that way using 1 less symbol than
411 the basic or 0/1 method (except all bits 0, which would use no
412 symbols, but a run of length 0 doesn't mean anything in this
413 context). Thus space is saved. */
Rob Landley2c98c402006-02-17 05:12:03 +0000414
Eric Andersen1acfb722003-10-18 01:59:46 +0000415 t += (runPos << nextSym); /* +runPos if RUNA; +2*runPos if RUNB */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000416 runPos <<= 1;
Rob Landleya8b98d62004-11-16 12:07:04 +0000417 goto end_of_huffman_loop;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000418 }
Rob Landley2c98c402006-02-17 05:12:03 +0000419
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000420 /* When we hit the first non-run symbol after a run, we now know
421 how many times to repeat the last literal, so append that many
422 copies to our buffer of decoded symbols (dbuf) now. (The last
423 literal used is the one at the head of the mtfSymbol array.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000424
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000425 if(runPos) {
426 runPos=0;
427 if(dbufCount+t>=dbufSize) return RETVAL_DATA_ERROR;
428
429 uc = symToByte[mtfSymbol[0]];
430 byteCount[uc] += t;
431 while(t--) dbuf[dbufCount++]=uc;
432 }
Rob Landley2c98c402006-02-17 05:12:03 +0000433
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000434 /* Is this the terminating symbol? */
Rob Landley2c98c402006-02-17 05:12:03 +0000435
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000436 if(nextSym>symTotal) break;
Rob Landley2c98c402006-02-17 05:12:03 +0000437
Eric Andersen5fa4db22003-10-23 06:52:01 +0000438 /* At this point, nextSym indicates a new literal character. Subtract
439 one to get the position in the MTF array at which this literal is
440 currently to be found. (Note that the result can't be -1 or 0,
441 because 0 and 1 are RUNA and RUNB. But another instance of the
442 first symbol in the mtf array, position 0, would have been handled
443 as part of a run above. Therefore 1 unused mtf position minus
444 2 non-literal nextSym values equals -1.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000445
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000446 if(dbufCount>=dbufSize) return RETVAL_DATA_ERROR;
447 i = nextSym - 1;
448 uc = mtfSymbol[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000449
Eric Andersen5fa4db22003-10-23 06:52:01 +0000450 /* Adjust the MTF array. Since we typically expect to move only a
451 * small number of symbols, and are bound by 256 in any case, using
452 * memmove here would typically be bigger and slower due to function
453 * call overhead and other assorted setup costs. */
Rob Landley2c98c402006-02-17 05:12:03 +0000454
Eric Andersen1acfb722003-10-18 01:59:46 +0000455 do {
456 mtfSymbol[i] = mtfSymbol[i-1];
457 } while (--i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000458 mtfSymbol[0] = uc;
459 uc=symToByte[uc];
Rob Landley2c98c402006-02-17 05:12:03 +0000460
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000461 /* We have our literal byte. Save it into dbuf. */
Rob Landley2c98c402006-02-17 05:12:03 +0000462
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000463 byteCount[uc]++;
464 dbuf[dbufCount++] = (unsigned int)uc;
Rob Landley2c98c402006-02-17 05:12:03 +0000465
Rob Landleyf856eab2006-02-17 03:43:49 +0000466 /* Skip group initialization if we're not done with this group. Done
467 * this way to avoid compiler warning. */
Rob Landley2c98c402006-02-17 05:12:03 +0000468
Rob Landleya8b98d62004-11-16 12:07:04 +0000469end_of_huffman_loop:
470 if(symCount--) goto continue_this_group;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000471 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000472
Eric Andersenaff114c2004-04-14 17:51:38 +0000473 /* At this point, we've read all the Huffman-coded symbols (and repeated
Eric Andersen5fa4db22003-10-23 06:52:01 +0000474 runs) for this block from the input stream, and decoded them into the
475 intermediate buffer. There are dbufCount many decoded bytes in dbuf[].
476 Now undo the Burrows-Wheeler transform on dbuf.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000477 See http://dogma.net/markn/articles/bwt/bwt.htm
478 */
Rob Landley2c98c402006-02-17 05:12:03 +0000479
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000480 /* Turn byteCount into cumulative occurrence counts of 0 to n-1. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000481
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000482 j=0;
483 for(i=0;i<256;i++) {
484 k=j+byteCount[i];
485 byteCount[i] = j;
486 j=k;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000487 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000488
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000489 /* Figure out what order dbuf would be in if we sorted it. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000490
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000491 for (i=0;i<dbufCount;i++) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000492 uc=(unsigned char)(dbuf[i] & 0xff);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000493 dbuf[byteCount[uc]] |= (i << 8);
494 byteCount[uc]++;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000495 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000496
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000497 /* Decode first byte by hand to initialize "previous" byte. Note that it
498 doesn't get output, and if the first three characters are identical
Eric Andersen5fa4db22003-10-23 06:52:01 +0000499 it doesn't qualify as a run (hence writeRunCountdown=5). */
Rob Landley2c98c402006-02-17 05:12:03 +0000500
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000501 if(dbufCount) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000502 if(origPtr>=dbufCount) return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000503 bd->writePos=dbuf[origPtr];
504 bd->writeCurrent=(unsigned char)(bd->writePos&0xff);
505 bd->writePos>>=8;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000506 bd->writeRunCountdown=5;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000507 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000508 bd->writeCount=dbufCount;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000509
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000510 return RETVAL_OK;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000511}
512
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000513/* Undo burrows-wheeler transform on intermediate buffer to produce output.
Eric Andersen5fa4db22003-10-23 06:52:01 +0000514 If start_bunzip was initialized with out_fd=-1, then up to len bytes of
515 data are written to outbuf. Return value is number of bytes written or
516 error (all errors are negative numbers). If out_fd!=-1, outbuf and len
517 are ignored, data is written to out_fd and return is RETVAL_OK or error.
518*/
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000519
Glenn L McGrath5699b852003-11-15 23:19:05 +0000520static int read_bunzip(bunzip_data *bd, char *outbuf, int len)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000521{
522 const unsigned int *dbuf;
523 int pos,current,previous,gotcount;
524
525 /* If last read was short due to end of file, return last block now */
526 if(bd->writeCount<0) return bd->writeCount;
527
528 gotcount = 0;
529 dbuf=bd->dbuf;
530 pos=bd->writePos;
531 current=bd->writeCurrent;
532
533 /* We will always have pending decoded data to write into the output
534 buffer unless this is the very first call (in which case we haven't
Eric Andersenaff114c2004-04-14 17:51:38 +0000535 Huffman-decoded a block into the intermediate buffer yet). */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000536
537 if (bd->writeCopies) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000538
Eric Andersen5fa4db22003-10-23 06:52:01 +0000539 /* Inside the loop, writeCopies means extra copies (beyond 1) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000540
Eric Andersen5fa4db22003-10-23 06:52:01 +0000541 --bd->writeCopies;
Rob Landleyf856eab2006-02-17 03:43:49 +0000542
Eric Andersen5fa4db22003-10-23 06:52:01 +0000543 /* Loop outputting bytes */
Rob Landleyf856eab2006-02-17 03:43:49 +0000544
Eric Andersen5fa4db22003-10-23 06:52:01 +0000545 for(;;) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000546
Eric Andersen5fa4db22003-10-23 06:52:01 +0000547 /* If the output buffer is full, snapshot state and return */
Rob Landleyf856eab2006-02-17 03:43:49 +0000548
Eric Andersen5fa4db22003-10-23 06:52:01 +0000549 if(gotcount >= len) {
550 bd->writePos=pos;
551 bd->writeCurrent=current;
552 bd->writeCopies++;
553 return len;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000554 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000555
Eric Andersen5fa4db22003-10-23 06:52:01 +0000556 /* Write next byte into output buffer, updating CRC */
Rob Landleyf856eab2006-02-17 03:43:49 +0000557
Eric Andersen5fa4db22003-10-23 06:52:01 +0000558 outbuf[gotcount++] = current;
559 bd->writeCRC=(((bd->writeCRC)<<8)
560 ^bd->crc32Table[((bd->writeCRC)>>24)^current]);
Rob Landleyf856eab2006-02-17 03:43:49 +0000561
Eric Andersen5fa4db22003-10-23 06:52:01 +0000562 /* Loop now if we're outputting multiple copies of this byte */
Rob Landleyf856eab2006-02-17 03:43:49 +0000563
Eric Andersen5fa4db22003-10-23 06:52:01 +0000564 if (bd->writeCopies) {
565 --bd->writeCopies;
566 continue;
567 }
568decode_next_byte:
569 if (!bd->writeCount--) break;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000570 /* Follow sequence vector to undo Burrows-Wheeler transform */
571 previous=current;
572 pos=dbuf[pos];
573 current=pos&0xff;
574 pos>>=8;
Rob Landleyf856eab2006-02-17 03:43:49 +0000575
Eric Andersen5fa4db22003-10-23 06:52:01 +0000576 /* After 3 consecutive copies of the same byte, the 4th is a repeat
577 count. We count down from 4 instead
578 * of counting up because testing for non-zero is faster */
Rob Landleyf856eab2006-02-17 03:43:49 +0000579
Eric Andersen5fa4db22003-10-23 06:52:01 +0000580 if(--bd->writeRunCountdown) {
581 if(current!=previous) bd->writeRunCountdown=4;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000582 } else {
Rob Landleyf856eab2006-02-17 03:43:49 +0000583
Eric Andersen5fa4db22003-10-23 06:52:01 +0000584 /* We have a repeated run, this byte indicates the count */
Rob Landleyf856eab2006-02-17 03:43:49 +0000585
Eric Andersen5fa4db22003-10-23 06:52:01 +0000586 bd->writeCopies=current;
587 current=previous;
588 bd->writeRunCountdown=5;
Rob Landleyf856eab2006-02-17 03:43:49 +0000589
Eric Andersen5fa4db22003-10-23 06:52:01 +0000590 /* Sometimes there are just 3 bytes (run length 0) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000591
Eric Andersen5fa4db22003-10-23 06:52:01 +0000592 if(!bd->writeCopies) goto decode_next_byte;
Rob Landleyf856eab2006-02-17 03:43:49 +0000593
Eric Andersen5fa4db22003-10-23 06:52:01 +0000594 /* Subtract the 1 copy we'd output anyway to get extras */
Rob Landleyf856eab2006-02-17 03:43:49 +0000595
Eric Andersen5fa4db22003-10-23 06:52:01 +0000596 --bd->writeCopies;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000597 }
598 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000599
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000600 /* Decompression of this block completed successfully */
Rob Landleyf856eab2006-02-17 03:43:49 +0000601
Eric Andersen5fa4db22003-10-23 06:52:01 +0000602 bd->writeCRC=~bd->writeCRC;
603 bd->totalCRC=((bd->totalCRC<<1) | (bd->totalCRC>>31)) ^ bd->writeCRC;
Rob Landleyf856eab2006-02-17 03:43:49 +0000604
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000605 /* If this block had a CRC error, force file level CRC error. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000606
Eric Andersen5fa4db22003-10-23 06:52:01 +0000607 if(bd->writeCRC!=bd->headerCRC) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000608 bd->totalCRC=bd->headerCRC+1;
609 return RETVAL_LAST_BLOCK;
610 }
Glenn L McGrath60bce492002-11-03 07:28:38 +0000611 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000612
Eric Andersenaff114c2004-04-14 17:51:38 +0000613 /* Refill the intermediate buffer by Huffman-decoding next block of input */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000614 /* (previous is just a convenient unused temp variable here) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000615
Eric Andersen5fa4db22003-10-23 06:52:01 +0000616 previous=get_next_block(bd);
617 if(previous) {
618 bd->writeCount=previous;
619 return (previous!=RETVAL_LAST_BLOCK) ? previous : gotcount;
620 }
621 bd->writeCRC=0xffffffffUL;
622 pos=bd->writePos;
623 current=bd->writeCurrent;
624 goto decode_next_byte;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000625}
626
Eric Andersen5fa4db22003-10-23 06:52:01 +0000627/* Allocate the structure, read file header. If in_fd==-1, inbuf must contain
628 a complete bunzip file (len bytes long). If in_fd!=-1, inbuf and len are
629 ignored, and data is read from file handle into temporary buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000630
Rob Landley1ff789c2005-09-25 03:12:26 +0000631static int start_bunzip(bunzip_data **bdp, int in_fd, unsigned char *inbuf,
632 int len)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000633{
634 bunzip_data *bd;
635 unsigned int i,j,c;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000636 const unsigned int BZh0=(((unsigned int)'B')<<24)+(((unsigned int)'Z')<<16)
637 +(((unsigned int)'h')<<8)+(unsigned int)'0';
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000638
639 /* Figure out how much data to allocate */
Rob Landleyf856eab2006-02-17 03:43:49 +0000640
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000641 i=sizeof(bunzip_data);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000642 if(in_fd!=-1) i+=IOBUF_SIZE;
Rob Landleyf856eab2006-02-17 03:43:49 +0000643
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000644 /* Allocate bunzip_data. Most fields initialize to zero. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000645
Glenn L McGrath1c834402003-10-28 23:32:12 +0000646 bd=*bdp=xmalloc(i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000647 memset(bd,0,sizeof(bunzip_data));
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
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000658 for(i=0;i<256;i++) {
659 c=i<<24;
660 for(j=8;j;j--)
661 c=c&0x80000000 ? (c<<1)^0x04c11db7 : (c<<1);
662 bd->crc32Table[i]=c;
663 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000664
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000665 /* Setup for I/O error handling via longjmp */
Rob Landleyf856eab2006-02-17 03:43:49 +0000666
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000667 i=setjmp(bd->jmpbuf);
668 if(i) return i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000669
670 /* Ensure that file starts with "BZh['1'-'9']." */
Rob Landleyf856eab2006-02-17 03:43:49 +0000671
Eric Andersen5fa4db22003-10-23 06:52:01 +0000672 i = get_bits(bd,32);
673 if (((unsigned int)(i-BZh0-1)) >= 9) return RETVAL_NOT_BZIP_DATA;
674
675 /* Fourth byte (ascii '1'-'9'), indicates block size in units of 100k of
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000676 uncompressed data. Allocate intermediate buffer for block. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000677
Eric Andersen5fa4db22003-10-23 06:52:01 +0000678 bd->dbufSize=100000*(i-BZh0);
679
Glenn L McGrath1c834402003-10-28 23:32:12 +0000680 bd->dbuf=xmalloc(bd->dbufSize * sizeof(int));
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000681 return RETVAL_OK;
682}
683
Eric Andersen5fa4db22003-10-23 06:52:01 +0000684/* Example usage: decompress src_fd to dst_fd. (Stops at end of bzip data,
685 not end of file.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000686
Eric Andersen5fa4db22003-10-23 06:52:01 +0000687extern int uncompressStream(int src_fd, int dst_fd)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000688{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000689 char *outbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000690 bunzip_data *bd;
691 int i;
692
Glenn L McGrath1c834402003-10-28 23:32:12 +0000693 outbuf=xmalloc(IOBUF_SIZE);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000694 if(!(i=start_bunzip(&bd,src_fd,0,0))) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000695 for(;;) {
696 if((i=read_bunzip(bd,outbuf,IOBUF_SIZE)) <= 0) break;
697 if(i!=write(dst_fd,outbuf,i)) {
698 i=RETVAL_UNEXPECTED_OUTPUT_EOF;
699 break;
700 }
701 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000702 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000703
Eric Andersen5fa4db22003-10-23 06:52:01 +0000704 /* Check CRC and release memory */
Rob Landleyf856eab2006-02-17 03:43:49 +0000705
Glenn L McGrath1c834402003-10-28 23:32:12 +0000706 if(i==RETVAL_LAST_BLOCK) {
707 if (bd->headerCRC!=bd->totalCRC) {
708 bb_error_msg("Data integrity error when decompressing.");
709 } else {
710 i=RETVAL_OK;
711 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000712 } else if (i==RETVAL_UNEXPECTED_OUTPUT_EOF) {
Glenn L McGrath1c834402003-10-28 23:32:12 +0000713 bb_error_msg("Compressed file ends unexpectedly");
714 } else {
715 bb_error_msg("Decompression failed");
716 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000717 if(bd->dbuf) free(bd->dbuf);
718 free(bd);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000719 free(outbuf);
Glenn L McGrath1c834402003-10-28 23:32:12 +0000720
Eric Andersen5fa4db22003-10-23 06:52:01 +0000721 return i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000722}
723
Eric Andersen5fa4db22003-10-23 06:52:01 +0000724#ifdef TESTING
Glenn L McGrath60bce492002-11-03 07:28:38 +0000725
Eric Andersen5fa4db22003-10-23 06:52:01 +0000726static char * const bunzip_errors[]={NULL,"Bad file checksum","Not bzip data",
727 "Unexpected input EOF","Unexpected output EOF","Data error",
728 "Out of memory","Obsolete (pre 0.9.5) bzip format not supported."};
Glenn L McGrath237ae422002-11-03 14:05:15 +0000729
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000730/* Dumb little test thing, decompress stdin to stdout */
731int main(int argc, char *argv[])
732{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000733 int i=uncompressStream(0,1);
734 char c;
735
736 if(i) fprintf(stderr,"%s\n", bunzip_errors[-i]);
737 else if(read(0,&c,1)) fprintf(stderr,"Trailing garbage ignored\n");
738 return -i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000739}
740#endif