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