4 * LZX decompression routines, originally based on code taken from cabextract
5 * v0.5, which was, itself, a modified version of the lzx decompression code
10 * Copyright (C) 2012, 2013 Eric Biggers
12 * This file is part of wimlib, a library for working with WIM files.
14 * wimlib is free software; you can redistribute it and/or modify it under the
15 * terms of the GNU General Public License as published by the Free
16 * Software Foundation; either version 3 of the License, or (at your option)
19 * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
20 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
21 * A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with wimlib; if not, see http://www.gnu.org/licenses/.
29 * LZX is a LZ77 and Huffman-code based compression format that has many
30 * similarities to the DEFLATE format used in zlib. The compression ratio is as
31 * good or better than DEFLATE. However, in WIM files only up to 32768 bytes of
32 * data can ever compressed be in the same LZX block, so a .tar.gz file could
33 * potentially be smaller than a WIM file that uses LZX compression because it
34 * can use a larger LZ77 window size.
36 * Some notes on the LZX compression format as used in Windows Imaging (WIM)
39 * A compressed WIM resource consists of a table of chunk offsets followed by
40 * the compressed chunks themselves. All compressed chunks except possibly the
41 * last decompress to WIM_CHUNK_SIZE (= 32768) bytes. This is quite similar to
42 * the cabinet (.cab) file format, but they are not the same. According to the
43 * cabinet format documentation, the LZX block size is independent from the
44 * CFDATA blocks, and a LZX block may span several CFDATA blocks. However, in
45 * WIMs, LZX blocks do not appear to ever span multiple WIM chunks. Note that
46 * this means any WIM chunk may be decompressed or compressed independently from
47 * any other chunk, which is convenient.
49 * A LZX compressed WIM chunk contains one or more LZX blocks of the aligned,
50 * verbatim, or uncompressed block types. For aligned and verbatim blocks, the
51 * size of the block in uncompressed bytes is specified by a bit following the 3
52 * bits that specify the block type, possibly followed by an additional 16 bits.
53 * '1' means to use the default block size (equal to 32768, the size of a WIM
54 * chunk--- and this seems to only be valid for the first LZX block in a WIM
55 * chunk), while '0' means that the block size is provided by the next 16 bits.
57 * The cabinet format, as documented, allows for the possibility that a
58 * compressed CFDATA chunk is up to 6144 bytes larger than the data it
59 * uncompresses to. However, in the WIM format it appears that every chunk that
60 * would be 32768 bytes or more when compressed is actually stored fully
63 * The 'e8' preprocessing step that changes x86 call instructions to use
64 * absolute offsets instead of relative offsets relies on a filesize parameter.
65 * There is no such parameter for this in the WIM files (even though the size of
66 * the file resource could be used for this purpose), and instead a magic file
67 * size of 12000000 is used. The 'e8' preprocessing is always done, and there
68 * is no bit to indicate whether it is done or not.
72 * Some more notes about errors in Microsoft's LZX documentation:
74 * Microsoft's LZX document and their implementation of the com.ms.util.cab Java
75 * package do not concur.
77 * In the LZX document, there is a table showing the correlation between window
78 * size and the number of position slots. It states that the 1MB window = 40
79 * slots and the 2MB window = 42 slots. In the implementation, 1MB = 42 slots,
80 * 2MB = 50 slots. The actual calculation is 'find the first slot whose position
81 * base is equal to or more than the required window size'. This would explain
82 * why other tables in the document refer to 50 slots rather than 42.
84 * The constant NUM_PRIMARY_LENS used in the decompression pseudocode is not
85 * defined in the specification.
87 * The LZX document states that aligned offset blocks have their aligned offset
88 * huffman tree AFTER the main and length trees. The implementation suggests
89 * that the aligned offset tree is BEFORE the main and length trees.
91 * The LZX document decoding algorithm states that, in an aligned offset block,
92 * if an extra_bits value is 1, 2 or 3, then that number of bits should be read
93 * and the result added to the match offset. This is correct for 1 and 2, but
94 * not 3, where just a huffman symbol (using the aligned tree) should be read.
96 * Regarding the E8 preprocessing, the LZX document states 'No translation may
97 * be performed on the last 6 bytes of the input block'. This is correct.
98 * However, the pseudocode provided checks for the *E8 leader* up to the last 6
99 * bytes. If the leader appears between -10 and -7 bytes from the end, this
100 * would cause the next four bytes to be modified, at least one of which would
101 * be in the last 6 bytes, which is not allowed according to the spec.
103 * The specification states that the huffman trees must always contain at least
104 * one element. However, many CAB files contain blocks where the length tree is
105 * completely empty (because there are no matches), and this is expected to
111 #include "decompress.h"
114 /* Huffman decoding tables and maps from symbols to code lengths. */
117 u16 maintree_decode_table[(1 << LZX_MAINTREE_TABLEBITS) +
118 (LZX_MAINTREE_NUM_SYMBOLS * 2)];
119 u8 maintree_lens[LZX_MAINTREE_NUM_SYMBOLS];
122 u16 lentree_decode_table[(1 << LZX_LENTREE_TABLEBITS) +
123 (LZX_LENTREE_NUM_SYMBOLS * 2)];
124 u8 lentree_lens[LZX_LENTREE_NUM_SYMBOLS];
127 u16 alignedtree_decode_table[(1 << LZX_ALIGNEDTREE_TABLEBITS) +
128 (LZX_ALIGNEDTREE_NUM_SYMBOLS * 2)];
129 u8 alignedtree_lens[LZX_ALIGNEDTREE_NUM_SYMBOLS];
134 * Reads a Huffman-encoded symbol using the pre-tree.
137 read_huffsym_using_pretree(struct input_bitstream *istream,
138 const u16 pretree_decode_table[],
139 const u8 pretree_lens[], unsigned *n)
141 return read_huffsym(istream, pretree_decode_table, pretree_lens,
142 LZX_PRETREE_NUM_SYMBOLS, LZX_PRETREE_TABLEBITS, n,
143 LZX_MAX_CODEWORD_LEN);
146 /* Reads a Huffman-encoded symbol using the main tree. */
148 read_huffsym_using_maintree(struct input_bitstream *istream,
149 const struct lzx_tables *tables,
152 return read_huffsym(istream, tables->maintree_decode_table,
153 tables->maintree_lens, LZX_MAINTREE_NUM_SYMBOLS,
154 LZX_MAINTREE_TABLEBITS, n, LZX_MAX_CODEWORD_LEN);
157 /* Reads a Huffman-encoded symbol using the length tree. */
159 read_huffsym_using_lentree(struct input_bitstream *istream,
160 const struct lzx_tables *tables,
163 return read_huffsym(istream, tables->lentree_decode_table,
164 tables->lentree_lens, LZX_LENTREE_NUM_SYMBOLS,
165 LZX_LENTREE_TABLEBITS, n, LZX_MAX_CODEWORD_LEN);
168 /* Reads a Huffman-encoded symbol using the aligned offset tree. */
170 read_huffsym_using_alignedtree(struct input_bitstream *istream,
171 const struct lzx_tables *tables,
174 return read_huffsym(istream, tables->alignedtree_decode_table,
175 tables->alignedtree_lens,
176 LZX_ALIGNEDTREE_NUM_SYMBOLS,
177 LZX_ALIGNEDTREE_TABLEBITS, n, 8);
181 * Reads the pretree from the input, then uses the pretree to decode @num_lens
182 * code length values from the input.
184 * @istream: The bit stream for the input. It is positioned on the beginning
185 * of the pretree for the code length values.
186 * @lens: An array that contains the length values from the previous time
187 * the code lengths for this Huffman tree were read, or all
188 * 0's if this is the first time.
189 * @num_lens: Number of length values to decode and return.
193 lzx_read_code_lens(struct input_bitstream *istream, u8 lens[],
196 /* Declare the decoding table and length table for the pretree. */
197 u16 pretree_decode_table[(1 << LZX_PRETREE_TABLEBITS) +
198 (LZX_PRETREE_NUM_SYMBOLS * 2)];
199 u8 pretree_lens[LZX_PRETREE_NUM_SYMBOLS];
204 /* Read the code lengths of the pretree codes. There are 20 lengths of
206 for (i = 0; i < LZX_PRETREE_NUM_SYMBOLS; i++) {
207 ret = bitstream_read_bits(istream, LZX_PRETREE_ELEMENT_SIZE,
211 pretree_lens[i] = len;
214 /* Make the decoding table for the pretree. */
215 ret = make_huffman_decode_table(pretree_decode_table,
216 LZX_PRETREE_NUM_SYMBOLS,
217 LZX_PRETREE_TABLEBITS,
219 LZX_MAX_CODEWORD_LEN);
223 /* Pointer past the last length value that needs to be filled in. */
224 u8 *lens_end = lens + num_lens;
228 /* Decode a symbol from the input. If the symbol is between 0
229 * and 16, it is the difference from the old length. If it is
230 * between 17 and 19, it is a special code that indicates that
231 * some number of the next lengths are all 0, or some number of
232 * the next lengths are all equal to the next symbol in the
240 ret = read_huffsym_using_pretree(istream, pretree_decode_table,
241 pretree_lens, &tree_code);
245 case 17: /* Run of 0's */
246 ret = bitstream_read_bits(istream, 4, &num_zeroes);
250 while (num_zeroes--) {
252 if (++lens == lens_end)
256 case 18: /* Longer run of 0's */
257 ret = bitstream_read_bits(istream, 5, &num_zeroes);
261 while (num_zeroes--) {
263 if (++lens == lens_end)
267 case 19: /* Run of identical lengths */
268 ret = bitstream_read_bits(istream, 1, &num_same);
272 ret = read_huffsym_using_pretree(istream,
273 pretree_decode_table,
278 value = (char)*lens - (char)code;
283 if (++lens == lens_end)
287 default: /* Difference from old length. */
288 value = (char)*lens - (char)tree_code;
292 if (++lens == lens_end)
300 * Reads the header for an LZX-compressed block.
302 * @istream: The input bitstream.
303 * @block_size_ret: A pointer to an int into which the size of the block,
304 * in bytes, will be returned.
305 * @block_type_ret: A pointer to an int into which the type of the block
306 * (LZX_BLOCKTYPE_*) will be returned.
307 * @tables: A pointer to a lzx_tables structure in which the
308 * main tree, the length tree, and possibly the
309 * aligned offset tree will be constructed.
310 * @queue: A pointer to the least-recently-used queue into which
311 * R0, R1, and R2 will be written (only for uncompressed
312 * blocks, which contain this information in the header)
315 lzx_read_block_header(struct input_bitstream *istream,
316 unsigned *block_size_ret,
317 unsigned *block_type_ret,
318 struct lzx_tables *tables,
319 struct lru_queue *queue)
328 ret = bitstream_ensure_bits(istream, 4);
330 ERROR("LZX input stream overrun");
334 /* The first three bits tell us what kind of block it is, and are one
335 * of the LZX_BLOCKTYPE_* values. */
336 block_type = bitstream_read_bits_nocheck(istream, 3);
338 /* The next bit indicates whether the block size is the default (32768),
339 * indicated by a 1 bit, or whether the block size is given by the next
340 * 16 bits, indicated by a 0 bit. */
341 s = bitstream_read_bits_nocheck(istream, 1);
346 ret = bitstream_read_bits(istream, 16, &block_size);
349 block_size = le16_to_cpu(block_size);
352 switch (block_type) {
353 case LZX_BLOCKTYPE_ALIGNED:
354 /* Read the path lengths for the elements of the aligned tree,
357 for (i = 0; i < LZX_ALIGNEDTREE_NUM_SYMBOLS; i++) {
358 ret = bitstream_read_bits(istream,
359 LZX_ALIGNEDTREE_ELEMENT_SIZE,
363 tables->alignedtree_lens[i] = len;
366 LZX_DEBUG("Building the aligned tree.");
367 ret = make_huffman_decode_table(tables->alignedtree_decode_table,
368 LZX_ALIGNEDTREE_NUM_SYMBOLS,
369 LZX_ALIGNEDTREE_TABLEBITS,
370 tables->alignedtree_lens,
373 ERROR("lzx_decompress(): Failed to make the decode "
374 "table for the aligned offset tree");
378 /* Fall though, since the rest of the header for aligned offset
379 * blocks is the same as that for verbatim blocks */
381 case LZX_BLOCKTYPE_VERBATIM:
382 if (block_type == LZX_BLOCKTYPE_VERBATIM)
383 LZX_DEBUG("Found verbatim block.");
385 LZX_DEBUG("Reading path lengths for main tree.");
386 /* Read the path lengths for the first 256 elements of the main
388 ret = lzx_read_code_lens(istream, tables->maintree_lens,
391 ERROR("lzx_decompress(): Failed to read the code "
392 "lengths for the first 256 elements of the "
397 /* Read the path lengths for the remaining elements of the main
399 LZX_DEBUG("Reading path lengths for remaining elements of "
400 "main tree (%d elements).",
401 LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
402 ret = lzx_read_code_lens(istream,
403 tables->maintree_lens + LZX_NUM_CHARS,
404 LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
406 ERROR("lzx_decompress(): Failed to read the path "
407 "lengths for the remaining elements of the main "
412 LZX_DEBUG("Building the Huffman decoding "
413 "table for the main tree.");
415 ret = make_huffman_decode_table(tables->maintree_decode_table,
416 LZX_MAINTREE_NUM_SYMBOLS,
417 LZX_MAINTREE_TABLEBITS,
418 tables->maintree_lens,
419 LZX_MAX_CODEWORD_LEN);
421 ERROR("lzx_decompress(): Failed to make the decode "
422 "table for the main tree");
426 LZX_DEBUG("Reading path lengths for the length tree.");
427 ret = lzx_read_code_lens(istream, tables->lentree_lens,
428 LZX_LENTREE_NUM_SYMBOLS);
430 ERROR("lzx_decompress(): Failed to read the path "
431 "lengths for the length tree");
435 LZX_DEBUG("Building the length tree.");
436 ret = make_huffman_decode_table(tables->lentree_decode_table,
437 LZX_LENTREE_NUM_SYMBOLS,
438 LZX_LENTREE_TABLEBITS,
439 tables->lentree_lens,
440 LZX_MAX_CODEWORD_LEN);
442 ERROR("lzx_decompress(): Failed to build the length "
446 /* The bitstream of compressed literals and matches for this
447 * block directly follows and will be read in
448 * lzx_decompress_block(). */
450 case LZX_BLOCKTYPE_UNCOMPRESSED:
451 LZX_DEBUG("Found uncompressed block.");
452 /* Before reading the three LRU match offsets from the
453 * uncompressed block header, the stream needs to be aligned on
454 * a 16-bit boundary. But, unexpectedly, if the stream is
455 * *already* aligned, the correct thing to do is to throw away
456 * the next 16 bits. */
457 if (istream->bitsleft == 0) {
458 if (istream->data_bytes_left < 14)
461 istream->data_bytes_left -= 2;
463 if (istream->data_bytes_left < 12)
465 istream->bitsleft = 0;
468 queue->R0 = le32_to_cpu(*(u32*)(istream->data + 0));
469 queue->R1 = le32_to_cpu(*(u32*)(istream->data + 4));
470 queue->R2 = le32_to_cpu(*(u32*)(istream->data + 8));
472 istream->data_bytes_left -= 12;
473 /* The uncompressed data of this block directly follows and will
474 * be read in lzx_decompress(). */
477 ERROR("lzx_decompress(): Found invalid block");
480 *block_type_ret = block_type;
481 *block_size_ret = block_size;
486 * Decodes a compressed match from a block of LZX-compressed data. A match
487 * refers to some match_offset to a point earlier in the window as well as some
488 * match_len, for which the data is to be copied to the current position in the
491 * @main_element: The start of the match data, as decoded using the main
494 * @block_type: The type of the block (LZX_BLOCKTYPE_ALIGNED or
495 * LZX_BLOCKTYPE_VERBATIM)
497 * @bytes_remaining: The amount of uncompressed data remaining to be
498 * uncompressed in this block. It is an error if the match
499 * is longer than this number.
501 * @window: A pointer to the window into which the uncompressed
502 * data is being written.
504 * @window_pos: The current byte offset in the window.
506 * @tables: The Huffman decoding tables for this LZX block (main
507 * code, length code, and for LZX_BLOCKTYPE_ALIGNED blocks,
508 * also the aligned offset code).
510 * @queue: The least-recently used queue for match offsets.
512 * @istream: The input bitstream.
514 * Returns the length of the match, or a negative number on error. The possible
516 * - Match would exceed the amount of data remaining to be uncompressed.
517 * - Match refers to data before the window.
518 * - The input bitstream ended unexpectedly.
521 lzx_decode_match(unsigned main_element, int block_type,
522 unsigned bytes_remaining, u8 *window,
524 const struct lzx_tables *tables,
525 struct lru_queue *queue,
526 struct input_bitstream *istream)
528 unsigned length_header;
529 unsigned position_slot;
531 unsigned match_offset;
532 unsigned additional_len;
533 unsigned num_extra_bits;
534 unsigned verbatim_bits;
535 unsigned aligned_bits;
541 /* The main element is offset by 256 because values under 256 indicate a
543 main_element -= LZX_NUM_CHARS;
545 /* The length header consists of the lower 3 bits of the main element.
546 * The position slot is the rest of it. */
547 length_header = main_element & LZX_NUM_PRIMARY_LENS;
548 position_slot = main_element >> 3;
550 /* If the length_header is less than LZX_NUM_PRIMARY_LENS (= 7), it
551 * gives the match length as the offset from LZX_MIN_MATCH. Otherwise,
552 * the length is given by an additional symbol encoded using the length
553 * tree, offset by 9 (LZX_MIN_MATCH + LZX_NUM_PRIMARY_LENS) */
554 match_len = LZX_MIN_MATCH + length_header;
555 if (length_header == LZX_NUM_PRIMARY_LENS) {
556 ret = read_huffsym_using_lentree(istream, tables,
560 match_len += additional_len;
564 /* If the position_slot is 0, 1, or 2, the match offset is retrieved
565 * from the LRU queue. Otherwise, the match offset is not in the LRU
567 switch (position_slot) {
569 match_offset = queue->R0;
572 match_offset = queue->R1;
573 swap(queue->R0, queue->R1);
576 /* The queue doesn't work quite the same as a real LRU queue,
577 * since using the R2 offset doesn't bump the R1 offset down to
579 match_offset = queue->R2;
580 swap(queue->R0, queue->R2);
583 /* Otherwise, the offset was not encoded as one the offsets in
584 * the queue. Depending on the position slot, there is a
585 * certain number of extra bits that need to be read to fully
586 * decode the match offset. */
588 /* Look up the number of extra bits that need to be read. */
589 num_extra_bits = lzx_get_num_extra_bits(position_slot);
591 /* For aligned blocks, if there are at least 3 extra bits, the
592 * actual number of extra bits is 3 less, and they encode a
593 * number of 8-byte words that are added to the offset; there
594 * is then an additional symbol read using the aligned tree that
595 * specifies the actual byte alignment. */
596 if (block_type == LZX_BLOCKTYPE_ALIGNED && num_extra_bits >= 3) {
598 /* There is an error in the LZX "specification" at this
599 * point; it indicates that a Huffman symbol is to be
600 * read only if num_extra_bits is greater than 3, but
601 * actually it is if num_extra_bits is greater than or
602 * equal to 3. (Note that in the case with
603 * num_extra_bits == 3, the assignment to verbatim_bits
604 * will just set it to 0. ) */
605 ret = bitstream_read_bits(istream, num_extra_bits - 3,
612 ret = read_huffsym_using_alignedtree(istream, tables,
617 /* For non-aligned blocks, or for aligned blocks with
618 * less than 3 extra bits, the extra bits are added
619 * directly to the match offset, and the correction for
620 * the alignment is taken to be 0. */
621 ret = bitstream_read_bits(istream, num_extra_bits,
629 /* Calculate the match offset. */
630 match_offset = lzx_position_base[position_slot] +
631 verbatim_bits + aligned_bits - 2;
633 /* Update the LRU queue. */
634 queue->R2 = queue->R1;
635 queue->R1 = queue->R0;
636 queue->R0 = match_offset;
640 /* Verify that the match is in the bounds of the part of the window
641 * currently in use, then copy the source of the match to the current
643 match_dest = window + window_pos;
644 match_src = match_dest - match_offset;
646 if (match_len > bytes_remaining) {
647 ERROR("lzx_decode_match(): Match of length %u bytes overflows "
648 "uncompressed block size", match_len);
652 if (match_src < window) {
653 ERROR("lzx_decode_match(): Match of length %u bytes references "
654 "data before window (match_offset = %u, window_pos = %u)",
655 match_len, match_offset, window_pos);
660 printf("Match: src %u, dst %u, len %u\n", match_src - window,
664 for (i = 0; i < match_len; i++) {
665 match_dest[i] = match_src[i];
666 putchar(match_src[i]);
671 for (i = 0; i < match_len; i++)
672 match_dest[i] = match_src[i];
679 undo_call_insn_translation(u32 *call_insn_target, int input_pos,
685 abs_offset = le32_to_cpu(*call_insn_target);
686 if (abs_offset >= -input_pos && abs_offset < file_size) {
687 if (abs_offset >= 0) {
688 /* "good translation" */
689 rel_offset = abs_offset - input_pos;
691 /* "compensating translation" */
692 rel_offset = abs_offset + file_size;
694 *call_insn_target = cpu_to_le32(rel_offset);
698 /* Undo the 'E8' preprocessing, where the targets of x86 CALL instructions were
699 * changed from relative offsets to absolute offsets.
701 * Note that this call instruction preprocessing can and will be used on any
702 * data even if it is not actually x86 machine code. In fact, this type of
703 * preprocessing appears to always be used in LZX-compressed resources in WIM
704 * files; there is no bit to indicate whether it is used or not, unlike in the
705 * LZX compressed format as used in cabinet files, where a bit is reserved for
708 * Call instruction preprocessing is disabled in the last 6 bytes of the
709 * uncompressed data, which really means the 5-byte call instruction cannot
710 * start in the last 10 bytes of the uncompressed data. This is one of the
711 * errors in the LZX documentation.
713 * Call instruction preprocessing does not appear to be disabled after the
714 * 32768th chunk of a WIM stream, which is apparently is yet another difference
715 * from the LZX compression used in cabinet files.
717 * Call instruction processing is supposed to take the file size as a parameter,
718 * as it is used in calculating the translated jump targets. But in WIM files,
719 * this file size is always the same (LZX_WIM_MAGIC_FILESIZE == 12000000).*/
721 undo_call_insn_preprocessing(u8 uncompressed_data[], int uncompressed_data_len)
723 for (int i = 0; i < uncompressed_data_len - 10; i++) {
724 if (uncompressed_data[i] == 0xe8) {
725 undo_call_insn_translation((u32*)&uncompressed_data[i + 1],
727 LZX_WIM_MAGIC_FILESIZE);
734 * Decompresses a LZX-compressed block of data from which the header has already
737 * @block_type: The type of the block (LZX_BLOCKTYPE_VERBATIM or
738 * LZX_BLOCKTYPE_ALIGNED)
739 * @block_size: The size of the block, in bytes.
740 * @window: Pointer to the decompression window.
741 * @window_pos: The current position in the window. Will be 0 for the first
743 * @tables: The Huffman decoding tables for the block (main, length, and
744 * aligned offset, the latter only for LZX_BLOCKTYPE_ALIGNED)
745 * @queue: The least-recently-used queue for match offsets.
746 * @istream: The input bitstream for the compressed literals.
749 lzx_decompress_block(int block_type, unsigned block_size,
752 const struct lzx_tables *tables,
753 struct lru_queue *queue,
754 struct input_bitstream *istream)
756 unsigned main_element;
761 end = window_pos + block_size;
762 while (window_pos < end) {
763 ret = read_huffsym_using_maintree(istream, tables,
768 if (main_element < LZX_NUM_CHARS) {
769 /* literal: 0 to LZX_NUM_CHARS - 1 */
770 window[window_pos++] = main_element;
772 /* match: LZX_NUM_CHARS to LZX_MAINTREE_NUM_SYMBOLS - 1 */
773 match_len = lzx_decode_match(main_element,
783 window_pos += match_len;
790 * Decompresses a block of LZX-compressed data as used in the WIM file format.
792 * Note that this will NOT work unmodified for LZX as used in the cabinet
793 * format, which is not the same as in the WIM format!
795 * @compressed_data: A pointer to the compressed data.
797 * @compressed_len: The length of the compressed data, in bytes.
799 * @uncompressed_data: A pointer to the buffer into which to write the
802 * @uncompressed_len: The length of the uncompressed data. It must be
803 * 32768 bytes or less.
805 * Return 0 on success; non-zero on failure.
808 lzx_decompress(const void *compressed_data, unsigned compressed_len,
809 void *uncompressed_data, unsigned uncompressed_len)
811 struct lzx_tables tables;
812 struct input_bitstream istream;
813 struct lru_queue queue;
818 bool e8_preprocessing_done;
820 LZX_DEBUG("lzx_decompress (compressed_data = %p, compressed_len = %d, "
821 "uncompressed_data = %p, uncompressed_len = %d).",
822 compressed_data, compressed_len,
823 uncompressed_data, uncompressed_len);
825 wimlib_assert(uncompressed_len <= 32768);
827 memset(tables.maintree_lens, 0, sizeof(tables.maintree_lens));
828 memset(tables.lentree_lens, 0, sizeof(tables.lentree_lens));
832 init_input_bitstream(&istream, compressed_data, compressed_len);
834 e8_preprocessing_done = false; /* Set to true if there may be 0xe8 bytes
835 in the uncompressed data. */
837 /* The compressed data will consist of one or more blocks. The
838 * following loop decompresses one block, and it runs until there all
839 * the compressed data has been decompressed, so there are no more
843 window_pos < uncompressed_len;
844 window_pos += block_size)
846 LZX_DEBUG("Reading block header.");
847 ret = lzx_read_block_header(&istream, &block_size,
848 &block_type, &tables, &queue);
852 LZX_DEBUG("block_size = %u, window_pos = %u",
853 block_size, window_pos);
855 if (block_size > uncompressed_len - window_pos) {
856 ERROR("lzx_decompress(): Expected a block size of at "
857 "most %u bytes (found %u bytes)",
858 uncompressed_len - window_pos, block_size);
862 switch (block_type) {
863 case LZX_BLOCKTYPE_VERBATIM:
864 case LZX_BLOCKTYPE_ALIGNED:
865 if (block_type == LZX_BLOCKTYPE_VERBATIM)
866 LZX_DEBUG("LZX_BLOCKTYPE_VERBATIM");
868 LZX_DEBUG("LZX_BLOCKTYPE_ALIGNED");
869 ret = lzx_decompress_block(block_type,
878 if (tables.maintree_lens[0xe8] != 0)
879 e8_preprocessing_done = true;
881 case LZX_BLOCKTYPE_UNCOMPRESSED:
882 LZX_DEBUG("LZX_BLOCKTYPE_UNCOMPRESSED");
883 if (istream.data_bytes_left < block_size) {
884 ERROR("Unexpected end of input when "
885 "reading %u bytes from LZX bitstream "
886 "(only have %u bytes left)",
887 block_size, istream.data_bytes_left);
890 memcpy(&((u8*)uncompressed_data)[window_pos], istream.data,
892 istream.data += block_size;
893 istream.data_bytes_left -= block_size;
894 /* Re-align bitstream if an odd number of bytes were
896 if (istream.data_bytes_left && (block_size & 1)) {
897 istream.data_bytes_left--;
900 e8_preprocessing_done = true;
904 if (e8_preprocessing_done)
905 undo_call_insn_preprocessing(uncompressed_data, uncompressed_len);