Coverage Report

Created: 2026-02-24 06:17

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/zlib-ng/inffast_tpl.h
Line
Count
Source
1
/* inffast.c -- fast decoding
2
 * Copyright (C) 1995-2017 Mark Adler
3
 * For conditions of distribution and use, see copyright notice in zlib.h
4
 */
5
6
#include "zbuild.h"
7
#include "zutil.h"
8
#include "inftrees.h"
9
#include "inflate.h"
10
#include "inflate_p.h"
11
#include "functable.h"
12
13
/*
14
   Decode literal, length, and distance codes and write out the resulting
15
   literal and match bytes until either not enough input or output is
16
   available, an end-of-block is encountered, or a data error is encountered.
17
   When large enough input and output buffers are supplied to inflate(), for
18
   example, a 16K input buffer and a 64K output buffer, more than 95% of the
19
   inflate execution time is spent in this routine.
20
21
   Entry assumptions:
22
23
        state->mode == LEN
24
        strm->avail_in >= INFLATE_FAST_MIN_HAVE
25
        strm->avail_out >= INFLATE_FAST_MIN_LEFT
26
        start >= strm->avail_out
27
        state->bits < 8
28
29
   On return, state->mode is one of:
30
31
        LEN -- ran out of enough output space or enough available input
32
        TYPE -- reached end of block code, inflate() to interpret next block
33
        BAD -- error in block data
34
35
   Notes:
36
37
    - The maximum input bits used by a length/distance pair is 15 bits for the
38
      length code, 5 bits for the length extra, 15 bits for the distance code,
39
      and 13 bits for the distance extra.  This totals 48 bits, or six bytes.
40
      Therefore if strm->avail_in >= 6, then there is enough input to avoid
41
      checking for available input while decoding.
42
43
    - On some architectures, it can be significantly faster (e.g. up to 1.2x
44
      faster on x86_64) to load from strm->next_in 64 bits, or 8 bytes, at a
45
      time, so INFLATE_FAST_MIN_HAVE == 8.
46
47
    - The maximum bytes that a single length/distance pair can output is 258
48
      bytes, which is the maximum length that can be coded.  inflate_fast()
49
      requires strm->avail_out >= 258 for each loop to avoid checking for
50
      output space.
51
 */
52
0
void Z_INTERNAL INFLATE_FAST(PREFIX3(stream) *strm, uint32_t start) {
53
    /* start: inflate()'s starting value for strm->avail_out */
54
0
    struct inflate_state *state;
55
0
    z_const unsigned char *in;  /* local strm->next_in */
56
0
    const unsigned char *last;  /* have enough input while in < last */
57
0
    unsigned char *out;         /* local strm->next_out */
58
0
    unsigned char *beg;         /* inflate()'s initial strm->next_out */
59
0
    unsigned char *end;         /* while out < end, enough space available */
60
0
    unsigned char *safe;        /* can use chunkcopy provided out < safe */
61
0
    unsigned char *window;      /* allocated sliding window, if wsize != 0 */
62
0
    unsigned wsize;             /* window size or zero if not using window */
63
0
    unsigned whave;             /* valid bytes in the window */
64
0
    unsigned wnext;             /* window write index */
65
66
    /* hold is a local copy of strm->hold. By default, hold satisfies the same
67
       invariants that strm->hold does, namely that (hold >> bits) == 0. This
68
       invariant is kept by loading bits into hold one byte at a time, like:
69
70
       hold |= next_byte_of_input << bits; in++; bits += 8;
71
72
       If we need to ensure that bits >= 15 then this code snippet is simply
73
       repeated. Over one iteration of the outermost do/while loop, this
74
       happens up to six times (48 bits of input), as described in the NOTES
75
       above.
76
77
       However, on some little endian architectures, it can be significantly
78
       faster to load 64 bits once instead of 8 bits six times:
79
80
       if (bits <= 16) {
81
         hold |= next_8_bytes_of_input << bits; in += 6; bits += 48;
82
       }
83
84
       Unlike the simpler one byte load, shifting the next_8_bytes_of_input
85
       by bits will overflow and lose those high bits, up to 2 bytes' worth.
86
       The conservative estimate is therefore that we have read only 6 bytes
87
       (48 bits). Again, as per the NOTES above, 48 bits is sufficient for the
88
       rest of the iteration, and we will not need to load another 8 bytes.
89
90
       Inside this function, we no longer satisfy (hold >> bits) == 0, but
91
       this is not problematic, even if that overflow does not land on an 8 bit
92
       byte boundary. Those excess bits will eventually shift down lower as the
93
       Huffman decoder consumes input, and when new input bits need to be loaded
94
       into the bits variable, the same input bits will be or'ed over those
95
       existing bits. A bitwise or is idempotent: (a | b | b) equals (a | b).
96
       Note that we therefore write that load operation as "hold |= etc" and not
97
       "hold += etc".
98
99
       Outside that loop, at the end of the function, hold is bitwise and'ed
100
       with (1<<bits)-1 to drop those excess bits so that, on function exit, we
101
       keep the invariant that (state->hold >> state->bits) == 0.
102
    */
103
0
    bits_t bits;                /* local strm->bits */
104
0
    uint64_t hold;              /* local strm->hold */
105
0
    unsigned lmask;             /* mask for first level of length codes */
106
0
    unsigned dmask;             /* mask for first level of distance codes */
107
0
    code const *lcode;          /* local strm->lencode */
108
0
    code const *dcode;          /* local strm->distcode */
109
0
    code here;                  /* retrieved table entry */
110
0
    unsigned op;                /* code bits, operation, extra bits, or */
111
                                /*  window position, window bytes to copy */
112
0
    unsigned len;               /* match length, unused bytes */
113
0
    unsigned char *from;        /* where to copy match from */
114
0
    unsigned dist;              /* match distance */
115
0
    unsigned extra_safe;        /* copy chunks safely in all cases */
116
0
    uint64_t old;               /* look-behind buffer for extra bits */
117
118
    /* copy state to local variables */
119
0
    state = (struct inflate_state *)strm->state;
120
0
    in = strm->next_in;
121
0
    last = in + (strm->avail_in - (INFLATE_FAST_MIN_HAVE - 1));
122
0
    out = strm->next_out;
123
0
    beg = out - (start - strm->avail_out);
124
0
    end = out + (strm->avail_out - (INFLATE_FAST_MIN_LEFT - 1));
125
0
    safe = out + strm->avail_out;
126
0
    wsize = state->wsize;
127
0
    whave = state->whave;
128
0
    wnext = state->wnext;
129
0
    window = state->window;
130
0
    hold = state->hold;
131
0
    bits = (bits_t)state->bits;
132
0
    lcode = state->lencode;
133
0
    dcode = state->distcode;
134
0
    lmask = (1U << state->lenbits) - 1;
135
0
    dmask = (1U << state->distbits) - 1;
136
137
    /* Detect if out and window point to the same memory allocation. In this instance it is
138
       necessary to use safe chunk copy functions to prevent overwriting the window. If the
139
       window is overwritten then future matches with far distances will fail to copy correctly. */
140
0
    extra_safe = (wsize != 0 && out >= window && out + INFLATE_FAST_MIN_LEFT <= window + state->wbufsize);
141
142
    /* decode literals and length/distances until end-of-block or not enough
143
       input data or output space */
144
0
    do {
145
0
        REFILL();
146
0
        here = lcode[hold & lmask];
147
0
        Z_TOUCH(here);
148
0
        old = hold;
149
0
        DROPBITS(here.bits);
150
0
        if (LIKELY(here.op == 0)) {
151
0
            TRACE_LITERAL(here.val);
152
0
            *out++ = (unsigned char)(here.val);
153
0
            here = lcode[hold & lmask];
154
0
            Z_TOUCH(here);
155
0
            old = hold;
156
0
            DROPBITS(here.bits);
157
0
            if (LIKELY(here.op == 0)) {
158
0
                TRACE_LITERAL(here.val);
159
0
                *out++ = (unsigned char)(here.val);
160
0
                here = lcode[hold & lmask];
161
0
                Z_TOUCH(here);
162
0
            dolen:
163
0
                old = hold;
164
0
                DROPBITS(here.bits);
165
0
                if (LIKELY(here.op == 0)) {
166
0
                    TRACE_LITERAL(here.val);
167
0
                    *out++ = (unsigned char)(here.val);
168
0
                    continue;
169
0
                }
170
0
            }
171
0
        }
172
0
        op = here.op;
173
0
        if (LIKELY(op & 16)) {                  /* length base */
174
0
            len = here.val + EXTRA_BITS(old, here, op);
175
0
            TRACE_LENGTH(len);
176
0
            here = dcode[hold & dmask];
177
0
            Z_TOUCH(here);
178
0
            if (UNLIKELY(bits < MAX_BITS + MAX_DIST_EXTRA_BITS)) {
179
0
                REFILL();
180
0
            }
181
0
          dodist:
182
0
            old = hold;
183
0
            DROPBITS(here.bits);
184
0
            op = here.op;
185
0
            if (LIKELY(op & 16)) {              /* distance base */
186
0
                dist = here.val + EXTRA_BITS(old, here, op);
187
#ifdef INFLATE_STRICT
188
                if (UNLIKELY(dist > state->dmax)) {
189
                    SET_BAD("invalid distance too far back");
190
                    break;
191
                }
192
#endif
193
0
                TRACE_DISTANCE(dist);
194
0
                op = (unsigned)(out - beg);     /* max distance in output */
195
0
                if (UNLIKELY(dist > op)) {      /* see if copy from window */
196
0
                    op = dist - op;             /* distance back in window */
197
0
                    if (UNLIKELY(op > whave)) {
198
#ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
199
                        if (LIKELY(state->sane)) {
200
                            SET_BAD("invalid distance too far back");
201
                            break;
202
                        }
203
                        unsigned gap = op - whave;
204
                        unsigned zeros = MIN(len, gap);
205
                        memset(out, 0, zeros);  /* fill missing bytes with zeros */
206
                        out += zeros;
207
                        len -= zeros;
208
                        if (UNLIKELY(len == 0))
209
                            continue;
210
                        op = whave;
211
                        if (UNLIKELY(op == 0)) {/* copy from already-decoded output */
212
                            out = chunkcopy_safe(out, out - dist, len, safe);
213
                            continue;
214
                        }
215
#else
216
0
                        SET_BAD("invalid distance too far back");
217
0
                        break;
218
0
#endif
219
0
                    }
220
0
                    from = window;
221
0
                    if (LIKELY(wnext == 0)) {           /* very common case */
222
0
                        from += wsize - op;
223
0
                    } else if (LIKELY(wnext >= op)) {   /* contiguous in window */
224
0
                        from += wnext - op;
225
0
                    } else {                            /* wrap around window */
226
0
                        op -= wnext;
227
0
                        from += wsize - op;
228
0
                        if (UNLIKELY(op < len)) {       /* some from end of window */
229
0
                            len -= op;
230
0
                            out = CHUNKCOPY_SAFE(out, from, op, safe);
231
0
                            from = window;              /* more from start of window */
232
0
                            op = wnext;
233
                            /* This (rare) case can create a situation where
234
                               the first chunkcopy below must be checked.
235
                             */
236
0
                        }
237
0
                    }
238
0
                    if (UNLIKELY(op < len)) {           /* still need some from output */
239
0
                        len -= op;
240
0
                        if (LIKELY(!extra_safe)) {
241
0
                            out = CHUNKCOPY_SAFE(out, from, op, safe);
242
0
                            out = CHUNKUNROLL(out, &dist, &len);
243
0
                            out = CHUNKCOPY_SAFE(out, out - dist, len, safe);
244
0
                        } else {
245
0
                            out = chunkcopy_safe(out, from, op, safe);
246
0
                            out = chunkcopy_safe(out, out - dist, len, safe);
247
0
                        }
248
0
                    } else {
249
#ifndef HAVE_MASKED_READWRITE
250
0
                        if (UNLIKELY(extra_safe))
251
0
                            out = chunkcopy_safe(out, from, len, safe);
252
0
                        else
253
0
#endif
254
0
                            out = CHUNKCOPY_SAFE(out, from, len, safe);
255
0
                    }
256
#ifndef HAVE_MASKED_READWRITE
257
0
                } else if (UNLIKELY(extra_safe)) {
258
                    /* Whole reference is in range of current output. */
259
                        out = chunkcopy_safe(out, out - dist, len, safe);
260
#endif
261
0
                } else {
262
                    /* Whole reference is in range of current output.  No range checks are
263
                       necessary because we start with room for at least 258 bytes of output,
264
                       so unroll and roundoff operations can write beyond `out+len` so long
265
                       as they stay within 258 bytes of `out`.
266
                    */
267
0
                    if (LIKELY(dist >= len || dist >= CHUNKSIZE()))
268
0
                        out = CHUNKCOPY(out, out - dist, len);
269
0
                    else
270
0
                        out = CHUNKMEMSET(out, out - dist, len);
271
0
                }
272
0
            } else if (UNLIKELY((op & 64) == 0)) {          /* 2nd level distance code */
273
0
                here = dcode[here.val + BITS(op)];
274
0
                Z_TOUCH(here);
275
0
                goto dodist;
276
0
            } else {
277
0
                SET_BAD("invalid distance code");
278
0
                break;
279
0
            }
280
0
        } else if (UNLIKELY((op & 64) == 0)) {              /* 2nd level length code */
281
0
            here = lcode[here.val + BITS(op)];
282
0
            Z_TOUCH(here);
283
0
            goto dolen;
284
0
        } else if (UNLIKELY(op & 32)) {                     /* end-of-block */
285
0
            TRACE_END_OF_BLOCK();
286
0
            state->mode = TYPE;
287
0
            break;
288
0
        } else {
289
0
            SET_BAD("invalid literal/length code");
290
0
            break;
291
0
        }
292
0
    } while (in < last && out < end);
293
294
    /* return unused bytes (on entry, bits < 8, so in won't go too far back) */
295
0
    len = bits >> 3;
296
0
    in -= len;
297
0
    bits -= (bits_t)(len << 3);
298
0
    hold &= (UINT64_C(1) << bits) - 1;
299
300
    /* update state and return */
301
0
    strm->next_in = in;
302
0
    strm->next_out = out;
303
0
    strm->avail_in = (unsigned)(in < last ? (INFLATE_FAST_MIN_HAVE - 1) + (last - in)
304
0
                                          : (INFLATE_FAST_MIN_HAVE - 1) - (in - last));
305
0
    strm->avail_out = (unsigned)(out < end ? (INFLATE_FAST_MIN_LEFT - 1) + (end - out)
306
0
                                           : (INFLATE_FAST_MIN_LEFT - 1) - (out - end));
307
308
0
    Assert(bits <= 32, "Remaining bits greater than 32");
309
0
    state->hold = (uint32_t)hold;
310
0
    state->bits = bits;
311
0
    return;
312
0
}
Unexecuted instantiation: inflate_fast_sse2
Unexecuted instantiation: inflate_fast_ssse3
Unexecuted instantiation: inflate_fast_avx2
Unexecuted instantiation: inflate_fast_avx512
313
314
/*
315
   inflate_fast() speedups that turned out slower (on a PowerPC G3 750CXe):
316
   - Using bit fields for code structure
317
   - Different op definition to avoid & for extra bits (do & for table bits)
318
   - Three separate decoding do-loops for direct, window, and wnext == 0
319
   - Special case for distance > 1 copies to do overlapped load and store copy
320
   - Explicit branch predictions (based on measured branch probabilities)
321
   - Deferring match copy and interspersed it with decoding subsequent codes
322
   - Swapping literal/length else
323
   - Swapping window/direct else
324
   - Larger unrolled copy loops (three is about right)
325
   - Moving len -= 3 statement into middle of loop
326
 */
327
328
 // Cleanup
329
#undef CHUNKCOPY
330
#undef CHUNKMEMSET
331
#undef CHUNKMEMSET_SAFE
332
#undef CHUNKSIZE
333
#undef CHUNKUNROLL
334
#undef HAVE_CHUNKCOPY
335
#undef HAVE_CHUNKMEMSET_2
336
#undef HAVE_CHUNKMEMSET_4
337
#undef HAVE_CHUNKMEMSET_8
338
#undef HAVE_CHUNKMEMSET_16
339
#undef HAVE_CHUNK_MAG
340
#undef HAVE_HALFCHUNKCOPY
341
#undef HAVE_HALF_CHUNK
342
#undef HAVE_MASKED_READWRITE
343
#undef INFLATE_FAST