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