blob: 486f78f887db1e6ae2cb8eaf1f7614ec6d237b93 [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 *
Eric Andersenc7bda1c2004-03-15 08:29:22 +000012 * Adjusted further by Erik Andersen <andersen@codepoet.org> to support
13 * files as well as stdin/stdout, and to generally behave itself wrt
Erik Andersen61677fe2000-04-13 01:18:56 +000014 * command line handling.
15 *
Bernhard Reutner-Fischer20f40002006-01-30 17:17:14 +000016 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
Eric Andersencc8ed391999-10-05 16:24:54 +000017 */
Eric Andersencc8ed391999-10-05 16:24:54 +000018
Erik Andersen61677fe2000-04-13 01:18:56 +000019#define SMALL_MEM
Erik Andersen61677fe2000-04-13 01:18:56 +000020
Eric Andersencbe31da2001-02-20 06:14:08 +000021#include <stdlib.h>
Eric Andersencc8ed391999-10-05 16:24:54 +000022#include <stdio.h>
Erik Andersen61677fe2000-04-13 01:18:56 +000023#include <string.h>
Eric Andersened3ef502001-01-27 08:24:39 +000024#include <unistd.h>
Glenn L McGrathf58efb52001-03-28 05:35:16 +000025#include <errno.h>
Eric Andersen3073dfb2001-07-02 17:57:32 +000026#include <sys/types.h>
27#include <signal.h>
28#include <utime.h>
29#include <ctype.h>
30#include <sys/types.h>
31#include <unistd.h>
32#include <dirent.h>
33#include <fcntl.h>
34#include <time.h>
Eric Andersencbe31da2001-02-20 06:14:08 +000035#include "busybox.h"
Eric Andersencbe31da2001-02-20 06:14:08 +000036
Erik Andersene49d5ec2000-02-08 19:58:47 +000037typedef unsigned char uch;
Eric Andersencc8ed391999-10-05 16:24:54 +000038typedef unsigned short ush;
Erik Andersene49d5ec2000-02-08 19:58:47 +000039typedef unsigned long ulg;
Eric Andersencc8ed391999-10-05 16:24:54 +000040
41/* Return codes from gzip */
42#define OK 0
43#define ERROR 1
44#define WARNING 2
45
46/* Compression methods (see algorithm.doc) */
Eric Andersen3073dfb2001-07-02 17:57:32 +000047/* Only STORED and DEFLATED are supported by this BusyBox module */
Eric Andersencc8ed391999-10-05 16:24:54 +000048#define STORED 0
Eric Andersencc8ed391999-10-05 16:24:54 +000049/* methods 4 to 7 reserved */
50#define DEFLATED 8
Eric Andersencc8ed391999-10-05 16:24:54 +000051
52/* To save memory for 16 bit systems, some arrays are overlaid between
53 * the various modules:
54 * deflate: prev+head window d_buf l_buf outbuf
55 * unlzw: tab_prefix tab_suffix stack inbuf outbuf
Eric Andersencc8ed391999-10-05 16:24:54 +000056 * For compression, input is done in window[]. For decompression, output
57 * is done in window except for unlzw.
58 */
59
60#ifndef INBUFSIZ
61# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +000062# define INBUFSIZ 0x2000 /* input buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000063# else
Erik Andersene49d5ec2000-02-08 19:58:47 +000064# define INBUFSIZ 0x8000 /* input buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000065# endif
66#endif
Glenn L McGrathd827e8b2002-08-22 13:21:26 +000067#define INBUF_EXTRA 64 /* required by unlzw() */
Eric Andersencc8ed391999-10-05 16:24:54 +000068
69#ifndef OUTBUFSIZ
70# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +000071# define OUTBUFSIZ 8192 /* output buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000072# else
Erik Andersene49d5ec2000-02-08 19:58:47 +000073# define OUTBUFSIZ 16384 /* output buffer size */
Eric Andersencc8ed391999-10-05 16:24:54 +000074# endif
75#endif
Glenn L McGrathd827e8b2002-08-22 13:21:26 +000076#define OUTBUF_EXTRA 2048 /* required by unlzw() */
Eric Andersencc8ed391999-10-05 16:24:54 +000077
78#ifndef DIST_BUFSIZE
79# ifdef SMALL_MEM
Erik Andersene49d5ec2000-02-08 19:58:47 +000080# define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
Eric Andersencc8ed391999-10-05 16:24:54 +000081# else
Erik Andersene49d5ec2000-02-08 19:58:47 +000082# define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
Eric Andersencc8ed391999-10-05 16:24:54 +000083# endif
84#endif
85
Eric Andersen3073dfb2001-07-02 17:57:32 +000086# define DECLARE(type, array, size) static type * array
Eric Andersencc8ed391999-10-05 16:24:54 +000087# define ALLOC(type, array, size) { \
Rob Landley1ec5b292006-05-29 07:42:02 +000088 array = (type*)xzalloc((size_t)(((size)+1L)/2) * 2*sizeof(type)); \
Eric Andersencc8ed391999-10-05 16:24:54 +000089 }
Aaron Lehmanna170e1c2002-11-28 11:27:31 +000090# define FREE(array) {free(array), array=NULL;}
Eric Andersencc8ed391999-10-05 16:24:54 +000091
Eric Andersencc8ed391999-10-05 16:24:54 +000092#define tab_suffix window
Glenn L McGrathd827e8b2002-08-22 13:21:26 +000093#define tab_prefix prev /* hash link (see deflate.c) */
94#define head (prev+WSIZE) /* hash head (see deflate.c) */
Eric Andersencc8ed391999-10-05 16:24:54 +000095
Glenn L McGrathd827e8b2002-08-22 13:21:26 +000096static long bytes_in; /* number of input bytes */
Eric Andersencc8ed391999-10-05 16:24:54 +000097
98#define isize bytes_in
99/* for compatibility with old zip sources (to be cleaned) */
100
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000101typedef int file_t; /* Do not use stdio */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000102
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000103#define NO_FILE (-1) /* in memory compression */
Eric Andersencc8ed391999-10-05 16:24:54 +0000104
105
Erik Andersene49d5ec2000-02-08 19:58:47 +0000106#define PACK_MAGIC "\037\036" /* Magic header for packed files */
107#define GZIP_MAGIC "\037\213" /* Magic header for gzip files, 1F 8B */
108#define OLD_GZIP_MAGIC "\037\236" /* Magic header for gzip 0.5 = freeze 1.x */
109#define LZH_MAGIC "\037\240" /* Magic header for SCO LZH Compress files */
110#define PKZIP_MAGIC "\120\113\003\004" /* Magic header for pkzip files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000111
112/* gzip flag byte */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000113#define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
114#define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
115#define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
116#define ORIG_NAME 0x08 /* bit 3 set: original file name present */
117#define COMMENT 0x10 /* bit 4 set: file comment present */
118#define RESERVED 0xC0 /* bit 6,7: reserved */
Eric Andersencc8ed391999-10-05 16:24:54 +0000119
120/* internal file attribute */
121#define UNKNOWN 0xffff
122#define BINARY 0
123#define ASCII 1
124
125#ifndef WSIZE
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000126# define WSIZE 0x8000 /* window size--must be a power of two, and */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000127#endif /* at least 32K for zip's deflate method */
Eric Andersencc8ed391999-10-05 16:24:54 +0000128
129#define MIN_MATCH 3
130#define MAX_MATCH 258
131/* The minimum and maximum match lengths */
132
133#define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
134/* Minimum amount of lookahead, except at the end of the input file.
135 * See deflate.c for comments about the MIN_MATCH+1.
136 */
137
138#define MAX_DIST (WSIZE-MIN_LOOKAHEAD)
139/* In order to simplify the code, particularly on 16 bit machines, match
140 * distances are limited to MAX_DIST instead of WSIZE.
141 */
142
Eric Andersen3073dfb2001-07-02 17:57:32 +0000143/* put_byte is used for the compressed output */
Eric Andersencc8ed391999-10-05 16:24:54 +0000144#define put_byte(c) {outbuf[outcnt++]=(uch)(c); if (outcnt==OUTBUFSIZ)\
145 flush_outbuf();}
Eric Andersencc8ed391999-10-05 16:24:54 +0000146
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000147#define seekable() 0 /* force sequential output */
148#define translate_eol 0 /* no option -a yet */
Eric Andersencc8ed391999-10-05 16:24:54 +0000149
Eric Andersencc8ed391999-10-05 16:24:54 +0000150/* Diagnostic functions */
151#ifdef DEBUG
Manuel Novoa III cad53642003-03-19 09:13:01 +0000152# define Assert(cond,msg) {if(!(cond)) bb_error_msg(msg);}
Eric Andersencc8ed391999-10-05 16:24:54 +0000153# define Trace(x) fprintf x
154# define Tracev(x) {if (verbose) fprintf x ;}
155# define Tracevv(x) {if (verbose>1) fprintf x ;}
156# define Tracec(c,x) {if (verbose && (c)) fprintf x ;}
157# define Tracecv(c,x) {if (verbose>1 && (c)) fprintf x ;}
158#else
159# define Assert(cond,msg)
160# define Trace(x)
161# define Tracev(x)
162# define Tracevv(x)
163# define Tracec(c,x)
164# define Tracecv(c,x)
165#endif
166
167#define WARN(msg) {if (!quiet) fprintf msg ; \
168 if (exit_code == OK) exit_code = WARNING;}
169
Eric Andersen3073dfb2001-07-02 17:57:32 +0000170#ifndef MAX_PATH_LEN
171# define MAX_PATH_LEN 1024 /* max pathname length */
172#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000173
Eric Andersencc8ed391999-10-05 16:24:54 +0000174
Eric Andersen3073dfb2001-07-02 17:57:32 +0000175 /* from zip.c: */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000176static int zip(int in, int out);
177static int file_read(char *buf, unsigned size);
Eric Andersencc8ed391999-10-05 16:24:54 +0000178
Eric Andersen3073dfb2001-07-02 17:57:32 +0000179 /* from deflate.c */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000180static void lm_init(ush * flags);
181static ulg deflate(void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000182
Eric Andersen3073dfb2001-07-02 17:57:32 +0000183 /* from trees.c */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000184static void ct_init(ush * attr, int *methodp);
185static int ct_tally(int dist, int lc);
186static ulg flush_block(char *buf, ulg stored_len, int eof);
Eric Andersencc8ed391999-10-05 16:24:54 +0000187
Eric Andersen3073dfb2001-07-02 17:57:32 +0000188 /* from bits.c */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000189static void bi_init(file_t zipfile);
190static void send_bits(int value, int length);
191static unsigned bi_reverse(unsigned value, int length);
192static void bi_windup(void);
193static void copy_block(char *buf, unsigned len, int header);
Eric Andersen3073dfb2001-07-02 17:57:32 +0000194static int (*read_buf) (char *buf, unsigned size);
Eric Andersencc8ed391999-10-05 16:24:54 +0000195
Eric Andersen3073dfb2001-07-02 17:57:32 +0000196 /* from util.c: */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000197static void flush_outbuf(void);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000198
Eric Andersencc8ed391999-10-05 16:24:54 +0000199/* lzw.h -- define the lzw functions.
200 * Copyright (C) 1992-1993 Jean-loup Gailly.
201 * This is free software; you can redistribute it and/or modify it under the
202 * terms of the GNU General Public License, see the file COPYING.
203 */
204
Eric Andersencc8ed391999-10-05 16:24:54 +0000205#ifndef BITS
206# define BITS 16
207#endif
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000208#define INIT_BITS 9 /* Initial number of bits per code */
Eric Andersencc8ed391999-10-05 16:24:54 +0000209
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000210#define BIT_MASK 0x1f /* Mask for 'number of compression bits' */
Eric Andersencc8ed391999-10-05 16:24:54 +0000211/* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
212 * It's a pity that old uncompress does not check bit 0x20. That makes
213 * extension of the format actually undesirable because old compress
214 * would just crash on the new format instead of giving a meaningful
215 * error message. It does check the number of bits, but it's more
216 * helpful to say "unsupported format, get a new version" than
217 * "can only handle 16 bits".
218 */
219
Eric Andersencc8ed391999-10-05 16:24:54 +0000220/* tailor.h -- target dependent definitions
221 * Copyright (C) 1992-1993 Jean-loup Gailly.
222 * This is free software; you can redistribute it and/or modify it under the
223 * terms of the GNU General Public License, see the file COPYING.
224 */
225
226/* The target dependent definitions should be defined here only.
227 * The target dependent functions should be defined in tailor.c.
228 */
229
Eric Andersencc8ed391999-10-05 16:24:54 +0000230
Eric Andersencc8ed391999-10-05 16:24:54 +0000231 /* Common defaults */
232
233#ifndef OS_CODE
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000234# define OS_CODE 0x03 /* assume Unix */
Eric Andersencc8ed391999-10-05 16:24:54 +0000235#endif
236
237#ifndef PATH_SEP
238# define PATH_SEP '/'
239#endif
240
Eric Andersencc8ed391999-10-05 16:24:54 +0000241#ifndef OPTIONS_VAR
242# define OPTIONS_VAR "GZIP"
243#endif
244
245#ifndef Z_SUFFIX
246# define Z_SUFFIX ".gz"
247#endif
248
249#ifdef MAX_EXT_CHARS
250# define MAX_SUFFIX MAX_EXT_CHARS
251#else
252# define MAX_SUFFIX 30
253#endif
254
Eric Andersen3073dfb2001-07-02 17:57:32 +0000255 /* global buffers */
Eric Andersencc8ed391999-10-05 16:24:54 +0000256
Eric Andersen3073dfb2001-07-02 17:57:32 +0000257DECLARE(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
258DECLARE(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
259DECLARE(ush, d_buf, DIST_BUFSIZE);
260DECLARE(uch, window, 2L * WSIZE);
261DECLARE(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +0000262
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000263static int foreground; /* set if program run in foreground */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000264static int method = DEFLATED; /* compression method */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000265static int exit_code = OK; /* program exit code */
266static int part_nb; /* number of parts in .gz file */
267static long time_stamp; /* original time stamp (modification time) */
268static long ifile_size; /* input file size, -1 for devices (debug only) */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000269static char z_suffix[MAX_SUFFIX + 1]; /* default suffix (can be set with --suffix) */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000270static int z_len; /* strlen(z_suffix) */
Eric Andersencc8ed391999-10-05 16:24:54 +0000271
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000272static int ifd; /* input file descriptor */
273static int ofd; /* output file descriptor */
274static unsigned insize; /* valid bytes in inbuf */
275static unsigned outcnt; /* bytes in output buffer */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000276
Rob Landleyc57ec372006-04-10 17:07:15 +0000277static uint32_t *crc_32_tab;
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000278
279/* Output a 16 bit value, lsb first */
280static void put_short(ush w)
281{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000282 if (outcnt < OUTBUFSIZ - 2) {
283 outbuf[outcnt++] = (uch) ((w) & 0xff);
284 outbuf[outcnt++] = (uch) ((ush) (w) >> 8);
285 } else {
286 put_byte((uch) ((w) & 0xff));
287 put_byte((uch) ((ush) (w) >> 8));
288 }
Aaron Lehmannb9df4702001-12-06 03:22:43 +0000289}
290
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000291/* ========================================================================
292 * Signal and error handler.
293 */
Bernhard Reutner-Fischer20f40002006-01-30 17:17:14 +0000294static void abort_gzip(int ATTRIBUTE_UNUSED ignored)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000295{
296 exit(ERROR);
297}
298
299/* ===========================================================================
300 * Clear input and output buffers
301 */
302static void clear_bufs(void)
303{
304 outcnt = 0;
Eric Andersen3073dfb2001-07-02 17:57:32 +0000305 insize = 0;
306 bytes_in = 0L;
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000307}
308
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000309/* ===========================================================================
310 * Does the same as write(), but also handles partial pipe writes and checks
311 * for error return.
312 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000313static void write_buf(int fd, void *buf, unsigned cnt)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000314{
315 unsigned n;
316
317 while ((n = write(fd, buf, cnt)) != cnt) {
Bernhard Reutner-Fischer1b9d7c92006-06-03 22:45:37 +0000318 if (n == (unsigned) (-1)) bb_error_msg_and_die(bb_msg_write_error);
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000319 cnt -= n;
320 buf = (void *) ((char *) buf + n);
321 }
322}
323
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000324/* ===========================================================================
325 * Run a set of bytes through the crc shift register. If s is a NULL
326 * pointer, then initialize the crc shift register contents instead.
327 * Return the current crc in either case.
328 */
Rob Landleyc57ec372006-04-10 17:07:15 +0000329static uint32_t updcrc(uch * s, unsigned n)
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000330{
Rob Landleyc57ec372006-04-10 17:07:15 +0000331 static uint32_t crc = ~0; /* shift register contents */
332 uint32_t c; /* temporary variable */
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000333
334 if (s == NULL) {
Rob Landleyc57ec372006-04-10 17:07:15 +0000335 c = ~0;
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000336 } else {
337 c = crc;
338 if (n)
339 do {
340 c = crc_32_tab[((int) c ^ (*s++)) & 0xff] ^ (c >> 8);
341 } while (--n);
342 }
343 crc = c;
Rob Landleyc57ec372006-04-10 17:07:15 +0000344 return ~c;
Glenn L McGrathf58efb52001-03-28 05:35:16 +0000345}
346
Eric Andersencc8ed391999-10-05 16:24:54 +0000347/* bits.c -- output variable-length bit strings
348 * Copyright (C) 1992-1993 Jean-loup Gailly
349 * This is free software; you can redistribute it and/or modify it under the
350 * terms of the GNU General Public License, see the file COPYING.
351 */
352
353
354/*
355 * PURPOSE
356 *
357 * Output variable-length bit strings. Compression can be done
358 * to a file or to memory. (The latter is not supported in this version.)
359 *
360 * DISCUSSION
361 *
362 * The PKZIP "deflate" file format interprets compressed file data
363 * as a sequence of bits. Multi-bit strings in the file may cross
364 * byte boundaries without restriction.
365 *
366 * The first bit of each byte is the low-order bit.
367 *
368 * The routines in this file allow a variable-length bit value to
369 * be output right-to-left (useful for literal values). For
370 * left-to-right output (useful for code strings from the tree routines),
371 * the bits must have been reversed first with bi_reverse().
372 *
373 * For in-memory compression, the compressed bit stream goes directly
374 * into the requested output buffer. The input data is read in blocks
375 * by the mem_read() function. The buffer is limited to 64K on 16 bit
376 * machines.
377 *
378 * INTERFACE
379 *
380 * void bi_init (FILE *zipfile)
381 * Initialize the bit string routines.
382 *
383 * void send_bits (int value, int length)
384 * Write out a bit string, taking the source bits right to
385 * left.
386 *
387 * int bi_reverse (int value, int length)
388 * Reverse the bits of a bit string, taking the source bits left to
389 * right and emitting them right to left.
390 *
391 * void bi_windup (void)
392 * Write out any remaining bits in an incomplete byte.
393 *
394 * void copy_block(char *buf, unsigned len, int header)
395 * Copy a stored block to the zip file, storing first the length and
396 * its one's complement if requested.
397 *
398 */
399
Eric Andersencc8ed391999-10-05 16:24:54 +0000400/* ===========================================================================
401 * Local data used by the "bit string" routines.
402 */
403
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000404static file_t zfile; /* output gzip file */
Eric Andersencc8ed391999-10-05 16:24:54 +0000405
Eric Andersen3073dfb2001-07-02 17:57:32 +0000406static unsigned short bi_buf;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000407
Eric Andersencc8ed391999-10-05 16:24:54 +0000408/* Output buffer. bits are inserted starting at the bottom (least significant
409 * bits).
410 */
411
412#define Buf_size (8 * 2*sizeof(char))
413/* Number of bits used within bi_buf. (bi_buf might be implemented on
414 * more than 16 bits on some systems.)
415 */
416
Eric Andersen3073dfb2001-07-02 17:57:32 +0000417static int bi_valid;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000418
Eric Andersencc8ed391999-10-05 16:24:54 +0000419/* Current input function. Set to mem_read for in-memory compression */
420
421#ifdef DEBUG
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000422ulg bits_sent; /* bit length of the compressed data */
Eric Andersencc8ed391999-10-05 16:24:54 +0000423#endif
424
425/* ===========================================================================
426 * Initialize the bit string routines.
427 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000428static void bi_init(file_t zipfile)
Eric Andersencc8ed391999-10-05 16:24:54 +0000429{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000430 zfile = zipfile;
431 bi_buf = 0;
432 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000433#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000434 bits_sent = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000435#endif
436
Erik Andersene49d5ec2000-02-08 19:58:47 +0000437 /* Set the defaults for file compression. They are set by memcompress
438 * for in-memory compression.
439 */
440 if (zfile != NO_FILE) {
441 read_buf = file_read;
442 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000443}
444
445/* ===========================================================================
446 * Send a value on a given number of bits.
447 * IN assertion: length <= 16 and value fits in length bits.
448 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000449static void send_bits(int value, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000450{
451#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000452 Tracev((stderr, " l %2d v %4x ", length, value));
453 Assert(length > 0 && length <= 15, "invalid length");
454 bits_sent += (ulg) length;
Eric Andersencc8ed391999-10-05 16:24:54 +0000455#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000456 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
457 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
458 * unused bits in value.
459 */
460 if (bi_valid > (int) Buf_size - length) {
461 bi_buf |= (value << bi_valid);
462 put_short(bi_buf);
463 bi_buf = (ush) value >> (Buf_size - bi_valid);
464 bi_valid += length - Buf_size;
465 } else {
466 bi_buf |= value << bi_valid;
467 bi_valid += length;
468 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000469}
470
471/* ===========================================================================
472 * Reverse the first len bits of a code, using straightforward code (a faster
473 * method would use a table)
474 * IN assertion: 1 <= len <= 15
475 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000476static unsigned bi_reverse(unsigned code, int len)
Eric Andersencc8ed391999-10-05 16:24:54 +0000477{
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000478 unsigned res = 0;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000479
480 do {
481 res |= code & 1;
482 code >>= 1, res <<= 1;
483 } while (--len > 0);
484 return res >> 1;
Eric Andersencc8ed391999-10-05 16:24:54 +0000485}
486
487/* ===========================================================================
488 * Write out any remaining bits in an incomplete byte.
489 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +0000490static void bi_windup(void)
Eric Andersencc8ed391999-10-05 16:24:54 +0000491{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000492 if (bi_valid > 8) {
493 put_short(bi_buf);
494 } else if (bi_valid > 0) {
495 put_byte(bi_buf);
496 }
497 bi_buf = 0;
498 bi_valid = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +0000499#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000500 bits_sent = (bits_sent + 7) & ~7;
Eric Andersencc8ed391999-10-05 16:24:54 +0000501#endif
502}
503
504/* ===========================================================================
505 * Copy a stored block to the zip file, storing first the length and its
506 * one's complement if requested.
507 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000508static void copy_block(char *buf, unsigned len, int header)
Eric Andersencc8ed391999-10-05 16:24:54 +0000509{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000510 bi_windup(); /* align on byte boundary */
Eric Andersencc8ed391999-10-05 16:24:54 +0000511
Erik Andersene49d5ec2000-02-08 19:58:47 +0000512 if (header) {
513 put_short((ush) len);
514 put_short((ush) ~ len);
Eric Andersencc8ed391999-10-05 16:24:54 +0000515#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000516 bits_sent += 2 * 16;
Eric Andersencc8ed391999-10-05 16:24:54 +0000517#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000518 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000519#ifdef DEBUG
Erik Andersene49d5ec2000-02-08 19:58:47 +0000520 bits_sent += (ulg) len << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +0000521#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +0000522 while (len--) {
Erik Andersene49d5ec2000-02-08 19:58:47 +0000523 put_byte(*buf++);
524 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000525}
Erik Andersene49d5ec2000-02-08 19:58:47 +0000526
Eric Andersencc8ed391999-10-05 16:24:54 +0000527/* deflate.c -- compress data using the deflation algorithm
528 * Copyright (C) 1992-1993 Jean-loup Gailly
529 * This is free software; you can redistribute it and/or modify it under the
530 * terms of the GNU General Public License, see the file COPYING.
531 */
532
533/*
534 * PURPOSE
535 *
536 * Identify new text as repetitions of old text within a fixed-
537 * length sliding window trailing behind the new text.
538 *
539 * DISCUSSION
540 *
541 * The "deflation" process depends on being able to identify portions
542 * of the input text which are identical to earlier input (within a
543 * sliding window trailing behind the input currently being processed).
544 *
545 * The most straightforward technique turns out to be the fastest for
546 * most input files: try all possible matches and select the longest.
547 * The key feature of this algorithm is that insertions into the string
548 * dictionary are very simple and thus fast, and deletions are avoided
549 * completely. Insertions are performed at each input character, whereas
550 * string matches are performed only when the previous match ends. So it
551 * is preferable to spend more time in matches to allow very fast string
552 * insertions and avoid deletions. The matching algorithm for small
553 * strings is inspired from that of Rabin & Karp. A brute force approach
554 * is used to find longer strings when a small match has been found.
555 * A similar algorithm is used in comic (by Jan-Mark Wams) and freeze
556 * (by Leonid Broukhis).
557 * A previous version of this file used a more sophisticated algorithm
558 * (by Fiala and Greene) which is guaranteed to run in linear amortized
559 * time, but has a larger average cost, uses more memory and is patented.
560 * However the F&G algorithm may be faster for some highly redundant
561 * files if the parameter max_chain_length (described below) is too large.
562 *
Eric Andersenaff114c2004-04-14 17:51:38 +0000563 * ACKNOWLEDGMENTS
Eric Andersencc8ed391999-10-05 16:24:54 +0000564 *
565 * The idea of lazy evaluation of matches is due to Jan-Mark Wams, and
566 * I found it in 'freeze' written by Leonid Broukhis.
567 * Thanks to many info-zippers for bug reports and testing.
568 *
569 * REFERENCES
570 *
571 * APPNOTE.TXT documentation file in PKZIP 1.93a distribution.
572 *
573 * A description of the Rabin and Karp algorithm is given in the book
574 * "Algorithms" by R. Sedgewick, Addison-Wesley, p252.
575 *
576 * Fiala,E.R., and Greene,D.H.
577 * Data Compression with Finite Windows, Comm.ACM, 32,4 (1989) 490-595
578 *
579 * INTERFACE
580 *
581 * void lm_init (int pack_level, ush *flags)
582 * Initialize the "longest match" routines for a new file
583 *
584 * ulg deflate (void)
585 * Processes a new input file and return its compressed length. Sets
586 * the compressed length, crc, deflate flags and internal file
587 * attributes.
588 */
589
Eric Andersencc8ed391999-10-05 16:24:54 +0000590
Eric Andersencc8ed391999-10-05 16:24:54 +0000591/* ===========================================================================
592 * Configuration parameters
593 */
594
595/* Compile with MEDIUM_MEM to reduce the memory requirements or
596 * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
597 * entire input file can be held in memory (not possible on 16 bit systems).
598 * Warning: defining these symbols affects HASH_BITS (see below) and thus
599 * affects the compression ratio. The compressed output
600 * is still correct, and might even be smaller in some cases.
601 */
602
603#ifdef SMALL_MEM
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000604# define HASH_BITS 13 /* Number of bits used to hash strings */
Eric Andersencc8ed391999-10-05 16:24:54 +0000605#endif
606#ifdef MEDIUM_MEM
607# define HASH_BITS 14
608#endif
609#ifndef HASH_BITS
610# define HASH_BITS 15
611 /* For portability to 16 bit machines, do not use values above 15. */
612#endif
613
614/* To save space (see unlzw.c), we overlay prev+head with tab_prefix and
615 * window with tab_suffix. Check that we can do this:
616 */
617#if (WSIZE<<1) > (1<<BITS)
Eric Andersen3073dfb2001-07-02 17:57:32 +0000618# error cannot overlay window with tab_suffix and prev with tab_prefix0
Eric Andersencc8ed391999-10-05 16:24:54 +0000619#endif
620#if HASH_BITS > BITS-1
Eric Andersen3073dfb2001-07-02 17:57:32 +0000621# error cannot overlay head with tab_prefix1
Eric Andersencc8ed391999-10-05 16:24:54 +0000622#endif
Eric Andersencc8ed391999-10-05 16:24:54 +0000623#define HASH_SIZE (unsigned)(1<<HASH_BITS)
624#define HASH_MASK (HASH_SIZE-1)
625#define WMASK (WSIZE-1)
626/* HASH_SIZE and WSIZE must be powers of two */
Eric Andersencc8ed391999-10-05 16:24:54 +0000627#define NIL 0
628/* Tail of hash chains */
Eric Andersencc8ed391999-10-05 16:24:54 +0000629#define FAST 4
630#define SLOW 2
631/* speed options for the general purpose bit flag */
Eric Andersencc8ed391999-10-05 16:24:54 +0000632#ifndef TOO_FAR
633# define TOO_FAR 4096
634#endif
635/* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
Eric Andersencc8ed391999-10-05 16:24:54 +0000636/* ===========================================================================
637 * Local data used by the "longest match" routines.
638 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000639typedef ush Pos;
640typedef unsigned IPos;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000641
Eric Andersencc8ed391999-10-05 16:24:54 +0000642/* A Pos is an index in the character window. We use short instead of int to
643 * save space in the various tables. IPos is used only for parameter passing.
644 */
645
646/* DECLARE(uch, window, 2L*WSIZE); */
647/* Sliding window. Input bytes are read into the second half of the window,
648 * and move to the first half later to keep a dictionary of at least WSIZE
649 * bytes. With this organization, matches are limited to a distance of
650 * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
651 * performed with a length multiple of the block size. Also, it limits
652 * the window size to 64K, which is quite useful on MSDOS.
653 * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
654 * be less efficient).
655 */
656
657/* DECLARE(Pos, prev, WSIZE); */
658/* Link to older string with same hash index. To limit the size of this
659 * array to 64K, this link is maintained only for the last 32K strings.
660 * An index in this array is thus a window index modulo 32K.
661 */
662
663/* DECLARE(Pos, head, 1<<HASH_BITS); */
664/* Heads of the hash chains or NIL. */
665
Eric Andersen3073dfb2001-07-02 17:57:32 +0000666static const ulg window_size = (ulg) 2 * WSIZE;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000667
Eric Andersencc8ed391999-10-05 16:24:54 +0000668/* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
669 * input file length plus MIN_LOOKAHEAD.
670 */
671
Eric Andersen3073dfb2001-07-02 17:57:32 +0000672static long block_start;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000673
Eric Andersencc8ed391999-10-05 16:24:54 +0000674/* window position at the beginning of the current output block. Gets
675 * negative when the window is moved backwards.
676 */
677
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000678static unsigned ins_h; /* hash index of string to be inserted */
Eric Andersencc8ed391999-10-05 16:24:54 +0000679
680#define H_SHIFT ((HASH_BITS+MIN_MATCH-1)/MIN_MATCH)
681/* Number of bits by which ins_h and del_h must be shifted at each
682 * input step. It must be such that after MIN_MATCH steps, the oldest
683 * byte no longer takes part in the hash key, that is:
684 * H_SHIFT * MIN_MATCH >= HASH_BITS
685 */
686
Eric Andersen3073dfb2001-07-02 17:57:32 +0000687static unsigned int prev_length;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000688
Eric Andersencc8ed391999-10-05 16:24:54 +0000689/* Length of the best match at previous step. Matches not greater than this
690 * are discarded. This is used in the lazy match evaluation.
691 */
692
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000693static unsigned strstart; /* start of string to insert */
694static unsigned match_start; /* start of matching string */
695static int eofile; /* flag set at end of input file */
696static unsigned lookahead; /* number of valid bytes ahead in window */
Eric Andersencc8ed391999-10-05 16:24:54 +0000697
Rob Landleybc68cd12006-03-10 19:22:06 +0000698enum {
699 max_chain_length = 4096,
Erik Andersene49d5ec2000-02-08 19:58:47 +0000700
Eric Andersencc8ed391999-10-05 16:24:54 +0000701/* To speed up deflation, hash chains are never searched beyond this length.
702 * A higher limit improves compression ratio but degrades the speed.
703 */
704
Rob Landleybc68cd12006-03-10 19:22:06 +0000705 max_lazy_match = 258,
Erik Andersene49d5ec2000-02-08 19:58:47 +0000706
Eric Andersencc8ed391999-10-05 16:24:54 +0000707/* Attempt to find a better match only when the current match is strictly
708 * smaller than this value. This mechanism is used only for compression
709 * levels >= 4.
710 */
Rob Landleybc68cd12006-03-10 19:22:06 +0000711 max_insert_length = max_lazy_match,
Eric Andersencc8ed391999-10-05 16:24:54 +0000712/* Insert new strings in the hash table only if the match length
713 * is not greater than this length. This saves time but degrades compression.
714 * max_insert_length is used only for compression levels <= 3.
715 */
716
Rob Landleybc68cd12006-03-10 19:22:06 +0000717 good_match = 32,
Erik Andersene49d5ec2000-02-08 19:58:47 +0000718
Eric Andersencc8ed391999-10-05 16:24:54 +0000719/* Use a faster search when the previous match is longer than this */
720
721
722/* Values for max_lazy_match, good_match and max_chain_length, depending on
723 * the desired pack level (0..9). The values given below have been tuned to
724 * exclude worst case performance for pathological files. Better values may be
725 * found for specific files.
726 */
727
Rob Landleybc68cd12006-03-10 19:22:06 +0000728 nice_match = 258 /* Stop searching when current match exceeds this */
Eric Andersencc8ed391999-10-05 16:24:54 +0000729
730/* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
731 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
732 * meaning.
733 */
Rob Landleybc68cd12006-03-10 19:22:06 +0000734};
Eric Andersencc8ed391999-10-05 16:24:54 +0000735
736#define EQUAL 0
737/* result of memcmp for equal strings */
738
739/* ===========================================================================
740 * Prototypes for local functions.
741 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000742static void fill_window(void);
Eric Andersencc8ed391999-10-05 16:24:54 +0000743
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000744static int longest_match(IPos cur_match);
Eric Andersencc8ed391999-10-05 16:24:54 +0000745
746#ifdef DEBUG
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000747static void check_match(IPos start, IPos match, int length);
Eric Andersencc8ed391999-10-05 16:24:54 +0000748#endif
749
750/* ===========================================================================
751 * Update a hash value with the given input byte
752 * IN assertion: all calls to to UPDATE_HASH are made with consecutive
753 * input characters, so that a running hash key can be computed from the
754 * previous key instead of complete recalculation each time.
755 */
756#define UPDATE_HASH(h,c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
757
758/* ===========================================================================
759 * Insert string s in the dictionary and set match_head to the previous head
760 * of the hash chain (the most recent string with same hash key). Return
761 * the previous length of the hash chain.
762 * IN assertion: all calls to to INSERT_STRING are made with consecutive
763 * input characters and the first MIN_MATCH bytes of s are valid
764 * (except for the last MIN_MATCH-1 bytes of the input file).
765 */
766#define INSERT_STRING(s, match_head) \
767 (UPDATE_HASH(ins_h, window[(s) + MIN_MATCH-1]), \
768 prev[(s) & WMASK] = match_head = head[ins_h], \
769 head[ins_h] = (s))
770
771/* ===========================================================================
772 * Initialize the "longest match" routines for a new file
773 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000774static void lm_init(ush * flags)
Eric Andersencc8ed391999-10-05 16:24:54 +0000775{
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000776 unsigned j;
Eric Andersencc8ed391999-10-05 16:24:54 +0000777
Erik Andersene49d5ec2000-02-08 19:58:47 +0000778 /* Initialize the hash table. */
Rob Landleyec4f3d92004-12-17 05:23:36 +0000779 memset(head, 0, HASH_SIZE * sizeof(*head));
Erik Andersene49d5ec2000-02-08 19:58:47 +0000780 /* prev will be initialized on the fly */
Eric Andersencc8ed391999-10-05 16:24:54 +0000781
Erik Andersene49d5ec2000-02-08 19:58:47 +0000782 *flags |= SLOW;
783 /* ??? reduce max_chain_length for binary files */
Eric Andersencc8ed391999-10-05 16:24:54 +0000784
Erik Andersene49d5ec2000-02-08 19:58:47 +0000785 strstart = 0;
786 block_start = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +0000787
Erik Andersene49d5ec2000-02-08 19:58:47 +0000788 lookahead = read_buf((char *) window,
789 sizeof(int) <= 2 ? (unsigned) WSIZE : 2 * WSIZE);
Eric Andersencc8ed391999-10-05 16:24:54 +0000790
Erik Andersene49d5ec2000-02-08 19:58:47 +0000791 if (lookahead == 0 || lookahead == (unsigned) EOF) {
792 eofile = 1, lookahead = 0;
793 return;
794 }
795 eofile = 0;
796 /* Make sure that we always have enough lookahead. This is important
797 * if input comes from a device such as a tty.
798 */
799 while (lookahead < MIN_LOOKAHEAD && !eofile)
800 fill_window();
Eric Andersencc8ed391999-10-05 16:24:54 +0000801
Erik Andersene49d5ec2000-02-08 19:58:47 +0000802 ins_h = 0;
803 for (j = 0; j < MIN_MATCH - 1; j++)
804 UPDATE_HASH(ins_h, window[j]);
805 /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
806 * not important since only literal bytes will be emitted.
807 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000808}
809
810/* ===========================================================================
811 * Set match_start to the longest match starting at the given string and
812 * return its length. Matches shorter or equal to prev_length are discarded,
813 * in which case the result is equal to prev_length and match_start is
814 * garbage.
815 * IN assertions: cur_match is the head of the hash chain for the current
816 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
817 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000818
Eric Andersencc8ed391999-10-05 16:24:54 +0000819/* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
820 * match.s. The code is functionally equivalent, so you can use the C version
821 * if desired.
822 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000823static int longest_match(IPos cur_match)
Eric Andersencc8ed391999-10-05 16:24:54 +0000824{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000825 unsigned chain_length = max_chain_length; /* max hash chain length */
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000826 uch *scan = window + strstart; /* current string */
827 uch *match; /* matched string */
828 int len; /* length of current match */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000829 int best_len = prev_length; /* best match length so far */
830 IPos limit =
Erik Andersene49d5ec2000-02-08 19:58:47 +0000831 strstart > (IPos) MAX_DIST ? strstart - (IPos) MAX_DIST : NIL;
832 /* Stop when cur_match becomes <= limit. To simplify the code,
833 * we prevent matches with the string of window index 0.
834 */
Eric Andersencc8ed391999-10-05 16:24:54 +0000835
836/* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
837 * It is easy to get rid of this optimization if necessary.
838 */
839#if HASH_BITS < 8 || MAX_MATCH != 258
Eric Andersen3073dfb2001-07-02 17:57:32 +0000840# error Code too clever
Eric Andersencc8ed391999-10-05 16:24:54 +0000841#endif
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000842 uch *strend = window + strstart + MAX_MATCH;
843 uch scan_end1 = scan[best_len - 1];
844 uch scan_end = scan[best_len];
Eric Andersencc8ed391999-10-05 16:24:54 +0000845
Erik Andersene49d5ec2000-02-08 19:58:47 +0000846 /* Do not waste too much time if we already have a good match: */
847 if (prev_length >= good_match) {
848 chain_length >>= 2;
849 }
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000850 Assert(strstart <= window_size - MIN_LOOKAHEAD, "insufficient lookahead");
Eric Andersencc8ed391999-10-05 16:24:54 +0000851
Erik Andersene49d5ec2000-02-08 19:58:47 +0000852 do {
853 Assert(cur_match < strstart, "no future");
854 match = window + cur_match;
Eric Andersencc8ed391999-10-05 16:24:54 +0000855
Erik Andersene49d5ec2000-02-08 19:58:47 +0000856 /* Skip to next match if the match length cannot increase
857 * or if the match length is less than 2:
858 */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000859 if (match[best_len] != scan_end ||
860 match[best_len - 1] != scan_end1 ||
861 *match != *scan || *++match != scan[1])
862 continue;
Eric Andersencc8ed391999-10-05 16:24:54 +0000863
Erik Andersene49d5ec2000-02-08 19:58:47 +0000864 /* The check at best_len-1 can be removed because it will be made
865 * again later. (This heuristic is not always a win.)
866 * It is not necessary to compare scan[2] and match[2] since they
867 * are always equal when the other bytes match, given that
868 * the hash keys are equal and that HASH_BITS >= 8.
869 */
870 scan += 2, match++;
Eric Andersencc8ed391999-10-05 16:24:54 +0000871
Erik Andersene49d5ec2000-02-08 19:58:47 +0000872 /* We check for insufficient lookahead only every 8th comparison;
873 * the 256th check will be made at strstart+258.
874 */
875 do {
876 } while (*++scan == *++match && *++scan == *++match &&
877 *++scan == *++match && *++scan == *++match &&
878 *++scan == *++match && *++scan == *++match &&
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000879 *++scan == *++match && *++scan == *++match && scan < strend);
Eric Andersencc8ed391999-10-05 16:24:54 +0000880
Erik Andersene49d5ec2000-02-08 19:58:47 +0000881 len = MAX_MATCH - (int) (strend - scan);
882 scan = strend - MAX_MATCH;
Eric Andersencc8ed391999-10-05 16:24:54 +0000883
Erik Andersene49d5ec2000-02-08 19:58:47 +0000884 if (len > best_len) {
885 match_start = cur_match;
886 best_len = len;
887 if (len >= nice_match)
888 break;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000889 scan_end1 = scan[best_len - 1];
890 scan_end = scan[best_len];
Erik Andersene49d5ec2000-02-08 19:58:47 +0000891 }
892 } while ((cur_match = prev[cur_match & WMASK]) > limit
893 && --chain_length != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +0000894
Erik Andersene49d5ec2000-02-08 19:58:47 +0000895 return best_len;
Eric Andersencc8ed391999-10-05 16:24:54 +0000896}
Eric Andersencc8ed391999-10-05 16:24:54 +0000897
898#ifdef DEBUG
899/* ===========================================================================
900 * Check that the match at match_start is indeed a match.
901 */
Eric Andersen3073dfb2001-07-02 17:57:32 +0000902static void check_match(IPos start, IPos match, int length)
Eric Andersencc8ed391999-10-05 16:24:54 +0000903{
Erik Andersene49d5ec2000-02-08 19:58:47 +0000904 /* check that the match is indeed a match */
905 if (memcmp((char *) window + match,
906 (char *) window + start, length) != EQUAL) {
Manuel Novoa III cad53642003-03-19 09:13:01 +0000907 bb_error_msg(" start %d, match %d, length %d", start, match, length);
908 bb_error_msg("invalid match");
Erik Andersene49d5ec2000-02-08 19:58:47 +0000909 }
910 if (verbose > 1) {
Manuel Novoa III cad53642003-03-19 09:13:01 +0000911 bb_error_msg("\\[%d,%d]", start - match, length);
Erik Andersene49d5ec2000-02-08 19:58:47 +0000912 do {
913 putc(window[start++], stderr);
914 } while (--length != 0);
915 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000916}
917#else
918# define check_match(start, match, length)
919#endif
920
921/* ===========================================================================
922 * Fill the window when the lookahead becomes insufficient.
923 * Updates strstart and lookahead, and sets eofile if end of input file.
924 * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
925 * OUT assertions: at least one byte has been read, or eofile is set;
926 * file reads are performed for at least two bytes (required for the
927 * translate_eol option).
928 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +0000929static void fill_window(void)
Eric Andersencc8ed391999-10-05 16:24:54 +0000930{
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000931 unsigned n, m;
Erik Andersene49d5ec2000-02-08 19:58:47 +0000932 unsigned more =
Erik Andersene49d5ec2000-02-08 19:58:47 +0000933 (unsigned) (window_size - (ulg) lookahead - (ulg) strstart);
934 /* Amount of free space at the end of the window. */
Eric Andersencc8ed391999-10-05 16:24:54 +0000935
Erik Andersene49d5ec2000-02-08 19:58:47 +0000936 /* If the window is almost full and there is insufficient lookahead,
937 * move the upper half to the lower one to make room in the upper half.
938 */
939 if (more == (unsigned) EOF) {
940 /* Very unlikely, but possible on 16 bit machine if strstart == 0
941 * and lookahead == 1 (input done one byte at time)
942 */
943 more--;
944 } else if (strstart >= WSIZE + MAX_DIST) {
945 /* By the IN assertion, the window is not empty so we can't confuse
946 * more == 0 with more == 64K on a 16 bit machine.
947 */
948 Assert(window_size == (ulg) 2 * WSIZE, "no sliding with BIG_MEM");
Eric Andersencc8ed391999-10-05 16:24:54 +0000949
Erik Andersene49d5ec2000-02-08 19:58:47 +0000950 memcpy((char *) window, (char *) window + WSIZE, (unsigned) WSIZE);
951 match_start -= WSIZE;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000952 strstart -= WSIZE; /* we now have strstart >= MAX_DIST: */
Eric Andersencc8ed391999-10-05 16:24:54 +0000953
Erik Andersene49d5ec2000-02-08 19:58:47 +0000954 block_start -= (long) WSIZE;
955
956 for (n = 0; n < HASH_SIZE; n++) {
957 m = head[n];
958 head[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
959 }
960 for (n = 0; n < WSIZE; n++) {
961 m = prev[n];
962 prev[n] = (Pos) (m >= WSIZE ? m - WSIZE : NIL);
963 /* If n is not on any hash chain, prev[n] is garbage but
964 * its value will never be used.
965 */
966 }
967 more += WSIZE;
968 }
969 /* At this point, more >= 2 */
970 if (!eofile) {
971 n = read_buf((char *) window + strstart + lookahead, more);
972 if (n == 0 || n == (unsigned) EOF) {
973 eofile = 1;
974 } else {
975 lookahead += n;
976 }
977 }
Eric Andersencc8ed391999-10-05 16:24:54 +0000978}
979
980/* ===========================================================================
981 * Flush the current block, with given end-of-file flag.
982 * IN assertion: strstart is set to the end of the current match.
983 */
984#define FLUSH_BLOCK(eof) \
985 flush_block(block_start >= 0L ? (char*)&window[(unsigned)block_start] : \
Tim Rikerc1ef7bd2006-01-25 00:08:53 +0000986 (char*)NULL, (long)strstart - block_start, (eof))
Eric Andersencc8ed391999-10-05 16:24:54 +0000987
988/* ===========================================================================
989 * Same as above, but achieves better compression. We use a lazy
990 * evaluation for matches: a match is finally adopted only if there is
991 * no better match at the next window position.
992 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +0000993static ulg deflate(void)
Eric Andersencc8ed391999-10-05 16:24:54 +0000994{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +0000995 IPos hash_head; /* head of hash chain */
996 IPos prev_match; /* previous match */
997 int flush; /* set if current block must be flushed */
Erik Andersene49d5ec2000-02-08 19:58:47 +0000998 int match_available = 0; /* set if previous match exists */
"Robert P. J. Day"68229832006-07-01 13:08:46 +0000999 unsigned match_length = MIN_MATCH - 1; /* length of best match */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001000
Erik Andersene49d5ec2000-02-08 19:58:47 +00001001 /* Process the input block. */
1002 while (lookahead != 0) {
1003 /* Insert the string window[strstart .. strstart+2] in the
1004 * dictionary, and set hash_head to the head of the hash chain:
1005 */
1006 INSERT_STRING(strstart, hash_head);
Eric Andersencc8ed391999-10-05 16:24:54 +00001007
Erik Andersene49d5ec2000-02-08 19:58:47 +00001008 /* Find the longest match, discarding those <= prev_length.
1009 */
1010 prev_length = match_length, prev_match = match_start;
1011 match_length = MIN_MATCH - 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001012
Erik Andersene49d5ec2000-02-08 19:58:47 +00001013 if (hash_head != NIL && prev_length < max_lazy_match &&
1014 strstart - hash_head <= MAX_DIST) {
1015 /* To simplify the code, we prevent matches with the string
1016 * of window index 0 (in particular we have to avoid a match
1017 * of the string with itself at the start of the input file).
1018 */
1019 match_length = longest_match(hash_head);
1020 /* longest_match() sets match_start */
1021 if (match_length > lookahead)
1022 match_length = lookahead;
Eric Andersencc8ed391999-10-05 16:24:54 +00001023
Erik Andersene49d5ec2000-02-08 19:58:47 +00001024 /* Ignore a length 3 match if it is too distant: */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001025 if (match_length == MIN_MATCH && strstart - match_start > TOO_FAR) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00001026 /* If prev_match is also MIN_MATCH, match_start is garbage
1027 * but we will ignore the current match anyway.
1028 */
1029 match_length--;
1030 }
1031 }
1032 /* If there was a match at the previous step and the current
1033 * match is not better, output the previous match:
1034 */
1035 if (prev_length >= MIN_MATCH && match_length <= prev_length) {
Eric Andersencc8ed391999-10-05 16:24:54 +00001036
Erik Andersene49d5ec2000-02-08 19:58:47 +00001037 check_match(strstart - 1, prev_match, prev_length);
Eric Andersencc8ed391999-10-05 16:24:54 +00001038
Erik Andersene49d5ec2000-02-08 19:58:47 +00001039 flush =
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001040 ct_tally(strstart - 1 - prev_match, prev_length - MIN_MATCH);
Eric Andersencc8ed391999-10-05 16:24:54 +00001041
Erik Andersene49d5ec2000-02-08 19:58:47 +00001042 /* Insert in hash table all strings up to the end of the match.
1043 * strstart-1 and strstart are already inserted.
1044 */
1045 lookahead -= prev_length - 1;
1046 prev_length -= 2;
1047 do {
1048 strstart++;
1049 INSERT_STRING(strstart, hash_head);
1050 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1051 * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1052 * these bytes are garbage, but it does not matter since the
1053 * next lookahead bytes will always be emitted as literals.
1054 */
1055 } while (--prev_length != 0);
1056 match_available = 0;
1057 match_length = MIN_MATCH - 1;
1058 strstart++;
1059 if (flush)
1060 FLUSH_BLOCK(0), block_start = strstart;
Eric Andersencc8ed391999-10-05 16:24:54 +00001061
Erik Andersene49d5ec2000-02-08 19:58:47 +00001062 } else if (match_available) {
1063 /* If there was no match at the previous position, output a
1064 * single literal. If there was a match but the current match
1065 * is longer, truncate the previous match to a single literal.
1066 */
1067 Tracevv((stderr, "%c", window[strstart - 1]));
1068 if (ct_tally(0, window[strstart - 1])) {
1069 FLUSH_BLOCK(0), block_start = strstart;
1070 }
1071 strstart++;
1072 lookahead--;
1073 } else {
1074 /* There is no previous match to compare with, wait for
1075 * the next step to decide.
1076 */
1077 match_available = 1;
1078 strstart++;
1079 lookahead--;
1080 }
1081 Assert(strstart <= isize && lookahead <= isize, "a bit too far");
Eric Andersencc8ed391999-10-05 16:24:54 +00001082
Erik Andersene49d5ec2000-02-08 19:58:47 +00001083 /* Make sure that we always have enough lookahead, except
1084 * at the end of the input file. We need MAX_MATCH bytes
1085 * for the next match, plus MIN_MATCH bytes to insert the
1086 * string following the next match.
1087 */
1088 while (lookahead < MIN_LOOKAHEAD && !eofile)
1089 fill_window();
1090 }
1091 if (match_available)
1092 ct_tally(0, window[strstart - 1]);
Eric Andersencc8ed391999-10-05 16:24:54 +00001093
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001094 return FLUSH_BLOCK(1); /* eof */
Eric Andersencc8ed391999-10-05 16:24:54 +00001095}
Erik Andersene49d5ec2000-02-08 19:58:47 +00001096
Eric Andersencc8ed391999-10-05 16:24:54 +00001097/* gzip (GNU zip) -- compress files with zip algorithm and 'compress' interface
1098 * Copyright (C) 1992-1993 Jean-loup Gailly
1099 * The unzip code was written and put in the public domain by Mark Adler.
1100 * Portions of the lzw code are derived from the public domain 'compress'
1101 * written by Spencer Thomas, Joe Orost, James Woods, Jim McKie, Steve Davies,
1102 * Ken Turkowski, Dave Mack and Peter Jannesen.
1103 *
1104 * See the license_msg below and the file COPYING for the software license.
1105 * See the file algorithm.doc for the compression algorithms and file formats.
1106 */
1107
1108/* Compress files with zip algorithm and 'compress' interface.
1109 * See usage() and help() functions below for all options.
1110 * Outputs:
1111 * file.gz: compressed file with same mode, owner, and utimes
1112 * or stdout with -c option or if stdin used as input.
1113 * If the output file name had to be truncated, the original name is kept
1114 * in the compressed file.
Eric Andersencc8ed391999-10-05 16:24:54 +00001115 */
1116
Eric Andersencc8ed391999-10-05 16:24:54 +00001117 /* configuration */
1118
Erik Andersene49d5ec2000-02-08 19:58:47 +00001119typedef struct dirent dir_type;
1120
Eric Andersencc8ed391999-10-05 16:24:54 +00001121/* ======================================================================== */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001122int gzip_main(int argc, char **argv)
Eric Andersencc8ed391999-10-05 16:24:54 +00001123{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001124 int result;
1125 int inFileNum;
1126 int outFileNum;
1127 struct stat statBuf;
1128 char *delFileName;
1129 int tostdout = 0;
Eric Andersenea824fb2000-07-21 22:17:39 +00001130 int force = 0;
Matt Kraai53265542001-04-18 16:05:34 +00001131 int opt;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001132
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001133 while ((opt = getopt(argc, argv, "cf123456789dq")) != -1) {
Matt Kraai53265542001-04-18 16:05:34 +00001134 switch (opt) {
1135 case 'c':
Erik Andersene49d5ec2000-02-08 19:58:47 +00001136 tostdout = 1;
Matt Kraai53265542001-04-18 16:05:34 +00001137 break;
1138 case 'f':
1139 force = 1;
1140 break;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001141 /* Ignore 1-9 (compression level) options */
1142 case '1':
1143 case '2':
1144 case '3':
1145 case '4':
1146 case '5':
1147 case '6':
1148 case '7':
1149 case '8':
1150 case '9':
Matt Kraai53265542001-04-18 16:05:34 +00001151 break;
Glenn L McGrath5bcfc9b2001-05-07 12:01:58 +00001152 case 'q':
1153 break;
Eric Andersenbdfd0d72001-10-24 05:00:29 +00001154#ifdef CONFIG_GUNZIP
Matt Kraai53265542001-04-18 16:05:34 +00001155 case 'd':
1156 optind = 1;
1157 return gunzip_main(argc, argv);
Glenn L McGrath528ef502001-04-11 03:45:37 +00001158#endif
Matt Kraai53265542001-04-18 16:05:34 +00001159 default:
Manuel Novoa III cad53642003-03-19 09:13:01 +00001160 bb_show_usage();
Erik Andersene49d5ec2000-02-08 19:58:47 +00001161 }
1162 }
1163
1164 foreground = signal(SIGINT, SIG_IGN) != SIG_IGN;
1165 if (foreground) {
Rob Landleyec4f3d92004-12-17 05:23:36 +00001166 (void) signal(SIGINT, abort_gzip);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001167 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001168#ifdef SIGTERM
Erik Andersene49d5ec2000-02-08 19:58:47 +00001169 if (signal(SIGTERM, SIG_IGN) != SIG_IGN) {
Rob Landleyec4f3d92004-12-17 05:23:36 +00001170 (void) signal(SIGTERM, abort_gzip);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001171 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001172#endif
1173#ifdef SIGHUP
Erik Andersene49d5ec2000-02-08 19:58:47 +00001174 if (signal(SIGHUP, SIG_IGN) != SIG_IGN) {
Rob Landleyec4f3d92004-12-17 05:23:36 +00001175 (void) signal(SIGHUP, abort_gzip);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001176 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001177#endif
1178
Erik Andersene49d5ec2000-02-08 19:58:47 +00001179 strncpy(z_suffix, Z_SUFFIX, sizeof(z_suffix) - 1);
1180 z_len = strlen(z_suffix);
Eric Andersencc8ed391999-10-05 16:24:54 +00001181
Erik Andersene49d5ec2000-02-08 19:58:47 +00001182 /* Allocate all global buffers (for DYN_ALLOC option) */
1183 ALLOC(uch, inbuf, INBUFSIZ + INBUF_EXTRA);
1184 ALLOC(uch, outbuf, OUTBUFSIZ + OUTBUF_EXTRA);
1185 ALLOC(ush, d_buf, DIST_BUFSIZE);
1186 ALLOC(uch, window, 2L * WSIZE);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001187 ALLOC(ush, tab_prefix, 1L << BITS);
Eric Andersencc8ed391999-10-05 16:24:54 +00001188
Rob Landleyc57ec372006-04-10 17:07:15 +00001189 /* Initialise the CRC32 table */
1190 crc_32_tab = bb_crc32_filltable(0);
1191
Matt Kraai9bd49d62002-02-05 22:31:48 +00001192 clear_bufs();
1193 part_nb = 0;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001194
Matt Kraai9bd49d62002-02-05 22:31:48 +00001195 if (optind == argc) {
1196 time_stamp = 0;
1197 ifile_size = -1L;
1198 zip(STDIN_FILENO, STDOUT_FILENO);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001199 } else {
Matt Kraai9bd49d62002-02-05 22:31:48 +00001200 int i;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001201
Matt Kraai9bd49d62002-02-05 22:31:48 +00001202 for (i = optind; i < argc; i++) {
1203 char *path = NULL;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001204
Manuel Novoa III df7bfb42005-03-02 04:10:46 +00001205 clear_bufs();
Matt Kraai9bd49d62002-02-05 22:31:48 +00001206 if (strcmp(argv[i], "-") == 0) {
1207 time_stamp = 0;
1208 ifile_size = -1L;
1209 inFileNum = STDIN_FILENO;
1210 outFileNum = STDOUT_FILENO;
1211 } else {
Bernhard Reutner-Fischerc2cb0f32006-04-13 12:45:04 +00001212 inFileNum = bb_xopen3(argv[i], O_RDONLY, 0);
Bernhard Reutner-Fischerdac7ff12006-04-12 17:55:51 +00001213 if (fstat(inFileNum, &statBuf) < 0)
Manuel Novoa III cad53642003-03-19 09:13:01 +00001214 bb_perror_msg_and_die("%s", argv[i]);
Matt Kraai9bd49d62002-02-05 22:31:48 +00001215 time_stamp = statBuf.st_ctime;
1216 ifile_size = statBuf.st_size;
Eric Andersen96bcfd31999-11-12 01:30:18 +00001217
Matt Kraai9bd49d62002-02-05 22:31:48 +00001218 if (!tostdout) {
1219 path = xmalloc(strlen(argv[i]) + 4);
1220 strcpy(path, argv[i]);
1221 strcat(path, ".gz");
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001222
Matt Kraai9bd49d62002-02-05 22:31:48 +00001223 /* Open output file */
Bernhard Reutner-Fischer0b42a6a2005-10-07 11:34:50 +00001224#if (__GLIBC__ >= 2) && (__GLIBC_MINOR__ >= 1) && defined O_NOFOLLOW
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001225 outFileNum =
1226 open(path, O_RDWR | O_CREAT | O_EXCL | O_NOFOLLOW);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001227#else
Matt Kraai9bd49d62002-02-05 22:31:48 +00001228 outFileNum = open(path, O_RDWR | O_CREAT | O_EXCL);
Erik Andersen4d1d0111999-12-17 18:44:15 +00001229#endif
Matt Kraai9bd49d62002-02-05 22:31:48 +00001230 if (outFileNum < 0) {
Manuel Novoa III cad53642003-03-19 09:13:01 +00001231 bb_perror_msg("%s", path);
Matt Kraai9bd49d62002-02-05 22:31:48 +00001232 free(path);
1233 continue;
1234 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001235
Matt Kraai9bd49d62002-02-05 22:31:48 +00001236 /* Set permissions on the file */
1237 fchmod(outFileNum, statBuf.st_mode);
1238 } else
1239 outFileNum = STDOUT_FILENO;
1240 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001241
Matt Kraaief8b1122002-03-22 22:55:51 +00001242 if (path == NULL && isatty(outFileNum) && force == 0) {
Manuel Novoa III cad53642003-03-19 09:13:01 +00001243 bb_error_msg
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001244 ("compressed data not written to a terminal. Use -f to force compression.");
Matt Kraai9bd49d62002-02-05 22:31:48 +00001245 free(path);
1246 continue;
1247 }
Erik Andersene49d5ec2000-02-08 19:58:47 +00001248
Matt Kraai9bd49d62002-02-05 22:31:48 +00001249 result = zip(inFileNum, outFileNum);
1250
1251 if (path != NULL) {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001252 close(inFileNum);
1253 close(outFileNum);
Matt Kraai9bd49d62002-02-05 22:31:48 +00001254
1255 /* Delete the original file */
1256 if (result == OK)
1257 delFileName = argv[i];
1258 else
1259 delFileName = path;
1260
1261 if (unlink(delFileName) < 0)
Manuel Novoa III cad53642003-03-19 09:13:01 +00001262 bb_perror_msg("%s", delFileName);
Matt Kraai9bd49d62002-02-05 22:31:48 +00001263 }
1264
1265 free(path);
1266 }
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001267 }
Eric Andersen0dfac6b1999-11-11 05:46:32 +00001268
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001269 return (exit_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001270}
1271
Eric Andersencc8ed391999-10-05 16:24:54 +00001272/* trees.c -- output deflated data using Huffman coding
1273 * Copyright (C) 1992-1993 Jean-loup Gailly
1274 * This is free software; you can redistribute it and/or modify it under the
1275 * terms of the GNU General Public License, see the file COPYING.
1276 */
1277
1278/*
1279 * PURPOSE
1280 *
1281 * Encode various sets of source values using variable-length
1282 * binary code trees.
1283 *
1284 * DISCUSSION
1285 *
1286 * The PKZIP "deflation" process uses several Huffman trees. The more
1287 * common source values are represented by shorter bit sequences.
1288 *
1289 * Each code tree is stored in the ZIP file in a compressed form
1290 * which is itself a Huffman encoding of the lengths of
1291 * all the code strings (in ascending order by source values).
1292 * The actual code strings are reconstructed from the lengths in
1293 * the UNZIP process, as described in the "application note"
1294 * (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
1295 *
1296 * REFERENCES
1297 *
1298 * Lynch, Thomas J.
1299 * Data Compression: Techniques and Applications, pp. 53-55.
1300 * Lifetime Learning Publications, 1985. ISBN 0-534-03418-7.
1301 *
1302 * Storer, James A.
1303 * Data Compression: Methods and Theory, pp. 49-50.
1304 * Computer Science Press, 1988. ISBN 0-7167-8156-5.
1305 *
1306 * Sedgewick, R.
1307 * Algorithms, p290.
1308 * Addison-Wesley, 1983. ISBN 0-201-06672-6.
1309 *
1310 * INTERFACE
1311 *
1312 * void ct_init (ush *attr, int *methodp)
1313 * Allocate the match buffer, initialize the various tables and save
1314 * the location of the internal file attribute (ascii/binary) and
1315 * method (DEFLATE/STORE)
1316 *
1317 * void ct_tally (int dist, int lc);
1318 * Save the match info and tally the frequency counts.
1319 *
1320 * long flush_block (char *buf, ulg stored_len, int eof)
1321 * Determine the best encoding for the current block: dynamic trees,
1322 * static trees or store, and output the encoded block to the zip
1323 * file. Returns the total compressed length for the file so far.
1324 *
1325 */
1326
Eric Andersencc8ed391999-10-05 16:24:54 +00001327/* ===========================================================================
1328 * Constants
1329 */
1330
1331#define MAX_BITS 15
1332/* All codes must not exceed MAX_BITS bits */
1333
1334#define MAX_BL_BITS 7
1335/* Bit length codes must not exceed MAX_BL_BITS bits */
1336
1337#define LENGTH_CODES 29
1338/* number of length codes, not counting the special END_BLOCK code */
1339
1340#define LITERALS 256
1341/* number of literal bytes 0..255 */
1342
1343#define END_BLOCK 256
1344/* end of block literal code */
1345
1346#define L_CODES (LITERALS+1+LENGTH_CODES)
1347/* number of Literal or Length codes, including the END_BLOCK code */
1348
1349#define D_CODES 30
1350/* number of distance codes */
1351
1352#define BL_CODES 19
1353/* number of codes used to transfer the bit lengths */
1354
Eric Andersen39eb0402001-08-22 04:15:47 +00001355typedef uch extra_bits_t;
Eric Andersencc8ed391999-10-05 16:24:54 +00001356
Eric Andersen39eb0402001-08-22 04:15:47 +00001357/* extra bits for each length code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001358static const extra_bits_t extra_lbits[LENGTH_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001359 = { 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001360 4, 4, 5, 5, 5, 5, 0
1361};
Eric Andersencc8ed391999-10-05 16:24:54 +00001362
Eric Andersen39eb0402001-08-22 04:15:47 +00001363/* extra bits for each distance code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001364static const extra_bits_t extra_dbits[D_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001365 = { 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001366 10, 10, 11, 11, 12, 12, 13, 13
1367};
Eric Andersencc8ed391999-10-05 16:24:54 +00001368
Eric Andersen39eb0402001-08-22 04:15:47 +00001369/* extra bits for each bit length code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001370static const extra_bits_t extra_blbits[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001371= { 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 +00001372
1373#define STORED_BLOCK 0
1374#define STATIC_TREES 1
1375#define DYN_TREES 2
1376/* The three kinds of block type */
1377
1378#ifndef LIT_BUFSIZE
1379# ifdef SMALL_MEM
1380# define LIT_BUFSIZE 0x2000
1381# else
1382# ifdef MEDIUM_MEM
1383# define LIT_BUFSIZE 0x4000
1384# else
1385# define LIT_BUFSIZE 0x8000
1386# endif
1387# endif
1388#endif
1389#ifndef DIST_BUFSIZE
1390# define DIST_BUFSIZE LIT_BUFSIZE
1391#endif
1392/* Sizes of match buffers for literals/lengths and distances. There are
1393 * 4 reasons for limiting LIT_BUFSIZE to 64K:
1394 * - frequencies can be kept in 16 bit counters
1395 * - if compression is not successful for the first block, all input data is
1396 * still in the window so we can still emit a stored block even when input
1397 * comes from standard input. (This can also be done for all blocks if
1398 * LIT_BUFSIZE is not greater than 32K.)
1399 * - if compression is not successful for a file smaller than 64K, we can
1400 * even emit a stored file instead of a stored block (saving 5 bytes).
1401 * - creating new Huffman trees less frequently may not provide fast
1402 * adaptation to changes in the input data statistics. (Take for
1403 * example a binary file with poorly compressible code followed by
1404 * a highly compressible string table.) Smaller buffer sizes give
1405 * fast adaptation but have of course the overhead of transmitting trees
1406 * more frequently.
1407 * - I can't count above 4
1408 * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
1409 * memory at the expense of compression). Some optimizations would be possible
1410 * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
1411 */
1412#if LIT_BUFSIZE > INBUFSIZ
Aaron Lehmannb9df4702001-12-06 03:22:43 +00001413#error cannot overlay l_buf and inbuf
Eric Andersencc8ed391999-10-05 16:24:54 +00001414#endif
Eric Andersencc8ed391999-10-05 16:24:54 +00001415#define REP_3_6 16
1416/* repeat previous bit length 3-6 times (2 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001417#define REPZ_3_10 17
1418/* repeat a zero length 3-10 times (3 bits of repeat count) */
Eric Andersencc8ed391999-10-05 16:24:54 +00001419#define REPZ_11_138 18
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001420/* repeat a zero length 11-138 times (7 bits of repeat count) */
1421
1422/* ===========================================================================
Eric Andersencc8ed391999-10-05 16:24:54 +00001423 * Local data
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001424 */
1425
1426/* Data structure describing a single value and its code string. */
1427typedef struct ct_data {
Erik Andersene49d5ec2000-02-08 19:58:47 +00001428 union {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001429 ush freq; /* frequency count */
1430 ush code; /* bit string */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001431 } fc;
1432 union {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001433 ush dad; /* father node in Huffman tree */
1434 ush len; /* length of bit string */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001435 } dl;
Eric Andersencc8ed391999-10-05 16:24:54 +00001436} ct_data;
1437
1438#define Freq fc.freq
1439#define Code fc.code
1440#define Dad dl.dad
1441#define Len dl.len
1442
1443#define HEAP_SIZE (2*L_CODES+1)
1444/* maximum heap size */
1445
Eric Andersen3073dfb2001-07-02 17:57:32 +00001446static ct_data dyn_ltree[HEAP_SIZE]; /* literal and length tree */
1447static ct_data dyn_dtree[2 * D_CODES + 1]; /* distance tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001448
Eric Andersen3073dfb2001-07-02 17:57:32 +00001449static ct_data static_ltree[L_CODES + 2];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001450
Eric Andersencc8ed391999-10-05 16:24:54 +00001451/* The static literal tree. Since the bit lengths are imposed, there is no
1452 * need for the L_CODES extra codes used during heap construction. However
1453 * The codes 286 and 287 are needed to build a canonical tree (see ct_init
1454 * below).
1455 */
1456
Eric Andersen3073dfb2001-07-02 17:57:32 +00001457static ct_data static_dtree[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001458
Eric Andersencc8ed391999-10-05 16:24:54 +00001459/* The static distance tree. (Actually a trivial tree since all codes use
1460 * 5 bits.)
1461 */
1462
Eric Andersen3073dfb2001-07-02 17:57:32 +00001463static ct_data bl_tree[2 * BL_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001464
Eric Andersencc8ed391999-10-05 16:24:54 +00001465/* Huffman tree for the bit lengths */
1466
1467typedef struct tree_desc {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001468 ct_data *dyn_tree; /* the dynamic tree */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001469 ct_data *static_tree; /* corresponding static tree or NULL */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001470 const extra_bits_t *extra_bits; /* extra bits for each code or NULL */
1471 int extra_base; /* base index for extra_bits */
1472 int elems; /* max number of elements in the tree */
1473 int max_length; /* max bit length for the codes */
1474 int max_code; /* largest code with non zero frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00001475} tree_desc;
1476
Eric Andersen3073dfb2001-07-02 17:57:32 +00001477static tree_desc l_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001478 { dyn_ltree, static_ltree, extra_lbits, LITERALS + 1, L_CODES,
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001479 MAX_BITS, 0
1480};
Eric Andersencc8ed391999-10-05 16:24:54 +00001481
Eric Andersen3073dfb2001-07-02 17:57:32 +00001482static tree_desc d_desc =
Erik Andersene49d5ec2000-02-08 19:58:47 +00001483 { dyn_dtree, static_dtree, extra_dbits, 0, D_CODES, MAX_BITS, 0 };
Eric Andersencc8ed391999-10-05 16:24:54 +00001484
Eric Andersen3073dfb2001-07-02 17:57:32 +00001485static tree_desc bl_desc =
1486 { bl_tree, (ct_data *) 0, extra_blbits, 0, BL_CODES, MAX_BL_BITS,
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001487 0
1488};
Eric Andersencc8ed391999-10-05 16:24:54 +00001489
1490
Eric Andersen3073dfb2001-07-02 17:57:32 +00001491static ush bl_count[MAX_BITS + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001492
Eric Andersencc8ed391999-10-05 16:24:54 +00001493/* number of codes at each bit length for an optimal tree */
1494
Eric Andersen3073dfb2001-07-02 17:57:32 +00001495static const uch bl_order[BL_CODES]
Erik Andersene49d5ec2000-02-08 19:58:47 +00001496= { 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
1497
Eric Andersencc8ed391999-10-05 16:24:54 +00001498/* The lengths of the bit length codes are sent in order of decreasing
1499 * probability, to avoid transmitting the lengths for unused bit length codes.
1500 */
1501
Eric Andersen3073dfb2001-07-02 17:57:32 +00001502static int heap[2 * L_CODES + 1]; /* heap used to build the Huffman trees */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001503static int heap_len; /* number of elements in the heap */
1504static int heap_max; /* element of largest frequency */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001505
Eric Andersencc8ed391999-10-05 16:24:54 +00001506/* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
1507 * The same heap array is used to build all trees.
1508 */
1509
Eric Andersen3073dfb2001-07-02 17:57:32 +00001510static uch depth[2 * L_CODES + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001511
Eric Andersencc8ed391999-10-05 16:24:54 +00001512/* Depth of each subtree used as tie breaker for trees of equal frequency */
1513
Eric Andersen3073dfb2001-07-02 17:57:32 +00001514static uch length_code[MAX_MATCH - MIN_MATCH + 1];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001515
Eric Andersencc8ed391999-10-05 16:24:54 +00001516/* length code for each normalized match length (0 == MIN_MATCH) */
1517
Eric Andersen3073dfb2001-07-02 17:57:32 +00001518static uch dist_code[512];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001519
Eric Andersencc8ed391999-10-05 16:24:54 +00001520/* distance codes. The first 256 values correspond to the distances
1521 * 3 .. 258, the last 256 values correspond to the top 8 bits of
1522 * the 15 bit distances.
1523 */
1524
Eric Andersen3073dfb2001-07-02 17:57:32 +00001525static int base_length[LENGTH_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001526
Eric Andersencc8ed391999-10-05 16:24:54 +00001527/* First normalized length for each code (0 = MIN_MATCH) */
1528
Eric Andersen3073dfb2001-07-02 17:57:32 +00001529static int base_dist[D_CODES];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001530
Eric Andersencc8ed391999-10-05 16:24:54 +00001531/* First normalized distance for each code (0 = distance of 1) */
1532
1533#define l_buf inbuf
1534/* DECLARE(uch, l_buf, LIT_BUFSIZE); buffer for literals or lengths */
1535
1536/* DECLARE(ush, d_buf, DIST_BUFSIZE); buffer for distances */
1537
Eric Andersen3073dfb2001-07-02 17:57:32 +00001538static uch flag_buf[(LIT_BUFSIZE / 8)];
Erik Andersene49d5ec2000-02-08 19:58:47 +00001539
Eric Andersencc8ed391999-10-05 16:24:54 +00001540/* flag_buf is a bit array distinguishing literals from lengths in
1541 * l_buf, thus indicating the presence or absence of a distance.
1542 */
1543
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001544static unsigned last_lit; /* running index in l_buf */
1545static unsigned last_dist; /* running index in d_buf */
1546static unsigned last_flags; /* running index in flag_buf */
1547static uch flags; /* current flags not yet saved in flag_buf */
1548static uch flag_bit; /* current bit used in flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001549
Eric Andersencc8ed391999-10-05 16:24:54 +00001550/* bits are filled in flags starting at bit 0 (least significant).
1551 * Note: these flags are overkill in the current code since we don't
1552 * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
1553 */
1554
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001555static ulg opt_len; /* bit length of current block with optimal trees */
1556static ulg static_len; /* bit length of current block with static trees */
Eric Andersencc8ed391999-10-05 16:24:54 +00001557
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001558static ulg compressed_len; /* total bit length of compressed file */
Eric Andersencc8ed391999-10-05 16:24:54 +00001559
Erik Andersene49d5ec2000-02-08 19:58:47 +00001560
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001561static ush *file_type; /* pointer to UNKNOWN, BINARY or ASCII */
1562static int *file_method; /* pointer to DEFLATE or STORE */
Eric Andersencc8ed391999-10-05 16:24:54 +00001563
1564/* ===========================================================================
1565 * Local (static) routines in this file.
1566 */
1567
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001568static void init_block(void);
1569static void pqdownheap(ct_data * tree, int k);
1570static void gen_bitlen(tree_desc * desc);
1571static void gen_codes(ct_data * tree, int max_code);
1572static void build_tree(tree_desc * desc);
1573static void scan_tree(ct_data * tree, int max_code);
1574static void send_tree(ct_data * tree, int max_code);
1575static int build_bl_tree(void);
1576static void send_all_trees(int lcodes, int dcodes, int blcodes);
1577static void compress_block(ct_data * ltree, ct_data * dtree);
1578static void set_file_type(void);
Eric Andersencc8ed391999-10-05 16:24:54 +00001579
1580
1581#ifndef DEBUG
1582# define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
1583 /* Send a code of the given tree. c and tree must not have side effects */
1584
Erik Andersene49d5ec2000-02-08 19:58:47 +00001585#else /* DEBUG */
Eric Andersencc8ed391999-10-05 16:24:54 +00001586# define send_code(c, tree) \
Manuel Novoa III cad53642003-03-19 09:13:01 +00001587 { if (verbose>1) bb_error_msg("\ncd %3d ",(c)); \
Eric Andersencc8ed391999-10-05 16:24:54 +00001588 send_bits(tree[c].Code, tree[c].Len); }
1589#endif
1590
1591#define d_code(dist) \
1592 ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
1593/* Mapping from a distance to a distance code. dist is the distance - 1 and
1594 * must not have side effects. dist_code[256] and dist_code[257] are never
1595 * used.
1596 */
1597
Eric Andersencc8ed391999-10-05 16:24:54 +00001598/* the arguments must not have side effects */
1599
1600/* ===========================================================================
1601 * Allocate the match buffer, initialize the various tables and save the
1602 * location of the internal file attribute (ascii/binary) and method
1603 * (DEFLATE/STORE).
1604 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001605static void ct_init(ush * attr, int *methodp)
Eric Andersencc8ed391999-10-05 16:24:54 +00001606{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001607 int n; /* iterates over tree elements */
1608 int bits; /* bit counter */
1609 int length; /* length value */
1610 int code; /* code value */
1611 int dist; /* distance index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001612
Erik Andersene49d5ec2000-02-08 19:58:47 +00001613 file_type = attr;
1614 file_method = methodp;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001615 compressed_len = 0L;
Eric Andersencc8ed391999-10-05 16:24:54 +00001616
Erik Andersene49d5ec2000-02-08 19:58:47 +00001617 if (static_dtree[0].Len != 0)
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001618 return; /* ct_init already called */
Eric Andersencc8ed391999-10-05 16:24:54 +00001619
Erik Andersene49d5ec2000-02-08 19:58:47 +00001620 /* Initialize the mapping length (0..255) -> length code (0..28) */
1621 length = 0;
1622 for (code = 0; code < LENGTH_CODES - 1; code++) {
1623 base_length[code] = length;
1624 for (n = 0; n < (1 << extra_lbits[code]); n++) {
1625 length_code[length++] = (uch) code;
1626 }
1627 }
1628 Assert(length == 256, "ct_init: length != 256");
1629 /* Note that the length 255 (match length 258) can be represented
1630 * in two different ways: code 284 + 5 bits or code 285, so we
1631 * overwrite length_code[255] to use the best encoding:
1632 */
1633 length_code[length - 1] = (uch) code;
Eric Andersencc8ed391999-10-05 16:24:54 +00001634
Erik Andersene49d5ec2000-02-08 19:58:47 +00001635 /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1636 dist = 0;
1637 for (code = 0; code < 16; code++) {
1638 base_dist[code] = dist;
1639 for (n = 0; n < (1 << extra_dbits[code]); n++) {
1640 dist_code[dist++] = (uch) code;
1641 }
1642 }
1643 Assert(dist == 256, "ct_init: dist != 256");
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001644 dist >>= 7; /* from now on, all distances are divided by 128 */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001645 for (; code < D_CODES; code++) {
1646 base_dist[code] = dist << 7;
1647 for (n = 0; n < (1 << (extra_dbits[code] - 7)); n++) {
1648 dist_code[256 + dist++] = (uch) code;
1649 }
1650 }
1651 Assert(dist == 256, "ct_init: 256+dist != 512");
Eric Andersencc8ed391999-10-05 16:24:54 +00001652
Erik Andersene49d5ec2000-02-08 19:58:47 +00001653 /* Construct the codes of the static literal tree */
1654 for (bits = 0; bits <= MAX_BITS; bits++)
1655 bl_count[bits] = 0;
1656 n = 0;
1657 while (n <= 143)
1658 static_ltree[n++].Len = 8, bl_count[8]++;
1659 while (n <= 255)
1660 static_ltree[n++].Len = 9, bl_count[9]++;
1661 while (n <= 279)
1662 static_ltree[n++].Len = 7, bl_count[7]++;
1663 while (n <= 287)
1664 static_ltree[n++].Len = 8, bl_count[8]++;
1665 /* Codes 286 and 287 do not exist, but we must include them in the
1666 * tree construction to get a canonical Huffman tree (longest code
1667 * all ones)
1668 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001669 gen_codes((ct_data *) static_ltree, L_CODES + 1);
Eric Andersencc8ed391999-10-05 16:24:54 +00001670
Erik Andersene49d5ec2000-02-08 19:58:47 +00001671 /* The static distance tree is trivial: */
1672 for (n = 0; n < D_CODES; n++) {
1673 static_dtree[n].Len = 5;
1674 static_dtree[n].Code = bi_reverse(n, 5);
1675 }
1676
1677 /* Initialize the first block of the first file: */
1678 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00001679}
1680
1681/* ===========================================================================
1682 * Initialize a new block.
1683 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +00001684static void init_block(void)
Eric Andersencc8ed391999-10-05 16:24:54 +00001685{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001686 int n; /* iterates over tree elements */
Eric Andersencc8ed391999-10-05 16:24:54 +00001687
Erik Andersene49d5ec2000-02-08 19:58:47 +00001688 /* Initialize the trees. */
1689 for (n = 0; n < L_CODES; n++)
1690 dyn_ltree[n].Freq = 0;
1691 for (n = 0; n < D_CODES; n++)
1692 dyn_dtree[n].Freq = 0;
1693 for (n = 0; n < BL_CODES; n++)
1694 bl_tree[n].Freq = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001695
Erik Andersene49d5ec2000-02-08 19:58:47 +00001696 dyn_ltree[END_BLOCK].Freq = 1;
1697 opt_len = static_len = 0L;
1698 last_lit = last_dist = last_flags = 0;
1699 flags = 0;
1700 flag_bit = 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00001701}
1702
1703#define SMALLEST 1
1704/* Index within the heap array of least frequent node in the Huffman tree */
1705
1706
1707/* ===========================================================================
1708 * Remove the smallest element from the heap and recreate the heap with
1709 * one less element. Updates heap and heap_len.
1710 */
1711#define pqremove(tree, top) \
1712{\
1713 top = heap[SMALLEST]; \
1714 heap[SMALLEST] = heap[heap_len--]; \
1715 pqdownheap(tree, SMALLEST); \
1716}
1717
1718/* ===========================================================================
1719 * Compares to subtrees, using the tree depth as tie breaker when
1720 * the subtrees have equal frequency. This minimizes the worst case length.
1721 */
1722#define smaller(tree, n, m) \
1723 (tree[n].Freq < tree[m].Freq || \
1724 (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
1725
1726/* ===========================================================================
1727 * Restore the heap property by moving down the tree starting at node k,
1728 * exchanging a node with the smallest of its two sons if necessary, stopping
1729 * when the heap property is re-established (each father smaller than its
1730 * two sons).
1731 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001732static void pqdownheap(ct_data * tree, int k)
Eric Andersencc8ed391999-10-05 16:24:54 +00001733{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001734 int v = heap[k];
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001735 int j = k << 1; /* left son of k */
Eric Andersencc8ed391999-10-05 16:24:54 +00001736
Erik Andersene49d5ec2000-02-08 19:58:47 +00001737 while (j <= heap_len) {
1738 /* Set j to the smallest of the two sons: */
1739 if (j < heap_len && smaller(tree, heap[j + 1], heap[j]))
1740 j++;
Eric Andersencc8ed391999-10-05 16:24:54 +00001741
Erik Andersene49d5ec2000-02-08 19:58:47 +00001742 /* Exit if v is smaller than both sons */
1743 if (smaller(tree, v, heap[j]))
1744 break;
Eric Andersencc8ed391999-10-05 16:24:54 +00001745
Erik Andersene49d5ec2000-02-08 19:58:47 +00001746 /* Exchange v with the smallest son */
1747 heap[k] = heap[j];
1748 k = j;
1749
1750 /* And continue down the tree, setting j to the left son of k */
1751 j <<= 1;
1752 }
1753 heap[k] = v;
Eric Andersencc8ed391999-10-05 16:24:54 +00001754}
1755
1756/* ===========================================================================
1757 * Compute the optimal bit lengths for a tree and update the total bit length
1758 * for the current block.
1759 * IN assertion: the fields freq and dad are set, heap[heap_max] and
1760 * above are the tree nodes sorted by increasing frequency.
1761 * OUT assertions: the field len is set to the optimal bit length, the
1762 * array bl_count contains the frequencies for each bit length.
1763 * The length opt_len is updated; static_len is also updated if stree is
1764 * not null.
1765 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001766static void gen_bitlen(tree_desc * desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001767{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001768 ct_data *tree = desc->dyn_tree;
Eric Andersen39eb0402001-08-22 04:15:47 +00001769 const extra_bits_t *extra = desc->extra_bits;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001770 int base = desc->extra_base;
1771 int max_code = desc->max_code;
1772 int max_length = desc->max_length;
Eric Andersen3073dfb2001-07-02 17:57:32 +00001773 ct_data *stree = desc->static_tree;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001774 int h; /* heap index */
1775 int n, m; /* iterate over the tree elements */
1776 int bits; /* bit length */
1777 int xbits; /* extra bits */
1778 ush f; /* frequency */
1779 int overflow = 0; /* number of elements with bit length too large */
Eric Andersencc8ed391999-10-05 16:24:54 +00001780
Erik Andersene49d5ec2000-02-08 19:58:47 +00001781 for (bits = 0; bits <= MAX_BITS; bits++)
1782 bl_count[bits] = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00001783
Erik Andersene49d5ec2000-02-08 19:58:47 +00001784 /* In a first pass, compute the optimal bit lengths (which may
1785 * overflow in the case of the bit length tree).
1786 */
1787 tree[heap[heap_max]].Len = 0; /* root of the heap */
Eric Andersencc8ed391999-10-05 16:24:54 +00001788
Erik Andersene49d5ec2000-02-08 19:58:47 +00001789 for (h = heap_max + 1; h < HEAP_SIZE; h++) {
1790 n = heap[h];
1791 bits = tree[tree[n].Dad].Len + 1;
1792 if (bits > max_length)
1793 bits = max_length, overflow++;
1794 tree[n].Len = (ush) bits;
1795 /* We overwrite tree[n].Dad which is no longer needed */
Eric Andersencc8ed391999-10-05 16:24:54 +00001796
Erik Andersene49d5ec2000-02-08 19:58:47 +00001797 if (n > max_code)
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001798 continue; /* not a leaf node */
Eric Andersencc8ed391999-10-05 16:24:54 +00001799
Erik Andersene49d5ec2000-02-08 19:58:47 +00001800 bl_count[bits]++;
1801 xbits = 0;
1802 if (n >= base)
1803 xbits = extra[n - base];
1804 f = tree[n].Freq;
1805 opt_len += (ulg) f *(bits + xbits);
Eric Andersencc8ed391999-10-05 16:24:54 +00001806
Erik Andersene49d5ec2000-02-08 19:58:47 +00001807 if (stree)
1808 static_len += (ulg) f *(stree[n].Len + xbits);
1809 }
1810 if (overflow == 0)
1811 return;
Eric Andersencc8ed391999-10-05 16:24:54 +00001812
Erik Andersene49d5ec2000-02-08 19:58:47 +00001813 Trace((stderr, "\nbit length overflow\n"));
1814 /* This happens for example on obj2 and pic of the Calgary corpus */
Eric Andersencc8ed391999-10-05 16:24:54 +00001815
Erik Andersene49d5ec2000-02-08 19:58:47 +00001816 /* Find the first bit length which could increase: */
1817 do {
1818 bits = max_length - 1;
1819 while (bl_count[bits] == 0)
1820 bits--;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001821 bl_count[bits]--; /* move one leaf down the tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001822 bl_count[bits + 1] += 2; /* move one overflow item as its brother */
1823 bl_count[max_length]--;
1824 /* The brother of the overflow item also moves one step up,
1825 * but this does not affect bl_count[max_length]
1826 */
1827 overflow -= 2;
1828 } while (overflow > 0);
1829
1830 /* Now recompute all bit lengths, scanning in increasing frequency.
1831 * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1832 * lengths instead of fixing only the wrong ones. This idea is taken
1833 * from 'ar' written by Haruhiko Okumura.)
1834 */
1835 for (bits = max_length; bits != 0; bits--) {
1836 n = bl_count[bits];
1837 while (n != 0) {
1838 m = heap[--h];
1839 if (m > max_code)
1840 continue;
1841 if (tree[m].Len != (unsigned) bits) {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001842 Trace((stderr, "code %d bits %d->%d\n", m, tree[m].Len,
Erik Andersene49d5ec2000-02-08 19:58:47 +00001843 bits));
1844 opt_len +=
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001845 ((long) bits - (long) tree[m].Len) * (long) tree[m].Freq;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001846 tree[m].Len = (ush) bits;
1847 }
1848 n--;
1849 }
1850 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001851}
1852
1853/* ===========================================================================
1854 * Generate the codes for a given tree and bit counts (which need not be
1855 * optimal).
1856 * IN assertion: the array bl_count contains the bit length statistics for
1857 * the given tree and the field len is set for all tree elements.
1858 * OUT assertion: the field code is set for all tree elements of non
1859 * zero code length.
1860 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001861static void gen_codes(ct_data * tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001862{
Erik Andersene49d5ec2000-02-08 19:58:47 +00001863 ush next_code[MAX_BITS + 1]; /* next code value for each bit length */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001864 ush code = 0; /* running code value */
1865 int bits; /* bit index */
1866 int n; /* code index */
Eric Andersencc8ed391999-10-05 16:24:54 +00001867
Erik Andersene49d5ec2000-02-08 19:58:47 +00001868 /* The distribution counts are first used to generate the code values
1869 * without bit reversal.
1870 */
1871 for (bits = 1; bits <= MAX_BITS; bits++) {
1872 next_code[bits] = code = (code + bl_count[bits - 1]) << 1;
1873 }
1874 /* Check that the bit counts in bl_count are consistent. The last code
1875 * must be all ones.
1876 */
1877 Assert(code + bl_count[MAX_BITS] - 1 == (1 << MAX_BITS) - 1,
1878 "inconsistent bit counts");
1879 Tracev((stderr, "\ngen_codes: max_code %d ", max_code));
Eric Andersencc8ed391999-10-05 16:24:54 +00001880
Erik Andersene49d5ec2000-02-08 19:58:47 +00001881 for (n = 0; n <= max_code; n++) {
1882 int len = tree[n].Len;
Eric Andersencc8ed391999-10-05 16:24:54 +00001883
Erik Andersene49d5ec2000-02-08 19:58:47 +00001884 if (len == 0)
1885 continue;
1886 /* Now reverse the bits */
1887 tree[n].Code = bi_reverse(next_code[len]++, len);
1888
1889 Tracec(tree != static_ltree,
1890 (stderr, "\nn %3d %c l %2d c %4x (%x) ", n,
1891 (isgraph(n) ? n : ' '), len, tree[n].Code,
1892 next_code[len] - 1));
1893 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001894}
1895
1896/* ===========================================================================
1897 * Construct one Huffman tree and assigns the code bit strings and lengths.
1898 * Update the total bit length for the current block.
1899 * IN assertion: the field freq is set for all tree elements.
1900 * OUT assertions: the fields len and code are set to the optimal bit length
1901 * and corresponding code. The length opt_len is updated; static_len is
1902 * also updated if stree is not null. The field max_code is set.
1903 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001904static void build_tree(tree_desc * desc)
Eric Andersencc8ed391999-10-05 16:24:54 +00001905{
Eric Andersen3073dfb2001-07-02 17:57:32 +00001906 ct_data *tree = desc->dyn_tree;
1907 ct_data *stree = desc->static_tree;
Erik Andersene49d5ec2000-02-08 19:58:47 +00001908 int elems = desc->elems;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001909 int n, m; /* iterate over heap elements */
1910 int max_code = -1; /* largest code with non zero frequency */
1911 int node = elems; /* next internal node of the tree */
Eric Andersencc8ed391999-10-05 16:24:54 +00001912
Erik Andersene49d5ec2000-02-08 19:58:47 +00001913 /* Construct the initial heap, with least frequent element in
1914 * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1915 * heap[0] is not used.
1916 */
1917 heap_len = 0, heap_max = HEAP_SIZE;
Eric Andersencc8ed391999-10-05 16:24:54 +00001918
Erik Andersene49d5ec2000-02-08 19:58:47 +00001919 for (n = 0; n < elems; n++) {
1920 if (tree[n].Freq != 0) {
1921 heap[++heap_len] = max_code = n;
1922 depth[n] = 0;
1923 } else {
1924 tree[n].Len = 0;
1925 }
1926 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001927
Erik Andersene49d5ec2000-02-08 19:58:47 +00001928 /* The pkzip format requires that at least one distance code exists,
1929 * and that at least one bit should be sent even if there is only one
1930 * possible code. So to avoid special checks later on we force at least
1931 * two codes of non zero frequency.
1932 */
1933 while (heap_len < 2) {
1934 int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00001935
Erik Andersene49d5ec2000-02-08 19:58:47 +00001936 tree[new].Freq = 1;
1937 depth[new] = 0;
1938 opt_len--;
1939 if (stree)
1940 static_len -= stree[new].Len;
1941 /* new is 0 or 1 so it does not have extra bits */
1942 }
1943 desc->max_code = max_code;
Eric Andersencc8ed391999-10-05 16:24:54 +00001944
Erik Andersene49d5ec2000-02-08 19:58:47 +00001945 /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
1946 * establish sub-heaps of increasing lengths:
1947 */
1948 for (n = heap_len / 2; n >= 1; n--)
1949 pqdownheap(tree, n);
Eric Andersencc8ed391999-10-05 16:24:54 +00001950
Erik Andersene49d5ec2000-02-08 19:58:47 +00001951 /* Construct the Huffman tree by repeatedly combining the least two
1952 * frequent nodes.
1953 */
1954 do {
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001955 pqremove(tree, n); /* n = node of least frequency */
1956 m = heap[SMALLEST]; /* m = node of next least frequency */
Eric Andersencc8ed391999-10-05 16:24:54 +00001957
Erik Andersene49d5ec2000-02-08 19:58:47 +00001958 heap[--heap_max] = n; /* keep the nodes sorted by frequency */
1959 heap[--heap_max] = m;
1960
1961 /* Create a new node father of n and m */
1962 tree[node].Freq = tree[n].Freq + tree[m].Freq;
1963 depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
1964 tree[n].Dad = tree[m].Dad = (ush) node;
Eric Andersencc8ed391999-10-05 16:24:54 +00001965#ifdef DUMP_BL_TREE
Erik Andersene49d5ec2000-02-08 19:58:47 +00001966 if (tree == bl_tree) {
Manuel Novoa III cad53642003-03-19 09:13:01 +00001967 bb_error_msg("\nnode %d(%d), sons %d(%d) %d(%d)",
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001968 node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
Erik Andersene49d5ec2000-02-08 19:58:47 +00001969 }
Eric Andersencc8ed391999-10-05 16:24:54 +00001970#endif
Erik Andersene49d5ec2000-02-08 19:58:47 +00001971 /* and insert the new node in the heap */
1972 heap[SMALLEST] = node++;
1973 pqdownheap(tree, SMALLEST);
Eric Andersencc8ed391999-10-05 16:24:54 +00001974
Erik Andersene49d5ec2000-02-08 19:58:47 +00001975 } while (heap_len >= 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00001976
Erik Andersene49d5ec2000-02-08 19:58:47 +00001977 heap[--heap_max] = heap[SMALLEST];
Eric Andersencc8ed391999-10-05 16:24:54 +00001978
Erik Andersene49d5ec2000-02-08 19:58:47 +00001979 /* At this point, the fields freq and dad are set. We can now
1980 * generate the bit lengths.
1981 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001982 gen_bitlen((tree_desc *) desc);
Eric Andersencc8ed391999-10-05 16:24:54 +00001983
Erik Andersene49d5ec2000-02-08 19:58:47 +00001984 /* The field len is now set, we can generate the bit codes */
Eric Andersen3073dfb2001-07-02 17:57:32 +00001985 gen_codes((ct_data *) tree, max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00001986}
1987
1988/* ===========================================================================
1989 * Scan a literal or distance tree to determine the frequencies of the codes
1990 * in the bit length tree. Updates opt_len to take into account the repeat
1991 * counts. (The contribution of the bit length codes will be added later
1992 * during the construction of bl_tree.)
1993 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001994static void scan_tree(ct_data * tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00001995{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00001996 int n; /* iterates over all tree elements */
1997 int prevlen = -1; /* last emitted length */
1998 int curlen; /* length of current code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00001999 int nextlen = tree[0].Len; /* length of next code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002000 int count = 0; /* repeat count of the current code */
2001 int max_count = 7; /* max repeat count */
2002 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002003
Erik Andersene49d5ec2000-02-08 19:58:47 +00002004 if (nextlen == 0)
2005 max_count = 138, min_count = 3;
2006 tree[max_code + 1].Len = (ush) 0xffff; /* guard */
Eric Andersencc8ed391999-10-05 16:24:54 +00002007
Erik Andersene49d5ec2000-02-08 19:58:47 +00002008 for (n = 0; n <= max_code; n++) {
2009 curlen = nextlen;
2010 nextlen = tree[n + 1].Len;
2011 if (++count < max_count && curlen == nextlen) {
2012 continue;
2013 } else if (count < min_count) {
2014 bl_tree[curlen].Freq += count;
2015 } else if (curlen != 0) {
2016 if (curlen != prevlen)
2017 bl_tree[curlen].Freq++;
2018 bl_tree[REP_3_6].Freq++;
2019 } else if (count <= 10) {
2020 bl_tree[REPZ_3_10].Freq++;
2021 } else {
2022 bl_tree[REPZ_11_138].Freq++;
2023 }
2024 count = 0;
2025 prevlen = curlen;
2026 if (nextlen == 0) {
2027 max_count = 138, min_count = 3;
2028 } else if (curlen == nextlen) {
2029 max_count = 6, min_count = 3;
2030 } else {
2031 max_count = 7, min_count = 4;
2032 }
2033 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002034}
2035
2036/* ===========================================================================
2037 * Send a literal or distance tree in compressed form, using the codes in
2038 * bl_tree.
2039 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002040static void send_tree(ct_data * tree, int max_code)
Eric Andersencc8ed391999-10-05 16:24:54 +00002041{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002042 int n; /* iterates over all tree elements */
2043 int prevlen = -1; /* last emitted length */
2044 int curlen; /* length of current code */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002045 int nextlen = tree[0].Len; /* length of next code */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002046 int count = 0; /* repeat count of the current code */
2047 int max_count = 7; /* max repeat count */
2048 int min_count = 4; /* min repeat count */
Eric Andersencc8ed391999-10-05 16:24:54 +00002049
Erik Andersene49d5ec2000-02-08 19:58:47 +00002050/* tree[max_code+1].Len = -1; *//* guard already set */
2051 if (nextlen == 0)
2052 max_count = 138, min_count = 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002053
Erik Andersene49d5ec2000-02-08 19:58:47 +00002054 for (n = 0; n <= max_code; n++) {
2055 curlen = nextlen;
2056 nextlen = tree[n + 1].Len;
2057 if (++count < max_count && curlen == nextlen) {
2058 continue;
2059 } else if (count < min_count) {
2060 do {
2061 send_code(curlen, bl_tree);
2062 } while (--count != 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002063
Erik Andersene49d5ec2000-02-08 19:58:47 +00002064 } else if (curlen != 0) {
2065 if (curlen != prevlen) {
2066 send_code(curlen, bl_tree);
2067 count--;
2068 }
2069 Assert(count >= 3 && count <= 6, " 3_6?");
2070 send_code(REP_3_6, bl_tree);
2071 send_bits(count - 3, 2);
Eric Andersencc8ed391999-10-05 16:24:54 +00002072
Erik Andersene49d5ec2000-02-08 19:58:47 +00002073 } else if (count <= 10) {
2074 send_code(REPZ_3_10, bl_tree);
2075 send_bits(count - 3, 3);
Eric Andersencc8ed391999-10-05 16:24:54 +00002076
Erik Andersene49d5ec2000-02-08 19:58:47 +00002077 } else {
2078 send_code(REPZ_11_138, bl_tree);
2079 send_bits(count - 11, 7);
2080 }
2081 count = 0;
2082 prevlen = curlen;
2083 if (nextlen == 0) {
2084 max_count = 138, min_count = 3;
2085 } else if (curlen == nextlen) {
2086 max_count = 6, min_count = 3;
2087 } else {
2088 max_count = 7, min_count = 4;
2089 }
2090 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002091}
2092
2093/* ===========================================================================
2094 * Construct the Huffman tree for the bit lengths and return the index in
2095 * bl_order of the last bit length code to send.
2096 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +00002097static int build_bl_tree(void)
Eric Andersencc8ed391999-10-05 16:24:54 +00002098{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002099 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002100
Erik Andersene49d5ec2000-02-08 19:58:47 +00002101 /* Determine the bit length frequencies for literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002102 scan_tree((ct_data *) dyn_ltree, l_desc.max_code);
2103 scan_tree((ct_data *) dyn_dtree, d_desc.max_code);
Eric Andersencc8ed391999-10-05 16:24:54 +00002104
Erik Andersene49d5ec2000-02-08 19:58:47 +00002105 /* Build the bit length tree: */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002106 build_tree((tree_desc *) (&bl_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002107 /* opt_len now includes the length of the tree representations, except
2108 * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
2109 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002110
Erik Andersene49d5ec2000-02-08 19:58:47 +00002111 /* Determine the number of bit length codes to send. The pkzip format
2112 * requires that at least 4 bit length codes be sent. (appnote.txt says
2113 * 3 but the actual value used is 4.)
2114 */
2115 for (max_blindex = BL_CODES - 1; max_blindex >= 3; max_blindex--) {
2116 if (bl_tree[bl_order[max_blindex]].Len != 0)
2117 break;
2118 }
2119 /* Update opt_len to include the bit length tree and counts */
2120 opt_len += 3 * (max_blindex + 1) + 5 + 5 + 4;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002121 Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len, static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002122
Erik Andersene49d5ec2000-02-08 19:58:47 +00002123 return max_blindex;
Eric Andersencc8ed391999-10-05 16:24:54 +00002124}
2125
2126/* ===========================================================================
2127 * Send the header for a block using dynamic Huffman trees: the counts, the
2128 * lengths of the bit length codes, the literal tree and the distance tree.
2129 * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
2130 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002131static void send_all_trees(int lcodes, int dcodes, int blcodes)
Eric Andersencc8ed391999-10-05 16:24:54 +00002132{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002133 int rank; /* index in bl_order */
Eric Andersencc8ed391999-10-05 16:24:54 +00002134
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002135 Assert(lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
Erik Andersene49d5ec2000-02-08 19:58:47 +00002136 Assert(lcodes <= L_CODES && dcodes <= D_CODES
2137 && blcodes <= BL_CODES, "too many codes");
2138 Tracev((stderr, "\nbl counts: "));
2139 send_bits(lcodes - 257, 5); /* not +255 as stated in appnote.txt */
2140 send_bits(dcodes - 1, 5);
2141 send_bits(blcodes - 4, 4); /* not -3 as stated in appnote.txt */
2142 for (rank = 0; rank < blcodes; rank++) {
2143 Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
2144 send_bits(bl_tree[bl_order[rank]].Len, 3);
2145 }
2146 Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002147
Eric Andersen3073dfb2001-07-02 17:57:32 +00002148 send_tree((ct_data *) dyn_ltree, lcodes - 1); /* send the literal tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002149 Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002150
Eric Andersen3073dfb2001-07-02 17:57:32 +00002151 send_tree((ct_data *) dyn_dtree, dcodes - 1); /* send the distance tree */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002152 Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
Eric Andersencc8ed391999-10-05 16:24:54 +00002153}
2154
2155/* ===========================================================================
2156 * Determine the best encoding for the current block: dynamic trees, static
2157 * trees or store, and output the encoded block to the zip file. This function
2158 * returns the total compressed length for the file so far.
2159 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002160static ulg flush_block(char *buf, ulg stored_len, int eof)
Eric Andersencc8ed391999-10-05 16:24:54 +00002161{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002162 ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002163 int max_blindex; /* index of last bit length code of non zero freq */
Eric Andersencc8ed391999-10-05 16:24:54 +00002164
Erik Andersene49d5ec2000-02-08 19:58:47 +00002165 flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
Eric Andersencc8ed391999-10-05 16:24:54 +00002166
Erik Andersene49d5ec2000-02-08 19:58:47 +00002167 /* Check if the file is ascii or binary */
2168 if (*file_type == (ush) UNKNOWN)
2169 set_file_type();
Eric Andersencc8ed391999-10-05 16:24:54 +00002170
Erik Andersene49d5ec2000-02-08 19:58:47 +00002171 /* Construct the literal and distance trees */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002172 build_tree((tree_desc *) (&l_desc));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002173 Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
Eric Andersencc8ed391999-10-05 16:24:54 +00002174
Eric Andersen3073dfb2001-07-02 17:57:32 +00002175 build_tree((tree_desc *) (&d_desc));
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002176 Tracev((stderr, "\ndist data: dyn %ld, stat %ld", opt_len, static_len));
Erik Andersene49d5ec2000-02-08 19:58:47 +00002177 /* At this point, opt_len and static_len are the total bit lengths of
2178 * the compressed block data, excluding the tree representations.
2179 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002180
Erik Andersene49d5ec2000-02-08 19:58:47 +00002181 /* Build the bit length tree for the above two trees, and get the index
2182 * in bl_order of the last bit length code to send.
2183 */
2184 max_blindex = build_bl_tree();
Eric Andersencc8ed391999-10-05 16:24:54 +00002185
Erik Andersene49d5ec2000-02-08 19:58:47 +00002186 /* Determine the best encoding. Compute first the block length in bytes */
2187 opt_lenb = (opt_len + 3 + 7) >> 3;
2188 static_lenb = (static_len + 3 + 7) >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002189
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002190 Trace((stderr,
Erik Andersene49d5ec2000-02-08 19:58:47 +00002191 "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
2192 opt_lenb, opt_len, static_lenb, static_len, stored_len,
2193 last_lit, last_dist));
Eric Andersencc8ed391999-10-05 16:24:54 +00002194
Erik Andersene49d5ec2000-02-08 19:58:47 +00002195 if (static_lenb <= opt_lenb)
2196 opt_lenb = static_lenb;
Eric Andersencc8ed391999-10-05 16:24:54 +00002197
Erik Andersene49d5ec2000-02-08 19:58:47 +00002198 /* If compression failed and this is the first and last block,
2199 * and if the zip file can be seeked (to rewrite the local header),
2200 * the whole file is transformed into a stored file:
2201 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002202 if (stored_len <= opt_lenb && eof && compressed_len == 0L && seekable()) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002203 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
2204 if (buf == (char *) 0)
Manuel Novoa III cad53642003-03-19 09:13:01 +00002205 bb_error_msg("block vanished");
Eric Andersencc8ed391999-10-05 16:24:54 +00002206
Erik Andersene49d5ec2000-02-08 19:58:47 +00002207 copy_block(buf, (unsigned) stored_len, 0); /* without header */
2208 compressed_len = stored_len << 3;
2209 *file_method = STORED;
Eric Andersencc8ed391999-10-05 16:24:54 +00002210
Erik Andersene49d5ec2000-02-08 19:58:47 +00002211 } else if (stored_len + 4 <= opt_lenb && buf != (char *) 0) {
2212 /* 4: two words for the lengths */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002213 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
2214 * Otherwise we can't have processed more than WSIZE input bytes since
2215 * the last block flush, because compression would have been
2216 * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
2217 * transform a block into a stored block.
2218 */
2219 send_bits((STORED_BLOCK << 1) + eof, 3); /* send block type */
2220 compressed_len = (compressed_len + 3 + 7) & ~7L;
2221 compressed_len += (stored_len + 4) << 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002222
Erik Andersene49d5ec2000-02-08 19:58:47 +00002223 copy_block(buf, (unsigned) stored_len, 1); /* with header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002224
Erik Andersene49d5ec2000-02-08 19:58:47 +00002225 } else if (static_lenb == opt_lenb) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002226 send_bits((STATIC_TREES << 1) + eof, 3);
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002227 compress_block((ct_data *) static_ltree, (ct_data *) static_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002228 compressed_len += 3 + static_len;
2229 } else {
2230 send_bits((DYN_TREES << 1) + eof, 3);
2231 send_all_trees(l_desc.max_code + 1, d_desc.max_code + 1,
2232 max_blindex + 1);
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002233 compress_block((ct_data *) dyn_ltree, (ct_data *) dyn_dtree);
Erik Andersene49d5ec2000-02-08 19:58:47 +00002234 compressed_len += 3 + opt_len;
2235 }
2236 Assert(compressed_len == bits_sent, "bad compressed size");
2237 init_block();
Eric Andersencc8ed391999-10-05 16:24:54 +00002238
Erik Andersene49d5ec2000-02-08 19:58:47 +00002239 if (eof) {
Erik Andersene49d5ec2000-02-08 19:58:47 +00002240 bi_windup();
2241 compressed_len += 7; /* align on byte boundary */
2242 }
2243 Tracev((stderr, "\ncomprlen %lu(%lu) ", compressed_len >> 3,
2244 compressed_len - 7 * eof));
Eric Andersencc8ed391999-10-05 16:24:54 +00002245
Erik Andersene49d5ec2000-02-08 19:58:47 +00002246 return compressed_len >> 3;
Eric Andersencc8ed391999-10-05 16:24:54 +00002247}
2248
2249/* ===========================================================================
2250 * Save the match info and tally the frequency counts. Return true if
2251 * the current block must be flushed.
2252 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002253static int ct_tally(int dist, int lc)
Eric Andersencc8ed391999-10-05 16:24:54 +00002254{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002255 l_buf[last_lit++] = (uch) lc;
2256 if (dist == 0) {
2257 /* lc is the unmatched char */
2258 dyn_ltree[lc].Freq++;
2259 } else {
2260 /* Here, lc is the match length - MIN_MATCH */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002261 dist--; /* dist = match distance - 1 */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002262 Assert((ush) dist < (ush) MAX_DIST &&
2263 (ush) lc <= (ush) (MAX_MATCH - MIN_MATCH) &&
2264 (ush) d_code(dist) < (ush) D_CODES, "ct_tally: bad match");
Eric Andersencc8ed391999-10-05 16:24:54 +00002265
Erik Andersene49d5ec2000-02-08 19:58:47 +00002266 dyn_ltree[length_code[lc] + LITERALS + 1].Freq++;
2267 dyn_dtree[d_code(dist)].Freq++;
Eric Andersencc8ed391999-10-05 16:24:54 +00002268
Erik Andersene49d5ec2000-02-08 19:58:47 +00002269 d_buf[last_dist++] = (ush) dist;
2270 flags |= flag_bit;
2271 }
2272 flag_bit <<= 1;
Eric Andersencc8ed391999-10-05 16:24:54 +00002273
Erik Andersene49d5ec2000-02-08 19:58:47 +00002274 /* Output the flags if they fill a byte: */
2275 if ((last_lit & 7) == 0) {
2276 flag_buf[last_flags++] = flags;
2277 flags = 0, flag_bit = 1;
2278 }
2279 /* Try to guess if it is profitable to stop the current block here */
2280 if ((last_lit & 0xfff) == 0) {
2281 /* Compute an upper bound for the compressed length */
2282 ulg out_length = (ulg) last_lit * 8L;
2283 ulg in_length = (ulg) strstart - block_start;
2284 int dcode;
2285
2286 for (dcode = 0; dcode < D_CODES; dcode++) {
2287 out_length +=
2288 (ulg) dyn_dtree[dcode].Freq * (5L + extra_dbits[dcode]);
2289 }
2290 out_length >>= 3;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002291 Trace((stderr,
Erik Andersene49d5ec2000-02-08 19:58:47 +00002292 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
2293 last_lit, last_dist, in_length, out_length,
2294 100L - out_length * 100L / in_length));
2295 if (last_dist < last_lit / 2 && out_length < in_length / 2)
2296 return 1;
2297 }
2298 return (last_lit == LIT_BUFSIZE - 1 || last_dist == DIST_BUFSIZE);
2299 /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
2300 * on 16 bit machines and because stored blocks are restricted to
2301 * 64K-1 bytes.
2302 */
Eric Andersencc8ed391999-10-05 16:24:54 +00002303}
2304
2305/* ===========================================================================
2306 * Send the block data compressed using the given Huffman trees
2307 */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002308static void compress_block(ct_data * ltree, ct_data * dtree)
Eric Andersencc8ed391999-10-05 16:24:54 +00002309{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002310 unsigned dist; /* distance of matched string */
2311 int lc; /* match length or unmatched char (if dist == 0) */
2312 unsigned lx = 0; /* running index in l_buf */
2313 unsigned dx = 0; /* running index in d_buf */
2314 unsigned fx = 0; /* running index in flag_buf */
2315 uch flag = 0; /* current flags */
2316 unsigned code; /* the code to send */
2317 int extra; /* number of extra bits to send */
Eric Andersencc8ed391999-10-05 16:24:54 +00002318
Erik Andersene49d5ec2000-02-08 19:58:47 +00002319 if (last_lit != 0)
2320 do {
2321 if ((lx & 7) == 0)
2322 flag = flag_buf[fx++];
2323 lc = l_buf[lx++];
2324 if ((flag & 1) == 0) {
2325 send_code(lc, ltree); /* send a literal byte */
2326 Tracecv(isgraph(lc), (stderr, " '%c' ", lc));
2327 } else {
2328 /* Here, lc is the match length - MIN_MATCH */
2329 code = length_code[lc];
2330 send_code(code + LITERALS + 1, ltree); /* send the length code */
2331 extra = extra_lbits[code];
2332 if (extra != 0) {
2333 lc -= base_length[code];
2334 send_bits(lc, extra); /* send the extra length bits */
2335 }
2336 dist = d_buf[dx++];
2337 /* Here, dist is the match distance - 1 */
2338 code = d_code(dist);
2339 Assert(code < D_CODES, "bad d_code");
Eric Andersencc8ed391999-10-05 16:24:54 +00002340
Erik Andersene49d5ec2000-02-08 19:58:47 +00002341 send_code(code, dtree); /* send the distance code */
2342 extra = extra_dbits[code];
2343 if (extra != 0) {
2344 dist -= base_dist[code];
2345 send_bits(dist, extra); /* send the extra distance bits */
2346 }
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002347 } /* literal or match pair ? */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002348 flag >>= 1;
2349 } while (lx < last_lit);
Eric Andersencc8ed391999-10-05 16:24:54 +00002350
Erik Andersene49d5ec2000-02-08 19:58:47 +00002351 send_code(END_BLOCK, ltree);
Eric Andersencc8ed391999-10-05 16:24:54 +00002352}
2353
2354/* ===========================================================================
2355 * Set the file type to ASCII or BINARY, using a crude approximation:
2356 * binary if more than 20% of the bytes are <= 6 or >= 128, ascii otherwise.
2357 * IN assertion: the fields freq of dyn_ltree are set and the total of all
2358 * frequencies does not exceed 64K (to fit in an int on 16 bit machines).
2359 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +00002360static void set_file_type(void)
Eric Andersencc8ed391999-10-05 16:24:54 +00002361{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002362 int n = 0;
2363 unsigned ascii_freq = 0;
2364 unsigned bin_freq = 0;
2365
2366 while (n < 7)
2367 bin_freq += dyn_ltree[n++].Freq;
2368 while (n < 128)
2369 ascii_freq += dyn_ltree[n++].Freq;
2370 while (n < LITERALS)
2371 bin_freq += dyn_ltree[n++].Freq;
2372 *file_type = bin_freq > (ascii_freq >> 2) ? BINARY : ASCII;
2373 if (*file_type == BINARY && translate_eol) {
Manuel Novoa III cad53642003-03-19 09:13:01 +00002374 bb_error_msg("-l used on binary file");
Erik Andersene49d5ec2000-02-08 19:58:47 +00002375 }
Eric Andersencc8ed391999-10-05 16:24:54 +00002376}
Erik Andersene49d5ec2000-02-08 19:58:47 +00002377
Eric Andersencc8ed391999-10-05 16:24:54 +00002378/* zip.c -- compress files to the gzip or pkzip format
2379 * Copyright (C) 1992-1993 Jean-loup Gailly
2380 * This is free software; you can redistribute it and/or modify it under the
2381 * terms of the GNU General Public License, see the file COPYING.
2382 */
2383
Eric Andersencc8ed391999-10-05 16:24:54 +00002384
Rob Landleyc57ec372006-04-10 17:07:15 +00002385static uint32_t crc; /* crc on uncompressed file data */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002386static long header_bytes; /* number of bytes in gzip header */
Eric Andersencc8ed391999-10-05 16:24:54 +00002387
Eric Andersen39eb0402001-08-22 04:15:47 +00002388static void put_long(ulg n)
2389{
Aaron Lehmannb9df4702001-12-06 03:22:43 +00002390 put_short((n) & 0xffff);
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002391 put_short(((ulg) (n)) >> 16);
Eric Andersen39eb0402001-08-22 04:15:47 +00002392}
2393
2394/* put_header_byte is used for the compressed output
2395 * - for the initial 4 bytes that can't overflow the buffer.
2396 */
2397#define put_header_byte(c) {outbuf[outcnt++]=(uch)(c);}
2398
Eric Andersencc8ed391999-10-05 16:24:54 +00002399/* ===========================================================================
2400 * Deflate in to out.
2401 * IN assertions: the input and output buffers are cleared.
2402 * The variables time_stamp and save_orig_name are initialized.
2403 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002404static int zip(int in, int out)
Eric Andersencc8ed391999-10-05 16:24:54 +00002405{
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002406 uch my_flags = 0; /* general purpose bit flags */
2407 ush attr = 0; /* ascii/binary flag */
2408 ush deflate_flags = 0; /* pkzip -es, -en or -ex equivalent */
Eric Andersencc8ed391999-10-05 16:24:54 +00002409
Erik Andersene49d5ec2000-02-08 19:58:47 +00002410 ifd = in;
2411 ofd = out;
2412 outcnt = 0;
Eric Andersencc8ed391999-10-05 16:24:54 +00002413
Erik Andersene49d5ec2000-02-08 19:58:47 +00002414 /* Write the header to the gzip file. See algorithm.doc for the format */
Eric Andersencc8ed391999-10-05 16:24:54 +00002415
Eric Andersen96bcfd31999-11-12 01:30:18 +00002416
Erik Andersene49d5ec2000-02-08 19:58:47 +00002417 method = DEFLATED;
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002418 put_header_byte(GZIP_MAGIC[0]); /* magic header */
Eric Andersen39eb0402001-08-22 04:15:47 +00002419 put_header_byte(GZIP_MAGIC[1]);
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002420 put_header_byte(DEFLATED); /* compression method */
Eric Andersencc8ed391999-10-05 16:24:54 +00002421
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002422 put_header_byte(my_flags); /* general flags */
Erik Andersene49d5ec2000-02-08 19:58:47 +00002423 put_long(time_stamp);
Eric Andersencc8ed391999-10-05 16:24:54 +00002424
Erik Andersene49d5ec2000-02-08 19:58:47 +00002425 /* Write deflated file to zip file */
2426 crc = updcrc(0, 0);
Eric Andersencc8ed391999-10-05 16:24:54 +00002427
Erik Andersene49d5ec2000-02-08 19:58:47 +00002428 bi_init(out);
2429 ct_init(&attr, &method);
2430 lm_init(&deflate_flags);
Eric Andersencc8ed391999-10-05 16:24:54 +00002431
Erik Andersene49d5ec2000-02-08 19:58:47 +00002432 put_byte((uch) deflate_flags); /* extra flags */
Glenn L McGrathd827e8b2002-08-22 13:21:26 +00002433 put_byte(OS_CODE); /* OS identifier */
Eric Andersencc8ed391999-10-05 16:24:54 +00002434
Erik Andersene49d5ec2000-02-08 19:58:47 +00002435 header_bytes = (long) outcnt;
Eric Andersencc8ed391999-10-05 16:24:54 +00002436
Erik Andersene49d5ec2000-02-08 19:58:47 +00002437 (void) deflate();
Eric Andersencc8ed391999-10-05 16:24:54 +00002438
Erik Andersene49d5ec2000-02-08 19:58:47 +00002439 /* Write the crc and uncompressed size */
2440 put_long(crc);
2441 put_long(isize);
2442 header_bytes += 2 * sizeof(long);
Eric Andersencc8ed391999-10-05 16:24:54 +00002443
Erik Andersene49d5ec2000-02-08 19:58:47 +00002444 flush_outbuf();
2445 return OK;
Eric Andersencc8ed391999-10-05 16:24:54 +00002446}
2447
2448
2449/* ===========================================================================
2450 * Read a new buffer from the current input file, perform end-of-line
2451 * translation, and update the crc and input file size.
2452 * IN assertion: size >= 2 (for end-of-line translation)
2453 */
Eric Andersen3073dfb2001-07-02 17:57:32 +00002454static int file_read(char *buf, unsigned size)
Eric Andersencc8ed391999-10-05 16:24:54 +00002455{
Erik Andersene49d5ec2000-02-08 19:58:47 +00002456 unsigned len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002457
Erik Andersene49d5ec2000-02-08 19:58:47 +00002458 Assert(insize == 0, "inbuf not empty");
Eric Andersencc8ed391999-10-05 16:24:54 +00002459
Erik Andersene49d5ec2000-02-08 19:58:47 +00002460 len = read(ifd, buf, size);
2461 if (len == (unsigned) (-1) || len == 0)
2462 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002463
Erik Andersene49d5ec2000-02-08 19:58:47 +00002464 crc = updcrc((uch *) buf, len);
2465 isize += (ulg) len;
2466 return (int) len;
Eric Andersencc8ed391999-10-05 16:24:54 +00002467}
Matt Kraai7918e1f2000-11-08 06:52:57 +00002468
2469/* ===========================================================================
2470 * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
2471 * (used for the compressed data only)
2472 */
Mike Frysinger4e5936e2005-04-16 04:30:38 +00002473static void flush_outbuf(void)
Matt Kraai7918e1f2000-11-08 06:52:57 +00002474{
2475 if (outcnt == 0)
2476 return;
2477
2478 write_buf(ofd, (char *) outbuf, outcnt);
Matt Kraai7918e1f2000-11-08 06:52:57 +00002479 outcnt = 0;
2480}