blob: 1879f7255799006f271396bafdbb69c4332479f7 [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
Bernhard Reutner-Fischercfb53df2006-04-02 21:50:01 +000027 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
Bernhard Reutner-Fischercfb53df2006-04-02 21:50:01 +000041#include "unarchive.h"
42
Eric Andersenaff114c2004-04-14 17:51:38 +000043/* Constants for Huffman coding */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000044#define MAX_GROUPS 6
Tim Rikerc1ef7bd2006-01-25 00:08:53 +000045#define GROUP_SIZE 50 /* 64 would have been more efficient */
46#define MAX_HUFCODE_BITS 20 /* Longest Huffman code allowed */
47#define MAX_SYMBOLS 258 /* 256 literals + RUNA + RUNB */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000048#define SYMBOL_RUNA 0
49#define SYMBOL_RUNB 1
Glenn L McGrath60bce492002-11-03 07:28:38 +000050
Eric Andersen0d6d88a2003-10-18 01:58:35 +000051/* Status return values */
52#define RETVAL_OK 0
53#define RETVAL_LAST_BLOCK (-1)
54#define RETVAL_NOT_BZIP_DATA (-2)
55#define RETVAL_UNEXPECTED_INPUT_EOF (-3)
56#define RETVAL_UNEXPECTED_OUTPUT_EOF (-4)
57#define RETVAL_DATA_ERROR (-5)
58#define RETVAL_OUT_OF_MEMORY (-6)
59#define RETVAL_OBSOLETE_INPUT (-7)
Glenn L McGrath60bce492002-11-03 07:28:38 +000060
Eric Andersen0d6d88a2003-10-18 01:58:35 +000061/* Other housekeeping constants */
62#define IOBUF_SIZE 4096
Glenn L McGrath60bce492002-11-03 07:28:38 +000063
Eric Andersenaff114c2004-04-14 17:51:38 +000064/* This is what we know about each Huffman coding group */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000065struct group_data {
Eric Andersen1acfb722003-10-18 01:59:46 +000066 /* We have an extra slot at the end of limit[] for a sentinal value. */
67 int limit[MAX_HUFCODE_BITS+1],base[MAX_HUFCODE_BITS],permute[MAX_SYMBOLS];
Eric Andersen5fa4db22003-10-23 06:52:01 +000068 int minLen, maxLen;
Glenn L McGrath60bce492002-11-03 07:28:38 +000069};
70
Eric Andersen0d6d88a2003-10-18 01:58:35 +000071/* Structure holding all the housekeeping data, including IO buffers and
72 memory that persists between calls to bunzip */
Rob Landleyf856eab2006-02-17 03:43:49 +000073
Eric Andersen0d6d88a2003-10-18 01:58:35 +000074typedef struct {
Eric Andersen5fa4db22003-10-23 06:52:01 +000075 /* State for interrupting output loop */
Rob Landley2c98c402006-02-17 05:12:03 +000076
Eric Andersen5fa4db22003-10-23 06:52:01 +000077 int writeCopies,writePos,writeRunCountdown,writeCount,writeCurrent;
Rob Landleyf856eab2006-02-17 03:43:49 +000078
Eric Andersen5fa4db22003-10-23 06:52:01 +000079 /* I/O tracking data (file handles, buffers, positions, etc.) */
Rob Landleyf856eab2006-02-17 03:43:49 +000080
Eric Andersen5fa4db22003-10-23 06:52:01 +000081 int in_fd,out_fd,inbufCount,inbufPos /*,outbufPos*/;
82 unsigned char *inbuf /*,*outbuf*/;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000083 unsigned int inbufBitCount, inbufBits;
Rob Landleyf856eab2006-02-17 03:43:49 +000084
Eric Andersen0d6d88a2003-10-18 01:58:35 +000085 /* The CRC values stored in the block header and calculated from the data */
Rob Landleyf856eab2006-02-17 03:43:49 +000086
Rob Landleyc57ec372006-04-10 17:07:15 +000087 uint32_t headerCRC, totalCRC, writeCRC;
88 uint32_t *crc32Table;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000089 /* Intermediate buffer and its size (in bytes) */
Rob Landleyf856eab2006-02-17 03:43:49 +000090
Eric Andersen0d6d88a2003-10-18 01:58:35 +000091 unsigned int *dbuf, dbufSize;
Rob Landleyf856eab2006-02-17 03:43:49 +000092
Eric Andersen0d6d88a2003-10-18 01:58:35 +000093 /* These things are a bit too big to go on the stack */
Rob Landleyf856eab2006-02-17 03:43:49 +000094
Eric Andersen0d6d88a2003-10-18 01:58:35 +000095 unsigned char selectors[32768]; /* nSelectors=15 bits */
Eric Andersenaff114c2004-04-14 17:51:38 +000096 struct group_data groups[MAX_GROUPS]; /* Huffman coding tables */
Rob Landleyf856eab2006-02-17 03:43:49 +000097
Eric Andersen5fa4db22003-10-23 06:52:01 +000098 /* For I/O error handling */
Rob Landleyf856eab2006-02-17 03:43:49 +000099
Eric Andersen5fa4db22003-10-23 06:52:01 +0000100 jmp_buf jmpbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000101} bunzip_data;
102
103/* Return the next nnn bits of input. All reads from the compressed input
104 are done through this function. All reads are big endian */
Rob Landleyf856eab2006-02-17 03:43:49 +0000105
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000106static unsigned int get_bits(bunzip_data *bd, char bits_wanted)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000107{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000108 unsigned int bits=0;
109
110 /* If we need to get more data from the byte buffer, do so. (Loop getting
111 one byte at a time to enforce endianness and avoid unaligned access.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000112
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000113 while (bd->inbufBitCount<bits_wanted) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000114
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000115 /* If we need to read more data from file into byte buffer, do so */
Rob Landleyf856eab2006-02-17 03:43:49 +0000116
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000117 if(bd->inbufPos==bd->inbufCount) {
Eric Andersen1acfb722003-10-18 01:59:46 +0000118 if((bd->inbufCount = read(bd->in_fd, bd->inbuf, IOBUF_SIZE)) <= 0)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000119 longjmp(bd->jmpbuf,RETVAL_UNEXPECTED_INPUT_EOF);
120 bd->inbufPos=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000121 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000122
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000123 /* Avoid 32-bit overflow (dump bit buffer to top of output) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000124
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000125 if(bd->inbufBitCount>=24) {
126 bits=bd->inbufBits&((1<<bd->inbufBitCount)-1);
127 bits_wanted-=bd->inbufBitCount;
128 bits<<=bits_wanted;
129 bd->inbufBitCount=0;
130 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000131
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000132 /* Grab next 8 bits of input from buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000133
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000134 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
135 bd->inbufBitCount+=8;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000136 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000137
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000138 /* Calculate result */
Rob Landleyf856eab2006-02-17 03:43:49 +0000139
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000140 bd->inbufBitCount-=bits_wanted;
141 bits|=(bd->inbufBits>>bd->inbufBitCount)&((1<<bits_wanted)-1);
142
143 return bits;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000144}
145
Eric Andersen5fa4db22003-10-23 06:52:01 +0000146/* Unpacks the next block and sets up for the inverse burrows-wheeler step. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000147
Eric Andersen5fa4db22003-10-23 06:52:01 +0000148static int get_next_block(bunzip_data *bd)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000149{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000150 struct group_data *hufGroup;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000151 int dbufCount,nextSym,dbufSize,groupCount,*base,*limit,selector,
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000152 i,j,k,t,runPos,symCount,symTotal,nSelectors,byteCount[256];
153 unsigned char uc, symToByte[256], mtfSymbol[256], *selectors;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000154 unsigned int *dbuf,origPtr;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000155
156 dbuf=bd->dbuf;
157 dbufSize=bd->dbufSize;
158 selectors=bd->selectors;
Rob Landley2c98c402006-02-17 05:12:03 +0000159
Eric Andersen5fa4db22003-10-23 06:52:01 +0000160 /* Reset longjmp I/O error handling */
Rob Landley2c98c402006-02-17 05:12:03 +0000161
Eric Andersen5fa4db22003-10-23 06:52:01 +0000162 i=setjmp(bd->jmpbuf);
163 if(i) return i;
Rob Landley2c98c402006-02-17 05:12:03 +0000164
Eric Andersen5fa4db22003-10-23 06:52:01 +0000165 /* Read in header signature and CRC, then validate signature.
166 (last block signature means CRC is for whole file, return now) */
Rob Landley2c98c402006-02-17 05:12:03 +0000167
Eric Andersen5fa4db22003-10-23 06:52:01 +0000168 i = get_bits(bd,24);
169 j = get_bits(bd,24);
170 bd->headerCRC=get_bits(bd,32);
171 if ((i == 0x177245) && (j == 0x385090)) return RETVAL_LAST_BLOCK;
172 if ((i != 0x314159) || (j != 0x265359)) return RETVAL_NOT_BZIP_DATA;
Rob Landley2c98c402006-02-17 05:12:03 +0000173
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000174 /* We can add support for blockRandomised if anybody complains. There was
175 some code for this in busybox 1.0.0-pre3, but nobody ever noticed that
176 it didn't actually work. */
Rob Landley2c98c402006-02-17 05:12:03 +0000177
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000178 if(get_bits(bd,1)) return RETVAL_OBSOLETE_INPUT;
179 if((origPtr=get_bits(bd,24)) > dbufSize) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000180
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000181 /* mapping table: if some byte values are never used (encoding things
182 like ascii text), the compression code removes the gaps to have fewer
183 symbols to deal with, and writes a sparse bitfield indicating which
184 values were present. We make a translation table to convert the symbols
185 back to the corresponding bytes. */
Rob Landley2c98c402006-02-17 05:12:03 +0000186
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000187 t=get_bits(bd, 16);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000188 symTotal=0;
189 for (i=0;i<16;i++) {
190 if(t&(1<<(15-i))) {
191 k=get_bits(bd,16);
192 for(j=0;j<16;j++)
193 if(k&(1<<(15-j))) symToByte[symTotal++]=(16*i)+j;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000194 }
195 }
Rob Landley2c98c402006-02-17 05:12:03 +0000196
Eric Andersenaff114c2004-04-14 17:51:38 +0000197 /* How many different Huffman coding groups does this block use? */
Rob Landley2c98c402006-02-17 05:12:03 +0000198
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000199 groupCount=get_bits(bd,3);
200 if (groupCount<2 || groupCount>MAX_GROUPS) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000201
Eric Andersenaff114c2004-04-14 17:51:38 +0000202 /* nSelectors: Every GROUP_SIZE many symbols we select a new Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000203 group. Read in the group selector list, which is stored as MTF encoded
Eric Andersen5fa4db22003-10-23 06:52:01 +0000204 bit runs. (MTF=Move To Front, as each value is used it's moved to the
205 start of the list.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000206
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000207 if(!(nSelectors=get_bits(bd, 15))) return RETVAL_DATA_ERROR;
208 for(i=0; i<groupCount; i++) mtfSymbol[i] = i;
209 for(i=0; i<nSelectors; i++) {
Rob Landley2c98c402006-02-17 05:12:03 +0000210
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000211 /* Get next value */
Rob Landley2c98c402006-02-17 05:12:03 +0000212
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000213 for(j=0;get_bits(bd,1);j++) if (j>=groupCount) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000214
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000215 /* Decode MTF to get the next selector */
Rob Landley2c98c402006-02-17 05:12:03 +0000216
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000217 uc = mtfSymbol[j];
Eric Andersen5fa4db22003-10-23 06:52:01 +0000218 for(;j;j--) mtfSymbol[j] = mtfSymbol[j-1];
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000219 mtfSymbol[0]=selectors[i]=uc;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000220 }
Rob Landley2c98c402006-02-17 05:12:03 +0000221
Eric Andersenaff114c2004-04-14 17:51:38 +0000222 /* Read the Huffman coding tables for each group, which code for symTotal
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000223 literal symbols, plus two run symbols (RUNA, RUNB) */
Rob Landley2c98c402006-02-17 05:12:03 +0000224
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000225 symCount=symTotal+2;
226 for (j=0; j<groupCount; j++) {
227 unsigned char length[MAX_SYMBOLS],temp[MAX_HUFCODE_BITS+1];
228 int minLen, maxLen, pp;
Rob Landley2c98c402006-02-17 05:12:03 +0000229
Eric Andersenaff114c2004-04-14 17:51:38 +0000230 /* Read Huffman code lengths for each symbol. They're stored in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000231 a way similar to mtf; record a starting value for the first symbol,
232 and an offset from the previous value for everys symbol after that.
233 (Subtracting 1 before the loop and then adding it back at the end is
234 an optimization that makes the test inside the loop simpler: symbol
235 length 0 becomes negative, so an unsigned inequality catches it.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000236
Eric Andersen5fa4db22003-10-23 06:52:01 +0000237 t=get_bits(bd, 5)-1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000238 for (i = 0; i < symCount; i++) {
239 for(;;) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000240 if (((unsigned)t) > (MAX_HUFCODE_BITS-1))
241 return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000242
Eric Andersen5fa4db22003-10-23 06:52:01 +0000243 /* If first bit is 0, stop. Else second bit indicates whether
244 to increment or decrement the value. Optimization: grab 2
245 bits and unget the second if the first was 0. */
Rob Landley2c98c402006-02-17 05:12:03 +0000246
Eric Andersen5fa4db22003-10-23 06:52:01 +0000247 k = get_bits(bd,2);
248 if (k < 2) {
249 bd->inbufBitCount++;
250 break;
251 }
Rob Landley2c98c402006-02-17 05:12:03 +0000252
Eric Andersen5fa4db22003-10-23 06:52:01 +0000253 /* Add one if second bit 1, else subtract 1. Avoids if/else */
Rob Landley2c98c402006-02-17 05:12:03 +0000254
Eric Andersen5fa4db22003-10-23 06:52:01 +0000255 t+=(((k+1)&2)-1);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000256 }
Rob Landley2c98c402006-02-17 05:12:03 +0000257
Eric Andersen5fa4db22003-10-23 06:52:01 +0000258 /* Correct for the initial -1, to get the final symbol length */
Rob Landley2c98c402006-02-17 05:12:03 +0000259
Eric Andersen5fa4db22003-10-23 06:52:01 +0000260 length[i]=t+1;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000261 }
Rob Landley2c98c402006-02-17 05:12:03 +0000262
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000263 /* Find largest and smallest lengths in this group */
Rob Landley2c98c402006-02-17 05:12:03 +0000264
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000265 minLen=maxLen=length[0];
266 for(i = 1; i < symCount; i++) {
267 if(length[i] > maxLen) maxLen = length[i];
268 else if(length[i] < minLen) minLen = length[i];
Glenn L McGrath60bce492002-11-03 07:28:38 +0000269 }
Rob Landley2c98c402006-02-17 05:12:03 +0000270
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000271 /* Calculate permute[], base[], and limit[] tables from length[].
272 *
Eric Andersenaff114c2004-04-14 17:51:38 +0000273 * permute[] is the lookup table for converting Huffman coded symbols
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000274 * into decoded symbols. base[] is the amount to subtract from the
Eric Andersenaff114c2004-04-14 17:51:38 +0000275 * value of a Huffman symbol of a given length when using permute[].
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000276 *
277 * limit[] indicates the largest numerical value a symbol with a given
Eric Andersenaff114c2004-04-14 17:51:38 +0000278 * number of bits can have. This is how the Huffman codes can vary in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000279 * length: each code with a value>limit[length] needs another bit.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000280 */
Rob Landley2c98c402006-02-17 05:12:03 +0000281
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000282 hufGroup=bd->groups+j;
283 hufGroup->minLen = minLen;
284 hufGroup->maxLen = maxLen;
Rob Landley2c98c402006-02-17 05:12:03 +0000285
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000286 /* Note that minLen can't be smaller than 1, so we adjust the base
287 and limit array pointers so we're not always wasting the first
288 entry. We do this again when using them (during symbol decoding).*/
Rob Landley2c98c402006-02-17 05:12:03 +0000289
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000290 base=hufGroup->base-1;
291 limit=hufGroup->limit-1;
Rob Landley2c98c402006-02-17 05:12:03 +0000292
Eric Andersen5fa4db22003-10-23 06:52:01 +0000293 /* Calculate permute[]. Concurently, initialize temp[] and limit[]. */
Rob Landley2c98c402006-02-17 05:12:03 +0000294
Eric Andersen5fa4db22003-10-23 06:52:01 +0000295 pp=0;
296 for(i=minLen;i<=maxLen;i++) {
297 temp[i]=limit[i]=0;
Eric Andersenc7bda1c2004-03-15 08:29:22 +0000298 for(t=0;t<symCount;t++)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000299 if(length[t]==i) hufGroup->permute[pp++] = t;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000300 }
Rob Landley2c98c402006-02-17 05:12:03 +0000301
Eric Andersen5fa4db22003-10-23 06:52:01 +0000302 /* Count symbols coded for at each bit length */
Rob Landley2c98c402006-02-17 05:12:03 +0000303
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000304 for (i=0;i<symCount;i++) temp[length[i]]++;
Rob Landley2c98c402006-02-17 05:12:03 +0000305
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000306 /* Calculate limit[] (the largest symbol-coding value at each bit
307 * length, which is (previous limit<<1)+symbols at this level), and
308 * base[] (number of symbols to ignore at each bit length, which is
Eric Andersen5fa4db22003-10-23 06:52:01 +0000309 * limit minus the cumulative count of symbols coded for already). */
Rob Landley2c98c402006-02-17 05:12:03 +0000310
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000311 pp=t=0;
312 for (i=minLen; i<maxLen; i++) {
313 pp+=temp[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000314
Eric Andersen5fa4db22003-10-23 06:52:01 +0000315 /* We read the largest possible symbol size and then unget bits
316 after determining how many we need, and those extra bits could
317 be set to anything. (They're noise from future symbols.) At
318 each level we're really only interested in the first few bits,
319 so here we set all the trailing to-be-ignored bits to 1 so they
320 don't affect the value>limit[length] comparison. */
Rob Landley2c98c402006-02-17 05:12:03 +0000321
Eric Andersen5fa4db22003-10-23 06:52:01 +0000322 limit[i]= (pp << (maxLen - i)) - 1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000323 pp<<=1;
324 base[i+1]=pp-(t+=temp[i]);
325 }
Eric Andersen1acfb722003-10-18 01:59:46 +0000326 limit[maxLen+1] = INT_MAX; /* Sentinal value for reading next sym. */
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000327 limit[maxLen]=pp+temp[maxLen]-1;
328 base[minLen]=0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000329 }
Rob Landley2c98c402006-02-17 05:12:03 +0000330
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000331 /* We've finished reading and digesting the block header. Now read this
Eric Andersenaff114c2004-04-14 17:51:38 +0000332 block's Huffman coded symbols from the file and undo the Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000333 and run length encoding, saving the result into dbuf[dbufCount++]=uc */
Glenn L McGrath60bce492002-11-03 07:28:38 +0000334
Eric Andersen5fa4db22003-10-23 06:52:01 +0000335 /* Initialize symbol occurrence counters and symbol Move To Front table */
Rob Landley2c98c402006-02-17 05:12:03 +0000336
Eric Andersen5fa4db22003-10-23 06:52:01 +0000337 for(i=0;i<256;i++) {
338 byteCount[i] = 0;
339 mtfSymbol[i]=(unsigned char)i;
340 }
Rob Landley2c98c402006-02-17 05:12:03 +0000341
Eric Andersen5fa4db22003-10-23 06:52:01 +0000342 /* Loop through compressed symbols. */
Rob Landley2c98c402006-02-17 05:12:03 +0000343
Rob Landleya8b98d62004-11-16 12:07:04 +0000344 runPos=dbufCount=selector=0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000345 for(;;) {
Rob Landley2c98c402006-02-17 05:12:03 +0000346
Rob Landleya8b98d62004-11-16 12:07:04 +0000347 /* fetch next Huffman coding group from list. */
Rob Landley2c98c402006-02-17 05:12:03 +0000348
Rob Landleya8b98d62004-11-16 12:07:04 +0000349 symCount=GROUP_SIZE-1;
350 if(selector>=nSelectors) return RETVAL_DATA_ERROR;
351 hufGroup=bd->groups+selectors[selector++];
352 base=hufGroup->base-1;
353 limit=hufGroup->limit-1;
354continue_this_group:
Rob Landley2c98c402006-02-17 05:12:03 +0000355
Eric Andersenaff114c2004-04-14 17:51:38 +0000356 /* Read next Huffman-coded symbol. */
Rob Landley2c98c402006-02-17 05:12:03 +0000357
Eric Andersen5fa4db22003-10-23 06:52:01 +0000358 /* Note: It is far cheaper to read maxLen bits and back up than it is
359 to read minLen bits and then an additional bit at a time, testing
360 as we go. Because there is a trailing last block (with file CRC),
361 there is no danger of the overread causing an unexpected EOF for a
362 valid compressed file. As a further optimization, we do the read
363 inline (falling back to a call to get_bits if the buffer runs
364 dry). The following (up to got_huff_bits:) is equivalent to
365 j=get_bits(bd,hufGroup->maxLen);
366 */
Rob Landley2c98c402006-02-17 05:12:03 +0000367
Eric Andersen5fa4db22003-10-23 06:52:01 +0000368 while (bd->inbufBitCount<hufGroup->maxLen) {
369 if(bd->inbufPos==bd->inbufCount) {
370 j = get_bits(bd,hufGroup->maxLen);
371 goto got_huff_bits;
372 }
373 bd->inbufBits=(bd->inbufBits<<8)|bd->inbuf[bd->inbufPos++];
374 bd->inbufBitCount+=8;
375 };
376 bd->inbufBitCount-=hufGroup->maxLen;
377 j = (bd->inbufBits>>bd->inbufBitCount)&((1<<hufGroup->maxLen)-1);
Rob Landley2c98c402006-02-17 05:12:03 +0000378
Eric Andersen5fa4db22003-10-23 06:52:01 +0000379got_huff_bits:
Rob Landley2c98c402006-02-17 05:12:03 +0000380
Eric Andersen5fa4db22003-10-23 06:52:01 +0000381 /* Figure how how many bits are in next symbol and unget extras */
Rob Landley2c98c402006-02-17 05:12:03 +0000382
Eric Andersen5fa4db22003-10-23 06:52:01 +0000383 i=hufGroup->minLen;
384 while(j>limit[i]) ++i;
385 bd->inbufBitCount += (hufGroup->maxLen - i);
Rob Landley2c98c402006-02-17 05:12:03 +0000386
Eric Andersen5fa4db22003-10-23 06:52:01 +0000387 /* Huffman decode value to get nextSym (with bounds checking) */
Rob Landley2c98c402006-02-17 05:12:03 +0000388
Eric Andersen5fa4db22003-10-23 06:52:01 +0000389 if ((i > hufGroup->maxLen)
390 || (((unsigned)(j=(j>>(hufGroup->maxLen-i))-base[i]))
391 >= MAX_SYMBOLS))
392 return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000393 nextSym = hufGroup->permute[j];
Rob Landley2c98c402006-02-17 05:12:03 +0000394
Eric Andersen5fa4db22003-10-23 06:52:01 +0000395 /* We have now decoded the symbol, which indicates either a new literal
396 byte, or a repeated run of the most recent literal byte. First,
397 check if nextSym indicates a repeated run, and if so loop collecting
398 how many times to repeat the last literal. */
Rob Landley2c98c402006-02-17 05:12:03 +0000399
Eric Andersen1acfb722003-10-18 01:59:46 +0000400 if (((unsigned)nextSym) <= SYMBOL_RUNB) { /* RUNA or RUNB */
Rob Landley2c98c402006-02-17 05:12:03 +0000401
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000402 /* If this is the start of a new run, zero out counter */
Rob Landley2c98c402006-02-17 05:12:03 +0000403
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000404 if(!runPos) {
405 runPos = 1;
406 t = 0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000407 }
Rob Landley2c98c402006-02-17 05:12:03 +0000408
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000409 /* Neat trick that saves 1 symbol: instead of or-ing 0 or 1 at
410 each bit position, add 1 or 2 instead. For example,
411 1011 is 1<<0 + 1<<1 + 2<<2. 1010 is 2<<0 + 2<<1 + 1<<2.
412 You can make any bit pattern that way using 1 less symbol than
413 the basic or 0/1 method (except all bits 0, which would use no
414 symbols, but a run of length 0 doesn't mean anything in this
415 context). Thus space is saved. */
Rob Landley2c98c402006-02-17 05:12:03 +0000416
Eric Andersen1acfb722003-10-18 01:59:46 +0000417 t += (runPos << nextSym); /* +runPos if RUNA; +2*runPos if RUNB */
Rob Landleyefae2942006-02-17 05:19:40 +0000418 if(runPos < dbufSize) runPos <<= 1;
Rob Landleya8b98d62004-11-16 12:07:04 +0000419 goto end_of_huffman_loop;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000420 }
Rob Landley2c98c402006-02-17 05:12:03 +0000421
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000422 /* When we hit the first non-run symbol after a run, we now know
423 how many times to repeat the last literal, so append that many
424 copies to our buffer of decoded symbols (dbuf) now. (The last
425 literal used is the one at the head of the mtfSymbol array.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000426
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000427 if(runPos) {
428 runPos=0;
429 if(dbufCount+t>=dbufSize) return RETVAL_DATA_ERROR;
430
431 uc = symToByte[mtfSymbol[0]];
432 byteCount[uc] += t;
433 while(t--) dbuf[dbufCount++]=uc;
434 }
Rob Landley2c98c402006-02-17 05:12:03 +0000435
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000436 /* Is this the terminating symbol? */
Rob Landley2c98c402006-02-17 05:12:03 +0000437
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000438 if(nextSym>symTotal) break;
Rob Landley2c98c402006-02-17 05:12:03 +0000439
Eric Andersen5fa4db22003-10-23 06:52:01 +0000440 /* At this point, nextSym indicates a new literal character. Subtract
441 one to get the position in the MTF array at which this literal is
442 currently to be found. (Note that the result can't be -1 or 0,
443 because 0 and 1 are RUNA and RUNB. But another instance of the
444 first symbol in the mtf array, position 0, would have been handled
445 as part of a run above. Therefore 1 unused mtf position minus
446 2 non-literal nextSym values equals -1.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000447
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000448 if(dbufCount>=dbufSize) return RETVAL_DATA_ERROR;
449 i = nextSym - 1;
450 uc = mtfSymbol[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000451
Eric Andersen5fa4db22003-10-23 06:52:01 +0000452 /* Adjust the MTF array. Since we typically expect to move only a
453 * small number of symbols, and are bound by 256 in any case, using
454 * memmove here would typically be bigger and slower due to function
455 * call overhead and other assorted setup costs. */
Rob Landley2c98c402006-02-17 05:12:03 +0000456
Eric Andersen1acfb722003-10-18 01:59:46 +0000457 do {
458 mtfSymbol[i] = mtfSymbol[i-1];
459 } while (--i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000460 mtfSymbol[0] = uc;
461 uc=symToByte[uc];
Rob Landley2c98c402006-02-17 05:12:03 +0000462
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000463 /* We have our literal byte. Save it into dbuf. */
Rob Landley2c98c402006-02-17 05:12:03 +0000464
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000465 byteCount[uc]++;
466 dbuf[dbufCount++] = (unsigned int)uc;
Rob Landley2c98c402006-02-17 05:12:03 +0000467
Rob Landleyf856eab2006-02-17 03:43:49 +0000468 /* Skip group initialization if we're not done with this group. Done
469 * this way to avoid compiler warning. */
Rob Landley2c98c402006-02-17 05:12:03 +0000470
Rob Landleya8b98d62004-11-16 12:07:04 +0000471end_of_huffman_loop:
472 if(symCount--) goto continue_this_group;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000473 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000474
Eric Andersenaff114c2004-04-14 17:51:38 +0000475 /* At this point, we've read all the Huffman-coded symbols (and repeated
Eric Andersen5fa4db22003-10-23 06:52:01 +0000476 runs) for this block from the input stream, and decoded them into the
477 intermediate buffer. There are dbufCount many decoded bytes in dbuf[].
478 Now undo the Burrows-Wheeler transform on dbuf.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000479 See http://dogma.net/markn/articles/bwt/bwt.htm
480 */
Rob Landley2c98c402006-02-17 05:12:03 +0000481
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000482 /* Turn byteCount into cumulative occurrence counts of 0 to n-1. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000483
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000484 j=0;
485 for(i=0;i<256;i++) {
486 k=j+byteCount[i];
487 byteCount[i] = j;
488 j=k;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000489 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000490
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000491 /* Figure out what order dbuf would be in if we sorted it. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000492
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000493 for (i=0;i<dbufCount;i++) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000494 uc=(unsigned char)(dbuf[i] & 0xff);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000495 dbuf[byteCount[uc]] |= (i << 8);
496 byteCount[uc]++;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000497 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000498
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000499 /* Decode first byte by hand to initialize "previous" byte. Note that it
500 doesn't get output, and if the first three characters are identical
Eric Andersen5fa4db22003-10-23 06:52:01 +0000501 it doesn't qualify as a run (hence writeRunCountdown=5). */
Rob Landley2c98c402006-02-17 05:12:03 +0000502
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000503 if(dbufCount) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000504 if(origPtr>=dbufCount) return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000505 bd->writePos=dbuf[origPtr];
506 bd->writeCurrent=(unsigned char)(bd->writePos&0xff);
507 bd->writePos>>=8;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000508 bd->writeRunCountdown=5;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000509 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000510 bd->writeCount=dbufCount;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000511
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000512 return RETVAL_OK;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000513}
514
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000515/* Undo burrows-wheeler transform on intermediate buffer to produce output.
Eric Andersen5fa4db22003-10-23 06:52:01 +0000516 If start_bunzip was initialized with out_fd=-1, then up to len bytes of
517 data are written to outbuf. Return value is number of bytes written or
518 error (all errors are negative numbers). If out_fd!=-1, outbuf and len
519 are ignored, data is written to out_fd and return is RETVAL_OK or error.
520*/
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000521
Glenn L McGrath5699b852003-11-15 23:19:05 +0000522static int read_bunzip(bunzip_data *bd, char *outbuf, int len)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000523{
524 const unsigned int *dbuf;
525 int pos,current,previous,gotcount;
526
527 /* If last read was short due to end of file, return last block now */
528 if(bd->writeCount<0) return bd->writeCount;
529
530 gotcount = 0;
531 dbuf=bd->dbuf;
532 pos=bd->writePos;
533 current=bd->writeCurrent;
534
535 /* We will always have pending decoded data to write into the output
536 buffer unless this is the very first call (in which case we haven't
Eric Andersenaff114c2004-04-14 17:51:38 +0000537 Huffman-decoded a block into the intermediate buffer yet). */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000538
539 if (bd->writeCopies) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000540
Eric Andersen5fa4db22003-10-23 06:52:01 +0000541 /* Inside the loop, writeCopies means extra copies (beyond 1) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000542
Eric Andersen5fa4db22003-10-23 06:52:01 +0000543 --bd->writeCopies;
Rob Landleyf856eab2006-02-17 03:43:49 +0000544
Eric Andersen5fa4db22003-10-23 06:52:01 +0000545 /* Loop outputting bytes */
Rob Landleyf856eab2006-02-17 03:43:49 +0000546
Eric Andersen5fa4db22003-10-23 06:52:01 +0000547 for(;;) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000548
Eric Andersen5fa4db22003-10-23 06:52:01 +0000549 /* If the output buffer is full, snapshot state and return */
Rob Landleyf856eab2006-02-17 03:43:49 +0000550
Eric Andersen5fa4db22003-10-23 06:52:01 +0000551 if(gotcount >= len) {
552 bd->writePos=pos;
553 bd->writeCurrent=current;
554 bd->writeCopies++;
555 return len;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000556 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000557
Eric Andersen5fa4db22003-10-23 06:52:01 +0000558 /* Write next byte into output buffer, updating CRC */
Rob Landleyf856eab2006-02-17 03:43:49 +0000559
Eric Andersen5fa4db22003-10-23 06:52:01 +0000560 outbuf[gotcount++] = current;
561 bd->writeCRC=(((bd->writeCRC)<<8)
562 ^bd->crc32Table[((bd->writeCRC)>>24)^current]);
Rob Landleyf856eab2006-02-17 03:43:49 +0000563
Eric Andersen5fa4db22003-10-23 06:52:01 +0000564 /* Loop now if we're outputting multiple copies of this byte */
Rob Landleyf856eab2006-02-17 03:43:49 +0000565
Eric Andersen5fa4db22003-10-23 06:52:01 +0000566 if (bd->writeCopies) {
567 --bd->writeCopies;
568 continue;
569 }
570decode_next_byte:
571 if (!bd->writeCount--) break;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000572 /* Follow sequence vector to undo Burrows-Wheeler transform */
573 previous=current;
574 pos=dbuf[pos];
575 current=pos&0xff;
576 pos>>=8;
Rob Landleyf856eab2006-02-17 03:43:49 +0000577
Eric Andersen5fa4db22003-10-23 06:52:01 +0000578 /* After 3 consecutive copies of the same byte, the 4th is a repeat
579 count. We count down from 4 instead
580 * of counting up because testing for non-zero is faster */
Rob Landleyf856eab2006-02-17 03:43:49 +0000581
Eric Andersen5fa4db22003-10-23 06:52:01 +0000582 if(--bd->writeRunCountdown) {
583 if(current!=previous) bd->writeRunCountdown=4;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000584 } else {
Rob Landleyf856eab2006-02-17 03:43:49 +0000585
Eric Andersen5fa4db22003-10-23 06:52:01 +0000586 /* We have a repeated run, this byte indicates the count */
Rob Landleyf856eab2006-02-17 03:43:49 +0000587
Eric Andersen5fa4db22003-10-23 06:52:01 +0000588 bd->writeCopies=current;
589 current=previous;
590 bd->writeRunCountdown=5;
Rob Landleyf856eab2006-02-17 03:43:49 +0000591
Eric Andersen5fa4db22003-10-23 06:52:01 +0000592 /* Sometimes there are just 3 bytes (run length 0) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000593
Eric Andersen5fa4db22003-10-23 06:52:01 +0000594 if(!bd->writeCopies) goto decode_next_byte;
Rob Landleyf856eab2006-02-17 03:43:49 +0000595
Eric Andersen5fa4db22003-10-23 06:52:01 +0000596 /* Subtract the 1 copy we'd output anyway to get extras */
Rob Landleyf856eab2006-02-17 03:43:49 +0000597
Eric Andersen5fa4db22003-10-23 06:52:01 +0000598 --bd->writeCopies;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000599 }
600 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000601
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000602 /* Decompression of this block completed successfully */
Rob Landleyf856eab2006-02-17 03:43:49 +0000603
Eric Andersen5fa4db22003-10-23 06:52:01 +0000604 bd->writeCRC=~bd->writeCRC;
605 bd->totalCRC=((bd->totalCRC<<1) | (bd->totalCRC>>31)) ^ bd->writeCRC;
Rob Landleyf856eab2006-02-17 03:43:49 +0000606
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000607 /* If this block had a CRC error, force file level CRC error. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000608
Eric Andersen5fa4db22003-10-23 06:52:01 +0000609 if(bd->writeCRC!=bd->headerCRC) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000610 bd->totalCRC=bd->headerCRC+1;
611 return RETVAL_LAST_BLOCK;
612 }
Glenn L McGrath60bce492002-11-03 07:28:38 +0000613 }
Eric Andersen5fa4db22003-10-23 06:52:01 +0000614
Eric Andersenaff114c2004-04-14 17:51:38 +0000615 /* Refill the intermediate buffer by Huffman-decoding next block of input */
Eric Andersen5fa4db22003-10-23 06:52:01 +0000616 /* (previous is just a convenient unused temp variable here) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000617
Eric Andersen5fa4db22003-10-23 06:52:01 +0000618 previous=get_next_block(bd);
619 if(previous) {
620 bd->writeCount=previous;
621 return (previous!=RETVAL_LAST_BLOCK) ? previous : gotcount;
622 }
Rob Landleyc57ec372006-04-10 17:07:15 +0000623 bd->writeCRC=~0;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000624 pos=bd->writePos;
625 current=bd->writeCurrent;
626 goto decode_next_byte;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000627}
628
Eric Andersen5fa4db22003-10-23 06:52:01 +0000629/* Allocate the structure, read file header. If in_fd==-1, inbuf must contain
630 a complete bunzip file (len bytes long). If in_fd!=-1, inbuf and len are
631 ignored, and data is read from file handle into temporary buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000632
Rob Landley1ff789c2005-09-25 03:12:26 +0000633static int start_bunzip(bunzip_data **bdp, int in_fd, unsigned char *inbuf,
634 int len)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000635{
636 bunzip_data *bd;
Rob Landleyc57ec372006-04-10 17:07:15 +0000637 unsigned int i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000638 const unsigned int BZh0=(((unsigned int)'B')<<24)+(((unsigned int)'Z')<<16)
639 +(((unsigned int)'h')<<8)+(unsigned int)'0';
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000640
641 /* Figure out how much data to allocate */
Rob Landleyf856eab2006-02-17 03:43:49 +0000642
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000643 i=sizeof(bunzip_data);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000644 if(in_fd!=-1) i+=IOBUF_SIZE;
Rob Landleyf856eab2006-02-17 03:43:49 +0000645
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000646 /* Allocate bunzip_data. Most fields initialize to zero. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000647
Glenn L McGrath1c834402003-10-28 23:32:12 +0000648 bd=*bdp=xmalloc(i);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000649 memset(bd,0,sizeof(bunzip_data));
Rob Landleyf856eab2006-02-17 03:43:49 +0000650
Eric Andersen5fa4db22003-10-23 06:52:01 +0000651 /* Setup input buffer */
Rob Landleyf856eab2006-02-17 03:43:49 +0000652
Eric Andersen5fa4db22003-10-23 06:52:01 +0000653 if(-1==(bd->in_fd=in_fd)) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000654 bd->inbuf=inbuf;
655 bd->inbufCount=len;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000656 } else bd->inbuf=(unsigned char *)(bd+1);
Rob Landleyf856eab2006-02-17 03:43:49 +0000657
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000658 /* Init the CRC32 table (big endian) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000659
Rob Landleyc57ec372006-04-10 17:07:15 +0000660 bd->crc32Table = bb_crc32_filltable(1);
Rob Landleyf856eab2006-02-17 03:43:49 +0000661
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000662 /* Setup for I/O error handling via longjmp */
Rob Landleyf856eab2006-02-17 03:43:49 +0000663
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000664 i=setjmp(bd->jmpbuf);
665 if(i) return i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000666
667 /* Ensure that file starts with "BZh['1'-'9']." */
Rob Landleyf856eab2006-02-17 03:43:49 +0000668
Eric Andersen5fa4db22003-10-23 06:52:01 +0000669 i = get_bits(bd,32);
670 if (((unsigned int)(i-BZh0-1)) >= 9) return RETVAL_NOT_BZIP_DATA;
671
672 /* Fourth byte (ascii '1'-'9'), indicates block size in units of 100k of
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000673 uncompressed data. Allocate intermediate buffer for block. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000674
Eric Andersen5fa4db22003-10-23 06:52:01 +0000675 bd->dbufSize=100000*(i-BZh0);
676
Glenn L McGrath1c834402003-10-28 23:32:12 +0000677 bd->dbuf=xmalloc(bd->dbufSize * sizeof(int));
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000678 return RETVAL_OK;
679}
680
Eric Andersen5fa4db22003-10-23 06:52:01 +0000681/* Example usage: decompress src_fd to dst_fd. (Stops at end of bzip data,
682 not end of file.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000683
Rob Landleydfba7412006-03-06 20:47:33 +0000684int uncompressStream(int src_fd, int dst_fd)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000685{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000686 char *outbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000687 bunzip_data *bd;
688 int i;
689
Glenn L McGrath1c834402003-10-28 23:32:12 +0000690 outbuf=xmalloc(IOBUF_SIZE);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000691 if(!(i=start_bunzip(&bd,src_fd,0,0))) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000692 for(;;) {
693 if((i=read_bunzip(bd,outbuf,IOBUF_SIZE)) <= 0) break;
694 if(i!=write(dst_fd,outbuf,i)) {
695 i=RETVAL_UNEXPECTED_OUTPUT_EOF;
696 break;
697 }
698 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000699 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000700
Eric Andersen5fa4db22003-10-23 06:52:01 +0000701 /* Check CRC and release memory */
Rob Landleyf856eab2006-02-17 03:43:49 +0000702
Glenn L McGrath1c834402003-10-28 23:32:12 +0000703 if(i==RETVAL_LAST_BLOCK) {
704 if (bd->headerCRC!=bd->totalCRC) {
705 bb_error_msg("Data integrity error when decompressing.");
706 } else {
707 i=RETVAL_OK;
708 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000709 } else if (i==RETVAL_UNEXPECTED_OUTPUT_EOF) {
Glenn L McGrath1c834402003-10-28 23:32:12 +0000710 bb_error_msg("Compressed file ends unexpectedly");
711 } else {
712 bb_error_msg("Decompression failed");
713 }
Rob Landleye7c43b62006-03-01 16:39:45 +0000714 free(bd->dbuf);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000715 free(bd);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000716 free(outbuf);
Glenn L McGrath1c834402003-10-28 23:32:12 +0000717
Eric Andersen5fa4db22003-10-23 06:52:01 +0000718 return i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000719}
720
Eric Andersen5fa4db22003-10-23 06:52:01 +0000721#ifdef TESTING
Glenn L McGrath60bce492002-11-03 07:28:38 +0000722
Eric Andersen5fa4db22003-10-23 06:52:01 +0000723static char * const bunzip_errors[]={NULL,"Bad file checksum","Not bzip data",
724 "Unexpected input EOF","Unexpected output EOF","Data error",
725 "Out of memory","Obsolete (pre 0.9.5) bzip format not supported."};
Glenn L McGrath237ae422002-11-03 14:05:15 +0000726
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000727/* Dumb little test thing, decompress stdin to stdout */
728int main(int argc, char *argv[])
729{
Eric Andersen5fa4db22003-10-23 06:52:01 +0000730 int i=uncompressStream(0,1);
731 char c;
732
733 if(i) fprintf(stderr,"%s\n", bunzip_errors[-i]);
734 else if(read(0,&c,1)) fprintf(stderr,"Trailing garbage ignored\n");
735 return -i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000736}
737#endif