Optimize Huffman code generation
[wimlib] / src / lzms-compress.c
1 /*
2  * lzms-compress.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 /* This a compressor for the LZMS compression format.  More details about this
25  * format can be found in lzms-decompress.c.
26  *
27  * NOTE: this compressor currently does not code any delta matches.
28  */
29
30 #ifdef HAVE_CONFIG_H
31 #  include "config.h"
32 #endif
33
34 #include "wimlib.h"
35 #include "wimlib/assert.h"
36 #include "wimlib/compiler.h"
37 #include "wimlib/compressor_ops.h"
38 #include "wimlib/compress_common.h"
39 #include "wimlib/endianness.h"
40 #include "wimlib/error.h"
41 #include "wimlib/lz_sarray.h"
42 #include "wimlib/lzms.h"
43 #include "wimlib/util.h"
44
45 #include <string.h>
46 #include <limits.h>
47 #include <pthread.h>
48
49 struct lzms_compressor;
50 struct lzms_adaptive_state {
51         struct lzms_lz_lru_queues lru;
52         u8 main_state;
53         u8 match_state;
54         u8 lz_match_state;
55         u8 lz_repeat_match_state[LZMS_NUM_RECENT_OFFSETS - 1];
56 };
57 #define LZ_ADAPTIVE_STATE struct lzms_adaptive_state
58 #define LZ_COMPRESSOR     struct lzms_compressor
59 #include "wimlib/lz_optimal.h"
60
61 /* Stucture used for writing raw bits to the end of the LZMS-compressed data as
62  * a series of 16-bit little endian coding units.  */
63 struct lzms_output_bitstream {
64         /* Buffer variable containing zero or more bits that have been logically
65          * written to the bitstream but not yet written to memory.  This must be
66          * at least as large as the coding unit size.  */
67         u16 bitbuf;
68
69         /* Number of bits in @bitbuf that are valid.  */
70         unsigned num_free_bits;
71
72         /* Pointer to one past the next position in the compressed data buffer
73          * at which to output a 16-bit coding unit.  */
74         le16 *out;
75
76         /* Maximum number of 16-bit coding units that can still be output to
77          * the compressed data buffer.  */
78         size_t num_le16_remaining;
79
80         /* Set to %true if not all coding units could be output due to
81          * insufficient space.  */
82         bool overrun;
83 };
84
85 /* Stucture used for range encoding (raw version).  */
86 struct lzms_range_encoder_raw {
87
88         /* A 33-bit variable that holds the low boundary of the current range.
89          * The 33rd bit is needed to catch carries.  */
90         u64 low;
91
92         /* Size of the current range.  */
93         u32 range;
94
95         /* Next 16-bit coding unit to output.  */
96         u16 cache;
97
98         /* Number of 16-bit coding units whose output has been delayed due to
99          * possible carrying.  The first such coding unit is @cache; all
100          * subsequent such coding units are 0xffff.  */
101         u32 cache_size;
102
103         /* Pointer to the next position in the compressed data buffer at which
104          * to output a 16-bit coding unit.  */
105         le16 *out;
106
107         /* Maximum number of 16-bit coding units that can still be output to
108          * the compressed data buffer.  */
109         size_t num_le16_remaining;
110
111         /* %true when the very first coding unit has not yet been output.  */
112         bool first;
113
114         /* Set to %true if not all coding units could be output due to
115          * insufficient space.  */
116         bool overrun;
117 };
118
119 /* Structure used for range encoding.  This wraps around `struct
120  * lzms_range_encoder_raw' to use and maintain probability entries.  */
121 struct lzms_range_encoder {
122         /* Pointer to the raw range encoder, which has no persistent knowledge
123          * of probabilities.  Multiple lzms_range_encoder's share the same
124          * lzms_range_encoder_raw.  */
125         struct lzms_range_encoder_raw *rc;
126
127         /* Bits recently encoded by this range encoder.  This are used as in
128          * index into @prob_entries.  */
129         u32 state;
130
131         /* Bitmask for @state to prevent its value from exceeding the number of
132          * probability entries.  */
133         u32 mask;
134
135         /* Probability entries being used for this range encoder.  */
136         struct lzms_probability_entry prob_entries[LZMS_MAX_NUM_STATES];
137 };
138
139 /* Structure used for Huffman encoding.  */
140 struct lzms_huffman_encoder {
141
142         /* Bitstream to write Huffman-encoded symbols and verbatim bits to.
143          * Multiple lzms_huffman_encoder's share the same lzms_output_bitstream.
144          */
145         struct lzms_output_bitstream *os;
146
147         /* Number of symbols that have been written using this code far.  Reset
148          * to 0 whenever the code is rebuilt.  */
149         u32 num_syms_written;
150
151         /* When @num_syms_written reaches this number, the Huffman code must be
152          * rebuilt.  */
153         u32 rebuild_freq;
154
155         /* Number of symbols in the represented Huffman code.  */
156         unsigned num_syms;
157
158         /* Running totals of symbol frequencies.  These are diluted slightly
159          * whenever the code is rebuilt.  */
160         u32 sym_freqs[LZMS_MAX_NUM_SYMS];
161
162         /* The length, in bits, of each symbol in the Huffman code.  */
163         u8 lens[LZMS_MAX_NUM_SYMS];
164
165         /* The codeword of each symbol in the Huffman code.  */
166         u32 codewords[LZMS_MAX_NUM_SYMS];
167 };
168
169 /* State of the LZMS compressor.  */
170 struct lzms_compressor {
171         /* Pointer to a buffer holding the preprocessed data to compress.  */
172         u8 *window;
173
174         /* Current position in @buffer.  */
175         u32 cur_window_pos;
176
177         /* Size of the data in @buffer.  */
178         u32 window_size;
179
180         /* Suffix array match-finder.  */
181         struct lz_sarray lz_sarray;
182
183         /* Temporary space to store found matches.  */
184         struct raw_match *matches;
185
186         /* Match-chooser.  */
187         struct lz_match_chooser mc;
188
189         /* Maximum block size this compressor instantiation allows.  This is the
190          * allocated size of @window.  */
191         u32 max_block_size;
192
193         /* Raw range encoder which outputs to the beginning of the compressed
194          * data buffer, proceeding forwards.  */
195         struct lzms_range_encoder_raw rc;
196
197         /* Bitstream which outputs to the end of the compressed data buffer,
198          * proceeding backwards.  */
199         struct lzms_output_bitstream os;
200
201         /* Range encoders.  */
202         struct lzms_range_encoder main_range_encoder;
203         struct lzms_range_encoder match_range_encoder;
204         struct lzms_range_encoder lz_match_range_encoder;
205         struct lzms_range_encoder lz_repeat_match_range_encoders[LZMS_NUM_RECENT_OFFSETS - 1];
206         struct lzms_range_encoder delta_match_range_encoder;
207         struct lzms_range_encoder delta_repeat_match_range_encoders[LZMS_NUM_RECENT_OFFSETS - 1];
208
209         /* Huffman encoders.  */
210         struct lzms_huffman_encoder literal_encoder;
211         struct lzms_huffman_encoder lz_offset_encoder;
212         struct lzms_huffman_encoder length_encoder;
213         struct lzms_huffman_encoder delta_power_encoder;
214         struct lzms_huffman_encoder delta_offset_encoder;
215
216         /* LRU (least-recently-used) queues for match information.  */
217         struct lzms_lru_queues lru;
218
219         /* Used for preprocessing.  */
220         s32 last_target_usages[65536];
221 };
222
223 /* Initialize the output bitstream @os to write forwards to the specified
224  * compressed data buffer @out that is @out_limit 16-bit integers long.  */
225 static void
226 lzms_output_bitstream_init(struct lzms_output_bitstream *os,
227                            le16 *out, size_t out_limit)
228 {
229         os->bitbuf = 0;
230         os->num_free_bits = 16;
231         os->out = out + out_limit;
232         os->num_le16_remaining = out_limit;
233         os->overrun = false;
234 }
235
236 /* Write @num_bits bits, contained in the low @num_bits bits of @bits (ordered
237  * from high-order to low-order), to the output bitstream @os.  */
238 static void
239 lzms_output_bitstream_put_bits(struct lzms_output_bitstream *os,
240                                u32 bits, unsigned num_bits)
241 {
242         bits &= (1U << num_bits) - 1;
243
244         while (num_bits > os->num_free_bits) {
245
246                 if (unlikely(os->num_le16_remaining == 0)) {
247                         os->overrun = true;
248                         return;
249                 }
250
251                 unsigned num_fill_bits = os->num_free_bits;
252
253                 os->bitbuf <<= num_fill_bits;
254                 os->bitbuf |= bits >> (num_bits - num_fill_bits);
255
256                 *--os->out = cpu_to_le16(os->bitbuf);
257                 --os->num_le16_remaining;
258
259                 os->num_free_bits = 16;
260                 num_bits -= num_fill_bits;
261                 bits &= (1U << num_bits) - 1;
262         }
263         os->bitbuf <<= num_bits;
264         os->bitbuf |= bits;
265         os->num_free_bits -= num_bits;
266 }
267
268 /* Flush the output bitstream, ensuring that all bits written to it have been
269  * written to memory.  Returns %true if all bits were output successfully, or
270  * %false if an overrun occurred.  */
271 static bool
272 lzms_output_bitstream_flush(struct lzms_output_bitstream *os)
273 {
274         if (os->num_free_bits != 16)
275                 lzms_output_bitstream_put_bits(os, 0, os->num_free_bits + 1);
276         return !os->overrun;
277 }
278
279 /* Initialize the range encoder @rc to write forwards to the specified
280  * compressed data buffer @out that is @out_limit 16-bit integers long.  */
281 static void
282 lzms_range_encoder_raw_init(struct lzms_range_encoder_raw *rc,
283                             le16 *out, size_t out_limit)
284 {
285         rc->low = 0;
286         rc->range = 0xffffffff;
287         rc->cache = 0;
288         rc->cache_size = 1;
289         rc->out = out;
290         rc->num_le16_remaining = out_limit;
291         rc->first = true;
292         rc->overrun = false;
293 }
294
295 /*
296  * Attempt to flush bits from the range encoder.
297  *
298  * Note: this is based on the public domain code for LZMA written by Igor
299  * Pavlov.  The only differences in this function are that in LZMS the bits must
300  * be output in 16-bit coding units instead of 8-bit coding units, and that in
301  * LZMS the first coding unit is not ignored by the decompressor, so the encoder
302  * cannot output a dummy value to that position.
303  *
304  * The basic idea is that we're writing bits from @rc->low to the output.
305  * However, due to carrying, the writing of coding units with value 0xffff, as
306  * well as one prior coding unit, must be delayed until it is determined whether
307  * a carry is needed.
308  */
309 static void
310 lzms_range_encoder_raw_shift_low(struct lzms_range_encoder_raw *rc)
311 {
312         LZMS_DEBUG("low=%"PRIx64", cache=%"PRIx64", cache_size=%u",
313                    rc->low, rc->cache, rc->cache_size);
314         if ((u32)(rc->low) < 0xffff0000 ||
315             (u32)(rc->low >> 32) != 0)
316         {
317                 /* Carry not needed (rc->low < 0xffff0000), or carry occurred
318                  * ((rc->low >> 32) != 0, a.k.a. the carry bit is 1).  */
319                 do {
320                         if (!rc->first) {
321                                 if (rc->num_le16_remaining == 0) {
322                                         rc->overrun = true;
323                                         return;
324                                 }
325                                 *rc->out++ = cpu_to_le16(rc->cache +
326                                                          (u16)(rc->low >> 32));
327                                 --rc->num_le16_remaining;
328                         } else {
329                                 rc->first = false;
330                         }
331
332                         rc->cache = 0xffff;
333                 } while (--rc->cache_size != 0);
334
335                 rc->cache = (rc->low >> 16) & 0xffff;
336         }
337         ++rc->cache_size;
338         rc->low = (rc->low & 0xffff) << 16;
339 }
340
341 static void
342 lzms_range_encoder_raw_normalize(struct lzms_range_encoder_raw *rc)
343 {
344         if (rc->range <= 0xffff) {
345                 rc->range <<= 16;
346                 lzms_range_encoder_raw_shift_low(rc);
347         }
348 }
349
350 static bool
351 lzms_range_encoder_raw_flush(struct lzms_range_encoder_raw *rc)
352 {
353         for (unsigned i = 0; i < 4; i++)
354                 lzms_range_encoder_raw_shift_low(rc);
355         return !rc->overrun;
356 }
357
358 /* Encode the next bit using the range encoder (raw version).
359  *
360  * @prob is the chance out of LZMS_PROBABILITY_MAX that the next bit is 0.  */
361 static void
362 lzms_range_encoder_raw_encode_bit(struct lzms_range_encoder_raw *rc, int bit,
363                                   u32 prob)
364 {
365         lzms_range_encoder_raw_normalize(rc);
366
367         u32 bound = (rc->range >> LZMS_PROBABILITY_BITS) * prob;
368         if (bit == 0) {
369                 rc->range = bound;
370         } else {
371                 rc->low += bound;
372                 rc->range -= bound;
373         }
374 }
375
376 /* Encode a bit using the specified range encoder. This wraps around
377  * lzms_range_encoder_raw_encode_bit() to handle using and updating the
378  * appropriate probability table.  */
379 static void
380 lzms_range_encode_bit(struct lzms_range_encoder *enc, int bit)
381 {
382         struct lzms_probability_entry *prob_entry;
383         u32 prob;
384
385         /* Load the probability entry corresponding to the current state.  */
386         prob_entry = &enc->prob_entries[enc->state];
387
388         /* Treat the number of zero bits in the most recently encoded
389          * LZMS_PROBABILITY_MAX bits with this probability entry as the chance,
390          * out of LZMS_PROBABILITY_MAX, that the next bit will be a 0.  However,
391          * don't allow 0% or 100% probabilities.  */
392         prob = prob_entry->num_recent_zero_bits;
393         if (prob == 0)
394                 prob = 1;
395         else if (prob == LZMS_PROBABILITY_MAX)
396                 prob = LZMS_PROBABILITY_MAX - 1;
397
398         /* Encode the next bit.  */
399         lzms_range_encoder_raw_encode_bit(enc->rc, bit, prob);
400
401         /* Update the state based on the newly encoded bit.  */
402         enc->state = ((enc->state << 1) | bit) & enc->mask;
403
404         /* Update the recent bits, including the cached count of 0's.  */
405         BUILD_BUG_ON(LZMS_PROBABILITY_MAX > sizeof(prob_entry->recent_bits) * 8);
406         if (bit == 0) {
407                 if (prob_entry->recent_bits & (1ULL << (LZMS_PROBABILITY_MAX - 1))) {
408                         /* Replacing 1 bit with 0 bit; increment the zero count.
409                          */
410                         prob_entry->num_recent_zero_bits++;
411                 }
412         } else {
413                 if (!(prob_entry->recent_bits & (1ULL << (LZMS_PROBABILITY_MAX - 1)))) {
414                         /* Replacing 0 bit with 1 bit; decrement the zero count.
415                          */
416                         prob_entry->num_recent_zero_bits--;
417                 }
418         }
419         prob_entry->recent_bits = (prob_entry->recent_bits << 1) | bit;
420 }
421
422 /* Encode a symbol using the specified Huffman encoder.  */
423 static void
424 lzms_huffman_encode_symbol(struct lzms_huffman_encoder *enc, u32 sym)
425 {
426         LZMS_ASSERT(sym < enc->num_syms);
427         lzms_output_bitstream_put_bits(enc->os,
428                                        enc->codewords[sym],
429                                        enc->lens[sym]);
430         ++enc->sym_freqs[sym];
431         if (++enc->num_syms_written == enc->rebuild_freq) {
432                 /* Adaptive code needs to be rebuilt.  */
433                 LZMS_DEBUG("Rebuilding code (num_syms=%u)", enc->num_syms);
434                 make_canonical_huffman_code(enc->num_syms,
435                                             LZMS_MAX_CODEWORD_LEN,
436                                             enc->sym_freqs,
437                                             enc->lens,
438                                             enc->codewords);
439
440                 /* Dilute the frequencies.  */
441                 for (unsigned i = 0; i < enc->num_syms; i++) {
442                         enc->sym_freqs[i] >>= 1;
443                         enc->sym_freqs[i] += 1;
444                 }
445                 enc->num_syms_written = 0;
446         }
447 }
448
449 static void
450 lzms_encode_length(struct lzms_huffman_encoder *enc, u32 length)
451 {
452         unsigned slot;
453         unsigned num_extra_bits;
454         u32 extra_bits;
455
456         slot = lzms_get_length_slot(length);
457
458         num_extra_bits = lzms_extra_length_bits[slot];
459
460         extra_bits = length - lzms_length_slot_base[slot];
461
462         lzms_huffman_encode_symbol(enc, slot);
463         lzms_output_bitstream_put_bits(enc->os, extra_bits, num_extra_bits);
464 }
465
466 static void
467 lzms_encode_offset(struct lzms_huffman_encoder *enc, u32 offset)
468 {
469         unsigned slot;
470         unsigned num_extra_bits;
471         u32 extra_bits;
472
473         slot = lzms_get_position_slot(offset);
474
475         num_extra_bits = lzms_extra_position_bits[slot];
476
477         extra_bits = offset - lzms_position_slot_base[slot];
478
479         lzms_huffman_encode_symbol(enc, slot);
480         lzms_output_bitstream_put_bits(enc->os, extra_bits, num_extra_bits);
481 }
482
483 static void
484 lzms_begin_encode_item(struct lzms_compressor *ctx)
485 {
486         ctx->lru.lz.upcoming_offset = 0;
487         ctx->lru.delta.upcoming_offset = 0;
488         ctx->lru.delta.upcoming_power = 0;
489 }
490
491 static void
492 lzms_end_encode_item(struct lzms_compressor *ctx, u32 length)
493 {
494         LZMS_ASSERT(ctx->window_size - ctx->cur_window_pos >= length);
495         ctx->cur_window_pos += length;
496         lzms_update_lru_queues(&ctx->lru);
497 }
498
499 /* Encode a literal byte.  */
500 static void
501 lzms_encode_literal(struct lzms_compressor *ctx, u8 literal)
502 {
503         LZMS_DEBUG("Position %u: Encoding literal 0x%02x ('%c')",
504                    ctx->cur_window_pos, literal, literal);
505
506         lzms_begin_encode_item(ctx);
507
508         /* Main bit: 0 = a literal, not a match.  */
509         lzms_range_encode_bit(&ctx->main_range_encoder, 0);
510
511         /* Encode the literal using the current literal Huffman code.  */
512         lzms_huffman_encode_symbol(&ctx->literal_encoder, literal);
513
514         lzms_end_encode_item(ctx, 1);
515 }
516
517 /* Encode a (length, offset) pair (LZ match).  */
518 static void
519 lzms_encode_lz_match(struct lzms_compressor *ctx, u32 length, u32 offset)
520 {
521         int recent_offset_idx;
522
523         LZMS_DEBUG("Position %u: Encoding LZ match {length=%u, offset=%u}",
524                    ctx->cur_window_pos, length, offset);
525
526         LZMS_ASSERT(length <= ctx->window_size - ctx->cur_window_pos);
527         LZMS_ASSERT(offset <= ctx->cur_window_pos);
528         LZMS_ASSERT(!memcmp(&ctx->window[ctx->cur_window_pos],
529                             &ctx->window[ctx->cur_window_pos - offset],
530                             length));
531
532         lzms_begin_encode_item(ctx);
533
534         /* Main bit: 1 = a match, not a literal.  */
535         lzms_range_encode_bit(&ctx->main_range_encoder, 1);
536
537         /* Match bit: 0 = an LZ match, not a delta match.  */
538         lzms_range_encode_bit(&ctx->match_range_encoder, 0);
539
540         /* Determine if the offset can be represented as a recent offset.  */
541         for (recent_offset_idx = 0;
542              recent_offset_idx < LZMS_NUM_RECENT_OFFSETS;
543              recent_offset_idx++)
544                 if (offset == ctx->lru.lz.recent_offsets[recent_offset_idx])
545                         break;
546
547         if (recent_offset_idx == LZMS_NUM_RECENT_OFFSETS) {
548                 /* Explicit offset.  */
549
550                 /* LZ match bit: 0 = explicit offset, not a recent offset.  */
551                 lzms_range_encode_bit(&ctx->lz_match_range_encoder, 0);
552
553                 /* Encode the match offset.  */
554                 lzms_encode_offset(&ctx->lz_offset_encoder, offset);
555         } else {
556                 int i;
557
558                 /* Recent offset.  */
559
560                 /* LZ match bit: 1 = recent offset, not an explicit offset.  */
561                 lzms_range_encode_bit(&ctx->lz_match_range_encoder, 1);
562
563                 /* Encode the recent offset index.  A 1 bit is encoded for each
564                  * index passed up.  This sequence of 1 bits is terminated by a
565                  * 0 bit, or automatically when (LZMS_NUM_RECENT_OFFSETS - 1) 1
566                  * bits have been encoded.  */
567                 for (i = 0; i < recent_offset_idx; i++)
568                         lzms_range_encode_bit(&ctx->lz_repeat_match_range_encoders[i], 1);
569
570                 if (i < LZMS_NUM_RECENT_OFFSETS - 1)
571                         lzms_range_encode_bit(&ctx->lz_repeat_match_range_encoders[i], 0);
572
573                 /* Initial update of the LZ match offset LRU queue.  */
574                 for (; i < LZMS_NUM_RECENT_OFFSETS; i++)
575                         ctx->lru.lz.recent_offsets[i] = ctx->lru.lz.recent_offsets[i + 1];
576         }
577
578         /* Encode the match length.  */
579         lzms_encode_length(&ctx->length_encoder, length);
580
581         /* Save the match offset for later insertion at the front of the LZ
582          * match offset LRU queue.  */
583         ctx->lru.lz.upcoming_offset = offset;
584
585         lzms_end_encode_item(ctx, length);
586 }
587
588 /* Fast heuristic cost evaluation to use in the inner loop of the match-finder.
589  * Unlike lzms_get_lz_match_cost(), which does a true cost evaluation, this
590  * simply prioritize matches based on their offset.  */
591 static input_idx_t
592 lzms_lz_match_cost_fast(input_idx_t length, input_idx_t offset, const void *_lru)
593 {
594         const struct lzms_lz_lru_queues *lru = _lru;
595
596         for (input_idx_t i = 0; i < LZMS_NUM_RECENT_OFFSETS; i++)
597                 if (offset == lru->recent_offsets[i])
598                         return i;
599
600         return offset;
601 }
602
603 #define LZMS_COST_SHIFT 5
604
605 /*#define LZMS_RC_COSTS_USE_FLOATING_POINT*/
606
607 static u32
608 lzms_rc_costs[LZMS_PROBABILITY_MAX + 1];
609
610 #ifdef LZMS_RC_COSTS_USE_FLOATING_POINT
611 #  include <math.h>
612 #endif
613
614 static void
615 lzms_do_init_rc_costs(void)
616 {
617         /* Fill in a table that maps range coding probabilities needed to code a
618          * bit X (0 or 1) to the number of bits (scaled by a constant factor, to
619          * handle fractional costs) needed to code that bit X.
620          *
621          * Consider the range of the range decoder.  To eliminate exactly half
622          * the range (logical probability of 0.5), we need exactly 1 bit.  For
623          * lower probabilities we need more bits and for higher probabilities we
624          * need fewer bits.  In general, a logical probability of N will
625          * eliminate the proportion 1 - N of the range; this information takes
626          * log2(1 / N) bits to encode.
627          *
628          * The below loop is simply calculating this number of bits for each
629          * possible probability allowed by the LZMS compression format, but
630          * without using real numbers.  To handle fractional probabilities, each
631          * cost is multiplied by (1 << LZMS_COST_SHIFT).  These techniques are
632          * based on those used by LZMA.
633          *
634          * Note that in LZMS, a probability x really means x / 64, and 0 / 64 is
635          * really interpreted as 1 / 64 and 64 / 64 is really interpreted as
636          * 63 / 64.
637          */
638         for (u32 i = 0; i <= LZMS_PROBABILITY_MAX; i++) {
639                 u32 prob = i;
640
641                 if (prob == 0)
642                         prob = 1;
643                 else if (prob == LZMS_PROBABILITY_MAX)
644                         prob = LZMS_PROBABILITY_MAX - 1;
645
646         #ifdef LZMS_RC_COSTS_USE_FLOATING_POINT
647                 lzms_rc_costs[i] = log2((double)LZMS_PROBABILITY_MAX / prob) *
648                                         (1 << LZMS_COST_SHIFT);
649         #else
650                 u32 w = prob;
651                 u32 bit_count = 0;
652                 for (u32 j = 0; j < LZMS_COST_SHIFT; j++) {
653                         w *= w;
654                         bit_count <<= 1;
655                         while (w >= (1U << 16)) {
656                                 w >>= 1;
657                                 ++bit_count;
658                         }
659                 }
660                 lzms_rc_costs[i] = (LZMS_PROBABILITY_BITS << LZMS_COST_SHIFT) -
661                                    (15 + bit_count);
662         #endif
663         }
664 }
665
666 static void
667 lzms_init_rc_costs(void)
668 {
669         static bool done = false;
670         static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
671
672         if (unlikely(!done)) {
673                 pthread_mutex_lock(&mutex);
674                 if (!done) {
675                         lzms_do_init_rc_costs();
676                         done = true;
677                 }
678                 pthread_mutex_unlock(&mutex);
679         }
680 }
681
682 /*
683  * Return the cost to range-encode the specified bit when in the specified
684  * state.
685  *
686  * @enc         The range encoder to use.
687  * @cur_state   Current state, which indicates the probability entry to choose.
688  *              Updated by this function.
689  * @bit         The bit to encode (0 or 1).
690  */
691 static u32
692 lzms_rc_bit_cost(const struct lzms_range_encoder *enc, u8 *cur_state, int bit)
693 {
694         u32 prob_zero;
695         u32 prob_correct;
696
697         prob_zero = enc->prob_entries[*cur_state & enc->mask].num_recent_zero_bits;
698
699         *cur_state = (*cur_state << 1) | bit;
700
701         if (bit == 0)
702                 prob_correct = prob_zero;
703         else
704                 prob_correct = LZMS_PROBABILITY_MAX - prob_zero;
705
706         return lzms_rc_costs[prob_correct];
707 }
708
709 static u32
710 lzms_huffman_symbol_cost(const struct lzms_huffman_encoder *enc, u32 sym)
711 {
712         return enc->lens[sym] << LZMS_COST_SHIFT;
713 }
714
715 static u32
716 lzms_offset_cost(const struct lzms_huffman_encoder *enc, u32 offset)
717 {
718         u32 slot;
719         u32 num_extra_bits;
720         u32 cost = 0;
721
722         slot = lzms_get_position_slot(offset);
723
724         cost += lzms_huffman_symbol_cost(enc, slot);
725
726         num_extra_bits = lzms_extra_position_bits[slot];
727
728         cost += num_extra_bits << LZMS_COST_SHIFT;
729
730         return cost;
731 }
732
733 static u32
734 lzms_length_cost(const struct lzms_huffman_encoder *enc, u32 length)
735 {
736         u32 slot;
737         u32 num_extra_bits;
738         u32 cost = 0;
739
740         slot = lzms_get_length_slot(length);
741
742         cost += lzms_huffman_symbol_cost(enc, slot);
743
744         num_extra_bits = lzms_extra_length_bits[slot];
745
746         cost += num_extra_bits << LZMS_COST_SHIFT;
747
748         return cost;
749 }
750
751 static u32
752 lzms_get_matches(struct lzms_compressor *ctx,
753                  const struct lzms_adaptive_state *state,
754                  struct raw_match **matches_ret)
755 {
756         *matches_ret = ctx->matches;
757         return lz_sarray_get_matches(&ctx->lz_sarray,
758                                      ctx->matches,
759                                      lzms_lz_match_cost_fast,
760                                      &state->lru);
761 }
762
763 static void
764 lzms_skip_bytes(struct lzms_compressor *ctx, input_idx_t n)
765 {
766         while (n--)
767                 lz_sarray_skip_position(&ctx->lz_sarray);
768 }
769
770 static u32
771 lzms_get_prev_literal_cost(struct lzms_compressor *ctx,
772                            struct lzms_adaptive_state *state)
773 {
774         u8 literal = ctx->window[lz_sarray_get_pos(&ctx->lz_sarray) - 1];
775         u32 cost = 0;
776
777         state->lru.upcoming_offset = 0;
778         lzms_update_lz_lru_queues(&state->lru);
779
780         cost += lzms_rc_bit_cost(&ctx->main_range_encoder,
781                                  &state->main_state, 0);
782
783         cost += lzms_huffman_symbol_cost(&ctx->literal_encoder, literal);
784
785         return cost;
786 }
787
788 static u32
789 lzms_get_lz_match_cost(struct lzms_compressor *ctx,
790                        struct lzms_adaptive_state *state,
791                        input_idx_t length, input_idx_t offset)
792 {
793         u32 cost = 0;
794         int recent_offset_idx;
795
796         cost += lzms_rc_bit_cost(&ctx->main_range_encoder,
797                                  &state->main_state, 1);
798         cost += lzms_rc_bit_cost(&ctx->match_range_encoder,
799                                  &state->match_state, 0);
800
801         for (recent_offset_idx = 0;
802              recent_offset_idx < LZMS_NUM_RECENT_OFFSETS;
803              recent_offset_idx++)
804                 if (offset == state->lru.recent_offsets[recent_offset_idx])
805                         break;
806
807         if (recent_offset_idx == LZMS_NUM_RECENT_OFFSETS) {
808                 /* Explicit offset.  */
809                 cost += lzms_rc_bit_cost(&ctx->lz_match_range_encoder,
810                                          &state->lz_match_state, 0);
811
812                 cost += lzms_offset_cost(&ctx->lz_offset_encoder, offset);
813         } else {
814                 int i;
815
816                 /* Recent offset.  */
817                 cost += lzms_rc_bit_cost(&ctx->lz_match_range_encoder,
818                                          &state->lz_match_state, 1);
819
820                 for (i = 0; i < recent_offset_idx; i++)
821                         cost += lzms_rc_bit_cost(&ctx->lz_repeat_match_range_encoders[i],
822                                                  &state->lz_repeat_match_state[i], 0);
823
824                 if (i < LZMS_NUM_RECENT_OFFSETS - 1)
825                         cost += lzms_rc_bit_cost(&ctx->lz_repeat_match_range_encoders[i],
826                                                  &state->lz_repeat_match_state[i], 1);
827
828
829                 /* Initial update of the LZ match offset LRU queue.  */
830                 for (; i < LZMS_NUM_RECENT_OFFSETS; i++)
831                         state->lru.recent_offsets[i] = state->lru.recent_offsets[i + 1];
832         }
833
834         cost += lzms_length_cost(&ctx->length_encoder, length);
835
836         state->lru.upcoming_offset = offset;
837         lzms_update_lz_lru_queues(&state->lru);
838
839         return cost;
840 }
841
842 static struct raw_match
843 lzms_get_near_optimal_match(struct lzms_compressor *ctx)
844 {
845         struct lzms_adaptive_state initial_state;
846
847         initial_state.lru = ctx->lru.lz;
848         initial_state.main_state = ctx->main_range_encoder.state;
849         initial_state.match_state = ctx->match_range_encoder.state;
850         initial_state.lz_match_state = ctx->lz_match_range_encoder.state;
851         for (int i = 0; i < LZMS_NUM_RECENT_OFFSETS - 1; i++)
852                 initial_state.lz_repeat_match_state[i] =
853                         ctx->lz_repeat_match_range_encoders[i].state;
854         return lz_get_near_optimal_match(&ctx->mc,
855                                          lzms_get_matches,
856                                          lzms_skip_bytes,
857                                          lzms_get_prev_literal_cost,
858                                          lzms_get_lz_match_cost,
859                                          ctx,
860                                          &initial_state);
861 }
862
863 /*
864  * The main loop for the LZMS compressor.
865  *
866  * Notes:
867  *
868  * - This uses near-optimal LZ parsing backed by a suffix-array match-finder.
869  *   More details can be found in the corresponding files (lz_optimal.h,
870  *   lz_sarray.{h,c}).
871  *
872  * - This does not output any delta matches.  It would take a specialized
873  *   algorithm to find them, then more code in lz_optimal.h and here to handle
874  *   evaluating and outputting them.
875  *
876  * - The costs of literals and matches are estimated using the range encoder
877  *   states and the semi-adaptive Huffman codes.  Except for range encoding
878  *   states, costs are assumed to be constant throughout a single run of the
879  *   parsing algorithm, which can parse up to @optim_array_length (from the
880  *   `struct wimlib_lzms_compressor_params') bytes of data.  This introduces a
881  *   source of inaccuracy because the probabilities and Huffman codes can change
882  *   over this part of the data.
883  */
884 static void
885 lzms_encode(struct lzms_compressor *ctx)
886 {
887         struct raw_match match;
888
889         /* Load window into suffix array match-finder.  */
890         lz_sarray_load_window(&ctx->lz_sarray, ctx->window, ctx->window_size);
891
892         /* Reset the match-chooser.  */
893         lz_match_chooser_begin(&ctx->mc);
894
895         while (ctx->cur_window_pos != ctx->window_size) {
896                 match = lzms_get_near_optimal_match(ctx);
897                 if (match.len <= 1)
898                         lzms_encode_literal(ctx, ctx->window[ctx->cur_window_pos]);
899                 else
900                         lzms_encode_lz_match(ctx, match.len, match.offset);
901         }
902 }
903
904 static void
905 lzms_init_range_encoder(struct lzms_range_encoder *enc,
906                         struct lzms_range_encoder_raw *rc, u32 num_states)
907 {
908         enc->rc = rc;
909         enc->state = 0;
910         enc->mask = num_states - 1;
911         for (u32 i = 0; i < num_states; i++) {
912                 enc->prob_entries[i].num_recent_zero_bits = LZMS_INITIAL_PROBABILITY;
913                 enc->prob_entries[i].recent_bits = LZMS_INITIAL_RECENT_BITS;
914         }
915 }
916
917 static void
918 lzms_init_huffman_encoder(struct lzms_huffman_encoder *enc,
919                           struct lzms_output_bitstream *os,
920                           unsigned num_syms,
921                           unsigned rebuild_freq)
922 {
923         enc->os = os;
924         enc->num_syms_written = 0;
925         enc->rebuild_freq = rebuild_freq;
926         enc->num_syms = num_syms;
927         for (unsigned i = 0; i < num_syms; i++)
928                 enc->sym_freqs[i] = 1;
929
930         make_canonical_huffman_code(enc->num_syms,
931                                     LZMS_MAX_CODEWORD_LEN,
932                                     enc->sym_freqs,
933                                     enc->lens,
934                                     enc->codewords);
935 }
936
937 /* Initialize the LZMS compressor.  */
938 static void
939 lzms_init_compressor(struct lzms_compressor *ctx, const u8 *udata, u32 ulen,
940                      le16 *cdata, u32 clen16)
941 {
942         unsigned num_position_slots;
943
944         /* Copy the uncompressed data into the @ctx->window buffer.  */
945         memcpy(ctx->window, udata, ulen);
946         ctx->cur_window_pos = 0;
947         ctx->window_size = ulen;
948
949         /* Initialize the raw range encoder (writing forwards).  */
950         lzms_range_encoder_raw_init(&ctx->rc, cdata, clen16);
951
952         /* Initialize the output bitstream for Huffman symbols and verbatim bits
953          * (writing backwards).  */
954         lzms_output_bitstream_init(&ctx->os, cdata, clen16);
955
956         /* Calculate the number of position slots needed for this compressed
957          * block.  */
958         num_position_slots = lzms_get_position_slot(ulen - 1) + 1;
959
960         LZMS_DEBUG("Using %u position slots", num_position_slots);
961
962         /* Initialize Huffman encoders for each alphabet used in the compressed
963          * representation.  */
964         lzms_init_huffman_encoder(&ctx->literal_encoder, &ctx->os,
965                                   LZMS_NUM_LITERAL_SYMS,
966                                   LZMS_LITERAL_CODE_REBUILD_FREQ);
967
968         lzms_init_huffman_encoder(&ctx->lz_offset_encoder, &ctx->os,
969                                   num_position_slots,
970                                   LZMS_LZ_OFFSET_CODE_REBUILD_FREQ);
971
972         lzms_init_huffman_encoder(&ctx->length_encoder, &ctx->os,
973                                   LZMS_NUM_LEN_SYMS,
974                                   LZMS_LENGTH_CODE_REBUILD_FREQ);
975
976         lzms_init_huffman_encoder(&ctx->delta_offset_encoder, &ctx->os,
977                                   num_position_slots,
978                                   LZMS_DELTA_OFFSET_CODE_REBUILD_FREQ);
979
980         lzms_init_huffman_encoder(&ctx->delta_power_encoder, &ctx->os,
981                                   LZMS_NUM_DELTA_POWER_SYMS,
982                                   LZMS_DELTA_POWER_CODE_REBUILD_FREQ);
983
984         /* Initialize range encoders, all of which wrap around the same
985          * lzms_range_encoder_raw.  */
986         lzms_init_range_encoder(&ctx->main_range_encoder,
987                                 &ctx->rc, LZMS_NUM_MAIN_STATES);
988
989         lzms_init_range_encoder(&ctx->match_range_encoder,
990                                 &ctx->rc, LZMS_NUM_MATCH_STATES);
991
992         lzms_init_range_encoder(&ctx->lz_match_range_encoder,
993                                 &ctx->rc, LZMS_NUM_LZ_MATCH_STATES);
994
995         for (size_t i = 0; i < ARRAY_LEN(ctx->lz_repeat_match_range_encoders); i++)
996                 lzms_init_range_encoder(&ctx->lz_repeat_match_range_encoders[i],
997                                         &ctx->rc, LZMS_NUM_LZ_REPEAT_MATCH_STATES);
998
999         lzms_init_range_encoder(&ctx->delta_match_range_encoder,
1000                                 &ctx->rc, LZMS_NUM_DELTA_MATCH_STATES);
1001
1002         for (size_t i = 0; i < ARRAY_LEN(ctx->delta_repeat_match_range_encoders); i++)
1003                 lzms_init_range_encoder(&ctx->delta_repeat_match_range_encoders[i],
1004                                         &ctx->rc, LZMS_NUM_DELTA_REPEAT_MATCH_STATES);
1005
1006         /* Initialize LRU match information.  */
1007         lzms_init_lru_queues(&ctx->lru);
1008 }
1009
1010 /* Flush the output streams, prepare the final compressed data, and return its
1011  * size in bytes.
1012  *
1013  * A return value of 0 indicates that the data could not be compressed to fit in
1014  * the available space.  */
1015 static size_t
1016 lzms_finalize(struct lzms_compressor *ctx, u8 *cdata, size_t csize_avail)
1017 {
1018         size_t num_forwards_bytes;
1019         size_t num_backwards_bytes;
1020         size_t compressed_size;
1021
1022         /* Flush both the forwards and backwards streams, and make sure they
1023          * didn't cross each other and start overwriting each other's data.  */
1024         if (!lzms_output_bitstream_flush(&ctx->os)) {
1025                 LZMS_DEBUG("Backwards bitstream overrun.");
1026                 return 0;
1027         }
1028
1029         if (!lzms_range_encoder_raw_flush(&ctx->rc)) {
1030                 LZMS_DEBUG("Forwards bitstream overrun.");
1031                 return 0;
1032         }
1033
1034         if (ctx->rc.out > ctx->os.out) {
1035                 LZMS_DEBUG("Two bitstreams crossed.");
1036                 return 0;
1037         }
1038
1039         /* Now the compressed buffer contains the data output by the forwards
1040          * bitstream, then empty space, then data output by the backwards
1041          * bitstream.  Move the data output by the backwards bitstream to be
1042          * adjacent to the data output by the forward bitstream, and calculate
1043          * the compressed size that this results in.  */
1044         num_forwards_bytes = (u8*)ctx->rc.out - (u8*)cdata;
1045         num_backwards_bytes = ((u8*)cdata + csize_avail) - (u8*)ctx->os.out;
1046
1047         memmove(cdata + num_forwards_bytes, ctx->os.out, num_backwards_bytes);
1048
1049         compressed_size = num_forwards_bytes + num_backwards_bytes;
1050         LZMS_DEBUG("num_forwards_bytes=%zu, num_backwards_bytes=%zu, "
1051                    "compressed_size=%zu",
1052                    num_forwards_bytes, num_backwards_bytes, compressed_size);
1053         LZMS_ASSERT(compressed_size % 2 == 0);
1054         return compressed_size;
1055 }
1056
1057 static size_t
1058 lzms_compress(const void *uncompressed_data, size_t uncompressed_size,
1059               void *compressed_data, size_t compressed_size_avail, void *_ctx)
1060 {
1061         struct lzms_compressor *ctx = _ctx;
1062         size_t compressed_size;
1063
1064         LZMS_DEBUG("uncompressed_size=%zu, compressed_size_avail=%zu",
1065                    uncompressed_size, compressed_size_avail);
1066
1067         /* Make sure the uncompressed size is compatible with this compressor.
1068          */
1069         if (uncompressed_size > ctx->max_block_size) {
1070                 LZMS_DEBUG("Can't compress %zu bytes: LZMS context "
1071                            "only supports %u bytes",
1072                            uncompressed_size, ctx->max_block_size);
1073                 return 0;
1074         }
1075
1076         /* Don't bother compressing extremely small inputs.  */
1077         if (uncompressed_size < 4) {
1078                 LZMS_DEBUG("Input too small to bother compressing.");
1079                 return 0;
1080         }
1081
1082         /* Cap the available compressed size to a 32-bit integer and round it
1083          * down to the nearest multiple of 2.  */
1084         if (compressed_size_avail > UINT32_MAX)
1085                 compressed_size_avail = UINT32_MAX;
1086         if (compressed_size_avail & 1)
1087                 compressed_size_avail--;
1088
1089         /* Initialize the compressor structures.  */
1090         lzms_init_compressor(ctx, uncompressed_data, uncompressed_size,
1091                              compressed_data, compressed_size_avail / 2);
1092
1093         /* Preprocess the uncompressed data.  */
1094         lzms_x86_filter(ctx->window, ctx->window_size,
1095                         ctx->last_target_usages, false);
1096
1097         /* Compute and encode a literal/match sequence that decompresses to the
1098          * preprocessed data.  */
1099         lzms_encode(ctx);
1100
1101         /* Get and return the compressed data size.  */
1102         compressed_size = lzms_finalize(ctx, compressed_data,
1103                                         compressed_size_avail);
1104
1105         if (compressed_size == 0) {
1106                 LZMS_DEBUG("Data did not compress to requested size or less.");
1107                 return 0;
1108         }
1109
1110         LZMS_DEBUG("Compressed %zu => %zu bytes",
1111                    uncompressed_size, compressed_size);
1112
1113 #if defined(ENABLE_VERIFY_COMPRESSION) || defined(ENABLE_LZMS_DEBUG)
1114         /* Verify that we really get the same thing back when decompressing.  */
1115         {
1116                 struct wimlib_decompressor *decompressor;
1117
1118                 LZMS_DEBUG("Verifying LZMS compression.");
1119
1120                 if (0 == wimlib_create_decompressor(WIMLIB_COMPRESSION_TYPE_LZMS,
1121                                                     ctx->max_block_size,
1122                                                     NULL,
1123                                                     &decompressor))
1124                 {
1125                         int ret;
1126                         ret = wimlib_decompress(compressed_data,
1127                                                 compressed_size,
1128                                                 ctx->window,
1129                                                 uncompressed_size,
1130                                                 decompressor);
1131                         wimlib_free_decompressor(decompressor);
1132
1133                         if (ret) {
1134                                 ERROR("Failed to decompress data we "
1135                                       "compressed using LZMS algorithm");
1136                                 wimlib_assert(0);
1137                                 return 0;
1138                         }
1139                         if (memcmp(uncompressed_data, ctx->window,
1140                                    uncompressed_size))
1141                         {
1142                                 ERROR("Data we compressed using LZMS algorithm "
1143                                       "didn't decompress to original");
1144                                 wimlib_assert(0);
1145                                 return 0;
1146                         }
1147                 } else {
1148                         WARNING("Failed to create decompressor for "
1149                                 "data verification!");
1150                 }
1151         }
1152 #endif /* ENABLE_LZMS_DEBUG || ENABLE_VERIFY_COMPRESSION  */
1153
1154         return compressed_size;
1155 }
1156
1157 static void
1158 lzms_free_compressor(void *_ctx)
1159 {
1160         struct lzms_compressor *ctx = _ctx;
1161
1162         if (ctx) {
1163                 FREE(ctx->window);
1164                 FREE(ctx->matches);
1165                 lz_sarray_destroy(&ctx->lz_sarray);
1166                 lz_match_chooser_destroy(&ctx->mc);
1167                 FREE(ctx);
1168         }
1169 }
1170
1171 static const struct wimlib_lzms_compressor_params lzms_default = {
1172         .hdr = {
1173                 .size = sizeof(struct wimlib_lzms_compressor_params),
1174         },
1175         .min_match_length = 2,
1176         .max_match_length = UINT32_MAX,
1177         .nice_match_length = 32,
1178         .max_search_depth = 50,
1179         .max_matches_per_pos = 3,
1180         .optim_array_length = 1024,
1181 };
1182
1183 static bool
1184 lzms_params_valid(const struct wimlib_compressor_params_header *);
1185
1186 static const struct wimlib_lzms_compressor_params *
1187 lzms_get_params(const struct wimlib_compressor_params_header *_params)
1188 {
1189         const struct wimlib_lzms_compressor_params *params =
1190                 (const struct wimlib_lzms_compressor_params*)_params;
1191
1192         if (params == NULL)
1193                 params = &lzms_default;
1194
1195         LZMS_ASSERT(lzms_params_valid(&params->hdr));
1196
1197         return params;
1198 }
1199
1200 static int
1201 lzms_create_compressor(size_t max_block_size,
1202                        const struct wimlib_compressor_params_header *_params,
1203                        void **ctx_ret)
1204 {
1205         struct lzms_compressor *ctx;
1206         const struct wimlib_lzms_compressor_params *params = lzms_get_params(_params);
1207
1208         if (max_block_size == 0 || max_block_size >= INT32_MAX) {
1209                 LZMS_DEBUG("Invalid max_block_size (%u)", max_block_size);
1210                 return WIMLIB_ERR_INVALID_PARAM;
1211         }
1212
1213         ctx = CALLOC(1, sizeof(struct lzms_compressor));
1214         if (ctx == NULL)
1215                 goto oom;
1216
1217         ctx->window = MALLOC(max_block_size);
1218         if (ctx->window == NULL)
1219                 goto oom;
1220
1221         ctx->matches = MALLOC(min(params->max_match_length -
1222                                         params->min_match_length + 1,
1223                                   params->max_matches_per_pos) *
1224                                 sizeof(ctx->matches[0]));
1225         if (ctx->matches == NULL)
1226                 goto oom;
1227
1228         if (!lz_sarray_init(&ctx->lz_sarray, max_block_size,
1229                             params->min_match_length,
1230                             min(params->max_match_length, LZ_SARRAY_LEN_MAX),
1231                             params->max_search_depth,
1232                             params->max_matches_per_pos))
1233                 goto oom;
1234
1235         if (!lz_match_chooser_init(&ctx->mc,
1236                                    params->optim_array_length,
1237                                    params->nice_match_length,
1238                                    params->max_match_length))
1239                 goto oom;
1240
1241         /* Initialize position and length slot data if not done already.  */
1242         lzms_init_slots();
1243
1244         /* Initialize range encoding cost table if not done already.  */
1245         lzms_init_rc_costs();
1246
1247         ctx->max_block_size = max_block_size;
1248
1249         *ctx_ret = ctx;
1250         return 0;
1251
1252 oom:
1253         lzms_free_compressor(ctx);
1254         return WIMLIB_ERR_NOMEM;
1255 }
1256
1257 static u64
1258 lzms_get_needed_memory(size_t max_block_size,
1259                        const struct wimlib_compressor_params_header *_params)
1260 {
1261         const struct wimlib_lzms_compressor_params *params = lzms_get_params(_params);
1262
1263         u64 size = 0;
1264
1265         size += max_block_size;
1266         size += sizeof(struct lzms_compressor);
1267         size += lz_sarray_get_needed_memory(max_block_size);
1268         size += lz_match_chooser_get_needed_memory(params->optim_array_length,
1269                                                    params->nice_match_length,
1270                                                    params->max_match_length);
1271         size += min(params->max_match_length -
1272                     params->min_match_length + 1,
1273                     params->max_matches_per_pos) *
1274                 sizeof(((struct lzms_compressor*)0)->matches[0]);
1275         return size;
1276 }
1277
1278 static bool
1279 lzms_params_valid(const struct wimlib_compressor_params_header *_params)
1280 {
1281         const struct wimlib_lzms_compressor_params *params =
1282                 (const struct wimlib_lzms_compressor_params*)_params;
1283
1284         if (params->hdr.size != sizeof(*params) ||
1285             params->max_match_length < params->min_match_length ||
1286             params->min_match_length < 2 ||
1287             params->optim_array_length == 0 ||
1288             min(params->max_match_length, params->nice_match_length) > 65536)
1289                 return false;
1290
1291         return true;
1292 }
1293
1294 const struct compressor_ops lzms_compressor_ops = {
1295         .params_valid       = lzms_params_valid,
1296         .get_needed_memory  = lzms_get_needed_memory,
1297         .create_compressor  = lzms_create_compressor,
1298         .compress           = lzms_compress,
1299         .free_compressor    = lzms_free_compressor,
1300 };