lzx-compress.c: Cleanup, mostly comments
[wimlib] / src / lzx-compress.c
1 /*
2  * lzx-compress.c
3  *
4  * LZX compression routines
5  */
6
7 /*
8  * Copyright (C) 2012, 2013 Eric Biggers
9  *
10  * This file is part of wimlib, a library for working with WIM files.
11  *
12  * wimlib is free software; you can redistribute it and/or modify it under the
13  * terms of the GNU General Public License as published by the Free
14  * Software Foundation; either version 3 of the License, or (at your option)
15  * any later version.
16  *
17  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
18  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
19  * A PARTICULAR PURPOSE. See the GNU General Public License for more
20  * details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with wimlib; if not, see http://www.gnu.org/licenses/.
24  */
25
26
27 /*
28  * This file contains a compressor for the LZX compression format, as used in
29  * the WIM file format.
30  *
31  * Format
32  * ======
33  *
34  * First, the primary reference for the LZX compression format is the
35  * specification released by Microsoft.
36  *
37  * Second, the comments in lzx-decompress.c provide some more information about
38  * the LZX compression format, including errors in the Microsoft specification.
39  *
40  * Do note that LZX shares many similarities with DEFLATE, the algorithm used by
41  * zlib and gzip.  Both LZX and DEFLATE use LZ77 matching and Huffman coding,
42  * and certain other details are quite similar, such as the method for storing
43  * Huffman codes.  However, some of the main differences are:
44  *
45  * - LZX preprocesses the data to attempt to make x86 machine code slightly more
46  *   compressible before attempting to compress it further.
47  * - LZX uses a "main" alphabet which combines literals and matches, with the
48  *   match symbols containing a "length header" (giving all or part of the match
49  *   length) and a "position slot" (giving, roughly speaking, the order of
50  *   magnitude of the match offset).
51  * - LZX does not have static Huffman blocks; however it does have two types of
52  *   dynamic Huffman blocks ("aligned offset" and "verbatim").
53  * - LZX has a minimum match length of 2 rather than 3.
54  * - In LZX, match offsets 0 through 2 actually represent entries in an LRU
55  *   queue of match offsets.  This is very useful for certain types of files,
56  *   such as binary files that have repeating records.
57  *
58  * Algorithms
59  * ==========
60  *
61  * There are actually two distinct overall algorithms implemented here.  We
62  * shall refer to them as the "slow" algorithm and the "fast" algorithm.  The
63  * "slow" algorithm spends more time compressing to achieve a higher compression
64  * ratio compared to the "fast" algorithm.  More details are presented below.
65  *
66  * Slow algorithm
67  * --------------
68  *
69  * The "slow" algorithm to generate LZX-compressed data is roughly as follows:
70  *
71  * 1. Preprocess the input data to translate the targets of x86 call
72  *    instructions to absolute offsets.
73  *
74  * 2. Build the suffix array and inverse suffix array for the input data.  The
75  *    suffix array contains the indices of all suffixes of the input data,
76  *    sorted lexcographically by the corresponding suffixes.  The "position" of
77  *    a suffix is the index of that suffix in the original string, whereas the
78  *    "rank" of a suffix is the index at which that suffix's position is found
79  *    in the suffix array.
80  *
81  * 3. Build the longest common prefix array corresponding to the suffix array.
82  *
83  * 4. For each suffix, find the highest lower ranked suffix that has a lower
84  *    position, the lowest higher ranked suffix that has a lower position, and
85  *    the length of the common prefix shared between each.   This information is
86  *    later used to link suffix ranks into a doubly-linked list for searching
87  *    the suffix array.
88  *
89  * 5. Set a default cost model for matches/literals.
90  *
91  * 6. Determine the lowest cost sequence of LZ77 matches ((offset, length)
92  *    pairs) and literal bytes to divide the input into.  Raw match-finding is
93  *    done by searching the suffix array using a linked list to avoid
94  *    considering any suffixes that start after the current position.  Each run
95  *    of the match-finder returns the approximate lowest-cost longest match as
96  *    well as any shorter matches that have even lower approximate costs.  Each
97  *    such run also adds the suffix rank of the current position into the linked
98  *    list being used to search the suffix array.  Parsing, or match-choosing,
99  *    is solved as a minimum-cost path problem using a forward "optimal parsing"
100  *    algorithm based on the Deflate encoder from 7-Zip.  This algorithm moves
101  *    forward calculating the minimum cost to reach each byte until either a
102  *    very long match is found or until a position is found at which no matches
103  *    start or overlap.
104  *
105  * 7. Build the Huffman codes needed to output the matches/literals.
106  *
107  * 8. Up to a certain number of iterations, use the resulting Huffman codes to
108  *    refine a cost model and go back to Step #6 to determine an improved
109  *    sequence of matches and literals.
110  *
111  * 9. Output the resulting block using the match/literal sequences and the
112  *    Huffman codes that were computed for the block.
113  *
114  * Note: the algorithm does not yet attempt to split the input into multiple LZX
115  * blocks; it instead uses a series of blocks of LZX_DIV_BLOCK_SIZE bytes.
116  *
117  * Fast algorithm
118  * --------------
119  *
120  * The fast algorithm (and the only one available in wimlib v1.5.1 and earlier)
121  * spends much less time on the main bottlenecks of the compression process ---
122  * that is, the match finding and match choosing.  Matches are found and chosen
123  * with hash chains using a greedy parse with one position of look-ahead.  No
124  * block splitting is done; only compressing the full input into an aligned
125  * offset block is considered.
126  *
127  * Acknowledgments
128  * ===============
129  *
130  * Acknowledgments to several open-source projects and research papers that made
131  * it possible to implement this code:
132  *
133  * - divsufsort (author: Yuta Mori), for the suffix array construction code,
134  *   located in a separate directory (divsufsort/).
135  *
136  * - "Linear-Time Longest-Common-Prefix Computation in Suffix Arrays and Its
137  *   Applications" (Kasai et al. 2001), for the LCP array computation.
138  *
139  * - "LPF computation revisited" (Crochemore et al. 2009) for the prev and next
140  *   array computations.
141  *
142  * - 7-Zip (author: Igor Pavlov) for the algorithm for forward optimal parsing
143  *   (match-choosing).
144  *
145  * - zlib (author: Jean-loup Gailly and Mark Adler), for the hash table
146  *   match-finding algorithm (used in lz77.c).
147  *
148  * - lzx-compress (author: Matthew T. Russotto), on which some parts of this
149  *   code were originally based.
150  */
151
152 #ifdef HAVE_CONFIG_H
153 #  include "config.h"
154 #endif
155
156 #include "wimlib.h"
157 #include "wimlib/compressor_ops.h"
158 #include "wimlib/compress_common.h"
159 #include "wimlib/endianness.h"
160 #include "wimlib/error.h"
161 #include "wimlib/lz_hash.h"
162 #include "wimlib/lz_sarray.h"
163 #include "wimlib/lzx.h"
164 #include "wimlib/util.h"
165 #include <string.h>
166
167 #ifdef ENABLE_LZX_DEBUG
168 #  include "wimlib/decompress_common.h"
169 #endif
170
171 typedef u32 block_cost_t;
172 #define INFINITE_BLOCK_COST     (~(block_cost_t)0)
173
174 #define LZX_OPTIM_ARRAY_SIZE    4096
175
176 #define LZX_DIV_BLOCK_SIZE      32768
177
178 #define LZX_MAX_CACHE_PER_POS   10
179
180 /* Codewords for the LZX main, length, and aligned offset Huffman codes  */
181 struct lzx_codewords {
182         u16 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
183         u16 len[LZX_LENCODE_NUM_SYMBOLS];
184         u16 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
185 };
186
187 /* Codeword lengths (in bits) for the LZX main, length, and aligned offset
188  * Huffman codes.
189  *
190  * A 0 length means the codeword has zero frequency.
191  */
192 struct lzx_lens {
193         u8 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
194         u8 len[LZX_LENCODE_NUM_SYMBOLS];
195         u8 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
196 };
197
198 /* Costs for the LZX main, length, and aligned offset Huffman symbols.
199  *
200  * If a codeword has zero frequency, it must still be assigned some nonzero cost
201  * --- generally a high cost, since even if it gets used in the next iteration,
202  * it probably will not be used very times.  */
203 struct lzx_costs {
204         u8 main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
205         u8 len[LZX_LENCODE_NUM_SYMBOLS];
206         u8 aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
207 };
208
209 /* The LZX main, length, and aligned offset Huffman codes  */
210 struct lzx_codes {
211         struct lzx_codewords codewords;
212         struct lzx_lens lens;
213 };
214
215 /* Tables for tallying symbol frequencies in the three LZX alphabets  */
216 struct lzx_freqs {
217         input_idx_t main[LZX_MAINCODE_MAX_NUM_SYMBOLS];
218         input_idx_t len[LZX_LENCODE_NUM_SYMBOLS];
219         input_idx_t aligned[LZX_ALIGNEDCODE_NUM_SYMBOLS];
220 };
221
222 /* LZX intermediate match/literal format  */
223 struct lzx_match {
224         /* Bit     Description
225          *
226          * 31      1 if a match, 0 if a literal.
227          *
228          * 30-25   position slot.  This can be at most 50, so it will fit in 6
229          *         bits.
230          *
231          * 8-24    position footer.  This is the offset of the real formatted
232          *         offset from the position base.  This can be at most 17 bits
233          *         (since lzx_extra_bits[LZX_MAX_POSITION_SLOTS - 1] is 17).
234          *
235          * 0-7     length of match, minus 2.  This can be at most
236          *         (LZX_MAX_MATCH_LEN - 2) == 255, so it will fit in 8 bits.  */
237         u32 data;
238 };
239
240 /* Specification for an LZX block.  */
241 struct lzx_block_spec {
242
243         /* One of the LZX_BLOCKTYPE_* constants indicating which type of this
244          * block.  */
245         int block_type;
246
247         /* 0-based position in the window at which this block starts.  */
248         input_idx_t window_pos;
249
250         /* The number of bytes of uncompressed data this block represents.  */
251         input_idx_t block_size;
252
253         /* The position in the 'chosen_matches' array in the `struct
254          * lzx_compressor' at which the match/literal specifications for
255          * this block begin.  */
256         input_idx_t chosen_matches_start_pos;
257
258         /* The number of match/literal specifications for this block.  */
259         input_idx_t num_chosen_matches;
260
261         /* Huffman codes for this block.  */
262         struct lzx_codes codes;
263 };
264
265 /* Include template for the match-choosing algorithm.  */
266 #define LZ_COMPRESSOR           struct lzx_compressor
267 #define LZ_ADAPTIVE_STATE       struct lzx_lru_queue
268 struct lzx_compressor;
269 #include "wimlib/lz_optimal.h"
270
271 /* State of the LZX compressor.  */
272 struct lzx_compressor {
273
274         /* The parameters that were used to create the compressor.  */
275         struct wimlib_lzx_compressor_params params;
276
277         /* The buffer of data to be compressed.
278          *
279          * 0xe8 byte preprocessing is done directly on the data here before
280          * further compression.
281          *
282          * Note that this compressor does *not* use a real sliding window!!!!
283          * It's not needed in the WIM format, since every chunk is compressed
284          * independently.  This is by design, to allow random access to the
285          * chunks.
286          *
287          * We reserve a few extra bytes to potentially allow reading off the end
288          * of the array in the match-finding code for optimization purposes
289          * (currently only needed for the hash chain match-finder).  */
290         u8 *window;
291
292         /* Number of bytes of data to be compressed, which is the number of
293          * bytes of data in @window that are actually valid.  */
294         input_idx_t window_size;
295
296         /* Allocated size of the @window.  */
297         input_idx_t max_window_size;
298
299         /* Number of symbols in the main alphabet (depends on the
300          * @max_window_size since it determines the maximum allowed offset).  */
301         unsigned num_main_syms;
302
303         /* The current match offset LRU queue.  */
304         struct lzx_lru_queue queue;
305
306         /* Space for the sequences of matches/literals that were chosen for each
307          * block.  */
308         struct lzx_match *chosen_matches;
309
310         /* Information about the LZX blocks the preprocessed input was divided
311          * into.  */
312         struct lzx_block_spec *block_specs;
313
314         /* Number of LZX blocks the input was divided into; a.k.a. the number of
315          * elements of @block_specs that are valid.  */
316         unsigned num_blocks;
317
318         /* This is simply filled in with zeroes and used to avoid special-casing
319          * the output of the first compressed Huffman code, which conceptually
320          * has a delta taken from a code with all symbols having zero-length
321          * codewords.  */
322         struct lzx_codes zero_codes;
323
324         /* The current cost model.  */
325         struct lzx_costs costs;
326
327         /* Fast algorithm only:  Array of hash table links.  */
328         input_idx_t *prev_tab;
329
330         /* Slow algorithm only: Suffix array match-finder.  */
331         struct lz_sarray lz_sarray;
332
333         /* Position in window of next match to return.  */
334         input_idx_t match_window_pos;
335
336         /* The match-finder shall ensure the length of matches does not exceed
337          * this position in the input.  */
338         input_idx_t match_window_end;
339
340         /* Matches found by the match-finder are cached in the following array
341          * to achieve a slight speedup when the same matches are needed on
342          * subsequent passes.  This is suboptimal because different matches may
343          * be preferred with different cost models, but seems to be a worthwhile
344          * speedup.  */
345         struct raw_match *cached_matches;
346         unsigned cached_matches_pos;
347         bool matches_cached;
348
349         /* Match chooser.  */
350         struct lz_match_chooser mc;
351 };
352
353 /* Returns the LZX position slot that corresponds to a given match offset,
354  * taking into account the recent offset queue and updating it if the offset is
355  * found in it.  */
356 static unsigned
357 lzx_get_position_slot(unsigned offset, struct lzx_lru_queue *queue)
358 {
359         unsigned position_slot;
360
361         /* See if the offset was recently used.  */
362         for (unsigned i = 0; i < LZX_NUM_RECENT_OFFSETS; i++) {
363                 if (offset == queue->R[i]) {
364                         /* Found it.  */
365
366                         /* Bring the repeat offset to the front of the
367                          * queue.  Note: this is, in fact, not a real
368                          * LRU queue because repeat matches are simply
369                          * swapped to the front.  */
370                         swap(queue->R[0], queue->R[i]);
371
372                         /* The resulting position slot is simply the first index
373                          * at which the offset was found in the queue.  */
374                         return i;
375                 }
376         }
377
378         /* The offset was not recently used; look up its real position slot.  */
379         position_slot = lzx_get_position_slot_raw(offset + LZX_OFFSET_OFFSET);
380
381         /* Bring the new offset to the front of the queue.  */
382         for (unsigned i = LZX_NUM_RECENT_OFFSETS - 1; i > 0; i--)
383                 queue->R[i] = queue->R[i - 1];
384         queue->R[0] = offset;
385
386         return position_slot;
387 }
388
389 /* Build the main, length, and aligned offset Huffman codes used in LZX.
390  *
391  * This takes as input the frequency tables for each code and produces as output
392  * a set of tables that map symbols to codewords and codeword lengths.  */
393 static void
394 lzx_make_huffman_codes(const struct lzx_freqs *freqs,
395                        struct lzx_codes *codes,
396                        unsigned num_main_syms)
397 {
398         make_canonical_huffman_code(num_main_syms,
399                                     LZX_MAX_MAIN_CODEWORD_LEN,
400                                     freqs->main,
401                                     codes->lens.main,
402                                     codes->codewords.main);
403
404         make_canonical_huffman_code(LZX_LENCODE_NUM_SYMBOLS,
405                                     LZX_MAX_LEN_CODEWORD_LEN,
406                                     freqs->len,
407                                     codes->lens.len,
408                                     codes->codewords.len);
409
410         make_canonical_huffman_code(LZX_ALIGNEDCODE_NUM_SYMBOLS,
411                                     LZX_MAX_ALIGNED_CODEWORD_LEN,
412                                     freqs->aligned,
413                                     codes->lens.aligned,
414                                     codes->codewords.aligned);
415 }
416
417 /*
418  * Output a precomputed LZX match.
419  *
420  * @out:
421  *      The bitstream to which to write the match.
422  * @block_type:
423  *      The type of the LZX block (LZX_BLOCKTYPE_ALIGNED or
424  *      LZX_BLOCKTYPE_VERBATIM)
425  * @match:
426  *      The match, as a (length, offset) pair.
427  * @codes:
428  *      Pointer to a structure that contains the codewords for the main, length,
429  *      and aligned offset Huffman codes for the current LZX compressed block.
430  */
431 static void
432 lzx_write_match(struct output_bitstream *out, int block_type,
433                 struct lzx_match match, const struct lzx_codes *codes)
434 {
435         /* low 8 bits are the match length minus 2 */
436         unsigned match_len_minus_2 = match.data & 0xff;
437         /* Next 17 bits are the position footer */
438         unsigned position_footer = (match.data >> 8) & 0x1ffff; /* 17 bits */
439         /* Next 6 bits are the position slot. */
440         unsigned position_slot = (match.data >> 25) & 0x3f;     /* 6 bits */
441         unsigned len_header;
442         unsigned len_footer;
443         unsigned main_symbol;
444         unsigned num_extra_bits;
445         unsigned verbatim_bits;
446         unsigned aligned_bits;
447
448         /* If the match length is less than MIN_MATCH_LEN (= 2) +
449          * NUM_PRIMARY_LENS (= 7), the length header contains
450          * the match length minus MIN_MATCH_LEN, and there is no
451          * length footer.
452          *
453          * Otherwise, the length header contains
454          * NUM_PRIMARY_LENS, and the length footer contains
455          * the match length minus NUM_PRIMARY_LENS minus
456          * MIN_MATCH_LEN. */
457         if (match_len_minus_2 < LZX_NUM_PRIMARY_LENS) {
458                 len_header = match_len_minus_2;
459                 /* No length footer-- mark it with a special
460                  * value. */
461                 len_footer = (unsigned)(-1);
462         } else {
463                 len_header = LZX_NUM_PRIMARY_LENS;
464                 len_footer = match_len_minus_2 - LZX_NUM_PRIMARY_LENS;
465         }
466
467         /* Combine the position slot with the length header into a single symbol
468          * that will be encoded with the main code.
469          *
470          * The actual main symbol is offset by LZX_NUM_CHARS because values
471          * under LZX_NUM_CHARS are used to indicate a literal byte rather than a
472          * match.  */
473         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
474
475         /* Output main symbol. */
476         bitstream_put_bits(out, codes->codewords.main[main_symbol],
477                            codes->lens.main[main_symbol]);
478
479         /* If there is a length footer, output it using the
480          * length Huffman code. */
481         if (len_footer != (unsigned)(-1)) {
482                 bitstream_put_bits(out, codes->codewords.len[len_footer],
483                                    codes->lens.len[len_footer]);
484         }
485
486         num_extra_bits = lzx_get_num_extra_bits(position_slot);
487
488         /* For aligned offset blocks with at least 3 extra bits, output the
489          * verbatim bits literally, then the aligned bits encoded using the
490          * aligned offset code.  Otherwise, only the verbatim bits need to be
491          * output. */
492         if ((block_type == LZX_BLOCKTYPE_ALIGNED) && (num_extra_bits >= 3)) {
493
494                 verbatim_bits = position_footer >> 3;
495                 bitstream_put_bits(out, verbatim_bits,
496                                    num_extra_bits - 3);
497
498                 aligned_bits = (position_footer & 7);
499                 bitstream_put_bits(out,
500                                    codes->codewords.aligned[aligned_bits],
501                                    codes->lens.aligned[aligned_bits]);
502         } else {
503                 /* verbatim bits is the same as the position
504                  * footer, in this case. */
505                 bitstream_put_bits(out, position_footer, num_extra_bits);
506         }
507 }
508
509 /* Output an LZX literal (encoded with the main Huffman code).  */
510 static void
511 lzx_write_literal(struct output_bitstream *out, u8 literal,
512                   const struct lzx_codes *codes)
513 {
514         bitstream_put_bits(out,
515                            codes->codewords.main[literal],
516                            codes->lens.main[literal]);
517 }
518
519 static unsigned
520 lzx_build_precode(const u8 lens[restrict],
521                   const u8 prev_lens[restrict],
522                   const unsigned num_syms,
523                   input_idx_t precode_freqs[restrict LZX_PRECODE_NUM_SYMBOLS],
524                   u8 output_syms[restrict num_syms],
525                   u8 precode_lens[restrict LZX_PRECODE_NUM_SYMBOLS],
526                   u16 precode_codewords[restrict LZX_PRECODE_NUM_SYMBOLS],
527                   unsigned *num_additional_bits_ret)
528 {
529         memset(precode_freqs, 0,
530                LZX_PRECODE_NUM_SYMBOLS * sizeof(precode_freqs[0]));
531
532         /* Since the code word lengths use a form of RLE encoding, the goal here
533          * is to find each run of identical lengths when going through them in
534          * symbol order (including runs of length 1).  For each run, as many
535          * lengths are encoded using RLE as possible, and the rest are output
536          * literally.
537          *
538          * output_syms[] will be filled in with the length symbols that will be
539          * output, including RLE codes, not yet encoded using the precode.
540          *
541          * cur_run_len keeps track of how many code word lengths are in the
542          * current run of identical lengths.  */
543         unsigned output_syms_idx = 0;
544         unsigned cur_run_len = 1;
545         unsigned num_additional_bits = 0;
546         for (unsigned i = 1; i <= num_syms; i++) {
547
548                 if (i != num_syms && lens[i] == lens[i - 1]) {
549                         /* Still in a run--- keep going. */
550                         cur_run_len++;
551                         continue;
552                 }
553
554                 /* Run ended! Check if it is a run of zeroes or a run of
555                  * nonzeroes. */
556
557                 /* The symbol that was repeated in the run--- not to be confused
558                  * with the length *of* the run (cur_run_len) */
559                 unsigned len_in_run = lens[i - 1];
560
561                 if (len_in_run == 0) {
562                         /* A run of 0's.  Encode it in as few length
563                          * codes as we can. */
564
565                         /* The magic length 18 indicates a run of 20 + n zeroes,
566                          * where n is an uncompressed literal 5-bit integer that
567                          * follows the magic length. */
568                         while (cur_run_len >= 20) {
569                                 unsigned additional_bits;
570
571                                 additional_bits = min(cur_run_len - 20, 0x1f);
572                                 num_additional_bits += 5;
573                                 precode_freqs[18]++;
574                                 output_syms[output_syms_idx++] = 18;
575                                 output_syms[output_syms_idx++] = additional_bits;
576                                 cur_run_len -= 20 + additional_bits;
577                         }
578
579                         /* The magic length 17 indicates a run of 4 + n zeroes,
580                          * where n is an uncompressed literal 4-bit integer that
581                          * follows the magic length. */
582                         while (cur_run_len >= 4) {
583                                 unsigned additional_bits;
584
585                                 additional_bits = min(cur_run_len - 4, 0xf);
586                                 num_additional_bits += 4;
587                                 precode_freqs[17]++;
588                                 output_syms[output_syms_idx++] = 17;
589                                 output_syms[output_syms_idx++] = additional_bits;
590                                 cur_run_len -= 4 + additional_bits;
591                         }
592
593                 } else {
594
595                         /* A run of nonzero lengths. */
596
597                         /* The magic length 19 indicates a run of 4 + n
598                          * nonzeroes, where n is a literal bit that follows the
599                          * magic length, and where the value of the lengths in
600                          * the run is given by an extra length symbol, encoded
601                          * with the precode, that follows the literal bit.
602                          *
603                          * The extra length symbol is encoded as a difference
604                          * from the length of the codeword for the first symbol
605                          * in the run in the previous code.
606                          * */
607                         while (cur_run_len >= 4) {
608                                 unsigned additional_bits;
609                                 signed char delta;
610
611                                 additional_bits = (cur_run_len > 4);
612                                 num_additional_bits += 1;
613                                 delta = (signed char)prev_lens[i - cur_run_len] -
614                                         (signed char)len_in_run;
615                                 if (delta < 0)
616                                         delta += 17;
617                                 precode_freqs[19]++;
618                                 precode_freqs[(unsigned char)delta]++;
619                                 output_syms[output_syms_idx++] = 19;
620                                 output_syms[output_syms_idx++] = additional_bits;
621                                 output_syms[output_syms_idx++] = delta;
622                                 cur_run_len -= 4 + additional_bits;
623                         }
624                 }
625
626                 /* Any remaining lengths in the run are outputted without RLE,
627                  * as a difference from the length of that codeword in the
628                  * previous code. */
629                 while (cur_run_len > 0) {
630                         signed char delta;
631
632                         delta = (signed char)prev_lens[i - cur_run_len] -
633                                 (signed char)len_in_run;
634                         if (delta < 0)
635                                 delta += 17;
636
637                         precode_freqs[(unsigned char)delta]++;
638                         output_syms[output_syms_idx++] = delta;
639                         cur_run_len--;
640                 }
641
642                 cur_run_len = 1;
643         }
644
645         /* Build the precode from the frequencies of the length symbols. */
646
647         make_canonical_huffman_code(LZX_PRECODE_NUM_SYMBOLS,
648                                     LZX_MAX_PRE_CODEWORD_LEN,
649                                     precode_freqs, precode_lens,
650                                     precode_codewords);
651
652         *num_additional_bits_ret = num_additional_bits;
653
654         return output_syms_idx;
655 }
656
657 /*
658  * Output a Huffman code in the compressed form used in LZX.
659  *
660  * The Huffman code is represented in the output as a logical series of codeword
661  * lengths from which the Huffman code, which must be in canonical form, can be
662  * reconstructed.
663  *
664  * The codeword lengths are themselves compressed using a separate Huffman code,
665  * the "precode", which contains a symbol for each possible codeword length in
666  * the larger code as well as several special symbols to represent repeated
667  * codeword lengths (a form of run-length encoding).  The precode is itself
668  * constructed in canonical form, and its codeword lengths are represented
669  * literally in 20 4-bit fields that immediately precede the compressed codeword
670  * lengths of the larger code.
671  *
672  * Furthermore, the codeword lengths of the larger code are actually represented
673  * as deltas from the codeword lengths of the corresponding code in the previous
674  * block.
675  *
676  * @out:
677  *      Bitstream to which to write the compressed Huffman code.
678  * @lens:
679  *      The codeword lengths, indexed by symbol, in the Huffman code.
680  * @prev_lens:
681  *      The codeword lengths, indexed by symbol, in the corresponding Huffman
682  *      code in the previous block, or all zeroes if this is the first block.
683  * @num_syms:
684  *      The number of symbols in the Huffman code.
685  */
686 static void
687 lzx_write_compressed_code(struct output_bitstream *out,
688                           const u8 lens[restrict],
689                           const u8 prev_lens[restrict],
690                           unsigned num_syms)
691 {
692         input_idx_t precode_freqs[LZX_PRECODE_NUM_SYMBOLS];
693         u8 output_syms[num_syms];
694         u8 precode_lens[LZX_PRECODE_NUM_SYMBOLS];
695         u16 precode_codewords[LZX_PRECODE_NUM_SYMBOLS];
696         unsigned i;
697         unsigned num_output_syms;
698         u8 precode_sym;
699         unsigned dummy;
700
701         num_output_syms = lzx_build_precode(lens,
702                                             prev_lens,
703                                             num_syms,
704                                             precode_freqs,
705                                             output_syms,
706                                             precode_lens,
707                                             precode_codewords,
708                                             &dummy);
709
710         /* Write the lengths of the precode codes to the output. */
711         for (i = 0; i < LZX_PRECODE_NUM_SYMBOLS; i++)
712                 bitstream_put_bits(out, precode_lens[i],
713                                    LZX_PRECODE_ELEMENT_SIZE);
714
715         /* Write the length symbols, encoded with the precode, to the output. */
716
717         for (i = 0; i < num_output_syms; ) {
718                 precode_sym = output_syms[i++];
719
720                 bitstream_put_bits(out, precode_codewords[precode_sym],
721                                    precode_lens[precode_sym]);
722                 switch (precode_sym) {
723                 case 17:
724                         bitstream_put_bits(out, output_syms[i++], 4);
725                         break;
726                 case 18:
727                         bitstream_put_bits(out, output_syms[i++], 5);
728                         break;
729                 case 19:
730                         bitstream_put_bits(out, output_syms[i++], 1);
731                         bitstream_put_bits(out,
732                                            precode_codewords[output_syms[i]],
733                                            precode_lens[output_syms[i]]);
734                         i++;
735                         break;
736                 default:
737                         break;
738                 }
739         }
740 }
741
742 /*
743  * Write all matches and literal bytes (which were precomputed) in an LZX
744  * compressed block to the output bitstream in the final compressed
745  * representation.
746  *
747  * @ostream
748  *      The output bitstream.
749  * @block_type
750  *      The chosen type of the LZX compressed block (LZX_BLOCKTYPE_ALIGNED or
751  *      LZX_BLOCKTYPE_VERBATIM).
752  * @match_tab
753  *      The array of matches/literals to output.
754  * @match_count
755  *      Number of matches/literals to output (length of @match_tab).
756  * @codes
757  *      The main, length, and aligned offset Huffman codes for the current
758  *      LZX compressed block.
759  */
760 static void
761 lzx_write_matches_and_literals(struct output_bitstream *ostream,
762                                int block_type,
763                                const struct lzx_match match_tab[],
764                                unsigned match_count,
765                                const struct lzx_codes *codes)
766 {
767         for (unsigned i = 0; i < match_count; i++) {
768                 struct lzx_match match = match_tab[i];
769
770                 /* The high bit of the 32-bit intermediate representation
771                  * indicates whether the item is an actual LZ-style match (1) or
772                  * a literal byte (0).  */
773                 if (match.data & 0x80000000)
774                         lzx_write_match(ostream, block_type, match, codes);
775                 else
776                         lzx_write_literal(ostream, match.data, codes);
777         }
778 }
779
780 static void
781 lzx_assert_codes_valid(const struct lzx_codes * codes, unsigned num_main_syms)
782 {
783 #ifdef ENABLE_LZX_DEBUG
784         unsigned i;
785
786         for (i = 0; i < num_main_syms; i++)
787                 LZX_ASSERT(codes->lens.main[i] <= LZX_MAX_MAIN_CODEWORD_LEN);
788
789         for (i = 0; i < LZX_LENCODE_NUM_SYMBOLS; i++)
790                 LZX_ASSERT(codes->lens.len[i] <= LZX_MAX_LEN_CODEWORD_LEN);
791
792         for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++)
793                 LZX_ASSERT(codes->lens.aligned[i] <= LZX_MAX_ALIGNED_CODEWORD_LEN);
794
795         const unsigned tablebits = 10;
796         u16 decode_table[(1 << tablebits) +
797                          (2 * max(num_main_syms, LZX_LENCODE_NUM_SYMBOLS))]
798                          _aligned_attribute(DECODE_TABLE_ALIGNMENT);
799         LZX_ASSERT(0 == make_huffman_decode_table(decode_table,
800                                                   num_main_syms,
801                                                   min(tablebits, LZX_MAINCODE_TABLEBITS),
802                                                   codes->lens.main,
803                                                   LZX_MAX_MAIN_CODEWORD_LEN));
804         LZX_ASSERT(0 == make_huffman_decode_table(decode_table,
805                                                   LZX_LENCODE_NUM_SYMBOLS,
806                                                   min(tablebits, LZX_LENCODE_TABLEBITS),
807                                                   codes->lens.len,
808                                                   LZX_MAX_LEN_CODEWORD_LEN));
809         LZX_ASSERT(0 == make_huffman_decode_table(decode_table,
810                                                   LZX_ALIGNEDCODE_NUM_SYMBOLS,
811                                                   min(tablebits, LZX_ALIGNEDCODE_TABLEBITS),
812                                                   codes->lens.aligned,
813                                                   LZX_MAX_ALIGNED_CODEWORD_LEN));
814 #endif /* ENABLE_LZX_DEBUG */
815 }
816
817 /* Write an LZX aligned offset or verbatim block to the output.  */
818 static void
819 lzx_write_compressed_block(int block_type,
820                            unsigned block_size,
821                            unsigned max_window_size,
822                            unsigned num_main_syms,
823                            struct lzx_match * chosen_matches,
824                            unsigned num_chosen_matches,
825                            const struct lzx_codes * codes,
826                            const struct lzx_codes * prev_codes,
827                            struct output_bitstream * ostream)
828 {
829         unsigned i;
830
831         LZX_ASSERT(block_type == LZX_BLOCKTYPE_ALIGNED ||
832                    block_type == LZX_BLOCKTYPE_VERBATIM);
833         lzx_assert_codes_valid(codes, num_main_syms);
834
835         /* The first three bits indicate the type of block and are one of the
836          * LZX_BLOCKTYPE_* constants.  */
837         bitstream_put_bits(ostream, block_type, 3);
838
839         /* Output the block size.
840          *
841          * The original LZX format seemed to always encode the block size in 3
842          * bytes.  However, the implementation in WIMGAPI, as used in WIM files,
843          * uses the first bit to indicate whether the block is the default size
844          * (32768) or a different size given explicitly by the next 16 bits.
845          *
846          * By default, this compressor uses a window size of 32768 and therefore
847          * follows the WIMGAPI behavior.  However, this compressor also supports
848          * window sizes greater than 32768 bytes, which do not appear to be
849          * supported by WIMGAPI.  In such cases, we retain the default size bit
850          * to mean a size of 32768 bytes but output non-default block size in 24
851          * bits rather than 16.  The compatibility of this behavior is unknown
852          * because WIMs created with chunk size greater than 32768 can seemingly
853          * only be opened by wimlib anyway.  */
854         if (block_size == LZX_DEFAULT_BLOCK_SIZE) {
855                 bitstream_put_bits(ostream, 1, 1);
856         } else {
857                 bitstream_put_bits(ostream, 0, 1);
858
859                 if (max_window_size >= 65536)
860                         bitstream_put_bits(ostream, block_size >> 16, 8);
861
862                 bitstream_put_bits(ostream, block_size, 16);
863         }
864
865         /* Write out lengths of the main code. Note that the LZX specification
866          * incorrectly states that the aligned offset code comes after the
867          * length code, but in fact it is the very first code to be written
868          * (before the main code).  */
869         if (block_type == LZX_BLOCKTYPE_ALIGNED)
870                 for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++)
871                         bitstream_put_bits(ostream, codes->lens.aligned[i],
872                                            LZX_ALIGNEDCODE_ELEMENT_SIZE);
873
874         LZX_DEBUG("Writing main code...");
875
876         /* Write the precode and lengths for the first LZX_NUM_CHARS symbols in
877          * the main code, which are the codewords for literal bytes.  */
878         lzx_write_compressed_code(ostream,
879                                   codes->lens.main,
880                                   prev_codes->lens.main,
881                                   LZX_NUM_CHARS);
882
883         /* Write the precode and lengths for the rest of the main code, which
884          * are the codewords for match headers.  */
885         lzx_write_compressed_code(ostream,
886                                   codes->lens.main + LZX_NUM_CHARS,
887                                   prev_codes->lens.main + LZX_NUM_CHARS,
888                                   num_main_syms - LZX_NUM_CHARS);
889
890         LZX_DEBUG("Writing length code...");
891
892         /* Write the precode and lengths for the length code.  */
893         lzx_write_compressed_code(ostream,
894                                   codes->lens.len,
895                                   prev_codes->lens.len,
896                                   LZX_LENCODE_NUM_SYMBOLS);
897
898         LZX_DEBUG("Writing matches and literals...");
899
900         /* Write the actual matches and literals.  */
901         lzx_write_matches_and_literals(ostream, block_type,
902                                        chosen_matches, num_chosen_matches,
903                                        codes);
904
905         LZX_DEBUG("Done writing block.");
906 }
907
908 /* Write out the LZX blocks that were computed.  */
909 static void
910 lzx_write_all_blocks(struct lzx_compressor *ctx, struct output_bitstream *ostream)
911 {
912
913         const struct lzx_codes *prev_codes = &ctx->zero_codes;
914         for (unsigned i = 0; i < ctx->num_blocks; i++) {
915                 const struct lzx_block_spec *spec = &ctx->block_specs[i];
916
917                 LZX_DEBUG("Writing block %u/%u (type=%d, size=%u, num_chosen_matches=%u)...",
918                           i + 1, ctx->num_blocks,
919                           spec->block_type, spec->block_size,
920                           spec->num_chosen_matches);
921
922                 lzx_write_compressed_block(spec->block_type,
923                                            spec->block_size,
924                                            ctx->max_window_size,
925                                            ctx->num_main_syms,
926                                            &ctx->chosen_matches[spec->chosen_matches_start_pos],
927                                            spec->num_chosen_matches,
928                                            &spec->codes,
929                                            prev_codes,
930                                            ostream);
931
932                 prev_codes = &spec->codes;
933         }
934 }
935
936 /* Constructs an LZX match from a literal byte and updates the main code symbol
937  * frequencies.  */
938 static u32
939 lzx_tally_literal(u8 lit, struct lzx_freqs *freqs)
940 {
941         freqs->main[lit]++;
942         return (u32)lit;
943 }
944
945 /* Constructs an LZX match from an offset and a length, and updates the LRU
946  * queue and the frequency of symbols in the main, length, and aligned offset
947  * alphabets.  The return value is a 32-bit number that provides the match in an
948  * intermediate representation documented below.  */
949 static u32
950 lzx_tally_match(unsigned match_len, unsigned match_offset,
951                 struct lzx_freqs *freqs, struct lzx_lru_queue *queue)
952 {
953         unsigned position_slot;
954         unsigned position_footer;
955         u32 len_header;
956         unsigned main_symbol;
957         unsigned len_footer;
958         unsigned adjusted_match_len;
959
960         LZX_ASSERT(match_len >= LZX_MIN_MATCH_LEN && match_len <= LZX_MAX_MATCH_LEN);
961
962         /* The match offset shall be encoded as a position slot (itself encoded
963          * as part of the main symbol) and a position footer.  */
964         position_slot = lzx_get_position_slot(match_offset, queue);
965         position_footer = (match_offset + LZX_OFFSET_OFFSET) &
966                                 ((1U << lzx_get_num_extra_bits(position_slot)) - 1);
967
968         /* The match length shall be encoded as a length header (itself encoded
969          * as part of the main symbol) and an optional length footer.  */
970         adjusted_match_len = match_len - LZX_MIN_MATCH_LEN;
971         if (adjusted_match_len < LZX_NUM_PRIMARY_LENS) {
972                 /* No length footer needed.  */
973                 len_header = adjusted_match_len;
974         } else {
975                 /* Length footer needed.  It will be encoded using the length
976                  * code.  */
977                 len_header = LZX_NUM_PRIMARY_LENS;
978                 len_footer = adjusted_match_len - LZX_NUM_PRIMARY_LENS;
979                 freqs->len[len_footer]++;
980         }
981
982         /* Account for the main symbol.  */
983         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
984
985         freqs->main[main_symbol]++;
986
987         /* In an aligned offset block, 3 bits of the position footer are output
988          * as an aligned offset symbol.  Account for this, although we may
989          * ultimately decide to output the block as verbatim.  */
990
991         /* The following check is equivalent to:
992          *
993          * if (lzx_extra_bits[position_slot] >= 3)
994          *
995          * Note that this correctly excludes position slots that correspond to
996          * recent offsets.  */
997         if (position_slot >= 8)
998                 freqs->aligned[position_footer & 7]++;
999
1000         /* Pack the position slot, position footer, and match length into an
1001          * intermediate representation.  See `struct lzx_match' for details.
1002          */
1003         LZX_ASSERT(LZX_MAX_POSITION_SLOTS <= 64);
1004         LZX_ASSERT(lzx_get_num_extra_bits(LZX_MAX_POSITION_SLOTS - 1) <= 17);
1005         LZX_ASSERT(LZX_MAX_MATCH_LEN - LZX_MIN_MATCH_LEN + 1 <= 256);
1006
1007         LZX_ASSERT(position_slot      <= (1U << (31 - 25)) - 1);
1008         LZX_ASSERT(position_footer    <= (1U << (25 -  8)) - 1);
1009         LZX_ASSERT(adjusted_match_len <= (1U << (8  -  0)) - 1);
1010         return 0x80000000 |
1011                 (position_slot << 25) |
1012                 (position_footer << 8) |
1013                 (adjusted_match_len);
1014 }
1015
1016 struct lzx_record_ctx {
1017         struct lzx_freqs freqs;
1018         struct lzx_lru_queue queue;
1019         struct lzx_match *matches;
1020 };
1021
1022 static void
1023 lzx_record_match(unsigned len, unsigned offset, void *_ctx)
1024 {
1025         struct lzx_record_ctx *ctx = _ctx;
1026
1027         (ctx->matches++)->data = lzx_tally_match(len, offset, &ctx->freqs, &ctx->queue);
1028 }
1029
1030 static void
1031 lzx_record_literal(u8 lit, void *_ctx)
1032 {
1033         struct lzx_record_ctx *ctx = _ctx;
1034
1035         (ctx->matches++)->data = lzx_tally_literal(lit, &ctx->freqs);
1036 }
1037
1038 /* Returns the cost, in bits, to output a literal byte using the specified cost
1039  * model.  */
1040 static unsigned
1041 lzx_literal_cost(u8 c, const struct lzx_costs * costs)
1042 {
1043         return costs->main[c];
1044 }
1045
1046 /* Given a (length, offset) pair that could be turned into a valid LZX match as
1047  * well as costs for the codewords in the main, length, and aligned Huffman
1048  * codes, return the approximate number of bits it will take to represent this
1049  * match in the compressed output.  Take into account the match offset LRU
1050  * queue and optionally update it.  */
1051 static unsigned
1052 lzx_match_cost(unsigned length, unsigned offset, const struct lzx_costs *costs,
1053                struct lzx_lru_queue *queue)
1054 {
1055         unsigned position_slot;
1056         unsigned len_header, main_symbol;
1057         unsigned cost = 0;
1058
1059         position_slot = lzx_get_position_slot(offset, queue);
1060
1061         len_header = min(length - LZX_MIN_MATCH_LEN, LZX_NUM_PRIMARY_LENS);
1062         main_symbol = ((position_slot << 3) | len_header) + LZX_NUM_CHARS;
1063
1064         /* Account for main symbol.  */
1065         cost += costs->main[main_symbol];
1066
1067         /* Account for extra position information.  */
1068         unsigned num_extra_bits = lzx_get_num_extra_bits(position_slot);
1069         if (num_extra_bits >= 3) {
1070                 cost += num_extra_bits - 3;
1071                 cost += costs->aligned[(offset + LZX_OFFSET_OFFSET) & 7];
1072         } else {
1073                 cost += num_extra_bits;
1074         }
1075
1076         /* Account for extra length information.  */
1077         if (len_header == LZX_NUM_PRIMARY_LENS)
1078                 cost += costs->len[length - LZX_MIN_MATCH_LEN - LZX_NUM_PRIMARY_LENS];
1079
1080         return cost;
1081
1082 }
1083
1084 /* Fast heuristic cost evaluation to use in the inner loop of the match-finder.
1085  * Unlike lzx_match_cost() which does a true cost evaluation, this simply
1086  * prioritize matches based on their offset.  */
1087 static input_idx_t
1088 lzx_match_cost_fast(input_idx_t length, input_idx_t offset, const void *_queue)
1089 {
1090         const struct lzx_lru_queue *queue = _queue;
1091
1092         /* It seems well worth it to take the time to give priority to recently
1093          * used offsets.  */
1094         for (input_idx_t i = 0; i < LZX_NUM_RECENT_OFFSETS; i++)
1095                 if (offset == queue->R[i])
1096                         return i;
1097
1098         return offset;
1099 }
1100
1101 /* Set the cost model @ctx->costs from the Huffman codeword lengths specified in
1102  * @lens.
1103  *
1104  * The cost model and codeword lengths are almost the same thing, but the
1105  * Huffman codewords with length 0 correspond to symbols with zero frequency
1106  * that still need to be assigned actual costs.  The specific values assigned
1107  * are arbitrary, but they should be fairly high (near the maximum codeword
1108  * length) to take into account the fact that uses of these symbols are expected
1109  * to be rare.  */
1110 static void
1111 lzx_set_costs(struct lzx_compressor * ctx, const struct lzx_lens * lens)
1112 {
1113         unsigned i;
1114         unsigned num_main_syms = ctx->num_main_syms;
1115
1116         /* Main code  */
1117         for (i = 0; i < num_main_syms; i++) {
1118                 ctx->costs.main[i] = lens->main[i];
1119                 if (ctx->costs.main[i] == 0)
1120                         ctx->costs.main[i] = ctx->params.alg_params.slow.main_nostat_cost;
1121         }
1122
1123         /* Length code  */
1124         for (i = 0; i < LZX_LENCODE_NUM_SYMBOLS; i++) {
1125                 ctx->costs.len[i] = lens->len[i];
1126                 if (ctx->costs.len[i] == 0)
1127                         ctx->costs.len[i] = ctx->params.alg_params.slow.len_nostat_cost;
1128         }
1129
1130         /* Aligned offset code  */
1131         for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++) {
1132                 ctx->costs.aligned[i] = lens->aligned[i];
1133                 if (ctx->costs.aligned[i] == 0)
1134                         ctx->costs.aligned[i] = ctx->params.alg_params.slow.aligned_nostat_cost;
1135         }
1136 }
1137
1138 /* Tell the match-finder to skip the specified number of bytes (@n) in the
1139  * input.  */
1140 static void
1141 lzx_lz_skip_bytes(struct lzx_compressor *ctx, input_idx_t n)
1142 {
1143         LZX_ASSERT(n <= ctx->match_window_end - ctx->match_window_pos);
1144         if (ctx->matches_cached) {
1145                 ctx->match_window_pos += n;
1146                 while (n--) {
1147                         ctx->cached_matches_pos +=
1148                                 ctx->cached_matches[ctx->cached_matches_pos].len + 1;
1149                 }
1150         } else {
1151                 while (n--) {
1152                         ctx->cached_matches[ctx->cached_matches_pos++].len = 0;
1153                         lz_sarray_skip_position(&ctx->lz_sarray);
1154                         ctx->match_window_pos++;
1155                 }
1156                 LZX_ASSERT(lz_sarray_get_pos(&ctx->lz_sarray) == ctx->match_window_pos);
1157         }
1158 }
1159
1160 /* Retrieve a list of matches available at the next position in the input.
1161  *
1162  * A pointer to the matches array is written into @matches_ret, and the return
1163  * value is the number of matches found.  */
1164 static u32
1165 lzx_lz_get_matches_caching(struct lzx_compressor *ctx,
1166                            const struct lzx_lru_queue *queue,
1167                            struct raw_match **matches_ret)
1168 {
1169         u32 num_matches;
1170         struct raw_match *matches;
1171
1172         LZX_ASSERT(ctx->match_window_pos <= ctx->match_window_end);
1173
1174         matches = &ctx->cached_matches[ctx->cached_matches_pos + 1];
1175
1176         if (ctx->matches_cached) {
1177                 num_matches = matches[-1].len;
1178         } else {
1179                 LZX_ASSERT(lz_sarray_get_pos(&ctx->lz_sarray) == ctx->match_window_pos);
1180                 num_matches = lz_sarray_get_matches(&ctx->lz_sarray,
1181                                                     matches,
1182                                                     lzx_match_cost_fast,
1183                                                     queue);
1184                 matches[-1].len = num_matches;
1185         }
1186         ctx->cached_matches_pos += num_matches + 1;
1187         *matches_ret = matches;
1188
1189         /* Cap the length of returned matches to the number of bytes remaining,
1190          * if it is not the whole window.  */
1191         if (ctx->match_window_end < ctx->window_size) {
1192                 unsigned maxlen = ctx->match_window_end - ctx->match_window_pos;
1193                 for (u32 i = 0; i < num_matches; i++)
1194                         if (matches[i].len > maxlen)
1195                                 matches[i].len = maxlen;
1196         }
1197 #if 0
1198         fprintf(stderr, "Pos %u/%u: %u matches\n",
1199                 ctx->match_window_pos, ctx->match_window_end, num_matches);
1200         for (unsigned i = 0; i < num_matches; i++)
1201                 fprintf(stderr, "\tLen %u Offset %u\n", matches[i].len, matches[i].offset);
1202 #endif
1203
1204 #ifdef ENABLE_LZX_DEBUG
1205         for (u32 i = 0; i < num_matches; i++) {
1206                 LZX_ASSERT(matches[i].len >= LZX_MIN_MATCH_LEN);
1207                 LZX_ASSERT(matches[i].len <= LZX_MAX_MATCH_LEN);
1208                 LZX_ASSERT(matches[i].len <= ctx->match_window_end - ctx->match_window_pos);
1209                 LZX_ASSERT(matches[i].offset > 0);
1210                 LZX_ASSERT(matches[i].offset <= ctx->match_window_pos);
1211                 LZX_ASSERT(!memcmp(&ctx->window[ctx->match_window_pos],
1212                                    &ctx->window[ctx->match_window_pos - matches[i].offset],
1213                                    matches[i].len));
1214         }
1215 #endif
1216
1217         ctx->match_window_pos++;
1218         return num_matches;
1219 }
1220
1221 static u32
1222 lzx_get_prev_literal_cost(struct lzx_compressor *ctx,
1223                           struct lzx_lru_queue *queue)
1224 {
1225         return lzx_literal_cost(ctx->window[ctx->match_window_pos - 1],
1226                                 &ctx->costs);
1227 }
1228
1229 static u32
1230 lzx_get_match_cost(struct lzx_compressor *ctx,
1231                    struct lzx_lru_queue *queue,
1232                    input_idx_t length, input_idx_t offset)
1233 {
1234         return lzx_match_cost(length, offset, &ctx->costs, queue);
1235 }
1236
1237 static struct raw_match
1238 lzx_lz_get_near_optimal_match(struct lzx_compressor *ctx)
1239 {
1240         return lz_get_near_optimal_match(&ctx->mc,
1241                                          lzx_lz_get_matches_caching,
1242                                          lzx_lz_skip_bytes,
1243                                          lzx_get_prev_literal_cost,
1244                                          lzx_get_match_cost,
1245                                          ctx,
1246                                          &ctx->queue);
1247 }
1248
1249 /* Set default symbol costs for the LZX Huffman codes.  */
1250 static void
1251 lzx_set_default_costs(struct lzx_costs * costs, unsigned num_main_syms)
1252 {
1253         unsigned i;
1254
1255         /* Main code (part 1): Literal symbols  */
1256         for (i = 0; i < LZX_NUM_CHARS; i++)
1257                 costs->main[i] = 8;
1258
1259         /* Main code (part 2): Match header symbols  */
1260         for (; i < num_main_syms; i++)
1261                 costs->main[i] = 10;
1262
1263         /* Length code  */
1264         for (i = 0; i < LZX_LENCODE_NUM_SYMBOLS; i++)
1265                 costs->len[i] = 8;
1266
1267         /* Aligned offset code  */
1268         for (i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++)
1269                 costs->aligned[i] = 3;
1270 }
1271
1272 /* Given the frequencies of symbols in an LZX-compressed block and the
1273  * corresponding Huffman codes, return LZX_BLOCKTYPE_ALIGNED or
1274  * LZX_BLOCKTYPE_VERBATIM if an aligned offset or verbatim block, respectively,
1275  * will take fewer bits to output.  */
1276 static int
1277 lzx_choose_verbatim_or_aligned(const struct lzx_freqs * freqs,
1278                                const struct lzx_codes * codes)
1279 {
1280         unsigned aligned_cost = 0;
1281         unsigned verbatim_cost = 0;
1282
1283         /* Verbatim blocks have a constant 3 bits per position footer.  Aligned
1284          * offset blocks have an aligned offset symbol per position footer, plus
1285          * an extra 24 bits per block to output the lengths necessary to
1286          * reconstruct the aligned offset code itself.  */
1287         for (unsigned i = 0; i < LZX_ALIGNEDCODE_NUM_SYMBOLS; i++) {
1288                 verbatim_cost += 3 * freqs->aligned[i];
1289                 aligned_cost += codes->lens.aligned[i] * freqs->aligned[i];
1290         }
1291         aligned_cost += LZX_ALIGNEDCODE_ELEMENT_SIZE * LZX_ALIGNEDCODE_NUM_SYMBOLS;
1292         if (aligned_cost < verbatim_cost)
1293                 return LZX_BLOCKTYPE_ALIGNED;
1294         else
1295                 return LZX_BLOCKTYPE_VERBATIM;
1296 }
1297
1298 /* Find a near-optimal sequence of matches/literals with which to output the
1299  * specified LZX block, then set the block's type to that which has the minimum
1300  * cost to output (either verbatim or aligned).  */
1301 static void
1302 lzx_optimize_block(struct lzx_compressor *ctx, struct lzx_block_spec *spec,
1303                    unsigned num_passes)
1304 {
1305         const struct lzx_lru_queue orig_queue = ctx->queue;
1306         struct lzx_freqs freqs;
1307
1308         unsigned orig_window_pos = spec->window_pos;
1309         unsigned orig_cached_pos = ctx->cached_matches_pos;
1310
1311         LZX_ASSERT(ctx->match_window_pos == spec->window_pos);
1312
1313         ctx->match_window_end = spec->window_pos + spec->block_size;
1314         spec->chosen_matches_start_pos = spec->window_pos;
1315
1316         LZX_ASSERT(num_passes >= 1);
1317
1318         /* The first optimal parsing pass is done using the cost model already
1319          * set in ctx->costs.  Each later pass is done using a cost model
1320          * computed from the previous pass.  */
1321         for (unsigned pass = 0; pass < num_passes; pass++) {
1322
1323                 ctx->match_window_pos = orig_window_pos;
1324                 ctx->cached_matches_pos = orig_cached_pos;
1325                 ctx->queue = orig_queue;
1326                 spec->num_chosen_matches = 0;
1327                 memset(&freqs, 0, sizeof(freqs));
1328
1329                 for (unsigned i = spec->window_pos; i < spec->window_pos + spec->block_size; ) {
1330                         struct raw_match raw_match;
1331                         struct lzx_match lzx_match;
1332
1333                         raw_match = lzx_lz_get_near_optimal_match(ctx);
1334                         if (raw_match.len >= LZX_MIN_MATCH_LEN) {
1335                                 if (unlikely(raw_match.len == LZX_MIN_MATCH_LEN &&
1336                                              raw_match.offset == ctx->max_window_size -
1337                                                                  LZX_MIN_MATCH_LEN))
1338                                 {
1339                                         /* Degenerate case where the parser
1340                                          * generated the minimum match length
1341                                          * with the maximum offset.  There
1342                                          * aren't actually enough position slots
1343                                          * to represent this offset, as noted in
1344                                          * the comments in
1345                                          * lzx_get_num_main_syms(), so we cannot
1346                                          * allow it.  Use literals instead.
1347                                          *
1348                                          * Note that this case only occurs if
1349                                          * the match-finder can generate matches
1350                                          * to the very start of the window.  The
1351                                          * suffix array match-finder can,
1352                                          * although typical hash chain and
1353                                          * binary tree match-finders use 0 as a
1354                                          * null value and therefore cannot
1355                                          * generate such matches.  */
1356                                         BUILD_BUG_ON(LZX_MIN_MATCH_LEN != 2);
1357                                         lzx_match.data = lzx_tally_literal(ctx->window[i],
1358                                                                            &freqs);
1359                                         i += 1;
1360                                         ctx->chosen_matches[spec->chosen_matches_start_pos +
1361                                                             spec->num_chosen_matches++]
1362                                                             = lzx_match;
1363                                         lzx_match.data = lzx_tally_literal(ctx->window[i],
1364                                                                            &freqs);
1365                                         i += 1;
1366                                 } else {
1367                                         lzx_match.data = lzx_tally_match(raw_match.len,
1368                                                                          raw_match.offset,
1369                                                                          &freqs,
1370                                                                          &ctx->queue);
1371                                         i += raw_match.len;
1372                                 }
1373                         } else {
1374                                 lzx_match.data = lzx_tally_literal(ctx->window[i], &freqs);
1375                                 i += 1;
1376                         }
1377                         ctx->chosen_matches[spec->chosen_matches_start_pos +
1378                                             spec->num_chosen_matches++] = lzx_match;
1379                 }
1380
1381                 lzx_make_huffman_codes(&freqs, &spec->codes,
1382                                        ctx->num_main_syms);
1383                 if (pass < num_passes - 1)
1384                         lzx_set_costs(ctx, &spec->codes.lens);
1385                 ctx->matches_cached = true;
1386         }
1387         spec->block_type = lzx_choose_verbatim_or_aligned(&freqs, &spec->codes);
1388         ctx->matches_cached = false;
1389 }
1390
1391 static void
1392 lzx_optimize_blocks(struct lzx_compressor *ctx)
1393 {
1394         lzx_lru_queue_init(&ctx->queue);
1395         lz_match_chooser_begin(&ctx->mc);
1396
1397         const unsigned num_passes = ctx->params.alg_params.slow.num_optim_passes;
1398
1399         for (unsigned i = 0; i < ctx->num_blocks; i++)
1400                 lzx_optimize_block(ctx, &ctx->block_specs[i], num_passes);
1401 }
1402
1403 /* Prepare the input window into one or more LZX blocks ready to be output.  */
1404 static void
1405 lzx_prepare_blocks(struct lzx_compressor * ctx)
1406 {
1407         /* Initialize the match-finder.  */
1408         lz_sarray_load_window(&ctx->lz_sarray, ctx->window, ctx->window_size);
1409         ctx->cached_matches_pos = 0;
1410         ctx->matches_cached = false;
1411         ctx->match_window_pos = 0;
1412
1413         /* Set up a default cost model.  */
1414         lzx_set_default_costs(&ctx->costs, ctx->num_main_syms);
1415
1416         /* TODO: The compression ratio could be slightly improved by performing
1417          * data-dependent block splitting instead of using fixed-size blocks.
1418          * Doing so well is a computationally hard problem, however.  */
1419         ctx->num_blocks = DIV_ROUND_UP(ctx->window_size, LZX_DIV_BLOCK_SIZE);
1420         for (unsigned i = 0; i < ctx->num_blocks; i++) {
1421                 unsigned pos = LZX_DIV_BLOCK_SIZE * i;
1422                 ctx->block_specs[i].window_pos = pos;
1423                 ctx->block_specs[i].block_size = min(ctx->window_size - pos, LZX_DIV_BLOCK_SIZE);
1424         }
1425
1426         /* Determine sequence of matches/literals to output for each block.  */
1427         lzx_optimize_blocks(ctx);
1428 }
1429
1430 /*
1431  * This is the fast version of lzx_prepare_blocks().  This version "quickly"
1432  * prepares a single compressed block containing the entire input.  See the
1433  * description of the "Fast algorithm" at the beginning of this file for more
1434  * information.
1435  *
1436  * Input ---  the preprocessed data:
1437  *
1438  *      ctx->window[]
1439  *      ctx->window_size
1440  *
1441  * Output --- the block specification and the corresponding match/literal data:
1442  *
1443  *      ctx->block_specs[]
1444  *      ctx->num_blocks
1445  *      ctx->chosen_matches[]
1446  */
1447 static void
1448 lzx_prepare_block_fast(struct lzx_compressor * ctx)
1449 {
1450         struct lzx_record_ctx record_ctx;
1451         struct lzx_block_spec *spec;
1452
1453         /* Parameters to hash chain LZ match finder
1454          * (lazy with 1 match lookahead)  */
1455         static const struct lz_params lzx_lz_params = {
1456                 /* Although LZX_MIN_MATCH_LEN == 2, length 2 matches typically
1457                  * aren't worth choosing when using greedy or lazy parsing.  */
1458                 .min_match      = 3,
1459                 .max_match      = LZX_MAX_MATCH_LEN,
1460                 .max_offset     = LZX_MAX_WINDOW_SIZE,
1461                 .good_match     = LZX_MAX_MATCH_LEN,
1462                 .nice_match     = LZX_MAX_MATCH_LEN,
1463                 .max_chain_len  = LZX_MAX_MATCH_LEN,
1464                 .max_lazy_match = LZX_MAX_MATCH_LEN,
1465                 .too_far        = 4096,
1466         };
1467
1468         /* Initialize symbol frequencies and match offset LRU queue.  */
1469         memset(&record_ctx.freqs, 0, sizeof(struct lzx_freqs));
1470         lzx_lru_queue_init(&record_ctx.queue);
1471         record_ctx.matches = ctx->chosen_matches;
1472
1473         /* Determine series of matches/literals to output.  */
1474         lz_analyze_block(ctx->window,
1475                          ctx->window_size,
1476                          lzx_record_match,
1477                          lzx_record_literal,
1478                          &record_ctx,
1479                          &lzx_lz_params,
1480                          ctx->prev_tab);
1481
1482         /* Set up block specification.  */
1483         spec = &ctx->block_specs[0];
1484         spec->block_type = LZX_BLOCKTYPE_ALIGNED;
1485         spec->window_pos = 0;
1486         spec->block_size = ctx->window_size;
1487         spec->num_chosen_matches = (record_ctx.matches - ctx->chosen_matches);
1488         spec->chosen_matches_start_pos = 0;
1489         lzx_make_huffman_codes(&record_ctx.freqs, &spec->codes,
1490                                ctx->num_main_syms);
1491         ctx->num_blocks = 1;
1492 }
1493
1494 static void
1495 do_call_insn_translation(u32 *call_insn_target, int input_pos,
1496                          s32 file_size)
1497 {
1498         s32 abs_offset;
1499         s32 rel_offset;
1500
1501         rel_offset = le32_to_cpu(*call_insn_target);
1502         if (rel_offset >= -input_pos && rel_offset < file_size) {
1503                 if (rel_offset < file_size - input_pos) {
1504                         /* "good translation" */
1505                         abs_offset = rel_offset + input_pos;
1506                 } else {
1507                         /* "compensating translation" */
1508                         abs_offset = rel_offset - file_size;
1509                 }
1510                 *call_insn_target = cpu_to_le32(abs_offset);
1511         }
1512 }
1513
1514 /* This is the reverse of undo_call_insn_preprocessing() in lzx-decompress.c.
1515  * See the comment above that function for more information.  */
1516 static void
1517 do_call_insn_preprocessing(u8 data[], int size)
1518 {
1519         for (int i = 0; i < size - 10; i++) {
1520                 if (data[i] == 0xe8) {
1521                         do_call_insn_translation((u32*)&data[i + 1], i,
1522                                                  LZX_WIM_MAGIC_FILESIZE);
1523                         i += 4;
1524                 }
1525         }
1526 }
1527
1528 static size_t
1529 lzx_compress(const void *uncompressed_data, size_t uncompressed_size,
1530              void *compressed_data, size_t compressed_size_avail, void *_ctx)
1531 {
1532         struct lzx_compressor *ctx = _ctx;
1533         struct output_bitstream ostream;
1534         size_t compressed_size;
1535
1536         if (uncompressed_size < 100) {
1537                 LZX_DEBUG("Too small to bother compressing.");
1538                 return 0;
1539         }
1540
1541         if (uncompressed_size > ctx->max_window_size) {
1542                 LZX_DEBUG("Can't compress %zu bytes using window of %u bytes!",
1543                           uncompressed_size, ctx->max_window_size);
1544                 return 0;
1545         }
1546
1547         LZX_DEBUG("Attempting to compress %zu bytes...",
1548                   uncompressed_size);
1549
1550         /* The input data must be preprocessed.  To avoid changing the original
1551          * input, copy it to a temporary buffer.  */
1552         memcpy(ctx->window, uncompressed_data, uncompressed_size);
1553         ctx->window_size = uncompressed_size;
1554
1555         /* This line is unnecessary; it just avoids inconsequential accesses of
1556          * uninitialized memory that would show up in memory-checking tools such
1557          * as valgrind.  */
1558         memset(&ctx->window[ctx->window_size], 0, 12);
1559
1560         LZX_DEBUG("Preprocessing data...");
1561
1562         /* Before doing any actual compression, do the call instruction (0xe8
1563          * byte) translation on the uncompressed data.  */
1564         do_call_insn_preprocessing(ctx->window, ctx->window_size);
1565
1566         LZX_DEBUG("Preparing blocks...");
1567
1568         /* Prepare the compressed data.  */
1569         if (ctx->params.algorithm == WIMLIB_LZX_ALGORITHM_FAST)
1570                 lzx_prepare_block_fast(ctx);
1571         else
1572                 lzx_prepare_blocks(ctx);
1573
1574         LZX_DEBUG("Writing compressed blocks...");
1575
1576         /* Generate the compressed data.  */
1577         init_output_bitstream(&ostream, compressed_data, compressed_size_avail);
1578         lzx_write_all_blocks(ctx, &ostream);
1579
1580         LZX_DEBUG("Flushing bitstream...");
1581         compressed_size = flush_output_bitstream(&ostream);
1582         if (compressed_size == ~(input_idx_t)0) {
1583                 LZX_DEBUG("Data did not compress to %zu bytes or less!",
1584                           compressed_size_avail);
1585                 return 0;
1586         }
1587
1588         LZX_DEBUG("Done: compressed %zu => %zu bytes.",
1589                   uncompressed_size, compressed_size);
1590
1591         /* Verify that we really get the same thing back when decompressing.
1592          * Although this could be disabled by default in all cases, it only
1593          * takes around 2-3% of the running time of the slow algorithm to do the
1594          * verification.  */
1595         if (ctx->params.algorithm == WIMLIB_LZX_ALGORITHM_SLOW
1596         #if defined(ENABLE_LZX_DEBUG) || defined(ENABLE_VERIFY_COMPRESSION)
1597             || 1
1598         #endif
1599             )
1600         {
1601                 struct wimlib_decompressor *decompressor;
1602
1603                 if (0 == wimlib_create_decompressor(WIMLIB_COMPRESSION_TYPE_LZX,
1604                                                     ctx->max_window_size,
1605                                                     NULL,
1606                                                     &decompressor))
1607                 {
1608                         int ret;
1609                         ret = wimlib_decompress(compressed_data,
1610                                                 compressed_size,
1611                                                 ctx->window,
1612                                                 uncompressed_size,
1613                                                 decompressor);
1614                         wimlib_free_decompressor(decompressor);
1615
1616                         if (ret) {
1617                                 ERROR("Failed to decompress data we "
1618                                       "compressed using LZX algorithm");
1619                                 wimlib_assert(0);
1620                                 return 0;
1621                         }
1622                         if (memcmp(uncompressed_data, ctx->window, uncompressed_size)) {
1623                                 ERROR("Data we compressed using LZX algorithm "
1624                                       "didn't decompress to original");
1625                                 wimlib_assert(0);
1626                                 return 0;
1627                         }
1628                 } else {
1629                         WARNING("Failed to create decompressor for "
1630                                 "data verification!");
1631                 }
1632         }
1633         return compressed_size;
1634 }
1635
1636 static void
1637 lzx_free_compressor(void *_ctx)
1638 {
1639         struct lzx_compressor *ctx = _ctx;
1640
1641         if (ctx) {
1642                 FREE(ctx->chosen_matches);
1643                 FREE(ctx->cached_matches);
1644                 lz_match_chooser_destroy(&ctx->mc);
1645                 lz_sarray_destroy(&ctx->lz_sarray);
1646                 FREE(ctx->block_specs);
1647                 FREE(ctx->prev_tab);
1648                 FREE(ctx->window);
1649                 FREE(ctx);
1650         }
1651 }
1652
1653 static const struct wimlib_lzx_compressor_params lzx_fast_default = {
1654         .hdr = {
1655                 .size = sizeof(struct wimlib_lzx_compressor_params),
1656         },
1657         .algorithm = WIMLIB_LZX_ALGORITHM_FAST,
1658         .use_defaults = 0,
1659         .alg_params = {
1660                 .fast = {
1661                 },
1662         },
1663 };
1664 static const struct wimlib_lzx_compressor_params lzx_slow_default = {
1665         .hdr = {
1666                 .size = sizeof(struct wimlib_lzx_compressor_params),
1667         },
1668         .algorithm = WIMLIB_LZX_ALGORITHM_SLOW,
1669         .use_defaults = 0,
1670         .alg_params = {
1671                 .slow = {
1672                         .use_len2_matches = 1,
1673                         .nice_match_length = 32,
1674                         .num_optim_passes = 2,
1675                         .max_search_depth = 50,
1676                         .max_matches_per_pos = 3,
1677                         .main_nostat_cost = 15,
1678                         .len_nostat_cost = 15,
1679                         .aligned_nostat_cost = 7,
1680                 },
1681         },
1682 };
1683
1684 static const struct wimlib_lzx_compressor_params *
1685 lzx_get_params(const struct wimlib_compressor_params_header *_params)
1686 {
1687         const struct wimlib_lzx_compressor_params *params =
1688                 (const struct wimlib_lzx_compressor_params*)_params;
1689
1690         if (params == NULL) {
1691                 LZX_DEBUG("Using default algorithm and parameters.");
1692                 params = &lzx_slow_default;
1693         } else {
1694                 if (params->use_defaults) {
1695                         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW)
1696                                 params = &lzx_slow_default;
1697                         else
1698                                 params = &lzx_fast_default;
1699                 }
1700         }
1701         return params;
1702 }
1703
1704 static int
1705 lzx_create_compressor(size_t window_size,
1706                       const struct wimlib_compressor_params_header *_params,
1707                       void **ctx_ret)
1708 {
1709         const struct wimlib_lzx_compressor_params *params = lzx_get_params(_params);
1710         struct lzx_compressor *ctx;
1711
1712         LZX_DEBUG("Allocating LZX context...");
1713
1714         if (!lzx_window_size_valid(window_size))
1715                 return WIMLIB_ERR_INVALID_PARAM;
1716
1717         LZX_DEBUG("Allocating memory.");
1718
1719         ctx = CALLOC(1, sizeof(struct lzx_compressor));
1720         if (ctx == NULL)
1721                 goto oom;
1722
1723         ctx->num_main_syms = lzx_get_num_main_syms(window_size);
1724         ctx->max_window_size = window_size;
1725         ctx->window = MALLOC(window_size + 12);
1726         if (ctx->window == NULL)
1727                 goto oom;
1728
1729         if (params->algorithm == WIMLIB_LZX_ALGORITHM_FAST) {
1730                 ctx->prev_tab = MALLOC(window_size * sizeof(ctx->prev_tab[0]));
1731                 if (ctx->prev_tab == NULL)
1732                         goto oom;
1733         }
1734
1735         size_t block_specs_length = DIV_ROUND_UP(window_size, LZX_DIV_BLOCK_SIZE);
1736         ctx->block_specs = MALLOC(block_specs_length * sizeof(ctx->block_specs[0]));
1737         if (ctx->block_specs == NULL)
1738                 goto oom;
1739
1740         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
1741                 unsigned min_match_len = LZX_MIN_MATCH_LEN;
1742                 if (!params->alg_params.slow.use_len2_matches)
1743                         min_match_len = max(min_match_len, 3);
1744
1745                 if (!lz_sarray_init(&ctx->lz_sarray,
1746                                     window_size,
1747                                     min_match_len,
1748                                     LZX_MAX_MATCH_LEN,
1749                                     params->alg_params.slow.max_search_depth,
1750                                     params->alg_params.slow.max_matches_per_pos))
1751                         goto oom;
1752         }
1753
1754         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
1755                 if (!lz_match_chooser_init(&ctx->mc,
1756                                            LZX_OPTIM_ARRAY_SIZE,
1757                                            params->alg_params.slow.nice_match_length,
1758                                            LZX_MAX_MATCH_LEN))
1759                         goto oom;
1760         }
1761
1762         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
1763                 u32 cache_per_pos;
1764
1765                 cache_per_pos = params->alg_params.slow.max_matches_per_pos;
1766                 if (cache_per_pos > LZX_MAX_CACHE_PER_POS)
1767                         cache_per_pos = LZX_MAX_CACHE_PER_POS;
1768
1769                 ctx->cached_matches = MALLOC(window_size * (cache_per_pos + 1) *
1770                                              sizeof(ctx->cached_matches[0]));
1771                 if (ctx->cached_matches == NULL)
1772                         goto oom;
1773         }
1774
1775         ctx->chosen_matches = MALLOC(window_size * sizeof(ctx->chosen_matches[0]));
1776         if (ctx->chosen_matches == NULL)
1777                 goto oom;
1778
1779         memcpy(&ctx->params, params, sizeof(struct wimlib_lzx_compressor_params));
1780         memset(&ctx->zero_codes, 0, sizeof(ctx->zero_codes));
1781
1782         LZX_DEBUG("Successfully allocated new LZX context.");
1783
1784         *ctx_ret = ctx;
1785         return 0;
1786
1787 oom:
1788         lzx_free_compressor(ctx);
1789         return WIMLIB_ERR_NOMEM;
1790 }
1791
1792 static u64
1793 lzx_get_needed_memory(size_t max_block_size,
1794                       const struct wimlib_compressor_params_header *_params)
1795 {
1796         const struct wimlib_lzx_compressor_params *params = lzx_get_params(_params);
1797
1798         u64 size = 0;
1799
1800         size += sizeof(struct lzx_compressor);
1801
1802         size += max_block_size + 12;
1803
1804         size += DIV_ROUND_UP(max_block_size, LZX_DIV_BLOCK_SIZE) *
1805                 sizeof(((struct lzx_compressor*)0)->block_specs[0]);
1806
1807         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW) {
1808                 size += max_block_size * sizeof(((struct lzx_compressor*)0)->chosen_matches[0]);
1809                 size += lz_sarray_get_needed_memory(max_block_size);
1810                 size += lz_match_chooser_get_needed_memory(LZX_OPTIM_ARRAY_SIZE,
1811                                                            params->alg_params.slow.nice_match_length,
1812                                                            LZX_MAX_MATCH_LEN);
1813                 u32 cache_per_pos;
1814
1815                 cache_per_pos = params->alg_params.slow.max_matches_per_pos;
1816                 if (cache_per_pos > LZX_MAX_CACHE_PER_POS)
1817                         cache_per_pos = LZX_MAX_CACHE_PER_POS;
1818
1819                 size += max_block_size * (cache_per_pos + 1) *
1820                         sizeof(((struct lzx_compressor*)0)->cached_matches[0]);
1821         } else {
1822                 size += max_block_size * sizeof(((struct lzx_compressor*)0)->prev_tab[0]);
1823         }
1824         return size;
1825 }
1826
1827 static bool
1828 lzx_params_valid(const struct wimlib_compressor_params_header *_params)
1829 {
1830         const struct wimlib_lzx_compressor_params *params =
1831                 (const struct wimlib_lzx_compressor_params*)_params;
1832
1833         if (params->hdr.size != sizeof(struct wimlib_lzx_compressor_params)) {
1834                 LZX_DEBUG("Invalid parameter structure size!");
1835                 return false;
1836         }
1837
1838         if (params->algorithm != WIMLIB_LZX_ALGORITHM_SLOW &&
1839             params->algorithm != WIMLIB_LZX_ALGORITHM_FAST)
1840         {
1841                 LZX_DEBUG("Invalid algorithm.");
1842                 return false;
1843         }
1844
1845         if (params->algorithm == WIMLIB_LZX_ALGORITHM_SLOW &&
1846             !params->use_defaults)
1847         {
1848                 if (params->alg_params.slow.num_optim_passes < 1)
1849                 {
1850                         LZX_DEBUG("Invalid number of optimization passes!");
1851                         return false;
1852                 }
1853
1854                 if (params->alg_params.slow.main_nostat_cost < 1 ||
1855                     params->alg_params.slow.main_nostat_cost > 16)
1856                 {
1857                         LZX_DEBUG("Invalid main_nostat_cost!");
1858                         return false;
1859                 }
1860
1861                 if (params->alg_params.slow.len_nostat_cost < 1 ||
1862                     params->alg_params.slow.len_nostat_cost > 16)
1863                 {
1864                         LZX_DEBUG("Invalid len_nostat_cost!");
1865                         return false;
1866                 }
1867
1868                 if (params->alg_params.slow.aligned_nostat_cost < 1 ||
1869                     params->alg_params.slow.aligned_nostat_cost > 8)
1870                 {
1871                         LZX_DEBUG("Invalid aligned_nostat_cost!");
1872                         return false;
1873                 }
1874         }
1875         return true;
1876 }
1877
1878 const struct compressor_ops lzx_compressor_ops = {
1879         .params_valid       = lzx_params_valid,
1880         .get_needed_memory  = lzx_get_needed_memory,
1881         .create_compressor  = lzx_create_compressor,
1882         .compress           = lzx_compress,
1883         .free_compressor    = lzx_free_compressor,
1884 };