portability and compression cleanups
[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/bitops.h"
27 #include "wimlib/endianness.h"
28 #include "wimlib/lzx.h"
29 #include "wimlib/unaligned.h"
30 #include "wimlib/util.h"
31
32 #ifdef __SSE2__
33 #  include <emmintrin.h>
34 #endif
35
36 /* Mapping: offset slot => first match offset that uses that offset slot.
37  */
38 const u32 lzx_offset_slot_base[LZX_MAX_OFFSET_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: offset slot => how many extra bits must be read and added to the
53  * corresponding offset slot base to decode the match offset.  */
54 const u8 lzx_extra_offset_bits[LZX_MAX_OFFSET_SLOTS] = {
55         0 , 0 , 0 , 0 , 1 ,
56         1 , 2 , 2 , 3 , 3 ,
57         4 , 4 , 5 , 5 , 6 ,
58         6 , 7 , 7 , 8 , 8 ,
59         9 , 9 , 10, 10, 11,
60         11, 12, 12, 13, 13,
61         14, 14, 15, 15, 16,
62         16, 17, 17, 17, 17,
63         17, 17, 17, 17, 17,
64         17, 17, 17, 17, 17,
65         17
66 };
67
68 /* Round the specified compression block size (not LZX block size) up to the
69  * next valid LZX window size, and return its order (log2).  Or, if the block
70  * size is 0 or greater than the largest valid LZX window size, return 0.  */
71 unsigned
72 lzx_get_window_order(size_t max_block_size)
73 {
74         unsigned order;
75
76         if (max_block_size == 0 || max_block_size > LZX_MAX_WINDOW_SIZE)
77                 return 0;
78
79         order = fls32(max_block_size);
80
81         if (((u32)1 << order) != max_block_size)
82                 order++;
83
84         return max(order, LZX_MIN_WINDOW_ORDER);
85 }
86
87 /* Given a valid LZX window order, return the number of symbols that will exist
88  * in the main Huffman code.  */
89 unsigned
90 lzx_get_num_main_syms(unsigned window_order)
91 {
92         u32 window_size = (u32)1 << window_order;
93
94         /* NOTE: the calculation *should* be as follows:
95          *
96          * u32 max_offset = window_size - LZX_MIN_MATCH_LEN;
97          * u32 max_adjusted_offset = max_offset + LZX_OFFSET_OFFSET;
98          * u32 num_offset_slots = 1 + lzx_get_offset_slot_raw(max_adjusted_offset);
99          *
100          * However since LZX_MIN_MATCH_LEN == LZX_OFFSET_OFFSET, we would get
101          * max_adjusted_offset == window_size, which would bump the number of
102          * offset slots up by 1 since every valid LZX window size is equal to a
103          * offset slot base value.  The format doesn't do this, and instead
104          * disallows matches with minimum length and maximum offset.  This sets
105          * max_adjusted_offset = window_size - 1, so instead we must calculate:
106          *
107          * num_offset_slots = 1 + lzx_get_offset_slot_raw(window_size - 1);
108          *
109          * ... which is the same as
110          *
111          * num_offset_slots = lzx_get_offset_slot_raw(window_size);
112          *
113          * ... since every valid window size is equal to an offset base value.
114          */
115         unsigned num_offset_slots = lzx_get_offset_slot_raw(window_size);
116
117         /* Now calculate the number of main symbols as LZX_NUM_CHARS literal
118          * symbols, plus 8 symbols per offset slot (since there are 8 possible
119          * length headers, and we need all (offset slot, length header)
120          * combinations).  */
121         return LZX_NUM_CHARS + (num_offset_slots << 3);
122 }
123
124 static void
125 do_translate_target(void *target, s32 input_pos)
126 {
127         s32 abs_offset, rel_offset;
128
129         rel_offset = get_unaligned_u32_le(target);
130         if (rel_offset >= -input_pos && rel_offset < LZX_WIM_MAGIC_FILESIZE) {
131                 if (rel_offset < LZX_WIM_MAGIC_FILESIZE - input_pos) {
132                         /* "good translation" */
133                         abs_offset = rel_offset + input_pos;
134                 } else {
135                         /* "compensating translation" */
136                         abs_offset = rel_offset - LZX_WIM_MAGIC_FILESIZE;
137                 }
138                 put_unaligned_u32_le(abs_offset, target);
139         }
140 }
141
142 static void
143 undo_translate_target(void *target, s32 input_pos)
144 {
145         s32 abs_offset, rel_offset;
146
147         abs_offset = get_unaligned_u32_le(target);
148         if (abs_offset >= 0) {
149                 if (abs_offset < LZX_WIM_MAGIC_FILESIZE) {
150                         /* "good translation" */
151                         rel_offset = abs_offset - input_pos;
152                         put_unaligned_u32_le(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                         put_unaligned_u32_le(rel_offset, target);
159                 }
160         }
161 }
162
163 /*
164  * Do or undo the 'E8' preprocessing used in LZX.  Before compression, the
165  * uncompressed data is preprocessed by changing the targets of x86 CALL
166  * instructions from relative offsets to absolute offsets.  After decompression,
167  * the translation is undone by changing the targets of x86 CALL instructions
168  * from absolute offsets to relative offsets.
169  *
170  * Note that despite its intent, E8 preprocessing can be done on any data even
171  * if it is not actually x86 machine code.  In fact, E8 preprocessing appears to
172  * always be used in LZX-compressed resources in WIM files; there is no bit to
173  * indicate whether it is used or not, unlike in the LZX compressed format as
174  * used in cabinet files, where a bit is reserved for that purpose.
175  *
176  * E8 preprocessing is disabled in the last 6 bytes of the uncompressed data,
177  * which really means the 5-byte call instruction cannot start in the last 10
178  * bytes of the uncompressed data.  This is one of the errors in the LZX
179  * documentation.
180  *
181  * E8 preprocessing does not appear to be disabled after the 32768th chunk of a
182  * WIM resource, which apparently is another difference from the LZX compression
183  * used in cabinet files.
184  *
185  * E8 processing is supposed to take the file size as a parameter, as it is used
186  * in calculating the translated jump targets.  But in WIM files, this file size
187  * is always the same (LZX_WIM_MAGIC_FILESIZE == 12000000).
188  */
189 static
190 #ifndef __SSE2__
191 inline  /* Although inlining the 'process_target' function still speeds up the
192            SSE2 case, it bloats the binary more.  */
193 #endif
194 void
195 lzx_e8_filter(u8 *data, u32 size, void (*process_target)(void *, s32))
196 {
197         u8 *p = data;
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         if (size >= 32 && (uintptr_t)p % 16 == 0) {
206
207                 u32 valid_mask = 0xFFFFFFFF;
208
209                 u8 * const vec_end = p + (size & ~15) - 16;
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(*(const __m128i *)p,
220                                                            e8_bytes);
221
222                         /* Map the comparison results into a single 16-bit
223                          * number.  It will contain a 1 bit when the
224                          * corresponding byte in the current 16-byte vector is
225                          * an e8 byte.  Note: the low-order bit corresponds to
226                          * the first (lowest address) byte.  */
227                         u32 e8_mask = _mm_movemask_epi8(cmpresult);
228
229                         if (!e8_mask) {
230                                 /* If e8_mask is 0, then none of these 16 bytes
231                                  * have value 0xe8.  No e8 translation is
232                                  * needed, and there is no restriction that
233                                  * carries over to the next 16 bytes.  */
234                                 valid_mask = 0xFFFFFFFF;
235                         } else {
236                                 /* At least one byte has value 0xe8.
237                                  *
238                                  * The AND with valid_mask accounts for the fact
239                                  * that we can't start an e8 translation that
240                                  * overlaps the previous one.  */
241                                 while ((e8_mask &= valid_mask)) {
242
243                                         /* Count the number of trailing zeroes
244                                          * in e8_mask.  This will produce the
245                                          * index of the byte, within the 16, at
246                                          * which the next e8 translation should
247                                          * be done.  */
248                                         int bit = ffs32(e8_mask);
249
250                                         /* Do (or undo) the e8 translation.  */
251                                         (*process_target)(p + bit + 1,
252                                                           p + bit - 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 ((p += 16) < vec_end);
264
265                 while (!(valid_mask & 1)) {
266                         p++;
267                         valid_mask >>= 1;
268                 }
269         }
270 #endif /* !__SSE2__  */
271
272         if (size > 10) {
273                 /* Finish any bytes that weren't processed by the vectorized
274                  * implementation.  */
275                 u8 *end = data + size - 10;
276                 do {
277                         if (*p == 0xe8) {
278                                 (*process_target)(p + 1, p - data);
279                                 p += 5;
280                         } else {
281                                 p++;
282                         }
283                 } while (p < end);
284         }
285 }
286
287 void
288 lzx_do_e8_preprocessing(u8 *data, u32 size)
289 {
290         lzx_e8_filter(data, size, do_translate_target);
291 }
292
293 void
294 lzx_undo_e8_preprocessing(u8 *data, u32 size)
295 {
296         lzx_e8_filter(data, size, undo_translate_target);
297 }