blob: 436393ed5efc71172c89e4deacaac5aa5125b674 [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) { \
Eric Andersen39eb0402001-08-22 04:15:47 +0000113 array = (type*)xcalloc((size_t)(((size)+1L)/2), 2*sizeof(type)); \
Eric Andersencc8ed391999-10-05 16:24:54 +0000114 }
Erik Andersen61677fe2000-04-13 01:18:56 +0000115# define FREE(array) {if (array != NULL) free(array), array=NULL;}
Eric Andersencc8ed391999-10-05 16:24:54 +0000116#else
Eric Andersen3073dfb2001-07-02 17:57:32 +0000117# define DECLARE(type, array, size) static type array[size]
Eric Andersencc8ed391999-10-05 16:24:54 +0000118# define ALLOC(type, array, size)
119# define FREE(array)
120#endif
121
Eric Andersencc8ed391999-10-05 16:24:54 +0000122#define tab_suffix window
Eric Andersen3073dfb2001-07-02 17:57:32 +0000123#define tab_prefix prev /* hash link (see deflate.c) */
124#define head (prev+WSIZE) /* hash head (see deflate.c) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000125
Eric Andersen3073dfb2001-07-02 17:57:32 +0000126static long bytes_in; /* number of input bytes */
Eric Andersencc8ed391999-10-05 16:24:54 +0000127
128#define isize bytes_in
129/* for compatibility with old zip sources (to be cleaned) */
130
Erik Andersene49d5ec2000-02-08 19:58:47 +0000131typedef int file_t; /* Do not use stdio */
132
133#define NO_FILE (-1) /* in memory compression */
Eric Andersencc8ed391999-10-05 16:24:54 +0000134
135
Erik Andersene49d5ec2000-02-08 19:58:47 +0000136#define PACK_MAGIC "\037\036" /* Magic header for packed files */
137#define GZIP_MAGIC "\037\213" /* Magic header for gzip files, 1F 8B */
138#define OLD_GZIP_MAGIC "\037\236" /* Magic header for gzip 0.5 = freeze 1.x */
139#define LZH_MAGIC "\037\240" /* Magic header for SCO LZH Compress files */
140#define PKZIP_MAGIC "\120\113\003\004" /* Magic header for pkzip files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000141
142/* gzip flag byte */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000143#define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
144#define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
145#define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
146#define ORIG_NAME 0x08 /* bit 3 set: original file name present */
147#define COMMENT 0x10 /* bit 4 set: file comment present */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000148#define RESERVED 0xC0 /* bit 6,7: reserved */
Eric Andersencc8ed391999-10-05 16:24:54 +0000149
150/* internal file attribute */
151#define UNKNOWN 0xffff
152#define BINARY 0
153#define ASCII 1
154
155#ifndef WSIZE
Erik Andersene49d5ec2000-02-08 19:58:47 +0000156# define WSIZE 0x8000 /* window size--must be a power of two, and */
157#endif /* at least 32K for zip's deflate method */
Eric Andersencc8ed391999-10-05 16:24:54 +0000158
159#define MIN_MATCH 3
160#define MAX_MATCH 258
161/* The minimum and maximum match lengths */
162
163#define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
164/* Minimum amount of lookahead, except at the end of the input file.
165 * See deflate.c for comments about the MIN_MATCH+1.
166 */
167
168#define MAX_DIST (WSIZE-MIN_LOOKAHEAD)
169/* In order to simplify the code, particularly on 16 bit machines, match
170 * distances are limited to MAX_DIST instead of WSIZE.
171 */
172
Eric Andersen3073dfb2001-07-02 17:57:32 +0000173/* put_byte is used for the compressed output */
Eric Andersencc8ed391999-10-05 16:24:54 +0000174#define put_byte(c) {outbuf[outcnt++]=(uch)(c); if (outcnt==OUTBUFSIZ)\
175 flush_outbuf();}
Eric Andersencc8ed391999-10-05 16:24:54 +0000176
Eric Andersencc8ed391999-10-05 16:24:54 +0000177
178/* Output a 32 bit value to the bit stream, lsb first */
Eric Andersen39eb0402001-08-22 04:15:47 +0000179#if 0
Eric Andersencc8ed391999-10-05 16:24:54 +0000180#define put_long(n) { \
181 put_short((n) & 0xffff); \
182 put_short(((ulg)(n)) >> 16); \
183}
Eric Andersen39eb0402001-08-22 04:15:47 +0000184#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000185
Erik Andersene49d5ec2000-02-08 19:58:47 +0000186#define seekable() 0 /* force sequential output */
187#define translate_eol 0 /* no option -a yet */
Eric Andersencc8ed391999-10-05 16:24:54 +0000188
Eric Andersencc8ed391999-10-05 16:24:54 +0000189/* Diagnostic functions */
190#ifdef DEBUG
Mark Whitleyf57c9442000-12-07 19:56:48 +0000191# define Assert(cond,msg) {if(!(cond)) error_msg(msg);}
Eric Andersencc8ed391999-10-05 16:24:54 +0000192# define Trace(x) fprintf x
193# define Tracev(x) {if (verbose) fprintf x ;}
194# define Tracevv(x) {if (verbose>1) fprintf x ;}
195# define Tracec(c,x) {if (verbose && (c)) fprintf x ;}
196# define Tracecv(c,x) {if (verbose>1 && (c)) fprintf x ;}
197#else
198# define Assert(cond,msg)
199# define Trace(x)
200# define Tracev(x)
201# define Tracevv(x)
202# define Tracec(c,x)
203# define Tracecv(c,x)
204#endif
205
206#define WARN(msg) {if (!quiet) fprintf msg ; \
207 if (exit_code == OK) exit_code = WARNING;}
208
Eric Andersen3073dfb2001-07-02 17:57:32 +0000209#ifndef MAX_PATH_LEN
210# define MAX_PATH_LEN 1024 /* max pathname length */
211#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000212
Eric Andersencc8ed391999-10-05 16:24:54 +0000213
Eric Andersen3073dfb2001-07-02 17:57:32 +0000214 /* from zip.c: */
215static int zip (int in, int out);
216static int file_read (char *buf, unsigned size);
Eric Andersencc8ed391999-10-05 16:24:54 +0000217
Eric Andersen3073dfb2001-07-02 17:57:32 +0000218 /* from gzip.c */
219static RETSIGTYPE abort_gzip (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000220
Eric Andersen3073dfb2001-07-02 17:57:32 +0000221 /* from deflate.c */
222static void lm_init (ush * flags);
223static ulg deflate (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000224
Eric Andersen3073dfb2001-07-02 17:57:32 +0000225 /* from trees.c */
226static void ct_init (ush * attr, int *methodp);
227static int ct_tally (int dist, int lc);
228static ulg flush_block (char *buf, ulg stored_len, int eof);
Eric Andersencc8ed391999-10-05 16:24:54 +0000229
Eric Andersen3073dfb2001-07-02 17:57:32 +0000230 /* from bits.c */
231static void bi_init (file_t zipfile);
232static void send_bits (int value, int length);
233static unsigned bi_reverse (unsigned value, int length);
234static void bi_windup (void);
235static void copy_block (char *buf, unsigned len, int header);
236static int (*read_buf) (char *buf, unsigned size);
Eric Andersencc8ed391999-10-05 16:24:54 +0000237
Eric Andersen3073dfb2001-07-02 17:57:32 +0000238 /* from util.c: */
239static void flush_outbuf (void);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000240
Eric Andersencc8ed391999-10-05 16:24:54 +0000241/* lzw.h -- define the lzw functions.
242 * Copyright (C) 1992-1993 Jean-loup Gailly.
243 * This is free software; you can redistribute it and/or modify it under the
244 * terms of the GNU General Public License, see the file COPYING.
245 */
246
247#if !defined(OF) && defined(lint)
248# include "gzip.h"
249#endif
250
251#ifndef BITS
252# define BITS 16
253#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000254#define INIT_BITS 9 /* Initial number of bits per code */
Eric Andersencc8ed391999-10-05 16:24:54 +0000255
Erik Andersene49d5ec2000-02-08 19:58:47 +0000256#define BIT_MASK 0x1f /* Mask for 'number of compression bits' */
Eric Andersencc8ed391999-10-05 16:24:54 +0000257/* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
258 * It's a pity that old uncompress does not check bit 0x20. That makes
259 * extension of the format actually undesirable because old compress
260 * would just crash on the new format instead of giving a meaningful
261 * error message. It does check the number of bits, but it's more
262 * helpful to say "unsupported format, get a new version" than
263 * "can only handle 16 bits".
264 */
265
Eric Andersencc8ed391999-10-05 16:24:54 +0000266/* tailor.h -- target dependent definitions
267 * Copyright (C) 1992-1993 Jean-loup Gailly.
268 * This is free software; you can redistribute it and/or modify it under the
269 * terms of the GNU General Public License, see the file COPYING.
270 */
271
272/* The target dependent definitions should be defined here only.
273 * The target dependent functions should be defined in tailor.c.
274 */
275
Eric Andersencc8ed391999-10-05 16:24:54 +0000276
Eric Andersencc8ed391999-10-05 16:24:54 +0000277 /* Common defaults */
278
279#ifndef OS_CODE
Erik Andersene49d5ec2000-02-08 19:58:47 +0000280# define OS_CODE 0x03 /* assume Unix */
Eric Andersencc8ed391999-10-05 16:24:54 +0000281#endif
282
283#ifndef PATH_SEP
284# define PATH_SEP '/'
285#endif
286
Eric Andersencc8ed391999-10-05 16:24:54 +0000287#ifndef OPTIONS_VAR
288# define OPTIONS_VAR "GZIP"
289#endif
290
291#ifndef Z_SUFFIX
292# define Z_SUFFIX ".gz"
293#endif
294
295#ifdef MAX_EXT_CHARS
296# define MAX_SUFFIX MAX_EXT_CHARS
297#else
298# define MAX_SUFFIX 30
299#endif
300
Eric Andersen3073dfb2001-07-02 17:57:32 +0000301 /* global buffers */
Eric Andersencc8ed391999-10-05 16:24:54 +0000302
Eric Andersen3073dfb2001-07-02 17:57:32 +0000303DECLARE(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
304DECLARE(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
305DECLARE(ush, d_buf, DIST_BUFSIZE);
306DECLARE(uch, window, 2L * WSIZE);
307DECLARE(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +0000308
Eric Andersen3073dfb2001-07-02 17:57:32 +0000309static int crc_table_empty = 1;
Eric Andersencc8ed391999-10-05 16:24:54 +0000310
Eric Andersen3073dfb2001-07-02 17:57:32 +0000311static int foreground; /* set if program run in foreground */
312static int method = DEFLATED; /* compression method */
313static int exit_code = OK; /* program exit code */
314static int part_nb; /* number of parts in .gz file */
315static long time_stamp; /* original time stamp (modification time) */
316static long ifile_size; /* input file size, -1 for devices (debug only) */
317static char z_suffix[MAX_SUFFIX + 1]; /* default suffix (can be set with --suffix) */
318static int z_len; /* strlen(z_suffix) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000319
Eric Andersen3073dfb2001-07-02 17:57:32 +0000320static char ifname[MAX_PATH_LEN]; /* input file name */
321static char ofname[MAX_PATH_LEN]; /* output file name */
322static int ifd; /* input file descriptor */
323static int ofd; /* output file descriptor */
324static unsigned insize; /* valid bytes in inbuf */
325static unsigned outcnt; /* bytes in output buffer */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000326
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000327
328/* Output a 16 bit value, lsb first */
329static void put_short(ush w)
330{
331 if (outcnt < OUTBUFSIZ-2) {
332 outbuf[outcnt++] = (uch) ((w) & 0xff);
333 outbuf[outcnt++] = (uch) ((ush)(w) >> 8);
334 } else {
335 put_byte((uch)((w) & 0xff));
336 put_byte((uch)((ush)(w) >> 8));
337 }
338}
339
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000340/* ========================================================================
341 * Signal and error handler.
342 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000343static void abort_gzip()
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000344{
345 exit(ERROR);
346}
347
348/* ===========================================================================
349 * Clear input and output buffers
350 */
351static void clear_bufs(void)
352{
353 outcnt = 0;
Eric Andersen3073dfb2001-07-02 17:57:32 +0000354 insize = 0;
355 bytes_in = 0L;
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000356}
357
Eric Andersen74400cc2001-10-18 04:11:39 +0000358static void write_error_msg(void)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000359{
360 fprintf(stderr, "\n");
361 perror("");
362 abort_gzip();
363}
364
365/* ===========================================================================
366 * Does the same as write(), but also handles partial pipe writes and checks
367 * for error return.
368 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000369static void write_buf(int fd, void *buf, unsigned cnt)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000370{
371 unsigned n;
372
373 while ((n = write(fd, buf, cnt)) != cnt) {
374 if (n == (unsigned) (-1)) {
375 write_error_msg();
376 }
377 cnt -= n;
378 buf = (void *) ((char *) buf + n);
379 }
380}
381
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000382/* ===========================================================================
383 * Run a set of bytes through the crc shift register. If s is a NULL
384 * pointer, then initialize the crc shift register contents instead.
385 * Return the current crc in either case.
386 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000387static ulg updcrc(uch *s, unsigned n)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000388{
389 static ulg crc = (ulg) 0xffffffffL; /* shift register contents */
390 register ulg c; /* temporary variable */
391 static unsigned long crc_32_tab[256];
392 if (crc_table_empty) {
393 unsigned long csr; /* crc shift register */
Eric Andersen39eb0402001-08-22 04:15:47 +0000394 const unsigned long e = 0xedb88320L; /* polynomial exclusive-or pattern */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000395 int i; /* counter for all possible eight bit values */
396 int k; /* byte being shifted into crc apparatus */
397
Eric Andersen39eb0402001-08-22 04:15:47 +0000398 /* Compute table of CRC's. */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000399 crc_32_tab[0] = 0x00000000L;
400 for (i = 1; i < 256; i++) {
401 csr = i;
402 /* The idea to initialize the register with the byte instead of
403 * zero was stolen from Haruhiko Okumura's ar002
404 */
405 for (k = 8; k; k--)
406 csr = csr & 1 ? (csr >> 1) ^ e : csr >> 1;
407 crc_32_tab[i]=csr;
408 }
409 }
410
411 if (s == NULL) {
412 c = 0xffffffffL;
413 } else {
414 c = crc;
415 if (n)
416 do {
417 c = crc_32_tab[((int) c ^ (*s++)) & 0xff] ^ (c >> 8);
418 } while (--n);
419 }
420 crc = c;
421 return c ^ 0xffffffffL; /* (instead of ~c for 64-bit machines) */
422}
423
Eric Andersencc8ed391999-10-05 16:24:54 +0000424/* bits.c -- output variable-length bit strings
425 * Copyright (C) 1992-1993 Jean-loup Gailly
426 * This is free software; you can redistribute it and/or modify it under the
427 * terms of the GNU General Public License, see the file COPYING.
428 */
429
430
431/*
432 * PURPOSE
433 *
434 * Output variable-length bit strings. Compression can be done
435 * to a file or to memory. (The latter is not supported in this version.)
436 *
437 * DISCUSSION
438 *
439 * The PKZIP "deflate" file format interprets compressed file data
440 * as a sequence of bits. Multi-bit strings in the file may cross
441 * byte boundaries without restriction.
442 *
443 * The first bit of each byte is the low-order bit.
444 *
445 * The routines in this file allow a variable-length bit value to
446 * be output right-to-left (useful for literal values). For
447 * left-to-right output (useful for code strings from the tree routines),
448 * the bits must have been reversed first with bi_reverse().
449 *
450 * For in-memory compression, the compressed bit stream goes directly
451 * into the requested output buffer. The input data is read in blocks
452 * by the mem_read() function. The buffer is limited to 64K on 16 bit
453 * machines.
454 *
455 * INTERFACE
456 *
457 * void bi_init (FILE *zipfile)
458 * Initialize the bit string routines.
459 *
460 * void send_bits (int value, int length)
461 * Write out a bit string, taking the source bits right to
462 * left.
463 *
464 * int bi_reverse (int value, int length)
465 * Reverse the bits of a bit string, taking the source bits left to
466 * right and emitting them right to left.
467 *
468 * void bi_windup (void)
469 * Write out any remaining bits in an incomplete byte.
470 *
471 * void copy_block(char *buf, unsigned len, int header)
472 * Copy a stored block to the zip file, storing first the length and
473 * its one's complement if requested.
474 *
475 */
476
Eric Andersencc8ed391999-10-05 16:24:54 +0000477/* ===========================================================================
478 * Local data used by the "bit string" routines.
479 */
480
Eric Andersen3073dfb2001-07-02 17:57:32 +0000481static file_t zfile; /* output gzip file */
Eric Andersencc8ed391999-10-05 16:24:54 +0000482
Eric Andersen3073dfb2001-07-02 17:57:32 +0000483static unsigned short bi_buf;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000484
Eric Andersencc8ed391999-10-05 16:24:54 +0000485/* Output buffer. bits are inserted starting at the bottom (least significant
486 * bits).
487 */
488
489#define Buf_size (8 * 2*sizeof(char))
490/* Number of bits used within bi_buf. (bi_buf might be implemented on
491 * more than 16 bits on some systems.)
492 */
493
Eric Andersen3073dfb2001-07-02 17:57:32 +0000494static int bi_valid;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000495
Eric Andersencc8ed391999-10-05 16:24:54 +0000496/* Current input function. Set to mem_read for in-memory compression */
497
498#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000499ulg bits_sent; /* bit length of the compressed data */
Eric Andersencc8ed391999-10-05 16:24:54 +0000500#endif
501
502/* ===========================================================================
503 * Initialize the bit string routines.
504 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000505static void bi_init(file_t zipfile)
Eric Andersencc8ed391999-10-05 16:24:54 +0000506{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000507 zfile = zipfile;
508 bi_buf = 0;
509 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000510#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000511 bits_sent = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000512#endif
513
Erik Andersene49d5ec2000-02-08 19:58:47 +0000514 /* Set the defaults for file compression. They are set by memcompress
515 * for in-memory compression.
516 */
517 if (zfile != NO_FILE) {
518 read_buf = file_read;
519 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000520}
521
522/* ===========================================================================
523 * Send a value on a given number of bits.
524 * IN assertion: length <= 16 and value fits in length bits.
525 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000526static void send_bits(int value, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000527{
528#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000529 Tracev((stderr, " l %2d v %4x ", length, value));
530 Assert(length > 0 && length <= 15, "invalid length");
531 bits_sent += (ulg) length;
Eric Andersencc8ed391999-10-05 16:24:54 +0000532#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000533 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
534 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
535 * unused bits in value.
536 */
537 if (bi_valid > (int) Buf_size - length) {
538 bi_buf |= (value << bi_valid);
539 put_short(bi_buf);
540 bi_buf = (ush) value >> (Buf_size - bi_valid);
541 bi_valid += length - Buf_size;
542 } else {
543 bi_buf |= value << bi_valid;
544 bi_valid += length;
545 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000546}
547
548/* ===========================================================================
549 * Reverse the first len bits of a code, using straightforward code (a faster
550 * method would use a table)
551 * IN assertion: 1 <= len <= 15
552 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000553static unsigned bi_reverse(unsigned code, int len)
Eric Andersencc8ed391999-10-05 16:24:54 +0000554{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000555 register unsigned res = 0;
556
557 do {
558 res |= code & 1;
559 code >>= 1, res <<= 1;
560 } while (--len > 0);
561 return res >> 1;
Eric Andersencc8ed391999-10-05 16:24:54 +0000562}
563
564/* ===========================================================================
565 * Write out any remaining bits in an incomplete byte.
566 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000567static void bi_windup()
Eric Andersencc8ed391999-10-05 16:24:54 +0000568{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000569 if (bi_valid > 8) {
570 put_short(bi_buf);
571 } else if (bi_valid > 0) {
572 put_byte(bi_buf);
573 }
574 bi_buf = 0;
575 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000576#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000577 bits_sent = (bits_sent + 7) & ~7;
Eric Andersencc8ed391999-10-05 16:24:54 +0000578#endif
579}
580
581/* ===========================================================================
582 * Copy a stored block to the zip file, storing first the length and its
583 * one's complement if requested.
584 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000585static void copy_block(char *buf, unsigned len, int header)
Eric Andersencc8ed391999-10-05 16:24:54 +0000586{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000587 bi_windup(); /* align on byte boundary */
Eric Andersencc8ed391999-10-05 16:24:54 +0000588
Erik Andersene49d5ec2000-02-08 19:58:47 +0000589 if (header) {
590 put_short((ush) len);
591 put_short((ush) ~ len);
Eric Andersencc8ed391999-10-05 16:24:54 +0000592#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000593 bits_sent += 2 * 16;
Eric Andersencc8ed391999-10-05 16:24:54 +0000594#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000595 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000596#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000597 bits_sent += (ulg) len << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +0000598#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000599 while (len--) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000600 put_byte(*buf++);
601 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000602}
Erik Andersene49d5ec2000-02-08 19:58:47 +0000603
Eric Andersencc8ed391999-10-05 16:24:54 +0000604/* deflate.c -- compress data using the deflation algorithm
605 * Copyright (C) 1992-1993 Jean-loup Gailly
606 * This is free software; you can redistribute it and/or modify it under the
607 * terms of the GNU General Public License, see the file COPYING.
608 */
609
610/*
611 * PURPOSE
612 *
613 * Identify new text as repetitions of old text within a fixed-
614 * length sliding window trailing behind the new text.
615 *
616 * DISCUSSION
617 *
618 * The "deflation" process depends on being able to identify portions
619 * of the input text which are identical to earlier input (within a
620 * sliding window trailing behind the input currently being processed).
621 *
622 * The most straightforward technique turns out to be the fastest for
623 * most input files: try all possible matches and select the longest.
624 * The key feature of this algorithm is that insertions into the string
625 * dictionary are very simple and thus fast, and deletions are avoided
626 * completely. Insertions are performed at each input character, whereas
627 * string matches are performed only when the previous match ends. So it
628 * is preferable to spend more time in matches to allow very fast string
629 * insertions and avoid deletions. The matching algorithm for small
630 * strings is inspired from that of Rabin & Karp. A brute force approach
631 * is used to find longer strings when a small match has been found.
632 * A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
633 * (by Leonid Broukhis).
634 * A previous version of this file used a more sophisticated algorithm
635 * (by Fiala and Greene) which is guaranteed to run in linear amortized
636 * time, but has a larger average cost, uses more memory and is patented.
637 * However the F&G algorithm may be faster for some highly redundant
638 * files if the parameter max_chain_length (described below) is too large.
639 *
640 * ACKNOWLEDGEMENTS
641 *
642 * The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
643 * I found it in 'freeze' written by Leonid Broukhis.
644 * Thanks to many info-zippers for bug reports and testing.
645 *
646 * REFERENCES
647 *
648 * APPNOTE.TXT documentation file in PKZIP 1.93a distribution.
649 *
650 * A description of the Rabin and Karp algorithm is given in the book
651 * "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
652 *
653 * Fiala,E.R., and Greene,D.H.
654 * Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
655 *
656 * INTERFACE
657 *
658 * void lm_init (int pack_level, ush *flags)
659 * Initialize the "longest match" routines for a new file
660 *
661 * ulg deflate (void)
662 * Processes a new input file and return its compressed length. Sets
663 * the compressed length, crc, deflate flags and internal file
664 * attributes.
665 */
666
Eric Andersencc8ed391999-10-05 16:24:54 +0000667
Eric Andersencc8ed391999-10-05 16:24:54 +0000668/* ===========================================================================
669 * Configuration parameters
670 */
671
672/* Compile with MEDIUM_MEM to reduce the memory requirements or
673 * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
674 * entire input file can be held in memory (not possible on 16 bit systems).
675 * Warning: defining these symbols affects HASH_BITS (see below) and thus
676 * affects the compression ratio. The compressed output
677 * is still correct, and might even be smaller in some cases.
678 */
679
680#ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000681# define HASH_BITS 13 /* Number of bits used to hash strings */
Eric Andersencc8ed391999-10-05 16:24:54 +0000682#endif
683#ifdef MEDIUM_MEM
684# define HASH_BITS 14
685#endif
686#ifndef HASH_BITS
687# define HASH_BITS 15
688 /* For portability to 16 bit machines, do not use values above 15. */
689#endif
690
691/* To save space (see unlzw.c), we overlay prev+head with tab_prefix and
692 * window with tab_suffix. Check that we can do this:
693 */
694#if (WSIZE<<1) > (1<<BITS)
Eric Andersen3073dfb2001-07-02 17:57:32 +0000695# error cannot overlay window with tab_suffix and prev with tab_prefix0
Eric Andersencc8ed391999-10-05 16:24:54 +0000696#endif
697#if HASH_BITS > BITS-1
Eric Andersen3073dfb2001-07-02 17:57:32 +0000698# error cannot overlay head with tab_prefix1
Eric Andersencc8ed391999-10-05 16:24:54 +0000699#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000700#define HASH_SIZE (unsigned)(1<<HASH_BITS)
701#define HASH_MASK (HASH_SIZE-1)
702#define WMASK (WSIZE-1)
703/* HASH_SIZE and WSIZE must be powers of two */
Eric Andersencc8ed391999-10-05 16:24:54 +0000704#define NIL 0
705/* Tail of hash chains */
Eric Andersencc8ed391999-10-05 16:24:54 +0000706#define FAST 4
707#define SLOW 2
708/* speed options for the general purpose bit flag */
Eric Andersencc8ed391999-10-05 16:24:54 +0000709#ifndef TOO_FAR
710# define TOO_FAR 4096
711#endif
712/* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
Eric Andersencc8ed391999-10-05 16:24:54 +0000713/* ===========================================================================
714 * Local data used by the "longest match" routines.
715 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000716typedef ush Pos;
717typedef unsigned IPos;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000718
Eric Andersencc8ed391999-10-05 16:24:54 +0000719/* A Pos is an index in the character window. We use short instead of int to
720 * save space in the various tables. IPos is used only for parameter passing.
721 */
722
723/* DECLARE(uch, window, 2L*WSIZE); */
724/* Sliding window. Input bytes are read into the second half of the window,
725 * and move to the first half later to keep a dictionary of at least WSIZE
726 * bytes. With this organization, matches are limited to a distance of
727 * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
728 * performed with a length multiple of the block size. Also, it limits
729 * the window size to 64K, which is quite useful on MSDOS.
730 * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
731 * be less efficient).
732 */
733
734/* DECLARE(Pos, prev, WSIZE); */
735/* Link to older string with same hash index. To limit the size of this
736 * array to 64K, this link is maintained only for the last 32K strings.
737 * An index in this array is thus a window index modulo 32K.
738 */
739
740/* DECLARE(Pos, head, 1<<HASH_BITS); */
741/* Heads of the hash chains or NIL. */
742
Eric Andersen3073dfb2001-07-02 17:57:32 +0000743static const ulg window_size = (ulg) 2 * WSIZE;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000744
Eric Andersencc8ed391999-10-05 16:24:54 +0000745/* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
746 * input file length plus MIN_LOOKAHEAD.
747 */
748
Eric Andersen3073dfb2001-07-02 17:57:32 +0000749static long block_start;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000750
Eric Andersencc8ed391999-10-05 16:24:54 +0000751/* window position at the beginning of the current output block. Gets
752 * negative when the window is moved backwards.
753 */
754
Eric Andersen3073dfb2001-07-02 17:57:32 +0000755static unsigned ins_h; /* hash index of string to be inserted */
Eric Andersencc8ed391999-10-05 16:24:54 +0000756
757#define H_SHIFT ((HASH_BITS+MIN_MATCH-1)/MIN_MATCH)
758/* Number of bits by which ins_h and del_h must be shifted at each
759 * input step. It must be such that after MIN_MATCH steps, the oldest
760 * byte no longer takes part in the hash key, that is:
761 * H_SHIFT * MIN_MATCH >= HASH_BITS
762 */
763
Eric Andersen3073dfb2001-07-02 17:57:32 +0000764static unsigned int prev_length;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000765
Eric Andersencc8ed391999-10-05 16:24:54 +0000766/* Length of the best match at previous step. Matches not greater than this
767 * are discarded. This is used in the lazy match evaluation.
768 */
769
Eric Andersen3073dfb2001-07-02 17:57:32 +0000770static unsigned strstart; /* start of string to insert */
771static unsigned match_start; /* start of matching string */
772static int eofile; /* flag set at end of input file */
773static unsigned lookahead; /* number of valid bytes ahead in window */
Eric Andersencc8ed391999-10-05 16:24:54 +0000774
Eric Andersen3073dfb2001-07-02 17:57:32 +0000775static const unsigned max_chain_length=4096;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000776
Eric Andersencc8ed391999-10-05 16:24:54 +0000777/* To speed up deflation, hash chains are never searched beyond this length.
778 * A higher limit improves compression ratio but degrades the speed.
779 */
780
Eric Andersen3073dfb2001-07-02 17:57:32 +0000781static const unsigned int max_lazy_match=258;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000782
Eric Andersencc8ed391999-10-05 16:24:54 +0000783/* Attempt to find a better match only when the current match is strictly
784 * smaller than this value. This mechanism is used only for compression
785 * levels >= 4.
786 */
787#define max_insert_length max_lazy_match
788/* Insert new strings in the hash table only if the match length
789 * is not greater than this length. This saves time but degrades compression.
790 * max_insert_length is used only for compression levels <= 3.
791 */
792
Eric Andersen3073dfb2001-07-02 17:57:32 +0000793static const unsigned good_match=32;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000794
Eric Andersencc8ed391999-10-05 16:24:54 +0000795/* Use a faster search when the previous match is longer than this */
796
797
798/* Values for max_lazy_match, good_match and max_chain_length, depending on
799 * the desired pack level (0..9). The values given below have been tuned to
800 * exclude worst case performance for pathological files. Better values may be
801 * found for specific files.
802 */
803
Eric Andersen3073dfb2001-07-02 17:57:32 +0000804static const int nice_match=258; /* Stop searching when current match exceeds this */
Eric Andersencc8ed391999-10-05 16:24:54 +0000805
806/* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
807 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
808 * meaning.
809 */
810
811#define EQUAL 0
812/* result of memcmp for equal strings */
813
814/* ===========================================================================
815 * Prototypes for local functions.
816 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000817static void fill_window (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000818
Eric Andersen3073dfb2001-07-02 17:57:32 +0000819static int longest_match (IPos cur_match);
Eric Andersencc8ed391999-10-05 16:24:54 +0000820
821#ifdef DEBUG
Eric Andersen3073dfb2001-07-02 17:57:32 +0000822static void check_match (IPos start, IPos match, int length);
Eric Andersencc8ed391999-10-05 16:24:54 +0000823#endif
824
825/* ===========================================================================
826 * Update a hash value with the given input byte
827 * IN assertion: all calls to to UPDATE_HASH are made with consecutive
828 * input characters, so that a running hash key can be computed from the
829 * previous key instead of complete recalculation each time.
830 */
831#define UPDATE_HASH(h,c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
832
833/* ===========================================================================
834 * Insert string s in the dictionary and set match_head to the previous head
835 * of the hash chain (the most recent string with same hash key). Return
836 * the previous length of the hash chain.
837 * IN assertion: all calls to to INSERT_STRING are made with consecutive
838 * input characters and the first MIN_MATCH bytes of s are valid
839 * (except for the last MIN_MATCH-1 bytes of the input file).
840 */
841#define INSERT_STRING(s, match_head) \
842 (UPDATE_HASH(ins_h, window[(s) + MIN_MATCH-1]), \
843 prev[(s) & WMASK] = match_head = head[ins_h], \
844 head[ins_h] = (s))
845
846/* ===========================================================================
847 * Initialize the "longest match" routines for a new file
848 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000849static void lm_init(ush *flags)
Eric Andersencc8ed391999-10-05 16:24:54 +0000850{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000851 register unsigned j;
Eric Andersencc8ed391999-10-05 16:24:54 +0000852
Erik Andersene49d5ec2000-02-08 19:58:47 +0000853 /* Initialize the hash table. */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000854 memzero((char *) head, HASH_SIZE * sizeof(*head));
Erik Andersene49d5ec2000-02-08 19:58:47 +0000855 /* prev will be initialized on the fly */
Eric Andersencc8ed391999-10-05 16:24:54 +0000856
Erik Andersene49d5ec2000-02-08 19:58:47 +0000857 *flags |= SLOW;
858 /* ??? reduce max_chain_length for binary files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000859
Erik Andersene49d5ec2000-02-08 19:58:47 +0000860 strstart = 0;
861 block_start = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000862
Erik Andersene49d5ec2000-02-08 19:58:47 +0000863 lookahead = read_buf((char *) window,
864 sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
Eric Andersencc8ed391999-10-05 16:24:54 +0000865
Erik Andersene49d5ec2000-02-08 19:58:47 +0000866 if (lookahead == 0 || lookahead == (unsigned) EOF) {
867 eofile = 1, lookahead = 0;
868 return;
869 }
870 eofile = 0;
871 /* Make sure that we always have enough lookahead. This is important
872 * if input comes from a device such as a tty.
873 */
874 while (lookahead < MIN_LOOKAHEAD && !eofile)
875 fill_window();
Eric Andersencc8ed391999-10-05 16:24:54 +0000876
Erik Andersene49d5ec2000-02-08 19:58:47 +0000877 ins_h = 0;
878 for (j = 0; j < MIN_MATCH - 1; j++)
879 UPDATE_HASH(ins_h, window[j]);
880 /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
881 * not important since only literal bytes will be emitted.
882 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000883}
884
885/* ===========================================================================
886 * Set match_start to the longest match starting at the given string and
887 * return its length. Matches shorter or equal to prev_length are discarded,
888 * in which case the result is equal to prev_length and match_start is
889 * garbage.
890 * IN assertions: cur_match is the head of the hash chain for the current
891 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
892 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000893
Eric Andersencc8ed391999-10-05 16:24:54 +0000894/* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
895 * match.s. The code is functionally equivalent, so you can use the C version
896 * if desired.
897 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000898static int longest_match(IPos cur_match)
Eric Andersencc8ed391999-10-05 16:24:54 +0000899{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000900 unsigned chain_length = max_chain_length; /* max hash chain length */
901 register uch *scan = window + strstart; /* current string */
902 register uch *match; /* matched string */
903 register int len; /* length of current match */
904 int best_len = prev_length; /* best match length so far */
905 IPos limit =
906
907 strstart > (IPos) MAX_DIST ? strstart - (IPos) MAX_DIST : NIL;
908 /* Stop when cur_match becomes <= limit. To simplify the code,
909 * we prevent matches with the string of window index 0.
910 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000911
912/* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
913 * It is easy to get rid of this optimization if necessary.
914 */
915#if HASH_BITS < 8 || MAX_MATCH != 258
Eric Andersen3073dfb2001-07-02 17:57:32 +0000916# error Code too clever
Eric Andersencc8ed391999-10-05 16:24:54 +0000917#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000918 register uch *strend = window + strstart + MAX_MATCH;
919 register uch scan_end1 = scan[best_len - 1];
920 register uch scan_end = scan[best_len];
Eric Andersencc8ed391999-10-05 16:24:54 +0000921
Erik Andersene49d5ec2000-02-08 19:58:47 +0000922 /* Do not waste too much time if we already have a good match: */
923 if (prev_length >= good_match) {
924 chain_length >>= 2;
925 }
926 Assert(strstart <= window_size - MIN_LOOKAHEAD,
927 "insufficient lookahead");
Eric Andersencc8ed391999-10-05 16:24:54 +0000928
Erik Andersene49d5ec2000-02-08 19:58:47 +0000929 do {
930 Assert(cur_match < strstart, "no future");
931 match = window + cur_match;
Eric Andersencc8ed391999-10-05 16:24:54 +0000932
Erik Andersene49d5ec2000-02-08 19:58:47 +0000933 /* Skip to next match if the match length cannot increase
934 * or if the match length is less than 2:
935 */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000936 if (match[best_len] != scan_end ||
937 match[best_len - 1] != scan_end1 ||
938 *match != *scan || *++match != scan[1])
939 continue;
Eric Andersencc8ed391999-10-05 16:24:54 +0000940
Erik Andersene49d5ec2000-02-08 19:58:47 +0000941 /* The check at best_len-1 can be removed because it will be made
942 * again later. (This heuristic is not always a win.)
943 * It is not necessary to compare scan[2] and match[2] since they
944 * are always equal when the other bytes match, given that
945 * the hash keys are equal and that HASH_BITS >= 8.
946 */
947 scan += 2, match++;
Eric Andersencc8ed391999-10-05 16:24:54 +0000948
Erik Andersene49d5ec2000-02-08 19:58:47 +0000949 /* We check for insufficient lookahead only every 8th comparison;
950 * the 256th check will be made at strstart+258.
951 */
952 do {
953 } while (*++scan == *++match && *++scan == *++match &&
954 *++scan == *++match && *++scan == *++match &&
955 *++scan == *++match && *++scan == *++match &&
956 *++scan == *++match && *++scan == *++match &&
957 scan < strend);
Eric Andersencc8ed391999-10-05 16:24:54 +0000958
Erik Andersene49d5ec2000-02-08 19:58:47 +0000959 len = MAX_MATCH - (int) (strend - scan);
960 scan = strend - MAX_MATCH;
Eric Andersencc8ed391999-10-05 16:24:54 +0000961
Erik Andersene49d5ec2000-02-08 19:58:47 +0000962 if (len > best_len) {
963 match_start = cur_match;
964 best_len = len;
965 if (len >= nice_match)
966 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000967 scan_end1 = scan[best_len - 1];
968 scan_end = scan[best_len];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000969 }
970 } while ((cur_match = prev[cur_match & WMASK]) > limit
971 && --chain_length != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +0000972
Erik Andersene49d5ec2000-02-08 19:58:47 +0000973 return best_len;
Eric Andersencc8ed391999-10-05 16:24:54 +0000974}
Eric Andersencc8ed391999-10-05 16:24:54 +0000975
976#ifdef DEBUG
977/* ===========================================================================
978 * Check that the match at match_start is indeed a match.
979 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000980static void check_match(IPos start, IPos match, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000981{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000982 /* check that the match is indeed a match */
983 if (memcmp((char *) window + match,
984 (char *) window + start, length) != EQUAL) {
985 fprintf(stderr,
986 " start %d, match %d, length %d\n", start, match, length);
Matt Kraaidd19c692001-01-31 19:00:21 +0000987 error_msg("invalid match");
Erik Andersene49d5ec2000-02-08 19:58:47 +0000988 }
989 if (verbose > 1) {
990 fprintf(stderr, "\\[%d,%d]", start - match, length);
991 do {
992 putc(window[start++], stderr);
993 } while (--length != 0);
994 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000995}
996#else
997# define check_match(start, match, length)
998#endif
999
1000/* ===========================================================================
1001 * Fill the window when the lookahead becomes insufficient.
1002 * Updates strstart and lookahead, and sets eofile if end of input file.
1003 * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
1004 * OUT assertions: at least one byte has been read, or eofile is set;
1005 * file reads are performed for at least two bytes (required for the
1006 * translate_eol option).
1007 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001008static void fill_window()
Eric Andersencc8ed391999-10-05 16:24:54 +00001009{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001010 register unsigned n, m;
1011 unsigned more =
Eric Andersencc8ed391999-10-05 16:24:54 +00001012
Erik Andersene49d5ec2000-02-08 19:58:47 +00001013 (unsigned) (window_size - (ulg) lookahead - (ulg) strstart);
1014 /* Amount of free space at the end of the window. */
Eric Andersencc8ed391999-10-05 16:24:54 +00001015
Erik Andersene49d5ec2000-02-08 19:58:47 +00001016 /* If the window is almost full and there is insufficient lookahead,
1017 * move the upper half to the lower one to make room in the upper half.
1018 */
1019 if (more == (unsigned) EOF) {
1020 /* Very unlikely, but possible on 16 bit machine if strstart == 0
1021 * and lookahead == 1 (input done one byte at time)
1022 */
1023 more--;
1024 } else if (strstart >= WSIZE + MAX_DIST) {
1025 /* By the IN assertion, the window is not empty so we can't confuse
1026 * more == 0 with more == 64K on a 16 bit machine.
1027 */
1028 Assert(window_size == (ulg) 2 * WSIZE, "no sliding with BIG_MEM");
Eric Andersencc8ed391999-10-05 16:24:54 +00001029
Erik Andersene49d5ec2000-02-08 19:58:47 +00001030 memcpy((char *) window, (char *) window + WSIZE, (unsigned) WSIZE);
1031 match_start -= WSIZE;
1032 strstart -= WSIZE; /* we now have strstart >= MAX_DIST: */
Eric Andersencc8ed391999-10-05 16:24:54 +00001033
Erik Andersene49d5ec2000-02-08 19:58:47 +00001034 block_start -= (long) WSIZE;
1035
1036 for (n = 0; n < HASH_SIZE; n++) {
1037 m = head[n];
1038 head[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1039 }
1040 for (n = 0; n < WSIZE; n++) {
1041 m = prev[n];
1042 prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1043 /* If n is not on any hash chain, prev[n] is garbage but
1044 * its value will never be used.
1045 */
1046 }
1047 more += WSIZE;
1048 }
1049 /* At this point, more >= 2 */
1050 if (!eofile) {
1051 n = read_buf((char *) window + strstart + lookahead, more);
1052 if (n == 0 || n == (unsigned) EOF) {
1053 eofile = 1;
1054 } else {
1055 lookahead += n;
1056 }
1057 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001058}
1059
1060/* ===========================================================================
1061 * Flush the current block, with given end-of-file flag.
1062 * IN assertion: strstart is set to the end of the current match.
1063 */
1064#define FLUSH_BLOCK(eof) \
1065 flush_block(block_start >= 0L ? (char*)&window[(unsigned)block_start] : \
1066 (char*)NULL, (long)strstart - block_start, (eof))
1067
1068/* ===========================================================================
1069 * Same as above, but achieves better compression. We use a lazy
1070 * evaluation for matches: a match is finally adopted only if there is
1071 * no better match at the next window position.
1072 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001073static ulg deflate()
Eric Andersencc8ed391999-10-05 16:24:54 +00001074{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001075 IPos hash_head; /* head of hash chain */
1076 IPos prev_match; /* previous match */
1077 int flush; /* set if current block must be flushed */
1078 int match_available = 0; /* set if previous match exists */
1079 register unsigned match_length = MIN_MATCH - 1; /* length of best match */
1080
Erik Andersene49d5ec2000-02-08 19:58:47 +00001081 /* Process the input block. */
1082 while (lookahead != 0) {
1083 /* Insert the string window[strstart .. strstart+2] in the
1084 * dictionary, and set hash_head to the head of the hash chain:
1085 */
1086 INSERT_STRING(strstart, hash_head);
Eric Andersencc8ed391999-10-05 16:24:54 +00001087
Erik Andersene49d5ec2000-02-08 19:58:47 +00001088 /* Find the longest match, discarding those <= prev_length.
1089 */
1090 prev_length = match_length, prev_match = match_start;
1091 match_length = MIN_MATCH - 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001092
Erik Andersene49d5ec2000-02-08 19:58:47 +00001093 if (hash_head != NIL && prev_length < max_lazy_match &&
1094 strstart - hash_head <= MAX_DIST) {
1095 /* To simplify the code, we prevent matches with the string
1096 * of window index 0 (in particular we have to avoid a match
1097 * of the string with itself at the start of the input file).
1098 */
1099 match_length = longest_match(hash_head);
1100 /* longest_match() sets match_start */
1101 if (match_length > lookahead)
1102 match_length = lookahead;
Eric Andersencc8ed391999-10-05 16:24:54 +00001103
Erik Andersene49d5ec2000-02-08 19:58:47 +00001104 /* Ignore a length 3 match if it is too distant: */
1105 if (match_length == MIN_MATCH
1106 && strstart - match_start > TOO_FAR) {
1107 /* If prev_match is also MIN_MATCH, match_start is garbage
1108 * but we will ignore the current match anyway.
1109 */
1110 match_length--;
1111 }
1112 }
1113 /* If there was a match at the previous step and the current
1114 * match is not better, output the previous match:
1115 */
1116 if (prev_length >= MIN_MATCH && match_length <= prev_length) {
Eric Andersencc8ed391999-10-05 16:24:54 +00001117
Erik Andersene49d5ec2000-02-08 19:58:47 +00001118 check_match(strstart - 1, prev_match, prev_length);
Eric Andersencc8ed391999-10-05 16:24:54 +00001119
Erik Andersene49d5ec2000-02-08 19:58:47 +00001120 flush =
1121 ct_tally(strstart - 1 - prev_match,
1122 prev_length - MIN_MATCH);
Eric Andersencc8ed391999-10-05 16:24:54 +00001123
Erik Andersene49d5ec2000-02-08 19:58:47 +00001124 /* Insert in hash table all strings up to the end of the match.
1125 * strstart-1 and strstart are already inserted.
1126 */
1127 lookahead -= prev_length - 1;
1128 prev_length -= 2;
1129 do {
1130 strstart++;
1131 INSERT_STRING(strstart, hash_head);
1132 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1133 * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1134 * these bytes are garbage, but it does not matter since the
1135 * next lookahead bytes will always be emitted as literals.
1136 */
1137 } while (--prev_length != 0);
1138 match_available = 0;
1139 match_length = MIN_MATCH - 1;
1140 strstart++;
1141 if (flush)
1142 FLUSH_BLOCK(0), block_start = strstart;
Eric Andersencc8ed391999-10-05 16:24:54 +00001143
Erik Andersene49d5ec2000-02-08 19:58:47 +00001144 } else if (match_available) {
1145 /* If there was no match at the previous position, output a
1146 * single literal. If there was a match but the current match
1147 * is longer, truncate the previous match to a single literal.
1148 */
1149 Tracevv((stderr, "%c", window[strstart - 1]));
1150 if (ct_tally(0, window[strstart - 1])) {
1151 FLUSH_BLOCK(0), block_start = strstart;
1152 }
1153 strstart++;
1154 lookahead--;
1155 } else {
1156 /* There is no previous match to compare with, wait for
1157 * the next step to decide.
1158 */
1159 match_available = 1;
1160 strstart++;
1161 lookahead--;
1162 }
1163 Assert(strstart <= isize && lookahead <= isize, "a bit too far");
Eric Andersencc8ed391999-10-05 16:24:54 +00001164
Erik Andersene49d5ec2000-02-08 19:58:47 +00001165 /* Make sure that we always have enough lookahead, except
1166 * at the end of the input file. We need MAX_MATCH bytes
1167 * for the next match, plus MIN_MATCH bytes to insert the
1168 * string following the next match.
1169 */
1170 while (lookahead < MIN_LOOKAHEAD && !eofile)
1171 fill_window();
1172 }
1173 if (match_available)
1174 ct_tally(0, window[strstart - 1]);
Eric Andersencc8ed391999-10-05 16:24:54 +00001175
Erik Andersene49d5ec2000-02-08 19:58:47 +00001176 return FLUSH_BLOCK(1); /* eof */
Eric Andersencc8ed391999-10-05 16:24:54 +00001177}
Erik Andersene49d5ec2000-02-08 19:58:47 +00001178
Eric Andersencc8ed391999-10-05 16:24:54 +00001179/* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
1180 * Copyright (C) 1992-1993 Jean-loup Gailly
1181 * The unzip code was written and put in the public domain by Mark Adler.
1182 * Portions of the lzw code are derived from the public domain 'compress'
1183 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
1184 * Ken Turkowski, Dave Mack and Peter Jannesen.
1185 *
1186 * See the license_msg below and the file COPYING for the software license.
1187 * See the file algorithm.doc for the compression algorithms and file formats.
1188 */
1189
1190/* Compress files with zip algorithm and 'compress' interface.
1191 * See usage() and help() functions below for all options.
1192 * Outputs:
1193 * file.gz: compressed file with same mode, owner, and utimes
1194 * or stdout with -c option or if stdin used as input.
1195 * If the output file name had to be truncated, the original name is kept
1196 * in the compressed file.
Eric Andersencc8ed391999-10-05 16:24:54 +00001197 */
1198
Eric Andersencc8ed391999-10-05 16:24:54 +00001199 /* configuration */
1200
Erik Andersene49d5ec2000-02-08 19:58:47 +00001201typedef struct dirent dir_type;
1202
Erik Andersen61677fe2000-04-13 01:18:56 +00001203typedef RETSIGTYPE(*sig_type) (int);
Eric Andersencc8ed391999-10-05 16:24:54 +00001204
Eric Andersencc8ed391999-10-05 16:24:54 +00001205/* ======================================================================== */
1206// int main (argc, argv)
1207// int argc;
1208// char **argv;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001209int gzip_main(int argc, char **argv)
Eric Andersencc8ed391999-10-05 16:24:54 +00001210{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001211 int result;
1212 int inFileNum;
1213 int outFileNum;
1214 struct stat statBuf;
1215 char *delFileName;
1216 int tostdout = 0;
1217 int fromstdin = 0;
Eric Andersenea824fb2000-07-21 22:17:39 +00001218 int force = 0;
Matt Kraai53265542001-04-18 16:05:34 +00001219 int opt;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001220
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001221 while ((opt = getopt(argc, argv, "cf123456789dq")) != -1) {
Matt Kraai53265542001-04-18 16:05:34 +00001222 switch (opt) {
1223 case 'c':
Erik Andersene49d5ec2000-02-08 19:58:47 +00001224 tostdout = 1;
Matt Kraai53265542001-04-18 16:05:34 +00001225 break;
1226 case 'f':
1227 force = 1;
1228 break;
1229 /* Ignore 1-9 (compression level) options */
1230 case '1': case '2': case '3': case '4': case '5':
1231 case '6': case '7': case '8': case '9':
1232 break;
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001233 case 'q':
1234 break;
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001235#ifdef CONFIG_GUNZIP
Matt Kraai53265542001-04-18 16:05:34 +00001236 case 'd':
1237 optind = 1;
1238 return gunzip_main(argc, argv);
Glenn L McGrath528ef502001-04-11 03:45:37 +00001239#endif
Matt Kraai53265542001-04-18 16:05:34 +00001240 default:
1241 show_usage();
Erik Andersene49d5ec2000-02-08 19:58:47 +00001242 }
1243 }
Glenn L McGrath74999182001-07-30 04:48:50 +00001244 if ((optind == argc) || (strcmp(argv[optind], "-") == 0)) {
Eric Andersenea824fb2000-07-21 22:17:39 +00001245 fromstdin = 1;
Eric Andersen5eb59122000-09-01 00:33:06 +00001246 tostdout = 1;
1247 }
Eric Andersenea824fb2000-07-21 22:17:39 +00001248
Eric Andersenea824fb2000-07-21 22:17:39 +00001249 if (isatty(fileno(stdout)) && tostdout==1 && force==0)
Matt Kraai53265542001-04-18 16:05:34 +00001250 error_msg_and_die( "compressed data not written to terminal. Use -f to force it.");
Erik Andersene49d5ec2000-02-08 19:58:47 +00001251
1252 foreground = signal(SIGINT, SIG_IGN) != SIG_IGN;
1253 if (foreground) {
1254 (void) signal(SIGINT, (sig_type) abort_gzip);
1255 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001256#ifdef SIGTERM
Erik Andersene49d5ec2000-02-08 19:58:47 +00001257 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
1258 (void) signal(SIGTERM, (sig_type) abort_gzip);
1259 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001260#endif
1261#ifdef SIGHUP
Erik Andersene49d5ec2000-02-08 19:58:47 +00001262 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
1263 (void) signal(SIGHUP, (sig_type) abort_gzip);
1264 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001265#endif
1266
Erik Andersene49d5ec2000-02-08 19:58:47 +00001267 strncpy(z_suffix, Z_SUFFIX, sizeof(z_suffix) - 1);
1268 z_len = strlen(z_suffix);
Eric Andersencc8ed391999-10-05 16:24:54 +00001269
Erik Andersene49d5ec2000-02-08 19:58:47 +00001270 /* Allocate all global buffers (for DYN_ALLOC option) */
1271 ALLOC(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
1272 ALLOC(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
1273 ALLOC(ush, d_buf, DIST_BUFSIZE);
1274 ALLOC(uch, window, 2L * WSIZE);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001275 ALLOC(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +00001276
Erik Andersene49d5ec2000-02-08 19:58:47 +00001277 if (fromstdin == 1) {
1278 strcpy(ofname, "stdin");
Eric Andersen96bcfd31999-11-12 01:30:18 +00001279
Erik Andersene49d5ec2000-02-08 19:58:47 +00001280 inFileNum = fileno(stdin);
1281 time_stamp = 0; /* time unknown by default */
1282 ifile_size = -1L; /* convention for unknown size */
1283 } else {
1284 /* Open up the input file */
Matt Kraai53265542001-04-18 16:05:34 +00001285 strncpy(ifname, argv[optind], MAX_PATH_LEN);
Eric Andersen96bcfd31999-11-12 01:30:18 +00001286
Matt Kraaia9819b22000-12-22 01:48:07 +00001287 /* Open input file */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001288 inFileNum = open(ifname, O_RDONLY);
Eric Andersen39eb0402001-08-22 04:15:47 +00001289 if (inFileNum < 0 || stat(ifname, &statBuf) < 0)
Matt Kraaia9819b22000-12-22 01:48:07 +00001290 perror_msg_and_die("%s", ifname);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001291 /* Get the time stamp on the input file. */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001292 time_stamp = statBuf.st_ctime;
1293 ifile_size = statBuf.st_size;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001294 }
Eric Andersen96bcfd31999-11-12 01:30:18 +00001295
1296
Erik Andersene49d5ec2000-02-08 19:58:47 +00001297 if (tostdout == 1) {
1298 /* And get to work */
1299 strcpy(ofname, "stdout");
1300 outFileNum = fileno(stdout);
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001301
Erik Andersene49d5ec2000-02-08 19:58:47 +00001302 clear_bufs(); /* clear input and output buffers */
1303 part_nb = 0;
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001304
Erik Andersene49d5ec2000-02-08 19:58:47 +00001305 /* Actually do the compression/decompression. */
1306 zip(inFileNum, outFileNum);
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001307
Erik Andersene49d5ec2000-02-08 19:58:47 +00001308 } else {
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001309
Erik Andersene49d5ec2000-02-08 19:58:47 +00001310 /* And get to work */
1311 strncpy(ofname, ifname, MAX_PATH_LEN - 4);
1312 strcat(ofname, ".gz");
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001313
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001314
Erik Andersene49d5ec2000-02-08 19:58:47 +00001315 /* Open output fille */
Erik Andersen4d1d0111999-12-17 18:44:15 +00001316#if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
Erik Andersene49d5ec2000-02-08 19:58:47 +00001317 outFileNum = open(ofname, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001318#else
Erik Andersene49d5ec2000-02-08 19:58:47 +00001319 outFileNum = open(ofname, O_RDWR | O_CREAT | O_EXCL);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001320#endif
Matt Kraaia9819b22000-12-22 01:48:07 +00001321 if (outFileNum < 0)
1322 perror_msg_and_die("%s", ofname);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001323 /* Set permissions on the file */
1324 fchmod(outFileNum, statBuf.st_mode);
1325
1326 clear_bufs(); /* clear input and output buffers */
1327 part_nb = 0;
1328
1329 /* Actually do the compression/decompression. */
1330 result = zip(inFileNum, outFileNum);
1331 close(outFileNum);
1332 close(inFileNum);
1333 /* Delete the original file */
1334 if (result == OK)
1335 delFileName = ifname;
1336 else
1337 delFileName = ofname;
1338
Matt Kraaia9819b22000-12-22 01:48:07 +00001339 if (unlink(delFileName) < 0)
1340 perror_msg_and_die("%s", delFileName);
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001341 }
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001342
Eric Andersenb6106152000-06-19 17:25:40 +00001343 return(exit_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001344}
1345
Eric Andersencc8ed391999-10-05 16:24:54 +00001346/* trees.c -- output deflated data using Huffman coding
1347 * Copyright (C) 1992-1993 Jean-loup Gailly
1348 * This is free software; you can redistribute it and/or modify it under the
1349 * terms of the GNU General Public License, see the file COPYING.
1350 */
1351
1352/*
1353 * PURPOSE
1354 *
1355 * Encode various sets of source values using variable-length
1356 * binary code trees.
1357 *
1358 * DISCUSSION
1359 *
1360 * The PKZIP "deflation" process uses several Huffman trees. The more
1361 * common source values are represented by shorter bit sequences.
1362 *
1363 * Each code tree is stored in the ZIP file in a compressed form
1364 * which is itself a Huffman encoding of the lengths of
1365 * all the code strings (in ascending order by source values).
1366 * The actual code strings are reconstructed from the lengths in
1367 * the UNZIP process, as described in the "application note"
1368 * (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
1369 *
1370 * REFERENCES
1371 *
1372 * Lynch, Thomas J.
1373 * Data Compression: Techniques and Applications, pp. 53-55.
1374 * Lifetime Learning Publications, 1985. ISBN 0-534-03418-7.
1375 *
1376 * Storer, James A.
1377 * Data Compression: Methods and Theory, pp. 49-50.
1378 * Computer Science Press, 1988. ISBN 0-7167-8156-5.
1379 *
1380 * Sedgewick, R.
1381 * Algorithms, p290.
1382 * Addison-Wesley, 1983. ISBN 0-201-06672-6.
1383 *
1384 * INTERFACE
1385 *
1386 * void ct_init (ush *attr, int *methodp)
1387 * Allocate the match buffer, initialize the various tables and save
1388 * the location of the internal file attribute (ascii/binary) and
1389 * method (DEFLATE/STORE)
1390 *
1391 * void ct_tally (int dist, int lc);
1392 * Save the match info and tally the frequency counts.
1393 *
1394 * long flush_block (char *buf, ulg stored_len, int eof)
1395 * Determine the best encoding for the current block: dynamic trees,
1396 * static trees or store, and output the encoded block to the zip
1397 * file. Returns the total compressed length for the file so far.
1398 *
1399 */
1400
Eric Andersencc8ed391999-10-05 16:24:54 +00001401/* ===========================================================================
1402 * Constants
1403 */
1404
1405#define MAX_BITS 15
1406/* All codes must not exceed MAX_BITS bits */
1407
1408#define MAX_BL_BITS 7
1409/* Bit length codes must not exceed MAX_BL_BITS bits */
1410
1411#define LENGTH_CODES 29
1412/* number of length codes, not counting the special END_BLOCK code */
1413
1414#define LITERALS 256
1415/* number of literal bytes 0..255 */
1416
1417#define END_BLOCK 256
1418/* end of block literal code */
1419
1420#define L_CODES (LITERALS+1+LENGTH_CODES)
1421/* number of Literal or Length codes, including the END_BLOCK code */
1422
1423#define D_CODES 30
1424/* number of distance codes */
1425
1426#define BL_CODES 19
1427/* number of codes used to transfer the bit lengths */
1428
Eric Andersen39eb0402001-08-22 04:15:47 +00001429typedef uch extra_bits_t;
Eric Andersencc8ed391999-10-05 16:24:54 +00001430
Eric Andersen39eb0402001-08-22 04:15:47 +00001431/* extra bits for each length code */
1432static const extra_bits_t extra_lbits[LENGTH_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001433 = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
1434 4, 4, 5, 5, 5, 5, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001435
Eric Andersen39eb0402001-08-22 04:15:47 +00001436/* extra bits for each distance code */
1437static const extra_bits_t extra_dbits[D_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001438 = { 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
1439 10, 10, 11, 11, 12, 12, 13, 13 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001440
Eric Andersen39eb0402001-08-22 04:15:47 +00001441/* extra bits for each bit length code */
1442static const extra_bits_t extra_blbits[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001443= { 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 +00001444
1445#define STORED_BLOCK 0
1446#define STATIC_TREES 1
1447#define DYN_TREES 2
1448/* The three kinds of block type */
1449
1450#ifndef LIT_BUFSIZE
1451# ifdef SMALL_MEM
1452# define LIT_BUFSIZE 0x2000
1453# else
1454# ifdef MEDIUM_MEM
1455# define LIT_BUFSIZE 0x4000
1456# else
1457# define LIT_BUFSIZE 0x8000
1458# endif
1459# endif
1460#endif
1461#ifndef DIST_BUFSIZE
1462# define DIST_BUFSIZE LIT_BUFSIZE
1463#endif
1464/* Sizes of match buffers for literals/lengths and distances. There are
1465 * 4 reasons for limiting LIT_BUFSIZE to 64K:
1466 * - frequencies can be kept in 16 bit counters
1467 * - if compression is not successful for the first block, all input data is
1468 * still in the window so we can still emit a stored block even when input
1469 * comes from standard input. (This can also be done for all blocks if
1470 * LIT_BUFSIZE is not greater than 32K.)
1471 * - if compression is not successful for a file smaller than 64K, we can
1472 * even emit a stored file instead of a stored block (saving 5 bytes).
1473 * - creating new Huffman trees less frequently may not provide fast
1474 * adaptation to changes in the input data statistics. (Take for
1475 * example a binary file with poorly compressible code followed by
1476 * a highly compressible string table.) Smaller buffer sizes give
1477 * fast adaptation but have of course the overhead of transmitting trees
1478 * more frequently.
1479 * - I can't count above 4
1480 * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
1481 * memory at the expense of compression). Some optimizations would be possible
1482 * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
1483 */
1484#if LIT_BUFSIZE > INBUFSIZ
Aaron Lehmannb9df4702001-12-06 03:22:43 +00001485#error cannot overlay l_buf and inbuf
Eric Andersencc8ed391999-10-05 16:24:54 +00001486#endif
Eric Andersencc8ed391999-10-05 16:24:54 +00001487#define REP_3_6 16
1488/* repeat previous bit length 3-6 times (2 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001489#define REPZ_3_10 17
1490/* repeat a zero length 3-10 times (3 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001491#define REPZ_11_138 18
Erik Andersene49d5ec2000-02-08 19:58:47 +00001492/* repeat a zero length 11-138 times (7 bits of repeat count) *//* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +00001493 * Local data
Erik Andersene49d5ec2000-02-08 19:58:47 +00001494 *//* Data structure describing a single value and its code string. */ typedef struct ct_data {
1495 union {
1496 ush freq; /* frequency count */
1497 ush code; /* bit string */
1498 } fc;
1499 union {
1500 ush dad; /* father node in Huffman tree */
1501 ush len; /* length of bit string */
1502 } dl;
Eric Andersencc8ed391999-10-05 16:24:54 +00001503} ct_data;
1504
1505#define Freq fc.freq
1506#define Code fc.code
1507#define Dad dl.dad
1508#define Len dl.len
1509
1510#define HEAP_SIZE (2*L_CODES+1)
1511/* maximum heap size */
1512
Eric Andersen3073dfb2001-07-02 17:57:32 +00001513static ct_data dyn_ltree[HEAP_SIZE]; /* literal and length tree */
1514static ct_data dyn_dtree[2 * D_CODES + 1]; /* distance tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001515
Eric Andersen3073dfb2001-07-02 17:57:32 +00001516static ct_data static_ltree[L_CODES + 2];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001517
Eric Andersencc8ed391999-10-05 16:24:54 +00001518/* The static literal tree. Since the bit lengths are imposed, there is no
1519 * need for the L_CODES extra codes used during heap construction. However
1520 * The codes 286 and 287 are needed to build a canonical tree (see ct_init
1521 * below).
1522 */
1523
Eric Andersen3073dfb2001-07-02 17:57:32 +00001524static ct_data static_dtree[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001525
Eric Andersencc8ed391999-10-05 16:24:54 +00001526/* The static distance tree. (Actually a trivial tree since all codes use
1527 * 5 bits.)
1528 */
1529
Eric Andersen3073dfb2001-07-02 17:57:32 +00001530static ct_data bl_tree[2 * BL_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001531
Eric Andersencc8ed391999-10-05 16:24:54 +00001532/* Huffman tree for the bit lengths */
1533
1534typedef struct tree_desc {
Eric Andersen3073dfb2001-07-02 17:57:32 +00001535 ct_data *dyn_tree; /* the dynamic tree */
1536 ct_data *static_tree; /* corresponding static tree or NULL */
Eric Andersen39eb0402001-08-22 04:15:47 +00001537 const extra_bits_t *extra_bits; /* extra bits for each code or NULL */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001538 int extra_base; /* base index for extra_bits */
1539 int elems; /* max number of elements in the tree */
1540 int max_length; /* max bit length for the codes */
1541 int max_code; /* largest code with non zero frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00001542} tree_desc;
1543
Eric Andersen3073dfb2001-07-02 17:57:32 +00001544static tree_desc l_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001545 { dyn_ltree, static_ltree, extra_lbits, LITERALS + 1, L_CODES,
1546 MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001547
Eric Andersen3073dfb2001-07-02 17:57:32 +00001548static tree_desc d_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001549 { dyn_dtree, static_dtree, extra_dbits, 0, D_CODES, MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001550
Eric Andersen3073dfb2001-07-02 17:57:32 +00001551static tree_desc bl_desc =
1552 { bl_tree, (ct_data *) 0, extra_blbits, 0, BL_CODES, MAX_BL_BITS,
Erik Andersene49d5ec2000-02-08 19:58:47 +00001553 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001554
1555
Eric Andersen3073dfb2001-07-02 17:57:32 +00001556static ush bl_count[MAX_BITS + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001557
Eric Andersencc8ed391999-10-05 16:24:54 +00001558/* number of codes at each bit length for an optimal tree */
1559
Eric Andersen3073dfb2001-07-02 17:57:32 +00001560static const uch bl_order[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001561= { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
1562
Eric Andersencc8ed391999-10-05 16:24:54 +00001563/* The lengths of the bit length codes are sent in order of decreasing
1564 * probability, to avoid transmitting the lengths for unused bit length codes.
1565 */
1566
Eric Andersen3073dfb2001-07-02 17:57:32 +00001567static int heap[2 * L_CODES + 1]; /* heap used to build the Huffman trees */
1568static int heap_len; /* number of elements in the heap */
1569static int heap_max; /* element of largest frequency */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001570
Eric Andersencc8ed391999-10-05 16:24:54 +00001571/* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
1572 * The same heap array is used to build all trees.
1573 */
1574
Eric Andersen3073dfb2001-07-02 17:57:32 +00001575static uch depth[2 * L_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001576
Eric Andersencc8ed391999-10-05 16:24:54 +00001577/* Depth of each subtree used as tie breaker for trees of equal frequency */
1578
Eric Andersen3073dfb2001-07-02 17:57:32 +00001579static uch length_code[MAX_MATCH - MIN_MATCH + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001580
Eric Andersencc8ed391999-10-05 16:24:54 +00001581/* length code for each normalized match length (0 == MIN_MATCH) */
1582
Eric Andersen3073dfb2001-07-02 17:57:32 +00001583static uch dist_code[512];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001584
Eric Andersencc8ed391999-10-05 16:24:54 +00001585/* distance codes. The first 256 values correspond to the distances
1586 * 3 .. 258, the last 256 values correspond to the top 8 bits of
1587 * the 15 bit distances.
1588 */
1589
Eric Andersen3073dfb2001-07-02 17:57:32 +00001590static int base_length[LENGTH_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001591
Eric Andersencc8ed391999-10-05 16:24:54 +00001592/* First normalized length for each code (0 = MIN_MATCH) */
1593
Eric Andersen3073dfb2001-07-02 17:57:32 +00001594static int base_dist[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001595
Eric Andersencc8ed391999-10-05 16:24:54 +00001596/* First normalized distance for each code (0 = distance of 1) */
1597
1598#define l_buf inbuf
1599/* DECLARE(uch, l_buf, LIT_BUFSIZE); buffer for literals or lengths */
1600
1601/* DECLARE(ush, d_buf, DIST_BUFSIZE); buffer for distances */
1602
Eric Andersen3073dfb2001-07-02 17:57:32 +00001603static uch flag_buf[(LIT_BUFSIZE / 8)];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001604
Eric Andersencc8ed391999-10-05 16:24:54 +00001605/* flag_buf is a bit array distinguishing literals from lengths in
1606 * l_buf, thus indicating the presence or absence of a distance.
1607 */
1608
Eric Andersen3073dfb2001-07-02 17:57:32 +00001609static unsigned last_lit; /* running index in l_buf */
1610static unsigned last_dist; /* running index in d_buf */
1611static unsigned last_flags; /* running index in flag_buf */
1612static uch flags; /* current flags not yet saved in flag_buf */
1613static uch flag_bit; /* current bit used in flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001614
Eric Andersencc8ed391999-10-05 16:24:54 +00001615/* bits are filled in flags starting at bit 0 (least significant).
1616 * Note: these flags are overkill in the current code since we don't
1617 * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1618 */
1619
Eric Andersen3073dfb2001-07-02 17:57:32 +00001620static ulg opt_len; /* bit length of current block with optimal trees */
1621static ulg static_len; /* bit length of current block with static trees */
Eric Andersencc8ed391999-10-05 16:24:54 +00001622
Eric Andersen3073dfb2001-07-02 17:57:32 +00001623static ulg compressed_len; /* total bit length of compressed file */
Eric Andersencc8ed391999-10-05 16:24:54 +00001624
Erik Andersene49d5ec2000-02-08 19:58:47 +00001625
Eric Andersen3073dfb2001-07-02 17:57:32 +00001626static ush *file_type; /* pointer to UNKNOWN, BINARY or ASCII */
1627static int *file_method; /* pointer to DEFLATE or STORE */
Eric Andersencc8ed391999-10-05 16:24:54 +00001628
1629/* ===========================================================================
1630 * Local (static) routines in this file.
1631 */
1632
Eric Andersen3073dfb2001-07-02 17:57:32 +00001633static void init_block (void);
1634static void pqdownheap (ct_data * tree, int k);
1635static void gen_bitlen (tree_desc * desc);
1636static void gen_codes (ct_data * tree, int max_code);
1637static void build_tree (tree_desc * desc);
1638static void scan_tree (ct_data * tree, int max_code);
1639static void send_tree (ct_data * tree, int max_code);
1640static int build_bl_tree (void);
1641static void send_all_trees (int lcodes, int dcodes, int blcodes);
1642static void compress_block (ct_data * ltree, ct_data * dtree);
1643static void set_file_type (void);
Eric Andersencc8ed391999-10-05 16:24:54 +00001644
1645
1646#ifndef DEBUG
1647# define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
1648 /* Send a code of the given tree. c and tree must not have side effects */
1649
Erik Andersene49d5ec2000-02-08 19:58:47 +00001650#else /* DEBUG */
Eric Andersencc8ed391999-10-05 16:24:54 +00001651# define send_code(c, tree) \
1652 { if (verbose>1) fprintf(stderr,"\ncd %3d ",(c)); \
1653 send_bits(tree[c].Code, tree[c].Len); }
1654#endif
1655
1656#define d_code(dist) \
1657 ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
1658/* Mapping from a distance to a distance code. dist is the distance - 1 and
1659 * must not have side effects. dist_code[256] and dist_code[257] are never
1660 * used.
1661 */
1662
Eric Andersencc8ed391999-10-05 16:24:54 +00001663/* the arguments must not have side effects */
1664
1665/* ===========================================================================
1666 * Allocate the match buffer, initialize the various tables and save the
1667 * location of the internal file attribute (ascii/binary) and method
1668 * (DEFLATE/STORE).
1669 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001670static void ct_init(ush *attr, int *methodp)
Eric Andersencc8ed391999-10-05 16:24:54 +00001671{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001672 int n; /* iterates over tree elements */
1673 int bits; /* bit counter */
1674 int length; /* length value */
1675 int code; /* code value */
1676 int dist; /* distance index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001677
Erik Andersene49d5ec2000-02-08 19:58:47 +00001678 file_type = attr;
1679 file_method = methodp;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001680 compressed_len = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +00001681
Erik Andersene49d5ec2000-02-08 19:58:47 +00001682 if (static_dtree[0].Len != 0)
1683 return; /* ct_init already called */
Eric Andersencc8ed391999-10-05 16:24:54 +00001684
Erik Andersene49d5ec2000-02-08 19:58:47 +00001685 /* Initialize the mapping length (0..255) -> length code (0..28) */
1686 length = 0;
1687 for (code = 0; code < LENGTH_CODES - 1; code++) {
1688 base_length[code] = length;
1689 for (n = 0; n < (1 << extra_lbits[code]); n++) {
1690 length_code[length++] = (uch) code;
1691 }
1692 }
1693 Assert(length == 256, "ct_init: length != 256");
1694 /* Note that the length 255 (match length 258) can be represented
1695 * in two different ways: code 284 + 5 bits or code 285, so we
1696 * overwrite length_code[255] to use the best encoding:
1697 */
1698 length_code[length - 1] = (uch) code;
Eric Andersencc8ed391999-10-05 16:24:54 +00001699
Erik Andersene49d5ec2000-02-08 19:58:47 +00001700 /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1701 dist = 0;
1702 for (code = 0; code < 16; code++) {
1703 base_dist[code] = dist;
1704 for (n = 0; n < (1 << extra_dbits[code]); n++) {
1705 dist_code[dist++] = (uch) code;
1706 }
1707 }
1708 Assert(dist == 256, "ct_init: dist != 256");
1709 dist >>= 7; /* from now on, all distances are divided by 128 */
1710 for (; code < D_CODES; code++) {
1711 base_dist[code] = dist << 7;
1712 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
1713 dist_code[256 + dist++] = (uch) code;
1714 }
1715 }
1716 Assert(dist == 256, "ct_init: 256+dist != 512");
Eric Andersencc8ed391999-10-05 16:24:54 +00001717
Erik Andersene49d5ec2000-02-08 19:58:47 +00001718 /* Construct the codes of the static literal tree */
1719 for (bits = 0; bits <= MAX_BITS; bits++)
1720 bl_count[bits] = 0;
1721 n = 0;
1722 while (n <= 143)
1723 static_ltree[n++].Len = 8, bl_count[8]++;
1724 while (n <= 255)
1725 static_ltree[n++].Len = 9, bl_count[9]++;
1726 while (n <= 279)
1727 static_ltree[n++].Len = 7, bl_count[7]++;
1728 while (n <= 287)
1729 static_ltree[n++].Len = 8, bl_count[8]++;
1730 /* Codes 286 and 287 do not exist, but we must include them in the
1731 * tree construction to get a canonical Huffman tree (longest code
1732 * all ones)
1733 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001734 gen_codes((ct_data *) static_ltree, L_CODES + 1);
Eric Andersencc8ed391999-10-05 16:24:54 +00001735
Erik Andersene49d5ec2000-02-08 19:58:47 +00001736 /* The static distance tree is trivial: */
1737 for (n = 0; n < D_CODES; n++) {
1738 static_dtree[n].Len = 5;
1739 static_dtree[n].Code = bi_reverse(n, 5);
1740 }
1741
1742 /* Initialize the first block of the first file: */
1743 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00001744}
1745
1746/* ===========================================================================
1747 * Initialize a new block.
1748 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001749static void init_block()
Eric Andersencc8ed391999-10-05 16:24:54 +00001750{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001751 int n; /* iterates over tree elements */
Eric Andersencc8ed391999-10-05 16:24:54 +00001752
Erik Andersene49d5ec2000-02-08 19:58:47 +00001753 /* Initialize the trees. */
1754 for (n = 0; n < L_CODES; n++)
1755 dyn_ltree[n].Freq = 0;
1756 for (n = 0; n < D_CODES; n++)
1757 dyn_dtree[n].Freq = 0;
1758 for (n = 0; n < BL_CODES; n++)
1759 bl_tree[n].Freq = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001760
Erik Andersene49d5ec2000-02-08 19:58:47 +00001761 dyn_ltree[END_BLOCK].Freq = 1;
1762 opt_len = static_len = 0L;
1763 last_lit = last_dist = last_flags = 0;
1764 flags = 0;
1765 flag_bit = 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001766}
1767
1768#define SMALLEST 1
1769/* Index within the heap array of least frequent node in the Huffman tree */
1770
1771
1772/* ===========================================================================
1773 * Remove the smallest element from the heap and recreate the heap with
1774 * one less element. Updates heap and heap_len.
1775 */
1776#define pqremove(tree, top) \
1777{\
1778 top = heap[SMALLEST]; \
1779 heap[SMALLEST] = heap[heap_len--]; \
1780 pqdownheap(tree, SMALLEST); \
1781}
1782
1783/* ===========================================================================
1784 * Compares to subtrees, using the tree depth as tie breaker when
1785 * the subtrees have equal frequency. This minimizes the worst case length.
1786 */
1787#define smaller(tree, n, m) \
1788 (tree[n].Freq < tree[m].Freq || \
1789 (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
1790
1791/* ===========================================================================
1792 * Restore the heap property by moving down the tree starting at node k,
1793 * exchanging a node with the smallest of its two sons if necessary, stopping
1794 * when the heap property is re-established (each father smaller than its
1795 * two sons).
1796 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001797static void pqdownheap(ct_data *tree, int k)
Eric Andersencc8ed391999-10-05 16:24:54 +00001798{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001799 int v = heap[k];
1800 int j = k << 1; /* left son of k */
Eric Andersencc8ed391999-10-05 16:24:54 +00001801
Erik Andersene49d5ec2000-02-08 19:58:47 +00001802 while (j <= heap_len) {
1803 /* Set j to the smallest of the two sons: */
1804 if (j < heap_len && smaller(tree, heap[j + 1], heap[j]))
1805 j++;
Eric Andersencc8ed391999-10-05 16:24:54 +00001806
Erik Andersene49d5ec2000-02-08 19:58:47 +00001807 /* Exit if v is smaller than both sons */
1808 if (smaller(tree, v, heap[j]))
1809 break;
Eric Andersencc8ed391999-10-05 16:24:54 +00001810
Erik Andersene49d5ec2000-02-08 19:58:47 +00001811 /* Exchange v with the smallest son */
1812 heap[k] = heap[j];
1813 k = j;
1814
1815 /* And continue down the tree, setting j to the left son of k */
1816 j <<= 1;
1817 }
1818 heap[k] = v;
Eric Andersencc8ed391999-10-05 16:24:54 +00001819}
1820
1821/* ===========================================================================
1822 * Compute the optimal bit lengths for a tree and update the total bit length
1823 * for the current block.
1824 * IN assertion: the fields freq and dad are set, heap[heap_max] and
1825 * above are the tree nodes sorted by increasing frequency.
1826 * OUT assertions: the field len is set to the optimal bit length, the
1827 * array bl_count contains the frequencies for each bit length.
1828 * The length opt_len is updated; static_len is also updated if stree is
1829 * not null.
1830 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001831static void gen_bitlen(tree_desc *desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001832{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001833 ct_data *tree = desc->dyn_tree;
Eric Andersen39eb0402001-08-22 04:15:47 +00001834 const extra_bits_t *extra = desc->extra_bits;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001835 int base = desc->extra_base;
1836 int max_code = desc->max_code;
1837 int max_length = desc->max_length;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001838 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001839 int h; /* heap index */
1840 int n, m; /* iterate over the tree elements */
1841 int bits; /* bit length */
1842 int xbits; /* extra bits */
1843 ush f; /* frequency */
1844 int overflow = 0; /* number of elements with bit length too large */
Eric Andersencc8ed391999-10-05 16:24:54 +00001845
Erik Andersene49d5ec2000-02-08 19:58:47 +00001846 for (bits = 0; bits <= MAX_BITS; bits++)
1847 bl_count[bits] = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001848
Erik Andersene49d5ec2000-02-08 19:58:47 +00001849 /* In a first pass, compute the optimal bit lengths (which may
1850 * overflow in the case of the bit length tree).
1851 */
1852 tree[heap[heap_max]].Len = 0; /* root of the heap */
Eric Andersencc8ed391999-10-05 16:24:54 +00001853
Erik Andersene49d5ec2000-02-08 19:58:47 +00001854 for (h = heap_max + 1; h < HEAP_SIZE; h++) {
1855 n = heap[h];
1856 bits = tree[tree[n].Dad].Len + 1;
1857 if (bits > max_length)
1858 bits = max_length, overflow++;
1859 tree[n].Len = (ush) bits;
1860 /* We overwrite tree[n].Dad which is no longer needed */
Eric Andersencc8ed391999-10-05 16:24:54 +00001861
Erik Andersene49d5ec2000-02-08 19:58:47 +00001862 if (n > max_code)
1863 continue; /* not a leaf node */
Eric Andersencc8ed391999-10-05 16:24:54 +00001864
Erik Andersene49d5ec2000-02-08 19:58:47 +00001865 bl_count[bits]++;
1866 xbits = 0;
1867 if (n >= base)
1868 xbits = extra[n - base];
1869 f = tree[n].Freq;
1870 opt_len += (ulg) f *(bits + xbits);
Eric Andersencc8ed391999-10-05 16:24:54 +00001871
Erik Andersene49d5ec2000-02-08 19:58:47 +00001872 if (stree)
1873 static_len += (ulg) f *(stree[n].Len + xbits);
1874 }
1875 if (overflow == 0)
1876 return;
Eric Andersencc8ed391999-10-05 16:24:54 +00001877
Erik Andersene49d5ec2000-02-08 19:58:47 +00001878 Trace((stderr, "\nbit length overflow\n"));
1879 /* This happens for example on obj2 and pic of the Calgary corpus */
Eric Andersencc8ed391999-10-05 16:24:54 +00001880
Erik Andersene49d5ec2000-02-08 19:58:47 +00001881 /* Find the first bit length which could increase: */
1882 do {
1883 bits = max_length - 1;
1884 while (bl_count[bits] == 0)
1885 bits--;
1886 bl_count[bits]--; /* move one leaf down the tree */
1887 bl_count[bits + 1] += 2; /* move one overflow item as its brother */
1888 bl_count[max_length]--;
1889 /* The brother of the overflow item also moves one step up,
1890 * but this does not affect bl_count[max_length]
1891 */
1892 overflow -= 2;
1893 } while (overflow > 0);
1894
1895 /* Now recompute all bit lengths, scanning in increasing frequency.
1896 * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1897 * lengths instead of fixing only the wrong ones. This idea is taken
1898 * from 'ar' written by Haruhiko Okumura.)
1899 */
1900 for (bits = max_length; bits != 0; bits--) {
1901 n = bl_count[bits];
1902 while (n != 0) {
1903 m = heap[--h];
1904 if (m > max_code)
1905 continue;
1906 if (tree[m].Len != (unsigned) bits) {
1907 Trace(
1908 (stderr, "code %d bits %d->%d\n", m, tree[m].Len,
1909 bits));
1910 opt_len +=
1911 ((long) bits -
1912 (long) tree[m].Len) * (long) tree[m].Freq;
1913 tree[m].Len = (ush) bits;
1914 }
1915 n--;
1916 }
1917 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001918}
1919
1920/* ===========================================================================
1921 * Generate the codes for a given tree and bit counts (which need not be
1922 * optimal).
1923 * IN assertion: the array bl_count contains the bit length statistics for
1924 * the given tree and the field len is set for all tree elements.
1925 * OUT assertion: the field code is set for all tree elements of non
1926 * zero code length.
1927 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001928static void gen_codes(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001929{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001930 ush next_code[MAX_BITS + 1]; /* next code value for each bit length */
1931 ush code = 0; /* running code value */
1932 int bits; /* bit index */
1933 int n; /* code index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001934
Erik Andersene49d5ec2000-02-08 19:58:47 +00001935 /* The distribution counts are first used to generate the code values
1936 * without bit reversal.
1937 */
1938 for (bits = 1; bits <= MAX_BITS; bits++) {
1939 next_code[bits] = code = (code + bl_count[bits - 1]) << 1;
1940 }
1941 /* Check that the bit counts in bl_count are consistent. The last code
1942 * must be all ones.
1943 */
1944 Assert(code + bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1945 "inconsistent bit counts");
1946 Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
Eric Andersencc8ed391999-10-05 16:24:54 +00001947
Erik Andersene49d5ec2000-02-08 19:58:47 +00001948 for (n = 0; n <= max_code; n++) {
1949 int len = tree[n].Len;
Eric Andersencc8ed391999-10-05 16:24:54 +00001950
Erik Andersene49d5ec2000-02-08 19:58:47 +00001951 if (len == 0)
1952 continue;
1953 /* Now reverse the bits */
1954 tree[n].Code = bi_reverse(next_code[len]++, len);
1955
1956 Tracec(tree != static_ltree,
1957 (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1958 (isgraph(n) ? n : ' '), len, tree[n].Code,
1959 next_code[len] - 1));
1960 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001961}
1962
1963/* ===========================================================================
1964 * Construct one Huffman tree and assigns the code bit strings and lengths.
1965 * Update the total bit length for the current block.
1966 * IN assertion: the field freq is set for all tree elements.
1967 * OUT assertions: the fields len and code are set to the optimal bit length
1968 * and corresponding code. The length opt_len is updated; static_len is
1969 * also updated if stree is not null. The field max_code is set.
1970 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001971static void build_tree(tree_desc *desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001972{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001973 ct_data *tree = desc->dyn_tree;
1974 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001975 int elems = desc->elems;
1976 int n, m; /* iterate over heap elements */
1977 int max_code = -1; /* largest code with non zero frequency */
1978 int node = elems; /* next internal node of the tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001979
Erik Andersene49d5ec2000-02-08 19:58:47 +00001980 /* Construct the initial heap, with least frequent element in
1981 * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1982 * heap[0] is not used.
1983 */
1984 heap_len = 0, heap_max = HEAP_SIZE;
Eric Andersencc8ed391999-10-05 16:24:54 +00001985
Erik Andersene49d5ec2000-02-08 19:58:47 +00001986 for (n = 0; n < elems; n++) {
1987 if (tree[n].Freq != 0) {
1988 heap[++heap_len] = max_code = n;
1989 depth[n] = 0;
1990 } else {
1991 tree[n].Len = 0;
1992 }
1993 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001994
Erik Andersene49d5ec2000-02-08 19:58:47 +00001995 /* The pkzip format requires that at least one distance code exists,
1996 * and that at least one bit should be sent even if there is only one
1997 * possible code. So to avoid special checks later on we force at least
1998 * two codes of non zero frequency.
1999 */
2000 while (heap_len < 2) {
2001 int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002002
Erik Andersene49d5ec2000-02-08 19:58:47 +00002003 tree[new].Freq = 1;
2004 depth[new] = 0;
2005 opt_len--;
2006 if (stree)
2007 static_len -= stree[new].Len;
2008 /* new is 0 or 1 so it does not have extra bits */
2009 }
2010 desc->max_code = max_code;
Eric Andersencc8ed391999-10-05 16:24:54 +00002011
Erik Andersene49d5ec2000-02-08 19:58:47 +00002012 /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
2013 * establish sub-heaps of increasing lengths:
2014 */
2015 for (n = heap_len / 2; n >= 1; n--)
2016 pqdownheap(tree, n);
Eric Andersencc8ed391999-10-05 16:24:54 +00002017
Erik Andersene49d5ec2000-02-08 19:58:47 +00002018 /* Construct the Huffman tree by repeatedly combining the least two
2019 * frequent nodes.
2020 */
2021 do {
2022 pqremove(tree, n); /* n = node of least frequency */
2023 m = heap[SMALLEST]; /* m = node of next least frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00002024
Erik Andersene49d5ec2000-02-08 19:58:47 +00002025 heap[--heap_max] = n; /* keep the nodes sorted by frequency */
2026 heap[--heap_max] = m;
2027
2028 /* Create a new node father of n and m */
2029 tree[node].Freq = tree[n].Freq + tree[m].Freq;
2030 depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
2031 tree[n].Dad = tree[m].Dad = (ush) node;
Eric Andersencc8ed391999-10-05 16:24:54 +00002032#ifdef DUMP_BL_TREE
Erik Andersene49d5ec2000-02-08 19:58:47 +00002033 if (tree == bl_tree) {
2034 fprintf(stderr, "\nnode %d(%d), sons %d(%d) %d(%d)",
2035 node, tree[node].Freq, n, tree[n].Freq, m,
2036 tree[m].Freq);
2037 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002038#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +00002039 /* and insert the new node in the heap */
2040 heap[SMALLEST] = node++;
2041 pqdownheap(tree, SMALLEST);
Eric Andersencc8ed391999-10-05 16:24:54 +00002042
Erik Andersene49d5ec2000-02-08 19:58:47 +00002043 } while (heap_len >= 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002044
Erik Andersene49d5ec2000-02-08 19:58:47 +00002045 heap[--heap_max] = heap[SMALLEST];
Eric Andersencc8ed391999-10-05 16:24:54 +00002046
Erik Andersene49d5ec2000-02-08 19:58:47 +00002047 /* At this point, the fields freq and dad are set. We can now
2048 * generate the bit lengths.
2049 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002050 gen_bitlen((tree_desc *) desc);
Eric Andersencc8ed391999-10-05 16:24:54 +00002051
Erik Andersene49d5ec2000-02-08 19:58:47 +00002052 /* The field len is now set, we can generate the bit codes */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002053 gen_codes((ct_data *) tree, max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002054}
2055
2056/* ===========================================================================
2057 * Scan a literal or distance tree to determine the frequencies of the codes
2058 * in the bit length tree. Updates opt_len to take into account the repeat
2059 * counts. (The contribution of the bit length codes will be added later
2060 * during the construction of bl_tree.)
2061 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002062static void scan_tree(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002063{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002064 int n; /* iterates over all tree elements */
2065 int prevlen = -1; /* last emitted length */
2066 int curlen; /* length of current code */
2067 int nextlen = tree[0].Len; /* length of next code */
2068 int count = 0; /* repeat count of the current code */
2069 int max_count = 7; /* max repeat count */
2070 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002071
Erik Andersene49d5ec2000-02-08 19:58:47 +00002072 if (nextlen == 0)
2073 max_count = 138, min_count = 3;
2074 tree[max_code + 1].Len = (ush) 0xffff; /* guard */
Eric Andersencc8ed391999-10-05 16:24:54 +00002075
Erik Andersene49d5ec2000-02-08 19:58:47 +00002076 for (n = 0; n <= max_code; n++) {
2077 curlen = nextlen;
2078 nextlen = tree[n + 1].Len;
2079 if (++count < max_count && curlen == nextlen) {
2080 continue;
2081 } else if (count < min_count) {
2082 bl_tree[curlen].Freq += count;
2083 } else if (curlen != 0) {
2084 if (curlen != prevlen)
2085 bl_tree[curlen].Freq++;
2086 bl_tree[REP_3_6].Freq++;
2087 } else if (count <= 10) {
2088 bl_tree[REPZ_3_10].Freq++;
2089 } else {
2090 bl_tree[REPZ_11_138].Freq++;
2091 }
2092 count = 0;
2093 prevlen = curlen;
2094 if (nextlen == 0) {
2095 max_count = 138, min_count = 3;
2096 } else if (curlen == nextlen) {
2097 max_count = 6, min_count = 3;
2098 } else {
2099 max_count = 7, min_count = 4;
2100 }
2101 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002102}
2103
2104/* ===========================================================================
2105 * Send a literal or distance tree in compressed form, using the codes in
2106 * bl_tree.
2107 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002108static void send_tree(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002109{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002110 int n; /* iterates over all tree elements */
2111 int prevlen = -1; /* last emitted length */
2112 int curlen; /* length of current code */
2113 int nextlen = tree[0].Len; /* length of next code */
2114 int count = 0; /* repeat count of the current code */
2115 int max_count = 7; /* max repeat count */
2116 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002117
Erik Andersene49d5ec2000-02-08 19:58:47 +00002118/* tree[max_code+1].Len = -1; *//* guard already set */
2119 if (nextlen == 0)
2120 max_count = 138, min_count = 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002121
Erik Andersene49d5ec2000-02-08 19:58:47 +00002122 for (n = 0; n <= max_code; n++) {
2123 curlen = nextlen;
2124 nextlen = tree[n + 1].Len;
2125 if (++count < max_count && curlen == nextlen) {
2126 continue;
2127 } else if (count < min_count) {
2128 do {
2129 send_code(curlen, bl_tree);
2130 } while (--count != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002131
Erik Andersene49d5ec2000-02-08 19:58:47 +00002132 } else if (curlen != 0) {
2133 if (curlen != prevlen) {
2134 send_code(curlen, bl_tree);
2135 count--;
2136 }
2137 Assert(count >= 3 && count <= 6, " 3_6?");
2138 send_code(REP_3_6, bl_tree);
2139 send_bits(count - 3, 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002140
Erik Andersene49d5ec2000-02-08 19:58:47 +00002141 } else if (count <= 10) {
2142 send_code(REPZ_3_10, bl_tree);
2143 send_bits(count - 3, 3);
Eric Andersencc8ed391999-10-05 16:24:54 +00002144
Erik Andersene49d5ec2000-02-08 19:58:47 +00002145 } else {
2146 send_code(REPZ_11_138, bl_tree);
2147 send_bits(count - 11, 7);
2148 }
2149 count = 0;
2150 prevlen = curlen;
2151 if (nextlen == 0) {
2152 max_count = 138, min_count = 3;
2153 } else if (curlen == nextlen) {
2154 max_count = 6, min_count = 3;
2155 } else {
2156 max_count = 7, min_count = 4;
2157 }
2158 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002159}
2160
2161/* ===========================================================================
2162 * Construct the Huffman tree for the bit lengths and return the index in
2163 * bl_order of the last bit length code to send.
2164 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002165static const int build_bl_tree()
Eric Andersencc8ed391999-10-05 16:24:54 +00002166{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002167 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002168
Erik Andersene49d5ec2000-02-08 19:58:47 +00002169 /* Determine the bit length frequencies for literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002170 scan_tree((ct_data *) dyn_ltree, l_desc.max_code);
2171 scan_tree((ct_data *) dyn_dtree, d_desc.max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002172
Erik Andersene49d5ec2000-02-08 19:58:47 +00002173 /* Build the bit length tree: */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002174 build_tree((tree_desc *) (&bl_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002175 /* opt_len now includes the length of the tree representations, except
2176 * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
2177 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002178
Erik Andersene49d5ec2000-02-08 19:58:47 +00002179 /* Determine the number of bit length codes to send. The pkzip format
2180 * requires that at least 4 bit length codes be sent. (appnote.txt says
2181 * 3 but the actual value used is 4.)
2182 */
2183 for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
2184 if (bl_tree[bl_order[max_blindex]].Len != 0)
2185 break;
2186 }
2187 /* Update opt_len to include the bit length tree and counts */
2188 opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
2189 Tracev(
2190 (stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len,
2191 static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002192
Erik Andersene49d5ec2000-02-08 19:58:47 +00002193 return max_blindex;
Eric Andersencc8ed391999-10-05 16:24:54 +00002194}
2195
2196/* ===========================================================================
2197 * Send the header for a block using dynamic Huffman trees: the counts, the
2198 * lengths of the bit length codes, the literal tree and the distance tree.
2199 * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
2200 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002201static void send_all_trees(int lcodes, int dcodes, int blcodes)
Eric Andersencc8ed391999-10-05 16:24:54 +00002202{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002203 int rank; /* index in bl_order */
Eric Andersencc8ed391999-10-05 16:24:54 +00002204
Erik Andersene49d5ec2000-02-08 19:58:47 +00002205 Assert(lcodes >= 257 && dcodes >= 1
2206 && blcodes >= 4, "not enough codes");
2207 Assert(lcodes <= L_CODES && dcodes <= D_CODES
2208 && blcodes <= BL_CODES, "too many codes");
2209 Tracev((stderr, "\nbl counts: "));
2210 send_bits(lcodes - 257, 5); /* not +255 as stated in appnote.txt */
2211 send_bits(dcodes - 1, 5);
2212 send_bits(blcodes - 4, 4); /* not -3 as stated in appnote.txt */
2213 for (rank = 0; rank < blcodes; rank++) {
2214 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
2215 send_bits(bl_tree[bl_order[rank]].Len, 3);
2216 }
2217 Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002218
Eric Andersen3073dfb2001-07-02 17:57:32 +00002219 send_tree((ct_data *) dyn_ltree, lcodes - 1); /* send the literal tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002220 Tracev((stderr, "\nlit 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_dtree, dcodes - 1); /* send the distance tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002223 Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002224}
2225
2226/* ===========================================================================
2227 * Determine the best encoding for the current block: dynamic trees, static
2228 * trees or store, and output the encoded block to the zip file. This function
2229 * returns the total compressed length for the file so far.
2230 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002231static ulg flush_block(char *buf, ulg stored_len, int eof)
Eric Andersencc8ed391999-10-05 16:24:54 +00002232{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002233 ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
2234 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002235
Erik Andersene49d5ec2000-02-08 19:58:47 +00002236 flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
Eric Andersencc8ed391999-10-05 16:24:54 +00002237
Erik Andersene49d5ec2000-02-08 19:58:47 +00002238 /* Check if the file is ascii or binary */
2239 if (*file_type == (ush) UNKNOWN)
2240 set_file_type();
Eric Andersencc8ed391999-10-05 16:24:54 +00002241
Erik Andersene49d5ec2000-02-08 19:58:47 +00002242 /* Construct the literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002243 build_tree((tree_desc *) (&l_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002244 Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002245
Eric Andersen3073dfb2001-07-02 17:57:32 +00002246 build_tree((tree_desc *) (&d_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002247 Tracev(
2248 (stderr, "\ndist data: dyn %ld, stat %ld", opt_len,
2249 static_len));
2250 /* At this point, opt_len and static_len are the total bit lengths of
2251 * the compressed block data, excluding the tree representations.
2252 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002253
Erik Andersene49d5ec2000-02-08 19:58:47 +00002254 /* Build the bit length tree for the above two trees, and get the index
2255 * in bl_order of the last bit length code to send.
2256 */
2257 max_blindex = build_bl_tree();
Eric Andersencc8ed391999-10-05 16:24:54 +00002258
Erik Andersene49d5ec2000-02-08 19:58:47 +00002259 /* Determine the best encoding. Compute first the block length in bytes */
2260 opt_lenb = (opt_len + 3 + 7) >> 3;
2261 static_lenb = (static_len + 3 + 7) >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002262
Erik Andersene49d5ec2000-02-08 19:58:47 +00002263 Trace(
2264 (stderr,
2265 "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
2266 opt_lenb, opt_len, static_lenb, static_len, stored_len,
2267 last_lit, last_dist));
Eric Andersencc8ed391999-10-05 16:24:54 +00002268
Erik Andersene49d5ec2000-02-08 19:58:47 +00002269 if (static_lenb <= opt_lenb)
2270 opt_lenb = static_lenb;
Eric Andersencc8ed391999-10-05 16:24:54 +00002271
Erik Andersene49d5ec2000-02-08 19:58:47 +00002272 /* If compression failed and this is the first and last block,
2273 * and if the zip file can be seeked (to rewrite the local header),
2274 * the whole file is transformed into a stored file:
2275 */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002276 if (stored_len <= opt_lenb && eof && compressed_len == 0L
2277 && seekable()) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002278 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
2279 if (buf == (char *) 0)
Matt Kraaidd19c692001-01-31 19:00:21 +00002280 error_msg("block vanished");
Eric Andersencc8ed391999-10-05 16:24:54 +00002281
Erik Andersene49d5ec2000-02-08 19:58:47 +00002282 copy_block(buf, (unsigned) stored_len, 0); /* without header */
2283 compressed_len = stored_len << 3;
2284 *file_method = STORED;
Eric Andersencc8ed391999-10-05 16:24:54 +00002285
Erik Andersene49d5ec2000-02-08 19:58:47 +00002286 } else if (stored_len + 4 <= opt_lenb && buf != (char *) 0) {
2287 /* 4: two words for the lengths */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002288 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
2289 * Otherwise we can't have processed more than WSIZE input bytes since
2290 * the last block flush, because compression would have been
2291 * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
2292 * transform a block into a stored block.
2293 */
2294 send_bits((STORED_BLOCK << 1) + eof, 3); /* send block type */
2295 compressed_len = (compressed_len + 3 + 7) & ~7L;
2296 compressed_len += (stored_len + 4) << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002297
Erik Andersene49d5ec2000-02-08 19:58:47 +00002298 copy_block(buf, (unsigned) stored_len, 1); /* with header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002299
Erik Andersene49d5ec2000-02-08 19:58:47 +00002300 } else if (static_lenb == opt_lenb) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002301 send_bits((STATIC_TREES << 1) + eof, 3);
Eric Andersen3073dfb2001-07-02 17:57:32 +00002302 compress_block((ct_data *) static_ltree,
2303 (ct_data *) static_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002304 compressed_len += 3 + static_len;
2305 } else {
2306 send_bits((DYN_TREES << 1) + eof, 3);
2307 send_all_trees(l_desc.max_code + 1, d_desc.max_code + 1,
2308 max_blindex + 1);
Eric Andersen3073dfb2001-07-02 17:57:32 +00002309 compress_block((ct_data *) dyn_ltree,
2310 (ct_data *) dyn_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002311 compressed_len += 3 + opt_len;
2312 }
2313 Assert(compressed_len == bits_sent, "bad compressed size");
2314 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00002315
Erik Andersene49d5ec2000-02-08 19:58:47 +00002316 if (eof) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002317 bi_windup();
2318 compressed_len += 7; /* align on byte boundary */
2319 }
2320 Tracev((stderr, "\ncomprlen %lu(%lu) ", compressed_len >> 3,
2321 compressed_len - 7 * eof));
Eric Andersencc8ed391999-10-05 16:24:54 +00002322
Erik Andersene49d5ec2000-02-08 19:58:47 +00002323 return compressed_len >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002324}
2325
2326/* ===========================================================================
2327 * Save the match info and tally the frequency counts. Return true if
2328 * the current block must be flushed.
2329 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002330static int ct_tally(int dist, int lc)
Eric Andersencc8ed391999-10-05 16:24:54 +00002331{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002332 l_buf[last_lit++] = (uch) lc;
2333 if (dist == 0) {
2334 /* lc is the unmatched char */
2335 dyn_ltree[lc].Freq++;
2336 } else {
2337 /* Here, lc is the match length - MIN_MATCH */
2338 dist--; /* dist = match distance - 1 */
2339 Assert((ush) dist < (ush) MAX_DIST &&
2340 (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH) &&
2341 (ush) d_code(dist) < (ush) D_CODES, "ct_tally: bad match");
Eric Andersencc8ed391999-10-05 16:24:54 +00002342
Erik Andersene49d5ec2000-02-08 19:58:47 +00002343 dyn_ltree[length_code[lc] + LITERALS + 1].Freq++;
2344 dyn_dtree[d_code(dist)].Freq++;
Eric Andersencc8ed391999-10-05 16:24:54 +00002345
Erik Andersene49d5ec2000-02-08 19:58:47 +00002346 d_buf[last_dist++] = (ush) dist;
2347 flags |= flag_bit;
2348 }
2349 flag_bit <<= 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00002350
Erik Andersene49d5ec2000-02-08 19:58:47 +00002351 /* Output the flags if they fill a byte: */
2352 if ((last_lit & 7) == 0) {
2353 flag_buf[last_flags++] = flags;
2354 flags = 0, flag_bit = 1;
2355 }
2356 /* Try to guess if it is profitable to stop the current block here */
2357 if ((last_lit & 0xfff) == 0) {
2358 /* Compute an upper bound for the compressed length */
2359 ulg out_length = (ulg) last_lit * 8L;
2360 ulg in_length = (ulg) strstart - block_start;
2361 int dcode;
2362
2363 for (dcode = 0; dcode < D_CODES; dcode++) {
2364 out_length +=
2365 (ulg) dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
2366 }
2367 out_length >>= 3;
2368 Trace(
2369 (stderr,
2370 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
2371 last_lit, last_dist, in_length, out_length,
2372 100L - out_length * 100L / in_length));
2373 if (last_dist < last_lit / 2 && out_length < in_length / 2)
2374 return 1;
2375 }
2376 return (last_lit == LIT_BUFSIZE - 1 || last_dist == DIST_BUFSIZE);
2377 /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
2378 * on 16 bit machines and because stored blocks are restricted to
2379 * 64K-1 bytes.
2380 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002381}
2382
2383/* ===========================================================================
2384 * Send the block data compressed using the given Huffman trees
2385 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002386static void compress_block(ct_data *ltree, ct_data *dtree)
Eric Andersencc8ed391999-10-05 16:24:54 +00002387{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002388 unsigned dist; /* distance of matched string */
2389 int lc; /* match length or unmatched char (if dist == 0) */
2390 unsigned lx = 0; /* running index in l_buf */
2391 unsigned dx = 0; /* running index in d_buf */
2392 unsigned fx = 0; /* running index in flag_buf */
2393 uch flag = 0; /* current flags */
2394 unsigned code; /* the code to send */
2395 int extra; /* number of extra bits to send */
Eric Andersencc8ed391999-10-05 16:24:54 +00002396
Erik Andersene49d5ec2000-02-08 19:58:47 +00002397 if (last_lit != 0)
2398 do {
2399 if ((lx & 7) == 0)
2400 flag = flag_buf[fx++];
2401 lc = l_buf[lx++];
2402 if ((flag & 1) == 0) {
2403 send_code(lc, ltree); /* send a literal byte */
2404 Tracecv(isgraph(lc), (stderr, " '%c' ", lc));
2405 } else {
2406 /* Here, lc is the match length - MIN_MATCH */
2407 code = length_code[lc];
2408 send_code(code + LITERALS + 1, ltree); /* send the length code */
2409 extra = extra_lbits[code];
2410 if (extra != 0) {
2411 lc -= base_length[code];
2412 send_bits(lc, extra); /* send the extra length bits */
2413 }
2414 dist = d_buf[dx++];
2415 /* Here, dist is the match distance - 1 */
2416 code = d_code(dist);
2417 Assert(code < D_CODES, "bad d_code");
Eric Andersencc8ed391999-10-05 16:24:54 +00002418
Erik Andersene49d5ec2000-02-08 19:58:47 +00002419 send_code(code, dtree); /* send the distance code */
2420 extra = extra_dbits[code];
2421 if (extra != 0) {
2422 dist -= base_dist[code];
2423 send_bits(dist, extra); /* send the extra distance bits */
2424 }
2425 } /* literal or match pair ? */
2426 flag >>= 1;
2427 } while (lx < last_lit);
Eric Andersencc8ed391999-10-05 16:24:54 +00002428
Erik Andersene49d5ec2000-02-08 19:58:47 +00002429 send_code(END_BLOCK, ltree);
Eric Andersencc8ed391999-10-05 16:24:54 +00002430}
2431
2432/* ===========================================================================
2433 * Set the file type to ASCII or BINARY, using a crude approximation:
2434 * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise.
2435 * IN assertion: the fields freq of dyn_ltree are set and the total of all
2436 * frequencies does not exceed 64K (to fit in an int on 16 bit machines).
2437 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002438static void set_file_type()
Eric Andersencc8ed391999-10-05 16:24:54 +00002439{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002440 int n = 0;
2441 unsigned ascii_freq = 0;
2442 unsigned bin_freq = 0;
2443
2444 while (n < 7)
2445 bin_freq += dyn_ltree[n++].Freq;
2446 while (n < 128)
2447 ascii_freq += dyn_ltree[n++].Freq;
2448 while (n < LITERALS)
2449 bin_freq += dyn_ltree[n++].Freq;
2450 *file_type = bin_freq > (ascii_freq >> 2) ? BINARY : ASCII;
2451 if (*file_type == BINARY && translate_eol) {
Matt Kraaidd19c692001-01-31 19:00:21 +00002452 error_msg("-l used on binary file");
Erik Andersene49d5ec2000-02-08 19:58:47 +00002453 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002454}
Erik Andersene49d5ec2000-02-08 19:58:47 +00002455
Eric Andersencc8ed391999-10-05 16:24:54 +00002456/* zip.c -- compress files to the gzip or pkzip format
2457 * Copyright (C) 1992-1993 Jean-loup Gailly
2458 * This is free software; you can redistribute it and/or modify it under the
2459 * terms of the GNU General Public License, see the file COPYING.
2460 */
2461
Eric Andersencc8ed391999-10-05 16:24:54 +00002462
Eric Andersen3073dfb2001-07-02 17:57:32 +00002463static ulg crc; /* crc on uncompressed file data */
2464static long header_bytes; /* number of bytes in gzip header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002465
Eric Andersen39eb0402001-08-22 04:15:47 +00002466static void put_long(ulg n)
2467{
Aaron Lehmannb9df4702001-12-06 03:22:43 +00002468 put_short((n) & 0xffff);
2469 put_short(((ulg)(n)) >> 16);
Eric Andersen39eb0402001-08-22 04:15:47 +00002470}
2471
2472/* put_header_byte is used for the compressed output
2473 * - for the initial 4 bytes that can't overflow the buffer.
2474 */
2475#define put_header_byte(c) {outbuf[outcnt++]=(uch)(c);}
2476
Eric Andersencc8ed391999-10-05 16:24:54 +00002477/* ===========================================================================
2478 * Deflate in to out.
2479 * IN assertions: the input and output buffers are cleared.
2480 * The variables time_stamp and save_orig_name are initialized.
2481 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002482static int zip(int in, int out)
Eric Andersencc8ed391999-10-05 16:24:54 +00002483{
Eric Andersen851895a2001-03-21 21:52:25 +00002484 uch my_flags = 0; /* general purpose bit flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002485 ush attr = 0; /* ascii/binary flag */
2486 ush deflate_flags = 0; /* pkzip -es, -en or -ex equivalent */
Eric Andersencc8ed391999-10-05 16:24:54 +00002487
Erik Andersene49d5ec2000-02-08 19:58:47 +00002488 ifd = in;
2489 ofd = out;
2490 outcnt = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00002491
Erik Andersene49d5ec2000-02-08 19:58:47 +00002492 /* Write the header to the gzip file. See algorithm.doc for the format */
Eric Andersencc8ed391999-10-05 16:24:54 +00002493
Eric Andersen96bcfd31999-11-12 01:30:18 +00002494
Erik Andersene49d5ec2000-02-08 19:58:47 +00002495 method = DEFLATED;
Eric Andersen39eb0402001-08-22 04:15:47 +00002496 put_header_byte(GZIP_MAGIC[0]); /* magic header */
2497 put_header_byte(GZIP_MAGIC[1]);
2498 put_header_byte(DEFLATED); /* compression method */
Eric Andersencc8ed391999-10-05 16:24:54 +00002499
Eric Andersen39eb0402001-08-22 04:15:47 +00002500 put_header_byte(my_flags); /* general flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002501 put_long(time_stamp);
Eric Andersencc8ed391999-10-05 16:24:54 +00002502
Erik Andersene49d5ec2000-02-08 19:58:47 +00002503 /* Write deflated file to zip file */
2504 crc = updcrc(0, 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002505
Erik Andersene49d5ec2000-02-08 19:58:47 +00002506 bi_init(out);
2507 ct_init(&attr, &method);
2508 lm_init(&deflate_flags);
Eric Andersencc8ed391999-10-05 16:24:54 +00002509
Erik Andersene49d5ec2000-02-08 19:58:47 +00002510 put_byte((uch) deflate_flags); /* extra flags */
2511 put_byte(OS_CODE); /* OS identifier */
Eric Andersencc8ed391999-10-05 16:24:54 +00002512
Erik Andersene49d5ec2000-02-08 19:58:47 +00002513 header_bytes = (long) outcnt;
Eric Andersencc8ed391999-10-05 16:24:54 +00002514
Erik Andersene49d5ec2000-02-08 19:58:47 +00002515 (void) deflate();
Eric Andersencc8ed391999-10-05 16:24:54 +00002516
Erik Andersene49d5ec2000-02-08 19:58:47 +00002517 /* Write the crc and uncompressed size */
2518 put_long(crc);
2519 put_long(isize);
2520 header_bytes += 2 * sizeof(long);
Eric Andersencc8ed391999-10-05 16:24:54 +00002521
Erik Andersene49d5ec2000-02-08 19:58:47 +00002522 flush_outbuf();
2523 return OK;
Eric Andersencc8ed391999-10-05 16:24:54 +00002524}
2525
2526
2527/* ===========================================================================
2528 * Read a new buffer from the current input file, perform end-of-line
2529 * translation, and update the crc and input file size.
2530 * IN assertion: size >= 2 (for end-of-line translation)
2531 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002532static int file_read(char *buf, unsigned size)
Eric Andersencc8ed391999-10-05 16:24:54 +00002533{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002534 unsigned len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002535
Erik Andersene49d5ec2000-02-08 19:58:47 +00002536 Assert(insize == 0, "inbuf not empty");
Eric Andersencc8ed391999-10-05 16:24:54 +00002537
Erik Andersene49d5ec2000-02-08 19:58:47 +00002538 len = read(ifd, buf, size);
2539 if (len == (unsigned) (-1) || len == 0)
2540 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002541
Erik Andersene49d5ec2000-02-08 19:58:47 +00002542 crc = updcrc((uch *) buf, len);
2543 isize += (ulg) len;
2544 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002545}
Matt Kraai7918e1f2000-11-08 06:52:57 +00002546
2547/* ===========================================================================
2548 * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
2549 * (used for the compressed data only)
2550 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002551static void flush_outbuf()
Matt Kraai7918e1f2000-11-08 06:52:57 +00002552{
2553 if (outcnt == 0)
2554 return;
2555
2556 write_buf(ofd, (char *) outbuf, outcnt);
Matt Kraai7918e1f2000-11-08 06:52:57 +00002557 outcnt = 0;
2558}