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