Compression.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2020 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLED_COMPRESSION_H_INCLUDED
#define RIPPLED_COMPRESSION_H_INCLUDED
 
#include <xrpl/basics/CompressionAlgorithms.h>
#include <xrpl/basics/Log.h>
#include <lz4frame.h>
 
namespace ripple {
 
namespace compression {
 
std::size_t constexpr headerBytes = 6;
std::size_t constexpr headerBytesCompressed = 10;
 
// All values other than 'none' must have the high bit. The low order four bits
// must be 0.
enum class Algorithm : std::uint8_t { None = 0x00, LZ4 = 0x90 };
 
enum class Compressed : std::uint8_t { On, Off };
 
template <typename InputStream>
std::size_t
decompress(
    InputStream& in,
    std::size_t inSize,
    std::uint8_t* decompressed,
    std::size_t decompressedSize,
    Algorithm algorithm = Algorithm::LZ4)
{
    try
    {
        if (algorithm == Algorithm::LZ4)
            return ripple::compression_algorithms::lz4Decompress(
                in, inSize, decompressed, decompressedSize);
        else
        {
            JLOG(debugLog().warn())
                << "decompress: invalid compression algorithm "
                << static_cast<int>(algorithm);
            UNREACHABLE(
                "ripple::compression::decompress : invalid compression "
                "algorithm");
        }
    }
    catch (...)
    {
    }
    return 0;
}
 
template <class BufferFactory>
std::size_t
compress(
    void const* in,
    std::size_t inSize,
    BufferFactory&& bf,
    Algorithm algorithm = Algorithm::LZ4)
{
    try
    {
        if (algorithm == Algorithm::LZ4)
            return ripple::compression_algorithms::lz4Compress(
                in, inSize, std::forward<BufferFactory>(bf));
        else
        {
            JLOG(debugLog().warn()) << "compress: invalid compression algorithm"
                                    << static_cast<int>(algorithm);
            UNREACHABLE(
                "ripple::compression::compress : invalid compression "
                "algorithm");
        }
    }
    catch (...)
    {
    }
    return 0;
}
}  // namespace compression
 
}  // namespace ripple
 
#endif  // RIPPLED_COMPRESSION_H_INCLUDED