LLVM  10.0.0svn
Binary.h
Go to the documentation of this file.
1 //===- Binary.h - A generic binary file -------------------------*- 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 // This file declares the Binary class.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_OBJECT_BINARY_H
14 #define LLVM_OBJECT_BINARY_H
15 
16 #include "llvm-c/Types.h"
17 #include "llvm/ADT/Triple.h"
18 #include "llvm/Object/Error.h"
19 #include "llvm/Support/Error.h"
21 #include <algorithm>
22 #include <memory>
23 #include <utility>
24 
25 namespace llvm {
26 
27 class LLVMContext;
28 class StringRef;
29 
30 namespace object {
31 
32 class Binary {
33 private:
34  unsigned int TypeID;
35 
36 protected:
38 
39  Binary(unsigned int Type, MemoryBufferRef Source);
40 
41  enum {
45  ID_IR, // LLVM IR
46 
48 
49  ID_WinRes, // Windows resource (.res) file.
50 
51  // Object and children.
54 
55  ID_XCOFF32, // AIX XCOFF 32-bit
56  ID_XCOFF64, // AIX XCOFF 64-bit
57 
58  ID_ELF32L, // ELF 32-bit, little endian
59  ID_ELF32B, // ELF 32-bit, big endian
60  ID_ELF64L, // ELF 64-bit, little endian
61  ID_ELF64B, // ELF 64-bit, big endian
62 
63  ID_MachO32L, // MachO 32-bit, little endian
64  ID_MachO32B, // MachO 32-bit, big endian
65  ID_MachO64L, // MachO 64-bit, little endian
66  ID_MachO64B, // MachO 64-bit, big endian
67 
69 
71  };
72 
73  static inline unsigned int getELFType(bool isLE, bool is64Bits) {
74  if (isLE)
75  return is64Bits ? ID_ELF64L : ID_ELF32L;
76  else
77  return is64Bits ? ID_ELF64B : ID_ELF32B;
78  }
79 
80  static unsigned int getMachOType(bool isLE, bool is64Bits) {
81  if (isLE)
82  return is64Bits ? ID_MachO64L : ID_MachO32L;
83  else
84  return is64Bits ? ID_MachO64B : ID_MachO32B;
85  }
86 
87 public:
88  Binary() = delete;
89  Binary(const Binary &other) = delete;
90  virtual ~Binary();
91 
92  StringRef getData() const;
93  StringRef getFileName() const;
95 
96  // Cast methods.
97  unsigned int getType() const { return TypeID; }
98 
99  // Convenience methods
100  bool isObject() const {
101  return TypeID > ID_StartObjects && TypeID < ID_EndObjects;
102  }
103 
104  bool isSymbolic() const { return isIR() || isObject() || isCOFFImportFile(); }
105 
106  bool isArchive() const {
107  return TypeID == ID_Archive;
108  }
109 
110  bool isMachOUniversalBinary() const {
111  return TypeID == ID_MachOUniversalBinary;
112  }
113 
114  bool isELF() const {
115  return TypeID >= ID_ELF32L && TypeID <= ID_ELF64B;
116  }
117 
118  bool isMachO() const {
119  return TypeID >= ID_MachO32L && TypeID <= ID_MachO64B;
120  }
121 
122  bool isCOFF() const {
123  return TypeID == ID_COFF;
124  }
125 
126  bool isXCOFF() const { return TypeID == ID_XCOFF32 || TypeID == ID_XCOFF64; }
127 
128  bool isWasm() const { return TypeID == ID_Wasm; }
129 
130  bool isCOFFImportFile() const {
131  return TypeID == ID_COFFImportFile;
132  }
133 
134  bool isIR() const {
135  return TypeID == ID_IR;
136  }
137 
138  bool isMinidump() const { return TypeID == ID_Minidump; }
139 
140  bool isLittleEndian() const {
141  return !(TypeID == ID_ELF32B || TypeID == ID_ELF64B ||
142  TypeID == ID_MachO32B || TypeID == ID_MachO64B);
143  }
144 
145  bool isWinRes() const { return TypeID == ID_WinRes; }
146 
148  if (isCOFF())
149  return Triple::COFF;
150  if (isMachO())
151  return Triple::MachO;
152  if (isELF())
153  return Triple::ELF;
155  }
156 
157  static std::error_code checkOffset(MemoryBufferRef M, uintptr_t Addr,
158  const uint64_t Size) {
159  if (Addr + Size < Addr || Addr + Size < Size ||
160  Addr + Size > uintptr_t(M.getBufferEnd()) ||
161  Addr < uintptr_t(M.getBufferStart())) {
163  }
164  return std::error_code();
165  }
166 };
167 
168 // Create wrappers for C Binding types (see CBindingWrapping.h).
170 
171 /// Create a Binary from Source, autodetecting the file type.
172 ///
173 /// @param Source The data to create the Binary from.
175  LLVMContext *Context = nullptr);
176 
177 template <typename T> class OwningBinary {
178  std::unique_ptr<T> Bin;
179  std::unique_ptr<MemoryBuffer> Buf;
180 
181 public:
182  OwningBinary();
183  OwningBinary(std::unique_ptr<T> Bin, std::unique_ptr<MemoryBuffer> Buf);
185  OwningBinary<T> &operator=(OwningBinary<T> &&Other);
186 
187  std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>> takeBinary();
188 
189  T* getBinary();
190  const T* getBinary() const;
191 };
192 
193 template <typename T>
194 OwningBinary<T>::OwningBinary(std::unique_ptr<T> Bin,
195  std::unique_ptr<MemoryBuffer> Buf)
196  : Bin(std::move(Bin)), Buf(std::move(Buf)) {}
197 
198 template <typename T> OwningBinary<T>::OwningBinary() = default;
199 
200 template <typename T>
202  : Bin(std::move(Other.Bin)), Buf(std::move(Other.Buf)) {}
203 
204 template <typename T>
206  Bin = std::move(Other.Bin);
207  Buf = std::move(Other.Buf);
208  return *this;
209 }
210 
211 template <typename T>
212 std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>>
214  return std::make_pair(std::move(Bin), std::move(Buf));
215 }
216 
217 template <typename T> T* OwningBinary<T>::getBinary() {
218  return Bin.get();
219 }
220 
221 template <typename T> const T* OwningBinary<T>::getBinary() const {
222  return Bin.get();
223 }
224 
226 
227 } // end namespace object
228 
229 } // end namespace llvm
230 
231 #endif // LLVM_OBJECT_BINARY_H
static unsigned int getMachOType(bool isLE, bool is64Bits)
Definition: Binary.h:80
LLVMContext & Context
This class represents lattice values for constants.
Definition: AllocatorList.h:23
const char * getBufferEnd() const
Definition: MemoryBuffer.h:277
StringRef getFileName() const
Definition: Binary.cpp:41
static std::error_code checkOffset(MemoryBufferRef M, uintptr_t Addr, const uint64_t Size)
Definition: Binary.h:157
bool isSymbolic() const
Definition: Binary.h:104
Expected< std::unique_ptr< Binary > > createBinary(MemoryBufferRef Source, LLVMContext *Context=nullptr)
Create a Binary from Source, autodetecting the file type.
Definition: Binary.cpp:45
bool isCOFF() const
Definition: Binary.h:122
Definition: BitVector.h:937
bool isCOFFImportFile() const
Definition: Binary.h:130
Tagged union holding either a T or a Error.
Definition: CachePruning.h:22
#define DEFINE_ISA_CONVERSION_FUNCTIONS(ty, ref)
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:877
MemoryBufferRef getMemoryBufferRef() const
Definition: Binary.cpp:43
struct LLVMOpaqueBinary * LLVMBinaryRef
Definition: Types.h:169
bool isArchive() const
Definition: Binary.h:106
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
unsigned int getType() const
Definition: Binary.h:97
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:64
Expected< OwningBinary< Binary > > createBinary(StringRef Path)
Definition: Binary.cpp:93
static unsigned int getELFType(bool isLE, bool is64Bits)
Definition: Binary.h:73
Type::TypeID TypeID
bool isELF() const
Definition: Binary.h:114
bool isLittleEndian() const
Definition: Binary.h:140
bool isWinRes() const
Definition: Binary.h:145
bool isMachOUniversalBinary() const
Definition: Binary.h:110
bool isObject() const
Definition: Binary.h:100
MemoryBufferRef Data
Definition: Binary.h:37
Triple::ObjectFormatType getTripleObjectFormat() const
Definition: Binary.h:147
bool isXCOFF() const
Definition: Binary.h:126
bool isIR() const
Definition: Binary.h:134
uint32_t Size
Definition: Profile.cpp:46
const char * getBufferStart() const
Definition: MemoryBuffer.h:276
ObjectFormatType
Definition: Triple.h:221
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
bool isMachO() const
Definition: Binary.h:118
bool isWasm() const
Definition: Binary.h:128
StringRef getData() const
Definition: Binary.cpp:39
bool isMinidump() const
Definition: Binary.h:138