4 * A decompressor for the LZMS compression format.
8 * Copyright (C) 2013, 2014, 2015 Eric Biggers
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
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
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/.
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.
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.
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.
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.
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:
60 * --------------------
62 * B[1...len] A[1...len]
64 * Decoding proceeds as follows:
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:
75 * -----------------------------
78 * ------------- -------------
80 * D[1...len] C[1...len] B[1...len] A[1...len]
82 * Decoding proceeds as follows:
85 * *A++ = *B++ + *C++ - *D++;
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.
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.
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.
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.
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}.
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)}.
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.
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
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.
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.
179 * Representations of the LZMS items themselves must be read from the backwards
180 * bitstream. For this, there are 5 different Huffman codes used:
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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"
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
265 struct lzms_range_decoder {
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. */
273 /* The current position in the range encoded by the portion of the input
277 /* Pointer to the next little-endian 16-bit integer in the compressed
278 * input data (reading forwards). */
281 /* Pointer to the end of the compressed input data. */
285 typedef u64 bitbuf_t;
287 struct lzms_input_bitstream {
289 /* Holding variable for bits that have been read from the compressed
290 * data. The bit ordering is high to low. */
293 /* Number of bits currently held in @bitbuf. */
296 /* Pointer to the one past the next little-endian 16-bit integer in the
297 * compressed input data (reading backwards). */
300 /* Pointer to the beginning of the compressed input data. */
304 /* Bookkeeping information for an adaptive Huffman code */
305 struct lzms_huffman_rebuild_info {
306 unsigned num_syms_until_rebuild;
308 unsigned rebuild_freq;
315 struct lzms_decompressor {
317 /* 'last_target_usages' is in union with everything else because it is
318 * only used for postprocessing. */
322 struct lzms_range_decoder rd;
323 struct lzms_input_bitstream is;
325 /* LRU queues for match sources */
326 u32 recent_lz_offsets[LZMS_NUM_LZ_REPS + 1];
327 u64 recent_delta_pairs[LZMS_NUM_DELTA_REPS + 1];
328 u32 pending_lz_offset;
329 u64 pending_delta_pair;
330 const u8 *lz_offset_still_pending;
331 const u8 *delta_pair_still_pending;
333 /* States and probability entries for item type disambiguation */
336 struct lzms_probability_entry main_probs[LZMS_NUM_MAIN_PROBS];
339 struct lzms_probability_entry match_probs[LZMS_NUM_MATCH_PROBS];
342 struct lzms_probability_entry lz_probs[LZMS_NUM_LZ_PROBS];
345 struct lzms_probability_entry delta_probs[LZMS_NUM_DELTA_PROBS];
347 u32 lz_rep_states[LZMS_NUM_LZ_REP_DECISIONS];
348 struct lzms_probability_entry lz_rep_probs[LZMS_NUM_LZ_REP_DECISIONS]
349 [LZMS_NUM_LZ_REP_PROBS];
351 u32 delta_rep_states[LZMS_NUM_DELTA_REP_DECISIONS];
352 struct lzms_probability_entry delta_rep_probs[LZMS_NUM_DELTA_REP_DECISIONS]
353 [LZMS_NUM_DELTA_REP_PROBS];
355 /* Huffman decoding */
357 u16 literal_decode_table[(1 << LZMS_LITERAL_TABLEBITS) +
358 (2 * LZMS_NUM_LITERAL_SYMS)]
359 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
360 u32 literal_freqs[LZMS_NUM_LITERAL_SYMS];
361 struct lzms_huffman_rebuild_info literal_rebuild_info;
363 u16 lz_offset_decode_table[(1 << LZMS_LZ_OFFSET_TABLEBITS) +
364 ( 2 * LZMS_MAX_NUM_OFFSET_SYMS)]
365 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
366 u32 lz_offset_freqs[LZMS_MAX_NUM_OFFSET_SYMS];
367 struct lzms_huffman_rebuild_info lz_offset_rebuild_info;
369 u16 length_decode_table[(1 << LZMS_LENGTH_TABLEBITS) +
370 (2 * LZMS_NUM_LENGTH_SYMS)]
371 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
372 u32 length_freqs[LZMS_NUM_LENGTH_SYMS];
373 struct lzms_huffman_rebuild_info length_rebuild_info;
375 u16 delta_offset_decode_table[(1 << LZMS_DELTA_OFFSET_TABLEBITS) +
376 (2 * LZMS_MAX_NUM_OFFSET_SYMS)]
377 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
378 u32 delta_offset_freqs[LZMS_MAX_NUM_OFFSET_SYMS];
379 struct lzms_huffman_rebuild_info delta_offset_rebuild_info;
381 u16 delta_power_decode_table[(1 << LZMS_DELTA_POWER_TABLEBITS) +
382 (2 * LZMS_NUM_DELTA_POWER_SYMS)]
383 _aligned_attribute(DECODE_TABLE_ALIGNMENT);
384 u32 delta_power_freqs[LZMS_NUM_DELTA_POWER_SYMS];
385 struct lzms_huffman_rebuild_info delta_power_rebuild_info;
387 u32 codewords[LZMS_MAX_NUM_SYMS];
391 s32 last_target_usages[65536];
396 /* Initialize the input bitstream @is to read backwards from the compressed data
397 * buffer @in that is @count 16-bit integers long. */
399 lzms_input_bitstream_init(struct lzms_input_bitstream *is,
400 const le16 *in, size_t count)
404 is->next = in + count;
408 /* Ensure that at least @num_bits bits are in the bitbuffer variable.
409 * @num_bits cannot be more than 32. */
411 lzms_ensure_bits(struct lzms_input_bitstream *is, unsigned num_bits)
413 if (is->bitsleft >= num_bits)
416 if (likely(is->next != is->begin))
417 is->bitbuf |= (bitbuf_t)le16_to_cpu(*--is->next)
418 << (sizeof(is->bitbuf) * 8 - is->bitsleft - 16);
421 if (likely(is->next != is->begin))
422 is->bitbuf |= (bitbuf_t)le16_to_cpu(*--is->next)
423 << (sizeof(is->bitbuf) * 8 - is->bitsleft - 16);
427 /* Get @num_bits bits from the bitbuffer variable. */
428 static inline bitbuf_t
429 lzms_peek_bits(struct lzms_input_bitstream *is, unsigned num_bits)
431 return (is->bitbuf >> 1) >> (sizeof(is->bitbuf) * 8 - num_bits - 1);
434 /* Remove @num_bits bits from the bitbuffer variable. */
436 lzms_remove_bits(struct lzms_input_bitstream *is, unsigned num_bits)
438 is->bitbuf <<= num_bits;
439 is->bitsleft -= num_bits;
442 /* Remove and return @num_bits bits from the bitbuffer variable. */
443 static inline bitbuf_t
444 lzms_pop_bits(struct lzms_input_bitstream *is, unsigned num_bits)
446 bitbuf_t bits = lzms_peek_bits(is, num_bits);
447 lzms_remove_bits(is, num_bits);
451 /* Read @num_bits bits from the input bitstream. */
452 static inline bitbuf_t
453 lzms_read_bits(struct lzms_input_bitstream *is, unsigned num_bits)
455 lzms_ensure_bits(is, num_bits);
456 return lzms_pop_bits(is, num_bits);
459 /* Initialize the range decoder @rd to read forwards from the compressed data
460 * buffer @in that is @count 16-bit integers long. */
462 lzms_range_decoder_init(struct lzms_range_decoder *rd,
463 const le16 *in, size_t count)
465 rd->range = 0xffffffff;
466 rd->code = ((u32)le16_to_cpu(in[0]) << 16) | le16_to_cpu(in[1]);
468 rd->end = in + count;
472 * Decode and return the next bit from the range decoder.
474 * @prob is the probability out of LZMS_PROBABILITY_DENOMINATOR that the next
475 * bit is 0 rather than 1.
478 lzms_range_decode_bit(struct lzms_range_decoder *rd, u32 prob)
482 /* Normalize if needed. */
483 if (rd->range <= 0xffff) {
486 if (likely(rd->next != rd->end))
487 rd->code |= le16_to_cpu(*rd->next++);
490 /* Based on the probability, calculate the bound between the 0-bit
491 * region and the 1-bit region of the range. */
492 bound = (rd->range >> LZMS_PROBABILITY_BITS) * prob;
494 if (rd->code < bound) {
495 /* Current code is in the 0-bit region of the range. */
499 /* Current code is in the 1-bit region of the range. */
507 * Decode a bit. This wraps around lzms_range_decode_bit() to handle using and
508 * updating the state and its corresponding probability entry.
511 lzms_decode_bit(struct lzms_range_decoder *rd, u32 *state_p, u32 num_states,
512 struct lzms_probability_entry *probs)
514 struct lzms_probability_entry *prob_entry;
518 /* Load the probability entry corresponding to the current state. */
519 prob_entry = &probs[*state_p];
521 /* Get the probability that the next bit is 0. */
522 prob = lzms_get_probability(prob_entry);
524 /* Decode the next bit. */
525 bit = lzms_range_decode_bit(rd, prob);
527 /* Update the state and probability entry based on the decoded bit. */
528 *state_p = ((*state_p << 1) | bit) & (num_states - 1);
529 lzms_update_probability_entry(prob_entry, bit);
531 /* Return the decoded bit. */
536 lzms_decode_main_bit(struct lzms_decompressor *d)
538 return lzms_decode_bit(&d->rd, &d->main_state,
539 LZMS_NUM_MAIN_PROBS, d->main_probs);
543 lzms_decode_match_bit(struct lzms_decompressor *d)
545 return lzms_decode_bit(&d->rd, &d->match_state,
546 LZMS_NUM_MATCH_PROBS, d->match_probs);
550 lzms_decode_lz_bit(struct lzms_decompressor *d)
552 return lzms_decode_bit(&d->rd, &d->lz_state,
553 LZMS_NUM_LZ_PROBS, d->lz_probs);
557 lzms_decode_delta_bit(struct lzms_decompressor *d)
559 return lzms_decode_bit(&d->rd, &d->delta_state,
560 LZMS_NUM_DELTA_PROBS, d->delta_probs);
564 lzms_decode_lz_rep_bit(struct lzms_decompressor *d, int idx)
566 return lzms_decode_bit(&d->rd, &d->lz_rep_states[idx],
567 LZMS_NUM_LZ_REP_PROBS, d->lz_rep_probs[idx]);
571 lzms_decode_delta_rep_bit(struct lzms_decompressor *d, int idx)
573 return lzms_decode_bit(&d->rd, &d->delta_rep_states[idx],
574 LZMS_NUM_DELTA_REP_PROBS, d->delta_rep_probs[idx]);
578 lzms_build_huffman_code(struct lzms_huffman_rebuild_info *rebuild_info)
580 make_canonical_huffman_code(rebuild_info->num_syms,
581 LZMS_MAX_CODEWORD_LENGTH,
583 (u8 *)rebuild_info->decode_table,
584 rebuild_info->codewords);
586 make_huffman_decode_table(rebuild_info->decode_table,
587 rebuild_info->num_syms,
588 rebuild_info->table_bits,
589 (u8 *)rebuild_info->decode_table,
590 LZMS_MAX_CODEWORD_LENGTH);
592 rebuild_info->num_syms_until_rebuild = rebuild_info->rebuild_freq;
596 lzms_init_huffman_code(struct lzms_huffman_rebuild_info *rebuild_info,
597 unsigned num_syms, unsigned rebuild_freq,
598 u32 *codewords, u32 *freqs,
599 u16 *decode_table, unsigned table_bits)
601 rebuild_info->num_syms = num_syms;
602 rebuild_info->rebuild_freq = rebuild_freq;
603 rebuild_info->codewords = codewords;
604 rebuild_info->freqs = freqs;
605 rebuild_info->decode_table = decode_table;
606 rebuild_info->table_bits = table_bits;
607 lzms_init_symbol_frequencies(freqs, num_syms);
608 lzms_build_huffman_code(rebuild_info);
612 lzms_rebuild_huffman_code(struct lzms_huffman_rebuild_info *rebuild_info)
614 lzms_build_huffman_code(rebuild_info);
615 lzms_dilute_symbol_frequencies(rebuild_info->freqs, rebuild_info->num_syms);
618 static inline unsigned
619 lzms_decode_huffman_symbol(struct lzms_input_bitstream *is, u16 decode_table[],
620 unsigned table_bits, u32 freqs[],
621 struct lzms_huffman_rebuild_info *rebuild_info)
627 lzms_ensure_bits(is, LZMS_MAX_CODEWORD_LENGTH);
629 /* Index the decode table by the next table_bits bits of the input. */
630 key_bits = lzms_peek_bits(is, table_bits);
631 entry = decode_table[key_bits];
632 if (likely(entry < 0xC000)) {
633 /* Fast case: The decode table directly provided the symbol and
634 * codeword length. The low 11 bits are the symbol, and the
635 * high 5 bits are the codeword length. */
636 lzms_remove_bits(is, entry >> 11);
639 /* Slow case: The codeword for the symbol is longer than
640 * table_bits, so the symbol does not have an entry directly in
641 * the first (1 << table_bits) entries of the decode table.
642 * Traverse the appropriate binary tree bit-by-bit in order to
643 * decode the symbol. */
644 lzms_remove_bits(is, table_bits);
646 key_bits = (entry & 0x3FFF) + lzms_pop_bits(is, 1);
647 } while ((entry = decode_table[key_bits]) >= 0xC000);
652 if (--rebuild_info->num_syms_until_rebuild == 0)
653 lzms_rebuild_huffman_code(rebuild_info);
658 lzms_decode_literal(struct lzms_decompressor *d)
660 return lzms_decode_huffman_symbol(&d->is,
661 d->literal_decode_table,
662 LZMS_LITERAL_TABLEBITS,
664 &d->literal_rebuild_info);
668 lzms_decode_lz_offset(struct lzms_decompressor *d)
670 unsigned slot = lzms_decode_huffman_symbol(&d->is,
671 d->lz_offset_decode_table,
672 LZMS_LZ_OFFSET_TABLEBITS,
674 &d->lz_offset_rebuild_info);
675 return lzms_offset_slot_base[slot] +
676 lzms_read_bits(&d->is, lzms_extra_offset_bits[slot]);
680 lzms_decode_length(struct lzms_decompressor *d)
682 unsigned slot = lzms_decode_huffman_symbol(&d->is,
683 d->length_decode_table,
684 LZMS_LENGTH_TABLEBITS,
686 &d->length_rebuild_info);
687 u32 length = lzms_length_slot_base[slot];
688 unsigned num_extra_bits = lzms_extra_length_bits[slot];
689 /* Usually most lengths are short and have no extra bits. */
691 length += lzms_read_bits(&d->is, num_extra_bits);
696 lzms_decode_delta_offset(struct lzms_decompressor *d)
698 unsigned slot = lzms_decode_huffman_symbol(&d->is,
699 d->delta_offset_decode_table,
700 LZMS_DELTA_OFFSET_TABLEBITS,
701 d->delta_offset_freqs,
702 &d->delta_offset_rebuild_info);
703 return lzms_offset_slot_base[slot] +
704 lzms_read_bits(&d->is, lzms_extra_offset_bits[slot]);
708 lzms_decode_delta_power(struct lzms_decompressor *d)
710 return lzms_decode_huffman_symbol(&d->is,
711 d->delta_power_decode_table,
712 LZMS_DELTA_POWER_TABLEBITS,
713 d->delta_power_freqs,
714 &d->delta_power_rebuild_info);
717 /* Decode the series of literals and matches from the LZMS-compressed data.
718 * Return 0 if successful or -1 if the compressed data is invalid. */
720 lzms_decode_items(struct lzms_decompressor * const restrict d,
721 u8 * const restrict out, const size_t out_nbytes)
724 u8 * const out_end = out + out_nbytes;
726 while (out_next != out_end) {
728 if (!lzms_decode_main_bit(d)) {
731 *out_next++ = lzms_decode_literal(d);
733 } else if (!lzms_decode_match_bit(d)) {
740 if (!lzms_decode_lz_bit(d)) {
741 /* Explicit offset */
742 offset = lzms_decode_lz_offset(d);
746 if (d->pending_lz_offset != 0 &&
747 out_next != d->lz_offset_still_pending)
749 BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
750 d->recent_lz_offsets[3] = d->recent_lz_offsets[2];
751 d->recent_lz_offsets[2] = d->recent_lz_offsets[1];
752 d->recent_lz_offsets[1] = d->recent_lz_offsets[0];
753 d->recent_lz_offsets[0] = d->pending_lz_offset;
754 d->pending_lz_offset = 0;
757 BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
758 if (!lzms_decode_lz_rep_bit(d, 0)) {
759 offset = d->recent_lz_offsets[0];
760 d->recent_lz_offsets[0] = 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 if (!lzms_decode_lz_rep_bit(d, 1)) {
764 offset = d->recent_lz_offsets[1];
765 d->recent_lz_offsets[1] = d->recent_lz_offsets[2];
766 d->recent_lz_offsets[2] = d->recent_lz_offsets[3];
768 offset = d->recent_lz_offsets[2];
769 d->recent_lz_offsets[2] = d->recent_lz_offsets[3];
773 if (d->pending_lz_offset != 0) {
774 BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
775 d->recent_lz_offsets[3] = d->recent_lz_offsets[2];
776 d->recent_lz_offsets[2] = d->recent_lz_offsets[1];
777 d->recent_lz_offsets[1] = d->recent_lz_offsets[0];
778 d->recent_lz_offsets[0] = d->pending_lz_offset;
780 d->pending_lz_offset = offset;
782 length = lzms_decode_length(d);
784 if (unlikely(length > out_end - out_next))
786 if (unlikely(offset > out_next - out))
789 lz_copy(out_next, length, offset, out_end, LZMS_MIN_MATCH_LENGTH);
792 d->lz_offset_still_pending = out_next;
796 /* (See beginning of file for more information.) */
805 if (!lzms_decode_delta_bit(d)) {
806 /* Explicit offset */
807 power = lzms_decode_delta_power(d);
808 raw_offset = lzms_decode_delta_offset(d);
813 if (d->pending_delta_pair != 0 &&
814 out_next != d->delta_pair_still_pending)
816 BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
817 d->recent_delta_pairs[3] = d->recent_delta_pairs[2];
818 d->recent_delta_pairs[2] = d->recent_delta_pairs[1];
819 d->recent_delta_pairs[1] = d->recent_delta_pairs[0];
820 d->recent_delta_pairs[0] = d->pending_delta_pair;
821 d->pending_delta_pair = 0;
824 BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
825 if (!lzms_decode_delta_rep_bit(d, 0)) {
826 val = d->recent_delta_pairs[0];
827 d->recent_delta_pairs[0] = 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 if (!lzms_decode_delta_rep_bit(d, 1)) {
831 val = d->recent_delta_pairs[1];
832 d->recent_delta_pairs[1] = d->recent_delta_pairs[2];
833 d->recent_delta_pairs[2] = d->recent_delta_pairs[3];
835 val = d->recent_delta_pairs[2];
836 d->recent_delta_pairs[2] = d->recent_delta_pairs[3];
839 raw_offset = (u32)val;
842 if (d->pending_delta_pair != 0) {
843 BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
844 d->recent_delta_pairs[3] = d->recent_delta_pairs[2];
845 d->recent_delta_pairs[2] = d->recent_delta_pairs[1];
846 d->recent_delta_pairs[1] = d->recent_delta_pairs[0];
847 d->recent_delta_pairs[0] = d->pending_delta_pair;
849 d->pending_delta_pair = raw_offset | ((u64)power << 32);
851 length = lzms_decode_length(d);
853 span = (u32)1 << power;
854 offset = raw_offset << power;
856 /* raw_offset<<power overflows? */
857 if (unlikely(offset >> power != raw_offset))
860 /* offset+span overflows? */
861 if (unlikely(offset + span < offset))
864 /* buffer underrun? */
865 if (unlikely(offset + span > out_next - out))
868 /* buffer overrun? */
869 if (unlikely(length > out_end - out_next))
872 matchptr = out_next - offset;
874 *out_next = *matchptr + *(out_next - span) -
880 d->delta_pair_still_pending = out_next;
887 lzms_init_decompressor(struct lzms_decompressor *d, const void *in,
888 size_t in_nbytes, unsigned num_offset_slots)
890 /* Match offset LRU queues */
891 for (int i = 0; i < LZMS_NUM_LZ_REPS + 1; i++)
892 d->recent_lz_offsets[i] = i + 1;
893 for (int i = 0; i < LZMS_NUM_DELTA_REPS + 1; i++)
894 d->recent_delta_pairs[i] = i + 1;
895 d->pending_lz_offset = 0;
896 d->pending_delta_pair = 0;
900 lzms_range_decoder_init(&d->rd, in, in_nbytes / sizeof(le16));
903 lzms_init_probability_entries(d->main_probs, LZMS_NUM_MAIN_PROBS);
906 lzms_init_probability_entries(d->match_probs, LZMS_NUM_MATCH_PROBS);
909 lzms_init_probability_entries(d->lz_probs, LZMS_NUM_LZ_PROBS);
911 for (int i = 0; i < LZMS_NUM_LZ_REP_DECISIONS; i++) {
912 d->lz_rep_states[i] = 0;
913 lzms_init_probability_entries(d->lz_rep_probs[i],
914 LZMS_NUM_LZ_REP_PROBS);
918 lzms_init_probability_entries(d->delta_probs, LZMS_NUM_DELTA_PROBS);
920 for (int i = 0; i < LZMS_NUM_DELTA_REP_DECISIONS; i++) {
921 d->delta_rep_states[i] = 0;
922 lzms_init_probability_entries(d->delta_rep_probs[i],
923 LZMS_NUM_DELTA_REP_PROBS);
926 /* Huffman decoding */
928 lzms_input_bitstream_init(&d->is, in, in_nbytes / sizeof(le16));
930 lzms_init_huffman_code(&d->literal_rebuild_info,
931 LZMS_NUM_LITERAL_SYMS,
932 LZMS_LITERAL_CODE_REBUILD_FREQ,
935 d->literal_decode_table,
936 LZMS_LITERAL_TABLEBITS);
938 lzms_init_huffman_code(&d->lz_offset_rebuild_info,
940 LZMS_LZ_OFFSET_CODE_REBUILD_FREQ,
943 d->lz_offset_decode_table,
944 LZMS_LZ_OFFSET_TABLEBITS);
946 lzms_init_huffman_code(&d->length_rebuild_info,
947 LZMS_NUM_LENGTH_SYMS,
948 LZMS_LENGTH_CODE_REBUILD_FREQ,
951 d->length_decode_table,
952 LZMS_LENGTH_TABLEBITS);
954 lzms_init_huffman_code(&d->delta_offset_rebuild_info,
956 LZMS_DELTA_OFFSET_CODE_REBUILD_FREQ,
958 d->delta_offset_freqs,
959 d->delta_offset_decode_table,
960 LZMS_DELTA_OFFSET_TABLEBITS);
962 lzms_init_huffman_code(&d->delta_power_rebuild_info,
963 LZMS_NUM_DELTA_POWER_SYMS,
964 LZMS_DELTA_POWER_CODE_REBUILD_FREQ,
966 d->delta_power_freqs,
967 d->delta_power_decode_table,
968 LZMS_DELTA_POWER_TABLEBITS);
972 lzms_create_decompressor(size_t max_bufsize, void **d_ret)
974 struct lzms_decompressor *d;
976 if (max_bufsize > LZMS_MAX_BUFFER_SIZE)
977 return WIMLIB_ERR_INVALID_PARAM;
979 d = ALIGNED_MALLOC(sizeof(struct lzms_decompressor),
980 DECODE_TABLE_ALIGNMENT);
982 return WIMLIB_ERR_NOMEM;
989 * Decompress @in_nbytes bytes of LZMS-compressed data at @in and write the
990 * uncompressed data, which had original size @out_nbytes, to @out. Return 0 if
991 * successful or -1 if the compressed data is invalid.
994 lzms_decompress(const void *in, size_t in_nbytes, void *out, size_t out_nbytes,
997 struct lzms_decompressor *d = _d;
1000 * Requirements on the compressed data:
1002 * 1. LZMS-compressed data is a series of 16-bit integers, so the
1003 * compressed data buffer cannot take up an odd number of bytes.
1004 * 2. To prevent poor performance on some architectures, we require that
1005 * the compressed data buffer is 2-byte aligned.
1006 * 3. There must be at least 4 bytes of compressed data, since otherwise
1007 * we cannot even initialize the range decoder.
1009 if ((in_nbytes & 1) || ((uintptr_t)in & 1) || (in_nbytes < 4))
1012 lzms_init_decompressor(d, in, in_nbytes,
1013 lzms_get_num_offset_slots(out_nbytes));
1015 if (lzms_decode_items(d, out, out_nbytes))
1018 lzms_x86_filter(out, out_nbytes, d->last_target_usages, true);
1023 lzms_free_decompressor(void *_d)
1025 struct lzms_decompressor *d = _d;
1030 const struct decompressor_ops lzms_decompressor_ops = {
1031 .create_decompressor = lzms_create_decompressor,
1032 .decompress = lzms_decompress,
1033 .free_decompressor = lzms_free_decompressor,