archival/bzip2.c

   1 /*
   2  * Copyright (C) 2007 Denys Vlasenko <vda.linux@googlemail.com>
   3  *
   4  * This file uses bzip2 library code which is written
   5  * by Julian Seward <jseward@bzip.org>.
   6  * See README and LICENSE files in bz/ directory for more information
   7  * about bzip2 library code.
   8  */
   9
  10 //config:config BZIP2
  11 //config:       bool "bzip2"
  12 //config:       default y
  13 //config:       help
  14 //config:         bzip2 is a compression utility using the Burrows-Wheeler block
  15 //config:         sorting text compression algorithm, and Huffman coding. Compression
  16 //config:         is generally considerably better than that achieved by more
  17 //config:         conventional LZ77/LZ78-based compressors, and approaches the
  18 //config:         performance of the PPM family of statistical compressors.
  19 //config:
  20 //config:         Unless you have a specific application which requires bzip2, you
  21 //config:         should probably say N here.
  22 //config:
  23 //config:config FEATURE_BZIP2_DECOMPRESS
  24 //config:       bool "Enable decompression"
  25 //config:       default y
  26 //config:       depends on BZIP2 || BUNZIP2 || BZCAT
  27 //config:       help
  28 //config:         Enable -d (--decompress) and -t (--test) options for bzip2.
  29 //config:         This will be automatically selected if bunzip2 or bzcat is
  30 //config:         enabled.
  31
  32 //applet:IF_BZIP2(APPLET(bzip2, BB_DIR_USR_BIN, BB_SUID_DROP))
  33 //kbuild:lib-$(CONFIG_BZIP2) += bzip2.o
  34
  35 //usage:#define bzip2_trivial_usage
  36 //usage:       "[OPTIONS] [FILE]..."
  37 //usage:#define bzip2_full_usage "\n\n"
  38 //usage:       "Compress FILEs (or stdin) with bzip2 algorithm\n"
  39 //usage:     "\n        -1..9   Compression level"
  40 //usage:        IF_FEATURE_BZIP2_DECOMPRESS(
  41 //usage:     "\n        -d      Decompress"
  42 //usage:     "\n        -t      Test file integrity"
  43 //usage:        )
  44 //usage:     "\n        -c      Write to stdout"
  45 //usage:     "\n        -f      Force"
  46
  47 #include "libbb.h"
  48 #include "bb_archive.h"
  49
  50 #define CONFIG_BZIP2_FAST 1
  51
  52 /* Speed test:
  53  * Compiled with gcc 4.2.1, run on Athlon 64 1800 MHz (512K L2 cache).
  54  * Stock bzip2 is 26.4% slower than bbox bzip2 at SPEED 1
  55  * (time to compress gcc-4.2.1.tar is 126.4% compared to bbox).
  56  * At SPEED 5 difference is 32.7%.
  57  *
  58  * Test run of all CONFIG_BZIP2_FAST values on a 11Mb text file:
  59  *     Size   Time (3 runs)
  60  * 0:  10828  4.145 4.146 4.148
  61  * 1:  11097  3.845 3.860 3.861
  62  * 2:  11392  3.763 3.767 3.768
  63  * 3:  11892  3.722 3.724 3.727
  64  * 4:  12740  3.637 3.640 3.644
  65  * 5:  17273  3.497 3.509 3.509
  66  */
  67
  68
  69 #define BZ_DEBUG 0
  70 /* Takes ~300 bytes, detects corruption caused by bad RAM etc */
  71 #define BZ_LIGHT_DEBUG 0
  72
  73 #include "libarchive/bz/bzlib.h"
  74
  75 #include "libarchive/bz/bzlib_private.h"
  76
  77 #include "libarchive/bz/blocksort.c"
  78 #include "libarchive/bz/bzlib.c"
  79 #include "libarchive/bz/compress.c"
  80 #include "libarchive/bz/huffman.c"
  81
  82 /* No point in being shy and having very small buffer here.
  83  * bzip2 internal buffers are much bigger anyway, hundreds of kbytes.
  84  * If iobuf is several pages long, malloc() may use mmap,
  85  * making iobuf is page aligned and thus (maybe) have one memcpy less
  86  * if kernel is clever enough.
  87  */
  88 enum {
  89         IOBUF_SIZE = 8 * 1024
  90 };
  91
  92 static uint8_t level;
  93
  94 /* NB: compressStream() has to return -1 on errors, not die.
  95  * bbunpack() will correctly clean up in this case
  96  * (delete incomplete .bz2 file)
  97  */
  98
  99 /* Returns:
 100  * -1 on errors
 101  * total written bytes so far otherwise
 102  */
 103 static
 104 IF_DESKTOP(long long) int bz_write(bz_stream *strm, void* rbuf, ssize_t rlen, void *wbuf)
 105 {
 106         int n, n2, ret;
 107
 108         strm->avail_in = rlen;
 109         strm->next_in = rbuf;
 110         while (1) {
 111                 strm->avail_out = IOBUF_SIZE;
 112                 strm->next_out = wbuf;
 113
 114                 ret = BZ2_bzCompress(strm, rlen ? BZ_RUN : BZ_FINISH);
 115                 if (ret != BZ_RUN_OK /* BZ_RUNning */
 116                  && ret != BZ_FINISH_OK /* BZ_FINISHing, but not done yet */
 117                  && ret != BZ_STREAM_END /* BZ_FINISHed */
 118                 ) {
 119                         bb_error_msg_and_die("internal error %d", ret);
 120                 }
 121
 122                 n = IOBUF_SIZE - strm->avail_out;
 123                 if (n) {
 124                         n2 = full_write(STDOUT_FILENO, wbuf, n);
 125                         if (n2 != n) {
 126                                 if (n2 >= 0)
 127                                         errno = 0; /* prevent bogus error message */
 128                                 bb_perror_msg(n2 >= 0 ? "short write" : bb_msg_write_error);
 129                                 return -1;
 130                         }
 131                 }
 132
 133                 if (ret == BZ_STREAM_END)
 134                         break;
 135                 if (rlen && strm->avail_in == 0)
 136                         break;
 137         }
 138         return 0 IF_DESKTOP( + strm->total_out );
 139 }
 140
 141 static
 142 IF_DESKTOP(long long) int FAST_FUNC compressStream(transformer_state_t *xstate UNUSED_PARAM)
 143 {
 144         IF_DESKTOP(long long) int total;
 145         ssize_t count;
 146         bz_stream bzs; /* it's small */
 147 #define strm (&bzs)
 148         char *iobuf;
 149 #define rbuf iobuf
 150 #define wbuf (iobuf + IOBUF_SIZE)
 151
 152         iobuf = xmalloc(2 * IOBUF_SIZE);
 153         BZ2_bzCompressInit(strm, level);
 154
 155         while (1) {
 156                 count = full_read(STDIN_FILENO, rbuf, IOBUF_SIZE);
 157                 if (count < 0) {
 158                         bb_perror_msg(bb_msg_read_error);
 159                         total = -1;
 160                         break;
 161                 }
 162                 /* if count == 0, bz_write finalizes compression */
 163                 total = bz_write(strm, rbuf, count, wbuf);
 164                 if (count == 0 || total < 0)
 165                         break;
 166         }
 167
 168         /* Can't be conditional on ENABLE_FEATURE_CLEAN_UP -
 169          * we are called repeatedly
 170          */
 171         BZ2_bzCompressEnd(strm);
 172         free(iobuf);
 173
 174         return total;
 175 }
 176
 177 int bzip2_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 178 int bzip2_main(int argc UNUSED_PARAM, char **argv)
 179 {
 180         unsigned opt;
 181
 182         /* standard bzip2 flags
 183          * -d --decompress force decompression
 184          * -z --compress force compression
 185          * -k --keep     keep (don't delete) input files
 186          * -f --force    overwrite existing output files
 187          * -t --test     test compressed file integrity
 188          * -c --stdout   output to standard out
 189          * -q --quiet    suppress noncritical error messages
 190          * -v --verbose  be verbose (a 2nd -v gives more)
 191          * -s --small    use less memory (at most 2500k)
 192          * -1 .. -9      set block size to 100k .. 900k
 193          * --fast        alias for -1
 194          * --best        alias for -9
 195          */
 196
 197         opt_complementary = "s2"; /* -s means -2 (compatibility) */
 198         /* Must match bbunzip's constants OPT_STDOUT, OPT_FORCE! */
 199         opt = getopt32(argv, "cfv" IF_FEATURE_BZIP2_DECOMPRESS("dt") "123456789qzs");
 200 #if ENABLE_FEATURE_BZIP2_DECOMPRESS /* bunzip2_main may not be visible... */
 201         if (opt & 0x18) // -d and/or -t
 202                 return bunzip2_main(argc, argv);
 203         opt >>= 5;
 204 #else
 205         opt >>= 3;
 206 #endif
 207         opt = (uint8_t)opt; /* isolate bits for -1..-8 */
 208         opt |= 0x100; /* if nothing else, assume -9 */
 209         level = 1;
 210         while (!(opt & 1)) {
 211                 level++;
 212                 opt >>= 1;
 213         }
 214
 215         argv += optind;
 216         option_mask32 &= 0x7; /* ignore all except -cfv */
 217         return bbunpack(argv, compressStream, append_ext, "bz2");
 218 }