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