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