deflate.c

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