wimlib.net Git - wimlib/blob - src/lzx-decomp.c

   1 /*
   2  * lzx-decomp.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 "decomp.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[], uint *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                                               uint *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                                              uint *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                                                  uint *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                               uint 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         uint i;
 196         uint 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                 uint tree_code;
 230                 uint num_zeroes;
 231                 uint code;
 232                 uint 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                                  int *block_size_ret, int *block_type_ret,
 311                                  struct lzx_tables *tables,
 312                                  struct lru_queue *queue)
 313 {
 314         int ret;
 315         int block_type;
 316         uint block_size;
 317         int s;
 318         int i;
 319         uint len;
 320         int32_t R[3];
 321
 322         ret = bitstream_ensure_bits(istream, 4);
 323         if (ret != 0) {
 324                 ERROR("LZX input stream overrun");
 325                 return ret;
 326         }
 327
 328         /* The first three bits tell us what kind of block it is, and are one
 329          * of the LZX_BLOCKTYPE_* values.  */
 330         block_type = bitstream_read_bits_nocheck(istream, 3);
 331
 332         /* The next bit indicates whether the block size is the default (32768),
 333          * indicated by a 1 bit, or whether the block size is given by the next
 334          * 16 bits, indicated by a 0 bit. */
 335         s = bitstream_read_bits_nocheck(istream, 1);
 336
 337         if (s == 1) {
 338                 block_size = 1 << 15;
 339         } else {
 340                 ret = bitstream_read_bits(istream, 16, &block_size);
 341                 if (ret != 0)
 342                         return ret;
 343                 block_size = le16_to_cpu(block_size);
 344         }
 345
 346         switch (block_type) {
 347         case LZX_BLOCKTYPE_ALIGNED:
 348                 /* Read the path lengths for the elements of the aligned tree,
 349                  * then build it. */
 350
 351                 for (i = 0; i < LZX_ALIGNEDTREE_NUM_SYMBOLS; i++) {
 352                         ret = bitstream_read_bits(istream,
 353                                                   LZX_ALIGNEDTREE_ELEMENT_SIZE,
 354                                                   &len);
 355                         if (ret != 0)
 356                                 return ret;
 357                         tables->alignedtree_lens[i] = len;
 358                 }
 359
 360                 LZX_DEBUG("Building the aligned tree.");
 361                 ret = make_huffman_decode_table(tables->alignedtree_decode_table,
 362                                                 LZX_ALIGNEDTREE_NUM_SYMBOLS,
 363                                                 LZX_ALIGNEDTREE_TABLEBITS,
 364                                                 tables->alignedtree_lens,
 365                                                 8);
 366                 if (ret != 0) {
 367                         ERROR("lzx_decompress(): Failed to make the decode "
 368                               "table for the aligned offset tree");
 369                         return ret;
 370                 }
 371
 372                 /* Fall though, since the rest of the header for aligned offset
 373                  * blocks is the same as that for verbatim blocks */
 374
 375         case LZX_BLOCKTYPE_VERBATIM:
 376                 if (block_type == LZX_BLOCKTYPE_VERBATIM)
 377                         LZX_DEBUG("Found verbatim block.");
 378
 379                 LZX_DEBUG("Reading path lengths for main tree.");
 380                 /* Read the path lengths for the first 256 elements of the main
 381                  * tree. */
 382                 ret = lzx_read_code_lens(istream, tables->maintree_lens,
 383                                          LZX_NUM_CHARS);
 384                 if (ret != 0) {
 385                         ERROR("lzx_decompress(): Failed to read the code "
 386                               "lengths for the first 256 elements of the "
 387                               "main tree");
 388                         return ret;
 389                 }
 390
 391                 /* Read the path lengths for the remaining elements of the main
 392                  * tree. */
 393                 LZX_DEBUG("Reading path lengths for remaining elements of "
 394                           "main tree (%d elements).",
 395                           LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
 396                 ret = lzx_read_code_lens(istream,
 397                                          tables->maintree_lens + LZX_NUM_CHARS,
 398                                          LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
 399                 if (ret != 0) {
 400                         ERROR("lzx_decompress(): Failed to read the path "
 401                               "lengths for the remaining elements of the main "
 402                               "tree");
 403                         return ret;
 404                 }
 405
 406                 LZX_DEBUG("Building the Huffman decoding "
 407                           "table for the main tree.");
 408
 409                 ret = make_huffman_decode_table(tables->maintree_decode_table,
 410                                                 LZX_MAINTREE_NUM_SYMBOLS,
 411                                                 LZX_MAINTREE_TABLEBITS,
 412                                                 tables->maintree_lens,
 413                                                 LZX_MAX_CODEWORD_LEN);
 414                 if (ret != 0) {
 415                         ERROR("lzx_decompress(): Failed to make the decode "
 416                               "table for the main tree");
 417                         return ret;
 418                 }
 419
 420                 LZX_DEBUG("Reading path lengths for the length tree.");
 421                 ret = lzx_read_code_lens(istream, tables->lentree_lens,
 422                                          LZX_LENTREE_NUM_SYMBOLS);
 423                 if (ret != 0) {
 424                         ERROR("lzx_decompress(): Failed to read the path "
 425                               "lengths for the length tree");
 426                         return ret;
 427                 }
 428
 429                 LZX_DEBUG("Building the length tree.");
 430                 ret = make_huffman_decode_table(tables->lentree_decode_table,
 431                                                 LZX_LENTREE_NUM_SYMBOLS,
 432                                                 LZX_LENTREE_TABLEBITS,
 433                                                 tables->lentree_lens,
 434                                                 LZX_MAX_CODEWORD_LEN);
 435                 if (ret != 0) {
 436                         ERROR("lzx_decompress(): Failed to build the length "
 437                               "Huffman tree");
 438                         return ret;
 439                 }
 440
 441                 break;
 442
 443         case LZX_BLOCKTYPE_UNCOMPRESSED:
 444                 LZX_DEBUG("Found uncompressed block.");
 445                 ret = align_input_bitstream(istream, true);
 446                 if (ret != 0)
 447                         return ret;
 448                 ret = bitstream_read_bytes(istream, sizeof(R), R);
 449                 if (ret != 0)
 450                         return ret;
 451                 queue->R0 = le32_to_cpu(R[0]);
 452                 queue->R1 = le32_to_cpu(R[1]);
 453                 queue->R2 = le32_to_cpu(R[2]);
 454                 break;
 455         default:
 456                 LZX_DEBUG("Found invalid block.");
 457                 return 1;
 458         }
 459         *block_type_ret = block_type;
 460         *block_size_ret = block_size;
 461         return 0;
 462 }
 463
 464 /*
 465  * Decodes a compressed literal match value.  It refers to some match_offset to
 466  * a point earlier in the window, and some match_len, for which the data is to
 467  * be copied to the current position in the window.
 468  *
 469  * @main_element:       The start of the match data, as decoded using the main
 470  *                              tree.
 471  * @block_type: The type of the block (LZX_BLOCKTYPE_ALIGNED or
 472  *                      LZX_BLOCKTYPE_VERBATIM)
 473  * @bytes_remaining:    The amount of uncompressed data remaining to be
 474  *                              uncompressed.  It is an error if the match
 475  *                              is longer than @bytes_remaining.
 476  * @window:     A pointer to the window into which the uncompressed
 477  *                      data is being written.
 478  * @window_pos: The current position in the window.
 479  * @tables:     Contains the Huffman tables for the block (main,
 480  *                      length, and also aligned offset only for
 481  *                      LZX_BLOCKTYPE_ALIGNED)
 482  * @queue:      The least-recently used queue for match offsets.
 483  * @istream:    The input bitstream.
 484  *
 485  * Returns the length of the match, or -1 on error (match would exceed
 486  * the amount of data needing to be uncompressed, or match refers to data before
 487  * the window, or the input bitstream ended unexpectedly).
 488  */
 489 static int lzx_decode_match(int main_element, int block_type,
 490                             int bytes_remaining, u8 *window, int window_pos,
 491                             const struct lzx_tables *tables,
 492                             struct lru_queue *queue,
 493                             struct input_bitstream *istream)
 494 {
 495         uint length_header;
 496         uint position_slot;
 497         uint match_len;
 498         uint match_offset;
 499         uint additional_len;
 500         uint num_extra_bits;
 501         uint verbatim_bits;
 502         uint aligned_bits;
 503         int ret;
 504         int i;
 505         u8 *match_dest;
 506         u8 *match_src;
 507
 508         /* The main element is offset by 256 because values under 256 indicate a
 509          * literal value. */
 510         main_element -= LZX_NUM_CHARS;
 511
 512         /* The length header consists of the lower 3 bits of the main element.
 513          * The position slot is the rest of it. */
 514         length_header = main_element & LZX_NUM_PRIMARY_LENS;
 515         position_slot = main_element >> 3;
 516
 517         /* If the length_header is less than LZX_NUM_PRIMARY_LENS (= 7), it
 518          * gives the match length as the offset from LZX_MIN_MATCH.  Otherwise,
 519          * the length is given by an additional symbol encoded using the length
 520          * tree, offset by 9 (LZX_MIN_MATCH + LZX_NUM_PRIMARY_LENS) */
 521         match_len = LZX_MIN_MATCH + length_header;
 522         if (length_header == LZX_NUM_PRIMARY_LENS) {
 523                 ret = read_huffsym_using_lentree(istream, tables,
 524                                                 &additional_len);
 525                 if (ret != 0)
 526                         return -1;
 527                 match_len += additional_len;
 528         }
 529
 530
 531         /* If the position_slot is 0, 1, or 2, the match offset is retrieved
 532          * from the LRU queue.  Otherwise, the match offset is not in the LRU
 533          * queue. */
 534         switch (position_slot) {
 535         case 0:
 536                 match_offset = queue->R0;
 537                 break;
 538         case 1:
 539                 match_offset = queue->R1;
 540                 swap(queue->R0, queue->R1);
 541                 break;
 542         case 2:
 543                 /* The queue doesn't work quite the same as a real LRU queue,
 544                  * since using the R2 offset doesn't bump the R1 offset down to
 545                  * R2. */
 546                 match_offset = queue->R2;
 547                 swap(queue->R0, queue->R2);
 548                 break;
 549         default:
 550                 /* Otherwise, the offset was not encoded as one the offsets in
 551                  * the queue.  Depending on the position slot, there is a
 552                  * certain number of extra bits that need to be read to fully
 553                  * decode the match offset. */
 554
 555                 /* Look up the number of extra bits that need to be read. */
 556                 num_extra_bits = lzx_extra_bits[position_slot];
 557
 558                 /* For aligned blocks, if there are at least 3 extra bits, the
 559                  * actual number of extra bits is 3 less, and they encode a
 560                  * number of 8-byte words that are added to the offset; there
 561                  * is then an additional symbol read using the aligned tree that
 562                  * specifies the actual byte alignment. */
 563                 if (block_type == LZX_BLOCKTYPE_ALIGNED && num_extra_bits >= 3) {
 564
 565                         /* There is an error in the LZX "specification" at this
 566                          * point; it indicates that a Huffman symbol is to be
 567                          * read only if num_extra_bits is greater than 3, but
 568                          * actually it is if num_extra_bits is greater than or
 569                          * equal to 3.  (Note that in the case with
 570                          * num_extra_bits == 3, the assignment to verbatim_bits
 571                          * will just set it to 0. ) */
 572                         ret = bitstream_read_bits(istream, num_extra_bits - 3,
 573                                                                 &verbatim_bits);
 574                         if (ret != 0)
 575                                 return -1;
 576
 577                         verbatim_bits <<= 3;
 578
 579                         ret = read_huffsym_using_alignedtree(istream, tables,
 580                                                              &aligned_bits);
 581                         if (ret != 0)
 582                                 return -1;
 583                 } else {
 584                         /* For non-aligned blocks, or for aligned blocks with
 585                          * less than 3 extra bits, the extra bits are added
 586                          * directly to the match offset, and the correction for
 587                          * the alignment is taken to be 0. */
 588                         ret = bitstream_read_bits(istream, num_extra_bits,
 589                                                   &verbatim_bits);
 590                         if (ret != 0)
 591                                 return -1;
 592
 593                         aligned_bits = 0;
 594                 }
 595
 596                 /* Calculate the match offset. */
 597                 match_offset = lzx_position_base[position_slot] + verbatim_bits +
 598                                                         aligned_bits - 2;
 599
 600                 /* Update the LRU queue. */
 601                 queue->R2 = queue->R1;
 602                 queue->R1 = queue->R0;
 603                 queue->R0 = match_offset;
 604                 break;
 605         }
 606
 607         /* Verify that the match is in the bounds of the part of the window
 608          * currently in use, then copy the source of the match to the current
 609          * position. */
 610         match_dest = window + window_pos;
 611         match_src = match_dest - match_offset;
 612
 613         if (match_len > bytes_remaining) {
 614                 ERROR("lzx_decode_match(): Match of length %d bytes overflows "
 615                       "uncompressed block size", match_len);
 616                 return -1;
 617         }
 618
 619         if (match_src < window) {
 620                 ERROR("lzx_decode_match(): Match of length %d bytes references "
 621                       "data before window (match_offset = %d, window_pos = %d)",
 622                       match_len, match_offset, window_pos);
 623                 return -1;
 624         }
 625
 626 #if 0
 627         printf("Match: src %u, dst %u, len %u\n", match_src - window,
 628                                                 match_dest - window,
 629                                                 match_len);
 630         putchar('|');
 631         for (i = 0; i < match_len; i++) {
 632                 match_dest[i] = match_src[i];
 633                 putchar(match_src[i]);
 634         }
 635         putchar('|');
 636         putchar('\n');
 637 #else
 638         for (i = 0; i < match_len; i++)
 639                 match_dest[i] = match_src[i];
 640 #endif
 641
 642         return match_len;
 643 }
 644
 645
 646
 647 /* Undo the 'E8' preprocessing, where the targets of x86 CALL instructions were
 648  * changed from relative offsets to absolute offsets.  This type of
 649  * preprocessing can be used on any binary data even if it is not actually
 650  * machine code.  It seems to always be used in WIM files, even though there is
 651  * no bit to indicate that it actually is used, unlike in the LZX compressed
 652  * format as used in other file formats, where a bit is reserved for that
 653  * purpose. */
 654 static void undo_call_insn_preprocessing(u8 uncompressed_data[],
 655                                          uint uncompressed_data_len)
 656 {
 657         int i = 0;
 658         int file_size = LZX_MAGIC_FILESIZE;
 659         int32_t abs_offset;
 660         int32_t rel_offset;
 661
 662         /* Not enabled in the last 6 bytes, which means the 5-byte call
 663          * instruction cannot start in the last *10* bytes. */
 664         while (i < uncompressed_data_len - 10) {
 665                 if (uncompressed_data[i] != 0xe8) {
 666                         i++;
 667                         continue;
 668                 }
 669                 abs_offset = le32_to_cpu(*(int32_t*)(uncompressed_data + i + 1));
 670
 671                 if (abs_offset >= -i && abs_offset < file_size) {
 672                         if (abs_offset >= 0) {
 673                                 /* "good translation" */
 674                                 rel_offset = abs_offset - i;
 675                         } else {
 676                                 /* "compensating translation" */
 677                                 rel_offset = abs_offset + file_size;
 678                         }
 679                         *(int32_t*)(uncompressed_data + i + 1) =
 680                                                 cpu_to_le32(rel_offset);
 681                 }
 682                 i += 5;
 683         }
 684 }
 685
 686 /*
 687  * Decompresses a compressed block of data from which the header has already
 688  * been read.
 689  *
 690  * @block_type: The type of the block (LZX_BLOCKTYPE_VERBATIM or
 691  *              LZX_BLOCKTYPE_ALIGNED)
 692  * @block_size: The size of the block, in bytes.
 693  * @window:     Pointer to the decompression window.
 694  * @window_pos: The current position in the window.  Will be 0 for the first
 695  *                      block.
 696  * @tables:     The Huffman decoding tables for the block (main, length, and
 697  *                      aligned offset, the latter only for LZX_BLOCKTYPE_ALIGNED)
 698  * @queue:      The least-recently-used queue for match offsets.
 699  * @istream:    The input bitstream for the compressed literals.
 700  */
 701 static int lzx_decompress_block(int block_type, int block_size, u8 *window,
 702                                 int window_pos,
 703                                 const struct lzx_tables *tables,
 704                                 struct lru_queue *queue,
 705                                 struct input_bitstream *istream)
 706 {
 707         uint bytes_remaining;
 708         uint main_element;
 709         int match_len;
 710         int ret;
 711
 712         bytes_remaining = block_size;
 713         while (bytes_remaining > 0) {
 714
 715                 ret = read_huffsym_using_maintree(istream, tables,
 716                                                   &main_element);
 717                 if (ret != 0)
 718                         return ret;
 719
 720                 if (main_element < LZX_NUM_CHARS) {
 721                         /* literal: 0 to LZX_NUM_CHARS - 1 */
 722                         window[window_pos + block_size - bytes_remaining] =
 723                                                         main_element;
 724                         bytes_remaining--;
 725                 } else {
 726                         /* match: LZX_NUM_CHARS to LZX_MAINTREE_NUM_SYMBOLS - 1 */
 727                         match_len = lzx_decode_match(main_element,
 728                                                 block_type, bytes_remaining, window,
 729                                                 block_size + window_pos -
 730                                                         bytes_remaining,
 731                                                 tables, queue, istream);
 732                         if (match_len == -1)
 733                                 return 1;
 734
 735                         bytes_remaining -= match_len;
 736                 }
 737         }
 738         return 0;
 739 }
 740
 741 /*
 742  * Decompresses a block of LZX-compressed data using a window size of 32768.
 743  *
 744  * @compressed_data:    A pointer to the compressed data.
 745  * @compressed_len:     The length of the compressed data, in bytes.
 746  * @uncompressed_data:  A pointer to the buffer into which to write the
 747  *                              uncompressed data.
 748  * @uncompressed_len:   The length of the uncompressed data.
 749  *
 750  * Return non-zero on failure.
 751  */
 752 int lzx_decompress(const void *compressed_data, uint compressed_len,
 753                    void *uncompressed_data, uint uncompressed_len)
 754 {
 755         struct lzx_tables       tables;
 756         struct input_bitstream  istream;
 757         struct lru_queue        queue;
 758         uint                    bytes_remaining;
 759         int ret;
 760         int block_size;
 761         int block_type;
 762
 763         LZX_DEBUG("lzx_decompress (compressed_data = %p, compressed_len = %d, "
 764                   "uncompressed_data = %p, uncompressed_len = %d).",
 765                   compressed_data, compressed_len,
 766                   uncompressed_data, uncompressed_len);
 767
 768         wimlib_assert(uncompressed_len <= 32768);
 769
 770         memset(tables.maintree_lens, 0, sizeof(tables.maintree_lens));
 771         memset(tables.lentree_lens, 0, sizeof(tables.lentree_lens));
 772         queue.R0 = 1;
 773         queue.R1 = 1;
 774         queue.R2 = 1;
 775         bytes_remaining = uncompressed_len;
 776
 777         init_input_bitstream(&istream, compressed_data, compressed_len);
 778
 779         /* The compressed data will consist of one or more blocks.  The
 780          * following loop decompresses one block, and it runs until there all
 781          * the compressed data has been decompressed, so there are no more
 782          * blocks.  */
 783
 784         while (bytes_remaining != 0) {
 785
 786                 LZX_DEBUG("Reading block header.");
 787                 ret = lzx_read_block_header(&istream, &block_size, &block_type,
 788                                                         &tables, &queue);
 789                 if (ret != 0)
 790                         return ret;
 791
 792                 LZX_DEBUG("block_size = %d, bytes_remaining = %d.",
 793                           block_size, bytes_remaining);
 794
 795                 if (block_size > bytes_remaining) {
 796                         ERROR("lzx_decompress(): Expected a block size of at "
 797                               "most %d bytes (found %d bytes)",
 798                               bytes_remaining, block_size);
 799                         return 1;
 800                 }
 801
 802                 switch (block_type) {
 803                 case LZX_BLOCKTYPE_VERBATIM:
 804                 case LZX_BLOCKTYPE_ALIGNED:
 805                         if (block_type == LZX_BLOCKTYPE_VERBATIM)
 806                                 LZX_DEBUG("LZX_BLOCKTYPE_VERBATIM");
 807                         else
 808                                 LZX_DEBUG("LZX_BLOCKTYPE_ALIGNED");
 809
 810                         ret = lzx_decompress_block(block_type,
 811                                                    block_size,
 812                                                    uncompressed_data,
 813                                                    uncompressed_len -
 814                                                        bytes_remaining,
 815                                                    &tables, &queue, &istream);
 816                         if (ret != 0)
 817                                 return ret;
 818                         break;
 819                 case LZX_BLOCKTYPE_UNCOMPRESSED:
 820                         LZX_DEBUG("LZX_BLOCKTYPE_UNCOMPRESSED");
 821                         ret = bitstream_read_bytes(&istream, block_size,
 822                                                    uncompressed_data +
 823                                                    uncompressed_len -
 824                                                    bytes_remaining);
 825                         if (ret != 0)
 826                                 return ret;
 827                         if (block_size & 1)
 828                                 align_input_bitstream(&istream, false);
 829                         break;
 830                 default:
 831                         wimlib_assert(0);
 832                         break;
 833                 }
 834
 835                 bytes_remaining -= block_size;
 836
 837                 if (bytes_remaining != 0)
 838                         LZX_DEBUG("%d bytes remaining.", bytes_remaining);
 839
 840         }
 841
 842         if (uncompressed_len >= 10)
 843                 undo_call_insn_preprocessing(uncompressed_data,
 844                                              uncompressed_len);
 845
 846         return 0;
 847 }