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