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