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