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 std::error_code getAddress(uint64_t &Result) const;
99 std::error_code getSize(uint64_t &Result) 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 std::error_code getAlignment(uint64_t &Result) const;
105 std::error_code isText(bool &Result) const;
106 std::error_code isData(bool &Result) const;
107 std::error_code isBSS(bool &Result) const;
108 std::error_code isRequiredForExecution(bool &Result) const;
109 std::error_code isVirtual(bool &Result) const;
110 std::error_code isZeroInit(bool &Result) const;
111 std::error_code isReadOnlyData(bool &Result) const;
113 std::error_code containsSymbol(SymbolRef S, bool &Result) 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 std::error_code getSectionAddress(DataRefImpl Sec,
229 uint64_t &Res) const = 0;
230 virtual std::error_code getSectionSize(DataRefImpl Sec,
231 uint64_t &Res) const = 0;
232 virtual std::error_code getSectionContents(DataRefImpl Sec,
233 StringRef &Res) const = 0;
234 virtual std::error_code getSectionAlignment(DataRefImpl Sec,
235 uint64_t &Res) const = 0;
236 virtual std::error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
237 virtual std::error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
238 virtual std::error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
239 virtual std::error_code isSectionRequiredForExecution(DataRefImpl Sec,
240 bool &Res) const = 0;
241 // A section is 'virtual' if its contents aren't present in the object image.
242 virtual std::error_code isSectionVirtual(DataRefImpl Sec,
243 bool &Res) const = 0;
244 virtual std::error_code isSectionZeroInit(DataRefImpl Sec,
245 bool &Res) const = 0;
246 virtual std::error_code isSectionReadOnlyData(DataRefImpl Sec,
247 bool &Res) const = 0;
248 virtual std::error_code sectionContainsSymbol(DataRefImpl Sec,
250 bool &Result) const = 0;
251 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
252 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
253 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
255 // Same as above for RelocationRef.
256 friend class RelocationRef;
257 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
258 virtual std::error_code getRelocationAddress(DataRefImpl Rel,
259 uint64_t &Res) const = 0;
260 virtual std::error_code getRelocationOffset(DataRefImpl Rel,
261 uint64_t &Res) const = 0;
262 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
263 virtual std::error_code getRelocationType(DataRefImpl Rel,
264 uint64_t &Res) const = 0;
265 virtual std::error_code
266 getRelocationTypeName(DataRefImpl Rel,
267 SmallVectorImpl<char> &Result) const = 0;
268 virtual std::error_code
269 getRelocationValueString(DataRefImpl Rel,
270 SmallVectorImpl<char> &Result) const = 0;
271 virtual std::error_code getRelocationHidden(DataRefImpl Rel,
272 bool &Result) const {
274 return object_error::success;
278 typedef iterator_range<symbol_iterator> symbol_iterator_range;
279 symbol_iterator_range symbols() const {
280 return symbol_iterator_range(symbol_begin(), symbol_end());
283 virtual section_iterator section_begin() const = 0;
284 virtual section_iterator section_end() const = 0;
286 typedef iterator_range<section_iterator> section_iterator_range;
287 section_iterator_range sections() const {
288 return section_iterator_range(section_begin(), section_end());
291 /// @brief The number of bytes used to represent an address in this object
293 virtual uint8_t getBytesInAddress() const = 0;
295 virtual StringRef getFileFormatName() const = 0;
296 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
298 /// Returns platform-specific object flags, if any.
299 virtual std::error_code getPlatformFlags(unsigned &Result) const {
301 return object_error::invalid_file_type;
304 /// True if this is a relocatable object (.o/.obj).
305 virtual bool isRelocatableObject() const = 0;
307 /// @returns Pointer to ObjectFile subclass to handle this type of object.
308 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
310 /// @brief Create ObjectFile from path.
311 static ErrorOr<OwningBinary<ObjectFile>>
312 createObjectFile(StringRef ObjectPath);
314 static ErrorOr<std::unique_ptr<ObjectFile>>
315 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
316 static ErrorOr<std::unique_ptr<ObjectFile>>
317 createObjectFile(MemoryBufferRef Object) {
318 return createObjectFile(Object, sys::fs::file_magic::unknown);
322 static inline bool classof(const Binary *v) {
323 return v->isObject();
326 static ErrorOr<std::unique_ptr<COFFObjectFile>>
327 createCOFFObjectFile(MemoryBufferRef Object);
329 static ErrorOr<std::unique_ptr<ObjectFile>>
330 createELFObjectFile(MemoryBufferRef Object);
332 static ErrorOr<std::unique_ptr<MachOObjectFile>>
333 createMachOObjectFile(MemoryBufferRef Object);
336 // Inline function definitions.
337 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
338 : BasicSymbolRef(SymbolP, Owner) {}
340 inline std::error_code SymbolRef::getName(StringRef &Result) const {
341 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
344 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
345 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
348 inline std::error_code SymbolRef::getAlignment(uint32_t &Result) const {
349 return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
352 inline std::error_code SymbolRef::getSize(uint64_t &Result) const {
353 return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
356 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
357 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
360 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
361 return getObject()->getSymbolType(getRawDataRefImpl(), Result);
364 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
365 return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
368 inline const ObjectFile *SymbolRef::getObject() const {
369 const SymbolicFile *O = BasicSymbolRef::getObject();
370 return cast<ObjectFile>(O);
375 inline SectionRef::SectionRef(DataRefImpl SectionP,
376 const ObjectFile *Owner)
377 : SectionPimpl(SectionP)
378 , OwningObject(Owner) {}
380 inline bool SectionRef::operator==(const SectionRef &Other) const {
381 return SectionPimpl == Other.SectionPimpl;
384 inline bool SectionRef::operator!=(const SectionRef &Other) const {
385 return SectionPimpl != Other.SectionPimpl;
388 inline bool SectionRef::operator<(const SectionRef &Other) const {
389 return SectionPimpl < Other.SectionPimpl;
392 inline void SectionRef::moveNext() {
393 return OwningObject->moveSectionNext(SectionPimpl);
396 inline std::error_code SectionRef::getName(StringRef &Result) const {
397 return OwningObject->getSectionName(SectionPimpl, Result);
400 inline std::error_code SectionRef::getAddress(uint64_t &Result) const {
401 return OwningObject->getSectionAddress(SectionPimpl, Result);
404 inline std::error_code SectionRef::getSize(uint64_t &Result) const {
405 return OwningObject->getSectionSize(SectionPimpl, Result);
408 inline std::error_code SectionRef::getContents(StringRef &Result) const {
409 return OwningObject->getSectionContents(SectionPimpl, Result);
412 inline std::error_code SectionRef::getAlignment(uint64_t &Result) const {
413 return OwningObject->getSectionAlignment(SectionPimpl, Result);
416 inline std::error_code SectionRef::isText(bool &Result) const {
417 return OwningObject->isSectionText(SectionPimpl, Result);
420 inline std::error_code SectionRef::isData(bool &Result) const {
421 return OwningObject->isSectionData(SectionPimpl, Result);
424 inline std::error_code SectionRef::isBSS(bool &Result) const {
425 return OwningObject->isSectionBSS(SectionPimpl, Result);
428 inline std::error_code SectionRef::isRequiredForExecution(bool &Result) const {
429 return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
432 inline std::error_code SectionRef::isVirtual(bool &Result) const {
433 return OwningObject->isSectionVirtual(SectionPimpl, Result);
436 inline std::error_code SectionRef::isZeroInit(bool &Result) const {
437 return OwningObject->isSectionZeroInit(SectionPimpl, Result);
440 inline std::error_code SectionRef::isReadOnlyData(bool &Result) const {
441 return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
444 inline std::error_code SectionRef::containsSymbol(SymbolRef S,
445 bool &Result) const {
446 return OwningObject->sectionContainsSymbol(SectionPimpl,
447 S.getRawDataRefImpl(), Result);
450 inline relocation_iterator SectionRef::relocation_begin() const {
451 return OwningObject->section_rel_begin(SectionPimpl);
454 inline relocation_iterator SectionRef::relocation_end() const {
455 return OwningObject->section_rel_end(SectionPimpl);
458 inline section_iterator SectionRef::getRelocatedSection() const {
459 return OwningObject->getRelocatedSection(SectionPimpl);
462 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
467 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
468 const ObjectFile *Owner)
469 : RelocationPimpl(RelocationP)
470 , OwningObject(Owner) {}
472 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
473 return RelocationPimpl == Other.RelocationPimpl;
476 inline void RelocationRef::moveNext() {
477 return OwningObject->moveRelocationNext(RelocationPimpl);
480 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
481 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
484 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
485 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
488 inline symbol_iterator RelocationRef::getSymbol() const {
489 return OwningObject->getRelocationSymbol(RelocationPimpl);
492 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
493 return OwningObject->getRelocationType(RelocationPimpl, Result);
496 inline std::error_code
497 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
498 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
501 inline std::error_code
502 RelocationRef::getValueString(SmallVectorImpl<char> &Result) const {
503 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
506 inline std::error_code RelocationRef::getHidden(bool &Result) const {
507 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
510 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
511 return RelocationPimpl;
514 inline const ObjectFile *RelocationRef::getObjectFile() const {
519 } // end namespace object
520 } // end namespace llvm