include/llvm/Support/Compressor.h

   1 //===- llvm/Support/Compressor.h --------------------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file declares the llvm::Compressor class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SUPPORT_COMPRESSOR_H
  15 #define LLVM_SUPPORT_COMPRESSOR_H
  16
  17 #include "llvm/Support/DataTypes.h"
  18 #include <ostream>
  19
  20 namespace llvm {
  21
  22   /// This class provides an abstraction for compression and decompression of
  23   /// a block of memory.  The algorithm used here is currently bzip2 but that
  24   /// may change without notice. Should newer algorithms prove to compress
  25   /// bytecode better than bzip2, that newer algorithm will be added, but won't
  26   /// replace bzip2. This interface allows us to abstract the notion of
  27   /// compression and deal with alternate compression schemes over time.
  28   /// The type of compression used can be determined by inspecting the
  29   /// first byte of the compressed output. Currently value '0' means no
  30   /// compression was used (for very small files) and value '2' means bzip2
  31   /// compression was used.  The Compressor is intended for use with memory
  32   /// mapped files where the entire data block to be compressed or decompressed
  33   /// is available in memory. However, output can be gathered in repeated calls
  34   /// to a callback.  Utilities for sending compressed or decompressed output
  35   /// to a stream or directly to a memory block are also provided.
  36   /// @since 1.4
  37   /// @brief An abstraction for memory to memory data (de)compression
  38   class Compressor {
  39     /// @name High Level Interface
  40     /// @{
  41     public:
  42       /// This method compresses a block of memory pointed to by \p in with
  43       /// size \p size to a block of memory, \p out, that is allocated with
  44       /// malloc. It is the caller's responsibility to free \p out. The \p hint
  45       /// indicates which type of compression the caller would *prefer*.
  46       /// @throws std::string explaining error if a compression error occurs
  47       /// @returns The size of the output buffer \p out.
  48       /// @brief Compress memory to a new memory buffer.
  49       static uint64_t compressToNewBuffer(
  50         const char* in,           ///< The buffer to be compressed
  51         unsigned size,            ///< The size of the buffer to be compressed
  52         char*&out                 ///< The returned output buffer
  53       );
  54
  55       /// This method compresses a block of memory pointed to by \p in with
  56       /// size \p size to a stream. The stream \p out must be open and ready for
  57       /// writing when this method is called. The stream will not be closed by
  58       /// this method.  The \p hint argument indicates which type of
  59       /// compression the caller would *prefer*.
  60       /// @returns The amount of data written to \p out.
  61       /// @brief Compress memory to a file.
  62       static uint64_t compressToStream(
  63         const char*in,            ///< The buffer to be compressed
  64         unsigned size,            ///< The size of the buffer to be compressed
  65         std::ostream& out         ///< The output stream to write data on
  66       );
  67
  68       /// This method decompresses a block of memory pointed to by \p in with
  69       /// size \p size to a new block of memory, \p out, \p that was allocated
  70       /// by malloc. It is the caller's responsibility to free \p out.
  71       /// @returns The size of the output buffer \p out.
  72       /// @brief Decompress memory to a new memory buffer.
  73       static uint64_t decompressToNewBuffer(
  74         const char *in,           ///< The buffer to be decompressed
  75         unsigned size,            ///< Size of the buffer to be decompressed
  76         char*&out                 ///< The returned output buffer
  77       );
  78
  79       /// This method decompresses a block of memory pointed to by \p in with
  80       /// size \p size to a stream. The stream \p out must be open and ready for
  81       /// writing when this method is called. The stream will not be closed by
  82       /// this method.
  83       /// @returns The amount of data written to \p out.
  84       /// @brief Decompress memory to a stream.
  85       static uint64_t decompressToStream(
  86         const char *in,           ///< The buffer to be decompressed
  87         unsigned size,            ///< Size of the buffer to be decompressed
  88         std::ostream& out         ///< The stream to write write data on
  89       );
  90
  91     /// @}
  92     /// @name Low Level Interface
  93     /// @{
  94     public:
  95       /// A callback function type used by the Compressor's low level interface
  96       /// to get the next chunk of data to which (de)compressed output will be
  97       /// written. This callback completely abstracts the notion of how to
  98       /// handle the output data of compression or decompression. The callback
  99       /// is responsible for determining both the storage location and the size
 100       /// of the output. The callback may also do other things with the data
 101       /// such as write it, transmit it, etc. Note that providing very small
 102       /// values for \p size will make the compression run very inefficiently.
 103       /// It is recommended that \p size be chosen based on the some multiple or
 104       /// fraction of the object being decompressed or compressed, respetively.
 105       /// @returns 0 for success, 1 for failure
 106       /// @throws nothing
 107       /// @brief Output callback function type
 108       typedef unsigned (OutputDataCallback)(char*& buffer, unsigned& size,
 109                                             void* context);
 110
 111       /// This function does the compression work. The block of memory starting
 112       /// at \p in and extending for \p size bytes is compressed. The compressed
 113       /// output is written to memory blocks returned by the \p cb callback. The
 114       /// caller must provide an implementation of the OutputDataCallback
 115       /// function type and provide its address as \p cb. Note that the callback
 116       /// function will be called as many times as necessary to complete the
 117       /// compression of the \p in block but that the total size will generally
 118       /// be less than \p size. It is a good idea to provide as large a value to
 119       /// the callback's \p size parameter as possible so that fewer calls to
 120       /// the callback are made. The \p hint parameter tells the function which
 121       /// kind of compression to start with. However, if its not available on
 122       /// the platform, the algorithm "falls back" from bzip2 -> zlib -> simple.
 123       /// @throws std::string if an error occurs
 124       /// @returns the total size of the compressed data
 125       /// @brief Compress a block of memory.
 126       static uint64_t compress(
 127         const char* in,            ///< The buffer to be compressed
 128         unsigned size,             ///< The size of the buffer to be compressed
 129         OutputDataCallback* cb,    ///< Call back for memory allocation
 130         void* context = 0          ///< Context for callback
 131       );
 132
 133       /// This function does the decompression work. The block of memory
 134       /// starting at \p in and extending for \p size bytes is decompressed. The
 135       /// decompressed output is written to memory blocks returned by the \p cb
 136       /// callback. The caller must provide an implementation of the
 137       /// OutputDataCallback function type and provide its address as \p cb.
 138       /// Note that the callback function will be called as many times as
 139       /// necessary to complete the compression of the \p in block but that the
 140       /// total size will generally be greater than \p size. It is a good idea
 141       /// to provide as large a value to the callback's \p size parameter as
 142       /// possible so that fewer calls to the callback are made.
 143       /// @throws std::string if an error occurs
 144       /// @returns the total size of the decompressed data
 145       /// @brief Decompress a block of memory.
 146       static uint64_t decompress(
 147         const char *in,              ///< The buffer to be decompressed
 148         unsigned size,               ///< Size of the buffer to be decompressed
 149         OutputDataCallback* cb,      ///< Call back for memory allocation
 150         void* context = 0            ///< Context for callback
 151       );
 152
 153     /// @}
 154   };
 155 }
 156
 157 // vim: sw=2 ai
 158
 159 #endif