Run through indent, fix comments
[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@lineo.com>, <andersee@debian.org>
13  * to support files as well as stdin/stdout, and to generally behave itself wrt
14  * command line handling.
15  *
16  * This program is free software; you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License as published by
18  * the Free Software Foundation; either version 2 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24  * General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, write to the Free Software
28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29  *
30  */
31
32 /* These defines are very important for BusyBox.  Without these,
33  * huge chunks of ram are pre-allocated making the BusyBox bss 
34  * size Freaking Huge(tm), which is a bad thing.*/
35 #define SMALL_MEM
36 #define DYN_ALLOC
37
38 #include <stdlib.h>
39 #include <stdio.h>
40 #include <string.h>
41 #include <unistd.h>
42 #include <errno.h>
43 #include <sys/types.h>
44 #include <signal.h>
45 #include <utime.h>
46 #include <ctype.h>
47 #include <sys/types.h>
48 #include <unistd.h>
49 #include <dirent.h>
50 #include <fcntl.h>
51 #include <time.h>
52 #include "busybox.h"
53
54 #define memzero(s, n)     memset ((void *)(s), 0, (n))
55
56 #ifndef RETSIGTYPE
57 #  define RETSIGTYPE void
58 #endif
59
60 typedef unsigned char uch;
61 typedef unsigned short ush;
62 typedef unsigned long ulg;
63
64 /* Return codes from gzip */
65 #define OK      0
66 #define ERROR   1
67 #define WARNING 2
68
69 /* Compression methods (see algorithm.doc) */
70 /* Only STORED and DEFLATED are supported by this BusyBox module */
71 #define STORED      0
72 /* methods 4 to 7 reserved */
73 #define DEFLATED    8
74 static int method;              /* compression method */
75
76 /* To save memory for 16 bit systems, some arrays are overlaid between
77  * the various modules:
78  * deflate:  prev+head   window      d_buf  l_buf  outbuf
79  * unlzw:    tab_prefix  tab_suffix  stack  inbuf  outbuf
80  * For compression, input is done in window[]. For decompression, output
81  * is done in window except for unlzw.
82  */
83
84 #ifndef INBUFSIZ
85 #  ifdef SMALL_MEM
86 #    define INBUFSIZ  0x2000    /* input buffer size */
87 #  else
88 #    define INBUFSIZ  0x8000    /* input buffer size */
89 #  endif
90 #endif
91 #define INBUF_EXTRA  64 /* required by unlzw() */
92
93 #ifndef OUTBUFSIZ
94 #  ifdef SMALL_MEM
95 #    define OUTBUFSIZ   8192    /* output buffer size */
96 #  else
97 #    define OUTBUFSIZ  16384    /* output buffer size */
98 #  endif
99 #endif
100 #define OUTBUF_EXTRA 2048       /* required by unlzw() */
101
102 #ifndef DIST_BUFSIZE
103 #  ifdef SMALL_MEM
104 #    define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
105 #  else
106 #    define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
107 #  endif
108 #endif
109
110 #ifdef DYN_ALLOC
111 #  define DECLARE(type, array, size)  static type * array
112 #  define ALLOC(type, array, size) { \
113       array = (type*)xcalloc((size_t)(((size)+1L)/2), 2*sizeof(type)); \
114    }
115 #  define FREE(array) {if (array != NULL) free(array), array=NULL;}
116 #else
117 #  define DECLARE(type, array, size)  static type array[size]
118 #  define ALLOC(type, array, size)
119 #  define FREE(array)
120 #endif
121
122 #define tab_suffix window
123 #define tab_prefix prev /* hash link (see deflate.c) */
124 #define head (prev+WSIZE)       /* hash head (see deflate.c) */
125
126 static long bytes_in;   /* number of input bytes */
127
128 #define isize bytes_in
129 /* for compatibility with old zip sources (to be cleaned) */
130
131 typedef int file_t;             /* Do not use stdio */
132
133 #define NO_FILE  (-1)   /* in memory compression */
134
135
136 #define PACK_MAGIC     "\037\036"       /* Magic header for packed files */
137 #define GZIP_MAGIC     "\037\213"       /* Magic header for gzip files, 1F 8B */
138 #define OLD_GZIP_MAGIC "\037\236"       /* Magic header for gzip 0.5 = freeze 1.x */
139 #define LZH_MAGIC      "\037\240"       /* Magic header for SCO LZH Compress files */
140 #define PKZIP_MAGIC    "\120\113\003\004"       /* Magic header for pkzip files */
141
142 /* gzip flag byte */
143 #define ASCII_FLAG   0x01       /* bit 0 set: file probably ascii text */
144 #define CONTINUATION 0x02       /* bit 1 set: continuation of multi-part gzip file */
145 #define EXTRA_FIELD  0x04       /* bit 2 set: extra field present */
146 #define ORIG_NAME    0x08       /* bit 3 set: original file name present */
147 #define COMMENT      0x10       /* bit 4 set: file comment present */
148 #define RESERVED     0xC0       /* bit 6,7:   reserved */
149
150 /* internal file attribute */
151 #define UNKNOWN 0xffff
152 #define BINARY  0
153 #define ASCII   1
154
155 #ifndef WSIZE
156 #  define WSIZE 0x8000  /* window size--must be a power of two, and */
157 #endif                                                  /*  at least 32K for zip's deflate method */
158
159 #define MIN_MATCH  3
160 #define MAX_MATCH  258
161 /* The minimum and maximum match lengths */
162
163 #define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
164 /* Minimum amount of lookahead, except at the end of the input file.
165  * See deflate.c for comments about the MIN_MATCH+1.
166  */
167
168 #define MAX_DIST  (WSIZE-MIN_LOOKAHEAD)
169 /* In order to simplify the code, particularly on 16 bit machines, match
170  * distances are limited to MAX_DIST instead of WSIZE.
171  */
172
173 /* put_byte is used for the compressed output */
174 #define put_byte(c) {outbuf[outcnt++]=(uch)(c); if (outcnt==OUTBUFSIZ)\
175    flush_outbuf();}
176
177
178 /* Output a 32 bit value to the bit stream, lsb first */
179 #if 0
180 #define put_long(n) { \
181     put_short((n) & 0xffff); \
182     put_short(((ulg)(n)) >> 16); \
183 }
184 #endif
185
186 #define seekable()    0 /* force sequential output */
187 #define translate_eol 0 /* no option -a yet */
188
189 /* Diagnostic functions */
190 #ifdef DEBUG
191 #  define Assert(cond,msg) {if(!(cond)) error_msg(msg);}
192 #  define Trace(x) fprintf x
193 #  define Tracev(x) {if (verbose) fprintf x ;}
194 #  define Tracevv(x) {if (verbose>1) fprintf x ;}
195 #  define Tracec(c,x) {if (verbose && (c)) fprintf x ;}
196 #  define Tracecv(c,x) {if (verbose>1 && (c)) fprintf x ;}
197 #else
198 #  define Assert(cond,msg)
199 #  define Trace(x)
200 #  define Tracev(x)
201 #  define Tracevv(x)
202 #  define Tracec(c,x)
203 #  define Tracecv(c,x)
204 #endif
205
206 #define WARN(msg) {if (!quiet) fprintf msg ; \
207                    if (exit_code == OK) exit_code = WARNING;}
208
209 #ifndef MAX_PATH_LEN
210 #  define MAX_PATH_LEN   1024   /* max pathname length */
211 #endif
212
213
214         /* from zip.c: */
215 static int zip(int in, int out);
216 static int file_read(char *buf, unsigned size);
217
218         /* from gzip.c */
219 static RETSIGTYPE abort_gzip(void);
220
221                 /* from deflate.c */
222 static void lm_init(ush * flags);
223 static ulg deflate(void);
224
225                 /* from trees.c */
226 static void ct_init(ush * attr, int *methodp);
227 static int ct_tally(int dist, int lc);
228 static ulg flush_block(char *buf, ulg stored_len, int eof);
229
230                 /* from bits.c */
231 static void bi_init(file_t zipfile);
232 static void send_bits(int value, int length);
233 static unsigned bi_reverse(unsigned value, int length);
234 static void bi_windup(void);
235 static void copy_block(char *buf, unsigned len, int header);
236 static int (*read_buf) (char *buf, unsigned size);
237
238         /* from util.c: */
239 static void flush_outbuf(void);
240
241 /* lzw.h -- define the lzw functions.
242  * Copyright (C) 1992-1993 Jean-loup Gailly.
243  * This is free software; you can redistribute it and/or modify it under the
244  * terms of the GNU General Public License, see the file COPYING.
245  */
246
247 #if !defined(OF) && defined(lint)
248 #  include "gzip.h"
249 #endif
250
251 #ifndef BITS
252 #  define BITS 16
253 #endif
254 #define INIT_BITS 9             /* Initial number of bits per code */
255
256 #define BIT_MASK    0x1f        /* Mask for 'number of compression bits' */
257 /* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
258  * It's a pity that old uncompress does not check bit 0x20. That makes
259  * extension of the format actually undesirable because old compress
260  * would just crash on the new format instead of giving a meaningful
261  * error message. It does check the number of bits, but it's more
262  * helpful to say "unsupported format, get a new version" than
263  * "can only handle 16 bits".
264  */
265
266 /* tailor.h -- target dependent definitions
267  * Copyright (C) 1992-1993 Jean-loup Gailly.
268  * This is free software; you can redistribute it and/or modify it under the
269  * terms of the GNU General Public License, see the file COPYING.
270  */
271
272 /* The target dependent definitions should be defined here only.
273  * The target dependent functions should be defined in tailor.c.
274  */
275
276
277         /* Common defaults */
278
279 #ifndef OS_CODE
280 #  define OS_CODE  0x03 /* assume Unix */
281 #endif
282
283 #ifndef PATH_SEP
284 #  define PATH_SEP '/'
285 #endif
286
287 #ifndef OPTIONS_VAR
288 #  define OPTIONS_VAR "GZIP"
289 #endif
290
291 #ifndef Z_SUFFIX
292 #  define Z_SUFFIX ".gz"
293 #endif
294
295 #ifdef MAX_EXT_CHARS
296 #  define MAX_SUFFIX  MAX_EXT_CHARS
297 #else
298 #  define MAX_SUFFIX  30
299 #endif
300
301                 /* global buffers */
302
303 DECLARE(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
304 DECLARE(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
305 DECLARE(ush, d_buf, DIST_BUFSIZE);
306 DECLARE(uch, window, 2L * WSIZE);
307 DECLARE(ush, tab_prefix, 1L << BITS);
308
309 static int crc_table_empty = 1;
310
311 static int foreground;  /* set if program run in foreground */
312 static int method = DEFLATED;   /* compression method */
313 static int exit_code = OK;      /* program exit code */
314 static int part_nb;             /* number of parts in .gz file */
315 static long time_stamp; /* original time stamp (modification time) */
316 static long ifile_size; /* input file size, -1 for devices (debug only) */
317 static char z_suffix[MAX_SUFFIX + 1];   /* default suffix (can be set with --suffix) */
318 static int z_len;               /* strlen(z_suffix) */
319
320 static int ifd;                 /* input file descriptor */
321 static int ofd;                 /* output file descriptor */
322 static unsigned insize; /* valid bytes in inbuf */
323 static unsigned outcnt; /* bytes in output buffer */
324
325
326 /* Output a 16 bit value, lsb first */
327 static void put_short(ush w)
328 {
329         if (outcnt < OUTBUFSIZ - 2) {
330                 outbuf[outcnt++] = (uch) ((w) & 0xff);
331                 outbuf[outcnt++] = (uch) ((ush) (w) >> 8);
332         } else {
333                 put_byte((uch) ((w) & 0xff));
334                 put_byte((uch) ((ush) (w) >> 8));
335         }
336 }
337
338 /* ========================================================================
339  * Signal and error handler.
340  */
341 static void abort_gzip()
342 {
343         exit(ERROR);
344 }
345
346 /* ===========================================================================
347  * Clear input and output buffers
348  */
349 static void clear_bufs(void)
350 {
351         outcnt = 0;
352         insize = 0;
353         bytes_in = 0L;
354 }
355
356 static void write_error_msg(void)
357 {
358         fprintf(stderr, "\n");
359         perror("");
360         abort_gzip();
361 }
362
363 /* ===========================================================================
364  * Does the same as write(), but also handles partial pipe writes and checks
365  * for error return.
366  */
367 static void write_buf(int fd, void *buf, unsigned cnt)
368 {
369         unsigned n;
370
371         while ((n = write(fd, buf, cnt)) != cnt) {
372                 if (n == (unsigned) (-1)) {
373                         write_error_msg();
374                 }
375                 cnt -= n;
376                 buf = (void *) ((char *) buf + n);
377         }
378 }
379
380 /* ===========================================================================
381  * Run a set of bytes through the crc shift register.  If s is a NULL
382  * pointer, then initialize the crc shift register contents instead.
383  * Return the current crc in either case.
384  */
385 static ulg updcrc(uch * s, unsigned n)
386 {
387         static ulg crc = (ulg) 0xffffffffL;     /* shift register contents */
388         register ulg c;         /* temporary variable */
389         static unsigned long crc_32_tab[256];
390
391         if (crc_table_empty) {
392                 unsigned long csr;      /* crc shift register */
393                 const unsigned long e = 0xedb88320L;    /* polynomial exclusive-or pattern */
394                 int i;                  /* counter for all possible eight bit values */
395                 int k;                  /* byte being shifted into crc apparatus */
396
397                 /* Compute table of CRC's. */
398                 crc_32_tab[0] = 0x00000000L;
399                 for (i = 1; i < 256; i++) {
400                         csr = i;
401                         /* The idea to initialize the register with the byte instead of
402                            * zero was stolen from Haruhiko Okumura's ar002
403                          */
404                         for (k = 8; k; k--)
405                                 csr = csr & 1 ? (csr >> 1) ^ e : csr >> 1;
406                         crc_32_tab[i] = csr;
407                 }
408         }
409
410         if (s == NULL) {
411                 c = 0xffffffffL;
412         } else {
413                 c = crc;
414                 if (n)
415                         do {
416                                 c = crc_32_tab[((int) c ^ (*s++)) & 0xff] ^ (c >> 8);
417                         } while (--n);
418         }
419         crc = c;
420         return c ^ 0xffffffffL; /* (instead of ~c for 64-bit machines) */
421 }
422
423 /* bits.c -- output variable-length bit strings
424  * Copyright (C) 1992-1993 Jean-loup Gailly
425  * This is free software; you can redistribute it and/or modify it under the
426  * terms of the GNU General Public License, see the file COPYING.
427  */
428
429
430 /*
431  *  PURPOSE
432  *
433  *      Output variable-length bit strings. Compression can be done
434  *      to a file or to memory. (The latter is not supported in this version.)
435  *
436  *  DISCUSSION
437  *
438  *      The PKZIP "deflate" file format interprets compressed file data
439  *      as a sequence of bits.  Multi-bit strings in the file may cross
440  *      byte boundaries without restriction.
441  *
442  *      The first bit of each byte is the low-order bit.
443  *
444  *      The routines in this file allow a variable-length bit value to
445  *      be output right-to-left (useful for literal values). For
446  *      left-to-right output (useful for code strings from the tree routines),
447  *      the bits must have been reversed first with bi_reverse().
448  *
449  *      For in-memory compression, the compressed bit stream goes directly
450  *      into the requested output buffer. The input data is read in blocks
451  *      by the mem_read() function. The buffer is limited to 64K on 16 bit
452  *      machines.
453  *
454  *  INTERFACE
455  *
456  *      void bi_init (FILE *zipfile)
457  *          Initialize the bit string routines.
458  *
459  *      void send_bits (int value, int length)
460  *          Write out a bit string, taking the source bits right to
461  *          left.
462  *
463  *      int bi_reverse (int value, int length)
464  *          Reverse the bits of a bit string, taking the source bits left to
465  *          right and emitting them right to left.
466  *
467  *      void bi_windup (void)
468  *          Write out any remaining bits in an incomplete byte.
469  *
470  *      void copy_block(char *buf, unsigned len, int header)
471  *          Copy a stored block to the zip file, storing first the length and
472  *          its one's complement if requested.
473  *
474  */
475
476 /* ===========================================================================
477  * Local data used by the "bit string" routines.
478  */
479
480 static file_t zfile;    /* output gzip file */
481
482 static unsigned short bi_buf;
483
484 /* Output buffer. bits are inserted starting at the bottom (least significant
485  * bits).
486  */
487
488 #define Buf_size (8 * 2*sizeof(char))
489 /* Number of bits used within bi_buf. (bi_buf might be implemented on
490  * more than 16 bits on some systems.)
491  */
492
493 static int bi_valid;
494
495 /* Current input function. Set to mem_read for in-memory compression */
496
497 #ifdef DEBUG
498 ulg bits_sent;                  /* bit length of the compressed data */
499 #endif
500
501 /* ===========================================================================
502  * Initialize the bit string routines.
503  */
504 static void bi_init(file_t zipfile)
505 {
506         zfile = zipfile;
507         bi_buf = 0;
508         bi_valid = 0;
509 #ifdef DEBUG
510         bits_sent = 0L;
511 #endif
512
513         /* Set the defaults for file compression. They are set by memcompress
514          * for in-memory compression.
515          */
516         if (zfile != NO_FILE) {
517                 read_buf = file_read;
518         }
519 }
520
521 /* ===========================================================================
522  * Send a value on a given number of bits.
523  * IN assertion: length <= 16 and value fits in length bits.
524  */
525 static void send_bits(int value, int length)
526 {
527 #ifdef DEBUG
528         Tracev((stderr, " l %2d v %4x ", length, value));
529         Assert(length > 0 && length <= 15, "invalid length");
530         bits_sent += (ulg) length;
531 #endif
532         /* If not enough room in bi_buf, use (valid) bits from bi_buf and
533          * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
534          * unused bits in value.
535          */
536         if (bi_valid > (int) Buf_size - length) {
537                 bi_buf |= (value << bi_valid);
538                 put_short(bi_buf);
539                 bi_buf = (ush) value >> (Buf_size - bi_valid);
540                 bi_valid += length - Buf_size;
541         } else {
542                 bi_buf |= value << bi_valid;
543                 bi_valid += length;
544         }
545 }
546
547 /* ===========================================================================
548  * Reverse the first len bits of a code, using straightforward code (a faster
549  * method would use a table)
550  * IN assertion: 1 <= len <= 15
551  */
552 static unsigned bi_reverse(unsigned code, int len)
553 {
554         register unsigned res = 0;
555
556         do {
557                 res |= code & 1;
558                 code >>= 1, res <<= 1;
559         } while (--len > 0);
560         return res >> 1;
561 }
562
563 /* ===========================================================================
564  * Write out any remaining bits in an incomplete byte.
565  */
566 static void bi_windup()
567 {
568         if (bi_valid > 8) {
569                 put_short(bi_buf);
570         } else if (bi_valid > 0) {
571                 put_byte(bi_buf);
572         }
573         bi_buf = 0;
574         bi_valid = 0;
575 #ifdef DEBUG
576         bits_sent = (bits_sent + 7) & ~7;
577 #endif
578 }
579
580 /* ===========================================================================
581  * Copy a stored block to the zip file, storing first the length and its
582  * one's complement if requested.
583  */
584 static void copy_block(char *buf, unsigned len, int header)
585 {
586         bi_windup();            /* align on byte boundary */
587
588         if (header) {
589                 put_short((ush) len);
590                 put_short((ush) ~ len);
591 #ifdef DEBUG
592                 bits_sent += 2 * 16;
593 #endif
594         }
595 #ifdef DEBUG
596         bits_sent += (ulg) len << 3;
597 #endif
598         while (len--) {
599                 put_byte(*buf++);
600         }
601 }
602
603 /* deflate.c -- compress data using the deflation algorithm
604  * Copyright (C) 1992-1993 Jean-loup Gailly
605  * This is free software; you can redistribute it and/or modify it under the
606  * terms of the GNU General Public License, see the file COPYING.
607  */
608
609 /*
610  *  PURPOSE
611  *
612  *      Identify new text as repetitions of old text within a fixed-
613  *      length sliding window trailing behind the new text.
614  *
615  *  DISCUSSION
616  *
617  *      The "deflation" process depends on being able to identify portions
618  *      of the input text which are identical to earlier input (within a
619  *      sliding window trailing behind the input currently being processed).
620  *
621  *      The most straightforward technique turns out to be the fastest for
622  *      most input files: try all possible matches and select the longest.
623  *      The key feature of this algorithm is that insertions into the string
624  *      dictionary are very simple and thus fast, and deletions are avoided
625  *      completely. Insertions are performed at each input character, whereas
626  *      string matches are performed only when the previous match ends. So it
627  *      is preferable to spend more time in matches to allow very fast string
628  *      insertions and avoid deletions. The matching algorithm for small
629  *      strings is inspired from that of Rabin & Karp. A brute force approach
630  *      is used to find longer strings when a small match has been found.
631  *      A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
632  *      (by Leonid Broukhis).
633  *         A previous version of this file used a more sophisticated algorithm
634  *      (by Fiala and Greene) which is guaranteed to run in linear amortized
635  *      time, but has a larger average cost, uses more memory and is patented.
636  *      However the F&G algorithm may be faster for some highly redundant
637  *      files if the parameter max_chain_length (described below) is too large.
638  *
639  *  ACKNOWLEDGEMENTS
640  *
641  *      The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
642  *      I found it in 'freeze' written by Leonid Broukhis.
643  *      Thanks to many info-zippers for bug reports and testing.
644  *
645  *  REFERENCES
646  *
647  *      APPNOTE.TXT documentation file in PKZIP 1.93a distribution.
648  *
649  *      A description of the Rabin and Karp algorithm is given in the book
650  *         "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
651  *
652  *      Fiala,E.R., and Greene,D.H.
653  *         Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
654  *
655  *  INTERFACE
656  *
657  *      void lm_init (int pack_level, ush *flags)
658  *          Initialize the "longest match" routines for a new file
659  *
660  *      ulg deflate (void)
661  *          Processes a new input file and return its compressed length. Sets
662  *          the compressed length, crc, deflate flags and internal file
663  *          attributes.
664  */
665
666
667 /* ===========================================================================
668  * Configuration parameters
669  */
670
671 /* Compile with MEDIUM_MEM to reduce the memory requirements or
672  * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
673  * entire input file can be held in memory (not possible on 16 bit systems).
674  * Warning: defining these symbols affects HASH_BITS (see below) and thus
675  * affects the compression ratio. The compressed output
676  * is still correct, and might even be smaller in some cases.
677  */
678
679 #ifdef SMALL_MEM
680 #   define HASH_BITS  13        /* Number of bits used to hash strings */
681 #endif
682 #ifdef MEDIUM_MEM
683 #   define HASH_BITS  14
684 #endif
685 #ifndef HASH_BITS
686 #   define HASH_BITS  15
687    /* For portability to 16 bit machines, do not use values above 15. */
688 #endif
689
690 /* To save space (see unlzw.c), we overlay prev+head with tab_prefix and
691  * window with tab_suffix. Check that we can do this:
692  */
693 #if (WSIZE<<1) > (1<<BITS)
694 #  error cannot overlay window with tab_suffix and prev with tab_prefix0
695 #endif
696 #if HASH_BITS > BITS-1
697 #  error cannot overlay head with tab_prefix1
698 #endif
699 #define HASH_SIZE (unsigned)(1<<HASH_BITS)
700 #define HASH_MASK (HASH_SIZE-1)
701 #define WMASK     (WSIZE-1)
702 /* HASH_SIZE and WSIZE must be powers of two */
703 #define NIL 0
704 /* Tail of hash chains */
705 #define FAST 4
706 #define SLOW 2
707 /* speed options for the general purpose bit flag */
708 #ifndef TOO_FAR
709 #  define TOO_FAR 4096
710 #endif
711 /* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
712 /* ===========================================================================
713  * Local data used by the "longest match" routines.
714  */
715 typedef ush Pos;
716 typedef unsigned IPos;
717
718 /* A Pos is an index in the character window. We use short instead of int to
719  * save space in the various tables. IPos is used only for parameter passing.
720  */
721
722 /* DECLARE(uch, window, 2L*WSIZE); */
723 /* Sliding window. Input bytes are read into the second half of the window,
724  * and move to the first half later to keep a dictionary of at least WSIZE
725  * bytes. With this organization, matches are limited to a distance of
726  * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
727  * performed with a length multiple of the block size. Also, it limits
728  * the window size to 64K, which is quite useful on MSDOS.
729  * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
730  * be less efficient).
731  */
732
733 /* DECLARE(Pos, prev, WSIZE); */
734 /* Link to older string with same hash index. To limit the size of this
735  * array to 64K, this link is maintained only for the last 32K strings.
736  * An index in this array is thus a window index modulo 32K.
737  */
738
739 /* DECLARE(Pos, head, 1<<HASH_BITS); */
740 /* Heads of the hash chains or NIL. */
741
742 static const ulg window_size = (ulg) 2 * WSIZE;
743
744 /* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
745  * input file length plus MIN_LOOKAHEAD.
746  */
747
748 static long block_start;
749
750 /* window position at the beginning of the current output block. Gets
751  * negative when the window is moved backwards.
752  */
753
754 static unsigned ins_h;  /* hash index of string to be inserted */
755
756 #define H_SHIFT  ((HASH_BITS+MIN_MATCH-1)/MIN_MATCH)
757 /* Number of bits by which ins_h and del_h must be shifted at each
758  * input step. It must be such that after MIN_MATCH steps, the oldest
759  * byte no longer takes part in the hash key, that is:
760  *   H_SHIFT * MIN_MATCH >= HASH_BITS
761  */
762
763 static unsigned int prev_length;
764
765 /* Length of the best match at previous step. Matches not greater than this
766  * are discarded. This is used in the lazy match evaluation.
767  */
768
769 static unsigned strstart;       /* start of string to insert */
770 static unsigned match_start;    /* start of matching string */
771 static int eofile;              /* flag set at end of input file */
772 static unsigned lookahead;      /* number of valid bytes ahead in window */
773
774 static const unsigned max_chain_length = 4096;
775
776 /* To speed up deflation, hash chains are never searched beyond this length.
777  * A higher limit improves compression ratio but degrades the speed.
778  */
779
780 static const unsigned int max_lazy_match = 258;
781
782 /* Attempt to find a better match only when the current match is strictly
783  * smaller than this value. This mechanism is used only for compression
784  * levels >= 4.
785  */
786 #define max_insert_length  max_lazy_match
787 /* Insert new strings in the hash table only if the match length
788  * is not greater than this length. This saves time but degrades compression.
789  * max_insert_length is used only for compression levels <= 3.
790  */
791
792 static const unsigned good_match = 32;
793
794 /* Use a faster search when the previous match is longer than this */
795
796
797 /* Values for max_lazy_match, good_match and max_chain_length, depending on
798  * the desired pack level (0..9). The values given below have been tuned to
799  * exclude worst case performance for pathological files. Better values may be
800  * found for specific files.
801  */
802
803 static const int nice_match = 258;      /* Stop searching when current match exceeds this */
804
805 /* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
806  * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
807  * meaning.
808  */
809
810 #define EQUAL 0
811 /* result of memcmp for equal strings */
812
813 /* ===========================================================================
814  *  Prototypes for local functions.
815  */
816 static void fill_window(void);
817
818 static int longest_match(IPos cur_match);
819
820 #ifdef DEBUG
821 static void check_match(IPos start, IPos match, int length);
822 #endif
823
824 /* ===========================================================================
825  * Update a hash value with the given input byte
826  * IN  assertion: all calls to to UPDATE_HASH are made with consecutive
827  *    input characters, so that a running hash key can be computed from the
828  *    previous key instead of complete recalculation each time.
829  */
830 #define UPDATE_HASH(h,c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
831
832 /* ===========================================================================
833  * Insert string s in the dictionary and set match_head to the previous head
834  * of the hash chain (the most recent string with same hash key). Return
835  * the previous length of the hash chain.
836  * IN  assertion: all calls to to INSERT_STRING are made with consecutive
837  *    input characters and the first MIN_MATCH bytes of s are valid
838  *    (except for the last MIN_MATCH-1 bytes of the input file).
839  */
840 #define INSERT_STRING(s, match_head) \
841    (UPDATE_HASH(ins_h, window[(s) + MIN_MATCH-1]), \
842     prev[(s) & WMASK] = match_head = head[ins_h], \
843     head[ins_h] = (s))
844
845 /* ===========================================================================
846  * Initialize the "longest match" routines for a new file
847  */
848 static void lm_init(ush * flags)
849 {
850         register unsigned j;
851
852         /* Initialize the hash table. */
853         memzero((char *) head, HASH_SIZE * sizeof(*head));
854         /* prev will be initialized on the fly */
855
856         *flags |= SLOW;
857         /* ??? reduce max_chain_length for binary files */
858
859         strstart = 0;
860         block_start = 0L;
861
862         lookahead = read_buf((char *) window,
863                                                  sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
864
865         if (lookahead == 0 || lookahead == (unsigned) EOF) {
866                 eofile = 1, lookahead = 0;
867                 return;
868         }
869         eofile = 0;
870         /* Make sure that we always have enough lookahead. This is important
871          * if input comes from a device such as a tty.
872          */
873         while (lookahead < MIN_LOOKAHEAD && !eofile)
874                 fill_window();
875
876         ins_h = 0;
877         for (j = 0; j < MIN_MATCH - 1; j++)
878                 UPDATE_HASH(ins_h, window[j]);
879         /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
880          * not important since only literal bytes will be emitted.
881          */
882 }
883
884 /* ===========================================================================
885  * Set match_start to the longest match starting at the given string and
886  * return its length. Matches shorter or equal to prev_length are discarded,
887  * in which case the result is equal to prev_length and match_start is
888  * garbage.
889  * IN assertions: cur_match is the head of the hash chain for the current
890  *   string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
891  */
892
893 /* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
894  * match.s. The code is functionally equivalent, so you can use the C version
895  * if desired.
896  */
897 static int longest_match(IPos cur_match)
898 {
899         unsigned chain_length = max_chain_length;       /* max hash chain length */
900         register uch *scan = window + strstart; /* current string */
901         register uch *match;    /* matched string */
902         register int len;       /* length of current match */
903         int best_len = prev_length;     /* best match length so far */
904         IPos limit =
905                 strstart > (IPos) MAX_DIST ? strstart - (IPos) MAX_DIST : NIL;
906         /* Stop when cur_match becomes <= limit. To simplify the code,
907          * we prevent matches with the string of window index 0.
908          */
909
910 /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
911  * It is easy to get rid of this optimization if necessary.
912  */
913 #if HASH_BITS < 8 || MAX_MATCH != 258
914 #  error Code too clever
915 #endif
916         register uch *strend = window + strstart + MAX_MATCH;
917         register uch scan_end1 = scan[best_len - 1];
918         register uch scan_end = scan[best_len];
919
920         /* Do not waste too much time if we already have a good match: */
921         if (prev_length >= good_match) {
922                 chain_length >>= 2;
923         }
924         Assert(strstart <= window_size - MIN_LOOKAHEAD, "insufficient lookahead");
925
926         do {
927                 Assert(cur_match < strstart, "no future");
928                 match = window + cur_match;
929
930                 /* Skip to next match if the match length cannot increase
931                  * or if the match length is less than 2:
932                  */
933                 if (match[best_len] != scan_end ||
934                         match[best_len - 1] != scan_end1 ||
935                         *match != *scan || *++match != scan[1])
936                         continue;
937
938                 /* The check at best_len-1 can be removed because it will be made
939                  * again later. (This heuristic is not always a win.)
940                  * It is not necessary to compare scan[2] and match[2] since they
941                  * are always equal when the other bytes match, given that
942                  * the hash keys are equal and that HASH_BITS >= 8.
943                  */
944                 scan += 2, match++;
945
946                 /* We check for insufficient lookahead only every 8th comparison;
947                  * the 256th check will be made at strstart+258.
948                  */
949                 do {
950                 } while (*++scan == *++match && *++scan == *++match &&
951                                  *++scan == *++match && *++scan == *++match &&
952                                  *++scan == *++match && *++scan == *++match &&
953                                  *++scan == *++match && *++scan == *++match && scan < strend);
954
955                 len = MAX_MATCH - (int) (strend - scan);
956                 scan = strend - MAX_MATCH;
957
958                 if (len > best_len) {
959                         match_start = cur_match;
960                         best_len = len;
961                         if (len >= nice_match)
962                                 break;
963                         scan_end1 = scan[best_len - 1];
964                         scan_end = scan[best_len];
965                 }
966         } while ((cur_match = prev[cur_match & WMASK]) > limit
967                          && --chain_length != 0);
968
969         return best_len;
970 }
971
972 #ifdef DEBUG
973 /* ===========================================================================
974  * Check that the match at match_start is indeed a match.
975  */
976 static void check_match(IPos start, IPos match, int length)
977 {
978         /* check that the match is indeed a match */
979         if (memcmp((char *) window + match,
980                            (char *) window + start, length) != EQUAL) {
981                 fprintf(stderr,
982                                 " start %d, match %d, length %d\n", start, match, length);
983                 error_msg("invalid match");
984         }
985         if (verbose > 1) {
986                 fprintf(stderr, "\\[%d,%d]", start - match, length);
987                 do {
988                         putc(window[start++], stderr);
989                 } while (--length != 0);
990         }
991 }
992 #else
993 #  define check_match(start, match, length)
994 #endif
995
996 /* ===========================================================================
997  * Fill the window when the lookahead becomes insufficient.
998  * Updates strstart and lookahead, and sets eofile if end of input file.
999  * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
1000  * OUT assertions: at least one byte has been read, or eofile is set;
1001  *    file reads are performed for at least two bytes (required for the
1002  *    translate_eol option).
1003  */
1004 static void fill_window()
1005 {
1006         register unsigned n, m;
1007         unsigned more =
1008                 (unsigned) (window_size - (ulg) lookahead - (ulg) strstart);
1009         /* Amount of free space at the end of the window. */
1010
1011         /* If the window is almost full and there is insufficient lookahead,
1012          * move the upper half to the lower one to make room in the upper half.
1013          */
1014         if (more == (unsigned) EOF) {
1015                 /* Very unlikely, but possible on 16 bit machine if strstart == 0
1016                  * and lookahead == 1 (input done one byte at time)
1017                  */
1018                 more--;
1019         } else if (strstart >= WSIZE + MAX_DIST) {
1020                 /* By the IN assertion, the window is not empty so we can't confuse
1021                  * more == 0 with more == 64K on a 16 bit machine.
1022                  */
1023                 Assert(window_size == (ulg) 2 * WSIZE, "no sliding with BIG_MEM");
1024
1025                 memcpy((char *) window, (char *) window + WSIZE, (unsigned) WSIZE);
1026                 match_start -= WSIZE;
1027                 strstart -= WSIZE;      /* we now have strstart >= MAX_DIST: */
1028
1029                 block_start -= (long) WSIZE;
1030
1031                 for (n = 0; n < HASH_SIZE; n++) {
1032                         m = head[n];
1033                         head[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1034                 }
1035                 for (n = 0; n < WSIZE; n++) {
1036                         m = prev[n];
1037                         prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1038                         /* If n is not on any hash chain, prev[n] is garbage but
1039                          * its value will never be used.
1040                          */
1041                 }
1042                 more += WSIZE;
1043         }
1044         /* At this point, more >= 2 */
1045         if (!eofile) {
1046                 n = read_buf((char *) window + strstart + lookahead, more);
1047                 if (n == 0 || n == (unsigned) EOF) {
1048                         eofile = 1;
1049                 } else {
1050                         lookahead += n;
1051                 }
1052         }
1053 }
1054
1055 /* ===========================================================================
1056  * Flush the current block, with given end-of-file flag.
1057  * IN assertion: strstart is set to the end of the current match.
1058  */
1059 #define FLUSH_BLOCK(eof) \
1060    flush_block(block_start >= 0L ? (char*)&window[(unsigned)block_start] : \
1061                 (char*)NULL, (long)strstart - block_start, (eof))
1062
1063 /* ===========================================================================
1064  * Same as above, but achieves better compression. We use a lazy
1065  * evaluation for matches: a match is finally adopted only if there is
1066  * no better match at the next window position.
1067  */
1068 static ulg deflate()
1069 {
1070         IPos hash_head;         /* head of hash chain */
1071         IPos prev_match;        /* previous match */
1072         int flush;                      /* set if current block must be flushed */
1073         int match_available = 0;        /* set if previous match exists */
1074         register unsigned match_length = MIN_MATCH - 1; /* length of best match */
1075
1076         /* Process the input block. */
1077         while (lookahead != 0) {
1078                 /* Insert the string window[strstart .. strstart+2] in the
1079                  * dictionary, and set hash_head to the head of the hash chain:
1080                  */
1081                 INSERT_STRING(strstart, hash_head);
1082
1083                 /* Find the longest match, discarding those <= prev_length.
1084                  */
1085                 prev_length = match_length, prev_match = match_start;
1086                 match_length = MIN_MATCH - 1;
1087
1088                 if (hash_head != NIL && prev_length < max_lazy_match &&
1089                         strstart - hash_head <= MAX_DIST) {
1090                         /* To simplify the code, we prevent matches with the string
1091                          * of window index 0 (in particular we have to avoid a match
1092                          * of the string with itself at the start of the input file).
1093                          */
1094                         match_length = longest_match(hash_head);
1095                         /* longest_match() sets match_start */
1096                         if (match_length > lookahead)
1097                                 match_length = lookahead;
1098
1099                         /* Ignore a length 3 match if it is too distant: */
1100                         if (match_length == MIN_MATCH && strstart - match_start > TOO_FAR) {
1101                                 /* If prev_match is also MIN_MATCH, match_start is garbage
1102                                  * but we will ignore the current match anyway.
1103                                  */
1104                                 match_length--;
1105                         }
1106                 }
1107                 /* If there was a match at the previous step and the current
1108                  * match is not better, output the previous match:
1109                  */
1110                 if (prev_length >= MIN_MATCH && match_length <= prev_length) {
1111
1112                         check_match(strstart - 1, prev_match, prev_length);
1113
1114                         flush =
1115                                 ct_tally(strstart - 1 - prev_match, prev_length - MIN_MATCH);
1116
1117                         /* Insert in hash table all strings up to the end of the match.
1118                          * strstart-1 and strstart are already inserted.
1119                          */
1120                         lookahead -= prev_length - 1;
1121                         prev_length -= 2;
1122                         do {
1123                                 strstart++;
1124                                 INSERT_STRING(strstart, hash_head);
1125                                 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1126                                  * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1127                                  * these bytes are garbage, but it does not matter since the
1128                                  * next lookahead bytes will always be emitted as literals.
1129                                  */
1130                         } while (--prev_length != 0);
1131                         match_available = 0;
1132                         match_length = MIN_MATCH - 1;
1133                         strstart++;
1134                         if (flush)
1135                                 FLUSH_BLOCK(0), block_start = strstart;
1136
1137                 } else if (match_available) {
1138                         /* If there was no match at the previous position, output a
1139                          * single literal. If there was a match but the current match
1140                          * is longer, truncate the previous match to a single literal.
1141                          */
1142                         Tracevv((stderr, "%c", window[strstart - 1]));
1143                         if (ct_tally(0, window[strstart - 1])) {
1144                                 FLUSH_BLOCK(0), block_start = strstart;
1145                         }
1146                         strstart++;
1147                         lookahead--;
1148                 } else {
1149                         /* There is no previous match to compare with, wait for
1150                          * the next step to decide.
1151                          */
1152                         match_available = 1;
1153                         strstart++;
1154                         lookahead--;
1155                 }
1156                 Assert(strstart <= isize && lookahead <= isize, "a bit too far");
1157
1158                 /* Make sure that we always have enough lookahead, except
1159                  * at the end of the input file. We need MAX_MATCH bytes
1160                  * for the next match, plus MIN_MATCH bytes to insert the
1161                  * string following the next match.
1162                  */
1163                 while (lookahead < MIN_LOOKAHEAD && !eofile)
1164                         fill_window();
1165         }
1166         if (match_available)
1167                 ct_tally(0, window[strstart - 1]);
1168
1169         return FLUSH_BLOCK(1);  /* eof */
1170 }
1171
1172 /* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
1173  * Copyright (C) 1992-1993 Jean-loup Gailly
1174  * The unzip code was written and put in the public domain by Mark Adler.
1175  * Portions of the lzw code are derived from the public domain 'compress'
1176  * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
1177  * Ken Turkowski, Dave Mack and Peter Jannesen.
1178  *
1179  * See the license_msg below and the file COPYING for the software license.
1180  * See the file algorithm.doc for the compression algorithms and file formats.
1181  */
1182
1183 /* Compress files with zip algorithm and 'compress' interface.
1184  * See usage() and help() functions below for all options.
1185  * Outputs:
1186  *        file.gz:   compressed file with same mode, owner, and utimes
1187  *     or stdout with -c option or if stdin used as input.
1188  * If the output file name had to be truncated, the original name is kept
1189  * in the compressed file.
1190  */
1191
1192                 /* configuration */
1193
1194 typedef struct dirent dir_type;
1195
1196 typedef RETSIGTYPE(*sig_type) (int);
1197
1198 /* ======================================================================== */
1199 int gzip_main(int argc, char **argv)
1200 {
1201         int result;
1202         int inFileNum;
1203         int outFileNum;
1204         struct stat statBuf;
1205         char *delFileName;
1206         int tostdout = 0;
1207         int force = 0;
1208         int opt;
1209
1210         while ((opt = getopt(argc, argv, "cf123456789dq")) != -1) {
1211                 switch (opt) {
1212                 case 'c':
1213                         tostdout = 1;
1214                         break;
1215                 case 'f':
1216                         force = 1;
1217                         break;
1218                         /* Ignore 1-9 (compression level) options */
1219                 case '1':
1220                 case '2':
1221                 case '3':
1222                 case '4':
1223                 case '5':
1224                 case '6':
1225                 case '7':
1226                 case '8':
1227                 case '9':
1228                         break;
1229                 case 'q':
1230                         break;
1231 #ifdef CONFIG_GUNZIP
1232                 case 'd':
1233                         optind = 1;
1234                         return gunzip_main(argc, argv);
1235 #endif
1236                 default:
1237                         show_usage();
1238                 }
1239         }
1240
1241         foreground = signal(SIGINT, SIG_IGN) != SIG_IGN;
1242         if (foreground) {
1243                 (void) signal(SIGINT, (sig_type) abort_gzip);
1244         }
1245 #ifdef SIGTERM
1246         if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
1247                 (void) signal(SIGTERM, (sig_type) abort_gzip);
1248         }
1249 #endif
1250 #ifdef SIGHUP
1251         if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
1252                 (void) signal(SIGHUP, (sig_type) abort_gzip);
1253         }
1254 #endif
1255
1256         strncpy(z_suffix, Z_SUFFIX, sizeof(z_suffix) - 1);
1257         z_len = strlen(z_suffix);
1258
1259         /* Allocate all global buffers (for DYN_ALLOC option) */
1260         ALLOC(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
1261         ALLOC(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
1262         ALLOC(ush, d_buf, DIST_BUFSIZE);
1263         ALLOC(uch, window, 2L * WSIZE);
1264         ALLOC(ush, tab_prefix, 1L << BITS);
1265
1266         clear_bufs();
1267         part_nb = 0;
1268
1269         if (optind == argc) {
1270                 time_stamp = 0;
1271                 ifile_size = -1L;
1272                 zip(STDIN_FILENO, STDOUT_FILENO);
1273         } else {
1274                 int i;
1275
1276                 for (i = optind; i < argc; i++) {
1277                         char *path = NULL;
1278
1279                         if (strcmp(argv[i], "-") == 0) {
1280                                 time_stamp = 0;
1281                                 ifile_size = -1L;
1282                                 inFileNum = STDIN_FILENO;
1283                                 outFileNum = STDOUT_FILENO;
1284                         } else {
1285                                 inFileNum = open(argv[i], O_RDONLY);
1286                                 if (inFileNum < 0 || fstat(inFileNum, &statBuf) < 0)
1287                                         perror_msg_and_die("%s", argv[i]);
1288                                 time_stamp = statBuf.st_ctime;
1289                                 ifile_size = statBuf.st_size;
1290
1291                                 if (!tostdout) {
1292                                         path = xmalloc(strlen(argv[i]) + 4);
1293                                         strcpy(path, argv[i]);
1294                                         strcat(path, ".gz");
1295
1296                                         /* Open output file */
1297 #if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
1298                                         outFileNum =
1299                                                 open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW);
1300 #else
1301                                         outFileNum = open(path, O_RDWR | O_CREAT | O_EXCL);
1302 #endif
1303                                         if (outFileNum < 0) {
1304                                                 perror_msg("%s", path);
1305                                                 free(path);
1306                                                 continue;
1307                                         }
1308
1309                                         /* Set permissions on the file */
1310                                         fchmod(outFileNum, statBuf.st_mode);
1311                                 } else
1312                                         outFileNum = STDOUT_FILENO;
1313                         }
1314
1315                         if (path == NULL && isatty(outFileNum) && force == 0) {
1316                                 error_msg
1317                                         ("compressed data not written to a terminal. Use -f to force compression.");
1318                                 free(path);
1319                                 continue;
1320                         }
1321
1322                         result = zip(inFileNum, outFileNum);
1323
1324                         if (path != NULL) {
1325                                 close(inFileNum);
1326                                 close(outFileNum);
1327
1328                                 /* Delete the original file */
1329                                 if (result == OK)
1330                                         delFileName = argv[i];
1331                                 else
1332                                         delFileName = path;
1333
1334                                 if (unlink(delFileName) < 0)
1335                                         perror_msg("%s", delFileName);
1336                         }
1337
1338                         free(path);
1339                 }
1340         }
1341
1342         return (exit_code);
1343 }
1344
1345 /* trees.c -- output deflated data using Huffman coding
1346  * Copyright (C) 1992-1993 Jean-loup Gailly
1347  * This is free software; you can redistribute it and/or modify it under the
1348  * terms of the GNU General Public License, see the file COPYING.
1349  */
1350
1351 /*
1352  *  PURPOSE
1353  *
1354  *      Encode various sets of source values using variable-length
1355  *      binary code trees.
1356  *
1357  *  DISCUSSION
1358  *
1359  *      The PKZIP "deflation" process uses several Huffman trees. The more
1360  *      common source values are represented by shorter bit sequences.
1361  *
1362  *      Each code tree is stored in the ZIP file in a compressed form
1363  *      which is itself a Huffman encoding of the lengths of
1364  *      all the code strings (in ascending order by source values).
1365  *      The actual code strings are reconstructed from the lengths in
1366  *      the UNZIP process, as described in the "application note"
1367  *      (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
1368  *
1369  *  REFERENCES
1370  *
1371  *      Lynch, Thomas J.
1372  *          Data Compression:  Techniques and Applications, pp. 53-55.
1373  *          Lifetime Learning Publications, 1985.  ISBN 0-534-03418-7.
1374  *
1375  *      Storer, James A.
1376  *          Data Compression:  Methods and Theory, pp. 49-50.
1377  *          Computer Science Press, 1988.  ISBN 0-7167-8156-5.
1378  *
1379  *      Sedgewick, R.
1380  *          Algorithms, p290.
1381  *          Addison-Wesley, 1983. ISBN 0-201-06672-6.
1382  *
1383  *  INTERFACE
1384  *
1385  *      void ct_init (ush *attr, int *methodp)
1386  *          Allocate the match buffer, initialize the various tables and save
1387  *          the location of the internal file attribute (ascii/binary) and
1388  *          method (DEFLATE/STORE)
1389  *
1390  *      void ct_tally (int dist, int lc);
1391  *          Save the match info and tally the frequency counts.
1392  *
1393  *      long flush_block (char *buf, ulg stored_len, int eof)
1394  *          Determine the best encoding for the current block: dynamic trees,
1395  *          static trees or store, and output the encoded block to the zip
1396  *          file. Returns the total compressed length for the file so far.
1397  *
1398  */
1399
1400 /* ===========================================================================
1401  * Constants
1402  */
1403
1404 #define MAX_BITS 15
1405 /* All codes must not exceed MAX_BITS bits */
1406
1407 #define MAX_BL_BITS 7
1408 /* Bit length codes must not exceed MAX_BL_BITS bits */
1409
1410 #define LENGTH_CODES 29
1411 /* number of length codes, not counting the special END_BLOCK code */
1412
1413 #define LITERALS  256
1414 /* number of literal bytes 0..255 */
1415
1416 #define END_BLOCK 256
1417 /* end of block literal code */
1418
1419 #define L_CODES (LITERALS+1+LENGTH_CODES)
1420 /* number of Literal or Length codes, including the END_BLOCK code */
1421
1422 #define D_CODES   30
1423 /* number of distance codes */
1424
1425 #define BL_CODES  19
1426 /* number of codes used to transfer the bit lengths */
1427
1428 typedef uch extra_bits_t;
1429
1430 /* extra bits for each length code */
1431 static const extra_bits_t extra_lbits[LENGTH_CODES]
1432         = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
1433         4, 4, 5, 5, 5, 5, 0
1434 };
1435
1436 /* extra bits for each distance code */
1437 static const extra_bits_t extra_dbits[D_CODES]
1438         = { 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
1439         10, 10, 11, 11, 12, 12, 13, 13
1440 };
1441
1442 /* extra bits for each bit length code */
1443 static const extra_bits_t extra_blbits[BL_CODES]
1444 = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 7 };
1445
1446 #define STORED_BLOCK 0
1447 #define STATIC_TREES 1
1448 #define DYN_TREES    2
1449 /* The three kinds of block type */
1450
1451 #ifndef LIT_BUFSIZE
1452 #  ifdef SMALL_MEM
1453 #    define LIT_BUFSIZE  0x2000
1454 #  else
1455 #  ifdef MEDIUM_MEM
1456 #    define LIT_BUFSIZE  0x4000
1457 #  else
1458 #    define LIT_BUFSIZE  0x8000
1459 #  endif
1460 #  endif
1461 #endif
1462 #ifndef DIST_BUFSIZE
1463 #  define DIST_BUFSIZE  LIT_BUFSIZE
1464 #endif
1465 /* Sizes of match buffers for literals/lengths and distances.  There are
1466  * 4 reasons for limiting LIT_BUFSIZE to 64K:
1467  *   - frequencies can be kept in 16 bit counters
1468  *   - if compression is not successful for the first block, all input data is
1469  *     still in the window so we can still emit a stored block even when input
1470  *     comes from standard input.  (This can also be done for all blocks if
1471  *     LIT_BUFSIZE is not greater than 32K.)
1472  *   - if compression is not successful for a file smaller than 64K, we can
1473  *     even emit a stored file instead of a stored block (saving 5 bytes).
1474  *   - creating new Huffman trees less frequently may not provide fast
1475  *     adaptation to changes in the input data statistics. (Take for
1476  *     example a binary file with poorly compressible code followed by
1477  *     a highly compressible string table.) Smaller buffer sizes give
1478  *     fast adaptation but have of course the overhead of transmitting trees
1479  *     more frequently.
1480  *   - I can't count above 4
1481  * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
1482  * memory at the expense of compression). Some optimizations would be possible
1483  * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
1484  */
1485 #if LIT_BUFSIZE > INBUFSIZ
1486 #error cannot overlay l_buf and inbuf
1487 #endif
1488 #define REP_3_6      16
1489 /* repeat previous bit length 3-6 times (2 bits of repeat count) */
1490 #define REPZ_3_10    17
1491 /* repeat a zero length 3-10 times  (3 bits of repeat count) */
1492 #define REPZ_11_138  18
1493 /* repeat a zero length 11-138 times  (7 bits of repeat count) */
1494
1495 /* ===========================================================================
1496  * Local data
1497  */
1498
1499 /* Data structure describing a single value and its code string. */
1500 typedef struct ct_data {
1501         union {
1502                 ush freq;               /* frequency count */
1503                 ush code;               /* bit string */
1504         } fc;
1505         union {
1506                 ush dad;                /* father node in Huffman tree */
1507                 ush len;                /* length of bit string */
1508         } dl;
1509 } ct_data;
1510
1511 #define Freq fc.freq
1512 #define Code fc.code
1513 #define Dad  dl.dad
1514 #define Len  dl.len
1515
1516 #define HEAP_SIZE (2*L_CODES+1)
1517 /* maximum heap size */
1518
1519 static ct_data dyn_ltree[HEAP_SIZE];    /* literal and length tree */
1520 static ct_data dyn_dtree[2 * D_CODES + 1];      /* distance tree */
1521
1522 static ct_data static_ltree[L_CODES + 2];
1523
1524 /* The static literal tree. Since the bit lengths are imposed, there is no
1525  * need for the L_CODES extra codes used during heap construction. However
1526  * The codes 286 and 287 are needed to build a canonical tree (see ct_init
1527  * below).
1528  */
1529
1530 static ct_data static_dtree[D_CODES];
1531
1532 /* The static distance tree. (Actually a trivial tree since all codes use
1533  * 5 bits.)
1534  */
1535
1536 static ct_data bl_tree[2 * BL_CODES + 1];
1537
1538 /* Huffman tree for the bit lengths */
1539
1540 typedef struct tree_desc {
1541         ct_data *dyn_tree;      /* the dynamic tree */
1542         ct_data *static_tree;   /* corresponding static tree or NULL */
1543         const extra_bits_t *extra_bits; /* extra bits for each code or NULL */
1544         int extra_base;         /* base index for extra_bits */
1545         int elems;                      /* max number of elements in the tree */
1546         int max_length;         /* max bit length for the codes */
1547         int max_code;           /* largest code with non zero frequency */
1548 } tree_desc;
1549
1550 static tree_desc l_desc =
1551         { dyn_ltree, static_ltree, extra_lbits, LITERALS + 1, L_CODES,
1552         MAX_BITS, 0
1553 };
1554
1555 static tree_desc d_desc =
1556         { dyn_dtree, static_dtree, extra_dbits, 0, D_CODES, MAX_BITS, 0 };
1557
1558 static tree_desc bl_desc =
1559         { bl_tree, (ct_data *) 0, extra_blbits, 0, BL_CODES, MAX_BL_BITS,
1560         0
1561 };
1562
1563
1564 static ush bl_count[MAX_BITS + 1];
1565
1566 /* number of codes at each bit length for an optimal tree */
1567
1568 static const uch bl_order[BL_CODES]
1569 = { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
1570
1571 /* The lengths of the bit length codes are sent in order of decreasing
1572  * probability, to avoid transmitting the lengths for unused bit length codes.
1573  */
1574
1575 static int heap[2 * L_CODES + 1];       /* heap used to build the Huffman trees */
1576 static int heap_len;    /* number of elements in the heap */
1577 static int heap_max;    /* element of largest frequency */
1578
1579 /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
1580  * The same heap array is used to build all trees.
1581  */
1582
1583 static uch depth[2 * L_CODES + 1];
1584
1585 /* Depth of each subtree used as tie breaker for trees of equal frequency */
1586
1587 static uch length_code[MAX_MATCH - MIN_MATCH + 1];
1588
1589 /* length code for each normalized match length (0 == MIN_MATCH) */
1590
1591 static uch dist_code[512];
1592
1593 /* distance codes. The first 256 values correspond to the distances
1594  * 3 .. 258, the last 256 values correspond to the top 8 bits of
1595  * the 15 bit distances.
1596  */
1597
1598 static int base_length[LENGTH_CODES];
1599
1600 /* First normalized length for each code (0 = MIN_MATCH) */
1601
1602 static int base_dist[D_CODES];
1603
1604 /* First normalized distance for each code (0 = distance of 1) */
1605
1606 #define l_buf inbuf
1607 /* DECLARE(uch, l_buf, LIT_BUFSIZE);  buffer for literals or lengths */
1608
1609 /* DECLARE(ush, d_buf, DIST_BUFSIZE); buffer for distances */
1610
1611 static uch flag_buf[(LIT_BUFSIZE / 8)];
1612
1613 /* flag_buf is a bit array distinguishing literals from lengths in
1614  * l_buf, thus indicating the presence or absence of a distance.
1615  */
1616
1617 static unsigned last_lit;       /* running index in l_buf */
1618 static unsigned last_dist;      /* running index in d_buf */
1619 static unsigned last_flags;     /* running index in flag_buf */
1620 static uch flags;               /* current flags not yet saved in flag_buf */
1621 static uch flag_bit;    /* current bit used in flags */
1622
1623 /* bits are filled in flags starting at bit 0 (least significant).
1624  * Note: these flags are overkill in the current code since we don't
1625  * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1626  */
1627
1628 static ulg opt_len;             /* bit length of current block with optimal trees */
1629 static ulg static_len;  /* bit length of current block with static trees */
1630
1631 static ulg compressed_len;      /* total bit length of compressed file */
1632
1633
1634 static ush *file_type;  /* pointer to UNKNOWN, BINARY or ASCII */
1635 static int *file_method;        /* pointer to DEFLATE or STORE */
1636
1637 /* ===========================================================================
1638  * Local (static) routines in this file.
1639  */
1640
1641 static void init_block(void);
1642 static void pqdownheap(ct_data * tree, int k);
1643 static void gen_bitlen(tree_desc * desc);
1644 static void gen_codes(ct_data * tree, int max_code);
1645 static void build_tree(tree_desc * desc);
1646 static void scan_tree(ct_data * tree, int max_code);
1647 static void send_tree(ct_data * tree, int max_code);
1648 static int build_bl_tree(void);
1649 static void send_all_trees(int lcodes, int dcodes, int blcodes);
1650 static void compress_block(ct_data * ltree, ct_data * dtree);
1651 static void set_file_type(void);
1652
1653
1654 #ifndef DEBUG
1655 #  define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
1656    /* Send a code of the given tree. c and tree must not have side effects */
1657
1658 #else                                                   /* DEBUG */
1659 #  define send_code(c, tree) \
1660      { if (verbose>1) fprintf(stderr,"\ncd %3d ",(c)); \
1661        send_bits(tree[c].Code, tree[c].Len); }
1662 #endif
1663
1664 #define d_code(dist) \
1665    ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
1666 /* Mapping from a distance to a distance code. dist is the distance - 1 and
1667  * must not have side effects. dist_code[256] and dist_code[257] are never
1668  * used.
1669  */
1670
1671 /* the arguments must not have side effects */
1672
1673 /* ===========================================================================
1674  * Allocate the match buffer, initialize the various tables and save the
1675  * location of the internal file attribute (ascii/binary) and method
1676  * (DEFLATE/STORE).
1677  */
1678 static void ct_init(ush * attr, int *methodp)
1679 {
1680         int n;                          /* iterates over tree elements */
1681         int bits;                       /* bit counter */
1682         int length;                     /* length value */
1683         int code;                       /* code value */
1684         int dist;                       /* distance index */
1685
1686         file_type = attr;
1687         file_method = methodp;
1688         compressed_len = 0L;
1689
1690         if (static_dtree[0].Len != 0)
1691                 return;                 /* ct_init already called */
1692
1693         /* Initialize the mapping length (0..255) -> length code (0..28) */
1694         length = 0;
1695         for (code = 0; code < LENGTH_CODES - 1; code++) {
1696                 base_length[code] = length;
1697                 for (n = 0; n < (1 << extra_lbits[code]); n++) {
1698                         length_code[length++] = (uch) code;
1699                 }
1700         }
1701         Assert(length == 256, "ct_init: length != 256");
1702         /* Note that the length 255 (match length 258) can be represented
1703          * in two different ways: code 284 + 5 bits or code 285, so we
1704          * overwrite length_code[255] to use the best encoding:
1705          */
1706         length_code[length - 1] = (uch) code;
1707
1708         /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1709         dist = 0;
1710         for (code = 0; code < 16; code++) {
1711                 base_dist[code] = dist;
1712                 for (n = 0; n < (1 << extra_dbits[code]); n++) {
1713                         dist_code[dist++] = (uch) code;
1714                 }
1715         }
1716         Assert(dist == 256, "ct_init: dist != 256");
1717         dist >>= 7;                     /* from now on, all distances are divided by 128 */
1718         for (; code < D_CODES; code++) {
1719                 base_dist[code] = dist << 7;
1720                 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
1721                         dist_code[256 + dist++] = (uch) code;
1722                 }
1723         }
1724         Assert(dist == 256, "ct_init: 256+dist != 512");
1725
1726         /* Construct the codes of the static literal tree */
1727         for (bits = 0; bits <= MAX_BITS; bits++)
1728                 bl_count[bits] = 0;
1729         n = 0;
1730         while (n <= 143)
1731                 static_ltree[n++].Len = 8, bl_count[8]++;
1732         while (n <= 255)
1733                 static_ltree[n++].Len = 9, bl_count[9]++;
1734         while (n <= 279)
1735                 static_ltree[n++].Len = 7, bl_count[7]++;
1736         while (n <= 287)
1737                 static_ltree[n++].Len = 8, bl_count[8]++;
1738         /* Codes 286 and 287 do not exist, but we must include them in the
1739          * tree construction to get a canonical Huffman tree (longest code
1740          * all ones)
1741          */
1742         gen_codes((ct_data *) static_ltree, L_CODES + 1);
1743
1744         /* The static distance tree is trivial: */
1745         for (n = 0; n < D_CODES; n++) {
1746                 static_dtree[n].Len = 5;
1747                 static_dtree[n].Code = bi_reverse(n, 5);
1748         }
1749
1750         /* Initialize the first block of the first file: */
1751         init_block();
1752 }
1753
1754 /* ===========================================================================
1755  * Initialize a new block.
1756  */
1757 static void init_block()
1758 {
1759         int n;                          /* iterates over tree elements */
1760
1761         /* Initialize the trees. */
1762         for (n = 0; n < L_CODES; n++)
1763                 dyn_ltree[n].Freq = 0;
1764         for (n = 0; n < D_CODES; n++)
1765                 dyn_dtree[n].Freq = 0;
1766         for (n = 0; n < BL_CODES; n++)
1767                 bl_tree[n].Freq = 0;
1768
1769         dyn_ltree[END_BLOCK].Freq = 1;
1770         opt_len = static_len = 0L;
1771         last_lit = last_dist = last_flags = 0;
1772         flags = 0;
1773         flag_bit = 1;
1774 }
1775
1776 #define SMALLEST 1
1777 /* Index within the heap array of least frequent node in the Huffman tree */
1778
1779
1780 /* ===========================================================================
1781  * Remove the smallest element from the heap and recreate the heap with
1782  * one less element. Updates heap and heap_len.
1783  */
1784 #define pqremove(tree, top) \
1785 {\
1786     top = heap[SMALLEST]; \
1787     heap[SMALLEST] = heap[heap_len--]; \
1788     pqdownheap(tree, SMALLEST); \
1789 }
1790
1791 /* ===========================================================================
1792  * Compares to subtrees, using the tree depth as tie breaker when
1793  * the subtrees have equal frequency. This minimizes the worst case length.
1794  */
1795 #define smaller(tree, n, m) \
1796    (tree[n].Freq < tree[m].Freq || \
1797    (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
1798
1799 /* ===========================================================================
1800  * Restore the heap property by moving down the tree starting at node k,
1801  * exchanging a node with the smallest of its two sons if necessary, stopping
1802  * when the heap property is re-established (each father smaller than its
1803  * two sons).
1804  */
1805 static void pqdownheap(ct_data * tree, int k)
1806 {
1807         int v = heap[k];
1808         int j = k << 1;         /* left son of k */
1809
1810         while (j <= heap_len) {
1811                 /* Set j to the smallest of the two sons: */
1812                 if (j < heap_len && smaller(tree, heap[j + 1], heap[j]))
1813                         j++;
1814
1815                 /* Exit if v is smaller than both sons */
1816                 if (smaller(tree, v, heap[j]))
1817                         break;
1818
1819                 /* Exchange v with the smallest son */
1820                 heap[k] = heap[j];
1821                 k = j;
1822
1823                 /* And continue down the tree, setting j to the left son of k */
1824                 j <<= 1;
1825         }
1826         heap[k] = v;
1827 }
1828
1829 /* ===========================================================================
1830  * Compute the optimal bit lengths for a tree and update the total bit length
1831  * for the current block.
1832  * IN assertion: the fields freq and dad are set, heap[heap_max] and
1833  *    above are the tree nodes sorted by increasing frequency.
1834  * OUT assertions: the field len is set to the optimal bit length, the
1835  *     array bl_count contains the frequencies for each bit length.
1836  *     The length opt_len is updated; static_len is also updated if stree is
1837  *     not null.
1838  */
1839 static void gen_bitlen(tree_desc * desc)
1840 {
1841         ct_data *tree = desc->dyn_tree;
1842         const extra_bits_t *extra = desc->extra_bits;
1843         int base = desc->extra_base;
1844         int max_code = desc->max_code;
1845         int max_length = desc->max_length;
1846         ct_data *stree = desc->static_tree;
1847         int h;                          /* heap index */
1848         int n, m;                       /* iterate over the tree elements */
1849         int bits;                       /* bit length */
1850         int xbits;                      /* extra bits */
1851         ush f;                          /* frequency */
1852         int overflow = 0;       /* number of elements with bit length too large */
1853
1854         for (bits = 0; bits <= MAX_BITS; bits++)
1855                 bl_count[bits] = 0;
1856
1857         /* In a first pass, compute the optimal bit lengths (which may
1858          * overflow in the case of the bit length tree).
1859          */
1860         tree[heap[heap_max]].Len = 0;   /* root of the heap */
1861
1862         for (h = heap_max + 1; h < HEAP_SIZE; h++) {
1863                 n = heap[h];
1864                 bits = tree[tree[n].Dad].Len + 1;
1865                 if (bits > max_length)
1866                         bits = max_length, overflow++;
1867                 tree[n].Len = (ush) bits;
1868                 /* We overwrite tree[n].Dad which is no longer needed */
1869
1870                 if (n > max_code)
1871                         continue;       /* not a leaf node */
1872
1873                 bl_count[bits]++;
1874                 xbits = 0;
1875                 if (n >= base)
1876                         xbits = extra[n - base];
1877                 f = tree[n].Freq;
1878                 opt_len += (ulg) f *(bits + xbits);
1879
1880                 if (stree)
1881                         static_len += (ulg) f *(stree[n].Len + xbits);
1882         }
1883         if (overflow == 0)
1884                 return;
1885
1886         Trace((stderr, "\nbit length overflow\n"));
1887         /* This happens for example on obj2 and pic of the Calgary corpus */
1888
1889         /* Find the first bit length which could increase: */
1890         do {
1891                 bits = max_length - 1;
1892                 while (bl_count[bits] == 0)
1893                         bits--;
1894                 bl_count[bits]--;       /* move one leaf down the tree */
1895                 bl_count[bits + 1] += 2;        /* move one overflow item as its brother */
1896                 bl_count[max_length]--;
1897                 /* The brother of the overflow item also moves one step up,
1898                  * but this does not affect bl_count[max_length]
1899                  */
1900                 overflow -= 2;
1901         } while (overflow > 0);
1902
1903         /* Now recompute all bit lengths, scanning in increasing frequency.
1904          * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1905          * lengths instead of fixing only the wrong ones. This idea is taken
1906          * from 'ar' written by Haruhiko Okumura.)
1907          */
1908         for (bits = max_length; bits != 0; bits--) {
1909                 n = bl_count[bits];
1910                 while (n != 0) {
1911                         m = heap[--h];
1912                         if (m > max_code)
1913                                 continue;
1914                         if (tree[m].Len != (unsigned) bits) {
1915                                 Trace((stderr, "code %d bits %d->%d\n", m, tree[m].Len,
1916                                            bits));
1917                                 opt_len +=
1918                                         ((long) bits - (long) tree[m].Len) * (long) tree[m].Freq;
1919                                 tree[m].Len = (ush) bits;
1920                         }
1921                         n--;
1922                 }
1923         }
1924 }
1925
1926 /* ===========================================================================
1927  * Generate the codes for a given tree and bit counts (which need not be
1928  * optimal).
1929  * IN assertion: the array bl_count contains the bit length statistics for
1930  * the given tree and the field len is set for all tree elements.
1931  * OUT assertion: the field code is set for all tree elements of non
1932  *     zero code length.
1933  */
1934 static void gen_codes(ct_data * tree, int max_code)
1935 {
1936         ush next_code[MAX_BITS + 1];    /* next code value for each bit length */
1937         ush code = 0;           /* running code value */
1938         int bits;                       /* bit index */
1939         int n;                          /* code index */
1940
1941         /* The distribution counts are first used to generate the code values
1942          * without bit reversal.
1943          */
1944         for (bits = 1; bits <= MAX_BITS; bits++) {
1945                 next_code[bits] = code = (code + bl_count[bits - 1]) << 1;
1946         }
1947         /* Check that the bit counts in bl_count are consistent. The last code
1948          * must be all ones.
1949          */
1950         Assert(code + bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1951                    "inconsistent bit counts");
1952         Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
1953
1954         for (n = 0; n <= max_code; n++) {
1955                 int len = tree[n].Len;
1956
1957                 if (len == 0)
1958                         continue;
1959                 /* Now reverse the bits */
1960                 tree[n].Code = bi_reverse(next_code[len]++, len);
1961
1962                 Tracec(tree != static_ltree,
1963                            (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1964                                 (isgraph(n) ? n : ' '), len, tree[n].Code,
1965                                 next_code[len] - 1));
1966         }
1967 }
1968
1969 /* ===========================================================================
1970  * Construct one Huffman tree and assigns the code bit strings and lengths.
1971  * Update the total bit length for the current block.
1972  * IN assertion: the field freq is set for all tree elements.
1973  * OUT assertions: the fields len and code are set to the optimal bit length
1974  *     and corresponding code. The length opt_len is updated; static_len is
1975  *     also updated if stree is not null. The field max_code is set.
1976  */
1977 static void build_tree(tree_desc * desc)
1978 {
1979         ct_data *tree = desc->dyn_tree;
1980         ct_data *stree = desc->static_tree;
1981         int elems = desc->elems;
1982         int n, m;                       /* iterate over heap elements */
1983         int max_code = -1;      /* largest code with non zero frequency */
1984         int node = elems;       /* next internal node of the tree */
1985
1986         /* Construct the initial heap, with least frequent element in
1987          * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1988          * heap[0] is not used.
1989          */
1990         heap_len = 0, heap_max = HEAP_SIZE;
1991
1992         for (n = 0; n < elems; n++) {
1993                 if (tree[n].Freq != 0) {
1994                         heap[++heap_len] = max_code = n;
1995                         depth[n] = 0;
1996                 } else {
1997                         tree[n].Len = 0;
1998                 }
1999         }
2000
2001         /* The pkzip format requires that at least one distance code exists,
2002          * and that at least one bit should be sent even if there is only one
2003          * possible code. So to avoid special checks later on we force at least
2004          * two codes of non zero frequency.
2005          */
2006         while (heap_len < 2) {
2007                 int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
2008
2009                 tree[new].Freq = 1;
2010                 depth[new] = 0;
2011                 opt_len--;
2012                 if (stree)
2013                         static_len -= stree[new].Len;
2014                 /* new is 0 or 1 so it does not have extra bits */
2015         }
2016         desc->max_code = max_code;
2017
2018         /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
2019          * establish sub-heaps of increasing lengths:
2020          */
2021         for (n = heap_len / 2; n >= 1; n--)
2022                 pqdownheap(tree, n);
2023
2024         /* Construct the Huffman tree by repeatedly combining the least two
2025          * frequent nodes.
2026          */
2027         do {
2028                 pqremove(tree, n);      /* n = node of least frequency */
2029                 m = heap[SMALLEST];     /* m = node of next least frequency */
2030
2031                 heap[--heap_max] = n;   /* keep the nodes sorted by frequency */
2032                 heap[--heap_max] = m;
2033
2034                 /* Create a new node father of n and m */
2035                 tree[node].Freq = tree[n].Freq + tree[m].Freq;
2036                 depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
2037                 tree[n].Dad = tree[m].Dad = (ush) node;
2038 #ifdef DUMP_BL_TREE
2039                 if (tree == bl_tree) {
2040                         fprintf(stderr, "\nnode %d(%d), sons %d(%d) %d(%d)",
2041                                         node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
2042                 }
2043 #endif
2044                 /* and insert the new node in the heap */
2045                 heap[SMALLEST] = node++;
2046                 pqdownheap(tree, SMALLEST);
2047
2048         } while (heap_len >= 2);
2049
2050         heap[--heap_max] = heap[SMALLEST];
2051
2052         /* At this point, the fields freq and dad are set. We can now
2053          * generate the bit lengths.
2054          */
2055         gen_bitlen((tree_desc *) desc);
2056
2057         /* The field len is now set, we can generate the bit codes */
2058         gen_codes((ct_data *) tree, max_code);
2059 }
2060
2061 /* ===========================================================================
2062  * Scan a literal or distance tree to determine the frequencies of the codes
2063  * in the bit length tree. Updates opt_len to take into account the repeat
2064  * counts. (The contribution of the bit length codes will be added later
2065  * during the construction of bl_tree.)
2066  */
2067 static void scan_tree(ct_data * tree, int max_code)
2068 {
2069         int n;                          /* iterates over all tree elements */
2070         int prevlen = -1;       /* last emitted length */
2071         int curlen;                     /* length of current code */
2072         int nextlen = tree[0].Len;      /* length of next code */
2073         int count = 0;          /* repeat count of the current code */
2074         int max_count = 7;      /* max repeat count */
2075         int min_count = 4;      /* min repeat count */
2076
2077         if (nextlen == 0)
2078                 max_count = 138, min_count = 3;
2079         tree[max_code + 1].Len = (ush) 0xffff;  /* guard */
2080
2081         for (n = 0; n <= max_code; n++) {
2082                 curlen = nextlen;
2083                 nextlen = tree[n + 1].Len;
2084                 if (++count < max_count && curlen == nextlen) {
2085                         continue;
2086                 } else if (count < min_count) {
2087                         bl_tree[curlen].Freq += count;
2088                 } else if (curlen != 0) {
2089                         if (curlen != prevlen)
2090                                 bl_tree[curlen].Freq++;
2091                         bl_tree[REP_3_6].Freq++;
2092                 } else if (count <= 10) {
2093                         bl_tree[REPZ_3_10].Freq++;
2094                 } else {
2095                         bl_tree[REPZ_11_138].Freq++;
2096                 }
2097                 count = 0;
2098                 prevlen = curlen;
2099                 if (nextlen == 0) {
2100                         max_count = 138, min_count = 3;
2101                 } else if (curlen == nextlen) {
2102                         max_count = 6, min_count = 3;
2103                 } else {
2104                         max_count = 7, min_count = 4;
2105                 }
2106         }
2107 }
2108
2109 /* ===========================================================================
2110  * Send a literal or distance tree in compressed form, using the codes in
2111  * bl_tree.
2112  */
2113 static void send_tree(ct_data * tree, int max_code)
2114 {
2115         int n;                          /* iterates over all tree elements */
2116         int prevlen = -1;       /* last emitted length */
2117         int curlen;                     /* length of current code */
2118         int nextlen = tree[0].Len;      /* length of next code */
2119         int count = 0;          /* repeat count of the current code */
2120         int max_count = 7;      /* max repeat count */
2121         int min_count = 4;      /* min repeat count */
2122
2123 /* tree[max_code+1].Len = -1; *//* guard already set */
2124         if (nextlen == 0)
2125                 max_count = 138, min_count = 3;
2126
2127         for (n = 0; n <= max_code; n++) {
2128                 curlen = nextlen;
2129                 nextlen = tree[n + 1].Len;
2130                 if (++count < max_count && curlen == nextlen) {
2131                         continue;
2132                 } else if (count < min_count) {
2133                         do {
2134                                 send_code(curlen, bl_tree);
2135                         } while (--count != 0);
2136
2137                 } else if (curlen != 0) {
2138                         if (curlen != prevlen) {
2139                                 send_code(curlen, bl_tree);
2140                                 count--;
2141                         }
2142                         Assert(count >= 3 && count <= 6, " 3_6?");
2143                         send_code(REP_3_6, bl_tree);
2144                         send_bits(count - 3, 2);
2145
2146                 } else if (count <= 10) {
2147                         send_code(REPZ_3_10, bl_tree);
2148                         send_bits(count - 3, 3);
2149
2150                 } else {
2151                         send_code(REPZ_11_138, bl_tree);
2152                         send_bits(count - 11, 7);
2153                 }
2154                 count = 0;
2155                 prevlen = curlen;
2156                 if (nextlen == 0) {
2157                         max_count = 138, min_count = 3;
2158                 } else if (curlen == nextlen) {
2159                         max_count = 6, min_count = 3;
2160                 } else {
2161                         max_count = 7, min_count = 4;
2162                 }
2163         }
2164 }
2165
2166 /* ===========================================================================
2167  * Construct the Huffman tree for the bit lengths and return the index in
2168  * bl_order of the last bit length code to send.
2169  */
2170 static const int build_bl_tree()
2171 {
2172         int max_blindex;        /* index of last bit length code of non zero freq */
2173
2174         /* Determine the bit length frequencies for literal and distance trees */
2175         scan_tree((ct_data *) dyn_ltree, l_desc.max_code);
2176         scan_tree((ct_data *) dyn_dtree, d_desc.max_code);
2177
2178         /* Build the bit length tree: */
2179         build_tree((tree_desc *) (&bl_desc));
2180         /* opt_len now includes the length of the tree representations, except
2181          * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
2182          */
2183
2184         /* Determine the number of bit length codes to send. The pkzip format
2185          * requires that at least 4 bit length codes be sent. (appnote.txt says
2186          * 3 but the actual value used is 4.)
2187          */
2188         for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
2189                 if (bl_tree[bl_order[max_blindex]].Len != 0)
2190                         break;
2191         }
2192         /* Update opt_len to include the bit length tree and counts */
2193         opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
2194         Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len, static_len));
2195
2196         return max_blindex;
2197 }
2198
2199 /* ===========================================================================
2200  * Send the header for a block using dynamic Huffman trees: the counts, the
2201  * lengths of the bit length codes, the literal tree and the distance tree.
2202  * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
2203  */
2204 static void send_all_trees(int lcodes, int dcodes, int blcodes)
2205 {
2206         int rank;                       /* index in bl_order */
2207
2208         Assert(lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
2209         Assert(lcodes <= L_CODES && dcodes <= D_CODES
2210                    && blcodes <= BL_CODES, "too many codes");
2211         Tracev((stderr, "\nbl counts: "));
2212         send_bits(lcodes - 257, 5);     /* not +255 as stated in appnote.txt */
2213         send_bits(dcodes - 1, 5);
2214         send_bits(blcodes - 4, 4);      /* not -3 as stated in appnote.txt */
2215         for (rank = 0; rank < blcodes; rank++) {
2216                 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
2217                 send_bits(bl_tree[bl_order[rank]].Len, 3);
2218         }
2219         Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
2220
2221         send_tree((ct_data *) dyn_ltree, lcodes - 1);   /* send the literal tree */
2222         Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
2223
2224         send_tree((ct_data *) dyn_dtree, dcodes - 1);   /* send the distance tree */
2225         Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
2226 }
2227
2228 /* ===========================================================================
2229  * Determine the best encoding for the current block: dynamic trees, static
2230  * trees or store, and output the encoded block to the zip file. This function
2231  * returns the total compressed length for the file so far.
2232  */
2233 static ulg flush_block(char *buf, ulg stored_len, int eof)
2234 {
2235         ulg opt_lenb, static_lenb;      /* opt_len and static_len in bytes */
2236         int max_blindex;        /* index of last bit length code of non zero freq */
2237
2238         flag_buf[last_flags] = flags;   /* Save the flags for the last 8 items */
2239
2240         /* Check if the file is ascii or binary */
2241         if (*file_type == (ush) UNKNOWN)
2242                 set_file_type();
2243
2244         /* Construct the literal and distance trees */
2245         build_tree((tree_desc *) (&l_desc));
2246         Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
2247
2248         build_tree((tree_desc *) (&d_desc));
2249         Tracev((stderr, "\ndist data: dyn %ld, stat %ld", opt_len, static_len));
2250         /* At this point, opt_len and static_len are the total bit lengths of
2251          * the compressed block data, excluding the tree representations.
2252          */
2253
2254         /* Build the bit length tree for the above two trees, and get the index
2255          * in bl_order of the last bit length code to send.
2256          */
2257         max_blindex = build_bl_tree();
2258
2259         /* Determine the best encoding. Compute first the block length in bytes */
2260         opt_lenb = (opt_len + 3 + 7) >> 3;
2261         static_lenb = (static_len + 3 + 7) >> 3;
2262
2263         Trace((stderr,
2264                    "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
2265                    opt_lenb, opt_len, static_lenb, static_len, stored_len,
2266                    last_lit, last_dist));
2267
2268         if (static_lenb <= opt_lenb)
2269                 opt_lenb = static_lenb;
2270
2271         /* If compression failed and this is the first and last block,
2272          * and if the zip file can be seeked (to rewrite the local header),
2273          * the whole file is transformed into a stored file:
2274          */
2275         if (stored_len <= opt_lenb && eof && compressed_len == 0L && seekable()) {
2276                 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
2277                 if (buf == (char *) 0)
2278                         error_msg("block vanished");
2279
2280                 copy_block(buf, (unsigned) stored_len, 0);      /* without header */
2281                 compressed_len = stored_len << 3;
2282                 *file_method = STORED;
2283
2284         } else if (stored_len + 4 <= opt_lenb && buf != (char *) 0) {
2285                 /* 4: two words for the lengths */
2286                 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
2287                  * Otherwise we can't have processed more than WSIZE input bytes since
2288                  * the last block flush, because compression would have been
2289                  * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
2290                  * transform a block into a stored block.
2291                  */
2292                 send_bits((STORED_BLOCK << 1) + eof, 3);        /* send block type */
2293                 compressed_len = (compressed_len + 3 + 7) & ~7L;
2294                 compressed_len += (stored_len + 4) << 3;
2295
2296                 copy_block(buf, (unsigned) stored_len, 1);      /* with header */
2297
2298         } else if (static_lenb == opt_lenb) {
2299                 send_bits((STATIC_TREES << 1) + eof, 3);
2300                 compress_block((ct_data *) static_ltree, (ct_data *) static_dtree);
2301                 compressed_len += 3 + static_len;
2302         } else {
2303                 send_bits((DYN_TREES << 1) + eof, 3);
2304                 send_all_trees(l_desc.max_code + 1, d_desc.max_code + 1,
2305                                            max_blindex + 1);
2306                 compress_block((ct_data *) dyn_ltree, (ct_data *) dyn_dtree);
2307                 compressed_len += 3 + opt_len;
2308         }
2309         Assert(compressed_len == bits_sent, "bad compressed size");
2310         init_block();
2311
2312         if (eof) {
2313                 bi_windup();
2314                 compressed_len += 7;    /* align on byte boundary */
2315         }
2316         Tracev((stderr, "\ncomprlen %lu(%lu) ", compressed_len >> 3,
2317                         compressed_len - 7 * eof));
2318
2319         return compressed_len >> 3;
2320 }
2321
2322 /* ===========================================================================
2323  * Save the match info and tally the frequency counts. Return true if
2324  * the current block must be flushed.
2325  */
2326 static int ct_tally(int dist, int lc)
2327 {
2328         l_buf[last_lit++] = (uch) lc;
2329         if (dist == 0) {
2330                 /* lc is the unmatched char */
2331                 dyn_ltree[lc].Freq++;
2332         } else {
2333                 /* Here, lc is the match length - MIN_MATCH */
2334                 dist--;                 /* dist = match distance - 1 */
2335                 Assert((ush) dist < (ush) MAX_DIST &&
2336                            (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH) &&
2337                            (ush) d_code(dist) < (ush) D_CODES, "ct_tally: bad match");
2338
2339                 dyn_ltree[length_code[lc] + LITERALS + 1].Freq++;
2340                 dyn_dtree[d_code(dist)].Freq++;
2341
2342                 d_buf[last_dist++] = (ush) dist;
2343                 flags |= flag_bit;
2344         }
2345         flag_bit <<= 1;
2346
2347         /* Output the flags if they fill a byte: */
2348         if ((last_lit & 7) == 0) {
2349                 flag_buf[last_flags++] = flags;
2350                 flags = 0, flag_bit = 1;
2351         }
2352         /* Try to guess if it is profitable to stop the current block here */
2353         if ((last_lit & 0xfff) == 0) {
2354                 /* Compute an upper bound for the compressed length */
2355                 ulg out_length = (ulg) last_lit * 8L;
2356                 ulg in_length = (ulg) strstart - block_start;
2357                 int dcode;
2358
2359                 for (dcode = 0; dcode < D_CODES; dcode++) {
2360                         out_length +=
2361                                 (ulg) dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
2362                 }
2363                 out_length >>= 3;
2364                 Trace((stderr,
2365                            "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
2366                            last_lit, last_dist, in_length, out_length,
2367                            100L - out_length * 100L / in_length));
2368                 if (last_dist < last_lit / 2 && out_length < in_length / 2)
2369                         return 1;
2370         }
2371         return (last_lit == LIT_BUFSIZE - 1 || last_dist == DIST_BUFSIZE);
2372         /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
2373          * on 16 bit machines and because stored blocks are restricted to
2374          * 64K-1 bytes.
2375          */
2376 }
2377
2378 /* ===========================================================================
2379  * Send the block data compressed using the given Huffman trees
2380  */
2381 static void compress_block(ct_data * ltree, ct_data * dtree)
2382 {
2383         unsigned dist;          /* distance of matched string */
2384         int lc;                         /* match length or unmatched char (if dist == 0) */
2385         unsigned lx = 0;        /* running index in l_buf */
2386         unsigned dx = 0;        /* running index in d_buf */
2387         unsigned fx = 0;        /* running index in flag_buf */
2388         uch flag = 0;           /* current flags */
2389         unsigned code;          /* the code to send */
2390         int extra;                      /* number of extra bits to send */
2391
2392         if (last_lit != 0)
2393                 do {
2394                         if ((lx & 7) == 0)
2395                                 flag = flag_buf[fx++];
2396                         lc = l_buf[lx++];
2397                         if ((flag & 1) == 0) {
2398                                 send_code(lc, ltree);   /* send a literal byte */
2399                                 Tracecv(isgraph(lc), (stderr, " '%c' ", lc));
2400                         } else {
2401                                 /* Here, lc is the match length - MIN_MATCH */
2402                                 code = length_code[lc];
2403                                 send_code(code + LITERALS + 1, ltree);  /* send the length code */
2404                                 extra = extra_lbits[code];
2405                                 if (extra != 0) {
2406                                         lc -= base_length[code];
2407                                         send_bits(lc, extra);   /* send the extra length bits */
2408                                 }
2409                                 dist = d_buf[dx++];
2410                                 /* Here, dist is the match distance - 1 */
2411                                 code = d_code(dist);
2412                                 Assert(code < D_CODES, "bad d_code");
2413
2414                                 send_code(code, dtree); /* send the distance code */
2415                                 extra = extra_dbits[code];
2416                                 if (extra != 0) {
2417                                         dist -= base_dist[code];
2418                                         send_bits(dist, extra); /* send the extra distance bits */
2419                                 }
2420                         }                       /* literal or match pair ? */
2421                         flag >>= 1;
2422                 } while (lx < last_lit);
2423
2424         send_code(END_BLOCK, ltree);
2425 }
2426
2427 /* ===========================================================================
2428  * Set the file type to ASCII or BINARY, using a crude approximation:
2429  * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise.
2430  * IN assertion: the fields freq of dyn_ltree are set and the total of all
2431  * frequencies does not exceed 64K (to fit in an int on 16 bit machines).
2432  */
2433 static void set_file_type()
2434 {
2435         int n = 0;
2436         unsigned ascii_freq = 0;
2437         unsigned bin_freq = 0;
2438
2439         while (n < 7)
2440                 bin_freq += dyn_ltree[n++].Freq;
2441         while (n < 128)
2442                 ascii_freq += dyn_ltree[n++].Freq;
2443         while (n < LITERALS)
2444                 bin_freq += dyn_ltree[n++].Freq;
2445         *file_type = bin_freq > (ascii_freq >> 2) ? BINARY : ASCII;
2446         if (*file_type == BINARY && translate_eol) {
2447                 error_msg("-l used on binary file");
2448         }
2449 }
2450
2451 /* zip.c -- compress files to the gzip or pkzip format
2452  * Copyright (C) 1992-1993 Jean-loup Gailly
2453  * This is free software; you can redistribute it and/or modify it under the
2454  * terms of the GNU General Public License, see the file COPYING.
2455  */
2456
2457
2458 static ulg crc;                 /* crc on uncompressed file data */
2459 static long header_bytes;       /* number of bytes in gzip header */
2460
2461 static void put_long(ulg n)
2462 {
2463         put_short((n) & 0xffff);
2464         put_short(((ulg) (n)) >> 16);
2465 }
2466
2467 /* put_header_byte is used for the compressed output
2468  * - for the initial 4 bytes that can't overflow the buffer.
2469  */
2470 #define put_header_byte(c) {outbuf[outcnt++]=(uch)(c);}
2471
2472 /* ===========================================================================
2473  * Deflate in to out.
2474  * IN assertions: the input and output buffers are cleared.
2475  *   The variables time_stamp and save_orig_name are initialized.
2476  */
2477 static int zip(int in, int out)
2478 {
2479         uch my_flags = 0;       /* general purpose bit flags */
2480         ush attr = 0;           /* ascii/binary flag */
2481         ush deflate_flags = 0;  /* pkzip -es, -en or -ex equivalent */
2482
2483         ifd = in;
2484         ofd = out;
2485         outcnt = 0;
2486
2487         /* Write the header to the gzip file. See algorithm.doc for the format */
2488
2489
2490         method = DEFLATED;
2491         put_header_byte(GZIP_MAGIC[0]); /* magic header */
2492         put_header_byte(GZIP_MAGIC[1]);
2493         put_header_byte(DEFLATED);      /* compression method */
2494
2495         put_header_byte(my_flags);      /* general flags */
2496         put_long(time_stamp);
2497
2498         /* Write deflated file to zip file */
2499         crc = updcrc(0, 0);
2500
2501         bi_init(out);
2502         ct_init(&attr, &method);
2503         lm_init(&deflate_flags);
2504
2505         put_byte((uch) deflate_flags);  /* extra flags */
2506         put_byte(OS_CODE);      /* OS identifier */
2507
2508         header_bytes = (long) outcnt;
2509
2510         (void) deflate();
2511
2512         /* Write the crc and uncompressed size */
2513         put_long(crc);
2514         put_long(isize);
2515         header_bytes += 2 * sizeof(long);
2516
2517         flush_outbuf();
2518         return OK;
2519 }
2520
2521
2522 /* ===========================================================================
2523  * Read a new buffer from the current input file, perform end-of-line
2524  * translation, and update the crc and input file size.
2525  * IN assertion: size >= 2 (for end-of-line translation)
2526  */
2527 static int file_read(char *buf, unsigned size)
2528 {
2529         unsigned len;
2530
2531         Assert(insize == 0, "inbuf not empty");
2532
2533         len = read(ifd, buf, size);
2534         if (len == (unsigned) (-1) || len == 0)
2535                 return (int) len;
2536
2537         crc = updcrc((uch *) buf, len);
2538         isize += (ulg) len;
2539         return (int) len;
2540 }
2541
2542 /* ===========================================================================
2543  * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
2544  * (used for the compressed data only)
2545  */
2546 static void flush_outbuf()
2547 {
2548         if (outcnt == 0)
2549                 return;
2550
2551         write_buf(ofd, (char *) outbuf, outcnt);
2552         outcnt = 0;
2553 }