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