LLVM 19.0.0git
Decompressor.h
Go to the documentation of this file.
1//===-- Decompressor.h ------------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===/
8
9#ifndef LLVM_OBJECT_DECOMPRESSOR_H
10#define LLVM_OBJECT_DECOMPRESSOR_H
11
12#include "llvm/ADT/ArrayRef.h"
13#include "llvm/ADT/StringRef.h"
15#include "llvm/Support/Error.h"
16
17namespace llvm {
18namespace object {
19
20/// Decompressor helps to handle decompression of compressed sections.
22public:
23 /// Create decompressor object.
24 /// @param Name Section name.
25 /// @param Data Section content.
26 /// @param IsLE Flag determines if Data is in little endian form.
27 /// @param Is64Bit Flag determines if object is 64 bit.
29 bool IsLE, bool Is64Bit);
30
31 /// Resize the buffer and uncompress section data into it.
32 /// @param Out Destination buffer.
33 template <class T> Error resizeAndDecompress(T &Out) {
34 Out.resize(DecompressedSize);
35 return decompress({(uint8_t *)Out.data(), (size_t)DecompressedSize});
36 }
37
38 /// Uncompress section data to raw buffer provided.
40
41 /// Return memory buffer size required for decompression.
42 uint64_t getDecompressedSize() { return DecompressedSize; }
43
44private:
46
47 Error consumeCompressedHeader(bool Is64Bit, bool IsLittleEndian);
48
49 StringRef SectionData;
50 uint64_t DecompressedSize;
52};
53
54} // end namespace object
55} // end namespace llvm
56
57#endif // LLVM_OBJECT_DECOMPRESSOR_H
std::string Name
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
Tagged union holding either a T or a Error.
Definition: Error.h:474
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
Definition: ArrayRef.h:307
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
Decompressor helps to handle decompression of compressed sections.
Definition: Decompressor.h:21
Error resizeAndDecompress(T &Out)
Resize the buffer and uncompress section data into it.
Definition: Decompressor.h:33
uint64_t getDecompressedSize()
Return memory buffer size required for decompression.
Definition: Decompressor.h:42
Error decompress(MutableArrayRef< uint8_t > Output)
Uncompress section data to raw buffer provided.
static Expected< Decompressor > create(StringRef Name, StringRef Data, bool IsLE, bool Is64Bit)
Create decompressor object.
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
DebugCompressionType
Definition: Compression.h:27