blob: fed93907bdab8ea02488b7b848839e487b61cff0 [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 int ifd; /* input file descriptor */
321static int ofd; /* output file descriptor */
322static unsigned insize; /* valid bytes in inbuf */
323static unsigned outcnt; /* bytes in output buffer */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000324
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000325
326/* Output a 16 bit value, lsb first */
327static void put_short(ush w)
328{
329 if (outcnt < OUTBUFSIZ-2) {
330 outbuf[outcnt++] = (uch) ((w) & 0xff);
331 outbuf[outcnt++] = (uch) ((ush)(w) >> 8);
332 } else {
333 put_byte((uch)((w) & 0xff));
334 put_byte((uch)((ush)(w) >> 8));
335 }
336}
337
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000338/* ========================================================================
339 * Signal and error handler.
340 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000341static void abort_gzip()
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000342{
343 exit(ERROR);
344}
345
346/* ===========================================================================
347 * Clear input and output buffers
348 */
349static void clear_bufs(void)
350{
351 outcnt = 0;
Eric Andersen3073dfb2001-07-02 17:57:32 +0000352 insize = 0;
353 bytes_in = 0L;
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000354}
355
Eric Andersen74400cc2001-10-18 04:11:39 +0000356static void write_error_msg(void)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000357{
358 fprintf(stderr, "\n");
359 perror("");
360 abort_gzip();
361}
362
363/* ===========================================================================
364 * Does the same as write(), but also handles partial pipe writes and checks
365 * for error return.
366 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000367static void write_buf(int fd, void *buf, unsigned cnt)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000368{
369 unsigned n;
370
371 while ((n = write(fd, buf, cnt)) != cnt) {
372 if (n == (unsigned) (-1)) {
373 write_error_msg();
374 }
375 cnt -= n;
376 buf = (void *) ((char *) buf + n);
377 }
378}
379
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000380/* ===========================================================================
381 * Run a set of bytes through the crc shift register. If s is a NULL
382 * pointer, then initialize the crc shift register contents instead.
383 * Return the current crc in either case.
384 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000385static ulg updcrc(uch *s, unsigned n)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000386{
387 static ulg crc = (ulg) 0xffffffffL; /* shift register contents */
388 register ulg c; /* temporary variable */
389 static unsigned long crc_32_tab[256];
390 if (crc_table_empty) {
391 unsigned long csr; /* crc shift register */
Eric Andersen39eb0402001-08-22 04:15:47 +0000392 const unsigned long e = 0xedb88320L; /* polynomial exclusive-or pattern */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000393 int i; /* counter for all possible eight bit values */
394 int k; /* byte being shifted into crc apparatus */
395
Eric Andersen39eb0402001-08-22 04:15:47 +0000396 /* Compute table of CRC's. */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000397 crc_32_tab[0] = 0x00000000L;
398 for (i = 1; i < 256; i++) {
399 csr = i;
400 /* The idea to initialize the register with the byte instead of
401 * zero was stolen from Haruhiko Okumura's ar002
402 */
403 for (k = 8; k; k--)
404 csr = csr & 1 ? (csr >> 1) ^ e : csr >> 1;
405 crc_32_tab[i]=csr;
406 }
407 }
408
409 if (s == NULL) {
410 c = 0xffffffffL;
411 } else {
412 c = crc;
413 if (n)
414 do {
415 c = crc_32_tab[((int) c ^ (*s++)) & 0xff] ^ (c >> 8);
416 } while (--n);
417 }
418 crc = c;
419 return c ^ 0xffffffffL; /* (instead of ~c for 64-bit machines) */
420}
421
Eric Andersencc8ed391999-10-05 16:24:54 +0000422/* bits.c -- output variable-length bit strings
423 * Copyright (C) 1992-1993 Jean-loup Gailly
424 * This is free software; you can redistribute it and/or modify it under the
425 * terms of the GNU General Public License, see the file COPYING.
426 */
427
428
429/*
430 * PURPOSE
431 *
432 * Output variable-length bit strings. Compression can be done
433 * to a file or to memory. (The latter is not supported in this version.)
434 *
435 * DISCUSSION
436 *
437 * The PKZIP "deflate" file format interprets compressed file data
438 * as a sequence of bits. Multi-bit strings in the file may cross
439 * byte boundaries without restriction.
440 *
441 * The first bit of each byte is the low-order bit.
442 *
443 * The routines in this file allow a variable-length bit value to
444 * be output right-to-left (useful for literal values). For
445 * left-to-right output (useful for code strings from the tree routines),
446 * the bits must have been reversed first with bi_reverse().
447 *
448 * For in-memory compression, the compressed bit stream goes directly
449 * into the requested output buffer. The input data is read in blocks
450 * by the mem_read() function. The buffer is limited to 64K on 16 bit
451 * machines.
452 *
453 * INTERFACE
454 *
455 * void bi_init (FILE *zipfile)
456 * Initialize the bit string routines.
457 *
458 * void send_bits (int value, int length)
459 * Write out a bit string, taking the source bits right to
460 * left.
461 *
462 * int bi_reverse (int value, int length)
463 * Reverse the bits of a bit string, taking the source bits left to
464 * right and emitting them right to left.
465 *
466 * void bi_windup (void)
467 * Write out any remaining bits in an incomplete byte.
468 *
469 * void copy_block(char *buf, unsigned len, int header)
470 * Copy a stored block to the zip file, storing first the length and
471 * its one's complement if requested.
472 *
473 */
474
Eric Andersencc8ed391999-10-05 16:24:54 +0000475/* ===========================================================================
476 * Local data used by the "bit string" routines.
477 */
478
Eric Andersen3073dfb2001-07-02 17:57:32 +0000479static file_t zfile; /* output gzip file */
Eric Andersencc8ed391999-10-05 16:24:54 +0000480
Eric Andersen3073dfb2001-07-02 17:57:32 +0000481static unsigned short bi_buf;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000482
Eric Andersencc8ed391999-10-05 16:24:54 +0000483/* Output buffer. bits are inserted starting at the bottom (least significant
484 * bits).
485 */
486
487#define Buf_size (8 * 2*sizeof(char))
488/* Number of bits used within bi_buf. (bi_buf might be implemented on
489 * more than 16 bits on some systems.)
490 */
491
Eric Andersen3073dfb2001-07-02 17:57:32 +0000492static int bi_valid;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000493
Eric Andersencc8ed391999-10-05 16:24:54 +0000494/* Current input function. Set to mem_read for in-memory compression */
495
496#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000497ulg bits_sent; /* bit length of the compressed data */
Eric Andersencc8ed391999-10-05 16:24:54 +0000498#endif
499
500/* ===========================================================================
501 * Initialize the bit string routines.
502 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000503static void bi_init(file_t zipfile)
Eric Andersencc8ed391999-10-05 16:24:54 +0000504{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000505 zfile = zipfile;
506 bi_buf = 0;
507 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000508#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000509 bits_sent = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000510#endif
511
Erik Andersene49d5ec2000-02-08 19:58:47 +0000512 /* Set the defaults for file compression. They are set by memcompress
513 * for in-memory compression.
514 */
515 if (zfile != NO_FILE) {
516 read_buf = file_read;
517 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000518}
519
520/* ===========================================================================
521 * Send a value on a given number of bits.
522 * IN assertion: length <= 16 and value fits in length bits.
523 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000524static void send_bits(int value, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000525{
526#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000527 Tracev((stderr, " l %2d v %4x ", length, value));
528 Assert(length > 0 && length <= 15, "invalid length");
529 bits_sent += (ulg) length;
Eric Andersencc8ed391999-10-05 16:24:54 +0000530#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000531 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
532 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
533 * unused bits in value.
534 */
535 if (bi_valid > (int) Buf_size - length) {
536 bi_buf |= (value << bi_valid);
537 put_short(bi_buf);
538 bi_buf = (ush) value >> (Buf_size - bi_valid);
539 bi_valid += length - Buf_size;
540 } else {
541 bi_buf |= value << bi_valid;
542 bi_valid += length;
543 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000544}
545
546/* ===========================================================================
547 * Reverse the first len bits of a code, using straightforward code (a faster
548 * method would use a table)
549 * IN assertion: 1 <= len <= 15
550 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000551static unsigned bi_reverse(unsigned code, int len)
Eric Andersencc8ed391999-10-05 16:24:54 +0000552{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000553 register unsigned res = 0;
554
555 do {
556 res |= code & 1;
557 code >>= 1, res <<= 1;
558 } while (--len > 0);
559 return res >> 1;
Eric Andersencc8ed391999-10-05 16:24:54 +0000560}
561
562/* ===========================================================================
563 * Write out any remaining bits in an incomplete byte.
564 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000565static void bi_windup()
Eric Andersencc8ed391999-10-05 16:24:54 +0000566{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000567 if (bi_valid > 8) {
568 put_short(bi_buf);
569 } else if (bi_valid > 0) {
570 put_byte(bi_buf);
571 }
572 bi_buf = 0;
573 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000574#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000575 bits_sent = (bits_sent + 7) & ~7;
Eric Andersencc8ed391999-10-05 16:24:54 +0000576#endif
577}
578
579/* ===========================================================================
580 * Copy a stored block to the zip file, storing first the length and its
581 * one's complement if requested.
582 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000583static void copy_block(char *buf, unsigned len, int header)
Eric Andersencc8ed391999-10-05 16:24:54 +0000584{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000585 bi_windup(); /* align on byte boundary */
Eric Andersencc8ed391999-10-05 16:24:54 +0000586
Erik Andersene49d5ec2000-02-08 19:58:47 +0000587 if (header) {
588 put_short((ush) len);
589 put_short((ush) ~ len);
Eric Andersencc8ed391999-10-05 16:24:54 +0000590#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000591 bits_sent += 2 * 16;
Eric Andersencc8ed391999-10-05 16:24:54 +0000592#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000593 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000594#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000595 bits_sent += (ulg) len << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +0000596#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000597 while (len--) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000598 put_byte(*buf++);
599 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000600}
Erik Andersene49d5ec2000-02-08 19:58:47 +0000601
Eric Andersencc8ed391999-10-05 16:24:54 +0000602/* deflate.c -- compress data using the deflation algorithm
603 * Copyright (C) 1992-1993 Jean-loup Gailly
604 * This is free software; you can redistribute it and/or modify it under the
605 * terms of the GNU General Public License, see the file COPYING.
606 */
607
608/*
609 * PURPOSE
610 *
611 * Identify new text as repetitions of old text within a fixed-
612 * length sliding window trailing behind the new text.
613 *
614 * DISCUSSION
615 *
616 * The "deflation" process depends on being able to identify portions
617 * of the input text which are identical to earlier input (within a
618 * sliding window trailing behind the input currently being processed).
619 *
620 * The most straightforward technique turns out to be the fastest for
621 * most input files: try all possible matches and select the longest.
622 * The key feature of this algorithm is that insertions into the string
623 * dictionary are very simple and thus fast, and deletions are avoided
624 * completely. Insertions are performed at each input character, whereas
625 * string matches are performed only when the previous match ends. So it
626 * is preferable to spend more time in matches to allow very fast string
627 * insertions and avoid deletions. The matching algorithm for small
628 * strings is inspired from that of Rabin & Karp. A brute force approach
629 * is used to find longer strings when a small match has been found.
630 * A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
631 * (by Leonid Broukhis).
632 * A previous version of this file used a more sophisticated algorithm
633 * (by Fiala and Greene) which is guaranteed to run in linear amortized
634 * time, but has a larger average cost, uses more memory and is patented.
635 * However the F&G algorithm may be faster for some highly redundant
636 * files if the parameter max_chain_length (described below) is too large.
637 *
638 * ACKNOWLEDGEMENTS
639 *
640 * The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
641 * I found it in 'freeze' written by Leonid Broukhis.
642 * Thanks to many info-zippers for bug reports and testing.
643 *
644 * REFERENCES
645 *
646 * APPNOTE.TXT documentation file in PKZIP 1.93a distribution.
647 *
648 * A description of the Rabin and Karp algorithm is given in the book
649 * "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
650 *
651 * Fiala,E.R., and Greene,D.H.
652 * Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
653 *
654 * INTERFACE
655 *
656 * void lm_init (int pack_level, ush *flags)
657 * Initialize the "longest match" routines for a new file
658 *
659 * ulg deflate (void)
660 * Processes a new input file and return its compressed length. Sets
661 * the compressed length, crc, deflate flags and internal file
662 * attributes.
663 */
664
Eric Andersencc8ed391999-10-05 16:24:54 +0000665
Eric Andersencc8ed391999-10-05 16:24:54 +0000666/* ===========================================================================
667 * Configuration parameters
668 */
669
670/* Compile with MEDIUM_MEM to reduce the memory requirements or
671 * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
672 * entire input file can be held in memory (not possible on 16 bit systems).
673 * Warning: defining these symbols affects HASH_BITS (see below) and thus
674 * affects the compression ratio. The compressed output
675 * is still correct, and might even be smaller in some cases.
676 */
677
678#ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +0000679# define HASH_BITS 13 /* Number of bits used to hash strings */
Eric Andersencc8ed391999-10-05 16:24:54 +0000680#endif
681#ifdef MEDIUM_MEM
682# define HASH_BITS 14
683#endif
684#ifndef HASH_BITS
685# define HASH_BITS 15
686 /* For portability to 16 bit machines, do not use values above 15. */
687#endif
688
689/* To save space (see unlzw.c), we overlay prev+head with tab_prefix and
690 * window with tab_suffix. Check that we can do this:
691 */
692#if (WSIZE<<1) > (1<<BITS)
Eric Andersen3073dfb2001-07-02 17:57:32 +0000693# error cannot overlay window with tab_suffix and prev with tab_prefix0
Eric Andersencc8ed391999-10-05 16:24:54 +0000694#endif
695#if HASH_BITS > BITS-1
Eric Andersen3073dfb2001-07-02 17:57:32 +0000696# error cannot overlay head with tab_prefix1
Eric Andersencc8ed391999-10-05 16:24:54 +0000697#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000698#define HASH_SIZE (unsigned)(1<<HASH_BITS)
699#define HASH_MASK (HASH_SIZE-1)
700#define WMASK (WSIZE-1)
701/* HASH_SIZE and WSIZE must be powers of two */
Eric Andersencc8ed391999-10-05 16:24:54 +0000702#define NIL 0
703/* Tail of hash chains */
Eric Andersencc8ed391999-10-05 16:24:54 +0000704#define FAST 4
705#define SLOW 2
706/* speed options for the general purpose bit flag */
Eric Andersencc8ed391999-10-05 16:24:54 +0000707#ifndef TOO_FAR
708# define TOO_FAR 4096
709#endif
710/* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
Eric Andersencc8ed391999-10-05 16:24:54 +0000711/* ===========================================================================
712 * Local data used by the "longest match" routines.
713 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000714typedef ush Pos;
715typedef unsigned IPos;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000716
Eric Andersencc8ed391999-10-05 16:24:54 +0000717/* A Pos is an index in the character window. We use short instead of int to
718 * save space in the various tables. IPos is used only for parameter passing.
719 */
720
721/* DECLARE(uch, window, 2L*WSIZE); */
722/* Sliding window. Input bytes are read into the second half of the window,
723 * and move to the first half later to keep a dictionary of at least WSIZE
724 * bytes. With this organization, matches are limited to a distance of
725 * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
726 * performed with a length multiple of the block size. Also, it limits
727 * the window size to 64K, which is quite useful on MSDOS.
728 * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
729 * be less efficient).
730 */
731
732/* DECLARE(Pos, prev, WSIZE); */
733/* Link to older string with same hash index. To limit the size of this
734 * array to 64K, this link is maintained only for the last 32K strings.
735 * An index in this array is thus a window index modulo 32K.
736 */
737
738/* DECLARE(Pos, head, 1<<HASH_BITS); */
739/* Heads of the hash chains or NIL. */
740
Eric Andersen3073dfb2001-07-02 17:57:32 +0000741static const ulg window_size = (ulg) 2 * WSIZE;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000742
Eric Andersencc8ed391999-10-05 16:24:54 +0000743/* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
744 * input file length plus MIN_LOOKAHEAD.
745 */
746
Eric Andersen3073dfb2001-07-02 17:57:32 +0000747static long block_start;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000748
Eric Andersencc8ed391999-10-05 16:24:54 +0000749/* window position at the beginning of the current output block. Gets
750 * negative when the window is moved backwards.
751 */
752
Eric Andersen3073dfb2001-07-02 17:57:32 +0000753static unsigned ins_h; /* hash index of string to be inserted */
Eric Andersencc8ed391999-10-05 16:24:54 +0000754
755#define H_SHIFT ((HASH_BITS+MIN_MATCH-1)/MIN_MATCH)
756/* Number of bits by which ins_h and del_h must be shifted at each
757 * input step. It must be such that after MIN_MATCH steps, the oldest
758 * byte no longer takes part in the hash key, that is:
759 * H_SHIFT * MIN_MATCH >= HASH_BITS
760 */
761
Eric Andersen3073dfb2001-07-02 17:57:32 +0000762static unsigned int prev_length;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000763
Eric Andersencc8ed391999-10-05 16:24:54 +0000764/* Length of the best match at previous step. Matches not greater than this
765 * are discarded. This is used in the lazy match evaluation.
766 */
767
Eric Andersen3073dfb2001-07-02 17:57:32 +0000768static unsigned strstart; /* start of string to insert */
769static unsigned match_start; /* start of matching string */
770static int eofile; /* flag set at end of input file */
771static unsigned lookahead; /* number of valid bytes ahead in window */
Eric Andersencc8ed391999-10-05 16:24:54 +0000772
Eric Andersen3073dfb2001-07-02 17:57:32 +0000773static const unsigned max_chain_length=4096;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000774
Eric Andersencc8ed391999-10-05 16:24:54 +0000775/* To speed up deflation, hash chains are never searched beyond this length.
776 * A higher limit improves compression ratio but degrades the speed.
777 */
778
Eric Andersen3073dfb2001-07-02 17:57:32 +0000779static const unsigned int max_lazy_match=258;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000780
Eric Andersencc8ed391999-10-05 16:24:54 +0000781/* Attempt to find a better match only when the current match is strictly
782 * smaller than this value. This mechanism is used only for compression
783 * levels >= 4.
784 */
785#define max_insert_length max_lazy_match
786/* Insert new strings in the hash table only if the match length
787 * is not greater than this length. This saves time but degrades compression.
788 * max_insert_length is used only for compression levels <= 3.
789 */
790
Eric Andersen3073dfb2001-07-02 17:57:32 +0000791static const unsigned good_match=32;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000792
Eric Andersencc8ed391999-10-05 16:24:54 +0000793/* Use a faster search when the previous match is longer than this */
794
795
796/* Values for max_lazy_match, good_match and max_chain_length, depending on
797 * the desired pack level (0..9). The values given below have been tuned to
798 * exclude worst case performance for pathological files. Better values may be
799 * found for specific files.
800 */
801
Eric Andersen3073dfb2001-07-02 17:57:32 +0000802static const int nice_match=258; /* Stop searching when current match exceeds this */
Eric Andersencc8ed391999-10-05 16:24:54 +0000803
804/* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
805 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
806 * meaning.
807 */
808
809#define EQUAL 0
810/* result of memcmp for equal strings */
811
812/* ===========================================================================
813 * Prototypes for local functions.
814 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000815static void fill_window (void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000816
Eric Andersen3073dfb2001-07-02 17:57:32 +0000817static int longest_match (IPos cur_match);
Eric Andersencc8ed391999-10-05 16:24:54 +0000818
819#ifdef DEBUG
Eric Andersen3073dfb2001-07-02 17:57:32 +0000820static void check_match (IPos start, IPos match, int length);
Eric Andersencc8ed391999-10-05 16:24:54 +0000821#endif
822
823/* ===========================================================================
824 * Update a hash value with the given input byte
825 * IN assertion: all calls to to UPDATE_HASH are made with consecutive
826 * input characters, so that a running hash key can be computed from the
827 * previous key instead of complete recalculation each time.
828 */
829#define UPDATE_HASH(h,c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
830
831/* ===========================================================================
832 * Insert string s in the dictionary and set match_head to the previous head
833 * of the hash chain (the most recent string with same hash key). Return
834 * the previous length of the hash chain.
835 * IN assertion: all calls to to INSERT_STRING are made with consecutive
836 * input characters and the first MIN_MATCH bytes of s are valid
837 * (except for the last MIN_MATCH-1 bytes of the input file).
838 */
839#define INSERT_STRING(s, match_head) \
840 (UPDATE_HASH(ins_h, window[(s) + MIN_MATCH-1]), \
841 prev[(s) & WMASK] = match_head = head[ins_h], \
842 head[ins_h] = (s))
843
844/* ===========================================================================
845 * Initialize the "longest match" routines for a new file
846 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000847static void lm_init(ush *flags)
Eric Andersencc8ed391999-10-05 16:24:54 +0000848{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000849 register unsigned j;
Eric Andersencc8ed391999-10-05 16:24:54 +0000850
Erik Andersene49d5ec2000-02-08 19:58:47 +0000851 /* Initialize the hash table. */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000852 memzero((char *) head, HASH_SIZE * sizeof(*head));
Erik Andersene49d5ec2000-02-08 19:58:47 +0000853 /* prev will be initialized on the fly */
Eric Andersencc8ed391999-10-05 16:24:54 +0000854
Erik Andersene49d5ec2000-02-08 19:58:47 +0000855 *flags |= SLOW;
856 /* ??? reduce max_chain_length for binary files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000857
Erik Andersene49d5ec2000-02-08 19:58:47 +0000858 strstart = 0;
859 block_start = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000860
Erik Andersene49d5ec2000-02-08 19:58:47 +0000861 lookahead = read_buf((char *) window,
862 sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
Eric Andersencc8ed391999-10-05 16:24:54 +0000863
Erik Andersene49d5ec2000-02-08 19:58:47 +0000864 if (lookahead == 0 || lookahead == (unsigned) EOF) {
865 eofile = 1, lookahead = 0;
866 return;
867 }
868 eofile = 0;
869 /* Make sure that we always have enough lookahead. This is important
870 * if input comes from a device such as a tty.
871 */
872 while (lookahead < MIN_LOOKAHEAD && !eofile)
873 fill_window();
Eric Andersencc8ed391999-10-05 16:24:54 +0000874
Erik Andersene49d5ec2000-02-08 19:58:47 +0000875 ins_h = 0;
876 for (j = 0; j < MIN_MATCH - 1; j++)
877 UPDATE_HASH(ins_h, window[j]);
878 /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
879 * not important since only literal bytes will be emitted.
880 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000881}
882
883/* ===========================================================================
884 * Set match_start to the longest match starting at the given string and
885 * return its length. Matches shorter or equal to prev_length are discarded,
886 * in which case the result is equal to prev_length and match_start is
887 * garbage.
888 * IN assertions: cur_match is the head of the hash chain for the current
889 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
890 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000891
Eric Andersencc8ed391999-10-05 16:24:54 +0000892/* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
893 * match.s. The code is functionally equivalent, so you can use the C version
894 * if desired.
895 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000896static int longest_match(IPos cur_match)
Eric Andersencc8ed391999-10-05 16:24:54 +0000897{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000898 unsigned chain_length = max_chain_length; /* max hash chain length */
899 register uch *scan = window + strstart; /* current string */
900 register uch *match; /* matched string */
901 register int len; /* length of current match */
902 int best_len = prev_length; /* best match length so far */
903 IPos limit =
904
905 strstart > (IPos) MAX_DIST ? strstart - (IPos) MAX_DIST : NIL;
906 /* Stop when cur_match becomes <= limit. To simplify the code,
907 * we prevent matches with the string of window index 0.
908 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000909
910/* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
911 * It is easy to get rid of this optimization if necessary.
912 */
913#if HASH_BITS < 8 || MAX_MATCH != 258
Eric Andersen3073dfb2001-07-02 17:57:32 +0000914# error Code too clever
Eric Andersencc8ed391999-10-05 16:24:54 +0000915#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000916 register uch *strend = window + strstart + MAX_MATCH;
917 register uch scan_end1 = scan[best_len - 1];
918 register uch scan_end = scan[best_len];
Eric Andersencc8ed391999-10-05 16:24:54 +0000919
Erik Andersene49d5ec2000-02-08 19:58:47 +0000920 /* Do not waste too much time if we already have a good match: */
921 if (prev_length >= good_match) {
922 chain_length >>= 2;
923 }
924 Assert(strstart <= window_size - MIN_LOOKAHEAD,
925 "insufficient lookahead");
Eric Andersencc8ed391999-10-05 16:24:54 +0000926
Erik Andersene49d5ec2000-02-08 19:58:47 +0000927 do {
928 Assert(cur_match < strstart, "no future");
929 match = window + cur_match;
Eric Andersencc8ed391999-10-05 16:24:54 +0000930
Erik Andersene49d5ec2000-02-08 19:58:47 +0000931 /* Skip to next match if the match length cannot increase
932 * or if the match length is less than 2:
933 */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000934 if (match[best_len] != scan_end ||
935 match[best_len - 1] != scan_end1 ||
936 *match != *scan || *++match != scan[1])
937 continue;
Eric Andersencc8ed391999-10-05 16:24:54 +0000938
Erik Andersene49d5ec2000-02-08 19:58:47 +0000939 /* The check at best_len-1 can be removed because it will be made
940 * again later. (This heuristic is not always a win.)
941 * It is not necessary to compare scan[2] and match[2] since they
942 * are always equal when the other bytes match, given that
943 * the hash keys are equal and that HASH_BITS >= 8.
944 */
945 scan += 2, match++;
Eric Andersencc8ed391999-10-05 16:24:54 +0000946
Erik Andersene49d5ec2000-02-08 19:58:47 +0000947 /* We check for insufficient lookahead only every 8th comparison;
948 * the 256th check will be made at strstart+258.
949 */
950 do {
951 } while (*++scan == *++match && *++scan == *++match &&
952 *++scan == *++match && *++scan == *++match &&
953 *++scan == *++match && *++scan == *++match &&
954 *++scan == *++match && *++scan == *++match &&
955 scan < strend);
Eric Andersencc8ed391999-10-05 16:24:54 +0000956
Erik Andersene49d5ec2000-02-08 19:58:47 +0000957 len = MAX_MATCH - (int) (strend - scan);
958 scan = strend - MAX_MATCH;
Eric Andersencc8ed391999-10-05 16:24:54 +0000959
Erik Andersene49d5ec2000-02-08 19:58:47 +0000960 if (len > best_len) {
961 match_start = cur_match;
962 best_len = len;
963 if (len >= nice_match)
964 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000965 scan_end1 = scan[best_len - 1];
966 scan_end = scan[best_len];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000967 }
968 } while ((cur_match = prev[cur_match & WMASK]) > limit
969 && --chain_length != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +0000970
Erik Andersene49d5ec2000-02-08 19:58:47 +0000971 return best_len;
Eric Andersencc8ed391999-10-05 16:24:54 +0000972}
Eric Andersencc8ed391999-10-05 16:24:54 +0000973
974#ifdef DEBUG
975/* ===========================================================================
976 * Check that the match at match_start is indeed a match.
977 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000978static void check_match(IPos start, IPos match, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000979{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000980 /* check that the match is indeed a match */
981 if (memcmp((char *) window + match,
982 (char *) window + start, length) != EQUAL) {
983 fprintf(stderr,
984 " start %d, match %d, length %d\n", start, match, length);
Matt Kraaidd19c692001-01-31 19:00:21 +0000985 error_msg("invalid match");
Erik Andersene49d5ec2000-02-08 19:58:47 +0000986 }
987 if (verbose > 1) {
988 fprintf(stderr, "\\[%d,%d]", start - match, length);
989 do {
990 putc(window[start++], stderr);
991 } while (--length != 0);
992 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000993}
994#else
995# define check_match(start, match, length)
996#endif
997
998/* ===========================================================================
999 * Fill the window when the lookahead becomes insufficient.
1000 * Updates strstart and lookahead, and sets eofile if end of input file.
1001 * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
1002 * OUT assertions: at least one byte has been read, or eofile is set;
1003 * file reads are performed for at least two bytes (required for the
1004 * translate_eol option).
1005 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001006static void fill_window()
Eric Andersencc8ed391999-10-05 16:24:54 +00001007{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001008 register unsigned n, m;
1009 unsigned more =
Eric Andersencc8ed391999-10-05 16:24:54 +00001010
Erik Andersene49d5ec2000-02-08 19:58:47 +00001011 (unsigned) (window_size - (ulg) lookahead - (ulg) strstart);
1012 /* Amount of free space at the end of the window. */
Eric Andersencc8ed391999-10-05 16:24:54 +00001013
Erik Andersene49d5ec2000-02-08 19:58:47 +00001014 /* If the window is almost full and there is insufficient lookahead,
1015 * move the upper half to the lower one to make room in the upper half.
1016 */
1017 if (more == (unsigned) EOF) {
1018 /* Very unlikely, but possible on 16 bit machine if strstart == 0
1019 * and lookahead == 1 (input done one byte at time)
1020 */
1021 more--;
1022 } else if (strstart >= WSIZE + MAX_DIST) {
1023 /* By the IN assertion, the window is not empty so we can't confuse
1024 * more == 0 with more == 64K on a 16 bit machine.
1025 */
1026 Assert(window_size == (ulg) 2 * WSIZE, "no sliding with BIG_MEM");
Eric Andersencc8ed391999-10-05 16:24:54 +00001027
Erik Andersene49d5ec2000-02-08 19:58:47 +00001028 memcpy((char *) window, (char *) window + WSIZE, (unsigned) WSIZE);
1029 match_start -= WSIZE;
1030 strstart -= WSIZE; /* we now have strstart >= MAX_DIST: */
Eric Andersencc8ed391999-10-05 16:24:54 +00001031
Erik Andersene49d5ec2000-02-08 19:58:47 +00001032 block_start -= (long) WSIZE;
1033
1034 for (n = 0; n < HASH_SIZE; n++) {
1035 m = head[n];
1036 head[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1037 }
1038 for (n = 0; n < WSIZE; n++) {
1039 m = prev[n];
1040 prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
1041 /* If n is not on any hash chain, prev[n] is garbage but
1042 * its value will never be used.
1043 */
1044 }
1045 more += WSIZE;
1046 }
1047 /* At this point, more >= 2 */
1048 if (!eofile) {
1049 n = read_buf((char *) window + strstart + lookahead, more);
1050 if (n == 0 || n == (unsigned) EOF) {
1051 eofile = 1;
1052 } else {
1053 lookahead += n;
1054 }
1055 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001056}
1057
1058/* ===========================================================================
1059 * Flush the current block, with given end-of-file flag.
1060 * IN assertion: strstart is set to the end of the current match.
1061 */
1062#define FLUSH_BLOCK(eof) \
1063 flush_block(block_start >= 0L ? (char*)&window[(unsigned)block_start] : \
1064 (char*)NULL, (long)strstart - block_start, (eof))
1065
1066/* ===========================================================================
1067 * Same as above, but achieves better compression. We use a lazy
1068 * evaluation for matches: a match is finally adopted only if there is
1069 * no better match at the next window position.
1070 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001071static ulg deflate()
Eric Andersencc8ed391999-10-05 16:24:54 +00001072{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001073 IPos hash_head; /* head of hash chain */
1074 IPos prev_match; /* previous match */
1075 int flush; /* set if current block must be flushed */
1076 int match_available = 0; /* set if previous match exists */
1077 register unsigned match_length = MIN_MATCH - 1; /* length of best match */
1078
Erik Andersene49d5ec2000-02-08 19:58:47 +00001079 /* Process the input block. */
1080 while (lookahead != 0) {
1081 /* Insert the string window[strstart .. strstart+2] in the
1082 * dictionary, and set hash_head to the head of the hash chain:
1083 */
1084 INSERT_STRING(strstart, hash_head);
Eric Andersencc8ed391999-10-05 16:24:54 +00001085
Erik Andersene49d5ec2000-02-08 19:58:47 +00001086 /* Find the longest match, discarding those <= prev_length.
1087 */
1088 prev_length = match_length, prev_match = match_start;
1089 match_length = MIN_MATCH - 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001090
Erik Andersene49d5ec2000-02-08 19:58:47 +00001091 if (hash_head != NIL && prev_length < max_lazy_match &&
1092 strstart - hash_head <= MAX_DIST) {
1093 /* To simplify the code, we prevent matches with the string
1094 * of window index 0 (in particular we have to avoid a match
1095 * of the string with itself at the start of the input file).
1096 */
1097 match_length = longest_match(hash_head);
1098 /* longest_match() sets match_start */
1099 if (match_length > lookahead)
1100 match_length = lookahead;
Eric Andersencc8ed391999-10-05 16:24:54 +00001101
Erik Andersene49d5ec2000-02-08 19:58:47 +00001102 /* Ignore a length 3 match if it is too distant: */
1103 if (match_length == MIN_MATCH
1104 && strstart - match_start > TOO_FAR) {
1105 /* If prev_match is also MIN_MATCH, match_start is garbage
1106 * but we will ignore the current match anyway.
1107 */
1108 match_length--;
1109 }
1110 }
1111 /* If there was a match at the previous step and the current
1112 * match is not better, output the previous match:
1113 */
1114 if (prev_length >= MIN_MATCH && match_length <= prev_length) {
Eric Andersencc8ed391999-10-05 16:24:54 +00001115
Erik Andersene49d5ec2000-02-08 19:58:47 +00001116 check_match(strstart - 1, prev_match, prev_length);
Eric Andersencc8ed391999-10-05 16:24:54 +00001117
Erik Andersene49d5ec2000-02-08 19:58:47 +00001118 flush =
1119 ct_tally(strstart - 1 - prev_match,
1120 prev_length - MIN_MATCH);
Eric Andersencc8ed391999-10-05 16:24:54 +00001121
Erik Andersene49d5ec2000-02-08 19:58:47 +00001122 /* Insert in hash table all strings up to the end of the match.
1123 * strstart-1 and strstart are already inserted.
1124 */
1125 lookahead -= prev_length - 1;
1126 prev_length -= 2;
1127 do {
1128 strstart++;
1129 INSERT_STRING(strstart, hash_head);
1130 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1131 * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1132 * these bytes are garbage, but it does not matter since the
1133 * next lookahead bytes will always be emitted as literals.
1134 */
1135 } while (--prev_length != 0);
1136 match_available = 0;
1137 match_length = MIN_MATCH - 1;
1138 strstart++;
1139 if (flush)
1140 FLUSH_BLOCK(0), block_start = strstart;
Eric Andersencc8ed391999-10-05 16:24:54 +00001141
Erik Andersene49d5ec2000-02-08 19:58:47 +00001142 } else if (match_available) {
1143 /* If there was no match at the previous position, output a
1144 * single literal. If there was a match but the current match
1145 * is longer, truncate the previous match to a single literal.
1146 */
1147 Tracevv((stderr, "%c", window[strstart - 1]));
1148 if (ct_tally(0, window[strstart - 1])) {
1149 FLUSH_BLOCK(0), block_start = strstart;
1150 }
1151 strstart++;
1152 lookahead--;
1153 } else {
1154 /* There is no previous match to compare with, wait for
1155 * the next step to decide.
1156 */
1157 match_available = 1;
1158 strstart++;
1159 lookahead--;
1160 }
1161 Assert(strstart <= isize && lookahead <= isize, "a bit too far");
Eric Andersencc8ed391999-10-05 16:24:54 +00001162
Erik Andersene49d5ec2000-02-08 19:58:47 +00001163 /* Make sure that we always have enough lookahead, except
1164 * at the end of the input file. We need MAX_MATCH bytes
1165 * for the next match, plus MIN_MATCH bytes to insert the
1166 * string following the next match.
1167 */
1168 while (lookahead < MIN_LOOKAHEAD && !eofile)
1169 fill_window();
1170 }
1171 if (match_available)
1172 ct_tally(0, window[strstart - 1]);
Eric Andersencc8ed391999-10-05 16:24:54 +00001173
Erik Andersene49d5ec2000-02-08 19:58:47 +00001174 return FLUSH_BLOCK(1); /* eof */
Eric Andersencc8ed391999-10-05 16:24:54 +00001175}
Erik Andersene49d5ec2000-02-08 19:58:47 +00001176
Eric Andersencc8ed391999-10-05 16:24:54 +00001177/* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
1178 * Copyright (C) 1992-1993 Jean-loup Gailly
1179 * The unzip code was written and put in the public domain by Mark Adler.
1180 * Portions of the lzw code are derived from the public domain 'compress'
1181 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
1182 * Ken Turkowski, Dave Mack and Peter Jannesen.
1183 *
1184 * See the license_msg below and the file COPYING for the software license.
1185 * See the file algorithm.doc for the compression algorithms and file formats.
1186 */
1187
1188/* Compress files with zip algorithm and 'compress' interface.
1189 * See usage() and help() functions below for all options.
1190 * Outputs:
1191 * file.gz: compressed file with same mode, owner, and utimes
1192 * or stdout with -c option or if stdin used as input.
1193 * If the output file name had to be truncated, the original name is kept
1194 * in the compressed file.
Eric Andersencc8ed391999-10-05 16:24:54 +00001195 */
1196
Eric Andersencc8ed391999-10-05 16:24:54 +00001197 /* configuration */
1198
Erik Andersene49d5ec2000-02-08 19:58:47 +00001199typedef struct dirent dir_type;
1200
Erik Andersen61677fe2000-04-13 01:18:56 +00001201typedef RETSIGTYPE(*sig_type) (int);
Eric Andersencc8ed391999-10-05 16:24:54 +00001202
Eric Andersencc8ed391999-10-05 16:24:54 +00001203/* ======================================================================== */
1204// int main (argc, argv)
1205// int argc;
1206// char **argv;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001207int gzip_main(int argc, char **argv)
Eric Andersencc8ed391999-10-05 16:24:54 +00001208{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001209 int result;
1210 int inFileNum;
1211 int outFileNum;
1212 struct stat statBuf;
1213 char *delFileName;
1214 int tostdout = 0;
Eric Andersenea824fb2000-07-21 22:17:39 +00001215 int force = 0;
Matt Kraai53265542001-04-18 16:05:34 +00001216 int opt;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001217
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001218 while ((opt = getopt(argc, argv, "cf123456789dq")) != -1) {
Matt Kraai53265542001-04-18 16:05:34 +00001219 switch (opt) {
1220 case 'c':
Erik Andersene49d5ec2000-02-08 19:58:47 +00001221 tostdout = 1;
Matt Kraai53265542001-04-18 16:05:34 +00001222 break;
1223 case 'f':
1224 force = 1;
1225 break;
1226 /* Ignore 1-9 (compression level) options */
1227 case '1': case '2': case '3': case '4': case '5':
1228 case '6': case '7': case '8': case '9':
1229 break;
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001230 case 'q':
1231 break;
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001232#ifdef CONFIG_GUNZIP
Matt Kraai53265542001-04-18 16:05:34 +00001233 case 'd':
1234 optind = 1;
1235 return gunzip_main(argc, argv);
Glenn L McGrath528ef502001-04-11 03:45:37 +00001236#endif
Matt Kraai53265542001-04-18 16:05:34 +00001237 default:
1238 show_usage();
Erik Andersene49d5ec2000-02-08 19:58:47 +00001239 }
1240 }
1241
1242 foreground = signal(SIGINT, SIG_IGN) != SIG_IGN;
1243 if (foreground) {
1244 (void) signal(SIGINT, (sig_type) abort_gzip);
1245 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001246#ifdef SIGTERM
Erik Andersene49d5ec2000-02-08 19:58:47 +00001247 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
1248 (void) signal(SIGTERM, (sig_type) abort_gzip);
1249 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001250#endif
1251#ifdef SIGHUP
Erik Andersene49d5ec2000-02-08 19:58:47 +00001252 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
1253 (void) signal(SIGHUP, (sig_type) abort_gzip);
1254 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001255#endif
1256
Erik Andersene49d5ec2000-02-08 19:58:47 +00001257 strncpy(z_suffix, Z_SUFFIX, sizeof(z_suffix) - 1);
1258 z_len = strlen(z_suffix);
Eric Andersencc8ed391999-10-05 16:24:54 +00001259
Erik Andersene49d5ec2000-02-08 19:58:47 +00001260 /* Allocate all global buffers (for DYN_ALLOC option) */
1261 ALLOC(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
1262 ALLOC(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
1263 ALLOC(ush, d_buf, DIST_BUFSIZE);
1264 ALLOC(uch, window, 2L * WSIZE);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001265 ALLOC(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +00001266
Matt Kraai9bd49d62002-02-05 22:31:48 +00001267 clear_bufs();
1268 part_nb = 0;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001269
Matt Kraai9bd49d62002-02-05 22:31:48 +00001270 if (optind == argc) {
1271 time_stamp = 0;
1272 ifile_size = -1L;
1273 zip(STDIN_FILENO, STDOUT_FILENO);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001274 } else {
Matt Kraai9bd49d62002-02-05 22:31:48 +00001275 int i;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001276
Matt Kraai9bd49d62002-02-05 22:31:48 +00001277 for (i = optind; i < argc; i++) {
1278 char *path = NULL;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001279
Matt Kraai9bd49d62002-02-05 22:31:48 +00001280 if (strcmp(argv[i], "-") == 0) {
1281 time_stamp = 0;
1282 ifile_size = -1L;
1283 inFileNum = STDIN_FILENO;
1284 outFileNum = STDOUT_FILENO;
1285 } else {
1286 inFileNum = open(argv[i], O_RDONLY);
1287 if (inFileNum < 0 || fstat (inFileNum, &statBuf) < 0)
1288 perror_msg_and_die("%s", argv[i]);
1289 time_stamp = statBuf.st_ctime;
1290 ifile_size = statBuf.st_size;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001291
Matt Kraai9bd49d62002-02-05 22:31:48 +00001292 if (!tostdout) {
1293 path = xmalloc(strlen(argv[i]) + 4);
1294 strcpy(path, argv[i]);
1295 strcat(path, ".gz");
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001296
Matt Kraai9bd49d62002-02-05 22:31:48 +00001297 /* Open output file */
Erik Andersen4d1d0111999-12-17 18:44:15 +00001298#if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1)
Matt Kraai9bd49d62002-02-05 22:31:48 +00001299 outFileNum = open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001300#else
Matt Kraai9bd49d62002-02-05 22:31:48 +00001301 outFileNum = open(path, O_RDWR | O_CREAT | O_EXCL);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001302#endif
Matt Kraai9bd49d62002-02-05 22:31:48 +00001303 if (outFileNum < 0) {
1304 perror_msg("%s", path);
1305 free(path);
1306 continue;
1307 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001308
Matt Kraai9bd49d62002-02-05 22:31:48 +00001309 /* Set permissions on the file */
1310 fchmod(outFileNum, statBuf.st_mode);
1311 } else
1312 outFileNum = STDOUT_FILENO;
1313 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001314
Matt Kraai9bd49d62002-02-05 22:31:48 +00001315 if (path == NULL && force == 0) {
1316 perror_msg("compressed data not written to a terminal. Use -f to force compression.");
1317 free(path);
1318 continue;
1319 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001320
Matt Kraai9bd49d62002-02-05 22:31:48 +00001321 result = zip(inFileNum, outFileNum);
1322
1323 if (path != NULL) {
1324 close (inFileNum);
1325 close (outFileNum);
1326
1327 /* Delete the original file */
1328 if (result == OK)
1329 delFileName = argv[i];
1330 else
1331 delFileName = path;
1332
1333 if (unlink(delFileName) < 0)
1334 perror_msg("%s", delFileName);
1335 }
1336
1337 free(path);
1338 }
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001339 }
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001340
Eric Andersenb6106152000-06-19 17:25:40 +00001341 return(exit_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001342}
1343
Eric Andersencc8ed391999-10-05 16:24:54 +00001344/* trees.c -- output deflated data using Huffman coding
1345 * Copyright (C) 1992-1993 Jean-loup Gailly
1346 * This is free software; you can redistribute it and/or modify it under the
1347 * terms of the GNU General Public License, see the file COPYING.
1348 */
1349
1350/*
1351 * PURPOSE
1352 *
1353 * Encode various sets of source values using variable-length
1354 * binary code trees.
1355 *
1356 * DISCUSSION
1357 *
1358 * The PKZIP "deflation" process uses several Huffman trees. The more
1359 * common source values are represented by shorter bit sequences.
1360 *
1361 * Each code tree is stored in the ZIP file in a compressed form
1362 * which is itself a Huffman encoding of the lengths of
1363 * all the code strings (in ascending order by source values).
1364 * The actual code strings are reconstructed from the lengths in
1365 * the UNZIP process, as described in the "application note"
1366 * (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
1367 *
1368 * REFERENCES
1369 *
1370 * Lynch, Thomas J.
1371 * Data Compression: Techniques and Applications, pp. 53-55.
1372 * Lifetime Learning Publications, 1985. ISBN 0-534-03418-7.
1373 *
1374 * Storer, James A.
1375 * Data Compression: Methods and Theory, pp. 49-50.
1376 * Computer Science Press, 1988. ISBN 0-7167-8156-5.
1377 *
1378 * Sedgewick, R.
1379 * Algorithms, p290.
1380 * Addison-Wesley, 1983. ISBN 0-201-06672-6.
1381 *
1382 * INTERFACE
1383 *
1384 * void ct_init (ush *attr, int *methodp)
1385 * Allocate the match buffer, initialize the various tables and save
1386 * the location of the internal file attribute (ascii/binary) and
1387 * method (DEFLATE/STORE)
1388 *
1389 * void ct_tally (int dist, int lc);
1390 * Save the match info and tally the frequency counts.
1391 *
1392 * long flush_block (char *buf, ulg stored_len, int eof)
1393 * Determine the best encoding for the current block: dynamic trees,
1394 * static trees or store, and output the encoded block to the zip
1395 * file. Returns the total compressed length for the file so far.
1396 *
1397 */
1398
Eric Andersencc8ed391999-10-05 16:24:54 +00001399/* ===========================================================================
1400 * Constants
1401 */
1402
1403#define MAX_BITS 15
1404/* All codes must not exceed MAX_BITS bits */
1405
1406#define MAX_BL_BITS 7
1407/* Bit length codes must not exceed MAX_BL_BITS bits */
1408
1409#define LENGTH_CODES 29
1410/* number of length codes, not counting the special END_BLOCK code */
1411
1412#define LITERALS 256
1413/* number of literal bytes 0..255 */
1414
1415#define END_BLOCK 256
1416/* end of block literal code */
1417
1418#define L_CODES (LITERALS+1+LENGTH_CODES)
1419/* number of Literal or Length codes, including the END_BLOCK code */
1420
1421#define D_CODES 30
1422/* number of distance codes */
1423
1424#define BL_CODES 19
1425/* number of codes used to transfer the bit lengths */
1426
Eric Andersen39eb0402001-08-22 04:15:47 +00001427typedef uch extra_bits_t;
Eric Andersencc8ed391999-10-05 16:24:54 +00001428
Eric Andersen39eb0402001-08-22 04:15:47 +00001429/* extra bits for each length code */
1430static const extra_bits_t extra_lbits[LENGTH_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001431 = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
1432 4, 4, 5, 5, 5, 5, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001433
Eric Andersen39eb0402001-08-22 04:15:47 +00001434/* extra bits for each distance code */
1435static const extra_bits_t extra_dbits[D_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001436 = { 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
1437 10, 10, 11, 11, 12, 12, 13, 13 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001438
Eric Andersen39eb0402001-08-22 04:15:47 +00001439/* extra bits for each bit length code */
1440static const extra_bits_t extra_blbits[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001441= { 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 +00001442
1443#define STORED_BLOCK 0
1444#define STATIC_TREES 1
1445#define DYN_TREES 2
1446/* The three kinds of block type */
1447
1448#ifndef LIT_BUFSIZE
1449# ifdef SMALL_MEM
1450# define LIT_BUFSIZE 0x2000
1451# else
1452# ifdef MEDIUM_MEM
1453# define LIT_BUFSIZE 0x4000
1454# else
1455# define LIT_BUFSIZE 0x8000
1456# endif
1457# endif
1458#endif
1459#ifndef DIST_BUFSIZE
1460# define DIST_BUFSIZE LIT_BUFSIZE
1461#endif
1462/* Sizes of match buffers for literals/lengths and distances. There are
1463 * 4 reasons for limiting LIT_BUFSIZE to 64K:
1464 * - frequencies can be kept in 16 bit counters
1465 * - if compression is not successful for the first block, all input data is
1466 * still in the window so we can still emit a stored block even when input
1467 * comes from standard input. (This can also be done for all blocks if
1468 * LIT_BUFSIZE is not greater than 32K.)
1469 * - if compression is not successful for a file smaller than 64K, we can
1470 * even emit a stored file instead of a stored block (saving 5 bytes).
1471 * - creating new Huffman trees less frequently may not provide fast
1472 * adaptation to changes in the input data statistics. (Take for
1473 * example a binary file with poorly compressible code followed by
1474 * a highly compressible string table.) Smaller buffer sizes give
1475 * fast adaptation but have of course the overhead of transmitting trees
1476 * more frequently.
1477 * - I can't count above 4
1478 * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
1479 * memory at the expense of compression). Some optimizations would be possible
1480 * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
1481 */
1482#if LIT_BUFSIZE > INBUFSIZ
Aaron Lehmannb9df4702001-12-06 03:22:43 +00001483#error cannot overlay l_buf and inbuf
Eric Andersencc8ed391999-10-05 16:24:54 +00001484#endif
Eric Andersencc8ed391999-10-05 16:24:54 +00001485#define REP_3_6 16
1486/* repeat previous bit length 3-6 times (2 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001487#define REPZ_3_10 17
1488/* repeat a zero length 3-10 times (3 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001489#define REPZ_11_138 18
Erik Andersene49d5ec2000-02-08 19:58:47 +00001490/* repeat a zero length 11-138 times (7 bits of repeat count) *//* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +00001491 * Local data
Erik Andersene49d5ec2000-02-08 19:58:47 +00001492 *//* Data structure describing a single value and its code string. */ typedef struct ct_data {
1493 union {
1494 ush freq; /* frequency count */
1495 ush code; /* bit string */
1496 } fc;
1497 union {
1498 ush dad; /* father node in Huffman tree */
1499 ush len; /* length of bit string */
1500 } dl;
Eric Andersencc8ed391999-10-05 16:24:54 +00001501} ct_data;
1502
1503#define Freq fc.freq
1504#define Code fc.code
1505#define Dad dl.dad
1506#define Len dl.len
1507
1508#define HEAP_SIZE (2*L_CODES+1)
1509/* maximum heap size */
1510
Eric Andersen3073dfb2001-07-02 17:57:32 +00001511static ct_data dyn_ltree[HEAP_SIZE]; /* literal and length tree */
1512static ct_data dyn_dtree[2 * D_CODES + 1]; /* distance tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001513
Eric Andersen3073dfb2001-07-02 17:57:32 +00001514static ct_data static_ltree[L_CODES + 2];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001515
Eric Andersencc8ed391999-10-05 16:24:54 +00001516/* The static literal tree. Since the bit lengths are imposed, there is no
1517 * need for the L_CODES extra codes used during heap construction. However
1518 * The codes 286 and 287 are needed to build a canonical tree (see ct_init
1519 * below).
1520 */
1521
Eric Andersen3073dfb2001-07-02 17:57:32 +00001522static ct_data static_dtree[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001523
Eric Andersencc8ed391999-10-05 16:24:54 +00001524/* The static distance tree. (Actually a trivial tree since all codes use
1525 * 5 bits.)
1526 */
1527
Eric Andersen3073dfb2001-07-02 17:57:32 +00001528static ct_data bl_tree[2 * BL_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001529
Eric Andersencc8ed391999-10-05 16:24:54 +00001530/* Huffman tree for the bit lengths */
1531
1532typedef struct tree_desc {
Eric Andersen3073dfb2001-07-02 17:57:32 +00001533 ct_data *dyn_tree; /* the dynamic tree */
1534 ct_data *static_tree; /* corresponding static tree or NULL */
Eric Andersen39eb0402001-08-22 04:15:47 +00001535 const extra_bits_t *extra_bits; /* extra bits for each code or NULL */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001536 int extra_base; /* base index for extra_bits */
1537 int elems; /* max number of elements in the tree */
1538 int max_length; /* max bit length for the codes */
1539 int max_code; /* largest code with non zero frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00001540} tree_desc;
1541
Eric Andersen3073dfb2001-07-02 17:57:32 +00001542static tree_desc l_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001543 { dyn_ltree, static_ltree, extra_lbits, LITERALS + 1, L_CODES,
1544 MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001545
Eric Andersen3073dfb2001-07-02 17:57:32 +00001546static tree_desc d_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001547 { dyn_dtree, static_dtree, extra_dbits, 0, D_CODES, MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001548
Eric Andersen3073dfb2001-07-02 17:57:32 +00001549static tree_desc bl_desc =
1550 { bl_tree, (ct_data *) 0, extra_blbits, 0, BL_CODES, MAX_BL_BITS,
Erik Andersene49d5ec2000-02-08 19:58:47 +00001551 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001552
1553
Eric Andersen3073dfb2001-07-02 17:57:32 +00001554static ush bl_count[MAX_BITS + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001555
Eric Andersencc8ed391999-10-05 16:24:54 +00001556/* number of codes at each bit length for an optimal tree */
1557
Eric Andersen3073dfb2001-07-02 17:57:32 +00001558static const uch bl_order[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001559= { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
1560
Eric Andersencc8ed391999-10-05 16:24:54 +00001561/* The lengths of the bit length codes are sent in order of decreasing
1562 * probability, to avoid transmitting the lengths for unused bit length codes.
1563 */
1564
Eric Andersen3073dfb2001-07-02 17:57:32 +00001565static int heap[2 * L_CODES + 1]; /* heap used to build the Huffman trees */
1566static int heap_len; /* number of elements in the heap */
1567static int heap_max; /* element of largest frequency */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001568
Eric Andersencc8ed391999-10-05 16:24:54 +00001569/* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
1570 * The same heap array is used to build all trees.
1571 */
1572
Eric Andersen3073dfb2001-07-02 17:57:32 +00001573static uch depth[2 * L_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001574
Eric Andersencc8ed391999-10-05 16:24:54 +00001575/* Depth of each subtree used as tie breaker for trees of equal frequency */
1576
Eric Andersen3073dfb2001-07-02 17:57:32 +00001577static uch length_code[MAX_MATCH - MIN_MATCH + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001578
Eric Andersencc8ed391999-10-05 16:24:54 +00001579/* length code for each normalized match length (0 == MIN_MATCH) */
1580
Eric Andersen3073dfb2001-07-02 17:57:32 +00001581static uch dist_code[512];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001582
Eric Andersencc8ed391999-10-05 16:24:54 +00001583/* distance codes. The first 256 values correspond to the distances
1584 * 3 .. 258, the last 256 values correspond to the top 8 bits of
1585 * the 15 bit distances.
1586 */
1587
Eric Andersen3073dfb2001-07-02 17:57:32 +00001588static int base_length[LENGTH_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001589
Eric Andersencc8ed391999-10-05 16:24:54 +00001590/* First normalized length for each code (0 = MIN_MATCH) */
1591
Eric Andersen3073dfb2001-07-02 17:57:32 +00001592static int base_dist[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001593
Eric Andersencc8ed391999-10-05 16:24:54 +00001594/* First normalized distance for each code (0 = distance of 1) */
1595
1596#define l_buf inbuf
1597/* DECLARE(uch, l_buf, LIT_BUFSIZE); buffer for literals or lengths */
1598
1599/* DECLARE(ush, d_buf, DIST_BUFSIZE); buffer for distances */
1600
Eric Andersen3073dfb2001-07-02 17:57:32 +00001601static uch flag_buf[(LIT_BUFSIZE / 8)];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001602
Eric Andersencc8ed391999-10-05 16:24:54 +00001603/* flag_buf is a bit array distinguishing literals from lengths in
1604 * l_buf, thus indicating the presence or absence of a distance.
1605 */
1606
Eric Andersen3073dfb2001-07-02 17:57:32 +00001607static unsigned last_lit; /* running index in l_buf */
1608static unsigned last_dist; /* running index in d_buf */
1609static unsigned last_flags; /* running index in flag_buf */
1610static uch flags; /* current flags not yet saved in flag_buf */
1611static uch flag_bit; /* current bit used in flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001612
Eric Andersencc8ed391999-10-05 16:24:54 +00001613/* bits are filled in flags starting at bit 0 (least significant).
1614 * Note: these flags are overkill in the current code since we don't
1615 * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1616 */
1617
Eric Andersen3073dfb2001-07-02 17:57:32 +00001618static ulg opt_len; /* bit length of current block with optimal trees */
1619static ulg static_len; /* bit length of current block with static trees */
Eric Andersencc8ed391999-10-05 16:24:54 +00001620
Eric Andersen3073dfb2001-07-02 17:57:32 +00001621static ulg compressed_len; /* total bit length of compressed file */
Eric Andersencc8ed391999-10-05 16:24:54 +00001622
Erik Andersene49d5ec2000-02-08 19:58:47 +00001623
Eric Andersen3073dfb2001-07-02 17:57:32 +00001624static ush *file_type; /* pointer to UNKNOWN, BINARY or ASCII */
1625static int *file_method; /* pointer to DEFLATE or STORE */
Eric Andersencc8ed391999-10-05 16:24:54 +00001626
1627/* ===========================================================================
1628 * Local (static) routines in this file.
1629 */
1630
Eric Andersen3073dfb2001-07-02 17:57:32 +00001631static void init_block (void);
1632static void pqdownheap (ct_data * tree, int k);
1633static void gen_bitlen (tree_desc * desc);
1634static void gen_codes (ct_data * tree, int max_code);
1635static void build_tree (tree_desc * desc);
1636static void scan_tree (ct_data * tree, int max_code);
1637static void send_tree (ct_data * tree, int max_code);
1638static int build_bl_tree (void);
1639static void send_all_trees (int lcodes, int dcodes, int blcodes);
1640static void compress_block (ct_data * ltree, ct_data * dtree);
1641static void set_file_type (void);
Eric Andersencc8ed391999-10-05 16:24:54 +00001642
1643
1644#ifndef DEBUG
1645# define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
1646 /* Send a code of the given tree. c and tree must not have side effects */
1647
Erik Andersene49d5ec2000-02-08 19:58:47 +00001648#else /* DEBUG */
Eric Andersencc8ed391999-10-05 16:24:54 +00001649# define send_code(c, tree) \
1650 { if (verbose>1) fprintf(stderr,"\ncd %3d ",(c)); \
1651 send_bits(tree[c].Code, tree[c].Len); }
1652#endif
1653
1654#define d_code(dist) \
1655 ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
1656/* Mapping from a distance to a distance code. dist is the distance - 1 and
1657 * must not have side effects. dist_code[256] and dist_code[257] are never
1658 * used.
1659 */
1660
Eric Andersencc8ed391999-10-05 16:24:54 +00001661/* the arguments must not have side effects */
1662
1663/* ===========================================================================
1664 * Allocate the match buffer, initialize the various tables and save the
1665 * location of the internal file attribute (ascii/binary) and method
1666 * (DEFLATE/STORE).
1667 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001668static void ct_init(ush *attr, int *methodp)
Eric Andersencc8ed391999-10-05 16:24:54 +00001669{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001670 int n; /* iterates over tree elements */
1671 int bits; /* bit counter */
1672 int length; /* length value */
1673 int code; /* code value */
1674 int dist; /* distance index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001675
Erik Andersene49d5ec2000-02-08 19:58:47 +00001676 file_type = attr;
1677 file_method = methodp;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001678 compressed_len = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +00001679
Erik Andersene49d5ec2000-02-08 19:58:47 +00001680 if (static_dtree[0].Len != 0)
1681 return; /* ct_init already called */
Eric Andersencc8ed391999-10-05 16:24:54 +00001682
Erik Andersene49d5ec2000-02-08 19:58:47 +00001683 /* Initialize the mapping length (0..255) -> length code (0..28) */
1684 length = 0;
1685 for (code = 0; code < LENGTH_CODES - 1; code++) {
1686 base_length[code] = length;
1687 for (n = 0; n < (1 << extra_lbits[code]); n++) {
1688 length_code[length++] = (uch) code;
1689 }
1690 }
1691 Assert(length == 256, "ct_init: length != 256");
1692 /* Note that the length 255 (match length 258) can be represented
1693 * in two different ways: code 284 + 5 bits or code 285, so we
1694 * overwrite length_code[255] to use the best encoding:
1695 */
1696 length_code[length - 1] = (uch) code;
Eric Andersencc8ed391999-10-05 16:24:54 +00001697
Erik Andersene49d5ec2000-02-08 19:58:47 +00001698 /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1699 dist = 0;
1700 for (code = 0; code < 16; code++) {
1701 base_dist[code] = dist;
1702 for (n = 0; n < (1 << extra_dbits[code]); n++) {
1703 dist_code[dist++] = (uch) code;
1704 }
1705 }
1706 Assert(dist == 256, "ct_init: dist != 256");
1707 dist >>= 7; /* from now on, all distances are divided by 128 */
1708 for (; code < D_CODES; code++) {
1709 base_dist[code] = dist << 7;
1710 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
1711 dist_code[256 + dist++] = (uch) code;
1712 }
1713 }
1714 Assert(dist == 256, "ct_init: 256+dist != 512");
Eric Andersencc8ed391999-10-05 16:24:54 +00001715
Erik Andersene49d5ec2000-02-08 19:58:47 +00001716 /* Construct the codes of the static literal tree */
1717 for (bits = 0; bits <= MAX_BITS; bits++)
1718 bl_count[bits] = 0;
1719 n = 0;
1720 while (n <= 143)
1721 static_ltree[n++].Len = 8, bl_count[8]++;
1722 while (n <= 255)
1723 static_ltree[n++].Len = 9, bl_count[9]++;
1724 while (n <= 279)
1725 static_ltree[n++].Len = 7, bl_count[7]++;
1726 while (n <= 287)
1727 static_ltree[n++].Len = 8, bl_count[8]++;
1728 /* Codes 286 and 287 do not exist, but we must include them in the
1729 * tree construction to get a canonical Huffman tree (longest code
1730 * all ones)
1731 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001732 gen_codes((ct_data *) static_ltree, L_CODES + 1);
Eric Andersencc8ed391999-10-05 16:24:54 +00001733
Erik Andersene49d5ec2000-02-08 19:58:47 +00001734 /* The static distance tree is trivial: */
1735 for (n = 0; n < D_CODES; n++) {
1736 static_dtree[n].Len = 5;
1737 static_dtree[n].Code = bi_reverse(n, 5);
1738 }
1739
1740 /* Initialize the first block of the first file: */
1741 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00001742}
1743
1744/* ===========================================================================
1745 * Initialize a new block.
1746 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001747static void init_block()
Eric Andersencc8ed391999-10-05 16:24:54 +00001748{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001749 int n; /* iterates over tree elements */
Eric Andersencc8ed391999-10-05 16:24:54 +00001750
Erik Andersene49d5ec2000-02-08 19:58:47 +00001751 /* Initialize the trees. */
1752 for (n = 0; n < L_CODES; n++)
1753 dyn_ltree[n].Freq = 0;
1754 for (n = 0; n < D_CODES; n++)
1755 dyn_dtree[n].Freq = 0;
1756 for (n = 0; n < BL_CODES; n++)
1757 bl_tree[n].Freq = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001758
Erik Andersene49d5ec2000-02-08 19:58:47 +00001759 dyn_ltree[END_BLOCK].Freq = 1;
1760 opt_len = static_len = 0L;
1761 last_lit = last_dist = last_flags = 0;
1762 flags = 0;
1763 flag_bit = 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001764}
1765
1766#define SMALLEST 1
1767/* Index within the heap array of least frequent node in the Huffman tree */
1768
1769
1770/* ===========================================================================
1771 * Remove the smallest element from the heap and recreate the heap with
1772 * one less element. Updates heap and heap_len.
1773 */
1774#define pqremove(tree, top) \
1775{\
1776 top = heap[SMALLEST]; \
1777 heap[SMALLEST] = heap[heap_len--]; \
1778 pqdownheap(tree, SMALLEST); \
1779}
1780
1781/* ===========================================================================
1782 * Compares to subtrees, using the tree depth as tie breaker when
1783 * the subtrees have equal frequency. This minimizes the worst case length.
1784 */
1785#define smaller(tree, n, m) \
1786 (tree[n].Freq < tree[m].Freq || \
1787 (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
1788
1789/* ===========================================================================
1790 * Restore the heap property by moving down the tree starting at node k,
1791 * exchanging a node with the smallest of its two sons if necessary, stopping
1792 * when the heap property is re-established (each father smaller than its
1793 * two sons).
1794 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001795static void pqdownheap(ct_data *tree, int k)
Eric Andersencc8ed391999-10-05 16:24:54 +00001796{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001797 int v = heap[k];
1798 int j = k << 1; /* left son of k */
Eric Andersencc8ed391999-10-05 16:24:54 +00001799
Erik Andersene49d5ec2000-02-08 19:58:47 +00001800 while (j <= heap_len) {
1801 /* Set j to the smallest of the two sons: */
1802 if (j < heap_len && smaller(tree, heap[j + 1], heap[j]))
1803 j++;
Eric Andersencc8ed391999-10-05 16:24:54 +00001804
Erik Andersene49d5ec2000-02-08 19:58:47 +00001805 /* Exit if v is smaller than both sons */
1806 if (smaller(tree, v, heap[j]))
1807 break;
Eric Andersencc8ed391999-10-05 16:24:54 +00001808
Erik Andersene49d5ec2000-02-08 19:58:47 +00001809 /* Exchange v with the smallest son */
1810 heap[k] = heap[j];
1811 k = j;
1812
1813 /* And continue down the tree, setting j to the left son of k */
1814 j <<= 1;
1815 }
1816 heap[k] = v;
Eric Andersencc8ed391999-10-05 16:24:54 +00001817}
1818
1819/* ===========================================================================
1820 * Compute the optimal bit lengths for a tree and update the total bit length
1821 * for the current block.
1822 * IN assertion: the fields freq and dad are set, heap[heap_max] and
1823 * above are the tree nodes sorted by increasing frequency.
1824 * OUT assertions: the field len is set to the optimal bit length, the
1825 * array bl_count contains the frequencies for each bit length.
1826 * The length opt_len is updated; static_len is also updated if stree is
1827 * not null.
1828 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001829static void gen_bitlen(tree_desc *desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001830{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001831 ct_data *tree = desc->dyn_tree;
Eric Andersen39eb0402001-08-22 04:15:47 +00001832 const extra_bits_t *extra = desc->extra_bits;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001833 int base = desc->extra_base;
1834 int max_code = desc->max_code;
1835 int max_length = desc->max_length;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001836 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001837 int h; /* heap index */
1838 int n, m; /* iterate over the tree elements */
1839 int bits; /* bit length */
1840 int xbits; /* extra bits */
1841 ush f; /* frequency */
1842 int overflow = 0; /* number of elements with bit length too large */
Eric Andersencc8ed391999-10-05 16:24:54 +00001843
Erik Andersene49d5ec2000-02-08 19:58:47 +00001844 for (bits = 0; bits <= MAX_BITS; bits++)
1845 bl_count[bits] = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001846
Erik Andersene49d5ec2000-02-08 19:58:47 +00001847 /* In a first pass, compute the optimal bit lengths (which may
1848 * overflow in the case of the bit length tree).
1849 */
1850 tree[heap[heap_max]].Len = 0; /* root of the heap */
Eric Andersencc8ed391999-10-05 16:24:54 +00001851
Erik Andersene49d5ec2000-02-08 19:58:47 +00001852 for (h = heap_max + 1; h < HEAP_SIZE; h++) {
1853 n = heap[h];
1854 bits = tree[tree[n].Dad].Len + 1;
1855 if (bits > max_length)
1856 bits = max_length, overflow++;
1857 tree[n].Len = (ush) bits;
1858 /* We overwrite tree[n].Dad which is no longer needed */
Eric Andersencc8ed391999-10-05 16:24:54 +00001859
Erik Andersene49d5ec2000-02-08 19:58:47 +00001860 if (n > max_code)
1861 continue; /* not a leaf node */
Eric Andersencc8ed391999-10-05 16:24:54 +00001862
Erik Andersene49d5ec2000-02-08 19:58:47 +00001863 bl_count[bits]++;
1864 xbits = 0;
1865 if (n >= base)
1866 xbits = extra[n - base];
1867 f = tree[n].Freq;
1868 opt_len += (ulg) f *(bits + xbits);
Eric Andersencc8ed391999-10-05 16:24:54 +00001869
Erik Andersene49d5ec2000-02-08 19:58:47 +00001870 if (stree)
1871 static_len += (ulg) f *(stree[n].Len + xbits);
1872 }
1873 if (overflow == 0)
1874 return;
Eric Andersencc8ed391999-10-05 16:24:54 +00001875
Erik Andersene49d5ec2000-02-08 19:58:47 +00001876 Trace((stderr, "\nbit length overflow\n"));
1877 /* This happens for example on obj2 and pic of the Calgary corpus */
Eric Andersencc8ed391999-10-05 16:24:54 +00001878
Erik Andersene49d5ec2000-02-08 19:58:47 +00001879 /* Find the first bit length which could increase: */
1880 do {
1881 bits = max_length - 1;
1882 while (bl_count[bits] == 0)
1883 bits--;
1884 bl_count[bits]--; /* move one leaf down the tree */
1885 bl_count[bits + 1] += 2; /* move one overflow item as its brother */
1886 bl_count[max_length]--;
1887 /* The brother of the overflow item also moves one step up,
1888 * but this does not affect bl_count[max_length]
1889 */
1890 overflow -= 2;
1891 } while (overflow > 0);
1892
1893 /* Now recompute all bit lengths, scanning in increasing frequency.
1894 * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1895 * lengths instead of fixing only the wrong ones. This idea is taken
1896 * from 'ar' written by Haruhiko Okumura.)
1897 */
1898 for (bits = max_length; bits != 0; bits--) {
1899 n = bl_count[bits];
1900 while (n != 0) {
1901 m = heap[--h];
1902 if (m > max_code)
1903 continue;
1904 if (tree[m].Len != (unsigned) bits) {
1905 Trace(
1906 (stderr, "code %d bits %d->%d\n", m, tree[m].Len,
1907 bits));
1908 opt_len +=
1909 ((long) bits -
1910 (long) tree[m].Len) * (long) tree[m].Freq;
1911 tree[m].Len = (ush) bits;
1912 }
1913 n--;
1914 }
1915 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001916}
1917
1918/* ===========================================================================
1919 * Generate the codes for a given tree and bit counts (which need not be
1920 * optimal).
1921 * IN assertion: the array bl_count contains the bit length statistics for
1922 * the given tree and the field len is set for all tree elements.
1923 * OUT assertion: the field code is set for all tree elements of non
1924 * zero code length.
1925 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001926static void gen_codes(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001927{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001928 ush next_code[MAX_BITS + 1]; /* next code value for each bit length */
1929 ush code = 0; /* running code value */
1930 int bits; /* bit index */
1931 int n; /* code index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001932
Erik Andersene49d5ec2000-02-08 19:58:47 +00001933 /* The distribution counts are first used to generate the code values
1934 * without bit reversal.
1935 */
1936 for (bits = 1; bits <= MAX_BITS; bits++) {
1937 next_code[bits] = code = (code + bl_count[bits - 1]) << 1;
1938 }
1939 /* Check that the bit counts in bl_count are consistent. The last code
1940 * must be all ones.
1941 */
1942 Assert(code + bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1943 "inconsistent bit counts");
1944 Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
Eric Andersencc8ed391999-10-05 16:24:54 +00001945
Erik Andersene49d5ec2000-02-08 19:58:47 +00001946 for (n = 0; n <= max_code; n++) {
1947 int len = tree[n].Len;
Eric Andersencc8ed391999-10-05 16:24:54 +00001948
Erik Andersene49d5ec2000-02-08 19:58:47 +00001949 if (len == 0)
1950 continue;
1951 /* Now reverse the bits */
1952 tree[n].Code = bi_reverse(next_code[len]++, len);
1953
1954 Tracec(tree != static_ltree,
1955 (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1956 (isgraph(n) ? n : ' '), len, tree[n].Code,
1957 next_code[len] - 1));
1958 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001959}
1960
1961/* ===========================================================================
1962 * Construct one Huffman tree and assigns the code bit strings and lengths.
1963 * Update the total bit length for the current block.
1964 * IN assertion: the field freq is set for all tree elements.
1965 * OUT assertions: the fields len and code are set to the optimal bit length
1966 * and corresponding code. The length opt_len is updated; static_len is
1967 * also updated if stree is not null. The field max_code is set.
1968 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001969static void build_tree(tree_desc *desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001970{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001971 ct_data *tree = desc->dyn_tree;
1972 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001973 int elems = desc->elems;
1974 int n, m; /* iterate over heap elements */
1975 int max_code = -1; /* largest code with non zero frequency */
1976 int node = elems; /* next internal node of the tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001977
Erik Andersene49d5ec2000-02-08 19:58:47 +00001978 /* Construct the initial heap, with least frequent element in
1979 * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1980 * heap[0] is not used.
1981 */
1982 heap_len = 0, heap_max = HEAP_SIZE;
Eric Andersencc8ed391999-10-05 16:24:54 +00001983
Erik Andersene49d5ec2000-02-08 19:58:47 +00001984 for (n = 0; n < elems; n++) {
1985 if (tree[n].Freq != 0) {
1986 heap[++heap_len] = max_code = n;
1987 depth[n] = 0;
1988 } else {
1989 tree[n].Len = 0;
1990 }
1991 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001992
Erik Andersene49d5ec2000-02-08 19:58:47 +00001993 /* The pkzip format requires that at least one distance code exists,
1994 * and that at least one bit should be sent even if there is only one
1995 * possible code. So to avoid special checks later on we force at least
1996 * two codes of non zero frequency.
1997 */
1998 while (heap_len < 2) {
1999 int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002000
Erik Andersene49d5ec2000-02-08 19:58:47 +00002001 tree[new].Freq = 1;
2002 depth[new] = 0;
2003 opt_len--;
2004 if (stree)
2005 static_len -= stree[new].Len;
2006 /* new is 0 or 1 so it does not have extra bits */
2007 }
2008 desc->max_code = max_code;
Eric Andersencc8ed391999-10-05 16:24:54 +00002009
Erik Andersene49d5ec2000-02-08 19:58:47 +00002010 /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
2011 * establish sub-heaps of increasing lengths:
2012 */
2013 for (n = heap_len / 2; n >= 1; n--)
2014 pqdownheap(tree, n);
Eric Andersencc8ed391999-10-05 16:24:54 +00002015
Erik Andersene49d5ec2000-02-08 19:58:47 +00002016 /* Construct the Huffman tree by repeatedly combining the least two
2017 * frequent nodes.
2018 */
2019 do {
2020 pqremove(tree, n); /* n = node of least frequency */
2021 m = heap[SMALLEST]; /* m = node of next least frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00002022
Erik Andersene49d5ec2000-02-08 19:58:47 +00002023 heap[--heap_max] = n; /* keep the nodes sorted by frequency */
2024 heap[--heap_max] = m;
2025
2026 /* Create a new node father of n and m */
2027 tree[node].Freq = tree[n].Freq + tree[m].Freq;
2028 depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
2029 tree[n].Dad = tree[m].Dad = (ush) node;
Eric Andersencc8ed391999-10-05 16:24:54 +00002030#ifdef DUMP_BL_TREE
Erik Andersene49d5ec2000-02-08 19:58:47 +00002031 if (tree == bl_tree) {
2032 fprintf(stderr, "\nnode %d(%d), sons %d(%d) %d(%d)",
2033 node, tree[node].Freq, n, tree[n].Freq, m,
2034 tree[m].Freq);
2035 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002036#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +00002037 /* and insert the new node in the heap */
2038 heap[SMALLEST] = node++;
2039 pqdownheap(tree, SMALLEST);
Eric Andersencc8ed391999-10-05 16:24:54 +00002040
Erik Andersene49d5ec2000-02-08 19:58:47 +00002041 } while (heap_len >= 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002042
Erik Andersene49d5ec2000-02-08 19:58:47 +00002043 heap[--heap_max] = heap[SMALLEST];
Eric Andersencc8ed391999-10-05 16:24:54 +00002044
Erik Andersene49d5ec2000-02-08 19:58:47 +00002045 /* At this point, the fields freq and dad are set. We can now
2046 * generate the bit lengths.
2047 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002048 gen_bitlen((tree_desc *) desc);
Eric Andersencc8ed391999-10-05 16:24:54 +00002049
Erik Andersene49d5ec2000-02-08 19:58:47 +00002050 /* The field len is now set, we can generate the bit codes */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002051 gen_codes((ct_data *) tree, max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002052}
2053
2054/* ===========================================================================
2055 * Scan a literal or distance tree to determine the frequencies of the codes
2056 * in the bit length tree. Updates opt_len to take into account the repeat
2057 * counts. (The contribution of the bit length codes will be added later
2058 * during the construction of bl_tree.)
2059 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002060static void scan_tree(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002061{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002062 int n; /* iterates over all tree elements */
2063 int prevlen = -1; /* last emitted length */
2064 int curlen; /* length of current code */
2065 int nextlen = tree[0].Len; /* length of next code */
2066 int count = 0; /* repeat count of the current code */
2067 int max_count = 7; /* max repeat count */
2068 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002069
Erik Andersene49d5ec2000-02-08 19:58:47 +00002070 if (nextlen == 0)
2071 max_count = 138, min_count = 3;
2072 tree[max_code + 1].Len = (ush) 0xffff; /* guard */
Eric Andersencc8ed391999-10-05 16:24:54 +00002073
Erik Andersene49d5ec2000-02-08 19:58:47 +00002074 for (n = 0; n <= max_code; n++) {
2075 curlen = nextlen;
2076 nextlen = tree[n + 1].Len;
2077 if (++count < max_count && curlen == nextlen) {
2078 continue;
2079 } else if (count < min_count) {
2080 bl_tree[curlen].Freq += count;
2081 } else if (curlen != 0) {
2082 if (curlen != prevlen)
2083 bl_tree[curlen].Freq++;
2084 bl_tree[REP_3_6].Freq++;
2085 } else if (count <= 10) {
2086 bl_tree[REPZ_3_10].Freq++;
2087 } else {
2088 bl_tree[REPZ_11_138].Freq++;
2089 }
2090 count = 0;
2091 prevlen = curlen;
2092 if (nextlen == 0) {
2093 max_count = 138, min_count = 3;
2094 } else if (curlen == nextlen) {
2095 max_count = 6, min_count = 3;
2096 } else {
2097 max_count = 7, min_count = 4;
2098 }
2099 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002100}
2101
2102/* ===========================================================================
2103 * Send a literal or distance tree in compressed form, using the codes in
2104 * bl_tree.
2105 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002106static void send_tree(ct_data *tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002107{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002108 int n; /* iterates over all tree elements */
2109 int prevlen = -1; /* last emitted length */
2110 int curlen; /* length of current code */
2111 int nextlen = tree[0].Len; /* length of next code */
2112 int count = 0; /* repeat count of the current code */
2113 int max_count = 7; /* max repeat count */
2114 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002115
Erik Andersene49d5ec2000-02-08 19:58:47 +00002116/* tree[max_code+1].Len = -1; *//* guard already set */
2117 if (nextlen == 0)
2118 max_count = 138, min_count = 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002119
Erik Andersene49d5ec2000-02-08 19:58:47 +00002120 for (n = 0; n <= max_code; n++) {
2121 curlen = nextlen;
2122 nextlen = tree[n + 1].Len;
2123 if (++count < max_count && curlen == nextlen) {
2124 continue;
2125 } else if (count < min_count) {
2126 do {
2127 send_code(curlen, bl_tree);
2128 } while (--count != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002129
Erik Andersene49d5ec2000-02-08 19:58:47 +00002130 } else if (curlen != 0) {
2131 if (curlen != prevlen) {
2132 send_code(curlen, bl_tree);
2133 count--;
2134 }
2135 Assert(count >= 3 && count <= 6, " 3_6?");
2136 send_code(REP_3_6, bl_tree);
2137 send_bits(count - 3, 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002138
Erik Andersene49d5ec2000-02-08 19:58:47 +00002139 } else if (count <= 10) {
2140 send_code(REPZ_3_10, bl_tree);
2141 send_bits(count - 3, 3);
Eric Andersencc8ed391999-10-05 16:24:54 +00002142
Erik Andersene49d5ec2000-02-08 19:58:47 +00002143 } else {
2144 send_code(REPZ_11_138, bl_tree);
2145 send_bits(count - 11, 7);
2146 }
2147 count = 0;
2148 prevlen = curlen;
2149 if (nextlen == 0) {
2150 max_count = 138, min_count = 3;
2151 } else if (curlen == nextlen) {
2152 max_count = 6, min_count = 3;
2153 } else {
2154 max_count = 7, min_count = 4;
2155 }
2156 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002157}
2158
2159/* ===========================================================================
2160 * Construct the Huffman tree for the bit lengths and return the index in
2161 * bl_order of the last bit length code to send.
2162 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002163static const int build_bl_tree()
Eric Andersencc8ed391999-10-05 16:24:54 +00002164{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002165 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002166
Erik Andersene49d5ec2000-02-08 19:58:47 +00002167 /* Determine the bit length frequencies for literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002168 scan_tree((ct_data *) dyn_ltree, l_desc.max_code);
2169 scan_tree((ct_data *) dyn_dtree, d_desc.max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002170
Erik Andersene49d5ec2000-02-08 19:58:47 +00002171 /* Build the bit length tree: */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002172 build_tree((tree_desc *) (&bl_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002173 /* opt_len now includes the length of the tree representations, except
2174 * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
2175 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002176
Erik Andersene49d5ec2000-02-08 19:58:47 +00002177 /* Determine the number of bit length codes to send. The pkzip format
2178 * requires that at least 4 bit length codes be sent. (appnote.txt says
2179 * 3 but the actual value used is 4.)
2180 */
2181 for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
2182 if (bl_tree[bl_order[max_blindex]].Len != 0)
2183 break;
2184 }
2185 /* Update opt_len to include the bit length tree and counts */
2186 opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
2187 Tracev(
2188 (stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len,
2189 static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002190
Erik Andersene49d5ec2000-02-08 19:58:47 +00002191 return max_blindex;
Eric Andersencc8ed391999-10-05 16:24:54 +00002192}
2193
2194/* ===========================================================================
2195 * Send the header for a block using dynamic Huffman trees: the counts, the
2196 * lengths of the bit length codes, the literal tree and the distance tree.
2197 * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
2198 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002199static void send_all_trees(int lcodes, int dcodes, int blcodes)
Eric Andersencc8ed391999-10-05 16:24:54 +00002200{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002201 int rank; /* index in bl_order */
Eric Andersencc8ed391999-10-05 16:24:54 +00002202
Erik Andersene49d5ec2000-02-08 19:58:47 +00002203 Assert(lcodes >= 257 && dcodes >= 1
2204 && blcodes >= 4, "not enough codes");
2205 Assert(lcodes <= L_CODES && dcodes <= D_CODES
2206 && blcodes <= BL_CODES, "too many codes");
2207 Tracev((stderr, "\nbl counts: "));
2208 send_bits(lcodes - 257, 5); /* not +255 as stated in appnote.txt */
2209 send_bits(dcodes - 1, 5);
2210 send_bits(blcodes - 4, 4); /* not -3 as stated in appnote.txt */
2211 for (rank = 0; rank < blcodes; rank++) {
2212 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
2213 send_bits(bl_tree[bl_order[rank]].Len, 3);
2214 }
2215 Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002216
Eric Andersen3073dfb2001-07-02 17:57:32 +00002217 send_tree((ct_data *) dyn_ltree, lcodes - 1); /* send the literal tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002218 Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002219
Eric Andersen3073dfb2001-07-02 17:57:32 +00002220 send_tree((ct_data *) dyn_dtree, dcodes - 1); /* send the distance tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002221 Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002222}
2223
2224/* ===========================================================================
2225 * Determine the best encoding for the current block: dynamic trees, static
2226 * trees or store, and output the encoded block to the zip file. This function
2227 * returns the total compressed length for the file so far.
2228 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002229static ulg flush_block(char *buf, ulg stored_len, int eof)
Eric Andersencc8ed391999-10-05 16:24:54 +00002230{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002231 ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
2232 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002233
Erik Andersene49d5ec2000-02-08 19:58:47 +00002234 flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
Eric Andersencc8ed391999-10-05 16:24:54 +00002235
Erik Andersene49d5ec2000-02-08 19:58:47 +00002236 /* Check if the file is ascii or binary */
2237 if (*file_type == (ush) UNKNOWN)
2238 set_file_type();
Eric Andersencc8ed391999-10-05 16:24:54 +00002239
Erik Andersene49d5ec2000-02-08 19:58:47 +00002240 /* Construct the literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002241 build_tree((tree_desc *) (&l_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002242 Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002243
Eric Andersen3073dfb2001-07-02 17:57:32 +00002244 build_tree((tree_desc *) (&d_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002245 Tracev(
2246 (stderr, "\ndist data: dyn %ld, stat %ld", opt_len,
2247 static_len));
2248 /* At this point, opt_len and static_len are the total bit lengths of
2249 * the compressed block data, excluding the tree representations.
2250 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002251
Erik Andersene49d5ec2000-02-08 19:58:47 +00002252 /* Build the bit length tree for the above two trees, and get the index
2253 * in bl_order of the last bit length code to send.
2254 */
2255 max_blindex = build_bl_tree();
Eric Andersencc8ed391999-10-05 16:24:54 +00002256
Erik Andersene49d5ec2000-02-08 19:58:47 +00002257 /* Determine the best encoding. Compute first the block length in bytes */
2258 opt_lenb = (opt_len + 3 + 7) >> 3;
2259 static_lenb = (static_len + 3 + 7) >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002260
Erik Andersene49d5ec2000-02-08 19:58:47 +00002261 Trace(
2262 (stderr,
2263 "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
2264 opt_lenb, opt_len, static_lenb, static_len, stored_len,
2265 last_lit, last_dist));
Eric Andersencc8ed391999-10-05 16:24:54 +00002266
Erik Andersene49d5ec2000-02-08 19:58:47 +00002267 if (static_lenb <= opt_lenb)
2268 opt_lenb = static_lenb;
Eric Andersencc8ed391999-10-05 16:24:54 +00002269
Erik Andersene49d5ec2000-02-08 19:58:47 +00002270 /* If compression failed and this is the first and last block,
2271 * and if the zip file can be seeked (to rewrite the local header),
2272 * the whole file is transformed into a stored file:
2273 */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002274 if (stored_len <= opt_lenb && eof && compressed_len == 0L
2275 && seekable()) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002276 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
2277 if (buf == (char *) 0)
Matt Kraaidd19c692001-01-31 19:00:21 +00002278 error_msg("block vanished");
Eric Andersencc8ed391999-10-05 16:24:54 +00002279
Erik Andersene49d5ec2000-02-08 19:58:47 +00002280 copy_block(buf, (unsigned) stored_len, 0); /* without header */
2281 compressed_len = stored_len << 3;
2282 *file_method = STORED;
Eric Andersencc8ed391999-10-05 16:24:54 +00002283
Erik Andersene49d5ec2000-02-08 19:58:47 +00002284 } else if (stored_len + 4 <= opt_lenb && buf != (char *) 0) {
2285 /* 4: two words for the lengths */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002286 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
2287 * Otherwise we can't have processed more than WSIZE input bytes since
2288 * the last block flush, because compression would have been
2289 * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
2290 * transform a block into a stored block.
2291 */
2292 send_bits((STORED_BLOCK << 1) + eof, 3); /* send block type */
2293 compressed_len = (compressed_len + 3 + 7) & ~7L;
2294 compressed_len += (stored_len + 4) << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002295
Erik Andersene49d5ec2000-02-08 19:58:47 +00002296 copy_block(buf, (unsigned) stored_len, 1); /* with header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002297
Erik Andersene49d5ec2000-02-08 19:58:47 +00002298 } else if (static_lenb == opt_lenb) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002299 send_bits((STATIC_TREES << 1) + eof, 3);
Eric Andersen3073dfb2001-07-02 17:57:32 +00002300 compress_block((ct_data *) static_ltree,
2301 (ct_data *) static_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002302 compressed_len += 3 + static_len;
2303 } else {
2304 send_bits((DYN_TREES << 1) + eof, 3);
2305 send_all_trees(l_desc.max_code + 1, d_desc.max_code + 1,
2306 max_blindex + 1);
Eric Andersen3073dfb2001-07-02 17:57:32 +00002307 compress_block((ct_data *) dyn_ltree,
2308 (ct_data *) dyn_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002309 compressed_len += 3 + opt_len;
2310 }
2311 Assert(compressed_len == bits_sent, "bad compressed size");
2312 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00002313
Erik Andersene49d5ec2000-02-08 19:58:47 +00002314 if (eof) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002315 bi_windup();
2316 compressed_len += 7; /* align on byte boundary */
2317 }
2318 Tracev((stderr, "\ncomprlen %lu(%lu) ", compressed_len >> 3,
2319 compressed_len - 7 * eof));
Eric Andersencc8ed391999-10-05 16:24:54 +00002320
Erik Andersene49d5ec2000-02-08 19:58:47 +00002321 return compressed_len >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002322}
2323
2324/* ===========================================================================
2325 * Save the match info and tally the frequency counts. Return true if
2326 * the current block must be flushed.
2327 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002328static int ct_tally(int dist, int lc)
Eric Andersencc8ed391999-10-05 16:24:54 +00002329{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002330 l_buf[last_lit++] = (uch) lc;
2331 if (dist == 0) {
2332 /* lc is the unmatched char */
2333 dyn_ltree[lc].Freq++;
2334 } else {
2335 /* Here, lc is the match length - MIN_MATCH */
2336 dist--; /* dist = match distance - 1 */
2337 Assert((ush) dist < (ush) MAX_DIST &&
2338 (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH) &&
2339 (ush) d_code(dist) < (ush) D_CODES, "ct_tally: bad match");
Eric Andersencc8ed391999-10-05 16:24:54 +00002340
Erik Andersene49d5ec2000-02-08 19:58:47 +00002341 dyn_ltree[length_code[lc] + LITERALS + 1].Freq++;
2342 dyn_dtree[d_code(dist)].Freq++;
Eric Andersencc8ed391999-10-05 16:24:54 +00002343
Erik Andersene49d5ec2000-02-08 19:58:47 +00002344 d_buf[last_dist++] = (ush) dist;
2345 flags |= flag_bit;
2346 }
2347 flag_bit <<= 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00002348
Erik Andersene49d5ec2000-02-08 19:58:47 +00002349 /* Output the flags if they fill a byte: */
2350 if ((last_lit & 7) == 0) {
2351 flag_buf[last_flags++] = flags;
2352 flags = 0, flag_bit = 1;
2353 }
2354 /* Try to guess if it is profitable to stop the current block here */
2355 if ((last_lit & 0xfff) == 0) {
2356 /* Compute an upper bound for the compressed length */
2357 ulg out_length = (ulg) last_lit * 8L;
2358 ulg in_length = (ulg) strstart - block_start;
2359 int dcode;
2360
2361 for (dcode = 0; dcode < D_CODES; dcode++) {
2362 out_length +=
2363 (ulg) dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
2364 }
2365 out_length >>= 3;
2366 Trace(
2367 (stderr,
2368 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
2369 last_lit, last_dist, in_length, out_length,
2370 100L - out_length * 100L / in_length));
2371 if (last_dist < last_lit / 2 && out_length < in_length / 2)
2372 return 1;
2373 }
2374 return (last_lit == LIT_BUFSIZE - 1 || last_dist == DIST_BUFSIZE);
2375 /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
2376 * on 16 bit machines and because stored blocks are restricted to
2377 * 64K-1 bytes.
2378 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002379}
2380
2381/* ===========================================================================
2382 * Send the block data compressed using the given Huffman trees
2383 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002384static void compress_block(ct_data *ltree, ct_data *dtree)
Eric Andersencc8ed391999-10-05 16:24:54 +00002385{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002386 unsigned dist; /* distance of matched string */
2387 int lc; /* match length or unmatched char (if dist == 0) */
2388 unsigned lx = 0; /* running index in l_buf */
2389 unsigned dx = 0; /* running index in d_buf */
2390 unsigned fx = 0; /* running index in flag_buf */
2391 uch flag = 0; /* current flags */
2392 unsigned code; /* the code to send */
2393 int extra; /* number of extra bits to send */
Eric Andersencc8ed391999-10-05 16:24:54 +00002394
Erik Andersene49d5ec2000-02-08 19:58:47 +00002395 if (last_lit != 0)
2396 do {
2397 if ((lx & 7) == 0)
2398 flag = flag_buf[fx++];
2399 lc = l_buf[lx++];
2400 if ((flag & 1) == 0) {
2401 send_code(lc, ltree); /* send a literal byte */
2402 Tracecv(isgraph(lc), (stderr, " '%c' ", lc));
2403 } else {
2404 /* Here, lc is the match length - MIN_MATCH */
2405 code = length_code[lc];
2406 send_code(code + LITERALS + 1, ltree); /* send the length code */
2407 extra = extra_lbits[code];
2408 if (extra != 0) {
2409 lc -= base_length[code];
2410 send_bits(lc, extra); /* send the extra length bits */
2411 }
2412 dist = d_buf[dx++];
2413 /* Here, dist is the match distance - 1 */
2414 code = d_code(dist);
2415 Assert(code < D_CODES, "bad d_code");
Eric Andersencc8ed391999-10-05 16:24:54 +00002416
Erik Andersene49d5ec2000-02-08 19:58:47 +00002417 send_code(code, dtree); /* send the distance code */
2418 extra = extra_dbits[code];
2419 if (extra != 0) {
2420 dist -= base_dist[code];
2421 send_bits(dist, extra); /* send the extra distance bits */
2422 }
2423 } /* literal or match pair ? */
2424 flag >>= 1;
2425 } while (lx < last_lit);
Eric Andersencc8ed391999-10-05 16:24:54 +00002426
Erik Andersene49d5ec2000-02-08 19:58:47 +00002427 send_code(END_BLOCK, ltree);
Eric Andersencc8ed391999-10-05 16:24:54 +00002428}
2429
2430/* ===========================================================================
2431 * Set the file type to ASCII or BINARY, using a crude approximation:
2432 * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise.
2433 * IN assertion: the fields freq of dyn_ltree are set and the total of all
2434 * frequencies does not exceed 64K (to fit in an int on 16 bit machines).
2435 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002436static void set_file_type()
Eric Andersencc8ed391999-10-05 16:24:54 +00002437{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002438 int n = 0;
2439 unsigned ascii_freq = 0;
2440 unsigned bin_freq = 0;
2441
2442 while (n < 7)
2443 bin_freq += dyn_ltree[n++].Freq;
2444 while (n < 128)
2445 ascii_freq += dyn_ltree[n++].Freq;
2446 while (n < LITERALS)
2447 bin_freq += dyn_ltree[n++].Freq;
2448 *file_type = bin_freq > (ascii_freq >> 2) ? BINARY : ASCII;
2449 if (*file_type == BINARY && translate_eol) {
Matt Kraaidd19c692001-01-31 19:00:21 +00002450 error_msg("-l used on binary file");
Erik Andersene49d5ec2000-02-08 19:58:47 +00002451 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002452}
Erik Andersene49d5ec2000-02-08 19:58:47 +00002453
Eric Andersencc8ed391999-10-05 16:24:54 +00002454/* zip.c -- compress files to the gzip or pkzip format
2455 * Copyright (C) 1992-1993 Jean-loup Gailly
2456 * This is free software; you can redistribute it and/or modify it under the
2457 * terms of the GNU General Public License, see the file COPYING.
2458 */
2459
Eric Andersencc8ed391999-10-05 16:24:54 +00002460
Eric Andersen3073dfb2001-07-02 17:57:32 +00002461static ulg crc; /* crc on uncompressed file data */
2462static long header_bytes; /* number of bytes in gzip header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002463
Eric Andersen39eb0402001-08-22 04:15:47 +00002464static void put_long(ulg n)
2465{
Aaron Lehmannb9df4702001-12-06 03:22:43 +00002466 put_short((n) & 0xffff);
2467 put_short(((ulg)(n)) >> 16);
Eric Andersen39eb0402001-08-22 04:15:47 +00002468}
2469
2470/* put_header_byte is used for the compressed output
2471 * - for the initial 4 bytes that can't overflow the buffer.
2472 */
2473#define put_header_byte(c) {outbuf[outcnt++]=(uch)(c);}
2474
Eric Andersencc8ed391999-10-05 16:24:54 +00002475/* ===========================================================================
2476 * Deflate in to out.
2477 * IN assertions: the input and output buffers are cleared.
2478 * The variables time_stamp and save_orig_name are initialized.
2479 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002480static int zip(int in, int out)
Eric Andersencc8ed391999-10-05 16:24:54 +00002481{
Eric Andersen851895a2001-03-21 21:52:25 +00002482 uch my_flags = 0; /* general purpose bit flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002483 ush attr = 0; /* ascii/binary flag */
2484 ush deflate_flags = 0; /* pkzip -es, -en or -ex equivalent */
Eric Andersencc8ed391999-10-05 16:24:54 +00002485
Erik Andersene49d5ec2000-02-08 19:58:47 +00002486 ifd = in;
2487 ofd = out;
2488 outcnt = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00002489
Erik Andersene49d5ec2000-02-08 19:58:47 +00002490 /* Write the header to the gzip file. See algorithm.doc for the format */
Eric Andersencc8ed391999-10-05 16:24:54 +00002491
Eric Andersen96bcfd31999-11-12 01:30:18 +00002492
Erik Andersene49d5ec2000-02-08 19:58:47 +00002493 method = DEFLATED;
Eric Andersen39eb0402001-08-22 04:15:47 +00002494 put_header_byte(GZIP_MAGIC[0]); /* magic header */
2495 put_header_byte(GZIP_MAGIC[1]);
2496 put_header_byte(DEFLATED); /* compression method */
Eric Andersencc8ed391999-10-05 16:24:54 +00002497
Eric Andersen39eb0402001-08-22 04:15:47 +00002498 put_header_byte(my_flags); /* general flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002499 put_long(time_stamp);
Eric Andersencc8ed391999-10-05 16:24:54 +00002500
Erik Andersene49d5ec2000-02-08 19:58:47 +00002501 /* Write deflated file to zip file */
2502 crc = updcrc(0, 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002503
Erik Andersene49d5ec2000-02-08 19:58:47 +00002504 bi_init(out);
2505 ct_init(&attr, &method);
2506 lm_init(&deflate_flags);
Eric Andersencc8ed391999-10-05 16:24:54 +00002507
Erik Andersene49d5ec2000-02-08 19:58:47 +00002508 put_byte((uch) deflate_flags); /* extra flags */
2509 put_byte(OS_CODE); /* OS identifier */
Eric Andersencc8ed391999-10-05 16:24:54 +00002510
Erik Andersene49d5ec2000-02-08 19:58:47 +00002511 header_bytes = (long) outcnt;
Eric Andersencc8ed391999-10-05 16:24:54 +00002512
Erik Andersene49d5ec2000-02-08 19:58:47 +00002513 (void) deflate();
Eric Andersencc8ed391999-10-05 16:24:54 +00002514
Erik Andersene49d5ec2000-02-08 19:58:47 +00002515 /* Write the crc and uncompressed size */
2516 put_long(crc);
2517 put_long(isize);
2518 header_bytes += 2 * sizeof(long);
Eric Andersencc8ed391999-10-05 16:24:54 +00002519
Erik Andersene49d5ec2000-02-08 19:58:47 +00002520 flush_outbuf();
2521 return OK;
Eric Andersencc8ed391999-10-05 16:24:54 +00002522}
2523
2524
2525/* ===========================================================================
2526 * Read a new buffer from the current input file, perform end-of-line
2527 * translation, and update the crc and input file size.
2528 * IN assertion: size >= 2 (for end-of-line translation)
2529 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002530static int file_read(char *buf, unsigned size)
Eric Andersencc8ed391999-10-05 16:24:54 +00002531{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002532 unsigned len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002533
Erik Andersene49d5ec2000-02-08 19:58:47 +00002534 Assert(insize == 0, "inbuf not empty");
Eric Andersencc8ed391999-10-05 16:24:54 +00002535
Erik Andersene49d5ec2000-02-08 19:58:47 +00002536 len = read(ifd, buf, size);
2537 if (len == (unsigned) (-1) || len == 0)
2538 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002539
Erik Andersene49d5ec2000-02-08 19:58:47 +00002540 crc = updcrc((uch *) buf, len);
2541 isize += (ulg) len;
2542 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002543}
Matt Kraai7918e1f2000-11-08 06:52:57 +00002544
2545/* ===========================================================================
2546 * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
2547 * (used for the compressed data only)
2548 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002549static void flush_outbuf()
Matt Kraai7918e1f2000-11-08 06:52:57 +00002550{
2551 if (outcnt == 0)
2552 return;
2553
2554 write_buf(ofd, (char *) outbuf, outcnt);
Matt Kraai7918e1f2000-11-08 06:52:57 +00002555 outcnt = 0;
2556}