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