1 //===- ObjectFile.h - File format independent object 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 a file format independent ObjectFile class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_OBJECT_OBJECTFILE_H
15 #define LLVM_OBJECT_OBJECTFILE_H
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/Object/SymbolicFile.h"
19 #include "llvm/Support/DataTypes.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/FileSystem.h"
22 #include "llvm/Support/MemoryBuffer.h"
31 class MachOObjectFile;
34 class symbol_iterator;
36 /// RelocationRef - This is a value type class that represents a single
37 /// relocation in the list of relocations in the object file.
39 DataRefImpl RelocationPimpl;
40 const ObjectFile *OwningObject;
43 RelocationRef() : OwningObject(nullptr) { }
45 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
47 bool operator==(const RelocationRef &Other) const;
51 std::error_code getAddress(uint64_t &Result) const;
52 std::error_code getOffset(uint64_t &Result) const;
53 symbol_iterator getSymbol() const;
54 std::error_code getType(uint64_t &Result) const;
56 /// @brief Indicates whether this relocation should hidden when listing
57 /// relocations, usually because it is the trailing part of a multipart
58 /// relocation that will be printed as part of the leading relocation.
59 std::error_code getHidden(bool &Result) const;
61 /// @brief Get a string that represents the type of this relocation.
63 /// This is for display purposes only.
64 std::error_code getTypeName(SmallVectorImpl<char> &Result) const;
66 /// @brief Get a string that represents the calculation of the value of this
69 /// This is for display purposes only.
70 std::error_code getValueString(SmallVectorImpl<char> &Result) const;
72 DataRefImpl getRawDataRefImpl() const;
73 const ObjectFile *getObjectFile() const;
75 typedef content_iterator<RelocationRef> relocation_iterator;
77 /// SectionRef - This is a value type class that represents a single section in
78 /// the list of sections in the object file.
80 typedef content_iterator<SectionRef> section_iterator;
82 friend class SymbolRef;
83 DataRefImpl SectionPimpl;
84 const ObjectFile *OwningObject;
87 SectionRef() : OwningObject(nullptr) { }
89 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
91 bool operator==(const SectionRef &Other) const;
92 bool operator!=(const SectionRef &Other) const;
93 bool operator<(const SectionRef &Other) const;
97 std::error_code getName(StringRef &Result) const;
98 uint64_t getAddress() const;
99 uint64_t getSize() const;
100 std::error_code getContents(StringRef &Result) const;
102 /// @brief Get the alignment of this section as the actual value (not log 2).
103 uint64_t getAlignment() const;
108 bool isRequiredForExecution() const;
109 bool isVirtual() const;
110 bool isZeroInit() const;
111 bool isReadOnlyData() const;
113 bool containsSymbol(SymbolRef S) const;
115 relocation_iterator relocation_begin() const;
116 relocation_iterator relocation_end() const;
117 iterator_range<relocation_iterator> relocations() const {
118 return iterator_range<relocation_iterator>(relocation_begin(),
121 section_iterator getRelocatedSection() const;
123 DataRefImpl getRawDataRefImpl() const;
126 /// SymbolRef - This is a value type class that represents a single symbol in
127 /// the list of symbols in the object file.
128 class SymbolRef : public BasicSymbolRef {
129 friend class SectionRef;
132 SymbolRef() : BasicSymbolRef() {}
135 ST_Unknown, // Type not specified
143 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
145 std::error_code getName(StringRef &Result) const;
146 /// Returns the symbol virtual address (i.e. address at which it will be
148 std::error_code getAddress(uint64_t &Result) const;
149 /// @brief Get the alignment of this symbol as the actual value (not log 2).
150 std::error_code getAlignment(uint32_t &Result) const;
151 std::error_code getSize(uint64_t &Result) const;
152 std::error_code getType(SymbolRef::Type &Result) const;
153 std::error_code getOther(uint8_t &Result) const;
155 /// @brief Get section this symbol is defined in reference to. Result is
156 /// end_sections() if it is undefined or is an absolute symbol.
157 std::error_code getSection(section_iterator &Result) const;
159 const ObjectFile *getObject() const;
162 class symbol_iterator : public basic_symbol_iterator {
164 symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
165 symbol_iterator(const basic_symbol_iterator &B)
166 : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
167 cast<ObjectFile>(B->getObject()))) {}
169 const SymbolRef *operator->() const {
170 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
171 return static_cast<const SymbolRef*>(&P);
174 const SymbolRef &operator*() const {
175 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
176 return static_cast<const SymbolRef&>(P);
180 /// ObjectFile - This class is the base class for all object file types.
181 /// Concrete instances of this object are created by createObjectFile, which
182 /// figures out which type to create.
183 class ObjectFile : public SymbolicFile {
184 virtual void anchor();
185 ObjectFile() LLVM_DELETED_FUNCTION;
186 ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
189 ObjectFile(unsigned int Type, MemoryBufferRef Source);
191 const uint8_t *base() const {
192 return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
195 // These functions are for SymbolRef to call internally. The main goal of
196 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
197 // entry in the memory mapped object file. SymbolPimpl cannot contain any
198 // virtual functions because then it could not point into the memory mapped
201 // Implementations assume that the DataRefImpl is valid and has not been
202 // modified externally. It's UB otherwise.
203 friend class SymbolRef;
204 virtual std::error_code getSymbolName(DataRefImpl Symb,
205 StringRef &Res) const = 0;
206 std::error_code printSymbolName(raw_ostream &OS,
207 DataRefImpl Symb) const override;
208 virtual std::error_code getSymbolAddress(DataRefImpl Symb,
209 uint64_t &Res) const = 0;
210 virtual std::error_code getSymbolAlignment(DataRefImpl Symb,
211 uint32_t &Res) const;
212 virtual std::error_code getSymbolSize(DataRefImpl Symb,
213 uint64_t &Res) const = 0;
214 virtual std::error_code getSymbolType(DataRefImpl Symb,
215 SymbolRef::Type &Res) const = 0;
216 virtual std::error_code getSymbolSection(DataRefImpl Symb,
217 section_iterator &Res) const = 0;
218 virtual std::error_code getSymbolOther(DataRefImpl Symb,
219 uint8_t &Res) const {
220 return object_error::invalid_file_type;
223 // Same as above for SectionRef.
224 friend class SectionRef;
225 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
226 virtual std::error_code getSectionName(DataRefImpl Sec,
227 StringRef &Res) const = 0;
228 virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
229 virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
230 virtual std::error_code getSectionContents(DataRefImpl Sec,
231 StringRef &Res) const = 0;
232 virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
233 virtual bool isSectionText(DataRefImpl Sec) const = 0;
234 virtual bool isSectionData(DataRefImpl Sec) const = 0;
235 virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
236 virtual bool isSectionRequiredForExecution(DataRefImpl Sec) const = 0;
237 // A section is 'virtual' if its contents aren't present in the object image.
238 virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
239 virtual bool isSectionZeroInit(DataRefImpl Sec) const = 0;
240 virtual bool isSectionReadOnlyData(DataRefImpl Sec) const = 0;
241 virtual bool sectionContainsSymbol(DataRefImpl Sec,
242 DataRefImpl Symb) const = 0;
243 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
244 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
245 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
247 // Same as above for RelocationRef.
248 friend class RelocationRef;
249 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
250 virtual std::error_code getRelocationAddress(DataRefImpl Rel,
251 uint64_t &Res) const = 0;
252 virtual std::error_code getRelocationOffset(DataRefImpl Rel,
253 uint64_t &Res) const = 0;
254 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
255 virtual std::error_code getRelocationType(DataRefImpl Rel,
256 uint64_t &Res) const = 0;
257 virtual std::error_code
258 getRelocationTypeName(DataRefImpl Rel,
259 SmallVectorImpl<char> &Result) const = 0;
260 virtual std::error_code
261 getRelocationValueString(DataRefImpl Rel,
262 SmallVectorImpl<char> &Result) const = 0;
263 virtual std::error_code getRelocationHidden(DataRefImpl Rel,
264 bool &Result) const {
266 return object_error::success;
270 typedef iterator_range<symbol_iterator> symbol_iterator_range;
271 symbol_iterator_range symbols() const {
272 return symbol_iterator_range(symbol_begin(), symbol_end());
275 virtual section_iterator section_begin() const = 0;
276 virtual section_iterator section_end() const = 0;
278 typedef iterator_range<section_iterator> section_iterator_range;
279 section_iterator_range sections() const {
280 return section_iterator_range(section_begin(), section_end());
283 /// @brief The number of bytes used to represent an address in this object
285 virtual uint8_t getBytesInAddress() const = 0;
287 virtual StringRef getFileFormatName() const = 0;
288 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
290 /// Returns platform-specific object flags, if any.
291 virtual std::error_code getPlatformFlags(unsigned &Result) const {
293 return object_error::invalid_file_type;
296 /// True if this is a relocatable object (.o/.obj).
297 virtual bool isRelocatableObject() const = 0;
299 /// @returns Pointer to ObjectFile subclass to handle this type of object.
300 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
302 /// @brief Create ObjectFile from path.
303 static ErrorOr<OwningBinary<ObjectFile>>
304 createObjectFile(StringRef ObjectPath);
306 static ErrorOr<std::unique_ptr<ObjectFile>>
307 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
308 static ErrorOr<std::unique_ptr<ObjectFile>>
309 createObjectFile(MemoryBufferRef Object) {
310 return createObjectFile(Object, sys::fs::file_magic::unknown);
314 static inline bool classof(const Binary *v) {
315 return v->isObject();
318 static ErrorOr<std::unique_ptr<COFFObjectFile>>
319 createCOFFObjectFile(MemoryBufferRef Object);
321 static ErrorOr<std::unique_ptr<ObjectFile>>
322 createELFObjectFile(MemoryBufferRef Object);
324 static ErrorOr<std::unique_ptr<MachOObjectFile>>
325 createMachOObjectFile(MemoryBufferRef Object);
328 // Inline function definitions.
329 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
330 : BasicSymbolRef(SymbolP, Owner) {}
332 inline std::error_code SymbolRef::getName(StringRef &Result) const {
333 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
336 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
337 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
340 inline std::error_code SymbolRef::getAlignment(uint32_t &Result) const {
341 return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
344 inline std::error_code SymbolRef::getSize(uint64_t &Result) const {
345 return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
348 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
349 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
352 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
353 return getObject()->getSymbolType(getRawDataRefImpl(), Result);
356 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
357 return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
360 inline const ObjectFile *SymbolRef::getObject() const {
361 const SymbolicFile *O = BasicSymbolRef::getObject();
362 return cast<ObjectFile>(O);
367 inline SectionRef::SectionRef(DataRefImpl SectionP,
368 const ObjectFile *Owner)
369 : SectionPimpl(SectionP)
370 , OwningObject(Owner) {}
372 inline bool SectionRef::operator==(const SectionRef &Other) const {
373 return SectionPimpl == Other.SectionPimpl;
376 inline bool SectionRef::operator!=(const SectionRef &Other) const {
377 return SectionPimpl != Other.SectionPimpl;
380 inline bool SectionRef::operator<(const SectionRef &Other) const {
381 return SectionPimpl < Other.SectionPimpl;
384 inline void SectionRef::moveNext() {
385 return OwningObject->moveSectionNext(SectionPimpl);
388 inline std::error_code SectionRef::getName(StringRef &Result) const {
389 return OwningObject->getSectionName(SectionPimpl, Result);
392 inline uint64_t SectionRef::getAddress() const {
393 return OwningObject->getSectionAddress(SectionPimpl);
396 inline uint64_t SectionRef::getSize() const {
397 return OwningObject->getSectionSize(SectionPimpl);
400 inline std::error_code SectionRef::getContents(StringRef &Result) const {
401 return OwningObject->getSectionContents(SectionPimpl, Result);
404 inline uint64_t SectionRef::getAlignment() const {
405 return OwningObject->getSectionAlignment(SectionPimpl);
408 inline bool SectionRef::isText() const {
409 return OwningObject->isSectionText(SectionPimpl);
412 inline bool SectionRef::isData() const {
413 return OwningObject->isSectionData(SectionPimpl);
416 inline bool SectionRef::isBSS() const {
417 return OwningObject->isSectionBSS(SectionPimpl);
420 inline bool SectionRef::isRequiredForExecution() const {
421 return OwningObject->isSectionRequiredForExecution(SectionPimpl);
424 inline bool SectionRef::isVirtual() const {
425 return OwningObject->isSectionVirtual(SectionPimpl);
428 inline bool SectionRef::isZeroInit() const {
429 return OwningObject->isSectionZeroInit(SectionPimpl);
432 inline bool SectionRef::isReadOnlyData() const {
433 return OwningObject->isSectionReadOnlyData(SectionPimpl);
436 inline bool SectionRef::containsSymbol(SymbolRef S) const {
437 return OwningObject->sectionContainsSymbol(SectionPimpl,
438 S.getRawDataRefImpl());
441 inline relocation_iterator SectionRef::relocation_begin() const {
442 return OwningObject->section_rel_begin(SectionPimpl);
445 inline relocation_iterator SectionRef::relocation_end() const {
446 return OwningObject->section_rel_end(SectionPimpl);
449 inline section_iterator SectionRef::getRelocatedSection() const {
450 return OwningObject->getRelocatedSection(SectionPimpl);
453 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
458 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
459 const ObjectFile *Owner)
460 : RelocationPimpl(RelocationP)
461 , OwningObject(Owner) {}
463 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
464 return RelocationPimpl == Other.RelocationPimpl;
467 inline void RelocationRef::moveNext() {
468 return OwningObject->moveRelocationNext(RelocationPimpl);
471 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
472 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
475 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
476 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
479 inline symbol_iterator RelocationRef::getSymbol() const {
480 return OwningObject->getRelocationSymbol(RelocationPimpl);
483 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
484 return OwningObject->getRelocationType(RelocationPimpl, Result);
487 inline std::error_code
488 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
489 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
492 inline std::error_code
493 RelocationRef::getValueString(SmallVectorImpl<char> &Result) const {
494 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
497 inline std::error_code RelocationRef::getHidden(bool &Result) const {
498 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
501 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
502 return RelocationPimpl;
505 inline const ObjectFile *RelocationRef::getObjectFile() const {
510 } // end namespace object
511 } // end namespace llvm