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