513b09dc66ec63c9596f22519c4e777d51de33df
[wimlib] / src / lzx-compress.c
1 /*
2  * lzx-compress.c
3  */
4
5 /*
6  * Copyright (C) 2012, 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
25 /*
26  * This file contains a compressor for the LZX ("Lempel-Ziv eXtended"?)
27  * compression format, as used in the WIM (Windows IMaging) file format.  This
28  * code may need some slight modifications to be used outside of the WIM format.
29  * In particular, in other situations the LZX block header might be slightly
30  * different, and a sliding window rather than a fixed-size window might be
31  * required.
32  *
33  * ----------------------------------------------------------------------------
34  *
35  *                               Format Overview
36  *
37  * The primary reference for LZX is the specification released by Microsoft.
38  * However, the comments in lzx-decompress.c provide more information about LZX
39  * and note some errors in the Microsoft specification.
40  *
41  * LZX shares many similarities with DEFLATE, the format used by zlib and gzip.
42  * Both LZX and DEFLATE use LZ77 matching and Huffman coding.  Certain details
43  * are quite similar, such as the method for storing Huffman codes.  However,
44  * the main differences are:
45  *
46  * - LZX preprocesses the data to attempt to make x86 machine code slightly more
47  *   compressible before attempting to compress it further.
48  *
49  * - LZX uses a "main" alphabet which combines literals and matches, with the
50  *   match symbols containing a "length header" (giving all or part of the match
51  *   length) and a "position slot" (giving, roughly speaking, the order of
52  *   magnitude of the match offset).
53  *
54  * - LZX does not have static Huffman blocks (that is, the kind with preset
55  *   Huffman codes); however it does have two types of dynamic Huffman blocks
56  *   ("verbatim" and "aligned").
57  *
58  * - LZX has a minimum match length of 2 rather than 3.
59  *
60  * - In LZX, match offsets 0 through 2 actually represent entries in an LRU
61  *   queue of match offsets.  This is very useful for certain types of files,
62  *   such as binary files that have repeating records.
63  *
64  * ----------------------------------------------------------------------------
65  *
66  *                            Algorithmic Overview
67  *
68  * At a high level, any implementation of LZX compression must operate as
69  * follows:
70  *
71  * 1. Preprocess the input data to translate the targets of 32-bit x86 call
72  *    instructions to absolute offsets.  (Actually, this is required for WIM,
73  *    but might not be in other places LZX is used.)
74  *
75  * 2. Find a sequence of LZ77-style matches and literal bytes that expands to
76  *    the preprocessed data.
77  *
78  * 3. Divide the match/literal sequence into one or more LZX blocks, each of
79  *    which may be "uncompressed", "verbatim", or "aligned".
80  *
81  * 4. Output each LZX block.
82  *
83  * Step (1) is fairly straightforward.  It requires looking for 0xe8 bytes in
84  * the input data and performing a translation on the 4 bytes following each
85  * one.
86  *
87  * Step (4) is complicated, but it is mostly determined by the LZX format.  The
88  * only real choice we have is what algorithm to use to build the length-limited
89  * canonical Huffman codes.  See lzx_write_all_blocks() for details.
90  *
91  * That leaves steps (2) and (3) as where all the hard stuff happens.  Focusing
92  * on step (2), we need to do LZ77-style parsing on the input data, or "window",
93  * to divide it into a sequence of matches and literals.  Each position in the
94  * window might have multiple matches associated with it, and we need to choose
95  * which one, if any, to actually use.  Therefore, the problem can really be
96  * divided into two areas of concern: (a) finding matches at a given position,
97  * which we shall call "match-finding", and (b) choosing whether to use a
98  * match or a literal at a given position, and if using a match, which one (if
99  * there is more than one available).  We shall call this "match-choosing".  We
100  * first consider match-finding, then match-choosing.
101  *
102  * ----------------------------------------------------------------------------
103  *
104  *                               Match-finding
105  *
106  * Given a position in the window, we want to find LZ77-style "matches" with
107  * that position at previous positions in the window.  With LZX, the minimum
108  * match length is 2 and the maximum match length is 257.  The only restriction
109  * on offsets is that LZX does not allow the last 2 bytes of the window to match
110  * the the beginning of the window.
111  *
112  * Depending on how good a compression ratio we want (see the "Match-choosing"
113  * section), we may want to find: (a) all matches, or (b) just the longest
114  * match, or (c) just some "promising" matches that we are able to find quickly,
115  * or (d) just the longest match that we're able to find quickly.  Below we
116  * introduce the match-finding methods that the code currently uses or has
117  * previously used:
118  *
119  * - Hash chains.  Maintain a table that maps hash codes, computed from
120  *   fixed-length byte sequences, to linked lists containing previous window
121  *   positions.  To search for matches, compute the hash for the current
122  *   position in the window and search the appropriate hash chain.  When
123  *   advancing to the next position, prepend the current position to the
124  *   appropriate hash list.  This is a good approach for producing matches with
125  *   stategy (d) and is useful for fast compression.  Therefore, we provide an
126  *   option to use this method for LZX compression.  See lz_hash.c for the
127  *   implementation.
128  *
129  * - Binary trees.  Similar to hash chains, but each hash bucket contains a
130  *   binary tree of previous window positions rather than a linked list.  This
131  *   is a good approach for producing matches with stategy (c) and is useful for
132  *   achieving a good compression ratio.  Therefore, we provide an option to use
133  *   this method; see lz_bt.c for the implementation.
134  *
135  * - Suffix arrays.  This code previously used this method to produce matches
136  *   with stategy (c), but I've dropped it because it was slower than the binary
137  *   trees approach, used more memory, and did not improve the compression ratio
138  *   enough to compensate.  Download wimlib v1.6.2 if you want the code.
139  *   However, the suffix array method was basically as follows.  Build the
140  *   suffix array for the entire window.  The suffix array contains each
141  *   possible window position, sorted by the lexicographic order of the strings
142  *   that begin at those positions.  Find the matches at a given position by
143  *   searching the suffix array outwards, in both directions, from the suffix
144  *   array slot for that position.  This produces the longest matches first, but
145  *   "matches" that actually occur at later positions in the window must be
146  *   skipped.  To do this skipping, use an auxiliary array with dynamically
147  *   constructed linked lists.  Also, use the inverse suffix array to quickly
148  *   find the suffix array slot for a given position without doing a binary
149  *   search.
150  *
151  * ----------------------------------------------------------------------------
152  *
153  *                               Match-choosing
154  *
155  * Usually, choosing the longest match is best because it encodes the most data
156  * in that one item.  However, sometimes the longest match is not optimal
157  * because (a) choosing a long match now might prevent using an even longer
158  * match later, or (b) more generally, what we actually care about is the number
159  * of bits it will ultimately take to output each match or literal, which is
160  * actually dependent on the entropy encoding using by the underlying
161  * compression format.  Consequently, a longer match usually, but not always,
162  * takes fewer bits to encode than multiple shorter matches or literals that
163  * cover the same data.
164  *
165  * This problem of choosing the truly best match/literal sequence is probably
166  * impossible to solve efficiently when combined with entropy encoding.  If we
167  * knew how many bits it takes to output each match/literal, then we could
168  * choose the optimal sequence using shortest-path search a la Dijkstra's
169  * algorithm.  However, with entropy encoding, the chosen match/literal sequence
170  * affects its own encoding.  Therefore, we can't know how many bits it will
171  * take to actually output any one match or literal until we have actually
172  * chosen the full sequence of matches and literals.
173  *
174  * Notwithstanding the entropy encoding problem, we also aren't guaranteed to
175  * choose the optimal match/literal sequence unless the match-finder (see
176  * section "Match-finder") provides the match-chooser with all possible matches
177  * at each position.  However, this is not computationally efficient.  For
178  * example, there might be many matches of the same length, and usually (but not
179  * always) the best choice is the one with the smallest offset.  So in practice,
180  * it's fine to only consider the smallest offset for a given match length at a
181  * given position.  (Actually, for LZX, it's also worth considering repeat
182  * offsets.)
183  *
184  * In addition, as mentioned earlier, in LZX we have the choice of using
185  * multiple blocks, each of which resets the Huffman codes.  This expands the
186  * search space even further.  Therefore, to simplify the problem, we currently
187  * we don't attempt to actually choose the LZX blocks based on the data.
188  * Instead, we just divide the data into fixed-size blocks of LZX_DIV_BLOCK_SIZE
189  * bytes each, and always use verbatim or aligned blocks (never uncompressed).
190  * A previous version of this code recursively split the input data into
191  * equal-sized blocks, up to a maximum depth, and chose the lowest-cost block
192  * divisions.  However, this made compression much slower and did not actually
193  * help very much.  It remains an open question whether a sufficiently fast and
194  * useful block-splitting algorithm is possible for LZX.  Essentially the same
195  * problem also applies to DEFLATE.  The Microsoft LZX compressor seemingly does
196  * do block splitting, although I don't know how fast or useful it is,
197  * specifically.
198  *
199  * Now, back to the entropy encoding problem.  The "solution" is to use an
200  * iterative approach to compute a good, but not necessarily optimal,
201  * match/literal sequence.  Start with a fixed assignment of symbol costs and
202  * choose an "optimal" match/literal sequence based on those costs, using
203  * shortest-path seach a la Dijkstra's algorithm.  Then, for each iteration of
204  * the optimization, update the costs based on the entropy encoding of the
205  * current match/literal sequence, then choose a new match/literal sequence
206  * based on the updated costs.  Usually, the actual cost to output the current
207  * match/literal sequence will decrease in each iteration until it converges on
208  * a fixed point.  This result may not be the truly optimal match/literal
209  * sequence, but it usually is much better than one chosen by doing a "greedy"
210  * parse where we always chooe the longest match.
211  *
212  * An alternative to both greedy parsing and iterative, near-optimal parsing is
213  * "lazy" parsing.  Briefly, "lazy" parsing considers just the longest match at
214  * each position, but it waits to choose that match until it has also examined
215  * the next position.  This is actually a useful approach; it's used by zlib,
216  * for example.  Therefore, for fast compression we combine lazy parsing with
217  * the hash chain max-finder.  For normal/high compression we combine
218  * near-optimal parsing with the binary tree match-finder.
219  *
220  * Anyway, if you've read through this comment, you hopefully should have a
221  * better idea of why things are done in a certain way in this LZX compressor,
222  * as well as in other compressors for LZ77-based formats (including third-party
223  * ones).  In my opinion, the phrase "compression algorithm" is often mis-used
224  * in place of "compression format",  since there can be many different
225  * algorithms that all generate compressed data in the same format.  The
226  * challenge is to design an algorithm that is efficient but still gives a good
227  * compression ratio.
228  */
229
230 #ifdef HAVE_CONFIG_H
231 #  include "config.h"
232 #endif
233
234 #include "wimlib.h"
235 #include "wimlib/compressor_ops.h"
236 #include "wimlib/compress_common.h"
237 #include "wimlib/endianness.h"
238 #include "wimlib/error.h"
239 #include "wimlib/lz.h"
240 #include "wimlib/lz_hash.h"
241 #include "wimlib/lz_bt.h"
242 #include "wimlib/lzx.h"
243 #include "wimlib/util.h"
244 #include <string.h>
245
246 #ifdef ENABLE_LZX_DEBUG
247 #  include "wimlib/decompress_common.h"
248 #endif
249
250 #define LZX_OPTIM_ARRAY_SIZE    4096
251
252 #define LZX_DIV_BLOCK_SIZE      32768
253
254 #define LZX_CACHE_PER_POS       8
255
256 #define LZX_CACHE_LEN (LZX_DIV_BLOCK_SIZE * (LZX_CACHE_PER_POS + 1))
257 #define LZX_CACHE_SIZE (LZX_CACHE_LEN * sizeof(struct lz_match))
258 #define LZX_MAX_MATCHES_PER_POS (LZX_MAX_MATCH_LEN - LZX_MIN_MATCH_LEN + 1)
259
260 /* Codewords for the LZX main, length, and aligned offset Huffman codes  */
261 struct lzx_codewords {
262         u32 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
263         u32 len[LZX_LENCODE_NUM_SYMBOLS];
264         u32 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
265 };
266
267 /* Codeword lengths (in bits) for the LZX main, length, and aligned offset
268  * Huffman codes.
269  *
270  * A 0 length means the codeword has zero frequency.
271  */
272 struct lzx_lens {
273         u8 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
274         u8 len[LZX_LENCODE_NUM_SYMBOLS];
275         u8 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
276 };
277
278 /* Costs for the LZX main, length, and aligned offset Huffman symbols.
279  *
280  * If a codeword has zero frequency, it must still be assigned some nonzero cost
281  * --- generally a high cost, since even if it gets used in the next iteration,
282  * it probably will not be used very many times.  */
283 struct lzx_costs {
284         u8 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
285         u8 len[LZX_LENCODE_NUM_SYMBOLS];
286         u8 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
287 };
288
289 /* The LZX main, length, and aligned offset Huffman codes  */
290 struct lzx_codes {
291         struct lzx_codewords codewords;
292         struct lzx_lens lens;
293 };
294
295 /* Tables for tallying symbol frequencies in the three LZX alphabets  */
296 struct lzx_freqs {
297         u32 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
298         u32 len[LZX_LENCODE_NUM_SYMBOLS];
299         u32 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
300 };
301
302 /* LZX intermediate match/literal format  */
303 struct lzx_item {
304         /* Bit     Description
305          *
306          * 31      1 if a match, 0 if a literal.
307          *
308          * 30-25   position slot.  This can be at most 50, so it will fit in 6
309          *         bits.
310          *
311          * 8-24    position footer.  This is the offset of the real formatted
312          *         offset from the position base.  This can be at most 17 bits
313          *         (since lzx_extra_bits[LZX_MAX_POSITION_SLOTS - 1] is 17).
314          *
315          * 0-7     length of match, minus 2.  This can be at most
316          *         (LZX_MAX_MATCH_LEN - 2) == 255, so it will fit in 8 bits.  */
317         u32 data;
318 };
319
320 /* Specification for an LZX block.  */
321 struct lzx_block_spec {
322
323         /* One of the LZX_BLOCKTYPE_* constants indicating which type of this
324          * block.  */
325         int block_type;
326
327         /* 0-based position in the window at which this block starts.  */
328         u32 window_pos;
329
330         /* The number of bytes of uncompressed data this block represents.  */
331         u32 block_size;
332
333         /* The match/literal sequence for this block.  */
334         struct lzx_item *chosen_items;
335
336         /* The length of the @chosen_items sequence.  */
337         u32 num_chosen_items;
338
339         /* Huffman codes for this block.  */
340         struct lzx_codes codes;
341 };
342
343 /* State of the LZX compressor.  */
344 struct lzx_compressor {
345
346         /* The parameters that were used to create the compressor.  */
347         struct wimlib_lzx_compressor_params params;
348
349         /* The buffer of data to be compressed.
350          *
351          * 0xe8 byte preprocessing is done directly on the data here before
352          * further compression.
353          *
354          * Note that this compressor does *not* use a real sliding window!!!!
355          * It's not needed in the WIM format, since every chunk is compressed
356          * independently.  This is by design, to allow random access to the
357          * chunks.
358          *
359          * We reserve a few extra bytes to potentially allow reading off the end
360          * of the array in the match-finding code for optimization purposes
361          * (currently only needed for the hash chain match-finder).  */
362         u8 *window;
363
364         /* Number of bytes of data to be compressed, which is the number of
365          * bytes of data in @window that are actually valid.  */
366         u32 window_size;
367
368         /* Allocated size of the @window.  */
369         u32 max_window_size;
370
371         /* Number of symbols in the main alphabet (depends on the
372          * @max_window_size since it determines the maximum allowed offset).  */
373         unsigned num_main_syms;
374
375         /* The current match offset LRU queue.  */
376         struct lzx_lru_queue queue;
377
378         /* Space for the sequences of matches/literals that were chosen for each
379          * block.  */
380         struct lzx_item *chosen_items;
381
382         /* Information about the LZX blocks the preprocessed input was divided
383          * into.  */
384         struct lzx_block_spec *block_specs;
385
386         /* Number of LZX blocks the input was divided into; a.k.a. the number of
387          * elements of @block_specs that are valid.  */
388         unsigned num_blocks;
389
390         /* This is simply filled in with zeroes and used to avoid special-casing
391          * the output of the first compressed Huffman code, which conceptually
392          * has a delta taken from a code with all symbols having zero-length
393          * codewords.  */
394         struct lzx_codes zero_codes;
395
396         /* The current cost model.  */
397         struct lzx_costs costs;
398
399         /* Fast algorithm only:  Array of hash table links.  */
400         u32 *prev_tab;
401
402         /* Slow algorithm only: Binary tree match-finder.  */
403         struct lz_bt mf;
404
405         /* Position in window of next match to return.  */
406         u32 match_window_pos;
407
408         /* The end-of-block position.  We can't allow any matches to span this
409          * position.  */
410         u32 match_window_end;
411
412         /* Matches found by the match-finder are cached in the following array
413          * to achieve a slight speedup when the same matches are needed on
414          * subsequent passes.  This is suboptimal because different matches may
415          * be preferred with different cost models, but seems to be a worthwhile
416          * speedup.  */
417         struct lz_match *cached_matches;
418         struct lz_match *cache_ptr;
419         bool matches_cached;
420         struct lz_match *cache_limit;
421
422         /* Match-chooser state.
423          * When matches have been chosen, optimum_cur_idx is set to the position
424          * in the window of the next match/literal to return and optimum_end_idx
425          * is set to the position in the window at the end of the last
426          * match/literal to return.  */
427         struct lzx_mc_pos_data *optimum;
428         unsigned optimum_cur_idx;
429         unsigned optimum_end_idx;
430 };
431
432 /*
433  * Match chooser position data:
434  *
435  * An array of these structures is used during the match-choosing algorithm.
436  * They correspond to consecutive positions in the window and are used to keep
437  * track of the cost to reach each position, and the match/literal choices that
438  * need to be chosen to reach that position.
439  */
440 struct lzx_mc_pos_data {
441         /* The approximate minimum cost, in bits, to reach this position in the
442          * window which has been found so far.  */
443         u32 cost;
444 #define MC_INFINITE_COST ((u32)~0UL)
445
446         /* The union here is just for clarity, since the fields are used in two
447          * slightly different ways.  Initially, the @prev structure is filled in
448          * first, and links go from later in the window to earlier in the
449          * window.  Later, @next structure is filled in and links go from
450          * earlier in the window to later in the window.  */
451         union {
452                 struct {
453                         /* Position of the start of the match or literal that
454                          * was taken to get to this position in the approximate
455                          * minimum-cost parse.  */
456                         u32 link;
457
458                         /* Offset (as in an LZ (length, offset) pair) of the
459                          * match or literal that was taken to get to this
460                          * position in the approximate minimum-cost parse.  */
461                         u32 match_offset;
462                 } prev;
463                 struct {
464                         /* Position at which the match or literal starting at
465                          * this position ends in the minimum-cost parse.  */
466                         u32 link;
467
468                         /* Offset (as in an LZ (length, offset) pair) of the
469                          * match or literal starting at this position in the
470                          * approximate minimum-cost parse.  */
471                         u32 match_offset;
472                 } next;
473         };
474
475         /* Adaptive state that exists after an approximate minimum-cost path to
476          * reach this position is taken.  */
477         struct lzx_lru_queue queue;
478 };
479
480 /* Returns the LZX position slot that corresponds to a given match offset,
481  * taking into account the recent offset queue and updating it if the offset is
482  * found in it.  */
483 static unsigned
484 lzx_get_position_slot(u32 offset, struct lzx_lru_queue *queue)
485 {
486         unsigned position_slot;
487
488         /* See if the offset was recently used.  */
489         for (int i = 0; i < LZX_NUM_RECENT_OFFSETS; i++) {
490                 if (offset == queue->R[i]) {
491                         /* Found it.  */
492
493                         /* Bring the repeat offset to the front of the
494                          * queue.  Note: this is, in fact, not a real
495                          * LRU queue because repeat matches are simply
496                          * swapped to the front.  */
497                         swap(queue->R[0], queue->R[i]);
498
499                         /* The resulting position slot is simply the first index
500                          * at which the offset was found in the queue.  */
501                         return i;
502                 }
503         }
504
505         /* The offset was not recently used; look up its real position slot.  */
506         position_slot = lzx_get_position_slot_raw(offset + LZX_OFFSET_OFFSET);
507
508         /* Bring the new offset to the front of the queue.  */
509         for (int i = LZX_NUM_RECENT_OFFSETS - 1; i > 0; i--)
510                 queue->R[i] = queue->R[i - 1];
511         queue->R[0] = offset;
512
513         return position_slot;
514 }
515
516 /* Build the main, length, and aligned offset Huffman codes used in LZX.
517  *
518  * This takes as input the frequency tables for each code and produces as output
519  * a set of tables that map symbols to codewords and codeword lengths.  */
520 static void
521 lzx_make_huffman_codes(const struct lzx_freqs *freqs,
522                        struct lzx_codes *codes,
523                        unsigned num_main_syms)
524 {
525         make_canonical_huffman_code(num_main_syms,
526                                     LZX_MAX_MAIN_CODEWORD_LEN,
527                                     freqs->main,
528                                     codes->lens.main,
529                                     codes->codewords.main);
530
531         make_canonical_huffman_code(LZX_LENCODE_NUM_SYMBOLS,
532                                     LZX_MAX_LEN_CODEWORD_LEN,
533                                     freqs->len,
534                                     codes->lens.len,
535                                     codes->codewords.len);
536
537         make_canonical_huffman_code(LZX_ALIGNEDCODE_NUM_SYMBOLS,
538                                     LZX_MAX_ALIGNED_CODEWORD_LEN,
539                                     freqs->aligned,
540                                     codes->lens.aligned,
541                                     codes->codewords.aligned);
542 }
543
544 /*
545  * Output a precomputed LZX match.
546  *
547  * @out:
548  *      The bitstream to which to write the match.
549  * @block_type:
550  *      The type of the LZX block (LZX_BLOCKTYPE_ALIGNED or
551  *      LZX_BLOCKTYPE_VERBATIM)
552  * @match:
553  *      The match data.
554  * @codes:
555  *      Pointer to a structure that contains the codewords for the main, length,
556  *      and aligned offset Huffman codes for the current LZX compressed block.
557  */
558 static void
559 lzx_write_match(struct output_bitstream *out, int block_type,
560                 struct lzx_item match, const struct lzx_codes *codes)
561 {
562         /* low 8 bits are the match length minus 2 */
563         unsigned match_len_minus_2 = match.data & 0xff;
564         /* Next 17 bits are the position footer */
565         unsigned position_footer = (match.data >> 8) & 0x1ffff; /* 17 bits */
566         /* Next 6 bits are the position slot. */
567         unsigned position_slot = (match.data >> 25) & 0x3f;     /* 6 bits */
568         unsigned len_header;
569         unsigned len_footer;
570         unsigned main_symbol;
571         unsigned num_extra_bits;
572         unsigned verbatim_bits;
573         unsigned aligned_bits;
574
575         /* If the match length is less than MIN_MATCH_LEN (= 2) +
576          * NUM_PRIMARY_LENS (= 7), the length header contains
577          * the match length minus MIN_MATCH_LEN, and there is no
578          * length footer.
579          *
580          * Otherwise, the length header contains
581          * NUM_PRIMARY_LENS, and the length footer contains
582          * the match length minus NUM_PRIMARY_LENS minus
583          * MIN_MATCH_LEN. */
584         if (match_len_minus_2 < LZX_NUM_PRIMARY_LENS) {
585                 len_header = match_len_minus_2;
586         } else {
587                 len_header = LZX_NUM_PRIMARY_LENS;
588                 len_footer = match_len_minus_2 - LZX_NUM_PRIMARY_LENS;
589         }
590
591         /* Combine the position slot with the length header into a single symbol
592          * that will be encoded with the main code.
593          *
594          * The actual main symbol is offset by LZX_NUM_CHARS because values
595          * under LZX_NUM_CHARS are used to indicate a literal byte rather than a
596          * match.  */
597         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
598
599         /* Output main symbol. */
600         bitstream_put_bits(out, codes->codewords.main[main_symbol],
601                            codes->lens.main[main_symbol]);
602
603         /* If there is a length footer, output it using the
604          * length Huffman code. */
605         if (len_header == LZX_NUM_PRIMARY_LENS)
606                 bitstream_put_bits(out, codes->codewords.len[len_footer],
607                                    codes->lens.len[len_footer]);
608
609         num_extra_bits = lzx_get_num_extra_bits(position_slot);
610
611         /* For aligned offset blocks with at least 3 extra bits, output the
612          * verbatim bits literally, then the aligned bits encoded using the
613          * aligned offset code.  Otherwise, only the verbatim bits need to be
614          * output. */
615         if ((block_type == LZX_BLOCKTYPE_ALIGNED) && (num_extra_bits >= 3)) {
616
617                 verbatim_bits = position_footer >> 3;
618                 bitstream_put_bits(out, verbatim_bits,
619                                    num_extra_bits - 3);
620
621                 aligned_bits = (position_footer & 7);
622                 bitstream_put_bits(out,
623                                    codes->codewords.aligned[aligned_bits],
624                                    codes->lens.aligned[aligned_bits]);
625         } else {
626                 /* verbatim bits is the same as the position
627                  * footer, in this case. */
628                 bitstream_put_bits(out, position_footer, num_extra_bits);
629         }
630 }
631
632 /* Output an LZX literal (encoded with the main Huffman code).  */
633 static void
634 lzx_write_literal(struct output_bitstream *out, u8 literal,
635                   const struct lzx_codes *codes)
636 {
637         bitstream_put_bits(out,
638                            codes->codewords.main[literal],
639                            codes->lens.main[literal]);
640 }
641
642 static unsigned
643 lzx_build_precode(const u8 lens[restrict],
644                   const u8 prev_lens[restrict],
645                   const unsigned num_syms,
646                   u32 precode_freqs[restrict LZX_PRECODE_NUM_SYMBOLS],
647                   u8 output_syms[restrict num_syms],
648                   u8 precode_lens[restrict LZX_PRECODE_NUM_SYMBOLS],
649                   u32 precode_codewords[restrict LZX_PRECODE_NUM_SYMBOLS],
650                   unsigned *num_additional_bits_ret)
651 {
652         memset(precode_freqs, 0,
653                LZX_PRECODE_NUM_SYMBOLS * sizeof(precode_freqs[0]));
654
655         /* Since the code word lengths use a form of RLE encoding, the goal here
656          * is to find each run of identical lengths when going through them in
657          * symbol order (including runs of length 1).  For each run, as many
658          * lengths are encoded using RLE as possible, and the rest are output
659          * literally.
660          *
661          * output_syms[] will be filled in with the length symbols that will be
662          * output, including RLE codes, not yet encoded using the precode.
663          *
664          * cur_run_len keeps track of how many code word lengths are in the
665          * current run of identical lengths.  */
666         unsigned output_syms_idx = 0;
667         unsigned cur_run_len = 1;
668         unsigned num_additional_bits = 0;
669         for (unsigned i = 1; i <= num_syms; i++) {
670
671                 if (i != num_syms && lens[i] == lens[i - 1]) {
672                         /* Still in a run--- keep going. */
673                         cur_run_len++;
674                         continue;
675                 }
676
677                 /* Run ended! Check if it is a run of zeroes or a run of
678                  * nonzeroes. */
679
680                 /* The symbol that was repeated in the run--- not to be confused
681                  * with the length *of* the run (cur_run_len) */
682                 unsigned len_in_run = lens[i - 1];
683
684                 if (len_in_run == 0) {
685                         /* A run of 0's.  Encode it in as few length
686                          * codes as we can. */
687
688                         /* The magic length 18 indicates a run of 20 + n zeroes,
689                          * where n is an uncompressed literal 5-bit integer that
690                          * follows the magic length. */
691                         while (cur_run_len >= 20) {
692                                 unsigned additional_bits;
693
694                                 additional_bits = min(cur_run_len - 20, 0x1f);
695                                 num_additional_bits += 5;
696                                 precode_freqs[18]++;
697                                 output_syms[output_syms_idx++] = 18;
698                                 output_syms[output_syms_idx++] = additional_bits;
699                                 cur_run_len -= 20 + additional_bits;
700                         }
701
702                         /* The magic length 17 indicates a run of 4 + n zeroes,
703                          * where n is an uncompressed literal 4-bit integer that
704                          * follows the magic length. */
705                         while (cur_run_len >= 4) {
706                                 unsigned additional_bits;
707
708                                 additional_bits = min(cur_run_len - 4, 0xf);
709                                 num_additional_bits += 4;
710                                 precode_freqs[17]++;
711                                 output_syms[output_syms_idx++] = 17;
712                                 output_syms[output_syms_idx++] = additional_bits;
713                                 cur_run_len -= 4 + additional_bits;
714                         }
715
716                 } else {
717
718                         /* A run of nonzero lengths. */
719
720                         /* The magic length 19 indicates a run of 4 + n
721                          * nonzeroes, where n is a literal bit that follows the
722                          * magic length, and where the value of the lengths in
723                          * the run is given by an extra length symbol, encoded
724                          * with the precode, that follows the literal bit.
725                          *
726                          * The extra length symbol is encoded as a difference
727                          * from the length of the codeword for the first symbol
728                          * in the run in the previous code.
729                          * */
730                         while (cur_run_len >= 4) {
731                                 unsigned additional_bits;
732                                 signed char delta;
733
734                                 additional_bits = (cur_run_len > 4);
735                                 num_additional_bits += 1;
736                                 delta = (signed char)prev_lens[i - cur_run_len] -
737                                         (signed char)len_in_run;
738                                 if (delta < 0)
739                                         delta += 17;
740                                 precode_freqs[19]++;
741                                 precode_freqs[(unsigned char)delta]++;
742                                 output_syms[output_syms_idx++] = 19;
743                                 output_syms[output_syms_idx++] = additional_bits;
744                                 output_syms[output_syms_idx++] = delta;
745                                 cur_run_len -= 4 + additional_bits;
746                         }
747                 }
748
749                 /* Any remaining lengths in the run are outputted without RLE,
750                  * as a difference from the length of that codeword in the
751                  * previous code. */
752                 while (cur_run_len > 0) {
753                         signed char delta;
754
755                         delta = (signed char)prev_lens[i - cur_run_len] -
756                                 (signed char)len_in_run;
757                         if (delta < 0)
758                                 delta += 17;
759
760                         precode_freqs[(unsigned char)delta]++;
761                         output_syms[output_syms_idx++] = delta;
762                         cur_run_len--;
763                 }
764
765                 cur_run_len = 1;
766         }
767
768         /* Build the precode from the frequencies of the length symbols. */
769
770         make_canonical_huffman_code(LZX_PRECODE_NUM_SYMBOLS,
771                                     LZX_MAX_PRE_CODEWORD_LEN,
772                                     precode_freqs, precode_lens,
773                                     precode_codewords);
774
775         *num_additional_bits_ret = num_additional_bits;
776
777         return output_syms_idx;
778 }
779
780 /*
781  * Output a Huffman code in the compressed form used in LZX.
782  *
783  * The Huffman code is represented in the output as a logical series of codeword
784  * lengths from which the Huffman code, which must be in canonical form, can be
785  * reconstructed.
786  *
787  * The codeword lengths are themselves compressed using a separate Huffman code,
788  * the "precode", which contains a symbol for each possible codeword length in
789  * the larger code as well as several special symbols to represent repeated
790  * codeword lengths (a form of run-length encoding).  The precode is itself
791  * constructed in canonical form, and its codeword lengths are represented
792  * literally in 20 4-bit fields that immediately precede the compressed codeword
793  * lengths of the larger code.
794  *
795  * Furthermore, the codeword lengths of the larger code are actually represented
796  * as deltas from the codeword lengths of the corresponding code in the previous
797  * block.
798  *
799  * @out:
800  *      Bitstream to which to write the compressed Huffman code.
801  * @lens:
802  *      The codeword lengths, indexed by symbol, in the Huffman code.
803  * @prev_lens:
804  *      The codeword lengths, indexed by symbol, in the corresponding Huffman
805  *      code in the previous block, or all zeroes if this is the first block.
806  * @num_syms:
807  *      The number of symbols in the Huffman code.
808  */
809 static void
810 lzx_write_compressed_code(struct output_bitstream *out,
811                           const u8 lens[restrict],
812                           const u8 prev_lens[restrict],
813                           unsigned num_syms)
814 {
815         u32 precode_freqs[LZX_PRECODE_NUM_SYMBOLS];
816         u8 output_syms[num_syms];
817         u8 precode_lens[LZX_PRECODE_NUM_SYMBOLS];
818         u32 precode_codewords[LZX_PRECODE_NUM_SYMBOLS];
819         unsigned i;
820         unsigned num_output_syms;
821         u8 precode_sym;
822         unsigned dummy;
823
824         num_output_syms = lzx_build_precode(lens,
825                                             prev_lens,
826                                             num_syms,
827                                             precode_freqs,
828                                             output_syms,
829                                             precode_lens,
830                                             precode_codewords,
831                                             &dummy);
832
833         /* Write the lengths of the precode codes to the output. */
834         for (i = 0; i < LZX_PRECODE_NUM_SYMBOLS; i++)
835                 bitstream_put_bits(out, precode_lens[i],
836                                    LZX_PRECODE_ELEMENT_SIZE);
837
838         /* Write the length symbols, encoded with the precode, to the output. */
839
840         for (i = 0; i < num_output_syms; ) {
841                 precode_sym = output_syms[i++];
842
843                 bitstream_put_bits(out, precode_codewords[precode_sym],
844                                    precode_lens[precode_sym]);
845                 switch (precode_sym) {
846                 case 17:
847                         bitstream_put_bits(out, output_syms[i++], 4);
848                         break;
849                 case 18:
850                         bitstream_put_bits(out, output_syms[i++], 5);
851                         break;
852                 case 19:
853                         bitstream_put_bits(out, output_syms[i++], 1);
854                         bitstream_put_bits(out,
855                                            precode_codewords[output_syms[i]],
856                                            precode_lens[output_syms[i]]);
857                         i++;
858                         break;
859                 default:
860                         break;
861                 }
862         }
863 }
864
865 /*
866  * Write all matches and literal bytes (which were precomputed) in an LZX
867  * compressed block to the output bitstream in the final compressed
868  * representation.
869  *
870  * @ostream
871  *      The output bitstream.
872  * @block_type
873  *      The chosen type of the LZX compressed block (LZX_BLOCKTYPE_ALIGNED or
874  *      LZX_BLOCKTYPE_VERBATIM).
875  * @items
876  *      The array of matches/literals to output.
877  * @num_items
878  *      Number of matches/literals to output (length of @items).
879  * @codes
880  *      The main, length, and aligned offset Huffman codes for the current
881  *      LZX compressed block.
882  */
883 static void
884 lzx_write_items(struct output_bitstream *ostream, int block_type,
885                 const struct lzx_item items[], u32 num_items,
886                 const struct lzx_codes *codes)
887 {
888         for (u32 i = 0; i < num_items; i++) {
889                 /* The high bit of the 32-bit intermediate representation
890                  * indicates whether the item is an actual LZ-style match (1) or
891                  * a literal byte (0).  */
892                 if (items[i].data & 0x80000000)
893                         lzx_write_match(ostream, block_type, items[i], codes);
894                 else
895                         lzx_write_literal(ostream, items[i].data, codes);
896         }
897 }
898
899 static void
900 lzx_assert_codes_valid(const struct lzx_codes * codes, unsigned num_main_syms)
901 {
902 #ifdef ENABLE_LZX_DEBUG
903         unsigned i;
904
905         for (i = 0; i < num_main_syms; i++)
906                 LZX_ASSERT(codes->lens.main[i] <= LZX_MAX_MAIN_CODEWORD_LEN);
907
908         for (i = 0; i < LZX_LENCODE_NUM_SYMBOLS; i++)
909                 LZX_ASSERT(codes->lens.len[i] <= LZX_MAX_LEN_CODEWORD_LEN);
910
911         for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++)
912                 LZX_ASSERT(codes->lens.aligned[i] <= LZX_MAX_ALIGNED_CODEWORD_LEN);
913
914         const unsigned tablebits = 10;
915         u16 decode_table[(1 << tablebits) +
916                          (2 * max(num_main_syms, LZX_LENCODE_NUM_SYMBOLS))]
917                          _aligned_attribute(DECODE_TABLE_ALIGNMENT);
918         LZX_ASSERT(0 == make_huffman_decode_table(decode_table,
919                                                   num_main_syms,
920                                                   min(tablebits, LZX_MAINCODE_TABLEBITS),
921                                                   codes->lens.main,
922                                                   LZX_MAX_MAIN_CODEWORD_LEN));
923         LZX_ASSERT(0 == make_huffman_decode_table(decode_table,
924                                                   LZX_LENCODE_NUM_SYMBOLS,
925                                                   min(tablebits, LZX_LENCODE_TABLEBITS),
926                                                   codes->lens.len,
927                                                   LZX_MAX_LEN_CODEWORD_LEN));
928         LZX_ASSERT(0 == make_huffman_decode_table(decode_table,
929                                                   LZX_ALIGNEDCODE_NUM_SYMBOLS,
930                                                   min(tablebits, LZX_ALIGNEDCODE_TABLEBITS),
931                                                   codes->lens.aligned,
932                                                   LZX_MAX_ALIGNED_CODEWORD_LEN));
933 #endif /* ENABLE_LZX_DEBUG */
934 }
935
936 /* Write an LZX aligned offset or verbatim block to the output.  */
937 static void
938 lzx_write_compressed_block(int block_type,
939                            unsigned block_size,
940                            unsigned max_window_size,
941                            unsigned num_main_syms,
942                            struct lzx_item * chosen_items,
943                            unsigned num_chosen_items,
944                            const struct lzx_codes * codes,
945                            const struct lzx_codes * prev_codes,
946                            struct output_bitstream * ostream)
947 {
948         unsigned i;
949
950         LZX_ASSERT(block_type == LZX_BLOCKTYPE_ALIGNED ||
951                    block_type == LZX_BLOCKTYPE_VERBATIM);
952         lzx_assert_codes_valid(codes, num_main_syms);
953
954         /* The first three bits indicate the type of block and are one of the
955          * LZX_BLOCKTYPE_* constants.  */
956         bitstream_put_bits(ostream, block_type, 3);
957
958         /* Output the block size.
959          *
960          * The original LZX format seemed to always encode the block size in 3
961          * bytes.  However, the implementation in WIMGAPI, as used in WIM files,
962          * uses the first bit to indicate whether the block is the default size
963          * (32768) or a different size given explicitly by the next 16 bits.
964          *
965          * By default, this compressor uses a window size of 32768 and therefore
966          * follows the WIMGAPI behavior.  However, this compressor also supports
967          * window sizes greater than 32768 bytes, which do not appear to be
968          * supported by WIMGAPI.  In such cases, we retain the default size bit
969          * to mean a size of 32768 bytes but output non-default block size in 24
970          * bits rather than 16.  The compatibility of this behavior is unknown
971          * because WIMs created with chunk size greater than 32768 can seemingly
972          * only be opened by wimlib anyway.  */
973         if (block_size == LZX_DEFAULT_BLOCK_SIZE) {
974                 bitstream_put_bits(ostream, 1, 1);
975         } else {
976                 bitstream_put_bits(ostream, 0, 1);
977
978                 if (max_window_size >= 65536)
979                         bitstream_put_bits(ostream, block_size >> 16, 8);
980
981                 bitstream_put_bits(ostream, block_size, 16);
982         }
983
984         /* Write out lengths of the main code. Note that the LZX specification
985          * incorrectly states that the aligned offset code comes after the
986          * length code, but in fact it is the very first code to be written
987          * (before the main code).  */
988         if (block_type == LZX_BLOCKTYPE_ALIGNED)
989                 for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++)
990                         bitstream_put_bits(ostream, codes->lens.aligned[i],
991                                            LZX_ALIGNEDCODE_ELEMENT_SIZE);
992
993         LZX_DEBUG("Writing main code...");
994
995         /* Write the precode and lengths for the first LZX_NUM_CHARS symbols in
996          * the main code, which are the codewords for literal bytes.  */
997         lzx_write_compressed_code(ostream,
998                                   codes->lens.main,
999                                   prev_codes->lens.main,
1000                                   LZX_NUM_CHARS);
1001
1002         /* Write the precode and lengths for the rest of the main code, which
1003          * are the codewords for match headers.  */
1004         lzx_write_compressed_code(ostream,
1005                                   codes->lens.main + LZX_NUM_CHARS,
1006                                   prev_codes->lens.main + LZX_NUM_CHARS,
1007                                   num_main_syms - LZX_NUM_CHARS);
1008
1009         LZX_DEBUG("Writing length code...");
1010
1011         /* Write the precode and lengths for the length code.  */
1012         lzx_write_compressed_code(ostream,
1013                                   codes->lens.len,
1014                                   prev_codes->lens.len,
1015                                   LZX_LENCODE_NUM_SYMBOLS);
1016
1017         LZX_DEBUG("Writing matches and literals...");
1018
1019         /* Write the actual matches and literals.  */
1020         lzx_write_items(ostream, block_type,
1021                         chosen_items, num_chosen_items, codes);
1022
1023         LZX_DEBUG("Done writing block.");
1024 }
1025
1026 /* Write out the LZX blocks that were computed.  */
1027 static void
1028 lzx_write_all_blocks(struct lzx_compressor *ctx, struct output_bitstream *ostream)
1029 {
1030
1031         const struct lzx_codes *prev_codes = &ctx->zero_codes;
1032         for (unsigned i = 0; i < ctx->num_blocks; i++) {
1033                 const struct lzx_block_spec *spec = &ctx->block_specs[i];
1034
1035                 LZX_DEBUG("Writing block %u/%u (type=%d, size=%u, num_chosen_items=%u)...",
1036                           i + 1, ctx->num_blocks,
1037                           spec->block_type, spec->block_size,
1038                           spec->num_chosen_items);
1039
1040                 lzx_write_compressed_block(spec->block_type,
1041                                            spec->block_size,
1042                                            ctx->max_window_size,
1043                                            ctx->num_main_syms,
1044                                            spec->chosen_items,
1045                                            spec->num_chosen_items,
1046                                            &spec->codes,
1047                                            prev_codes,
1048                                            ostream);
1049
1050                 prev_codes = &spec->codes;
1051         }
1052 }
1053
1054 /* Constructs an LZX match from a literal byte and updates the main code symbol
1055  * frequencies.  */
1056 static inline u32
1057 lzx_tally_literal(u8 lit, struct lzx_freqs *freqs)
1058 {
1059         freqs->main[lit]++;
1060         return (u32)lit;
1061 }
1062
1063 /* Constructs an LZX match from an offset and a length, and updates the LRU
1064  * queue and the frequency of symbols in the main, length, and aligned offset
1065  * alphabets.  The return value is a 32-bit number that provides the match in an
1066  * intermediate representation documented below.  */
1067 static inline u32
1068 lzx_tally_match(unsigned match_len, u32 match_offset,
1069                 struct lzx_freqs *freqs, struct lzx_lru_queue *queue)
1070 {
1071         unsigned position_slot;
1072         unsigned position_footer;
1073         u32 len_header;
1074         unsigned main_symbol;
1075         unsigned len_footer;
1076         unsigned adjusted_match_len;
1077
1078         LZX_ASSERT(match_len >= LZX_MIN_MATCH_LEN && match_len <= LZX_MAX_MATCH_LEN);
1079
1080         /* The match offset shall be encoded as a position slot (itself encoded
1081          * as part of the main symbol) and a position footer.  */
1082         position_slot = lzx_get_position_slot(match_offset, queue);
1083         position_footer = (match_offset + LZX_OFFSET_OFFSET) &
1084                                 ((1U << lzx_get_num_extra_bits(position_slot)) - 1);
1085
1086         /* The match length shall be encoded as a length header (itself encoded
1087          * as part of the main symbol) and an optional length footer.  */
1088         adjusted_match_len = match_len - LZX_MIN_MATCH_LEN;
1089         if (adjusted_match_len < LZX_NUM_PRIMARY_LENS) {
1090                 /* No length footer needed.  */
1091                 len_header = adjusted_match_len;
1092         } else {
1093                 /* Length footer needed.  It will be encoded using the length
1094                  * code.  */
1095                 len_header = LZX_NUM_PRIMARY_LENS;
1096                 len_footer = adjusted_match_len - LZX_NUM_PRIMARY_LENS;
1097                 freqs->len[len_footer]++;
1098         }
1099
1100         /* Account for the main symbol.  */
1101         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
1102
1103         freqs->main[main_symbol]++;
1104
1105         /* In an aligned offset block, 3 bits of the position footer are output
1106          * as an aligned offset symbol.  Account for this, although we may
1107          * ultimately decide to output the block as verbatim.  */
1108
1109         /* The following check is equivalent to:
1110          *
1111          * if (lzx_extra_bits[position_slot] >= 3)
1112          *
1113          * Note that this correctly excludes position slots that correspond to
1114          * recent offsets.  */
1115         if (position_slot >= 8)
1116                 freqs->aligned[position_footer & 7]++;
1117
1118         /* Pack the position slot, position footer, and match length into an
1119          * intermediate representation.  See `struct lzx_item' for details.
1120          */
1121         LZX_ASSERT(LZX_MAX_POSITION_SLOTS <= 64);
1122         LZX_ASSERT(lzx_get_num_extra_bits(LZX_MAX_POSITION_SLOTS - 1) <= 17);
1123         LZX_ASSERT(LZX_MAX_MATCH_LEN - LZX_MIN_MATCH_LEN + 1 <= 256);
1124
1125         LZX_ASSERT(position_slot      <= (1U << (31 - 25)) - 1);
1126         LZX_ASSERT(position_footer    <= (1U << (25 -  8)) - 1);
1127         LZX_ASSERT(adjusted_match_len <= (1U << (8  -  0)) - 1);
1128         return 0x80000000 |
1129                 (position_slot << 25) |
1130                 (position_footer << 8) |
1131                 (adjusted_match_len);
1132 }
1133
1134 struct lzx_record_ctx {
1135         struct lzx_freqs freqs;
1136         struct lzx_lru_queue queue;
1137         struct lzx_item *matches;
1138 };
1139
1140 static void
1141 lzx_record_match(unsigned len, unsigned offset, void *_ctx)
1142 {
1143         struct lzx_record_ctx *ctx = _ctx;
1144
1145         (ctx->matches++)->data = lzx_tally_match(len, offset, &ctx->freqs, &ctx->queue);
1146 }
1147
1148 static void
1149 lzx_record_literal(u8 lit, void *_ctx)
1150 {
1151         struct lzx_record_ctx *ctx = _ctx;
1152
1153         (ctx->matches++)->data = lzx_tally_literal(lit, &ctx->freqs);
1154 }
1155
1156 /* Returns the cost, in bits, to output a literal byte using the specified cost
1157  * model.  */
1158 static u32
1159 lzx_literal_cost(u8 c, const struct lzx_costs * costs)
1160 {
1161         return costs->main[c];
1162 }
1163
1164 /* Given a (length, offset) pair that could be turned into a valid LZX match as
1165  * well as costs for the codewords in the main, length, and aligned Huffman
1166  * codes, return the approximate number of bits it will take to represent this
1167  * match in the compressed output.  Take into account the match offset LRU
1168  * queue and also updates it.  */
1169 static u32
1170 lzx_match_cost(unsigned length, u32 offset, const struct lzx_costs *costs,
1171                struct lzx_lru_queue *queue)
1172 {
1173         unsigned position_slot;
1174         unsigned len_header, main_symbol;
1175         unsigned num_extra_bits;
1176         u32 cost = 0;
1177
1178         position_slot = lzx_get_position_slot(offset, queue);
1179
1180         len_header = min(length - LZX_MIN_MATCH_LEN, LZX_NUM_PRIMARY_LENS);
1181         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
1182
1183         /* Account for main symbol.  */
1184         cost += costs->main[main_symbol];
1185
1186         /* Account for extra position information.  */
1187         num_extra_bits = lzx_get_num_extra_bits(position_slot);
1188         if (num_extra_bits >= 3) {
1189                 cost += num_extra_bits - 3;
1190                 cost += costs->aligned[(offset + LZX_OFFSET_OFFSET) & 7];
1191         } else {
1192                 cost += num_extra_bits;
1193         }
1194
1195         /* Account for extra length information.  */
1196         if (len_header == LZX_NUM_PRIMARY_LENS)
1197                 cost += costs->len[length - LZX_MIN_MATCH_LEN - LZX_NUM_PRIMARY_LENS];
1198
1199         return cost;
1200
1201 }
1202
1203 /* Set the cost model @ctx->costs from the Huffman codeword lengths specified in
1204  * @lens.
1205  *
1206  * The cost model and codeword lengths are almost the same thing, but the
1207  * Huffman codewords with length 0 correspond to symbols with zero frequency
1208  * that still need to be assigned actual costs.  The specific values assigned
1209  * are arbitrary, but they should be fairly high (near the maximum codeword
1210  * length) to take into account the fact that uses of these symbols are expected
1211  * to be rare.  */
1212 static void
1213 lzx_set_costs(struct lzx_compressor * ctx, const struct lzx_lens * lens)
1214 {
1215         unsigned i;
1216         unsigned num_main_syms = ctx->num_main_syms;
1217
1218         /* Main code  */
1219         for (i = 0; i < num_main_syms; i++) {
1220                 ctx->costs.main[i] = lens->main[i];
1221                 if (ctx->costs.main[i] == 0)
1222                         ctx->costs.main[i] = ctx->params.alg_params.slow.main_nostat_cost;
1223         }
1224
1225         /* Length code  */
1226         for (i = 0; i < LZX_LENCODE_NUM_SYMBOLS; i++) {
1227                 ctx->costs.len[i] = lens->len[i];
1228                 if (ctx->costs.len[i] == 0)
1229                         ctx->costs.len[i] = ctx->params.alg_params.slow.len_nostat_cost;
1230         }
1231
1232         /* Aligned offset code  */
1233         for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++) {
1234                 ctx->costs.aligned[i] = lens->aligned[i];
1235                 if (ctx->costs.aligned[i] == 0)
1236                         ctx->costs.aligned[i] = ctx->params.alg_params.slow.aligned_nostat_cost;
1237         }
1238 }
1239
1240 /* Retrieve a list of matches available at the next position in the input.
1241  *
1242  * A pointer to the matches array is written into @matches_ret, and the return
1243  * value is the number of matches found.  */
1244 static unsigned
1245 lzx_get_matches(struct lzx_compressor *ctx,
1246                 const struct lz_match **matches_ret)
1247 {
1248         struct lz_match *cache_ptr;
1249         struct lz_match *matches;
1250         unsigned num_matches;
1251
1252         LZX_ASSERT(ctx->match_window_pos < ctx->match_window_end);
1253
1254         cache_ptr = ctx->cache_ptr;
1255         matches = cache_ptr + 1;
1256         if (likely(cache_ptr <= ctx->cache_limit)) {
1257                 if (ctx->matches_cached) {
1258                         num_matches = cache_ptr->len;
1259                 } else {
1260                         num_matches = lz_bt_get_matches(&ctx->mf, matches);
1261                         cache_ptr->len = num_matches;
1262                 }
1263         } else {
1264                 num_matches = 0;
1265         }
1266
1267         /* Don't allow matches to span the end of an LZX block.  */
1268         if (ctx->match_window_end < ctx->window_size && num_matches != 0) {
1269                 unsigned limit = ctx->match_window_end - ctx->match_window_pos;
1270
1271                 if (limit >= LZX_MIN_MATCH_LEN) {
1272
1273                         unsigned i = num_matches - 1;
1274                         do {
1275                                 if (matches[i].len >= limit) {
1276                                         matches[i].len = limit;
1277
1278                                         /* Truncation might produce multiple
1279                                          * matches with length 'limit'.  Keep at
1280                                          * most 1.  */
1281                                         num_matches = i + 1;
1282                                 }
1283                         } while (i--);
1284                 } else {
1285                         num_matches = 0;
1286                 }
1287                 cache_ptr->len = num_matches;
1288         }
1289
1290 #if 0
1291         fprintf(stderr, "Pos %u/%u: %u matches\n",
1292                 ctx->match_window_pos, ctx->window_size, num_matches);
1293         for (unsigned i = 0; i < num_matches; i++)
1294                 fprintf(stderr, "\tLen %u Offset %u\n", matches[i].len, matches[i].offset);
1295 #endif
1296
1297 #ifdef ENABLE_LZX_DEBUG
1298         for (unsigned i = 0; i < num_matches; i++) {
1299                 LZX_ASSERT(matches[i].len >= LZX_MIN_MATCH_LEN);
1300                 LZX_ASSERT(matches[i].len <= LZX_MAX_MATCH_LEN);
1301                 LZX_ASSERT(matches[i].len <= ctx->match_window_end - ctx->match_window_pos);
1302                 LZX_ASSERT(matches[i].offset > 0);
1303                 LZX_ASSERT(matches[i].offset <= ctx->match_window_pos);
1304                 LZX_ASSERT(!memcmp(&ctx->window[ctx->match_window_pos],
1305                                    &ctx->window[ctx->match_window_pos - matches[i].offset],
1306                                    matches[i].len));
1307                 if (i) {
1308                         LZX_ASSERT(matches[i].len > matches[i - 1].len);
1309                         LZX_ASSERT(matches[i].offset > matches[i - 1].offset);
1310                 }
1311         }
1312 #endif
1313         ctx->match_window_pos++;
1314         ctx->cache_ptr = matches + num_matches;
1315         *matches_ret = matches;
1316         return num_matches;
1317 }
1318
1319 static void
1320 lzx_skip_bytes(struct lzx_compressor *ctx, unsigned n)
1321 {
1322         struct lz_match *cache_ptr;
1323
1324         LZX_ASSERT(n <= ctx->match_window_end - ctx->match_window_pos);
1325
1326         cache_ptr = ctx->cache_ptr;
1327         ctx->match_window_pos += n;
1328         if (ctx->matches_cached) {
1329                 while (n-- && cache_ptr <= ctx->cache_limit)
1330                         cache_ptr += 1 + cache_ptr->len;
1331         } else {
1332                 lz_bt_skip_positions(&ctx->mf, n);
1333                 while (n-- && cache_ptr <= ctx->cache_limit) {
1334                         cache_ptr->len = 0;
1335                         cache_ptr += 1;
1336                 }
1337         }
1338         ctx->cache_ptr = cache_ptr;
1339 }
1340
1341 /*
1342  * Reverse the linked list of near-optimal matches so that they can be returned
1343  * in forwards order.
1344  *
1345  * Returns the first match in the list.
1346  */
1347 static struct lz_match
1348 lzx_match_chooser_reverse_list(struct lzx_compressor *ctx, unsigned cur_pos)
1349 {
1350         unsigned prev_link, saved_prev_link;
1351         unsigned prev_match_offset, saved_prev_match_offset;
1352
1353         ctx->optimum_end_idx = cur_pos;
1354
1355         saved_prev_link = ctx->optimum[cur_pos].prev.link;
1356         saved_prev_match_offset = ctx->optimum[cur_pos].prev.match_offset;
1357
1358         do {
1359                 prev_link = saved_prev_link;
1360                 prev_match_offset = saved_prev_match_offset;
1361
1362                 saved_prev_link = ctx->optimum[prev_link].prev.link;
1363                 saved_prev_match_offset = ctx->optimum[prev_link].prev.match_offset;
1364
1365                 ctx->optimum[prev_link].next.link = cur_pos;
1366                 ctx->optimum[prev_link].next.match_offset = prev_match_offset;
1367
1368                 cur_pos = prev_link;
1369         } while (cur_pos != 0);
1370
1371         ctx->optimum_cur_idx = ctx->optimum[0].next.link;
1372
1373         return (struct lz_match)
1374                 { .len = ctx->optimum_cur_idx,
1375                   .offset = ctx->optimum[0].next.match_offset,
1376                 };
1377 }
1378
1379 /*
1380  * lzx_get_near_optimal_match() -
1381  *
1382  * Choose an approximately optimal match or literal to use at the next position
1383  * in the string, or "window", being LZ-encoded.
1384  *
1385  * This is based on algorithms used in 7-Zip, including the DEFLATE encoder
1386  * and the LZMA encoder, written by Igor Pavlov.
1387  *
1388  * Unlike a greedy parser that always takes the longest match, or even a "lazy"
1389  * parser with one match/literal look-ahead like zlib, the algorithm used here
1390  * may look ahead many matches/literals to determine the approximately optimal
1391  * match/literal to code next.  The motivation is that the compression ratio is
1392  * improved if the compressor can do things like use a shorter-than-possible
1393  * match in order to allow a longer match later, and also take into account the
1394  * estimated real cost of coding each match/literal based on the underlying
1395  * entropy encoding.
1396  *
1397  * Still, this is not a true optimal parser for several reasons:
1398  *
1399  * - Real compression formats use entropy encoding of the literal/match
1400  *   sequence, so the real cost of coding each match or literal is unknown until
1401  *   the parse is fully determined.  It can be approximated based on iterative
1402  *   parses, but the end result is not guaranteed to be globally optimal.
1403  *
1404  * - Very long matches are chosen immediately.  This is because locations with
1405  *   long matches are likely to have many possible alternatives that would cause
1406  *   slow optimal parsing, but also such locations are already highly
1407  *   compressible so it is not too harmful to just grab the longest match.
1408  *
1409  * - Not all possible matches at each location are considered because the
1410  *   underlying match-finder limits the number and type of matches produced at
1411  *   each position.  For example, for a given match length it's usually not
1412  *   worth it to only consider matches other than the lowest-offset match,
1413  *   except in the case of a repeat offset.
1414  *
1415  * - Although we take into account the adaptive state (in LZX, the recent offset
1416  *   queue), coding decisions made with respect to the adaptive state will be
1417  *   locally optimal but will not necessarily be globally optimal.  This is
1418  *   because the algorithm only keeps the least-costly path to get to a given
1419  *   location and does not take into account that a slightly more costly path
1420  *   could result in a different adaptive state that ultimately results in a
1421  *   lower global cost.
1422  *
1423  * - The array space used by this function is bounded, so in degenerate cases it
1424  *   is forced to start returning matches/literals before the algorithm has
1425  *   really finished.
1426  *
1427  * Each call to this function does one of two things:
1428  *
1429  * 1. Build a sequence of near-optimal matches/literals, up to some point, that
1430  *    will be returned by subsequent calls to this function, then return the
1431  *    first one.
1432  *
1433  * OR
1434  *
1435  * 2. Return the next match/literal previously computed by a call to this
1436  *    function.
1437  *
1438  * The return value is a (length, offset) pair specifying the match or literal
1439  * chosen.  For literals, the length is 0 or 1 and the offset is meaningless.
1440  */
1441 static struct lz_match
1442 lzx_get_near_optimal_match(struct lzx_compressor *ctx)
1443 {
1444         unsigned num_matches;
1445         const struct lz_match *matches;
1446         struct lz_match match;
1447         unsigned longest_len;
1448         unsigned longest_rep_len;
1449         u32 longest_rep_offset;
1450         unsigned cur_pos;
1451         unsigned end_pos;
1452
1453         if (ctx->optimum_cur_idx != ctx->optimum_end_idx) {
1454                 /* Case 2: Return the next match/literal already found.  */
1455                 match.len = ctx->optimum[ctx->optimum_cur_idx].next.link -
1456                                     ctx->optimum_cur_idx;
1457                 match.offset = ctx->optimum[ctx->optimum_cur_idx].next.match_offset;
1458
1459                 ctx->optimum_cur_idx = ctx->optimum[ctx->optimum_cur_idx].next.link;
1460                 return match;
1461         }
1462
1463         /* Case 1:  Compute a new list of matches/literals to return.  */
1464
1465         ctx->optimum_cur_idx = 0;
1466         ctx->optimum_end_idx = 0;
1467
1468         /* Search for matches at recent offsets.  Only keep the one with the
1469          * longest match length.  */
1470         longest_rep_len = LZX_MIN_MATCH_LEN - 1;
1471         if (ctx->match_window_pos >= 1) {
1472                 unsigned limit = min(LZX_MAX_MATCH_LEN,
1473                                      ctx->match_window_end - ctx->match_window_pos);
1474                 for (int i = 0; i < LZX_NUM_RECENT_OFFSETS; i++) {
1475                         u32 offset = ctx->queue.R[i];
1476                         const u8 *strptr = &ctx->window[ctx->match_window_pos];
1477                         const u8 *matchptr = strptr - offset;
1478                         unsigned len = 0;
1479                         while (len < limit && strptr[len] == matchptr[len])
1480                                 len++;
1481                         if (len > longest_rep_len) {
1482                                 longest_rep_len = len;
1483                                 longest_rep_offset = offset;
1484                         }
1485                 }
1486         }
1487
1488         /* If there's a long match with a recent offset, take it.  */
1489         if (longest_rep_len >= ctx->params.alg_params.slow.nice_match_length) {
1490                 lzx_skip_bytes(ctx, longest_rep_len);
1491                 return (struct lz_match) {
1492                         .len = longest_rep_len,
1493                         .offset = longest_rep_offset,
1494                 };
1495         }
1496
1497         /* Search other matches.  */
1498         num_matches = lzx_get_matches(ctx, &matches);
1499
1500         /* If there's a long match, take it.  */
1501         if (num_matches) {
1502                 longest_len = matches[num_matches - 1].len;
1503                 if (longest_len >= ctx->params.alg_params.slow.nice_match_length) {
1504                         lzx_skip_bytes(ctx, longest_len - 1);
1505                         return matches[num_matches - 1];
1506                 }
1507         } else {
1508                 longest_len = 1;
1509         }
1510
1511         /* Calculate the cost to reach the next position by coding a literal.
1512          */
1513         ctx->optimum[1].queue = ctx->queue;
1514         ctx->optimum[1].cost = lzx_literal_cost(ctx->window[ctx->match_window_pos - 1],
1515                                                 &ctx->costs);
1516         ctx->optimum[1].prev.link = 0;
1517
1518         /* Calculate the cost to reach any position up to and including that
1519          * reached by the longest match.
1520          *
1521          * Note: We consider only the lowest-offset match that reaches each
1522          * position.
1523          *
1524          * Note: Some of the cost calculation stays the same for each offset,
1525          * regardless of how many lengths it gets used for.  Therefore, to
1526          * improve performance, we hand-code the cost calculation instead of
1527          * calling lzx_match_cost() to do a from-scratch cost evaluation at each
1528          * length.  */
1529         for (unsigned i = 0, len = 2; i < num_matches; i++) {
1530                 u32 offset;
1531                 struct lzx_lru_queue queue;
1532                 u32 position_cost;
1533                 unsigned position_slot;
1534                 unsigned num_extra_bits;
1535
1536                 offset = matches[i].offset;
1537                 queue = ctx->queue;
1538                 position_cost = 0;
1539
1540                 position_slot = lzx_get_position_slot(offset, &queue);
1541                 num_extra_bits = lzx_get_num_extra_bits(position_slot);
1542                 if (num_extra_bits >= 3) {
1543                         position_cost += num_extra_bits - 3;
1544                         position_cost += ctx->costs.aligned[(offset + LZX_OFFSET_OFFSET) & 7];
1545                 } else {
1546                         position_cost += num_extra_bits;
1547                 }
1548
1549                 do {
1550                         unsigned len_header;
1551                         unsigned main_symbol;
1552                         u32 cost;
1553
1554                         cost = position_cost;
1555
1556                         len_header = min(len - LZX_MIN_MATCH_LEN, LZX_NUM_PRIMARY_LENS);
1557                         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
1558                         cost += ctx->costs.main[main_symbol];
1559                         if (len_header == LZX_NUM_PRIMARY_LENS)
1560                                 cost += ctx->costs.len[len - LZX_MIN_MATCH_LEN - LZX_NUM_PRIMARY_LENS];
1561
1562                         ctx->optimum[len].queue = queue;
1563                         ctx->optimum[len].prev.link = 0;
1564                         ctx->optimum[len].prev.match_offset = offset;
1565                         ctx->optimum[len].cost = cost;
1566                 } while (++len <= matches[i].len);
1567         }
1568         end_pos = longest_len;
1569
1570         if (longest_rep_len >= LZX_MIN_MATCH_LEN) {
1571                 struct lzx_lru_queue queue;
1572                 u32 cost;
1573
1574                 while (end_pos < longest_rep_len)
1575                         ctx->optimum[++end_pos].cost = MC_INFINITE_COST;
1576
1577                 queue = ctx->queue;
1578                 cost = lzx_match_cost(longest_rep_len, longest_rep_offset,
1579                                       &ctx->costs, &queue);
1580                 if (cost <= ctx->optimum[longest_rep_len].cost) {
1581                         ctx->optimum[longest_rep_len].queue = queue;
1582                         ctx->optimum[longest_rep_len].prev.link = 0;
1583                         ctx->optimum[longest_rep_len].prev.match_offset = longest_rep_offset;
1584                         ctx->optimum[longest_rep_len].cost = cost;
1585                 }
1586         }
1587
1588         /* Step forward, calculating the estimated minimum cost to reach each
1589          * position.  The algorithm may find multiple paths to reach each
1590          * position; only the lowest-cost path is saved.
1591          *
1592          * The progress of the parse is tracked in the @ctx->optimum array, which
1593          * for each position contains the minimum cost to reach that position,
1594          * the index of the start of the match/literal taken to reach that
1595          * position through the minimum-cost path, the offset of the match taken
1596          * (not relevant for literals), and the adaptive state that will exist
1597          * at that position after the minimum-cost path is taken.  The @cur_pos
1598          * variable stores the position at which the algorithm is currently
1599          * considering coding choices, and the @end_pos variable stores the
1600          * greatest position at which the costs of coding choices have been
1601          * saved.  (Actually, the algorithm guarantees that all positions up to
1602          * and including @end_pos are reachable by at least one path.)
1603          *
1604          * The loop terminates when any one of the following conditions occurs:
1605          *
1606          * 1. A match with length greater than or equal to @nice_match_length is
1607          *    found.  When this occurs, the algorithm chooses this match
1608          *    unconditionally, and consequently the near-optimal match/literal
1609          *    sequence up to and including that match is fully determined and it
1610          *    can begin returning the match/literal list.
1611          *
1612          * 2. @cur_pos reaches a position not overlapped by a preceding match.
1613          *    In such cases, the near-optimal match/literal sequence up to
1614          *    @cur_pos is fully determined and it can begin returning the
1615          *    match/literal list.
1616          *
1617          * 3. Failing either of the above in a degenerate case, the loop
1618          *    terminates when space in the @ctx->optimum array is exhausted.
1619          *    This terminates the algorithm and forces it to start returning
1620          *    matches/literals even though they may not be globally optimal.
1621          *
1622          * Upon loop termination, a nonempty list of matches/literals will have
1623          * been produced and stored in the @optimum array.  These
1624          * matches/literals are linked in reverse order, so the last thing this
1625          * function does is reverse this list and return the first
1626          * match/literal, leaving the rest to be returned immediately by
1627          * subsequent calls to this function.
1628          */
1629         cur_pos = 0;
1630         for (;;) {
1631                 u32 cost;
1632
1633                 /* Advance to next position.  */
1634                 cur_pos++;
1635
1636                 /* Check termination conditions (2) and (3) noted above.  */
1637                 if (cur_pos == end_pos || cur_pos == LZX_OPTIM_ARRAY_SIZE)
1638                         return lzx_match_chooser_reverse_list(ctx, cur_pos);
1639
1640                 /* Search for matches at recent offsets.  */
1641                 longest_rep_len = LZX_MIN_MATCH_LEN - 1;
1642                 unsigned limit = min(LZX_MAX_MATCH_LEN,
1643                                      ctx->match_window_end - ctx->match_window_pos);
1644                 for (int i = 0; i < LZX_NUM_RECENT_OFFSETS; i++) {
1645                         u32 offset = ctx->optimum[cur_pos].queue.R[i];
1646                         const u8 *strptr = &ctx->window[ctx->match_window_pos];
1647                         const u8 *matchptr = strptr - offset;
1648                         unsigned len = 0;
1649                         while (len < limit && strptr[len] == matchptr[len])
1650                                 len++;
1651                         if (len > longest_rep_len) {
1652                                 longest_rep_len = len;
1653                                 longest_rep_offset = offset;
1654                         }
1655                 }
1656
1657                 /* If we found a long match at a recent offset, choose it
1658                  * immediately.  */
1659                 if (longest_rep_len >= ctx->params.alg_params.slow.nice_match_length) {
1660                         /* Build the list of matches to return and get
1661                          * the first one.  */
1662                         match = lzx_match_chooser_reverse_list(ctx, cur_pos);
1663
1664                         /* Append the long match to the end of the list.  */
1665                         ctx->optimum[cur_pos].next.match_offset = longest_rep_offset;
1666                         ctx->optimum[cur_pos].next.link = cur_pos + longest_rep_len;
1667                         ctx->optimum_end_idx = cur_pos + longest_rep_len;
1668
1669                         /* Skip over the remaining bytes of the long match.  */
1670                         lzx_skip_bytes(ctx, longest_rep_len);
1671
1672                         /* Return first match in the list.  */
1673                         return match;
1674                 }
1675
1676                 /* Search other matches.  */
1677                 num_matches = lzx_get_matches(ctx, &matches);
1678
1679                 /* If there's a long match, take it.  */
1680                 if (num_matches) {
1681                         longest_len = matches[num_matches - 1].len;
1682                         if (longest_len >= ctx->params.alg_params.slow.nice_match_length) {
1683                                 /* Build the list of matches to return and get
1684                                  * the first one.  */
1685                                 match = lzx_match_chooser_reverse_list(ctx, cur_pos);
1686
1687                                 /* Append the long match to the end of the list.  */
1688                                 ctx->optimum[cur_pos].next.match_offset =
1689                                         matches[num_matches - 1].offset;
1690                                 ctx->optimum[cur_pos].next.link = cur_pos + longest_len;
1691                                 ctx->optimum_end_idx = cur_pos + longest_len;
1692
1693                                 /* Skip over the remaining bytes of the long match.  */
1694                                 lzx_skip_bytes(ctx, longest_len - 1);
1695
1696                                 /* Return first match in the list.  */
1697                                 return match;
1698                         }
1699                 } else {
1700                         longest_len = 1;
1701                 }
1702
1703                 while (end_pos < cur_pos + longest_len)
1704                         ctx->optimum[++end_pos].cost = MC_INFINITE_COST;
1705
1706                 /* Consider coding a literal.  */
1707                 cost = ctx->optimum[cur_pos].cost +
1708                         lzx_literal_cost(ctx->window[ctx->match_window_pos - 1],
1709                                          &ctx->costs);
1710                 if (cost < ctx->optimum[cur_pos + 1].cost) {
1711                         ctx->optimum[cur_pos + 1].queue = ctx->optimum[cur_pos].queue;
1712                         ctx->optimum[cur_pos + 1].cost = cost;
1713                         ctx->optimum[cur_pos + 1].prev.link = cur_pos;
1714                 }
1715
1716                 /* Consider coding a match.
1717                  *
1718                  * The hard-coded cost calculation is done for the same reason
1719                  * stated in the comment for the similar loop earlier.
1720                  * Actually, it is *this* one that has the biggest effect on
1721                  * performance; overall LZX compression is > 10% faster with
1722                  * this code compared to calling lzx_match_cost() with each
1723                  * length.  */
1724                 for (unsigned i = 0, len = 2; i < num_matches; i++) {
1725                         u32 offset;
1726                         struct lzx_lru_queue queue;
1727                         u32 position_cost;
1728                         unsigned position_slot;
1729                         unsigned num_extra_bits;
1730
1731                         offset = matches[i].offset;
1732                         queue = ctx->optimum[cur_pos].queue;
1733                         position_cost = ctx->optimum[cur_pos].cost;
1734
1735                         position_slot = lzx_get_position_slot(offset, &queue);
1736                         num_extra_bits = lzx_get_num_extra_bits(position_slot);
1737                         if (num_extra_bits >= 3) {
1738                                 position_cost += num_extra_bits - 3;
1739                                 position_cost += ctx->costs.aligned[
1740                                                 (offset + LZX_OFFSET_OFFSET) & 7];
1741                         } else {
1742                                 position_cost += num_extra_bits;
1743                         }
1744
1745                         do {
1746                                 unsigned len_header;
1747                                 unsigned main_symbol;
1748                                 u32 cost;
1749
1750                                 cost = position_cost;
1751
1752                                 len_header = min(len - LZX_MIN_MATCH_LEN,
1753                                                  LZX_NUM_PRIMARY_LENS);
1754                                 main_symbol = ((position_slot << 3) | len_header) +
1755                                                 LZX_NUM_CHARS;
1756                                 cost += ctx->costs.main[main_symbol];
1757                                 if (len_header == LZX_NUM_PRIMARY_LENS) {
1758                                         cost += ctx->costs.len[len -
1759                                                         LZX_MIN_MATCH_LEN -
1760                                                         LZX_NUM_PRIMARY_LENS];
1761                                 }
1762                                 if (cost < ctx->optimum[cur_pos + len].cost) {
1763                                         ctx->optimum[cur_pos + len].queue = queue;
1764                                         ctx->optimum[cur_pos + len].prev.link = cur_pos;
1765                                         ctx->optimum[cur_pos + len].prev.match_offset = offset;
1766                                         ctx->optimum[cur_pos + len].cost = cost;
1767                                 }
1768                         } while (++len <= matches[i].len);
1769                 }
1770
1771                 if (longest_rep_len >= LZX_MIN_MATCH_LEN) {
1772                         struct lzx_lru_queue queue;
1773
1774                         while (end_pos < cur_pos + longest_rep_len)
1775                                 ctx->optimum[++end_pos].cost = MC_INFINITE_COST;
1776
1777                         queue = ctx->optimum[cur_pos].queue;
1778
1779                         cost = ctx->optimum[cur_pos].cost +
1780                                 lzx_match_cost(longest_rep_len, longest_rep_offset,
1781                                                &ctx->costs, &queue);
1782                         if (cost <= ctx->optimum[cur_pos + longest_rep_len].cost) {
1783                                 ctx->optimum[cur_pos + longest_rep_len].queue =
1784                                         queue;
1785                                 ctx->optimum[cur_pos + longest_rep_len].prev.link =
1786                                         cur_pos;
1787                                 ctx->optimum[cur_pos + longest_rep_len].prev.match_offset =
1788                                         longest_rep_offset;
1789                                 ctx->optimum[cur_pos + longest_rep_len].cost =
1790                                         cost;
1791                         }
1792                 }
1793         }
1794 }
1795
1796 /* Set default symbol costs for the LZX Huffman codes.  */
1797 static void
1798 lzx_set_default_costs(struct lzx_costs * costs, unsigned num_main_syms)
1799 {
1800         unsigned i;
1801
1802         /* Main code (part 1): Literal symbols  */
1803         for (i = 0; i < LZX_NUM_CHARS; i++)
1804                 costs->main[i] = 8;
1805
1806         /* Main code (part 2): Match header symbols  */
1807         for (; i < num_main_syms; i++)
1808                 costs->main[i] = 10;
1809
1810         /* Length code  */
1811         for (i = 0; i < LZX_LENCODE_NUM_SYMBOLS; i++)
1812                 costs->len[i] = 8;
1813
1814         /* Aligned offset code  */
1815         for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++)
1816                 costs->aligned[i] = 3;
1817 }
1818
1819 /* Given the frequencies of symbols in an LZX-compressed block and the
1820  * corresponding Huffman codes, return LZX_BLOCKTYPE_ALIGNED or
1821  * LZX_BLOCKTYPE_VERBATIM if an aligned offset or verbatim block, respectively,
1822  * will take fewer bits to output.  */
1823 static int
1824 lzx_choose_verbatim_or_aligned(const struct lzx_freqs * freqs,
1825                                const struct lzx_codes * codes)
1826 {
1827         unsigned aligned_cost = 0;
1828         unsigned verbatim_cost = 0;
1829
1830         /* Verbatim blocks have a constant 3 bits per position footer.  Aligned
1831          * offset blocks have an aligned offset symbol per position footer, plus
1832          * an extra 24 bits per block to output the lengths necessary to
1833          * reconstruct the aligned offset code itself.  */
1834         for (unsigned i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++) {
1835                 verbatim_cost += 3 * freqs->aligned[i];
1836                 aligned_cost += codes->lens.aligned[i] * freqs->aligned[i];
1837         }
1838         aligned_cost += LZX_ALIGNEDCODE_ELEMENT_SIZE * LZX_ALIGNEDCODE_NUM_SYMBOLS;
1839         if (aligned_cost < verbatim_cost)
1840                 return LZX_BLOCKTYPE_ALIGNED;
1841         else
1842                 return LZX_BLOCKTYPE_VERBATIM;
1843 }
1844
1845 /* Find a near-optimal sequence of matches/literals with which to output the
1846  * specified LZX block, then set the block's type to that which has the minimum
1847  * cost to output (either verbatim or aligned).  */
1848 static void
1849 lzx_optimize_block(struct lzx_compressor *ctx, struct lzx_block_spec *spec,
1850                    unsigned num_passes)
1851 {
1852         const struct lzx_lru_queue orig_queue = ctx->queue;
1853         unsigned num_passes_remaining = num_passes;
1854         struct lzx_freqs freqs;
1855         const u8 *window_ptr;
1856         const u8 *window_end;
1857         struct lzx_item *next_chosen_match;
1858         struct lz_match lz_match;
1859         struct lzx_item lzx_item;
1860
1861         LZX_ASSERT(num_passes >= 1);
1862         LZX_ASSERT(lz_bt_get_position(&ctx->mf) == spec->window_pos);
1863
1864         ctx->match_window_end = spec->window_pos + spec->block_size;
1865         ctx->matches_cached = false;
1866
1867         /* The first optimal parsing pass is done using the cost model already
1868          * set in ctx->costs.  Each later pass is done using a cost model
1869          * computed from the previous pass.
1870          *
1871          * To improve performance we only generate the array containing the
1872          * matches and literals in intermediate form on the final pass.  */
1873
1874         while (--num_passes_remaining) {
1875                 ctx->match_window_pos = spec->window_pos;
1876                 ctx->cache_ptr = ctx->cached_matches;
1877                 memset(&freqs, 0, sizeof(freqs));
1878                 window_ptr = &ctx->window[spec->window_pos];
1879                 window_end = window_ptr + spec->block_size;
1880
1881                 while (window_ptr != window_end) {
1882
1883                         lz_match = lzx_get_near_optimal_match(ctx);
1884
1885                         LZX_ASSERT(!(lz_match.len == LZX_MIN_MATCH_LEN &&
1886                                      lz_match.offset == ctx->max_window_size -
1887                                                          LZX_MIN_MATCH_LEN));
1888                         if (lz_match.len >= LZX_MIN_MATCH_LEN) {
1889                                 lzx_tally_match(lz_match.len, lz_match.offset,
1890                                                 &freqs, &ctx->queue);
1891                                 window_ptr += lz_match.len;
1892                         } else {
1893                                 lzx_tally_literal(*window_ptr, &freqs);
1894                                 window_ptr += 1;
1895                         }
1896                 }
1897                 lzx_make_huffman_codes(&freqs, &spec->codes, ctx->num_main_syms);
1898                 lzx_set_costs(ctx, &spec->codes.lens);
1899                 ctx->queue = orig_queue;
1900                 ctx->matches_cached = true;
1901         }
1902
1903         ctx->match_window_pos = spec->window_pos;
1904         ctx->cache_ptr = ctx->cached_matches;
1905         memset(&freqs, 0, sizeof(freqs));
1906         window_ptr = &ctx->window[spec->window_pos];
1907         window_end = window_ptr + spec->block_size;
1908
1909         spec->chosen_items = &ctx->chosen_items[spec->window_pos];
1910         next_chosen_match = spec->chosen_items;
1911
1912         while (window_ptr != window_end) {
1913                 lz_match = lzx_get_near_optimal_match(ctx);
1914
1915                 LZX_ASSERT(!(lz_match.len == LZX_MIN_MATCH_LEN &&
1916                              lz_match.offset == ctx->max_window_size -
1917                                                  LZX_MIN_MATCH_LEN));
1918                 if (lz_match.len >= LZX_MIN_MATCH_LEN) {
1919                         lzx_item.data = lzx_tally_match(lz_match.len,
1920                                                          lz_match.offset,
1921                                                          &freqs, &ctx->queue);
1922                         window_ptr += lz_match.len;
1923                 } else {
1924                         lzx_item.data = lzx_tally_literal(*window_ptr, &freqs);
1925                         window_ptr += 1;
1926                 }
1927                 *next_chosen_match++ = lzx_item;
1928         }
1929         spec->num_chosen_items = next_chosen_match - spec->chosen_items;
1930         lzx_make_huffman_codes(&freqs, &spec->codes, ctx->num_main_syms);
1931         spec->block_type = lzx_choose_verbatim_or_aligned(&freqs, &spec->codes);
1932 }
1933
1934 /* Prepare the input window into one or more LZX blocks ready to be output.  */
1935 static void
1936 lzx_prepare_blocks(struct lzx_compressor * ctx)
1937 {
1938         /* Set up a default cost model.  */
1939         lzx_set_default_costs(&ctx->costs, ctx->num_main_syms);
1940
1941         /* Set up the block specifications.
1942          * TODO: The compression ratio could be slightly improved by performing
1943          * data-dependent block splitting instead of using fixed-size blocks.
1944          * Doing so well is a computationally hard problem, however.  */
1945         ctx->num_blocks = DIV_ROUND_UP(ctx->window_size, LZX_DIV_BLOCK_SIZE);
1946         for (unsigned i = 0; i < ctx->num_blocks; i++) {
1947                 unsigned pos = LZX_DIV_BLOCK_SIZE * i;
1948                 ctx->block_specs[i].window_pos = pos;
1949                 ctx->block_specs[i].block_size = min(ctx->window_size - pos,
1950                                                      LZX_DIV_BLOCK_SIZE);
1951         }
1952
1953         /* Load the window into the match-finder.  */
1954         lz_bt_load_window(&ctx->mf, ctx->window, ctx->window_size);
1955
1956         /* Determine sequence of matches/literals to output for each block.  */
1957         lzx_lru_queue_init(&ctx->queue);
1958         ctx->optimum_cur_idx = 0;
1959         ctx->optimum_end_idx = 0;
1960         for (unsigned i = 0; i < ctx->num_blocks; i++) {
1961                 lzx_optimize_block(ctx, &ctx->block_specs[i],
1962                                    ctx->params.alg_params.slow.num_optim_passes);
1963         }
1964 }
1965
1966 /*
1967  * This is the fast version of lzx_prepare_blocks().  This version "quickly"
1968  * prepares a single compressed block containing the entire input.  See the
1969  * description of the "Fast algorithm" at the beginning of this file for more
1970  * information.
1971  *
1972  * Input ---  the preprocessed data:
1973  *
1974  *      ctx->window[]
1975  *      ctx->window_size
1976  *
1977  * Output --- the block specification and the corresponding match/literal data:
1978  *
1979  *      ctx->block_specs[]
1980  *      ctx->num_blocks
1981  *      ctx->chosen_items[]
1982  */
1983 static void
1984 lzx_prepare_block_fast(struct lzx_compressor * ctx)
1985 {
1986         struct lzx_record_ctx record_ctx;
1987         struct lzx_block_spec *spec;
1988
1989         /* Parameters to hash chain LZ match finder
1990          * (lazy with 1 match lookahead)  */
1991         static const struct lz_params lzx_lz_params = {
1992                 /* Although LZX_MIN_MATCH_LEN == 2, length 2 matches typically
1993                  * aren't worth choosing when using greedy or lazy parsing.  */
1994                 .min_match      = 3,
1995                 .max_match      = LZX_MAX_MATCH_LEN,
1996                 .max_offset     = LZX_MAX_WINDOW_SIZE,
1997                 .good_match     = LZX_MAX_MATCH_LEN,
1998                 .nice_match     = LZX_MAX_MATCH_LEN,
1999                 .max_chain_len  = LZX_MAX_MATCH_LEN,
2000                 .max_lazy_match = LZX_MAX_MATCH_LEN,
2001                 .too_far        = 4096,
2002         };
2003
2004         /* Initialize symbol frequencies and match offset LRU queue.  */
2005         memset(&record_ctx.freqs, 0, sizeof(struct lzx_freqs));
2006         lzx_lru_queue_init(&record_ctx.queue);
2007         record_ctx.matches = ctx->chosen_items;
2008
2009         /* Determine series of matches/literals to output.  */
2010         lz_analyze_block(ctx->window,
2011                          ctx->window_size,
2012                          lzx_record_match,
2013                          lzx_record_literal,
2014                          &record_ctx,
2015                          &lzx_lz_params,
2016                          ctx->prev_tab);
2017
2018         /* Set up block specification.  */
2019         spec = &ctx->block_specs[0];
2020         spec->block_type = LZX_BLOCKTYPE_ALIGNED;
2021         spec->window_pos = 0;
2022         spec->block_size = ctx->window_size;
2023         spec->num_chosen_items = (record_ctx.matches - ctx->chosen_items);
2024         spec->chosen_items = ctx->chosen_items;
2025         lzx_make_huffman_codes(&record_ctx.freqs, &spec->codes,
2026                                ctx->num_main_syms);
2027         ctx->num_blocks = 1;
2028 }
2029
2030 static size_t
2031 lzx_compress(const void *uncompressed_data, size_t uncompressed_size,
2032              void *compressed_data, size_t compressed_size_avail, void *_ctx)
2033 {
2034         struct lzx_compressor *ctx = _ctx;
2035         struct output_bitstream ostream;
2036         size_t compressed_size;
2037
2038         if (uncompressed_size < 100) {
2039                 LZX_DEBUG("Too small to bother compressing.");
2040                 return 0;
2041         }
2042
2043         if (uncompressed_size > ctx->max_window_size) {
2044                 LZX_DEBUG("Can't compress %zu bytes using window of %u bytes!",
2045                           uncompressed_size, ctx->max_window_size);
2046                 return 0;
2047         }
2048
2049         LZX_DEBUG("Attempting to compress %zu bytes...",
2050                   uncompressed_size);
2051
2052         /* The input data must be preprocessed.  To avoid changing the original
2053          * input, copy it to a temporary buffer.  */
2054         memcpy(ctx->window, uncompressed_data, uncompressed_size);
2055         ctx->window_size = uncompressed_size;
2056
2057         /* This line is unnecessary; it just avoids inconsequential accesses of
2058          * uninitialized memory that would show up in memory-checking tools such
2059          * as valgrind.  */
2060         memset(&ctx->window[ctx->window_size], 0, 12);
2061
2062         LZX_DEBUG("Preprocessing data...");
2063
2064         /* Before doing any actual compression, do the call instruction (0xe8
2065          * byte) translation on the uncompressed data.  */
2066         lzx_do_e8_preprocessing(ctx->window, ctx->window_size);
2067
2068         LZX_DEBUG("Preparing blocks...");
2069
2070         /* Prepare the compressed data.  */
2071         if (ctx->params.algorithm == WIMLIB_LZX_ALGORITHM_FAST)
2072                 lzx_prepare_block_fast(ctx);
2073         else
2074                 lzx_prepare_blocks(ctx);
2075
2076         LZX_DEBUG("Writing compressed blocks...");
2077
2078         /* Generate the compressed data.  */
2079         init_output_bitstream(&ostream, compressed_data, compressed_size_avail);
2080         lzx_write_all_blocks(ctx, &ostream);
2081
2082         LZX_DEBUG("Flushing bitstream...");
2083         compressed_size = flush_output_bitstream(&ostream);
2084         if (compressed_size == (u32)~0UL) {
2085                 LZX_DEBUG("Data did not compress to %zu bytes or less!",
2086                           compressed_size_avail);
2087                 return 0;
2088         }
2089
2090         LZX_DEBUG("Done: compressed %zu => %zu bytes.",
2091                   uncompressed_size, compressed_size);
2092
2093         /* Verify that we really get the same thing back when decompressing.
2094          * Although this could be disabled by default in all cases, it only
2095          * takes around 2-3% of the running time of the slow algorithm to do the
2096          * verification.  */
2097         if (ctx->params.algorithm == WIMLIB_LZX_ALGORITHM_SLOW
2098         #if defined(ENABLE_LZX_DEBUG) || defined(ENABLE_VERIFY_COMPRESSION)
2099             || 1
2100         #endif
2101             )
2102         {
2103                 struct wimlib_decompressor *decompressor;
2104
2105                 if (0 == wimlib_create_decompressor(WIMLIB_COMPRESSION_TYPE_LZX,
2106                                                     ctx->max_window_size,
2107                                                     NULL,
2108                                                     &decompressor))
2109                 {
2110                         int ret;
2111                         ret = wimlib_decompress(compressed_data,
2112                                                 compressed_size,
2113                                                 ctx->window,
2114                                                 uncompressed_size,
2115                                                 decompressor);
2116                         wimlib_free_decompressor(decompressor);
2117
2118                         if (ret) {
2119                                 ERROR("Failed to decompress data we "
2120                                       "compressed using LZX algorithm");
2121                                 wimlib_assert(0);
2122                                 return 0;
2123                         }
2124                         if (memcmp(uncompressed_data, ctx->window, uncompressed_size)) {
2125                                 ERROR("Data we compressed using LZX algorithm "
2126                                       "didn't decompress to original");
2127                                 wimlib_assert(0);
2128                                 return 0;
2129                         }
2130                 } else {
2131                         WARNING("Failed to create decompressor for "
2132                                 "data verification!");
2133                 }
2134         }
2135         return compressed_size;
2136 }
2137
2138 static void
2139 lzx_free_compressor(void *_ctx)
2140 {
2141         struct lzx_compressor *ctx = _ctx;
2142
2143         if (ctx) {
2144                 FREE(ctx->chosen_items);
2145                 FREE(ctx->cached_matches);
2146                 FREE(ctx->optimum);
2147                 lz_bt_destroy(&ctx->mf);
2148                 FREE(ctx->block_specs);
2149                 FREE(ctx->prev_tab);
2150                 FREE(ctx->window);
2151                 FREE(ctx);
2152         }
2153 }
2154
2155 static const struct wimlib_lzx_compressor_params lzx_fast_default = {
2156         .hdr = {
2157                 .size = sizeof(struct wimlib_lzx_compressor_params),
2158         },
2159         .algorithm = WIMLIB_LZX_ALGORITHM_FAST,
2160         .use_defaults = 0,
2161         .alg_params = {
2162                 .fast = {
2163                 },
2164         },
2165 };
2166 static const struct wimlib_lzx_compressor_params lzx_slow_default = {
2167         .hdr = {
2168                 .size = sizeof(struct wimlib_lzx_compressor_params),
2169         },
2170         .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
2171         .use_defaults = 0,
2172         .alg_params = {
2173                 .slow = {
2174                         .use_len2_matches = 1,
2175                         .nice_match_length = 32,
2176                         .num_optim_passes = 2,
2177                         .max_search_depth = 50,
2178                         .main_nostat_cost = 15,
2179                         .len_nostat_cost = 15,
2180                         .aligned_nostat_cost = 7,
2181                 },
2182         },
2183 };
2184
2185 static const struct wimlib_lzx_compressor_params *
2186 lzx_get_params(const struct wimlib_compressor_params_header *_params)
2187 {
2188         const struct wimlib_lzx_compressor_params *params =
2189                 (const struct wimlib_lzx_compressor_params*)_params;
2190
2191         if (params == NULL) {
2192                 LZX_DEBUG("Using default algorithm and parameters.");
2193                 params = &lzx_slow_default;
2194         } else {
2195                 if (params->use_defaults) {
2196                         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW)
2197                                 params = &lzx_slow_default;
2198                         else
2199                                 params = &lzx_fast_default;
2200                 }
2201         }
2202         return params;
2203 }
2204
2205 static int
2206 lzx_create_compressor(size_t window_size,
2207                       const struct wimlib_compressor_params_header *_params,
2208                       void **ctx_ret)
2209 {
2210         const struct wimlib_lzx_compressor_params *params = lzx_get_params(_params);
2211         struct lzx_compressor *ctx;
2212
2213         LZX_DEBUG("Allocating LZX context...");
2214
2215         if (!lzx_window_size_valid(window_size))
2216                 return WIMLIB_ERR_INVALID_PARAM;
2217
2218         ctx = CALLOC(1, sizeof(struct lzx_compressor));
2219         if (ctx == NULL)
2220                 goto oom;
2221
2222         ctx->num_main_syms = lzx_get_num_main_syms(window_size);
2223         ctx->max_window_size = window_size;
2224         ctx->window = MALLOC(window_size + 12);
2225         if (ctx->window == NULL)
2226                 goto oom;
2227
2228         if (params->algorithm == WIMLIB_LZX_ALGORITHM_FAST) {
2229                 ctx->prev_tab = MALLOC(window_size * sizeof(ctx->prev_tab[0]));
2230                 if (ctx->prev_tab == NULL)
2231                         goto oom;
2232         }
2233
2234         size_t block_specs_length = DIV_ROUND_UP(window_size, LZX_DIV_BLOCK_SIZE);
2235         ctx->block_specs = MALLOC(block_specs_length * sizeof(ctx->block_specs[0]));
2236         if (ctx->block_specs == NULL)
2237                 goto oom;
2238
2239         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
2240                 unsigned min_match_len = LZX_MIN_MATCH_LEN;
2241                 if (!params->alg_params.slow.use_len2_matches)
2242                         min_match_len = max(min_match_len, 3);
2243
2244                 if (!lz_bt_init(&ctx->mf,
2245                                 window_size,
2246                                 min_match_len,
2247                                 LZX_MAX_MATCH_LEN,
2248                                 params->alg_params.slow.nice_match_length,
2249                                 params->alg_params.slow.max_search_depth))
2250                         goto oom;
2251         }
2252
2253         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
2254                 ctx->optimum = MALLOC((LZX_OPTIM_ARRAY_SIZE +
2255                                        min(params->alg_params.slow.nice_match_length,
2256                                            LZX_MAX_MATCH_LEN)) *
2257                                                 sizeof(ctx->optimum[0]));
2258                 if (ctx->optimum == NULL)
2259                         goto oom;
2260         }
2261
2262         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
2263                 ctx->cached_matches = MALLOC(LZX_CACHE_SIZE);
2264                 if (ctx->cached_matches == NULL)
2265                         goto oom;
2266                 ctx->cache_limit = ctx->cached_matches +
2267                                    LZX_CACHE_LEN - (LZX_MAX_MATCHES_PER_POS + 1);
2268         }
2269
2270         ctx->chosen_items = MALLOC(window_size * sizeof(ctx->chosen_items[0]));
2271         if (ctx->chosen_items == NULL)
2272                 goto oom;
2273
2274         memcpy(&ctx->params, params, sizeof(struct wimlib_lzx_compressor_params));
2275         memset(&ctx->zero_codes, 0, sizeof(ctx->zero_codes));
2276
2277         LZX_DEBUG("Successfully allocated new LZX context.");
2278
2279         *ctx_ret = ctx;
2280         return 0;
2281
2282 oom:
2283         lzx_free_compressor(ctx);
2284         return WIMLIB_ERR_NOMEM;
2285 }
2286
2287 static u64
2288 lzx_get_needed_memory(size_t max_block_size,
2289                       const struct wimlib_compressor_params_header *_params)
2290 {
2291         const struct wimlib_lzx_compressor_params *params = lzx_get_params(_params);
2292
2293         u64 size = 0;
2294
2295         size += sizeof(struct lzx_compressor);
2296
2297         size += max_block_size + 12;
2298
2299         size += DIV_ROUND_UP(max_block_size, LZX_DIV_BLOCK_SIZE) *
2300                 sizeof(((struct lzx_compressor*)0)->block_specs[0]);
2301
2302         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
2303                 size += max_block_size * sizeof(((struct lzx_compressor*)0)->chosen_items[0]);
2304                 size += lz_bt_get_needed_memory(max_block_size);
2305                 size += (LZX_OPTIM_ARRAY_SIZE +
2306                          min(params->alg_params.slow.nice_match_length,
2307                              LZX_MAX_MATCH_LEN)) *
2308                                 sizeof(((struct lzx_compressor *)0)->optimum[0]);
2309                 size += LZX_CACHE_SIZE;
2310         } else {
2311                 size += max_block_size * sizeof(((struct lzx_compressor*)0)->prev_tab[0]);
2312         }
2313         return size;
2314 }
2315
2316 static bool
2317 lzx_params_valid(const struct wimlib_compressor_params_header *_params)
2318 {
2319         const struct wimlib_lzx_compressor_params *params =
2320                 (const struct wimlib_lzx_compressor_params*)_params;
2321
2322         if (params->hdr.size != sizeof(struct wimlib_lzx_compressor_params)) {
2323                 LZX_DEBUG("Invalid parameter structure size!");
2324                 return false;
2325         }
2326
2327         if (params->algorithm != WIMLIB_LZX_ALGORITHM_SLOW &&
2328             params->algorithm != WIMLIB_LZX_ALGORITHM_FAST)
2329         {
2330                 LZX_DEBUG("Invalid algorithm.");
2331                 return false;
2332         }
2333
2334         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW &&
2335             !params->use_defaults)
2336         {
2337                 if (params->alg_params.slow.num_optim_passes < 1)
2338                 {
2339                         LZX_DEBUG("Invalid number of optimization passes!");
2340                         return false;
2341                 }
2342
2343                 if (params->alg_params.slow.main_nostat_cost < 1 ||
2344                     params->alg_params.slow.main_nostat_cost > 16)
2345                 {
2346                         LZX_DEBUG("Invalid main_nostat_cost!");
2347                         return false;
2348                 }
2349
2350                 if (params->alg_params.slow.len_nostat_cost < 1 ||
2351                     params->alg_params.slow.len_nostat_cost > 16)
2352                 {
2353                         LZX_DEBUG("Invalid len_nostat_cost!");
2354                         return false;
2355                 }
2356
2357                 if (params->alg_params.slow.aligned_nostat_cost < 1 ||
2358                     params->alg_params.slow.aligned_nostat_cost > 8)
2359                 {
2360                         LZX_DEBUG("Invalid aligned_nostat_cost!");
2361                         return false;
2362                 }
2363         }
2364         return true;
2365 }
2366
2367 const struct compressor_ops lzx_compressor_ops = {
2368         .params_valid       = lzx_params_valid,
2369         .get_needed_memory  = lzx_get_needed_memory,
2370         .create_compressor  = lzx_create_compressor,
2371         .compress           = lzx_compress,
2372         .free_compressor    = lzx_free_compressor,
2373 };