]> git.lizzy.rs Git - zlib.git/blob - deflate.c
Use snprintf() for later versions of Microsoft C.
[zlib.git] / deflate.c
1 /* deflate.c -- compress data using the deflation algorithm
2  * Copyright (C) 1995-2016 Jean-loup Gailly and Mark Adler
3  * For conditions of distribution and use, see copyright notice in zlib.h
4  */
5
6 /*
7  *  ALGORITHM
8  *
9  *      The "deflation" process depends on being able to identify portions
10  *      of the input text which are identical to earlier input (within a
11  *      sliding window trailing behind the input currently being processed).
12  *
13  *      The most straightforward technique turns out to be the fastest for
14  *      most input files: try all possible matches and select the longest.
15  *      The key feature of this algorithm is that insertions into the string
16  *      dictionary are very simple and thus fast, and deletions are avoided
17  *      completely. Insertions are performed at each input character, whereas
18  *      string matches are performed only when the previous match ends. So it
19  *      is preferable to spend more time in matches to allow very fast string
20  *      insertions and avoid deletions. The matching algorithm for small
21  *      strings is inspired from that of Rabin & Karp. A brute force approach
22  *      is used to find longer strings when a small match has been found.
23  *      A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
24  *      (by Leonid Broukhis).
25  *         A previous version of this file used a more sophisticated algorithm
26  *      (by Fiala and Greene) which is guaranteed to run in linear amortized
27  *      time, but has a larger average cost, uses more memory and is patented.
28  *      However the F&G algorithm may be faster for some highly redundant
29  *      files if the parameter max_chain_length (described below) is too large.
30  *
31  *  ACKNOWLEDGEMENTS
32  *
33  *      The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
34  *      I found it in 'freeze' written by Leonid Broukhis.
35  *      Thanks to many people for bug reports and testing.
36  *
37  *  REFERENCES
38  *
39  *      Deutsch, L.P.,"DEFLATE Compressed Data Format Specification".
40  *      Available in http://tools.ietf.org/html/rfc1951
41  *
42  *      A description of the Rabin and Karp algorithm is given in the book
43  *         "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
44  *
45  *      Fiala,E.R., and Greene,D.H.
46  *         Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
47  *
48  */
49
50 /* @(#) $Id$ */
51
52 #include "deflate.h"
53
54 const char deflate_copyright[] =
55    " deflate 1.2.8.1 Copyright 1995-2016 Jean-loup Gailly and Mark Adler ";
56 /*
57   If you use the zlib library in a product, an acknowledgment is welcome
58   in the documentation of your product. If for some reason you cannot
59   include such an acknowledgment, I would appreciate that you keep this
60   copyright string in the executable of your product.
61  */
62
63 /* ===========================================================================
64  *  Function prototypes.
65  */
66 typedef enum {
67     need_more,      /* block not completed, need more input or more output */
68     block_done,     /* block flush performed */
69     finish_started, /* finish started, need only more output at next deflate */
70     finish_done     /* finish done, accept no more input or output */
71 } block_state;
72
73 typedef block_state (*compress_func) OF((deflate_state *s, int flush));
74 /* Compression function. Returns the block state after the call. */
75
76 local int deflateStateCheck      OF((z_streamp strm));
77 local void slide_hash     OF((deflate_state *s));
78 local void fill_window    OF((deflate_state *s));
79 local block_state deflate_stored OF((deflate_state *s, int flush));
80 local block_state deflate_fast   OF((deflate_state *s, int flush));
81 #ifndef FASTEST
82 local block_state deflate_slow   OF((deflate_state *s, int flush));
83 #endif
84 local block_state deflate_rle    OF((deflate_state *s, int flush));
85 local block_state deflate_huff   OF((deflate_state *s, int flush));
86 local void lm_init        OF((deflate_state *s));
87 local void putShortMSB    OF((deflate_state *s, uInt b));
88 local void flush_pending  OF((z_streamp strm));
89 local unsigned read_buf   OF((z_streamp strm, Bytef *buf, unsigned size));
90 #ifdef ASMV
91       void match_init OF((void)); /* asm code initialization */
92       uInt longest_match  OF((deflate_state *s, IPos cur_match));
93 #else
94 local uInt longest_match  OF((deflate_state *s, IPos cur_match));
95 #endif
96
97 #ifdef ZLIB_DEBUG
98 local  void check_match OF((deflate_state *s, IPos start, IPos match,
99                             int length));
100 #endif
101
102 /* ===========================================================================
103  * Local data
104  */
105
106 #define NIL 0
107 /* Tail of hash chains */
108
109 #ifndef TOO_FAR
110 #  define TOO_FAR 4096
111 #endif
112 /* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
113
114 /* Values for max_lazy_match, good_match and max_chain_length, depending on
115  * the desired pack level (0..9). The values given below have been tuned to
116  * exclude worst case performance for pathological files. Better values may be
117  * found for specific files.
118  */
119 typedef struct config_s {
120    ush good_length; /* reduce lazy search above this match length */
121    ush max_lazy;    /* do not perform lazy search above this match length */
122    ush nice_length; /* quit search above this match length */
123    ush max_chain;
124    compress_func func;
125 } config;
126
127 #ifdef FASTEST
128 local const config configuration_table[2] = {
129 /*      good lazy nice chain */
130 /* 0 */ {0,    0,  0,    0, deflate_stored},  /* store only */
131 /* 1 */ {4,    4,  8,    4, deflate_fast}}; /* max speed, no lazy matches */
132 #else
133 local const config configuration_table[10] = {
134 /*      good lazy nice chain */
135 /* 0 */ {0,    0,  0,    0, deflate_stored},  /* store only */
136 /* 1 */ {4,    4,  8,    4, deflate_fast}, /* max speed, no lazy matches */
137 /* 2 */ {4,    5, 16,    8, deflate_fast},
138 /* 3 */ {4,    6, 32,   32, deflate_fast},
139
140 /* 4 */ {4,    4, 16,   16, deflate_slow},  /* lazy matches */
141 /* 5 */ {8,   16, 32,   32, deflate_slow},
142 /* 6 */ {8,   16, 128, 128, deflate_slow},
143 /* 7 */ {8,   32, 128, 256, deflate_slow},
144 /* 8 */ {32, 128, 258, 1024, deflate_slow},
145 /* 9 */ {32, 258, 258, 4096, deflate_slow}}; /* max compression */
146 #endif
147
148 /* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
149  * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
150  * meaning.
151  */
152
153 /* rank Z_BLOCK between Z_NO_FLUSH and Z_PARTIAL_FLUSH */
154 #define RANK(f) (((f) * 2) - ((f) > 4 ? 9 : 0))
155
156 /* ===========================================================================
157  * Update a hash value with the given input byte
158  * IN  assertion: all calls to UPDATE_HASH are made with consecutive input
159  *    characters, so that a running hash key can be computed from the previous
160  *    key instead of complete recalculation each time.
161  */
162 #define UPDATE_HASH(s,h,c) (h = (((h)<<s->hash_shift) ^ (c)) & s->hash_mask)
163
164
165 /* ===========================================================================
166  * Insert string str in the dictionary and set match_head to the previous head
167  * of the hash chain (the most recent string with same hash key). Return
168  * the previous length of the hash chain.
169  * If this file is compiled with -DFASTEST, the compression level is forced
170  * to 1, and no hash chains are maintained.
171  * IN  assertion: all calls to INSERT_STRING are made with consecutive input
172  *    characters and the first MIN_MATCH bytes of str are valid (except for
173  *    the last MIN_MATCH-1 bytes of the input file).
174  */
175 #ifdef FASTEST
176 #define INSERT_STRING(s, str, match_head) \
177    (UPDATE_HASH(s, s->ins_h, s->window[(str) + (MIN_MATCH-1)]), \
178     match_head = s->head[s->ins_h], \
179     s->head[s->ins_h] = (Pos)(str))
180 #else
181 #define INSERT_STRING(s, str, match_head) \
182    (UPDATE_HASH(s, s->ins_h, s->window[(str) + (MIN_MATCH-1)]), \
183     match_head = s->prev[(str) & s->w_mask] = s->head[s->ins_h], \
184     s->head[s->ins_h] = (Pos)(str))
185 #endif
186
187 /* ===========================================================================
188  * Initialize the hash table (avoiding 64K overflow for 16 bit systems).
189  * prev[] will be initialized on the fly.
190  */
191 #define CLEAR_HASH(s) \
192     s->head[s->hash_size-1] = NIL; \
193     zmemzero((Bytef *)s->head, (unsigned)(s->hash_size-1)*sizeof(*s->head));
194
195 /* ===========================================================================
196  * Slide the hash table when sliding the window down (could be avoided with 32
197  * bit values at the expense of memory usage). We slide even when level == 0 to
198  * keep the hash table consistent if we switch back to level > 0 later.
199  */
200 local void slide_hash(s)
201     deflate_state *s;
202 {
203     unsigned n, m;
204     Posf *p;
205     uInt wsize = s->w_size;
206
207     n = s->hash_size;
208     p = &s->head[n];
209     do {
210         m = *--p;
211         *p = (Pos)(m >= wsize ? m - wsize : NIL);
212     } while (--n);
213     n = wsize;
214 #ifndef FASTEST
215     p = &s->prev[n];
216     do {
217         m = *--p;
218         *p = (Pos)(m >= wsize ? m - wsize : NIL);
219         /* If n is not on any hash chain, prev[n] is garbage but
220          * its value will never be used.
221          */
222     } while (--n);
223 #endif
224 }
225
226 /* ========================================================================= */
227 int ZEXPORT deflateInit_(strm, level, version, stream_size)
228     z_streamp strm;
229     int level;
230     const char *version;
231     int stream_size;
232 {
233     return deflateInit2_(strm, level, Z_DEFLATED, MAX_WBITS, DEF_MEM_LEVEL,
234                          Z_DEFAULT_STRATEGY, version, stream_size);
235     /* To do: ignore strm->next_in if we use it as window */
236 }
237
238 /* ========================================================================= */
239 int ZEXPORT deflateInit2_(strm, level, method, windowBits, memLevel, strategy,
240                   version, stream_size)
241     z_streamp strm;
242     int  level;
243     int  method;
244     int  windowBits;
245     int  memLevel;
246     int  strategy;
247     const char *version;
248     int stream_size;
249 {
250     deflate_state *s;
251     int wrap = 1;
252     static const char my_version[] = ZLIB_VERSION;
253
254     ushf *overlay;
255     /* We overlay pending_buf and d_buf+l_buf. This works since the average
256      * output size for (length,distance) codes is <= 24 bits.
257      */
258
259     if (version == Z_NULL || version[0] != my_version[0] ||
260         stream_size != sizeof(z_stream)) {
261         return Z_VERSION_ERROR;
262     }
263     if (strm == Z_NULL) return Z_STREAM_ERROR;
264
265     strm->msg = Z_NULL;
266     if (strm->zalloc == (alloc_func)0) {
267 #ifdef Z_SOLO
268         return Z_STREAM_ERROR;
269 #else
270         strm->zalloc = zcalloc;
271         strm->opaque = (voidpf)0;
272 #endif
273     }
274     if (strm->zfree == (free_func)0)
275 #ifdef Z_SOLO
276         return Z_STREAM_ERROR;
277 #else
278         strm->zfree = zcfree;
279 #endif
280
281 #ifdef FASTEST
282     if (level != 0) level = 1;
283 #else
284     if (level == Z_DEFAULT_COMPRESSION) level = 6;
285 #endif
286
287     if (windowBits < 0) { /* suppress zlib wrapper */
288         wrap = 0;
289         windowBits = -windowBits;
290     }
291 #ifdef GZIP
292     else if (windowBits > 15) {
293         wrap = 2;       /* write gzip wrapper instead */
294         windowBits -= 16;
295     }
296 #endif
297     if (memLevel < 1 || memLevel > MAX_MEM_LEVEL || method != Z_DEFLATED ||
298         windowBits < 8 || windowBits > 15 || level < 0 || level > 9 ||
299         strategy < 0 || strategy > Z_FIXED || (windowBits == 8 && wrap != 1)) {
300         return Z_STREAM_ERROR;
301     }
302     if (windowBits == 8) windowBits = 9;  /* until 256-byte window bug fixed */
303     s = (deflate_state *) ZALLOC(strm, 1, sizeof(deflate_state));
304     if (s == Z_NULL) return Z_MEM_ERROR;
305     strm->state = (struct internal_state FAR *)s;
306     s->strm = strm;
307     s->status = INIT_STATE;     /* to pass state test in deflateReset() */
308
309     s->wrap = wrap;
310     s->gzhead = Z_NULL;
311     s->w_bits = (uInt)windowBits;
312     s->w_size = 1 << s->w_bits;
313     s->w_mask = s->w_size - 1;
314
315     s->hash_bits = (uInt)memLevel + 7;
316     s->hash_size = 1 << s->hash_bits;
317     s->hash_mask = s->hash_size - 1;
318     s->hash_shift =  ((s->hash_bits+MIN_MATCH-1)/MIN_MATCH);
319
320     s->window = (Bytef *) ZALLOC(strm, s->w_size, 2*sizeof(Byte));
321     s->prev   = (Posf *)  ZALLOC(strm, s->w_size, sizeof(Pos));
322     s->head   = (Posf *)  ZALLOC(strm, s->hash_size, sizeof(Pos));
323
324     s->high_water = 0;      /* nothing written to s->window yet */
325
326     s->lit_bufsize = 1 << (memLevel + 6); /* 16K elements by default */
327
328     overlay = (ushf *) ZALLOC(strm, s->lit_bufsize, sizeof(ush)+2);
329     s->pending_buf = (uchf *) overlay;
330     s->pending_buf_size = (ulg)s->lit_bufsize * (sizeof(ush)+2L);
331
332     if (s->window == Z_NULL || s->prev == Z_NULL || s->head == Z_NULL ||
333         s->pending_buf == Z_NULL) {
334         s->status = FINISH_STATE;
335         strm->msg = ERR_MSG(Z_MEM_ERROR);
336         deflateEnd (strm);
337         return Z_MEM_ERROR;
338     }
339     s->d_buf = overlay + s->lit_bufsize/sizeof(ush);
340     s->l_buf = s->pending_buf + (1+sizeof(ush))*s->lit_bufsize;
341
342     s->level = level;
343     s->strategy = strategy;
344     s->method = (Byte)method;
345
346     return deflateReset(strm);
347 }
348
349 /* =========================================================================
350  * Check for a valid deflate stream state. Return 0 if ok, 1 if not.
351  */
352 local int deflateStateCheck (strm)
353     z_streamp strm;
354 {
355     deflate_state *s;
356     if (strm == Z_NULL ||
357         strm->zalloc == (alloc_func)0 || strm->zfree == (free_func)0)
358         return 1;
359     s = strm->state;
360     if (s == Z_NULL || s->strm != strm || (s->status != INIT_STATE &&
361 #ifdef GZIP
362                                            s->status != GZIP_STATE &&
363 #endif
364                                            s->status != EXTRA_STATE &&
365                                            s->status != NAME_STATE &&
366                                            s->status != COMMENT_STATE &&
367                                            s->status != HCRC_STATE &&
368                                            s->status != BUSY_STATE &&
369                                            s->status != FINISH_STATE))
370         return 1;
371     return 0;
372 }
373
374 /* ========================================================================= */
375 int ZEXPORT deflateSetDictionary (strm, dictionary, dictLength)
376     z_streamp strm;
377     const Bytef *dictionary;
378     uInt  dictLength;
379 {
380     deflate_state *s;
381     uInt str, n;
382     int wrap;
383     unsigned avail;
384     z_const unsigned char *next;
385
386     if (deflateStateCheck(strm) || dictionary == Z_NULL)
387         return Z_STREAM_ERROR;
388     s = strm->state;
389     wrap = s->wrap;
390     if (wrap == 2 || (wrap == 1 && s->status != INIT_STATE) || s->lookahead)
391         return Z_STREAM_ERROR;
392
393     /* when using zlib wrappers, compute Adler-32 for provided dictionary */
394     if (wrap == 1)
395         strm->adler = adler32(strm->adler, dictionary, dictLength);
396     s->wrap = 0;                    /* avoid computing Adler-32 in read_buf */
397
398     /* if dictionary would fill window, just replace the history */
399     if (dictLength >= s->w_size) {
400         if (wrap == 0) {            /* already empty otherwise */
401             CLEAR_HASH(s);
402             s->strstart = 0;
403             s->block_start = 0L;
404             s->insert = 0;
405         }
406         dictionary += dictLength - s->w_size;  /* use the tail */
407         dictLength = s->w_size;
408     }
409
410     /* insert dictionary into window and hash */
411     avail = strm->avail_in;
412     next = strm->next_in;
413     strm->avail_in = dictLength;
414     strm->next_in = (z_const Bytef *)dictionary;
415     fill_window(s);
416     while (s->lookahead >= MIN_MATCH) {
417         str = s->strstart;
418         n = s->lookahead - (MIN_MATCH-1);
419         do {
420             UPDATE_HASH(s, s->ins_h, s->window[str + MIN_MATCH-1]);
421 #ifndef FASTEST
422             s->prev[str & s->w_mask] = s->head[s->ins_h];
423 #endif
424             s->head[s->ins_h] = (Pos)str;
425             str++;
426         } while (--n);
427         s->strstart = str;
428         s->lookahead = MIN_MATCH-1;
429         fill_window(s);
430     }
431     s->strstart += s->lookahead;
432     s->block_start = (long)s->strstart;
433     s->insert = s->lookahead;
434     s->lookahead = 0;
435     s->match_length = s->prev_length = MIN_MATCH-1;
436     s->match_available = 0;
437     strm->next_in = next;
438     strm->avail_in = avail;
439     s->wrap = wrap;
440     return Z_OK;
441 }
442
443 /* ========================================================================= */
444 int ZEXPORT deflateGetDictionary (strm, dictionary, dictLength)
445     z_streamp strm;
446     Bytef *dictionary;
447     uInt  *dictLength;
448 {
449     deflate_state *s;
450
451     if (deflateStateCheck(strm))
452         return Z_STREAM_ERROR;
453     s = strm->state;
454     uInt len = s->strstart + s->lookahead;
455     if (len > s->w_size)
456         len = s->w_size;
457     if (dictionary != Z_NULL && len)
458         zmemcpy(dictionary, s->window + s->strstart + s->lookahead - len, len);
459     if (dictLength != Z_NULL)
460         *dictLength = len;
461     return Z_OK;
462 }
463
464 /* ========================================================================= */
465 int ZEXPORT deflateResetKeep (strm)
466     z_streamp strm;
467 {
468     deflate_state *s;
469
470     if (deflateStateCheck(strm)) {
471         return Z_STREAM_ERROR;
472     }
473
474     strm->total_in = strm->total_out = 0;
475     strm->msg = Z_NULL; /* use zfree if we ever allocate msg dynamically */
476     strm->data_type = Z_UNKNOWN;
477
478     s = (deflate_state *)strm->state;
479     s->pending = 0;
480     s->pending_out = s->pending_buf;
481
482     if (s->wrap < 0) {
483         s->wrap = -s->wrap; /* was made negative by deflate(..., Z_FINISH); */
484     }
485     s->status =
486 #ifdef GZIP
487         s->wrap == 2 ? GZIP_STATE :
488 #endif
489         s->wrap ? INIT_STATE : BUSY_STATE;
490     strm->adler =
491 #ifdef GZIP
492         s->wrap == 2 ? crc32(0L, Z_NULL, 0) :
493 #endif
494         adler32(0L, Z_NULL, 0);
495     s->last_flush = Z_NO_FLUSH;
496
497     _tr_init(s);
498
499     return Z_OK;
500 }
501
502 /* ========================================================================= */
503 int ZEXPORT deflateReset (strm)
504     z_streamp strm;
505 {
506     int ret;
507
508     ret = deflateResetKeep(strm);
509     if (ret == Z_OK)
510         lm_init(strm->state);
511     return ret;
512 }
513
514 /* ========================================================================= */
515 int ZEXPORT deflateSetHeader (strm, head)
516     z_streamp strm;
517     gz_headerp head;
518 {
519     if (deflateStateCheck(strm) || strm->state->wrap != 2)
520         return Z_STREAM_ERROR;
521     strm->state->gzhead = head;
522     return Z_OK;
523 }
524
525 /* ========================================================================= */
526 int ZEXPORT deflatePending (strm, pending, bits)
527     unsigned *pending;
528     int *bits;
529     z_streamp strm;
530 {
531     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
532     if (pending != Z_NULL)
533         *pending = strm->state->pending;
534     if (bits != Z_NULL)
535         *bits = strm->state->bi_valid;
536     return Z_OK;
537 }
538
539 /* ========================================================================= */
540 int ZEXPORT deflatePrime (strm, bits, value)
541     z_streamp strm;
542     int bits;
543     int value;
544 {
545     deflate_state *s;
546     int put;
547
548     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
549     s = strm->state;
550     if ((Bytef *)(s->d_buf) < s->pending_out + ((Buf_size + 7) >> 3))
551         return Z_BUF_ERROR;
552     do {
553         put = Buf_size - s->bi_valid;
554         if (put > bits)
555             put = bits;
556         s->bi_buf |= (ush)((value & ((1 << put) - 1)) << s->bi_valid);
557         s->bi_valid += put;
558         _tr_flush_bits(s);
559         value >>= put;
560         bits -= put;
561     } while (bits);
562     return Z_OK;
563 }
564
565 /* ========================================================================= */
566 int ZEXPORT deflateParams(strm, level, strategy)
567     z_streamp strm;
568     int level;
569     int strategy;
570 {
571     deflate_state *s;
572     compress_func func;
573
574     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
575     s = strm->state;
576
577 #ifdef FASTEST
578     if (level != 0) level = 1;
579 #else
580     if (level == Z_DEFAULT_COMPRESSION) level = 6;
581 #endif
582     if (level < 0 || level > 9 || strategy < 0 || strategy > Z_FIXED) {
583         return Z_STREAM_ERROR;
584     }
585     func = configuration_table[s->level].func;
586
587     if ((strategy != s->strategy || func != configuration_table[level].func)) {
588         /* Flush the last buffer: */
589         int err = deflate(strm, Z_BLOCK);
590         if (err == Z_STREAM_ERROR)
591             return err;
592         if (strm->avail_out == 0)
593             return Z_BUF_ERROR;
594     }
595     if (s->level != level) {
596         if (s->level == 0 && s->matches != 0) {
597             if (s->matches == 1)
598                 slide_hash(s);
599             else
600                 CLEAR_HASH(s);
601             s->matches = 0;
602         }
603         s->level = level;
604         s->max_lazy_match   = configuration_table[level].max_lazy;
605         s->good_match       = configuration_table[level].good_length;
606         s->nice_match       = configuration_table[level].nice_length;
607         s->max_chain_length = configuration_table[level].max_chain;
608     }
609     s->strategy = strategy;
610     return Z_OK;
611 }
612
613 /* ========================================================================= */
614 int ZEXPORT deflateTune(strm, good_length, max_lazy, nice_length, max_chain)
615     z_streamp strm;
616     int good_length;
617     int max_lazy;
618     int nice_length;
619     int max_chain;
620 {
621     deflate_state *s;
622
623     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
624     s = strm->state;
625     s->good_match = (uInt)good_length;
626     s->max_lazy_match = (uInt)max_lazy;
627     s->nice_match = nice_length;
628     s->max_chain_length = (uInt)max_chain;
629     return Z_OK;
630 }
631
632 /* =========================================================================
633  * For the default windowBits of 15 and memLevel of 8, this function returns
634  * a close to exact, as well as small, upper bound on the compressed size.
635  * They are coded as constants here for a reason--if the #define's are
636  * changed, then this function needs to be changed as well.  The return
637  * value for 15 and 8 only works for those exact settings.
638  *
639  * For any setting other than those defaults for windowBits and memLevel,
640  * the value returned is a conservative worst case for the maximum expansion
641  * resulting from using fixed blocks instead of stored blocks, which deflate
642  * can emit on compressed data for some combinations of the parameters.
643  *
644  * This function could be more sophisticated to provide closer upper bounds for
645  * every combination of windowBits and memLevel.  But even the conservative
646  * upper bound of about 14% expansion does not seem onerous for output buffer
647  * allocation.
648  */
649 uLong ZEXPORT deflateBound(strm, sourceLen)
650     z_streamp strm;
651     uLong sourceLen;
652 {
653     deflate_state *s;
654     uLong complen, wraplen;
655
656     /* conservative upper bound for compressed data */
657     complen = sourceLen +
658               ((sourceLen + 7) >> 3) + ((sourceLen + 63) >> 6) + 5;
659
660     /* if can't get parameters, return conservative bound plus zlib wrapper */
661     if (deflateStateCheck(strm))
662         return complen + 6;
663
664     /* compute wrapper length */
665     s = strm->state;
666     switch (s->wrap) {
667     case 0:                                 /* raw deflate */
668         wraplen = 0;
669         break;
670     case 1:                                 /* zlib wrapper */
671         wraplen = 6 + (s->strstart ? 4 : 0);
672         break;
673 #ifdef GZIP
674     case 2:                                 /* gzip wrapper */
675         wraplen = 18;
676         if (s->gzhead != Z_NULL) {          /* user-supplied gzip header */
677             Bytef *str;
678             if (s->gzhead->extra != Z_NULL)
679                 wraplen += 2 + s->gzhead->extra_len;
680             str = s->gzhead->name;
681             if (str != Z_NULL)
682                 do {
683                     wraplen++;
684                 } while (*str++);
685             str = s->gzhead->comment;
686             if (str != Z_NULL)
687                 do {
688                     wraplen++;
689                 } while (*str++);
690             if (s->gzhead->hcrc)
691                 wraplen += 2;
692         }
693         break;
694 #endif
695     default:                                /* for compiler happiness */
696         wraplen = 6;
697     }
698
699     /* if not default parameters, return conservative bound */
700     if (s->w_bits != 15 || s->hash_bits != 8 + 7)
701         return complen + wraplen;
702
703     /* default settings: return tight bound for that case */
704     return sourceLen + (sourceLen >> 12) + (sourceLen >> 14) +
705            (sourceLen >> 25) + 13 - 6 + wraplen;
706 }
707
708 /* =========================================================================
709  * Put a short in the pending buffer. The 16-bit value is put in MSB order.
710  * IN assertion: the stream state is correct and there is enough room in
711  * pending_buf.
712  */
713 local void putShortMSB (s, b)
714     deflate_state *s;
715     uInt b;
716 {
717     put_byte(s, (Byte)(b >> 8));
718     put_byte(s, (Byte)(b & 0xff));
719 }
720
721 /* =========================================================================
722  * Flush as much pending output as possible. All deflate() output, except for
723  * some deflate_stored() output, goes through this function so some
724  * applications may wish to modify it to avoid allocating a large
725  * strm->next_out buffer and copying into it. (See also read_buf()).
726  */
727 local void flush_pending(strm)
728     z_streamp strm;
729 {
730     unsigned len;
731     deflate_state *s = strm->state;
732
733     _tr_flush_bits(s);
734     len = s->pending;
735     if (len > strm->avail_out) len = strm->avail_out;
736     if (len == 0) return;
737
738     zmemcpy(strm->next_out, s->pending_out, len);
739     strm->next_out  += len;
740     s->pending_out  += len;
741     strm->total_out += len;
742     strm->avail_out -= len;
743     s->pending      -= len;
744     if (s->pending == 0) {
745         s->pending_out = s->pending_buf;
746     }
747 }
748
749 /* ===========================================================================
750  * Update the header CRC with the bytes s->pending_buf[beg..s->pending - 1].
751  */
752 #define HCRC_UPDATE(beg) \
753     do { \
754         if (s->gzhead->hcrc && s->pending > (beg)) \
755             strm->adler = crc32(strm->adler, s->pending_buf + (beg), \
756                                 s->pending - (beg)); \
757     } while (0)
758
759 /* ========================================================================= */
760 int ZEXPORT deflate (strm, flush)
761     z_streamp strm;
762     int flush;
763 {
764     int old_flush; /* value of flush param for previous deflate call */
765     deflate_state *s;
766
767     if (deflateStateCheck(strm) || flush > Z_BLOCK || flush < 0) {
768         return Z_STREAM_ERROR;
769     }
770     s = strm->state;
771
772     if (strm->next_out == Z_NULL ||
773         (strm->avail_in != 0 && strm->next_in == Z_NULL) ||
774         (s->status == FINISH_STATE && flush != Z_FINISH)) {
775         ERR_RETURN(strm, Z_STREAM_ERROR);
776     }
777     if (strm->avail_out == 0) ERR_RETURN(strm, Z_BUF_ERROR);
778
779     old_flush = s->last_flush;
780     s->last_flush = flush;
781
782     /* Flush as much pending output as possible */
783     if (s->pending != 0) {
784         flush_pending(strm);
785         if (strm->avail_out == 0) {
786             /* Since avail_out is 0, deflate will be called again with
787              * more output space, but possibly with both pending and
788              * avail_in equal to zero. There won't be anything to do,
789              * but this is not an error situation so make sure we
790              * return OK instead of BUF_ERROR at next call of deflate:
791              */
792             s->last_flush = -1;
793             return Z_OK;
794         }
795
796     /* Make sure there is something to do and avoid duplicate consecutive
797      * flushes. For repeated and useless calls with Z_FINISH, we keep
798      * returning Z_STREAM_END instead of Z_BUF_ERROR.
799      */
800     } else if (strm->avail_in == 0 && RANK(flush) <= RANK(old_flush) &&
801                flush != Z_FINISH) {
802         ERR_RETURN(strm, Z_BUF_ERROR);
803     }
804
805     /* User must not provide more input after the first FINISH: */
806     if (s->status == FINISH_STATE && strm->avail_in != 0) {
807         ERR_RETURN(strm, Z_BUF_ERROR);
808     }
809
810     /* Write the header */
811     if (s->status == INIT_STATE) {
812         /* zlib header */
813         uInt header = (Z_DEFLATED + ((s->w_bits-8)<<4)) << 8;
814         uInt level_flags;
815
816         if (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2)
817             level_flags = 0;
818         else if (s->level < 6)
819             level_flags = 1;
820         else if (s->level == 6)
821             level_flags = 2;
822         else
823             level_flags = 3;
824         header |= (level_flags << 6);
825         if (s->strstart != 0) header |= PRESET_DICT;
826         header += 31 - (header % 31);
827
828         putShortMSB(s, header);
829
830         /* Save the adler32 of the preset dictionary: */
831         if (s->strstart != 0) {
832             putShortMSB(s, (uInt)(strm->adler >> 16));
833             putShortMSB(s, (uInt)(strm->adler & 0xffff));
834         }
835         strm->adler = adler32(0L, Z_NULL, 0);
836         s->status = BUSY_STATE;
837
838         /* Compression must start with an empty pending buffer */
839         flush_pending(strm);
840         if (s->pending != 0) {
841             s->last_flush = -1;
842             return Z_OK;
843         }
844     }
845 #ifdef GZIP
846     if (s->status == GZIP_STATE) {
847         /* gzip header */
848         strm->adler = crc32(0L, Z_NULL, 0);
849         put_byte(s, 31);
850         put_byte(s, 139);
851         put_byte(s, 8);
852         if (s->gzhead == Z_NULL) {
853             put_byte(s, 0);
854             put_byte(s, 0);
855             put_byte(s, 0);
856             put_byte(s, 0);
857             put_byte(s, 0);
858             put_byte(s, s->level == 9 ? 2 :
859                      (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2 ?
860                       4 : 0));
861             put_byte(s, OS_CODE);
862             s->status = BUSY_STATE;
863
864             /* Compression must start with an empty pending buffer */
865             flush_pending(strm);
866             if (s->pending != 0) {
867                 s->last_flush = -1;
868                 return Z_OK;
869             }
870         }
871         else {
872             put_byte(s, (s->gzhead->text ? 1 : 0) +
873                      (s->gzhead->hcrc ? 2 : 0) +
874                      (s->gzhead->extra == Z_NULL ? 0 : 4) +
875                      (s->gzhead->name == Z_NULL ? 0 : 8) +
876                      (s->gzhead->comment == Z_NULL ? 0 : 16)
877                      );
878             put_byte(s, (Byte)(s->gzhead->time & 0xff));
879             put_byte(s, (Byte)((s->gzhead->time >> 8) & 0xff));
880             put_byte(s, (Byte)((s->gzhead->time >> 16) & 0xff));
881             put_byte(s, (Byte)((s->gzhead->time >> 24) & 0xff));
882             put_byte(s, s->level == 9 ? 2 :
883                      (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2 ?
884                       4 : 0));
885             put_byte(s, s->gzhead->os & 0xff);
886             if (s->gzhead->extra != Z_NULL) {
887                 put_byte(s, s->gzhead->extra_len & 0xff);
888                 put_byte(s, (s->gzhead->extra_len >> 8) & 0xff);
889             }
890             if (s->gzhead->hcrc)
891                 strm->adler = crc32(strm->adler, s->pending_buf,
892                                     s->pending);
893             s->gzindex = 0;
894             s->status = EXTRA_STATE;
895         }
896     }
897     if (s->status == EXTRA_STATE) {
898         if (s->gzhead->extra != Z_NULL) {
899             ulg beg = s->pending;   /* start of bytes to update crc */
900             uInt left = (s->gzhead->extra_len & 0xffff) - s->gzindex;
901             while (s->pending + left > s->pending_buf_size) {
902                 uInt copy = s->pending_buf_size - s->pending;
903                 zmemcpy(s->pending_buf + s->pending,
904                         s->gzhead->extra + s->gzindex, copy);
905                 s->pending = s->pending_buf_size;
906                 HCRC_UPDATE(beg);
907                 s->gzindex += copy;
908                 flush_pending(strm);
909                 if (s->pending != 0) {
910                     s->last_flush = -1;
911                     return Z_OK;
912                 }
913                 beg = 0;
914                 left -= copy;
915             }
916             zmemcpy(s->pending_buf + s->pending,
917                     s->gzhead->extra + s->gzindex, left);
918             s->pending += left;
919             HCRC_UPDATE(beg);
920             s->gzindex = 0;
921         }
922         s->status = NAME_STATE;
923     }
924     if (s->status == NAME_STATE) {
925         if (s->gzhead->name != Z_NULL) {
926             ulg beg = s->pending;   /* start of bytes to update crc */
927             int val;
928             do {
929                 if (s->pending == s->pending_buf_size) {
930                     HCRC_UPDATE(beg);
931                     flush_pending(strm);
932                     if (s->pending != 0) {
933                         s->last_flush = -1;
934                         return Z_OK;
935                     }
936                     beg = 0;
937                 }
938                 val = s->gzhead->name[s->gzindex++];
939                 put_byte(s, val);
940             } while (val != 0);
941             HCRC_UPDATE(beg);
942             s->gzindex = 0;
943         }
944         s->status = COMMENT_STATE;
945     }
946     if (s->status == COMMENT_STATE) {
947         if (s->gzhead->comment != Z_NULL) {
948             ulg beg = s->pending;   /* start of bytes to update crc */
949             int val;
950             do {
951                 if (s->pending == s->pending_buf_size) {
952                     HCRC_UPDATE(beg);
953                     flush_pending(strm);
954                     if (s->pending != 0) {
955                         s->last_flush = -1;
956                         return Z_OK;
957                     }
958                     beg = 0;
959                 }
960                 val = s->gzhead->comment[s->gzindex++];
961                 put_byte(s, val);
962             } while (val != 0);
963             HCRC_UPDATE(beg);
964         }
965         s->status = HCRC_STATE;
966     }
967     if (s->status == HCRC_STATE) {
968         if (s->gzhead->hcrc) {
969             if (s->pending + 2 > s->pending_buf_size) {
970                 flush_pending(strm);
971                 if (s->pending != 0) {
972                     s->last_flush = -1;
973                     return Z_OK;
974                 }
975             }
976             put_byte(s, (Byte)(strm->adler & 0xff));
977             put_byte(s, (Byte)((strm->adler >> 8) & 0xff));
978             strm->adler = crc32(0L, Z_NULL, 0);
979         }
980         s->status = BUSY_STATE;
981
982         /* Compression must start with an empty pending buffer */
983         flush_pending(strm);
984         if (s->pending != 0) {
985             s->last_flush = -1;
986             return Z_OK;
987         }
988     }
989 #endif
990
991     /* Start a new block or continue the current one.
992      */
993     if (strm->avail_in != 0 || s->lookahead != 0 ||
994         (flush != Z_NO_FLUSH && s->status != FINISH_STATE)) {
995         block_state bstate;
996
997         bstate = s->level == 0 ? deflate_stored(s, flush) :
998                  s->strategy == Z_HUFFMAN_ONLY ? deflate_huff(s, flush) :
999                  s->strategy == Z_RLE ? deflate_rle(s, flush) :
1000                  (*(configuration_table[s->level].func))(s, flush);
1001
1002         if (bstate == finish_started || bstate == finish_done) {
1003             s->status = FINISH_STATE;
1004         }
1005         if (bstate == need_more || bstate == finish_started) {
1006             if (strm->avail_out == 0) {
1007                 s->last_flush = -1; /* avoid BUF_ERROR next call, see above */
1008             }
1009             return Z_OK;
1010             /* If flush != Z_NO_FLUSH && avail_out == 0, the next call
1011              * of deflate should use the same flush parameter to make sure
1012              * that the flush is complete. So we don't have to output an
1013              * empty block here, this will be done at next call. This also
1014              * ensures that for a very small output buffer, we emit at most
1015              * one empty block.
1016              */
1017         }
1018         if (bstate == block_done) {
1019             if (flush == Z_PARTIAL_FLUSH) {
1020                 _tr_align(s);
1021             } else if (flush != Z_BLOCK) { /* FULL_FLUSH or SYNC_FLUSH */
1022                 _tr_stored_block(s, (char*)0, 0L, 0);
1023                 /* For a full flush, this empty block will be recognized
1024                  * as a special marker by inflate_sync().
1025                  */
1026                 if (flush == Z_FULL_FLUSH) {
1027                     CLEAR_HASH(s);             /* forget history */
1028                     if (s->lookahead == 0) {
1029                         s->strstart = 0;
1030                         s->block_start = 0L;
1031                         s->insert = 0;
1032                     }
1033                 }
1034             }
1035             flush_pending(strm);
1036             if (strm->avail_out == 0) {
1037               s->last_flush = -1; /* avoid BUF_ERROR at next call, see above */
1038               return Z_OK;
1039             }
1040         }
1041     }
1042     Assert(strm->avail_out > 0, "bug2");
1043
1044     if (flush != Z_FINISH) return Z_OK;
1045     if (s->wrap <= 0) return Z_STREAM_END;
1046
1047     /* Write the trailer */
1048 #ifdef GZIP
1049     if (s->wrap == 2) {
1050         put_byte(s, (Byte)(strm->adler & 0xff));
1051         put_byte(s, (Byte)((strm->adler >> 8) & 0xff));
1052         put_byte(s, (Byte)((strm->adler >> 16) & 0xff));
1053         put_byte(s, (Byte)((strm->adler >> 24) & 0xff));
1054         put_byte(s, (Byte)(strm->total_in & 0xff));
1055         put_byte(s, (Byte)((strm->total_in >> 8) & 0xff));
1056         put_byte(s, (Byte)((strm->total_in >> 16) & 0xff));
1057         put_byte(s, (Byte)((strm->total_in >> 24) & 0xff));
1058     }
1059     else
1060 #endif
1061     {
1062         putShortMSB(s, (uInt)(strm->adler >> 16));
1063         putShortMSB(s, (uInt)(strm->adler & 0xffff));
1064     }
1065     flush_pending(strm);
1066     /* If avail_out is zero, the application will call deflate again
1067      * to flush the rest.
1068      */
1069     if (s->wrap > 0) s->wrap = -s->wrap; /* write the trailer only once! */
1070     return s->pending != 0 ? Z_OK : Z_STREAM_END;
1071 }
1072
1073 /* ========================================================================= */
1074 int ZEXPORT deflateEnd (strm)
1075     z_streamp strm;
1076 {
1077     int status;
1078
1079     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
1080
1081     status = strm->state->status;
1082
1083     /* Deallocate in reverse order of allocations: */
1084     TRY_FREE(strm, strm->state->pending_buf);
1085     TRY_FREE(strm, strm->state->head);
1086     TRY_FREE(strm, strm->state->prev);
1087     TRY_FREE(strm, strm->state->window);
1088
1089     ZFREE(strm, strm->state);
1090     strm->state = Z_NULL;
1091
1092     return status == BUSY_STATE ? Z_DATA_ERROR : Z_OK;
1093 }
1094
1095 /* =========================================================================
1096  * Copy the source state to the destination state.
1097  * To simplify the source, this is not supported for 16-bit MSDOS (which
1098  * doesn't have enough memory anyway to duplicate compression states).
1099  */
1100 int ZEXPORT deflateCopy (dest, source)
1101     z_streamp dest;
1102     z_streamp source;
1103 {
1104 #ifdef MAXSEG_64K
1105     return Z_STREAM_ERROR;
1106 #else
1107     deflate_state *ds;
1108     deflate_state *ss;
1109     ushf *overlay;
1110
1111
1112     if (deflateStateCheck(source) || dest == Z_NULL) {
1113         return Z_STREAM_ERROR;
1114     }
1115
1116     ss = source->state;
1117
1118     zmemcpy((voidpf)dest, (voidpf)source, sizeof(z_stream));
1119
1120     ds = (deflate_state *) ZALLOC(dest, 1, sizeof(deflate_state));
1121     if (ds == Z_NULL) return Z_MEM_ERROR;
1122     dest->state = (struct internal_state FAR *) ds;
1123     zmemcpy((voidpf)ds, (voidpf)ss, sizeof(deflate_state));
1124     ds->strm = dest;
1125
1126     ds->window = (Bytef *) ZALLOC(dest, ds->w_size, 2*sizeof(Byte));
1127     ds->prev   = (Posf *)  ZALLOC(dest, ds->w_size, sizeof(Pos));
1128     ds->head   = (Posf *)  ZALLOC(dest, ds->hash_size, sizeof(Pos));
1129     overlay = (ushf *) ZALLOC(dest, ds->lit_bufsize, sizeof(ush)+2);
1130     ds->pending_buf = (uchf *) overlay;
1131
1132     if (ds->window == Z_NULL || ds->prev == Z_NULL || ds->head == Z_NULL ||
1133         ds->pending_buf == Z_NULL) {
1134         deflateEnd (dest);
1135         return Z_MEM_ERROR;
1136     }
1137     /* following zmemcpy do not work for 16-bit MSDOS */
1138     zmemcpy(ds->window, ss->window, ds->w_size * 2 * sizeof(Byte));
1139     zmemcpy((voidpf)ds->prev, (voidpf)ss->prev, ds->w_size * sizeof(Pos));
1140     zmemcpy((voidpf)ds->head, (voidpf)ss->head, ds->hash_size * sizeof(Pos));
1141     zmemcpy(ds->pending_buf, ss->pending_buf, (uInt)ds->pending_buf_size);
1142
1143     ds->pending_out = ds->pending_buf + (ss->pending_out - ss->pending_buf);
1144     ds->d_buf = overlay + ds->lit_bufsize/sizeof(ush);
1145     ds->l_buf = ds->pending_buf + (1+sizeof(ush))*ds->lit_bufsize;
1146
1147     ds->l_desc.dyn_tree = ds->dyn_ltree;
1148     ds->d_desc.dyn_tree = ds->dyn_dtree;
1149     ds->bl_desc.dyn_tree = ds->bl_tree;
1150
1151     return Z_OK;
1152 #endif /* MAXSEG_64K */
1153 }
1154
1155 /* ===========================================================================
1156  * Read a new buffer from the current input stream, update the adler32
1157  * and total number of bytes read.  All deflate() input goes through
1158  * this function so some applications may wish to modify it to avoid
1159  * allocating a large strm->next_in buffer and copying from it.
1160  * (See also flush_pending()).
1161  */
1162 local unsigned read_buf(strm, buf, size)
1163     z_streamp strm;
1164     Bytef *buf;
1165     unsigned size;
1166 {
1167     unsigned len = strm->avail_in;
1168
1169     if (len > size) len = size;
1170     if (len == 0) return 0;
1171
1172     strm->avail_in  -= len;
1173
1174     zmemcpy(buf, strm->next_in, len);
1175     if (strm->state->wrap == 1) {
1176         strm->adler = adler32(strm->adler, buf, len);
1177     }
1178 #ifdef GZIP
1179     else if (strm->state->wrap == 2) {
1180         strm->adler = crc32(strm->adler, buf, len);
1181     }
1182 #endif
1183     strm->next_in  += len;
1184     strm->total_in += len;
1185
1186     return len;
1187 }
1188
1189 /* ===========================================================================
1190  * Initialize the "longest match" routines for a new zlib stream
1191  */
1192 local void lm_init (s)
1193     deflate_state *s;
1194 {
1195     s->window_size = (ulg)2L*s->w_size;
1196
1197     CLEAR_HASH(s);
1198
1199     /* Set the default configuration parameters:
1200      */
1201     s->max_lazy_match   = configuration_table[s->level].max_lazy;
1202     s->good_match       = configuration_table[s->level].good_length;
1203     s->nice_match       = configuration_table[s->level].nice_length;
1204     s->max_chain_length = configuration_table[s->level].max_chain;
1205
1206     s->strstart = 0;
1207     s->block_start = 0L;
1208     s->lookahead = 0;
1209     s->insert = 0;
1210     s->match_length = s->prev_length = MIN_MATCH-1;
1211     s->match_available = 0;
1212     s->ins_h = 0;
1213 #ifndef FASTEST
1214 #ifdef ASMV
1215     match_init(); /* initialize the asm code */
1216 #endif
1217 #endif
1218 }
1219
1220 #ifndef FASTEST
1221 /* ===========================================================================
1222  * Set match_start to the longest match starting at the given string and
1223  * return its length. Matches shorter or equal to prev_length are discarded,
1224  * in which case the result is equal to prev_length and match_start is
1225  * garbage.
1226  * IN assertions: cur_match is the head of the hash chain for the current
1227  *   string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
1228  * OUT assertion: the match length is not greater than s->lookahead.
1229  */
1230 #ifndef ASMV
1231 /* For 80x86 and 680x0, an optimized version will be provided in match.asm or
1232  * match.S. The code will be functionally equivalent.
1233  */
1234 local uInt longest_match(s, cur_match)
1235     deflate_state *s;
1236     IPos cur_match;                             /* current match */
1237 {
1238     unsigned chain_length = s->max_chain_length;/* max hash chain length */
1239     register Bytef *scan = s->window + s->strstart; /* current string */
1240     register Bytef *match;                      /* matched string */
1241     register int len;                           /* length of current match */
1242     int best_len = (int)s->prev_length;         /* best match length so far */
1243     int nice_match = s->nice_match;             /* stop if match long enough */
1244     IPos limit = s->strstart > (IPos)MAX_DIST(s) ?
1245         s->strstart - (IPos)MAX_DIST(s) : NIL;
1246     /* Stop when cur_match becomes <= limit. To simplify the code,
1247      * we prevent matches with the string of window index 0.
1248      */
1249     Posf *prev = s->prev;
1250     uInt wmask = s->w_mask;
1251
1252 #ifdef UNALIGNED_OK
1253     /* Compare two bytes at a time. Note: this is not always beneficial.
1254      * Try with and without -DUNALIGNED_OK to check.
1255      */
1256     register Bytef *strend = s->window + s->strstart + MAX_MATCH - 1;
1257     register ush scan_start = *(ushf*)scan;
1258     register ush scan_end   = *(ushf*)(scan+best_len-1);
1259 #else
1260     register Bytef *strend = s->window + s->strstart + MAX_MATCH;
1261     register Byte scan_end1  = scan[best_len-1];
1262     register Byte scan_end   = scan[best_len];
1263 #endif
1264
1265     /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
1266      * It is easy to get rid of this optimization if necessary.
1267      */
1268     Assert(s->hash_bits >= 8 && MAX_MATCH == 258, "Code too clever");
1269
1270     /* Do not waste too much time if we already have a good match: */
1271     if (s->prev_length >= s->good_match) {
1272         chain_length >>= 2;
1273     }
1274     /* Do not look for matches beyond the end of the input. This is necessary
1275      * to make deflate deterministic.
1276      */
1277     if ((uInt)nice_match > s->lookahead) nice_match = (int)s->lookahead;
1278
1279     Assert((ulg)s->strstart <= s->window_size-MIN_LOOKAHEAD, "need lookahead");
1280
1281     do {
1282         Assert(cur_match < s->strstart, "no future");
1283         match = s->window + cur_match;
1284
1285         /* Skip to next match if the match length cannot increase
1286          * or if the match length is less than 2.  Note that the checks below
1287          * for insufficient lookahead only occur occasionally for performance
1288          * reasons.  Therefore uninitialized memory will be accessed, and
1289          * conditional jumps will be made that depend on those values.
1290          * However the length of the match is limited to the lookahead, so
1291          * the output of deflate is not affected by the uninitialized values.
1292          */
1293 #if (defined(UNALIGNED_OK) && MAX_MATCH == 258)
1294         /* This code assumes sizeof(unsigned short) == 2. Do not use
1295          * UNALIGNED_OK if your compiler uses a different size.
1296          */
1297         if (*(ushf*)(match+best_len-1) != scan_end ||
1298             *(ushf*)match != scan_start) continue;
1299
1300         /* It is not necessary to compare scan[2] and match[2] since they are
1301          * always equal when the other bytes match, given that the hash keys
1302          * are equal and that HASH_BITS >= 8. Compare 2 bytes at a time at
1303          * strstart+3, +5, ... up to strstart+257. We check for insufficient
1304          * lookahead only every 4th comparison; the 128th check will be made
1305          * at strstart+257. If MAX_MATCH-2 is not a multiple of 8, it is
1306          * necessary to put more guard bytes at the end of the window, or
1307          * to check more often for insufficient lookahead.
1308          */
1309         Assert(scan[2] == match[2], "scan[2]?");
1310         scan++, match++;
1311         do {
1312         } while (*(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1313                  *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1314                  *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1315                  *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1316                  scan < strend);
1317         /* The funny "do {}" generates better code on most compilers */
1318
1319         /* Here, scan <= window+strstart+257 */
1320         Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1321         if (*scan == *match) scan++;
1322
1323         len = (MAX_MATCH - 1) - (int)(strend-scan);
1324         scan = strend - (MAX_MATCH-1);
1325
1326 #else /* UNALIGNED_OK */
1327
1328         if (match[best_len]   != scan_end  ||
1329             match[best_len-1] != scan_end1 ||
1330             *match            != *scan     ||
1331             *++match          != scan[1])      continue;
1332
1333         /* The check at best_len-1 can be removed because it will be made
1334          * again later. (This heuristic is not always a win.)
1335          * It is not necessary to compare scan[2] and match[2] since they
1336          * are always equal when the other bytes match, given that
1337          * the hash keys are equal and that HASH_BITS >= 8.
1338          */
1339         scan += 2, match++;
1340         Assert(*scan == *match, "match[2]?");
1341
1342         /* We check for insufficient lookahead only every 8th comparison;
1343          * the 256th check will be made at strstart+258.
1344          */
1345         do {
1346         } while (*++scan == *++match && *++scan == *++match &&
1347                  *++scan == *++match && *++scan == *++match &&
1348                  *++scan == *++match && *++scan == *++match &&
1349                  *++scan == *++match && *++scan == *++match &&
1350                  scan < strend);
1351
1352         Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1353
1354         len = MAX_MATCH - (int)(strend - scan);
1355         scan = strend - MAX_MATCH;
1356
1357 #endif /* UNALIGNED_OK */
1358
1359         if (len > best_len) {
1360             s->match_start = cur_match;
1361             best_len = len;
1362             if (len >= nice_match) break;
1363 #ifdef UNALIGNED_OK
1364             scan_end = *(ushf*)(scan+best_len-1);
1365 #else
1366             scan_end1  = scan[best_len-1];
1367             scan_end   = scan[best_len];
1368 #endif
1369         }
1370     } while ((cur_match = prev[cur_match & wmask]) > limit
1371              && --chain_length != 0);
1372
1373     if ((uInt)best_len <= s->lookahead) return (uInt)best_len;
1374     return s->lookahead;
1375 }
1376 #endif /* ASMV */
1377
1378 #else /* FASTEST */
1379
1380 /* ---------------------------------------------------------------------------
1381  * Optimized version for FASTEST only
1382  */
1383 local uInt longest_match(s, cur_match)
1384     deflate_state *s;
1385     IPos cur_match;                             /* current match */
1386 {
1387     register Bytef *scan = s->window + s->strstart; /* current string */
1388     register Bytef *match;                       /* matched string */
1389     register int len;                           /* length of current match */
1390     register Bytef *strend = s->window + s->strstart + MAX_MATCH;
1391
1392     /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
1393      * It is easy to get rid of this optimization if necessary.
1394      */
1395     Assert(s->hash_bits >= 8 && MAX_MATCH == 258, "Code too clever");
1396
1397     Assert((ulg)s->strstart <= s->window_size-MIN_LOOKAHEAD, "need lookahead");
1398
1399     Assert(cur_match < s->strstart, "no future");
1400
1401     match = s->window + cur_match;
1402
1403     /* Return failure if the match length is less than 2:
1404      */
1405     if (match[0] != scan[0] || match[1] != scan[1]) return MIN_MATCH-1;
1406
1407     /* The check at best_len-1 can be removed because it will be made
1408      * again later. (This heuristic is not always a win.)
1409      * It is not necessary to compare scan[2] and match[2] since they
1410      * are always equal when the other bytes match, given that
1411      * the hash keys are equal and that HASH_BITS >= 8.
1412      */
1413     scan += 2, match += 2;
1414     Assert(*scan == *match, "match[2]?");
1415
1416     /* We check for insufficient lookahead only every 8th comparison;
1417      * the 256th check will be made at strstart+258.
1418      */
1419     do {
1420     } while (*++scan == *++match && *++scan == *++match &&
1421              *++scan == *++match && *++scan == *++match &&
1422              *++scan == *++match && *++scan == *++match &&
1423              *++scan == *++match && *++scan == *++match &&
1424              scan < strend);
1425
1426     Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1427
1428     len = MAX_MATCH - (int)(strend - scan);
1429
1430     if (len < MIN_MATCH) return MIN_MATCH - 1;
1431
1432     s->match_start = cur_match;
1433     return (uInt)len <= s->lookahead ? (uInt)len : s->lookahead;
1434 }
1435
1436 #endif /* FASTEST */
1437
1438 #ifdef ZLIB_DEBUG
1439
1440 #define EQUAL 0
1441 /* result of memcmp for equal strings */
1442
1443 /* ===========================================================================
1444  * Check that the match at match_start is indeed a match.
1445  */
1446 local void check_match(s, start, match, length)
1447     deflate_state *s;
1448     IPos start, match;
1449     int length;
1450 {
1451     /* check that the match is indeed a match */
1452     if (zmemcmp(s->window + match,
1453                 s->window + start, length) != EQUAL) {
1454         fprintf(stderr, " start %u, match %u, length %d\n",
1455                 start, match, length);
1456         do {
1457             fprintf(stderr, "%c%c", s->window[match++], s->window[start++]);
1458         } while (--length != 0);
1459         z_error("invalid match");
1460     }
1461     if (z_verbose > 1) {
1462         fprintf(stderr,"\\[%d,%d]", start-match, length);
1463         do { putc(s->window[start++], stderr); } while (--length != 0);
1464     }
1465 }
1466 #else
1467 #  define check_match(s, start, match, length)
1468 #endif /* ZLIB_DEBUG */
1469
1470 /* ===========================================================================
1471  * Fill the window when the lookahead becomes insufficient.
1472  * Updates strstart and lookahead.
1473  *
1474  * IN assertion: lookahead < MIN_LOOKAHEAD
1475  * OUT assertions: strstart <= window_size-MIN_LOOKAHEAD
1476  *    At least one byte has been read, or avail_in == 0; reads are
1477  *    performed for at least two bytes (required for the zip translate_eol
1478  *    option -- not supported here).
1479  */
1480 local void fill_window(s)
1481     deflate_state *s;
1482 {
1483     unsigned n;
1484     unsigned more;    /* Amount of free space at the end of the window. */
1485     uInt wsize = s->w_size;
1486
1487     Assert(s->lookahead < MIN_LOOKAHEAD, "already enough lookahead");
1488
1489     do {
1490         more = (unsigned)(s->window_size -(ulg)s->lookahead -(ulg)s->strstart);
1491
1492         /* Deal with !@#$% 64K limit: */
1493         if (sizeof(int) <= 2) {
1494             if (more == 0 && s->strstart == 0 && s->lookahead == 0) {
1495                 more = wsize;
1496
1497             } else if (more == (unsigned)(-1)) {
1498                 /* Very unlikely, but possible on 16 bit machine if
1499                  * strstart == 0 && lookahead == 1 (input done a byte at time)
1500                  */
1501                 more--;
1502             }
1503         }
1504
1505         /* If the window is almost full and there is insufficient lookahead,
1506          * move the upper half to the lower one to make room in the upper half.
1507          */
1508         if (s->strstart >= wsize+MAX_DIST(s)) {
1509
1510             zmemcpy(s->window, s->window+wsize, (unsigned)wsize - more);
1511             s->match_start -= wsize;
1512             s->strstart    -= wsize; /* we now have strstart >= MAX_DIST */
1513             s->block_start -= (long) wsize;
1514             slide_hash(s);
1515             more += wsize;
1516         }
1517         if (s->strm->avail_in == 0) break;
1518
1519         /* If there was no sliding:
1520          *    strstart <= WSIZE+MAX_DIST-1 && lookahead <= MIN_LOOKAHEAD - 1 &&
1521          *    more == window_size - lookahead - strstart
1522          * => more >= window_size - (MIN_LOOKAHEAD-1 + WSIZE + MAX_DIST-1)
1523          * => more >= window_size - 2*WSIZE + 2
1524          * In the BIG_MEM or MMAP case (not yet supported),
1525          *   window_size == input_size + MIN_LOOKAHEAD  &&
1526          *   strstart + s->lookahead <= input_size => more >= MIN_LOOKAHEAD.
1527          * Otherwise, window_size == 2*WSIZE so more >= 2.
1528          * If there was sliding, more >= WSIZE. So in all cases, more >= 2.
1529          */
1530         Assert(more >= 2, "more < 2");
1531
1532         n = read_buf(s->strm, s->window + s->strstart + s->lookahead, more);
1533         s->lookahead += n;
1534
1535         /* Initialize the hash value now that we have some input: */
1536         if (s->lookahead + s->insert >= MIN_MATCH) {
1537             uInt str = s->strstart - s->insert;
1538             s->ins_h = s->window[str];
1539             UPDATE_HASH(s, s->ins_h, s->window[str + 1]);
1540 #if MIN_MATCH != 3
1541             Call UPDATE_HASH() MIN_MATCH-3 more times
1542 #endif
1543             while (s->insert) {
1544                 UPDATE_HASH(s, s->ins_h, s->window[str + MIN_MATCH-1]);
1545 #ifndef FASTEST
1546                 s->prev[str & s->w_mask] = s->head[s->ins_h];
1547 #endif
1548                 s->head[s->ins_h] = (Pos)str;
1549                 str++;
1550                 s->insert--;
1551                 if (s->lookahead + s->insert < MIN_MATCH)
1552                     break;
1553             }
1554         }
1555         /* If the whole input has less than MIN_MATCH bytes, ins_h is garbage,
1556          * but this is not important since only literal bytes will be emitted.
1557          */
1558
1559     } while (s->lookahead < MIN_LOOKAHEAD && s->strm->avail_in != 0);
1560
1561     /* If the WIN_INIT bytes after the end of the current data have never been
1562      * written, then zero those bytes in order to avoid memory check reports of
1563      * the use of uninitialized (or uninitialised as Julian writes) bytes by
1564      * the longest match routines.  Update the high water mark for the next
1565      * time through here.  WIN_INIT is set to MAX_MATCH since the longest match
1566      * routines allow scanning to strstart + MAX_MATCH, ignoring lookahead.
1567      */
1568     if (s->high_water < s->window_size) {
1569         ulg curr = s->strstart + (ulg)(s->lookahead);
1570         ulg init;
1571
1572         if (s->high_water < curr) {
1573             /* Previous high water mark below current data -- zero WIN_INIT
1574              * bytes or up to end of window, whichever is less.
1575              */
1576             init = s->window_size - curr;
1577             if (init > WIN_INIT)
1578                 init = WIN_INIT;
1579             zmemzero(s->window + curr, (unsigned)init);
1580             s->high_water = curr + init;
1581         }
1582         else if (s->high_water < (ulg)curr + WIN_INIT) {
1583             /* High water mark at or above current data, but below current data
1584              * plus WIN_INIT -- zero out to current data plus WIN_INIT, or up
1585              * to end of window, whichever is less.
1586              */
1587             init = (ulg)curr + WIN_INIT - s->high_water;
1588             if (init > s->window_size - s->high_water)
1589                 init = s->window_size - s->high_water;
1590             zmemzero(s->window + s->high_water, (unsigned)init);
1591             s->high_water += init;
1592         }
1593     }
1594
1595     Assert((ulg)s->strstart <= s->window_size - MIN_LOOKAHEAD,
1596            "not enough room for search");
1597 }
1598
1599 /* ===========================================================================
1600  * Flush the current block, with given end-of-file flag.
1601  * IN assertion: strstart is set to the end of the current match.
1602  */
1603 #define FLUSH_BLOCK_ONLY(s, last) { \
1604    _tr_flush_block(s, (s->block_start >= 0L ? \
1605                    (charf *)&s->window[(unsigned)s->block_start] : \
1606                    (charf *)Z_NULL), \
1607                 (ulg)((long)s->strstart - s->block_start), \
1608                 (last)); \
1609    s->block_start = s->strstart; \
1610    flush_pending(s->strm); \
1611    Tracev((stderr,"[FLUSH]")); \
1612 }
1613
1614 /* Same but force premature exit if necessary. */
1615 #define FLUSH_BLOCK(s, last) { \
1616    FLUSH_BLOCK_ONLY(s, last); \
1617    if (s->strm->avail_out == 0) return (last) ? finish_started : need_more; \
1618 }
1619
1620 /* Maximum stored block length in deflate format (not including header). */
1621 #define MAX_STORED 65535
1622
1623 /* Minimum of a and b. */
1624 #define MIN(a, b) ((a) > (b) ? (b) : (a))
1625
1626 /* ===========================================================================
1627  * Copy without compression as much as possible from the input stream, return
1628  * the current block state.
1629  *
1630  * In case deflateParams() is used to later switch to a non-zero compression
1631  * level, s->matches (otherwise unused when storing) keeps track of the number
1632  * of hash table slides to perform. If s->matches is 1, then one hash table
1633  * slide will be done when switching. If s->matches is 2, the maximum value
1634  * allowed here, then the hash table will be cleared, since two or more slides
1635  * is the same as a clear.
1636  *
1637  * deflate_stored() is written to minimize the number of times an input byte is
1638  * copied. It is most efficient with large input and output buffers, which
1639  * maximizes the opportunites to have a single copy from next_in to next_out.
1640  */
1641 local block_state deflate_stored(s, flush)
1642     deflate_state *s;
1643     int flush;
1644 {
1645     /* Smallest worthy block size when not flushing or finishing. By default
1646      * this is 32K. This can be as small as 507 bytes for memLevel == 1. For
1647      * large input and output buffers, the stored block size will be larger.
1648      */
1649     unsigned min_block = MIN(s->pending_buf_size - 5, s->w_size);
1650
1651     /* Copy as many min_block or larger stored blocks directly to next_out as
1652      * possible. If flushing, copy the remaining available input to next_out as
1653      * stored blocks, if there is enough space.
1654      */
1655     unsigned len, left, have, last;
1656     unsigned used = s->strm->avail_in;
1657     for (;;) {
1658         /* Set len to the maximum size block that we can copy directly with the
1659          * available input data and output space. Set left to how much of that
1660          * would be copied from what's left in the window.
1661          */
1662         len = MAX_STORED;       /* maximum deflate stored block length */
1663         have = (s->bi_valid + 42) >> 3;         /* number of header bytes */
1664             /* maximum stored block length that will fit in avail_out: */
1665         have = s->strm->avail_out > have ? s->strm->avail_out - have : 0;
1666         left = s->strstart - s->block_start;    /* bytes left in window */
1667         if (len > (ulg)left + s->strm->avail_in)
1668             len = left + s->strm->avail_in;     /* limit len to the input */
1669         if (len > have)
1670             len = have;                         /* limit len to the output */
1671         if (left > len)
1672             left = len;                         /* limit window pull to len */
1673
1674         /* If the stored block would be less than min_block in length, or if
1675          * unable to copy all of the available input when flushing, then try
1676          * copying to the window and the pending buffer instead. Also don't
1677          * write an empty block when flushing -- deflate() does that.
1678          */
1679         if (len < min_block && (len == 0 || flush == Z_NO_FLUSH ||
1680                                 len - left != s->strm->avail_in))
1681             break;
1682
1683         /* Make a dummy stored block in pending to get the header bytes,
1684          * including any pending bits. This also updates the debugging counts.
1685          */
1686         last = flush == Z_FINISH && len - left == s->strm->avail_in ? 1 : 0;
1687         _tr_stored_block(s, (char *)0, 0L, last);
1688
1689         /* Replace the lengths in the dummy stored block with len. */
1690         s->pending_buf[s->pending - 4] = len;
1691         s->pending_buf[s->pending - 3] = len >> 8;
1692         s->pending_buf[s->pending - 2] = ~len;
1693         s->pending_buf[s->pending - 1] = ~len >> 8;
1694
1695         /* Write the stored block header bytes. */
1696         flush_pending(s->strm);
1697
1698         /* Update debugging counts for the data about to be copied. */
1699 #ifdef ZLIB_DEBUG
1700         s->compressed_len += len << 3;
1701         s->bits_sent += len << 3;
1702 #endif
1703
1704         /* Copy uncompressed bytes from the window to next_out. */
1705         if (left) {
1706             zmemcpy(s->strm->next_out, s->window + s->block_start, left);
1707             s->strm->next_out += left;
1708             s->strm->avail_out -= left;
1709             s->strm->total_out += left;
1710             s->block_start += left;
1711             len -= left;
1712         }
1713
1714         /* Copy uncompressed bytes directly from next_in to next_out, updating
1715          * the check value.
1716          */
1717         if (len) {
1718             read_buf(s->strm, s->strm->next_out, len);
1719             s->strm->next_out += len;
1720             s->strm->avail_out -= len;
1721             s->strm->total_out += len;
1722         }
1723     }
1724
1725     /* Update the sliding window with the last s->w_size bytes of the copied
1726      * data, or append all of the copied data to the existing window if less
1727      * than s->w_size bytes were copied. Also update the number of bytes to
1728      * insert in the hash tables, in the event that deflateParams() switches to
1729      * a non-zero compression level.
1730      */
1731     used -= s->strm->avail_in;      /* number of input bytes directly copied */
1732     if (used) {
1733         /* If any input was used, then no unused input remains in the window,
1734          * therefore s->block_start == s->strstart.
1735          */
1736         if (used >= s->w_size) {    /* supplant the previous history */
1737             s->matches = 2;         /* clear hash */
1738             zmemcpy(s->window, s->strm->next_in - s->w_size, s->w_size);
1739             s->strstart = s->w_size;
1740         }
1741         else {
1742             if (s->window_size - s->strstart <= used) {
1743                 /* Slide the window down. */
1744                 s->strstart -= s->w_size;
1745                 zmemcpy(s->window, s->window + s->w_size, s->strstart);
1746                 if (s->matches < 2)
1747                     s->matches++;   /* add a pending slide_hash() */
1748             }
1749             zmemcpy(s->window + s->strstart, s->strm->next_in - used, used);
1750             s->strstart += used;
1751         }
1752         s->block_start = s->strstart;
1753         s->insert += MIN(used, s->w_size - s->insert);
1754     }
1755
1756     /* If flushing or finishing and all input has been consumed, then done. If
1757      * the code above couldn't write a complete block to next_out, then the
1758      * code following this won't be able to either.
1759      */
1760     if (flush != Z_NO_FLUSH && s->strm->avail_in == 0 &&
1761         s->strstart == s->block_start)
1762         return flush == Z_FINISH ? finish_done : block_done;
1763
1764     /* Fill the window with any remaining input. */
1765     have = s->window_size - s->strstart - 1;
1766     if (s->strm->avail_in > have && s->block_start >= s->w_size) {
1767         /* Slide the window down. */
1768         s->block_start -= s->w_size;
1769         s->strstart -= s->w_size;
1770         zmemcpy(s->window, s->window + s->w_size, s->strstart);
1771         if (s->matches < 2)
1772             s->matches++;           /* add a pending slide_hash() */
1773         have += s->w_size;          /* more space now */
1774     }
1775     if (have > s->strm->avail_in)
1776         have = s->strm->avail_in;
1777     if (have) {
1778         read_buf(s->strm, s->window + s->strstart, have);
1779         s->strstart += have;
1780     }
1781
1782     /* There was not enough avail_out to write a complete worthy or flushed
1783      * stored block to next_out. Write a stored block to pending instead, if we
1784      * have enough input for a worthy block, or if flushing and there is enough
1785      * room for the remaining input as a stored block in the pending buffer.
1786      */
1787     have = (s->bi_valid + 42) >> 3;         /* number of header bytes */
1788         /* maximum stored block length that will fit in pending: */
1789     have = MIN(s->pending_buf_size - have, MAX_STORED);
1790     min_block = MIN(have, s->w_size);
1791     left = s->strstart - s->block_start;
1792     if (left >= min_block ||
1793         (left && flush != Z_NO_FLUSH && s->strm->avail_in == 0 &&
1794          left <= have)) {
1795         len = MIN(left, have);
1796         last = flush == Z_FINISH && s->strm->avail_in == 0 &&
1797                len == left ? 1 : 0;
1798         _tr_stored_block(s, (charf *)s->window + s->block_start, len, last);
1799         s->block_start += len;
1800         flush_pending(s->strm);
1801         if (last)
1802             return finish_started;
1803     }
1804
1805     /* We've done all we can with the available input and output. */
1806     return need_more;
1807 }
1808
1809 /* ===========================================================================
1810  * Compress as much as possible from the input stream, return the current
1811  * block state.
1812  * This function does not perform lazy evaluation of matches and inserts
1813  * new strings in the dictionary only for unmatched strings or for short
1814  * matches. It is used only for the fast compression options.
1815  */
1816 local block_state deflate_fast(s, flush)
1817     deflate_state *s;
1818     int flush;
1819 {
1820     IPos hash_head;       /* head of the hash chain */
1821     int bflush;           /* set if current block must be flushed */
1822
1823     for (;;) {
1824         /* Make sure that we always have enough lookahead, except
1825          * at the end of the input file. We need MAX_MATCH bytes
1826          * for the next match, plus MIN_MATCH bytes to insert the
1827          * string following the next match.
1828          */
1829         if (s->lookahead < MIN_LOOKAHEAD) {
1830             fill_window(s);
1831             if (s->lookahead < MIN_LOOKAHEAD && flush == Z_NO_FLUSH) {
1832                 return need_more;
1833             }
1834             if (s->lookahead == 0) break; /* flush the current block */
1835         }
1836
1837         /* Insert the string window[strstart .. strstart+2] in the
1838          * dictionary, and set hash_head to the head of the hash chain:
1839          */
1840         hash_head = NIL;
1841         if (s->lookahead >= MIN_MATCH) {
1842             INSERT_STRING(s, s->strstart, hash_head);
1843         }
1844
1845         /* Find the longest match, discarding those <= prev_length.
1846          * At this point we have always match_length < MIN_MATCH
1847          */
1848         if (hash_head != NIL && s->strstart - hash_head <= MAX_DIST(s)) {
1849             /* To simplify the code, we prevent matches with the string
1850              * of window index 0 (in particular we have to avoid a match
1851              * of the string with itself at the start of the input file).
1852              */
1853             s->match_length = longest_match (s, hash_head);
1854             /* longest_match() sets match_start */
1855         }
1856         if (s->match_length >= MIN_MATCH) {
1857             check_match(s, s->strstart, s->match_start, s->match_length);
1858
1859             _tr_tally_dist(s, s->strstart - s->match_start,
1860                            s->match_length - MIN_MATCH, bflush);
1861
1862             s->lookahead -= s->match_length;
1863
1864             /* Insert new strings in the hash table only if the match length
1865              * is not too large. This saves time but degrades compression.
1866              */
1867 #ifndef FASTEST
1868             if (s->match_length <= s->max_insert_length &&
1869                 s->lookahead >= MIN_MATCH) {
1870                 s->match_length--; /* string at strstart already in table */
1871                 do {
1872                     s->strstart++;
1873                     INSERT_STRING(s, s->strstart, hash_head);
1874                     /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1875                      * always MIN_MATCH bytes ahead.
1876                      */
1877                 } while (--s->match_length != 0);
1878                 s->strstart++;
1879             } else
1880 #endif
1881             {
1882                 s->strstart += s->match_length;
1883                 s->match_length = 0;
1884                 s->ins_h = s->window[s->strstart];
1885                 UPDATE_HASH(s, s->ins_h, s->window[s->strstart+1]);
1886 #if MIN_MATCH != 3
1887                 Call UPDATE_HASH() MIN_MATCH-3 more times
1888 #endif
1889                 /* If lookahead < MIN_MATCH, ins_h is garbage, but it does not
1890                  * matter since it will be recomputed at next deflate call.
1891                  */
1892             }
1893         } else {
1894             /* No match, output a literal byte */
1895             Tracevv((stderr,"%c", s->window[s->strstart]));
1896             _tr_tally_lit (s, s->window[s->strstart], bflush);
1897             s->lookahead--;
1898             s->strstart++;
1899         }
1900         if (bflush) FLUSH_BLOCK(s, 0);
1901     }
1902     s->insert = s->strstart < MIN_MATCH-1 ? s->strstart : MIN_MATCH-1;
1903     if (flush == Z_FINISH) {
1904         FLUSH_BLOCK(s, 1);
1905         return finish_done;
1906     }
1907     if (s->last_lit)
1908         FLUSH_BLOCK(s, 0);
1909     return block_done;
1910 }
1911
1912 #ifndef FASTEST
1913 /* ===========================================================================
1914  * Same as above, but achieves better compression. We use a lazy
1915  * evaluation for matches: a match is finally adopted only if there is
1916  * no better match at the next window position.
1917  */
1918 local block_state deflate_slow(s, flush)
1919     deflate_state *s;
1920     int flush;
1921 {
1922     IPos hash_head;          /* head of hash chain */
1923     int bflush;              /* set if current block must be flushed */
1924
1925     /* Process the input block. */
1926     for (;;) {
1927         /* Make sure that we always have enough lookahead, except
1928          * at the end of the input file. We need MAX_MATCH bytes
1929          * for the next match, plus MIN_MATCH bytes to insert the
1930          * string following the next match.
1931          */
1932         if (s->lookahead < MIN_LOOKAHEAD) {
1933             fill_window(s);
1934             if (s->lookahead < MIN_LOOKAHEAD && flush == Z_NO_FLUSH) {
1935                 return need_more;
1936             }
1937             if (s->lookahead == 0) break; /* flush the current block */
1938         }
1939
1940         /* Insert the string window[strstart .. strstart+2] in the
1941          * dictionary, and set hash_head to the head of the hash chain:
1942          */
1943         hash_head = NIL;
1944         if (s->lookahead >= MIN_MATCH) {
1945             INSERT_STRING(s, s->strstart, hash_head);
1946         }
1947
1948         /* Find the longest match, discarding those <= prev_length.
1949          */
1950         s->prev_length = s->match_length, s->prev_match = s->match_start;
1951         s->match_length = MIN_MATCH-1;
1952
1953         if (hash_head != NIL && s->prev_length < s->max_lazy_match &&
1954             s->strstart - hash_head <= MAX_DIST(s)) {
1955             /* To simplify the code, we prevent matches with the string
1956              * of window index 0 (in particular we have to avoid a match
1957              * of the string with itself at the start of the input file).
1958              */
1959             s->match_length = longest_match (s, hash_head);
1960             /* longest_match() sets match_start */
1961
1962             if (s->match_length <= 5 && (s->strategy == Z_FILTERED
1963 #if TOO_FAR <= 32767
1964                 || (s->match_length == MIN_MATCH &&
1965                     s->strstart - s->match_start > TOO_FAR)
1966 #endif
1967                 )) {
1968
1969                 /* If prev_match is also MIN_MATCH, match_start is garbage
1970                  * but we will ignore the current match anyway.
1971                  */
1972                 s->match_length = MIN_MATCH-1;
1973             }
1974         }
1975         /* If there was a match at the previous step and the current
1976          * match is not better, output the previous match:
1977          */
1978         if (s->prev_length >= MIN_MATCH && s->match_length <= s->prev_length) {
1979             uInt max_insert = s->strstart + s->lookahead - MIN_MATCH;
1980             /* Do not insert strings in hash table beyond this. */
1981
1982             check_match(s, s->strstart-1, s->prev_match, s->prev_length);
1983
1984             _tr_tally_dist(s, s->strstart -1 - s->prev_match,
1985                            s->prev_length - MIN_MATCH, bflush);
1986
1987             /* Insert in hash table all strings up to the end of the match.
1988              * strstart-1 and strstart are already inserted. If there is not
1989              * enough lookahead, the last two strings are not inserted in
1990              * the hash table.
1991              */
1992             s->lookahead -= s->prev_length-1;
1993             s->prev_length -= 2;
1994             do {
1995                 if (++s->strstart <= max_insert) {
1996                     INSERT_STRING(s, s->strstart, hash_head);
1997                 }
1998             } while (--s->prev_length != 0);
1999             s->match_available = 0;
2000             s->match_length = MIN_MATCH-1;
2001             s->strstart++;
2002
2003             if (bflush) FLUSH_BLOCK(s, 0);
2004
2005         } else if (s->match_available) {
2006             /* If there was no match at the previous position, output a
2007              * single literal. If there was a match but the current match
2008              * is longer, truncate the previous match to a single literal.
2009              */
2010             Tracevv((stderr,"%c", s->window[s->strstart-1]));
2011             _tr_tally_lit(s, s->window[s->strstart-1], bflush);
2012             if (bflush) {
2013                 FLUSH_BLOCK_ONLY(s, 0);
2014             }
2015             s->strstart++;
2016             s->lookahead--;
2017             if (s->strm->avail_out == 0) return need_more;
2018         } else {
2019             /* There is no previous match to compare with, wait for
2020              * the next step to decide.
2021              */
2022             s->match_available = 1;
2023             s->strstart++;
2024             s->lookahead--;
2025         }
2026     }
2027     Assert (flush != Z_NO_FLUSH, "no flush?");
2028     if (s->match_available) {
2029         Tracevv((stderr,"%c", s->window[s->strstart-1]));
2030         _tr_tally_lit(s, s->window[s->strstart-1], bflush);
2031         s->match_available = 0;
2032     }
2033     s->insert = s->strstart < MIN_MATCH-1 ? s->strstart : MIN_MATCH-1;
2034     if (flush == Z_FINISH) {
2035         FLUSH_BLOCK(s, 1);
2036         return finish_done;
2037     }
2038     if (s->last_lit)
2039         FLUSH_BLOCK(s, 0);
2040     return block_done;
2041 }
2042 #endif /* FASTEST */
2043
2044 /* ===========================================================================
2045  * For Z_RLE, simply look for runs of bytes, generate matches only of distance
2046  * one.  Do not maintain a hash table.  (It will be regenerated if this run of
2047  * deflate switches away from Z_RLE.)
2048  */
2049 local block_state deflate_rle(s, flush)
2050     deflate_state *s;
2051     int flush;
2052 {
2053     int bflush;             /* set if current block must be flushed */
2054     uInt prev;              /* byte at distance one to match */
2055     Bytef *scan, *strend;   /* scan goes up to strend for length of run */
2056
2057     for (;;) {
2058         /* Make sure that we always have enough lookahead, except
2059          * at the end of the input file. We need MAX_MATCH bytes
2060          * for the longest run, plus one for the unrolled loop.
2061          */
2062         if (s->lookahead <= MAX_MATCH) {
2063             fill_window(s);
2064             if (s->lookahead <= MAX_MATCH && flush == Z_NO_FLUSH) {
2065                 return need_more;
2066             }
2067             if (s->lookahead == 0) break; /* flush the current block */
2068         }
2069
2070         /* See how many times the previous byte repeats */
2071         s->match_length = 0;
2072         if (s->lookahead >= MIN_MATCH && s->strstart > 0) {
2073             scan = s->window + s->strstart - 1;
2074             prev = *scan;
2075             if (prev == *++scan && prev == *++scan && prev == *++scan) {
2076                 strend = s->window + s->strstart + MAX_MATCH;
2077                 do {
2078                 } while (prev == *++scan && prev == *++scan &&
2079                          prev == *++scan && prev == *++scan &&
2080                          prev == *++scan && prev == *++scan &&
2081                          prev == *++scan && prev == *++scan &&
2082                          scan < strend);
2083                 s->match_length = MAX_MATCH - (uInt)(strend - scan);
2084                 if (s->match_length > s->lookahead)
2085                     s->match_length = s->lookahead;
2086             }
2087             Assert(scan <= s->window+(uInt)(s->window_size-1), "wild scan");
2088         }
2089
2090         /* Emit match if have run of MIN_MATCH or longer, else emit literal */
2091         if (s->match_length >= MIN_MATCH) {
2092             check_match(s, s->strstart, s->strstart - 1, s->match_length);
2093
2094             _tr_tally_dist(s, 1, s->match_length - MIN_MATCH, bflush);
2095
2096             s->lookahead -= s->match_length;
2097             s->strstart += s->match_length;
2098             s->match_length = 0;
2099         } else {
2100             /* No match, output a literal byte */
2101             Tracevv((stderr,"%c", s->window[s->strstart]));
2102             _tr_tally_lit (s, s->window[s->strstart], bflush);
2103             s->lookahead--;
2104             s->strstart++;
2105         }
2106         if (bflush) FLUSH_BLOCK(s, 0);
2107     }
2108     s->insert = 0;
2109     if (flush == Z_FINISH) {
2110         FLUSH_BLOCK(s, 1);
2111         return finish_done;
2112     }
2113     if (s->last_lit)
2114         FLUSH_BLOCK(s, 0);
2115     return block_done;
2116 }
2117
2118 /* ===========================================================================
2119  * For Z_HUFFMAN_ONLY, do not look for matches.  Do not maintain a hash table.
2120  * (It will be regenerated if this run of deflate switches away from Huffman.)
2121  */
2122 local block_state deflate_huff(s, flush)
2123     deflate_state *s;
2124     int flush;
2125 {
2126     int bflush;             /* set if current block must be flushed */
2127
2128     for (;;) {
2129         /* Make sure that we have a literal to write. */
2130         if (s->lookahead == 0) {
2131             fill_window(s);
2132             if (s->lookahead == 0) {
2133                 if (flush == Z_NO_FLUSH)
2134                     return need_more;
2135                 break;      /* flush the current block */
2136             }
2137         }
2138
2139         /* Output a literal byte */
2140         s->match_length = 0;
2141         Tracevv((stderr,"%c", s->window[s->strstart]));
2142         _tr_tally_lit (s, s->window[s->strstart], bflush);
2143         s->lookahead--;
2144         s->strstart++;
2145         if (bflush) FLUSH_BLOCK(s, 0);
2146     }
2147     s->insert = 0;
2148     if (flush == Z_FINISH) {
2149         FLUSH_BLOCK(s, 1);
2150         return finish_done;
2151     }
2152     if (s->last_lit)
2153         FLUSH_BLOCK(s, 0);
2154     return block_done;
2155 }