]> wimlib.net Git - wimlib/blobdiff - src/lzms_decompress.c
LZMS: always correctly handle misaligned buffers
[wimlib] / src / lzms_decompress.c
index 5dd500aa05345a5b8716fd60a03477fffd0c893e..e14ba590ac311dc074699470e27277f177bff178 100644 (file)
@@ -276,10 +276,10 @@ struct lzms_range_decoder {
 
        /* Pointer to the next little-endian 16-bit integer in the compressed
         * input data (reading forwards).  */
-       const le16 *next;
+       const u8 *next;
 
        /* Pointer to the end of the compressed input data.  */
-       const le16 *end;
+       const u8 *end;
 };
 
 typedef u64 bitbuf_t;
@@ -295,10 +295,10 @@ struct lzms_input_bitstream {
 
        /* Pointer to the one past the next little-endian 16-bit integer in the
         * compressed input data (reading backwards).  */
-       const le16 *next;
+       const u8 *next;
 
        /* Pointer to the beginning of the compressed input data.  */
-       const le16 *begin;
+       const u8 *begin;
 };
 
 #define BITBUF_NBITS   (8 * sizeof(bitbuf_t))
@@ -314,17 +314,6 @@ struct lzms_huffman_rebuild_info {
        unsigned table_bits;
 };
 
-struct lzms_probabilites {
-       struct lzms_probability_entry main[LZMS_NUM_MAIN_PROBS];
-       struct lzms_probability_entry match[LZMS_NUM_MATCH_PROBS];
-       struct lzms_probability_entry lz[LZMS_NUM_LZ_PROBS];
-       struct lzms_probability_entry delta[LZMS_NUM_DELTA_PROBS];
-       struct lzms_probability_entry lz_rep[LZMS_NUM_LZ_REP_DECISIONS]
-                                           [LZMS_NUM_LZ_REP_PROBS];
-       struct lzms_probability_entry delta_rep[LZMS_NUM_DELTA_REP_DECISIONS]
-                                              [LZMS_NUM_DELTA_REP_PROBS];
-};
-
 struct lzms_decompressor {
 
        /* 'last_target_usages' is in union with everything else because it is
@@ -374,10 +363,10 @@ struct lzms_decompressor {
 };
 
 /* Initialize the input bitstream @is to read backwards from the compressed data
- * buffer @in that is @count 16-bit integers long.  */
+ * buffer @in that is @count bytes long.  */
 static void
 lzms_input_bitstream_init(struct lzms_input_bitstream *is,
-                         const le16 *in, size_t count)
+                         const u8 *in, size_t count)
 {
        is->bitbuf = 0;
        is->bitsleft = 0;
@@ -398,18 +387,22 @@ lzms_ensure_bits(struct lzms_input_bitstream *is, unsigned num_bits)
        avail = BITBUF_NBITS - is->bitsleft;
 
        if (UNALIGNED_ACCESS_IS_FAST && CPU_IS_LITTLE_ENDIAN &&
-           WORDSIZE == 8 && likely((u8 *)is->next - (u8 *)is->begin >= 8))
+           WORDSIZE == 8 && likely(is->next - is->begin >= 8))
        {
-               is->next -= avail >> 4;
+               is->next -= (avail & ~15) >> 3;
                is->bitbuf |= load_u64_unaligned(is->next) << (avail & 15);
                is->bitsleft += avail & ~15;
        } else {
-               if (likely(is->next != is->begin))
-                       is->bitbuf |= (bitbuf_t)le16_to_cpu(*--is->next)
+               if (likely(is->next != is->begin)) {
+                       is->next -= sizeof(le16);
+                       is->bitbuf |= (bitbuf_t)get_unaligned_le16(is->next)
                                        << (avail - 16);
-               if (likely(is->next != is->begin))
-                       is->bitbuf |=(bitbuf_t)le16_to_cpu(*--is->next)
+               }
+               if (likely(is->next != is->begin)) {
+                       is->next -= sizeof(le16);
+                       is->bitbuf |= (bitbuf_t)get_unaligned_le16(is->next)
                                        << (avail - 32);
+               }
                is->bitsleft += 32;
        }
 }
@@ -447,14 +440,15 @@ lzms_read_bits(struct lzms_input_bitstream *is, unsigned num_bits)
 }
 
 /* Initialize the range decoder @rd to read forwards from the compressed data
- * buffer @in that is @count 16-bit integers long.  */
+ * buffer @in that is @count bytes long.  */
 static void
 lzms_range_decoder_init(struct lzms_range_decoder *rd,
-                       const le16 *in, size_t count)
+                       const u8 *in, size_t count)
 {
        rd->range = 0xffffffff;
-       rd->code = ((u32)le16_to_cpu(in[0]) << 16) | le16_to_cpu(in[1]);
-       rd->next = in + 2;
+       rd->code = ((u32)get_unaligned_le16(in) << 16) |
+                  get_unaligned_le16(in + 2);
+       rd->next = in + 4;
        rd->end = in + count;
 }
 
@@ -474,18 +468,24 @@ lzms_decode_bit(struct lzms_range_decoder *rd, u32 *state_p, u32 num_states,
        /* Load the probability entry corresponding to the current state.  */
        prob_entry = &probs[*state_p];
 
-       /* Normalize if needed.  */
-       if (rd->range <= 0xffff) {
-               rd->range <<= 16;
-               rd->code <<= 16;
-               if (likely(rd->next != rd->end))
-                       rd->code |= le16_to_cpu(*rd->next++);
-       }
+       /* Update the state early.  We'll still need to OR the state with 1
+        * later if the decoded bit is a 1.  */
+       *state_p = (*state_p << 1) & (num_states - 1);
 
        /* Get the probability (out of LZMS_PROBABILITY_DENOMINATOR) that the
         * next bit is 0.  */
        prob = lzms_get_probability(prob_entry);
 
+       /* Normalize if needed.  */
+       if (!(rd->range & 0xFFFF0000)) {
+               rd->range <<= 16;
+               rd->code <<= 16;
+               if (likely(rd->next != rd->end)) {
+                       rd->code |= get_unaligned_le16(rd->next);
+                       rd->next += sizeof(le16);
+               }
+       }
+
        /* Based on the probability, calculate the bound between the 0-bit
         * region and the 1-bit region of the range.  */
        bound = (rd->range >> LZMS_PROBABILITY_BITS) * prob;
@@ -495,7 +495,6 @@ lzms_decode_bit(struct lzms_range_decoder *rd, u32 *state_p, u32 num_states,
                rd->range = bound;
 
                /* Update the state and probability entry based on the decoded bit.  */
-               *state_p = ((*state_p << 1) | 0) & (num_states - 1);
                lzms_update_probability_entry(prob_entry, 0);
                return 0;
        } else {
@@ -504,8 +503,8 @@ lzms_decode_bit(struct lzms_range_decoder *rd, u32 *state_p, u32 num_states,
                rd->code -= bound;
 
                /* Update the state and probability entry based on the decoded bit.  */
-               *state_p = ((*state_p << 1) | 1) & (num_states - 1);
                lzms_update_probability_entry(prob_entry, 1);
+               *state_p |= 1;
                return 1;
        }
 }
@@ -735,10 +734,14 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
        /* LRU queues for match sources  */
        u32 recent_lz_offsets[LZMS_NUM_LZ_REPS + 1];
        u64 recent_delta_pairs[LZMS_NUM_DELTA_REPS + 1];
-       u32 pending_lz_offset = 0;
-       u64 pending_delta_pair = 0;
-       const u8 *lz_offset_still_pending;
-       const u8 *delta_pair_still_pending;
+
+       /* Previous item type: 0 = literal, 1 = LZ match, 2 = delta match.
+        * This is used to handle delayed updates of the LRU queues.  Instead of
+        * actually delaying the updates, we can check when decoding each rep
+        * match whether a delayed update needs to be taken into account, and if
+        * so get the match source from slot 'rep_idx + 1' instead of from slot
+        * 'rep_idx'.  */
+       unsigned prev_item_type = 0;
 
        /* States and probability entries for item type disambiguation  */
        u32 main_state = 0;
@@ -753,21 +756,17 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
         *
         * 1. LZMS-compressed data is a series of 16-bit integers, so the
         *    compressed data buffer cannot take up an odd number of bytes.
-        * 2. To prevent poor performance on some architectures, we require that
-        *    the compressed data buffer is 2-byte aligned.
-        * 3. There must be at least 4 bytes of compressed data, since otherwise
+        * 2. There must be at least 4 bytes of compressed data, since otherwise
         *    we cannot even initialize the range decoder.
         */
-       if ((in_nbytes & 1) || ((uintptr_t)in & 1) || (in_nbytes < 4))
+       if ((in_nbytes & 1) || (in_nbytes < 4))
                return -1;
 
-       lzms_range_decoder_init(&rd, in, in_nbytes / sizeof(le16));
+       lzms_range_decoder_init(&rd, in, in_nbytes);
 
-       lzms_input_bitstream_init(&is, in, in_nbytes / sizeof(le16));
+       lzms_input_bitstream_init(&is, in, in_nbytes);
 
-       lzms_init_probability_entries((struct lzms_probability_entry *)&d->probs,
-                                     sizeof(d->probs) /
-                                       sizeof(struct lzms_probability_entry));
+       lzms_init_probabilities(&d->probs);
 
        lzms_init_huffman_codes(d, lzms_get_num_offset_slots(out_nbytes));
 
@@ -785,6 +784,7 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
                {
                        /* Literal  */
                        *out_next++ = lzms_decode_literal(d, &is);
+                       prev_item_type = 0;
 
                } else if (!lzms_decode_bit(&rd, &match_state,
                                            LZMS_NUM_MATCH_PROBS,
@@ -795,55 +795,42 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
                        u32 offset;
                        u32 length;
 
+                       STATIC_ASSERT(LZMS_NUM_LZ_REPS == 3);
+
                        if (!lzms_decode_bit(&rd, &lz_state,
                                             LZMS_NUM_LZ_PROBS, d->probs.lz))
                        {
                                /* Explicit offset  */
                                offset = lzms_decode_lz_offset(d, &is);
+
+                               recent_lz_offsets[3] = recent_lz_offsets[2];
+                               recent_lz_offsets[2] = recent_lz_offsets[1];
+                               recent_lz_offsets[1] = recent_lz_offsets[0];
                        } else {
                                /* Repeat offset  */
 
-                               if (pending_lz_offset != 0 &&
-                                   out_next != lz_offset_still_pending)
-                               {
-                                       BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
-                                       recent_lz_offsets[3] = recent_lz_offsets[2];
-                                       recent_lz_offsets[2] = recent_lz_offsets[1];
-                                       recent_lz_offsets[1] = recent_lz_offsets[0];
-                                       recent_lz_offsets[0] = pending_lz_offset;
-                                       pending_lz_offset = 0;
-                               }
-
-                               BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
                                if (!lzms_decode_bit(&rd, &lz_rep_states[0],
                                                     LZMS_NUM_LZ_REP_PROBS,
                                                     d->probs.lz_rep[0]))
                                {
-                                       offset = recent_lz_offsets[0];
-                                       recent_lz_offsets[0] = recent_lz_offsets[1];
-                                       recent_lz_offsets[1] = recent_lz_offsets[2];
-                                       recent_lz_offsets[2] = recent_lz_offsets[3];
+                                       offset = recent_lz_offsets[0 + (prev_item_type & 1)];
+                                       recent_lz_offsets[0 + (prev_item_type & 1)] = recent_lz_offsets[0];
                                } else if (!lzms_decode_bit(&rd, &lz_rep_states[1],
                                                            LZMS_NUM_LZ_REP_PROBS,
                                                            d->probs.lz_rep[1]))
                                {
-                                       offset = recent_lz_offsets[1];
-                                       recent_lz_offsets[1] = recent_lz_offsets[2];
-                                       recent_lz_offsets[2] = recent_lz_offsets[3];
+                                       offset = recent_lz_offsets[1 + (prev_item_type & 1)];
+                                       recent_lz_offsets[1 + (prev_item_type & 1)] = recent_lz_offsets[1];
+                                       recent_lz_offsets[1] = recent_lz_offsets[0];
                                } else {
-                                       offset = recent_lz_offsets[2];
-                                       recent_lz_offsets[2] = recent_lz_offsets[3];
+                                       offset = recent_lz_offsets[2 + (prev_item_type & 1)];
+                                       recent_lz_offsets[2 + (prev_item_type & 1)] = recent_lz_offsets[2];
+                                       recent_lz_offsets[2] = recent_lz_offsets[1];
+                                       recent_lz_offsets[1] = recent_lz_offsets[0];
                                }
                        }
-
-                       if (pending_lz_offset != 0) {
-                               BUILD_BUG_ON(LZMS_NUM_LZ_REPS != 3);
-                               recent_lz_offsets[3] = recent_lz_offsets[2];
-                               recent_lz_offsets[2] = recent_lz_offsets[1];
-                               recent_lz_offsets[1] = recent_lz_offsets[0];
-                               recent_lz_offsets[0] = pending_lz_offset;
-                       }
-                       pending_lz_offset = offset;
+                       recent_lz_offsets[0] = offset;
+                       prev_item_type = 1;
 
                        length = lzms_decode_length(d, &is);
 
@@ -854,8 +841,6 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
 
                        lz_copy(out_next, length, offset, out_end, LZMS_MIN_MATCH_LENGTH);
                        out_next += length;
-
-                       lz_offset_still_pending = out_next;
                } else {
                        /* Delta match  */
 
@@ -867,6 +852,9 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
                        u32 offset;
                        const u8 *matchptr;
                        u32 length;
+                       u64 pair;
+
+                       STATIC_ASSERT(LZMS_NUM_DELTA_REPS == 3);
 
                        if (!lzms_decode_bit(&rd, &delta_state,
                                             LZMS_NUM_DELTA_PROBS,
@@ -875,53 +863,37 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
                                /* Explicit offset  */
                                power = lzms_decode_delta_power(d, &is);
                                raw_offset = lzms_decode_delta_offset(d, &is);
-                       } else {
-                               /* Repeat offset  */
-                               u64 val;
 
-                               if (pending_delta_pair != 0 &&
-                                   out_next != delta_pair_still_pending)
-                               {
-                                       BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
-                                       recent_delta_pairs[3] = recent_delta_pairs[2];
-                                       recent_delta_pairs[2] = recent_delta_pairs[1];
-                                       recent_delta_pairs[1] = recent_delta_pairs[0];
-                                       recent_delta_pairs[0] = pending_delta_pair;
-                                       pending_delta_pair = 0;
-                               }
-
-                               BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
+                               pair = ((u64)power << 32) | raw_offset;
+                               recent_delta_pairs[3] = recent_delta_pairs[2];
+                               recent_delta_pairs[2] = recent_delta_pairs[1];
+                               recent_delta_pairs[1] = recent_delta_pairs[0];
+                       } else {
                                if (!lzms_decode_bit(&rd, &delta_rep_states[0],
                                                     LZMS_NUM_DELTA_REP_PROBS,
                                                     d->probs.delta_rep[0]))
                                {
-                                       val = recent_delta_pairs[0];
-                                       recent_delta_pairs[0] = recent_delta_pairs[1];
-                                       recent_delta_pairs[1] = recent_delta_pairs[2];
-                                       recent_delta_pairs[2] = recent_delta_pairs[3];
+                                       pair = recent_delta_pairs[0 + (prev_item_type >> 1)];
+                                       recent_delta_pairs[0 + (prev_item_type >> 1)] = recent_delta_pairs[0];
                                } else if (!lzms_decode_bit(&rd, &delta_rep_states[1],
                                                            LZMS_NUM_DELTA_REP_PROBS,
                                                            d->probs.delta_rep[1]))
                                {
-                                       val = recent_delta_pairs[1];
-                                       recent_delta_pairs[1] = recent_delta_pairs[2];
-                                       recent_delta_pairs[2] = recent_delta_pairs[3];
+                                       pair = recent_delta_pairs[1 + (prev_item_type >> 1)];
+                                       recent_delta_pairs[1 + (prev_item_type >> 1)] = recent_delta_pairs[1];
+                                       recent_delta_pairs[1] = recent_delta_pairs[0];
                                } else {
-                                       val = recent_delta_pairs[2];
-                                       recent_delta_pairs[2] = recent_delta_pairs[3];
+                                       pair = recent_delta_pairs[2 + (prev_item_type >> 1)];
+                                       recent_delta_pairs[2 + (prev_item_type >> 1)] = recent_delta_pairs[2];
+                                       recent_delta_pairs[2] = recent_delta_pairs[1];
+                                       recent_delta_pairs[1] = recent_delta_pairs[0];
                                }
-                               power = val >> 32;
-                               raw_offset = (u32)val;
-                       }
 
-                       if (pending_delta_pair != 0) {
-                               BUILD_BUG_ON(LZMS_NUM_DELTA_REPS != 3);
-                               recent_delta_pairs[3] = recent_delta_pairs[2];
-                               recent_delta_pairs[2] = recent_delta_pairs[1];
-                               recent_delta_pairs[1] = recent_delta_pairs[0];
-                               recent_delta_pairs[0] = pending_delta_pair;
+                               power = pair >> 32;
+                               raw_offset = (u32)pair;
                        }
-                       pending_delta_pair = raw_offset | ((u64)power << 32);
+                       recent_delta_pairs[0] = pair;
+                       prev_item_type = 2;
 
                        length = lzms_decode_length(d, &is);
 
@@ -951,8 +923,6 @@ lzms_decompress(const void * const restrict in, const size_t in_nbytes,
                                out_next++;
                                matchptr++;
                        } while (--length);
-
-                       delta_pair_still_pending = out_next;
                }
        }