Line | Count | Source (jump to first uncovered line) |
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 "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.44k | void ZLIB_INTERNAL inflate_fast(z_streamp strm, unsigned start) { |
51 | 2.44k | struct inflate_state FAR *state; |
52 | 2.44k | z_const unsigned char FAR *in; /* local strm->next_in */ |
53 | 2.44k | z_const unsigned char FAR *last; /* have enough input while in < last */ |
54 | 2.44k | unsigned char FAR *out; /* local strm->next_out */ |
55 | 2.44k | unsigned char FAR *beg; /* inflate()'s initial strm->next_out */ |
56 | 2.44k | 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.44k | unsigned wsize; /* window size or zero if not using window */ |
61 | 2.44k | unsigned whave; /* valid bytes in the window */ |
62 | 2.44k | unsigned wnext; /* window write index */ |
63 | 2.44k | unsigned char FAR *window; /* allocated sliding window, if wsize != 0 */ |
64 | 2.44k | unsigned long hold; /* local strm->hold */ |
65 | 2.44k | unsigned bits; /* local strm->bits */ |
66 | 2.44k | code const FAR *lcode; /* local strm->lencode */ |
67 | 2.44k | code const FAR *dcode; /* local strm->distcode */ |
68 | 2.44k | unsigned lmask; /* mask for first level of length codes */ |
69 | 2.44k | unsigned dmask; /* mask for first level of distance codes */ |
70 | 2.44k | code const *here; /* retrieved table entry */ |
71 | 2.44k | unsigned op; /* code bits, operation, extra bits, or */ |
72 | | /* window position, window bytes to copy */ |
73 | 2.44k | unsigned len; /* match length, unused bytes */ |
74 | 2.44k | unsigned dist; /* match distance */ |
75 | 2.44k | unsigned char FAR *from; /* where to copy match from */ |
76 | | |
77 | | /* copy state to local variables */ |
78 | 2.44k | state = (struct inflate_state FAR *)strm->state; |
79 | 2.44k | in = strm->next_in; |
80 | 2.44k | last = in + (strm->avail_in - 5); |
81 | 2.44k | out = strm->next_out; |
82 | 2.44k | beg = out - (start - strm->avail_out); |
83 | 2.44k | end = out + (strm->avail_out - 257); |
84 | | #ifdef INFLATE_STRICT |
85 | | dmax = state->dmax; |
86 | | #endif |
87 | 2.44k | wsize = state->wsize; |
88 | 2.44k | whave = state->whave; |
89 | 2.44k | wnext = state->wnext; |
90 | 2.44k | window = state->window; |
91 | 2.44k | hold = state->hold; |
92 | 2.44k | bits = state->bits; |
93 | 2.44k | lcode = state->lencode; |
94 | 2.44k | dcode = state->distcode; |
95 | 2.44k | lmask = (1U << state->lenbits) - 1; |
96 | 2.44k | 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 | 79.5k | do { |
101 | 79.5k | if (bits < 15) { |
102 | 42.1k | hold += (unsigned long)(*in++) << bits; |
103 | 42.1k | bits += 8; |
104 | 42.1k | hold += (unsigned long)(*in++) << bits; |
105 | 42.1k | bits += 8; |
106 | 42.1k | } |
107 | 79.5k | here = lcode + (hold & lmask); |
108 | 79.5k | dolen: |
109 | 79.5k | op = (unsigned)(here->bits); |
110 | 79.5k | hold >>= op; |
111 | 79.5k | bits -= op; |
112 | 79.5k | op = (unsigned)(here->op); |
113 | 79.5k | if (op == 0) { /* literal */ |
114 | 67.0k | Tracevv((stderr, here->val >= 0x20 && here->val < 0x7f ? |
115 | 67.0k | "inflate: literal '%c'\n" : |
116 | 67.0k | "inflate: literal 0x%02x\n", here->val)); |
117 | 67.0k | *out++ = (unsigned char)(here->val); |
118 | 67.0k | } |
119 | 12.5k | else if (op & 16) { /* length base */ |
120 | 11.7k | len = (unsigned)(here->val); |
121 | 11.7k | op &= 15; /* number of extra bits */ |
122 | 11.7k | if (op) { |
123 | 1.58k | if (bits < op) { |
124 | 0 | hold += (unsigned long)(*in++) << bits; |
125 | 0 | bits += 8; |
126 | 0 | } |
127 | 1.58k | len += (unsigned)hold & ((1U << op) - 1); |
128 | 1.58k | hold >>= op; |
129 | 1.58k | bits -= op; |
130 | 1.58k | } |
131 | 11.7k | Tracevv((stderr, "inflate: length %u\n", len)); |
132 | 11.7k | if (bits < 15) { |
133 | 4.80k | hold += (unsigned long)(*in++) << bits; |
134 | 4.80k | bits += 8; |
135 | 4.80k | hold += (unsigned long)(*in++) << bits; |
136 | 4.80k | bits += 8; |
137 | 4.80k | } |
138 | 11.7k | here = dcode + (hold & dmask); |
139 | 11.7k | dodist: |
140 | 11.7k | op = (unsigned)(here->bits); |
141 | 11.7k | hold >>= op; |
142 | 11.7k | bits -= op; |
143 | 11.7k | op = (unsigned)(here->op); |
144 | 11.7k | if (op & 16) { /* distance base */ |
145 | 11.7k | dist = (unsigned)(here->val); |
146 | 11.7k | op &= 15; /* number of extra bits */ |
147 | 11.7k | if (bits < op) { |
148 | 24 | hold += (unsigned long)(*in++) << bits; |
149 | 24 | bits += 8; |
150 | 24 | if (bits < op) { |
151 | 0 | hold += (unsigned long)(*in++) << bits; |
152 | 0 | bits += 8; |
153 | 0 | } |
154 | 24 | } |
155 | 11.7k | dist += (unsigned)hold & ((1U << op) - 1); |
156 | | #ifdef INFLATE_STRICT |
157 | | if (dist > dmax) { |
158 | | strm->msg = (char *)"invalid distance too far back"; |
159 | | state->mode = BAD; |
160 | | break; |
161 | | } |
162 | | #endif |
163 | 11.7k | hold >>= op; |
164 | 11.7k | bits -= op; |
165 | 11.7k | Tracevv((stderr, "inflate: distance %u\n", dist)); |
166 | 11.7k | op = (unsigned)(out - beg); /* max distance in output */ |
167 | 11.7k | if (dist > op) { /* see if copy from window */ |
168 | 791 | op = dist - op; /* distance back in window */ |
169 | 791 | if (op > whave) { |
170 | 461 | if (state->sane) { |
171 | 461 | strm->msg = |
172 | 461 | (char *)"invalid distance too far back"; |
173 | 461 | state->mode = BAD; |
174 | 461 | break; |
175 | 461 | } |
176 | | #ifdef INFLATE_ALLOW_INVALID_DISTANCE_TOOFAR_ARRR |
177 | | if (len <= op - whave) { |
178 | | do { |
179 | | *out++ = 0; |
180 | | } while (--len); |
181 | | continue; |
182 | | } |
183 | | len -= op - whave; |
184 | | do { |
185 | | *out++ = 0; |
186 | | } while (--op > whave); |
187 | | if (op == 0) { |
188 | | from = out - dist; |
189 | | do { |
190 | | *out++ = *from++; |
191 | | } while (--len); |
192 | | continue; |
193 | | } |
194 | | #endif |
195 | 461 | } |
196 | 330 | from = window; |
197 | 330 | if (wnext == 0) { /* very common case */ |
198 | 0 | from += wsize - op; |
199 | 0 | if (op < len) { /* some from window */ |
200 | 0 | len -= op; |
201 | 0 | do { |
202 | 0 | *out++ = *from++; |
203 | 0 | } while (--op); |
204 | 0 | from = out - dist; /* rest from output */ |
205 | 0 | } |
206 | 0 | } |
207 | 330 | else if (wnext < op) { /* wrap around window */ |
208 | 0 | from += wsize + wnext - op; |
209 | 0 | op -= wnext; |
210 | 0 | if (op < len) { /* some from end of window */ |
211 | 0 | len -= op; |
212 | 0 | do { |
213 | 0 | *out++ = *from++; |
214 | 0 | } while (--op); |
215 | 0 | from = window; |
216 | 0 | if (wnext < len) { /* some from start of window */ |
217 | 0 | op = wnext; |
218 | 0 | len -= op; |
219 | 0 | do { |
220 | 0 | *out++ = *from++; |
221 | 0 | } while (--op); |
222 | 0 | from = out - dist; /* rest from output */ |
223 | 0 | } |
224 | 0 | } |
225 | 0 | } |
226 | 330 | else { /* contiguous in window */ |
227 | 330 | from += wnext - op; |
228 | 330 | if (op < len) { /* some from window */ |
229 | 196 | len -= op; |
230 | 4.10k | do { |
231 | 4.10k | *out++ = *from++; |
232 | 4.10k | } while (--op); |
233 | 196 | from = out - dist; /* rest from output */ |
234 | 196 | } |
235 | 330 | } |
236 | 3.45k | while (len > 2) { |
237 | 3.12k | *out++ = *from++; |
238 | 3.12k | *out++ = *from++; |
239 | 3.12k | *out++ = *from++; |
240 | 3.12k | len -= 3; |
241 | 3.12k | } |
242 | 330 | if (len) { |
243 | 223 | *out++ = *from++; |
244 | 223 | if (len > 1) |
245 | 67 | *out++ = *from++; |
246 | 223 | } |
247 | 330 | } |
248 | 10.9k | else { |
249 | 10.9k | from = out - dist; /* copy direct from output */ |
250 | 44.0k | do { /* minimum length is three */ |
251 | 44.0k | *out++ = *from++; |
252 | 44.0k | *out++ = *from++; |
253 | 44.0k | *out++ = *from++; |
254 | 44.0k | len -= 3; |
255 | 44.0k | } while (len > 2); |
256 | 10.9k | if (len) { |
257 | 4.70k | *out++ = *from++; |
258 | 4.70k | if (len > 1) |
259 | 1.24k | *out++ = *from++; |
260 | 4.70k | } |
261 | 10.9k | } |
262 | 11.7k | } |
263 | 17 | else if ((op & 64) == 0) { /* 2nd level distance code */ |
264 | 0 | here = dcode + here->val + (hold & ((1U << op) - 1)); |
265 | 0 | goto dodist; |
266 | 0 | } |
267 | 17 | else { |
268 | 17 | strm->msg = (char *)"invalid distance code"; |
269 | 17 | state->mode = BAD; |
270 | 17 | break; |
271 | 17 | } |
272 | 11.7k | } |
273 | 761 | else if ((op & 64) == 0) { /* 2nd level length code */ |
274 | 0 | here = lcode + here->val + (hold & ((1U << op) - 1)); |
275 | 0 | goto dolen; |
276 | 0 | } |
277 | 761 | else if (op & 32) { /* end-of-block */ |
278 | 731 | Tracevv((stderr, "inflate: end of block\n")); |
279 | 731 | state->mode = TYPE; |
280 | 731 | break; |
281 | 731 | } |
282 | 30 | else { |
283 | 30 | strm->msg = (char *)"invalid literal/length code"; |
284 | 30 | state->mode = BAD; |
285 | 30 | break; |
286 | 30 | } |
287 | 79.5k | } while (in < last && out < end); |
288 | | |
289 | | /* return unused bytes (on entry, bits < 8, so in won't go too far back) */ |
290 | 2.44k | len = bits >> 3; |
291 | 2.44k | in -= len; |
292 | 2.44k | bits -= len << 3; |
293 | 2.44k | hold &= (1U << bits) - 1; |
294 | | |
295 | | /* update state and return */ |
296 | 2.44k | strm->next_in = in; |
297 | 2.44k | strm->next_out = out; |
298 | 2.44k | strm->avail_in = (unsigned)(in < last ? 5 + (last - in) : 5 - (in - last)); |
299 | 2.44k | strm->avail_out = (unsigned)(out < end ? |
300 | 2.44k | 257 + (end - out) : 257 - (out - end)); |
301 | 2.44k | state->hold = hold; |
302 | 2.44k | state->bits = bits; |
303 | 2.44k | return; |
304 | 2.44k | } |
305 | | |
306 | | /* |
307 | | inflate_fast() speedups that turned out slower (on a PowerPC G3 750CXe): |
308 | | - Using bit fields for code structure |
309 | | - Different op definition to avoid & for extra bits (do & for table bits) |
310 | | - Three separate decoding do-loops for direct, window, and wnext == 0 |
311 | | - Special case for distance > 1 copies to do overlapped load and store copy |
312 | | - Explicit branch predictions (based on measured branch probabilities) |
313 | | - Deferring match copy and interspersed it with decoding subsequent codes |
314 | | - Swapping literal/length else |
315 | | - Swapping window/direct else |
316 | | - Larger unrolled copy loops (three is about right) |
317 | | - Moving len -= 3 statement into middle of loop |
318 | | */ |
319 | | |
320 | | #endif /* !ASMINF */ |