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