LLVM  4.0.0
Binary.h
Go to the documentation of this file.
1 //===- Binary.h - A generic binary file -------------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file declares the Binary class.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_OBJECT_BINARY_H
15 #define LLVM_OBJECT_BINARY_H
16 
17 #include "llvm/Object/Error.h"
18 #include "llvm/Support/ErrorOr.h"
21 
22 namespace llvm {
23 
24 class LLVMContext;
25 class StringRef;
26 
27 namespace object {
28 
29 class Binary {
30 private:
31  Binary() = delete;
32  Binary(const Binary &other) = delete;
33 
34  unsigned int TypeID;
35 
36 protected:
38 
39  Binary(unsigned int Type, MemoryBufferRef Source);
40 
41  enum {
45  ID_IR, // LLVM IR
46  ID_ModuleSummaryIndex, // Module summary index
47 
48  // Object and children.
51 
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
56 
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
61 
63 
65  };
66 
67  static inline unsigned int getELFType(bool isLE, bool is64Bits) {
68  if (isLE)
69  return is64Bits ? ID_ELF64L : ID_ELF32L;
70  else
71  return is64Bits ? ID_ELF64B : ID_ELF32B;
72  }
73 
74  static unsigned int getMachOType(bool isLE, bool is64Bits) {
75  if (isLE)
76  return is64Bits ? ID_MachO64L : ID_MachO32L;
77  else
78  return is64Bits ? ID_MachO64B : ID_MachO32B;
79  }
80 
81 public:
82  virtual ~Binary();
83 
84  StringRef getData() const;
85  StringRef getFileName() const;
87 
88  // Cast methods.
89  unsigned int getType() const { return TypeID; }
90 
91  // Convenience methods
92  bool isObject() const {
94  }
95 
96  bool isSymbolic() const {
97  return isIR() || isObject();
98  }
99 
100  bool isArchive() const {
101  return TypeID == ID_Archive;
102  }
103 
104  bool isMachOUniversalBinary() const {
106  }
107 
108  bool isELF() const {
109  return TypeID >= ID_ELF32L && TypeID <= ID_ELF64B;
110  }
111 
112  bool isMachO() const {
113  return TypeID >= ID_MachO32L && TypeID <= ID_MachO64B;
114  }
115 
116  bool isCOFF() const {
117  return TypeID == ID_COFF;
118  }
119 
120  bool isWasm() const { return TypeID == ID_Wasm; }
121 
122  bool isCOFFImportFile() const {
123  return TypeID == ID_COFFImportFile;
124  }
125 
126  bool isIR() const {
127  return TypeID == ID_IR;
128  }
129 
131 
132  bool isLittleEndian() const {
133  return !(TypeID == ID_ELF32B || TypeID == ID_ELF64B ||
135  }
136 };
137 
138 /// @brief Create a Binary from Source, autodetecting the file type.
139 ///
140 /// @param Source The data to create the Binary from.
142  LLVMContext *Context = nullptr);
143 
144 template <typename T> class OwningBinary {
145  std::unique_ptr<T> Bin;
146  std::unique_ptr<MemoryBuffer> Buf;
147 
148 public:
149  OwningBinary();
150  OwningBinary(std::unique_ptr<T> Bin, std::unique_ptr<MemoryBuffer> Buf);
151  OwningBinary(OwningBinary<T>&& Other);
153 
154  std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>> takeBinary();
155 
156  T* getBinary();
157  const T* getBinary() const;
158 };
159 
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)) {}
164 
165 template <typename T> OwningBinary<T>::OwningBinary() {}
166 
167 template <typename T>
169  : Bin(std::move(Other.Bin)), Buf(std::move(Other.Buf)) {}
170 
171 template <typename T>
173  Bin = std::move(Other.Bin);
174  Buf = std::move(Other.Buf);
175  return *this;
176 }
177 
178 template <typename T>
179 std::pair<std::unique_ptr<T>, std::unique_ptr<MemoryBuffer>>
181  return std::make_pair(std::move(Bin), std::move(Buf));
182 }
183 
184 template <typename T> T* OwningBinary<T>::getBinary() {
185  return Bin.get();
186 }
187 
188 template <typename T> const T* OwningBinary<T>::getBinary() const {
189  return Bin.get();
190 }
191 
193 }
194 }
195 
196 #endif
bool isELF() const
Definition: Binary.h:108
static unsigned int getMachOType(bool isLE, bool is64Bits)
Definition: Binary.h:74
LLVMContext & Context
Type::TypeID TypeID
bool isModuleSummaryIndex() const
Definition: Binary.h:130
virtual ~Binary()
Definition: Binary.cpp:28
Expected< std::unique_ptr< Binary > > createBinary(MemoryBufferRef Source, LLVMContext *Context=nullptr)
Create a Binary from Source, autodetecting the file type.
Definition: Binary.cpp:39
StringRef getData() const
Definition: Binary.cpp:33
Tagged union holding either a T or a Error.
bool isIR() const
Definition: Binary.h:126
ELFYAML::ELF_STO Other
Definition: ELFYAML.cpp:662
MemoryBufferRef getMemoryBufferRef() const
Definition: Binary.cpp:37
bool isCOFFImportFile() const
Definition: Binary.h:122
bool isCOFF() const
Definition: Binary.h:116
unsigned int getType() const
Definition: Binary.h:89
bool isObject() const
Definition: Binary.h:92
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:48
static unsigned int getELFType(bool isLE, bool is64Bits)
Definition: Binary.h:67
StringRef getFileName() const
Definition: Binary.cpp:35
std::pair< std::unique_ptr< T >, std::unique_ptr< MemoryBuffer > > takeBinary()
Definition: Binary.h:180
bool isMachO() const
Definition: Binary.h:112
MemoryBufferRef Data
Definition: Binary.h:37
OwningBinary< T > & operator=(OwningBinary< T > &&Other)
Definition: Binary.h:172
bool isLittleEndian() const
Definition: Binary.h:132
Provides ErrorOr<T> smart pointer.
bool isWasm() const
Definition: Binary.h:120
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:47
bool isMachOUniversalBinary() const
Definition: Binary.h:104
bool isSymbolic() const
Definition: Binary.h:96
bool isArchive() const
Definition: Binary.h:100