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 deflateResetKeep (strm)
 445     z_streamp strm;
 446 {
 447     deflate_state *s;
 448
 449     if (deflateStateCheck(strm)) {
 450         return Z_STREAM_ERROR;
 451     }
 452
 453     strm->total_in = strm->total_out = 0;
 454     strm->msg = Z_NULL; /* use zfree if we ever allocate msg dynamically */
 455     strm->data_type = Z_UNKNOWN;
 456
 457     s = (deflate_state *)strm->state;
 458     s->pending = 0;
 459     s->pending_out = s->pending_buf;
 460
 461     if (s->wrap < 0) {
 462         s->wrap = -s->wrap; /* was made negative by deflate(..., Z_FINISH); */
 463     }
 464     s->status =
 465 #ifdef GZIP
 466         s->wrap == 2 ? GZIP_STATE :
 467 #endif
 468         s->wrap ? INIT_STATE : BUSY_STATE;
 469     strm->adler =
 470 #ifdef GZIP
 471         s->wrap == 2 ? crc32(0L, Z_NULL, 0) :
 472 #endif
 473         adler32(0L, Z_NULL, 0);
 474     s->last_flush = Z_NO_FLUSH;
 475
 476     _tr_init(s);
 477
 478     return Z_OK;
 479 }
 480
 481 /* ========================================================================= */
 482 int ZEXPORT deflateReset (strm)
 483     z_streamp strm;
 484 {
 485     int ret;
 486
 487     ret = deflateResetKeep(strm);
 488     if (ret == Z_OK)
 489         lm_init(strm->state);
 490     return ret;
 491 }
 492
 493 /* ========================================================================= */
 494 int ZEXPORT deflateSetHeader (strm, head)
 495     z_streamp strm;
 496     gz_headerp head;
 497 {
 498     if (deflateStateCheck(strm) || strm->state->wrap != 2)
 499         return Z_STREAM_ERROR;
 500     strm->state->gzhead = head;
 501     return Z_OK;
 502 }
 503
 504 /* ========================================================================= */
 505 int ZEXPORT deflatePending (strm, pending, bits)
 506     unsigned *pending;
 507     int *bits;
 508     z_streamp strm;
 509 {
 510     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
 511     if (pending != Z_NULL)
 512         *pending = strm->state->pending;
 513     if (bits != Z_NULL)
 514         *bits = strm->state->bi_valid;
 515     return Z_OK;
 516 }
 517
 518 /* ========================================================================= */
 519 int ZEXPORT deflatePrime (strm, bits, value)
 520     z_streamp strm;
 521     int bits;
 522     int value;
 523 {
 524     deflate_state *s;
 525     int put;
 526
 527     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
 528     s = strm->state;
 529     if ((Bytef *)(s->d_buf) < s->pending_out + ((Buf_size + 7) >> 3))
 530         return Z_BUF_ERROR;
 531     do {
 532         put = Buf_size - s->bi_valid;
 533         if (put > bits)
 534             put = bits;
 535         s->bi_buf |= (ush)((value & ((1 << put) - 1)) << s->bi_valid);
 536         s->bi_valid += put;
 537         _tr_flush_bits(s);
 538         value >>= put;
 539         bits -= put;
 540     } while (bits);
 541     return Z_OK;
 542 }
 543
 544 /* ========================================================================= */
 545 int ZEXPORT deflateParams(strm, level, strategy)
 546     z_streamp strm;
 547     int level;
 548     int strategy;
 549 {
 550     deflate_state *s;
 551     compress_func func;
 552
 553     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
 554     s = strm->state;
 555
 556 #ifdef FASTEST
 557     if (level != 0) level = 1;
 558 #else
 559     if (level == Z_DEFAULT_COMPRESSION) level = 6;
 560 #endif
 561     if (level < 0 || level > 9 || strategy < 0 || strategy > Z_FIXED) {
 562         return Z_STREAM_ERROR;
 563     }
 564     func = configuration_table[s->level].func;
 565
 566     if ((strategy != s->strategy || func != configuration_table[level].func)) {
 567         /* Flush the last buffer: */
 568         int err = deflate(strm, Z_BLOCK);
 569         if (err == Z_STREAM_ERROR)
 570             return err;
 571         if (strm->avail_out == 0)
 572             return Z_BUF_ERROR;
 573     }
 574     if (s->level != level) {
 575         if (s->level == 0 && s->matches != 0) {
 576             if (s->matches == 1)
 577                 slide_hash(s);
 578             else
 579                 CLEAR_HASH(s);
 580             s->matches = 0;
 581         }
 582         s->level = level;
 583         s->max_lazy_match   = configuration_table[level].max_lazy;
 584         s->good_match       = configuration_table[level].good_length;
 585         s->nice_match       = configuration_table[level].nice_length;
 586         s->max_chain_length = configuration_table[level].max_chain;
 587     }
 588     s->strategy = strategy;
 589     return Z_OK;
 590 }
 591
 592 /* ========================================================================= */
 593 int ZEXPORT deflateTune(strm, good_length, max_lazy, nice_length, max_chain)
 594     z_streamp strm;
 595     int good_length;
 596     int max_lazy;
 597     int nice_length;
 598     int max_chain;
 599 {
 600     deflate_state *s;
 601
 602     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
 603     s = strm->state;
 604     s->good_match = (uInt)good_length;
 605     s->max_lazy_match = (uInt)max_lazy;
 606     s->nice_match = nice_length;
 607     s->max_chain_length = (uInt)max_chain;
 608     return Z_OK;
 609 }
 610
 611 /* =========================================================================
 612  * For the default windowBits of 15 and memLevel of 8, this function returns
 613  * a close to exact, as well as small, upper bound on the compressed size.
 614  * They are coded as constants here for a reason--if the #define's are
 615  * changed, then this function needs to be changed as well.  The return
 616  * value for 15 and 8 only works for those exact settings.
 617  *
 618  * For any setting other than those defaults for windowBits and memLevel,
 619  * the value returned is a conservative worst case for the maximum expansion
 620  * resulting from using fixed blocks instead of stored blocks, which deflate
 621  * can emit on compressed data for some combinations of the parameters.
 622  *
 623  * This function could be more sophisticated to provide closer upper bounds for
 624  * every combination of windowBits and memLevel.  But even the conservative
 625  * upper bound of about 14% expansion does not seem onerous for output buffer
 626  * allocation.
 627  */
 628 uLong ZEXPORT deflateBound(strm, sourceLen)
 629     z_streamp strm;
 630     uLong sourceLen;
 631 {
 632     deflate_state *s;
 633     uLong complen, wraplen;
 634
 635     /* conservative upper bound for compressed data */
 636     complen = sourceLen +
 637               ((sourceLen + 7) >> 3) + ((sourceLen + 63) >> 6) + 5;
 638
 639     /* if can't get parameters, return conservative bound plus zlib wrapper */
 640     if (deflateStateCheck(strm))
 641         return complen + 6;
 642
 643     /* compute wrapper length */
 644     s = strm->state;
 645     switch (s->wrap) {
 646     case 0:                                 /* raw deflate */
 647         wraplen = 0;
 648         break;
 649     case 1:                                 /* zlib wrapper */
 650         wraplen = 6 + (s->strstart ? 4 : 0);
 651         break;
 652 #ifdef GZIP
 653     case 2:                                 /* gzip wrapper */
 654         wraplen = 18;
 655         if (s->gzhead != Z_NULL) {          /* user-supplied gzip header */
 656             Bytef *str;
 657             if (s->gzhead->extra != Z_NULL)
 658                 wraplen += 2 + s->gzhead->extra_len;
 659             str = s->gzhead->name;
 660             if (str != Z_NULL)
 661                 do {
 662                     wraplen++;
 663                 } while (*str++);
 664             str = s->gzhead->comment;
 665             if (str != Z_NULL)
 666                 do {
 667                     wraplen++;
 668                 } while (*str++);
 669             if (s->gzhead->hcrc)
 670                 wraplen += 2;
 671         }
 672         break;
 673 #endif
 674     default:                                /* for compiler happiness */
 675         wraplen = 6;
 676     }
 677
 678     /* if not default parameters, return conservative bound */
 679     if (s->w_bits != 15 || s->hash_bits != 8 + 7)
 680         return complen + wraplen;
 681
 682     /* default settings: return tight bound for that case */
 683     return sourceLen + (sourceLen >> 12) + (sourceLen >> 14) +
 684            (sourceLen >> 25) + 13 - 6 + wraplen;
 685 }
 686
 687 /* =========================================================================
 688  * Put a short in the pending buffer. The 16-bit value is put in MSB order.
 689  * IN assertion: the stream state is correct and there is enough room in
 690  * pending_buf.
 691  */
 692 local void putShortMSB (s, b)
 693     deflate_state *s;
 694     uInt b;
 695 {
 696     put_byte(s, (Byte)(b >> 8));
 697     put_byte(s, (Byte)(b & 0xff));
 698 }
 699
 700 /* =========================================================================
 701  * Flush as much pending output as possible. All deflate() output, except for
 702  * some deflate_stored() output, goes through this function so some
 703  * applications may wish to modify it to avoid allocating a large
 704  * strm->next_out buffer and copying into it. (See also read_buf()).
 705  */
 706 local void flush_pending(strm)
 707     z_streamp strm;
 708 {
 709     unsigned len;
 710     deflate_state *s = strm->state;
 711
 712     _tr_flush_bits(s);
 713     len = s->pending;
 714     if (len > strm->avail_out) len = strm->avail_out;
 715     if (len == 0) return;
 716
 717     zmemcpy(strm->next_out, s->pending_out, len);
 718     strm->next_out  += len;
 719     s->pending_out  += len;
 720     strm->total_out += len;
 721     strm->avail_out -= len;
 722     s->pending      -= len;
 723     if (s->pending == 0) {
 724         s->pending_out = s->pending_buf;
 725     }
 726 }
 727
 728 /* ===========================================================================
 729  * Update the header CRC with the bytes s->pending_buf[beg..s->pending - 1].
 730  */
 731 #define HCRC_UPDATE(beg) \
 732     do { \
 733         if (s->gzhead->hcrc && s->pending > (beg)) \
 734             strm->adler = crc32(strm->adler, s->pending_buf + (beg), \
 735                                 s->pending - (beg)); \
 736     } while (0)
 737
 738 /* ========================================================================= */
 739 int ZEXPORT deflate (strm, flush)
 740     z_streamp strm;
 741     int flush;
 742 {
 743     int old_flush; /* value of flush param for previous deflate call */
 744     deflate_state *s;
 745
 746     if (deflateStateCheck(strm) || flush > Z_BLOCK || flush < 0) {
 747         return Z_STREAM_ERROR;
 748     }
 749     s = strm->state;
 750
 751     if (strm->next_out == Z_NULL ||
 752         (strm->avail_in != 0 && strm->next_in == Z_NULL) ||
 753         (s->status == FINISH_STATE && flush != Z_FINISH)) {
 754         ERR_RETURN(strm, Z_STREAM_ERROR);
 755     }
 756     if (strm->avail_out == 0) ERR_RETURN(strm, Z_BUF_ERROR);
 757
 758     old_flush = s->last_flush;
 759     s->last_flush = flush;
 760
 761     /* Flush as much pending output as possible */
 762     if (s->pending != 0) {
 763         flush_pending(strm);
 764         if (strm->avail_out == 0) {
 765             /* Since avail_out is 0, deflate will be called again with
 766              * more output space, but possibly with both pending and
 767              * avail_in equal to zero. There won't be anything to do,
 768              * but this is not an error situation so make sure we
 769              * return OK instead of BUF_ERROR at next call of deflate:
 770              */
 771             s->last_flush = -1;
 772             return Z_OK;
 773         }
 774
 775     /* Make sure there is something to do and avoid duplicate consecutive
 776      * flushes. For repeated and useless calls with Z_FINISH, we keep
 777      * returning Z_STREAM_END instead of Z_BUF_ERROR.
 778      */
 779     } else if (strm->avail_in == 0 && RANK(flush) <= RANK(old_flush) &&
 780                flush != Z_FINISH) {
 781         ERR_RETURN(strm, Z_BUF_ERROR);
 782     }
 783
 784     /* User must not provide more input after the first FINISH: */
 785     if (s->status == FINISH_STATE && strm->avail_in != 0) {
 786         ERR_RETURN(strm, Z_BUF_ERROR);
 787     }
 788
 789     /* Write the header */
 790     if (s->status == INIT_STATE) {
 791         /* zlib header */
 792         uInt header = (Z_DEFLATED + ((s->w_bits-8)<<4)) << 8;
 793         uInt level_flags;
 794
 795         if (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2)
 796             level_flags = 0;
 797         else if (s->level < 6)
 798             level_flags = 1;
 799         else if (s->level == 6)
 800             level_flags = 2;
 801         else
 802             level_flags = 3;
 803         header |= (level_flags << 6);
 804         if (s->strstart != 0) header |= PRESET_DICT;
 805         header += 31 - (header % 31);
 806
 807         putShortMSB(s, header);
 808
 809         /* Save the adler32 of the preset dictionary: */
 810         if (s->strstart != 0) {
 811             putShortMSB(s, (uInt)(strm->adler >> 16));
 812             putShortMSB(s, (uInt)(strm->adler & 0xffff));
 813         }
 814         strm->adler = adler32(0L, Z_NULL, 0);
 815         s->status = BUSY_STATE;
 816
 817         /* Compression must start with an empty pending buffer */
 818         flush_pending(strm);
 819         if (s->pending != 0) {
 820             s->last_flush = -1;
 821             return Z_OK;
 822         }
 823     }
 824 #ifdef GZIP
 825     if (s->status == GZIP_STATE) {
 826         /* gzip header */
 827         strm->adler = crc32(0L, Z_NULL, 0);
 828         put_byte(s, 31);
 829         put_byte(s, 139);
 830         put_byte(s, 8);
 831         if (s->gzhead == Z_NULL) {
 832             put_byte(s, 0);
 833             put_byte(s, 0);
 834             put_byte(s, 0);
 835             put_byte(s, 0);
 836             put_byte(s, 0);
 837             put_byte(s, s->level == 9 ? 2 :
 838                      (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2 ?
 839                       4 : 0));
 840             put_byte(s, OS_CODE);
 841             s->status = BUSY_STATE;
 842
 843             /* Compression must start with an empty pending buffer */
 844             flush_pending(strm);
 845             if (s->pending != 0) {
 846                 s->last_flush = -1;
 847                 return Z_OK;
 848             }
 849         }
 850         else {
 851             put_byte(s, (s->gzhead->text ? 1 : 0) +
 852                      (s->gzhead->hcrc ? 2 : 0) +
 853                      (s->gzhead->extra == Z_NULL ? 0 : 4) +
 854                      (s->gzhead->name == Z_NULL ? 0 : 8) +
 855                      (s->gzhead->comment == Z_NULL ? 0 : 16)
 856                      );
 857             put_byte(s, (Byte)(s->gzhead->time & 0xff));
 858             put_byte(s, (Byte)((s->gzhead->time >> 8) & 0xff));
 859             put_byte(s, (Byte)((s->gzhead->time >> 16) & 0xff));
 860             put_byte(s, (Byte)((s->gzhead->time >> 24) & 0xff));
 861             put_byte(s, s->level == 9 ? 2 :
 862                      (s->strategy >= Z_HUFFMAN_ONLY || s->level < 2 ?
 863                       4 : 0));
 864             put_byte(s, s->gzhead->os & 0xff);
 865             if (s->gzhead->extra != Z_NULL) {
 866                 put_byte(s, s->gzhead->extra_len & 0xff);
 867                 put_byte(s, (s->gzhead->extra_len >> 8) & 0xff);
 868             }
 869             if (s->gzhead->hcrc)
 870                 strm->adler = crc32(strm->adler, s->pending_buf,
 871                                     s->pending);
 872             s->gzindex = 0;
 873             s->status = EXTRA_STATE;
 874         }
 875     }
 876     if (s->status == EXTRA_STATE) {
 877         if (s->gzhead->extra != Z_NULL) {
 878             ulg beg = s->pending;   /* start of bytes to update crc */
 879             uInt left = (s->gzhead->extra_len & 0xffff) - s->gzindex;
 880             while (s->pending + left > s->pending_buf_size) {
 881                 uInt copy = s->pending_buf_size - s->pending;
 882                 zmemcpy(s->pending_buf + s->pending,
 883                         s->gzhead->extra + s->gzindex, copy);
 884                 s->pending = s->pending_buf_size;
 885                 HCRC_UPDATE(beg);
 886                 s->gzindex += copy;
 887                 flush_pending(strm);
 888                 if (s->pending != 0) {
 889                     s->last_flush = -1;
 890                     return Z_OK;
 891                 }
 892                 beg = 0;
 893                 left -= copy;
 894             }
 895             zmemcpy(s->pending_buf + s->pending,
 896                     s->gzhead->extra + s->gzindex, left);
 897             s->pending += left;
 898             HCRC_UPDATE(beg);
 899             s->gzindex = 0;
 900         }
 901         s->status = NAME_STATE;
 902     }
 903     if (s->status == NAME_STATE) {
 904         if (s->gzhead->name != Z_NULL) {
 905             ulg beg = s->pending;   /* start of bytes to update crc */
 906             int val;
 907             do {
 908                 if (s->pending == s->pending_buf_size) {
 909                     HCRC_UPDATE(beg);
 910                     flush_pending(strm);
 911                     if (s->pending != 0) {
 912                         s->last_flush = -1;
 913                         return Z_OK;
 914                     }
 915                     beg = 0;
 916                 }
 917                 val = s->gzhead->name[s->gzindex++];
 918                 put_byte(s, val);
 919             } while (val != 0);
 920             HCRC_UPDATE(beg);
 921             s->gzindex = 0;
 922         }
 923         s->status = COMMENT_STATE;
 924     }
 925     if (s->status == COMMENT_STATE) {
 926         if (s->gzhead->comment != Z_NULL) {
 927             ulg beg = s->pending;   /* start of bytes to update crc */
 928             int val;
 929             do {
 930                 if (s->pending == s->pending_buf_size) {
 931                     HCRC_UPDATE(beg);
 932                     flush_pending(strm);
 933                     if (s->pending != 0) {
 934                         s->last_flush = -1;
 935                         return Z_OK;
 936                     }
 937                     beg = 0;
 938                 }
 939                 val = s->gzhead->comment[s->gzindex++];
 940                 put_byte(s, val);
 941             } while (val != 0);
 942             HCRC_UPDATE(beg);
 943         }
 944         s->status = HCRC_STATE;
 945     }
 946     if (s->status == HCRC_STATE) {
 947         if (s->gzhead->hcrc) {
 948             if (s->pending + 2 > s->pending_buf_size) {
 949                 flush_pending(strm);
 950                 if (s->pending != 0) {
 951                     s->last_flush = -1;
 952                     return Z_OK;
 953                 }
 954             }
 955             put_byte(s, (Byte)(strm->adler & 0xff));
 956             put_byte(s, (Byte)((strm->adler >> 8) & 0xff));
 957             strm->adler = crc32(0L, Z_NULL, 0);
 958         }
 959         s->status = BUSY_STATE;
 960
 961         /* Compression must start with an empty pending buffer */
 962         flush_pending(strm);
 963         if (s->pending != 0) {
 964             s->last_flush = -1;
 965             return Z_OK;
 966         }
 967     }
 968 #endif
 969
 970     /* Start a new block or continue the current one.
 971      */
 972     if (strm->avail_in != 0 || s->lookahead != 0 ||
 973         (flush != Z_NO_FLUSH && s->status != FINISH_STATE)) {
 974         block_state bstate;
 975
 976         bstate = s->level == 0 ? deflate_stored(s, flush) :
 977                  s->strategy == Z_HUFFMAN_ONLY ? deflate_huff(s, flush) :
 978                  s->strategy == Z_RLE ? deflate_rle(s, flush) :
 979                  (*(configuration_table[s->level].func))(s, flush);
 980
 981         if (bstate == finish_started || bstate == finish_done) {
 982             s->status = FINISH_STATE;
 983         }
 984         if (bstate == need_more || bstate == finish_started) {
 985             if (strm->avail_out == 0) {
 986                 s->last_flush = -1; /* avoid BUF_ERROR next call, see above */
 987             }
 988             return Z_OK;
 989             /* If flush != Z_NO_FLUSH && avail_out == 0, the next call
 990              * of deflate should use the same flush parameter to make sure
 991              * that the flush is complete. So we don't have to output an
 992              * empty block here, this will be done at next call. This also
 993              * ensures that for a very small output buffer, we emit at most
 994              * one empty block.
 995              */
 996         }
 997         if (bstate == block_done) {
 998             if (flush == Z_PARTIAL_FLUSH) {
 999                 _tr_align(s);
1000             } else if (flush != Z_BLOCK) { /* FULL_FLUSH or SYNC_FLUSH */
1001                 _tr_stored_block(s, (char*)0, 0L, 0);
1002                 /* For a full flush, this empty block will be recognized
1003                  * as a special marker by inflate_sync().
1004                  */
1005                 if (flush == Z_FULL_FLUSH) {
1006                     CLEAR_HASH(s);             /* forget history */
1007                     if (s->lookahead == 0) {
1008                         s->strstart = 0;
1009                         s->block_start = 0L;
1010                         s->insert = 0;
1011                     }
1012                 }
1013             }
1014             flush_pending(strm);
1015             if (strm->avail_out == 0) {
1016               s->last_flush = -1; /* avoid BUF_ERROR at next call, see above */
1017               return Z_OK;
1018             }
1019         }
1020     }
1021     Assert(strm->avail_out > 0, "bug2");
1022
1023     if (flush != Z_FINISH) return Z_OK;
1024     if (s->wrap <= 0) return Z_STREAM_END;
1025
1026     /* Write the trailer */
1027 #ifdef GZIP
1028     if (s->wrap == 2) {
1029         put_byte(s, (Byte)(strm->adler & 0xff));
1030         put_byte(s, (Byte)((strm->adler >> 8) & 0xff));
1031         put_byte(s, (Byte)((strm->adler >> 16) & 0xff));
1032         put_byte(s, (Byte)((strm->adler >> 24) & 0xff));
1033         put_byte(s, (Byte)(strm->total_in & 0xff));
1034         put_byte(s, (Byte)((strm->total_in >> 8) & 0xff));
1035         put_byte(s, (Byte)((strm->total_in >> 16) & 0xff));
1036         put_byte(s, (Byte)((strm->total_in >> 24) & 0xff));
1037     }
1038     else
1039 #endif
1040     {
1041         putShortMSB(s, (uInt)(strm->adler >> 16));
1042         putShortMSB(s, (uInt)(strm->adler & 0xffff));
1043     }
1044     flush_pending(strm);
1045     /* If avail_out is zero, the application will call deflate again
1046      * to flush the rest.
1047      */
1048     if (s->wrap > 0) s->wrap = -s->wrap; /* write the trailer only once! */
1049     return s->pending != 0 ? Z_OK : Z_STREAM_END;
1050 }
1051
1052 /* ========================================================================= */
1053 int ZEXPORT deflateEnd (strm)
1054     z_streamp strm;
1055 {
1056     int status;
1057
1058     if (deflateStateCheck(strm)) return Z_STREAM_ERROR;
1059
1060     status = strm->state->status;
1061
1062     /* Deallocate in reverse order of allocations: */
1063     TRY_FREE(strm, strm->state->pending_buf);
1064     TRY_FREE(strm, strm->state->head);
1065     TRY_FREE(strm, strm->state->prev);
1066     TRY_FREE(strm, strm->state->window);
1067
1068     ZFREE(strm, strm->state);
1069     strm->state = Z_NULL;
1070
1071     return status == BUSY_STATE ? Z_DATA_ERROR : Z_OK;
1072 }
1073
1074 /* =========================================================================
1075  * Copy the source state to the destination state.
1076  * To simplify the source, this is not supported for 16-bit MSDOS (which
1077  * doesn't have enough memory anyway to duplicate compression states).
1078  */
1079 int ZEXPORT deflateCopy (dest, source)
1080     z_streamp dest;
1081     z_streamp source;
1082 {
1083 #ifdef MAXSEG_64K
1084     return Z_STREAM_ERROR;
1085 #else
1086     deflate_state *ds;
1087     deflate_state *ss;
1088     ushf *overlay;
1089
1090
1091     if (deflateStateCheck(source) || dest == Z_NULL) {
1092         return Z_STREAM_ERROR;
1093     }
1094
1095     ss = source->state;
1096
1097     zmemcpy((voidpf)dest, (voidpf)source, sizeof(z_stream));
1098
1099     ds = (deflate_state *) ZALLOC(dest, 1, sizeof(deflate_state));
1100     if (ds == Z_NULL) return Z_MEM_ERROR;
1101     dest->state = (struct internal_state FAR *) ds;
1102     zmemcpy((voidpf)ds, (voidpf)ss, sizeof(deflate_state));
1103     ds->strm = dest;
1104
1105     ds->window = (Bytef *) ZALLOC(dest, ds->w_size, 2*sizeof(Byte));
1106     ds->prev   = (Posf *)  ZALLOC(dest, ds->w_size, sizeof(Pos));
1107     ds->head   = (Posf *)  ZALLOC(dest, ds->hash_size, sizeof(Pos));
1108     overlay = (ushf *) ZALLOC(dest, ds->lit_bufsize, sizeof(ush)+2);
1109     ds->pending_buf = (uchf *) overlay;
1110
1111     if (ds->window == Z_NULL || ds->prev == Z_NULL || ds->head == Z_NULL ||
1112         ds->pending_buf == Z_NULL) {
1113         deflateEnd (dest);
1114         return Z_MEM_ERROR;
1115     }
1116     /* following zmemcpy do not work for 16-bit MSDOS */
1117     zmemcpy(ds->window, ss->window, ds->w_size * 2 * sizeof(Byte));
1118     zmemcpy((voidpf)ds->prev, (voidpf)ss->prev, ds->w_size * sizeof(Pos));
1119     zmemcpy((voidpf)ds->head, (voidpf)ss->head, ds->hash_size * sizeof(Pos));
1120     zmemcpy(ds->pending_buf, ss->pending_buf, (uInt)ds->pending_buf_size);
1121
1122     ds->pending_out = ds->pending_buf + (ss->pending_out - ss->pending_buf);
1123     ds->d_buf = overlay + ds->lit_bufsize/sizeof(ush);
1124     ds->l_buf = ds->pending_buf + (1+sizeof(ush))*ds->lit_bufsize;
1125
1126     ds->l_desc.dyn_tree = ds->dyn_ltree;
1127     ds->d_desc.dyn_tree = ds->dyn_dtree;
1128     ds->bl_desc.dyn_tree = ds->bl_tree;
1129
1130     return Z_OK;
1131 #endif /* MAXSEG_64K */
1132 }
1133
1134 /* ===========================================================================
1135  * Read a new buffer from the current input stream, update the adler32
1136  * and total number of bytes read.  All deflate() input goes through
1137  * this function so some applications may wish to modify it to avoid
1138  * allocating a large strm->next_in buffer and copying from it.
1139  * (See also flush_pending()).
1140  */
1141 local unsigned read_buf(strm, buf, size)
1142     z_streamp strm;
1143     Bytef *buf;
1144     unsigned size;
1145 {
1146     unsigned len = strm->avail_in;
1147
1148     if (len > size) len = size;
1149     if (len == 0) return 0;
1150
1151     strm->avail_in  -= len;
1152
1153     zmemcpy(buf, strm->next_in, len);
1154     if (strm->state->wrap == 1) {
1155         strm->adler = adler32(strm->adler, buf, len);
1156     }
1157 #ifdef GZIP
1158     else if (strm->state->wrap == 2) {
1159         strm->adler = crc32(strm->adler, buf, len);
1160     }
1161 #endif
1162     strm->next_in  += len;
1163     strm->total_in += len;
1164
1165     return len;
1166 }
1167
1168 /* ===========================================================================
1169  * Initialize the "longest match" routines for a new zlib stream
1170  */
1171 local void lm_init (s)
1172     deflate_state *s;
1173 {
1174     s->window_size = (ulg)2L*s->w_size;
1175
1176     CLEAR_HASH(s);
1177
1178     /* Set the default configuration parameters:
1179      */
1180     s->max_lazy_match   = configuration_table[s->level].max_lazy;
1181     s->good_match       = configuration_table[s->level].good_length;
1182     s->nice_match       = configuration_table[s->level].nice_length;
1183     s->max_chain_length = configuration_table[s->level].max_chain;
1184
1185     s->strstart = 0;
1186     s->block_start = 0L;
1187     s->lookahead = 0;
1188     s->insert = 0;
1189     s->match_length = s->prev_length = MIN_MATCH-1;
1190     s->match_available = 0;
1191     s->ins_h = 0;
1192 #ifndef FASTEST
1193 #ifdef ASMV
1194     match_init(); /* initialize the asm code */
1195 #endif
1196 #endif
1197 }
1198
1199 #ifndef FASTEST
1200 /* ===========================================================================
1201  * Set match_start to the longest match starting at the given string and
1202  * return its length. Matches shorter or equal to prev_length are discarded,
1203  * in which case the result is equal to prev_length and match_start is
1204  * garbage.
1205  * IN assertions: cur_match is the head of the hash chain for the current
1206  *   string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
1207  * OUT assertion: the match length is not greater than s->lookahead.
1208  */
1209 #ifndef ASMV
1210 /* For 80x86 and 680x0, an optimized version will be provided in match.asm or
1211  * match.S. The code will be functionally equivalent.
1212  */
1213 local uInt longest_match(s, cur_match)
1214     deflate_state *s;
1215     IPos cur_match;                             /* current match */
1216 {
1217     unsigned chain_length = s->max_chain_length;/* max hash chain length */
1218     register Bytef *scan = s->window + s->strstart; /* current string */
1219     register Bytef *match;                      /* matched string */
1220     register int len;                           /* length of current match */
1221     int best_len = (int)s->prev_length;         /* best match length so far */
1222     int nice_match = s->nice_match;             /* stop if match long enough */
1223     IPos limit = s->strstart > (IPos)MAX_DIST(s) ?
1224         s->strstart - (IPos)MAX_DIST(s) : NIL;
1225     /* Stop when cur_match becomes <= limit. To simplify the code,
1226      * we prevent matches with the string of window index 0.
1227      */
1228     Posf *prev = s->prev;
1229     uInt wmask = s->w_mask;
1230
1231 #ifdef UNALIGNED_OK
1232     /* Compare two bytes at a time. Note: this is not always beneficial.
1233      * Try with and without -DUNALIGNED_OK to check.
1234      */
1235     register Bytef *strend = s->window + s->strstart + MAX_MATCH - 1;
1236     register ush scan_start = *(ushf*)scan;
1237     register ush scan_end   = *(ushf*)(scan+best_len-1);
1238 #else
1239     register Bytef *strend = s->window + s->strstart + MAX_MATCH;
1240     register Byte scan_end1  = scan[best_len-1];
1241     register Byte scan_end   = scan[best_len];
1242 #endif
1243
1244     /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
1245      * It is easy to get rid of this optimization if necessary.
1246      */
1247     Assert(s->hash_bits >= 8 && MAX_MATCH == 258, "Code too clever");
1248
1249     /* Do not waste too much time if we already have a good match: */
1250     if (s->prev_length >= s->good_match) {
1251         chain_length >>= 2;
1252     }
1253     /* Do not look for matches beyond the end of the input. This is necessary
1254      * to make deflate deterministic.
1255      */
1256     if ((uInt)nice_match > s->lookahead) nice_match = (int)s->lookahead;
1257
1258     Assert((ulg)s->strstart <= s->window_size-MIN_LOOKAHEAD, "need lookahead");
1259
1260     do {
1261         Assert(cur_match < s->strstart, "no future");
1262         match = s->window + cur_match;
1263
1264         /* Skip to next match if the match length cannot increase
1265          * or if the match length is less than 2.  Note that the checks below
1266          * for insufficient lookahead only occur occasionally for performance
1267          * reasons.  Therefore uninitialized memory will be accessed, and
1268          * conditional jumps will be made that depend on those values.
1269          * However the length of the match is limited to the lookahead, so
1270          * the output of deflate is not affected by the uninitialized values.
1271          */
1272 #if (defined(UNALIGNED_OK) && MAX_MATCH == 258)
1273         /* This code assumes sizeof(unsigned short) == 2. Do not use
1274          * UNALIGNED_OK if your compiler uses a different size.
1275          */
1276         if (*(ushf*)(match+best_len-1) != scan_end ||
1277             *(ushf*)match != scan_start) continue;
1278
1279         /* It is not necessary to compare scan[2] and match[2] since they are
1280          * always equal when the other bytes match, given that the hash keys
1281          * are equal and that HASH_BITS >= 8. Compare 2 bytes at a time at
1282          * strstart+3, +5, ... up to strstart+257. We check for insufficient
1283          * lookahead only every 4th comparison; the 128th check will be made
1284          * at strstart+257. If MAX_MATCH-2 is not a multiple of 8, it is
1285          * necessary to put more guard bytes at the end of the window, or
1286          * to check more often for insufficient lookahead.
1287          */
1288         Assert(scan[2] == match[2], "scan[2]?");
1289         scan++, match++;
1290         do {
1291         } while (*(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1292                  *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1293                  *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1294                  *(ushf*)(scan+=2) == *(ushf*)(match+=2) &&
1295                  scan < strend);
1296         /* The funny "do {}" generates better code on most compilers */
1297
1298         /* Here, scan <= window+strstart+257 */
1299         Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1300         if (*scan == *match) scan++;
1301
1302         len = (MAX_MATCH - 1) - (int)(strend-scan);
1303         scan = strend - (MAX_MATCH-1);
1304
1305 #else /* UNALIGNED_OK */
1306
1307         if (match[best_len]   != scan_end  ||
1308             match[best_len-1] != scan_end1 ||
1309             *match            != *scan     ||
1310             *++match          != scan[1])      continue;
1311
1312         /* The check at best_len-1 can be removed because it will be made
1313          * again later. (This heuristic is not always a win.)
1314          * It is not necessary to compare scan[2] and match[2] since they
1315          * are always equal when the other bytes match, given that
1316          * the hash keys are equal and that HASH_BITS >= 8.
1317          */
1318         scan += 2, match++;
1319         Assert(*scan == *match, "match[2]?");
1320
1321         /* We check for insufficient lookahead only every 8th comparison;
1322          * the 256th check will be made at strstart+258.
1323          */
1324         do {
1325         } while (*++scan == *++match && *++scan == *++match &&
1326                  *++scan == *++match && *++scan == *++match &&
1327                  *++scan == *++match && *++scan == *++match &&
1328                  *++scan == *++match && *++scan == *++match &&
1329                  scan < strend);
1330
1331         Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1332
1333         len = MAX_MATCH - (int)(strend - scan);
1334         scan = strend - MAX_MATCH;
1335
1336 #endif /* UNALIGNED_OK */
1337
1338         if (len > best_len) {
1339             s->match_start = cur_match;
1340             best_len = len;
1341             if (len >= nice_match) break;
1342 #ifdef UNALIGNED_OK
1343             scan_end = *(ushf*)(scan+best_len-1);
1344 #else
1345             scan_end1  = scan[best_len-1];
1346             scan_end   = scan[best_len];
1347 #endif
1348         }
1349     } while ((cur_match = prev[cur_match & wmask]) > limit
1350              && --chain_length != 0);
1351
1352     if ((uInt)best_len <= s->lookahead) return (uInt)best_len;
1353     return s->lookahead;
1354 }
1355 #endif /* ASMV */
1356
1357 #else /* FASTEST */
1358
1359 /* ---------------------------------------------------------------------------
1360  * Optimized version for FASTEST only
1361  */
1362 local uInt longest_match(s, cur_match)
1363     deflate_state *s;
1364     IPos cur_match;                             /* current match */
1365 {
1366     register Bytef *scan = s->window + s->strstart; /* current string */
1367     register Bytef *match;                       /* matched string */
1368     register int len;                           /* length of current match */
1369     register Bytef *strend = s->window + s->strstart + MAX_MATCH;
1370
1371     /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
1372      * It is easy to get rid of this optimization if necessary.
1373      */
1374     Assert(s->hash_bits >= 8 && MAX_MATCH == 258, "Code too clever");
1375
1376     Assert((ulg)s->strstart <= s->window_size-MIN_LOOKAHEAD, "need lookahead");
1377
1378     Assert(cur_match < s->strstart, "no future");
1379
1380     match = s->window + cur_match;
1381
1382     /* Return failure if the match length is less than 2:
1383      */
1384     if (match[0] != scan[0] || match[1] != scan[1]) return MIN_MATCH-1;
1385
1386     /* The check at best_len-1 can be removed because it will be made
1387      * again later. (This heuristic is not always a win.)
1388      * It is not necessary to compare scan[2] and match[2] since they
1389      * are always equal when the other bytes match, given that
1390      * the hash keys are equal and that HASH_BITS >= 8.
1391      */
1392     scan += 2, match += 2;
1393     Assert(*scan == *match, "match[2]?");
1394
1395     /* We check for insufficient lookahead only every 8th comparison;
1396      * the 256th check will be made at strstart+258.
1397      */
1398     do {
1399     } while (*++scan == *++match && *++scan == *++match &&
1400              *++scan == *++match && *++scan == *++match &&
1401              *++scan == *++match && *++scan == *++match &&
1402              *++scan == *++match && *++scan == *++match &&
1403              scan < strend);
1404
1405     Assert(scan <= s->window+(unsigned)(s->window_size-1), "wild scan");
1406
1407     len = MAX_MATCH - (int)(strend - scan);
1408
1409     if (len < MIN_MATCH) return MIN_MATCH - 1;
1410
1411     s->match_start = cur_match;
1412     return (uInt)len <= s->lookahead ? (uInt)len : s->lookahead;
1413 }
1414
1415 #endif /* FASTEST */
1416
1417 #ifdef ZLIB_DEBUG
1418
1419 #define EQUAL 0
1420 /* result of memcmp for equal strings */
1421
1422 /* ===========================================================================
1423  * Check that the match at match_start is indeed a match.
1424  */
1425 local void check_match(s, start, match, length)
1426     deflate_state *s;
1427     IPos start, match;
1428     int length;
1429 {
1430     /* check that the match is indeed a match */
1431     if (zmemcmp(s->window + match,
1432                 s->window + start, length) != EQUAL) {
1433         fprintf(stderr, " start %u, match %u, length %d\n",
1434                 start, match, length);
1435         do {
1436             fprintf(stderr, "%c%c", s->window[match++], s->window[start++]);
1437         } while (--length != 0);
1438         z_error("invalid match");
1439     }
1440     if (z_verbose > 1) {
1441         fprintf(stderr,"\\[%d,%d]", start-match, length);
1442         do { putc(s->window[start++], stderr); } while (--length != 0);
1443     }
1444 }
1445 #else
1446 #  define check_match(s, start, match, length)
1447 #endif /* ZLIB_DEBUG */
1448
1449 /* ===========================================================================
1450  * Fill the window when the lookahead becomes insufficient.
1451  * Updates strstart and lookahead.
1452  *
1453  * IN assertion: lookahead < MIN_LOOKAHEAD
1454  * OUT assertions: strstart <= window_size-MIN_LOOKAHEAD
1455  *    At least one byte has been read, or avail_in == 0; reads are
1456  *    performed for at least two bytes (required for the zip translate_eol
1457  *    option -- not supported here).
1458  */
1459 local void fill_window(s)
1460     deflate_state *s;
1461 {
1462     unsigned n;
1463     unsigned more;    /* Amount of free space at the end of the window. */
1464     uInt wsize = s->w_size;
1465
1466     Assert(s->lookahead < MIN_LOOKAHEAD, "already enough lookahead");
1467
1468     do {
1469         more = (unsigned)(s->window_size -(ulg)s->lookahead -(ulg)s->strstart);
1470
1471         /* Deal with !@#$% 64K limit: */
1472         if (sizeof(int) <= 2) {
1473             if (more == 0 && s->strstart == 0 && s->lookahead == 0) {
1474                 more = wsize;
1475
1476             } else if (more == (unsigned)(-1)) {
1477                 /* Very unlikely, but possible on 16 bit machine if
1478                  * strstart == 0 && lookahead == 1 (input done a byte at time)
1479                  */
1480                 more--;
1481             }
1482         }
1483
1484         /* If the window is almost full and there is insufficient lookahead,
1485          * move the upper half to the lower one to make room in the upper half.
1486          */
1487         if (s->strstart >= wsize+MAX_DIST(s)) {
1488
1489             zmemcpy(s->window, s->window+wsize, (unsigned)wsize - more);
1490             s->match_start -= wsize;
1491             s->strstart    -= wsize; /* we now have strstart >= MAX_DIST */
1492             s->block_start -= (long) wsize;
1493             slide_hash(s);
1494             more += wsize;
1495         }
1496         if (s->strm->avail_in == 0) break;
1497
1498         /* If there was no sliding:
1499          *    strstart <= WSIZE+MAX_DIST-1 && lookahead <= MIN_LOOKAHEAD - 1 &&
1500          *    more == window_size - lookahead - strstart
1501          * => more >= window_size - (MIN_LOOKAHEAD-1 + WSIZE + MAX_DIST-1)
1502          * => more >= window_size - 2*WSIZE + 2
1503          * In the BIG_MEM or MMAP case (not yet supported),
1504          *   window_size == input_size + MIN_LOOKAHEAD  &&
1505          *   strstart + s->lookahead <= input_size => more >= MIN_LOOKAHEAD.
1506          * Otherwise, window_size == 2*WSIZE so more >= 2.
1507          * If there was sliding, more >= WSIZE. So in all cases, more >= 2.
1508          */
1509         Assert(more >= 2, "more < 2");
1510
1511         n = read_buf(s->strm, s->window + s->strstart + s->lookahead, more);
1512         s->lookahead += n;
1513
1514         /* Initialize the hash value now that we have some input: */
1515         if (s->lookahead + s->insert >= MIN_MATCH) {
1516             uInt str = s->strstart - s->insert;
1517             s->ins_h = s->window[str];
1518             UPDATE_HASH(s, s->ins_h, s->window[str + 1]);
1519 #if MIN_MATCH != 3
1520             Call UPDATE_HASH() MIN_MATCH-3 more times
1521 #endif
1522             while (s->insert) {
1523                 UPDATE_HASH(s, s->ins_h, s->window[str + MIN_MATCH-1]);
1524 #ifndef FASTEST
1525                 s->prev[str & s->w_mask] = s->head[s->ins_h];
1526 #endif
1527                 s->head[s->ins_h] = (Pos)str;
1528                 str++;
1529                 s->insert--;
1530                 if (s->lookahead + s->insert < MIN_MATCH)
1531                     break;
1532             }
1533         }
1534         /* If the whole input has less than MIN_MATCH bytes, ins_h is garbage,
1535          * but this is not important since only literal bytes will be emitted.
1536          */
1537
1538     } while (s->lookahead < MIN_LOOKAHEAD && s->strm->avail_in != 0);
1539
1540     /* If the WIN_INIT bytes after the end of the current data have never been
1541      * written, then zero those bytes in order to avoid memory check reports of
1542      * the use of uninitialized (or uninitialised as Julian writes) bytes by
1543      * the longest match routines.  Update the high water mark for the next
1544      * time through here.  WIN_INIT is set to MAX_MATCH since the longest match
1545      * routines allow scanning to strstart + MAX_MATCH, ignoring lookahead.
1546      */
1547     if (s->high_water < s->window_size) {
1548         ulg curr = s->strstart + (ulg)(s->lookahead);
1549         ulg init;
1550
1551         if (s->high_water < curr) {
1552             /* Previous high water mark below current data -- zero WIN_INIT
1553              * bytes or up to end of window, whichever is less.
1554              */
1555             init = s->window_size - curr;
1556             if (init > WIN_INIT)
1557                 init = WIN_INIT;
1558             zmemzero(s->window + curr, (unsigned)init);
1559             s->high_water = curr + init;
1560         }
1561         else if (s->high_water < (ulg)curr + WIN_INIT) {
1562             /* High water mark at or above current data, but below current data
1563              * plus WIN_INIT -- zero out to current data plus WIN_INIT, or up
1564              * to end of window, whichever is less.
1565              */
1566             init = (ulg)curr + WIN_INIT - s->high_water;
1567             if (init > s->window_size - s->high_water)
1568                 init = s->window_size - s->high_water;
1569             zmemzero(s->window + s->high_water, (unsigned)init);
1570             s->high_water += init;
1571         }
1572     }
1573
1574     Assert((ulg)s->strstart <= s->window_size - MIN_LOOKAHEAD,
1575            "not enough room for search");
1576 }
1577
1578 /* ===========================================================================
1579  * Flush the current block, with given end-of-file flag.
1580  * IN assertion: strstart is set to the end of the current match.
1581  */
1582 #define FLUSH_BLOCK_ONLY(s, last) { \
1583    _tr_flush_block(s, (s->block_start >= 0L ? \
1584                    (charf *)&s->window[(unsigned)s->block_start] : \
1585                    (charf *)Z_NULL), \
1586                 (ulg)((long)s->strstart - s->block_start), \
1587                 (last)); \
1588    s->block_start = s->strstart; \
1589    flush_pending(s->strm); \
1590    Tracev((stderr,"[FLUSH]")); \
1591 }
1592
1593 /* Same but force premature exit if necessary. */
1594 #define FLUSH_BLOCK(s, last) { \
1595    FLUSH_BLOCK_ONLY(s, last); \
1596    if (s->strm->avail_out == 0) return (last) ? finish_started : need_more; \
1597 }
1598
1599 /* Maximum stored block length in deflate format (not including header). */
1600 #define MAX_STORED 65535
1601
1602 /* Minimum of a and b. */
1603 #define MIN(a, b) ((a) > (b) ? (b) : (a))
1604
1605 /* ===========================================================================
1606  * Copy without compression as much as possible from the input stream, return
1607  * the current block state.
1608  *
1609  * In case deflateParams() is used to later switch to a non-zero compression
1610  * level, s->matches (otherwise unused when storing) keeps track of the number
1611  * of hash table slides to perform. If s->matches is 1, then one hash table
1612  * slide will be done when switching. If s->matches is 2, the maximum value
1613  * allowed here, then the hash table will be cleared, since two or more slides
1614  * is the same as a clear.
1615  *
1616  * deflate_stored() is written to minimize the number of times an input byte is
1617  * copied. It is most efficient with large input and output buffers, which
1618  * maximizes the opportunites to have a single copy from next_in to next_out.
1619  */
1620 local block_state deflate_stored(s, flush)
1621     deflate_state *s;
1622     int flush;
1623 {
1624     /* Smallest worthy block size when not flushing or finishing. By default
1625      * this is 32K. This can be as small as 507 bytes for memLevel == 1. For
1626      * large input and output buffers, the stored block size will be larger.
1627      */
1628     unsigned min_block = MIN(s->pending_buf_size - 5, s->w_size);
1629
1630     /* Copy as many min_block or larger stored blocks directly to next_out as
1631      * possible. If flushing, copy the remaining available input to next_out as
1632      * stored blocks, if there is enough space.
1633      */
1634     unsigned len, left, have, last;
1635     unsigned used = s->strm->avail_in;
1636     for (;;) {
1637         /* Set len to the maximum size block that we can copy directly with the
1638          * available input data and output space. Set left to how much of that
1639          * would be copied from what's left in the window.
1640          */
1641         len = MAX_STORED;       /* maximum deflate stored block length */
1642         have = (s->bi_valid + 42) >> 3;         /* number of header bytes */
1643             /* maximum stored block length that will fit in avail_out: */
1644         have = s->strm->avail_out > have ? s->strm->avail_out - have : 0;
1645         left = s->strstart - s->block_start;    /* bytes left in window */
1646         if (len > (ulg)left + s->strm->avail_in)
1647             len = left + s->strm->avail_in;     /* limit len to the input */
1648         if (len > have)
1649             len = have;                         /* limit len to the output */
1650         if (left > len)
1651             left = len;                         /* limit window pull to len */
1652
1653         /* If the stored block would be less than min_block in length, or if
1654          * unable to copy all of the available input when flushing, then try
1655          * copying to the window and the pending buffer instead. Also don't
1656          * write an empty block when flushing -- deflate() does that.
1657          */
1658         if (len < min_block && (len == 0 || flush == Z_NO_FLUSH ||
1659                                 len - left != s->strm->avail_in))
1660             break;
1661
1662         /* Make a dummy stored block in pending to get the header bytes,
1663          * including any pending bits. This also updates the debugging counts.
1664          */
1665         last = flush == Z_FINISH && len - left == s->strm->avail_in ? 1 : 0;
1666         _tr_stored_block(s, (char *)0, 0L, last);
1667
1668         /* Replace the lengths in the dummy stored block with len. */
1669         s->pending_buf[s->pending - 4] = len;
1670         s->pending_buf[s->pending - 3] = len >> 8;
1671         s->pending_buf[s->pending - 2] = ~len;
1672         s->pending_buf[s->pending - 1] = ~len >> 8;
1673
1674         /* Write the stored block header bytes. */
1675         flush_pending(s->strm);
1676
1677         /* Update debugging counts for the data about to be copied. */
1678 #ifdef ZLIB_DEBUG
1679         s->compressed_len += len << 3;
1680         s->bits_sent += len << 3;
1681 #endif
1682
1683         /* Copy uncompressed bytes from the window to next_out. */
1684         if (left) {
1685             zmemcpy(s->strm->next_out, s->window + s->block_start, left);
1686             s->strm->next_out += left;
1687             s->strm->avail_out -= left;
1688             s->strm->total_out += left;
1689             s->block_start += left;
1690             len -= left;
1691         }
1692
1693         /* Copy uncompressed bytes directly from next_in to next_out, updating
1694          * the check value.
1695          */
1696         if (len) {
1697             read_buf(s->strm, s->strm->next_out, len);
1698             s->strm->next_out += len;
1699             s->strm->avail_out -= len;
1700             s->strm->total_out += len;
1701         }
1702     }
1703
1704     /* Update the sliding window with the last s->w_size bytes of the copied
1705      * data, or append all of the copied data to the existing window if less
1706      * than s->w_size bytes were copied. Also update the number of bytes to
1707      * insert in the hash tables, in the event that deflateParams() switches to
1708      * a non-zero compression level.
1709      */
1710     used -= s->strm->avail_in;      /* number of input bytes directly copied */
1711     if (used) {
1712         /* If any input was used, then no unused input remains in the window,
1713          * therefore s->block_start == s->strstart.
1714          */
1715         if (used >= s->w_size) {    /* supplant the previous history */
1716             s->matches = 2;         /* clear hash */
1717             zmemcpy(s->window, s->strm->next_in - s->w_size, s->w_size);
1718             s->strstart = s->w_size;
1719         }
1720         else {
1721             if (s->window_size - s->strstart <= used) {
1722                 /* Slide the window down. */
1723                 s->strstart -= s->w_size;
1724                 zmemcpy(s->window, s->window + s->w_size, s->strstart);
1725                 if (s->matches < 2)
1726                     s->matches++;   /* add a pending slide_hash() */
1727             }
1728             zmemcpy(s->window + s->strstart, s->strm->next_in - used, used);
1729             s->strstart += used;
1730         }
1731         s->block_start = s->strstart;
1732         s->insert += MIN(used, s->w_size - s->insert);
1733     }
1734
1735     /* If flushing or finishing and all input has been consumed, then done. If
1736      * the code above couldn't write a complete block to next_out, then the
1737      * code following this won't be able to either.
1738      */
1739     if (flush != Z_NO_FLUSH && s->strm->avail_in == 0 &&
1740         s->strstart == s->block_start)
1741         return flush == Z_FINISH ? finish_done : block_done;
1742
1743     /* Fill the window with any remaining input. */
1744     have = s->window_size - s->strstart - 1;
1745     if (s->strm->avail_in > have && s->block_start >= s->w_size) {
1746         /* Slide the window down. */
1747         s->block_start -= s->w_size;
1748         s->strstart -= s->w_size;
1749         zmemcpy(s->window, s->window + s->w_size, s->strstart);
1750         if (s->matches < 2)
1751             s->matches++;           /* add a pending slide_hash() */
1752         have += s->w_size;          /* more space now */
1753     }
1754     if (have > s->strm->avail_in)
1755         have = s->strm->avail_in;
1756     if (have) {
1757         read_buf(s->strm, s->window + s->strstart, have);
1758         s->strstart += have;
1759     }
1760
1761     /* There was not enough avail_out to write a complete worthy or flushed
1762      * stored block to next_out. Write a stored block to pending instead, if we
1763      * have enough input for a worthy block, or if flushing and there is enough
1764      * room for the remaining input as a stored block in the pending buffer.
1765      */
1766     have = (s->bi_valid + 42) >> 3;         /* number of header bytes */
1767         /* maximum stored block length that will fit in pending: */
1768     have = MIN(s->pending_buf_size - have, MAX_STORED);
1769     min_block = MIN(have, s->w_size);
1770     left = s->strstart - s->block_start;
1771     if (left >= min_block ||
1772         (left && flush != Z_NO_FLUSH && s->strm->avail_in == 0 &&
1773          left <= have)) {
1774         len = MIN(left, have);
1775         last = flush == Z_FINISH && s->strm->avail_in == 0 &&
1776                len == left ? 1 : 0;
1777         _tr_stored_block(s, (charf *)s->window + s->block_start, len, last);
1778         s->block_start += len;
1779         flush_pending(s->strm);
1780         if (last)
1781             return finish_started;
1782     }
1783
1784     /* We've done all we can with the available input and output. */
1785     return need_more;
1786 }
1787
1788 /* ===========================================================================
1789  * Compress as much as possible from the input stream, return the current
1790  * block state.
1791  * This function does not perform lazy evaluation of matches and inserts
1792  * new strings in the dictionary only for unmatched strings or for short
1793  * matches. It is used only for the fast compression options.
1794  */
1795 local block_state deflate_fast(s, flush)
1796     deflate_state *s;
1797     int flush;
1798 {
1799     IPos hash_head;       /* head of the hash chain */
1800     int bflush;           /* set if current block must be flushed */
1801
1802     for (;;) {
1803         /* Make sure that we always have enough lookahead, except
1804          * at the end of the input file. We need MAX_MATCH bytes
1805          * for the next match, plus MIN_MATCH bytes to insert the
1806          * string following the next match.
1807          */
1808         if (s->lookahead < MIN_LOOKAHEAD) {
1809             fill_window(s);
1810             if (s->lookahead < MIN_LOOKAHEAD && flush == Z_NO_FLUSH) {
1811                 return need_more;
1812             }
1813             if (s->lookahead == 0) break; /* flush the current block */
1814         }
1815
1816         /* Insert the string window[strstart .. strstart+2] in the
1817          * dictionary, and set hash_head to the head of the hash chain:
1818          */
1819         hash_head = NIL;
1820         if (s->lookahead >= MIN_MATCH) {
1821             INSERT_STRING(s, s->strstart, hash_head);
1822         }
1823
1824         /* Find the longest match, discarding those <= prev_length.
1825          * At this point we have always match_length < MIN_MATCH
1826          */
1827         if (hash_head != NIL && s->strstart - hash_head <= MAX_DIST(s)) {
1828             /* To simplify the code, we prevent matches with the string
1829              * of window index 0 (in particular we have to avoid a match
1830              * of the string with itself at the start of the input file).
1831              */
1832             s->match_length = longest_match (s, hash_head);
1833             /* longest_match() sets match_start */
1834         }
1835         if (s->match_length >= MIN_MATCH) {
1836             check_match(s, s->strstart, s->match_start, s->match_length);
1837
1838             _tr_tally_dist(s, s->strstart - s->match_start,
1839                            s->match_length - MIN_MATCH, bflush);
1840
1841             s->lookahead -= s->match_length;
1842
1843             /* Insert new strings in the hash table only if the match length
1844              * is not too large. This saves time but degrades compression.
1845              */
1846 #ifndef FASTEST
1847             if (s->match_length <= s->max_insert_length &&
1848                 s->lookahead >= MIN_MATCH) {
1849                 s->match_length--; /* string at strstart already in table */
1850                 do {
1851                     s->strstart++;
1852                     INSERT_STRING(s, s->strstart, hash_head);
1853                     /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1854                      * always MIN_MATCH bytes ahead.
1855                      */
1856                 } while (--s->match_length != 0);
1857                 s->strstart++;
1858             } else
1859 #endif
1860             {
1861                 s->strstart += s->match_length;
1862                 s->match_length = 0;
1863                 s->ins_h = s->window[s->strstart];
1864                 UPDATE_HASH(s, s->ins_h, s->window[s->strstart+1]);
1865 #if MIN_MATCH != 3
1866                 Call UPDATE_HASH() MIN_MATCH-3 more times
1867 #endif
1868                 /* If lookahead < MIN_MATCH, ins_h is garbage, but it does not
1869                  * matter since it will be recomputed at next deflate call.
1870                  */
1871             }
1872         } else {
1873             /* No match, output a literal byte */
1874             Tracevv((stderr,"%c", s->window[s->strstart]));
1875             _tr_tally_lit (s, s->window[s->strstart], bflush);
1876             s->lookahead--;
1877             s->strstart++;
1878         }
1879         if (bflush) FLUSH_BLOCK(s, 0);
1880     }
1881     s->insert = s->strstart < MIN_MATCH-1 ? s->strstart : MIN_MATCH-1;
1882     if (flush == Z_FINISH) {
1883         FLUSH_BLOCK(s, 1);
1884         return finish_done;
1885     }
1886     if (s->last_lit)
1887         FLUSH_BLOCK(s, 0);
1888     return block_done;
1889 }
1890
1891 #ifndef FASTEST
1892 /* ===========================================================================
1893  * Same as above, but achieves better compression. We use a lazy
1894  * evaluation for matches: a match is finally adopted only if there is
1895  * no better match at the next window position.
1896  */
1897 local block_state deflate_slow(s, flush)
1898     deflate_state *s;
1899     int flush;
1900 {
1901     IPos hash_head;          /* head of hash chain */
1902     int bflush;              /* set if current block must be flushed */
1903
1904     /* Process the input block. */
1905     for (;;) {
1906         /* Make sure that we always have enough lookahead, except
1907          * at the end of the input file. We need MAX_MATCH bytes
1908          * for the next match, plus MIN_MATCH bytes to insert the
1909          * string following the next match.
1910          */
1911         if (s->lookahead < MIN_LOOKAHEAD) {
1912             fill_window(s);
1913             if (s->lookahead < MIN_LOOKAHEAD && flush == Z_NO_FLUSH) {
1914                 return need_more;
1915             }
1916             if (s->lookahead == 0) break; /* flush the current block */
1917         }
1918
1919         /* Insert the string window[strstart .. strstart+2] in the
1920          * dictionary, and set hash_head to the head of the hash chain:
1921          */
1922         hash_head = NIL;
1923         if (s->lookahead >= MIN_MATCH) {
1924             INSERT_STRING(s, s->strstart, hash_head);
1925         }
1926
1927         /* Find the longest match, discarding those <= prev_length.
1928          */
1929         s->prev_length = s->match_length, s->prev_match = s->match_start;
1930         s->match_length = MIN_MATCH-1;
1931
1932         if (hash_head != NIL && s->prev_length < s->max_lazy_match &&
1933             s->strstart - hash_head <= MAX_DIST(s)) {
1934             /* To simplify the code, we prevent matches with the string
1935              * of window index 0 (in particular we have to avoid a match
1936              * of the string with itself at the start of the input file).
1937              */
1938             s->match_length = longest_match (s, hash_head);
1939             /* longest_match() sets match_start */
1940
1941             if (s->match_length <= 5 && (s->strategy == Z_FILTERED
1942 #if TOO_FAR <= 32767
1943                 || (s->match_length == MIN_MATCH &&
1944                     s->strstart - s->match_start > TOO_FAR)
1945 #endif
1946                 )) {
1947
1948                 /* If prev_match is also MIN_MATCH, match_start is garbage
1949                  * but we will ignore the current match anyway.
1950                  */
1951                 s->match_length = MIN_MATCH-1;
1952             }
1953         }
1954         /* If there was a match at the previous step and the current
1955          * match is not better, output the previous match:
1956          */
1957         if (s->prev_length >= MIN_MATCH && s->match_length <= s->prev_length) {
1958             uInt max_insert = s->strstart + s->lookahead - MIN_MATCH;
1959             /* Do not insert strings in hash table beyond this. */
1960
1961             check_match(s, s->strstart-1, s->prev_match, s->prev_length);
1962
1963             _tr_tally_dist(s, s->strstart -1 - s->prev_match,
1964                            s->prev_length - MIN_MATCH, bflush);
1965
1966             /* Insert in hash table all strings up to the end of the match.
1967              * strstart-1 and strstart are already inserted. If there is not
1968              * enough lookahead, the last two strings are not inserted in
1969              * the hash table.
1970              */
1971             s->lookahead -= s->prev_length-1;
1972             s->prev_length -= 2;
1973             do {
1974                 if (++s->strstart <= max_insert) {
1975                     INSERT_STRING(s, s->strstart, hash_head);
1976                 }
1977             } while (--s->prev_length != 0);
1978             s->match_available = 0;
1979             s->match_length = MIN_MATCH-1;
1980             s->strstart++;
1981
1982             if (bflush) FLUSH_BLOCK(s, 0);
1983
1984         } else if (s->match_available) {
1985             /* If there was no match at the previous position, output a
1986              * single literal. If there was a match but the current match
1987              * is longer, truncate the previous match to a single literal.
1988              */
1989             Tracevv((stderr,"%c", s->window[s->strstart-1]));
1990             _tr_tally_lit(s, s->window[s->strstart-1], bflush);
1991             if (bflush) {
1992                 FLUSH_BLOCK_ONLY(s, 0);
1993             }
1994             s->strstart++;
1995             s->lookahead--;
1996             if (s->strm->avail_out == 0) return need_more;
1997         } else {
1998             /* There is no previous match to compare with, wait for
1999              * the next step to decide.
2000              */
2001             s->match_available = 1;
2002             s->strstart++;
2003             s->lookahead--;
2004         }
2005     }
2006     Assert (flush != Z_NO_FLUSH, "no flush?");
2007     if (s->match_available) {
2008         Tracevv((stderr,"%c", s->window[s->strstart-1]));
2009         _tr_tally_lit(s, s->window[s->strstart-1], bflush);
2010         s->match_available = 0;
2011     }
2012     s->insert = s->strstart < MIN_MATCH-1 ? s->strstart : MIN_MATCH-1;
2013     if (flush == Z_FINISH) {
2014         FLUSH_BLOCK(s, 1);
2015         return finish_done;
2016     }
2017     if (s->last_lit)
2018         FLUSH_BLOCK(s, 0);
2019     return block_done;
2020 }
2021 #endif /* FASTEST */
2022
2023 /* ===========================================================================
2024  * For Z_RLE, simply look for runs of bytes, generate matches only of distance
2025  * one.  Do not maintain a hash table.  (It will be regenerated if this run of
2026  * deflate switches away from Z_RLE.)
2027  */
2028 local block_state deflate_rle(s, flush)
2029     deflate_state *s;
2030     int flush;
2031 {
2032     int bflush;             /* set if current block must be flushed */
2033     uInt prev;              /* byte at distance one to match */
2034     Bytef *scan, *strend;   /* scan goes up to strend for length of run */
2035
2036     for (;;) {
2037         /* Make sure that we always have enough lookahead, except
2038          * at the end of the input file. We need MAX_MATCH bytes
2039          * for the longest run, plus one for the unrolled loop.
2040          */
2041         if (s->lookahead <= MAX_MATCH) {
2042             fill_window(s);
2043             if (s->lookahead <= MAX_MATCH && flush == Z_NO_FLUSH) {
2044                 return need_more;
2045             }
2046             if (s->lookahead == 0) break; /* flush the current block */
2047         }
2048
2049         /* See how many times the previous byte repeats */
2050         s->match_length = 0;
2051         if (s->lookahead >= MIN_MATCH && s->strstart > 0) {
2052             scan = s->window + s->strstart - 1;
2053             prev = *scan;
2054             if (prev == *++scan && prev == *++scan && prev == *++scan) {
2055                 strend = s->window + s->strstart + MAX_MATCH;
2056                 do {
2057                 } while (prev == *++scan && prev == *++scan &&
2058                          prev == *++scan && prev == *++scan &&
2059                          prev == *++scan && prev == *++scan &&
2060                          prev == *++scan && prev == *++scan &&
2061                          scan < strend);
2062                 s->match_length = MAX_MATCH - (uInt)(strend - scan);
2063                 if (s->match_length > s->lookahead)
2064                     s->match_length = s->lookahead;
2065             }
2066             Assert(scan <= s->window+(uInt)(s->window_size-1), "wild scan");
2067         }
2068
2069         /* Emit match if have run of MIN_MATCH or longer, else emit literal */
2070         if (s->match_length >= MIN_MATCH) {
2071             check_match(s, s->strstart, s->strstart - 1, s->match_length);
2072
2073             _tr_tally_dist(s, 1, s->match_length - MIN_MATCH, bflush);
2074
2075             s->lookahead -= s->match_length;
2076             s->strstart += s->match_length;
2077             s->match_length = 0;
2078         } else {
2079             /* No match, output a literal byte */
2080             Tracevv((stderr,"%c", s->window[s->strstart]));
2081             _tr_tally_lit (s, s->window[s->strstart], bflush);
2082             s->lookahead--;
2083             s->strstart++;
2084         }
2085         if (bflush) FLUSH_BLOCK(s, 0);
2086     }
2087     s->insert = 0;
2088     if (flush == Z_FINISH) {
2089         FLUSH_BLOCK(s, 1);
2090         return finish_done;
2091     }
2092     if (s->last_lit)
2093         FLUSH_BLOCK(s, 0);
2094     return block_done;
2095 }
2096
2097 /* ===========================================================================
2098  * For Z_HUFFMAN_ONLY, do not look for matches.  Do not maintain a hash table.
2099  * (It will be regenerated if this run of deflate switches away from Huffman.)
2100  */
2101 local block_state deflate_huff(s, flush)
2102     deflate_state *s;
2103     int flush;
2104 {
2105     int bflush;             /* set if current block must be flushed */
2106
2107     for (;;) {
2108         /* Make sure that we have a literal to write. */
2109         if (s->lookahead == 0) {
2110             fill_window(s);
2111             if (s->lookahead == 0) {
2112                 if (flush == Z_NO_FLUSH)
2113                     return need_more;
2114                 break;      /* flush the current block */
2115             }
2116         }
2117
2118         /* Output a literal byte */
2119         s->match_length = 0;
2120         Tracevv((stderr,"%c", s->window[s->strstart]));
2121         _tr_tally_lit (s, s->window[s->strstart], bflush);
2122         s->lookahead--;
2123         s->strstart++;
2124         if (bflush) FLUSH_BLOCK(s, 0);
2125     }
2126     s->insert = 0;
2127     if (flush == Z_FINISH) {
2128         FLUSH_BLOCK(s, 1);
2129         return finish_done;
2130     }
2131     if (s->last_lit)
2132         FLUSH_BLOCK(s, 0);
2133     return block_done;
2134 }