Style
[wimlib] / src / lzx-compress.c
1 /*
2  * lzx-compress.c
3  *
4  * LZX compression routines, originally based on code written by Matthew T.
5  * Russotto (liblzxcomp), but heavily modified.
6  */
7
8 /*
9  * Copyright (C) 2002 Matthew T. Russotto
10  * Copyright (C) 2012, 2013 Eric Biggers
11  *
12  * This file is part of wimlib, a library for working with WIM files.
13  *
14  * wimlib is free software; you can redistribute it and/or modify it under the
15  * terms of the GNU General Public License as published by the Free
16  * Software Foundation; either version 3 of the License, or (at your option)
17  * any later version.
18  *
19  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
20  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
21  * A PARTICULAR PURPOSE. See the GNU General Public License for more
22  * details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with wimlib; if not, see http://www.gnu.org/licenses/.
26  */
27
28
29 /*
30  * This file provides lzx_compress(), a function to compress an in-memory buffer
31  * of data using LZX compression, as used in the WIM file format.
32  *
33  * Please see the comments in lzx-decompress.c for more information about this
34  * compression format.
35  *
36  * One thing to keep in mind is that there is no sliding window, since the
37  * window is always the entirety of a WIM chunk, which is at most WIM_CHUNK_SIZE
38  * ( = 32768) bytes.
39  *
40  * The basic compression algorithm used here should be familiar if you are
41  * familiar with Huffman trees and with other LZ77 and Huffman-based formats
42  * such as DEFLATE.  Otherwise it can be quite tricky to understand.  Basically
43  * it is the following:
44  *
45  * - Preprocess the input data (LZX-specific)
46  * - Go through the input data and determine matches.  This part is based on
47  *       code from zlib, and a hash table of 3-character strings is used to
48  *       accelerate the process of finding matches.
49  * - Build the Huffman trees based on the frequencies of symbols determined
50  *       while recording matches.
51  * - Output the block header, including the Huffman trees; then output the
52  *       compressed stream of matches and literal characters.
53  *
54  * It is possible for a WIM chunk to include multiple LZX blocks, since for some
55  * input data this will produce a better compression ratio (especially since
56  * each block can include new Huffman codes).  However, producing multiple LZX
57  * blocks from one input chunk is not yet implemented.
58  */
59
60 #include "lzx.h"
61 #include "compress.h"
62 #include <stdlib.h>
63 #include <string.h>
64
65
66 /* Structure to contain the Huffman codes for the main, length, and aligned
67  * offset trees. */
68 struct lzx_codes {
69         u16 main_codewords[LZX_MAINTREE_NUM_SYMBOLS];
70         u8  main_lens[LZX_MAINTREE_NUM_SYMBOLS];
71
72         u16 len_codewords[LZX_LENTREE_NUM_SYMBOLS];
73         u8  len_lens[LZX_LENTREE_NUM_SYMBOLS];
74
75         u16 aligned_codewords[LZX_ALIGNEDTREE_NUM_SYMBOLS];
76         u8  aligned_lens[LZX_ALIGNEDTREE_NUM_SYMBOLS];
77 };
78
79 struct lzx_freq_tables {
80         freq_t main_freq_table[LZX_MAINTREE_NUM_SYMBOLS];
81         freq_t len_freq_table[LZX_LENTREE_NUM_SYMBOLS];
82         freq_t aligned_freq_table[LZX_ALIGNEDTREE_NUM_SYMBOLS];
83 };
84
85 /* Returns the LZX position slot that corresponds to a given formatted offset.
86  *
87  * Logically, this returns the smallest i such that
88  * formatted_offset >= lzx_position_base[i].
89  *
90  * The actual implementation below takes advantage of the regularity of the
91  * numbers in the lzx_position_base array to calculate the slot directly from
92  * the formatted offset without actually looking at the array.
93  */
94 static inline unsigned
95 lzx_get_position_slot(unsigned formatted_offset)
96 {
97 #if 0
98         /*
99          * Slots 36-49 (formatted_offset >= 262144) can be found by
100          * (formatted_offset/131072) + 34 == (formatted_offset >> 17) + 34;
101          * however, this check for formatted_offset >= 262144 is commented out
102          * because WIM chunks cannot be that large.
103          */
104         if (formatted_offset >= 262144) {
105                 return (formatted_offset >> 17) + 34;
106         } else
107 #endif
108         {
109                 /* Note: this part here only works if:
110                  *
111                  *    2 <= formatted_offset < 655360
112                  *
113                  * It is < 655360 because the frequency of the position bases
114                  * increases starting at the 655360 entry, and it is >= 2
115                  * because the below calculation fails if the most significant
116                  * bit is lower than the 2's place. */
117                 wimlib_assert(formatted_offset >= 2 && formatted_offset < 655360);
118                 unsigned mssb_idx = bsr32(formatted_offset);
119                 return (mssb_idx << 1) |
120                         ((formatted_offset >> (mssb_idx - 1)) & 1);
121         }
122 }
123
124 static u32
125 lzx_record_literal(u8 literal, void *__main_freq_tab)
126 {
127         freq_t *main_freq_tab = __main_freq_tab;
128         main_freq_tab[literal]++;
129         return literal;
130 }
131
132 /* Constructs a match from an offset and a length, and updates the LRU queue and
133  * the frequency of symbols in the main, length, and aligned offset alphabets.
134  * The return value is a 32-bit number that provides the match in an
135  * intermediate representation documented below. */
136 static u32
137 lzx_record_match(unsigned match_offset, unsigned match_len,
138                  void *__freq_tabs, void *__queue)
139 {
140         struct lzx_freq_tables *freq_tabs = __freq_tabs;
141         struct lru_queue *queue = __queue;
142         unsigned position_slot;
143         unsigned position_footer = 0;
144         u32 match;
145         u32 len_header;
146         u32 len_pos_header;
147         unsigned len_footer;
148         unsigned adjusted_match_len;
149
150         wimlib_assert(match_len >= LZX_MIN_MATCH && match_len <= LZX_MAX_MATCH);
151         wimlib_assert(match_offset != 0);
152
153         /* If possible, encode this offset as a repeated offset. */
154         if (match_offset == queue->R0) {
155                 position_slot = 0;
156         } else if (match_offset == queue->R1) {
157                 swap(queue->R0, queue->R1);
158                 position_slot = 1;
159         } else if (match_offset == queue->R2) {
160                 swap(queue->R0, queue->R2);
161                 position_slot = 2;
162         } else {
163                 /* Not a repeated offset. */
164
165                 /* offsets of 0, 1, and 2 are reserved for the repeated offset
166                  * codes, so non-repeated offsets must be encoded as 3+.  The
167                  * minimum offset is 1, so encode the offsets offset by 2. */
168                 unsigned formatted_offset = match_offset + LZX_MIN_MATCH;
169
170                 queue->R2 = queue->R1;
171                 queue->R1 = queue->R0;
172                 queue->R0 = match_offset;
173
174                 /* The (now-formatted) offset will actually be encoded as a
175                  * small position slot number that maps to a certain hard-coded
176                  * offset (position base), followed by a number of extra bits---
177                  * the position footer--- that are added to the position base to
178                  * get the original formatted offset. */
179
180                 position_slot = lzx_get_position_slot(formatted_offset);
181                 position_footer = formatted_offset &
182                                   ((1 << lzx_get_num_extra_bits(position_slot)) - 1);
183         }
184
185         adjusted_match_len = match_len - LZX_MIN_MATCH;
186
187         /* Pack the position slot, position footer, and match length into an
188          * intermediate representation.
189          *
190          * bits    description
191          * ----    -----------------------------------------------------------
192          *
193          * 31      1 if a match, 0 if a literal.
194          *
195          * 30-25   position slot.  This can be at most 50, so it will fit in 6
196          *         bits.
197          *
198          * 8-24    position footer.  This is the offset of the real formatted
199          *         offset from the position base.  This can be at most 17 bits
200          *         (since lzx_extra_bits[LZX_NUM_POSITION_SLOTS - 1] is 17).
201          *
202          * 0-7     length of match, offset by 2.  This can be at most
203          *         (LZX_MAX_MATCH - 2) == 255, so it will fit in 8 bits.  */
204         match = 0x80000000 |
205                 (position_slot << 25) |
206                 (position_footer << 8) |
207                 (adjusted_match_len);
208
209         /* The match length must be at least 2, so let the adjusted match length
210          * be the match length minus 2.
211          *
212          * If it is less than 7, the adjusted match length is encoded as a 3-bit
213          * number offset by 2.  Otherwise, the 3-bit length header is all 1's
214          * and the actual adjusted length is given as a symbol encoded with the
215          * length tree, offset by 7.
216          */
217         if (adjusted_match_len < LZX_NUM_PRIMARY_LENS) {
218                 len_header = adjusted_match_len;
219         } else {
220                 len_header = LZX_NUM_PRIMARY_LENS;
221                 len_footer = adjusted_match_len - LZX_NUM_PRIMARY_LENS;
222                 freq_tabs->len_freq_table[len_footer]++;
223         }
224         len_pos_header = (position_slot << 3) | len_header;
225
226         wimlib_assert(len_pos_header < LZX_MAINTREE_NUM_SYMBOLS - LZX_NUM_CHARS);
227
228         freq_tabs->main_freq_table[len_pos_header + LZX_NUM_CHARS]++;
229
230         /* Equivalent to:
231          * if (lzx_extra_bits[position_slot] >= 3) */
232         if (position_slot >= 8)
233                 freq_tabs->aligned_freq_table[position_footer & 7]++;
234
235         return match;
236 }
237
238 /*
239  * Writes a compressed literal match to the output.
240  *
241  * @out:         The output bitstream.
242  * @block_type:  The type of the block (LZX_BLOCKTYPE_ALIGNED or LZX_BLOCKTYPE_VERBATIM)
243  * @match:       The match, encoded as a 32-bit number.
244  * @codes:      Pointer to a structure that contains the codewords for the
245  *                      main, length, and aligned offset Huffman codes.
246  */
247 static int
248 lzx_write_match(struct output_bitstream *out, int block_type,
249                 u32 match, const struct lzx_codes *codes)
250 {
251         /* low 8 bits are the match length minus 2 */
252         unsigned match_len_minus_2 = match & 0xff;
253         /* Next 17 bits are the position footer */
254         unsigned position_footer = (match >> 8) & 0x1ffff;      /* 17 bits */
255         /* Next 6 bits are the position slot. */
256         unsigned position_slot = (match >> 25) & 0x3f;  /* 6 bits */
257         unsigned len_header;
258         unsigned len_footer;
259         unsigned len_pos_header;
260         unsigned main_symbol;
261         unsigned num_extra_bits;
262         unsigned verbatim_bits;
263         unsigned aligned_bits;
264         int ret;
265
266         /* If the match length is less than MIN_MATCH (= 2) +
267          * NUM_PRIMARY_LENS (= 7), the length header contains
268          * the match length minus MIN_MATCH, and there is no
269          * length footer.
270          *
271          * Otherwise, the length header contains
272          * NUM_PRIMARY_LENS, and the length footer contains
273          * the match length minus NUM_PRIMARY_LENS minus
274          * MIN_MATCH. */
275         if (match_len_minus_2 < LZX_NUM_PRIMARY_LENS) {
276                 len_header = match_len_minus_2;
277                 /* No length footer-- mark it with a special
278                  * value. */
279                 len_footer = (unsigned)(-1);
280         } else {
281                 len_header = LZX_NUM_PRIMARY_LENS;
282                 len_footer = match_len_minus_2 - LZX_NUM_PRIMARY_LENS;
283         }
284
285         /* Combine the position slot with the length header into
286          * a single symbol that will be encoded with the main
287          * tree. */
288         len_pos_header = (position_slot << 3) | len_header;
289
290         /* The actual main symbol is offset by LZX_NUM_CHARS because
291          * values under LZX_NUM_CHARS are used to indicate a literal
292          * byte rather than a match. */
293         main_symbol = len_pos_header + LZX_NUM_CHARS;
294
295         /* Output main symbol. */
296         ret = bitstream_put_bits(out, codes->main_codewords[main_symbol],
297                                  codes->main_lens[main_symbol]);
298         if (ret != 0)
299                 return ret;
300
301         /* If there is a length footer, output it using the
302          * length Huffman code. */
303         if (len_footer != (unsigned)(-1)) {
304                 ret = bitstream_put_bits(out, codes->len_codewords[len_footer],
305                                          codes->len_lens[len_footer]);
306                 if (ret != 0)
307                         return ret;
308         }
309
310         wimlib_assert(position_slot < LZX_NUM_POSITION_SLOTS);
311
312         num_extra_bits = lzx_get_num_extra_bits(position_slot);
313
314         /* For aligned offset blocks with at least 3 extra bits, output the
315          * verbatim bits literally, then the aligned bits encoded using the
316          * aligned offset tree.  Otherwise, only the verbatim bits need to be
317          * output. */
318         if ((block_type == LZX_BLOCKTYPE_ALIGNED) && (num_extra_bits >= 3)) {
319
320                 verbatim_bits = position_footer >> 3;
321                 ret = bitstream_put_bits(out, verbatim_bits,
322                                          num_extra_bits - 3);
323                 if (ret != 0)
324                         return ret;
325
326                 aligned_bits = (position_footer & 7);
327                 ret = bitstream_put_bits(out,
328                                          codes->aligned_codewords[aligned_bits],
329                                          codes->aligned_lens[aligned_bits]);
330                 if (ret != 0)
331                         return ret;
332         } else {
333                 /* verbatim bits is the same as the position
334                  * footer, in this case. */
335                 ret = bitstream_put_bits(out, position_footer, num_extra_bits);
336                 if (ret != 0)
337                         return ret;
338         }
339         return 0;
340 }
341
342 /*
343  * Writes all compressed literals in a block, both matches and literal bytes, to
344  * the output bitstream.
345  *
346  * @out:         The output bitstream.
347  * @block_type:  The type of the block (LZX_BLOCKTYPE_ALIGNED or LZX_BLOCKTYPE_VERBATIM)
348  * @match_tab[]:   The array of matches that will be output.  It has length
349  *                      of @num_compressed_literals.
350  * @num_compressed_literals:  Number of compressed literals to be output.
351  * @codes:      Pointer to a structure that contains the codewords for the
352  *                      main, length, and aligned offset Huffman codes.
353  */
354 static int
355 lzx_write_compressed_literals(struct output_bitstream *ostream,
356                               int block_type,
357                               const u32 match_tab[],
358                               unsigned  num_compressed_literals,
359                               const struct lzx_codes *codes)
360 {
361         unsigned i;
362         u32 match;
363         int ret;
364
365         for (i = 0; i < num_compressed_literals; i++) {
366                 match = match_tab[i];
367
368                 /* High bit of the match indicates whether the match is an
369                  * actual match (1) or a literal uncompressed byte (0) */
370                 if (match & 0x80000000) {
371                         /* match */
372                         ret = lzx_write_match(ostream, block_type, match,
373                                               codes);
374                         if (ret != 0)
375                                 return ret;
376                 } else {
377                         /* literal byte */
378                         wimlib_assert(match < LZX_NUM_CHARS);
379                         ret = bitstream_put_bits(ostream,
380                                                  codes->main_codewords[match],
381                                                  codes->main_lens[match]);
382                         if (ret != 0)
383                                 return ret;
384                 }
385         }
386         return 0;
387 }
388
389 /*
390  * Writes a compressed Huffman tree to the output, preceded by the pretree for
391  * it.
392  *
393  * The Huffman tree is represented in the output as a series of path lengths
394  * from which the canonical Huffman code can be reconstructed.  The path lengths
395  * themselves are compressed using a separate Huffman code, the pretree, which
396  * consists of LZX_PRETREE_NUM_SYMBOLS (= 20) symbols that cover all possible code
397  * lengths, plus extra codes for repeated lengths.  The path lengths of the
398  * pretree precede the path lengths of the larger code and are uncompressed,
399  * consisting of 20 entries of 4 bits each.
400  *
401  * @out:        The bitstream for the compressed output.
402  * @lens:       The code lengths for the Huffman tree, indexed by symbol.
403  * @num_symbols:        The number of symbols in the code.
404  */
405 static int
406 lzx_write_compressed_tree(struct output_bitstream *out,
407                           const u8 lens[], unsigned num_symbols)
408 {
409         /* Frequencies of the length symbols, including the RLE symbols (NOT the
410          * actual lengths themselves). */
411         freq_t pretree_freqs[LZX_PRETREE_NUM_SYMBOLS];
412         u8 pretree_lens[LZX_PRETREE_NUM_SYMBOLS];
413         u16 pretree_codewords[LZX_PRETREE_NUM_SYMBOLS];
414         u8 output_syms[num_symbols * 2];
415         unsigned output_syms_idx;
416         unsigned cur_run_len;
417         unsigned i;
418         unsigned len_in_run;
419         unsigned additional_bits;
420         char delta;
421         u8 pretree_sym;
422
423         ZERO_ARRAY(pretree_freqs);
424
425         /* Since the code word lengths use a form of RLE encoding, the goal here
426          * is to find each run of identical lengths when going through them in
427          * symbol order (including runs of length 1).  For each run, as many
428          * lengths are encoded using RLE as possible, and the rest are output
429          * literally.
430          *
431          * output_syms[] will be filled in with the length symbols that will be
432          * output, including RLE codes, not yet encoded using the pre-tree.
433          *
434          * cur_run_len keeps track of how many code word lengths are in the
435          * current run of identical lengths.
436          */
437         output_syms_idx = 0;
438         cur_run_len = 1;
439         for (i = 1; i <= num_symbols; i++) {
440
441                 if (i != num_symbols && lens[i] == lens[i - 1]) {
442                         /* Still in a run--- keep going. */
443                         cur_run_len++;
444                         continue;
445                 }
446
447                 /* Run ended! Check if it is a run of zeroes or a run of
448                  * nonzeroes. */
449
450                 /* The symbol that was repeated in the run--- not to be confused
451                  * with the length *of* the run (cur_run_len) */
452                 len_in_run = lens[i - 1];
453
454                 if (len_in_run == 0) {
455                         /* A run of 0's.  Encode it in as few length
456                          * codes as we can. */
457
458                         /* The magic length 18 indicates a run of 20 + n zeroes,
459                          * where n is an uncompressed literal 5-bit integer that
460                          * follows the magic length. */
461                         while (cur_run_len >= 20) {
462
463                                 additional_bits = min(cur_run_len - 20, 0x1f);
464                                 pretree_freqs[18]++;
465                                 output_syms[output_syms_idx++] = 18;
466                                 output_syms[output_syms_idx++] = additional_bits;
467                                 cur_run_len -= 20 + additional_bits;
468                         }
469
470                         /* The magic length 17 indicates a run of 4 + n zeroes,
471                          * where n is an uncompressed literal 4-bit integer that
472                          * follows the magic length. */
473                         while (cur_run_len >= 4) {
474                                 additional_bits = min(cur_run_len - 4, 0xf);
475                                 pretree_freqs[17]++;
476                                 output_syms[output_syms_idx++] = 17;
477                                 output_syms[output_syms_idx++] = additional_bits;
478                                 cur_run_len -= 4 + additional_bits;
479                         }
480
481                 } else {
482
483                         /* A run of nonzero lengths. */
484
485                         /* The magic length 19 indicates a run of 4 + n
486                          * nonzeroes, where n is a literal bit that follows the
487                          * magic length, and where the value of the lengths in
488                          * the run is given by an extra length symbol, encoded
489                          * with the pretree, that follows the literal bit.
490                          *
491                          * The extra length symbol is encoded as a difference
492                          * from the length of the codeword for the first symbol
493                          * in the run in the previous tree.
494                          * */
495                         while (cur_run_len >= 4) {
496                                 additional_bits = (cur_run_len > 4);
497                                 delta = -(char)len_in_run;
498                                 if (delta < 0)
499                                         delta += 17;
500                                 pretree_freqs[19]++;
501                                 pretree_freqs[(unsigned char)delta]++;
502                                 output_syms[output_syms_idx++] = 19;
503                                 output_syms[output_syms_idx++] = additional_bits;
504                                 output_syms[output_syms_idx++] = delta;
505                                 cur_run_len -= 4 + additional_bits;
506                         }
507                 }
508
509                 /* Any remaining lengths in the run are outputted without RLE,
510                  * as a difference from the length of that codeword in the
511                  * previous tree. */
512                 while (cur_run_len--) {
513                         delta = -(char)len_in_run;
514                         if (delta < 0)
515                                 delta += 17;
516
517                         pretree_freqs[(unsigned char)delta]++;
518                         output_syms[output_syms_idx++] = delta;
519                 }
520
521                 cur_run_len = 1;
522         }
523
524         wimlib_assert(output_syms_idx < ARRAY_LEN(output_syms));
525
526         /* Build the pretree from the frequencies of the length symbols. */
527
528         make_canonical_huffman_code(LZX_PRETREE_NUM_SYMBOLS,
529                                     LZX_MAX_CODEWORD_LEN,
530                                     pretree_freqs, pretree_lens,
531                                     pretree_codewords);
532
533         /* Write the lengths of the pretree codes to the output. */
534         for (i = 0; i < LZX_PRETREE_NUM_SYMBOLS; i++)
535                 bitstream_put_bits(out, pretree_lens[i],
536                                    LZX_PRETREE_ELEMENT_SIZE);
537
538         /* Write the length symbols, encoded with the pretree, to the output. */
539
540         i = 0;
541         while (i < output_syms_idx) {
542                 pretree_sym = output_syms[i++];
543
544                 bitstream_put_bits(out, pretree_codewords[pretree_sym],
545                                    pretree_lens[pretree_sym]);
546                 switch (pretree_sym) {
547                 case 17:
548                         bitstream_put_bits(out, output_syms[i++], 4);
549                         break;
550                 case 18:
551                         bitstream_put_bits(out, output_syms[i++], 5);
552                         break;
553                 case 19:
554                         bitstream_put_bits(out, output_syms[i++], 1);
555                         bitstream_put_bits(out,
556                                            pretree_codewords[output_syms[i]],
557                                            pretree_lens[output_syms[i]]);
558                         i++;
559                         break;
560                 default:
561                         break;
562                 }
563         }
564         return 0;
565 }
566
567 /* Builds the canonical Huffman code for the main tree, the length tree, and the
568  * aligned offset tree. */
569 static void 
570 lzx_make_huffman_codes(const struct lzx_freq_tables *freq_tabs,
571                        struct lzx_codes *codes)
572 {
573         make_canonical_huffman_code(LZX_MAINTREE_NUM_SYMBOLS,
574                                         LZX_MAX_CODEWORD_LEN,
575                                         freq_tabs->main_freq_table,
576                                         codes->main_lens,
577                                         codes->main_codewords);
578
579         make_canonical_huffman_code(LZX_LENTREE_NUM_SYMBOLS,
580                                         LZX_MAX_CODEWORD_LEN,
581                                         freq_tabs->len_freq_table,
582                                         codes->len_lens,
583                                         codes->len_codewords);
584
585         make_canonical_huffman_code(LZX_ALIGNEDTREE_NUM_SYMBOLS, 8,
586                                         freq_tabs->aligned_freq_table,
587                                         codes->aligned_lens,
588                                         codes->aligned_codewords);
589 }
590
591 static void
592 do_call_insn_translation(u32 *call_insn_target, int input_pos,
593                          int32_t file_size)
594 {
595         int32_t abs_offset;
596         int32_t rel_offset;
597
598         rel_offset = le32_to_cpu(*call_insn_target);
599         if (rel_offset >= -input_pos && rel_offset < file_size) {
600                 if (rel_offset < file_size - input_pos) {
601                         /* "good translation" */
602                         abs_offset = rel_offset + input_pos;
603                 } else {
604                         /* "compensating translation" */
605                         abs_offset = rel_offset - file_size;
606                 }
607                 *call_insn_target = cpu_to_le32(abs_offset);
608         }
609 }
610
611 /* This is the reverse of undo_call_insn_preprocessing() in lzx-decompress.c.
612  * See the comment above that function for more information. */
613 static void
614 do_call_insn_preprocessing(u8 uncompressed_data[], int uncompressed_data_len)
615 {
616         for (int i = 0; i < uncompressed_data_len - 10; i++) {
617                 if (uncompressed_data[i] == 0xe8) {
618                         do_call_insn_translation((u32*)&uncompressed_data[i + 1],
619                                                  i,
620                                                  LZX_WIM_MAGIC_FILESIZE);
621                         i += 4;
622                 }
623         }
624 }
625
626
627 static const struct lz_params lzx_lz_params = {
628
629          /* LZX_MIN_MATCH == 2, but 2-character matches are rarely useful; the
630           * minimum match for compression is set to 3 instead. */
631         .min_match      = 3,
632
633         .max_match      = LZX_MAX_MATCH,
634         .good_match     = LZX_MAX_MATCH,
635         .nice_match     = LZX_MAX_MATCH,
636         .max_chain_len  = LZX_MAX_MATCH,
637         .max_lazy_match = LZX_MAX_MATCH,
638         .too_far        = 4096,
639 };
640
641 /*
642  * Performs LZX compression on a block of data.
643  *
644  * @__uncompressed_data:  Pointer to the data to be compressed.
645  * @uncompressed_len:     Length, in bytes, of the data to be compressed.
646  * @compressed_data:      Pointer to a location at least (@uncompressed_len - 1)
647  *                              bytes long into which the compressed data may be
648  *                              written.
649  * @compressed_len_ret:   A pointer to an unsigned int into which the length of
650  *                              the compressed data may be returned.
651  *
652  * Returns zero if compression was successfully performed.  In that case
653  * @compressed_data and @compressed_len_ret will contain the compressed data and
654  * its length.  A return value of nonzero means that compressing the data did
655  * not reduce its size, and @compressed_data will not contain the full
656  * compressed data.
657  */
658 int
659 lzx_compress(const void *__uncompressed_data, unsigned uncompressed_len,
660              void *compressed_data, unsigned *compressed_len_ret)
661 {
662         struct output_bitstream ostream;
663         u8 uncompressed_data[uncompressed_len + 8];
664         struct lzx_freq_tables freq_tabs;
665         struct lzx_codes codes;
666         u32 match_tab[uncompressed_len];
667         struct lru_queue queue;
668         unsigned num_matches;
669         unsigned compressed_len;
670         unsigned i;
671         int ret;
672         int block_type = LZX_BLOCKTYPE_ALIGNED;
673
674         if (uncompressed_len < 100)
675                 return 1;
676
677         memset(&freq_tabs, 0, sizeof(freq_tabs));
678         queue.R0 = 1;
679         queue.R1 = 1;
680         queue.R2 = 1;
681
682         /* The input data must be preprocessed. To avoid changing the original
683          * input, copy it to a temporary buffer. */
684         memcpy(uncompressed_data, __uncompressed_data, uncompressed_len);
685
686         /* Before doing any actual compression, do the call instruction (0xe8
687          * byte) translation on the uncompressed data. */
688         do_call_insn_preprocessing(uncompressed_data, uncompressed_len);
689
690         /* Determine the sequence of matches and literals that will be output,
691          * and in the process, keep counts of the number of times each symbol
692          * will be output, so that the Huffman trees can be made. */
693
694         num_matches = lz_analyze_block(uncompressed_data, uncompressed_len,
695                                        match_tab, lzx_record_match,
696                                        lzx_record_literal, &freq_tabs,
697                                        &queue, freq_tabs.main_freq_table,
698                                        &lzx_lz_params);
699
700         lzx_make_huffman_codes(&freq_tabs, &codes);
701
702         /* Initialize the output bitstream. */
703         init_output_bitstream(&ostream, compressed_data, uncompressed_len - 1);
704
705         /* The first three bits tell us what kind of block it is, and are one
706          * of the LZX_BLOCKTYPE_* values.  */
707         bitstream_put_bits(&ostream, block_type, 3);
708
709         /* The next bit indicates whether the block size is the default (32768),
710          * indicated by a 1 bit, or whether the block size is given by the next
711          * 16 bits, indicated by a 0 bit. */
712         if (uncompressed_len == 32768) {
713                 bitstream_put_bits(&ostream, 1, 1);
714         } else {
715                 bitstream_put_bits(&ostream, 0, 1);
716                 bitstream_put_bits(&ostream, uncompressed_len, 16);
717         }
718
719         /* Write out the aligned offset tree. Note that M$ lies and says that
720          * the aligned offset tree comes after the length tree, but that is
721          * wrong; it actually is before the main tree.  */
722         if (block_type == LZX_BLOCKTYPE_ALIGNED)
723                 for (i = 0; i < LZX_ALIGNEDTREE_NUM_SYMBOLS; i++)
724                         bitstream_put_bits(&ostream, codes.aligned_lens[i],
725                                            LZX_ALIGNEDTREE_ELEMENT_SIZE);
726
727         /* Write the pre-tree and lengths for the first LZX_NUM_CHARS symbols in the
728          * main tree. */
729         ret = lzx_write_compressed_tree(&ostream, codes.main_lens,
730                                         LZX_NUM_CHARS);
731         if (ret != 0)
732                 return ret;
733
734         /* Write the pre-tree and symbols for the rest of the main tree. */
735         ret = lzx_write_compressed_tree(&ostream, codes.main_lens +
736                                         LZX_NUM_CHARS,
737                                         LZX_MAINTREE_NUM_SYMBOLS -
738                                                 LZX_NUM_CHARS);
739         if (ret != 0)
740                 return ret;
741
742         /* Write the pre-tree and symbols for the length tree. */
743         ret = lzx_write_compressed_tree(&ostream, codes.len_lens,
744                                         LZX_LENTREE_NUM_SYMBOLS);
745         if (ret != 0)
746                 return ret;
747
748         /* Write the compressed literals. */
749         ret = lzx_write_compressed_literals(&ostream, block_type,
750                                             match_tab, num_matches, &codes);
751         if (ret != 0)
752                 return ret;
753
754         ret = flush_output_bitstream(&ostream);
755         if (ret != 0)
756                 return ret;
757
758         compressed_len = ostream.bit_output - (u8*)compressed_data;
759
760         *compressed_len_ret = compressed_len;
761
762 #ifdef ENABLE_VERIFY_COMPRESSION
763         /* Verify that we really get the same thing back when decompressing. */
764         u8 buf[uncompressed_len];
765         ret = lzx_decompress(compressed_data, compressed_len, buf,
766                              uncompressed_len);
767         if (ret != 0) {
768                 ERROR("lzx_compress(): Failed to decompress data we compressed");
769                 abort();
770         }
771
772         for (i = 0; i < uncompressed_len; i++) {
773                 if (buf[i] != *((u8*)__uncompressed_data + i)) {
774                         ERROR("lzx_compress(): Data we compressed didn't "
775                               "decompress to the original data (difference at "
776                               "byte %u of %u)", i + 1, uncompressed_len);
777                         abort();
778                 }
779         }
780 #endif
781         return 0;
782 }