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