1 /* vi: set sw=4 ts=4: */
3 * Gzip implementation for busybox
5 * Based on GNU gzip Copyright (C) 1992-1993 Jean-loup Gailly.
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."
12 * Adjusted further by Erik Andersen <andersen@codepoet.org> to support
13 * files as well as stdin/stdout, and to generally behave itself wrt
14 * command line handling.
16 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
19 /* big objects in bss:
21 * 00000074 b base_length
22 * 00000078 b base_dist
23 * 00000078 b static_dtree
25 * 000000f4 b dyn_dtree
26 * 00000100 b length_code
27 * 00000200 b dist_code
31 * 00000480 b static_ltree
32 * 000008f4 b dyn_ltree
35 /* TODO: full support for -v for DESKTOP
36 * "/usr/bin/gzip -v a bogus aa" should say:
37 a: 85.1% -- replaced with a.gz
38 gzip: bogus: No such file or directory
39 aa: 85.1% -- replaced with aa.gz
43 #include "unarchive.h"
46 /* ===========================================================================
49 /* Diagnostic functions */
51 # define Assert(cond,msg) { if (!(cond)) bb_error_msg(msg); }
52 # define Trace(x) fprintf x
53 # define Tracev(x) {if (verbose) fprintf x; }
54 # define Tracevv(x) {if (verbose > 1) fprintf x; }
55 # define Tracec(c,x) {if (verbose && (c)) fprintf x; }
56 # define Tracecv(c,x) {if (verbose > 1 && (c)) fprintf x; }
58 # define Assert(cond,msg)
67 /* ===========================================================================
73 # define INBUFSIZ 0x2000 /* input buffer size */
75 # define INBUFSIZ 0x8000 /* input buffer size */
81 # define OUTBUFSIZ 8192 /* output buffer size */
83 # define OUTBUFSIZ 16384 /* output buffer size */
89 # define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
91 # define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
96 #define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
97 #define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
98 #define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
99 #define ORIG_NAME 0x08 /* bit 3 set: original file name present */
100 #define COMMENT 0x10 /* bit 4 set: file comment present */
101 #define RESERVED 0xC0 /* bit 6,7: reserved */
103 /* internal file attribute */
104 #define UNKNOWN 0xffff
109 # define WSIZE 0x8000 /* window size--must be a power of two, and */
110 #endif /* at least 32K for zip's deflate method */
113 #define MAX_MATCH 258
114 /* The minimum and maximum match lengths */
116 #define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
117 /* Minimum amount of lookahead, except at the end of the input file.
118 * See deflate.c for comments about the MIN_MATCH+1.
121 #define MAX_DIST (WSIZE-MIN_LOOKAHEAD)
122 /* In order to simplify the code, particularly on 16 bit machines, match
123 * distances are limited to MAX_DIST instead of WSIZE.
127 # define MAX_PATH_LEN 1024 /* max pathname length */
130 #define seekable() 0 /* force sequential output */
131 #define translate_eol 0 /* no option -a yet */
136 #define INIT_BITS 9 /* Initial number of bits per code */
138 #define BIT_MASK 0x1f /* Mask for 'number of compression bits' */
139 /* Mask 0x20 is reserved to mean a fourth header byte, and 0x40 is free.
140 * It's a pity that old uncompress does not check bit 0x20. That makes
141 * extension of the format actually undesirable because old compress
142 * would just crash on the new format instead of giving a meaningful
143 * error message. It does check the number of bits, but it's more
144 * helpful to say "unsupported format, get a new version" than
145 * "can only handle 16 bits".
149 # define MAX_SUFFIX MAX_EXT_CHARS
151 # define MAX_SUFFIX 30
155 /* ===========================================================================
156 * Compile with MEDIUM_MEM to reduce the memory requirements or
157 * with SMALL_MEM to use as little memory as possible. Use BIG_MEM if the
158 * entire input file can be held in memory (not possible on 16 bit systems).
159 * Warning: defining these symbols affects HASH_BITS (see below) and thus
160 * affects the compression ratio. The compressed output
161 * is still correct, and might even be smaller in some cases.
165 # define HASH_BITS 13 /* Number of bits used to hash strings */
168 # define HASH_BITS 14
171 # define HASH_BITS 15
172 /* For portability to 16 bit machines, do not use values above 15. */
175 #define HASH_SIZE (unsigned)(1<<HASH_BITS)
176 #define HASH_MASK (HASH_SIZE-1)
177 #define WMASK (WSIZE-1)
178 /* HASH_SIZE and WSIZE must be powers of two */
180 # define TOO_FAR 4096
182 /* Matches of length 3 are discarded if their distance exceeds TOO_FAR */
185 /* ===========================================================================
186 * These types are not really 'char', 'short' and 'long'
189 typedef uint16_t ush
;
190 typedef uint32_t ulg
;
194 typedef unsigned IPos
;
195 /* A Pos is an index in the character window. We use short instead of int to
196 * save space in the various tables. IPos is used only for parameter passing.
200 WINDOW_SIZE
= 2 * WSIZE
,
201 /* window size, 2*WSIZE except for MMAP or BIG_MEM, where it is the
202 * input file length plus MIN_LOOKAHEAD.
205 max_chain_length
= 4096,
206 /* To speed up deflation, hash chains are never searched beyond this length.
207 * A higher limit improves compression ratio but degrades the speed.
210 max_lazy_match
= 258,
211 /* Attempt to find a better match only when the current match is strictly
212 * smaller than this value. This mechanism is used only for compression
216 max_insert_length
= max_lazy_match
,
217 /* Insert new strings in the hash table only if the match length
218 * is not greater than this length. This saves time but degrades compression.
219 * max_insert_length is used only for compression levels <= 3.
223 /* Use a faster search when the previous match is longer than this */
225 /* Values for max_lazy_match, good_match and max_chain_length, depending on
226 * the desired pack level (0..9). The values given below have been tuned to
227 * exclude worst case performance for pathological files. Better values may be
228 * found for specific files.
231 nice_match
= 258, /* Stop searching when current match exceeds this */
232 /* Note: the deflate() code requires max_lazy >= MIN_MATCH and max_chain >= 4
233 * For deflate_fast() (levels <= 3) good is ignored and lazy has a different
243 /* window position at the beginning of the current output block. Gets
244 * negative when the window is moved backwards.
246 unsigned ins_h
; /* hash index of string to be inserted */
248 #define H_SHIFT ((HASH_BITS+MIN_MATCH-1) / MIN_MATCH)
249 /* Number of bits by which ins_h and del_h must be shifted at each
250 * input step. It must be such that after MIN_MATCH steps, the oldest
251 * byte no longer takes part in the hash key, that is:
252 * H_SHIFT * MIN_MATCH >= HASH_BITS
255 unsigned prev_length
;
257 /* Length of the best match at previous step. Matches not greater than this
258 * are discarded. This is used in the lazy match evaluation.
261 unsigned strstart
; /* start of string to insert */
262 unsigned match_start
; /* start of matching string */
263 unsigned lookahead
; /* number of valid bytes ahead in window */
265 /* ===========================================================================
267 #define DECLARE(type, array, size) \
269 #define ALLOC(type, array, size) \
270 array = xzalloc((size_t)(((size)+1L)/2) * 2*sizeof(type));
271 #define FREE(array) \
272 do { free(array); array = NULL; } while (0)
276 /* buffer for literals or lengths */
277 /* DECLARE(uch, l_buf, LIT_BUFSIZE); */
278 DECLARE(uch
, l_buf
, INBUFSIZ
);
280 DECLARE(ush
, d_buf
, DIST_BUFSIZE
);
281 DECLARE(uch
, outbuf
, OUTBUFSIZ
);
283 /* Sliding window. Input bytes are read into the second half of the window,
284 * and move to the first half later to keep a dictionary of at least WSIZE
285 * bytes. With this organization, matches are limited to a distance of
286 * WSIZE-MAX_MATCH bytes, but this ensures that IO is always
287 * performed with a length multiple of the block size. Also, it limits
288 * the window size to 64K, which is quite useful on MSDOS.
289 * To do: limit the window size to WSIZE+BSZ if SMALL_MEM (the code would
290 * be less efficient).
292 DECLARE(uch
, window
, 2L * WSIZE
);
294 /* Link to older string with same hash index. To limit the size of this
295 * array to 64K, this link is maintained only for the last 32K strings.
296 * An index in this array is thus a window index modulo 32K.
298 /* DECLARE(Pos, prev, WSIZE); */
299 DECLARE(ush
, prev
, 1L << BITS
);
301 /* Heads of the hash chains or 0. */
302 /* DECLARE(Pos, head, 1<<HASH_BITS); */
303 #define head (G1.prev + WSIZE) /* hash head (see deflate.c) */
305 /* number of input bytes */
306 ulg isize
; /* only 32 bits stored in .gz file */
308 /* bbox always use stdin/stdout */
309 #define ifd STDIN_FILENO /* input file descriptor */
310 #define ofd STDOUT_FILENO /* output file descriptor */
313 unsigned insize
; /* valid bytes in l_buf */
315 unsigned outcnt
; /* bytes in output buffer */
317 smallint eofile
; /* flag set at end of input file */
319 /* ===========================================================================
320 * Local data used by the "bit string" routines.
323 unsigned short bi_buf
;
325 /* Output buffer. bits are inserted starting at the bottom (least significant
330 #define BUF_SIZE (8 * sizeof(G1.bi_buf))
331 /* Number of bits used within bi_buf. (bi_buf might be implemented on
332 * more than 16 bits on some systems.)
337 /* Current input function. Set to mem_read for in-memory compression */
340 ulg bits_sent
; /* bit length of the compressed data */
343 uint32_t *crc_32_tab
;
344 uint32_t crc
; /* shift register contents */
347 #define G1 (*(ptr_to_globals - 1))
350 /* ===========================================================================
351 * Write the output buffer outbuf[0..outcnt-1] and update bytes_out.
352 * (used for the compressed data only)
354 static void flush_outbuf(void)
359 xwrite(ofd
, (char *) G1
.outbuf
, G1
.outcnt
);
364 /* ===========================================================================
366 /* put_8bit is used for the compressed output */
367 #define put_8bit(c) \
369 G1.outbuf[G1.outcnt++] = (c); \
370 if (G1.outcnt == OUTBUFSIZ) flush_outbuf(); \
373 /* Output a 16 bit value, lsb first */
374 static void put_16bit(ush w
)
376 if (G1
.outcnt
< OUTBUFSIZ
- 2) {
377 G1
.outbuf
[G1
.outcnt
++] = w
;
378 G1
.outbuf
[G1
.outcnt
++] = w
>> 8;
385 static void put_32bit(ulg n
)
391 /* ===========================================================================
392 * Clear input and output buffers
394 static void clear_bufs(void)
404 /* ===========================================================================
405 * Run a set of bytes through the crc shift register. If s is a NULL
406 * pointer, then initialize the crc shift register contents instead.
407 * Return the current crc in either case.
409 static uint32_t updcrc(uch
* s
, unsigned n
)
413 c
= G1
.crc_32_tab
[(uch
)(c
^ *s
++)] ^ (c
>> 8);
421 /* ===========================================================================
422 * Read a new buffer from the current input file, perform end-of-line
423 * translation, and update the crc and input file size.
424 * IN assertion: size >= 2 (for end-of-line translation)
426 static unsigned file_read(void *buf
, unsigned size
)
430 Assert(G1
.insize
== 0, "l_buf not empty");
432 len
= safe_read(ifd
, buf
, size
);
433 if (len
== (unsigned)(-1) || len
== 0)
442 /* ===========================================================================
443 * Send a value on a given number of bits.
444 * IN assertion: length <= 16 and value fits in length bits.
446 static void send_bits(int value
, int length
)
449 Tracev((stderr
, " l %2d v %4x ", length
, value
));
450 Assert(length
> 0 && length
<= 15, "invalid length");
451 G1
.bits_sent
+= length
;
453 /* If not enough room in bi_buf, use (valid) bits from bi_buf and
454 * (16 - bi_valid) bits from value, leaving (width - (16-bi_valid))
455 * unused bits in value.
457 if (G1
.bi_valid
> (int) BUF_SIZE
- length
) {
458 G1
.bi_buf
|= (value
<< G1
.bi_valid
);
459 put_16bit(G1
.bi_buf
);
460 G1
.bi_buf
= (ush
) value
>> (BUF_SIZE
- G1
.bi_valid
);
461 G1
.bi_valid
+= length
- BUF_SIZE
;
463 G1
.bi_buf
|= value
<< G1
.bi_valid
;
464 G1
.bi_valid
+= length
;
469 /* ===========================================================================
470 * Reverse the first len bits of a code, using straightforward code (a faster
471 * method would use a table)
472 * IN assertion: 1 <= len <= 15
474 static unsigned bi_reverse(unsigned code
, int len
)
480 if (--len
<= 0) return res
;
487 /* ===========================================================================
488 * Write out any remaining bits in an incomplete byte.
490 static void bi_windup(void)
492 if (G1
.bi_valid
> 8) {
493 put_16bit(G1
.bi_buf
);
494 } else if (G1
.bi_valid
> 0) {
500 G1
.bits_sent
= (G1
.bits_sent
+ 7) & ~7;
505 /* ===========================================================================
506 * Copy a stored block to the zip file, storing first the length and its
507 * one's complement if requested.
509 static void copy_block(char *buf
, unsigned len
, int header
)
511 bi_windup(); /* align on byte boundary */
517 G1
.bits_sent
+= 2 * 16;
521 G1
.bits_sent
+= (ulg
) len
<< 3;
529 /* ===========================================================================
530 * Fill the window when the lookahead becomes insufficient.
531 * Updates strstart and lookahead, and sets eofile if end of input file.
532 * IN assertion: lookahead < MIN_LOOKAHEAD && strstart + lookahead > 0
533 * OUT assertions: at least one byte has been read, or eofile is set;
534 * file reads are performed for at least two bytes (required for the
535 * translate_eol option).
537 static void fill_window(void)
540 unsigned more
= WINDOW_SIZE
- G1
.lookahead
- G1
.strstart
;
541 /* Amount of free space at the end of the window. */
543 /* If the window is almost full and there is insufficient lookahead,
544 * move the upper half to the lower one to make room in the upper half.
546 if (more
== (unsigned) -1) {
547 /* Very unlikely, but possible on 16 bit machine if strstart == 0
548 * and lookahead == 1 (input done one byte at time)
551 } else if (G1
.strstart
>= WSIZE
+ MAX_DIST
) {
552 /* By the IN assertion, the window is not empty so we can't confuse
553 * more == 0 with more == 64K on a 16 bit machine.
555 Assert(WINDOW_SIZE
== 2 * WSIZE
, "no sliding with BIG_MEM");
557 memcpy(G1
.window
, G1
.window
+ WSIZE
, WSIZE
);
558 G1
.match_start
-= WSIZE
;
559 G1
.strstart
-= WSIZE
; /* we now have strstart >= MAX_DIST: */
561 G1
.block_start
-= WSIZE
;
563 for (n
= 0; n
< HASH_SIZE
; n
++) {
565 head
[n
] = (Pos
) (m
>= WSIZE
? m
- WSIZE
: 0);
567 for (n
= 0; n
< WSIZE
; n
++) {
569 G1
.prev
[n
] = (Pos
) (m
>= WSIZE
? m
- WSIZE
: 0);
570 /* If n is not on any hash chain, prev[n] is garbage but
571 * its value will never be used.
576 /* At this point, more >= 2 */
578 n
= file_read(G1
.window
+ G1
.strstart
+ G1
.lookahead
, more
);
579 if (n
== 0 || n
== (unsigned) -1) {
588 /* ===========================================================================
589 * Set match_start to the longest match starting at the given string and
590 * return its length. Matches shorter or equal to prev_length are discarded,
591 * in which case the result is equal to prev_length and match_start is
593 * IN assertions: cur_match is the head of the hash chain for the current
594 * string (strstart) and its distance is <= MAX_DIST, and prev_length >= 1
597 /* For MSDOS, OS/2 and 386 Unix, an optimized version is in match.asm or
598 * match.s. The code is functionally equivalent, so you can use the C version
601 static int longest_match(IPos cur_match
)
603 unsigned chain_length
= max_chain_length
; /* max hash chain length */
604 uch
*scan
= G1
.window
+ G1
.strstart
; /* current string */
605 uch
*match
; /* matched string */
606 int len
; /* length of current match */
607 int best_len
= G1
.prev_length
; /* best match length so far */
608 IPos limit
= G1
.strstart
> (IPos
) MAX_DIST
? G1
.strstart
- (IPos
) MAX_DIST
: 0;
609 /* Stop when cur_match becomes <= limit. To simplify the code,
610 * we prevent matches with the string of window index 0.
613 /* The code is optimized for HASH_BITS >= 8 and MAX_MATCH-2 multiple of 16.
614 * It is easy to get rid of this optimization if necessary.
616 #if HASH_BITS < 8 || MAX_MATCH != 258
617 # error Code too clever
619 uch
*strend
= G1
.window
+ G1
.strstart
+ MAX_MATCH
;
620 uch scan_end1
= scan
[best_len
- 1];
621 uch scan_end
= scan
[best_len
];
623 /* Do not waste too much time if we already have a good match: */
624 if (G1
.prev_length
>= good_match
) {
627 Assert(G1
.strstart
<= WINDOW_SIZE
- MIN_LOOKAHEAD
, "insufficient lookahead");
630 Assert(cur_match
< G1
.strstart
, "no future");
631 match
= G1
.window
+ cur_match
;
633 /* Skip to next match if the match length cannot increase
634 * or if the match length is less than 2:
636 if (match
[best_len
] != scan_end
||
637 match
[best_len
- 1] != scan_end1
||
638 *match
!= *scan
|| *++match
!= scan
[1])
641 /* The check at best_len-1 can be removed because it will be made
642 * again later. (This heuristic is not always a win.)
643 * It is not necessary to compare scan[2] and match[2] since they
644 * are always equal when the other bytes match, given that
645 * the hash keys are equal and that HASH_BITS >= 8.
649 /* We check for insufficient lookahead only every 8th comparison;
650 * the 256th check will be made at strstart+258.
653 } while (*++scan
== *++match
&& *++scan
== *++match
&&
654 *++scan
== *++match
&& *++scan
== *++match
&&
655 *++scan
== *++match
&& *++scan
== *++match
&&
656 *++scan
== *++match
&& *++scan
== *++match
&& scan
< strend
);
658 len
= MAX_MATCH
- (int) (strend
- scan
);
659 scan
= strend
- MAX_MATCH
;
661 if (len
> best_len
) {
662 G1
.match_start
= cur_match
;
664 if (len
>= nice_match
)
666 scan_end1
= scan
[best_len
- 1];
667 scan_end
= scan
[best_len
];
669 } while ((cur_match
= G1
.prev
[cur_match
& WMASK
]) > limit
670 && --chain_length
!= 0);
677 /* ===========================================================================
678 * Check that the match at match_start is indeed a match.
680 static void check_match(IPos start
, IPos match
, int length
)
682 /* check that the match is indeed a match */
683 if (memcmp(G1
.window
+ match
, G1
.window
+ start
, length
) != 0) {
684 bb_error_msg(" start %d, match %d, length %d", start
, match
, length
);
685 bb_error_msg("invalid match");
688 bb_error_msg("\\[%d,%d]", start
- match
, length
);
690 fputc(G1
.window
[start
++], stderr
);
691 } while (--length
!= 0);
695 # define check_match(start, match, length) ((void)0)
699 /* trees.c -- output deflated data using Huffman coding
700 * Copyright (C) 1992-1993 Jean-loup Gailly
701 * This is free software; you can redistribute it and/or modify it under the
702 * terms of the GNU General Public License, see the file COPYING.
706 * Encode various sets of source values using variable-length
710 * The PKZIP "deflation" process uses several Huffman trees. The more
711 * common source values are represented by shorter bit sequences.
713 * Each code tree is stored in the ZIP file in a compressed form
714 * which is itself a Huffman encoding of the lengths of
715 * all the code strings (in ascending order by source values).
716 * The actual code strings are reconstructed from the lengths in
717 * the UNZIP process, as described in the "application note"
718 * (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
722 * Data Compression: Techniques and Applications, pp. 53-55.
723 * Lifetime Learning Publications, 1985. ISBN 0-534-03418-7.
726 * Data Compression: Methods and Theory, pp. 49-50.
727 * Computer Science Press, 1988. ISBN 0-7167-8156-5.
731 * Addison-Wesley, 1983. ISBN 0-201-06672-6.
735 * Allocate the match buffer, initialize the various tables [and save
736 * the location of the internal file attribute (ascii/binary) and
737 * method (DEFLATE/STORE) -- deleted in bbox]
739 * void ct_tally(int dist, int lc);
740 * Save the match info and tally the frequency counts.
742 * ulg flush_block(char *buf, ulg stored_len, int eof)
743 * Determine the best encoding for the current block: dynamic trees,
744 * static trees or store, and output the encoded block to the zip
745 * file. Returns the total compressed length for the file so far.
749 /* All codes must not exceed MAX_BITS bits */
751 #define MAX_BL_BITS 7
752 /* Bit length codes must not exceed MAX_BL_BITS bits */
754 #define LENGTH_CODES 29
755 /* number of length codes, not counting the special END_BLOCK code */
758 /* number of literal bytes 0..255 */
760 #define END_BLOCK 256
761 /* end of block literal code */
763 #define L_CODES (LITERALS+1+LENGTH_CODES)
764 /* number of Literal or Length codes, including the END_BLOCK code */
767 /* number of distance codes */
770 /* number of codes used to transfer the bit lengths */
772 /* extra bits for each length code */
773 static const uint8_t extra_lbits
[LENGTH_CODES
] ALIGN1
= {
774 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4,
778 /* extra bits for each distance code */
779 static const uint8_t extra_dbits
[D_CODES
] ALIGN1
= {
780 0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9,
781 10, 10, 11, 11, 12, 12, 13, 13
784 /* extra bits for each bit length code */
785 static const uint8_t extra_blbits
[BL_CODES
] ALIGN1
= {
786 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 3, 7 };
788 /* number of codes at each bit length for an optimal tree */
789 static const uint8_t bl_order
[BL_CODES
] ALIGN1
= {
790 16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15 };
792 #define STORED_BLOCK 0
793 #define STATIC_TREES 1
795 /* The three kinds of block type */
799 # define LIT_BUFSIZE 0x2000
802 # define LIT_BUFSIZE 0x4000
804 # define LIT_BUFSIZE 0x8000
809 # define DIST_BUFSIZE LIT_BUFSIZE
811 /* Sizes of match buffers for literals/lengths and distances. There are
812 * 4 reasons for limiting LIT_BUFSIZE to 64K:
813 * - frequencies can be kept in 16 bit counters
814 * - if compression is not successful for the first block, all input data is
815 * still in the window so we can still emit a stored block even when input
816 * comes from standard input. (This can also be done for all blocks if
817 * LIT_BUFSIZE is not greater than 32K.)
818 * - if compression is not successful for a file smaller than 64K, we can
819 * even emit a stored file instead of a stored block (saving 5 bytes).
820 * - creating new Huffman trees less frequently may not provide fast
821 * adaptation to changes in the input data statistics. (Take for
822 * example a binary file with poorly compressible code followed by
823 * a highly compressible string table.) Smaller buffer sizes give
824 * fast adaptation but have of course the overhead of transmitting trees
826 * - I can't count above 4
827 * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
828 * memory at the expense of compression). Some optimizations would be possible
829 * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
832 /* repeat previous bit length 3-6 times (2 bits of repeat count) */
834 /* repeat a zero length 3-10 times (3 bits of repeat count) */
835 #define REPZ_11_138 18
836 /* repeat a zero length 11-138 times (7 bits of repeat count) */
838 /* ===========================================================================
840 /* Data structure describing a single value and its code string. */
841 typedef struct ct_data
{
843 ush freq
; /* frequency count */
844 ush code
; /* bit string */
847 ush dad
; /* father node in Huffman tree */
848 ush len
; /* length of bit string */
857 #define HEAP_SIZE (2*L_CODES + 1)
858 /* maximum heap size */
860 typedef struct tree_desc
{
861 ct_data
*dyn_tree
; /* the dynamic tree */
862 ct_data
*static_tree
; /* corresponding static tree or NULL */
863 const uint8_t *extra_bits
; /* extra bits for each code or NULL */
864 int extra_base
; /* base index for extra_bits */
865 int elems
; /* max number of elements in the tree */
866 int max_length
; /* max bit length for the codes */
867 int max_code
; /* largest code with non zero frequency */
872 ush heap
[HEAP_SIZE
]; /* heap used to build the Huffman trees */
873 int heap_len
; /* number of elements in the heap */
874 int heap_max
; /* element of largest frequency */
876 /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
877 * The same heap array is used to build all trees.
880 ct_data dyn_ltree
[HEAP_SIZE
]; /* literal and length tree */
881 ct_data dyn_dtree
[2 * D_CODES
+ 1]; /* distance tree */
883 ct_data static_ltree
[L_CODES
+ 2];
885 /* The static literal tree. Since the bit lengths are imposed, there is no
886 * need for the L_CODES extra codes used during heap construction. However
887 * The codes 286 and 287 are needed to build a canonical tree (see ct_init
891 ct_data static_dtree
[D_CODES
];
893 /* The static distance tree. (Actually a trivial tree since all codes use
897 ct_data bl_tree
[2 * BL_CODES
+ 1];
899 /* Huffman tree for the bit lengths */
905 ush bl_count
[MAX_BITS
+ 1];
907 /* The lengths of the bit length codes are sent in order of decreasing
908 * probability, to avoid transmitting the lengths for unused bit length codes.
911 uch depth
[2 * L_CODES
+ 1];
913 /* Depth of each subtree used as tie breaker for trees of equal frequency */
915 uch length_code
[MAX_MATCH
- MIN_MATCH
+ 1];
917 /* length code for each normalized match length (0 == MIN_MATCH) */
921 /* distance codes. The first 256 values correspond to the distances
922 * 3 .. 258, the last 256 values correspond to the top 8 bits of
923 * the 15 bit distances.
926 int base_length
[LENGTH_CODES
];
928 /* First normalized length for each code (0 = MIN_MATCH) */
930 int base_dist
[D_CODES
];
932 /* First normalized distance for each code (0 = distance of 1) */
934 uch flag_buf
[LIT_BUFSIZE
/ 8];
936 /* flag_buf is a bit array distinguishing literals from lengths in
937 * l_buf, thus indicating the presence or absence of a distance.
940 unsigned last_lit
; /* running index in l_buf */
941 unsigned last_dist
; /* running index in d_buf */
942 unsigned last_flags
; /* running index in flag_buf */
943 uch flags
; /* current flags not yet saved in flag_buf */
944 uch flag_bit
; /* current bit used in flags */
946 /* bits are filled in flags starting at bit 0 (least significant).
947 * Note: these flags are overkill in the current code since we don't
948 * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
951 ulg opt_len
; /* bit length of current block with optimal trees */
952 ulg static_len
; /* bit length of current block with static trees */
954 ulg compressed_len
; /* total bit length of compressed file */
957 #define G2ptr ((struct globals2*)(ptr_to_globals))
961 /* ===========================================================================
963 static void gen_codes(ct_data
* tree
, int max_code
);
964 static void build_tree(tree_desc
* desc
);
965 static void scan_tree(ct_data
* tree
, int max_code
);
966 static void send_tree(ct_data
* tree
, int max_code
);
967 static int build_bl_tree(void);
968 static void send_all_trees(int lcodes
, int dcodes
, int blcodes
);
969 static void compress_block(ct_data
* ltree
, ct_data
* dtree
);
973 /* Send a code of the given tree. c and tree must not have side effects */
974 # define SEND_CODE(c, tree) send_bits(tree[c].Code, tree[c].Len)
976 # define SEND_CODE(c, tree) \
978 if (verbose > 1) bb_error_msg("\ncd %3d ",(c)); \
979 send_bits(tree[c].Code, tree[c].Len); \
983 #define D_CODE(dist) \
984 ((dist) < 256 ? G2.dist_code[dist] : G2.dist_code[256 + ((dist)>>7)])
985 /* Mapping from a distance to a distance code. dist is the distance - 1 and
986 * must not have side effects. dist_code[256] and dist_code[257] are never
988 * The arguments must not have side effects.
992 /* ===========================================================================
993 * Initialize a new block.
995 static void init_block(void)
997 int n
; /* iterates over tree elements */
999 /* Initialize the trees. */
1000 for (n
= 0; n
< L_CODES
; n
++)
1001 G2
.dyn_ltree
[n
].Freq
= 0;
1002 for (n
= 0; n
< D_CODES
; n
++)
1003 G2
.dyn_dtree
[n
].Freq
= 0;
1004 for (n
= 0; n
< BL_CODES
; n
++)
1005 G2
.bl_tree
[n
].Freq
= 0;
1007 G2
.dyn_ltree
[END_BLOCK
].Freq
= 1;
1008 G2
.opt_len
= G2
.static_len
= 0;
1009 G2
.last_lit
= G2
.last_dist
= G2
.last_flags
= 0;
1015 /* ===========================================================================
1016 * Restore the heap property by moving down the tree starting at node k,
1017 * exchanging a node with the smallest of its two sons if necessary, stopping
1018 * when the heap property is re-established (each father smaller than its
1022 /* Compares to subtrees, using the tree depth as tie breaker when
1023 * the subtrees have equal frequency. This minimizes the worst case length. */
1024 #define SMALLER(tree, n, m) \
1025 (tree[n].Freq < tree[m].Freq \
1026 || (tree[n].Freq == tree[m].Freq && G2.depth[n] <= G2.depth[m]))
1028 static void pqdownheap(ct_data
* tree
, int k
)
1031 int j
= k
<< 1; /* left son of k */
1033 while (j
<= G2
.heap_len
) {
1034 /* Set j to the smallest of the two sons: */
1035 if (j
< G2
.heap_len
&& SMALLER(tree
, G2
.heap
[j
+ 1], G2
.heap
[j
]))
1038 /* Exit if v is smaller than both sons */
1039 if (SMALLER(tree
, v
, G2
.heap
[j
]))
1042 /* Exchange v with the smallest son */
1043 G2
.heap
[k
] = G2
.heap
[j
];
1046 /* And continue down the tree, setting j to the left son of k */
1053 /* ===========================================================================
1054 * Compute the optimal bit lengths for a tree and update the total bit length
1055 * for the current block.
1056 * IN assertion: the fields freq and dad are set, heap[heap_max] and
1057 * above are the tree nodes sorted by increasing frequency.
1058 * OUT assertions: the field len is set to the optimal bit length, the
1059 * array bl_count contains the frequencies for each bit length.
1060 * The length opt_len is updated; static_len is also updated if stree is
1063 static void gen_bitlen(tree_desc
* desc
)
1065 ct_data
*tree
= desc
->dyn_tree
;
1066 const uint8_t *extra
= desc
->extra_bits
;
1067 int base
= desc
->extra_base
;
1068 int max_code
= desc
->max_code
;
1069 int max_length
= desc
->max_length
;
1070 ct_data
*stree
= desc
->static_tree
;
1071 int h
; /* heap index */
1072 int n
, m
; /* iterate over the tree elements */
1073 int bits
; /* bit length */
1074 int xbits
; /* extra bits */
1075 ush f
; /* frequency */
1076 int overflow
= 0; /* number of elements with bit length too large */
1078 for (bits
= 0; bits
<= MAX_BITS
; bits
++)
1079 G2
.bl_count
[bits
] = 0;
1081 /* In a first pass, compute the optimal bit lengths (which may
1082 * overflow in the case of the bit length tree).
1084 tree
[G2
.heap
[G2
.heap_max
]].Len
= 0; /* root of the heap */
1086 for (h
= G2
.heap_max
+ 1; h
< HEAP_SIZE
; h
++) {
1088 bits
= tree
[tree
[n
].Dad
].Len
+ 1;
1089 if (bits
> max_length
) {
1093 tree
[n
].Len
= (ush
) bits
;
1094 /* We overwrite tree[n].Dad which is no longer needed */
1097 continue; /* not a leaf node */
1099 G2
.bl_count
[bits
]++;
1102 xbits
= extra
[n
- base
];
1104 G2
.opt_len
+= (ulg
) f
*(bits
+ xbits
);
1107 G2
.static_len
+= (ulg
) f
* (stree
[n
].Len
+ xbits
);
1112 Trace((stderr
, "\nbit length overflow\n"));
1113 /* This happens for example on obj2 and pic of the Calgary corpus */
1115 /* Find the first bit length which could increase: */
1117 bits
= max_length
- 1;
1118 while (G2
.bl_count
[bits
] == 0)
1120 G2
.bl_count
[bits
]--; /* move one leaf down the tree */
1121 G2
.bl_count
[bits
+ 1] += 2; /* move one overflow item as its brother */
1122 G2
.bl_count
[max_length
]--;
1123 /* The brother of the overflow item also moves one step up,
1124 * but this does not affect bl_count[max_length]
1127 } while (overflow
> 0);
1129 /* Now recompute all bit lengths, scanning in increasing frequency.
1130 * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
1131 * lengths instead of fixing only the wrong ones. This idea is taken
1132 * from 'ar' written by Haruhiko Okumura.)
1134 for (bits
= max_length
; bits
!= 0; bits
--) {
1135 n
= G2
.bl_count
[bits
];
1140 if (tree
[m
].Len
!= (unsigned) bits
) {
1141 Trace((stderr
, "code %d bits %d->%d\n", m
, tree
[m
].Len
, bits
));
1142 G2
.opt_len
+= ((int32_t) bits
- tree
[m
].Len
) * tree
[m
].Freq
;
1151 /* ===========================================================================
1152 * Generate the codes for a given tree and bit counts (which need not be
1154 * IN assertion: the array bl_count contains the bit length statistics for
1155 * the given tree and the field len is set for all tree elements.
1156 * OUT assertion: the field code is set for all tree elements of non
1159 static void gen_codes(ct_data
* tree
, int max_code
)
1161 ush next_code
[MAX_BITS
+ 1]; /* next code value for each bit length */
1162 ush code
= 0; /* running code value */
1163 int bits
; /* bit index */
1164 int n
; /* code index */
1166 /* The distribution counts are first used to generate the code values
1167 * without bit reversal.
1169 for (bits
= 1; bits
<= MAX_BITS
; bits
++) {
1170 next_code
[bits
] = code
= (code
+ G2
.bl_count
[bits
- 1]) << 1;
1172 /* Check that the bit counts in bl_count are consistent. The last code
1175 Assert(code
+ G2
.bl_count
[MAX_BITS
] - 1 == (1 << MAX_BITS
) - 1,
1176 "inconsistent bit counts");
1177 Tracev((stderr
, "\ngen_codes: max_code %d ", max_code
));
1179 for (n
= 0; n
<= max_code
; n
++) {
1180 int len
= tree
[n
].Len
;
1184 /* Now reverse the bits */
1185 tree
[n
].Code
= bi_reverse(next_code
[len
]++, len
);
1187 Tracec(tree
!= G2
.static_ltree
,
1188 (stderr
, "\nn %3d %c l %2d c %4x (%x) ", n
,
1189 (isgraph(n
) ? n
: ' '), len
, tree
[n
].Code
,
1190 next_code
[len
] - 1));
1195 /* ===========================================================================
1196 * Construct one Huffman tree and assigns the code bit strings and lengths.
1197 * Update the total bit length for the current block.
1198 * IN assertion: the field freq is set for all tree elements.
1199 * OUT assertions: the fields len and code are set to the optimal bit length
1200 * and corresponding code. The length opt_len is updated; static_len is
1201 * also updated if stree is not null. The field max_code is set.
1204 /* Remove the smallest element from the heap and recreate the heap with
1205 * one less element. Updates heap and heap_len. */
1208 /* Index within the heap array of least frequent node in the Huffman tree */
1210 #define PQREMOVE(tree, top) \
1212 top = G2.heap[SMALLEST]; \
1213 G2.heap[SMALLEST] = G2.heap[G2.heap_len--]; \
1214 pqdownheap(tree, SMALLEST); \
1217 static void build_tree(tree_desc
* desc
)
1219 ct_data
*tree
= desc
->dyn_tree
;
1220 ct_data
*stree
= desc
->static_tree
;
1221 int elems
= desc
->elems
;
1222 int n
, m
; /* iterate over heap elements */
1223 int max_code
= -1; /* largest code with non zero frequency */
1224 int node
= elems
; /* next internal node of the tree */
1226 /* Construct the initial heap, with least frequent element in
1227 * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
1228 * heap[0] is not used.
1231 G2
.heap_max
= HEAP_SIZE
;
1233 for (n
= 0; n
< elems
; n
++) {
1234 if (tree
[n
].Freq
!= 0) {
1235 G2
.heap
[++G2
.heap_len
] = max_code
= n
;
1242 /* The pkzip format requires that at least one distance code exists,
1243 * and that at least one bit should be sent even if there is only one
1244 * possible code. So to avoid special checks later on we force at least
1245 * two codes of non zero frequency.
1247 while (G2
.heap_len
< 2) {
1248 int new = G2
.heap
[++G2
.heap_len
] = (max_code
< 2 ? ++max_code
: 0);
1254 G2
.static_len
-= stree
[new].Len
;
1255 /* new is 0 or 1 so it does not have extra bits */
1257 desc
->max_code
= max_code
;
1259 /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
1260 * establish sub-heaps of increasing lengths:
1262 for (n
= G2
.heap_len
/ 2; n
>= 1; n
--)
1263 pqdownheap(tree
, n
);
1265 /* Construct the Huffman tree by repeatedly combining the least two
1269 PQREMOVE(tree
, n
); /* n = node of least frequency */
1270 m
= G2
.heap
[SMALLEST
]; /* m = node of next least frequency */
1272 G2
.heap
[--G2
.heap_max
] = n
; /* keep the nodes sorted by frequency */
1273 G2
.heap
[--G2
.heap_max
] = m
;
1275 /* Create a new node father of n and m */
1276 tree
[node
].Freq
= tree
[n
].Freq
+ tree
[m
].Freq
;
1277 G2
.depth
[node
] = MAX(G2
.depth
[n
], G2
.depth
[m
]) + 1;
1278 tree
[n
].Dad
= tree
[m
].Dad
= (ush
) node
;
1280 if (tree
== G2
.bl_tree
) {
1281 bb_error_msg("\nnode %d(%d), sons %d(%d) %d(%d)",
1282 node
, tree
[node
].Freq
, n
, tree
[n
].Freq
, m
, tree
[m
].Freq
);
1285 /* and insert the new node in the heap */
1286 G2
.heap
[SMALLEST
] = node
++;
1287 pqdownheap(tree
, SMALLEST
);
1289 } while (G2
.heap_len
>= 2);
1291 G2
.heap
[--G2
.heap_max
] = G2
.heap
[SMALLEST
];
1293 /* At this point, the fields freq and dad are set. We can now
1294 * generate the bit lengths.
1296 gen_bitlen((tree_desc
*) desc
);
1298 /* The field len is now set, we can generate the bit codes */
1299 gen_codes((ct_data
*) tree
, max_code
);
1303 /* ===========================================================================
1304 * Scan a literal or distance tree to determine the frequencies of the codes
1305 * in the bit length tree. Updates opt_len to take into account the repeat
1306 * counts. (The contribution of the bit length codes will be added later
1307 * during the construction of bl_tree.)
1309 static void scan_tree(ct_data
* tree
, int max_code
)
1311 int n
; /* iterates over all tree elements */
1312 int prevlen
= -1; /* last emitted length */
1313 int curlen
; /* length of current code */
1314 int nextlen
= tree
[0].Len
; /* length of next code */
1315 int count
= 0; /* repeat count of the current code */
1316 int max_count
= 7; /* max repeat count */
1317 int min_count
= 4; /* min repeat count */
1323 tree
[max_code
+ 1].Len
= 0xffff; /* guard */
1325 for (n
= 0; n
<= max_code
; n
++) {
1327 nextlen
= tree
[n
+ 1].Len
;
1328 if (++count
< max_count
&& curlen
== nextlen
)
1331 if (count
< min_count
) {
1332 G2
.bl_tree
[curlen
].Freq
+= count
;
1333 } else if (curlen
!= 0) {
1334 if (curlen
!= prevlen
)
1335 G2
.bl_tree
[curlen
].Freq
++;
1336 G2
.bl_tree
[REP_3_6
].Freq
++;
1337 } else if (count
<= 10) {
1338 G2
.bl_tree
[REPZ_3_10
].Freq
++;
1340 G2
.bl_tree
[REPZ_11_138
].Freq
++;
1350 } else if (curlen
== nextlen
) {
1358 /* ===========================================================================
1359 * Send a literal or distance tree in compressed form, using the codes in
1362 static void send_tree(ct_data
* tree
, int max_code
)
1364 int n
; /* iterates over all tree elements */
1365 int prevlen
= -1; /* last emitted length */
1366 int curlen
; /* length of current code */
1367 int nextlen
= tree
[0].Len
; /* length of next code */
1368 int count
= 0; /* repeat count of the current code */
1369 int max_count
= 7; /* max repeat count */
1370 int min_count
= 4; /* min repeat count */
1372 /* tree[max_code+1].Len = -1; *//* guard already set */
1374 max_count
= 138, min_count
= 3;
1376 for (n
= 0; n
<= max_code
; n
++) {
1378 nextlen
= tree
[n
+ 1].Len
;
1379 if (++count
< max_count
&& curlen
== nextlen
) {
1381 } else if (count
< min_count
) {
1383 SEND_CODE(curlen
, G2
.bl_tree
);
1385 } else if (curlen
!= 0) {
1386 if (curlen
!= prevlen
) {
1387 SEND_CODE(curlen
, G2
.bl_tree
);
1390 Assert(count
>= 3 && count
<= 6, " 3_6?");
1391 SEND_CODE(REP_3_6
, G2
.bl_tree
);
1392 send_bits(count
- 3, 2);
1393 } else if (count
<= 10) {
1394 SEND_CODE(REPZ_3_10
, G2
.bl_tree
);
1395 send_bits(count
- 3, 3);
1397 SEND_CODE(REPZ_11_138
, G2
.bl_tree
);
1398 send_bits(count
- 11, 7);
1405 } else if (curlen
== nextlen
) {
1416 /* ===========================================================================
1417 * Construct the Huffman tree for the bit lengths and return the index in
1418 * bl_order of the last bit length code to send.
1420 static int build_bl_tree(void)
1422 int max_blindex
; /* index of last bit length code of non zero freq */
1424 /* Determine the bit length frequencies for literal and distance trees */
1425 scan_tree(G2
.dyn_ltree
, G2
.l_desc
.max_code
);
1426 scan_tree(G2
.dyn_dtree
, G2
.d_desc
.max_code
);
1428 /* Build the bit length tree: */
1429 build_tree(&G2
.bl_desc
);
1430 /* opt_len now includes the length of the tree representations, except
1431 * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
1434 /* Determine the number of bit length codes to send. The pkzip format
1435 * requires that at least 4 bit length codes be sent. (appnote.txt says
1436 * 3 but the actual value used is 4.)
1438 for (max_blindex
= BL_CODES
- 1; max_blindex
>= 3; max_blindex
--) {
1439 if (G2
.bl_tree
[bl_order
[max_blindex
]].Len
!= 0)
1442 /* Update opt_len to include the bit length tree and counts */
1443 G2
.opt_len
+= 3 * (max_blindex
+ 1) + 5 + 5 + 4;
1444 Tracev((stderr
, "\ndyn trees: dyn %ld, stat %ld", G2
.opt_len
, G2
.static_len
));
1450 /* ===========================================================================
1451 * Send the header for a block using dynamic Huffman trees: the counts, the
1452 * lengths of the bit length codes, the literal tree and the distance tree.
1453 * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
1455 static void send_all_trees(int lcodes
, int dcodes
, int blcodes
)
1457 int rank
; /* index in bl_order */
1459 Assert(lcodes
>= 257 && dcodes
>= 1 && blcodes
>= 4, "not enough codes");
1460 Assert(lcodes
<= L_CODES
&& dcodes
<= D_CODES
1461 && blcodes
<= BL_CODES
, "too many codes");
1462 Tracev((stderr
, "\nbl counts: "));
1463 send_bits(lcodes
- 257, 5); /* not +255 as stated in appnote.txt */
1464 send_bits(dcodes
- 1, 5);
1465 send_bits(blcodes
- 4, 4); /* not -3 as stated in appnote.txt */
1466 for (rank
= 0; rank
< blcodes
; rank
++) {
1467 Tracev((stderr
, "\nbl code %2d ", bl_order
[rank
]));
1468 send_bits(G2
.bl_tree
[bl_order
[rank
]].Len
, 3);
1470 Tracev((stderr
, "\nbl tree: sent %ld", G1
.bits_sent
));
1472 send_tree((ct_data
*) G2
.dyn_ltree
, lcodes
- 1); /* send the literal tree */
1473 Tracev((stderr
, "\nlit tree: sent %ld", G1
.bits_sent
));
1475 send_tree((ct_data
*) G2
.dyn_dtree
, dcodes
- 1); /* send the distance tree */
1476 Tracev((stderr
, "\ndist tree: sent %ld", G1
.bits_sent
));
1480 /* ===========================================================================
1481 * Save the match info and tally the frequency counts. Return true if
1482 * the current block must be flushed.
1484 static int ct_tally(int dist
, int lc
)
1486 G1
.l_buf
[G2
.last_lit
++] = lc
;
1488 /* lc is the unmatched char */
1489 G2
.dyn_ltree
[lc
].Freq
++;
1491 /* Here, lc is the match length - MIN_MATCH */
1492 dist
--; /* dist = match distance - 1 */
1493 Assert((ush
) dist
< (ush
) MAX_DIST
1494 && (ush
) lc
<= (ush
) (MAX_MATCH
- MIN_MATCH
)
1495 && (ush
) D_CODE(dist
) < (ush
) D_CODES
, "ct_tally: bad match"
1498 G2
.dyn_ltree
[G2
.length_code
[lc
] + LITERALS
+ 1].Freq
++;
1499 G2
.dyn_dtree
[D_CODE(dist
)].Freq
++;
1501 G1
.d_buf
[G2
.last_dist
++] = dist
;
1502 G2
.flags
|= G2
.flag_bit
;
1506 /* Output the flags if they fill a byte: */
1507 if ((G2
.last_lit
& 7) == 0) {
1508 G2
.flag_buf
[G2
.last_flags
++] = G2
.flags
;
1512 /* Try to guess if it is profitable to stop the current block here */
1513 if ((G2
.last_lit
& 0xfff) == 0) {
1514 /* Compute an upper bound for the compressed length */
1515 ulg out_length
= G2
.last_lit
* 8L;
1516 ulg in_length
= (ulg
) G1
.strstart
- G1
.block_start
;
1519 for (dcode
= 0; dcode
< D_CODES
; dcode
++) {
1520 out_length
+= G2
.dyn_dtree
[dcode
].Freq
* (5L + extra_dbits
[dcode
]);
1524 "\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
1525 G2
.last_lit
, G2
.last_dist
, in_length
, out_length
,
1526 100L - out_length
* 100L / in_length
));
1527 if (G2
.last_dist
< G2
.last_lit
/ 2 && out_length
< in_length
/ 2)
1530 return (G2
.last_lit
== LIT_BUFSIZE
- 1 || G2
.last_dist
== DIST_BUFSIZE
);
1531 /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
1532 * on 16 bit machines and because stored blocks are restricted to
1537 /* ===========================================================================
1538 * Send the block data compressed using the given Huffman trees
1540 static void compress_block(ct_data
* ltree
, ct_data
* dtree
)
1542 unsigned dist
; /* distance of matched string */
1543 int lc
; /* match length or unmatched char (if dist == 0) */
1544 unsigned lx
= 0; /* running index in l_buf */
1545 unsigned dx
= 0; /* running index in d_buf */
1546 unsigned fx
= 0; /* running index in flag_buf */
1547 uch flag
= 0; /* current flags */
1548 unsigned code
; /* the code to send */
1549 int extra
; /* number of extra bits to send */
1551 if (G2
.last_lit
!= 0) do {
1553 flag
= G2
.flag_buf
[fx
++];
1554 lc
= G1
.l_buf
[lx
++];
1555 if ((flag
& 1) == 0) {
1556 SEND_CODE(lc
, ltree
); /* send a literal byte */
1557 Tracecv(isgraph(lc
), (stderr
, " '%c' ", lc
));
1559 /* Here, lc is the match length - MIN_MATCH */
1560 code
= G2
.length_code
[lc
];
1561 SEND_CODE(code
+ LITERALS
+ 1, ltree
); /* send the length code */
1562 extra
= extra_lbits
[code
];
1564 lc
-= G2
.base_length
[code
];
1565 send_bits(lc
, extra
); /* send the extra length bits */
1567 dist
= G1
.d_buf
[dx
++];
1568 /* Here, dist is the match distance - 1 */
1569 code
= D_CODE(dist
);
1570 Assert(code
< D_CODES
, "bad d_code");
1572 SEND_CODE(code
, dtree
); /* send the distance code */
1573 extra
= extra_dbits
[code
];
1575 dist
-= G2
.base_dist
[code
];
1576 send_bits(dist
, extra
); /* send the extra distance bits */
1578 } /* literal or match pair ? */
1580 } while (lx
< G2
.last_lit
);
1582 SEND_CODE(END_BLOCK
, ltree
);
1586 /* ===========================================================================
1587 * Determine the best encoding for the current block: dynamic trees, static
1588 * trees or store, and output the encoded block to the zip file. This function
1589 * returns the total compressed length for the file so far.
1591 static ulg
flush_block(char *buf
, ulg stored_len
, int eof
)
1593 ulg opt_lenb
, static_lenb
; /* opt_len and static_len in bytes */
1594 int max_blindex
; /* index of last bit length code of non zero freq */
1596 G2
.flag_buf
[G2
.last_flags
] = G2
.flags
; /* Save the flags for the last 8 items */
1598 /* Construct the literal and distance trees */
1599 build_tree(&G2
.l_desc
);
1600 Tracev((stderr
, "\nlit data: dyn %ld, stat %ld", G2
.opt_len
, G2
.static_len
));
1602 build_tree(&G2
.d_desc
);
1603 Tracev((stderr
, "\ndist data: dyn %ld, stat %ld", G2
.opt_len
, G2
.static_len
));
1604 /* At this point, opt_len and static_len are the total bit lengths of
1605 * the compressed block data, excluding the tree representations.
1608 /* Build the bit length tree for the above two trees, and get the index
1609 * in bl_order of the last bit length code to send.
1611 max_blindex
= build_bl_tree();
1613 /* Determine the best encoding. Compute first the block length in bytes */
1614 opt_lenb
= (G2
.opt_len
+ 3 + 7) >> 3;
1615 static_lenb
= (G2
.static_len
+ 3 + 7) >> 3;
1618 "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
1619 opt_lenb
, G2
.opt_len
, static_lenb
, G2
.static_len
, stored_len
,
1620 G2
.last_lit
, G2
.last_dist
));
1622 if (static_lenb
<= opt_lenb
)
1623 opt_lenb
= static_lenb
;
1625 /* If compression failed and this is the first and last block,
1626 * and if the zip file can be seeked (to rewrite the local header),
1627 * the whole file is transformed into a stored file:
1629 if (stored_len
<= opt_lenb
&& eof
&& G2
.compressed_len
== 0L && seekable()) {
1630 /* Since LIT_BUFSIZE <= 2*WSIZE, the input data must be there: */
1632 bb_error_msg("block vanished");
1634 copy_block(buf
, (unsigned) stored_len
, 0); /* without header */
1635 G2
.compressed_len
= stored_len
<< 3;
1637 } else if (stored_len
+ 4 <= opt_lenb
&& buf
!= NULL
) {
1638 /* 4: two words for the lengths */
1639 /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
1640 * Otherwise we can't have processed more than WSIZE input bytes since
1641 * the last block flush, because compression would have been
1642 * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
1643 * transform a block into a stored block.
1645 send_bits((STORED_BLOCK
<< 1) + eof
, 3); /* send block type */
1646 G2
.compressed_len
= (G2
.compressed_len
+ 3 + 7) & ~7L;
1647 G2
.compressed_len
+= (stored_len
+ 4) << 3;
1649 copy_block(buf
, (unsigned) stored_len
, 1); /* with header */
1651 } else if (static_lenb
== opt_lenb
) {
1652 send_bits((STATIC_TREES
<< 1) + eof
, 3);
1653 compress_block((ct_data
*) G2
.static_ltree
, (ct_data
*) G2
.static_dtree
);
1654 G2
.compressed_len
+= 3 + G2
.static_len
;
1656 send_bits((DYN_TREES
<< 1) + eof
, 3);
1657 send_all_trees(G2
.l_desc
.max_code
+ 1, G2
.d_desc
.max_code
+ 1,
1659 compress_block((ct_data
*) G2
.dyn_ltree
, (ct_data
*) G2
.dyn_dtree
);
1660 G2
.compressed_len
+= 3 + G2
.opt_len
;
1662 Assert(G2
.compressed_len
== G1
.bits_sent
, "bad compressed size");
1667 G2
.compressed_len
+= 7; /* align on byte boundary */
1669 Tracev((stderr
, "\ncomprlen %lu(%lu) ", G2
.compressed_len
>> 3,
1670 G2
.compressed_len
- 7 * eof
));
1672 return G2
.compressed_len
>> 3;
1676 /* ===========================================================================
1677 * Update a hash value with the given input byte
1678 * IN assertion: all calls to to UPDATE_HASH are made with consecutive
1679 * input characters, so that a running hash key can be computed from the
1680 * previous key instead of complete recalculation each time.
1682 #define UPDATE_HASH(h, c) (h = (((h)<<H_SHIFT) ^ (c)) & HASH_MASK)
1685 /* ===========================================================================
1686 * Same as above, but achieves better compression. We use a lazy
1687 * evaluation for matches: a match is finally adopted only if there is
1688 * no better match at the next window position.
1690 * Processes a new input file and return its compressed length. Sets
1691 * the compressed length, crc, deflate flags and internal file
1695 /* Flush the current block, with given end-of-file flag.
1696 * IN assertion: strstart is set to the end of the current match. */
1697 #define FLUSH_BLOCK(eof) \
1699 G1.block_start >= 0L \
1700 ? (char*)&G1.window[(unsigned)G1.block_start] \
1702 (ulg)G1.strstart - G1.block_start, \
1706 /* Insert string s in the dictionary and set match_head to the previous head
1707 * of the hash chain (the most recent string with same hash key). Return
1708 * the previous length of the hash chain.
1709 * IN assertion: all calls to to INSERT_STRING are made with consecutive
1710 * input characters and the first MIN_MATCH bytes of s are valid
1711 * (except for the last MIN_MATCH-1 bytes of the input file). */
1712 #define INSERT_STRING(s, match_head) \
1714 UPDATE_HASH(G1.ins_h, G1.window[(s) + MIN_MATCH-1]); \
1715 G1.prev[(s) & WMASK] = match_head = head[G1.ins_h]; \
1716 head[G1.ins_h] = (s); \
1719 static ulg
deflate(void)
1721 IPos hash_head
; /* head of hash chain */
1722 IPos prev_match
; /* previous match */
1723 int flush
; /* set if current block must be flushed */
1724 int match_available
= 0; /* set if previous match exists */
1725 unsigned match_length
= MIN_MATCH
- 1; /* length of best match */
1727 /* Process the input block. */
1728 while (G1
.lookahead
!= 0) {
1729 /* Insert the string window[strstart .. strstart+2] in the
1730 * dictionary, and set hash_head to the head of the hash chain:
1732 INSERT_STRING(G1
.strstart
, hash_head
);
1734 /* Find the longest match, discarding those <= prev_length.
1736 G1
.prev_length
= match_length
;
1737 prev_match
= G1
.match_start
;
1738 match_length
= MIN_MATCH
- 1;
1740 if (hash_head
!= 0 && G1
.prev_length
< max_lazy_match
1741 && G1
.strstart
- hash_head
<= MAX_DIST
1743 /* To simplify the code, we prevent matches with the string
1744 * of window index 0 (in particular we have to avoid a match
1745 * of the string with itself at the start of the input file).
1747 match_length
= longest_match(hash_head
);
1748 /* longest_match() sets match_start */
1749 if (match_length
> G1
.lookahead
)
1750 match_length
= G1
.lookahead
;
1752 /* Ignore a length 3 match if it is too distant: */
1753 if (match_length
== MIN_MATCH
&& G1
.strstart
- G1
.match_start
> TOO_FAR
) {
1754 /* If prev_match is also MIN_MATCH, G1.match_start is garbage
1755 * but we will ignore the current match anyway.
1760 /* If there was a match at the previous step and the current
1761 * match is not better, output the previous match:
1763 if (G1
.prev_length
>= MIN_MATCH
&& match_length
<= G1
.prev_length
) {
1764 check_match(G1
.strstart
- 1, prev_match
, G1
.prev_length
);
1765 flush
= ct_tally(G1
.strstart
- 1 - prev_match
, G1
.prev_length
- MIN_MATCH
);
1767 /* Insert in hash table all strings up to the end of the match.
1768 * strstart-1 and strstart are already inserted.
1770 G1
.lookahead
-= G1
.prev_length
- 1;
1771 G1
.prev_length
-= 2;
1774 INSERT_STRING(G1
.strstart
, hash_head
);
1775 /* strstart never exceeds WSIZE-MAX_MATCH, so there are
1776 * always MIN_MATCH bytes ahead. If lookahead < MIN_MATCH
1777 * these bytes are garbage, but it does not matter since the
1778 * next lookahead bytes will always be emitted as literals.
1780 } while (--G1
.prev_length
!= 0);
1781 match_available
= 0;
1782 match_length
= MIN_MATCH
- 1;
1786 G1
.block_start
= G1
.strstart
;
1788 } else if (match_available
) {
1789 /* If there was no match at the previous position, output a
1790 * single literal. If there was a match but the current match
1791 * is longer, truncate the previous match to a single literal.
1793 Tracevv((stderr
, "%c", G1
.window
[G1
.strstart
- 1]));
1794 if (ct_tally(0, G1
.window
[G1
.strstart
- 1])) {
1796 G1
.block_start
= G1
.strstart
;
1801 /* There is no previous match to compare with, wait for
1802 * the next step to decide.
1804 match_available
= 1;
1808 Assert(G1
.strstart
<= G1
.isize
&& lookahead
<= G1
.isize
, "a bit too far");
1810 /* Make sure that we always have enough lookahead, except
1811 * at the end of the input file. We need MAX_MATCH bytes
1812 * for the next match, plus MIN_MATCH bytes to insert the
1813 * string following the next match.
1815 while (G1
.lookahead
< MIN_LOOKAHEAD
&& !G1
.eofile
)
1818 if (match_available
)
1819 ct_tally(0, G1
.window
[G1
.strstart
- 1]);
1821 return FLUSH_BLOCK(1); /* eof */
1825 /* ===========================================================================
1826 * Initialize the bit string routines.
1828 static void bi_init(void)
1838 /* ===========================================================================
1839 * Initialize the "longest match" routines for a new file
1841 static void lm_init(ush
* flagsp
)
1845 /* Initialize the hash table. */
1846 memset(head
, 0, HASH_SIZE
* sizeof(*head
));
1847 /* prev will be initialized on the fly */
1849 /* speed options for the general purpose bit flag */
1850 *flagsp
|= 2; /* FAST 4, SLOW 2 */
1851 /* ??? reduce max_chain_length for binary files */
1854 G1
.block_start
= 0L;
1856 G1
.lookahead
= file_read(G1
.window
,
1857 sizeof(int) <= 2 ? (unsigned) WSIZE
: 2 * WSIZE
);
1859 if (G1
.lookahead
== 0 || G1
.lookahead
== (unsigned) -1) {
1865 /* Make sure that we always have enough lookahead. This is important
1866 * if input comes from a device such as a tty.
1868 while (G1
.lookahead
< MIN_LOOKAHEAD
&& !G1
.eofile
)
1872 for (j
= 0; j
< MIN_MATCH
- 1; j
++)
1873 UPDATE_HASH(G1
.ins_h
, G1
.window
[j
]);
1874 /* If lookahead < MIN_MATCH, ins_h is garbage, but this is
1875 * not important since only literal bytes will be emitted.
1880 /* ===========================================================================
1881 * Allocate the match buffer, initialize the various tables and save the
1882 * location of the internal file attribute (ascii/binary) and method
1884 * One callsite in zip()
1886 static void ct_init(void)
1888 int n
; /* iterates over tree elements */
1889 int length
; /* length value */
1890 int code
; /* code value */
1891 int dist
; /* distance index */
1893 G2
.compressed_len
= 0L;
1896 if (G2
.static_dtree
[0].Len
!= 0)
1897 return; /* ct_init already called */
1900 /* Initialize the mapping length (0..255) -> length code (0..28) */
1902 for (code
= 0; code
< LENGTH_CODES
- 1; code
++) {
1903 G2
.base_length
[code
] = length
;
1904 for (n
= 0; n
< (1 << extra_lbits
[code
]); n
++) {
1905 G2
.length_code
[length
++] = code
;
1908 Assert(length
== 256, "ct_init: length != 256");
1909 /* Note that the length 255 (match length 258) can be represented
1910 * in two different ways: code 284 + 5 bits or code 285, so we
1911 * overwrite length_code[255] to use the best encoding:
1913 G2
.length_code
[length
- 1] = code
;
1915 /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
1917 for (code
= 0; code
< 16; code
++) {
1918 G2
.base_dist
[code
] = dist
;
1919 for (n
= 0; n
< (1 << extra_dbits
[code
]); n
++) {
1920 G2
.dist_code
[dist
++] = code
;
1923 Assert(dist
== 256, "ct_init: dist != 256");
1924 dist
>>= 7; /* from now on, all distances are divided by 128 */
1925 for (; code
< D_CODES
; code
++) {
1926 G2
.base_dist
[code
] = dist
<< 7;
1927 for (n
= 0; n
< (1 << (extra_dbits
[code
] - 7)); n
++) {
1928 G2
.dist_code
[256 + dist
++] = code
;
1931 Assert(dist
== 256, "ct_init: 256+dist != 512");
1933 /* Construct the codes of the static literal tree */
1934 /* already zeroed - it's in bss
1935 for (n = 0; n <= MAX_BITS; n++)
1936 G2.bl_count[n] = 0; */
1940 G2
.static_ltree
[n
++].Len
= 8;
1944 G2
.static_ltree
[n
++].Len
= 9;
1948 G2
.static_ltree
[n
++].Len
= 7;
1952 G2
.static_ltree
[n
++].Len
= 8;
1955 /* Codes 286 and 287 do not exist, but we must include them in the
1956 * tree construction to get a canonical Huffman tree (longest code
1959 gen_codes((ct_data
*) G2
.static_ltree
, L_CODES
+ 1);
1961 /* The static distance tree is trivial: */
1962 for (n
= 0; n
< D_CODES
; n
++) {
1963 G2
.static_dtree
[n
].Len
= 5;
1964 G2
.static_dtree
[n
].Code
= bi_reverse(n
, 5);
1967 /* Initialize the first block of the first file: */
1972 /* ===========================================================================
1973 * Deflate in to out.
1974 * IN assertions: the input and output buffers are cleared.
1977 static void zip(ulg time_stamp
)
1979 ush deflate_flags
= 0; /* pkzip -es, -en or -ex equivalent */
1983 /* Write the header to the gzip file. See algorithm.doc for the format */
1984 /* magic header for gzip files: 1F 8B */
1985 /* compression method: 8 (DEFLATED) */
1986 /* general flags: 0 */
1987 put_32bit(0x00088b1f);
1988 put_32bit(time_stamp
);
1990 /* Write deflated file to zip file */
1995 lm_init(&deflate_flags
);
1997 put_8bit(deflate_flags
); /* extra flags */
1998 put_8bit(3); /* OS identifier = 3 (Unix) */
2002 /* Write the crc and uncompressed size */
2004 put_32bit(G1
.isize
);
2010 /* ======================================================================== */
2012 char* make_new_name_gzip(char *filename
)
2014 return xasprintf("%s.gz", filename
);
2018 USE_DESKTOP(long long) int pack_gzip(unpack_info_t
*info UNUSED_PARAM
)
2024 fstat(STDIN_FILENO
, &s
);
2030 * Linux kernel build uses gzip -d -n. We accept and ignore it.
2033 * gzip: do not save the original file name and time stamp.
2034 * (The original name is always saved if the name had to be truncated.)
2035 * gunzip: do not restore the original file name/time even if present
2036 * (remove only the gzip suffix from the compressed file name).
2037 * This option is the default when decompressing.
2039 * gzip: always save the original file name and time stamp (this is the default)
2040 * gunzip: restore the original file name and time stamp if present.
2043 int gzip_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
2045 int gzip_main(int argc
, char **argv
)
2047 int gzip_main(int argc UNUSED_PARAM
, char **argv
)
2052 /* Must match bbunzip's constants OPT_STDOUT, OPT_FORCE! */
2053 opt
= getopt32(argv
, "cfv" USE_GUNZIP("dt") "q123456789n");
2054 #if ENABLE_GUNZIP /* gunzip_main may not be visible... */
2055 if (opt
& 0x18) // -d and/or -t
2056 return gunzip_main(argc
, argv
);
2058 option_mask32
&= 0x7; /* ignore -q, -0..9 */
2059 //if (opt & 0x1) // -c
2060 //if (opt & 0x2) // -f
2061 //if (opt & 0x4) // -v
2064 SET_PTR_TO_GLOBALS(xzalloc(sizeof(struct globals
) + sizeof(struct globals2
))
2065 + sizeof(struct globals
));
2067 G2
.l_desc
.dyn_tree
= G2
.dyn_ltree
;
2068 G2
.l_desc
.static_tree
= G2
.static_ltree
;
2069 G2
.l_desc
.extra_bits
= extra_lbits
;
2070 G2
.l_desc
.extra_base
= LITERALS
+ 1;
2071 G2
.l_desc
.elems
= L_CODES
;
2072 G2
.l_desc
.max_length
= MAX_BITS
;
2073 //G2.l_desc.max_code = 0;
2075 G2
.d_desc
.dyn_tree
= G2
.dyn_dtree
;
2076 G2
.d_desc
.static_tree
= G2
.static_dtree
;
2077 G2
.d_desc
.extra_bits
= extra_dbits
;
2078 //G2.d_desc.extra_base = 0;
2079 G2
.d_desc
.elems
= D_CODES
;
2080 G2
.d_desc
.max_length
= MAX_BITS
;
2081 //G2.d_desc.max_code = 0;
2083 G2
.bl_desc
.dyn_tree
= G2
.bl_tree
;
2084 //G2.bl_desc.static_tree = NULL;
2085 G2
.bl_desc
.extra_bits
= extra_blbits
,
2086 //G2.bl_desc.extra_base = 0;
2087 G2
.bl_desc
.elems
= BL_CODES
;
2088 G2
.bl_desc
.max_length
= MAX_BL_BITS
;
2089 //G2.bl_desc.max_code = 0;
2091 /* Allocate all global buffers (for DYN_ALLOC option) */
2092 ALLOC(uch
, G1
.l_buf
, INBUFSIZ
);
2093 ALLOC(uch
, G1
.outbuf
, OUTBUFSIZ
);
2094 ALLOC(ush
, G1
.d_buf
, DIST_BUFSIZE
);
2095 ALLOC(uch
, G1
.window
, 2L * WSIZE
);
2096 ALLOC(ush
, G1
.prev
, 1L << BITS
);
2098 /* Initialise the CRC32 table */
2099 G1
.crc_32_tab
= crc32_filltable(NULL
, 0);
2101 return bbunpack(argv
, make_new_name_gzip
, pack_gzip
);