blob: 3f0b0f6f22ba481ff75297806cf723e8f23c576a [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
Glenn L McGrath1c834402003-10-28 23:32:12 +000031#include "libbb.h"
Bernhard Reutner-Fischercfb53df2006-04-02 21:50:01 +000032#include "unarchive.h"
33
Eric Andersenaff114c2004-04-14 17:51:38 +000034/* Constants for Huffman coding */
Denis Vlasenkobf0a2012006-12-26 10:42:51 +000035#define MAX_GROUPS 6
36#define GROUP_SIZE 50 /* 64 would have been more efficient */
37#define MAX_HUFCODE_BITS 20 /* Longest Huffman code allowed */
38#define MAX_SYMBOLS 258 /* 256 literals + RUNA + RUNB */
39#define SYMBOL_RUNA 0
40#define SYMBOL_RUNB 1
Glenn L McGrath60bce492002-11-03 07:28:38 +000041
Eric Andersen0d6d88a2003-10-18 01:58:35 +000042/* Status return values */
Denis Vlasenkobf0a2012006-12-26 10:42:51 +000043#define RETVAL_OK 0
44#define RETVAL_LAST_BLOCK (-1)
45#define RETVAL_NOT_BZIP_DATA (-2)
46#define RETVAL_UNEXPECTED_INPUT_EOF (-3)
47#define RETVAL_UNEXPECTED_OUTPUT_EOF (-4)
48#define RETVAL_DATA_ERROR (-5)
49#define RETVAL_OUT_OF_MEMORY (-6)
50#define RETVAL_OBSOLETE_INPUT (-7)
Glenn L McGrath60bce492002-11-03 07:28:38 +000051
Eric Andersen0d6d88a2003-10-18 01:58:35 +000052/* Other housekeeping constants */
Denis Vlasenkobf0a2012006-12-26 10:42:51 +000053#define IOBUF_SIZE 4096
Glenn L McGrath60bce492002-11-03 07:28:38 +000054
Eric Andersenaff114c2004-04-14 17:51:38 +000055/* This is what we know about each Huffman coding group */
Eric Andersen0d6d88a2003-10-18 01:58:35 +000056struct group_data {
Eric Andersen1acfb722003-10-18 01:59:46 +000057 /* We have an extra slot at the end of limit[] for a sentinal value. */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000058 int limit[MAX_HUFCODE_BITS+1], base[MAX_HUFCODE_BITS], permute[MAX_SYMBOLS];
Eric Andersen5fa4db22003-10-23 06:52:01 +000059 int minLen, maxLen;
Glenn L McGrath60bce492002-11-03 07:28:38 +000060};
61
Eric Andersen0d6d88a2003-10-18 01:58:35 +000062/* Structure holding all the housekeeping data, including IO buffers and
63 memory that persists between calls to bunzip */
Rob Landleyf856eab2006-02-17 03:43:49 +000064
Denis Vlasenkoc6758a02007-04-10 21:40:19 +000065struct bunzip_data {
Eric Andersen5fa4db22003-10-23 06:52:01 +000066 /* State for interrupting output loop */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000067 int writeCopies, writePos, writeRunCountdown, writeCount, writeCurrent;
Rob Landleyf856eab2006-02-17 03:43:49 +000068
Eric Andersen5fa4db22003-10-23 06:52:01 +000069 /* I/O tracking data (file handles, buffers, positions, etc.) */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000070 int in_fd, out_fd, inbufCount, inbufPos /*, outbufPos*/;
Eric Andersen5fa4db22003-10-23 06:52:01 +000071 unsigned char *inbuf /*,*outbuf*/;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000072 unsigned inbufBitCount, inbufBits;
Rob Landleyf856eab2006-02-17 03:43:49 +000073
Eric Andersen0d6d88a2003-10-18 01:58:35 +000074 /* The CRC values stored in the block header and calculated from the data */
Rob Landleyc57ec372006-04-10 17:07:15 +000075 uint32_t headerCRC, totalCRC, writeCRC;
Rob Landleyf856eab2006-02-17 03:43:49 +000076
Denis Vlasenkoc6758a02007-04-10 21:40:19 +000077 /* Intermediate buffer and its size (in bytes) */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000078 unsigned *dbuf, dbufSize;
Rob Landleyf856eab2006-02-17 03:43:49 +000079
Denis Vlasenkoc6758a02007-04-10 21:40:19 +000080 /* For I/O error handling */
81 jmp_buf jmpbuf;
Rob Landleyf856eab2006-02-17 03:43:49 +000082
Denis Vlasenkoc6758a02007-04-10 21:40:19 +000083 /* Big things go last (register-relative addressing can be larger for big offsets */
84 uint32_t crc32Table[256];
Eric Andersen0d6d88a2003-10-18 01:58:35 +000085 unsigned char selectors[32768]; /* nSelectors=15 bits */
Eric Andersenaff114c2004-04-14 17:51:38 +000086 struct group_data groups[MAX_GROUPS]; /* Huffman coding tables */
Denis Vlasenkoc6758a02007-04-10 21:40:19 +000087};
88/* typedef struct bunzip_data bunzip_data; -- done in .h file */
Rob Landleyf856eab2006-02-17 03:43:49 +000089
Eric Andersen0d6d88a2003-10-18 01:58:35 +000090
91/* Return the next nnn bits of input. All reads from the compressed input
92 are done through this function. All reads are big endian */
Rob Landleyf856eab2006-02-17 03:43:49 +000093
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000094static unsigned get_bits(bunzip_data *bd, char bits_wanted)
Glenn L McGrath60bce492002-11-03 07:28:38 +000095{
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +000096 unsigned bits = 0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +000097
98 /* If we need to get more data from the byte buffer, do so. (Loop getting
99 one byte at a time to enforce endianness and avoid unaligned access.) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000100
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000101 while (bd->inbufBitCount < bits_wanted) {
Rob Landleyf856eab2006-02-17 03:43:49 +0000102
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000103 /* If we need to read more data from file into byte buffer, do so */
Rob Landleyf856eab2006-02-17 03:43:49 +0000104
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000105 if (bd->inbufPos == bd->inbufCount) {
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000106 /* if "no input fd" case: in_fd == -1, read fails, we jump */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000107 bd->inbufCount = read(bd->in_fd, bd->inbuf, IOBUF_SIZE);
108 if (bd->inbufCount <= 0)
109 longjmp(bd->jmpbuf, RETVAL_UNEXPECTED_INPUT_EOF);
110 bd->inbufPos = 0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000111 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000112
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000113 /* Avoid 32-bit overflow (dump bit buffer to top of output) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000114
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000115 if (bd->inbufBitCount >= 24) {
116 bits = bd->inbufBits & ((1 << bd->inbufBitCount) - 1);
117 bits_wanted -= bd->inbufBitCount;
118 bits <<= bits_wanted;
119 bd->inbufBitCount = 0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000120 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000121
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000122 /* Grab next 8 bits of input from buffer. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000123
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000124 bd->inbufBits = (bd->inbufBits<<8) | bd->inbuf[bd->inbufPos++];
125 bd->inbufBitCount += 8;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000126 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000127
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000128 /* Calculate result */
Rob Landleyf856eab2006-02-17 03:43:49 +0000129
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000130 bd->inbufBitCount -= bits_wanted;
131 bits |= (bd->inbufBits >> bd->inbufBitCount) & ((1 << bits_wanted) - 1);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000132
133 return bits;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000134}
135
Eric Andersen5fa4db22003-10-23 06:52:01 +0000136/* Unpacks the next block and sets up for the inverse burrows-wheeler step. */
Eric Andersen1acfb722003-10-18 01:59:46 +0000137
Eric Andersen5fa4db22003-10-23 06:52:01 +0000138static int get_next_block(bunzip_data *bd)
Glenn L McGrath60bce492002-11-03 07:28:38 +0000139{
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000140 struct group_data *hufGroup;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000141 int dbufCount, nextSym, dbufSize, groupCount, *base, *limit, selector,
142 i, j, k, t, runPos, symCount, symTotal, nSelectors, byteCount[256];
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000143 unsigned char uc, symToByte[256], mtfSymbol[256], *selectors;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000144 unsigned *dbuf, origPtr;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000145
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000146 dbuf = bd->dbuf;
147 dbufSize = bd->dbufSize;
148 selectors = bd->selectors;
Rob Landley2c98c402006-02-17 05:12:03 +0000149
Eric Andersen5fa4db22003-10-23 06:52:01 +0000150 /* Reset longjmp I/O error handling */
Rob Landley2c98c402006-02-17 05:12:03 +0000151
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000152 i = setjmp(bd->jmpbuf);
Denis Vlasenkobf0a2012006-12-26 10:42:51 +0000153 if (i) return i;
Rob Landley2c98c402006-02-17 05:12:03 +0000154
Eric Andersen5fa4db22003-10-23 06:52:01 +0000155 /* Read in header signature and CRC, then validate signature.
156 (last block signature means CRC is for whole file, return now) */
Rob Landley2c98c402006-02-17 05:12:03 +0000157
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000158 i = get_bits(bd, 24);
159 j = get_bits(bd, 24);
160 bd->headerCRC = get_bits(bd, 32);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000161 if ((i == 0x177245) && (j == 0x385090)) return RETVAL_LAST_BLOCK;
162 if ((i != 0x314159) || (j != 0x265359)) return RETVAL_NOT_BZIP_DATA;
Rob Landley2c98c402006-02-17 05:12:03 +0000163
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000164 /* We can add support for blockRandomised if anybody complains. There was
165 some code for this in busybox 1.0.0-pre3, but nobody ever noticed that
166 it didn't actually work. */
Rob Landley2c98c402006-02-17 05:12:03 +0000167
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000168 if (get_bits(bd, 1)) return RETVAL_OBSOLETE_INPUT;
169 origPtr = get_bits(bd, 24);
170 if (origPtr > dbufSize) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000171
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000172 /* mapping table: if some byte values are never used (encoding things
173 like ascii text), the compression code removes the gaps to have fewer
174 symbols to deal with, and writes a sparse bitfield indicating which
175 values were present. We make a translation table to convert the symbols
176 back to the corresponding bytes. */
Rob Landley2c98c402006-02-17 05:12:03 +0000177
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000178 t = get_bits(bd, 16);
179 symTotal = 0;
180 for (i = 0; i < 16; i++) {
181 if (t & (1 << (15-i))) {
182 k = get_bits(bd, 16);
183 for (j = 0; j < 16; j++)
184 if (k & (1 << (15-j)))
185 symToByte[symTotal++] = (16*i) + j;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000186 }
187 }
Rob Landley2c98c402006-02-17 05:12:03 +0000188
Eric Andersenaff114c2004-04-14 17:51:38 +0000189 /* How many different Huffman coding groups does this block use? */
Rob Landley2c98c402006-02-17 05:12:03 +0000190
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000191 groupCount = get_bits(bd, 3);
192 if (groupCount < 2 || groupCount > MAX_GROUPS)
193 return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000194
Eric Andersenaff114c2004-04-14 17:51:38 +0000195 /* nSelectors: Every GROUP_SIZE many symbols we select a new Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000196 group. Read in the group selector list, which is stored as MTF encoded
Eric Andersen5fa4db22003-10-23 06:52:01 +0000197 bit runs. (MTF=Move To Front, as each value is used it's moved to the
198 start of the list.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000199
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000200 nSelectors = get_bits(bd, 15);
201 if (!nSelectors) return RETVAL_DATA_ERROR;
202 for (i = 0; i < groupCount; i++) mtfSymbol[i] = i;
203 for (i = 0; i < nSelectors; i++) {
Rob Landley2c98c402006-02-17 05:12:03 +0000204
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000205 /* Get next value */
Rob Landley2c98c402006-02-17 05:12:03 +0000206
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000207 for (j = 0; get_bits(bd, 1); j++)
208 if (j>=groupCount) return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000209
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000210 /* Decode MTF to get the next selector */
Rob Landley2c98c402006-02-17 05:12:03 +0000211
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000212 uc = mtfSymbol[j];
Denis Vlasenkobf0a2012006-12-26 10:42:51 +0000213 for (;j;j--) mtfSymbol[j] = mtfSymbol[j-1];
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000214 mtfSymbol[0] = selectors[i] = uc;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000215 }
Rob Landley2c98c402006-02-17 05:12:03 +0000216
Eric Andersenaff114c2004-04-14 17:51:38 +0000217 /* Read the Huffman coding tables for each group, which code for symTotal
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000218 literal symbols, plus two run symbols (RUNA, RUNB) */
Rob Landley2c98c402006-02-17 05:12:03 +0000219
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000220 symCount = symTotal + 2;
221 for (j = 0; j < groupCount; j++) {
222 unsigned char length[MAX_SYMBOLS], temp[MAX_HUFCODE_BITS+1];
223 int minLen, maxLen, pp;
Rob Landley2c98c402006-02-17 05:12:03 +0000224
Eric Andersenaff114c2004-04-14 17:51:38 +0000225 /* Read Huffman code lengths for each symbol. They're stored in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000226 a way similar to mtf; record a starting value for the first symbol,
227 and an offset from the previous value for everys symbol after that.
228 (Subtracting 1 before the loop and then adding it back at the end is
229 an optimization that makes the test inside the loop simpler: symbol
230 length 0 becomes negative, so an unsigned inequality catches it.) */
Rob Landley2c98c402006-02-17 05:12:03 +0000231
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000232 t = get_bits(bd, 5) - 1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000233 for (i = 0; i < symCount; i++) {
Denis Vlasenkobf0a2012006-12-26 10:42:51 +0000234 for (;;) {
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000235 if ((unsigned)t > (MAX_HUFCODE_BITS-1))
Eric Andersen5fa4db22003-10-23 06:52:01 +0000236 return RETVAL_DATA_ERROR;
Rob Landley2c98c402006-02-17 05:12:03 +0000237
Eric Andersen5fa4db22003-10-23 06:52:01 +0000238 /* If first bit is 0, stop. Else second bit indicates whether
239 to increment or decrement the value. Optimization: grab 2
240 bits and unget the second if the first was 0. */
Rob Landley2c98c402006-02-17 05:12:03 +0000241
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000242 k = get_bits(bd, 2);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000243 if (k < 2) {
244 bd->inbufBitCount++;
245 break;
246 }
Rob Landley2c98c402006-02-17 05:12:03 +0000247
Eric Andersen5fa4db22003-10-23 06:52:01 +0000248 /* Add one if second bit 1, else subtract 1. Avoids if/else */
Rob Landley2c98c402006-02-17 05:12:03 +0000249
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000250 t += (((k+1) & 2) - 1);
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000251 }
Rob Landley2c98c402006-02-17 05:12:03 +0000252
Eric Andersen5fa4db22003-10-23 06:52:01 +0000253 /* Correct for the initial -1, to get the final symbol length */
Rob Landley2c98c402006-02-17 05:12:03 +0000254
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000255 length[i] = t + 1;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000256 }
Rob Landley2c98c402006-02-17 05:12:03 +0000257
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000258 /* Find largest and smallest lengths in this group */
Rob Landley2c98c402006-02-17 05:12:03 +0000259
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000260 minLen = maxLen = length[0];
Denis Vlasenkobf0a2012006-12-26 10:42:51 +0000261 for (i = 1; i < symCount; i++) {
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000262 if (length[i] > maxLen) maxLen = length[i];
263 else if (length[i] < minLen) minLen = length[i];
Glenn L McGrath60bce492002-11-03 07:28:38 +0000264 }
Rob Landley2c98c402006-02-17 05:12:03 +0000265
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000266 /* Calculate permute[], base[], and limit[] tables from length[].
267 *
Eric Andersenaff114c2004-04-14 17:51:38 +0000268 * permute[] is the lookup table for converting Huffman coded symbols
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000269 * into decoded symbols. base[] is the amount to subtract from the
Eric Andersenaff114c2004-04-14 17:51:38 +0000270 * value of a Huffman symbol of a given length when using permute[].
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000271 *
272 * limit[] indicates the largest numerical value a symbol with a given
Eric Andersenaff114c2004-04-14 17:51:38 +0000273 * number of bits can have. This is how the Huffman codes can vary in
Eric Andersen5fa4db22003-10-23 06:52:01 +0000274 * length: each code with a value>limit[length] needs another bit.
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000275 */
Rob Landley2c98c402006-02-17 05:12:03 +0000276
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000277 hufGroup = bd->groups + j;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000278 hufGroup->minLen = minLen;
279 hufGroup->maxLen = maxLen;
Rob Landley2c98c402006-02-17 05:12:03 +0000280
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000281 /* Note that minLen can't be smaller than 1, so we adjust the base
282 and limit array pointers so we're not always wasting the first
283 entry. We do this again when using them (during symbol decoding).*/
Rob Landley2c98c402006-02-17 05:12:03 +0000284
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000285 base = hufGroup->base - 1;
286 limit = hufGroup->limit - 1;
Rob Landley2c98c402006-02-17 05:12:03 +0000287
Eric Andersen5fa4db22003-10-23 06:52:01 +0000288 /* Calculate permute[]. Concurently, initialize temp[] and limit[]. */
Rob Landley2c98c402006-02-17 05:12:03 +0000289
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000290 pp = 0;
291 for (i = minLen; i <= maxLen; i++) {
292 temp[i] = limit[i] = 0;
293 for (t = 0; t < symCount; t++)
294 if (length[t] == i)
295 hufGroup->permute[pp++] = t;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000296 }
Rob Landley2c98c402006-02-17 05:12:03 +0000297
Eric Andersen5fa4db22003-10-23 06:52:01 +0000298 /* Count symbols coded for at each bit length */
Rob Landley2c98c402006-02-17 05:12:03 +0000299
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000300 for (i = 0; i < symCount; i++) temp[length[i]]++;
Rob Landley2c98c402006-02-17 05:12:03 +0000301
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000302 /* Calculate limit[] (the largest symbol-coding value at each bit
303 * length, which is (previous limit<<1)+symbols at this level), and
304 * base[] (number of symbols to ignore at each bit length, which is
Eric Andersen5fa4db22003-10-23 06:52:01 +0000305 * limit minus the cumulative count of symbols coded for already). */
Rob Landley2c98c402006-02-17 05:12:03 +0000306
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000307 pp = t = 0;
308 for (i = minLen; i < maxLen; i++) {
309 pp += temp[i];
Rob Landley2c98c402006-02-17 05:12:03 +0000310
Eric Andersen5fa4db22003-10-23 06:52:01 +0000311 /* We read the largest possible symbol size and then unget bits
312 after determining how many we need, and those extra bits could
313 be set to anything. (They're noise from future symbols.) At
314 each level we're really only interested in the first few bits,
315 so here we set all the trailing to-be-ignored bits to 1 so they
316 don't affect the value>limit[length] comparison. */
Rob Landley2c98c402006-02-17 05:12:03 +0000317
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000318 limit[i] = (pp << (maxLen - i)) - 1;
319 pp <<= 1;
320 t += temp[i];
321 base[i+1] = pp - t;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000322 }
Eric Andersen1acfb722003-10-18 01:59:46 +0000323 limit[maxLen+1] = INT_MAX; /* Sentinal value for reading next sym. */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000324 limit[maxLen] = pp + temp[maxLen] - 1;
325 base[minLen] = 0;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000326 }
Rob Landley2c98c402006-02-17 05:12:03 +0000327
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000328 /* We've finished reading and digesting the block header. Now read this
Eric Andersenaff114c2004-04-14 17:51:38 +0000329 block's Huffman coded symbols from the file and undo the Huffman coding
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000330 and run length encoding, saving the result into dbuf[dbufCount++]=uc */
Glenn L McGrath60bce492002-11-03 07:28:38 +0000331
Eric Andersen5fa4db22003-10-23 06:52:01 +0000332 /* Initialize symbol occurrence counters and symbol Move To Front table */
Rob Landley2c98c402006-02-17 05:12:03 +0000333
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000334 for (i = 0; i < 256; i++) {
Eric Andersen5fa4db22003-10-23 06:52:01 +0000335 byteCount[i] = 0;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000336 mtfSymbol[i] = (unsigned char)i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000337 }
Rob Landley2c98c402006-02-17 05:12:03 +0000338
Eric Andersen5fa4db22003-10-23 06:52:01 +0000339 /* Loop through compressed symbols. */
Rob Landley2c98c402006-02-17 05:12:03 +0000340
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000341 runPos = dbufCount = selector = 0;
Denis Vlasenkobf0a2012006-12-26 10:42:51 +0000342 for (;;) {
Rob Landley2c98c402006-02-17 05:12:03 +0000343
Rob Landleya8b98d62004-11-16 12:07:04 +0000344 /* fetch next Huffman coding group from list. */
Rob Landley2c98c402006-02-17 05:12:03 +0000345
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000346 symCount = GROUP_SIZE - 1;
347 if (selector >= nSelectors) return RETVAL_DATA_ERROR;
348 hufGroup = bd->groups + selectors[selector++];
349 base = hufGroup->base - 1;
350 limit = hufGroup->limit - 1;
351 continue_this_group:
Rob Landley2c98c402006-02-17 05:12:03 +0000352
Eric Andersenaff114c2004-04-14 17:51:38 +0000353 /* Read next Huffman-coded symbol. */
Rob Landley2c98c402006-02-17 05:12:03 +0000354
Eric Andersen5fa4db22003-10-23 06:52:01 +0000355 /* Note: It is far cheaper to read maxLen bits and back up than it is
356 to read minLen bits and then an additional bit at a time, testing
357 as we go. Because there is a trailing last block (with file CRC),
358 there is no danger of the overread causing an unexpected EOF for a
359 valid compressed file. As a further optimization, we do the read
360 inline (falling back to a call to get_bits if the buffer runs
361 dry). The following (up to got_huff_bits:) is equivalent to
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000362 j = get_bits(bd, hufGroup->maxLen);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000363 */
Rob Landley2c98c402006-02-17 05:12:03 +0000364
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000365 while (bd->inbufBitCount < hufGroup->maxLen) {
366 if (bd->inbufPos == bd->inbufCount) {
367 j = get_bits(bd, hufGroup->maxLen);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000368 goto got_huff_bits;
369 }
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000370 bd->inbufBits = (bd->inbufBits << 8) | bd->inbuf[bd->inbufPos++];
371 bd->inbufBitCount += 8;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000372 };
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000373 bd->inbufBitCount -= hufGroup->maxLen;
374 j = (bd->inbufBits >> bd->inbufBitCount) & ((1 << hufGroup->maxLen) - 1);
Rob Landley2c98c402006-02-17 05:12:03 +0000375
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000376 got_huff_bits:
Rob Landley2c98c402006-02-17 05:12:03 +0000377
Eric Andersen5fa4db22003-10-23 06:52:01 +0000378 /* Figure how how many bits are in next symbol and unget extras */
Rob Landley2c98c402006-02-17 05:12:03 +0000379
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000380 i = hufGroup->minLen;
381 while (j > limit[i]) ++i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000382 bd->inbufBitCount += (hufGroup->maxLen - i);
Rob Landley2c98c402006-02-17 05:12:03 +0000383
Eric Andersen5fa4db22003-10-23 06:52:01 +0000384 /* Huffman decode value to get nextSym (with bounds checking) */
Rob Landley2c98c402006-02-17 05:12:03 +0000385
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000386 if (i > hufGroup->maxLen)
387 return RETVAL_DATA_ERROR;
388 j = (j >> (hufGroup->maxLen - i)) - base[i];
389 if ((unsigned)j >= MAX_SYMBOLS)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000390 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000402 if (!runPos) {
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000403 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 */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000416 if (runPos < dbufSize) 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000425 if (runPos) {
426 runPos = 0;
427 if (dbufCount + t >= dbufSize) return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000428
429 uc = symToByte[mtfSymbol[0]];
430 byteCount[uc] += t;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000431 while (t--) dbuf[dbufCount++] = uc;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000432 }
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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000446 if (dbufCount >= dbufSize) return RETVAL_DATA_ERROR;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000447 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;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000459 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]++;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000464 dbuf[dbufCount++] = (unsigned)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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000469 end_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
Denis Vlasenko246b5c32007-04-10 17:18:12 +0000474 runs) for this block from the input stream, and decoded them into the
Eric Andersen5fa4db22003-10-23 06:52:01 +0000475 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000482 j = 0;
483 for (i = 0; i < 256; i++) {
484 k = j + byteCount[i];
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000485 byteCount[i] = j;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000486 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000491 for (i = 0; i < dbufCount; i++) {
492 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000501 if (dbufCount) {
502 if (origPtr >= dbufCount) return RETVAL_DATA_ERROR;
503 bd->writePos = dbuf[origPtr];
504 bd->writeCurrent = (unsigned char)(bd->writePos & 0xff);
505 bd->writePos >>= 8;
506 bd->writeRunCountdown = 5;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000507 }
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +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
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000520int read_bunzip(bunzip_data *bd, char *outbuf, int len)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000521{
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000522 const unsigned *dbuf;
523 int pos, current, previous, gotcount;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000524
525 /* If last read was short due to end of file, return last block now */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000526 if (bd->writeCount < 0) return bd->writeCount;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000527
528 gotcount = 0;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000529 dbuf = bd->dbuf;
530 pos = bd->writePos;
531 current = bd->writeCurrent;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000532
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
Denis Vlasenkobf0a2012006-12-26 10:42:51 +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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000549 if (gotcount >= len) {
550 bd->writePos =pos;
551 bd->writeCurrent = current;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000552 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;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000559 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 }
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000568 decode_next_byte:
Eric Andersen5fa4db22003-10-23 06:52:01 +0000569 if (!bd->writeCount--) break;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000570 /* Follow sequence vector to undo Burrows-Wheeler transform */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000571 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000580 if (--bd->writeRunCountdown) {
581 if (current != previous)
582 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000608 if (bd->writeCRC != bd->headerCRC) {
609 bd->totalCRC = bd->headerCRC+1;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000610 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
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000617 previous = get_next_block(bd);
618 if (previous) {
619 bd->writeCount = previous;
620 return (previous != RETVAL_LAST_BLOCK) ? previous : gotcount;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000621 }
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000622 bd->writeCRC = ~0;
623 pos = bd->writePos;
624 current = bd->writeCurrent;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000625 goto decode_next_byte;
Glenn L McGrath60bce492002-11-03 07:28:38 +0000626}
627
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000628
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
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000633/* Because bunzip2 is used for help text unpacking, and because bb_show_usage()
634 should work for NOFORK applets too, we must be extremely careful to not leak
635 any allocations! */
636
637int start_bunzip(bunzip_data **bdp, int in_fd, const unsigned char *inbuf,
Rob Landley1ff789c2005-09-25 03:12:26 +0000638 int len)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000639{
640 bunzip_data *bd;
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000641 unsigned i;
642 enum {
643 BZh0 = ('B' << 24) + ('Z' << 16) + ('h' << 8) + '0'
644 };
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000645
646 /* Figure out how much data to allocate */
Rob Landleyf856eab2006-02-17 03:43:49 +0000647
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000648 i = sizeof(bunzip_data);
649 if (in_fd != -1) i += IOBUF_SIZE;
Rob Landleyf856eab2006-02-17 03:43:49 +0000650
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000651 /* Allocate bunzip_data. Most fields initialize to zero. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000652
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000653 bd = *bdp = xzalloc(i);
Rob Landleyf856eab2006-02-17 03:43:49 +0000654
Eric Andersen5fa4db22003-10-23 06:52:01 +0000655 /* Setup input buffer */
Rob Landleyf856eab2006-02-17 03:43:49 +0000656
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000657 bd->in_fd = in_fd;
658 if (-1 == in_fd) {
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000659 /* in this case, bd->inbuf is read-only */
660 bd->inbuf = (void*)inbuf; /* cast away const-ness */
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000661 bd->inbufCount = len;
662 } else
663 bd->inbuf = (unsigned char *)(bd + 1);
Rob Landleyf856eab2006-02-17 03:43:49 +0000664
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000665 /* Init the CRC32 table (big endian) */
Rob Landleyf856eab2006-02-17 03:43:49 +0000666
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000667 crc32_filltable(bd->crc32Table, 1);
Rob Landleyf856eab2006-02-17 03:43:49 +0000668
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000669 /* Setup for I/O error handling via longjmp */
Rob Landleyf856eab2006-02-17 03:43:49 +0000670
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000671 i = setjmp(bd->jmpbuf);
672 if (i) return i;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000673
674 /* Ensure that file starts with "BZh['1'-'9']." */
Rob Landleyf856eab2006-02-17 03:43:49 +0000675
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000676 i = get_bits(bd, 32);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000677 if ((unsigned)(i - BZh0 - 1) >= 9) return RETVAL_NOT_BZIP_DATA;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000678
679 /* Fourth byte (ascii '1'-'9'), indicates block size in units of 100k of
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000680 uncompressed data. Allocate intermediate buffer for block. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000681
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000682 bd->dbufSize = 100000 * (i - BZh0);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000683
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000684 /* Cannot use xmalloc - may leak bd in NOFORK case! */
685 bd->dbuf = malloc_or_warn(bd->dbufSize * sizeof(int));
686 if (!bd->dbuf) {
687 free(bd);
688 xfunc_die();
689 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000690 return RETVAL_OK;
691}
692
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000693void dealloc_bunzip(bunzip_data *bd)
694{
695 free(bd->dbuf);
696 free(bd);
697}
698
699
700/* Decompress src_fd to dst_fd. Stops at end of bzip data, not end of file. */
Rob Landleyf856eab2006-02-17 03:43:49 +0000701
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000702USE_DESKTOP(long long) int
703uncompressStream(int src_fd, int dst_fd)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000704{
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000705 USE_DESKTOP(long long total_written = 0;)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000706 char *outbuf;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000707 bunzip_data *bd;
708 int i;
709
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000710 outbuf = xmalloc(IOBUF_SIZE);
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000711 i = start_bunzip(&bd, src_fd, NULL, 0);
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000712 if (!i) {
Denis Vlasenkobf0a2012006-12-26 10:42:51 +0000713 for (;;) {
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000714 i = read_bunzip(bd, outbuf, IOBUF_SIZE);
715 if (i <= 0) break;
716 if (i != safe_write(dst_fd, outbuf, i)) {
717 i = RETVAL_UNEXPECTED_OUTPUT_EOF;
Eric Andersen5fa4db22003-10-23 06:52:01 +0000718 break;
719 }
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000720 USE_DESKTOP(total_written += i;)
Eric Andersen5fa4db22003-10-23 06:52:01 +0000721 }
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000722 }
Rob Landleyf856eab2006-02-17 03:43:49 +0000723
Eric Andersen5fa4db22003-10-23 06:52:01 +0000724 /* Check CRC and release memory */
Rob Landleyf856eab2006-02-17 03:43:49 +0000725
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000726 if (i == RETVAL_LAST_BLOCK) {
727 if (bd->headerCRC != bd->totalCRC) {
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000728 bb_error_msg("data integrity error when decompressing");
Glenn L McGrath1c834402003-10-28 23:32:12 +0000729 } else {
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000730 i = RETVAL_OK;
Glenn L McGrath1c834402003-10-28 23:32:12 +0000731 }
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000732 } else if (i == RETVAL_UNEXPECTED_OUTPUT_EOF) {
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000733 bb_error_msg("compressed file ends unexpectedly");
Glenn L McGrath1c834402003-10-28 23:32:12 +0000734 } else {
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000735 bb_error_msg("decompression failed");
Glenn L McGrath1c834402003-10-28 23:32:12 +0000736 }
Denis Vlasenkoc6758a02007-04-10 21:40:19 +0000737 dealloc_bunzip(bd);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000738 free(outbuf);
Glenn L McGrath1c834402003-10-28 23:32:12 +0000739
Denis Vlasenko97a8dd32006-10-01 15:55:11 +0000740 return i ? i : USE_DESKTOP(total_written) + 0;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000741}
742
Eric Andersen5fa4db22003-10-23 06:52:01 +0000743#ifdef TESTING
Glenn L McGrath60bce492002-11-03 07:28:38 +0000744
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000745static char *const bunzip_errors[] = {
746 NULL, "Bad file checksum", "Not bzip data",
747 "Unexpected input EOF", "Unexpected output EOF", "Data error",
748 "Out of memory", "Obsolete (pre 0.9.5) bzip format not supported"
749};
Glenn L McGrath237ae422002-11-03 14:05:15 +0000750
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000751/* Dumb little test thing, decompress stdin to stdout */
Bernhard Reutner-Fischerfebe3c42007-04-04 20:52:03 +0000752int main(int argc, char **argv)
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000753{
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000754 int i = uncompressStream(0, 1);
Eric Andersen5fa4db22003-10-23 06:52:01 +0000755 char c;
756
Denis Vlasenkob38cf3f2007-04-10 17:16:33 +0000757 if (i < 0)
758 fprintf(stderr,"%s\n", bunzip_errors[-i]);
759 else if (read(0, &c, 1))
760 fprintf(stderr,"Trailing garbage ignored\n");
Eric Andersen5fa4db22003-10-23 06:52:01 +0000761 return -i;
Eric Andersen0d6d88a2003-10-18 01:58:35 +0000762}
763#endif