/src/zlib/inffast.c

Source
/* inffast.c -- fast decoding
 * Copyright (C) 1995-2025 Mark Adler
 * For conditions of distribution and use, see copyright notice in zlib.h
 */

#include "zutil.h"
#include "inftrees.h"
#include "inflate.h"
#include "inffast.h"

#ifdef ASMINF
#  pragma message("Assembler code may have bugs -- use at your own risk")
#else

/*
   Decode literal, length, and distance codes and write out the resulting
   literal and match bytes until either not enough input or output is
   available, an end-of-block is encountered, or a data error is encountered.
   When large enough input and output buffers are supplied to inflate(), for
   example, a 16K input buffer and a 64K output buffer, more than 95% of the
   inflate execution time is spent in this routine.

   Entry assumptions:

        state->mode == LEN
        strm->avail_in >= 6
        strm->avail_out >= 258
        start >= strm->avail_out
        state->bits < 8

   On return, state->mode is one of:

        LEN -- ran out of enough output space or enough available input
        TYPE -- reached end of block code, inflate() to interpret next block
        BAD -- error in block data

   Notes:

    - The maximum input bits used by a length/distance pair is 15 bits for the
      length code, 5 bits for the length extra, 15 bits for the distance code,
      and 13 bits for the distance extra.  This totals 48 bits, or six bytes.
      Therefore if strm->avail_in >= 6, then there is enough input to avoid
      checking for available input while decoding.

    - The maximum bytes that a single length/distance pair can output is 258
      bytes, which is the maximum length that can be coded.  inflate_fast()
      requires strm->avail_out >= 258 for each loop to avoid checking for
      output space.
 */
void ZLIB_INTERNAL inflate_fast(z_streamp strm, unsigned start) {
    struct inflate_state FAR *state;
    z_const unsigned char FAR *in;      /* local strm->next_in */
    z_const unsigned char FAR *last;    /* have enough input while in < last */
    unsigned char FAR *out;     /* local strm->next_out */
    unsigned char FAR *beg;     /* inflate()'s initial strm->next_out */
    unsigned char FAR *end;     /* while out < end, enough space available */
#ifdef INFLATE_STRICT
    unsigned dmax;              /* maximum distance from zlib header */
#endif
    unsigned wsize;             /* window size or zero if not using window */
    unsigned whave;             /* valid bytes in the window */
    unsigned wnext;             /* window write index */
    unsigned char FAR *window;  /* allocated sliding window, if wsize != 0 */
    unsigned long hold;         /* local strm->hold */
    unsigned bits;              /* local strm->bits */
    code const FAR *lcode;      /* local strm->lencode */
    code const FAR *dcode;      /* local strm->distcode */
    unsigned lmask;             /* mask for first level of length codes */
    unsigned dmask;             /* mask for first level of distance codes */
    code const *here;           /* retrieved table entry */
    unsigned op;                /* code bits, operation, extra bits, or */
                                /*  window position, window bytes to copy */
    unsigned len;               /* match length, unused bytes */
    unsigned dist;              /* match distance */
    unsigned char FAR *from;    /* where to copy match from */

    /* copy state to local variables */
    state = (struct inflate_state FAR *)strm->state;
    in = strm->next_in;
    last = in + (strm->avail_in - 5);
    out = strm->next_out;
    beg = out - (start - strm->avail_out);
    end = out + (strm->avail_out - 257);
#ifdef INFLATE_STRICT
    dmax = state->dmax;
#endif
    wsize = state->wsize;
    whave = state->whave;
    wnext = state->wnext;
    window = state->window;
    hold = state->hold;
    bits = state->bits;
    lcode = state->lencode;
    dcode = state->distcode;
    lmask = (1U << state->lenbits) - 1;
    dmask = (1U << state->distbits) - 1;

    /* decode literals and length/distances until end-of-block or not enough
       input data or output space */
    do {
        if (bits < 15) {
            hold += (unsigned long)(*in++) << bits;
            bits += 8;
            hold += (unsigned long)(*in++) << bits;
            bits += 8;
        }
        here = lcode + (hold & lmask);
      dolen:
        op = (unsigned)(here->bits);
        hold >>= op;
        bits -= op;
        op = (unsigned)(here->op);
        if (op == 0) {                          /* literal */
            Tracevv((stderr, here->val >= 0x20 && here->val < 0x7f ?
                    "inflate:         literal '%c'\n" :
                    "inflate:         literal 0x%02x\n", here->val));
            *out++ = (unsigned char)(here->val);
        }
        else if (op & 16) {                     /* length base */
            len = (unsigned)(here->val);
            op &= 15;                           /* number of extra bits */
            if (op) {
                if (bits < op) {
                    hold += (unsigned long)(*in++) << bits;
                    bits += 8;
                }
                len += (unsigned)hold & ((1U << op) - 1);
                hold >>= op;
                bits -= op;
            }
            Tracevv((stderr, "inflate:         length %u\n", len));
            if (bits < 15) {
                hold += (unsigned long)(*in++) << bits;
                bits += 8;
                hold += (unsigned long)(*in++) << bits;
                bits += 8;
            }
            here = dcode + (hold & dmask);
          dodist:
            op = (unsigned)(here->bits);
            hold >>= op;
            bits -= op;
            op = (unsigned)(here->op);
            if (op & 16) {                      /* distance base */
                dist = (unsigned)(here->val);
                op &= 15;                       /* number of extra bits */
                if (bits < op) {
                    hold += (unsigned long)(*in++) << bits;
                    bits += 8;
                    if (bits < op) {
                        hold += (unsigned long)(*in++) << bits;
                        bits += 8;
                    }
                }
                dist += (unsigned)hold & ((1U << op) - 1);
#ifdef INFLATE_STRICT
                if (dist > dmax) {
                    strm->msg = (z_const char *)
                        "invalid distance too far back";
                    state->mode = BAD;
                    break;
                }
#endif
                hold >>= op;
                bits -= op;
                Tracevv((stderr, "inflate:         distance %u\n", dist));
                op = (unsigned)(out - beg);     /* max distance in output */
                if (dist > op) {                /* see if copy from window */
                    op = dist - op;             /* distance back in window */
                    if (op > whave) {
                        if (state->sane) {
                            strm->msg = (z_const char *)
                                "invalid distance too far back";
                            state->mode = BAD;
                            break;
                        }
#ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR
                        if (len <= op - whave) {
                            do {
                                *out++ = 0;
                            } while (--len);
                            continue;
                        }
                        len -= op - whave;
                        do {
                            *out++ = 0;
                        } while (--op > whave);
                        if (op == 0) {
                            from = out - dist;
                            do {
                                *out++ = *from++;
                            } while (--len);
                            continue;
                        }
#endif
                    }
                    from = window;
                    if (wnext == 0) {           /* very common case */
                        from += wsize - op;
                        if (op < len) {         /* some from window */
                            len -= op;
                            do {
                                *out++ = *from++;
                            } while (--op);
                            from = out - dist;  /* rest from output */
                        }
                    }
                    else if (wnext < op) {      /* wrap around window */
                        from += wsize + wnext - op;
                        op -= wnext;
                        if (op < len) {         /* some from end of window */
                            len -= op;
                            do {
                                *out++ = *from++;
                            } while (--op);
                            from = window;
                            if (wnext < len) {  /* some from start of window */
                                op = wnext;
                                len -= op;
                                do {
                                    *out++ = *from++;
                                } while (--op);
                                from = out - dist;      /* rest from output */
                            }
                        }
                    }
                    else {                      /* contiguous in window */
                        from += wnext - op;
                        if (op < len) {         /* some from window */
                            len -= op;
                            do {
                                *out++ = *from++;
                            } while (--op);
                            from = out - dist;  /* rest from output */
                        }
                    }
                    while (len > 2) {
                        *out++ = *from++;
                        *out++ = *from++;
                        *out++ = *from++;
                        len -= 3;
                    }
                    if (len) {
                        *out++ = *from++;
                        if (len > 1)
                            *out++ = *from++;
                    }
                }
                else {
                    from = out - dist;          /* copy direct from output */
                    do {                        /* minimum length is three */
                        *out++ = *from++;
                        *out++ = *from++;
                        *out++ = *from++;
                        len -= 3;
                    } while (len > 2);
                    if (len) {
                        *out++ = *from++;
                        if (len > 1)
                            *out++ = *from++;
                    }
                }
            }
            else if ((op & 64) == 0) {          /* 2nd level distance code */
                here = dcode + here->val + (hold & ((1U << op) - 1));
                goto dodist;
            }
            else {
                strm->msg = (z_const char *)"invalid distance code";
                state->mode = BAD;
                break;
            }
        }
        else if ((op & 64) == 0) {              /* 2nd level length code */
            here = lcode + here->val + (hold & ((1U << op) - 1));
            goto dolen;
        }
        else if (op & 32) {                     /* end-of-block */
            Tracevv((stderr, "inflate:         end of block\n"));
            state->mode = TYPE;
            break;
        }
        else {
            strm->msg = (z_const char *)"invalid literal/length code";
            state->mode = BAD;
            break;
        }
    } while (in < last && out < end);

    /* return unused bytes (on entry, bits < 8, so in won't go too far back) */
    len = bits >> 3;
    in -= len;
    bits -= len << 3;
    hold &= (1U << bits) - 1;

    /* update state and return */
    strm->next_in = in;
    strm->next_out = out;
    strm->avail_in = (unsigned)(in < last ? 5 + (last - in) : 5 - (in - last));
    strm->avail_out = (unsigned)(out < end ?
                                 257 + (end - out) : 257 - (out - end));
    state->hold = hold;
    state->bits = bits;
    return;
}

/*
   inflate_fast() speedups that turned out slower (on a PowerPC G3 750CXe):
   - Using bit fields for code structure
   - Different op definition to avoid & for extra bits (do & for table bits)
   - Three separate decoding do-loops for direct, window, and wnext == 0
   - Special case for distance > 1 copies to do overlapped load and store copy
   - Explicit branch predictions (based on measured branch probabilities)
   - Deferring match copy and interspersed it with decoding subsequent codes
   - Swapping literal/length else
   - Swapping window/direct else
   - Larger unrolled copy loops (three is about right)
   - Moving len -= 3 statement into middle of loop
 */

#endif /* !ASMINF */

Coverage Report

Created: 2025-12-31 07:15

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	27.8k	void ZLIB_INTERNAL inflate_fast(z_streamp strm, unsigned start) {
51	27.8k	struct inflate_state FAR *state;
52	27.8k	z_const unsigned char FAR in; / local strm->next_in */
53	27.8k	z_const unsigned char FAR last; / have enough input while in < last */
54	27.8k	unsigned char FAR out; / local strm->next_out */
55	27.8k	unsigned char FAR beg; / inflate()'s initial strm->next_out */
56	27.8k	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	27.8k	unsigned wsize; /* window size or zero if not using window */
61	27.8k	unsigned whave; /* valid bytes in the window */
62	27.8k	unsigned wnext; /* window write index */
63	27.8k	unsigned char FAR window; / allocated sliding window, if wsize != 0 */
64	27.8k	unsigned long hold; /* local strm->hold */
65	27.8k	unsigned bits; /* local strm->bits */
66	27.8k	code const FAR lcode; / local strm->lencode */
67	27.8k	code const FAR dcode; / local strm->distcode */
68	27.8k	unsigned lmask; /* mask for first level of length codes */
69	27.8k	unsigned dmask; /* mask for first level of distance codes */
70	27.8k	code const here; / retrieved table entry */
71	27.8k	unsigned op; /* code bits, operation, extra bits, or */
72		/* window position, window bytes to copy */
73	27.8k	unsigned len; /* match length, unused bytes */
74	27.8k	unsigned dist; /* match distance */
75	27.8k	unsigned char FAR from; / where to copy match from */
76
77		/* copy state to local variables */
78	27.8k	state = (struct inflate_state FAR *)strm->state;
79	27.8k	in = strm->next_in;
80	27.8k	last = in + (strm->avail_in - 5);
81	27.8k	out = strm->next_out;
82	27.8k	beg = out - (start - strm->avail_out);
83	27.8k	end = out + (strm->avail_out - 257);
84		#ifdef INFLATE_STRICT
85		dmax = state->dmax;
86		#endif
87	27.8k	wsize = state->wsize;
88	27.8k	whave = state->whave;
89	27.8k	wnext = state->wnext;
90	27.8k	window = state->window;
91	27.8k	hold = state->hold;
92	27.8k	bits = state->bits;
93	27.8k	lcode = state->lencode;
94	27.8k	dcode = state->distcode;
95	27.8k	lmask = (1U << state->lenbits) - 1;
96	27.8k	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	3.50M	do {
101	3.50M	if (bits < 15) {
102	1.35M	hold += (unsigned long)(*in++) << bits;
103	1.35M	bits += 8;
104	1.35M	hold += (unsigned long)(*in++) << bits;
105	1.35M	bits += 8;
106	1.35M	}
107	3.50M	here = lcode + (hold & lmask);
108	3.99M	dolen:
109	3.99M	op = (unsigned)(here->bits);
110	3.99M	hold >>= op;
111	3.99M	bits -= op;
112	3.99M	op = (unsigned)(here->op);
113	3.99M	if (op == 0) { /* literal */
114	1.59M	Tracevv((stderr, here->val >= 0x20 && here->val < 0x7f ?
115	1.59M	"inflate: literal '%c'\n" :
116	1.59M	"inflate: literal 0x%02x\n", here->val));
117	1.59M	*out++ = (unsigned char)(here->val);
118	1.59M	}
119	2.40M	else if (op & 16) { /* length base */
120	1.91M	len = (unsigned)(here->val);
121	1.91M	op &= 15; /* number of extra bits */
122	1.91M	if (op) {
123	255k	if (bits < op) {
124	0	hold += (unsigned long)(*in++) << bits;
125	0	bits += 8;
126	0	}
127	255k	len += (unsigned)hold & ((1U << op) - 1);
128	255k	hold >>= op;
129	255k	bits -= op;
130	255k	}
131	1.91M	Tracevv((stderr, "inflate: length %u\n", len));
132	1.91M	if (bits < 15) {
133	1.01M	hold += (unsigned long)(*in++) << bits;
134	1.01M	bits += 8;
135	1.01M	hold += (unsigned long)(*in++) << bits;
136	1.01M	bits += 8;
137	1.01M	}
138	1.91M	here = dcode + (hold & dmask);
139	1.97M	dodist:
140	1.97M	op = (unsigned)(here->bits);
141	1.97M	hold >>= op;
142	1.97M	bits -= op;
143	1.97M	op = (unsigned)(here->op);
144	1.97M	if (op & 16) { /* distance base */
145	1.91M	dist = (unsigned)(here->val);
146	1.91M	op &= 15; /* number of extra bits */
147	1.91M	if (bits < op) {
148	260	hold += (unsigned long)(*in++) << bits;
149	260	bits += 8;
150	260	if (bits < op) {
151	0	hold += (unsigned long)(*in++) << bits;
152	0	bits += 8;
153	0	}
154	260	}
155	1.91M	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	1.91M	hold >>= op;
165	1.91M	bits -= op;
166	1.91M	Tracevv((stderr, "inflate: distance %u\n", dist));
167	1.91M	op = (unsigned)(out - beg); /* max distance in output */
168	1.91M	if (dist > op) { /* see if copy from window */
169	502k	op = dist - op; /* distance back in window */
170	502k	if (op > whave) {
171	196	if (state->sane) {
172	196	strm->msg = (z_const char *)
173	196	"invalid distance too far back";
174	196	state->mode = BAD;
175	196	break;
176	196	}
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	196	}
197	502k	from = window;
198	502k	if (wnext == 0) { /* very common case */
199	8.15k	from += wsize - op;
200	8.15k	if (op < len) { /* some from window */
201	906	len -= op;
202	37.4k	do {
203	37.4k	out++ = from++;
204	37.4k	} while (--op);
205	906	from = out - dist; /* rest from output */
206	906	}
207	8.15k	}
208	493k	else if (wnext < op) { /* wrap around window */
209	34.4k	from += wsize + wnext - op;
210	34.4k	op -= wnext;
211	34.4k	if (op < len) { /* some from end of window */
212	2.09k	len -= op;
213	158k	do {
214	158k	out++ = from++;
215	158k	} while (--op);
216	2.09k	from = window;
217	2.09k	if (wnext < len) { /* some from start of window */
218	405	op = wnext;
219	405	len -= op;
220	53.4k	do {
221	53.4k	out++ = from++;
222	53.4k	} while (--op);
223	405	from = out - dist; /* rest from output */
224	405	}
225	2.09k	}
226	34.4k	}
227	459k	else { /* contiguous in window */
228	459k	from += wnext - op;
229	459k	if (op < len) { /* some from window */
230	14.4k	len -= op;
231	696k	do {
232	696k	out++ = from++;
233	696k	} while (--op);
234	14.4k	from = out - dist; /* rest from output */
235	14.4k	}
236	459k	}
237	2.37M	while (len > 2) {
238	1.87M	out++ = from++;
239	1.87M	out++ = from++;
240	1.87M	out++ = from++;
241	1.87M	len -= 3;
242	1.87M	}
243	502k	if (len) {
244	272k	out++ = from++;
245	272k	if (len > 1)
246	126k	out++ = from++;
247	272k	}
248	502k	}
249	1.41M	else {
250	1.41M	from = out - dist; /* copy direct from output */
251	10.1M	do { /* minimum length is three */
252	10.1M	out++ = from++;
253	10.1M	out++ = from++;
254	10.1M	out++ = from++;
255	10.1M	len -= 3;
256	10.1M	} while (len > 2);
257	1.41M	if (len) {
258	433k	out++ = from++;
259	433k	if (len > 1)
260	194k	out++ = from++;
261	433k	}
262	1.41M	}
263	1.91M	}
264	62.9k	else if ((op & 64) == 0) { /* 2nd level distance code */
265	62.8k	here = dcode + here->val + (hold & ((1U << op) - 1));
266	62.8k	goto dodist;
267	62.8k	}
268	126	else {
269	126	strm->msg = (z_const char *)"invalid distance code";
270	126	state->mode = BAD;
271	126	break;
272	126	}
273	1.97M	}
274	486k	else if ((op & 64) == 0) { /* 2nd level length code */
275	485k	here = lcode + here->val + (hold & ((1U << op) - 1));
276	485k	goto dolen;
277	485k	}
278	729	else if (op & 32) { /* end-of-block */
279	716	Tracevv((stderr, "inflate: end of block\n"));
280	716	state->mode = TYPE;
281	716	break;
282	716	}
283	13	else {
284	13	strm->msg = (z_const char *)"invalid literal/length code";
285	13	state->mode = BAD;
286	13	break;
287	13	}
288	3.99M	} while (in < last && out < end);
289
290		/* return unused bytes (on entry, bits < 8, so in won't go too far back) */
291	27.8k	len = bits >> 3;
292	27.8k	in -= len;
293	27.8k	bits -= len << 3;
294	27.8k	hold &= (1U << bits) - 1;
295
296		/* update state and return */
297	27.8k	strm->next_in = in;
298	27.8k	strm->next_out = out;
299	27.8k	strm->avail_in = (unsigned)(in < last ? 5 + (last - in) : 5 - (in - last));
300	27.8k	strm->avail_out = (unsigned)(out < end ?
301	22.1k	257 + (end - out) : 257 - (out - end));
302	27.8k	state->hold = hold;
303	27.8k	state->bits = bits;
304	27.8k	return;
305	27.8k	}
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 */