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