gzip: speed up send_bits()
[oweals/busybox.git] / archival / gzip.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Gzip implementation for busybox
4  *
5  * Based on GNU gzip Copyright (C) 1992-1993 Jean-loup Gailly.
6  *
7  * Originally adjusted for busybox by Charles P. Wright <cpw@unix.asb.com>
8  * "this is a stripped down version of gzip I put into busybox, it does
9  * only standard in to standard out with -9 compression.  It also requires
10  * the zcat module for some important functions."
11  *
12  * Adjusted further by Erik Andersen <andersen@codepoet.org> to support
13  * files as well as stdin/stdout, and to generally behave itself wrt
14  * command line handling.
15  *
16  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
17  */
18 /* TODO: full support for -v for DESKTOP
19  * "/usr/bin/gzip -v a bogus aa" should say:
20 a:       85.1% -- replaced with a.gz
21 gzip: bogus: No such file or directory
22 aa:      85.1% -- replaced with aa.gz
23 */
24 //config:config GZIP
25 //config:       bool "gzip (19 kb)"
26 //config:       default y
27 //config:       help
28 //config:       gzip is used to compress files.
29 //config:       It's probably the most widely used UNIX compression program.
30 //config:
31 //config:config FEATURE_GZIP_LONG_OPTIONS
32 //config:       bool "Enable long options"
33 //config:       default y
34 //config:       depends on GZIP && LONG_OPTS
35 //config:
36 //config:config GZIP_FAST
37 //config:       int "Trade memory for speed (0:small,slow - 2:fast,big)"
38 //config:       default 0
39 //config:       range 0 2
40 //config:       depends on GZIP
41 //config:       help
42 //config:       Enable big memory options for gzip.
43 //config:       0: small buffers, small hash-tables
44 //config:       1: larger buffers, larger hash-tables
45 //config:       2: larger buffers, largest hash-tables
46 //config:       Larger models may give slightly better compression
47 //config:
48 //config:config FEATURE_GZIP_LEVELS
49 //config:       bool "Enable compression levels"
50 //config:       default n
51 //config:       depends on GZIP
52 //config:       help
53 //config:       Enable support for compression levels 4-9. The default level
54 //config:       is 6. If levels 1-3 are specified, 4 is used.
55 //config:       If this option is not selected, -N options are ignored and -9
56 //config:       is used.
57 //config:
58 //config:config FEATURE_GZIP_DECOMPRESS
59 //config:       bool "Enable decompression"
60 //config:       default y
61 //config:       depends on GZIP || GUNZIP || ZCAT
62 //config:       help
63 //config:       Enable -d (--decompress) and -t (--test) options for gzip.
64 //config:       This will be automatically selected if gunzip or zcat is
65 //config:       enabled.
66
67 //applet:IF_GZIP(APPLET(gzip, BB_DIR_BIN, BB_SUID_DROP))
68
69 //kbuild:lib-$(CONFIG_GZIP) += gzip.o
70
71 //usage:#define gzip_trivial_usage
72 //usage:       "[-cfk" IF_FEATURE_GZIP_DECOMPRESS("dt") IF_FEATURE_GZIP_LEVELS("123456789") "] [FILE]..."
73 //usage:#define gzip_full_usage "\n\n"
74 //usage:       "Compress FILEs (or stdin)\n"
75 //usage:        IF_FEATURE_GZIP_LEVELS(
76 //usage:     "\n        -1..9   Compression level"
77 //usage:        )
78 //usage:        IF_FEATURE_GZIP_DECOMPRESS(
79 //usage:     "\n        -d      Decompress"
80 //usage:     "\n        -t      Test file integrity"
81 //usage:        )
82 //usage:     "\n        -c      Write to stdout"
83 //usage:     "\n        -f      Force"
84 //usage:     "\n        -k      Keep input files"
85 //usage:
86 //usage:#define gzip_example_usage
87 //usage:       "$ ls -la /tmp/busybox*\n"
88 //usage:       "-rw-rw-r--    1 andersen andersen  1761280 Apr 14 17:47 /tmp/busybox.tar\n"
89 //usage:       "$ gzip /tmp/busybox.tar\n"
90 //usage:       "$ ls -la /tmp/busybox*\n"
91 //usage:       "-rw-rw-r--    1 andersen andersen   554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
92
93 #include "libbb.h"
94 #include "bb_archive.h"
95
96
97 /* ===========================================================================
98  */
99 //#define DEBUG 1
100 /* Diagnostic functions */
101 #ifdef DEBUG
102 static int verbose;
103 #  define Assert(cond,msg) { if (!(cond)) bb_error_msg(msg); }
104 #  define Trace(x) fprintf x
105 #  define Tracev(x) {if (verbose) fprintf x; }
106 #  define Tracevv(x) {if (verbose > 1) fprintf x; }
107 #  define Tracec(c,x) {if (verbose && (c)) fprintf x; }
108 #  define Tracecv(c,x) {if (verbose > 1 && (c)) fprintf x; }
109 #else
110 #  define Assert(cond,msg)
111 #  define Trace(x)
112 #  define Tracev(x)
113 #  define Tracevv(x)
114 #  define Tracec(c,x)
115 #  define Tracecv(c,x)
116 #endif
117
118
119 /* ===========================================================================
120  */
121 #if   CONFIG_GZIP_FAST == 0
122 # define SMALL_MEM
123 #elif CONFIG_GZIP_FAST == 1
124 # define MEDIUM_MEM
125 #elif CONFIG_GZIP_FAST == 2
126 # define BIG_MEM
127 #else
128 # error "Invalid CONFIG_GZIP_FAST value"
129 #endif
130
131 #ifndef INBUFSIZ
132 #  ifdef SMALL_MEM
133 #    define INBUFSIZ  0x2000    /* input buffer size */
134 #  else
135 #    define INBUFSIZ  0x8000    /* input buffer size */
136 #  endif
137 #endif
138
139 #ifndef OUTBUFSIZ
140 #  ifdef SMALL_MEM
141 #    define OUTBUFSIZ   8192    /* output buffer size */
142 #  else
143 #    define OUTBUFSIZ  16384    /* output buffer size */
144 #  endif
145 #endif
146
147 #ifndef DIST_BUFSIZE
148 #  ifdef SMALL_MEM
149 #    define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
150 #  else
151 #    define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
152 #  endif
153 #endif
154
155 /* gzip flag byte */
156 #define ASCII_FLAG   0x01       /* bit 0 set: file probably ascii text */
157 #define CONTINUATION 0x02       /* bit 1 set: continuation of multi-part gzip file */
158 #define EXTRA_FIELD  0x04       /* bit 2 set: extra field present */
159 #define ORIG_NAME    0x08       /* bit 3 set: original file name present */
160 #define COMMENT      0x10       /* bit 4 set: file comment present */
161 #define RESERVED     0xC0       /* bit 6,7:   reserved */
162
163 /* internal file attribute */
164 #define UNKNOWN 0xffff
165 #define BINARY  0
166 #define ASCII   1
167
168 #ifndef WSIZE
169 #  define WSIZE 0x8000  /* window size--must be a power of two, and */
170 #endif                  /*  at least 32K for zip's deflate method */
171
172 #define MIN_MATCH  3
173 #define MAX_MATCH  258
174 /* The minimum and maximum match lengths */
175
176 #define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
177 /* Minimum amount of lookahead, except at the end of the input file.
178  * See deflate.c for comments about the MIN_MATCH+1.
179  */
180
181 #define MAX_DIST  (WSIZE-MIN_LOOKAHEAD)
182 /* In order to simplify the code, particularly on 16 bit machines, match
183  * distances are limited to MAX_DIST instead of WSIZE.
184  */
185
186 #ifndef MAX_PATH_LEN
187 #  define MAX_PATH_LEN   1024   /* max pathname length */
188 #endif
189
190 #define seekable()    0 /* force sequential output */
191 #define translate_eol 0 /* no option -a yet */
192
193 #ifndef BITS
194 #  define BITS 16
195 #endif
196 #define INIT_BITS 9             /* Initial number of bits per code */
197
198 #define BIT_MASK    0x1f        /* Mask for 'number of compression bits' */
199 /* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
200  * It's a pity that old uncompress does not check bit 0x20. That makes
201  * extension of the format actually undesirable because old compress
202  * would just crash on the new format instead of giving a meaningful
203  * error message. It does check the number of bits, but it's more
204  * helpful to say "unsupported format, get a new version" than
205  * "can only handle 16 bits".
206  */
207
208 #ifdef MAX_EXT_CHARS
209 #  define MAX_SUFFIX  MAX_EXT_CHARS
210 #else
211 #  define MAX_SUFFIX  30
212 #endif
213
214
215 /* ===========================================================================
216  * Compile with MEDIUM_MEM to reduce the memory requirements or
217  * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
218  * entire input file can be held in memory (not possible on 16 bit systems).
219  * Warning: defining these symbols affects HASH_BITS (see below) and thus
220  * affects the compression ratio. The compressed output
221  * is still correct, and might even be smaller in some cases.
222  */
223
224 #ifdef SMALL_MEM
225 #   define HASH_BITS  13        /* Number of bits used to hash strings */
226 #endif
227 #ifdef MEDIUM_MEM
228 #   define HASH_BITS  14
229 #endif
230 #ifndef HASH_BITS
231 #   define HASH_BITS  15
232    /* For portability to 16 bit machines, do not use values above 15. */
233 #endif
234
235 #define HASH_SIZE (unsigned)(1<<HASH_BITS)
236 #define HASH_MASK (HASH_SIZE-1)
237 #define WMASK     (WSIZE-1)
238 /* HASH_SIZE and WSIZE must be powers of two */
239 #ifndef TOO_FAR
240 #  define TOO_FAR 4096
241 #endif
242 /* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
243
244
245 /* ===========================================================================
246  * These types are not really 'char', 'short' and 'long'
247  */
248 typedef uint8_t uch;
249 typedef uint16_t ush;
250 typedef uint32_t ulg;
251 typedef int32_t lng;
252
253 typedef ush Pos;
254 typedef unsigned IPos;
255 /* A Pos is an index in the character window. We use short instead of int to
256  * save space in the various tables. IPos is used only for parameter passing.
257  */
258
259 enum {
260         WINDOW_SIZE = 2 * WSIZE,
261 /* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
262  * input file length plus MIN_LOOKAHEAD.
263  */
264
265 #if !ENABLE_FEATURE_GZIP_LEVELS
266
267         max_chain_length = 4096,
268 /* To speed up deflation, hash chains are never searched beyond this length.
269  * A higher limit improves compression ratio but degrades the speed.
270  */
271
272         max_lazy_match = 258,
273 /* Attempt to find a better match only when the current match is strictly
274  * smaller than this value. This mechanism is used only for compression
275  * levels >= 4.
276  */
277
278         max_insert_length = max_lazy_match,
279 /* Insert new strings in the hash table only if the match length
280  * is not greater than this length. This saves time but degrades compression.
281  * max_insert_length is used only for compression levels <= 3.
282  */
283
284         good_match = 32,
285 /* Use a faster search when the previous match is longer than this */
286
287 /* Values for max_lazy_match, good_match and max_chain_length, depending on
288  * the desired pack level (0..9). The values given below have been tuned to
289  * exclude worst case performance for pathological files. Better values may be
290  * found for specific files.
291  */
292
293         nice_match = 258,       /* Stop searching when current match exceeds this */
294 /* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
295  * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
296  * meaning.
297  */
298 #endif /* ENABLE_FEATURE_GZIP_LEVELS */
299 };
300
301
302 struct globals {
303
304 #if ENABLE_FEATURE_GZIP_LEVELS
305         unsigned max_chain_length;
306         unsigned max_lazy_match;
307         unsigned good_match;
308         unsigned nice_match;
309 #define max_chain_length (G1.max_chain_length)
310 #define max_lazy_match   (G1.max_lazy_match)
311 #define good_match       (G1.good_match)
312 #define nice_match       (G1.nice_match)
313 #endif
314
315 /* window position at the beginning of the current output block. Gets
316  * negative when the window is moved backwards.
317  */
318         lng block_start;
319
320         unsigned ins_h; /* hash index of string to be inserted */
321
322 /* Number of bits by which ins_h and del_h must be shifted at each
323  * input step. It must be such that after MIN_MATCH steps, the oldest
324  * byte no longer takes part in the hash key, that is:
325  * H_SHIFT * MIN_MATCH >= HASH_BITS
326  */
327 #define H_SHIFT  ((HASH_BITS+MIN_MATCH-1) / MIN_MATCH)
328
329 /* Length of the best match at previous step. Matches not greater than this
330  * are discarded. This is used in the lazy match evaluation.
331  */
332         unsigned prev_length;
333
334         unsigned strstart;      /* start of string to insert */
335         unsigned match_start;   /* start of matching string */
336         unsigned lookahead;     /* number of valid bytes ahead in window */
337
338 /* number of input bytes */
339         ulg isize;              /* only 32 bits stored in .gz file */
340
341 /* bbox always use stdin/stdout */
342 #define ifd STDIN_FILENO        /* input file descriptor */
343 #define ofd STDOUT_FILENO       /* output file descriptor */
344
345 #ifdef DEBUG
346         unsigned insize;        /* valid bytes in l_buf */
347 #endif
348         unsigned outcnt;        /* bytes in output buffer */
349         smallint eofile;        /* flag set at end of input file */
350
351 /* ===========================================================================
352  * Local data used by the "bit string" routines.
353  */
354
355 /* Output buffer. bits are inserted starting at the bottom (least significant
356  * bits).
357  */
358         unsigned bi_buf;        /* was unsigned short */
359
360 #undef BUF_SIZE
361 #define BUF_SIZE (int)(8 * sizeof(G1.bi_buf))
362
363 /* Number of bits used within bi_buf. (bi_buf might be implemented on
364  * more than 16 bits on some systems.)
365  */
366         unsigned bi_valid;
367
368 #ifdef DEBUG
369         ulg bits_sent;  /* bit length of the compressed data */
370 #endif
371
372         /*uint32_t *crc_32_tab;*/
373         uint32_t crc;   /* shift register contents */
374
375 /* ===========================================================================
376  */
377 #define DECLARE(type, array, size) \
378         type * array
379 #define ALLOC(type, array, size) \
380         array = xzalloc((size_t)(((size)+1L)/2) * 2*sizeof(type))
381 #define FREE(array) \
382         do { free(array); array = NULL; } while (0)
383
384         /* global buffers */
385
386         /* buffer for literals or lengths */
387         /* DECLARE(uch, l_buf, LIT_BUFSIZE); */
388         DECLARE(uch, l_buf, INBUFSIZ);
389
390         DECLARE(ush, d_buf, DIST_BUFSIZE);
391         DECLARE(uch, outbuf, OUTBUFSIZ);
392
393 /* Sliding window. Input bytes are read into the second half of the window,
394  * and move to the first half later to keep a dictionary of at least WSIZE
395  * bytes. With this organization, matches are limited to a distance of
396  * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
397  * performed with a length multiple of the block size. Also, it limits
398  * the window size to 64K, which is quite useful on MSDOS.
399  * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
400  * be less efficient).
401  */
402         DECLARE(uch, window, 2L * WSIZE);
403
404 /* Link to older string with same hash index. To limit the size of this
405  * array to 64K, this link is maintained only for the last 32K strings.
406  * An index in this array is thus a window index modulo 32K.
407  */
408         /* DECLARE(Pos, prev, WSIZE); */
409         DECLARE(ush, prev, 1L << BITS);
410
411 /* Heads of the hash chains or 0. */
412         /* DECLARE(Pos, head, 1<<HASH_BITS); */
413 #define head (G1.prev + WSIZE) /* hash head (see deflate.c) */
414 };
415
416 #define G1 (*(ptr_to_globals - 1))
417
418
419 /* ===========================================================================
420  * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
421  * (used for the compressed data only)
422  */
423 static void flush_outbuf(void)
424 {
425         if (G1.outcnt == 0)
426                 return;
427
428         xwrite(ofd, (char *) G1.outbuf, G1.outcnt);
429         G1.outcnt = 0;
430 }
431
432
433 /* ===========================================================================
434  */
435 /* put_8bit is used for the compressed output */
436 #define put_8bit(c) \
437 do { \
438         G1.outbuf[G1.outcnt++] = (c); \
439         if (G1.outcnt == OUTBUFSIZ) \
440                 flush_outbuf(); \
441 } while (0)
442
443 /* Output a 16 bit value, lsb first */
444 static void put_16bit(ush w)
445 {
446         /* GCC 4.2.1 won't optimize out redundant loads of G1.outcnt
447          * (probably because of fear of aliasing with G1.outbuf[]
448          * stores), do it explicitly:
449          */
450         unsigned outcnt = G1.outcnt;
451         uch *dst = &G1.outbuf[outcnt];
452
453 #if BB_UNALIGNED_MEMACCESS_OK && BB_LITTLE_ENDIAN
454         if (outcnt < OUTBUFSIZ-2) {
455                 /* Common case */
456                 ush *dst16 = (void*) dst;
457                 *dst16 = w; /* unalinged LSB 16-bit store */
458                 G1.outcnt = outcnt + 2;
459                 return;
460         }
461         *dst = (uch)w;
462         w >>= 8;
463 #else
464         *dst = (uch)w;
465         w >>= 8;
466         if (outcnt < OUTBUFSIZ-2) {
467                 /* Common case */
468                 dst[1] = w;
469                 G1.outcnt = outcnt + 2;
470                 return;
471         }
472 #endif
473
474         /* Slowpath: we will need to do flush_outbuf() */
475         G1.outcnt = ++outcnt;
476         if (outcnt == OUTBUFSIZ)
477                 flush_outbuf();
478         put_8bit(w);
479 }
480
481 static void put_32bit(ulg n)
482 {
483         put_16bit(n);
484         put_16bit(n >> 16);
485 }
486
487 /* ===========================================================================
488  * Run a set of bytes through the crc shift register.  If s is a NULL
489  * pointer, then initialize the crc shift register contents instead.
490  * Return the current crc in either case.
491  */
492 static void updcrc(uch * s, unsigned n)
493 {
494         G1.crc = crc32_block_endian0(G1.crc, s, n, global_crc32_table /*G1.crc_32_tab*/);
495 }
496
497
498 /* ===========================================================================
499  * Read a new buffer from the current input file, perform end-of-line
500  * translation, and update the crc and input file size.
501  * IN assertion: size >= 2 (for end-of-line translation)
502  */
503 static unsigned file_read(void *buf, unsigned size)
504 {
505         unsigned len;
506
507         Assert(G1.insize == 0, "l_buf not empty");
508
509         len = safe_read(ifd, buf, size);
510         if (len == (unsigned)(-1) || len == 0)
511                 return len;
512
513         updcrc(buf, len);
514         G1.isize += len;
515         return len;
516 }
517
518
519 /* ===========================================================================
520  * Send a value on a given number of bits.
521  * IN assertion: length <= 16 and value fits in length bits.
522  */
523 static void send_bits(unsigned value, unsigned length)
524 {
525         unsigned new_buf;
526
527 #ifdef DEBUG
528         Tracev((stderr, " l %2d v %4x ", length, value));
529         Assert(length > 0 && length <= 15, "invalid length");
530         G1.bits_sent += length;
531 #endif
532         BUILD_BUG_ON(BUF_SIZE != 32 && BUF_SIZE != 16);
533
534         new_buf = G1.bi_buf | (value << G1.bi_valid);
535         /* NB: the above may sometimes do "<< 32" shift (undefined)
536          * if check below is changed to "length > BUF_SIZE" instead of >= */
537         length += G1.bi_valid;
538
539         /* If bi_buf is full */
540         if (length >= BUF_SIZE) {
541                 /* ...use (valid) bits from bi_buf and
542                  * (BUF_SIZE - bi_valid) bits from value,
543                  *  leaving (width - (BUF_SIZE-bi_valid)) unused bits in value.
544                  */
545                 value >>= (BUF_SIZE - G1.bi_valid);
546                 if (BUF_SIZE == 32) {
547                         put_32bit(new_buf); /* maybe unroll to 2*put_16bit()? */
548                 } else { /* 16 */
549                         put_16bit(new_buf);
550                 }
551                 new_buf = value;
552                 length -= BUF_SIZE;
553         }
554         G1.bi_buf = new_buf;
555         G1.bi_valid = length;
556 }
557
558
559 /* ===========================================================================
560  * Reverse the first len bits of a code, using straightforward code (a faster
561  * method would use a table)
562  * IN assertion: 1 <= len <= 15
563  */
564 static unsigned bi_reverse(unsigned code, int len)
565 {
566         unsigned res = 0;
567
568         while (1) {
569                 res |= code & 1;
570                 if (--len <= 0) return res;
571                 code >>= 1;
572                 res <<= 1;
573         }
574 }
575
576
577 /* ===========================================================================
578  * Write out any remaining bits in an incomplete byte.
579  */
580 static void bi_windup(void)
581 {
582         unsigned bits = G1.bi_buf;
583         int cnt = G1.bi_valid;
584
585         while (cnt > 0) {
586                 put_8bit(bits);
587                 bits >>= 8;
588                 cnt -= 8;
589         }
590         G1.bi_buf = 0;
591         G1.bi_valid = 0;
592 #ifdef DEBUG
593         G1.bits_sent = (G1.bits_sent + 7) & ~7;
594 #endif
595 }
596
597
598 /* ===========================================================================
599  * Copy a stored block to the zip file, storing first the length and its
600  * one's complement if requested.
601  */
602 static void copy_block(char *buf, unsigned len, int header)
603 {
604         bi_windup();            /* align on byte boundary */
605
606         if (header) {
607                 put_16bit(len);
608                 put_16bit(~len);
609 #ifdef DEBUG
610                 G1.bits_sent += 2 * 16;
611 #endif
612         }
613 #ifdef DEBUG
614         G1.bits_sent += (ulg) len << 3;
615 #endif
616         while (len--) {
617                 put_8bit(*buf++);
618         }
619 }
620
621
622 /* ===========================================================================
623  * Fill the window when the lookahead becomes insufficient.
624  * Updates strstart and lookahead, and sets eofile if end of input file.
625  * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
626  * OUT assertions: at least one byte has been read, or eofile is set;
627  *    file reads are performed for at least two bytes (required for the
628  *    translate_eol option).
629  */
630 static void fill_window(void)
631 {
632         unsigned n, m;
633         unsigned more = WINDOW_SIZE - G1.lookahead - G1.strstart;
634         /* Amount of free space at the end of the window. */
635
636         /* If the window is almost full and there is insufficient lookahead,
637          * move the upper half to the lower one to make room in the upper half.
638          */
639         if (more == (unsigned) -1) {
640                 /* Very unlikely, but possible on 16 bit machine if strstart == 0
641                  * and lookahead == 1 (input done one byte at time)
642                  */
643                 more--;
644         } else if (G1.strstart >= WSIZE + MAX_DIST) {
645                 /* By the IN assertion, the window is not empty so we can't confuse
646                  * more == 0 with more == 64K on a 16 bit machine.
647                  */
648                 Assert(WINDOW_SIZE == 2 * WSIZE, "no sliding with BIG_MEM");
649
650                 memcpy(G1.window, G1.window + WSIZE, WSIZE);
651                 G1.match_start -= WSIZE;
652                 G1.strstart -= WSIZE;   /* we now have strstart >= MAX_DIST: */
653
654                 G1.block_start -= WSIZE;
655
656                 for (n = 0; n < HASH_SIZE; n++) {
657                         m = head[n];
658                         head[n] = (Pos) (m >= WSIZE ? m - WSIZE : 0);
659                 }
660                 for (n = 0; n < WSIZE; n++) {
661                         m = G1.prev[n];
662                         G1.prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : 0);
663                         /* If n is not on any hash chain, prev[n] is garbage but
664                          * its value will never be used.
665                          */
666                 }
667                 more += WSIZE;
668         }
669         /* At this point, more >= 2 */
670         if (!G1.eofile) {
671                 n = file_read(G1.window + G1.strstart + G1.lookahead, more);
672                 if (n == 0 || n == (unsigned) -1) {
673                         G1.eofile = 1;
674                 } else {
675                         G1.lookahead += n;
676                 }
677         }
678 }
679 /* Both users fill window with the same loop: */
680 static void fill_window_if_needed(void)
681 {
682         while (G1.lookahead < MIN_LOOKAHEAD && !G1.eofile)
683                 fill_window();
684 }
685
686
687 /* ===========================================================================
688  * Set match_start to the longest match starting at the given string and
689  * return its length. Matches shorter or equal to prev_length are discarded,
690  * in which case the result is equal to prev_length and match_start is
691  * garbage.
692  * IN assertions: cur_match is the head of the hash chain for the current
693  *   string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
694  */
695
696 /* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
697  * match.s. The code is functionally equivalent, so you can use the C version
698  * if desired.
699  */
700 static int longest_match(IPos cur_match)
701 {
702         unsigned chain_length = max_chain_length;       /* max hash chain length */
703         uch *scan = G1.window + G1.strstart;    /* current string */
704         uch *match;     /* matched string */
705         int len;        /* length of current match */
706         int best_len = G1.prev_length;  /* best match length so far */
707         IPos limit = G1.strstart > (IPos) MAX_DIST ? G1.strstart - (IPos) MAX_DIST : 0;
708         /* Stop when cur_match becomes <= limit. To simplify the code,
709          * we prevent matches with the string of window index 0.
710          */
711
712 /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
713  * It is easy to get rid of this optimization if necessary.
714  */
715 #if HASH_BITS < 8 || MAX_MATCH != 258
716 #  error Code too clever
717 #endif
718         uch *strend = G1.window + G1.strstart + MAX_MATCH;
719         uch scan_end1 = scan[best_len - 1];
720         uch scan_end = scan[best_len];
721
722         /* Do not waste too much time if we already have a good match: */
723         if (G1.prev_length >= good_match) {
724                 chain_length >>= 2;
725         }
726         Assert(G1.strstart <= WINDOW_SIZE - MIN_LOOKAHEAD, "insufficient lookahead");
727
728         do {
729                 Assert(cur_match < G1.strstart, "no future");
730                 match = G1.window + cur_match;
731
732                 /* Skip to next match if the match length cannot increase
733                  * or if the match length is less than 2:
734                  */
735                 if (match[best_len] != scan_end
736                  || match[best_len - 1] != scan_end1
737                  || *match != *scan || *++match != scan[1]
738                 ) {
739                         continue;
740                 }
741
742                 /* The check at best_len-1 can be removed because it will be made
743                  * again later. (This heuristic is not always a win.)
744                  * It is not necessary to compare scan[2] and match[2] since they
745                  * are always equal when the other bytes match, given that
746                  * the hash keys are equal and that HASH_BITS >= 8.
747                  */
748                 scan += 2, match++;
749
750                 /* We check for insufficient lookahead only every 8th comparison;
751                  * the 256th check will be made at strstart+258.
752                  */
753                 do {
754                 } while (*++scan == *++match && *++scan == *++match &&
755                                  *++scan == *++match && *++scan == *++match &&
756                                  *++scan == *++match && *++scan == *++match &&
757                                  *++scan == *++match && *++scan == *++match && scan < strend);
758
759                 len = MAX_MATCH - (int) (strend - scan);
760                 scan = strend - MAX_MATCH;
761
762                 if (len > best_len) {
763                         G1.match_start = cur_match;
764                         best_len = len;
765                         if (len >= nice_match)
766                                 break;
767                         scan_end1 = scan[best_len - 1];
768                         scan_end = scan[best_len];
769                 }
770         } while ((cur_match = G1.prev[cur_match & WMASK]) > limit
771                          && --chain_length != 0);
772
773         return best_len;
774 }
775
776
777 #ifdef DEBUG
778 /* ===========================================================================
779  * Check that the match at match_start is indeed a match.
780  */
781 static void check_match(IPos start, IPos match, int length)
782 {
783         /* check that the match is indeed a match */
784         if (memcmp(G1.window + match, G1.window + start, length) != 0) {
785                 bb_error_msg(" start %d, match %d, length %d", start, match, length);
786                 bb_error_msg("invalid match");
787         }
788         if (verbose > 1) {
789                 bb_error_msg("\\[%d,%d]", start - match, length);
790                 do {
791                         bb_putchar_stderr(G1.window[start++]);
792                 } while (--length != 0);
793         }
794 }
795 #else
796 #  define check_match(start, match, length) ((void)0)
797 #endif
798
799
800 /* trees.c -- output deflated data using Huffman coding
801  * Copyright (C) 1992-1993 Jean-loup Gailly
802  * This is free software; you can redistribute it and/or modify it under the
803  * terms of the GNU General Public License, see the file COPYING.
804  */
805
806 /*  PURPOSE
807  *      Encode various sets of source values using variable-length
808  *      binary code trees.
809  *
810  *  DISCUSSION
811  *      The PKZIP "deflation" process uses several Huffman trees. The more
812  *      common source values are represented by shorter bit sequences.
813  *
814  *      Each code tree is stored in the ZIP file in a compressed form
815  *      which is itself a Huffman encoding of the lengths of
816  *      all the code strings (in ascending order by source values).
817  *      The actual code strings are reconstructed from the lengths in
818  *      the UNZIP process, as described in the "application note"
819  *      (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
820  *
821  *  REFERENCES
822  *      Lynch, Thomas J.
823  *          Data Compression:  Techniques and Applications, pp. 53-55.
824  *          Lifetime Learning Publications, 1985.  ISBN 0-534-03418-7.
825  *
826  *      Storer, James A.
827  *          Data Compression:  Methods and Theory, pp. 49-50.
828  *          Computer Science Press, 1988.  ISBN 0-7167-8156-5.
829  *
830  *      Sedgewick, R.
831  *          Algorithms, p290.
832  *          Addison-Wesley, 1983. ISBN 0-201-06672-6.
833  *
834  *  INTERFACE
835  *      void ct_init()
836  *          Allocate the match buffer, initialize the various tables [and save
837  *          the location of the internal file attribute (ascii/binary) and
838  *          method (DEFLATE/STORE) -- deleted in bbox]
839  *
840  *      void ct_tally(int dist, int lc);
841  *          Save the match info and tally the frequency counts.
842  *
843  *      ulg flush_block(char *buf, ulg stored_len, int eof)
844  *          Determine the best encoding for the current block: dynamic trees,
845  *          static trees or store, and output the encoded block to the zip
846  *          file. Returns the total compressed length for the file so far.
847  */
848
849 #define MAX_BITS 15
850 /* All codes must not exceed MAX_BITS bits */
851
852 #define MAX_BL_BITS 7
853 /* Bit length codes must not exceed MAX_BL_BITS bits */
854
855 #define LENGTH_CODES 29
856 /* number of length codes, not counting the special END_BLOCK code */
857
858 #define LITERALS  256
859 /* number of literal bytes 0..255 */
860
861 #define END_BLOCK 256
862 /* end of block literal code */
863
864 #define L_CODES (LITERALS+1+LENGTH_CODES)
865 /* number of Literal or Length codes, including the END_BLOCK code */
866
867 #define D_CODES   30
868 /* number of distance codes */
869
870 #define BL_CODES  19
871 /* number of codes used to transfer the bit lengths */
872
873 /* extra bits for each length code */
874 static const uint8_t extra_lbits[LENGTH_CODES] ALIGN1 = {
875         0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
876         4, 4, 5, 5, 5, 5, 0
877 };
878
879 /* extra bits for each distance code */
880 static const uint8_t extra_dbits[D_CODES] ALIGN1 = {
881         0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
882         10, 10, 11, 11, 12, 12, 13, 13
883 };
884
885 /* extra bits for each bit length code */
886 static const uint8_t extra_blbits[BL_CODES] ALIGN1 = {
887         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 7 };
888
889 /* number of codes at each bit length for an optimal tree */
890 static const uint8_t bl_order[BL_CODES] ALIGN1 = {
891         16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
892
893 #define STORED_BLOCK 0
894 #define STATIC_TREES 1
895 #define DYN_TREES    2
896 /* The three kinds of block type */
897
898 #ifndef LIT_BUFSIZE
899 #  ifdef SMALL_MEM
900 #    define LIT_BUFSIZE  0x2000
901 #  else
902 #  ifdef MEDIUM_MEM
903 #    define LIT_BUFSIZE  0x4000
904 #  else
905 #    define LIT_BUFSIZE  0x8000
906 #  endif
907 #  endif
908 #endif
909 #ifndef DIST_BUFSIZE
910 #  define DIST_BUFSIZE  LIT_BUFSIZE
911 #endif
912 /* Sizes of match buffers for literals/lengths and distances.  There are
913  * 4 reasons for limiting LIT_BUFSIZE to 64K:
914  *   - frequencies can be kept in 16 bit counters
915  *   - if compression is not successful for the first block, all input data is
916  *     still in the window so we can still emit a stored block even when input
917  *     comes from standard input.  (This can also be done for all blocks if
918  *     LIT_BUFSIZE is not greater than 32K.)
919  *   - if compression is not successful for a file smaller than 64K, we can
920  *     even emit a stored file instead of a stored block (saving 5 bytes).
921  *   - creating new Huffman trees less frequently may not provide fast
922  *     adaptation to changes in the input data statistics. (Take for
923  *     example a binary file with poorly compressible code followed by
924  *     a highly compressible string table.) Smaller buffer sizes give
925  *     fast adaptation but have of course the overhead of transmitting trees
926  *     more frequently.
927  *   - I can't count above 4
928  * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
929  * memory at the expense of compression). Some optimizations would be possible
930  * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
931  */
932 #define REP_3_6      16
933 /* repeat previous bit length 3-6 times (2 bits of repeat count) */
934 #define REPZ_3_10    17
935 /* repeat a zero length 3-10 times  (3 bits of repeat count) */
936 #define REPZ_11_138  18
937 /* repeat a zero length 11-138 times  (7 bits of repeat count) */
938
939 /* ===========================================================================
940 */
941 /* Data structure describing a single value and its code string. */
942 typedef struct ct_data {
943         union {
944                 ush freq;               /* frequency count */
945                 ush code;               /* bit string */
946         } fc;
947         union {
948                 ush dad;                /* father node in Huffman tree */
949                 ush len;                /* length of bit string */
950         } dl;
951 } ct_data;
952
953 #define Freq fc.freq
954 #define Code fc.code
955 #define Dad  dl.dad
956 #define Len  dl.len
957
958 #define HEAP_SIZE (2*L_CODES + 1)
959 /* maximum heap size */
960
961 typedef struct tree_desc {
962         ct_data *dyn_tree;      /* the dynamic tree */
963         ct_data *static_tree;   /* corresponding static tree or NULL */
964         const uint8_t *extra_bits;      /* extra bits for each code or NULL */
965         int extra_base;         /* base index for extra_bits */
966         int elems;                      /* max number of elements in the tree */
967         int max_length;         /* max bit length for the codes */
968         int max_code;           /* largest code with non zero frequency */
969 } tree_desc;
970
971 struct globals2 {
972
973         ush heap[HEAP_SIZE];     /* heap used to build the Huffman trees */
974         int heap_len;            /* number of elements in the heap */
975         int heap_max;            /* element of largest frequency */
976
977 /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
978  * The same heap array is used to build all trees.
979  */
980
981         ct_data dyn_ltree[HEAP_SIZE];   /* literal and length tree */
982         ct_data dyn_dtree[2 * D_CODES + 1];     /* distance tree */
983
984         ct_data static_ltree[L_CODES + 2];
985
986 /* The static literal tree. Since the bit lengths are imposed, there is no
987  * need for the L_CODES extra codes used during heap construction. However
988  * The codes 286 and 287 are needed to build a canonical tree (see ct_init
989  * below).
990  */
991
992         ct_data static_dtree[D_CODES];
993
994 /* The static distance tree. (Actually a trivial tree since all codes use
995  * 5 bits.)
996  */
997
998         ct_data bl_tree[2 * BL_CODES + 1];
999
1000 /* Huffman tree for the bit lengths */
1001
1002         tree_desc l_desc;
1003         tree_desc d_desc;
1004         tree_desc bl_desc;
1005
1006         ush bl_count[MAX_BITS + 1];
1007
1008 /* The lengths of the bit length codes are sent in order of decreasing
1009  * probability, to avoid transmitting the lengths for unused bit length codes.
1010  */
1011
1012         uch depth[2 * L_CODES + 1];
1013
1014 /* Depth of each subtree used as tie breaker for trees of equal frequency */
1015
1016         uch length_code[MAX_MATCH - MIN_MATCH + 1];
1017
1018 /* length code for each normalized match length (0 == MIN_MATCH) */
1019
1020         uch dist_code[512];
1021
1022 /* distance codes. The first 256 values correspond to the distances
1023  * 3 .. 258, the last 256 values correspond to the top 8 bits of
1024  * the 15 bit distances.
1025  */
1026
1027         int base_length[LENGTH_CODES];
1028
1029 /* First normalized length for each code (0 = MIN_MATCH) */
1030
1031         int base_dist[D_CODES];
1032
1033 /* First normalized distance for each code (0 = distance of 1) */
1034
1035         uch flag_buf[LIT_BUFSIZE / 8];
1036
1037 /* flag_buf is a bit array distinguishing literals from lengths in
1038  * l_buf, thus indicating the presence or absence of a distance.
1039  */
1040
1041         unsigned last_lit;       /* running index in l_buf */
1042         unsigned last_dist;      /* running index in d_buf */
1043         unsigned last_flags;     /* running index in flag_buf */
1044         uch flags;               /* current flags not yet saved in flag_buf */
1045         uch flag_bit;            /* current bit used in flags */
1046
1047 /* bits are filled in flags starting at bit 0 (least significant).
1048  * Note: these flags are overkill in the current code since we don't
1049  * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1050  */
1051
1052         ulg opt_len;             /* bit length of current block with optimal trees */
1053         ulg static_len;          /* bit length of current block with static trees */
1054
1055         ulg compressed_len;      /* total bit length of compressed file */
1056 };
1057
1058 #define G2ptr ((struct globals2*)(ptr_to_globals))
1059 #define G2 (*G2ptr)
1060
1061
1062 /* ===========================================================================
1063  */
1064 static void gen_codes(ct_data * tree, int max_code);
1065 static void build_tree(tree_desc * desc);
1066 static void scan_tree(ct_data * tree, int max_code);
1067 static void send_tree(ct_data * tree, int max_code);
1068 static int build_bl_tree(void);
1069 static void send_all_trees(int lcodes, int dcodes, int blcodes);
1070 static void compress_block(ct_data * ltree, ct_data * dtree);
1071
1072
1073 #ifndef DEBUG
1074 /* Send a code of the given tree. c and tree must not have side effects */
1075 #  define SEND_CODE(c, tree) send_bits(tree[c].Code, tree[c].Len)
1076 #else
1077 #  define SEND_CODE(c, tree) \
1078 { \
1079         if (verbose > 1) bb_error_msg("\ncd %3d ", (c)); \
1080         send_bits(tree[c].Code, tree[c].Len); \
1081 }
1082 #endif
1083
1084 #define D_CODE(dist) \
1085         ((dist) < 256 ? G2.dist_code[dist] : G2.dist_code[256 + ((dist)>>7)])
1086 /* Mapping from a distance to a distance code. dist is the distance - 1 and
1087  * must not have side effects. dist_code[256] and dist_code[257] are never
1088  * used.
1089  * The arguments must not have side effects.
1090  */
1091
1092
1093 /* ===========================================================================
1094  * Initialize a new block.
1095  */
1096 static void init_block(void)
1097 {
1098         int n; /* iterates over tree elements */
1099
1100         /* Initialize the trees. */
1101         for (n = 0; n < L_CODES; n++)
1102                 G2.dyn_ltree[n].Freq = 0;
1103         for (n = 0; n < D_CODES; n++)
1104                 G2.dyn_dtree[n].Freq = 0;
1105         for (n = 0; n < BL_CODES; n++)
1106                 G2.bl_tree[n].Freq = 0;
1107
1108         G2.dyn_ltree[END_BLOCK].Freq = 1;
1109         G2.opt_len = G2.static_len = 0;
1110         G2.last_lit = G2.last_dist = G2.last_flags = 0;
1111         G2.flags = 0;
1112         G2.flag_bit = 1;
1113 }
1114
1115
1116 /* ===========================================================================
1117  * Restore the heap property by moving down the tree starting at node k,
1118  * exchanging a node with the smallest of its two sons if necessary, stopping
1119  * when the heap property is re-established (each father smaller than its
1120  * two sons).
1121  */
1122
1123 /* Compares to subtrees, using the tree depth as tie breaker when
1124  * the subtrees have equal frequency. This minimizes the worst case length. */
1125 #define SMALLER(tree, n, m) \
1126         (tree[n].Freq < tree[m].Freq \
1127         || (tree[n].Freq == tree[m].Freq && G2.depth[n] <= G2.depth[m]))
1128
1129 static void pqdownheap(ct_data * tree, int k)
1130 {
1131         int v = G2.heap[k];
1132         int j = k << 1;         /* left son of k */
1133
1134         while (j <= G2.heap_len) {
1135                 /* Set j to the smallest of the two sons: */
1136                 if (j < G2.heap_len && SMALLER(tree, G2.heap[j + 1], G2.heap[j]))
1137                         j++;
1138
1139                 /* Exit if v is smaller than both sons */
1140                 if (SMALLER(tree, v, G2.heap[j]))
1141                         break;
1142
1143                 /* Exchange v with the smallest son */
1144                 G2.heap[k] = G2.heap[j];
1145                 k = j;
1146
1147                 /* And continue down the tree, setting j to the left son of k */
1148                 j <<= 1;
1149         }
1150         G2.heap[k] = v;
1151 }
1152
1153
1154 /* ===========================================================================
1155  * Compute the optimal bit lengths for a tree and update the total bit length
1156  * for the current block.
1157  * IN assertion: the fields freq and dad are set, heap[heap_max] and
1158  *    above are the tree nodes sorted by increasing frequency.
1159  * OUT assertions: the field len is set to the optimal bit length, the
1160  *     array bl_count contains the frequencies for each bit length.
1161  *     The length opt_len is updated; static_len is also updated if stree is
1162  *     not null.
1163  */
1164 static void gen_bitlen(tree_desc * desc)
1165 {
1166         ct_data *tree = desc->dyn_tree;
1167         const uint8_t *extra = desc->extra_bits;
1168         int base = desc->extra_base;
1169         int max_code = desc->max_code;
1170         int max_length = desc->max_length;
1171         ct_data *stree = desc->static_tree;
1172         int h;                          /* heap index */
1173         int n, m;                       /* iterate over the tree elements */
1174         int bits;                       /* bit length */
1175         int xbits;                      /* extra bits */
1176         ush f;                          /* frequency */
1177         int overflow = 0;       /* number of elements with bit length too large */
1178
1179         for (bits = 0; bits <= MAX_BITS; bits++)
1180                 G2.bl_count[bits] = 0;
1181
1182         /* In a first pass, compute the optimal bit lengths (which may
1183          * overflow in the case of the bit length tree).
1184          */
1185         tree[G2.heap[G2.heap_max]].Len = 0;     /* root of the heap */
1186
1187         for (h = G2.heap_max + 1; h < HEAP_SIZE; h++) {
1188                 n = G2.heap[h];
1189                 bits = tree[tree[n].Dad].Len + 1;
1190                 if (bits > max_length) {
1191                         bits = max_length;
1192                         overflow++;
1193                 }
1194                 tree[n].Len = (ush) bits;
1195                 /* We overwrite tree[n].Dad which is no longer needed */
1196
1197                 if (n > max_code)
1198                         continue;       /* not a leaf node */
1199
1200                 G2.bl_count[bits]++;
1201                 xbits = 0;
1202                 if (n >= base)
1203                         xbits = extra[n - base];
1204                 f = tree[n].Freq;
1205                 G2.opt_len += (ulg) f *(bits + xbits);
1206
1207                 if (stree)
1208                         G2.static_len += (ulg) f * (stree[n].Len + xbits);
1209         }
1210         if (overflow == 0)
1211                 return;
1212
1213         Trace((stderr, "\nbit length overflow\n"));
1214         /* This happens for example on obj2 and pic of the Calgary corpus */
1215
1216         /* Find the first bit length which could increase: */
1217         do {
1218                 bits = max_length - 1;
1219                 while (G2.bl_count[bits] == 0)
1220                         bits--;
1221                 G2.bl_count[bits]--;    /* move one leaf down the tree */
1222                 G2.bl_count[bits + 1] += 2;     /* move one overflow item as its brother */
1223                 G2.bl_count[max_length]--;
1224                 /* The brother of the overflow item also moves one step up,
1225                  * but this does not affect bl_count[max_length]
1226                  */
1227                 overflow -= 2;
1228         } while (overflow > 0);
1229
1230         /* Now recompute all bit lengths, scanning in increasing frequency.
1231          * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1232          * lengths instead of fixing only the wrong ones. This idea is taken
1233          * from 'ar' written by Haruhiko Okumura.)
1234          */
1235         for (bits = max_length; bits != 0; bits--) {
1236                 n = G2.bl_count[bits];
1237                 while (n != 0) {
1238                         m = G2.heap[--h];
1239                         if (m > max_code)
1240                                 continue;
1241                         if (tree[m].Len != (unsigned) bits) {
1242                                 Trace((stderr, "code %d bits %d->%d\n", m, tree[m].Len, bits));
1243                                 G2.opt_len += ((int32_t) bits - tree[m].Len) * tree[m].Freq;
1244                                 tree[m].Len = bits;
1245                         }
1246                         n--;
1247                 }
1248         }
1249 }
1250
1251
1252 /* ===========================================================================
1253  * Generate the codes for a given tree and bit counts (which need not be
1254  * optimal).
1255  * IN assertion: the array bl_count contains the bit length statistics for
1256  * the given tree and the field len is set for all tree elements.
1257  * OUT assertion: the field code is set for all tree elements of non
1258  *     zero code length.
1259  */
1260 static void gen_codes(ct_data * tree, int max_code)
1261 {
1262         ush next_code[MAX_BITS + 1];    /* next code value for each bit length */
1263         ush code = 0;           /* running code value */
1264         int bits;                       /* bit index */
1265         int n;                          /* code index */
1266
1267         /* The distribution counts are first used to generate the code values
1268          * without bit reversal.
1269          */
1270         for (bits = 1; bits <= MAX_BITS; bits++) {
1271                 next_code[bits] = code = (code + G2.bl_count[bits - 1]) << 1;
1272         }
1273         /* Check that the bit counts in bl_count are consistent. The last code
1274          * must be all ones.
1275          */
1276         Assert(code + G2.bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1277                         "inconsistent bit counts");
1278         Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
1279
1280         for (n = 0; n <= max_code; n++) {
1281                 int len = tree[n].Len;
1282
1283                 if (len == 0)
1284                         continue;
1285                 /* Now reverse the bits */
1286                 tree[n].Code = bi_reverse(next_code[len]++, len);
1287
1288                 Tracec(tree != G2.static_ltree,
1289                            (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1290                                 (n > ' ' ? n : ' '), len, tree[n].Code,
1291                                 next_code[len] - 1));
1292         }
1293 }
1294
1295
1296 /* ===========================================================================
1297  * Construct one Huffman tree and assigns the code bit strings and lengths.
1298  * Update the total bit length for the current block.
1299  * IN assertion: the field freq is set for all tree elements.
1300  * OUT assertions: the fields len and code are set to the optimal bit length
1301  *     and corresponding code. The length opt_len is updated; static_len is
1302  *     also updated if stree is not null. The field max_code is set.
1303  */
1304
1305 /* Remove the smallest element from the heap and recreate the heap with
1306  * one less element. Updates heap and heap_len. */
1307
1308 #define SMALLEST 1
1309 /* Index within the heap array of least frequent node in the Huffman tree */
1310
1311 #define PQREMOVE(tree, top) \
1312 do { \
1313         top = G2.heap[SMALLEST]; \
1314         G2.heap[SMALLEST] = G2.heap[G2.heap_len--]; \
1315         pqdownheap(tree, SMALLEST); \
1316 } while (0)
1317
1318 static void build_tree(tree_desc * desc)
1319 {
1320         ct_data *tree = desc->dyn_tree;
1321         ct_data *stree = desc->static_tree;
1322         int elems = desc->elems;
1323         int n, m;                       /* iterate over heap elements */
1324         int max_code = -1;      /* largest code with non zero frequency */
1325         int node = elems;       /* next internal node of the tree */
1326
1327         /* Construct the initial heap, with least frequent element in
1328          * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1329          * heap[0] is not used.
1330          */
1331         G2.heap_len = 0;
1332         G2.heap_max = HEAP_SIZE;
1333
1334         for (n = 0; n < elems; n++) {
1335                 if (tree[n].Freq != 0) {
1336                         G2.heap[++G2.heap_len] = max_code = n;
1337                         G2.depth[n] = 0;
1338                 } else {
1339                         tree[n].Len = 0;
1340                 }
1341         }
1342
1343         /* The pkzip format requires that at least one distance code exists,
1344          * and that at least one bit should be sent even if there is only one
1345          * possible code. So to avoid special checks later on we force at least
1346          * two codes of non zero frequency.
1347          */
1348         while (G2.heap_len < 2) {
1349                 int new = G2.heap[++G2.heap_len] = (max_code < 2 ? ++max_code : 0);
1350
1351                 tree[new].Freq = 1;
1352                 G2.depth[new] = 0;
1353                 G2.opt_len--;
1354                 if (stree)
1355                         G2.static_len -= stree[new].Len;
1356                 /* new is 0 or 1 so it does not have extra bits */
1357         }
1358         desc->max_code = max_code;
1359
1360         /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
1361          * establish sub-heaps of increasing lengths:
1362          */
1363         for (n = G2.heap_len / 2; n >= 1; n--)
1364                 pqdownheap(tree, n);
1365
1366         /* Construct the Huffman tree by repeatedly combining the least two
1367          * frequent nodes.
1368          */
1369         do {
1370                 PQREMOVE(tree, n);      /* n = node of least frequency */
1371                 m = G2.heap[SMALLEST];  /* m = node of next least frequency */
1372
1373                 G2.heap[--G2.heap_max] = n;     /* keep the nodes sorted by frequency */
1374                 G2.heap[--G2.heap_max] = m;
1375
1376                 /* Create a new node father of n and m */
1377                 tree[node].Freq = tree[n].Freq + tree[m].Freq;
1378                 G2.depth[node] = MAX(G2.depth[n], G2.depth[m]) + 1;
1379                 tree[n].Dad = tree[m].Dad = (ush) node;
1380 #ifdef DUMP_BL_TREE
1381                 if (tree == G2.bl_tree) {
1382                         bb_error_msg("\nnode %d(%d), sons %d(%d) %d(%d)",
1383                                         node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
1384                 }
1385 #endif
1386                 /* and insert the new node in the heap */
1387                 G2.heap[SMALLEST] = node++;
1388                 pqdownheap(tree, SMALLEST);
1389         } while (G2.heap_len >= 2);
1390
1391         G2.heap[--G2.heap_max] = G2.heap[SMALLEST];
1392
1393         /* At this point, the fields freq and dad are set. We can now
1394          * generate the bit lengths.
1395          */
1396         gen_bitlen((tree_desc *) desc);
1397
1398         /* The field len is now set, we can generate the bit codes */
1399         gen_codes((ct_data *) tree, max_code);
1400 }
1401
1402
1403 /* ===========================================================================
1404  * Scan a literal or distance tree to determine the frequencies of the codes
1405  * in the bit length tree. Updates opt_len to take into account the repeat
1406  * counts. (The contribution of the bit length codes will be added later
1407  * during the construction of bl_tree.)
1408  */
1409 static void scan_tree(ct_data * tree, int max_code)
1410 {
1411         int n;                          /* iterates over all tree elements */
1412         int prevlen = -1;       /* last emitted length */
1413         int curlen;                     /* length of current code */
1414         int nextlen = tree[0].Len;      /* length of next code */
1415         int count = 0;          /* repeat count of the current code */
1416         int max_count = 7;      /* max repeat count */
1417         int min_count = 4;      /* min repeat count */
1418
1419         if (nextlen == 0) {
1420                 max_count = 138;
1421                 min_count = 3;
1422         }
1423         tree[max_code + 1].Len = 0xffff; /* guard */
1424
1425         for (n = 0; n <= max_code; n++) {
1426                 curlen = nextlen;
1427                 nextlen = tree[n + 1].Len;
1428                 if (++count < max_count && curlen == nextlen)
1429                         continue;
1430
1431                 if (count < min_count) {
1432                         G2.bl_tree[curlen].Freq += count;
1433                 } else if (curlen != 0) {
1434                         if (curlen != prevlen)
1435                                 G2.bl_tree[curlen].Freq++;
1436                         G2.bl_tree[REP_3_6].Freq++;
1437                 } else if (count <= 10) {
1438                         G2.bl_tree[REPZ_3_10].Freq++;
1439                 } else {
1440                         G2.bl_tree[REPZ_11_138].Freq++;
1441                 }
1442                 count = 0;
1443                 prevlen = curlen;
1444
1445                 max_count = 7;
1446                 min_count = 4;
1447                 if (nextlen == 0) {
1448                         max_count = 138;
1449                         min_count = 3;
1450                 } else if (curlen == nextlen) {
1451                         max_count = 6;
1452                         min_count = 3;
1453                 }
1454         }
1455 }
1456
1457
1458 /* ===========================================================================
1459  * Send a literal or distance tree in compressed form, using the codes in
1460  * bl_tree.
1461  */
1462 static void send_tree(ct_data * tree, int max_code)
1463 {
1464         int n;                          /* iterates over all tree elements */
1465         int prevlen = -1;       /* last emitted length */
1466         int curlen;                     /* length of current code */
1467         int nextlen = tree[0].Len;      /* length of next code */
1468         int count = 0;          /* repeat count of the current code */
1469         int max_count = 7;      /* max repeat count */
1470         int min_count = 4;      /* min repeat count */
1471
1472 /* tree[max_code+1].Len = -1; *//* guard already set */
1473         if (nextlen == 0)
1474                 max_count = 138, min_count = 3;
1475
1476         for (n = 0; n <= max_code; n++) {
1477                 curlen = nextlen;
1478                 nextlen = tree[n + 1].Len;
1479                 if (++count < max_count && curlen == nextlen) {
1480                         continue;
1481                 } else if (count < min_count) {
1482                         do {
1483                                 SEND_CODE(curlen, G2.bl_tree);
1484                         } while (--count);
1485                 } else if (curlen != 0) {
1486                         if (curlen != prevlen) {
1487                                 SEND_CODE(curlen, G2.bl_tree);
1488                                 count--;
1489                         }
1490                         Assert(count >= 3 && count <= 6, " 3_6?");
1491                         SEND_CODE(REP_3_6, G2.bl_tree);
1492                         send_bits(count - 3, 2);
1493                 } else if (count <= 10) {
1494                         SEND_CODE(REPZ_3_10, G2.bl_tree);
1495                         send_bits(count - 3, 3);
1496                 } else {
1497                         SEND_CODE(REPZ_11_138, G2.bl_tree);
1498                         send_bits(count - 11, 7);
1499                 }
1500                 count = 0;
1501                 prevlen = curlen;
1502                 if (nextlen == 0) {
1503                         max_count = 138;
1504                         min_count = 3;
1505                 } else if (curlen == nextlen) {
1506                         max_count = 6;
1507                         min_count = 3;
1508                 } else {
1509                         max_count = 7;
1510                         min_count = 4;
1511                 }
1512         }
1513 }
1514
1515
1516 /* ===========================================================================
1517  * Construct the Huffman tree for the bit lengths and return the index in
1518  * bl_order of the last bit length code to send.
1519  */
1520 static int build_bl_tree(void)
1521 {
1522         int max_blindex;        /* index of last bit length code of non zero freq */
1523
1524         /* Determine the bit length frequencies for literal and distance trees */
1525         scan_tree(G2.dyn_ltree, G2.l_desc.max_code);
1526         scan_tree(G2.dyn_dtree, G2.d_desc.max_code);
1527
1528         /* Build the bit length tree: */
1529         build_tree(&G2.bl_desc);
1530         /* opt_len now includes the length of the tree representations, except
1531          * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
1532          */
1533
1534         /* Determine the number of bit length codes to send. The pkzip format
1535          * requires that at least 4 bit length codes be sent. (appnote.txt says
1536          * 3 but the actual value used is 4.)
1537          */
1538         for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
1539                 if (G2.bl_tree[bl_order[max_blindex]].Len != 0)
1540                         break;
1541         }
1542         /* Update opt_len to include the bit length tree and counts */
1543         G2.opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
1544         Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", (long)G2.opt_len, (long)G2.static_len));
1545
1546         return max_blindex;
1547 }
1548
1549
1550 /* ===========================================================================
1551  * Send the header for a block using dynamic Huffman trees: the counts, the
1552  * lengths of the bit length codes, the literal tree and the distance tree.
1553  * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
1554  */
1555 static void send_all_trees(int lcodes, int dcodes, int blcodes)
1556 {
1557         int rank;                       /* index in bl_order */
1558
1559         Assert(lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
1560         Assert(lcodes <= L_CODES && dcodes <= D_CODES
1561                    && blcodes <= BL_CODES, "too many codes");
1562         Tracev((stderr, "\nbl counts: "));
1563         send_bits(lcodes - 257, 5);     /* not +255 as stated in appnote.txt */
1564         send_bits(dcodes - 1, 5);
1565         send_bits(blcodes - 4, 4);      /* not -3 as stated in appnote.txt */
1566         for (rank = 0; rank < blcodes; rank++) {
1567                 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
1568                 send_bits(G2.bl_tree[bl_order[rank]].Len, 3);
1569         }
1570         Tracev((stderr, "\nbl tree: sent %ld", (long)G1.bits_sent));
1571
1572         send_tree((ct_data *) G2.dyn_ltree, lcodes - 1);        /* send the literal tree */
1573         Tracev((stderr, "\nlit tree: sent %ld", (long)G1.bits_sent));
1574
1575         send_tree((ct_data *) G2.dyn_dtree, dcodes - 1);        /* send the distance tree */
1576         Tracev((stderr, "\ndist tree: sent %ld", (long)G1.bits_sent));
1577 }
1578
1579
1580 /* ===========================================================================
1581  * Save the match info and tally the frequency counts. Return true if
1582  * the current block must be flushed.
1583  */
1584 static int ct_tally(int dist, int lc)
1585 {
1586         G1.l_buf[G2.last_lit++] = lc;
1587         if (dist == 0) {
1588                 /* lc is the unmatched char */
1589                 G2.dyn_ltree[lc].Freq++;
1590         } else {
1591                 /* Here, lc is the match length - MIN_MATCH */
1592                 dist--;                 /* dist = match distance - 1 */
1593                 Assert((ush) dist < (ush) MAX_DIST
1594                  && (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH)
1595                  && (ush) D_CODE(dist) < (ush) D_CODES, "ct_tally: bad match"
1596                 );
1597
1598                 G2.dyn_ltree[G2.length_code[lc] + LITERALS + 1].Freq++;
1599                 G2.dyn_dtree[D_CODE(dist)].Freq++;
1600
1601                 G1.d_buf[G2.last_dist++] = dist;
1602                 G2.flags |= G2.flag_bit;
1603         }
1604         G2.flag_bit <<= 1;
1605
1606         /* Output the flags if they fill a byte: */
1607         if ((G2.last_lit & 7) == 0) {
1608                 G2.flag_buf[G2.last_flags++] = G2.flags;
1609                 G2.flags = 0;
1610                 G2.flag_bit = 1;
1611         }
1612         /* Try to guess if it is profitable to stop the current block here */
1613         if ((G2.last_lit & 0xfff) == 0) {
1614                 /* Compute an upper bound for the compressed length */
1615                 ulg out_length = G2.last_lit * 8L;
1616                 ulg in_length = (ulg) G1.strstart - G1.block_start;
1617                 int dcode;
1618
1619                 for (dcode = 0; dcode < D_CODES; dcode++) {
1620                         out_length += G2.dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
1621                 }
1622                 out_length >>= 3;
1623                 Trace((stderr,
1624                                 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
1625                                 G2.last_lit, G2.last_dist,
1626                                 (long)in_length, (long)out_length,
1627                                 100L - out_length * 100L / in_length));
1628                 if (G2.last_dist < G2.last_lit / 2 && out_length < in_length / 2)
1629                         return 1;
1630         }
1631         return (G2.last_lit == LIT_BUFSIZE - 1 || G2.last_dist == DIST_BUFSIZE);
1632         /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
1633          * on 16 bit machines and because stored blocks are restricted to
1634          * 64K-1 bytes.
1635          */
1636 }
1637
1638 /* ===========================================================================
1639  * Send the block data compressed using the given Huffman trees
1640  */
1641 static void compress_block(ct_data * ltree, ct_data * dtree)
1642 {
1643         unsigned dist;          /* distance of matched string */
1644         int lc;                 /* match length or unmatched char (if dist == 0) */
1645         unsigned lx = 0;        /* running index in l_buf */
1646         unsigned dx = 0;        /* running index in d_buf */
1647         unsigned fx = 0;        /* running index in flag_buf */
1648         uch flag = 0;           /* current flags */
1649         unsigned code;          /* the code to send */
1650         int extra;              /* number of extra bits to send */
1651
1652         if (G2.last_lit != 0) do {
1653                 if ((lx & 7) == 0)
1654                         flag = G2.flag_buf[fx++];
1655                 lc = G1.l_buf[lx++];
1656                 if ((flag & 1) == 0) {
1657                         SEND_CODE(lc, ltree);   /* send a literal byte */
1658                         Tracecv(lc > ' ', (stderr, " '%c' ", lc));
1659                 } else {
1660                         /* Here, lc is the match length - MIN_MATCH */
1661                         code = G2.length_code[lc];
1662                         SEND_CODE(code + LITERALS + 1, ltree);  /* send the length code */
1663                         extra = extra_lbits[code];
1664                         if (extra != 0) {
1665                                 lc -= G2.base_length[code];
1666                                 send_bits(lc, extra);   /* send the extra length bits */
1667                         }
1668                         dist = G1.d_buf[dx++];
1669                         /* Here, dist is the match distance - 1 */
1670                         code = D_CODE(dist);
1671                         Assert(code < D_CODES, "bad d_code");
1672
1673                         SEND_CODE(code, dtree); /* send the distance code */
1674                         extra = extra_dbits[code];
1675                         if (extra != 0) {
1676                                 dist -= G2.base_dist[code];
1677                                 send_bits(dist, extra); /* send the extra distance bits */
1678                         }
1679                 }                       /* literal or match pair ? */
1680                 flag >>= 1;
1681         } while (lx < G2.last_lit);
1682
1683         SEND_CODE(END_BLOCK, ltree);
1684 }
1685
1686
1687 /* ===========================================================================
1688  * Determine the best encoding for the current block: dynamic trees, static
1689  * trees or store, and output the encoded block to the zip file. This function
1690  * returns the total compressed length for the file so far.
1691  */
1692 static ulg flush_block(char *buf, ulg stored_len, int eof)
1693 {
1694         ulg opt_lenb, static_lenb;      /* opt_len and static_len in bytes */
1695         int max_blindex;                /* index of last bit length code of non zero freq */
1696
1697         G2.flag_buf[G2.last_flags] = G2.flags;   /* Save the flags for the last 8 items */
1698
1699         /* Construct the literal and distance trees */
1700         build_tree(&G2.l_desc);
1701         Tracev((stderr, "\nlit data: dyn %ld, stat %ld", (long)G2.opt_len, (long)G2.static_len));
1702
1703         build_tree(&G2.d_desc);
1704         Tracev((stderr, "\ndist data: dyn %ld, stat %ld", (long)G2.opt_len, (long)G2.static_len));
1705         /* At this point, opt_len and static_len are the total bit lengths of
1706          * the compressed block data, excluding the tree representations.
1707          */
1708
1709         /* Build the bit length tree for the above two trees, and get the index
1710          * in bl_order of the last bit length code to send.
1711          */
1712         max_blindex = build_bl_tree();
1713
1714         /* Determine the best encoding. Compute first the block length in bytes */
1715         opt_lenb = (G2.opt_len + 3 + 7) >> 3;
1716         static_lenb = (G2.static_len + 3 + 7) >> 3;
1717
1718         Trace((stderr,
1719                         "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
1720                         (unsigned long)opt_lenb, (unsigned long)G2.opt_len,
1721                         (unsigned long)static_lenb, (unsigned long)G2.static_len,
1722                         (unsigned long)stored_len,
1723                         G2.last_lit, G2.last_dist));
1724
1725         if (static_lenb <= opt_lenb)
1726                 opt_lenb = static_lenb;
1727
1728         /* If compression failed and this is the first and last block,
1729          * and if the zip file can be seeked (to rewrite the local header),
1730          * the whole file is transformed into a stored file:
1731          */
1732         if (stored_len <= opt_lenb && eof && G2.compressed_len == 0L && seekable()) {
1733                 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
1734                 if (buf == NULL)
1735                         bb_error_msg("block vanished");
1736
1737                 copy_block(buf, (unsigned) stored_len, 0);      /* without header */
1738                 G2.compressed_len = stored_len << 3;
1739         } else if (stored_len + 4 <= opt_lenb && buf != NULL) {
1740                 /* 4: two words for the lengths */
1741                 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
1742                  * Otherwise we can't have processed more than WSIZE input bytes since
1743                  * the last block flush, because compression would have been
1744                  * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
1745                  * transform a block into a stored block.
1746                  */
1747                 send_bits((STORED_BLOCK << 1) + eof, 3);        /* send block type */
1748                 G2.compressed_len = (G2.compressed_len + 3 + 7) & ~7L;
1749                 G2.compressed_len += (stored_len + 4) << 3;
1750
1751                 copy_block(buf, (unsigned) stored_len, 1);      /* with header */
1752         } else if (static_lenb == opt_lenb) {
1753                 send_bits((STATIC_TREES << 1) + eof, 3);
1754                 compress_block((ct_data *) G2.static_ltree, (ct_data *) G2.static_dtree);
1755                 G2.compressed_len += 3 + G2.static_len;
1756         } else {
1757                 send_bits((DYN_TREES << 1) + eof, 3);
1758                 send_all_trees(G2.l_desc.max_code + 1, G2.d_desc.max_code + 1,
1759                                         max_blindex + 1);
1760                 compress_block((ct_data *) G2.dyn_ltree, (ct_data *) G2.dyn_dtree);
1761                 G2.compressed_len += 3 + G2.opt_len;
1762         }
1763         Assert(G2.compressed_len == G1.bits_sent, "bad compressed size");
1764         init_block();
1765
1766         if (eof) {
1767                 bi_windup();
1768                 G2.compressed_len += 7; /* align on byte boundary */
1769         }
1770         Tracev((stderr, "\ncomprlen %lu(%lu) ",
1771                         (unsigned long)G2.compressed_len >> 3,
1772                         (unsigned long)G2.compressed_len - 7 * eof));
1773
1774         return G2.compressed_len >> 3;
1775 }
1776
1777
1778 /* ===========================================================================
1779  * Update a hash value with the given input byte
1780  * IN  assertion: all calls to UPDATE_HASH are made with consecutive
1781  *    input characters, so that a running hash key can be computed from the
1782  *    previous key instead of complete recalculation each time.
1783  */
1784 #define UPDATE_HASH(h, c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
1785
1786
1787 /* ===========================================================================
1788  * Same as above, but achieves better compression. We use a lazy
1789  * evaluation for matches: a match is finally adopted only if there is
1790  * no better match at the next window position.
1791  *
1792  * Processes a new input file and return its compressed length. Sets
1793  * the compressed length, crc, deflate flags and internal file
1794  * attributes.
1795  */
1796
1797 /* Flush the current block, with given end-of-file flag.
1798  * IN assertion: strstart is set to the end of the current match. */
1799 #define FLUSH_BLOCK(eof) \
1800         flush_block( \
1801                 G1.block_start >= 0L \
1802                         ? (char*)&G1.window[(unsigned)G1.block_start] \
1803                         : (char*)NULL, \
1804                 (ulg)G1.strstart - G1.block_start, \
1805                 (eof) \
1806         )
1807
1808 /* Insert string s in the dictionary and set match_head to the previous head
1809  * of the hash chain (the most recent string with same hash key). Return
1810  * the previous length of the hash chain.
1811  * IN  assertion: all calls to INSERT_STRING are made with consecutive
1812  *    input characters and the first MIN_MATCH bytes of s are valid
1813  *    (except for the last MIN_MATCH-1 bytes of the input file). */
1814 #define INSERT_STRING(s, match_head) \
1815 do { \
1816         UPDATE_HASH(G1.ins_h, G1.window[(s) + MIN_MATCH-1]); \
1817         G1.prev[(s) & WMASK] = match_head = head[G1.ins_h]; \
1818         head[G1.ins_h] = (s); \
1819 } while (0)
1820
1821 static NOINLINE ulg deflate(void)
1822 {
1823         IPos hash_head;         /* head of hash chain */
1824         IPos prev_match;        /* previous match */
1825         int flush;                      /* set if current block must be flushed */
1826         int match_available = 0;        /* set if previous match exists */
1827         unsigned match_length = MIN_MATCH - 1;  /* length of best match */
1828
1829         /* Process the input block. */
1830         while (G1.lookahead != 0) {
1831                 /* Insert the string window[strstart .. strstart+2] in the
1832                  * dictionary, and set hash_head to the head of the hash chain:
1833                  */
1834                 INSERT_STRING(G1.strstart, hash_head);
1835
1836                 /* Find the longest match, discarding those <= prev_length.
1837                  */
1838                 G1.prev_length = match_length;
1839                 prev_match = G1.match_start;
1840                 match_length = MIN_MATCH - 1;
1841
1842                 if (hash_head != 0 && G1.prev_length < max_lazy_match
1843                  && G1.strstart - hash_head <= MAX_DIST
1844                 ) {
1845                         /* To simplify the code, we prevent matches with the string
1846                          * of window index 0 (in particular we have to avoid a match
1847                          * of the string with itself at the start of the input file).
1848                          */
1849                         match_length = longest_match(hash_head);
1850                         /* longest_match() sets match_start */
1851                         if (match_length > G1.lookahead)
1852                                 match_length = G1.lookahead;
1853
1854                         /* Ignore a length 3 match if it is too distant: */
1855                         if (match_length == MIN_MATCH && G1.strstart - G1.match_start > TOO_FAR) {
1856                                 /* If prev_match is also MIN_MATCH, G1.match_start is garbage
1857                                  * but we will ignore the current match anyway.
1858                                  */
1859                                 match_length--;
1860                         }
1861                 }
1862                 /* If there was a match at the previous step and the current
1863                  * match is not better, output the previous match:
1864                  */
1865                 if (G1.prev_length >= MIN_MATCH && match_length <= G1.prev_length) {
1866                         check_match(G1.strstart - 1, prev_match, G1.prev_length);
1867                         flush = ct_tally(G1.strstart - 1 - prev_match, G1.prev_length - MIN_MATCH);
1868
1869                         /* Insert in hash table all strings up to the end of the match.
1870                          * strstart-1 and strstart are already inserted.
1871                          */
1872                         G1.lookahead -= G1.prev_length - 1;
1873                         G1.prev_length -= 2;
1874                         do {
1875                                 G1.strstart++;
1876                                 INSERT_STRING(G1.strstart, hash_head);
1877                                 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1878                                  * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1879                                  * these bytes are garbage, but it does not matter since the
1880                                  * next lookahead bytes will always be emitted as literals.
1881                                  */
1882                         } while (--G1.prev_length != 0);
1883                         match_available = 0;
1884                         match_length = MIN_MATCH - 1;
1885                         G1.strstart++;
1886                         if (flush) {
1887                                 FLUSH_BLOCK(0);
1888                                 G1.block_start = G1.strstart;
1889                         }
1890                 } else if (match_available) {
1891                         /* If there was no match at the previous position, output a
1892                          * single literal. If there was a match but the current match
1893                          * is longer, truncate the previous match to a single literal.
1894                          */
1895                         Tracevv((stderr, "%c", G1.window[G1.strstart - 1]));
1896                         if (ct_tally(0, G1.window[G1.strstart - 1])) {
1897                                 FLUSH_BLOCK(0);
1898                                 G1.block_start = G1.strstart;
1899                         }
1900                         G1.strstart++;
1901                         G1.lookahead--;
1902                 } else {
1903                         /* There is no previous match to compare with, wait for
1904                          * the next step to decide.
1905                          */
1906                         match_available = 1;
1907                         G1.strstart++;
1908                         G1.lookahead--;
1909                 }
1910                 Assert(G1.strstart <= G1.isize && G1.lookahead <= G1.isize, "a bit too far");
1911
1912                 /* Make sure that we always have enough lookahead, except
1913                  * at the end of the input file. We need MAX_MATCH bytes
1914                  * for the next match, plus MIN_MATCH bytes to insert the
1915                  * string following the next match.
1916                  */
1917                 fill_window_if_needed();
1918         }
1919         if (match_available)
1920                 ct_tally(0, G1.window[G1.strstart - 1]);
1921
1922         return FLUSH_BLOCK(1);  /* eof */
1923 }
1924
1925
1926 /* ===========================================================================
1927  * Initialize the bit string routines.
1928  */
1929 static void bi_init(void)
1930 {
1931         //G1.bi_buf = 0; // globals are zeroed in pack_gzip()
1932         //G1.bi_valid = 0; // globals are zeroed in pack_gzip()
1933 #ifdef DEBUG
1934         //G1.bits_sent = 0L; // globals are zeroed in pack_gzip()
1935 #endif
1936 }
1937
1938
1939 /* ===========================================================================
1940  * Initialize the "longest match" routines for a new file
1941  */
1942 static void lm_init(ush * flagsp)
1943 {
1944         unsigned j;
1945
1946         /* Initialize the hash table. */
1947         memset(head, 0, HASH_SIZE * sizeof(*head));
1948         /* prev will be initialized on the fly */
1949
1950         /* speed options for the general purpose bit flag */
1951         *flagsp |= 2;   /* FAST 4, SLOW 2 */
1952         /* ??? reduce max_chain_length for binary files */
1953
1954         //G1.strstart = 0; // globals are zeroed in pack_gzip()
1955         //G1.block_start = 0L; // globals are zeroed in pack_gzip()
1956
1957         G1.lookahead = file_read(G1.window,
1958                         sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
1959
1960         if (G1.lookahead == 0 || G1.lookahead == (unsigned) -1) {
1961                 G1.eofile = 1;
1962                 G1.lookahead = 0;
1963                 return;
1964         }
1965         //G1.eofile = 0; // globals are zeroed in pack_gzip()
1966
1967         /* Make sure that we always have enough lookahead. This is important
1968          * if input comes from a device such as a tty.
1969          */
1970         fill_window_if_needed();
1971
1972         //G1.ins_h = 0; // globals are zeroed in pack_gzip()
1973         for (j = 0; j < MIN_MATCH - 1; j++)
1974                 UPDATE_HASH(G1.ins_h, G1.window[j]);
1975         /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
1976          * not important since only literal bytes will be emitted.
1977          */
1978 }
1979
1980
1981 /* ===========================================================================
1982  * Allocate the match buffer, initialize the various tables and save the
1983  * location of the internal file attribute (ascii/binary) and method
1984  * (DEFLATE/STORE).
1985  * One callsite in zip()
1986  */
1987 static void ct_init(void)
1988 {
1989         int n;                          /* iterates over tree elements */
1990         int length;                     /* length value */
1991         int code;                       /* code value */
1992         int dist;                       /* distance index */
1993
1994         //G2.compressed_len = 0L; // globals are zeroed in pack_gzip()
1995
1996 #ifdef NOT_NEEDED
1997         if (G2.static_dtree[0].Len != 0)
1998                 return;                 /* ct_init already called */
1999 #endif
2000
2001         /* Initialize the mapping length (0..255) -> length code (0..28) */
2002         length = 0;
2003         for (code = 0; code < LENGTH_CODES - 1; code++) {
2004                 G2.base_length[code] = length;
2005                 for (n = 0; n < (1 << extra_lbits[code]); n++) {
2006                         G2.length_code[length++] = code;
2007                 }
2008         }
2009         Assert(length == 256, "ct_init: length != 256");
2010         /* Note that the length 255 (match length 258) can be represented
2011          * in two different ways: code 284 + 5 bits or code 285, so we
2012          * overwrite length_code[255] to use the best encoding:
2013          */
2014         G2.length_code[length - 1] = code;
2015
2016         /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
2017         dist = 0;
2018         for (code = 0; code < 16; code++) {
2019                 G2.base_dist[code] = dist;
2020                 for (n = 0; n < (1 << extra_dbits[code]); n++) {
2021                         G2.dist_code[dist++] = code;
2022                 }
2023         }
2024         Assert(dist == 256, "ct_init: dist != 256");
2025         dist >>= 7;                     /* from now on, all distances are divided by 128 */
2026         for (; code < D_CODES; code++) {
2027                 G2.base_dist[code] = dist << 7;
2028                 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
2029                         G2.dist_code[256 + dist++] = code;
2030                 }
2031         }
2032         Assert(dist == 256, "ct_init: 256+dist != 512");
2033
2034         /* Construct the codes of the static literal tree */
2035         /* already zeroed - it's in bss
2036         for (n = 0; n <= MAX_BITS; n++)
2037                 G2.bl_count[n] = 0; */
2038
2039         n = 0;
2040         while (n <= 143) {
2041                 G2.static_ltree[n++].Len = 8;
2042                 G2.bl_count[8]++;
2043         }
2044         while (n <= 255) {
2045                 G2.static_ltree[n++].Len = 9;
2046                 G2.bl_count[9]++;
2047         }
2048         while (n <= 279) {
2049                 G2.static_ltree[n++].Len = 7;
2050                 G2.bl_count[7]++;
2051         }
2052         while (n <= 287) {
2053                 G2.static_ltree[n++].Len = 8;
2054                 G2.bl_count[8]++;
2055         }
2056         /* Codes 286 and 287 do not exist, but we must include them in the
2057          * tree construction to get a canonical Huffman tree (longest code
2058          * all ones)
2059          */
2060         gen_codes((ct_data *) G2.static_ltree, L_CODES + 1);
2061
2062         /* The static distance tree is trivial: */
2063         for (n = 0; n < D_CODES; n++) {
2064                 G2.static_dtree[n].Len = 5;
2065                 G2.static_dtree[n].Code = bi_reverse(n, 5);
2066         }
2067
2068         /* Initialize the first block of the first file: */
2069         init_block();
2070 }
2071
2072
2073 /* ===========================================================================
2074  * Deflate in to out.
2075  * IN assertions: the input and output buffers are cleared.
2076  */
2077 static void zip(void)
2078 {
2079         ush deflate_flags = 0;  /* pkzip -es, -en or -ex equivalent */
2080
2081         //G1.outcnt = 0; // globals are zeroed in pack_gzip()
2082
2083         /* Write the header to the gzip file. See algorithm.doc for the format */
2084         /* magic header for gzip files: 1F 8B */
2085         /* compression method: 8 (DEFLATED) */
2086         /* general flags: 0 */
2087         put_32bit(0x00088b1f);
2088         put_32bit(0);           /* Unix timestamp */
2089
2090         /* Write deflated file to zip file */
2091         G1.crc = ~0;
2092
2093         bi_init();
2094         ct_init();
2095         lm_init(&deflate_flags);
2096
2097         put_8bit(deflate_flags);        /* extra flags */
2098         put_8bit(3);    /* OS identifier = 3 (Unix) */
2099
2100         deflate();
2101
2102         /* Write the crc and uncompressed size */
2103         put_32bit(~G1.crc);
2104         put_32bit(G1.isize);
2105
2106         flush_outbuf();
2107 }
2108
2109
2110 /* ======================================================================== */
2111 static
2112 IF_DESKTOP(long long) int FAST_FUNC pack_gzip(transformer_state_t *xstate UNUSED_PARAM)
2113 {
2114         /* Reinit G1.xxx except pointers to allocated buffers */
2115         memset(&G1, 0, offsetof(struct globals, l_buf));
2116
2117         /* Clear input and output buffers */
2118         //G1.outcnt = 0;
2119 #ifdef DEBUG
2120         //G1.insize = 0;
2121 #endif
2122         //G1.isize = 0;
2123
2124         /* Reinit G2.xxx */
2125         memset(&G2, 0, sizeof(G2));
2126         G2.l_desc.dyn_tree     = G2.dyn_ltree;
2127         G2.l_desc.static_tree  = G2.static_ltree;
2128         G2.l_desc.extra_bits   = extra_lbits;
2129         G2.l_desc.extra_base   = LITERALS + 1;
2130         G2.l_desc.elems        = L_CODES;
2131         G2.l_desc.max_length   = MAX_BITS;
2132         //G2.l_desc.max_code     = 0;
2133         G2.d_desc.dyn_tree     = G2.dyn_dtree;
2134         G2.d_desc.static_tree  = G2.static_dtree;
2135         G2.d_desc.extra_bits   = extra_dbits;
2136         //G2.d_desc.extra_base   = 0;
2137         G2.d_desc.elems        = D_CODES;
2138         G2.d_desc.max_length   = MAX_BITS;
2139         //G2.d_desc.max_code     = 0;
2140         G2.bl_desc.dyn_tree    = G2.bl_tree;
2141         //G2.bl_desc.static_tree = NULL;
2142         G2.bl_desc.extra_bits  = extra_blbits,
2143         //G2.bl_desc.extra_base  = 0;
2144         G2.bl_desc.elems       = BL_CODES;
2145         G2.bl_desc.max_length  = MAX_BL_BITS;
2146         //G2.bl_desc.max_code    = 0;
2147
2148 #if 0
2149         /* Saving of timestamp is disabled. Why?
2150          * - it is not Y2038-safe.
2151          * - some people want deterministic results
2152          *   (normally they'd use -n, but our -n is a nop).
2153          * - it's bloat.
2154          * Per RFC 1952, gzfile.time=0 is "no timestamp".
2155          * If users will demand this to be reinstated,
2156          * implement -n "don't save timestamp".
2157          */
2158         struct stat s;
2159         s.st_ctime = 0;
2160         fstat(STDIN_FILENO, &s);
2161         zip(s.st_ctime);
2162 #else
2163         zip();
2164 #endif
2165         return 0;
2166 }
2167
2168 #if ENABLE_FEATURE_GZIP_LONG_OPTIONS
2169 static const char gzip_longopts[] ALIGN1 =
2170         "stdout\0"              No_argument       "c"
2171         "to-stdout\0"           No_argument       "c"
2172         "force\0"               No_argument       "f"
2173         "verbose\0"             No_argument       "v"
2174 #if ENABLE_FEATURE_GZIP_DECOMPRESS
2175         "decompress\0"          No_argument       "d"
2176         "uncompress\0"          No_argument       "d"
2177         "test\0"                No_argument       "t"
2178 #endif
2179         "quiet\0"               No_argument       "q"
2180         "fast\0"                No_argument       "1"
2181         "best\0"                No_argument       "9"
2182         "no-name\0"             No_argument       "n"
2183         ;
2184 #endif
2185
2186 /*
2187  * Linux kernel build uses gzip -d -n. We accept and ignore -n.
2188  * Man page says:
2189  * -n --no-name
2190  * gzip: do not save the original file name and time stamp.
2191  * (The original name is always saved if the name had to be truncated.)
2192  * gunzip: do not restore the original file name/time even if present
2193  * (remove only the gzip suffix from the compressed file name).
2194  * This option is the default when decompressing.
2195  * -N --name
2196  * gzip: always save the original file name and time stamp (this is the default)
2197  * gunzip: restore the original file name and time stamp if present.
2198  */
2199
2200 int gzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
2201 #if ENABLE_FEATURE_GZIP_DECOMPRESS
2202 int gzip_main(int argc, char **argv)
2203 #else
2204 int gzip_main(int argc UNUSED_PARAM, char **argv)
2205 #endif
2206 {
2207         unsigned opt;
2208 #if ENABLE_FEATURE_GZIP_LEVELS
2209         static const struct {
2210                 uint8_t good;
2211                 uint8_t chain_shift;
2212                 uint8_t lazy2;
2213                 uint8_t nice2;
2214         } gzip_level_config[6] = {
2215                 {4,   4,   4/2,  16/2}, /* Level 4 */
2216                 {8,   5,  16/2,  32/2}, /* Level 5 */
2217                 {8,   7,  16/2, 128/2}, /* Level 6 */
2218                 {8,   8,  32/2, 128/2}, /* Level 7 */
2219                 {32, 10, 128/2, 258/2}, /* Level 8 */
2220                 {32, 12, 258/2, 258/2}, /* Level 9 */
2221         };
2222 #endif
2223
2224         SET_PTR_TO_GLOBALS((char *)xzalloc(sizeof(struct globals)+sizeof(struct globals2))
2225                         + sizeof(struct globals));
2226
2227         /* Must match bbunzip's constants OPT_STDOUT, OPT_FORCE! */
2228 #if ENABLE_FEATURE_GZIP_LONG_OPTIONS
2229         opt = getopt32long(argv, "cfkv" IF_FEATURE_GZIP_DECOMPRESS("dt") "qn123456789", gzip_longopts);
2230 #else
2231         opt = getopt32(argv, "cfkv" IF_FEATURE_GZIP_DECOMPRESS("dt") "qn123456789");
2232 #endif
2233 #if ENABLE_FEATURE_GZIP_DECOMPRESS /* gunzip_main may not be visible... */
2234         if (opt & 0x30) // -d and/or -t
2235                 return gunzip_main(argc, argv);
2236 #endif
2237 #if ENABLE_FEATURE_GZIP_LEVELS
2238         opt >>= ENABLE_FEATURE_GZIP_DECOMPRESS ? 8 : 6; /* drop cfkv[dt]qn bits */
2239         if (opt == 0)
2240                 opt = 1 << 6; /* default: 6 */
2241         opt = ffs(opt >> 4); /* Maps -1..-4 to [0], -5 to [1] ... -9 to [5] */
2242         max_chain_length = 1 << gzip_level_config[opt].chain_shift;
2243         good_match       = gzip_level_config[opt].good;
2244         max_lazy_match   = gzip_level_config[opt].lazy2 * 2;
2245         nice_match       = gzip_level_config[opt].nice2 * 2;
2246 #endif
2247         option_mask32 &= 0xf; /* retain only -cfkv */
2248
2249         /* Allocate all global buffers (for DYN_ALLOC option) */
2250         ALLOC(uch, G1.l_buf, INBUFSIZ);
2251         ALLOC(uch, G1.outbuf, OUTBUFSIZ);
2252         ALLOC(ush, G1.d_buf, DIST_BUFSIZE);
2253         ALLOC(uch, G1.window, 2L * WSIZE);
2254         ALLOC(ush, G1.prev, 1L << BITS);
2255
2256         /* Initialize the CRC32 table */
2257         global_crc32_table = crc32_filltable(NULL, 0);
2258
2259         argv += optind;
2260         return bbunpack(argv, pack_gzip, append_ext, "gz");
2261 }