3cc6981b186926ebef22bd63633153a6eb80a217
[wimlib] / src / lzx_common.c
1 /*
2  * lzx_common.c - Common code for LZX compression and decompression.
3  */
4
5 /*
6  * Copyright (C) 2012, 2013, 2014, 2015 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 <string.h>
27
28 #ifdef __SSE2__
29 #  include <emmintrin.h>
30 #endif
31
32 #ifdef __AVX2__
33 #  include <immintrin.h>
34 #endif
35
36 #include "wimlib/bitops.h"
37 #include "wimlib/endianness.h"
38 #include "wimlib/lzx_common.h"
39 #include "wimlib/unaligned.h"
40 #include "wimlib/util.h"
41
42 /* Mapping: offset slot => first match offset that uses that offset slot.
43  */
44 const u32 lzx_offset_slot_base[LZX_MAX_OFFSET_SLOTS + 1] = {
45         0      , 1      , 2      , 3      , 4      ,    /* 0  --- 4  */
46         6      , 8      , 12     , 16     , 24     ,    /* 5  --- 9  */
47         32     , 48     , 64     , 96     , 128    ,    /* 10 --- 14 */
48         192    , 256    , 384    , 512    , 768    ,    /* 15 --- 19 */
49         1024   , 1536   , 2048   , 3072   , 4096   ,    /* 20 --- 24 */
50         6144   , 8192   , 12288  , 16384  , 24576  ,    /* 25 --- 29 */
51         32768  , 49152  , 65536  , 98304  , 131072 ,    /* 30 --- 34 */
52         196608 , 262144 , 393216 , 524288 , 655360 ,    /* 35 --- 39 */
53         786432 , 917504 , 1048576, 1179648, 1310720,    /* 40 --- 44 */
54         1441792, 1572864, 1703936, 1835008, 1966080,    /* 45 --- 49 */
55         2097152                                         /* extra     */
56 };
57
58 /* Mapping: offset slot => how many extra bits must be read and added to the
59  * corresponding offset slot base to decode the match offset.  */
60 const u8 lzx_extra_offset_bits[LZX_MAX_OFFSET_SLOTS + 1] = {
61         0 , 0 , 0 , 0 , 1 ,
62         1 , 2 , 2 , 3 , 3 ,
63         4 , 4 , 5 , 5 , 6 ,
64         6 , 7 , 7 , 8 , 8 ,
65         9 , 9 , 10, 10, 11,
66         11, 12, 12, 13, 13,
67         14, 14, 15, 15, 16,
68         16, 17, 17, 17, 17,
69         17, 17, 17, 17, 17,
70         17, 17, 17, 17, 17,
71         17
72 };
73
74 /* Round the specified buffer size up to the next valid LZX window size, and
75  * return its order (log2).  Or, if the buffer size is 0 or greater than the
76  * largest valid LZX window size, return 0.  */
77 unsigned
78 lzx_get_window_order(size_t max_bufsize)
79 {
80         unsigned order;
81
82         if (max_bufsize == 0 || max_bufsize > LZX_MAX_WINDOW_SIZE)
83                 return 0;
84
85         order = fls32(max_bufsize);
86
87         if (((u32)1 << order) != max_bufsize)
88                 order++;
89
90         return max(order, LZX_MIN_WINDOW_ORDER);
91 }
92
93 unsigned
94 lzx_get_num_offset_slots(unsigned window_order)
95 {
96         /* Note: one would expect that the maximum match offset would be
97          * 'window_size - LZX_MIN_MATCH_LEN', which would occur if the first two
98          * bytes were to match the last two bytes.  However, the format
99          * disallows this case.  This reduces the number of needed offset slots
100          * by 1.  */
101         u32 window_size = (u32)1 << window_order;
102         u32 max_offset = window_size - LZX_MIN_MATCH_LEN - 1;
103         return 1 + lzx_get_offset_slot(max_offset);
104 }
105
106 /* Given a valid LZX window order, return the number of symbols that will exist
107  * in the main Huffman code.  */
108 unsigned
109 lzx_get_num_main_syms(unsigned window_order)
110 {
111         return LZX_NUM_CHARS + (lzx_get_num_offset_slots(window_order) *
112                                 LZX_NUM_LEN_HEADERS);
113 }
114
115 static void
116 do_translate_target(void *target, s32 input_pos)
117 {
118         s32 abs_offset, rel_offset;
119
120         rel_offset = get_unaligned_u32_le(target);
121         if (rel_offset >= -input_pos && rel_offset < LZX_WIM_MAGIC_FILESIZE) {
122                 if (rel_offset < LZX_WIM_MAGIC_FILESIZE - input_pos) {
123                         /* "good translation" */
124                         abs_offset = rel_offset + input_pos;
125                 } else {
126                         /* "compensating translation" */
127                         abs_offset = rel_offset - LZX_WIM_MAGIC_FILESIZE;
128                 }
129                 put_unaligned_u32_le(abs_offset, target);
130         }
131 }
132
133 static void
134 undo_translate_target(void *target, s32 input_pos)
135 {
136         s32 abs_offset, rel_offset;
137
138         abs_offset = get_unaligned_u32_le(target);
139         if (abs_offset >= 0) {
140                 if (abs_offset < LZX_WIM_MAGIC_FILESIZE) {
141                         /* "good translation" */
142                         rel_offset = abs_offset - input_pos;
143                         put_unaligned_u32_le(rel_offset, target);
144                 }
145         } else {
146                 if (abs_offset >= -input_pos) {
147                         /* "compensating translation" */
148                         rel_offset = abs_offset + LZX_WIM_MAGIC_FILESIZE;
149                         put_unaligned_u32_le(rel_offset, target);
150                 }
151         }
152 }
153
154 /*
155  * Do or undo the 'E8' preprocessing used in LZX.  Before compression, the
156  * uncompressed data is preprocessed by changing the targets of x86 CALL
157  * instructions from relative offsets to absolute offsets.  After decompression,
158  * the translation is undone by changing the targets of x86 CALL instructions
159  * from absolute offsets to relative offsets.
160  *
161  * Note that despite its intent, E8 preprocessing can be done on any data even
162  * if it is not actually x86 machine code.  In fact, E8 preprocessing appears to
163  * always be used in LZX-compressed resources in WIM files; there is no bit to
164  * indicate whether it is used or not, unlike in the LZX compressed format as
165  * used in cabinet files, where a bit is reserved for that purpose.
166  *
167  * E8 preprocessing is disabled in the last 6 bytes of the uncompressed data,
168  * which really means the 5-byte call instruction cannot start in the last 10
169  * bytes of the uncompressed data.  This is one of the errors in the LZX
170  * documentation.
171  *
172  * E8 preprocessing does not appear to be disabled after the 32768th chunk of a
173  * WIM resource, which apparently is another difference from the LZX compression
174  * used in cabinet files.
175  *
176  * E8 processing is supposed to take the file size as a parameter, as it is used
177  * in calculating the translated jump targets.  But in WIM files, this file size
178  * is always the same (LZX_WIM_MAGIC_FILESIZE == 12000000).
179  */
180 static void
181 lzx_e8_filter(u8 *data, u32 size, void (*process_target)(void *, s32))
182 {
183
184 #if !defined(__SSE2__) && !defined(__AVX2__)
185         /*
186          * A worthwhile optimization is to push the end-of-buffer check into the
187          * relatively rare E8 case.  This is possible if we replace the last six
188          * bytes of data with E8 bytes; then we are guaranteed to hit an E8 byte
189          * before reaching end-of-buffer.  In addition, this scheme guarantees
190          * that no translation can begin following an E8 byte in the last 10
191          * bytes because a 4-byte offset containing E8 as its high byte is a
192          * large negative number that is not valid for translation.  That is
193          * exactly what we need.
194          */
195         u8 *tail;
196         u8 saved_bytes[6];
197         u8 *p;
198
199         if (size <= 10)
200                 return;
201
202         tail = &data[size - 6];
203         memcpy(saved_bytes, tail, 6);
204         memset(tail, 0xE8, 6);
205         p = data;
206         for (;;) {
207                 while (*p != 0xE8)
208                         p++;
209                 if (p >= tail)
210                         break;
211                 (*process_target)(p + 1, p - data);
212                 p += 5;
213         }
214         memcpy(tail, saved_bytes, 6);
215 #else
216         /* SSE2 or AVX-2 optimized version for x86_64  */
217
218         u8 *p = data;
219         u64 valid_mask = ~0;
220
221         if (size <= 10)
222                 return;
223 #ifdef __AVX2__
224 #  define ALIGNMENT_REQUIRED 32
225 #else
226 #  define ALIGNMENT_REQUIRED 16
227 #endif
228
229         /* Process one byte at a time until the pointer is properly aligned.  */
230         while ((uintptr_t)p % ALIGNMENT_REQUIRED != 0) {
231                 if (p >= data + size - 10)
232                         return;
233                 if (*p == 0xE8 && (valid_mask & 1)) {
234                         (*process_target)(p + 1, p - data);
235                         valid_mask &= ~0x1F;
236                 }
237                 p++;
238                 valid_mask >>= 1;
239                 valid_mask |= (u64)1 << 63;
240         }
241
242         if (data + size - p >= 64) {
243
244                 /* Vectorized processing  */
245
246                 /* Note: we use a "trap" E8 byte to eliminate the need to check
247                  * for end-of-buffer in the inner loop.  This byte is carefully
248                  * positioned so that it will never be changed by a previous
249                  * translation before it is detected.  */
250
251                 u8 *trap = p + ((data + size - p) & ~31) - 32 + 4;
252                 u8 saved_byte = *trap;
253                 *trap = 0xE8;
254
255                 for (;;) {
256                         u32 e8_mask;
257                         u8 *orig_p = p;
258                 #ifdef __AVX2__
259                         const __m256i e8_bytes = _mm256_set1_epi8(0xE8);
260                         for (;;) {
261                                 __m256i bytes = *(const __m256i *)p;
262                                 __m256i cmpresult = _mm256_cmpeq_epi8(bytes, e8_bytes);
263                                 e8_mask = _mm256_movemask_epi8(cmpresult);
264                                 if (e8_mask)
265                                         break;
266                                 p += 32;
267                         }
268                 #else
269                         const __m128i e8_bytes = _mm_set1_epi8(0xE8);
270                         for (;;) {
271                                 /* Read the next 32 bytes of data and test them
272                                  * for E8 bytes.  */
273                                 __m128i bytes1 = *(const __m128i *)p;
274                                 __m128i bytes2 = *(const __m128i *)(p + 16);
275                                 __m128i cmpresult1 = _mm_cmpeq_epi8(bytes1, e8_bytes);
276                                 __m128i cmpresult2 = _mm_cmpeq_epi8(bytes2, e8_bytes);
277                                 u32 mask1 = _mm_movemask_epi8(cmpresult1);
278                                 u32 mask2 = _mm_movemask_epi8(cmpresult2);
279                                 /* The masks have a bit set for each E8 byte.
280                                  * We stay in this fast inner loop as long as
281                                  * there are no E8 bytes.  */
282                                 if (mask1 | mask2) {
283                                         e8_mask = mask1 | (mask2 << 16);
284                                         break;
285                                 }
286                                 p += 32;
287                         }
288                 #endif
289
290                         /* Did we pass over data with no E8 bytes?  */
291                         if (p != orig_p)
292                                 valid_mask = ~0;
293
294                         /* Are we nearing end-of-buffer?  */
295                         if (p == trap - 4)
296                                 break;
297
298                         /* Process the E8 bytes.  However, the AND with
299                          * 'valid_mask' ensures we never process an E8 byte that
300                          * was itself part of a translation target.  */
301                         while ((e8_mask &= valid_mask)) {
302                                 unsigned bit = ffs32(e8_mask);
303                                 (*process_target)(p + bit + 1, p + bit - data);
304                                 valid_mask &= ~((u64)0x1F << bit);
305                         }
306
307                         valid_mask >>= 32;
308                         valid_mask |= 0xFFFFFFFF00000000;
309                         p += 32;
310                 }
311
312                 *trap = saved_byte;
313         }
314
315         /* Approaching the end of the buffer; process one byte a time.  */
316         while (p < data + size - 10) {
317                 if (*p == 0xE8 && (valid_mask & 1)) {
318                         (*process_target)(p + 1, p - data);
319                         valid_mask &= ~0x1F;
320                 }
321                 p++;
322                 valid_mask >>= 1;
323                 valid_mask |= (u64)1 << 63;
324         }
325 #endif /* __SSE2__ || __AVX2__ */
326 }
327
328 void
329 lzx_do_e8_preprocessing(u8 *data, u32 size)
330 {
331         lzx_e8_filter(data, size, do_translate_target);
332 }
333
334 void
335 lzx_undo_e8_preprocessing(u8 *data, u32 size)
336 {
337         lzx_e8_filter(data, size, undo_translate_target);
338 }