lzms_decompress.c: pack states together in struct lzms_decompressor
[wimlib] / src / lzms_decompress.c
1 /*
2  * lzms_decompress.c
3  *
4  * A decompressor for the LZMS compression format.
5  */
6
7 /*
8  * Copyright (C) 2013, 2014, 2015 Eric Biggers
9  *
10  * This file is free software; you can redistribute it and/or modify it under
11  * the terms of the GNU Lesser General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option) any
13  * later version.
14  *
15  * This file is distributed in the hope that it will be useful, but WITHOUT
16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
17  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this file; 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 is a
35  * container format from which the locations and sizes (both compressed and
36  * uncompressed) of the constituent blocks can be determined.
37  *
38  * An 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  * binary range-encoded data, whereas bits read from the backwards bitstream
43  * constitute Huffman-encoded symbols or verbatim bits.  For both bitstreams,
44  * the ordering of the bits within the 16-bit coding units is such that the
45  * first bit is the 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 LZ77 match consists of a length and offset.  It asserts that
54  * the sequence of bytes beginning at the current position and extending for the
55  * length is equal to the same-length sequence of bytes at the offset back in
56  * the data buffer.  This type of match can be visualized as follows, with the
57  * caveat that the sequences may overlap:
58  *
59  *                                offset
60  *                         --------------------
61  *                         |                  |
62  *                         B[1...len]         A[1...len]
63  *
64  * Decoding proceeds as follows:
65  *
66  *                      do {
67  *                              *A++ = *B++;
68  *                      } while (--length);
69  *
70  * On the other hand, a delta match consists of a "span" as well as a length and
71  * offset.  A delta match can be visualized as follows, with the caveat that the
72  * various sequences may overlap:
73  *
74  *                                       offset
75  *                            -----------------------------
76  *                            |                           |
77  *                    span    |                   span    |
78  *                -------------               -------------
79  *                |           |               |           |
80  *                D[1...len]  C[1...len]      B[1...len]  A[1...len]
81  *
82  * Decoding proceeds as follows:
83  *
84  *                      do {
85  *                              *A++ = *B++ + *C++ - *D++;
86  *                      } while (--length);
87  *
88  * A delta match asserts that the bytewise differences of the A and B sequences
89  * are equal to the bytewise differences of the C and D sequences.  The
90  * sequences within each pair are separated by the same number of bytes, the
91  * "span".  The inter-pair distance is the "offset".  In LZMS, spans are
92  * restricted to powers of 2 between 2**0 and 2**7 inclusively.  Offsets are
93  * restricted to multiples of the span.  The stored value for the offset is the
94  * "raw offset", which is the real offset divided by the span.
95  *
96  * Delta matches can cover data containing a series of power-of-2 sized integers
97  * that is linearly increasing or decreasing.  Another way of thinking about it
98  * is that a delta match can match a longer sequence that is interrupted by a
99  * non-matching byte, provided that the non-matching byte is a continuation of a
100  * linearly changing pattern.  Examples of files that may contain data like this
101  * are uncompressed bitmap images, uncompressed digital audio, and Unicode data
102  * tables.  To some extent, this match type is a replacement for delta filters
103  * or multimedia filters that are sometimes used in other compression software
104  * (e.g.  'xz --delta --lzma2').  However, on most types of files, delta matches
105  * do not seem to be very useful.
106  *
107  * Both LZ and delta matches may use overlapping sequences.  Therefore, they
108  * must be decoded as if only one byte is copied at a time.
109  *
110  * For both LZ and delta matches, any match length in [1, 1073809578] can be
111  * represented.  Similarly, any match offset in [1, 1180427428] can be
112  * represented.  For delta matches, this range applies to the raw offset, so the
113  * real offset may be larger.
114  *
115  * For LZ matches, up to 3 repeat offsets are allowed, similar to some other
116  * LZ-based formats such as LZX and LZMA.  They must updated in an LRU fashion,
117  * except for a quirk: inserting anything to the front of the queue must be
118  * delayed by one LZMS item.  The reason for this is presumably that there is
119  * almost no reason to code the same match offset twice in a row, since you
120  * might as well have coded a longer match at that offset.  For this same
121  * reason, it also is a requirement that when an offset in the queue is used,
122  * that offset is removed from the queue immediately (and made pending for
123  * front-insertion after the following decoded item), and everything to the
124  * right is shifted left one queue slot.  This creates a need for an "overflow"
125  * fourth entry in the queue, even though it is only possible to decode
126  * references to the first 3 entries at any given time.  The queue must be
127  * initialized to the offsets {1, 2, 3, 4}.
128  *
129  * Repeat delta matches are handled similarly, but for them the queue contains
130  * (power, raw offset) pairs.  This queue must be initialized to
131  * {(0, 1), (0, 2), (0, 3), (0, 4)}.
132  *
133  * Bits from the binary range decoder must be used to disambiguate item types.
134  * The range decoder must hold two state variables: the range, which must
135  * initially be set to 0xffffffff, and the current code, which must initially be
136  * set to the first 32 bits read from the forwards bitstream.  The range must be
137  * maintained above 0xffff; when it falls below 0xffff, both the range and code
138  * must be left-shifted by 16 bits and the low 16 bits of the code must be
139  * filled in with the next 16 bits from the forwards bitstream.
140  *
141  * To decode each bit, the binary range decoder requires a probability that is
142  * logically a real number between 0 and 1.  Multiplying this probability by the
143  * current range and taking the floor gives the bound between the 0-bit region of
144  * the range and the 1-bit region of the range.  However, in LZMS, probabilities
145  * are restricted to values of n/64 where n is an integer is between 1 and 63
146  * inclusively, so the implementation may use integer operations instead.
147  * Following calculation of the bound, if the current code is in the 0-bit
148  * region, the new range becomes the current code and the decoded bit is 0;
149  * otherwise, the bound must be subtracted from both the range and the code, and
150  * the decoded bit is 1.  More information about range coding can be found at
151  * https://en.wikipedia.org/wiki/Range_encoding.  Furthermore, note that the
152  * LZMA format also uses range coding and has public domain code available for
153  * it.
154  *
155  * The probability used to range-decode each bit must be taken from a table, of
156  * which one instance must exist for each distinct context, or "binary decision
157  * class", in which a range-decoded bit is needed.  At each call of the range
158  * decoder, the appropriate probability must be obtained by indexing the
159  * appropriate probability table with the last 4 (in the context disambiguating
160  * literals from matches), 5 (in the context disambiguating LZ matches from
161  * delta matches), or 6 (in all other contexts) bits recently range-decoded in
162  * that context, ordered such that the most recently decoded bit is the
163  * low-order bit of the index.
164  *
165  * Furthermore, each probability entry itself is variable, as its value must be
166  * maintained as n/64 where n is the number of 0 bits in the most recently
167  * decoded 64 bits with that same entry.  This allows the compressed
168  * representation to adapt to the input and use fewer bits to represent the most
169  * likely data; note that LZMA uses a similar scheme.  Initially, the most
170  * recently 64 decoded bits for each probability entry are assumed to be
171  * 0x0000000055555555 (high order to low order); therefore, all probabilities
172  * are initially 48/64.  During the course of decoding, each probability may be
173  * updated to as low as 0/64 (as a result of reading many consecutive 1 bits
174  * with that entry) or as high as 64/64 (as a result of reading many consecutive
175  * 0 bits with that entry); however, probabilities of 0/64 and 64/64 cannot be
176  * used as-is but rather must be adjusted to 1/64 and 63/64, respectively,
177  * before being used for range decoding.
178  *
179  * Representations of the LZMS items themselves must be read from the backwards
180  * bitstream.  For this, there are 5 different Huffman codes used:
181  *
182  *  - The literal code, used for decoding literal bytes.  Each of the 256
183  *    symbols represents a literal byte.  This code must be rebuilt whenever
184  *    1024 symbols have been decoded with it.
185  *
186  *  - The LZ offset code, used for decoding the offsets of standard LZ77
187  *    matches.  Each symbol represents an offset slot, which corresponds to a
188  *    base value and some number of extra bits which must be read and added to
189  *    the base value to reconstitute the full offset.  The number of symbols in
190  *    this code is the number of offset slots needed to represent all possible
191  *    offsets in the uncompressed block.  This code must be rebuilt whenever
192  *    1024 symbols have been decoded with it.
193  *
194  *  - The length code, used for decoding length symbols.  Each of the 54 symbols
195  *    represents a length slot, which corresponds to a base value and some
196  *    number of extra bits which must be read and added to the base value to
197  *    reconstitute the full length.  This code must be rebuilt whenever 512
198  *    symbols have been decoded with it.
199  *
200  *  - The delta offset code, used for decoding the raw offsets of delta matches.
201  *    Each symbol corresponds to an offset slot, which corresponds to a base
202  *    value and some number of extra bits which must be read and added to the
203  *    base value to reconstitute the full raw offset.  The number of symbols in
204  *    this code is equal to the number of symbols in the LZ offset code.  This
205  *    code must be rebuilt whenever 1024 symbols have been decoded with it.
206  *
207  *  - The delta power code, used for decoding the powers of delta matches.  Each
208  *    of the 8 symbols corresponds to a power.  This code must be rebuilt
209  *    whenever 512 symbols have been decoded with it.
210  *
211  * Initially, each Huffman code must be built assuming that each symbol in that
212  * code has frequency 1.  Following that, each code must be rebuilt each time a
213  * certain number of symbols, as noted above, has been decoded with it.  The
214  * symbol frequencies for a code must be halved after each rebuild of that code;
215  * this makes the codes adapt to the more recent data.
216  *
217  * Like other compression formats such as XPRESS, LZX, and DEFLATE, the LZMS
218  * format requires that all Huffman codes be constructed in canonical form.
219  * This form requires that same-length codewords be lexicographically ordered
220  * the same way as the corresponding symbols and that all shorter codewords
221  * lexicographically precede longer codewords.  Such a code can be constructed
222  * directly from codeword lengths.
223  *
224  * Even with the canonical code restriction, the same frequencies can be used to
225  * construct multiple valid Huffman codes.  Therefore, the decompressor needs to
226  * construct the right one.  Specifically, the LZMS format requires that the
227  * Huffman code be constructed as if the well-known priority queue algorithm is
228  * used and frequency ties are always broken in favor of leaf nodes.
229  *
230  * Codewords in LZMS are guaranteed to not exceed 15 bits.  The format otherwise
231  * places no restrictions on codeword length.  Therefore, the Huffman code
232  * construction algorithm that a correct LZMS decompressor uses need not
233  * implement length-limited code construction.  But if it does (e.g. by virtue
234  * of being shared among multiple compression algorithms), the details of how it
235  * does so are unimportant, provided that the maximum codeword length parameter
236  * is set to at least 15 bits.
237  *
238  * After all LZMS items have been decoded, the data must be postprocessed to
239  * translate absolute address encoded in x86 instructions into their original
240  * relative addresses.
241  *
242  * Details omitted above can be found in the code.  Note that in the absence of
243  * an official specification there is no guarantee that this decompressor
244  * handles all possible cases.
245  */
246
247 #ifdef HAVE_CONFIG_H
248 #  include "config.h"
249 #endif
250
251 #include "wimlib/compress_common.h"
252 #include "wimlib/decompress_common.h"
253 #include "wimlib/decompressor_ops.h"
254 #include "wimlib/error.h"
255 #include "wimlib/lzms_common.h"
256 #include "wimlib/util.h"
257
258 /* The TABLEBITS values can be changed; they only affect decoding speed.  */
259 #define LZMS_LITERAL_TABLEBITS          10
260 #define LZMS_LENGTH_TABLEBITS           10
261 #define LZMS_LZ_OFFSET_TABLEBITS        10
262 #define LZMS_DELTA_OFFSET_TABLEBITS     10
263 #define LZMS_DELTA_POWER_TABLEBITS      8
264
265 struct lzms_range_decoder {
266
267         /* The relevant part of the current range.  Although the logical range
268          * for range decoding is a very large integer, only a small portion
269          * matters at any given time, and it can be normalized (shifted left)
270          * whenever it gets too small.  */
271         u32 range;
272
273         /* The current position in the range encoded by the portion of the input
274          * read so far.  */
275         u32 code;
276
277         /* Pointer to the next little-endian 16-bit integer in the compressed
278          * input data (reading forwards).  */
279         const le16 *next;
280
281         /* Pointer to the end of the compressed input data.  */
282         const le16 *end;
283 };
284
285 typedef u64 bitbuf_t;
286
287 struct lzms_input_bitstream {
288
289         /* Holding variable for bits that have been read from the compressed
290          * data.  The bit ordering is high to low.  */
291         bitbuf_t bitbuf;
292
293         /* Number of bits currently held in @bitbuf.  */
294         unsigned bitsleft;
295
296         /* Pointer to the one past the next little-endian 16-bit integer in the
297          * compressed input data (reading backwards).  */
298         const le16 *next;
299
300         /* Pointer to the beginning of the compressed input data.  */
301         const le16 *begin;
302 };
303
304 #define BITBUF_NBITS    (8 * sizeof(bitbuf_t))
305
306 /* Bookkeeping information for an adaptive Huffman code  */
307 struct lzms_huffman_rebuild_info {
308         unsigned num_syms_until_rebuild;
309         unsigned num_syms;
310         unsigned rebuild_freq;
311         u32 *codewords;
312         u32 *freqs;
313         u16 *decode_table;
314         unsigned table_bits;
315 };
316
317 struct lzms_decompressor {
318
319         /* 'last_target_usages' is in union with everything else because it is
320          * only used for postprocessing.  */
321         union {
322         struct {
323
324         struct lzms_range_decoder rd;
325         struct lzms_input_bitstream is;
326
327         /* LRU queues for match sources  */
328         u32 recent_lz_offsets[LZMS_NUM_LZ_REPS + 1];
329         u64 recent_delta_pairs[LZMS_NUM_DELTA_REPS + 1];
330         u32 pending_lz_offset;
331         u64 pending_delta_pair;
332         const u8 *lz_offset_still_pending;
333         const u8 *delta_pair_still_pending;
334
335         /* States and probability entries for item type disambiguation  */
336
337         u32 main_state;
338         u32 match_state;
339         u32 lz_state;
340         u32 delta_state;
341         u32 lz_rep_states[LZMS_NUM_LZ_REP_DECISIONS];
342         u32 delta_rep_states[LZMS_NUM_DELTA_REP_DECISIONS];
343
344         struct lzms_probability_entry main_probs[LZMS_NUM_MAIN_PROBS];
345         struct lzms_probability_entry match_probs[LZMS_NUM_MATCH_PROBS];
346         struct lzms_probability_entry lz_probs[LZMS_NUM_LZ_PROBS];
347         struct lzms_probability_entry delta_probs[LZMS_NUM_DELTA_PROBS];
348         struct lzms_probability_entry lz_rep_probs[LZMS_NUM_LZ_REP_DECISIONS]
349                                                   [LZMS_NUM_LZ_REP_PROBS];
350         struct lzms_probability_entry delta_rep_probs[LZMS_NUM_DELTA_REP_DECISIONS]
351                                                      [LZMS_NUM_DELTA_REP_PROBS];
352
353         /* Huffman decoding  */
354
355         u16 literal_decode_table[(1 << LZMS_LITERAL_TABLEBITS) +
356                                  (2 * LZMS_NUM_LITERAL_SYMS)]
357                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
358         u32 literal_freqs[LZMS_NUM_LITERAL_SYMS];
359         struct lzms_huffman_rebuild_info literal_rebuild_info;
360
361         u16 lz_offset_decode_table[(1 << LZMS_LZ_OFFSET_TABLEBITS) +
362                                    ( 2 * LZMS_MAX_NUM_OFFSET_SYMS)]
363                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
364         u32 lz_offset_freqs[LZMS_MAX_NUM_OFFSET_SYMS];
365         struct lzms_huffman_rebuild_info lz_offset_rebuild_info;
366
367         u16 length_decode_table[(1 << LZMS_LENGTH_TABLEBITS) +
368                                 (2 * LZMS_NUM_LENGTH_SYMS)]
369                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
370         u32 length_freqs[LZMS_NUM_LENGTH_SYMS];
371         struct lzms_huffman_rebuild_info length_rebuild_info;
372
373         u16 delta_offset_decode_table[(1 << LZMS_DELTA_OFFSET_TABLEBITS) +
374                                       (2 * LZMS_MAX_NUM_OFFSET_SYMS)]
375                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
376         u32 delta_offset_freqs[LZMS_MAX_NUM_OFFSET_SYMS];
377         struct lzms_huffman_rebuild_info delta_offset_rebuild_info;
378
379         u16 delta_power_decode_table[(1 << LZMS_DELTA_POWER_TABLEBITS) +
380                                      (2 * LZMS_NUM_DELTA_POWER_SYMS)]
381                 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
382         u32 delta_power_freqs[LZMS_NUM_DELTA_POWER_SYMS];
383         struct lzms_huffman_rebuild_info delta_power_rebuild_info;
384
385         u32 codewords[LZMS_MAX_NUM_SYMS];
386
387         }; // struct
388
389         s32 last_target_usages[65536];
390
391         }; // union
392 };
393
394 /* Initialize the input bitstream @is to read backwards from the compressed data
395  * buffer @in that is @count 16-bit integers long.  */
396 static void
397 lzms_input_bitstream_init(struct lzms_input_bitstream *is,
398                           const le16 *in, size_t count)
399 {
400         is->bitbuf = 0;
401         is->bitsleft = 0;
402         is->next = in + count;
403         is->begin = in;
404 }
405
406 /* Ensure that at least @num_bits bits are in the bitbuffer variable.
407  * @num_bits cannot be more than 32.  */
408 static inline void
409 lzms_ensure_bits(struct lzms_input_bitstream *is, unsigned num_bits)
410 {
411         unsigned avail;
412
413         if (is->bitsleft >= num_bits)
414                 return;
415
416         avail = BITBUF_NBITS - is->bitsleft;
417
418         if (UNALIGNED_ACCESS_IS_FAST && CPU_IS_LITTLE_ENDIAN &&
419             WORDSIZE == 8 && likely((u8 *)is->next - (u8 *)is->begin >= 8))
420         {
421                 is->next -= avail >> 4;
422                 is->bitbuf |= load_u64_unaligned(is->next) << (avail & 15);
423                 is->bitsleft += avail & ~15;
424         } else {
425                 if (likely(is->next != is->begin))
426                         is->bitbuf |= (bitbuf_t)le16_to_cpu(*--is->next)
427                                         << (avail - 16);
428                 if (likely(is->next != is->begin))
429                         is->bitbuf |=(bitbuf_t)le16_to_cpu(*--is->next)
430                                         << (avail - 32);
431                 is->bitsleft += 32;
432         }
433 }
434
435 /* Get @num_bits bits from the bitbuffer variable.  */
436 static inline bitbuf_t
437 lzms_peek_bits(struct lzms_input_bitstream *is, unsigned num_bits)
438 {
439         return (is->bitbuf >> 1) >> (BITBUF_NBITS - num_bits - 1);
440 }
441
442 /* Remove @num_bits bits from the bitbuffer variable.  */
443 static inline void
444 lzms_remove_bits(struct lzms_input_bitstream *is, unsigned num_bits)
445 {
446         is->bitbuf <<= num_bits;
447         is->bitsleft -= num_bits;
448 }
449
450 /* Remove and return @num_bits bits from the bitbuffer variable.  */
451 static inline bitbuf_t
452 lzms_pop_bits(struct lzms_input_bitstream *is, unsigned num_bits)
453 {
454         bitbuf_t bits = lzms_peek_bits(is, num_bits);
455         lzms_remove_bits(is, num_bits);
456         return bits;
457 }
458
459 /* Read @num_bits bits from the input bitstream.  */
460 static inline bitbuf_t
461 lzms_read_bits(struct lzms_input_bitstream *is, unsigned num_bits)
462 {
463         lzms_ensure_bits(is, num_bits);
464         return lzms_pop_bits(is, num_bits);
465 }
466
467 /* Initialize the range decoder @rd to read forwards from the compressed data
468  * buffer @in that is @count 16-bit integers long.  */
469 static void
470 lzms_range_decoder_init(struct lzms_range_decoder *rd,
471                         const le16 *in, size_t count)
472 {
473         rd->range = 0xffffffff;
474         rd->code = ((u32)le16_to_cpu(in[0]) << 16) | le16_to_cpu(in[1]);
475         rd->next = in + 2;
476         rd->end = in + count;
477 }
478
479 /*
480  * Decode a bit using the range coder.  The current state specifies the
481  * probability entry to use.  The state and probability entry will be updated
482  * based on the decoded bit.
483  */
484 static inline int
485 lzms_decode_bit(struct lzms_range_decoder *rd, u32 *state_p, u32 num_states,
486                 struct lzms_probability_entry *probs)
487 {
488         struct lzms_probability_entry *prob_entry;
489         u32 prob;
490         u32 bound;
491
492         /* Load the probability entry corresponding to the current state.  */
493         prob_entry = &probs[*state_p];
494
495         /* Get the probability (out of LZMS_PROBABILITY_DENOMINATOR) that the
496          * next bit is 0.  */
497         prob = lzms_get_probability(prob_entry);
498
499         /* Normalize if needed.  */
500         if (rd->range <= 0xffff) {
501                 rd->range <<= 16;
502                 rd->code <<= 16;
503                 if (likely(rd->next != rd->end))
504                         rd->code |= le16_to_cpu(*rd->next++);
505         }
506
507         /* Based on the probability, calculate the bound between the 0-bit
508          * region and the 1-bit region of the range.  */
509         bound = (rd->range >> LZMS_PROBABILITY_BITS) * prob;
510
511         if (rd->code < bound) {
512                 /* Current code is in the 0-bit region of the range.  */
513                 rd->range = bound;
514
515                 /* Update the state and probability entry based on the decoded bit.  */
516                 *state_p = ((*state_p << 1) | 0) & (num_states - 1);
517                 lzms_update_probability_entry(prob_entry, 0);
518                 return 0;
519         } else {
520                 /* Current code is in the 1-bit region of the range.  */
521                 rd->range -= bound;
522                 rd->code -= bound;
523
524                 /* Update the state and probability entry based on the decoded bit.  */
525                 *state_p = ((*state_p << 1) | 1) & (num_states - 1);
526                 lzms_update_probability_entry(prob_entry, 1);
527                 return 1;
528         }
529 }
530
531 static int
532 lzms_decode_main_bit(struct lzms_decompressor *d)
533 {
534         return lzms_decode_bit(&d->rd, &d->main_state,
535                                LZMS_NUM_MAIN_PROBS, d->main_probs);
536 }
537
538 static int
539 lzms_decode_match_bit(struct lzms_decompressor *d)
540 {
541         return lzms_decode_bit(&d->rd, &d->match_state,
542                                LZMS_NUM_MATCH_PROBS, d->match_probs);
543 }
544
545 static int
546 lzms_decode_lz_bit(struct lzms_decompressor *d)
547 {
548         return lzms_decode_bit(&d->rd, &d->lz_state,
549                                LZMS_NUM_LZ_PROBS, d->lz_probs);
550 }
551
552 static int
553 lzms_decode_delta_bit(struct lzms_decompressor *d)
554 {
555         return lzms_decode_bit(&d->rd, &d->delta_state,
556                                LZMS_NUM_DELTA_PROBS, d->delta_probs);
557 }
558
559 static noinline int
560 lzms_decode_lz_rep_bit(struct lzms_decompressor *d, int idx)
561 {
562         return lzms_decode_bit(&d->rd, &d->lz_rep_states[idx],
563                                LZMS_NUM_LZ_REP_PROBS, d->lz_rep_probs[idx]);
564 }
565
566 static noinline int
567 lzms_decode_delta_rep_bit(struct lzms_decompressor *d, int idx)
568 {
569         return lzms_decode_bit(&d->rd, &d->delta_rep_states[idx],
570                                LZMS_NUM_DELTA_REP_PROBS, d->delta_rep_probs[idx]);
571 }
572
573 static void
574 lzms_build_huffman_code(struct lzms_huffman_rebuild_info *rebuild_info)
575 {
576         make_canonical_huffman_code(rebuild_info->num_syms,
577                                     LZMS_MAX_CODEWORD_LENGTH,
578                                     rebuild_info->freqs,
579                                     (u8 *)rebuild_info->decode_table,
580                                     rebuild_info->codewords);
581
582         make_huffman_decode_table(rebuild_info->decode_table,
583                                   rebuild_info->num_syms,
584                                   rebuild_info->table_bits,
585                                   (u8 *)rebuild_info->decode_table,
586                                   LZMS_MAX_CODEWORD_LENGTH);
587
588         rebuild_info->num_syms_until_rebuild = rebuild_info->rebuild_freq;
589 }
590
591 static void
592 lzms_init_huffman_code(struct lzms_huffman_rebuild_info *rebuild_info,
593                        unsigned num_syms, unsigned rebuild_freq,
594                        u32 *codewords, u32 *freqs,
595                        u16 *decode_table, unsigned table_bits)
596 {
597         rebuild_info->num_syms = num_syms;
598         rebuild_info->rebuild_freq = rebuild_freq;
599         rebuild_info->codewords = codewords;
600         rebuild_info->freqs = freqs;
601         rebuild_info->decode_table = decode_table;
602         rebuild_info->table_bits = table_bits;
603         lzms_init_symbol_frequencies(freqs, num_syms);
604         lzms_build_huffman_code(rebuild_info);
605 }
606
607 static noinline void
608 lzms_rebuild_huffman_code(struct lzms_huffman_rebuild_info *rebuild_info)
609 {
610         lzms_build_huffman_code(rebuild_info);
611         lzms_dilute_symbol_frequencies(rebuild_info->freqs, rebuild_info->num_syms);
612 }
613
614 static inline unsigned
615 lzms_decode_huffman_symbol(struct lzms_input_bitstream *is, u16 decode_table[],
616                            unsigned table_bits, u32 freqs[],
617                            struct lzms_huffman_rebuild_info *rebuild_info)
618 {
619         unsigned key_bits;
620         unsigned entry;
621         unsigned sym;
622
623         lzms_ensure_bits(is, LZMS_MAX_CODEWORD_LENGTH);
624
625         /* Index the decode table by the next table_bits bits of the input.  */
626         key_bits = lzms_peek_bits(is, table_bits);
627         entry = decode_table[key_bits];
628         if (likely(entry < 0xC000)) {
629                 /* Fast case: The decode table directly provided the symbol and
630                  * codeword length.  The low 11 bits are the symbol, and the
631                  * high 5 bits are the codeword length.  */
632                 lzms_remove_bits(is, entry >> 11);
633                 sym = entry & 0x7FF;
634         } else {
635                 /* Slow case: The codeword for the symbol is longer than
636                  * table_bits, so the symbol does not have an entry directly in
637                  * the first (1 << table_bits) entries of the decode table.
638                  * Traverse the appropriate binary tree bit-by-bit in order to
639                  * decode the symbol.  */
640                 lzms_remove_bits(is, table_bits);
641                 do {
642                         key_bits = (entry & 0x3FFF) + lzms_pop_bits(is, 1);
643                 } while ((entry = decode_table[key_bits]) >= 0xC000);
644                 sym = entry;
645         }
646
647         freqs[sym]++;
648         if (--rebuild_info->num_syms_until_rebuild == 0)
649                 lzms_rebuild_huffman_code(rebuild_info);
650         return sym;
651 }
652
653 static unsigned
654 lzms_decode_literal(struct lzms_decompressor *d)
655 {
656         return lzms_decode_huffman_symbol(&d->is,
657                                           d->literal_decode_table,
658                                           LZMS_LITERAL_TABLEBITS,
659                                           d->literal_freqs,
660                                           &d->literal_rebuild_info);
661 }
662
663 static u32
664 lzms_decode_lz_offset(struct lzms_decompressor *d)
665 {
666         unsigned slot = lzms_decode_huffman_symbol(&d->is,
667                                                    d->lz_offset_decode_table,
668                                                    LZMS_LZ_OFFSET_TABLEBITS,
669                                                    d->lz_offset_freqs,
670                                                    &d->lz_offset_rebuild_info);
671         return lzms_offset_slot_base[slot] +
672                lzms_read_bits(&d->is, lzms_extra_offset_bits[slot]);
673 }
674
675 static u32
676 lzms_decode_length(struct lzms_decompressor *d)
677 {
678         unsigned slot = lzms_decode_huffman_symbol(&d->is,
679                                                    d->length_decode_table,
680                                                    LZMS_LENGTH_TABLEBITS,
681                                                    d->length_freqs,
682                                                    &d->length_rebuild_info);
683         u32 length = lzms_length_slot_base[slot];
684         unsigned num_extra_bits = lzms_extra_length_bits[slot];
685         /* Usually most lengths are short and have no extra bits.  */
686         if (num_extra_bits)
687                 length += lzms_read_bits(&d->is, num_extra_bits);
688         return length;
689 }
690
691 static u32
692 lzms_decode_delta_offset(struct lzms_decompressor *d)
693 {
694         unsigned slot = lzms_decode_huffman_symbol(&d->is,
695                                                    d->delta_offset_decode_table,
696                                                    LZMS_DELTA_OFFSET_TABLEBITS,
697                                                    d->delta_offset_freqs,
698                                                    &d->delta_offset_rebuild_info);
699         return lzms_offset_slot_base[slot] +
700                lzms_read_bits(&d->is, lzms_extra_offset_bits[slot]);
701 }
702
703 static unsigned
704 lzms_decode_delta_power(struct lzms_decompressor *d)
705 {
706         return lzms_decode_huffman_symbol(&d->is,
707                                           d->delta_power_decode_table,
708                                           LZMS_DELTA_POWER_TABLEBITS,
709                                           d->delta_power_freqs,
710                                           &d->delta_power_rebuild_info);
711 }
712
713 /* Decode the series of literals and matches from the LZMS-compressed data.
714  * Return 0 if successful or -1 if the compressed data is invalid.  */
715 static int
716 lzms_decode_items(struct lzms_decompressor * const restrict d,
717                   u8 * const restrict out, const size_t out_nbytes)
718 {
719         u8 *out_next = out;
720         u8 * const out_end = out + out_nbytes;
721
722         while (out_next != out_end) {
723
724                 if (!lzms_decode_main_bit(d)) {
725
726                         /* Literal  */
727                         *out_next++ = lzms_decode_literal(d);
728
729                 } else if (!lzms_decode_match_bit(d)) {
730
731                         /* LZ match  */
732
733                         u32 offset;
734                         u32 length;
735
736                         if (!lzms_decode_lz_bit(d)) {
737                                 /* Explicit offset  */
738                                 offset = lzms_decode_lz_offset(d);
739                         } else {
740                                 /* Repeat offset  */
741
742                                 if (d->pending_lz_offset != 0 &&
743                                     out_next != d->lz_offset_still_pending)
744                                 {
745                                         BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
746                                         d->recent_lz_offsets[3] = d->recent_lz_offsets[2];
747                                         d->recent_lz_offsets[2] = d->recent_lz_offsets[1];
748                                         d->recent_lz_offsets[1] = d->recent_lz_offsets[0];
749                                         d->recent_lz_offsets[0] = d->pending_lz_offset;
750                                         d->pending_lz_offset = 0;
751                                 }
752
753                                 BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
754                                 if (!lzms_decode_lz_rep_bit(d, 0)) {
755                                         offset = d->recent_lz_offsets[0];
756                                         d->recent_lz_offsets[0] = d->recent_lz_offsets[1];
757                                         d->recent_lz_offsets[1] = d->recent_lz_offsets[2];
758                                         d->recent_lz_offsets[2] = d->recent_lz_offsets[3];
759                                 } else if (!lzms_decode_lz_rep_bit(d, 1)) {
760                                         offset = d->recent_lz_offsets[1];
761                                         d->recent_lz_offsets[1] = d->recent_lz_offsets[2];
762                                         d->recent_lz_offsets[2] = d->recent_lz_offsets[3];
763                                 } else {
764                                         offset = d->recent_lz_offsets[2];
765                                         d->recent_lz_offsets[2] = d->recent_lz_offsets[3];
766                                 }
767                         }
768
769                         if (d->pending_lz_offset != 0) {
770                                 BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
771                                 d->recent_lz_offsets[3] = d->recent_lz_offsets[2];
772                                 d->recent_lz_offsets[2] = d->recent_lz_offsets[1];
773                                 d->recent_lz_offsets[1] = d->recent_lz_offsets[0];
774                                 d->recent_lz_offsets[0] = d->pending_lz_offset;
775                         }
776                         d->pending_lz_offset = offset;
777
778                         length = lzms_decode_length(d);
779
780                         if (unlikely(length > out_end - out_next))
781                                 return -1;
782                         if (unlikely(offset > out_next - out))
783                                 return -1;
784
785                         lz_copy(out_next, length, offset, out_end, LZMS_MIN_MATCH_LENGTH);
786                         out_next += length;
787
788                         d->lz_offset_still_pending = out_next;
789                 } else {
790                         /* Delta match  */
791
792                         /* (See beginning of file for more information.)  */
793
794                         u32 power;
795                         u32 raw_offset;
796                         u32 span;
797                         u32 offset;
798                         const u8 *matchptr;
799                         u32 length;
800
801                         if (!lzms_decode_delta_bit(d)) {
802                                 /* Explicit offset  */
803                                 power = lzms_decode_delta_power(d);
804                                 raw_offset = lzms_decode_delta_offset(d);
805                         } else {
806                                 /* Repeat offset  */
807                                 u64 val;
808
809                                 if (d->pending_delta_pair != 0 &&
810                                     out_next != d->delta_pair_still_pending)
811                                 {
812                                         BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
813                                         d->recent_delta_pairs[3] = d->recent_delta_pairs[2];
814                                         d->recent_delta_pairs[2] = d->recent_delta_pairs[1];
815                                         d->recent_delta_pairs[1] = d->recent_delta_pairs[0];
816                                         d->recent_delta_pairs[0] = d->pending_delta_pair;
817                                         d->pending_delta_pair = 0;
818                                 }
819
820                                 BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
821                                 if (!lzms_decode_delta_rep_bit(d, 0)) {
822                                         val = d->recent_delta_pairs[0];
823                                         d->recent_delta_pairs[0] = d->recent_delta_pairs[1];
824                                         d->recent_delta_pairs[1] = d->recent_delta_pairs[2];
825                                         d->recent_delta_pairs[2] = d->recent_delta_pairs[3];
826                                 } else if (!lzms_decode_delta_rep_bit(d, 1)) {
827                                         val = d->recent_delta_pairs[1];
828                                         d->recent_delta_pairs[1] = d->recent_delta_pairs[2];
829                                         d->recent_delta_pairs[2] = d->recent_delta_pairs[3];
830                                 } else {
831                                         val = d->recent_delta_pairs[2];
832                                         d->recent_delta_pairs[2] = d->recent_delta_pairs[3];
833                                 }
834                                 power = val >> 32;
835                                 raw_offset = (u32)val;
836                         }
837
838                         if (d->pending_delta_pair != 0) {
839                                 BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
840                                 d->recent_delta_pairs[3] = d->recent_delta_pairs[2];
841                                 d->recent_delta_pairs[2] = d->recent_delta_pairs[1];
842                                 d->recent_delta_pairs[1] = d->recent_delta_pairs[0];
843                                 d->recent_delta_pairs[0] = d->pending_delta_pair;
844                         }
845                         d->pending_delta_pair = raw_offset | ((u64)power << 32);
846
847                         length = lzms_decode_length(d);
848
849                         span = (u32)1 << power;
850                         offset = raw_offset << power;
851
852                         /* raw_offset<<power overflows?  */
853                         if (unlikely(offset >> power != raw_offset))
854                                 return -1;
855
856                         /* offset+span overflows?  */
857                         if (unlikely(offset + span < offset))
858                                 return -1;
859
860                         /* buffer underrun?  */
861                         if (unlikely(offset + span > out_next - out))
862                                 return -1;
863
864                         /* buffer overrun?  */
865                         if (unlikely(length > out_end - out_next))
866                                 return -1;
867
868                         matchptr = out_next - offset;
869                         do {
870                                 *out_next = *matchptr + *(out_next - span) -
871                                             *(matchptr - span);
872                                 out_next++;
873                                 matchptr++;
874                         } while (--length);
875
876                         d->delta_pair_still_pending = out_next;
877                 }
878         }
879         return 0;
880 }
881
882 static void
883 lzms_init_decompressor(struct lzms_decompressor *d, const void *in,
884                        size_t in_nbytes, unsigned num_offset_slots)
885 {
886         /* Match offset LRU queues  */
887         for (int i = 0; i < LZMS_NUM_LZ_REPS + 1; i++)
888                 d->recent_lz_offsets[i] = i + 1;
889         for (int i = 0; i < LZMS_NUM_DELTA_REPS + 1; i++)
890                 d->recent_delta_pairs[i] = i + 1;
891         d->pending_lz_offset = 0;
892         d->pending_delta_pair = 0;
893
894         /* Range decoding  */
895
896         lzms_range_decoder_init(&d->rd, in, in_nbytes / sizeof(le16));
897
898         d->main_state = 0;
899         lzms_init_probability_entries(d->main_probs, LZMS_NUM_MAIN_PROBS);
900
901         d->match_state = 0;
902         lzms_init_probability_entries(d->match_probs, LZMS_NUM_MATCH_PROBS);
903
904         d->lz_state = 0;
905         lzms_init_probability_entries(d->lz_probs, LZMS_NUM_LZ_PROBS);
906
907         for (int i = 0; i < LZMS_NUM_LZ_REP_DECISIONS; i++) {
908                 d->lz_rep_states[i] = 0;
909                 lzms_init_probability_entries(d->lz_rep_probs[i],
910                                               LZMS_NUM_LZ_REP_PROBS);
911         }
912
913         d->delta_state = 0;
914         lzms_init_probability_entries(d->delta_probs, LZMS_NUM_DELTA_PROBS);
915
916         for (int i = 0; i < LZMS_NUM_DELTA_REP_DECISIONS; i++) {
917                 d->delta_rep_states[i] = 0;
918                 lzms_init_probability_entries(d->delta_rep_probs[i],
919                                               LZMS_NUM_DELTA_REP_PROBS);
920         }
921
922         /* Huffman decoding  */
923
924         lzms_input_bitstream_init(&d->is, in, in_nbytes / sizeof(le16));
925
926         lzms_init_huffman_code(&d->literal_rebuild_info,
927                                LZMS_NUM_LITERAL_SYMS,
928                                LZMS_LITERAL_CODE_REBUILD_FREQ,
929                                d->codewords,
930                                d->literal_freqs,
931                                d->literal_decode_table,
932                                LZMS_LITERAL_TABLEBITS);
933
934         lzms_init_huffman_code(&d->lz_offset_rebuild_info,
935                                num_offset_slots,
936                                LZMS_LZ_OFFSET_CODE_REBUILD_FREQ,
937                                d->codewords,
938                                d->lz_offset_freqs,
939                                d->lz_offset_decode_table,
940                                LZMS_LZ_OFFSET_TABLEBITS);
941
942         lzms_init_huffman_code(&d->length_rebuild_info,
943                                LZMS_NUM_LENGTH_SYMS,
944                                LZMS_LENGTH_CODE_REBUILD_FREQ,
945                                d->codewords,
946                                d->length_freqs,
947                                d->length_decode_table,
948                                LZMS_LENGTH_TABLEBITS);
949
950         lzms_init_huffman_code(&d->delta_offset_rebuild_info,
951                                num_offset_slots,
952                                LZMS_DELTA_OFFSET_CODE_REBUILD_FREQ,
953                                d->codewords,
954                                d->delta_offset_freqs,
955                                d->delta_offset_decode_table,
956                                LZMS_DELTA_OFFSET_TABLEBITS);
957
958         lzms_init_huffman_code(&d->delta_power_rebuild_info,
959                                LZMS_NUM_DELTA_POWER_SYMS,
960                                LZMS_DELTA_POWER_CODE_REBUILD_FREQ,
961                                d->codewords,
962                                d->delta_power_freqs,
963                                d->delta_power_decode_table,
964                                LZMS_DELTA_POWER_TABLEBITS);
965 }
966
967 static int
968 lzms_create_decompressor(size_t max_bufsize, void **d_ret)
969 {
970         struct lzms_decompressor *d;
971
972         if (max_bufsize > LZMS_MAX_BUFFER_SIZE)
973                 return WIMLIB_ERR_INVALID_PARAM;
974
975         d = ALIGNED_MALLOC(sizeof(struct lzms_decompressor),
976                            DECODE_TABLE_ALIGNMENT);
977         if (!d)
978                 return WIMLIB_ERR_NOMEM;
979
980         *d_ret = d;
981         return 0;
982 }
983
984 /*
985  * Decompress @in_nbytes bytes of LZMS-compressed data at @in and write the
986  * uncompressed data, which had original size @out_nbytes, to @out.  Return 0 if
987  * successful or -1 if the compressed data is invalid.
988  */
989 static int
990 lzms_decompress(const void *in, size_t in_nbytes, void *out, size_t out_nbytes,
991                 void *_d)
992 {
993         struct lzms_decompressor *d = _d;
994
995         /*
996          * Requirements on the compressed data:
997          *
998          * 1. LZMS-compressed data is a series of 16-bit integers, so the
999          *    compressed data buffer cannot take up an odd number of bytes.
1000          * 2. To prevent poor performance on some architectures, we require that
1001          *    the compressed data buffer is 2-byte aligned.
1002          * 3. There must be at least 4 bytes of compressed data, since otherwise
1003          *    we cannot even initialize the range decoder.
1004          */
1005         if ((in_nbytes & 1) || ((uintptr_t)in & 1) || (in_nbytes < 4))
1006                 return -1;
1007
1008         lzms_init_decompressor(d, in, in_nbytes,
1009                                lzms_get_num_offset_slots(out_nbytes));
1010
1011         if (lzms_decode_items(d, out, out_nbytes))
1012                 return -1;
1013
1014         lzms_x86_filter(out, out_nbytes, d->last_target_usages, true);
1015         return 0;
1016 }
1017
1018 static void
1019 lzms_free_decompressor(void *_d)
1020 {
1021         struct lzms_decompressor *d = _d;
1022
1023         ALIGNED_FREE(d);
1024 }
1025
1026 const struct decompressor_ops lzms_decompressor_ops = {
1027         .create_decompressor  = lzms_create_decompressor,
1028         .decompress           = lzms_decompress,
1029         .free_decompressor    = lzms_free_decompressor,
1030 };