LZX: Allow max_block_size not a power of 2
[wimlib] / src / lzx-common.c
1 /*
2  * lzx-common.c - Common data for LZX compression and decompression.
3  */
4
5 /*
6  * Copyright (C) 2012, 2013 Eric Biggers
7  *
8  * This file is part of wimlib, a library for working with WIM files.
9  *
10  * wimlib is free software; you can redistribute it and/or modify it under the
11  * terms of the GNU General Public License as published by the Free
12  * Software Foundation; either version 3 of the License, or (at your option)
13  * any later version.
14  *
15  * wimlib is distributed in the hope that it will be useful, but WITHOUT ANY
16  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17  * A PARTICULAR PURPOSE. See the GNU General Public License for more
18  * details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with wimlib; if not, see http://www.gnu.org/licenses/.
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #  include "config.h"
26 #endif
27
28 #include "wimlib/endianness.h"
29 #include "wimlib/lzx.h"
30 #include "wimlib/util.h"
31
32 #ifdef __SSE2__
33 #  include <emmintrin.h>
34 #endif
35
36 /* Mapping: position slot => first match offset that uses that position slot.
37  */
38 const u32 lzx_position_base[LZX_MAX_POSITION_SLOTS] = {
39         0      , 1      , 2      , 3      , 4      ,    /* 0  --- 4  */
40         6      , 8      , 12     , 16     , 24     ,    /* 5  --- 9  */
41         32     , 48     , 64     , 96     , 128    ,    /* 10 --- 14 */
42         192    , 256    , 384    , 512    , 768    ,    /* 15 --- 19 */
43         1024   , 1536   , 2048   , 3072   , 4096   ,    /* 20 --- 24 */
44         6144   , 8192   , 12288  , 16384  , 24576  ,    /* 25 --- 29 */
45         32768  , 49152  , 65536  , 98304  , 131072 ,    /* 30 --- 34 */
46         196608 , 262144 , 393216 , 524288 , 655360 ,    /* 35 --- 39 */
47         786432 , 917504 , 1048576, 1179648, 1310720,    /* 40 --- 44 */
48         1441792, 1572864, 1703936, 1835008, 1966080,    /* 45 --- 49 */
49         2097152                                         /* 50        */
50 };
51
52 /* Mapping: position slot => how many extra bits must be read and added to the
53  * corresponding position base to decode the match offset.  */
54 #ifdef USE_LZX_EXTRA_BITS_ARRAY
55 const u8 lzx_extra_bits[LZX_MAX_POSITION_SLOTS] = {
56         0 , 0 , 0 , 0 , 1 ,
57         1 , 2 , 2 , 3 , 3 ,
58         4 , 4 , 5 , 5 , 6 ,
59         6 , 7 , 7 , 8 , 8 ,
60         9 , 9 , 10, 10, 11,
61         11, 12, 12, 13, 13,
62         14, 14, 15, 15, 16,
63         16, 17, 17, 17, 17,
64         17, 17, 17, 17, 17,
65         17, 17, 17, 17, 17,
66         17
67 };
68 #endif
69
70 /* Round the specified compression block size (not LZX block size) up to the
71  * next valid LZX window size, and return its order (log2).  Or, if the block
72  * size is 0 or greater than the largest valid LZX window size, return 0.  */
73 unsigned
74 lzx_get_window_order(size_t max_block_size)
75 {
76         unsigned order;
77
78         if (max_block_size == 0 || max_block_size > (1 << LZX_MAX_WINDOW_ORDER))
79                 return 0;
80
81         order = bsr32(max_block_size);
82
83         if ((1 << order) != max_block_size)
84                 order++;
85
86         return max(order, LZX_MIN_WINDOW_ORDER);
87 }
88
89 /* Given a valid LZX window order, return the number of symbols that will exist
90  * in the main Huffman code.  */
91 unsigned
92 lzx_get_num_main_syms(unsigned window_order)
93 {
94         u32 window_size = 1 << window_order;
95
96         /* NOTE: the calculation *should* be as follows:
97          *
98          * u32 max_offset = window_size - LZX_MIN_MATCH_LEN;
99          * u32 max_formatted_offset = max_offset + LZX_OFFSET_OFFSET;
100          * u32 num_position_slots = 1 + lzx_get_position_slot_raw(max_formatted_offset);
101          *
102          * However since LZX_MIN_MATCH_LEN == LZX_OFFSET_OFFSET, we would get
103          * max_formatted_offset == window_size, which would bump the number of
104          * position slots up by 1 since every valid LZX window size is equal to
105          * a position base value.  The format doesn't do this, and instead
106          * disallows matches with minimum length and maximum offset.  This sets
107          * max_formatted_offset = window_size - 1, so instead we must calculate:
108          *
109          * num_position_slots = 1 + lzx_get_position_slot_raw(window_size - 1);
110          *
111          * ... which is the same as
112          *
113          * num_position_slots = lzx_get_position_slot_raw(window_size);
114          *
115          * ... since every valid window size is equal to a position base value.
116          */
117         unsigned num_position_slots = lzx_get_position_slot_raw(window_size);
118
119         /* Now calculate the number of main symbols as LZX_NUM_CHARS literal
120          * symbols, plus 8 symbols per position slot (since there are 8 possible
121          * length headers, and we need all (position slot, length header)
122          * combinations).  */
123         return LZX_NUM_CHARS + (num_position_slots << 3);
124 }
125
126 static void
127 do_translate_target(sle32 *target, s32 input_pos)
128 {
129         s32 abs_offset, rel_offset;
130
131         /* XXX: This assumes unaligned memory accesses are okay.  */
132         rel_offset = le32_to_cpu(*target);
133         if (rel_offset >= -input_pos && rel_offset < LZX_WIM_MAGIC_FILESIZE) {
134                 if (rel_offset < LZX_WIM_MAGIC_FILESIZE - input_pos) {
135                         /* "good translation" */
136                         abs_offset = rel_offset + input_pos;
137                 } else {
138                         /* "compensating translation" */
139                         abs_offset = rel_offset - LZX_WIM_MAGIC_FILESIZE;
140                 }
141                 *target = cpu_to_le32(abs_offset);
142         }
143 }
144
145 static void
146 undo_translate_target(sle32 *target, s32 input_pos)
147 {
148         s32 abs_offset, rel_offset;
149
150         /* XXX: This assumes unaligned memory accesses are okay.  */
151         abs_offset = le32_to_cpu(*target);
152         if (abs_offset >= 0) {
153                 if (abs_offset < LZX_WIM_MAGIC_FILESIZE) {
154                         /* "good translation" */
155                         rel_offset = abs_offset - input_pos;
156
157                         *target = cpu_to_le32(rel_offset);
158                 }
159         } else {
160                 if (abs_offset >= -input_pos) {
161                         /* "compensating translation" */
162                         rel_offset = abs_offset + LZX_WIM_MAGIC_FILESIZE;
163
164                         *target = cpu_to_le32(rel_offset);
165                 }
166         }
167 }
168
169 /*
170  * Do or undo the 'E8' preprocessing used in LZX.  Before compression, the
171  * uncompressed data is preprocessed by changing the targets of x86 CALL
172  * instructions from relative offsets to absolute offsets.  After decompression,
173  * the translation is undone by changing the targets of x86 CALL instructions
174  * from absolute offsets to relative offsets.
175  *
176  * Note that despite its intent, E8 preprocessing can be done on any data even
177  * if it is not actually x86 machine code.  In fact, E8 preprocessing appears to
178  * always be used in LZX-compressed resources in WIM files; there is no bit to
179  * indicate whether it is used or not, unlike in the LZX compressed format as
180  * used in cabinet files, where a bit is reserved for that purpose.
181  *
182  * E8 preprocessing is disabled in the last 6 bytes of the uncompressed data,
183  * which really means the 5-byte call instruction cannot start in the last 10
184  * bytes of the uncompressed data.  This is one of the errors in the LZX
185  * documentation.
186  *
187  * E8 preprocessing does not appear to be disabled after the 32768th chunk of a
188  * WIM resource, which apparently is another difference from the LZX compression
189  * used in cabinet files.
190  *
191  * E8 processing is supposed to take the file size as a parameter, as it is used
192  * in calculating the translated jump targets.  But in WIM files, this file size
193  * is always the same (LZX_WIM_MAGIC_FILESIZE == 12000000).
194  */
195 static
196 #ifndef __SSE2__
197 inline  /* Although inlining the 'process_target' function still speeds up the
198            SSE2 case, it bloats the binary more.  */
199 #endif
200 void
201 lzx_e8_filter(u8 *data, u32 size, void (*process_target)(sle32 *, s32))
202 {
203 #ifdef __SSE2__
204         /* SSE2 vectorized implementation for x86_64.  This speeds up LZX
205          * decompression by about 5-8% overall.  (Usually --- the performance
206          * actually regresses slightly in the degenerate case that the data
207          * consists entirely of 0xe8 bytes.  Also, this optimization affects
208          * compression as well, but the percentage improvement is less because
209          * LZX compression is much slower than LZX decompression. ) */
210         __m128i *p128 = (__m128i *)data;
211         u32 valid_mask = 0xFFFFFFFF;
212
213         if (size >= 32 && (uintptr_t)data % 16 == 0) {
214                 __m128i * const end128 = p128 + size / 16 - 1;
215
216                 /* Create a vector of all 0xe8 bytes  */
217                 const __m128i e8_bytes = _mm_set1_epi8(0xe8);
218
219                 /* Iterate through the 16-byte vectors in the input.  */
220                 do {
221                         /* Compare the current 16-byte vector with the vector of
222                          * all 0xe8 bytes.  This produces 0xff where the byte is
223                          * 0xe8 and 0x00 where it is not.  */
224                         __m128i cmpresult = _mm_cmpeq_epi8(*p128, e8_bytes);
225
226                         /* Map the comparison results into a single 16-bit
227                          * number.  It will contain a 1 bit when the
228                          * corresponding byte in the current 16-byte vector is
229                          * an e8 byte.  Note: the low-order bit corresponds to
230                          * the first (lowest address) byte.  */
231                         u32 e8_mask = _mm_movemask_epi8(cmpresult);
232
233                         if (!e8_mask) {
234                                 /* If e8_mask is 0, then none of these 16 bytes
235                                  * have value 0xe8.  No e8 translation is
236                                  * needed, and there is no restriction that
237                                  * carries over to the next 16 bytes.  */
238                                 valid_mask = 0xFFFFFFFF;
239                         } else {
240                                 /* At least one byte has value 0xe8.
241                                  *
242                                  * The AND with valid_mask accounts for the fact
243                                  * that we can't start an e8 translation that
244                                  * overlaps the previous one.  */
245                                 while ((e8_mask &= valid_mask)) {
246
247                                         /* Count the number of trailing zeroes
248                                          * in e8_mask.  This will produce the
249                                          * index of the byte, within the 16, at
250                                          * which the next e8 translation should
251                                          * be done.  */
252                                         u32 bit = __builtin_ctz(e8_mask);
253
254                                         /* Do (or undo) the e8 translation.  */
255                                         u8 *p8 = (u8 *)p128 + bit;
256                                         (*process_target)((sle32 *)(p8 + 1),
257                                                           p8 - data);
258
259                                         /* Don't start an e8 translation in the
260                                          * next 4 bytes.  */
261                                         valid_mask &= ~((u32)0x1F << bit);
262                                 }
263                                 /* Moving on to the next vector.  Shift and set
264                                  * valid_mask accordingly.  */
265                                 valid_mask >>= 16;
266                                 valid_mask |= 0xFFFF0000;
267                         }
268                 } while (++p128 < end128);
269         }
270
271         u8 *p8 = (u8 *)p128;
272         while (!(valid_mask & 1)) {
273                 p8++;
274                 valid_mask >>= 1;
275         }
276 #else /* __SSE2__  */
277         u8 *p8 = data;
278 #endif /* !__SSE2__  */
279
280         if (size > 10) {
281                 /* Finish any bytes that weren't processed by the vectorized
282                  * implementation.  */
283                 u8 *p8_end = data + size - 10;
284                 do {
285                         if (*p8 == 0xe8) {
286                                 (*process_target)((sle32 *)(p8 + 1), p8 - data);
287                                 p8 += 5;
288                         } else {
289                                 p8++;
290                         }
291                 } while (p8 < p8_end);
292         }
293 }
294
295 void
296 lzx_do_e8_preprocessing(u8 *data, u32 size)
297 {
298         lzx_e8_filter(data, size, do_translate_target);
299 }
300
301 void
302 lzx_undo_e8_preprocessing(u8 *data, u32 size)
303 {
304         lzx_e8_filter(data, size, undo_translate_target);
305 }