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