mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-25 17:36:06 +00:00
124d0b787b
Added --offload-compression-level= option to clang and -compression-level= option to clang-offload-bundler for controlling compression level. Added support of long distance matching (LDM) for llvm::zstd which is off by default. Enable it for clang-offload-bundler by default since it improves compression rate in general. Change default compression level to 3 for zstd for clang-offload-bundler since it works well for bundle entry size from 1KB to 32MB, which should cover most of the clang-offload-bundler usage. Users can still specify compression level by -compression-level= option if necessary.
244 lines
8.6 KiB
C++
244 lines
8.6 KiB
C++
//===--- Compression.cpp - Compression implementation ---------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements compression functions.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Support/Compression.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Config/config.h"
|
|
#include "llvm/Support/Compiler.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/ErrorHandling.h"
|
|
#if LLVM_ENABLE_ZLIB
|
|
#include <zlib.h>
|
|
#endif
|
|
#if LLVM_ENABLE_ZSTD
|
|
#include <zstd.h>
|
|
#endif
|
|
|
|
using namespace llvm;
|
|
using namespace llvm::compression;
|
|
|
|
const char *compression::getReasonIfUnsupported(compression::Format F) {
|
|
switch (F) {
|
|
case compression::Format::Zlib:
|
|
if (zlib::isAvailable())
|
|
return nullptr;
|
|
return "LLVM was not built with LLVM_ENABLE_ZLIB or did not find zlib at "
|
|
"build time";
|
|
case compression::Format::Zstd:
|
|
if (zstd::isAvailable())
|
|
return nullptr;
|
|
return "LLVM was not built with LLVM_ENABLE_ZSTD or did not find zstd at "
|
|
"build time";
|
|
}
|
|
llvm_unreachable("");
|
|
}
|
|
|
|
void compression::compress(Params P, ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &Output) {
|
|
switch (P.format) {
|
|
case compression::Format::Zlib:
|
|
zlib::compress(Input, Output, P.level);
|
|
break;
|
|
case compression::Format::Zstd:
|
|
zstd::compress(Input, Output, P.level, P.zstdEnableLdm);
|
|
break;
|
|
}
|
|
}
|
|
|
|
Error compression::decompress(DebugCompressionType T, ArrayRef<uint8_t> Input,
|
|
uint8_t *Output, size_t UncompressedSize) {
|
|
switch (formatFor(T)) {
|
|
case compression::Format::Zlib:
|
|
return zlib::decompress(Input, Output, UncompressedSize);
|
|
case compression::Format::Zstd:
|
|
return zstd::decompress(Input, Output, UncompressedSize);
|
|
}
|
|
llvm_unreachable("");
|
|
}
|
|
|
|
Error compression::decompress(compression::Format F, ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &Output,
|
|
size_t UncompressedSize) {
|
|
switch (F) {
|
|
case compression::Format::Zlib:
|
|
return zlib::decompress(Input, Output, UncompressedSize);
|
|
case compression::Format::Zstd:
|
|
return zstd::decompress(Input, Output, UncompressedSize);
|
|
}
|
|
llvm_unreachable("");
|
|
}
|
|
|
|
Error compression::decompress(DebugCompressionType T, ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &Output,
|
|
size_t UncompressedSize) {
|
|
return decompress(formatFor(T), Input, Output, UncompressedSize);
|
|
}
|
|
|
|
#if LLVM_ENABLE_ZLIB
|
|
|
|
static StringRef convertZlibCodeToString(int Code) {
|
|
switch (Code) {
|
|
case Z_MEM_ERROR:
|
|
return "zlib error: Z_MEM_ERROR";
|
|
case Z_BUF_ERROR:
|
|
return "zlib error: Z_BUF_ERROR";
|
|
case Z_STREAM_ERROR:
|
|
return "zlib error: Z_STREAM_ERROR";
|
|
case Z_DATA_ERROR:
|
|
return "zlib error: Z_DATA_ERROR";
|
|
case Z_OK:
|
|
default:
|
|
llvm_unreachable("unknown or unexpected zlib status code");
|
|
}
|
|
}
|
|
|
|
bool zlib::isAvailable() { return true; }
|
|
|
|
void zlib::compress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &CompressedBuffer, int Level) {
|
|
unsigned long CompressedSize = ::compressBound(Input.size());
|
|
CompressedBuffer.resize_for_overwrite(CompressedSize);
|
|
int Res = ::compress2((Bytef *)CompressedBuffer.data(), &CompressedSize,
|
|
(const Bytef *)Input.data(), Input.size(), Level);
|
|
if (Res == Z_MEM_ERROR)
|
|
report_bad_alloc_error("Allocation failed");
|
|
assert(Res == Z_OK);
|
|
// Tell MemorySanitizer that zlib output buffer is fully initialized.
|
|
// This avoids a false report when running LLVM with uninstrumented ZLib.
|
|
__msan_unpoison(CompressedBuffer.data(), CompressedSize);
|
|
if (CompressedSize < CompressedBuffer.size())
|
|
CompressedBuffer.truncate(CompressedSize);
|
|
}
|
|
|
|
Error zlib::decompress(ArrayRef<uint8_t> Input, uint8_t *Output,
|
|
size_t &UncompressedSize) {
|
|
int Res = ::uncompress((Bytef *)Output, (uLongf *)&UncompressedSize,
|
|
(const Bytef *)Input.data(), Input.size());
|
|
// Tell MemorySanitizer that zlib output buffer is fully initialized.
|
|
// This avoids a false report when running LLVM with uninstrumented ZLib.
|
|
__msan_unpoison(Output, UncompressedSize);
|
|
return Res ? make_error<StringError>(convertZlibCodeToString(Res),
|
|
inconvertibleErrorCode())
|
|
: Error::success();
|
|
}
|
|
|
|
Error zlib::decompress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &Output,
|
|
size_t UncompressedSize) {
|
|
Output.resize_for_overwrite(UncompressedSize);
|
|
Error E = zlib::decompress(Input, Output.data(), UncompressedSize);
|
|
if (UncompressedSize < Output.size())
|
|
Output.truncate(UncompressedSize);
|
|
return E;
|
|
}
|
|
|
|
#else
|
|
bool zlib::isAvailable() { return false; }
|
|
void zlib::compress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &CompressedBuffer, int Level) {
|
|
llvm_unreachable("zlib::compress is unavailable");
|
|
}
|
|
Error zlib::decompress(ArrayRef<uint8_t> Input, uint8_t *UncompressedBuffer,
|
|
size_t &UncompressedSize) {
|
|
llvm_unreachable("zlib::decompress is unavailable");
|
|
}
|
|
Error zlib::decompress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &UncompressedBuffer,
|
|
size_t UncompressedSize) {
|
|
llvm_unreachable("zlib::decompress is unavailable");
|
|
}
|
|
#endif
|
|
|
|
#if LLVM_ENABLE_ZSTD
|
|
|
|
bool zstd::isAvailable() { return true; }
|
|
|
|
#include <zstd.h> // Ensure ZSTD library is included
|
|
|
|
void zstd::compress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &CompressedBuffer, int Level,
|
|
bool EnableLdm) {
|
|
ZSTD_CCtx *Cctx = ZSTD_createCCtx();
|
|
if (!Cctx)
|
|
report_bad_alloc_error("Failed to create ZSTD_CCtx");
|
|
|
|
if (ZSTD_isError(ZSTD_CCtx_setParameter(
|
|
Cctx, ZSTD_c_enableLongDistanceMatching, EnableLdm ? 1 : 0))) {
|
|
ZSTD_freeCCtx(Cctx);
|
|
report_bad_alloc_error("Failed to set ZSTD_c_enableLongDistanceMatching");
|
|
}
|
|
|
|
if (ZSTD_isError(
|
|
ZSTD_CCtx_setParameter(Cctx, ZSTD_c_compressionLevel, Level))) {
|
|
ZSTD_freeCCtx(Cctx);
|
|
report_bad_alloc_error("Failed to set ZSTD_c_compressionLevel");
|
|
}
|
|
|
|
unsigned long CompressedBufferSize = ZSTD_compressBound(Input.size());
|
|
CompressedBuffer.resize_for_overwrite(CompressedBufferSize);
|
|
|
|
size_t const CompressedSize =
|
|
ZSTD_compress2(Cctx, CompressedBuffer.data(), CompressedBufferSize,
|
|
Input.data(), Input.size());
|
|
|
|
ZSTD_freeCCtx(Cctx);
|
|
|
|
if (ZSTD_isError(CompressedSize))
|
|
report_bad_alloc_error("Compression failed");
|
|
|
|
__msan_unpoison(CompressedBuffer.data(), CompressedSize);
|
|
if (CompressedSize < CompressedBuffer.size())
|
|
CompressedBuffer.truncate(CompressedSize);
|
|
}
|
|
|
|
Error zstd::decompress(ArrayRef<uint8_t> Input, uint8_t *Output,
|
|
size_t &UncompressedSize) {
|
|
const size_t Res = ::ZSTD_decompress(
|
|
Output, UncompressedSize, (const uint8_t *)Input.data(), Input.size());
|
|
UncompressedSize = Res;
|
|
// Tell MemorySanitizer that zstd output buffer is fully initialized.
|
|
// This avoids a false report when running LLVM with uninstrumented ZLib.
|
|
__msan_unpoison(Output, UncompressedSize);
|
|
return ZSTD_isError(Res) ? make_error<StringError>(ZSTD_getErrorName(Res),
|
|
inconvertibleErrorCode())
|
|
: Error::success();
|
|
}
|
|
|
|
Error zstd::decompress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &Output,
|
|
size_t UncompressedSize) {
|
|
Output.resize_for_overwrite(UncompressedSize);
|
|
Error E = zstd::decompress(Input, Output.data(), UncompressedSize);
|
|
if (UncompressedSize < Output.size())
|
|
Output.truncate(UncompressedSize);
|
|
return E;
|
|
}
|
|
|
|
#else
|
|
bool zstd::isAvailable() { return false; }
|
|
void zstd::compress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &CompressedBuffer, int Level,
|
|
bool EnableLdm) {
|
|
llvm_unreachable("zstd::compress is unavailable");
|
|
}
|
|
Error zstd::decompress(ArrayRef<uint8_t> Input, uint8_t *Output,
|
|
size_t &UncompressedSize) {
|
|
llvm_unreachable("zstd::decompress is unavailable");
|
|
}
|
|
Error zstd::decompress(ArrayRef<uint8_t> Input,
|
|
SmallVectorImpl<uint8_t> &Output,
|
|
size_t UncompressedSize) {
|
|
llvm_unreachable("zstd::decompress is unavailable");
|
|
}
|
|
#endif
|