1 //===- Binary.h - A generic binary file -------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares the Binary class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_OBJECT_BINARY_H
15 #define LLVM_OBJECT_BINARY_H
17 #include "llvm/Object/Error.h"
18 #include "llvm/Support/ErrorOr.h"
19 #include "llvm/Support/FileSystem.h"
20 #include "llvm/Support/MemoryBuffer.h"
32 Binary(const Binary &other) = delete;
39 Binary(unsigned int Type, MemoryBufferRef Source);
43 ID_MachOUniversalBinary,
46 ID_ModuleSummaryIndex, // Module summary index
48 // Object and children.
52 ID_ELF32L, // ELF 32-bit, little endian
53 ID_ELF32B, // ELF 32-bit, big endian
54 ID_ELF64L, // ELF 64-bit, little endian
55 ID_ELF64B, // ELF 64-bit, big endian
57 ID_MachO32L, // MachO 32-bit, little endian
58 ID_MachO32B, // MachO 32-bit, big endian
59 ID_MachO64L, // MachO 64-bit, little endian
60 ID_MachO64B, // MachO 64-bit, big endian
67 static inline unsigned int getELFType(bool isLE, bool is64Bits) {
69 return is64Bits ? ID_ELF64L : ID_ELF32L;
71 return is64Bits ? ID_ELF64B : ID_ELF32B;
74 static unsigned int getMachOType(bool isLE, bool is64Bits) {
76 return is64Bits ? ID_MachO64L : ID_MachO32L;
78 return is64Bits ? ID_MachO64B : ID_MachO32B;
84 StringRef getData() const;
85 StringRef getFileName() const;
86 MemoryBufferRef getMemoryBufferRef() const;
89 unsigned int getType() const { return TypeID; }
91 // Convenience methods
92 bool isObject() const {
93 return TypeID > ID_StartObjects && TypeID < ID_EndObjects;
96 bool isSymbolic() const {
97 return isIR() || isObject();
100 bool isArchive() const {
101 return TypeID == ID_Archive;
104 bool isMachOUniversalBinary() const {
105 return TypeID == ID_MachOUniversalBinary;
109 return TypeID >= ID_ELF32L && TypeID <= ID_ELF64B;
112 bool isMachO() const {
113 return TypeID >= ID_MachO32L && TypeID <= ID_MachO64B;
116 bool isCOFF() const {
117 return TypeID == ID_COFF;
120 bool isWasm() const { return TypeID == ID_Wasm; }
122 bool isCOFFImportFile() const {
123 return TypeID == ID_COFFImportFile;
127 return TypeID == ID_IR;
130 bool isModuleSummaryIndex() const { return TypeID == ID_ModuleSummaryIndex; }
132 bool isLittleEndian() const {
133 return !(TypeID == ID_ELF32B || TypeID == ID_ELF64B ||
134 TypeID == ID_MachO32B || TypeID == ID_MachO64B);
138 /// @brief Create a Binary from Source, autodetecting the file type.
140 /// @param Source The data to create the Binary from.
141 Expected<std::unique_ptr<Binary>> createBinary(MemoryBufferRef Source,
142 LLVMContext *Context = nullptr);
144 template <typename T> class OwningBinary {
145 std::unique_ptr<T> Bin;
146 std::unique_ptr<MemoryBuffer> Buf;
150 OwningBinary(std::unique_ptr<T> Bin, std::unique_ptr<MemoryBuffer> Buf);
151 OwningBinary(OwningBinary<T>&& Other);
152 OwningBinary<T> &operator=(OwningBinary<T> &&Other);
154 std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>> takeBinary();
157 const T* getBinary() const;
160 template <typename T>
161 OwningBinary<T>::OwningBinary(std::unique_ptr<T> Bin,
162 std::unique_ptr<MemoryBuffer> Buf)
163 : Bin(std::move(Bin)), Buf(std::move(Buf)) {}
165 template <typename T> OwningBinary<T>::OwningBinary() {}
167 template <typename T>
168 OwningBinary<T>::OwningBinary(OwningBinary &&Other)
169 : Bin(std::move(Other.Bin)), Buf(std::move(Other.Buf)) {}
171 template <typename T>
172 OwningBinary<T> &OwningBinary<T>::operator=(OwningBinary &&Other) {
173 Bin = std::move(Other.Bin);
174 Buf = std::move(Other.Buf);
178 template <typename T>
179 std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>>
180 OwningBinary<T>::takeBinary() {
181 return std::make_pair(std::move(Bin), std::move(Buf));
184 template <typename T> T* OwningBinary<T>::getBinary() {
188 template <typename T> const T* OwningBinary<T>::getBinary() const {
192 Expected<OwningBinary<Binary>> createBinary(StringRef Path);