a66e6d8b2126384880ca943fb2979141a4182340
[wimlib] / src / lzx-decompress.c
1 /*
2  * lzx-decompress.c
3  *
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
6  * from unlzx.
7  */
8
9 /*
10  * Copyright (C) 2012 Eric Biggers
11  *
12  * This file is part of wimlib, a library for working with WIM files.
13  *
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)
17  * any later version.
18  *
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
22  * details.
23  *
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/.
26  */
27
28 /*
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.
35  *
36  * Some notes on the LZX compression format as used in Windows Imaging (WIM)
37  * files:
38  *
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.
48  *
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.
56  *
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
61  * uncompressed.
62  *
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.
69  */
70
71 /*
72  * Some more notes about errors in Microsoft's LZX documentation:
73  *
74  * Microsoft's LZX document and their implementation of the com.ms.util.cab Java
75  * package do not concur.
76  *
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.
83  *
84  * The constant NUM_PRIMARY_LENS used in the decompression pseudocode is not
85  * defined in the specification.
86  *
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.
90  *
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.
95  *
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.
102  *
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
106  * succeed.
107  */
108
109 #include "util.h"
110 #include "lzx.h"
111 #include "decompress.h"
112 #include <string.h>
113
114 /* Huffman decoding tables and maps from symbols to code lengths. */
115 struct lzx_tables {
116
117         u16 maintree_decode_table[(1 << LZX_MAINTREE_TABLEBITS) +
118                                         (LZX_MAINTREE_NUM_SYMBOLS * 2)];
119         u8 maintree_lens[LZX_MAINTREE_NUM_SYMBOLS];
120
121
122         u16 lentree_decode_table[(1 << LZX_LENTREE_TABLEBITS) +
123                                         (LZX_LENTREE_NUM_SYMBOLS * 2)];
124         u8 lentree_lens[LZX_LENTREE_NUM_SYMBOLS];
125
126
127         u16 alignedtree_decode_table[(1 << LZX_ALIGNEDTREE_TABLEBITS) +
128                                         (LZX_ALIGNEDTREE_NUM_SYMBOLS * 2)];
129         u8 alignedtree_lens[LZX_ALIGNEDTREE_NUM_SYMBOLS];
130 };
131
132
133 /*
134  * Reads a Huffman-encoded symbol using the pre-tree.
135  */
136 static inline int read_huffsym_using_pretree(struct input_bitstream *istream,
137                                              const u16 pretree_decode_table[],
138                                              const u8 pretree_lens[], unsigned *n)
139 {
140         return read_huffsym(istream, pretree_decode_table, pretree_lens,
141                             LZX_PRETREE_NUM_SYMBOLS, LZX_PRETREE_TABLEBITS, n,
142                             LZX_MAX_CODEWORD_LEN);
143 }
144
145 /* Reads a Huffman-encoded symbol using the main tree. */
146 static inline int read_huffsym_using_maintree(struct input_bitstream *istream,
147                                               const struct lzx_tables *tables,
148                                               unsigned *n)
149 {
150         return read_huffsym(istream, tables->maintree_decode_table,
151                             tables->maintree_lens, LZX_MAINTREE_NUM_SYMBOLS,
152                             LZX_MAINTREE_TABLEBITS, n, LZX_MAX_CODEWORD_LEN);
153 }
154
155 /* Reads a Huffman-encoded symbol using the length tree. */
156 static inline int read_huffsym_using_lentree(struct input_bitstream *istream,
157                                              const struct lzx_tables *tables,
158                                              unsigned *n)
159 {
160         return read_huffsym(istream, tables->lentree_decode_table,
161                             tables->lentree_lens, LZX_LENTREE_NUM_SYMBOLS,
162                             LZX_LENTREE_TABLEBITS, n, LZX_MAX_CODEWORD_LEN);
163 }
164
165 /* Reads a Huffman-encoded symbol using the aligned offset tree. */
166 static inline int read_huffsym_using_alignedtree(struct input_bitstream *istream,
167                                                  const struct lzx_tables *tables,
168                                                  unsigned *n)
169 {
170         return read_huffsym(istream, tables->alignedtree_decode_table,
171                             tables->alignedtree_lens,
172                             LZX_ALIGNEDTREE_NUM_SYMBOLS,
173                             LZX_ALIGNEDTREE_TABLEBITS, n, 8);
174 }
175
176 /*
177  * Reads the pretree from the input, then uses the pretree to decode @num_lens
178  * code length values from the input.
179  *
180  * @istream:    The bit stream for the input.  It is positioned on the beginning
181  *                      of the pretree for the code length values.
182  * @lens:       An array that contains the length values from the previous time
183  *                      the code lengths for this Huffman tree were read, or all
184  *                      0's if this is the first time.
185  * @num_lens:   Number of length values to decode and return.
186  *
187  */
188 static int lzx_read_code_lens(struct input_bitstream *istream, u8 lens[],
189                               unsigned num_lens)
190 {
191         /* Declare the decoding table and length table for the pretree. */
192         u16 pretree_decode_table[(1 << LZX_PRETREE_TABLEBITS) +
193                                         (LZX_PRETREE_NUM_SYMBOLS * 2)];
194         u8 pretree_lens[LZX_PRETREE_NUM_SYMBOLS];
195         unsigned i;
196         unsigned len;
197         int ret;
198
199         /* Read the code lengths of the pretree codes.  There are 20 lengths of
200          * 4 bits each. */
201         for (i = 0; i < LZX_PRETREE_NUM_SYMBOLS; i++) {
202                 ret = bitstream_read_bits(istream, LZX_PRETREE_ELEMENT_SIZE,
203                                           &len);
204                 if (ret != 0)
205                         return ret;
206                 pretree_lens[i] = len;
207         }
208
209         /* Make the decoding table for the pretree. */
210         ret = make_huffman_decode_table(pretree_decode_table,
211                                         LZX_PRETREE_NUM_SYMBOLS,
212                                         LZX_PRETREE_TABLEBITS,
213                                         pretree_lens,
214                                         LZX_MAX_CODEWORD_LEN);
215         if (ret != 0)
216                 return ret;
217
218         /* Pointer past the last length value that needs to be filled in. */
219         u8 *lens_end = lens + num_lens;
220
221         while (1) {
222
223                 /* Decode a symbol from the input.  If the symbol is between 0
224                  * and 16, it is the difference from the old length.  If it is
225                  * between 17 and 19, it is a special code that indicates that
226                  * some number of the next lengths are all 0, or some number of
227                  * the next lengths are all equal to the next symbol in the
228                  * input. */
229                 unsigned tree_code;
230                 unsigned num_zeroes;
231                 unsigned code;
232                 unsigned num_same;
233                 char value;
234
235                 ret = read_huffsym_using_pretree(istream, pretree_decode_table,
236                                                 pretree_lens, &tree_code);
237                 if (ret != 0)
238                         return ret;
239                 switch (tree_code) {
240                 case 17: /* Run of 0's */
241                         ret = bitstream_read_bits(istream, 4, &num_zeroes);
242                         if (ret != 0)
243                                 return ret;
244                         num_zeroes += 4;
245                         while (num_zeroes--) {
246                                 *lens = 0;
247                                 if (++lens == lens_end)
248                                         return 0;
249                         }
250                         break;
251                 case 18: /* Longer run of 0's */
252                         ret = bitstream_read_bits(istream, 5, &num_zeroes);
253                         if (ret != 0)
254                                 return ret;
255                         num_zeroes += 20;
256                         while (num_zeroes--) {
257                                 *lens = 0;
258                                 if (++lens == lens_end)
259                                         return 0;
260                         }
261                         break;
262                 case 19: /* Run of identical lengths */
263                         ret = bitstream_read_bits(istream, 1, &num_same);
264                         if (ret != 0)
265                                 return ret;
266                         num_same += 4;
267
268                         ret = read_huffsym_using_pretree(istream,
269                                                 pretree_decode_table,
270                                                 pretree_lens, &code);
271                         if (ret != 0)
272                                 return ret;
273                         value = (char)*lens - (char)code;
274                         if (value < 0)
275                                 value += 17;
276                         while (num_same--) {
277                                 *lens = value;
278                                 if (++lens == lens_end)
279                                         return 0;
280                         }
281                         break;
282                 default: /* Difference from old length. */
283                         value = (char)*lens - (char)tree_code;
284                         if (value < 0)
285                                 value += 17;
286                         *lens = value;
287                         if (++lens == lens_end)
288                                 return 0;
289                         break;
290                 }
291         }
292 }
293
294 /*
295  * Reads the header for an LZX-compressed block.
296  *
297  * @istream:            The input bitstream.
298  * @block_size_ret:     A pointer to an int into which the size of the block,
299  *                              in bytes, will be returned.
300  * @block_type_ret:     A pointer to an int into which the type of the block
301  *                              (LZX_BLOCKTYPE_*) will be returned.
302  * @tables:             A pointer to a lzx_tables structure in which the
303  *                              main tree, the length tree, and possibly the
304  *                              aligned offset tree will be constructed.
305  * @queue:      A pointer to the least-recently-used queue into which
306  *                      R0, R1, and R2 will be written (only for uncompressed
307  *                      blocks, which contain this information in the header)
308  */
309 static int lzx_read_block_header(struct input_bitstream *istream,
310                                  unsigned *block_size_ret,
311                                  unsigned *block_type_ret,
312                                  struct lzx_tables *tables,
313                                  struct lru_queue *queue)
314 {
315         int ret;
316         int block_type;
317         unsigned block_size;
318         int s;
319         int i;
320         unsigned len;
321         int32_t R[3];
322
323         ret = bitstream_ensure_bits(istream, 4);
324         if (ret != 0) {
325                 ERROR("LZX input stream overrun");
326                 return ret;
327         }
328
329         /* The first three bits tell us what kind of block it is, and are one
330          * of the LZX_BLOCKTYPE_* values.  */
331         block_type = bitstream_read_bits_nocheck(istream, 3);
332
333         /* The next bit indicates whether the block size is the default (32768),
334          * indicated by a 1 bit, or whether the block size is given by the next
335          * 16 bits, indicated by a 0 bit. */
336         s = bitstream_read_bits_nocheck(istream, 1);
337
338         if (s == 1) {
339                 block_size = 1 << 15;
340         } else {
341                 ret = bitstream_read_bits(istream, 16, &block_size);
342                 if (ret != 0)
343                         return ret;
344                 block_size = le16_to_cpu(block_size);
345         }
346
347         switch (block_type) {
348         case LZX_BLOCKTYPE_ALIGNED:
349                 /* Read the path lengths for the elements of the aligned tree,
350                  * then build it. */
351
352                 for (i = 0; i < LZX_ALIGNEDTREE_NUM_SYMBOLS; i++) {
353                         ret = bitstream_read_bits(istream,
354                                                   LZX_ALIGNEDTREE_ELEMENT_SIZE,
355                                                   &len);
356                         if (ret != 0)
357                                 return ret;
358                         tables->alignedtree_lens[i] = len;
359                 }
360
361                 LZX_DEBUG("Building the aligned tree.");
362                 ret = make_huffman_decode_table(tables->alignedtree_decode_table,
363                                                 LZX_ALIGNEDTREE_NUM_SYMBOLS,
364                                                 LZX_ALIGNEDTREE_TABLEBITS,
365                                                 tables->alignedtree_lens,
366                                                 8);
367                 if (ret != 0) {
368                         ERROR("lzx_decompress(): Failed to make the decode "
369                               "table for the aligned offset tree");
370                         return ret;
371                 }
372
373                 /* Fall though, since the rest of the header for aligned offset
374                  * blocks is the same as that for verbatim blocks */
375
376         case LZX_BLOCKTYPE_VERBATIM:
377                 if (block_type == LZX_BLOCKTYPE_VERBATIM)
378                         LZX_DEBUG("Found verbatim block.");
379
380                 LZX_DEBUG("Reading path lengths for main tree.");
381                 /* Read the path lengths for the first 256 elements of the main
382                  * tree. */
383                 ret = lzx_read_code_lens(istream, tables->maintree_lens,
384                                          LZX_NUM_CHARS);
385                 if (ret != 0) {
386                         ERROR("lzx_decompress(): Failed to read the code "
387                               "lengths for the first 256 elements of the "
388                               "main tree");
389                         return ret;
390                 }
391
392                 /* Read the path lengths for the remaining elements of the main
393                  * tree. */
394                 LZX_DEBUG("Reading path lengths for remaining elements of "
395                           "main tree (%d elements).",
396                           LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
397                 ret = lzx_read_code_lens(istream,
398                                          tables->maintree_lens + LZX_NUM_CHARS,
399                                          LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
400                 if (ret != 0) {
401                         ERROR("lzx_decompress(): Failed to read the path "
402                               "lengths for the remaining elements of the main "
403                               "tree");
404                         return ret;
405                 }
406
407                 LZX_DEBUG("Building the Huffman decoding "
408                           "table for the main tree.");
409
410                 ret = make_huffman_decode_table(tables->maintree_decode_table,
411                                                 LZX_MAINTREE_NUM_SYMBOLS,
412                                                 LZX_MAINTREE_TABLEBITS,
413                                                 tables->maintree_lens,
414                                                 LZX_MAX_CODEWORD_LEN);
415                 if (ret != 0) {
416                         ERROR("lzx_decompress(): Failed to make the decode "
417                               "table for the main tree");
418                         return ret;
419                 }
420
421                 LZX_DEBUG("Reading path lengths for the length tree.");
422                 ret = lzx_read_code_lens(istream, tables->lentree_lens,
423                                          LZX_LENTREE_NUM_SYMBOLS);
424                 if (ret != 0) {
425                         ERROR("lzx_decompress(): Failed to read the path "
426                               "lengths for the length tree");
427                         return ret;
428                 }
429
430                 LZX_DEBUG("Building the length tree.");
431                 ret = make_huffman_decode_table(tables->lentree_decode_table,
432                                                 LZX_LENTREE_NUM_SYMBOLS,
433                                                 LZX_LENTREE_TABLEBITS,
434                                                 tables->lentree_lens,
435                                                 LZX_MAX_CODEWORD_LEN);
436                 if (ret != 0) {
437                         ERROR("lzx_decompress(): Failed to build the length "
438                               "Huffman tree");
439                         return ret;
440                 }
441
442                 break;
443
444         case LZX_BLOCKTYPE_UNCOMPRESSED:
445                 LZX_DEBUG("Found uncompressed block.");
446
447                 /* Mystery bit! */
448                 ret = bitstream_read_bits(istream, 1, &i);
449                 if (ret != 0)
450                         return ret;
451                 align_input_bitstream(istream);
452                 ret = bitstream_read_bytes(istream, sizeof(R), R);
453                 if (ret != 0)
454                         return ret;
455                 queue->R0 = le32_to_cpu(R[0]);
456                 queue->R1 = le32_to_cpu(R[1]);
457                 queue->R2 = le32_to_cpu(R[2]);
458                 break;
459         default:
460                 LZX_DEBUG("Found invalid block.");
461                 return 1;
462         }
463         *block_type_ret = block_type;
464         *block_size_ret = block_size;
465         return 0;
466 }
467
468 /*
469  * Decodes a compressed literal match value.  It refers to some match_offset to
470  * a point earlier in the window, and some match_len, for which the data is to
471  * be copied to the current position in the window.
472  *
473  * @main_element:       The start of the match data, as decoded using the main
474  *                              tree.
475  * @block_type: The type of the block (LZX_BLOCKTYPE_ALIGNED or
476  *                      LZX_BLOCKTYPE_VERBATIM)
477  * @bytes_remaining:    The amount of uncompressed data remaining to be
478  *                              uncompressed.  It is an error if the match
479  *                              is longer than @bytes_remaining.
480  * @window:     A pointer to the window into which the uncompressed
481  *                      data is being written.
482  * @window_pos: The current position in the window.
483  * @tables:     Contains the Huffman tables for the block (main,
484  *                      length, and also aligned offset only for
485  *                      LZX_BLOCKTYPE_ALIGNED)
486  * @queue:      The least-recently used queue for match offsets.
487  * @istream:    The input bitstream.
488  *
489  * Returns the length of the match, or -1 on error (match would exceed
490  * the amount of data needing to be uncompressed, or match refers to data before
491  * the window, or the input bitstream ended unexpectedly).
492  */
493 static int lzx_decode_match(int main_element, int block_type,
494                             int bytes_remaining, u8 *window, int window_pos,
495                             const struct lzx_tables *tables,
496                             struct lru_queue *queue,
497                             struct input_bitstream *istream)
498 {
499         unsigned length_header;
500         unsigned position_slot;
501         unsigned match_len;
502         unsigned match_offset;
503         unsigned additional_len;
504         unsigned num_extra_bits;
505         unsigned verbatim_bits;
506         unsigned aligned_bits;
507         int ret;
508         int i;
509         u8 *match_dest;
510         u8 *match_src;
511
512         /* The main element is offset by 256 because values under 256 indicate a
513          * literal value. */
514         main_element -= LZX_NUM_CHARS;
515
516         /* The length header consists of the lower 3 bits of the main element.
517          * The position slot is the rest of it. */
518         length_header = main_element & LZX_NUM_PRIMARY_LENS;
519         position_slot = main_element >> 3;
520
521         /* If the length_header is less than LZX_NUM_PRIMARY_LENS (= 7), it
522          * gives the match length as the offset from LZX_MIN_MATCH.  Otherwise,
523          * the length is given by an additional symbol encoded using the length
524          * tree, offset by 9 (LZX_MIN_MATCH + LZX_NUM_PRIMARY_LENS) */
525         match_len = LZX_MIN_MATCH + length_header;
526         if (length_header == LZX_NUM_PRIMARY_LENS) {
527                 ret = read_huffsym_using_lentree(istream, tables,
528                                                 &additional_len);
529                 if (ret != 0)
530                         return -1;
531                 match_len += additional_len;
532         }
533
534
535         /* If the position_slot is 0, 1, or 2, the match offset is retrieved
536          * from the LRU queue.  Otherwise, the match offset is not in the LRU
537          * queue. */
538         switch (position_slot) {
539         case 0:
540                 match_offset = queue->R0;
541                 break;
542         case 1:
543                 match_offset = queue->R1;
544                 swap(queue->R0, queue->R1);
545                 break;
546         case 2:
547                 /* The queue doesn't work quite the same as a real LRU queue,
548                  * since using the R2 offset doesn't bump the R1 offset down to
549                  * R2. */
550                 match_offset = queue->R2;
551                 swap(queue->R0, queue->R2);
552                 break;
553         default:
554                 /* Otherwise, the offset was not encoded as one the offsets in
555                  * the queue.  Depending on the position slot, there is a
556                  * certain number of extra bits that need to be read to fully
557                  * decode the match offset. */
558
559                 /* Look up the number of extra bits that need to be read. */
560                 num_extra_bits = lzx_extra_bits[position_slot];
561
562                 /* For aligned blocks, if there are at least 3 extra bits, the
563                  * actual number of extra bits is 3 less, and they encode a
564                  * number of 8-byte words that are added to the offset; there
565                  * is then an additional symbol read using the aligned tree that
566                  * specifies the actual byte alignment. */
567                 if (block_type == LZX_BLOCKTYPE_ALIGNED && num_extra_bits >= 3) {
568
569                         /* There is an error in the LZX "specification" at this
570                          * point; it indicates that a Huffman symbol is to be
571                          * read only if num_extra_bits is greater than 3, but
572                          * actually it is if num_extra_bits is greater than or
573                          * equal to 3.  (Note that in the case with
574                          * num_extra_bits == 3, the assignment to verbatim_bits
575                          * will just set it to 0. ) */
576                         ret = bitstream_read_bits(istream, num_extra_bits - 3,
577                                                                 &verbatim_bits);
578                         if (ret != 0)
579                                 return -1;
580
581                         verbatim_bits <<= 3;
582
583                         ret = read_huffsym_using_alignedtree(istream, tables,
584                                                              &aligned_bits);
585                         if (ret != 0)
586                                 return -1;
587                 } else {
588                         /* For non-aligned blocks, or for aligned blocks with
589                          * less than 3 extra bits, the extra bits are added
590                          * directly to the match offset, and the correction for
591                          * the alignment is taken to be 0. */
592                         ret = bitstream_read_bits(istream, num_extra_bits,
593                                                   &verbatim_bits);
594                         if (ret != 0)
595                                 return -1;
596
597                         aligned_bits = 0;
598                 }
599
600                 /* Calculate the match offset. */
601                 match_offset = lzx_position_base[position_slot] + verbatim_bits +
602                                                         aligned_bits - 2;
603
604                 /* Update the LRU queue. */
605                 queue->R2 = queue->R1;
606                 queue->R1 = queue->R0;
607                 queue->R0 = match_offset;
608                 break;
609         }
610
611         /* Verify that the match is in the bounds of the part of the window
612          * currently in use, then copy the source of the match to the current
613          * position. */
614         match_dest = window + window_pos;
615         match_src = match_dest - match_offset;
616
617         if (match_len > bytes_remaining) {
618                 ERROR("lzx_decode_match(): Match of length %d bytes overflows "
619                       "uncompressed block size", match_len);
620                 return -1;
621         }
622
623         if (match_src < window) {
624                 ERROR("lzx_decode_match(): Match of length %d bytes references "
625                       "data before window (match_offset = %d, window_pos = %d)",
626                       match_len, match_offset, window_pos);
627                 return -1;
628         }
629
630 #if 0
631         printf("Match: src %u, dst %u, len %u\n", match_src - window,
632                                                 match_dest - window,
633                                                 match_len);
634         putchar('|');
635         for (i = 0; i < match_len; i++) {
636                 match_dest[i] = match_src[i];
637                 putchar(match_src[i]);
638         }
639         putchar('|');
640         putchar('\n');
641 #else
642         for (i = 0; i < match_len; i++)
643                 match_dest[i] = match_src[i];
644 #endif
645
646         return match_len;
647 }
648
649
650
651 /* Undo the 'E8' preprocessing, where the targets of x86 CALL instructions were
652  * changed from relative offsets to absolute offsets.  This type of
653  * preprocessing can be used on any binary data even if it is not actually
654  * machine code.  It seems to always be used in WIM files, even though there is
655  * no bit to indicate that it actually is used, unlike in the LZX compressed
656  * format as used in other file formats, where a bit is reserved for that
657  * purpose. */
658 static void undo_call_insn_preprocessing(u8 uncompressed_data[],
659                                          unsigned uncompressed_data_len)
660 {
661         int i = 0;
662         int file_size = LZX_MAGIC_FILESIZE;
663         int32_t abs_offset;
664         int32_t rel_offset;
665
666         /* Not enabled in the last 6 bytes, which means the 5-byte call
667          * instruction cannot start in the last *10* bytes. */
668         while (i < uncompressed_data_len - 10) {
669                 if (uncompressed_data[i] != 0xe8) {
670                         i++;
671                         continue;
672                 }
673                 abs_offset = le32_to_cpu(*(int32_t*)(uncompressed_data + i + 1));
674
675                 if (abs_offset >= -i && abs_offset < file_size) {
676                         if (abs_offset >= 0) {
677                                 /* "good translation" */
678                                 rel_offset = abs_offset - i;
679                         } else {
680                                 /* "compensating translation" */
681                                 rel_offset = abs_offset + file_size;
682                         }
683                         *(int32_t*)(uncompressed_data + i + 1) =
684                                                 cpu_to_le32(rel_offset);
685                 }
686                 i += 5;
687         }
688 }
689
690 /*
691  * Decompresses a compressed block of data from which the header has already
692  * been read.
693  *
694  * @block_type: The type of the block (LZX_BLOCKTYPE_VERBATIM or
695  *              LZX_BLOCKTYPE_ALIGNED)
696  * @block_size: The size of the block, in bytes.
697  * @window:     Pointer to the decompression window.
698  * @window_pos: The current position in the window.  Will be 0 for the first
699  *                      block.
700  * @tables:     The Huffman decoding tables for the block (main, length, and
701  *                      aligned offset, the latter only for LZX_BLOCKTYPE_ALIGNED)
702  * @queue:      The least-recently-used queue for match offsets.
703  * @istream:    The input bitstream for the compressed literals.
704  */
705 static int lzx_decompress_block(int block_type, int block_size, u8 *window,
706                                 int window_pos,
707                                 const struct lzx_tables *tables,
708                                 struct lru_queue *queue,
709                                 struct input_bitstream *istream)
710 {
711         unsigned bytes_remaining;
712         unsigned main_element;
713         int match_len;
714         int ret;
715
716         bytes_remaining = block_size;
717         while (bytes_remaining > 0) {
718
719                 ret = read_huffsym_using_maintree(istream, tables,
720                                                   &main_element);
721                 if (ret != 0)
722                         return ret;
723
724                 if (main_element < LZX_NUM_CHARS) {
725                         /* literal: 0 to LZX_NUM_CHARS - 1 */
726                         window[window_pos + block_size - bytes_remaining] =
727                                                         main_element;
728                         bytes_remaining--;
729                 } else {
730                         /* match: LZX_NUM_CHARS to LZX_MAINTREE_NUM_SYMBOLS - 1 */
731                         match_len = lzx_decode_match(main_element,
732                                                 block_type, bytes_remaining, window,
733                                                 block_size + window_pos -
734                                                         bytes_remaining,
735                                                 tables, queue, istream);
736                         if (match_len == -1)
737                                 return 1;
738
739                         bytes_remaining -= match_len;
740                 }
741         }
742         return 0;
743 }
744
745 /*
746  * Decompresses a block of LZX-compressed data using a window size of 32768.
747  *
748  * @compressed_data:    A pointer to the compressed data.
749  * @compressed_len:     The length of the compressed data, in bytes.
750  * @uncompressed_data:  A pointer to the buffer into which to write the
751  *                              uncompressed data.
752  * @uncompressed_len:   The length of the uncompressed data.
753  *
754  * Return non-zero on failure.
755  */
756 int lzx_decompress(const void *compressed_data, unsigned compressed_len,
757                    void *uncompressed_data, unsigned uncompressed_len)
758 {
759         struct lzx_tables tables;
760         struct input_bitstream istream;
761         struct lru_queue queue;
762         unsigned bytes_remaining;
763         unsigned block_size;
764         unsigned block_type;
765         int ret;
766
767         LZX_DEBUG("lzx_decompress (compressed_data = %p, compressed_len = %d, "
768                   "uncompressed_data = %p, uncompressed_len = %d).",
769                   compressed_data, compressed_len,
770                   uncompressed_data, uncompressed_len);
771
772         wimlib_assert(uncompressed_len <= 32768);
773
774         memset(tables.maintree_lens, 0, sizeof(tables.maintree_lens));
775         memset(tables.lentree_lens, 0, sizeof(tables.lentree_lens));
776         queue.R0 = 1;
777         queue.R1 = 1;
778         queue.R2 = 1;
779         bytes_remaining = uncompressed_len;
780
781         init_input_bitstream(&istream, compressed_data, compressed_len);
782
783         /* The compressed data will consist of one or more blocks.  The
784          * following loop decompresses one block, and it runs until there all
785          * the compressed data has been decompressed, so there are no more
786          * blocks.  */
787
788         while (bytes_remaining != 0) {
789
790                 LZX_DEBUG("Reading block header.");
791                 ret = lzx_read_block_header(&istream, &block_size,
792                                             &block_type, &tables, &queue);
793                 if (ret != 0)
794                         return ret;
795
796                 LZX_DEBUG("block_size = %u, bytes_remaining = %u",
797                           block_size, bytes_remaining);
798
799                 if (block_size > bytes_remaining) {
800                         ERROR("lzx_decompress(): Expected a block size of at "
801                               "most %u bytes (found %u bytes)",
802                               bytes_remaining, block_size);
803                         return 1;
804                 }
805
806                 switch (block_type) {
807                 case LZX_BLOCKTYPE_VERBATIM:
808                 case LZX_BLOCKTYPE_ALIGNED:
809                         if (block_type == LZX_BLOCKTYPE_VERBATIM)
810                                 LZX_DEBUG("LZX_BLOCKTYPE_VERBATIM");
811                         else
812                                 LZX_DEBUG("LZX_BLOCKTYPE_ALIGNED");
813
814                         ret = lzx_decompress_block(block_type,
815                                                    block_size,
816                                                    uncompressed_data,
817                                                    uncompressed_len -
818                                                        bytes_remaining,
819                                                    &tables, &queue, &istream);
820                         if (ret != 0)
821                                 return ret;
822                         break;
823                 case LZX_BLOCKTYPE_UNCOMPRESSED:
824                         LZX_DEBUG("LZX_BLOCKTYPE_UNCOMPRESSED");
825                         ret = bitstream_read_bytes(&istream, block_size,
826                                                    uncompressed_data +
827                                                    uncompressed_len -
828                                                    bytes_remaining);
829                         if (ret != 0)
830                                 return ret;
831                         if (block_size & 1)
832                                 align_input_bitstream(&istream);
833                         break;
834                 default:
835                         wimlib_assert(0);
836                         break;
837                 }
838
839                 bytes_remaining -= block_size;
840
841                 if (bytes_remaining != 0)
842                         LZX_DEBUG("%d bytes remaining.", bytes_remaining);
843         }
844
845         if (uncompressed_len >= 10)
846                 undo_call_insn_preprocessing(uncompressed_data,
847                                              uncompressed_len);
848
849         return 0;
850 }