f2fcb60ebcd94b10f78c02207df6ec9926e50dcb
[wimlib] / src / lzms-decompress.c
1 /*
2  * lzms-decompress.c
3  */
4
5 /*
6  * Copyright (C) 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option)
13  * any later version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
22  */
23
24 /*
25  * This is a decompressor for the LZMS compression format used by Microsoft.
26  * This format is not documented, but it is one of the formats supported by the
27  * compression API available in Windows 8, and as of Windows 8 it is one of the
28  * formats that can be used in WIM files.
29  *
30  * This decompressor only implements "raw" decompression, which decompresses a
31  * single LZMS-compressed block.  This behavior is the same as that of
32  * Decompress() in the Windows 8 compression API when using a compression handle
33  * created with CreateDecompressor() with the Algorithm parameter specified as
34  * COMPRESS_ALGORITHM_LZMS | COMPRESS_RAW.  Presumably, non-raw LZMS data
35  * is a container format from which the locations and sizes (both compressed and
36  * uncompressed) of the constituent blocks can be determined.
37  *
38  * A LZMS-compressed block must be read in 16-bit little endian units from both
39  * directions.  One logical bitstream starts at the front of the block and
40  * proceeds forwards.  Another logical bitstream starts at the end of the block
41  * and proceeds backwards.  Bits read from the forwards bitstream constitute
42  * range-encoded data, whereas bits read from the backwards bitstream constitute
43  * Huffman-encoded symbols or verbatim bits.  For both bitstreams, the ordering
44  * of the bits within the 16-bit coding units is such that the first bit is the
45  * high-order bit and the last bit is the low-order bit.
46  *
47  * From these two logical bitstreams, an LZMS decompressor can reconstitute the
48  * series of items that make up the LZMS data representation.  Each such item
49  * may be a literal byte or a match.  Matches may be either traditional LZ77
50  * matches or "delta" matches, either of which can have its offset encoded
51  * explicitly or encoded via a reference to a recently used (repeat) offset.
52  *
53  * A traditional LZ match consists of a length and offset; it asserts that the
54  * sequence of bytes beginning at the current position and extending for the
55  * length is exactly equal to the equal-length sequence of bytes at the offset
56  * back in the window.  On the other hand, a delta match consists of a length,
57  * raw offset, and power.  It asserts that the sequence of bytes beginning at
58  * the current position and extending for the length is equal to the bytewise
59  * sum of the two equal-length sequences of bytes (2**power) and (raw_offset *
60  * 2**power) bytes before the current position, minus bytewise the sequence of
61  * bytes beginning at (2**power + raw_offset * 2**power) bytes before the
62  * current position.  Although not generally as useful as traditional LZ
63  * matches, delta matches can be helpful on some types of data.  Both LZ and
64  * delta matches may overlap with the current position; in fact, the minimum
65  * offset is 1, regardless of match length.
66  *
67  * For LZ matches, up to 3 repeat offsets are allowed, similar to some other
68  * LZ-based formats such as LZX and LZMA.  They must updated in a LRU fashion,
69  * except for a quirk: updates to the queue must be delayed by one LZMS item,
70  * except for the removal of a repeat match.  As a result, 4 entries are
71  * actually needed in the queue, even though it is only possible to decode
72  * references to the first 3 at any given time.  The queue must be initialized
73  * to the offsets {1, 2, 3, 4}.
74  *
75  * Repeat delta matches are handled similarly, but for them there are two queues
76  * updated in lock-step: one for powers and one for raw offsets.  The power
77  * queue must be initialized to {0, 0, 0, 0}, and the raw offset queue must be
78  * initialized to {1, 2, 3, 4}.
79  *
80  * Bits from the range decoder must be used to disambiguate item types.  The
81  * range decoder must hold two state variables: the range, which must initially
82  * be set to 0xffffffff, and the current code, which must initially be set to
83  * the first 32 bits read from the forwards bitstream.  The range must be
84  * maintained above 0xffff; when it falls below 0xffff, both the range and code
85  * must be left-shifted by 16 bits and the low 16 bits of the code must be
86  * filled in with the next 16 bits from the forwards bitstream.
87  *
88  * To decode each bit, the range decoder requires a probability that is
89  * logically a real number between 0 and 1.  Multiplying this probability by the
90  * current range and taking the floor gives the bound between the 0-bit region
91  * of the range and the 1-bit region of the range.  However, in LZMS,
92  * probabilities are restricted to values of n/64 where n is an integer is
93  * between 1 and 63 inclusively, so the implementation may use integer
94  * operations instead.  Following calculation of the bound, if the current code
95  * is in the 0-bit region, the new range becomes the current code and the
96  * decoded bit is 0; otherwise, the bound must be subtracted from both the range
97  * and the code, and the decoded bit is 1.  More information about range coding
98  * can be found at https://en.wikipedia.org/wiki/Range_encoding.  Furthermore,
99  * note that the LZMA format also uses range coding and has public domain code
100  * available for it.
101  *
102  * The probability used to range-decode each bit must be taken from a table, of
103  * which one instance must exist for each distinct context in which a
104  * range-decoded bit is needed.  At each call of the range decoder, the
105  * appropriate probability must be obtained by indexing the appropriate
106  * probability table with the last 4 (in the context disambiguating literals
107  * from matches), 5 (in the context disambiguating LZ matches from delta
108  * matches), or 6 (in all other contexts) bits recently range-decoded in that
109  * context, ordered such that the most recently decoded bit is the low-order bit
110  * of the index.
111  *
112  * Furthermore, each probability entry itself is variable, as its value must be
113  * maintained as n/64 where n is the number of 0 bits in the most recently
114  * decoded 64 bits with that same entry.  This allows the compressed
115  * representation to adapt to the input and use fewer bits to represent the most
116  * likely data; note that LZMA uses a similar scheme.  Initially, the most
117  * recently 64 decoded bits for each probability entry are assumed to be
118  * 0x0000000055555555 (high order to low order); therefore, all probabilities
119  * are initially 48/64.  During the course of decoding, each probability may be
120  * updated to as low as 0/64 (as a result of reading many consecutive 1 bits
121  * with that entry) or as high as 64/64 (as a result of reading many consecutive
122  * 0 bits with that entry); however, probabilities of 0/64 and 64/64 cannot be
123  * used as-is but rather must be adjusted to 1/64 and 63/64, respectively,
124  * before being used for range decoding.
125  *
126  * Representations of the LZMS items themselves must be read from the backwards
127  * bitstream.  For this, there are 5 different Huffman codes used:
128  *
129  *  - The literal code, used for decoding literal bytes.  Each of the 256
130  *    symbols represents a literal byte.  This code must be rebuilt whenever
131  *    1024 symbols have been decoded with it.
132  *
133  *  - The LZ offset code, used for decoding the offsets of standard LZ77
134  *    matches.  Each symbol represents a position slot, which corresponds to a
135  *    base value and some number of extra bits which must be read and added to
136  *    the base value to reconstitute the full offset.  The number of symbols in
137  *    this code is the number of position slots needed to represent all possible
138  *    offsets in the uncompressed block.  This code must be rebuilt whenever
139  *    1024 symbols have been decoded with it.
140  *
141  *  - The length code, used for decoding length symbols.  Each of the 54 symbols
142  *    represents a length slot, which corresponds to a base value and some
143  *    number of extra bits which must be read and added to the base value to
144  *    reconstitute the full length.  This code must be rebuilt whenever 512
145  *    symbols have been decoded with it.
146  *
147  *  - The delta offset code, used for decoding the offsets of delta matches.
148  *    Each symbol corresponds to a position slot, which corresponds to a base
149  *    value and some number of extra bits which must be read and added to the
150  *    base value to reconstitute the full offset.  The number of symbols in this
151  *    code is equal to the number of symbols in the LZ offset code.  This code
152  *    must be rebuilt whenever 1024 symbols have been decoded with it.
153  *
154  *  - The delta power code, used for decoding the powers of delta matches.  Each
155  *    of the 8 symbols corresponds to a power.  This code must be rebuilt
156  *    whenever 512 symbols have been decoded with it.
157  *
158  * All the LZMS Huffman codes must be built adaptively based on symbol
159  * frequencies.  Initially, each code must be built assuming that all symbols
160  * have equal frequency.  Following that, each code must be rebuilt whenever a
161  * certain number of symbols has been decoded with it.
162  *
163  * In general, multiple valid Huffman codes can be constructed from a set of
164  * symbol frequencies.  Like other compression formats such as XPRESS, LZX, and
165  * DEFLATE, the LZMS format solves this ambiguity by requiring that all Huffman
166  * codes be constructed in canonical form.  This form requires that same-length
167  * codewords be lexicographically ordered the same way as the corresponding
168  * symbols and that all shorter codewords lexicographically precede longer
169  * codewords.
170  *
171  * Codewords in all the LZMS Huffman codes are limited to 15 bits.  If the
172  * canonical code for a given set of symbol frequencies has any codewords longer
173  * than 15 bits, then all frequencies must be divided by 2, rounding up, and the
174  * code construction must be attempted again.
175  *
176  * A LZMS-compressed block seemingly cannot have a compressed size greater than
177  * or equal to the uncompressed size.  In such cases the block must be stored
178  * uncompressed.
179  *
180  * After all LZMS items have been decoded, the data must be postprocessed to
181  * translate absolute address encoded in x86 instructions into their original
182  * relative addresses.
183  *
184  * Details omitted above can be found in the code.  Note that in the absence of
185  * an official specification there is no guarantee that this decompressor
186  * handles all possible cases.
187  */
188
189 #ifdef HAVE_CONFIG_H
190 #  include "config.h"
191 #endif
192
193 #include "wimlib.h"
194 #include "wimlib/compress_common.h"
195 #include "wimlib/decompressor_ops.h"
196 #include "wimlib/decompress_common.h"
197 #include "wimlib/error.h"
198 #include "wimlib/lzms.h"
199 #include "wimlib/util.h"
200
201 #include <limits.h>
202
203 #define LZMS_DECODE_TABLE_BITS  10
204
205 /* Structure used for range decoding, reading bits forwards.  This is the first
206  * logical bitstream mentioned above.  */
207 struct lzms_range_decoder_raw {
208         /* The relevant part of the current range.  Although the logical range
209          * for range decoding is a very large integer, only a small portion
210          * matters at any given time, and it can be normalized (shifted left)
211          * whenever it gets too small.  */
212         u32 range;
213
214         /* The current position in the range encoded by the portion of the input
215          * read so far.  */
216         u32 code;
217
218         /* Pointer to the next little-endian 16-bit integer in the compressed
219          * input data (reading forwards).  */
220         const le16 *in;
221
222         /* Number of 16-bit integers remaining in the compressed input data
223          * (reading forwards).  */
224         size_t num_le16_remaining;
225 };
226
227 /* Structure used for reading raw bits backwards.  This is the second logical
228  * bitstream mentioned above.  */
229 struct lzms_input_bitstream {
230         /* Holding variable for bits that have been read from the compressed
231          * data.  The bits are ordered from high-order to low-order.  */
232         /* XXX:  Without special-case code to handle reading more than 17 bits
233          * at a time, this needs to be 64 bits rather than 32 bits.  */
234         u64 bitbuf;
235
236         /* Number of bits in @bitbuf that are are used.  */
237         unsigned num_filled_bits;
238
239         /* Pointer to the one past the next little-endian 16-bit integer in the
240          * compressed input data (reading backwards).  */
241         const le16 *in;
242
243         /* Number of 16-bit integers remaining in the compressed input data
244          * (reading backwards).  */
245         size_t num_le16_remaining;
246 };
247
248 /* Structure used for range decoding.  This wraps around `struct
249  * lzms_range_decoder_raw' to use and maintain probability entries.  */
250 struct lzms_range_decoder {
251         /* Pointer to the raw range decoder, which has no persistent knowledge
252          * of probabilities.  Multiple lzms_range_decoder's share the same
253          * lzms_range_decoder_raw.  */
254         struct lzms_range_decoder_raw *rd;
255
256         /* Bits recently decoded by this range decoder.  This are used as in
257          * index into @prob_entries.  */
258         u32 state;
259
260         /* Bitmask for @state to prevent its value from exceeding the number of
261          * probability entries.  */
262         u32 mask;
263
264         /* Probability entries being used for this range decoder.  */
265         struct lzms_probability_entry prob_entries[LZMS_MAX_NUM_STATES];
266 };
267
268 /* Structure used for Huffman decoding, optionally using the decoded symbols as
269  * slots into a base table to determine how many extra bits need to be read to
270  * reconstitute the full value.  */
271 struct lzms_huffman_decoder {
272
273         /* Bitstream to read Huffman-encoded symbols and verbatim bits from.
274          * Multiple lzms_huffman_decoder's share the same lzms_input_bitstream.
275          */
276         struct lzms_input_bitstream *is;
277
278         /* Pointer to the slot base table to use.  It is indexed by the decoded
279          * Huffman symbol that specifies the slot.  The entry specifies the base
280          * value to use, and the position of its high bit is the number of
281          * additional bits that must be read to reconstitute the full value.
282          *
283          * This member need not be set if only raw Huffman symbols are being
284          * read using this decoder.  */
285         const u32 *slot_base_tab;
286
287         /* Number of symbols that have been read using this code far.  Reset to
288          * 0 whenever the code is rebuilt.  */
289         u32 num_syms_read;
290
291         /* When @num_syms_read reaches this number, the Huffman code must be
292          * rebuilt.  */
293         u32 rebuild_freq;
294
295         /* Number of symbols in the represented Huffman code.  */
296         unsigned num_syms;
297
298         /* Running totals of symbol frequencies.  These are diluted slightly
299          * whenever the code is rebuilt.  */
300         u32 sym_freqs[LZMS_MAX_NUM_SYMS];
301
302         /* The length, in bits, of each symbol in the Huffman code.  */
303         u8 lens[LZMS_MAX_NUM_SYMS];
304
305         /* The codeword of each symbol in the Huffman code.  */
306         u16 codewords[LZMS_MAX_NUM_SYMS];
307
308         /* A table for quickly decoding symbols encoded using the Huffman code.
309          */
310         u16 decode_table[(1U << LZMS_DECODE_TABLE_BITS) + 2 * LZMS_MAX_NUM_SYMS]
311                                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
312 };
313
314 /* State of the LZMS decompressor.  */
315 struct lzms_decompressor {
316
317         /* Pointer to the beginning of the uncompressed data buffer.  */
318         u8 *out_begin;
319
320         /* Pointer to the next position in the uncompressed data buffer.  */
321         u8 *out_next;
322
323         /* Pointer to one past the end of the uncompressed data buffer.  */
324         u8 *out_end;
325
326         /* Range decoder, which reads bits from the beginning of the compressed
327          * block, going forwards.  */
328         struct lzms_range_decoder_raw rd;
329
330         /* Input bitstream, which reads from the end of the compressed block,
331          * going backwards.  */
332         struct lzms_input_bitstream is;
333
334         /* Range decoders.  */
335         struct lzms_range_decoder main_range_decoder;
336         struct lzms_range_decoder match_range_decoder;
337         struct lzms_range_decoder lz_match_range_decoder;
338         struct lzms_range_decoder lz_repeat_match_range_decoders[LZMS_NUM_RECENT_OFFSETS - 1];
339         struct lzms_range_decoder delta_match_range_decoder;
340         struct lzms_range_decoder delta_repeat_match_range_decoders[LZMS_NUM_RECENT_OFFSETS - 1];
341
342         /* Huffman decoders.  */
343         struct lzms_huffman_decoder literal_decoder;
344         struct lzms_huffman_decoder lz_offset_decoder;
345         struct lzms_huffman_decoder length_decoder;
346         struct lzms_huffman_decoder delta_power_decoder;
347         struct lzms_huffman_decoder delta_offset_decoder;
348
349         /* LRU (least-recently-used) queues for match information.  */
350         struct lzms_lru_queues lru;
351
352         /* Used for postprocessing.  */
353         s32 last_target_usages[65536];
354 };
355
356 /* Initialize the input bitstream @is to read forwards from the specified
357  * compressed data buffer @in that is @in_limit 16-bit integers long.  */
358 static void
359 lzms_input_bitstream_init(struct lzms_input_bitstream *is,
360                           const le16 *in, size_t in_limit)
361 {
362         is->bitbuf = 0;
363         is->num_filled_bits = 0;
364         is->in = in + in_limit;
365         is->num_le16_remaining = in_limit;
366 }
367
368 /* Ensures that @num_bits bits are buffered in the input bitstream.  */
369 static int
370 lzms_input_bitstream_ensure_bits(struct lzms_input_bitstream *is,
371                                  unsigned num_bits)
372 {
373         while (is->num_filled_bits < num_bits) {
374                 u64 next;
375
376                 LZMS_ASSERT(is->num_filled_bits + 16 <= sizeof(is->bitbuf) * 8);
377
378                 if (unlikely(is->num_le16_remaining == 0))
379                         return -1;
380
381                 next = le16_to_cpu(*--is->in);
382                 is->num_le16_remaining--;
383
384                 is->bitbuf |= next << (sizeof(is->bitbuf) * 8 - is->num_filled_bits - 16);
385                 is->num_filled_bits += 16;
386         }
387         return 0;
388
389 }
390
391 /* Returns the next @num_bits bits that are buffered in the input bitstream.  */
392 static u32
393 lzms_input_bitstream_peek_bits(struct lzms_input_bitstream *is,
394                                unsigned num_bits)
395 {
396         LZMS_ASSERT(is->num_filled_bits >= num_bits);
397         return is->bitbuf >> (sizeof(is->bitbuf) * 8 - num_bits);
398 }
399
400 /* Removes the next @num_bits bits that are buffered in the input bitstream.  */
401 static void
402 lzms_input_bitstream_remove_bits(struct lzms_input_bitstream *is,
403                                  unsigned num_bits)
404 {
405         LZMS_ASSERT(is->num_filled_bits >= num_bits);
406         is->bitbuf <<= num_bits;
407         is->num_filled_bits -= num_bits;
408 }
409
410 /* Removes and returns the next @num_bits bits that are buffered in the input
411  * bitstream.  */
412 static u32
413 lzms_input_bitstream_pop_bits(struct lzms_input_bitstream *is,
414                               unsigned num_bits)
415 {
416         u32 bits = lzms_input_bitstream_peek_bits(is, num_bits);
417         lzms_input_bitstream_remove_bits(is, num_bits);
418         return bits;
419 }
420
421 /* Reads the next @num_bits from the input bitstream.  */
422 static u32
423 lzms_input_bitstream_read_bits(struct lzms_input_bitstream *is,
424                                unsigned num_bits)
425 {
426         if (unlikely(lzms_input_bitstream_ensure_bits(is, num_bits)))
427                 return 0;
428         return lzms_input_bitstream_pop_bits(is, num_bits);
429 }
430
431 /* Initialize the range decoder @rd to read forwards from the specified
432  * compressed data buffer @in that is @in_limit 16-bit integers long.  */
433 static void
434 lzms_range_decoder_raw_init(struct lzms_range_decoder_raw *rd,
435                             const le16 *in, size_t in_limit)
436 {
437         rd->range = 0xffffffff;
438         rd->code = ((u32)le16_to_cpu(in[0]) << 16) |
439                    ((u32)le16_to_cpu(in[1]) <<  0);
440         rd->in = in + 2;
441         rd->num_le16_remaining = in_limit - 2;
442 }
443
444 /* Ensures the current range of the range decoder has at least 16 bits of
445  * precision.  */
446 static int
447 lzms_range_decoder_raw_normalize(struct lzms_range_decoder_raw *rd)
448 {
449         if (rd->range <= 0xffff) {
450                 rd->range <<= 16;
451                 if (unlikely(rd->num_le16_remaining == 0))
452                         return -1;
453                 rd->code = (rd->code << 16) | le16_to_cpu(*rd->in++);
454                 rd->num_le16_remaining--;
455         }
456         return 0;
457 }
458
459 /* Decode and return the next bit from the range decoder (raw version).
460  *
461  * @prob is the chance out of LZMS_PROBABILITY_MAX that the next bit is 0.
462  */
463 static int
464 lzms_range_decoder_raw_decode_bit(struct lzms_range_decoder_raw *rd, u32 prob)
465 {
466         u32 bound;
467
468         /* Ensure the range has at least 16 bits of precision.  */
469         lzms_range_decoder_raw_normalize(rd);
470
471         /* Based on the probability, calculate the bound between the 0-bit
472          * region and the 1-bit region of the range.  */
473         bound = (rd->range >> LZMS_PROBABILITY_BITS) * prob;
474
475         if (rd->code < bound) {
476                 /* Current code is in the 0-bit region of the range.  */
477                 rd->range = bound;
478                 return 0;
479         } else {
480                 /* Current code is in the 1-bit region of the range.  */
481                 rd->range -= bound;
482                 rd->code -= bound;
483                 return 1;
484         }
485 }
486
487 /* Decode and return the next bit from the range decoder.  This wraps around
488  * lzms_range_decoder_raw_decode_bit() to handle using and updating the
489  * appropriate probability table.  */
490 static int
491 lzms_range_decode_bit(struct lzms_range_decoder *dec)
492 {
493         struct lzms_probability_entry *prob_entry;
494         u32 prob;
495         int bit;
496
497         /* Load the probability entry corresponding to the current state.  */
498         prob_entry = &dec->prob_entries[dec->state];
499
500         /* Treat the number of zero bits in the most recently decoded
501          * LZMS_PROBABILITY_MAX bits with this probability entry as the chance,
502          * out of LZMS_PROBABILITY_MAX, that the next bit will be a 0.  However,
503          * don't allow 0% or 100% probabilities.  */
504         prob = prob_entry->num_recent_zero_bits;
505         if (prob == LZMS_PROBABILITY_MAX)
506                 prob = LZMS_PROBABILITY_MAX - 1;
507         else if (prob == 0)
508                 prob = 1;
509
510         /* Decode the next bit.  */
511         bit = lzms_range_decoder_raw_decode_bit(dec->rd, prob);
512
513         /* Update the state based on the newly decoded bit.  */
514         dec->state = (((dec->state << 1) | bit) & dec->mask);
515
516         /* Update the recent bits, including the cached count of 0's.  */
517         BUILD_BUG_ON(LZMS_PROBABILITY_MAX > sizeof(prob_entry->recent_bits) * 8);
518         if (bit == 0) {
519                 if (prob_entry->recent_bits & (1ULL << (LZMS_PROBABILITY_MAX - 1))) {
520                         /* Replacing 1 bit with 0 bit; increment the zero count.
521                          */
522                         prob_entry->num_recent_zero_bits++;
523                 }
524         } else {
525                 if (!(prob_entry->recent_bits & (1ULL << (LZMS_PROBABILITY_MAX - 1)))) {
526                         /* Replacing 0 bit with 1 bit; decrement the zero count.
527                          */
528                         prob_entry->num_recent_zero_bits--;
529                 }
530         }
531         prob_entry->recent_bits = (prob_entry->recent_bits << 1) | bit;
532
533         /* Return the decoded bit.  */
534         return bit;
535 }
536
537
538 /* Build the decoding table for a new adaptive Huffman code using the alphabet
539  * used in the specified Huffman decoder, with the symbol frequencies
540  * dec->sym_freqs.  */
541 static void
542 lzms_rebuild_adaptive_huffman_code(struct lzms_huffman_decoder *dec)
543 {
544
545         /* XXX:  This implementation makes use of code already implemented for
546          * the XPRESS and LZX compression formats.  However, since for the
547          * adaptive codes used in LZMS we don't actually need the explicit codes
548          * themselves, only the decode tables, it may be possible to optimize
549          * this by somehow directly building or updating the Huffman decode
550          * table.  This may be a worthwhile optimization because the adaptive
551          * codes change many times throughout a decompression run.  */
552         LZMS_DEBUG("Rebuilding adaptive Huffman code (num_syms=%u)",
553                    dec->num_syms);
554         make_canonical_huffman_code(dec->num_syms, LZMS_MAX_CODEWORD_LEN,
555                                     dec->sym_freqs, dec->lens, dec->codewords);
556 #if defined(ENABLE_LZMS_DEBUG)
557         int ret =
558 #endif
559         make_huffman_decode_table(dec->decode_table, dec->num_syms,
560                                   LZMS_DECODE_TABLE_BITS, dec->lens,
561                                   LZMS_MAX_CODEWORD_LEN);
562         LZMS_ASSERT(ret == 0);
563 }
564
565 /* Decode and return the next Huffman-encoded symbol from the LZMS-compressed
566  * block using the specified Huffman decoder.  */
567 static u32
568 lzms_huffman_decode_symbol(struct lzms_huffman_decoder *dec)
569 {
570         const u8 *lens = dec->lens;
571         const u16 *decode_table = dec->decode_table;
572         struct lzms_input_bitstream *is = dec->is;
573
574         /* The Huffman codes used in LZMS are adaptive and must be rebuilt
575          * whenever a certain number of symbols have been read.  Each such
576          * rebuild uses the current symbol frequencies, but the format also
577          * requires that the symbol frequencies be halved after each code
578          * rebuild.  This diminishes the effect of old symbols on the current
579          * Huffman codes, thereby causing the Huffman codes to be more locally
580          * adaptable.  */
581         if (dec->num_syms_read == dec->rebuild_freq) {
582                 lzms_rebuild_adaptive_huffman_code(dec);
583                 for (unsigned i = 0; i < dec->num_syms; i++) {
584                         dec->sym_freqs[i] >>= 1;
585                         dec->sym_freqs[i] += 1;
586                 }
587                 dec->num_syms_read = 0;
588         }
589
590         /* In the following Huffman decoding implementation, the first
591          * LZMS_DECODE_TABLE_BITS of the input are used as an offset into a
592          * decode table.  The entry will either provide the decoded symbol
593          * directly, or else a "real" Huffman binary tree will be searched to
594          * decode the symbol.  */
595
596         lzms_input_bitstream_ensure_bits(is, LZMS_MAX_CODEWORD_LEN);
597
598         u16 key_bits = lzms_input_bitstream_peek_bits(is, LZMS_DECODE_TABLE_BITS);
599         u16 sym = decode_table[key_bits];
600
601         if (sym < dec->num_syms) {
602                 /* Fast case: The decode table directly provided the symbol.  */
603                 lzms_input_bitstream_remove_bits(is, lens[sym]);
604         } else {
605                 /* Slow case: The symbol took too many bits to include directly
606                  * in the decode table, so search for it in a binary tree at the
607                  * end of the decode table.  */
608                 lzms_input_bitstream_remove_bits(is, LZMS_DECODE_TABLE_BITS);
609                 do {
610                         key_bits = sym + lzms_input_bitstream_pop_bits(is, 1);
611                 } while ((sym = decode_table[key_bits]) >= dec->num_syms);
612         }
613
614         /* Tally and return the decoded symbol.  */
615         ++dec->sym_freqs[sym];
616         ++dec->num_syms_read;
617         return sym;
618 }
619
620 /* Decode a number from the LZMS bitstream, encoded as a Huffman-encoded symbol
621  * specifying a "slot" (whose corresponding value is looked up in a static
622  * table) plus the number specified by a number of extra bits depending on the
623  * slot.  */
624 static u32
625 lzms_decode_value(struct lzms_huffman_decoder *dec)
626 {
627         unsigned slot;
628         unsigned num_extra_bits;
629         u32 extra_bits;
630
631         /* Read the slot (position slot, length slot, etc.), which is encoded as
632          * a Huffman symbol.  */
633         slot = lzms_huffman_decode_symbol(dec);
634
635         LZMS_ASSERT(dec->slot_base_tab != NULL);
636
637         /* Get the number of extra bits needed to represent the range of values
638          * that share the slot.  */
639         num_extra_bits = bsr32(dec->slot_base_tab[slot + 1] -
640                                dec->slot_base_tab[slot]);
641
642         /* Read the number of extra bits and add them to the slot to form the
643          * final decoded value.  */
644         extra_bits = lzms_input_bitstream_read_bits(dec->is, num_extra_bits);
645         return dec->slot_base_tab[slot] + extra_bits;
646 }
647
648 /* Copy a literal to the output buffer.  */
649 static int
650 lzms_copy_literal(struct lzms_decompressor *ctx, u8 literal)
651 {
652         *ctx->out_next++ = literal;
653         return 0;
654 }
655
656 /* Validate an LZ match and copy it to the output buffer.  */
657 static int
658 lzms_copy_lz_match(struct lzms_decompressor *ctx, u32 length, u32 offset)
659 {
660         u8 *out_next;
661         u8 *matchptr;
662
663         if (length > ctx->out_end - ctx->out_next) {
664                 LZMS_DEBUG("Match overrun!");
665                 return -1;
666         }
667         if (offset > ctx->out_next - ctx->out_begin) {
668                 LZMS_DEBUG("Match underrun!");
669                 return -1;
670         }
671
672         out_next = ctx->out_next;
673         matchptr = out_next - offset;
674         while (length--)
675                 *out_next++ = *matchptr++;
676
677         ctx->out_next = out_next;
678         return 0;
679 }
680
681 /* Validate a delta match and copy it to the output buffer.  */
682 static int
683 lzms_copy_delta_match(struct lzms_decompressor *ctx, u32 length,
684                       u32 power, u32 raw_offset)
685 {
686         u32 offset1 = 1U << power;
687         u32 offset2 = raw_offset << power;
688         u32 offset = offset1 + offset2;
689         u8 *out_next;
690         u8 *matchptr1;
691         u8 *matchptr2;
692         u8 *matchptr;
693
694         if (length > ctx->out_end - ctx->out_next) {
695                 LZMS_DEBUG("Match overrun!");
696                 return -1;
697         }
698         if (offset > ctx->out_next - ctx->out_begin) {
699                 LZMS_DEBUG("Match underrun!");
700                 return -1;
701         }
702
703         out_next = ctx->out_next;
704         matchptr1 = out_next - offset1;
705         matchptr2 = out_next - offset2;
706         matchptr = out_next - offset;
707
708         while (length--)
709                 *out_next++ = *matchptr1++ + *matchptr2++ - *matchptr++;
710
711         ctx->out_next = out_next;
712         return 0;
713 }
714
715 /* Decode a (length, offset) pair from the input.  */
716 static int
717 lzms_decode_lz_match(struct lzms_decompressor *ctx)
718 {
719         int bit;
720         u32 length, offset;
721
722         /* Decode the match offset.  The next range-encoded bit indicates
723          * whether it's a repeat offset or an explicit offset.  */
724
725         bit = lzms_range_decode_bit(&ctx->lz_match_range_decoder);
726         if (bit == 0) {
727                 /* Explicit offset.  */
728                 offset = lzms_decode_value(&ctx->lz_offset_decoder);
729         } else {
730                 /* Repeat offset.  */
731                 int i;
732
733                 for (i = 0; i < LZMS_NUM_RECENT_OFFSETS - 1; i++)
734                         if (!lzms_range_decode_bit(&ctx->lz_repeat_match_range_decoders[i]))
735                                 break;
736
737                 offset = ctx->lru.lz.recent_offsets[i];
738
739                 for (; i < LZMS_NUM_RECENT_OFFSETS; i++)
740                         ctx->lru.lz.recent_offsets[i] = ctx->lru.lz.recent_offsets[i + 1];
741         }
742
743         /* Decode match length, which is always given explicitly (there is no
744          * LRU queue for repeat lengths).  */
745         length = lzms_decode_value(&ctx->length_decoder);
746
747         ctx->lru.lz.upcoming_offset = offset;
748
749         LZMS_DEBUG("Decoded %s LZ match: length=%u, offset=%u",
750                    (bit ? "repeat" : "explicit"), length, offset);
751
752         /* Validate the match and copy it to the output.  */
753         return lzms_copy_lz_match(ctx, length, offset);
754 }
755
756 /* Decodes a "delta" match from the input.  */
757 static int
758 lzms_decode_delta_match(struct lzms_decompressor *ctx)
759 {
760         int bit;
761         u32 length, power, raw_offset;
762
763         /* Decode the match power and raw offset.  The next range-encoded bit
764          * indicates whether these data are a repeat, or given explicitly.  */
765
766         bit = lzms_range_decode_bit(&ctx->delta_match_range_decoder);
767         if (bit == 0) {
768                 power = lzms_huffman_decode_symbol(&ctx->delta_power_decoder);
769                 raw_offset = lzms_decode_value(&ctx->delta_offset_decoder);
770         } else {
771                 int i;
772
773                 for (i = 0; i < LZMS_NUM_RECENT_OFFSETS - 1; i++)
774                         if (!lzms_range_decode_bit(&ctx->delta_repeat_match_range_decoders[i]))
775                                 break;
776
777                 power = ctx->lru.delta.recent_powers[i];
778                 raw_offset = ctx->lru.delta.recent_offsets[i];
779
780                 for (; i < LZMS_NUM_RECENT_OFFSETS; i++) {
781                         ctx->lru.delta.recent_powers[i] = ctx->lru.delta.recent_powers[i + 1];
782                         ctx->lru.delta.recent_offsets[i] = ctx->lru.delta.recent_offsets[i + 1];
783                 }
784         }
785
786         length = lzms_decode_value(&ctx->length_decoder);
787
788         ctx->lru.delta.upcoming_power = power;
789         ctx->lru.delta.upcoming_offset = raw_offset;
790
791         LZMS_DEBUG("Decoded %s delta match: length=%u, power=%u, raw_offset=%u",
792                    (bit ? "repeat" : "explicit"), length, power, raw_offset);
793
794         /* Validate the match and copy it to the output.  */
795         return lzms_copy_delta_match(ctx, length, power, raw_offset);
796 }
797
798 static int
799 lzms_decode_match(struct lzms_decompressor *ctx)
800 {
801         if (!lzms_range_decode_bit(&ctx->match_range_decoder))
802                 return lzms_decode_lz_match(ctx);
803         else
804                 return lzms_decode_delta_match(ctx);
805 }
806
807 /* Decode a literal byte encoded using the literal Huffman code.  */
808 static int
809 lzms_decode_literal(struct lzms_decompressor *ctx)
810 {
811         u8 literal = lzms_huffman_decode_symbol(&ctx->literal_decoder);
812         LZMS_DEBUG("Decoded literal: 0x%02x", literal);
813         return lzms_copy_literal(ctx, literal);
814 }
815
816 /* Decode the next LZMS match or literal.  */
817 static int
818 lzms_decode_item(struct lzms_decompressor *ctx)
819 {
820         int ret;
821
822         ctx->lru.lz.upcoming_offset = 0;
823         ctx->lru.delta.upcoming_power = 0;
824         ctx->lru.delta.upcoming_offset = 0;
825
826         if (lzms_range_decode_bit(&ctx->main_range_decoder))
827                 ret = lzms_decode_match(ctx);
828         else
829                 ret = lzms_decode_literal(ctx);
830
831         if (ret)
832                 return ret;
833
834         /* Update LRU queues  */
835         lzms_update_lru_queues(&ctx->lru);
836         return 0;
837 }
838
839 static void
840 lzms_init_range_decoder(struct lzms_range_decoder *dec,
841                         struct lzms_range_decoder_raw *rd, u32 num_states)
842 {
843         dec->rd = rd;
844         dec->state = 0;
845         dec->mask = num_states - 1;
846         for (u32 i = 0; i < num_states; i++) {
847                 dec->prob_entries[i].num_recent_zero_bits = LZMS_INITIAL_PROBABILITY;
848                 dec->prob_entries[i].recent_bits = LZMS_INITIAL_RECENT_BITS;
849         }
850 }
851
852 static void
853 lzms_init_huffman_decoder(struct lzms_huffman_decoder *dec,
854                           struct lzms_input_bitstream *is,
855                           const u32 *slot_base_tab, unsigned num_syms,
856                           unsigned rebuild_freq)
857 {
858         dec->is = is;
859         dec->slot_base_tab = slot_base_tab;
860         dec->num_syms = num_syms;
861         dec->num_syms_read = rebuild_freq;
862         dec->rebuild_freq = rebuild_freq;
863         for (unsigned i = 0; i < num_syms; i++)
864                 dec->sym_freqs[i] = 1;
865 }
866
867 /* Prepare to decode items from an LZMS-compressed block.  */
868 static void
869 lzms_init_decompressor(struct lzms_decompressor *ctx,
870                        const void *cdata, unsigned clen,
871                        void *ubuf, unsigned ulen)
872 {
873         unsigned num_position_slots;
874
875         LZMS_DEBUG("Initializing decompressor (clen=%u, ulen=%u)", clen, ulen);
876
877         /* Initialize output pointers.  */
878         ctx->out_begin = ubuf;
879         ctx->out_next = ubuf;
880         ctx->out_end = (u8*)ubuf + ulen;
881
882         /* Initialize the raw range decoder (reading forwards).  */
883         lzms_range_decoder_raw_init(&ctx->rd, cdata, clen / 2);
884
885         /* Initialize the input bitstream for Huffman symbols (reading
886          * backwards)  */
887         lzms_input_bitstream_init(&ctx->is, cdata, clen / 2);
888
889         /* Initialize position and length slot bases if not done already.  */
890         lzms_init_slot_bases();
891
892         /* Calculate the number of position slots needed for this compressed
893          * block.  */
894         num_position_slots = lzms_get_position_slot(ulen - 1) + 1;
895
896         LZMS_DEBUG("Using %u position slots", num_position_slots);
897
898         /* Initialize Huffman decoders for each alphabet used in the compressed
899          * representation.  */
900         lzms_init_huffman_decoder(&ctx->literal_decoder, &ctx->is,
901                                   NULL, LZMS_NUM_LITERAL_SYMS,
902                                   LZMS_LITERAL_CODE_REBUILD_FREQ);
903
904         lzms_init_huffman_decoder(&ctx->lz_offset_decoder, &ctx->is,
905                                   lzms_position_slot_base, num_position_slots,
906                                   LZMS_LZ_OFFSET_CODE_REBUILD_FREQ);
907
908         lzms_init_huffman_decoder(&ctx->length_decoder, &ctx->is,
909                                   lzms_length_slot_base, LZMS_NUM_LEN_SYMS,
910                                   LZMS_LENGTH_CODE_REBUILD_FREQ);
911
912         lzms_init_huffman_decoder(&ctx->delta_offset_decoder, &ctx->is,
913                                   lzms_position_slot_base, num_position_slots,
914                                   LZMS_DELTA_OFFSET_CODE_REBUILD_FREQ);
915
916         lzms_init_huffman_decoder(&ctx->delta_power_decoder, &ctx->is,
917                                   NULL, LZMS_NUM_DELTA_POWER_SYMS,
918                                   LZMS_DELTA_POWER_CODE_REBUILD_FREQ);
919
920
921         /* Initialize range decoders, all of which wrap around the same
922          * lzms_range_decoder_raw.  */
923         lzms_init_range_decoder(&ctx->main_range_decoder,
924                                 &ctx->rd, LZMS_NUM_MAIN_STATES);
925
926         lzms_init_range_decoder(&ctx->match_range_decoder,
927                                 &ctx->rd, LZMS_NUM_MATCH_STATES);
928
929         lzms_init_range_decoder(&ctx->lz_match_range_decoder,
930                                 &ctx->rd, LZMS_NUM_LZ_MATCH_STATES);
931
932         for (size_t i = 0; i < ARRAY_LEN(ctx->lz_repeat_match_range_decoders); i++)
933                 lzms_init_range_decoder(&ctx->lz_repeat_match_range_decoders[i],
934                                         &ctx->rd, LZMS_NUM_LZ_REPEAT_MATCH_STATES);
935
936         lzms_init_range_decoder(&ctx->delta_match_range_decoder,
937                                 &ctx->rd, LZMS_NUM_DELTA_MATCH_STATES);
938
939         for (size_t i = 0; i < ARRAY_LEN(ctx->delta_repeat_match_range_decoders); i++)
940                 lzms_init_range_decoder(&ctx->delta_repeat_match_range_decoders[i],
941                                         &ctx->rd, LZMS_NUM_DELTA_REPEAT_MATCH_STATES);
942
943         /* Initialize LRU match information.  */
944         lzms_init_lru_queues(&ctx->lru);
945
946         LZMS_DEBUG("Decompressor successfully initialized");
947 }
948
949 /* Decode the series of literals and matches from the LZMS-compressed data.
950  * Returns 0 on success; nonzero if the compressed data is invalid.  */
951 static int
952 lzms_decode_items(const u8 *cdata, size_t clen, u8 *ubuf, size_t ulen,
953                   struct lzms_decompressor *ctx)
954 {
955         /* Initialize the LZMS decompressor.  */
956         lzms_init_decompressor(ctx, cdata, clen, ubuf, ulen);
957
958         /* Decode the sequence of items.  */
959         while (ctx->out_next != ctx->out_end) {
960                 LZMS_DEBUG("Position %u", ctx->out_next - ctx->out_begin);
961                 if (lzms_decode_item(ctx))
962                         return -1;
963         }
964         return 0;
965 }
966
967 static int
968 lzms_decompress(const void *compressed_data, size_t compressed_size,
969                 void *uncompressed_data, size_t uncompressed_size, void *_ctx)
970 {
971         struct lzms_decompressor *ctx = _ctx;
972
973         /* The range decoder requires that a minimum of 4 bytes of compressed
974          * data be initially available.  */
975         if (compressed_size < 4) {
976                 LZMS_DEBUG("Compressed size too small (got %zu, expected >= 4)",
977                            compressed_size);
978                 return -1;
979         }
980
981         /* A LZMS-compressed data block should be evenly divisible into 16-bit
982          * integers.  */
983         if (compressed_size % 2 != 0) {
984                 LZMS_DEBUG("Compressed size not divisible by 2 (got %zu)",
985                            compressed_size);
986                 return -1;
987         }
988
989         /* Handle the trivial case where nothing needs to be decompressed.
990          * (Necessary because a window of size 0 does not have a valid position
991          * slot.)  */
992         if (uncompressed_size == 0)
993                 return 0;
994
995         /* The x86 post-processor requires that the uncompressed length fit into
996          * a signed 32-bit integer.  Also, the position slot table cannot be
997          * searched for a position of INT32_MAX or greater.  */
998         if (uncompressed_size >= INT32_MAX) {
999                 LZMS_DEBUG("Uncompressed length too large "
1000                            "(got %zu, expected < INT32_MAX)",
1001                            uncompressed_size);
1002                 return -1;
1003         }
1004
1005         /* Decode the literals and matches.  */
1006         if (lzms_decode_items(compressed_data, compressed_size,
1007                               uncompressed_data, uncompressed_size, ctx))
1008                 return -1;
1009
1010         /* Postprocess the data.  */
1011         lzms_x86_filter(uncompressed_data, uncompressed_size,
1012                         ctx->last_target_usages, true);
1013
1014         LZMS_DEBUG("Decompression successful.");
1015         return 0;
1016 }
1017
1018 static void
1019 lzms_free_decompressor(void *_ctx)
1020 {
1021         struct lzms_decompressor *ctx = _ctx;
1022
1023         FREE(ctx);
1024 }
1025
1026 static int
1027 lzms_create_decompressor(size_t max_block_size,
1028                          const struct wimlib_decompressor_params_header *params,
1029                          void **ctx_ret)
1030 {
1031         struct lzms_decompressor *ctx;
1032
1033         ctx = MALLOC(sizeof(struct lzms_decompressor));
1034         if (ctx == NULL)
1035                 return WIMLIB_ERR_NOMEM;
1036
1037         *ctx_ret = ctx;
1038         return 0;
1039 }
1040
1041 const struct decompressor_ops lzms_decompressor_ops = {
1042         .create_decompressor  = lzms_create_decompressor,
1043         .decompress           = lzms_decompress,
1044         .free_decompressor    = lzms_free_decompressor,
1045 };