gzip: code shrink
[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 short bi_buf;
359
360 #undef BUF_SIZE
361 #define BUF_SIZE (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         int 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(int value, int length)
524 {
525 #ifdef DEBUG
526         Tracev((stderr, " l %2d v %4x ", length, value));
527         Assert(length > 0 && length <= 15, "invalid length");
528         G1.bits_sent += length;
529 #endif
530         /* If not enough room in bi_buf, use (valid) bits from bi_buf and
531          * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
532          * unused bits in value.
533          */
534         if (G1.bi_valid > (int) BUF_SIZE - length) {
535                 G1.bi_buf |= (value << G1.bi_valid);
536                 put_16bit(G1.bi_buf);
537                 G1.bi_buf = (ush) value >> (BUF_SIZE - G1.bi_valid);
538                 G1.bi_valid += length - BUF_SIZE;
539         } else {
540                 G1.bi_buf |= value << G1.bi_valid;
541                 G1.bi_valid += length;
542         }
543 }
544
545
546 /* ===========================================================================
547  * Reverse the first len bits of a code, using straightforward code (a faster
548  * method would use a table)
549  * IN assertion: 1 <= len <= 15
550  */
551 static unsigned bi_reverse(unsigned code, int len)
552 {
553         unsigned res = 0;
554
555         while (1) {
556                 res |= code & 1;
557                 if (--len <= 0) return res;
558                 code >>= 1;
559                 res <<= 1;
560         }
561 }
562
563
564 /* ===========================================================================
565  * Write out any remaining bits in an incomplete byte.
566  */
567 static void bi_windup(void)
568 {
569         if (G1.bi_valid > 8) {
570                 put_16bit(G1.bi_buf);
571         } else if (G1.bi_valid > 0) {
572                 put_8bit(G1.bi_buf);
573         }
574         G1.bi_buf = 0;
575         G1.bi_valid = 0;
576 #ifdef DEBUG
577         G1.bits_sent = (G1.bits_sent + 7) & ~7;
578 #endif
579 }
580
581
582 /* ===========================================================================
583  * Copy a stored block to the zip file, storing first the length and its
584  * one's complement if requested.
585  */
586 static void copy_block(char *buf, unsigned len, int header)
587 {
588         bi_windup();            /* align on byte boundary */
589
590         if (header) {
591                 put_16bit(len);
592                 put_16bit(~len);
593 #ifdef DEBUG
594                 G1.bits_sent += 2 * 16;
595 #endif
596         }
597 #ifdef DEBUG
598         G1.bits_sent += (ulg) len << 3;
599 #endif
600         while (len--) {
601                 put_8bit(*buf++);
602         }
603 }
604
605
606 /* ===========================================================================
607  * Fill the window when the lookahead becomes insufficient.
608  * Updates strstart and lookahead, and sets eofile if end of input file.
609  * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
610  * OUT assertions: at least one byte has been read, or eofile is set;
611  *    file reads are performed for at least two bytes (required for the
612  *    translate_eol option).
613  */
614 static void fill_window(void)
615 {
616         unsigned n, m;
617         unsigned more = WINDOW_SIZE - G1.lookahead - G1.strstart;
618         /* Amount of free space at the end of the window. */
619
620         /* If the window is almost full and there is insufficient lookahead,
621          * move the upper half to the lower one to make room in the upper half.
622          */
623         if (more == (unsigned) -1) {
624                 /* Very unlikely, but possible on 16 bit machine if strstart == 0
625                  * and lookahead == 1 (input done one byte at time)
626                  */
627                 more--;
628         } else if (G1.strstart >= WSIZE + MAX_DIST) {
629                 /* By the IN assertion, the window is not empty so we can't confuse
630                  * more == 0 with more == 64K on a 16 bit machine.
631                  */
632                 Assert(WINDOW_SIZE == 2 * WSIZE, "no sliding with BIG_MEM");
633
634                 memcpy(G1.window, G1.window + WSIZE, WSIZE);
635                 G1.match_start -= WSIZE;
636                 G1.strstart -= WSIZE;   /* we now have strstart >= MAX_DIST: */
637
638                 G1.block_start -= WSIZE;
639
640                 for (n = 0; n < HASH_SIZE; n++) {
641                         m = head[n];
642                         head[n] = (Pos) (m >= WSIZE ? m - WSIZE : 0);
643                 }
644                 for (n = 0; n < WSIZE; n++) {
645                         m = G1.prev[n];
646                         G1.prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : 0);
647                         /* If n is not on any hash chain, prev[n] is garbage but
648                          * its value will never be used.
649                          */
650                 }
651                 more += WSIZE;
652         }
653         /* At this point, more >= 2 */
654         if (!G1.eofile) {
655                 n = file_read(G1.window + G1.strstart + G1.lookahead, more);
656                 if (n == 0 || n == (unsigned) -1) {
657                         G1.eofile = 1;
658                 } else {
659                         G1.lookahead += n;
660                 }
661         }
662 }
663 /* Both users fill window with the same loop: */
664 static void fill_window_if_needed(void)
665 {
666         while (G1.lookahead < MIN_LOOKAHEAD && !G1.eofile)
667                 fill_window();
668 }
669
670
671 /* ===========================================================================
672  * Set match_start to the longest match starting at the given string and
673  * return its length. Matches shorter or equal to prev_length are discarded,
674  * in which case the result is equal to prev_length and match_start is
675  * garbage.
676  * IN assertions: cur_match is the head of the hash chain for the current
677  *   string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
678  */
679
680 /* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
681  * match.s. The code is functionally equivalent, so you can use the C version
682  * if desired.
683  */
684 static int longest_match(IPos cur_match)
685 {
686         unsigned chain_length = max_chain_length;       /* max hash chain length */
687         uch *scan = G1.window + G1.strstart;    /* current string */
688         uch *match;     /* matched string */
689         int len;        /* length of current match */
690         int best_len = G1.prev_length;  /* best match length so far */
691         IPos limit = G1.strstart > (IPos) MAX_DIST ? G1.strstart - (IPos) MAX_DIST : 0;
692         /* Stop when cur_match becomes <= limit. To simplify the code,
693          * we prevent matches with the string of window index 0.
694          */
695
696 /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
697  * It is easy to get rid of this optimization if necessary.
698  */
699 #if HASH_BITS < 8 || MAX_MATCH != 258
700 #  error Code too clever
701 #endif
702         uch *strend = G1.window + G1.strstart + MAX_MATCH;
703         uch scan_end1 = scan[best_len - 1];
704         uch scan_end = scan[best_len];
705
706         /* Do not waste too much time if we already have a good match: */
707         if (G1.prev_length >= good_match) {
708                 chain_length >>= 2;
709         }
710         Assert(G1.strstart <= WINDOW_SIZE - MIN_LOOKAHEAD, "insufficient lookahead");
711
712         do {
713                 Assert(cur_match < G1.strstart, "no future");
714                 match = G1.window + cur_match;
715
716                 /* Skip to next match if the match length cannot increase
717                  * or if the match length is less than 2:
718                  */
719                 if (match[best_len] != scan_end
720                  || match[best_len - 1] != scan_end1
721                  || *match != *scan || *++match != scan[1]
722                 ) {
723                         continue;
724                 }
725
726                 /* The check at best_len-1 can be removed because it will be made
727                  * again later. (This heuristic is not always a win.)
728                  * It is not necessary to compare scan[2] and match[2] since they
729                  * are always equal when the other bytes match, given that
730                  * the hash keys are equal and that HASH_BITS >= 8.
731                  */
732                 scan += 2, match++;
733
734                 /* We check for insufficient lookahead only every 8th comparison;
735                  * the 256th check will be made at strstart+258.
736                  */
737                 do {
738                 } while (*++scan == *++match && *++scan == *++match &&
739                                  *++scan == *++match && *++scan == *++match &&
740                                  *++scan == *++match && *++scan == *++match &&
741                                  *++scan == *++match && *++scan == *++match && scan < strend);
742
743                 len = MAX_MATCH - (int) (strend - scan);
744                 scan = strend - MAX_MATCH;
745
746                 if (len > best_len) {
747                         G1.match_start = cur_match;
748                         best_len = len;
749                         if (len >= nice_match)
750                                 break;
751                         scan_end1 = scan[best_len - 1];
752                         scan_end = scan[best_len];
753                 }
754         } while ((cur_match = G1.prev[cur_match & WMASK]) > limit
755                          && --chain_length != 0);
756
757         return best_len;
758 }
759
760
761 #ifdef DEBUG
762 /* ===========================================================================
763  * Check that the match at match_start is indeed a match.
764  */
765 static void check_match(IPos start, IPos match, int length)
766 {
767         /* check that the match is indeed a match */
768         if (memcmp(G1.window + match, G1.window + start, length) != 0) {
769                 bb_error_msg(" start %d, match %d, length %d", start, match, length);
770                 bb_error_msg("invalid match");
771         }
772         if (verbose > 1) {
773                 bb_error_msg("\\[%d,%d]", start - match, length);
774                 do {
775                         bb_putchar_stderr(G1.window[start++]);
776                 } while (--length != 0);
777         }
778 }
779 #else
780 #  define check_match(start, match, length) ((void)0)
781 #endif
782
783
784 /* trees.c -- output deflated data using Huffman coding
785  * Copyright (C) 1992-1993 Jean-loup Gailly
786  * This is free software; you can redistribute it and/or modify it under the
787  * terms of the GNU General Public License, see the file COPYING.
788  */
789
790 /*  PURPOSE
791  *      Encode various sets of source values using variable-length
792  *      binary code trees.
793  *
794  *  DISCUSSION
795  *      The PKZIP "deflation" process uses several Huffman trees. The more
796  *      common source values are represented by shorter bit sequences.
797  *
798  *      Each code tree is stored in the ZIP file in a compressed form
799  *      which is itself a Huffman encoding of the lengths of
800  *      all the code strings (in ascending order by source values).
801  *      The actual code strings are reconstructed from the lengths in
802  *      the UNZIP process, as described in the "application note"
803  *      (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
804  *
805  *  REFERENCES
806  *      Lynch, Thomas J.
807  *          Data Compression:  Techniques and Applications, pp. 53-55.
808  *          Lifetime Learning Publications, 1985.  ISBN 0-534-03418-7.
809  *
810  *      Storer, James A.
811  *          Data Compression:  Methods and Theory, pp. 49-50.
812  *          Computer Science Press, 1988.  ISBN 0-7167-8156-5.
813  *
814  *      Sedgewick, R.
815  *          Algorithms, p290.
816  *          Addison-Wesley, 1983. ISBN 0-201-06672-6.
817  *
818  *  INTERFACE
819  *      void ct_init()
820  *          Allocate the match buffer, initialize the various tables [and save
821  *          the location of the internal file attribute (ascii/binary) and
822  *          method (DEFLATE/STORE) -- deleted in bbox]
823  *
824  *      void ct_tally(int dist, int lc);
825  *          Save the match info and tally the frequency counts.
826  *
827  *      ulg flush_block(char *buf, ulg stored_len, int eof)
828  *          Determine the best encoding for the current block: dynamic trees,
829  *          static trees or store, and output the encoded block to the zip
830  *          file. Returns the total compressed length for the file so far.
831  */
832
833 #define MAX_BITS 15
834 /* All codes must not exceed MAX_BITS bits */
835
836 #define MAX_BL_BITS 7
837 /* Bit length codes must not exceed MAX_BL_BITS bits */
838
839 #define LENGTH_CODES 29
840 /* number of length codes, not counting the special END_BLOCK code */
841
842 #define LITERALS  256
843 /* number of literal bytes 0..255 */
844
845 #define END_BLOCK 256
846 /* end of block literal code */
847
848 #define L_CODES (LITERALS+1+LENGTH_CODES)
849 /* number of Literal or Length codes, including the END_BLOCK code */
850
851 #define D_CODES   30
852 /* number of distance codes */
853
854 #define BL_CODES  19
855 /* number of codes used to transfer the bit lengths */
856
857 /* extra bits for each length code */
858 static const uint8_t extra_lbits[LENGTH_CODES] ALIGN1 = {
859         0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
860         4, 4, 5, 5, 5, 5, 0
861 };
862
863 /* extra bits for each distance code */
864 static const uint8_t extra_dbits[D_CODES] ALIGN1 = {
865         0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
866         10, 10, 11, 11, 12, 12, 13, 13
867 };
868
869 /* extra bits for each bit length code */
870 static const uint8_t extra_blbits[BL_CODES] ALIGN1 = {
871         0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 7 };
872
873 /* number of codes at each bit length for an optimal tree */
874 static const uint8_t bl_order[BL_CODES] ALIGN1 = {
875         16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
876
877 #define STORED_BLOCK 0
878 #define STATIC_TREES 1
879 #define DYN_TREES    2
880 /* The three kinds of block type */
881
882 #ifndef LIT_BUFSIZE
883 #  ifdef SMALL_MEM
884 #    define LIT_BUFSIZE  0x2000
885 #  else
886 #  ifdef MEDIUM_MEM
887 #    define LIT_BUFSIZE  0x4000
888 #  else
889 #    define LIT_BUFSIZE  0x8000
890 #  endif
891 #  endif
892 #endif
893 #ifndef DIST_BUFSIZE
894 #  define DIST_BUFSIZE  LIT_BUFSIZE
895 #endif
896 /* Sizes of match buffers for literals/lengths and distances.  There are
897  * 4 reasons for limiting LIT_BUFSIZE to 64K:
898  *   - frequencies can be kept in 16 bit counters
899  *   - if compression is not successful for the first block, all input data is
900  *     still in the window so we can still emit a stored block even when input
901  *     comes from standard input.  (This can also be done for all blocks if
902  *     LIT_BUFSIZE is not greater than 32K.)
903  *   - if compression is not successful for a file smaller than 64K, we can
904  *     even emit a stored file instead of a stored block (saving 5 bytes).
905  *   - creating new Huffman trees less frequently may not provide fast
906  *     adaptation to changes in the input data statistics. (Take for
907  *     example a binary file with poorly compressible code followed by
908  *     a highly compressible string table.) Smaller buffer sizes give
909  *     fast adaptation but have of course the overhead of transmitting trees
910  *     more frequently.
911  *   - I can't count above 4
912  * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
913  * memory at the expense of compression). Some optimizations would be possible
914  * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
915  */
916 #define REP_3_6      16
917 /* repeat previous bit length 3-6 times (2 bits of repeat count) */
918 #define REPZ_3_10    17
919 /* repeat a zero length 3-10 times  (3 bits of repeat count) */
920 #define REPZ_11_138  18
921 /* repeat a zero length 11-138 times  (7 bits of repeat count) */
922
923 /* ===========================================================================
924 */
925 /* Data structure describing a single value and its code string. */
926 typedef struct ct_data {
927         union {
928                 ush freq;               /* frequency count */
929                 ush code;               /* bit string */
930         } fc;
931         union {
932                 ush dad;                /* father node in Huffman tree */
933                 ush len;                /* length of bit string */
934         } dl;
935 } ct_data;
936
937 #define Freq fc.freq
938 #define Code fc.code
939 #define Dad  dl.dad
940 #define Len  dl.len
941
942 #define HEAP_SIZE (2*L_CODES + 1)
943 /* maximum heap size */
944
945 typedef struct tree_desc {
946         ct_data *dyn_tree;      /* the dynamic tree */
947         ct_data *static_tree;   /* corresponding static tree or NULL */
948         const uint8_t *extra_bits;      /* extra bits for each code or NULL */
949         int extra_base;         /* base index for extra_bits */
950         int elems;                      /* max number of elements in the tree */
951         int max_length;         /* max bit length for the codes */
952         int max_code;           /* largest code with non zero frequency */
953 } tree_desc;
954
955 struct globals2 {
956
957         ush heap[HEAP_SIZE];     /* heap used to build the Huffman trees */
958         int heap_len;            /* number of elements in the heap */
959         int heap_max;            /* element of largest frequency */
960
961 /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
962  * The same heap array is used to build all trees.
963  */
964
965         ct_data dyn_ltree[HEAP_SIZE];   /* literal and length tree */
966         ct_data dyn_dtree[2 * D_CODES + 1];     /* distance tree */
967
968         ct_data static_ltree[L_CODES + 2];
969
970 /* The static literal tree. Since the bit lengths are imposed, there is no
971  * need for the L_CODES extra codes used during heap construction. However
972  * The codes 286 and 287 are needed to build a canonical tree (see ct_init
973  * below).
974  */
975
976         ct_data static_dtree[D_CODES];
977
978 /* The static distance tree. (Actually a trivial tree since all codes use
979  * 5 bits.)
980  */
981
982         ct_data bl_tree[2 * BL_CODES + 1];
983
984 /* Huffman tree for the bit lengths */
985
986         tree_desc l_desc;
987         tree_desc d_desc;
988         tree_desc bl_desc;
989
990         ush bl_count[MAX_BITS + 1];
991
992 /* The lengths of the bit length codes are sent in order of decreasing
993  * probability, to avoid transmitting the lengths for unused bit length codes.
994  */
995
996         uch depth[2 * L_CODES + 1];
997
998 /* Depth of each subtree used as tie breaker for trees of equal frequency */
999
1000         uch length_code[MAX_MATCH - MIN_MATCH + 1];
1001
1002 /* length code for each normalized match length (0 == MIN_MATCH) */
1003
1004         uch dist_code[512];
1005
1006 /* distance codes. The first 256 values correspond to the distances
1007  * 3 .. 258, the last 256 values correspond to the top 8 bits of
1008  * the 15 bit distances.
1009  */
1010
1011         int base_length[LENGTH_CODES];
1012
1013 /* First normalized length for each code (0 = MIN_MATCH) */
1014
1015         int base_dist[D_CODES];
1016
1017 /* First normalized distance for each code (0 = distance of 1) */
1018
1019         uch flag_buf[LIT_BUFSIZE / 8];
1020
1021 /* flag_buf is a bit array distinguishing literals from lengths in
1022  * l_buf, thus indicating the presence or absence of a distance.
1023  */
1024
1025         unsigned last_lit;       /* running index in l_buf */
1026         unsigned last_dist;      /* running index in d_buf */
1027         unsigned last_flags;     /* running index in flag_buf */
1028         uch flags;               /* current flags not yet saved in flag_buf */
1029         uch flag_bit;            /* current bit used in flags */
1030
1031 /* bits are filled in flags starting at bit 0 (least significant).
1032  * Note: these flags are overkill in the current code since we don't
1033  * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1034  */
1035
1036         ulg opt_len;             /* bit length of current block with optimal trees */
1037         ulg static_len;          /* bit length of current block with static trees */
1038
1039         ulg compressed_len;      /* total bit length of compressed file */
1040 };
1041
1042 #define G2ptr ((struct globals2*)(ptr_to_globals))
1043 #define G2 (*G2ptr)
1044
1045
1046 /* ===========================================================================
1047  */
1048 static void gen_codes(ct_data * tree, int max_code);
1049 static void build_tree(tree_desc * desc);
1050 static void scan_tree(ct_data * tree, int max_code);
1051 static void send_tree(ct_data * tree, int max_code);
1052 static int build_bl_tree(void);
1053 static void send_all_trees(int lcodes, int dcodes, int blcodes);
1054 static void compress_block(ct_data * ltree, ct_data * dtree);
1055
1056
1057 #ifndef DEBUG
1058 /* Send a code of the given tree. c and tree must not have side effects */
1059 #  define SEND_CODE(c, tree) send_bits(tree[c].Code, tree[c].Len)
1060 #else
1061 #  define SEND_CODE(c, tree) \
1062 { \
1063         if (verbose > 1) bb_error_msg("\ncd %3d ", (c)); \
1064         send_bits(tree[c].Code, tree[c].Len); \
1065 }
1066 #endif
1067
1068 #define D_CODE(dist) \
1069         ((dist) < 256 ? G2.dist_code[dist] : G2.dist_code[256 + ((dist)>>7)])
1070 /* Mapping from a distance to a distance code. dist is the distance - 1 and
1071  * must not have side effects. dist_code[256] and dist_code[257] are never
1072  * used.
1073  * The arguments must not have side effects.
1074  */
1075
1076
1077 /* ===========================================================================
1078  * Initialize a new block.
1079  */
1080 static void init_block(void)
1081 {
1082         int n; /* iterates over tree elements */
1083
1084         /* Initialize the trees. */
1085         for (n = 0; n < L_CODES; n++)
1086                 G2.dyn_ltree[n].Freq = 0;
1087         for (n = 0; n < D_CODES; n++)
1088                 G2.dyn_dtree[n].Freq = 0;
1089         for (n = 0; n < BL_CODES; n++)
1090                 G2.bl_tree[n].Freq = 0;
1091
1092         G2.dyn_ltree[END_BLOCK].Freq = 1;
1093         G2.opt_len = G2.static_len = 0;
1094         G2.last_lit = G2.last_dist = G2.last_flags = 0;
1095         G2.flags = 0;
1096         G2.flag_bit = 1;
1097 }
1098
1099
1100 /* ===========================================================================
1101  * Restore the heap property by moving down the tree starting at node k,
1102  * exchanging a node with the smallest of its two sons if necessary, stopping
1103  * when the heap property is re-established (each father smaller than its
1104  * two sons).
1105  */
1106
1107 /* Compares to subtrees, using the tree depth as tie breaker when
1108  * the subtrees have equal frequency. This minimizes the worst case length. */
1109 #define SMALLER(tree, n, m) \
1110         (tree[n].Freq < tree[m].Freq \
1111         || (tree[n].Freq == tree[m].Freq && G2.depth[n] <= G2.depth[m]))
1112
1113 static void pqdownheap(ct_data * tree, int k)
1114 {
1115         int v = G2.heap[k];
1116         int j = k << 1;         /* left son of k */
1117
1118         while (j <= G2.heap_len) {
1119                 /* Set j to the smallest of the two sons: */
1120                 if (j < G2.heap_len && SMALLER(tree, G2.heap[j + 1], G2.heap[j]))
1121                         j++;
1122
1123                 /* Exit if v is smaller than both sons */
1124                 if (SMALLER(tree, v, G2.heap[j]))
1125                         break;
1126
1127                 /* Exchange v with the smallest son */
1128                 G2.heap[k] = G2.heap[j];
1129                 k = j;
1130
1131                 /* And continue down the tree, setting j to the left son of k */
1132                 j <<= 1;
1133         }
1134         G2.heap[k] = v;
1135 }
1136
1137
1138 /* ===========================================================================
1139  * Compute the optimal bit lengths for a tree and update the total bit length
1140  * for the current block.
1141  * IN assertion: the fields freq and dad are set, heap[heap_max] and
1142  *    above are the tree nodes sorted by increasing frequency.
1143  * OUT assertions: the field len is set to the optimal bit length, the
1144  *     array bl_count contains the frequencies for each bit length.
1145  *     The length opt_len is updated; static_len is also updated if stree is
1146  *     not null.
1147  */
1148 static void gen_bitlen(tree_desc * desc)
1149 {
1150         ct_data *tree = desc->dyn_tree;
1151         const uint8_t *extra = desc->extra_bits;
1152         int base = desc->extra_base;
1153         int max_code = desc->max_code;
1154         int max_length = desc->max_length;
1155         ct_data *stree = desc->static_tree;
1156         int h;                          /* heap index */
1157         int n, m;                       /* iterate over the tree elements */
1158         int bits;                       /* bit length */
1159         int xbits;                      /* extra bits */
1160         ush f;                          /* frequency */
1161         int overflow = 0;       /* number of elements with bit length too large */
1162
1163         for (bits = 0; bits <= MAX_BITS; bits++)
1164                 G2.bl_count[bits] = 0;
1165
1166         /* In a first pass, compute the optimal bit lengths (which may
1167          * overflow in the case of the bit length tree).
1168          */
1169         tree[G2.heap[G2.heap_max]].Len = 0;     /* root of the heap */
1170
1171         for (h = G2.heap_max + 1; h < HEAP_SIZE; h++) {
1172                 n = G2.heap[h];
1173                 bits = tree[tree[n].Dad].Len + 1;
1174                 if (bits > max_length) {
1175                         bits = max_length;
1176                         overflow++;
1177                 }
1178                 tree[n].Len = (ush) bits;
1179                 /* We overwrite tree[n].Dad which is no longer needed */
1180
1181                 if (n > max_code)
1182                         continue;       /* not a leaf node */
1183
1184                 G2.bl_count[bits]++;
1185                 xbits = 0;
1186                 if (n >= base)
1187                         xbits = extra[n - base];
1188                 f = tree[n].Freq;
1189                 G2.opt_len += (ulg) f *(bits + xbits);
1190
1191                 if (stree)
1192                         G2.static_len += (ulg) f * (stree[n].Len + xbits);
1193         }
1194         if (overflow == 0)
1195                 return;
1196
1197         Trace((stderr, "\nbit length overflow\n"));
1198         /* This happens for example on obj2 and pic of the Calgary corpus */
1199
1200         /* Find the first bit length which could increase: */
1201         do {
1202                 bits = max_length - 1;
1203                 while (G2.bl_count[bits] == 0)
1204                         bits--;
1205                 G2.bl_count[bits]--;    /* move one leaf down the tree */
1206                 G2.bl_count[bits + 1] += 2;     /* move one overflow item as its brother */
1207                 G2.bl_count[max_length]--;
1208                 /* The brother of the overflow item also moves one step up,
1209                  * but this does not affect bl_count[max_length]
1210                  */
1211                 overflow -= 2;
1212         } while (overflow > 0);
1213
1214         /* Now recompute all bit lengths, scanning in increasing frequency.
1215          * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1216          * lengths instead of fixing only the wrong ones. This idea is taken
1217          * from 'ar' written by Haruhiko Okumura.)
1218          */
1219         for (bits = max_length; bits != 0; bits--) {
1220                 n = G2.bl_count[bits];
1221                 while (n != 0) {
1222                         m = G2.heap[--h];
1223                         if (m > max_code)
1224                                 continue;
1225                         if (tree[m].Len != (unsigned) bits) {
1226                                 Trace((stderr, "code %d bits %d->%d\n", m, tree[m].Len, bits));
1227                                 G2.opt_len += ((int32_t) bits - tree[m].Len) * tree[m].Freq;
1228                                 tree[m].Len = bits;
1229                         }
1230                         n--;
1231                 }
1232         }
1233 }
1234
1235
1236 /* ===========================================================================
1237  * Generate the codes for a given tree and bit counts (which need not be
1238  * optimal).
1239  * IN assertion: the array bl_count contains the bit length statistics for
1240  * the given tree and the field len is set for all tree elements.
1241  * OUT assertion: the field code is set for all tree elements of non
1242  *     zero code length.
1243  */
1244 static void gen_codes(ct_data * tree, int max_code)
1245 {
1246         ush next_code[MAX_BITS + 1];    /* next code value for each bit length */
1247         ush code = 0;           /* running code value */
1248         int bits;                       /* bit index */
1249         int n;                          /* code index */
1250
1251         /* The distribution counts are first used to generate the code values
1252          * without bit reversal.
1253          */
1254         for (bits = 1; bits <= MAX_BITS; bits++) {
1255                 next_code[bits] = code = (code + G2.bl_count[bits - 1]) << 1;
1256         }
1257         /* Check that the bit counts in bl_count are consistent. The last code
1258          * must be all ones.
1259          */
1260         Assert(code + G2.bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1261                         "inconsistent bit counts");
1262         Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
1263
1264         for (n = 0; n <= max_code; n++) {
1265                 int len = tree[n].Len;
1266
1267                 if (len == 0)
1268                         continue;
1269                 /* Now reverse the bits */
1270                 tree[n].Code = bi_reverse(next_code[len]++, len);
1271
1272                 Tracec(tree != G2.static_ltree,
1273                            (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1274                                 (n > ' ' ? n : ' '), len, tree[n].Code,
1275                                 next_code[len] - 1));
1276         }
1277 }
1278
1279
1280 /* ===========================================================================
1281  * Construct one Huffman tree and assigns the code bit strings and lengths.
1282  * Update the total bit length for the current block.
1283  * IN assertion: the field freq is set for all tree elements.
1284  * OUT assertions: the fields len and code are set to the optimal bit length
1285  *     and corresponding code. The length opt_len is updated; static_len is
1286  *     also updated if stree is not null. The field max_code is set.
1287  */
1288
1289 /* Remove the smallest element from the heap and recreate the heap with
1290  * one less element. Updates heap and heap_len. */
1291
1292 #define SMALLEST 1
1293 /* Index within the heap array of least frequent node in the Huffman tree */
1294
1295 #define PQREMOVE(tree, top) \
1296 do { \
1297         top = G2.heap[SMALLEST]; \
1298         G2.heap[SMALLEST] = G2.heap[G2.heap_len--]; \
1299         pqdownheap(tree, SMALLEST); \
1300 } while (0)
1301
1302 static void build_tree(tree_desc * desc)
1303 {
1304         ct_data *tree = desc->dyn_tree;
1305         ct_data *stree = desc->static_tree;
1306         int elems = desc->elems;
1307         int n, m;                       /* iterate over heap elements */
1308         int max_code = -1;      /* largest code with non zero frequency */
1309         int node = elems;       /* next internal node of the tree */
1310
1311         /* Construct the initial heap, with least frequent element in
1312          * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1313          * heap[0] is not used.
1314          */
1315         G2.heap_len = 0;
1316         G2.heap_max = HEAP_SIZE;
1317
1318         for (n = 0; n < elems; n++) {
1319                 if (tree[n].Freq != 0) {
1320                         G2.heap[++G2.heap_len] = max_code = n;
1321                         G2.depth[n] = 0;
1322                 } else {
1323                         tree[n].Len = 0;
1324                 }
1325         }
1326
1327         /* The pkzip format requires that at least one distance code exists,
1328          * and that at least one bit should be sent even if there is only one
1329          * possible code. So to avoid special checks later on we force at least
1330          * two codes of non zero frequency.
1331          */
1332         while (G2.heap_len < 2) {
1333                 int new = G2.heap[++G2.heap_len] = (max_code < 2 ? ++max_code : 0);
1334
1335                 tree[new].Freq = 1;
1336                 G2.depth[new] = 0;
1337                 G2.opt_len--;
1338                 if (stree)
1339                         G2.static_len -= stree[new].Len;
1340                 /* new is 0 or 1 so it does not have extra bits */
1341         }
1342         desc->max_code = max_code;
1343
1344         /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
1345          * establish sub-heaps of increasing lengths:
1346          */
1347         for (n = G2.heap_len / 2; n >= 1; n--)
1348                 pqdownheap(tree, n);
1349
1350         /* Construct the Huffman tree by repeatedly combining the least two
1351          * frequent nodes.
1352          */
1353         do {
1354                 PQREMOVE(tree, n);      /* n = node of least frequency */
1355                 m = G2.heap[SMALLEST];  /* m = node of next least frequency */
1356
1357                 G2.heap[--G2.heap_max] = n;     /* keep the nodes sorted by frequency */
1358                 G2.heap[--G2.heap_max] = m;
1359
1360                 /* Create a new node father of n and m */
1361                 tree[node].Freq = tree[n].Freq + tree[m].Freq;
1362                 G2.depth[node] = MAX(G2.depth[n], G2.depth[m]) + 1;
1363                 tree[n].Dad = tree[m].Dad = (ush) node;
1364 #ifdef DUMP_BL_TREE
1365                 if (tree == G2.bl_tree) {
1366                         bb_error_msg("\nnode %d(%d), sons %d(%d) %d(%d)",
1367                                         node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
1368                 }
1369 #endif
1370                 /* and insert the new node in the heap */
1371                 G2.heap[SMALLEST] = node++;
1372                 pqdownheap(tree, SMALLEST);
1373         } while (G2.heap_len >= 2);
1374
1375         G2.heap[--G2.heap_max] = G2.heap[SMALLEST];
1376
1377         /* At this point, the fields freq and dad are set. We can now
1378          * generate the bit lengths.
1379          */
1380         gen_bitlen((tree_desc *) desc);
1381
1382         /* The field len is now set, we can generate the bit codes */
1383         gen_codes((ct_data *) tree, max_code);
1384 }
1385
1386
1387 /* ===========================================================================
1388  * Scan a literal or distance tree to determine the frequencies of the codes
1389  * in the bit length tree. Updates opt_len to take into account the repeat
1390  * counts. (The contribution of the bit length codes will be added later
1391  * during the construction of bl_tree.)
1392  */
1393 static void scan_tree(ct_data * tree, int max_code)
1394 {
1395         int n;                          /* iterates over all tree elements */
1396         int prevlen = -1;       /* last emitted length */
1397         int curlen;                     /* length of current code */
1398         int nextlen = tree[0].Len;      /* length of next code */
1399         int count = 0;          /* repeat count of the current code */
1400         int max_count = 7;      /* max repeat count */
1401         int min_count = 4;      /* min repeat count */
1402
1403         if (nextlen == 0) {
1404                 max_count = 138;
1405                 min_count = 3;
1406         }
1407         tree[max_code + 1].Len = 0xffff; /* guard */
1408
1409         for (n = 0; n <= max_code; n++) {
1410                 curlen = nextlen;
1411                 nextlen = tree[n + 1].Len;
1412                 if (++count < max_count && curlen == nextlen)
1413                         continue;
1414
1415                 if (count < min_count) {
1416                         G2.bl_tree[curlen].Freq += count;
1417                 } else if (curlen != 0) {
1418                         if (curlen != prevlen)
1419                                 G2.bl_tree[curlen].Freq++;
1420                         G2.bl_tree[REP_3_6].Freq++;
1421                 } else if (count <= 10) {
1422                         G2.bl_tree[REPZ_3_10].Freq++;
1423                 } else {
1424                         G2.bl_tree[REPZ_11_138].Freq++;
1425                 }
1426                 count = 0;
1427                 prevlen = curlen;
1428
1429                 max_count = 7;
1430                 min_count = 4;
1431                 if (nextlen == 0) {
1432                         max_count = 138;
1433                         min_count = 3;
1434                 } else if (curlen == nextlen) {
1435                         max_count = 6;
1436                         min_count = 3;
1437                 }
1438         }
1439 }
1440
1441
1442 /* ===========================================================================
1443  * Send a literal or distance tree in compressed form, using the codes in
1444  * bl_tree.
1445  */
1446 static void send_tree(ct_data * tree, int max_code)
1447 {
1448         int n;                          /* iterates over all tree elements */
1449         int prevlen = -1;       /* last emitted length */
1450         int curlen;                     /* length of current code */
1451         int nextlen = tree[0].Len;      /* length of next code */
1452         int count = 0;          /* repeat count of the current code */
1453         int max_count = 7;      /* max repeat count */
1454         int min_count = 4;      /* min repeat count */
1455
1456 /* tree[max_code+1].Len = -1; *//* guard already set */
1457         if (nextlen == 0)
1458                 max_count = 138, min_count = 3;
1459
1460         for (n = 0; n <= max_code; n++) {
1461                 curlen = nextlen;
1462                 nextlen = tree[n + 1].Len;
1463                 if (++count < max_count && curlen == nextlen) {
1464                         continue;
1465                 } else if (count < min_count) {
1466                         do {
1467                                 SEND_CODE(curlen, G2.bl_tree);
1468                         } while (--count);
1469                 } else if (curlen != 0) {
1470                         if (curlen != prevlen) {
1471                                 SEND_CODE(curlen, G2.bl_tree);
1472                                 count--;
1473                         }
1474                         Assert(count >= 3 && count <= 6, " 3_6?");
1475                         SEND_CODE(REP_3_6, G2.bl_tree);
1476                         send_bits(count - 3, 2);
1477                 } else if (count <= 10) {
1478                         SEND_CODE(REPZ_3_10, G2.bl_tree);
1479                         send_bits(count - 3, 3);
1480                 } else {
1481                         SEND_CODE(REPZ_11_138, G2.bl_tree);
1482                         send_bits(count - 11, 7);
1483                 }
1484                 count = 0;
1485                 prevlen = curlen;
1486                 if (nextlen == 0) {
1487                         max_count = 138;
1488                         min_count = 3;
1489                 } else if (curlen == nextlen) {
1490                         max_count = 6;
1491                         min_count = 3;
1492                 } else {
1493                         max_count = 7;
1494                         min_count = 4;
1495                 }
1496         }
1497 }
1498
1499
1500 /* ===========================================================================
1501  * Construct the Huffman tree for the bit lengths and return the index in
1502  * bl_order of the last bit length code to send.
1503  */
1504 static int build_bl_tree(void)
1505 {
1506         int max_blindex;        /* index of last bit length code of non zero freq */
1507
1508         /* Determine the bit length frequencies for literal and distance trees */
1509         scan_tree(G2.dyn_ltree, G2.l_desc.max_code);
1510         scan_tree(G2.dyn_dtree, G2.d_desc.max_code);
1511
1512         /* Build the bit length tree: */
1513         build_tree(&G2.bl_desc);
1514         /* opt_len now includes the length of the tree representations, except
1515          * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
1516          */
1517
1518         /* Determine the number of bit length codes to send. The pkzip format
1519          * requires that at least 4 bit length codes be sent. (appnote.txt says
1520          * 3 but the actual value used is 4.)
1521          */
1522         for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
1523                 if (G2.bl_tree[bl_order[max_blindex]].Len != 0)
1524                         break;
1525         }
1526         /* Update opt_len to include the bit length tree and counts */
1527         G2.opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
1528         Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", (long)G2.opt_len, (long)G2.static_len));
1529
1530         return max_blindex;
1531 }
1532
1533
1534 /* ===========================================================================
1535  * Send the header for a block using dynamic Huffman trees: the counts, the
1536  * lengths of the bit length codes, the literal tree and the distance tree.
1537  * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
1538  */
1539 static void send_all_trees(int lcodes, int dcodes, int blcodes)
1540 {
1541         int rank;                       /* index in bl_order */
1542
1543         Assert(lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
1544         Assert(lcodes <= L_CODES && dcodes <= D_CODES
1545                    && blcodes <= BL_CODES, "too many codes");
1546         Tracev((stderr, "\nbl counts: "));
1547         send_bits(lcodes - 257, 5);     /* not +255 as stated in appnote.txt */
1548         send_bits(dcodes - 1, 5);
1549         send_bits(blcodes - 4, 4);      /* not -3 as stated in appnote.txt */
1550         for (rank = 0; rank < blcodes; rank++) {
1551                 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
1552                 send_bits(G2.bl_tree[bl_order[rank]].Len, 3);
1553         }
1554         Tracev((stderr, "\nbl tree: sent %ld", (long)G1.bits_sent));
1555
1556         send_tree((ct_data *) G2.dyn_ltree, lcodes - 1);        /* send the literal tree */
1557         Tracev((stderr, "\nlit tree: sent %ld", (long)G1.bits_sent));
1558
1559         send_tree((ct_data *) G2.dyn_dtree, dcodes - 1);        /* send the distance tree */
1560         Tracev((stderr, "\ndist tree: sent %ld", (long)G1.bits_sent));
1561 }
1562
1563
1564 /* ===========================================================================
1565  * Save the match info and tally the frequency counts. Return true if
1566  * the current block must be flushed.
1567  */
1568 static int ct_tally(int dist, int lc)
1569 {
1570         G1.l_buf[G2.last_lit++] = lc;
1571         if (dist == 0) {
1572                 /* lc is the unmatched char */
1573                 G2.dyn_ltree[lc].Freq++;
1574         } else {
1575                 /* Here, lc is the match length - MIN_MATCH */
1576                 dist--;                 /* dist = match distance - 1 */
1577                 Assert((ush) dist < (ush) MAX_DIST
1578                  && (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH)
1579                  && (ush) D_CODE(dist) < (ush) D_CODES, "ct_tally: bad match"
1580                 );
1581
1582                 G2.dyn_ltree[G2.length_code[lc] + LITERALS + 1].Freq++;
1583                 G2.dyn_dtree[D_CODE(dist)].Freq++;
1584
1585                 G1.d_buf[G2.last_dist++] = dist;
1586                 G2.flags |= G2.flag_bit;
1587         }
1588         G2.flag_bit <<= 1;
1589
1590         /* Output the flags if they fill a byte: */
1591         if ((G2.last_lit & 7) == 0) {
1592                 G2.flag_buf[G2.last_flags++] = G2.flags;
1593                 G2.flags = 0;
1594                 G2.flag_bit = 1;
1595         }
1596         /* Try to guess if it is profitable to stop the current block here */
1597         if ((G2.last_lit & 0xfff) == 0) {
1598                 /* Compute an upper bound for the compressed length */
1599                 ulg out_length = G2.last_lit * 8L;
1600                 ulg in_length = (ulg) G1.strstart - G1.block_start;
1601                 int dcode;
1602
1603                 for (dcode = 0; dcode < D_CODES; dcode++) {
1604                         out_length += G2.dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
1605                 }
1606                 out_length >>= 3;
1607                 Trace((stderr,
1608                                 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
1609                                 G2.last_lit, G2.last_dist,
1610                                 (long)in_length, (long)out_length,
1611                                 100L - out_length * 100L / in_length));
1612                 if (G2.last_dist < G2.last_lit / 2 && out_length < in_length / 2)
1613                         return 1;
1614         }
1615         return (G2.last_lit == LIT_BUFSIZE - 1 || G2.last_dist == DIST_BUFSIZE);
1616         /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
1617          * on 16 bit machines and because stored blocks are restricted to
1618          * 64K-1 bytes.
1619          */
1620 }
1621
1622 /* ===========================================================================
1623  * Send the block data compressed using the given Huffman trees
1624  */
1625 static void compress_block(ct_data * ltree, ct_data * dtree)
1626 {
1627         unsigned dist;          /* distance of matched string */
1628         int lc;                 /* match length or unmatched char (if dist == 0) */
1629         unsigned lx = 0;        /* running index in l_buf */
1630         unsigned dx = 0;        /* running index in d_buf */
1631         unsigned fx = 0;        /* running index in flag_buf */
1632         uch flag = 0;           /* current flags */
1633         unsigned code;          /* the code to send */
1634         int extra;              /* number of extra bits to send */
1635
1636         if (G2.last_lit != 0) do {
1637                 if ((lx & 7) == 0)
1638                         flag = G2.flag_buf[fx++];
1639                 lc = G1.l_buf[lx++];
1640                 if ((flag & 1) == 0) {
1641                         SEND_CODE(lc, ltree);   /* send a literal byte */
1642                         Tracecv(lc > ' ', (stderr, " '%c' ", lc));
1643                 } else {
1644                         /* Here, lc is the match length - MIN_MATCH */
1645                         code = G2.length_code[lc];
1646                         SEND_CODE(code + LITERALS + 1, ltree);  /* send the length code */
1647                         extra = extra_lbits[code];
1648                         if (extra != 0) {
1649                                 lc -= G2.base_length[code];
1650                                 send_bits(lc, extra);   /* send the extra length bits */
1651                         }
1652                         dist = G1.d_buf[dx++];
1653                         /* Here, dist is the match distance - 1 */
1654                         code = D_CODE(dist);
1655                         Assert(code < D_CODES, "bad d_code");
1656
1657                         SEND_CODE(code, dtree); /* send the distance code */
1658                         extra = extra_dbits[code];
1659                         if (extra != 0) {
1660                                 dist -= G2.base_dist[code];
1661                                 send_bits(dist, extra); /* send the extra distance bits */
1662                         }
1663                 }                       /* literal or match pair ? */
1664                 flag >>= 1;
1665         } while (lx < G2.last_lit);
1666
1667         SEND_CODE(END_BLOCK, ltree);
1668 }
1669
1670
1671 /* ===========================================================================
1672  * Determine the best encoding for the current block: dynamic trees, static
1673  * trees or store, and output the encoded block to the zip file. This function
1674  * returns the total compressed length for the file so far.
1675  */
1676 static ulg flush_block(char *buf, ulg stored_len, int eof)
1677 {
1678         ulg opt_lenb, static_lenb;      /* opt_len and static_len in bytes */
1679         int max_blindex;                /* index of last bit length code of non zero freq */
1680
1681         G2.flag_buf[G2.last_flags] = G2.flags;   /* Save the flags for the last 8 items */
1682
1683         /* Construct the literal and distance trees */
1684         build_tree(&G2.l_desc);
1685         Tracev((stderr, "\nlit data: dyn %ld, stat %ld", (long)G2.opt_len, (long)G2.static_len));
1686
1687         build_tree(&G2.d_desc);
1688         Tracev((stderr, "\ndist data: dyn %ld, stat %ld", (long)G2.opt_len, (long)G2.static_len));
1689         /* At this point, opt_len and static_len are the total bit lengths of
1690          * the compressed block data, excluding the tree representations.
1691          */
1692
1693         /* Build the bit length tree for the above two trees, and get the index
1694          * in bl_order of the last bit length code to send.
1695          */
1696         max_blindex = build_bl_tree();
1697
1698         /* Determine the best encoding. Compute first the block length in bytes */
1699         opt_lenb = (G2.opt_len + 3 + 7) >> 3;
1700         static_lenb = (G2.static_len + 3 + 7) >> 3;
1701
1702         Trace((stderr,
1703                         "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
1704                         (unsigned long)opt_lenb, (unsigned long)G2.opt_len,
1705                         (unsigned long)static_lenb, (unsigned long)G2.static_len,
1706                         (unsigned long)stored_len,
1707                         G2.last_lit, G2.last_dist));
1708
1709         if (static_lenb <= opt_lenb)
1710                 opt_lenb = static_lenb;
1711
1712         /* If compression failed and this is the first and last block,
1713          * and if the zip file can be seeked (to rewrite the local header),
1714          * the whole file is transformed into a stored file:
1715          */
1716         if (stored_len <= opt_lenb && eof && G2.compressed_len == 0L && seekable()) {
1717                 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
1718                 if (buf == NULL)
1719                         bb_error_msg("block vanished");
1720
1721                 copy_block(buf, (unsigned) stored_len, 0);      /* without header */
1722                 G2.compressed_len = stored_len << 3;
1723         } else if (stored_len + 4 <= opt_lenb && buf != NULL) {
1724                 /* 4: two words for the lengths */
1725                 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
1726                  * Otherwise we can't have processed more than WSIZE input bytes since
1727                  * the last block flush, because compression would have been
1728                  * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
1729                  * transform a block into a stored block.
1730                  */
1731                 send_bits((STORED_BLOCK << 1) + eof, 3);        /* send block type */
1732                 G2.compressed_len = (G2.compressed_len + 3 + 7) & ~7L;
1733                 G2.compressed_len += (stored_len + 4) << 3;
1734
1735                 copy_block(buf, (unsigned) stored_len, 1);      /* with header */
1736         } else if (static_lenb == opt_lenb) {
1737                 send_bits((STATIC_TREES << 1) + eof, 3);
1738                 compress_block((ct_data *) G2.static_ltree, (ct_data *) G2.static_dtree);
1739                 G2.compressed_len += 3 + G2.static_len;
1740         } else {
1741                 send_bits((DYN_TREES << 1) + eof, 3);
1742                 send_all_trees(G2.l_desc.max_code + 1, G2.d_desc.max_code + 1,
1743                                         max_blindex + 1);
1744                 compress_block((ct_data *) G2.dyn_ltree, (ct_data *) G2.dyn_dtree);
1745                 G2.compressed_len += 3 + G2.opt_len;
1746         }
1747         Assert(G2.compressed_len == G1.bits_sent, "bad compressed size");
1748         init_block();
1749
1750         if (eof) {
1751                 bi_windup();
1752                 G2.compressed_len += 7; /* align on byte boundary */
1753         }
1754         Tracev((stderr, "\ncomprlen %lu(%lu) ",
1755                         (unsigned long)G2.compressed_len >> 3,
1756                         (unsigned long)G2.compressed_len - 7 * eof));
1757
1758         return G2.compressed_len >> 3;
1759 }
1760
1761
1762 /* ===========================================================================
1763  * Update a hash value with the given input byte
1764  * IN  assertion: all calls to UPDATE_HASH are made with consecutive
1765  *    input characters, so that a running hash key can be computed from the
1766  *    previous key instead of complete recalculation each time.
1767  */
1768 #define UPDATE_HASH(h, c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
1769
1770
1771 /* ===========================================================================
1772  * Same as above, but achieves better compression. We use a lazy
1773  * evaluation for matches: a match is finally adopted only if there is
1774  * no better match at the next window position.
1775  *
1776  * Processes a new input file and return its compressed length. Sets
1777  * the compressed length, crc, deflate flags and internal file
1778  * attributes.
1779  */
1780
1781 /* Flush the current block, with given end-of-file flag.
1782  * IN assertion: strstart is set to the end of the current match. */
1783 #define FLUSH_BLOCK(eof) \
1784         flush_block( \
1785                 G1.block_start >= 0L \
1786                         ? (char*)&G1.window[(unsigned)G1.block_start] \
1787                         : (char*)NULL, \
1788                 (ulg)G1.strstart - G1.block_start, \
1789                 (eof) \
1790         )
1791
1792 /* Insert string s in the dictionary and set match_head to the previous head
1793  * of the hash chain (the most recent string with same hash key). Return
1794  * the previous length of the hash chain.
1795  * IN  assertion: all calls to INSERT_STRING are made with consecutive
1796  *    input characters and the first MIN_MATCH bytes of s are valid
1797  *    (except for the last MIN_MATCH-1 bytes of the input file). */
1798 #define INSERT_STRING(s, match_head) \
1799 do { \
1800         UPDATE_HASH(G1.ins_h, G1.window[(s) + MIN_MATCH-1]); \
1801         G1.prev[(s) & WMASK] = match_head = head[G1.ins_h]; \
1802         head[G1.ins_h] = (s); \
1803 } while (0)
1804
1805 static NOINLINE ulg deflate(void)
1806 {
1807         IPos hash_head;         /* head of hash chain */
1808         IPos prev_match;        /* previous match */
1809         int flush;                      /* set if current block must be flushed */
1810         int match_available = 0;        /* set if previous match exists */
1811         unsigned match_length = MIN_MATCH - 1;  /* length of best match */
1812
1813         /* Process the input block. */
1814         while (G1.lookahead != 0) {
1815                 /* Insert the string window[strstart .. strstart+2] in the
1816                  * dictionary, and set hash_head to the head of the hash chain:
1817                  */
1818                 INSERT_STRING(G1.strstart, hash_head);
1819
1820                 /* Find the longest match, discarding those <= prev_length.
1821                  */
1822                 G1.prev_length = match_length;
1823                 prev_match = G1.match_start;
1824                 match_length = MIN_MATCH - 1;
1825
1826                 if (hash_head != 0 && G1.prev_length < max_lazy_match
1827                  && G1.strstart - hash_head <= MAX_DIST
1828                 ) {
1829                         /* To simplify the code, we prevent matches with the string
1830                          * of window index 0 (in particular we have to avoid a match
1831                          * of the string with itself at the start of the input file).
1832                          */
1833                         match_length = longest_match(hash_head);
1834                         /* longest_match() sets match_start */
1835                         if (match_length > G1.lookahead)
1836                                 match_length = G1.lookahead;
1837
1838                         /* Ignore a length 3 match if it is too distant: */
1839                         if (match_length == MIN_MATCH && G1.strstart - G1.match_start > TOO_FAR) {
1840                                 /* If prev_match is also MIN_MATCH, G1.match_start is garbage
1841                                  * but we will ignore the current match anyway.
1842                                  */
1843                                 match_length--;
1844                         }
1845                 }
1846                 /* If there was a match at the previous step and the current
1847                  * match is not better, output the previous match:
1848                  */
1849                 if (G1.prev_length >= MIN_MATCH && match_length <= G1.prev_length) {
1850                         check_match(G1.strstart - 1, prev_match, G1.prev_length);
1851                         flush = ct_tally(G1.strstart - 1 - prev_match, G1.prev_length - MIN_MATCH);
1852
1853                         /* Insert in hash table all strings up to the end of the match.
1854                          * strstart-1 and strstart are already inserted.
1855                          */
1856                         G1.lookahead -= G1.prev_length - 1;
1857                         G1.prev_length -= 2;
1858                         do {
1859                                 G1.strstart++;
1860                                 INSERT_STRING(G1.strstart, hash_head);
1861                                 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1862                                  * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1863                                  * these bytes are garbage, but it does not matter since the
1864                                  * next lookahead bytes will always be emitted as literals.
1865                                  */
1866                         } while (--G1.prev_length != 0);
1867                         match_available = 0;
1868                         match_length = MIN_MATCH - 1;
1869                         G1.strstart++;
1870                         if (flush) {
1871                                 FLUSH_BLOCK(0);
1872                                 G1.block_start = G1.strstart;
1873                         }
1874                 } else if (match_available) {
1875                         /* If there was no match at the previous position, output a
1876                          * single literal. If there was a match but the current match
1877                          * is longer, truncate the previous match to a single literal.
1878                          */
1879                         Tracevv((stderr, "%c", G1.window[G1.strstart - 1]));
1880                         if (ct_tally(0, G1.window[G1.strstart - 1])) {
1881                                 FLUSH_BLOCK(0);
1882                                 G1.block_start = G1.strstart;
1883                         }
1884                         G1.strstart++;
1885                         G1.lookahead--;
1886                 } else {
1887                         /* There is no previous match to compare with, wait for
1888                          * the next step to decide.
1889                          */
1890                         match_available = 1;
1891                         G1.strstart++;
1892                         G1.lookahead--;
1893                 }
1894                 Assert(G1.strstart <= G1.isize && G1.lookahead <= G1.isize, "a bit too far");
1895
1896                 /* Make sure that we always have enough lookahead, except
1897                  * at the end of the input file. We need MAX_MATCH bytes
1898                  * for the next match, plus MIN_MATCH bytes to insert the
1899                  * string following the next match.
1900                  */
1901                 fill_window_if_needed();
1902         }
1903         if (match_available)
1904                 ct_tally(0, G1.window[G1.strstart - 1]);
1905
1906         return FLUSH_BLOCK(1);  /* eof */
1907 }
1908
1909
1910 /* ===========================================================================
1911  * Initialize the bit string routines.
1912  */
1913 static void bi_init(void)
1914 {
1915         //G1.bi_buf = 0; // globals are zeroed in pack_gzip()
1916         //G1.bi_valid = 0; // globals are zeroed in pack_gzip()
1917 #ifdef DEBUG
1918         //G1.bits_sent = 0L; // globals are zeroed in pack_gzip()
1919 #endif
1920 }
1921
1922
1923 /* ===========================================================================
1924  * Initialize the "longest match" routines for a new file
1925  */
1926 static void lm_init(ush * flagsp)
1927 {
1928         unsigned j;
1929
1930         /* Initialize the hash table. */
1931         memset(head, 0, HASH_SIZE * sizeof(*head));
1932         /* prev will be initialized on the fly */
1933
1934         /* speed options for the general purpose bit flag */
1935         *flagsp |= 2;   /* FAST 4, SLOW 2 */
1936         /* ??? reduce max_chain_length for binary files */
1937
1938         //G1.strstart = 0; // globals are zeroed in pack_gzip()
1939         //G1.block_start = 0L; // globals are zeroed in pack_gzip()
1940
1941         G1.lookahead = file_read(G1.window,
1942                         sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
1943
1944         if (G1.lookahead == 0 || G1.lookahead == (unsigned) -1) {
1945                 G1.eofile = 1;
1946                 G1.lookahead = 0;
1947                 return;
1948         }
1949         //G1.eofile = 0; // globals are zeroed in pack_gzip()
1950
1951         /* Make sure that we always have enough lookahead. This is important
1952          * if input comes from a device such as a tty.
1953          */
1954         fill_window_if_needed();
1955
1956         //G1.ins_h = 0; // globals are zeroed in pack_gzip()
1957         for (j = 0; j < MIN_MATCH - 1; j++)
1958                 UPDATE_HASH(G1.ins_h, G1.window[j]);
1959         /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
1960          * not important since only literal bytes will be emitted.
1961          */
1962 }
1963
1964
1965 /* ===========================================================================
1966  * Allocate the match buffer, initialize the various tables and save the
1967  * location of the internal file attribute (ascii/binary) and method
1968  * (DEFLATE/STORE).
1969  * One callsite in zip()
1970  */
1971 static void ct_init(void)
1972 {
1973         int n;                          /* iterates over tree elements */
1974         int length;                     /* length value */
1975         int code;                       /* code value */
1976         int dist;                       /* distance index */
1977
1978         //G2.compressed_len = 0L; // globals are zeroed in pack_gzip()
1979
1980 #ifdef NOT_NEEDED
1981         if (G2.static_dtree[0].Len != 0)
1982                 return;                 /* ct_init already called */
1983 #endif
1984
1985         /* Initialize the mapping length (0..255) -> length code (0..28) */
1986         length = 0;
1987         for (code = 0; code < LENGTH_CODES - 1; code++) {
1988                 G2.base_length[code] = length;
1989                 for (n = 0; n < (1 << extra_lbits[code]); n++) {
1990                         G2.length_code[length++] = code;
1991                 }
1992         }
1993         Assert(length == 256, "ct_init: length != 256");
1994         /* Note that the length 255 (match length 258) can be represented
1995          * in two different ways: code 284 + 5 bits or code 285, so we
1996          * overwrite length_code[255] to use the best encoding:
1997          */
1998         G2.length_code[length - 1] = code;
1999
2000         /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
2001         dist = 0;
2002         for (code = 0; code < 16; code++) {
2003                 G2.base_dist[code] = dist;
2004                 for (n = 0; n < (1 << extra_dbits[code]); n++) {
2005                         G2.dist_code[dist++] = code;
2006                 }
2007         }
2008         Assert(dist == 256, "ct_init: dist != 256");
2009         dist >>= 7;                     /* from now on, all distances are divided by 128 */
2010         for (; code < D_CODES; code++) {
2011                 G2.base_dist[code] = dist << 7;
2012                 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
2013                         G2.dist_code[256 + dist++] = code;
2014                 }
2015         }
2016         Assert(dist == 256, "ct_init: 256+dist != 512");
2017
2018         /* Construct the codes of the static literal tree */
2019         /* already zeroed - it's in bss
2020         for (n = 0; n <= MAX_BITS; n++)
2021                 G2.bl_count[n] = 0; */
2022
2023         n = 0;
2024         while (n <= 143) {
2025                 G2.static_ltree[n++].Len = 8;
2026                 G2.bl_count[8]++;
2027         }
2028         while (n <= 255) {
2029                 G2.static_ltree[n++].Len = 9;
2030                 G2.bl_count[9]++;
2031         }
2032         while (n <= 279) {
2033                 G2.static_ltree[n++].Len = 7;
2034                 G2.bl_count[7]++;
2035         }
2036         while (n <= 287) {
2037                 G2.static_ltree[n++].Len = 8;
2038                 G2.bl_count[8]++;
2039         }
2040         /* Codes 286 and 287 do not exist, but we must include them in the
2041          * tree construction to get a canonical Huffman tree (longest code
2042          * all ones)
2043          */
2044         gen_codes((ct_data *) G2.static_ltree, L_CODES + 1);
2045
2046         /* The static distance tree is trivial: */
2047         for (n = 0; n < D_CODES; n++) {
2048                 G2.static_dtree[n].Len = 5;
2049                 G2.static_dtree[n].Code = bi_reverse(n, 5);
2050         }
2051
2052         /* Initialize the first block of the first file: */
2053         init_block();
2054 }
2055
2056
2057 /* ===========================================================================
2058  * Deflate in to out.
2059  * IN assertions: the input and output buffers are cleared.
2060  */
2061 static void zip(void)
2062 {
2063         ush deflate_flags = 0;  /* pkzip -es, -en or -ex equivalent */
2064
2065         //G1.outcnt = 0; // globals are zeroed in pack_gzip()
2066
2067         /* Write the header to the gzip file. See algorithm.doc for the format */
2068         /* magic header for gzip files: 1F 8B */
2069         /* compression method: 8 (DEFLATED) */
2070         /* general flags: 0 */
2071         put_32bit(0x00088b1f);
2072         put_32bit(0);           /* Unix timestamp */
2073
2074         /* Write deflated file to zip file */
2075         G1.crc = ~0;
2076
2077         bi_init();
2078         ct_init();
2079         lm_init(&deflate_flags);
2080
2081         put_8bit(deflate_flags);        /* extra flags */
2082         put_8bit(3);    /* OS identifier = 3 (Unix) */
2083
2084         deflate();
2085
2086         /* Write the crc and uncompressed size */
2087         put_32bit(~G1.crc);
2088         put_32bit(G1.isize);
2089
2090         flush_outbuf();
2091 }
2092
2093
2094 /* ======================================================================== */
2095 static
2096 IF_DESKTOP(long long) int FAST_FUNC pack_gzip(transformer_state_t *xstate UNUSED_PARAM)
2097 {
2098         /* Reinit G1.xxx except pointers to allocated buffers */
2099         memset(&G1, 0, offsetof(struct globals, l_buf));
2100
2101         /* Clear input and output buffers */
2102         //G1.outcnt = 0;
2103 #ifdef DEBUG
2104         //G1.insize = 0;
2105 #endif
2106         //G1.isize = 0;
2107
2108         /* Reinit G2.xxx */
2109         memset(&G2, 0, sizeof(G2));
2110         G2.l_desc.dyn_tree     = G2.dyn_ltree;
2111         G2.l_desc.static_tree  = G2.static_ltree;
2112         G2.l_desc.extra_bits   = extra_lbits;
2113         G2.l_desc.extra_base   = LITERALS + 1;
2114         G2.l_desc.elems        = L_CODES;
2115         G2.l_desc.max_length   = MAX_BITS;
2116         //G2.l_desc.max_code     = 0;
2117         G2.d_desc.dyn_tree     = G2.dyn_dtree;
2118         G2.d_desc.static_tree  = G2.static_dtree;
2119         G2.d_desc.extra_bits   = extra_dbits;
2120         //G2.d_desc.extra_base   = 0;
2121         G2.d_desc.elems        = D_CODES;
2122         G2.d_desc.max_length   = MAX_BITS;
2123         //G2.d_desc.max_code     = 0;
2124         G2.bl_desc.dyn_tree    = G2.bl_tree;
2125         //G2.bl_desc.static_tree = NULL;
2126         G2.bl_desc.extra_bits  = extra_blbits,
2127         //G2.bl_desc.extra_base  = 0;
2128         G2.bl_desc.elems       = BL_CODES;
2129         G2.bl_desc.max_length  = MAX_BL_BITS;
2130         //G2.bl_desc.max_code    = 0;
2131
2132 #if 0
2133         /* Saving of timestamp is disabled. Why?
2134          * - it is not Y2038-safe.
2135          * - some people want deterministic results
2136          *   (normally they'd use -n, but our -n is a nop).
2137          * - it's bloat.
2138          * Per RFC 1952, gzfile.time=0 is "no timestamp".
2139          * If users will demand this to be reinstated,
2140          * implement -n "don't save timestamp".
2141          */
2142         struct stat s;
2143         s.st_ctime = 0;
2144         fstat(STDIN_FILENO, &s);
2145         zip(s.st_ctime);
2146 #else
2147         zip();
2148 #endif
2149         return 0;
2150 }
2151
2152 #if ENABLE_FEATURE_GZIP_LONG_OPTIONS
2153 static const char gzip_longopts[] ALIGN1 =
2154         "stdout\0"              No_argument       "c"
2155         "to-stdout\0"           No_argument       "c"
2156         "force\0"               No_argument       "f"
2157         "verbose\0"             No_argument       "v"
2158 #if ENABLE_FEATURE_GZIP_DECOMPRESS
2159         "decompress\0"          No_argument       "d"
2160         "uncompress\0"          No_argument       "d"
2161         "test\0"                No_argument       "t"
2162 #endif
2163         "quiet\0"               No_argument       "q"
2164         "fast\0"                No_argument       "1"
2165         "best\0"                No_argument       "9"
2166         "no-name\0"             No_argument       "n"
2167         ;
2168 #endif
2169
2170 /*
2171  * Linux kernel build uses gzip -d -n. We accept and ignore -n.
2172  * Man page says:
2173  * -n --no-name
2174  * gzip: do not save the original file name and time stamp.
2175  * (The original name is always saved if the name had to be truncated.)
2176  * gunzip: do not restore the original file name/time even if present
2177  * (remove only the gzip suffix from the compressed file name).
2178  * This option is the default when decompressing.
2179  * -N --name
2180  * gzip: always save the original file name and time stamp (this is the default)
2181  * gunzip: restore the original file name and time stamp if present.
2182  */
2183
2184 int gzip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
2185 #if ENABLE_FEATURE_GZIP_DECOMPRESS
2186 int gzip_main(int argc, char **argv)
2187 #else
2188 int gzip_main(int argc UNUSED_PARAM, char **argv)
2189 #endif
2190 {
2191         unsigned opt;
2192 #if ENABLE_FEATURE_GZIP_LEVELS
2193         static const struct {
2194                 uint8_t good;
2195                 uint8_t chain_shift;
2196                 uint8_t lazy2;
2197                 uint8_t nice2;
2198         } gzip_level_config[6] = {
2199                 {4,   4,   4/2,  16/2}, /* Level 4 */
2200                 {8,   5,  16/2,  32/2}, /* Level 5 */
2201                 {8,   7,  16/2, 128/2}, /* Level 6 */
2202                 {8,   8,  32/2, 128/2}, /* Level 7 */
2203                 {32, 10, 128/2, 258/2}, /* Level 8 */
2204                 {32, 12, 258/2, 258/2}, /* Level 9 */
2205         };
2206 #endif
2207
2208         SET_PTR_TO_GLOBALS((char *)xzalloc(sizeof(struct globals)+sizeof(struct globals2))
2209                         + sizeof(struct globals));
2210
2211         /* Must match bbunzip's constants OPT_STDOUT, OPT_FORCE! */
2212 #if ENABLE_FEATURE_GZIP_LONG_OPTIONS
2213         opt = getopt32long(argv, "cfkv" IF_FEATURE_GZIP_DECOMPRESS("dt") "qn123456789", gzip_longopts);
2214 #else
2215         opt = getopt32(argv, "cfkv" IF_FEATURE_GZIP_DECOMPRESS("dt") "qn123456789");
2216 #endif
2217 #if ENABLE_FEATURE_GZIP_DECOMPRESS /* gunzip_main may not be visible... */
2218         if (opt & 0x30) // -d and/or -t
2219                 return gunzip_main(argc, argv);
2220 #endif
2221 #if ENABLE_FEATURE_GZIP_LEVELS
2222         opt >>= ENABLE_FEATURE_GZIP_DECOMPRESS ? 8 : 6; /* drop cfkv[dt]qn bits */
2223         if (opt == 0)
2224                 opt = 1 << 6; /* default: 6 */
2225         opt = ffs(opt >> 4); /* Maps -1..-4 to [0], -5 to [1] ... -9 to [5] */
2226         max_chain_length = 1 << gzip_level_config[opt].chain_shift;
2227         good_match       = gzip_level_config[opt].good;
2228         max_lazy_match   = gzip_level_config[opt].lazy2 * 2;
2229         nice_match       = gzip_level_config[opt].nice2 * 2;
2230 #endif
2231         option_mask32 &= 0xf; /* retain only -cfkv */
2232
2233         /* Allocate all global buffers (for DYN_ALLOC option) */
2234         ALLOC(uch, G1.l_buf, INBUFSIZ);
2235         ALLOC(uch, G1.outbuf, OUTBUFSIZ);
2236         ALLOC(ush, G1.d_buf, DIST_BUFSIZE);
2237         ALLOC(uch, G1.window, 2L * WSIZE);
2238         ALLOC(ush, G1.prev, 1L << BITS);
2239
2240         /* Initialize the CRC32 table */
2241         global_crc32_table = crc32_filltable(NULL, 0);
2242
2243         argv += optind;
2244         return bbunpack(argv, pack_gzip, append_ext, "gz");
2245 }