Coverage Report

Created: 2026-01-20 07:37

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/zlib/inffast.c
Line
Count
Source
1
/* inffast.c -- fast decoding
2
 * Copyright (C) 1995-2025 Mark Adler
3
 * For conditions of distribution and use, see copyright notice in zlib.h
4
 */
5
6
#include "zutil.h"
7
#include "inftrees.h"
8
#include "inflate.h"
9
#include "inffast.h"
10
11
#ifdef ASMINF
12
#  pragma message("Assembler code may have bugs -- use at your own risk")
13
#else
14
15
/*
16
   Decode literal, length, and distance codes and write out the resulting
17
   literal and match bytes until either not enough input or output is
18
   available, an end-of-block is encountered, or a data error is encountered.
19
   When large enough input and output buffers are supplied to inflate(), for
20
   example, a 16K input buffer and a 64K output buffer, more than 95% of the
21
   inflate execution time is spent in this routine.
22
23
   Entry assumptions:
24
25
        state->mode == LEN
26
        strm->avail_in >= 6
27
        strm->avail_out >= 258
28
        start >= strm->avail_out
29
        state->bits < 8
30
31
   On return, state->mode is one of:
32
33
        LEN -- ran out of enough output space or enough available input
34
        TYPE -- reached end of block code, inflate() to interpret next block
35
        BAD -- error in block data
36
37
   Notes:
38
39
    - The maximum input bits used by a length/distance pair is 15 bits for the
40
      length code, 5 bits for the length extra, 15 bits for the distance code,
41
      and 13 bits for the distance extra.  This totals 48 bits, or six bytes.
42
      Therefore if strm->avail_in >= 6, then there is enough input to avoid
43
      checking for available input while decoding.
44
45
    - The maximum bytes that a single length/distance pair can output is 258
46
      bytes, which is the maximum length that can be coded.  inflate_fast()
47
      requires strm->avail_out >= 258 for each loop to avoid checking for
48
      output space.
49
 */
50
2.82M
void ZLIB_INTERNAL inflate_fast(z_streamp strm, unsigned start) {
51
2.82M
    struct inflate_state FAR *state;
52
2.82M
    z_const unsigned char FAR *in;      /* local strm->next_in */
53
2.82M
    z_const unsigned char FAR *last;    /* have enough input while in < last */
54
2.82M
    unsigned char FAR *out;     /* local strm->next_out */
55
2.82M
    unsigned char FAR *beg;     /* inflate()'s initial strm->next_out */
56
2.82M
    unsigned char FAR *end;     /* while out < end, enough space available */
57
#ifdef INFLATE_STRICT
58
    unsigned dmax;              /* maximum distance from zlib header */
59
#endif
60
2.82M
    unsigned wsize;             /* window size or zero if not using window */
61
2.82M
    unsigned whave;             /* valid bytes in the window */
62
2.82M
    unsigned wnext;             /* window write index */
63
2.82M
    unsigned char FAR *window;  /* allocated sliding window, if wsize != 0 */
64
2.82M
    unsigned long hold;         /* local strm->hold */
65
2.82M
    unsigned bits;              /* local strm->bits */
66
2.82M
    code const FAR *lcode;      /* local strm->lencode */
67
2.82M
    code const FAR *dcode;      /* local strm->distcode */
68
2.82M
    unsigned lmask;             /* mask for first level of length codes */
69
2.82M
    unsigned dmask;             /* mask for first level of distance codes */
70
2.82M
    code const *here;           /* retrieved table entry */
71
2.82M
    unsigned op;                /* code bits, operation, extra bits, or */
72
                                /*  window position, window bytes to copy */
73
2.82M
    unsigned len;               /* match length, unused bytes */
74
2.82M
    unsigned dist;              /* match distance */
75
2.82M
    unsigned char FAR *from;    /* where to copy match from */
76
77
    /* copy state to local variables */
78
2.82M
    state = (struct inflate_state FAR *)strm->state;
79
2.82M
    in = strm->next_in;
80
2.82M
    last = in + (strm->avail_in - 5);
81
2.82M
    out = strm->next_out;
82
2.82M
    beg = out - (start - strm->avail_out);
83
2.82M
    end = out + (strm->avail_out - 257);
84
#ifdef INFLATE_STRICT
85
    dmax = state->dmax;
86
#endif
87
2.82M
    wsize = state->wsize;
88
2.82M
    whave = state->whave;
89
2.82M
    wnext = state->wnext;
90
2.82M
    window = state->window;
91
2.82M
    hold = state->hold;
92
2.82M
    bits = state->bits;
93
2.82M
    lcode = state->lencode;
94
2.82M
    dcode = state->distcode;
95
2.82M
    lmask = (1U << state->lenbits) - 1;
96
2.82M
    dmask = (1U << state->distbits) - 1;
97
98
    /* decode literals and length/distances until end-of-block or not enough
99
       input data or output space */
100
163M
    do {
101
163M
        if (bits < 15) {
102
77.7M
            hold += (unsigned long)(*in++) << bits;
103
77.7M
            bits += 8;
104
77.7M
            hold += (unsigned long)(*in++) << bits;
105
77.7M
            bits += 8;
106
77.7M
        }
107
163M
        here = lcode + (hold & lmask);
108
170M
      dolen:
109
170M
        op = (unsigned)(here->bits);
110
170M
        hold >>= op;
111
170M
        bits -= op;
112
170M
        op = (unsigned)(here->op);
113
170M
        if (op == 0) {                          /* literal */
114
97.7M
            Tracevv((stderr, here->val >= 0x20 && here->val < 0x7f ?
115
97.7M
                    "inflate:         literal '%c'\n" :
116
97.7M
                    "inflate:         literal 0x%02x\n", here->val));
117
97.7M
            *out++ = (unsigned char)(here->val);
118
97.7M
        }
119
72.7M
        else if (op & 16) {                     /* length base */
120
65.2M
            len = (unsigned)(here->val);
121
65.2M
            op &= 15;                           /* number of extra bits */
122
65.2M
            if (op) {
123
17.5M
                if (bits < op) {
124
101k
                    hold += (unsigned long)(*in++) << bits;
125
101k
                    bits += 8;
126
101k
                }
127
17.5M
                len += (unsigned)hold & ((1U << op) - 1);
128
17.5M
                hold >>= op;
129
17.5M
                bits -= op;
130
17.5M
            }
131
65.2M
            Tracevv((stderr, "inflate:         length %u\n", len));
132
65.2M
            if (bits < 15) {
133
25.4M
                hold += (unsigned long)(*in++) << bits;
134
25.4M
                bits += 8;
135
25.4M
                hold += (unsigned long)(*in++) << bits;
136
25.4M
                bits += 8;
137
25.4M
            }
138
65.2M
            here = dcode + (hold & dmask);
139
71.4M
          dodist:
140
71.4M
            op = (unsigned)(here->bits);
141
71.4M
            hold >>= op;
142
71.4M
            bits -= op;
143
71.4M
            op = (unsigned)(here->op);
144
71.4M
            if (op & 16) {                      /* distance base */
145
65.2M
                dist = (unsigned)(here->val);
146
65.2M
                op &= 15;                       /* number of extra bits */
147
65.2M
                if (bits < op) {
148
435k
                    hold += (unsigned long)(*in++) << bits;
149
435k
                    bits += 8;
150
435k
                    if (bits < op) {
151
4.58k
                        hold += (unsigned long)(*in++) << bits;
152
4.58k
                        bits += 8;
153
4.58k
                    }
154
435k
                }
155
65.2M
                dist += (unsigned)hold & ((1U << op) - 1);
156
#ifdef INFLATE_STRICT
157
                if (dist > dmax) {
158
                    strm->msg = (z_const char *)
159
                        "invalid distance too far back";
160
                    state->mode = BAD;
161
                    break;
162
                }
163
#endif
164
65.2M
                hold >>= op;
165
65.2M
                bits -= op;
166
65.2M
                Tracevv((stderr, "inflate:         distance %u\n", dist));
167
65.2M
                op = (unsigned)(out - beg);     /* max distance in output */
168
65.2M
                if (dist > op) {                /* see if copy from window */
169
28.1M
                    op = dist - op;             /* distance back in window */
170
28.1M
                    if (op > whave) {
171
25.0k
                        if (state->sane) {
172
25.0k
                            strm->msg = (z_const char *)
173
25.0k
                                "invalid distance too far back";
174
25.0k
                            state->mode = BAD;
175
25.0k
                            break;
176
25.0k
                        }
177
#ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
178
                        if (len <= op - whave) {
179
                            do {
180
                                *out++ = 0;
181
                            } while (--len);
182
                            continue;
183
                        }
184
                        len -= op - whave;
185
                        do {
186
                            *out++ = 0;
187
                        } while (--op > whave);
188
                        if (op == 0) {
189
                            from = out - dist;
190
                            do {
191
                                *out++ = *from++;
192
                            } while (--len);
193
                            continue;
194
                        }
195
#endif
196
25.0k
                    }
197
28.1M
                    from = window;
198
28.1M
                    if (wnext == 0) {           /* very common case */
199
176k
                        from += wsize - op;
200
176k
                        if (op < len) {         /* some from window */
201
26.5k
                            len -= op;
202
2.46M
                            do {
203
2.46M
                                *out++ = *from++;
204
2.46M
                            } while (--op);
205
26.5k
                            from = out - dist;  /* rest from output */
206
26.5k
                        }
207
176k
                    }
208
27.9M
                    else if (wnext < op) {      /* wrap around window */
209
1.82M
                        from += wsize + wnext - op;
210
1.82M
                        op -= wnext;
211
1.82M
                        if (op < len) {         /* some from end of window */
212
29.4k
                            len -= op;
213
2.81M
                            do {
214
2.81M
                                *out++ = *from++;
215
2.81M
                            } while (--op);
216
29.4k
                            from = window;
217
29.4k
                            if (wnext < len) {  /* some from start of window */
218
8.45k
                                op = wnext;
219
8.45k
                                len -= op;
220
515k
                                do {
221
515k
                                    *out++ = *from++;
222
515k
                                } while (--op);
223
8.45k
                                from = out - dist;      /* rest from output */
224
8.45k
                            }
225
29.4k
                        }
226
1.82M
                    }
227
26.1M
                    else {                      /* contiguous in window */
228
26.1M
                        from += wnext - op;
229
26.1M
                        if (op < len) {         /* some from window */
230
712k
                            len -= op;
231
73.3M
                            do {
232
73.3M
                                *out++ = *from++;
233
73.3M
                            } while (--op);
234
712k
                            from = out - dist;  /* rest from output */
235
712k
                        }
236
26.1M
                    }
237
282M
                    while (len > 2) {
238
254M
                        *out++ = *from++;
239
254M
                        *out++ = *from++;
240
254M
                        *out++ = *from++;
241
254M
                        len -= 3;
242
254M
                    }
243
28.1M
                    if (len) {
244
4.25M
                        *out++ = *from++;
245
4.25M
                        if (len > 1)
246
1.97M
                            *out++ = *from++;
247
4.25M
                    }
248
28.1M
                }
249
37.1M
                else {
250
37.1M
                    from = out - dist;          /* copy direct from output */
251
813M
                    do {                        /* minimum length is three */
252
813M
                        *out++ = *from++;
253
813M
                        *out++ = *from++;
254
813M
                        *out++ = *from++;
255
813M
                        len -= 3;
256
813M
                    } while (len > 2);
257
37.1M
                    if (len) {
258
7.32M
                        *out++ = *from++;
259
7.32M
                        if (len > 1)
260
4.87M
                            *out++ = *from++;
261
7.32M
                    }
262
37.1M
                }
263
65.2M
            }
264
6.21M
            else if ((op & 64) == 0) {          /* 2nd level distance code */
265
6.20M
                here = dcode + here->val + (hold & ((1U << op) - 1));
266
6.20M
                goto dodist;
267
6.20M
            }
268
11.6k
            else {
269
11.6k
                strm->msg = (z_const char *)"invalid distance code";
270
11.6k
                state->mode = BAD;
271
11.6k
                break;
272
11.6k
            }
273
71.4M
        }
274
7.43M
        else if ((op & 64) == 0) {              /* 2nd level length code */
275
7.33M
            here = lcode + here->val + (hold & ((1U << op) - 1));
276
7.33M
            goto dolen;
277
7.33M
        }
278
101k
        else if (op & 32) {                     /* end-of-block */
279
97.1k
            Tracevv((stderr, "inflate:         end of block\n"));
280
97.1k
            state->mode = TYPE;
281
97.1k
            break;
282
97.1k
        }
283
4.71k
        else {
284
4.71k
            strm->msg = (z_const char *)"invalid literal/length code";
285
4.71k
            state->mode = BAD;
286
4.71k
            break;
287
4.71k
        }
288
170M
    } while (in < last && out < end);
289
290
    /* return unused bytes (on entry, bits < 8, so in won't go too far back) */
291
2.82M
    len = bits >> 3;
292
2.82M
    in -= len;
293
2.82M
    bits -= len << 3;
294
2.82M
    hold &= (1U << bits) - 1;
295
296
    /* update state and return */
297
2.82M
    strm->next_in = in;
298
2.82M
    strm->next_out = out;
299
2.82M
    strm->avail_in = (unsigned)(in < last ? 5 + (last - in) : 5 - (in - last));
300
2.82M
    strm->avail_out = (unsigned)(out < end ?
301
2.45M
                                 257 + (end - out) : 257 - (out - end));
302
2.82M
    state->hold = hold;
303
2.82M
    state->bits = bits;
304
2.82M
    return;
305
2.82M
}
306
307
/*
308
   inflate_fast() speedups that turned out slower (on a PowerPC G3 750CXe):
309
   - Using bit fields for code structure
310
   - Different op definition to avoid & for extra bits (do & for table bits)
311
   - Three separate decoding do-loops for direct, window, and wnext == 0
312
   - Special case for distance > 1 copies to do overlapped load and store copy
313
   - Explicit branch predictions (based on measured branch probabilities)
314
   - Deferring match copy and interspersed it with decoding subsequent codes
315
   - Swapping literal/length else
316
   - Swapping window/direct else
317
   - Larger unrolled copy loops (three is about right)
318
   - Moving len -= 3 statement into middle of loop
319
 */
320
321
#endif /* !ASMINF */