blob: cdf22688924ebd9dfefddc1b4ac434dd39d4d56c [file] [log] [blame]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001/* vi: set sw=4 ts=4: */
Erik Andersen61677fe2000-04-13 01:18:56 +00002/*
3 * Gzip implementation for busybox
Eric Andersencc8ed391999-10-05 16:24:54 +00004 *
Erik Andersen61677fe2000-04-13 01:18:56 +00005 * Based on GNU gzip Copyright (C) 1992-1993 Jean-loup Gailly.
6 *
7 * Originally adjusted for busybox by Charles P. Wright <cpw@unix.asb.com>
8 * "this is a stripped down version of gzip I put into busybox, it does
9 * only standard in to standard out with -9 compression. It also requires
10 * the zcat module for some important functions."
11 *
12 * Adjusted further by Erik Andersen <andersen@lineo.com>, <andersee@debian.org>
13 * to support files as well as stdin/stdout, and to generally behave itself wrt
14 * command line handling.
15 *
16 * This program is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 * General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 *
Eric Andersencc8ed391999-10-05 16:24:54 +000030 */
Eric Andersencc8ed391999-10-05 16:24:54 +000031
Erik Andersen61677fe2000-04-13 01:18:56 +000032/* These defines are very important for BusyBox. Without these,
33 * huge chunks of ram are pre-allocated making the BusyBox bss
34 * size Freaking Huge(tm), which is a bad thing.*/
35#define SMALL_MEM
36#define DYN_ALLOC
37
Eric Andersencbe31da2001-02-20 06:14:08 +000038#include <stdlib.h>
Eric Andersencc8ed391999-10-05 16:24:54 +000039#include <stdio.h>
Erik Andersen61677fe2000-04-13 01:18:56 +000040#include <string.h>
Eric Andersened3ef502001-01-27 08:24:39 +000041#include <unistd.h>
Glenn L McGrathf58efb52001-03-28 05:35:16 +000042#include <errno.h>
Eric Andersen3073dfb2001-07-02 17:57:32 +000043#include <sys/types.h>
44#include <signal.h>
45#include <utime.h>
46#include <ctype.h>
47#include <sys/types.h>
48#include <unistd.h>
49#include <dirent.h>
50#include <fcntl.h>
51#include <time.h>
Eric Andersencbe31da2001-02-20 06:14:08 +000052#include "busybox.h"
Eric Andersencbe31da2001-02-20 06:14:08 +000053
Erik Andersen61677fe2000-04-13 01:18:56 +000054#define memzero(s, n) memset ((void *)(s), 0, (n))
Eric Andersencc8ed391999-10-05 16:24:54 +000055
56#ifndef RETSIGTYPE
57# define RETSIGTYPE void
58#endif
59
Erik Andersene49d5ec2000-02-08 19:58:47 +000060typedef unsigned char uch;
Eric Andersencc8ed391999-10-05 16:24:54 +000061typedef unsigned short ush;
Erik Andersene49d5ec2000-02-08 19:58:47 +000062typedef unsigned long ulg;
Eric Andersencc8ed391999-10-05 16:24:54 +000063
64/* Return codes from gzip */
65#define OK 0
66#define ERROR 1
67#define WARNING 2
68
69/* Compression methods (see algorithm.doc) */
Eric Andersen3073dfb2001-07-02 17:57:32 +000070/* Only STORED and DEFLATED are supported by this BusyBox module */
Eric Andersencc8ed391999-10-05 16:24:54 +000071#define STORED 0
Eric Andersencc8ed391999-10-05 16:24:54 +000072/* methods 4 to 7 reserved */
73#define DEFLATED 8
Glenn L McGrathf58efb52001-03-28 05:35:16 +000074static int method; /* compression method */
Eric Andersencc8ed391999-10-05 16:24:54 +000075
76/* To save memory for 16 bit systems, some arrays are overlaid between
77 * the various modules:
78 * deflate: prev+head window d_buf l_buf outbuf
79 * unlzw: tab_prefix tab_suffix stack inbuf outbuf
Eric Andersencc8ed391999-10-05 16:24:54 +000080 * For compression, input is done in window[]. For decompression, output
81 * is done in window except for unlzw.
82 */
83
84#ifndef INBUFSIZ
85# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +000086# define INBUFSIZ 0x2000 /* input buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000087# else
Erik Andersene49d5ec2000-02-08 19:58:47 +000088# define INBUFSIZ 0x8000 /* input buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000089# endif
90#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +000091#define INBUF_EXTRA 64 /* required by unlzw() */
Eric Andersencc8ed391999-10-05 16:24:54 +000092
93#ifndef OUTBUFSIZ
94# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +000095# define OUTBUFSIZ 8192 /* output buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000096# else
Erik Andersene49d5ec2000-02-08 19:58:47 +000097# define OUTBUFSIZ 16384 /* output buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000098# endif
99#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000100#define OUTBUF_EXTRA 2048 /* required by unlzw() */
Eric Andersencc8ed391999-10-05 16:24:54 +0000101
102#ifndef DIST_BUFSIZE
103# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000104# define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
Eric Andersencc8ed391999-10-05 16:24:54 +0000105# else
Erik Andersene49d5ec2000-02-08 19:58:47 +0000106# define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
Eric Andersencc8ed391999-10-05 16:24:54 +0000107# endif
108#endif
109
110#ifdef DYN_ALLOC
Eric Andersen3073dfb2001-07-02 17:57:32 +0000111# define DECLARE(type, array, size) static type * array
Eric Andersencc8ed391999-10-05 16:24:54 +0000112# define ALLOC(type, array, size) { \
Erik Andersen61677fe2000-04-13 01:18:56 +0000113 array = (type*)calloc((size_t)(((size)+1L)/2), 2*sizeof(type)); \
Mark Whitleyf57c9442000-12-07 19:56:48 +0000114 if (array == NULL) error_msg(memory_exhausted); \
Eric Andersencc8ed391999-10-05 16:24:54 +0000115 }
Erik Andersen61677fe2000-04-13 01:18:56 +0000116# define FREE(array) {if (array != NULL) free(array), array=NULL;}
Eric Andersencc8ed391999-10-05 16:24:54 +0000117#else
Eric Andersen3073dfb2001-07-02 17:57:32 +0000118# define DECLARE(type, array, size) static type array[size]
Eric Andersencc8ed391999-10-05 16:24:54 +0000119# define ALLOC(type, array, size)
120# define FREE(array)
121#endif
122
Eric Andersencc8ed391999-10-05 16:24:54 +0000123#define tab_suffix window
Eric Andersen3073dfb2001-07-02 17:57:32 +0000124#define tab_prefix prev /* hash link (see deflate.c) */
125#define head (prev+WSIZE) /* hash head (see deflate.c) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000126
Eric Andersen3073dfb2001-07-02 17:57:32 +0000127static long bytes_in; /* number of input bytes */
Eric Andersencc8ed391999-10-05 16:24:54 +0000128
129#define isize bytes_in
130/* for compatibility with old zip sources (to be cleaned) */
131
Erik Andersene49d5ec2000-02-08 19:58:47 +0000132typedef int file_t; /* Do not use stdio */
133
134#define NO_FILE (-1) /* in memory compression */
Eric Andersencc8ed391999-10-05 16:24:54 +0000135
136
Erik Andersene49d5ec2000-02-08 19:58:47 +0000137#define PACK_MAGIC "\037\036" /* Magic header for packed files */
138#define GZIP_MAGIC "\037\213" /* Magic header for gzip files, 1F 8B */
139#define OLD_GZIP_MAGIC "\037\236" /* Magic header for gzip 0.5 = freeze 1.x */
140#define LZH_MAGIC "\037\240" /* Magic header for SCO LZH Compress files */
141#define PKZIP_MAGIC "\120\113\003\004" /* Magic header for pkzip files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000142
143/* gzip flag byte */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000144#define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
145#define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
146#define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
147#define ORIG_NAME 0x08 /* bit 3 set: original file name present */
148#define COMMENT 0x10 /* bit 4 set: file comment present */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000149#define RESERVED 0xC0 /* bit 6,7: reserved */
Eric Andersencc8ed391999-10-05 16:24:54 +0000150
151/* internal file attribute */
152#define UNKNOWN 0xffff
153#define BINARY 0
154#define ASCII 1
155
156#ifndef WSIZE
Erik Andersene49d5ec2000-02-08 19:58:47 +0000157# define WSIZE 0x8000 /* window size--must be a power of two, and */
158#endif /* at least 32K for zip's deflate method */
Eric Andersencc8ed391999-10-05 16:24:54 +0000159
160#define MIN_MATCH 3
161#define MAX_MATCH 258
162/* The minimum and maximum match lengths */
163
164#define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
165/* Minimum amount of lookahead, except at the end of the input file.
166 * See deflate.c for comments about the MIN_MATCH+1.
167 */
168
169#define MAX_DIST (WSIZE-MIN_LOOKAHEAD)
170/* In order to simplify the code, particularly on 16 bit machines, match
171 * distances are limited to MAX_DIST instead of WSIZE.
172 */
173
Eric Andersen3073dfb2001-07-02 17:57:32 +0000174/* put_byte is used for the compressed output */
Eric Andersencc8ed391999-10-05 16:24:54 +0000175#define put_byte(c) {outbuf[outcnt++]=(uch)(c); if (outcnt==OUTBUFSIZ)\
176 flush_outbuf();}
Eric Andersencc8ed391999-10-05 16:24:54 +0000177
178/* Output a 16 bit value, lsb first */
179#define put_short(w) \
180{ if (outcnt < OUTBUFSIZ-2) { \
181 outbuf[outcnt++] = (uch) ((w) & 0xff); \
182 outbuf[outcnt++] = (uch) ((ush)(w) >> 8); \
183 } else { \
184 put_byte((uch)((w) & 0xff)); \
185 put_byte((uch)((ush)(w) >> 8)); \
186 } \
187}
188
189/* Output a 32 bit value to the bit stream, lsb first */
190#define put_long(n) { \
191 put_short((n) & 0xffff); \
192 put_short(((ulg)(n)) >> 16); \
193}
194
Erik Andersene49d5ec2000-02-08 19:58:47 +0000195#define seekable() 0 /* force sequential output */
196#define translate_eol 0 /* no option -a yet */
Eric Andersencc8ed391999-10-05 16:24:54 +0000197
Eric Andersencc8ed391999-10-05 16:24:54 +0000198/* Diagnostic functions */
199#ifdef DEBUG
Mark Whitleyf57c9442000-12-07 19:56:48 +0000200# define Assert(cond,msg) {if(!(cond)) error_msg(msg);}
Eric Andersencc8ed391999-10-05 16:24:54 +0000201# define Trace(x) fprintf x
202# define Tracev(x) {if (verbose) fprintf x ;}
203# define Tracevv(x) {if (verbose>1) fprintf x ;}
204# define Tracec(c,x) {if (verbose && (c)) fprintf x ;}
205# define Tracecv(c,x) {if (verbose>1 && (c)) fprintf x ;}
206#else
207# define Assert(cond,msg)
208# define Trace(x)
209# define Tracev(x)
210# define Tracevv(x)
211# define Tracec(c,x)
212# define Tracecv(c,x)
213#endif
214
215#define WARN(msg) {if (!quiet) fprintf msg ; \
216 if (exit_code == OK) exit_code = WARNING;}
217
Eric Andersen3073dfb2001-07-02 17:57:32 +0000218#ifndef MAX_PATH_LEN
219# define MAX_PATH_LEN 1024 /* max pathname length */
220#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000221
Eric Andersencc8ed391999-10-05 16:24:54 +0000222
Eric Andersencc8ed391999-10-05 16:24:54 +0000223
Eric Andersen3073dfb2001-07-02 17:57:32 +0000224 /* from zip.c: */
225static int zip (int in, int out);
226static int file_read (char *buf, unsigned size);
Eric Andersencc8ed391999-10-05 16:24:54 +0000227
Eric Andersen3073dfb2001-07-02 17:57:32 +0000228 /* from gzip.c */
229static RETSIGTYPE abort_gzip (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000230
Eric Andersen3073dfb2001-07-02 17:57:32 +0000231 /* from deflate.c */
232static void lm_init (ush * flags);
233static ulg deflate (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000234
Eric Andersen3073dfb2001-07-02 17:57:32 +0000235 /* from trees.c */
236static void ct_init (ush * attr, int *methodp);
237static int ct_tally (int dist, int lc);
238static ulg flush_block (char *buf, ulg stored_len, int eof);
Eric Andersencc8ed391999-10-05 16:24:54 +0000239
Eric Andersen3073dfb2001-07-02 17:57:32 +0000240 /* from bits.c */
241static void bi_init (file_t zipfile);
242static void send_bits (int value, int length);
243static unsigned bi_reverse (unsigned value, int length);
244static void bi_windup (void);
245static void copy_block (char *buf, unsigned len, int header);
246static int (*read_buf) (char *buf, unsigned size);
Eric Andersencc8ed391999-10-05 16:24:54 +0000247
Eric Andersen3073dfb2001-07-02 17:57:32 +0000248 /* from util.c: */
249static void flush_outbuf (void);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000250
Eric Andersencc8ed391999-10-05 16:24:54 +0000251/* lzw.h -- define the lzw functions.
252 * Copyright (C) 1992-1993 Jean-loup Gailly.
253 * This is free software; you can redistribute it and/or modify it under the
254 * terms of the GNU General Public License, see the file COPYING.
255 */
256
257#if !defined(OF) && defined(lint)
258# include "gzip.h"
259#endif
260
261#ifndef BITS
262# define BITS 16
263#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000264#define INIT_BITS 9 /* Initial number of bits per code */
Eric Andersencc8ed391999-10-05 16:24:54 +0000265
Erik Andersene49d5ec2000-02-08 19:58:47 +0000266#define BIT_MASK 0x1f /* Mask for 'number of compression bits' */
Eric Andersencc8ed391999-10-05 16:24:54 +0000267/* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
268 * It's a pity that old uncompress does not check bit 0x20. That makes
269 * extension of the format actually undesirable because old compress
270 * would just crash on the new format instead of giving a meaningful
271 * error message. It does check the number of bits, but it's more
272 * helpful to say "unsupported format, get a new version" than
273 * "can only handle 16 bits".
274 */
275
Eric Andersencc8ed391999-10-05 16:24:54 +0000276/* tailor.h -- target dependent definitions
277 * Copyright (C) 1992-1993 Jean-loup Gailly.
278 * This is free software; you can redistribute it and/or modify it under the
279 * terms of the GNU General Public License, see the file COPYING.
280 */
281
282/* The target dependent definitions should be defined here only.
283 * The target dependent functions should be defined in tailor.c.
284 */
285
Eric Andersencc8ed391999-10-05 16:24:54 +0000286
Eric Andersencc8ed391999-10-05 16:24:54 +0000287 /* Common defaults */
288
289#ifndef OS_CODE
Erik Andersene49d5ec2000-02-08 19:58:47 +0000290# define OS_CODE 0x03 /* assume Unix */
Eric Andersencc8ed391999-10-05 16:24:54 +0000291#endif
292
293#ifndef PATH_SEP
294# define PATH_SEP '/'
295#endif
296
Eric Andersencc8ed391999-10-05 16:24:54 +0000297#ifndef OPTIONS_VAR
298# define OPTIONS_VAR "GZIP"
299#endif
300
301#ifndef Z_SUFFIX
302# define Z_SUFFIX ".gz"
303#endif
304
305#ifdef MAX_EXT_CHARS
306# define MAX_SUFFIX MAX_EXT_CHARS
307#else
308# define MAX_SUFFIX 30
309#endif
310
Eric Andersen3073dfb2001-07-02 17:57:32 +0000311 /* global buffers */
Eric Andersencc8ed391999-10-05 16:24:54 +0000312
Eric Andersen3073dfb2001-07-02 17:57:32 +0000313DECLARE(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
314DECLARE(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
315DECLARE(ush, d_buf, DIST_BUFSIZE);
316DECLARE(uch, window, 2L * WSIZE);
317DECLARE(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +0000318
Eric Andersen3073dfb2001-07-02 17:57:32 +0000319static int crc_table_empty = 1;
Eric Andersencc8ed391999-10-05 16:24:54 +0000320
Eric Andersen3073dfb2001-07-02 17:57:32 +0000321static int foreground; /* set if program run in foreground */
322static int method = DEFLATED; /* compression method */
323static int exit_code = OK; /* program exit code */
324static int part_nb; /* number of parts in .gz file */
325static long time_stamp; /* original time stamp (modification time) */
326static long ifile_size; /* input file size, -1 for devices (debug only) */
327static char z_suffix[MAX_SUFFIX + 1]; /* default suffix (can be set with --suffix) */
328static int z_len; /* strlen(z_suffix) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000329
Eric Andersen3073dfb2001-07-02 17:57:32 +0000330static char ifname[MAX_PATH_LEN]; /* input file name */
331static char ofname[MAX_PATH_LEN]; /* output file name */
332static int ifd; /* input file descriptor */
333static int ofd; /* output file descriptor */
334static unsigned insize; /* valid bytes in inbuf */
335static unsigned outcnt; /* bytes in output buffer */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000336
337/* ========================================================================
338 * Signal and error handler.
339 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000340static void abort_gzip()
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000341{
342 exit(ERROR);
343}
344
345/* ===========================================================================
346 * Clear input and output buffers
347 */
348static void clear_bufs(void)
349{
350 outcnt = 0;
Eric Andersen3073dfb2001-07-02 17:57:32 +0000351 insize = 0;
352 bytes_in = 0L;
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000353}
354
355static void write_error_msg()
356{
357 fprintf(stderr, "\n");
358 perror("");
359 abort_gzip();
360}
361
362/* ===========================================================================
363 * Does the same as write(), but also handles partial pipe writes and checks
364 * for error return.
365 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000366static void write_buf(int fd, void *buf, unsigned cnt)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000367{
368 unsigned n;
369
370 while ((n = write(fd, buf, cnt)) != cnt) {
371 if (n == (unsigned) (-1)) {
372 write_error_msg();
373 }
374 cnt -= n;
375 buf = (void *) ((char *) buf + n);
376 }
377}
378
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000379/* ===========================================================================
380 * Run a set of bytes through the crc shift register. If s is a NULL
381 * pointer, then initialize the crc shift register contents instead.
382 * Return the current crc in either case.
383 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000384static ulg updcrc(uch *s, unsigned n)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000385{
386 static ulg crc = (ulg) 0xffffffffL; /* shift register contents */
387 register ulg c; /* temporary variable */
388 static unsigned long crc_32_tab[256];
389 if (crc_table_empty) {
390 unsigned long csr; /* crc shift register */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000391 unsigned long e=0; /* polynomial exclusive-or pattern */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000392 int i; /* counter for all possible eight bit values */
393 int k; /* byte being shifted into crc apparatus */
394
395 /* terms of polynomial defining this crc (except x^32): */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000396 static const int p[] = {0,1,2,4,5,7,8,10,11,12,16,22,23,26};
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000397
398 /* Make exclusive-or pattern from polynomial (0xedb88320) */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000399 for (i = 0; i < sizeof(p)/sizeof(int); i++)
400 e |= 1L << (31 - p[i]);
401
402 /* Compute and print table of CRC's, five per line */
403 crc_32_tab[0] = 0x00000000L;
404 for (i = 1; i < 256; i++) {
405 csr = i;
406 /* The idea to initialize the register with the byte instead of
407 * zero was stolen from Haruhiko Okumura's ar002
408 */
409 for (k = 8; k; k--)
410 csr = csr & 1 ? (csr >> 1) ^ e : csr >> 1;
411 crc_32_tab[i]=csr;
412 }
413 }
414
415 if (s == NULL) {
416 c = 0xffffffffL;
417 } else {
418 c = crc;
419 if (n)
420 do {
421 c = crc_32_tab[((int) c ^ (*s++)) & 0xff] ^ (c >> 8);
422 } while (--n);
423 }
424 crc = c;
425 return c ^ 0xffffffffL; /* (instead of ~c for 64-bit machines) */
426}
427
Eric Andersencc8ed391999-10-05 16:24:54 +0000428/* bits.c -- output variable-length bit strings
429 * Copyright (C) 1992-1993 Jean-loup Gailly
430 * This is free software; you can redistribute it and/or modify it under the
431 * terms of the GNU General Public License, see the file COPYING.
432 */
433
434
435/*
436 * PURPOSE
437 *
438 * Output variable-length bit strings. Compression can be done
439 * to a file or to memory. (The latter is not supported in this version.)
440 *
441 * DISCUSSION
442 *
443 * The PKZIP "deflate" file format interprets compressed file data
444 * as a sequence of bits. Multi-bit strings in the file may cross
445 * byte boundaries without restriction.
446 *
447 * The first bit of each byte is the low-order bit.
448 *
449 * The routines in this file allow a variable-length bit value to
450 * be output right-to-left (useful for literal values). For
451 * left-to-right output (useful for code strings from the tree routines),
452 * the bits must have been reversed first with bi_reverse().
453 *
454 * For in-memory compression, the compressed bit stream goes directly
455 * into the requested output buffer. The input data is read in blocks
456 * by the mem_read() function. The buffer is limited to 64K on 16 bit
457 * machines.
458 *
459 * INTERFACE
460 *
461 * void bi_init (FILE *zipfile)
462 * Initialize the bit string routines.
463 *
464 * void send_bits (int value, int length)
465 * Write out a bit string, taking the source bits right to
466 * left.
467 *
468 * int bi_reverse (int value, int length)
469 * Reverse the bits of a bit string, taking the source bits left to
470 * right and emitting them right to left.
471 *
472 * void bi_windup (void)
473 * Write out any remaining bits in an incomplete byte.
474 *
475 * void copy_block(char *buf, unsigned len, int header)
476 * Copy a stored block to the zip file, storing first the length and
477 * its one's complement if requested.
478 *
479 */
480
Eric Andersencc8ed391999-10-05 16:24:54 +0000481/* ===========================================================================
482 * Local data used by the "bit string" routines.
483 */
484
Eric Andersen3073dfb2001-07-02 17:57:32 +0000485static file_t zfile; /* output gzip file */
Eric Andersencc8ed391999-10-05 16:24:54 +0000486
Eric Andersen3073dfb2001-07-02 17:57:32 +0000487static unsigned short bi_buf;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000488
Eric Andersencc8ed391999-10-05 16:24:54 +0000489/* Output buffer. bits are inserted starting at the bottom (least significant
490 * bits).
491 */
492
493#define Buf_size (8 * 2*sizeof(char))
494/* Number of bits used within bi_buf. (bi_buf might be implemented on
495 * more than 16 bits on some systems.)
496 */
497
Eric Andersen3073dfb2001-07-02 17:57:32 +0000498static int bi_valid;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000499
Eric Andersencc8ed391999-10-05 16:24:54 +0000500/* Current input function. Set to mem_read for in-memory compression */
501
502#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000503ulg bits_sent; /* bit length of the compressed data */
Eric Andersencc8ed391999-10-05 16:24:54 +0000504#endif
505
506/* ===========================================================================
507 * Initialize the bit string routines.
508 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000509static void bi_init(file_t zipfile)
Eric Andersencc8ed391999-10-05 16:24:54 +0000510{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000511 zfile = zipfile;
512 bi_buf = 0;
513 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000514#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000515 bits_sent = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000516#endif
517
Erik Andersene49d5ec2000-02-08 19:58:47 +0000518 /* Set the defaults for file compression. They are set by memcompress
519 * for in-memory compression.
520 */
521 if (zfile != NO_FILE) {
522 read_buf = file_read;
523 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000524}
525
526/* ===========================================================================
527 * Send a value on a given number of bits.
528 * IN assertion: length <= 16 and value fits in length bits.
529 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000530static void send_bits(int value, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000531{
532#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000533 Tracev((stderr, " l %2d v %4x ", length, value));
534 Assert(length > 0 && length <= 15, "invalid length");
535 bits_sent += (ulg) length;
Eric Andersencc8ed391999-10-05 16:24:54 +0000536#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000537 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
538 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
539 * unused bits in value.
540 */
541 if (bi_valid > (int) Buf_size - length) {
542 bi_buf |= (value << bi_valid);
543 put_short(bi_buf);
544 bi_buf = (ush) value >> (Buf_size - bi_valid);
545 bi_valid += length - Buf_size;
546 } else {
547 bi_buf |= value << bi_valid;
548 bi_valid += length;
549 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000550}
551
552/* ===========================================================================
553 * Reverse the first len bits of a code, using straightforward code (a faster
554 * method would use a table)
555 * IN assertion: 1 <= len <= 15
556 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000557static unsigned bi_reverse(unsigned code, int len)
Eric Andersencc8ed391999-10-05 16:24:54 +0000558{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000559 register unsigned res = 0;
560
561 do {
562 res |= code & 1;
563 code >>= 1, res <<= 1;
564 } while (--len > 0);
565 return res >> 1;
Eric Andersencc8ed391999-10-05 16:24:54 +0000566}
567
568/* ===========================================================================
569 * Write out any remaining bits in an incomplete byte.
570 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000571static void bi_windup()
Eric Andersencc8ed391999-10-05 16:24:54 +0000572{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000573 if (bi_valid > 8) {
574 put_short(bi_buf);
575 } else if (bi_valid > 0) {
576 put_byte(bi_buf);
577 }
578 bi_buf = 0;
579 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000580#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000581 bits_sent = (bits_sent + 7) & ~7;
Eric Andersencc8ed391999-10-05 16:24:54 +0000582#endif
583}
584
585/* ===========================================================================
586 * Copy a stored block to the zip file, storing first the length and its
587 * one's complement if requested.
588 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000589static void copy_block(char *buf, unsigned len, int header)
Eric Andersencc8ed391999-10-05 16:24:54 +0000590{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000591 bi_windup(); /* align on byte boundary */
Eric Andersencc8ed391999-10-05 16:24:54 +0000592
Erik Andersene49d5ec2000-02-08 19:58:47 +0000593 if (header) {
594 put_short((ush) len);
595 put_short((ush) ~ len);
Eric Andersencc8ed391999-10-05 16:24:54 +0000596#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000597 bits_sent += 2 * 16;
Eric Andersencc8ed391999-10-05 16:24:54 +0000598#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000599 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000600#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000601 bits_sent += (ulg) len << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +0000602#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000603 while (len--) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000604 put_byte(*buf++);
605 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000606}
Erik Andersene49d5ec2000-02-08 19:58:47 +0000607
Eric Andersencc8ed391999-10-05 16:24:54 +0000608/* deflate.c -- compress data using the deflation algorithm
609 * Copyright (C) 1992-1993 Jean-loup Gailly
610 * This is free software; you can redistribute it and/or modify it under the
611 * terms of the GNU General Public License, see the file COPYING.
612 */
613
614/*
615 * PURPOSE
616 *
617 * Identify new text as repetitions of old text within a fixed-
618 * length sliding window trailing behind the new text.
619 *
620 * DISCUSSION
621 *
622 * The "deflation" process depends on being able to identify portions
623 * of the input text which are identical to earlier input (within a
624 * sliding window trailing behind the input currently being processed).
625 *
626 * The most straightforward technique turns out to be the fastest for
627 * most input files: try all possible matches and select the longest.
628 * The key feature of this algorithm is that insertions into the string
629 * dictionary are very simple and thus fast, and deletions are avoided
630 * completely. Insertions are performed at each input character, whereas
631 * string matches are performed only when the previous match ends. So it
632 * is preferable to spend more time in matches to allow very fast string
633 * insertions and avoid deletions. The matching algorithm for small
634 * strings is inspired from that of Rabin & Karp. A brute force approach
635 * is used to find longer strings when a small match has been found.
636 * A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
637 * (by Leonid Broukhis).
638 * A previous version of this file used a more sophisticated algorithm
639 * (by Fiala and Greene) which is guaranteed to run in linear amortized
640 * time, but has a larger average cost, uses more memory and is patented.
641 * However the F&G algorithm may be faster for some highly redundant
642 * files if the parameter max_chain_length (described below) is too large.
643 *
644 * ACKNOWLEDGEMENTS
645 *
646 * The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
647 * I found it in 'freeze' written by Leonid Broukhis.
648 * Thanks to many info-zippers for bug reports and testing.
649 *
650 * REFERENCES
651 *
652 * APPNOTE.TXT documentation file in PKZIP 1.93a distribution.
653 *
654 * A description of the Rabin and Karp algorithm is given in the book
655 * "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
656 *
657 * Fiala,E.R., and Greene,D.H.
658 * Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
659 *
660 * INTERFACE
661 *
662 * void lm_init (int pack_level, ush *flags)
663 * Initialize the "longest match" routines for a new file
664 *
665 * ulg deflate (void)
666 * Processes a new input file and return its compressed length. Sets
667 * the compressed length, crc, deflate flags and internal file
668 * attributes.
669 */
670
Eric Andersencc8ed391999-10-05 16:24:54 +0000671
Eric Andersencc8ed391999-10-05 16:24:54 +0000672/* ===========================================================================
673 * Configuration parameters
674 */
675
676/* Compile with MEDIUM_MEM to reduce the memory requirements or
677 * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
678 * entire input file can be held in memory (not possible on 16 bit systems).
679 * Warning: defining these symbols affects HASH_BITS (see below) and thus
680 * affects the compression ratio. The compressed output
681 * is still correct, and might even be smaller in some cases.
682 */
683
684#ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000685# define HASH_BITS 13 /* Number of bits used to hash strings */
Eric Andersencc8ed391999-10-05 16:24:54 +0000686#endif
687#ifdef MEDIUM_MEM
688# define HASH_BITS 14
689#endif
690#ifndef HASH_BITS
691# define HASH_BITS 15
692 /* For portability to 16 bit machines, do not use values above 15. */
693#endif
694
695/* To save space (see unlzw.c), we overlay prev+head with tab_prefix and
696 * window with tab_suffix. Check that we can do this:
697 */
698#if (WSIZE<<1) > (1<<BITS)
Eric Andersen3073dfb2001-07-02 17:57:32 +0000699# error cannot overlay window with tab_suffix and prev with tab_prefix0
Eric Andersencc8ed391999-10-05 16:24:54 +0000700#endif
701#if HASH_BITS > BITS-1
Eric Andersen3073dfb2001-07-02 17:57:32 +0000702# error cannot overlay head with tab_prefix1
Eric Andersencc8ed391999-10-05 16:24:54 +0000703#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000704#define HASH_SIZE (unsigned)(1<<HASH_BITS)
705#define HASH_MASK (HASH_SIZE-1)
706#define WMASK (WSIZE-1)
707/* HASH_SIZE and WSIZE must be powers of two */
Eric Andersencc8ed391999-10-05 16:24:54 +0000708#define NIL 0
709/* Tail of hash chains */
Eric Andersencc8ed391999-10-05 16:24:54 +0000710#define FAST 4
711#define SLOW 2
712/* speed options for the general purpose bit flag */
Eric Andersencc8ed391999-10-05 16:24:54 +0000713#ifndef TOO_FAR
714# define TOO_FAR 4096
715#endif
716/* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
Eric Andersencc8ed391999-10-05 16:24:54 +0000717/* ===========================================================================
718 * Local data used by the "longest match" routines.
719 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000720typedef ush Pos;
721typedef unsigned IPos;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000722
Eric Andersencc8ed391999-10-05 16:24:54 +0000723/* A Pos is an index in the character window. We use short instead of int to
724 * save space in the various tables. IPos is used only for parameter passing.
725 */
726
727/* DECLARE(uch, window, 2L*WSIZE); */
728/* Sliding window. Input bytes are read into the second half of the window,
729 * and move to the first half later to keep a dictionary of at least WSIZE
730 * bytes. With this organization, matches are limited to a distance of
731 * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
732 * performed with a length multiple of the block size. Also, it limits
733 * the window size to 64K, which is quite useful on MSDOS.
734 * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
735 * be less efficient).
736 */
737
738/* DECLARE(Pos, prev, WSIZE); */
739/* Link to older string with same hash index. To limit the size of this
740 * array to 64K, this link is maintained only for the last 32K strings.
741 * An index in this array is thus a window index modulo 32K.
742 */
743
744/* DECLARE(Pos, head, 1<<HASH_BITS); */
745/* Heads of the hash chains or NIL. */
746
Eric Andersen3073dfb2001-07-02 17:57:32 +0000747static const ulg window_size = (ulg) 2 * WSIZE;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000748
Eric Andersencc8ed391999-10-05 16:24:54 +0000749/* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
750 * input file length plus MIN_LOOKAHEAD.
751 */
752
Eric Andersen3073dfb2001-07-02 17:57:32 +0000753static long block_start;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000754
Eric Andersencc8ed391999-10-05 16:24:54 +0000755/* window position at the beginning of the current output block. Gets
756 * negative when the window is moved backwards.
757 */
758
Eric Andersen3073dfb2001-07-02 17:57:32 +0000759static unsigned ins_h; /* hash index of string to be inserted */
Eric Andersencc8ed391999-10-05 16:24:54 +0000760
761#define H_SHIFT ((HASH_BITS+MIN_MATCH-1)/MIN_MATCH)
762/* Number of bits by which ins_h and del_h must be shifted at each
763 * input step. It must be such that after MIN_MATCH steps, the oldest
764 * byte no longer takes part in the hash key, that is:
765 * H_SHIFT * MIN_MATCH >= HASH_BITS
766 */
767
Eric Andersen3073dfb2001-07-02 17:57:32 +0000768static unsigned int prev_length;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000769
Eric Andersencc8ed391999-10-05 16:24:54 +0000770/* Length of the best match at previous step. Matches not greater than this
771 * are discarded. This is used in the lazy match evaluation.
772 */
773
Eric Andersen3073dfb2001-07-02 17:57:32 +0000774static unsigned strstart; /* start of string to insert */
775static unsigned match_start; /* start of matching string */
776static int eofile; /* flag set at end of input file */
777static unsigned lookahead; /* number of valid bytes ahead in window */
Eric Andersencc8ed391999-10-05 16:24:54 +0000778
Eric Andersen3073dfb2001-07-02 17:57:32 +0000779static const unsigned max_chain_length=4096;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000780
Eric Andersencc8ed391999-10-05 16:24:54 +0000781/* To speed up deflation, hash chains are never searched beyond this length.
782 * A higher limit improves compression ratio but degrades the speed.
783 */
784
Eric Andersen3073dfb2001-07-02 17:57:32 +0000785static const unsigned int max_lazy_match=258;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000786
Eric Andersencc8ed391999-10-05 16:24:54 +0000787/* Attempt to find a better match only when the current match is strictly
788 * smaller than this value. This mechanism is used only for compression
789 * levels >= 4.
790 */
791#define max_insert_length max_lazy_match
792/* Insert new strings in the hash table only if the match length
793 * is not greater than this length. This saves time but degrades compression.
794 * max_insert_length is used only for compression levels <= 3.
795 */
796
Eric Andersen3073dfb2001-07-02 17:57:32 +0000797static const unsigned good_match=32;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000798
Eric Andersencc8ed391999-10-05 16:24:54 +0000799/* Use a faster search when the previous match is longer than this */
800
801
802/* Values for max_lazy_match, good_match and max_chain_length, depending on
803 * the desired pack level (0..9). The values given below have been tuned to
804 * exclude worst case performance for pathological files. Better values may be
805 * found for specific files.
806 */
807
Eric Andersen3073dfb2001-07-02 17:57:32 +0000808static const int nice_match=258; /* Stop searching when current match exceeds this */
Eric Andersencc8ed391999-10-05 16:24:54 +0000809
810/* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
811 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
812 * meaning.
813 */
814
815#define EQUAL 0
816/* result of memcmp for equal strings */
817
818/* ===========================================================================
819 * Prototypes for local functions.
820 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000821static void fill_window (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000822
Eric Andersen3073dfb2001-07-02 17:57:32 +0000823static int longest_match (IPos cur_match);
Eric Andersencc8ed391999-10-05 16:24:54 +0000824
825#ifdef DEBUG
Eric Andersen3073dfb2001-07-02 17:57:32 +0000826static void check_match (IPos start, IPos match, int length);
Eric Andersencc8ed391999-10-05 16:24:54 +0000827#endif
828
829/* ===========================================================================
830 * Update a hash value with the given input byte
831 * IN assertion: all calls to to UPDATE_HASH are made with consecutive
832 * input characters, so that a running hash key can be computed from the
833 * previous key instead of complete recalculation each time.
834 */
835#define UPDATE_HASH(h,c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
836
837/* ===========================================================================
838 * Insert string s in the dictionary and set match_head to the previous head
839 * of the hash chain (the most recent string with same hash key). Return
840 * the previous length of the hash chain.
841 * IN assertion: all calls to to INSERT_STRING are made with consecutive
842 * input characters and the first MIN_MATCH bytes of s are valid
843 * (except for the last MIN_MATCH-1 bytes of the input file).
844 */
845#define INSERT_STRING(s, match_head) \
846 (UPDATE_HASH(ins_h, window[(s) + MIN_MATCH-1]), \
847 prev[(s) & WMASK] = match_head = head[ins_h], \
848 head[ins_h] = (s))
849
850/* ===========================================================================
851 * Initialize the "longest match" routines for a new file
852 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000853static void lm_init(ush *flags)
Eric Andersencc8ed391999-10-05 16:24:54 +0000854{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000855 register unsigned j;
Eric Andersencc8ed391999-10-05 16:24:54 +0000856
Erik Andersene49d5ec2000-02-08 19:58:47 +0000857 /* Initialize the hash table. */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000858 memzero((char *) head, HASH_SIZE * sizeof(*head));
Erik Andersene49d5ec2000-02-08 19:58:47 +0000859 /* prev will be initialized on the fly */
Eric Andersencc8ed391999-10-05 16:24:54 +0000860
Erik Andersene49d5ec2000-02-08 19:58:47 +0000861 *flags |= SLOW;
862 /* ??? reduce max_chain_length for binary files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000863
Erik Andersene49d5ec2000-02-08 19:58:47 +0000864 strstart = 0;
865 block_start = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000866
Erik Andersene49d5ec2000-02-08 19:58:47 +0000867 lookahead = read_buf((char *) window,
868 sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
Eric Andersencc8ed391999-10-05 16:24:54 +0000869
Erik Andersene49d5ec2000-02-08 19:58:47 +0000870 if (lookahead == 0 || lookahead == (unsigned) EOF) {
871 eofile = 1, lookahead = 0;
872 return;
873 }
874 eofile = 0;
875 /* Make sure that we always have enough lookahead. This is important
876 * if input comes from a device such as a tty.
877 */
878 while (lookahead < MIN_LOOKAHEAD && !eofile)
879 fill_window();
Eric Andersencc8ed391999-10-05 16:24:54 +0000880
Erik Andersene49d5ec2000-02-08 19:58:47 +0000881 ins_h = 0;
882 for (j = 0; j < MIN_MATCH - 1; j++)
883 UPDATE_HASH(ins_h, window[j]);
884 /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
885 * not important since only literal bytes will be emitted.
886 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000887}
888
889/* ===========================================================================
890 * Set match_start to the longest match starting at the given string and
891 * return its length. Matches shorter or equal to prev_length are discarded,
892 * in which case the result is equal to prev_length and match_start is
893 * garbage.
894 * IN assertions: cur_match is the head of the hash chain for the current
895 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
896 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000897
Eric Andersencc8ed391999-10-05 16:24:54 +0000898/* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
899 * match.s. The code is functionally equivalent, so you can use the C version
900 * if desired.
901 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000902static int longest_match(IPos cur_match)
Eric Andersencc8ed391999-10-05 16:24:54 +0000903{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000904 unsigned chain_length = max_chain_length; /* max hash chain length */
905 register uch *scan = window + strstart; /* current string */
906 register uch *match; /* matched string */
907 register int len; /* length of current match */
908 int best_len = prev_length; /* best match length so far */
909 IPos limit =
910
911 strstart > (IPos) MAX_DIST ? strstart - (IPos) MAX_DIST : NIL;
912 /* Stop when cur_match becomes <= limit. To simplify the code,
913 * we prevent matches with the string of window index 0.
914 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000915
916/* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
917 * It is easy to get rid of this optimization if necessary.
918 */
919#if HASH_BITS < 8 || MAX_MATCH != 258
Eric Andersen3073dfb2001-07-02 17:57:32 +0000920# error Code too clever
Eric Andersencc8ed391999-10-05 16:24:54 +0000921#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000922 register uch *strend = window + strstart + MAX_MATCH;
923 register uch scan_end1 = scan[best_len - 1];
924 register uch scan_end = scan[best_len];
Eric Andersencc8ed391999-10-05 16:24:54 +0000925
Erik Andersene49d5ec2000-02-08 19:58:47 +0000926 /* Do not waste too much time if we already have a good match: */
927 if (prev_length >= good_match) {
928 chain_length >>= 2;
929 }
930 Assert(strstart <= window_size - MIN_LOOKAHEAD,
931 "insufficient lookahead");
Eric Andersencc8ed391999-10-05 16:24:54 +0000932
Erik Andersene49d5ec2000-02-08 19:58:47 +0000933 do {
934 Assert(cur_match < strstart, "no future");
935 match = window + cur_match;
Eric Andersencc8ed391999-10-05 16:24:54 +0000936
Erik Andersene49d5ec2000-02-08 19:58:47 +0000937 /* Skip to next match if the match length cannot increase
938 * or if the match length is less than 2:
939 */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000940 if (match[best_len] != scan_end ||
941 match[best_len - 1] != scan_end1 ||
942 *match != *scan || *++match != scan[1])
943 continue;
Eric Andersencc8ed391999-10-05 16:24:54 +0000944
Erik Andersene49d5ec2000-02-08 19:58:47 +0000945 /* The check at best_len-1 can be removed because it will be made
946 * again later. (This heuristic is not always a win.)
947 * It is not necessary to compare scan[2] and match[2] since they
948 * are always equal when the other bytes match, given that
949 * the hash keys are equal and that HASH_BITS >= 8.
950 */
951 scan += 2, match++;
Eric Andersencc8ed391999-10-05 16:24:54 +0000952
Erik Andersene49d5ec2000-02-08 19:58:47 +0000953 /* We check for insufficient lookahead only every 8th comparison;
954 * the 256th check will be made at strstart+258.
955 */
956 do {
957 } while (*++scan == *++match && *++scan == *++match &&
958 *++scan == *++match && *++scan == *++match &&
959 *++scan == *++match && *++scan == *++match &&
960 *++scan == *++match && *++scan == *++match &&
961 scan < strend);
Eric Andersencc8ed391999-10-05 16:24:54 +0000962
Erik Andersene49d5ec2000-02-08 19:58:47 +0000963 len = MAX_MATCH - (int) (strend - scan);
964 scan = strend - MAX_MATCH;
Eric Andersencc8ed391999-10-05 16:24:54 +0000965
Erik Andersene49d5ec2000-02-08 19:58:47 +0000966 if (len > best_len) {
967 match_start = cur_match;
968 best_len = len;
969 if (len >= nice_match)
970 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000971 scan_end1 = scan[best_len - 1];
972 scan_end = scan[best_len];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000973 }
974 } while ((cur_match = prev[cur_match & WMASK]) > limit
975 && --chain_length != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +0000976
Erik Andersene49d5ec2000-02-08 19:58:47 +0000977 return best_len;
Eric Andersencc8ed391999-10-05 16:24:54 +0000978}
Eric Andersencc8ed391999-10-05 16:24:54 +0000979
980#ifdef DEBUG
981/* ===========================================================================
982 * Check that the match at match_start is indeed a match.
983 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000984static void check_match(IPos start, IPos match, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000985{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000986 /* check that the match is indeed a match */
987 if (memcmp((char *) window + match,
988 (char *) window + start, length) != EQUAL) {
989 fprintf(stderr,
990 " start %d, match %d, length %d\n", start, match, length);
Matt Kraaidd19c692001-01-31 19:00:21 +0000991 error_msg("invalid match");
Erik Andersene49d5ec2000-02-08 19:58:47 +0000992 }
993 if (verbose > 1) {
994 fprintf(stderr, "\\[%d,%d]", start - match, length);
995 do {
996 putc(window[start++], stderr);
997 } while (--length != 0);
998 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000999}
1000#else
1001# define check_match(start, match, length)
1002#endif
1003
1004/* ===========================================================================
1005 * Fill the window when the lookahead becomes insufficient.
1006 * Updates strstart and lookahead, and sets eofile if end of input file.
1007 * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
1008 * OUT assertions: at least one byte has been read, or eofile is set;
1009 * file reads are performed for at least two bytes (required for the
1010 * translate_eol option).
1011 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001012static void fill_window()
Eric Andersencc8ed391999-10-05 16:24:54 +00001013{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001014 register unsigned n, m;
1015 unsigned more =
Eric Andersencc8ed391999-10-05 16:24:54 +00001016
Erik Andersene49d5ec2000-02-08 19:58:47 +00001017 (unsigned) (window_size - (ulg) lookahead - (ulg) strstart);
1018 /* Amount of free space at the end of the window. */
Eric Andersencc8ed391999-10-05 16:24:54 +00001019
Erik Andersene49d5ec2000-02-08 19:58:47 +00001020 /* If the window is almost full and there is insufficient lookahead,
1021 * move the upper half to the lower one to make room in the upper half.
1022 */
1023 if (more == (unsigned) EOF) {
1024 /* Very unlikely, but possible on 16 bit machine if strstart == 0
1025 * and lookahead == 1 (input done one byte at time)
1026 */
1027 more--;
1028 } else if (strstart >= WSIZE + MAX_DIST) {
1029 /* By the IN assertion, the window is not empty so we can't confuse
1030 * more == 0 with more == 64K on a 16 bit machine.
1031 */
1032 Assert(window_size == (ulg) 2 * WSIZE, "no sliding with BIG_MEM");
Eric Andersencc8ed391999-10-05 16:24:54 +00001033
Erik Andersene49d5ec2000-02-08 19:58:47 +00001034 memcpy((char *) window, (char *) window + WSIZE, (unsigned) WSIZE);
1035 match_start -= WSIZE;
1036 strstart -= WSIZE; /* we now have strstart >= MAX_DIST: */
Eric Andersencc8ed391999-10-05 16:24:54 +00001037
Erik Andersene49d5ec2000-02-08 19:58:47 +00001038 block_start -= (long) WSIZE;
1039
1040 for (n = 0; n < HASH_SIZE; n++) {
1041 m = head[n];
1042 head[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1043 }
1044 for (n = 0; n < WSIZE; n++) {
1045 m = prev[n];
1046 prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1047 /* If n is not on any hash chain, prev[n] is garbage but
1048 * its value will never be used.
1049 */
1050 }
1051 more += WSIZE;
1052 }
1053 /* At this point, more >= 2 */
1054 if (!eofile) {
1055 n = read_buf((char *) window + strstart + lookahead, more);
1056 if (n == 0 || n == (unsigned) EOF) {
1057 eofile = 1;
1058 } else {
1059 lookahead += n;
1060 }
1061 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001062}
1063
1064/* ===========================================================================
1065 * Flush the current block, with given end-of-file flag.
1066 * IN assertion: strstart is set to the end of the current match.
1067 */
1068#define FLUSH_BLOCK(eof) \
1069 flush_block(block_start >= 0L ? (char*)&window[(unsigned)block_start] : \
1070 (char*)NULL, (long)strstart - block_start, (eof))
1071
1072/* ===========================================================================
1073 * Same as above, but achieves better compression. We use a lazy
1074 * evaluation for matches: a match is finally adopted only if there is
1075 * no better match at the next window position.
1076 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001077static ulg deflate()
Eric Andersencc8ed391999-10-05 16:24:54 +00001078{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001079 IPos hash_head; /* head of hash chain */
1080 IPos prev_match; /* previous match */
1081 int flush; /* set if current block must be flushed */
1082 int match_available = 0; /* set if previous match exists */
1083 register unsigned match_length = MIN_MATCH - 1; /* length of best match */
1084
Erik Andersene49d5ec2000-02-08 19:58:47 +00001085 /* Process the input block. */
1086 while (lookahead != 0) {
1087 /* Insert the string window[strstart .. strstart+2] in the
1088 * dictionary, and set hash_head to the head of the hash chain:
1089 */
1090 INSERT_STRING(strstart, hash_head);
Eric Andersencc8ed391999-10-05 16:24:54 +00001091
Erik Andersene49d5ec2000-02-08 19:58:47 +00001092 /* Find the longest match, discarding those <= prev_length.
1093 */
1094 prev_length = match_length, prev_match = match_start;
1095 match_length = MIN_MATCH - 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001096
Erik Andersene49d5ec2000-02-08 19:58:47 +00001097 if (hash_head != NIL && prev_length < max_lazy_match &&
1098 strstart - hash_head <= MAX_DIST) {
1099 /* To simplify the code, we prevent matches with the string
1100 * of window index 0 (in particular we have to avoid a match
1101 * of the string with itself at the start of the input file).
1102 */
1103 match_length = longest_match(hash_head);
1104 /* longest_match() sets match_start */
1105 if (match_length > lookahead)
1106 match_length = lookahead;
Eric Andersencc8ed391999-10-05 16:24:54 +00001107
Erik Andersene49d5ec2000-02-08 19:58:47 +00001108 /* Ignore a length 3 match if it is too distant: */
1109 if (match_length == MIN_MATCH
1110 && strstart - match_start > TOO_FAR) {
1111 /* If prev_match is also MIN_MATCH, match_start is garbage
1112 * but we will ignore the current match anyway.
1113 */
1114 match_length--;
1115 }
1116 }
1117 /* If there was a match at the previous step and the current
1118 * match is not better, output the previous match:
1119 */
1120 if (prev_length >= MIN_MATCH && match_length <= prev_length) {
Eric Andersencc8ed391999-10-05 16:24:54 +00001121
Erik Andersene49d5ec2000-02-08 19:58:47 +00001122 check_match(strstart - 1, prev_match, prev_length);
Eric Andersencc8ed391999-10-05 16:24:54 +00001123
Erik Andersene49d5ec2000-02-08 19:58:47 +00001124 flush =
1125 ct_tally(strstart - 1 - prev_match,
1126 prev_length - MIN_MATCH);
Eric Andersencc8ed391999-10-05 16:24:54 +00001127
Erik Andersene49d5ec2000-02-08 19:58:47 +00001128 /* Insert in hash table all strings up to the end of the match.
1129 * strstart-1 and strstart are already inserted.
1130 */
1131 lookahead -= prev_length - 1;
1132 prev_length -= 2;
1133 do {
1134 strstart++;
1135 INSERT_STRING(strstart, hash_head);
1136 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1137 * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1138 * these bytes are garbage, but it does not matter since the
1139 * next lookahead bytes will always be emitted as literals.
1140 */
1141 } while (--prev_length != 0);
1142 match_available = 0;
1143 match_length = MIN_MATCH - 1;
1144 strstart++;
1145 if (flush)
1146 FLUSH_BLOCK(0), block_start = strstart;
Eric Andersencc8ed391999-10-05 16:24:54 +00001147
Erik Andersene49d5ec2000-02-08 19:58:47 +00001148 } else if (match_available) {
1149 /* If there was no match at the previous position, output a
1150 * single literal. If there was a match but the current match
1151 * is longer, truncate the previous match to a single literal.
1152 */
1153 Tracevv((stderr, "%c", window[strstart - 1]));
1154 if (ct_tally(0, window[strstart - 1])) {
1155 FLUSH_BLOCK(0), block_start = strstart;
1156 }
1157 strstart++;
1158 lookahead--;
1159 } else {
1160 /* There is no previous match to compare with, wait for
1161 * the next step to decide.
1162 */
1163 match_available = 1;
1164 strstart++;
1165 lookahead--;
1166 }
1167 Assert(strstart <= isize && lookahead <= isize, "a bit too far");
Eric Andersencc8ed391999-10-05 16:24:54 +00001168
Erik Andersene49d5ec2000-02-08 19:58:47 +00001169 /* Make sure that we always have enough lookahead, except
1170 * at the end of the input file. We need MAX_MATCH bytes
1171 * for the next match, plus MIN_MATCH bytes to insert the
1172 * string following the next match.
1173 */
1174 while (lookahead < MIN_LOOKAHEAD && !eofile)
1175 fill_window();
1176 }
1177 if (match_available)
1178 ct_tally(0, window[strstart - 1]);
Eric Andersencc8ed391999-10-05 16:24:54 +00001179
Erik Andersene49d5ec2000-02-08 19:58:47 +00001180 return FLUSH_BLOCK(1); /* eof */
Eric Andersencc8ed391999-10-05 16:24:54 +00001181}
Erik Andersene49d5ec2000-02-08 19:58:47 +00001182
Eric Andersencc8ed391999-10-05 16:24:54 +00001183/* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
1184 * Copyright (C) 1992-1993 Jean-loup Gailly
1185 * The unzip code was written and put in the public domain by Mark Adler.
1186 * Portions of the lzw code are derived from the public domain 'compress'
1187 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
1188 * Ken Turkowski, Dave Mack and Peter Jannesen.
1189 *
1190 * See the license_msg below and the file COPYING for the software license.
1191 * See the file algorithm.doc for the compression algorithms and file formats.
1192 */
1193
1194/* Compress files with zip algorithm and 'compress' interface.
1195 * See usage() and help() functions below for all options.
1196 * Outputs:
1197 * file.gz: compressed file with same mode, owner, and utimes
1198 * or stdout with -c option or if stdin used as input.
1199 * If the output file name had to be truncated, the original name is kept
1200 * in the compressed file.
Eric Andersencc8ed391999-10-05 16:24:54 +00001201 */
1202
Eric Andersencc8ed391999-10-05 16:24:54 +00001203 /* configuration */
1204
Erik Andersene49d5ec2000-02-08 19:58:47 +00001205typedef struct dirent dir_type;
1206
Erik Andersen61677fe2000-04-13 01:18:56 +00001207typedef RETSIGTYPE(*sig_type) (int);
Eric Andersencc8ed391999-10-05 16:24:54 +00001208
Eric Andersencc8ed391999-10-05 16:24:54 +00001209
1210/* ======================================================================== */
1211// int main (argc, argv)
1212// int argc;
1213// char **argv;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001214int gzip_main(int argc, char **argv)
Eric Andersencc8ed391999-10-05 16:24:54 +00001215{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001216 int result;
1217 int inFileNum;
1218 int outFileNum;
1219 struct stat statBuf;
1220 char *delFileName;
1221 int tostdout = 0;
1222 int fromstdin = 0;
Eric Andersenea824fb2000-07-21 22:17:39 +00001223 int force = 0;
Matt Kraai53265542001-04-18 16:05:34 +00001224 int opt;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001225
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001226 while ((opt = getopt(argc, argv, "cf123456789dq")) != -1) {
Matt Kraai53265542001-04-18 16:05:34 +00001227 switch (opt) {
1228 case 'c':
Erik Andersene49d5ec2000-02-08 19:58:47 +00001229 tostdout = 1;
Matt Kraai53265542001-04-18 16:05:34 +00001230 break;
1231 case 'f':
1232 force = 1;
1233 break;
1234 /* Ignore 1-9 (compression level) options */
1235 case '1': case '2': case '3': case '4': case '5':
1236 case '6': case '7': case '8': case '9':
1237 break;
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001238 case 'q':
1239 break;
Glenn L McGrath528ef502001-04-11 03:45:37 +00001240#ifdef BB_GUNZIP
Matt Kraai53265542001-04-18 16:05:34 +00001241 case 'd':
1242 optind = 1;
1243 return gunzip_main(argc, argv);
Glenn L McGrath528ef502001-04-11 03:45:37 +00001244#endif
Matt Kraai53265542001-04-18 16:05:34 +00001245 default:
1246 show_usage();
Erik Andersene49d5ec2000-02-08 19:58:47 +00001247 }
1248 }
Matt Kraai53265542001-04-18 16:05:34 +00001249 if (optind == argc) {
Eric Andersenea824fb2000-07-21 22:17:39 +00001250 fromstdin = 1;
Eric Andersen5eb59122000-09-01 00:33:06 +00001251 tostdout = 1;
1252 }
Eric Andersenea824fb2000-07-21 22:17:39 +00001253
Eric Andersenea824fb2000-07-21 22:17:39 +00001254 if (isatty(fileno(stdout)) && tostdout==1 && force==0)
Matt Kraai53265542001-04-18 16:05:34 +00001255 error_msg_and_die( "compressed data not written to terminal. Use -f to force it.");
Erik Andersene49d5ec2000-02-08 19:58:47 +00001256
1257 foreground = signal(SIGINT, SIG_IGN) != SIG_IGN;
1258 if (foreground) {
1259 (void) signal(SIGINT, (sig_type) abort_gzip);
1260 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001261#ifdef SIGTERM
Erik Andersene49d5ec2000-02-08 19:58:47 +00001262 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
1263 (void) signal(SIGTERM, (sig_type) abort_gzip);
1264 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001265#endif
1266#ifdef SIGHUP
Erik Andersene49d5ec2000-02-08 19:58:47 +00001267 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
1268 (void) signal(SIGHUP, (sig_type) abort_gzip);
1269 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001270#endif
1271
Erik Andersene49d5ec2000-02-08 19:58:47 +00001272 strncpy(z_suffix, Z_SUFFIX, sizeof(z_suffix) - 1);
1273 z_len = strlen(z_suffix);
Eric Andersencc8ed391999-10-05 16:24:54 +00001274
Erik Andersene49d5ec2000-02-08 19:58:47 +00001275 /* Allocate all global buffers (for DYN_ALLOC option) */
1276 ALLOC(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
1277 ALLOC(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
1278 ALLOC(ush, d_buf, DIST_BUFSIZE);
1279 ALLOC(uch, window, 2L * WSIZE);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001280 ALLOC(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +00001281
Erik Andersene49d5ec2000-02-08 19:58:47 +00001282 if (fromstdin == 1) {
1283 strcpy(ofname, "stdin");
Eric Andersen96bcfd31999-11-12 01:30:18 +00001284
Erik Andersene49d5ec2000-02-08 19:58:47 +00001285 inFileNum = fileno(stdin);
1286 time_stamp = 0; /* time unknown by default */
1287 ifile_size = -1L; /* convention for unknown size */
1288 } else {
1289 /* Open up the input file */
Matt Kraai53265542001-04-18 16:05:34 +00001290 strncpy(ifname, argv[optind], MAX_PATH_LEN);
Eric Andersen96bcfd31999-11-12 01:30:18 +00001291
Matt Kraaia9819b22000-12-22 01:48:07 +00001292 /* Open input file */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001293 inFileNum = open(ifname, O_RDONLY);
Matt Kraaia9819b22000-12-22 01:48:07 +00001294 if (inFileNum < 0)
1295 perror_msg_and_die("%s", ifname);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001296 /* Get the time stamp on the input file. */
Matt Kraaia9819b22000-12-22 01:48:07 +00001297 if (stat(ifname, &statBuf) < 0)
1298 perror_msg_and_die("%s", ifname);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001299 time_stamp = statBuf.st_ctime;
1300 ifile_size = statBuf.st_size;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001301 }
Eric Andersen96bcfd31999-11-12 01:30:18 +00001302
1303
Erik Andersene49d5ec2000-02-08 19:58:47 +00001304 if (tostdout == 1) {
1305 /* And get to work */
1306 strcpy(ofname, "stdout");
1307 outFileNum = fileno(stdout);
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001308
Erik Andersene49d5ec2000-02-08 19:58:47 +00001309 clear_bufs(); /* clear input and output buffers */
1310 part_nb = 0;
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001311
Erik Andersene49d5ec2000-02-08 19:58:47 +00001312 /* Actually do the compression/decompression. */
1313 zip(inFileNum, outFileNum);
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001314
Erik Andersene49d5ec2000-02-08 19:58:47 +00001315 } else {
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001316
Erik Andersene49d5ec2000-02-08 19:58:47 +00001317 /* And get to work */
1318 strncpy(ofname, ifname, MAX_PATH_LEN - 4);
1319 strcat(ofname, ".gz");
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001320
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001321
Erik Andersene49d5ec2000-02-08 19:58:47 +00001322 /* Open output fille */
Erik Andersen4d1d0111999-12-17 18:44:15 +00001323#if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001324 outFileNum = open(ofname, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001325#else
Erik Andersene49d5ec2000-02-08 19:58:47 +00001326 outFileNum = open(ofname, O_RDWR | O_CREAT | O_EXCL);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001327#endif
Matt Kraaia9819b22000-12-22 01:48:07 +00001328 if (outFileNum < 0)
1329 perror_msg_and_die("%s", ofname);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001330 /* Set permissions on the file */
1331 fchmod(outFileNum, statBuf.st_mode);
1332
1333 clear_bufs(); /* clear input and output buffers */
1334 part_nb = 0;
1335
1336 /* Actually do the compression/decompression. */
1337 result = zip(inFileNum, outFileNum);
1338 close(outFileNum);
1339 close(inFileNum);
1340 /* Delete the original file */
1341 if (result == OK)
1342 delFileName = ifname;
1343 else
1344 delFileName = ofname;
1345
Matt Kraaia9819b22000-12-22 01:48:07 +00001346 if (unlink(delFileName) < 0)
1347 perror_msg_and_die("%s", delFileName);
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001348 }
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001349
Eric Andersenb6106152000-06-19 17:25:40 +00001350 return(exit_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001351}
1352
Eric Andersencc8ed391999-10-05 16:24:54 +00001353/* trees.c -- output deflated data using Huffman coding
1354 * Copyright (C) 1992-1993 Jean-loup Gailly
1355 * This is free software; you can redistribute it and/or modify it under the
1356 * terms of the GNU General Public License, see the file COPYING.
1357 */
1358
1359/*
1360 * PURPOSE
1361 *
1362 * Encode various sets of source values using variable-length
1363 * binary code trees.
1364 *
1365 * DISCUSSION
1366 *
1367 * The PKZIP "deflation" process uses several Huffman trees. The more
1368 * common source values are represented by shorter bit sequences.
1369 *
1370 * Each code tree is stored in the ZIP file in a compressed form
1371 * which is itself a Huffman encoding of the lengths of
1372 * all the code strings (in ascending order by source values).
1373 * The actual code strings are reconstructed from the lengths in
1374 * the UNZIP process, as described in the "application note"
1375 * (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
1376 *
1377 * REFERENCES
1378 *
1379 * Lynch, Thomas J.
1380 * Data Compression: Techniques and Applications, pp. 53-55.
1381 * Lifetime Learning Publications, 1985. ISBN 0-534-03418-7.
1382 *
1383 * Storer, James A.
1384 * Data Compression: Methods and Theory, pp. 49-50.
1385 * Computer Science Press, 1988. ISBN 0-7167-8156-5.
1386 *
1387 * Sedgewick, R.
1388 * Algorithms, p290.
1389 * Addison-Wesley, 1983. ISBN 0-201-06672-6.
1390 *
1391 * INTERFACE
1392 *
1393 * void ct_init (ush *attr, int *methodp)
1394 * Allocate the match buffer, initialize the various tables and save
1395 * the location of the internal file attribute (ascii/binary) and
1396 * method (DEFLATE/STORE)
1397 *
1398 * void ct_tally (int dist, int lc);
1399 * Save the match info and tally the frequency counts.
1400 *
1401 * long flush_block (char *buf, ulg stored_len, int eof)
1402 * Determine the best encoding for the current block: dynamic trees,
1403 * static trees or store, and output the encoded block to the zip
1404 * file. Returns the total compressed length for the file so far.
1405 *
1406 */
1407
Eric Andersencc8ed391999-10-05 16:24:54 +00001408/* ===========================================================================
1409 * Constants
1410 */
1411
1412#define MAX_BITS 15
1413/* All codes must not exceed MAX_BITS bits */
1414
1415#define MAX_BL_BITS 7
1416/* Bit length codes must not exceed MAX_BL_BITS bits */
1417
1418#define LENGTH_CODES 29
1419/* number of length codes, not counting the special END_BLOCK code */
1420
1421#define LITERALS 256
1422/* number of literal bytes 0..255 */
1423
1424#define END_BLOCK 256
1425/* end of block literal code */
1426
1427#define L_CODES (LITERALS+1+LENGTH_CODES)
1428/* number of Literal or Length codes, including the END_BLOCK code */
1429
1430#define D_CODES 30
1431/* number of distance codes */
1432
1433#define BL_CODES 19
1434/* number of codes used to transfer the bit lengths */
1435
1436
Eric Andersen3073dfb2001-07-02 17:57:32 +00001437static const int extra_lbits[LENGTH_CODES] /* extra bits for each length code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001438 = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
1439 4, 4, 5, 5, 5, 5, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001440
Eric Andersen3073dfb2001-07-02 17:57:32 +00001441static const int extra_dbits[D_CODES] /* extra bits for each distance code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001442 = { 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
1443 10, 10, 11, 11, 12, 12, 13, 13 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001444
Eric Andersen3073dfb2001-07-02 17:57:32 +00001445static const int extra_blbits[BL_CODES] /* extra bits for each bit length code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001446= { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 7 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001447
1448#define STORED_BLOCK 0
1449#define STATIC_TREES 1
1450#define DYN_TREES 2
1451/* The three kinds of block type */
1452
1453#ifndef LIT_BUFSIZE
1454# ifdef SMALL_MEM
1455# define LIT_BUFSIZE 0x2000
1456# else
1457# ifdef MEDIUM_MEM
1458# define LIT_BUFSIZE 0x4000
1459# else
1460# define LIT_BUFSIZE 0x8000
1461# endif
1462# endif
1463#endif
1464#ifndef DIST_BUFSIZE
1465# define DIST_BUFSIZE LIT_BUFSIZE
1466#endif
1467/* Sizes of match buffers for literals/lengths and distances. There are
1468 * 4 reasons for limiting LIT_BUFSIZE to 64K:
1469 * - frequencies can be kept in 16 bit counters
1470 * - if compression is not successful for the first block, all input data is
1471 * still in the window so we can still emit a stored block even when input
1472 * comes from standard input. (This can also be done for all blocks if
1473 * LIT_BUFSIZE is not greater than 32K.)
1474 * - if compression is not successful for a file smaller than 64K, we can
1475 * even emit a stored file instead of a stored block (saving 5 bytes).
1476 * - creating new Huffman trees less frequently may not provide fast
1477 * adaptation to changes in the input data statistics. (Take for
1478 * example a binary file with poorly compressible code followed by
1479 * a highly compressible string table.) Smaller buffer sizes give
1480 * fast adaptation but have of course the overhead of transmitting trees
1481 * more frequently.
1482 * - I can't count above 4
1483 * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
1484 * memory at the expense of compression). Some optimizations would be possible
1485 * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
1486 */
1487#if LIT_BUFSIZE > INBUFSIZ
Erik Andersene49d5ec2000-02-08 19:58:47 +00001488error cannot overlay l_buf and inbuf
Eric Andersencc8ed391999-10-05 16:24:54 +00001489#endif
Eric Andersencc8ed391999-10-05 16:24:54 +00001490#define REP_3_6 16
1491/* repeat previous bit length 3-6 times (2 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001492#define REPZ_3_10 17
1493/* repeat a zero length 3-10 times (3 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001494#define REPZ_11_138 18
Erik Andersene49d5ec2000-02-08 19:58:47 +00001495/* repeat a zero length 11-138 times (7 bits of repeat count) *//* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +00001496 * Local data
Erik Andersene49d5ec2000-02-08 19:58:47 +00001497 *//* Data structure describing a single value and its code string. */ typedef struct ct_data {
1498 union {
1499 ush freq; /* frequency count */
1500 ush code; /* bit string */
1501 } fc;
1502 union {
1503 ush dad; /* father node in Huffman tree */
1504 ush len; /* length of bit string */
1505 } dl;
Eric Andersencc8ed391999-10-05 16:24:54 +00001506} ct_data;
1507
1508#define Freq fc.freq
1509#define Code fc.code
1510#define Dad dl.dad
1511#define Len dl.len
1512
1513#define HEAP_SIZE (2*L_CODES+1)
1514/* maximum heap size */
1515
Eric Andersen3073dfb2001-07-02 17:57:32 +00001516static ct_data dyn_ltree[HEAP_SIZE]; /* literal and length tree */
1517static ct_data dyn_dtree[2 * D_CODES + 1]; /* distance tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001518
Eric Andersen3073dfb2001-07-02 17:57:32 +00001519static ct_data static_ltree[L_CODES + 2];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001520
Eric Andersencc8ed391999-10-05 16:24:54 +00001521/* The static literal tree. Since the bit lengths are imposed, there is no
1522 * need for the L_CODES extra codes used during heap construction. However
1523 * The codes 286 and 287 are needed to build a canonical tree (see ct_init
1524 * below).
1525 */
1526
Eric Andersen3073dfb2001-07-02 17:57:32 +00001527static ct_data static_dtree[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001528
Eric Andersencc8ed391999-10-05 16:24:54 +00001529/* The static distance tree. (Actually a trivial tree since all codes use
1530 * 5 bits.)
1531 */
1532
Eric Andersen3073dfb2001-07-02 17:57:32 +00001533static ct_data bl_tree[2 * BL_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001534
Eric Andersencc8ed391999-10-05 16:24:54 +00001535/* Huffman tree for the bit lengths */
1536
1537typedef struct tree_desc {
Eric Andersen3073dfb2001-07-02 17:57:32 +00001538 ct_data *dyn_tree; /* the dynamic tree */
1539 ct_data *static_tree; /* corresponding static tree or NULL */
1540 const int *extra_bits; /* extra bits for each code or NULL */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001541 int extra_base; /* base index for extra_bits */
1542 int elems; /* max number of elements in the tree */
1543 int max_length; /* max bit length for the codes */
1544 int max_code; /* largest code with non zero frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00001545} tree_desc;
1546
Eric Andersen3073dfb2001-07-02 17:57:32 +00001547static tree_desc l_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001548 { dyn_ltree, static_ltree, extra_lbits, LITERALS + 1, L_CODES,
1549 MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001550
Eric Andersen3073dfb2001-07-02 17:57:32 +00001551static tree_desc d_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001552 { dyn_dtree, static_dtree, extra_dbits, 0, D_CODES, MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001553
Eric Andersen3073dfb2001-07-02 17:57:32 +00001554static tree_desc bl_desc =
1555 { bl_tree, (ct_data *) 0, extra_blbits, 0, BL_CODES, MAX_BL_BITS,
Erik Andersene49d5ec2000-02-08 19:58:47 +00001556 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001557
1558
Eric Andersen3073dfb2001-07-02 17:57:32 +00001559static ush bl_count[MAX_BITS + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001560
Eric Andersencc8ed391999-10-05 16:24:54 +00001561/* number of codes at each bit length for an optimal tree */
1562
Eric Andersen3073dfb2001-07-02 17:57:32 +00001563static const uch bl_order[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001564= { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
1565
Eric Andersencc8ed391999-10-05 16:24:54 +00001566/* The lengths of the bit length codes are sent in order of decreasing
1567 * probability, to avoid transmitting the lengths for unused bit length codes.
1568 */
1569
Eric Andersen3073dfb2001-07-02 17:57:32 +00001570static int heap[2 * L_CODES + 1]; /* heap used to build the Huffman trees */
1571static int heap_len; /* number of elements in the heap */
1572static int heap_max; /* element of largest frequency */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001573
Eric Andersencc8ed391999-10-05 16:24:54 +00001574/* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
1575 * The same heap array is used to build all trees.
1576 */
1577
Eric Andersen3073dfb2001-07-02 17:57:32 +00001578static uch depth[2 * L_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001579
Eric Andersencc8ed391999-10-05 16:24:54 +00001580/* Depth of each subtree used as tie breaker for trees of equal frequency */
1581
Eric Andersen3073dfb2001-07-02 17:57:32 +00001582static uch length_code[MAX_MATCH - MIN_MATCH + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001583
Eric Andersencc8ed391999-10-05 16:24:54 +00001584/* length code for each normalized match length (0 == MIN_MATCH) */
1585
Eric Andersen3073dfb2001-07-02 17:57:32 +00001586static uch dist_code[512];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001587
Eric Andersencc8ed391999-10-05 16:24:54 +00001588/* distance codes. The first 256 values correspond to the distances
1589 * 3 .. 258, the last 256 values correspond to the top 8 bits of
1590 * the 15 bit distances.
1591 */
1592
Eric Andersen3073dfb2001-07-02 17:57:32 +00001593static int base_length[LENGTH_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001594
Eric Andersencc8ed391999-10-05 16:24:54 +00001595/* First normalized length for each code (0 = MIN_MATCH) */
1596
Eric Andersen3073dfb2001-07-02 17:57:32 +00001597static int base_dist[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001598
Eric Andersencc8ed391999-10-05 16:24:54 +00001599/* First normalized distance for each code (0 = distance of 1) */
1600
1601#define l_buf inbuf
1602/* DECLARE(uch, l_buf, LIT_BUFSIZE); buffer for literals or lengths */
1603
1604/* DECLARE(ush, d_buf, DIST_BUFSIZE); buffer for distances */
1605
Eric Andersen3073dfb2001-07-02 17:57:32 +00001606static uch flag_buf[(LIT_BUFSIZE / 8)];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001607
Eric Andersencc8ed391999-10-05 16:24:54 +00001608/* flag_buf is a bit array distinguishing literals from lengths in
1609 * l_buf, thus indicating the presence or absence of a distance.
1610 */
1611
Eric Andersen3073dfb2001-07-02 17:57:32 +00001612static unsigned last_lit; /* running index in l_buf */
1613static unsigned last_dist; /* running index in d_buf */
1614static unsigned last_flags; /* running index in flag_buf */
1615static uch flags; /* current flags not yet saved in flag_buf */
1616static uch flag_bit; /* current bit used in flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001617
Eric Andersencc8ed391999-10-05 16:24:54 +00001618/* bits are filled in flags starting at bit 0 (least significant).
1619 * Note: these flags are overkill in the current code since we don't
1620 * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1621 */
1622
Eric Andersen3073dfb2001-07-02 17:57:32 +00001623static ulg opt_len; /* bit length of current block with optimal trees */
1624static ulg static_len; /* bit length of current block with static trees */
Eric Andersencc8ed391999-10-05 16:24:54 +00001625
Eric Andersen3073dfb2001-07-02 17:57:32 +00001626static ulg compressed_len; /* total bit length of compressed file */
Eric Andersencc8ed391999-10-05 16:24:54 +00001627
Erik Andersene49d5ec2000-02-08 19:58:47 +00001628
Eric Andersen3073dfb2001-07-02 17:57:32 +00001629static ush *file_type; /* pointer to UNKNOWN, BINARY or ASCII */
1630static int *file_method; /* pointer to DEFLATE or STORE */
Eric Andersencc8ed391999-10-05 16:24:54 +00001631
1632/* ===========================================================================
1633 * Local (static) routines in this file.
1634 */
1635
Eric Andersen3073dfb2001-07-02 17:57:32 +00001636static void init_block (void);
1637static void pqdownheap (ct_data * tree, int k);
1638static void gen_bitlen (tree_desc * desc);
1639static void gen_codes (ct_data * tree, int max_code);
1640static void build_tree (tree_desc * desc);
1641static void scan_tree (ct_data * tree, int max_code);
1642static void send_tree (ct_data * tree, int max_code);
1643static int build_bl_tree (void);
1644static void send_all_trees (int lcodes, int dcodes, int blcodes);
1645static void compress_block (ct_data * ltree, ct_data * dtree);
1646static void set_file_type (void);
Eric Andersencc8ed391999-10-05 16:24:54 +00001647
1648
1649#ifndef DEBUG
1650# define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
1651 /* Send a code of the given tree. c and tree must not have side effects */
1652
Erik Andersene49d5ec2000-02-08 19:58:47 +00001653#else /* DEBUG */
Eric Andersencc8ed391999-10-05 16:24:54 +00001654# define send_code(c, tree) \
1655 { if (verbose>1) fprintf(stderr,"\ncd %3d ",(c)); \
1656 send_bits(tree[c].Code, tree[c].Len); }
1657#endif
1658
1659#define d_code(dist) \
1660 ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
1661/* Mapping from a distance to a distance code. dist is the distance - 1 and
1662 * must not have side effects. dist_code[256] and dist_code[257] are never
1663 * used.
1664 */
1665
Eric Andersencc8ed391999-10-05 16:24:54 +00001666/* the arguments must not have side effects */
1667
1668/* ===========================================================================
1669 * Allocate the match buffer, initialize the various tables and save the
1670 * location of the internal file attribute (ascii/binary) and method
1671 * (DEFLATE/STORE).
1672 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001673static void ct_init(ush *attr, int *methodp)
Eric Andersencc8ed391999-10-05 16:24:54 +00001674{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001675 int n; /* iterates over tree elements */
1676 int bits; /* bit counter */
1677 int length; /* length value */
1678 int code; /* code value */
1679 int dist; /* distance index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001680
Erik Andersene49d5ec2000-02-08 19:58:47 +00001681 file_type = attr;
1682 file_method = methodp;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001683 compressed_len = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +00001684
Erik Andersene49d5ec2000-02-08 19:58:47 +00001685 if (static_dtree[0].Len != 0)
1686 return; /* ct_init already called */
Eric Andersencc8ed391999-10-05 16:24:54 +00001687
Erik Andersene49d5ec2000-02-08 19:58:47 +00001688 /* Initialize the mapping length (0..255) -> length code (0..28) */
1689 length = 0;
1690 for (code = 0; code < LENGTH_CODES - 1; code++) {
1691 base_length[code] = length;
1692 for (n = 0; n < (1 << extra_lbits[code]); n++) {
1693 length_code[length++] = (uch) code;
1694 }
1695 }
1696 Assert(length == 256, "ct_init: length != 256");
1697 /* Note that the length 255 (match length 258) can be represented
1698 * in two different ways: code 284 + 5 bits or code 285, so we
1699 * overwrite length_code[255] to use the best encoding:
1700 */
1701 length_code[length - 1] = (uch) code;
Eric Andersencc8ed391999-10-05 16:24:54 +00001702
Erik Andersene49d5ec2000-02-08 19:58:47 +00001703 /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1704 dist = 0;
1705 for (code = 0; code < 16; code++) {
1706 base_dist[code] = dist;
1707 for (n = 0; n < (1 << extra_dbits[code]); n++) {
1708 dist_code[dist++] = (uch) code;
1709 }
1710 }
1711 Assert(dist == 256, "ct_init: dist != 256");
1712 dist >>= 7; /* from now on, all distances are divided by 128 */
1713 for (; code < D_CODES; code++) {
1714 base_dist[code] = dist << 7;
1715 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
1716 dist_code[256 + dist++] = (uch) code;
1717 }
1718 }
1719 Assert(dist == 256, "ct_init: 256+dist != 512");
Eric Andersencc8ed391999-10-05 16:24:54 +00001720
Erik Andersene49d5ec2000-02-08 19:58:47 +00001721 /* Construct the codes of the static literal tree */
1722 for (bits = 0; bits <= MAX_BITS; bits++)
1723 bl_count[bits] = 0;
1724 n = 0;
1725 while (n <= 143)
1726 static_ltree[n++].Len = 8, bl_count[8]++;
1727 while (n <= 255)
1728 static_ltree[n++].Len = 9, bl_count[9]++;
1729 while (n <= 279)
1730 static_ltree[n++].Len = 7, bl_count[7]++;
1731 while (n <= 287)
1732 static_ltree[n++].Len = 8, bl_count[8]++;
1733 /* Codes 286 and 287 do not exist, but we must include them in the
1734 * tree construction to get a canonical Huffman tree (longest code
1735 * all ones)
1736 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001737 gen_codes((ct_data *) static_ltree, L_CODES + 1);
Eric Andersencc8ed391999-10-05 16:24:54 +00001738
Erik Andersene49d5ec2000-02-08 19:58:47 +00001739 /* The static distance tree is trivial: */
1740 for (n = 0; n < D_CODES; n++) {
1741 static_dtree[n].Len = 5;
1742 static_dtree[n].Code = bi_reverse(n, 5);
1743 }
1744
1745 /* Initialize the first block of the first file: */
1746 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00001747}
1748
1749/* ===========================================================================
1750 * Initialize a new block.
1751 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001752static void init_block()
Eric Andersencc8ed391999-10-05 16:24:54 +00001753{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001754 int n; /* iterates over tree elements */
Eric Andersencc8ed391999-10-05 16:24:54 +00001755
Erik Andersene49d5ec2000-02-08 19:58:47 +00001756 /* Initialize the trees. */
1757 for (n = 0; n < L_CODES; n++)
1758 dyn_ltree[n].Freq = 0;
1759 for (n = 0; n < D_CODES; n++)
1760 dyn_dtree[n].Freq = 0;
1761 for (n = 0; n < BL_CODES; n++)
1762 bl_tree[n].Freq = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001763
Erik Andersene49d5ec2000-02-08 19:58:47 +00001764 dyn_ltree[END_BLOCK].Freq = 1;
1765 opt_len = static_len = 0L;
1766 last_lit = last_dist = last_flags = 0;
1767 flags = 0;
1768 flag_bit = 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001769}
1770
1771#define SMALLEST 1
1772/* Index within the heap array of least frequent node in the Huffman tree */
1773
1774
1775/* ===========================================================================
1776 * Remove the smallest element from the heap and recreate the heap with
1777 * one less element. Updates heap and heap_len.
1778 */
1779#define pqremove(tree, top) \
1780{\
1781 top = heap[SMALLEST]; \
1782 heap[SMALLEST] = heap[heap_len--]; \
1783 pqdownheap(tree, SMALLEST); \
1784}
1785
1786/* ===========================================================================
1787 * Compares to subtrees, using the tree depth as tie breaker when
1788 * the subtrees have equal frequency. This minimizes the worst case length.
1789 */
1790#define smaller(tree, n, m) \
1791 (tree[n].Freq < tree[m].Freq || \
1792 (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
1793
1794/* ===========================================================================
1795 * Restore the heap property by moving down the tree starting at node k,
1796 * exchanging a node with the smallest of its two sons if necessary, stopping
1797 * when the heap property is re-established (each father smaller than its
1798 * two sons).
1799 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001800static void pqdownheap(ct_data *tree, int k)
Eric Andersencc8ed391999-10-05 16:24:54 +00001801{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001802 int v = heap[k];
1803 int j = k << 1; /* left son of k */
Eric Andersencc8ed391999-10-05 16:24:54 +00001804
Erik Andersene49d5ec2000-02-08 19:58:47 +00001805 while (j <= heap_len) {
1806 /* Set j to the smallest of the two sons: */
1807 if (j < heap_len && smaller(tree, heap[j + 1], heap[j]))
1808 j++;
Eric Andersencc8ed391999-10-05 16:24:54 +00001809
Erik Andersene49d5ec2000-02-08 19:58:47 +00001810 /* Exit if v is smaller than both sons */
1811 if (smaller(tree, v, heap[j]))
1812 break;
Eric Andersencc8ed391999-10-05 16:24:54 +00001813
Erik Andersene49d5ec2000-02-08 19:58:47 +00001814 /* Exchange v with the smallest son */
1815 heap[k] = heap[j];
1816 k = j;
1817
1818 /* And continue down the tree, setting j to the left son of k */
1819 j <<= 1;
1820 }
1821 heap[k] = v;
Eric Andersencc8ed391999-10-05 16:24:54 +00001822}
1823
1824/* ===========================================================================
1825 * Compute the optimal bit lengths for a tree and update the total bit length
1826 * for the current block.
1827 * IN assertion: the fields freq and dad are set, heap[heap_max] and
1828 * above are the tree nodes sorted by increasing frequency.
1829 * OUT assertions: the field len is set to the optimal bit length, the
1830 * array bl_count contains the frequencies for each bit length.
1831 * The length opt_len is updated; static_len is also updated if stree is
1832 * not null.
1833 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001834static void gen_bitlen(tree_desc *desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001835{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001836 ct_data *tree = desc->dyn_tree;
1837 const int *extra = desc->extra_bits;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001838 int base = desc->extra_base;
1839 int max_code = desc->max_code;
1840 int max_length = desc->max_length;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001841 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001842 int h; /* heap index */
1843 int n, m; /* iterate over the tree elements */
1844 int bits; /* bit length */
1845 int xbits; /* extra bits */
1846 ush f; /* frequency */
1847 int overflow = 0; /* number of elements with bit length too large */
Eric Andersencc8ed391999-10-05 16:24:54 +00001848
Erik Andersene49d5ec2000-02-08 19:58:47 +00001849 for (bits = 0; bits <= MAX_BITS; bits++)
1850 bl_count[bits] = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001851
Erik Andersene49d5ec2000-02-08 19:58:47 +00001852 /* In a first pass, compute the optimal bit lengths (which may
1853 * overflow in the case of the bit length tree).
1854 */
1855 tree[heap[heap_max]].Len = 0; /* root of the heap */
Eric Andersencc8ed391999-10-05 16:24:54 +00001856
Erik Andersene49d5ec2000-02-08 19:58:47 +00001857 for (h = heap_max + 1; h < HEAP_SIZE; h++) {
1858 n = heap[h];
1859 bits = tree[tree[n].Dad].Len + 1;
1860 if (bits > max_length)
1861 bits = max_length, overflow++;
1862 tree[n].Len = (ush) bits;
1863 /* We overwrite tree[n].Dad which is no longer needed */
Eric Andersencc8ed391999-10-05 16:24:54 +00001864
Erik Andersene49d5ec2000-02-08 19:58:47 +00001865 if (n > max_code)
1866 continue; /* not a leaf node */
Eric Andersencc8ed391999-10-05 16:24:54 +00001867
Erik Andersene49d5ec2000-02-08 19:58:47 +00001868 bl_count[bits]++;
1869 xbits = 0;
1870 if (n >= base)
1871 xbits = extra[n - base];
1872 f = tree[n].Freq;
1873 opt_len += (ulg) f *(bits + xbits);
Eric Andersencc8ed391999-10-05 16:24:54 +00001874
Erik Andersene49d5ec2000-02-08 19:58:47 +00001875 if (stree)
1876 static_len += (ulg) f *(stree[n].Len + xbits);
1877 }
1878 if (overflow == 0)
1879 return;
Eric Andersencc8ed391999-10-05 16:24:54 +00001880
Erik Andersene49d5ec2000-02-08 19:58:47 +00001881 Trace((stderr, "\nbit length overflow\n"));
1882 /* This happens for example on obj2 and pic of the Calgary corpus */
Eric Andersencc8ed391999-10-05 16:24:54 +00001883
Erik Andersene49d5ec2000-02-08 19:58:47 +00001884 /* Find the first bit length which could increase: */
1885 do {
1886 bits = max_length - 1;
1887 while (bl_count[bits] == 0)
1888 bits--;
1889 bl_count[bits]--; /* move one leaf down the tree */
1890 bl_count[bits + 1] += 2; /* move one overflow item as its brother */
1891 bl_count[max_length]--;
1892 /* The brother of the overflow item also moves one step up,
1893 * but this does not affect bl_count[max_length]
1894 */
1895 overflow -= 2;
1896 } while (overflow > 0);
1897
1898 /* Now recompute all bit lengths, scanning in increasing frequency.
1899 * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1900 * lengths instead of fixing only the wrong ones. This idea is taken
1901 * from 'ar' written by Haruhiko Okumura.)
1902 */
1903 for (bits = max_length; bits != 0; bits--) {
1904 n = bl_count[bits];
1905 while (n != 0) {
1906 m = heap[--h];
1907 if (m > max_code)
1908 continue;
1909 if (tree[m].Len != (unsigned) bits) {
1910 Trace(
1911 (stderr, "code %d bits %d->%d\n", m, tree[m].Len,
1912 bits));
1913 opt_len +=
1914 ((long) bits -
1915 (long) tree[m].Len) * (long) tree[m].Freq;
1916 tree[m].Len = (ush) bits;
1917 }
1918 n--;
1919 }
1920 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001921}
1922
1923/* ===========================================================================
1924 * Generate the codes for a given tree and bit counts (which need not be
1925 * optimal).
1926 * IN assertion: the array bl_count contains the bit length statistics for
1927 * the given tree and the field len is set for all tree elements.
1928 * OUT assertion: the field code is set for all tree elements of non
1929 * zero code length.
1930 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001931static void gen_codes(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001932{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001933 ush next_code[MAX_BITS + 1]; /* next code value for each bit length */
1934 ush code = 0; /* running code value */
1935 int bits; /* bit index */
1936 int n; /* code index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001937
Erik Andersene49d5ec2000-02-08 19:58:47 +00001938 /* The distribution counts are first used to generate the code values
1939 * without bit reversal.
1940 */
1941 for (bits = 1; bits <= MAX_BITS; bits++) {
1942 next_code[bits] = code = (code + bl_count[bits - 1]) << 1;
1943 }
1944 /* Check that the bit counts in bl_count are consistent. The last code
1945 * must be all ones.
1946 */
1947 Assert(code + bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1948 "inconsistent bit counts");
1949 Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
Eric Andersencc8ed391999-10-05 16:24:54 +00001950
Erik Andersene49d5ec2000-02-08 19:58:47 +00001951 for (n = 0; n <= max_code; n++) {
1952 int len = tree[n].Len;
Eric Andersencc8ed391999-10-05 16:24:54 +00001953
Erik Andersene49d5ec2000-02-08 19:58:47 +00001954 if (len == 0)
1955 continue;
1956 /* Now reverse the bits */
1957 tree[n].Code = bi_reverse(next_code[len]++, len);
1958
1959 Tracec(tree != static_ltree,
1960 (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1961 (isgraph(n) ? n : ' '), len, tree[n].Code,
1962 next_code[len] - 1));
1963 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001964}
1965
1966/* ===========================================================================
1967 * Construct one Huffman tree and assigns the code bit strings and lengths.
1968 * Update the total bit length for the current block.
1969 * IN assertion: the field freq is set for all tree elements.
1970 * OUT assertions: the fields len and code are set to the optimal bit length
1971 * and corresponding code. The length opt_len is updated; static_len is
1972 * also updated if stree is not null. The field max_code is set.
1973 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001974static void build_tree(tree_desc *desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001975{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001976 ct_data *tree = desc->dyn_tree;
1977 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001978 int elems = desc->elems;
1979 int n, m; /* iterate over heap elements */
1980 int max_code = -1; /* largest code with non zero frequency */
1981 int node = elems; /* next internal node of the tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001982
Erik Andersene49d5ec2000-02-08 19:58:47 +00001983 /* Construct the initial heap, with least frequent element in
1984 * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1985 * heap[0] is not used.
1986 */
1987 heap_len = 0, heap_max = HEAP_SIZE;
Eric Andersencc8ed391999-10-05 16:24:54 +00001988
Erik Andersene49d5ec2000-02-08 19:58:47 +00001989 for (n = 0; n < elems; n++) {
1990 if (tree[n].Freq != 0) {
1991 heap[++heap_len] = max_code = n;
1992 depth[n] = 0;
1993 } else {
1994 tree[n].Len = 0;
1995 }
1996 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001997
Erik Andersene49d5ec2000-02-08 19:58:47 +00001998 /* The pkzip format requires that at least one distance code exists,
1999 * and that at least one bit should be sent even if there is only one
2000 * possible code. So to avoid special checks later on we force at least
2001 * two codes of non zero frequency.
2002 */
2003 while (heap_len < 2) {
2004 int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002005
Erik Andersene49d5ec2000-02-08 19:58:47 +00002006 tree[new].Freq = 1;
2007 depth[new] = 0;
2008 opt_len--;
2009 if (stree)
2010 static_len -= stree[new].Len;
2011 /* new is 0 or 1 so it does not have extra bits */
2012 }
2013 desc->max_code = max_code;
Eric Andersencc8ed391999-10-05 16:24:54 +00002014
Erik Andersene49d5ec2000-02-08 19:58:47 +00002015 /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
2016 * establish sub-heaps of increasing lengths:
2017 */
2018 for (n = heap_len / 2; n >= 1; n--)
2019 pqdownheap(tree, n);
Eric Andersencc8ed391999-10-05 16:24:54 +00002020
Erik Andersene49d5ec2000-02-08 19:58:47 +00002021 /* Construct the Huffman tree by repeatedly combining the least two
2022 * frequent nodes.
2023 */
2024 do {
2025 pqremove(tree, n); /* n = node of least frequency */
2026 m = heap[SMALLEST]; /* m = node of next least frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00002027
Erik Andersene49d5ec2000-02-08 19:58:47 +00002028 heap[--heap_max] = n; /* keep the nodes sorted by frequency */
2029 heap[--heap_max] = m;
2030
2031 /* Create a new node father of n and m */
2032 tree[node].Freq = tree[n].Freq + tree[m].Freq;
2033 depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
2034 tree[n].Dad = tree[m].Dad = (ush) node;
Eric Andersencc8ed391999-10-05 16:24:54 +00002035#ifdef DUMP_BL_TREE
Erik Andersene49d5ec2000-02-08 19:58:47 +00002036 if (tree == bl_tree) {
2037 fprintf(stderr, "\nnode %d(%d), sons %d(%d) %d(%d)",
2038 node, tree[node].Freq, n, tree[n].Freq, m,
2039 tree[m].Freq);
2040 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002041#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +00002042 /* and insert the new node in the heap */
2043 heap[SMALLEST] = node++;
2044 pqdownheap(tree, SMALLEST);
Eric Andersencc8ed391999-10-05 16:24:54 +00002045
Erik Andersene49d5ec2000-02-08 19:58:47 +00002046 } while (heap_len >= 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002047
Erik Andersene49d5ec2000-02-08 19:58:47 +00002048 heap[--heap_max] = heap[SMALLEST];
Eric Andersencc8ed391999-10-05 16:24:54 +00002049
Erik Andersene49d5ec2000-02-08 19:58:47 +00002050 /* At this point, the fields freq and dad are set. We can now
2051 * generate the bit lengths.
2052 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002053 gen_bitlen((tree_desc *) desc);
Eric Andersencc8ed391999-10-05 16:24:54 +00002054
Erik Andersene49d5ec2000-02-08 19:58:47 +00002055 /* The field len is now set, we can generate the bit codes */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002056 gen_codes((ct_data *) tree, max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002057}
2058
2059/* ===========================================================================
2060 * Scan a literal or distance tree to determine the frequencies of the codes
2061 * in the bit length tree. Updates opt_len to take into account the repeat
2062 * counts. (The contribution of the bit length codes will be added later
2063 * during the construction of bl_tree.)
2064 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002065static void scan_tree(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002066{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002067 int n; /* iterates over all tree elements */
2068 int prevlen = -1; /* last emitted length */
2069 int curlen; /* length of current code */
2070 int nextlen = tree[0].Len; /* length of next code */
2071 int count = 0; /* repeat count of the current code */
2072 int max_count = 7; /* max repeat count */
2073 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002074
Erik Andersene49d5ec2000-02-08 19:58:47 +00002075 if (nextlen == 0)
2076 max_count = 138, min_count = 3;
2077 tree[max_code + 1].Len = (ush) 0xffff; /* guard */
Eric Andersencc8ed391999-10-05 16:24:54 +00002078
Erik Andersene49d5ec2000-02-08 19:58:47 +00002079 for (n = 0; n <= max_code; n++) {
2080 curlen = nextlen;
2081 nextlen = tree[n + 1].Len;
2082 if (++count < max_count && curlen == nextlen) {
2083 continue;
2084 } else if (count < min_count) {
2085 bl_tree[curlen].Freq += count;
2086 } else if (curlen != 0) {
2087 if (curlen != prevlen)
2088 bl_tree[curlen].Freq++;
2089 bl_tree[REP_3_6].Freq++;
2090 } else if (count <= 10) {
2091 bl_tree[REPZ_3_10].Freq++;
2092 } else {
2093 bl_tree[REPZ_11_138].Freq++;
2094 }
2095 count = 0;
2096 prevlen = curlen;
2097 if (nextlen == 0) {
2098 max_count = 138, min_count = 3;
2099 } else if (curlen == nextlen) {
2100 max_count = 6, min_count = 3;
2101 } else {
2102 max_count = 7, min_count = 4;
2103 }
2104 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002105}
2106
2107/* ===========================================================================
2108 * Send a literal or distance tree in compressed form, using the codes in
2109 * bl_tree.
2110 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002111static void send_tree(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002112{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002113 int n; /* iterates over all tree elements */
2114 int prevlen = -1; /* last emitted length */
2115 int curlen; /* length of current code */
2116 int nextlen = tree[0].Len; /* length of next code */
2117 int count = 0; /* repeat count of the current code */
2118 int max_count = 7; /* max repeat count */
2119 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002120
Erik Andersene49d5ec2000-02-08 19:58:47 +00002121/* tree[max_code+1].Len = -1; *//* guard already set */
2122 if (nextlen == 0)
2123 max_count = 138, min_count = 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002124
Erik Andersene49d5ec2000-02-08 19:58:47 +00002125 for (n = 0; n <= max_code; n++) {
2126 curlen = nextlen;
2127 nextlen = tree[n + 1].Len;
2128 if (++count < max_count && curlen == nextlen) {
2129 continue;
2130 } else if (count < min_count) {
2131 do {
2132 send_code(curlen, bl_tree);
2133 } while (--count != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002134
Erik Andersene49d5ec2000-02-08 19:58:47 +00002135 } else if (curlen != 0) {
2136 if (curlen != prevlen) {
2137 send_code(curlen, bl_tree);
2138 count--;
2139 }
2140 Assert(count >= 3 && count <= 6, " 3_6?");
2141 send_code(REP_3_6, bl_tree);
2142 send_bits(count - 3, 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002143
Erik Andersene49d5ec2000-02-08 19:58:47 +00002144 } else if (count <= 10) {
2145 send_code(REPZ_3_10, bl_tree);
2146 send_bits(count - 3, 3);
Eric Andersencc8ed391999-10-05 16:24:54 +00002147
Erik Andersene49d5ec2000-02-08 19:58:47 +00002148 } else {
2149 send_code(REPZ_11_138, bl_tree);
2150 send_bits(count - 11, 7);
2151 }
2152 count = 0;
2153 prevlen = curlen;
2154 if (nextlen == 0) {
2155 max_count = 138, min_count = 3;
2156 } else if (curlen == nextlen) {
2157 max_count = 6, min_count = 3;
2158 } else {
2159 max_count = 7, min_count = 4;
2160 }
2161 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002162}
2163
2164/* ===========================================================================
2165 * Construct the Huffman tree for the bit lengths and return the index in
2166 * bl_order of the last bit length code to send.
2167 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002168static const int build_bl_tree()
Eric Andersencc8ed391999-10-05 16:24:54 +00002169{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002170 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002171
Erik Andersene49d5ec2000-02-08 19:58:47 +00002172 /* Determine the bit length frequencies for literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002173 scan_tree((ct_data *) dyn_ltree, l_desc.max_code);
2174 scan_tree((ct_data *) dyn_dtree, d_desc.max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002175
Erik Andersene49d5ec2000-02-08 19:58:47 +00002176 /* Build the bit length tree: */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002177 build_tree((tree_desc *) (&bl_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002178 /* opt_len now includes the length of the tree representations, except
2179 * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
2180 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002181
Erik Andersene49d5ec2000-02-08 19:58:47 +00002182 /* Determine the number of bit length codes to send. The pkzip format
2183 * requires that at least 4 bit length codes be sent. (appnote.txt says
2184 * 3 but the actual value used is 4.)
2185 */
2186 for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
2187 if (bl_tree[bl_order[max_blindex]].Len != 0)
2188 break;
2189 }
2190 /* Update opt_len to include the bit length tree and counts */
2191 opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
2192 Tracev(
2193 (stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len,
2194 static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002195
Erik Andersene49d5ec2000-02-08 19:58:47 +00002196 return max_blindex;
Eric Andersencc8ed391999-10-05 16:24:54 +00002197}
2198
2199/* ===========================================================================
2200 * Send the header for a block using dynamic Huffman trees: the counts, the
2201 * lengths of the bit length codes, the literal tree and the distance tree.
2202 * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
2203 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002204static void send_all_trees(int lcodes, int dcodes, int blcodes)
Eric Andersencc8ed391999-10-05 16:24:54 +00002205{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002206 int rank; /* index in bl_order */
Eric Andersencc8ed391999-10-05 16:24:54 +00002207
Erik Andersene49d5ec2000-02-08 19:58:47 +00002208 Assert(lcodes >= 257 && dcodes >= 1
2209 && blcodes >= 4, "not enough codes");
2210 Assert(lcodes <= L_CODES && dcodes <= D_CODES
2211 && blcodes <= BL_CODES, "too many codes");
2212 Tracev((stderr, "\nbl counts: "));
2213 send_bits(lcodes - 257, 5); /* not +255 as stated in appnote.txt */
2214 send_bits(dcodes - 1, 5);
2215 send_bits(blcodes - 4, 4); /* not -3 as stated in appnote.txt */
2216 for (rank = 0; rank < blcodes; rank++) {
2217 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
2218 send_bits(bl_tree[bl_order[rank]].Len, 3);
2219 }
2220 Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002221
Eric Andersen3073dfb2001-07-02 17:57:32 +00002222 send_tree((ct_data *) dyn_ltree, lcodes - 1); /* send the literal tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002223 Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002224
Eric Andersen3073dfb2001-07-02 17:57:32 +00002225 send_tree((ct_data *) dyn_dtree, dcodes - 1); /* send the distance tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002226 Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002227}
2228
2229/* ===========================================================================
2230 * Determine the best encoding for the current block: dynamic trees, static
2231 * trees or store, and output the encoded block to the zip file. This function
2232 * returns the total compressed length for the file so far.
2233 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002234static ulg flush_block(char *buf, ulg stored_len, int eof)
Eric Andersencc8ed391999-10-05 16:24:54 +00002235{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002236 ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
2237 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002238
Erik Andersene49d5ec2000-02-08 19:58:47 +00002239 flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
Eric Andersencc8ed391999-10-05 16:24:54 +00002240
Erik Andersene49d5ec2000-02-08 19:58:47 +00002241 /* Check if the file is ascii or binary */
2242 if (*file_type == (ush) UNKNOWN)
2243 set_file_type();
Eric Andersencc8ed391999-10-05 16:24:54 +00002244
Erik Andersene49d5ec2000-02-08 19:58:47 +00002245 /* Construct the literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002246 build_tree((tree_desc *) (&l_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002247 Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002248
Eric Andersen3073dfb2001-07-02 17:57:32 +00002249 build_tree((tree_desc *) (&d_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002250 Tracev(
2251 (stderr, "\ndist data: dyn %ld, stat %ld", opt_len,
2252 static_len));
2253 /* At this point, opt_len and static_len are the total bit lengths of
2254 * the compressed block data, excluding the tree representations.
2255 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002256
Erik Andersene49d5ec2000-02-08 19:58:47 +00002257 /* Build the bit length tree for the above two trees, and get the index
2258 * in bl_order of the last bit length code to send.
2259 */
2260 max_blindex = build_bl_tree();
Eric Andersencc8ed391999-10-05 16:24:54 +00002261
Erik Andersene49d5ec2000-02-08 19:58:47 +00002262 /* Determine the best encoding. Compute first the block length in bytes */
2263 opt_lenb = (opt_len + 3 + 7) >> 3;
2264 static_lenb = (static_len + 3 + 7) >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002265
Erik Andersene49d5ec2000-02-08 19:58:47 +00002266 Trace(
2267 (stderr,
2268 "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
2269 opt_lenb, opt_len, static_lenb, static_len, stored_len,
2270 last_lit, last_dist));
Eric Andersencc8ed391999-10-05 16:24:54 +00002271
Erik Andersene49d5ec2000-02-08 19:58:47 +00002272 if (static_lenb <= opt_lenb)
2273 opt_lenb = static_lenb;
Eric Andersencc8ed391999-10-05 16:24:54 +00002274
Erik Andersene49d5ec2000-02-08 19:58:47 +00002275 /* If compression failed and this is the first and last block,
2276 * and if the zip file can be seeked (to rewrite the local header),
2277 * the whole file is transformed into a stored file:
2278 */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002279 if (stored_len <= opt_lenb && eof && compressed_len == 0L
2280 && seekable()) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002281 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
2282 if (buf == (char *) 0)
Matt Kraaidd19c692001-01-31 19:00:21 +00002283 error_msg("block vanished");
Eric Andersencc8ed391999-10-05 16:24:54 +00002284
Erik Andersene49d5ec2000-02-08 19:58:47 +00002285 copy_block(buf, (unsigned) stored_len, 0); /* without header */
2286 compressed_len = stored_len << 3;
2287 *file_method = STORED;
Eric Andersencc8ed391999-10-05 16:24:54 +00002288
Erik Andersene49d5ec2000-02-08 19:58:47 +00002289 } else if (stored_len + 4 <= opt_lenb && buf != (char *) 0) {
2290 /* 4: two words for the lengths */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002291 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
2292 * Otherwise we can't have processed more than WSIZE input bytes since
2293 * the last block flush, because compression would have been
2294 * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
2295 * transform a block into a stored block.
2296 */
2297 send_bits((STORED_BLOCK << 1) + eof, 3); /* send block type */
2298 compressed_len = (compressed_len + 3 + 7) & ~7L;
2299 compressed_len += (stored_len + 4) << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002300
Erik Andersene49d5ec2000-02-08 19:58:47 +00002301 copy_block(buf, (unsigned) stored_len, 1); /* with header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002302
Erik Andersene49d5ec2000-02-08 19:58:47 +00002303 } else if (static_lenb == opt_lenb) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002304 send_bits((STATIC_TREES << 1) + eof, 3);
Eric Andersen3073dfb2001-07-02 17:57:32 +00002305 compress_block((ct_data *) static_ltree,
2306 (ct_data *) static_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002307 compressed_len += 3 + static_len;
2308 } else {
2309 send_bits((DYN_TREES << 1) + eof, 3);
2310 send_all_trees(l_desc.max_code + 1, d_desc.max_code + 1,
2311 max_blindex + 1);
Eric Andersen3073dfb2001-07-02 17:57:32 +00002312 compress_block((ct_data *) dyn_ltree,
2313 (ct_data *) dyn_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002314 compressed_len += 3 + opt_len;
2315 }
2316 Assert(compressed_len == bits_sent, "bad compressed size");
2317 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00002318
Erik Andersene49d5ec2000-02-08 19:58:47 +00002319 if (eof) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002320 bi_windup();
2321 compressed_len += 7; /* align on byte boundary */
2322 }
2323 Tracev((stderr, "\ncomprlen %lu(%lu) ", compressed_len >> 3,
2324 compressed_len - 7 * eof));
Eric Andersencc8ed391999-10-05 16:24:54 +00002325
Erik Andersene49d5ec2000-02-08 19:58:47 +00002326 return compressed_len >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002327}
2328
2329/* ===========================================================================
2330 * Save the match info and tally the frequency counts. Return true if
2331 * the current block must be flushed.
2332 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002333static int ct_tally(int dist, int lc)
Eric Andersencc8ed391999-10-05 16:24:54 +00002334{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002335 l_buf[last_lit++] = (uch) lc;
2336 if (dist == 0) {
2337 /* lc is the unmatched char */
2338 dyn_ltree[lc].Freq++;
2339 } else {
2340 /* Here, lc is the match length - MIN_MATCH */
2341 dist--; /* dist = match distance - 1 */
2342 Assert((ush) dist < (ush) MAX_DIST &&
2343 (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH) &&
2344 (ush) d_code(dist) < (ush) D_CODES, "ct_tally: bad match");
Eric Andersencc8ed391999-10-05 16:24:54 +00002345
Erik Andersene49d5ec2000-02-08 19:58:47 +00002346 dyn_ltree[length_code[lc] + LITERALS + 1].Freq++;
2347 dyn_dtree[d_code(dist)].Freq++;
Eric Andersencc8ed391999-10-05 16:24:54 +00002348
Erik Andersene49d5ec2000-02-08 19:58:47 +00002349 d_buf[last_dist++] = (ush) dist;
2350 flags |= flag_bit;
2351 }
2352 flag_bit <<= 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00002353
Erik Andersene49d5ec2000-02-08 19:58:47 +00002354 /* Output the flags if they fill a byte: */
2355 if ((last_lit & 7) == 0) {
2356 flag_buf[last_flags++] = flags;
2357 flags = 0, flag_bit = 1;
2358 }
2359 /* Try to guess if it is profitable to stop the current block here */
2360 if ((last_lit & 0xfff) == 0) {
2361 /* Compute an upper bound for the compressed length */
2362 ulg out_length = (ulg) last_lit * 8L;
2363 ulg in_length = (ulg) strstart - block_start;
2364 int dcode;
2365
2366 for (dcode = 0; dcode < D_CODES; dcode++) {
2367 out_length +=
2368 (ulg) dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
2369 }
2370 out_length >>= 3;
2371 Trace(
2372 (stderr,
2373 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
2374 last_lit, last_dist, in_length, out_length,
2375 100L - out_length * 100L / in_length));
2376 if (last_dist < last_lit / 2 && out_length < in_length / 2)
2377 return 1;
2378 }
2379 return (last_lit == LIT_BUFSIZE - 1 || last_dist == DIST_BUFSIZE);
2380 /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
2381 * on 16 bit machines and because stored blocks are restricted to
2382 * 64K-1 bytes.
2383 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002384}
2385
2386/* ===========================================================================
2387 * Send the block data compressed using the given Huffman trees
2388 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002389static void compress_block(ct_data *ltree, ct_data *dtree)
Eric Andersencc8ed391999-10-05 16:24:54 +00002390{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002391 unsigned dist; /* distance of matched string */
2392 int lc; /* match length or unmatched char (if dist == 0) */
2393 unsigned lx = 0; /* running index in l_buf */
2394 unsigned dx = 0; /* running index in d_buf */
2395 unsigned fx = 0; /* running index in flag_buf */
2396 uch flag = 0; /* current flags */
2397 unsigned code; /* the code to send */
2398 int extra; /* number of extra bits to send */
Eric Andersencc8ed391999-10-05 16:24:54 +00002399
Erik Andersene49d5ec2000-02-08 19:58:47 +00002400 if (last_lit != 0)
2401 do {
2402 if ((lx & 7) == 0)
2403 flag = flag_buf[fx++];
2404 lc = l_buf[lx++];
2405 if ((flag & 1) == 0) {
2406 send_code(lc, ltree); /* send a literal byte */
2407 Tracecv(isgraph(lc), (stderr, " '%c' ", lc));
2408 } else {
2409 /* Here, lc is the match length - MIN_MATCH */
2410 code = length_code[lc];
2411 send_code(code + LITERALS + 1, ltree); /* send the length code */
2412 extra = extra_lbits[code];
2413 if (extra != 0) {
2414 lc -= base_length[code];
2415 send_bits(lc, extra); /* send the extra length bits */
2416 }
2417 dist = d_buf[dx++];
2418 /* Here, dist is the match distance - 1 */
2419 code = d_code(dist);
2420 Assert(code < D_CODES, "bad d_code");
Eric Andersencc8ed391999-10-05 16:24:54 +00002421
Erik Andersene49d5ec2000-02-08 19:58:47 +00002422 send_code(code, dtree); /* send the distance code */
2423 extra = extra_dbits[code];
2424 if (extra != 0) {
2425 dist -= base_dist[code];
2426 send_bits(dist, extra); /* send the extra distance bits */
2427 }
2428 } /* literal or match pair ? */
2429 flag >>= 1;
2430 } while (lx < last_lit);
Eric Andersencc8ed391999-10-05 16:24:54 +00002431
Erik Andersene49d5ec2000-02-08 19:58:47 +00002432 send_code(END_BLOCK, ltree);
Eric Andersencc8ed391999-10-05 16:24:54 +00002433}
2434
2435/* ===========================================================================
2436 * Set the file type to ASCII or BINARY, using a crude approximation:
2437 * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise.
2438 * IN assertion: the fields freq of dyn_ltree are set and the total of all
2439 * frequencies does not exceed 64K (to fit in an int on 16 bit machines).
2440 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002441static void set_file_type()
Eric Andersencc8ed391999-10-05 16:24:54 +00002442{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002443 int n = 0;
2444 unsigned ascii_freq = 0;
2445 unsigned bin_freq = 0;
2446
2447 while (n < 7)
2448 bin_freq += dyn_ltree[n++].Freq;
2449 while (n < 128)
2450 ascii_freq += dyn_ltree[n++].Freq;
2451 while (n < LITERALS)
2452 bin_freq += dyn_ltree[n++].Freq;
2453 *file_type = bin_freq > (ascii_freq >> 2) ? BINARY : ASCII;
2454 if (*file_type == BINARY && translate_eol) {
Matt Kraaidd19c692001-01-31 19:00:21 +00002455 error_msg("-l used on binary file");
Erik Andersene49d5ec2000-02-08 19:58:47 +00002456 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002457}
Erik Andersene49d5ec2000-02-08 19:58:47 +00002458
Eric Andersencc8ed391999-10-05 16:24:54 +00002459/* zip.c -- compress files to the gzip or pkzip format
2460 * Copyright (C) 1992-1993 Jean-loup Gailly
2461 * This is free software; you can redistribute it and/or modify it under the
2462 * terms of the GNU General Public License, see the file COPYING.
2463 */
2464
Eric Andersencc8ed391999-10-05 16:24:54 +00002465
Eric Andersen3073dfb2001-07-02 17:57:32 +00002466static ulg crc; /* crc on uncompressed file data */
2467static long header_bytes; /* number of bytes in gzip header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002468
2469/* ===========================================================================
2470 * Deflate in to out.
2471 * IN assertions: the input and output buffers are cleared.
2472 * The variables time_stamp and save_orig_name are initialized.
2473 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002474static int zip(int in, int out)
Eric Andersencc8ed391999-10-05 16:24:54 +00002475{
Eric Andersen851895a2001-03-21 21:52:25 +00002476 uch my_flags = 0; /* general purpose bit flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002477 ush attr = 0; /* ascii/binary flag */
2478 ush deflate_flags = 0; /* pkzip -es, -en or -ex equivalent */
Eric Andersencc8ed391999-10-05 16:24:54 +00002479
Erik Andersene49d5ec2000-02-08 19:58:47 +00002480 ifd = in;
2481 ofd = out;
2482 outcnt = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00002483
Erik Andersene49d5ec2000-02-08 19:58:47 +00002484 /* Write the header to the gzip file. See algorithm.doc for the format */
Eric Andersencc8ed391999-10-05 16:24:54 +00002485
Eric Andersen96bcfd31999-11-12 01:30:18 +00002486
Erik Andersene49d5ec2000-02-08 19:58:47 +00002487 method = DEFLATED;
2488 put_byte(GZIP_MAGIC[0]); /* magic header */
2489 put_byte(GZIP_MAGIC[1]);
2490 put_byte(DEFLATED); /* compression method */
Eric Andersencc8ed391999-10-05 16:24:54 +00002491
Eric Andersen851895a2001-03-21 21:52:25 +00002492 put_byte(my_flags); /* general flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002493 put_long(time_stamp);
Eric Andersencc8ed391999-10-05 16:24:54 +00002494
Erik Andersene49d5ec2000-02-08 19:58:47 +00002495 /* Write deflated file to zip file */
2496 crc = updcrc(0, 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002497
Erik Andersene49d5ec2000-02-08 19:58:47 +00002498 bi_init(out);
2499 ct_init(&attr, &method);
2500 lm_init(&deflate_flags);
Eric Andersencc8ed391999-10-05 16:24:54 +00002501
Erik Andersene49d5ec2000-02-08 19:58:47 +00002502 put_byte((uch) deflate_flags); /* extra flags */
2503 put_byte(OS_CODE); /* OS identifier */
Eric Andersencc8ed391999-10-05 16:24:54 +00002504
Erik Andersene49d5ec2000-02-08 19:58:47 +00002505 header_bytes = (long) outcnt;
Eric Andersencc8ed391999-10-05 16:24:54 +00002506
Erik Andersene49d5ec2000-02-08 19:58:47 +00002507 (void) deflate();
Eric Andersencc8ed391999-10-05 16:24:54 +00002508
Erik Andersene49d5ec2000-02-08 19:58:47 +00002509 /* Write the crc and uncompressed size */
2510 put_long(crc);
2511 put_long(isize);
2512 header_bytes += 2 * sizeof(long);
Eric Andersencc8ed391999-10-05 16:24:54 +00002513
Erik Andersene49d5ec2000-02-08 19:58:47 +00002514 flush_outbuf();
2515 return OK;
Eric Andersencc8ed391999-10-05 16:24:54 +00002516}
2517
2518
2519/* ===========================================================================
2520 * Read a new buffer from the current input file, perform end-of-line
2521 * translation, and update the crc and input file size.
2522 * IN assertion: size >= 2 (for end-of-line translation)
2523 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002524static int file_read(char *buf, unsigned size)
Eric Andersencc8ed391999-10-05 16:24:54 +00002525{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002526 unsigned len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002527
Erik Andersene49d5ec2000-02-08 19:58:47 +00002528 Assert(insize == 0, "inbuf not empty");
Eric Andersencc8ed391999-10-05 16:24:54 +00002529
Erik Andersene49d5ec2000-02-08 19:58:47 +00002530 len = read(ifd, buf, size);
2531 if (len == (unsigned) (-1) || len == 0)
2532 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002533
Erik Andersene49d5ec2000-02-08 19:58:47 +00002534 crc = updcrc((uch *) buf, len);
2535 isize += (ulg) len;
2536 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002537}
Matt Kraai7918e1f2000-11-08 06:52:57 +00002538
2539/* ===========================================================================
2540 * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
2541 * (used for the compressed data only)
2542 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002543static void flush_outbuf()
Matt Kraai7918e1f2000-11-08 06:52:57 +00002544{
2545 if (outcnt == 0)
2546 return;
2547
2548 write_buf(ofd, (char *) outbuf, outcnt);
Matt Kraai7918e1f2000-11-08 06:52:57 +00002549 outcnt = 0;
2550}