wimlib.net Git - wimlib/blob - 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                         ret = read_huffsym_using_pretree(istream,
 268                                                          pretree_decode_table,
 269                                                          pretree_lens,
 270                                                          &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         unsigned block_type;
 317         unsigned block_size;
 318         unsigned s;
 319         unsigned i;
 320         unsigned len;
 321         u32 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) {
 339                 block_size = 32768;
 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                 /* The bitstream of compressed literals and matches for this
 442                  * block directly follows and will be read in
 443                  * lzx_decompress_block(). */
 444                 break;
 445         case LZX_BLOCKTYPE_UNCOMPRESSED:
 446                 LZX_DEBUG("Found uncompressed block.");
 447                 /* Before reading the three LRU match offsets from the
 448                  * uncompressed block header, the stream needs to be aligned on
 449                  * a 16-bit boundary.  But, unexpectedly, if the stream is
 450                  * *already* aligned, the correct thing to do is to throw away
 451                  * the next 16 bits. */
 452                 if (istream->bitsleft == 0) {
 453                         if (istream->data_bytes_left < 14)
 454                                 return -1;
 455                         istream->data += 2;
 456                         istream->data_bytes_left -= 2;
 457                 } else {
 458                         if (istream->data_bytes_left < 12)
 459                                 return -1;
 460                         istream->bitsleft = 0;
 461                         istream->bitbuf = 0;
 462                 }
 463                 queue->R0 = le32_to_cpu(*(u32*)(istream->data + 0));
 464                 queue->R1 = le32_to_cpu(*(u32*)(istream->data + 4));
 465                 queue->R2 = le32_to_cpu(*(u32*)(istream->data + 8));
 466                 istream->data += 12;
 467                 istream->data_bytes_left -= 12;
 468                 /* The uncompressed data of this block directly follows and will
 469                  * be read in lzx_decompress(). */
 470                 break;
 471         default:
 472                 ERROR("lzx_decompress(): Found invalid block");
 473                 return -1;
 474         }
 475         *block_type_ret = block_type;
 476         *block_size_ret = block_size;
 477         return 0;
 478 }
 479
 480 /*
 481  * Decodes a compressed match from a block of LZX-compressed data.  A match
 482  * refers to some match_offset to a point earlier in the window as well as some
 483  * match_len, for which the data is to be copied to the current position in the
 484  * window.
 485  *
 486  * @main_element:       The start of the match data, as decoded using the main
 487  *                      tree.
 488  *
 489  * @block_type:         The type of the block (LZX_BLOCKTYPE_ALIGNED or
 490  *                      LZX_BLOCKTYPE_VERBATIM)
 491  *
 492  * @bytes_remaining:    The amount of uncompressed data remaining to be
 493  *                      uncompressed in this block.  It is an error if the match
 494  *                      is longer than this number.
 495  *
 496  * @window:             A pointer to the window into which the uncompressed
 497  *                      data is being written.
 498  *
 499  * @window_pos:         The current byte offset in the window.
 500  *
 501  * @tables:             The Huffman decoding tables for this LZX block (main
 502  *                      code, length code, and for LZX_BLOCKTYPE_ALIGNED blocks,
 503  *                      also the aligned offset code).
 504  *
 505  * @queue:              The least-recently used queue for match offsets.
 506  *
 507  * @istream:            The input bitstream.
 508  *
 509  * Returns the length of the match, or a negative number on error.  The possible
 510  * error cases are:
 511  *      - Match would exceed the amount of data remaining to be uncompressed.
 512  *      - Match refers to data before the window.
 513  *      - The input bitstream ended unexpectedly.
 514  */
 515 static int lzx_decode_match(unsigned main_element, int block_type,
 516                             unsigned bytes_remaining, u8 *window,
 517                             unsigned window_pos,
 518                             const struct lzx_tables *tables,
 519                             struct lru_queue *queue,
 520                             struct input_bitstream *istream)
 521 {
 522         unsigned length_header;
 523         unsigned position_slot;
 524         unsigned match_len;
 525         unsigned match_offset;
 526         unsigned additional_len;
 527         unsigned num_extra_bits;
 528         unsigned verbatim_bits;
 529         unsigned aligned_bits;
 530         unsigned i;
 531         int ret;
 532         u8 *match_dest;
 533         u8 *match_src;
 534
 535         /* The main element is offset by 256 because values under 256 indicate a
 536          * literal value. */
 537         main_element -= LZX_NUM_CHARS;
 538
 539         /* The length header consists of the lower 3 bits of the main element.
 540          * The position slot is the rest of it. */
 541         length_header = main_element & LZX_NUM_PRIMARY_LENS;
 542         position_slot = main_element >> 3;
 543
 544         /* If the length_header is less than LZX_NUM_PRIMARY_LENS (= 7), it
 545          * gives the match length as the offset from LZX_MIN_MATCH.  Otherwise,
 546          * the length is given by an additional symbol encoded using the length
 547          * tree, offset by 9 (LZX_MIN_MATCH + LZX_NUM_PRIMARY_LENS) */
 548         match_len = LZX_MIN_MATCH + length_header;
 549         if (length_header == LZX_NUM_PRIMARY_LENS) {
 550                 ret = read_huffsym_using_lentree(istream, tables,
 551                                                  &additional_len);
 552                 if (ret != 0)
 553                         return ret;
 554                 match_len += additional_len;
 555         }
 556
 557
 558         /* If the position_slot is 0, 1, or 2, the match offset is retrieved
 559          * from the LRU queue.  Otherwise, the match offset is not in the LRU
 560          * queue. */
 561         switch (position_slot) {
 562         case 0:
 563                 match_offset = queue->R0;
 564                 break;
 565         case 1:
 566                 match_offset = queue->R1;
 567                 swap(queue->R0, queue->R1);
 568                 break;
 569         case 2:
 570                 /* The queue doesn't work quite the same as a real LRU queue,
 571                  * since using the R2 offset doesn't bump the R1 offset down to
 572                  * R2. */
 573                 match_offset = queue->R2;
 574                 swap(queue->R0, queue->R2);
 575                 break;
 576         default:
 577                 /* Otherwise, the offset was not encoded as one the offsets in
 578                  * the queue.  Depending on the position slot, there is a
 579                  * certain number of extra bits that need to be read to fully
 580                  * decode the match offset. */
 581
 582                 /* Look up the number of extra bits that need to be read. */
 583                 num_extra_bits = lzx_get_num_extra_bits(position_slot);
 584
 585                 /* For aligned blocks, if there are at least 3 extra bits, the
 586                  * actual number of extra bits is 3 less, and they encode a
 587                  * number of 8-byte words that are added to the offset; there
 588                  * is then an additional symbol read using the aligned tree that
 589                  * specifies the actual byte alignment. */
 590                 if (block_type == LZX_BLOCKTYPE_ALIGNED && num_extra_bits >= 3) {
 591
 592                         /* There is an error in the LZX "specification" at this
 593                          * point; it indicates that a Huffman symbol is to be
 594                          * read only if num_extra_bits is greater than 3, but
 595                          * actually it is if num_extra_bits is greater than or
 596                          * equal to 3.  (Note that in the case with
 597                          * num_extra_bits == 3, the assignment to verbatim_bits
 598                          * will just set it to 0. ) */
 599                         ret = bitstream_read_bits(istream, num_extra_bits - 3,
 600                                                   &verbatim_bits);
 601                         if (ret != 0)
 602                                 return ret;
 603
 604                         verbatim_bits <<= 3;
 605
 606                         ret = read_huffsym_using_alignedtree(istream, tables,
 607                                                              &aligned_bits);
 608                         if (ret != 0)
 609                                 return ret;
 610                 } else {
 611                         /* For non-aligned blocks, or for aligned blocks with
 612                          * less than 3 extra bits, the extra bits are added
 613                          * directly to the match offset, and the correction for
 614                          * the alignment is taken to be 0. */
 615                         ret = bitstream_read_bits(istream, num_extra_bits,
 616                                                   &verbatim_bits);
 617                         if (ret != 0)
 618                                 return ret;
 619
 620                         aligned_bits = 0;
 621                 }
 622
 623                 /* Calculate the match offset. */
 624                 match_offset = lzx_position_base[position_slot] +
 625                                verbatim_bits + aligned_bits - 2;
 626
 627                 /* Update the LRU queue. */
 628                 queue->R2 = queue->R1;
 629                 queue->R1 = queue->R0;
 630                 queue->R0 = match_offset;
 631                 break;
 632         }
 633
 634         /* Verify that the match is in the bounds of the part of the window
 635          * currently in use, then copy the source of the match to the current
 636          * position. */
 637         match_dest = window + window_pos;
 638         match_src = match_dest - match_offset;
 639
 640         if (match_len > bytes_remaining) {
 641                 ERROR("lzx_decode_match(): Match of length %u bytes overflows "
 642                       "uncompressed block size", match_len);
 643                 return -1;
 644         }
 645
 646         if (match_src < window) {
 647                 ERROR("lzx_decode_match(): Match of length %u bytes references "
 648                       "data before window (match_offset = %u, window_pos = %u)",
 649                       match_len, match_offset, window_pos);
 650                 return -1;
 651         }
 652
 653 #if 0
 654         printf("Match: src %u, dst %u, len %u\n", match_src - window,
 655                                                 match_dest - window,
 656                                                 match_len);
 657         putchar('|');
 658         for (i = 0; i < match_len; i++) {
 659                 match_dest[i] = match_src[i];
 660                 putchar(match_src[i]);
 661         }
 662         putchar('|');
 663         putchar('\n');
 664 #else
 665         for (i = 0; i < match_len; i++)
 666                 match_dest[i] = match_src[i];
 667 #endif
 668
 669         return match_len;
 670 }
 671
 672 static void undo_call_insn_translation(u32 *call_insn_target, int input_pos,
 673                                        int32_t file_size)
 674 {
 675         int32_t abs_offset;
 676         int32_t rel_offset;
 677
 678         abs_offset = le32_to_cpu(*call_insn_target);
 679         if (abs_offset >= -input_pos && abs_offset < file_size) {
 680                 if (abs_offset >= 0) {
 681                         /* "good translation" */
 682                         rel_offset = abs_offset - input_pos;
 683                 } else {
 684                         /* "compensating translation" */
 685                         rel_offset = abs_offset + file_size;
 686                 }
 687                 *call_insn_target = cpu_to_le32(rel_offset);
 688         }
 689 }
 690
 691 /* Undo the 'E8' preprocessing, where the targets of x86 CALL instructions were
 692  * changed from relative offsets to absolute offsets.
 693  *
 694  * Note that this call instruction preprocessing can and will be used on any
 695  * data even if it is not actually x86 machine code.  In fact, this type of
 696  * preprocessing appears to always be used in LZX-compressed resources in WIM
 697  * files; there is no bit to indicate whether it is used or not, unlike in the
 698  * LZX compressed format as used in cabinet files, where a bit is reserved for
 699  * that purpose.
 700  *
 701  * Call instruction preprocessing is disabled in the last 6 bytes of the
 702  * uncompressed data, which really means the 5-byte call instruction cannot
 703  * start in the last 10 bytes of the uncompressed data.  This is one of the
 704  * errors in the LZX documentation.
 705  *
 706  * Call instruction preprocessing does not appear to be disabled after the
 707  * 32768th chunk of a WIM stream, which is apparently is yet another difference
 708  * from the LZX compression used in cabinet files.
 709  *
 710  * Call instruction processing is supposed to take the file size as a parameter,
 711  * as it is used in calculating the translated jump targets.  But in WIM files,
 712  * this file size is always the same (LZX_WIM_MAGIC_FILESIZE == 12000000).*/
 713 static void undo_call_insn_preprocessing(u8 uncompressed_data[],
 714                                          int uncompressed_data_len)
 715 {
 716         for (int i = 0; i < uncompressed_data_len - 10; i++) {
 717                 if (uncompressed_data[i] == 0xe8) {
 718                         undo_call_insn_translation((u32*)&uncompressed_data[i + 1],
 719                                                    i,
 720                                                    LZX_WIM_MAGIC_FILESIZE);
 721                         i += 4;
 722                 }
 723         }
 724 }
 725
 726 /*
 727  * Decompresses a LZX-compressed block of data from which the header has already
 728  * been read.
 729  *
 730  * @block_type: The type of the block (LZX_BLOCKTYPE_VERBATIM or
 731  *              LZX_BLOCKTYPE_ALIGNED)
 732  * @block_size: The size of the block, in bytes.
 733  * @window:     Pointer to the decompression window.
 734  * @window_pos: The current position in the window.  Will be 0 for the first
 735  *                      block.
 736  * @tables:     The Huffman decoding tables for the block (main, length, and
 737  *                      aligned offset, the latter only for LZX_BLOCKTYPE_ALIGNED)
 738  * @queue:      The least-recently-used queue for match offsets.
 739  * @istream:    The input bitstream for the compressed literals.
 740  */
 741 static int lzx_decompress_block(int block_type, unsigned block_size,
 742                                 u8 *window,
 743                                 unsigned window_pos,
 744                                 const struct lzx_tables *tables,
 745                                 struct lru_queue *queue,
 746                                 struct input_bitstream *istream)
 747 {
 748         unsigned main_element;
 749         unsigned end;
 750         int match_len;
 751         int ret = 0;
 752
 753         end = window_pos + block_size;
 754         while (window_pos < end) {
 755                 ret = read_huffsym_using_maintree(istream, tables,
 756                                                   &main_element);
 757                 if (ret != 0)
 758                         break;
 759
 760                 if (main_element < LZX_NUM_CHARS) {
 761                         /* literal: 0 to LZX_NUM_CHARS - 1 */
 762                         window[window_pos++] = main_element;
 763                 } else {
 764                         /* match: LZX_NUM_CHARS to LZX_MAINTREE_NUM_SYMBOLS - 1 */
 765                         ret = lzx_decode_match(main_element,
 766                                                block_type,
 767                                                end - window_pos,
 768                                                window,
 769                                                window_pos,
 770                                                tables,
 771                                                queue,
 772                                                istream);
 773                         if (ret < 0)
 774                                 break;
 775                         window_pos += ret;
 776                 }
 777         }
 778         return 0;
 779 }
 780
 781 /*
 782  * Decompresses a block of LZX-compressed data as used in the WIM file format.
 783  *
 784  * Note that this will NOT work unmodified for LZX as used in the cabinet
 785  * format, which is not the same as in the WIM format!
 786  *
 787  * @compressed_data:    A pointer to the compressed data.
 788  *
 789  * @compressed_len:     The length of the compressed data, in bytes.
 790  *
 791  * @uncompressed_data:  A pointer to the buffer into which to write the
 792  *                      uncompressed data.
 793  *
 794  * @uncompressed_len:   The length of the uncompressed data.  It must be
 795  *                      32768 bytes or less.
 796  *
 797  * Return 0 on success; non-zero on failure.
 798  */
 799 int lzx_decompress(const void *compressed_data, unsigned compressed_len,
 800                    void *uncompressed_data, unsigned uncompressed_len)
 801 {
 802         struct lzx_tables tables;
 803         struct input_bitstream istream;
 804         struct lru_queue queue;
 805         unsigned window_pos;
 806         unsigned block_size;
 807         unsigned block_type;
 808         int ret;
 809         bool e8_preprocessing_done;
 810
 811         LZX_DEBUG("lzx_decompress (compressed_data = %p, compressed_len = %d, "
 812                   "uncompressed_data = %p, uncompressed_len = %d).",
 813                   compressed_data, compressed_len,
 814                   uncompressed_data, uncompressed_len);
 815
 816         wimlib_assert(uncompressed_len <= 32768);
 817
 818         memset(tables.maintree_lens, 0, sizeof(tables.maintree_lens));
 819         memset(tables.lentree_lens, 0, sizeof(tables.lentree_lens));
 820         queue.R0 = 1;
 821         queue.R1 = 1;
 822         queue.R2 = 1;
 823         init_input_bitstream(&istream, compressed_data, compressed_len);
 824
 825         e8_preprocessing_done = false; /* Set to true if there may be 0xe8 bytes
 826                                           in the uncompressed data. */
 827
 828         /* The compressed data will consist of one or more blocks.  The
 829          * following loop decompresses one block, and it runs until there all
 830          * the compressed data has been decompressed, so there are no more
 831          * blocks.  */
 832
 833         for (window_pos = 0;
 834              window_pos < uncompressed_len;
 835              window_pos += block_size)
 836         {
 837                 LZX_DEBUG("Reading block header.");
 838                 ret = lzx_read_block_header(&istream, &block_size,
 839                                             &block_type, &tables, &queue);
 840                 if (ret != 0)
 841                         return ret;
 842
 843                 LZX_DEBUG("block_size = %u, window_pos = %u",
 844                           block_size, window_pos);
 845
 846                 if (block_size > uncompressed_len - window_pos) {
 847                         ERROR("lzx_decompress(): Expected a block size of at "
 848                               "most %u bytes (found %u bytes)",
 849                               uncompressed_len - window_pos, block_size);
 850                         return -1;
 851                 }
 852
 853                 switch (block_type) {
 854                 case LZX_BLOCKTYPE_VERBATIM:
 855                 case LZX_BLOCKTYPE_ALIGNED:
 856                         if (block_type == LZX_BLOCKTYPE_VERBATIM)
 857                                 LZX_DEBUG("LZX_BLOCKTYPE_VERBATIM");
 858                         else
 859                                 LZX_DEBUG("LZX_BLOCKTYPE_ALIGNED");
 860                         ret = lzx_decompress_block(block_type,
 861                                                    block_size,
 862                                                    uncompressed_data,
 863                                                    window_pos,
 864                                                    &tables,
 865                                                    &queue,
 866                                                    &istream);
 867                         if (ret != 0)
 868                                 return ret;
 869                         if (tables.maintree_lens[0xe8] != 0)
 870                                 e8_preprocessing_done = true;
 871                         break;
 872                 case LZX_BLOCKTYPE_UNCOMPRESSED:
 873                         LZX_DEBUG("LZX_BLOCKTYPE_UNCOMPRESSED");
 874                         if (istream.data_bytes_left < block_size) {
 875                                 ERROR("Unexpected end of input when "
 876                                       "reading %zu bytes from LZX bitstream "
 877                                       "(only have %u bytes left)",
 878                                       block_size, istream.data_bytes_left);
 879                                 return -1;
 880                         }
 881                         memcpy(&((u8*)uncompressed_data)[window_pos], istream.data,
 882                                block_size);
 883                         istream.data += block_size;
 884                         istream.data_bytes_left -= block_size;
 885                         /* Re-align bitstream if an odd number of bytes were
 886                          * read.  */
 887                         if (istream.data_bytes_left && (block_size & 1)) {
 888                                 istream.data_bytes_left--;
 889                                 istream.data++;
 890                         }
 891                         e8_preprocessing_done = true;
 892                         break;
 893                 }
 894         }
 895         if (e8_preprocessing_done)
 896                 undo_call_insn_preprocessing(uncompressed_data, uncompressed_len);
 897         return 0;
 898 }