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