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 typedef content_iterator<SectionRef> section_iterator;
38 /// This is a value type class that represents a single relocation in the list
39 /// of relocations in the object file.
41 DataRefImpl RelocationPimpl;
42 const ObjectFile *OwningObject;
45 RelocationRef() : OwningObject(nullptr) { }
47 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
49 bool operator==(const RelocationRef &Other) const;
53 std::error_code getAddress(uint64_t &Result) const;
54 std::error_code getOffset(uint64_t &Result) const;
55 symbol_iterator getSymbol() const;
56 std::error_code getType(uint64_t &Result) const;
58 /// @brief Indicates whether this relocation should hidden when listing
59 /// relocations, usually because it is the trailing part of a multipart
60 /// relocation that will be printed as part of the leading relocation.
61 std::error_code getHidden(bool &Result) const;
63 /// @brief Get a string that represents the type of this relocation.
65 /// This is for display purposes only.
66 std::error_code getTypeName(SmallVectorImpl<char> &Result) const;
69 DataRefImpl getRawDataRefImpl() const;
70 const ObjectFile *getObjectFile() const;
72 typedef content_iterator<RelocationRef> relocation_iterator;
74 /// This is a value type class that represents a single section in the list of
75 /// sections in the object file.
77 friend class SymbolRef;
78 DataRefImpl SectionPimpl;
79 const ObjectFile *OwningObject;
82 SectionRef() : OwningObject(nullptr) { }
84 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
86 bool operator==(const SectionRef &Other) const;
87 bool operator!=(const SectionRef &Other) const;
88 bool operator<(const SectionRef &Other) const;
92 std::error_code getName(StringRef &Result) const;
93 uint64_t getAddress() const;
94 uint64_t getSize() const;
95 std::error_code getContents(StringRef &Result) const;
97 /// @brief Get the alignment of this section as the actual value (not log 2).
98 uint64_t getAlignment() const;
103 bool isVirtual() const;
105 bool containsSymbol(SymbolRef S) const;
107 relocation_iterator relocation_begin() const;
108 relocation_iterator relocation_end() const;
109 iterator_range<relocation_iterator> relocations() const {
110 return iterator_range<relocation_iterator>(relocation_begin(),
113 section_iterator getRelocatedSection() const;
115 DataRefImpl getRawDataRefImpl() const;
116 const ObjectFile *getObject() const;
119 /// This is a value type class that represents a single symbol in the list of
120 /// symbols in the object file.
121 class SymbolRef : public BasicSymbolRef {
122 friend class SectionRef;
125 SymbolRef() : BasicSymbolRef() {}
128 ST_Unknown, // Type not specified
136 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
138 std::error_code getName(StringRef &Result) const;
139 /// Returns the symbol virtual address (i.e. address at which it will be
141 std::error_code getAddress(uint64_t &Result) const;
143 /// Return the value of the symbol depending on the object this can be an
144 /// offset or a virtual address.
145 uint64_t getValue() const;
147 /// @brief Get the alignment of this symbol as the actual value (not log 2).
148 uint32_t getAlignment() const;
149 uint64_t getCommonSize() const;
150 std::error_code getType(SymbolRef::Type &Result) const;
151 std::error_code getOther(uint8_t &Result) const;
153 /// @brief Get section this symbol is defined in reference to. Result is
154 /// end_sections() if it is undefined or is an absolute symbol.
155 std::error_code getSection(section_iterator &Result) const;
157 const ObjectFile *getObject() const;
160 class symbol_iterator : public basic_symbol_iterator {
162 symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
163 symbol_iterator(const basic_symbol_iterator &B)
164 : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
165 cast<ObjectFile>(B->getObject()))) {}
167 const SymbolRef *operator->() const {
168 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
169 return static_cast<const SymbolRef*>(&P);
172 const SymbolRef &operator*() const {
173 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
174 return static_cast<const SymbolRef&>(P);
178 /// This class is the base class for all object file types. Concrete instances
179 /// of this object are created by createObjectFile, which figures out which type
181 class ObjectFile : public SymbolicFile {
182 virtual void anchor();
183 ObjectFile() = delete;
184 ObjectFile(const ObjectFile &other) = delete;
187 ObjectFile(unsigned int Type, MemoryBufferRef Source);
189 const uint8_t *base() const {
190 return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
193 // These functions are for SymbolRef to call internally. The main goal of
194 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
195 // entry in the memory mapped object file. SymbolPimpl cannot contain any
196 // virtual functions because then it could not point into the memory mapped
199 // Implementations assume that the DataRefImpl is valid and has not been
200 // modified externally. It's UB otherwise.
201 friend class SymbolRef;
202 virtual std::error_code getSymbolName(DataRefImpl Symb,
203 StringRef &Res) const = 0;
204 std::error_code printSymbolName(raw_ostream &OS,
205 DataRefImpl Symb) const override;
206 virtual std::error_code getSymbolAddress(DataRefImpl Symb,
207 uint64_t &Res) const = 0;
208 virtual uint64_t getSymbolValue(DataRefImpl Symb) const = 0;
209 virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
210 virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
211 virtual std::error_code getSymbolType(DataRefImpl Symb,
212 SymbolRef::Type &Res) const = 0;
213 virtual std::error_code getSymbolSection(DataRefImpl Symb,
214 section_iterator &Res) const = 0;
215 virtual std::error_code getSymbolOther(DataRefImpl Symb,
216 uint8_t &Res) const {
217 return object_error::invalid_file_type;
220 // Same as above for SectionRef.
221 friend class SectionRef;
222 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
223 virtual std::error_code getSectionName(DataRefImpl Sec,
224 StringRef &Res) const = 0;
225 virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
226 virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
227 virtual std::error_code getSectionContents(DataRefImpl Sec,
228 StringRef &Res) const = 0;
229 virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
230 virtual bool isSectionText(DataRefImpl Sec) const = 0;
231 virtual bool isSectionData(DataRefImpl Sec) const = 0;
232 virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
233 // A section is 'virtual' if its contents aren't present in the object image.
234 virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
235 virtual bool sectionContainsSymbol(DataRefImpl Sec,
236 DataRefImpl Symb) const = 0;
237 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
238 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
239 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
241 // Same as above for RelocationRef.
242 friend class RelocationRef;
243 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
244 virtual std::error_code getRelocationAddress(DataRefImpl Rel,
245 uint64_t &Res) const = 0;
246 virtual std::error_code getRelocationOffset(DataRefImpl Rel,
247 uint64_t &Res) const = 0;
248 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
249 virtual std::error_code getRelocationType(DataRefImpl Rel,
250 uint64_t &Res) const = 0;
251 virtual std::error_code
252 getRelocationTypeName(DataRefImpl Rel,
253 SmallVectorImpl<char> &Result) const = 0;
254 virtual std::error_code getRelocationHidden(DataRefImpl Rel,
255 bool &Result) const {
257 return std::error_code();
261 uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
262 assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
263 return getCommonSymbolSizeImpl(Symb);
266 typedef iterator_range<symbol_iterator> symbol_iterator_range;
267 symbol_iterator_range symbols() const {
268 return symbol_iterator_range(symbol_begin(), symbol_end());
271 virtual section_iterator section_begin() const = 0;
272 virtual section_iterator section_end() const = 0;
274 typedef iterator_range<section_iterator> section_iterator_range;
275 section_iterator_range sections() const {
276 return section_iterator_range(section_begin(), section_end());
279 /// @brief The number of bytes used to represent an address in this object
281 virtual uint8_t getBytesInAddress() const = 0;
283 virtual StringRef getFileFormatName() const = 0;
284 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
286 /// Returns platform-specific object flags, if any.
287 virtual std::error_code getPlatformFlags(unsigned &Result) const {
289 return object_error::invalid_file_type;
292 /// True if this is a relocatable object (.o/.obj).
293 virtual bool isRelocatableObject() const = 0;
295 /// @returns Pointer to ObjectFile subclass to handle this type of object.
296 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
298 /// @brief Create ObjectFile from path.
299 static ErrorOr<OwningBinary<ObjectFile>>
300 createObjectFile(StringRef ObjectPath);
302 static ErrorOr<std::unique_ptr<ObjectFile>>
303 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
304 static ErrorOr<std::unique_ptr<ObjectFile>>
305 createObjectFile(MemoryBufferRef Object) {
306 return createObjectFile(Object, sys::fs::file_magic::unknown);
310 static inline bool classof(const Binary *v) {
311 return v->isObject();
314 static ErrorOr<std::unique_ptr<COFFObjectFile>>
315 createCOFFObjectFile(MemoryBufferRef Object);
317 static ErrorOr<std::unique_ptr<ObjectFile>>
318 createELFObjectFile(MemoryBufferRef Object);
320 static ErrorOr<std::unique_ptr<MachOObjectFile>>
321 createMachOObjectFile(MemoryBufferRef Object);
324 // Inline function definitions.
325 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
326 : BasicSymbolRef(SymbolP, Owner) {}
328 inline std::error_code SymbolRef::getName(StringRef &Result) const {
329 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
332 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
333 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
336 inline uint64_t SymbolRef::getValue() const {
337 return getObject()->getSymbolValue(getRawDataRefImpl());
340 inline uint32_t SymbolRef::getAlignment() const {
341 return getObject()->getSymbolAlignment(getRawDataRefImpl());
344 inline uint64_t SymbolRef::getCommonSize() const {
345 return getObject()->getCommonSymbolSize(getRawDataRefImpl());
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::isVirtual() const {
421 return OwningObject->isSectionVirtual(SectionPimpl);
424 inline bool SectionRef::containsSymbol(SymbolRef S) const {
425 return OwningObject->sectionContainsSymbol(SectionPimpl,
426 S.getRawDataRefImpl());
429 inline relocation_iterator SectionRef::relocation_begin() const {
430 return OwningObject->section_rel_begin(SectionPimpl);
433 inline relocation_iterator SectionRef::relocation_end() const {
434 return OwningObject->section_rel_end(SectionPimpl);
437 inline section_iterator SectionRef::getRelocatedSection() const {
438 return OwningObject->getRelocatedSection(SectionPimpl);
441 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
445 inline const ObjectFile *SectionRef::getObject() const {
450 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
451 const ObjectFile *Owner)
452 : RelocationPimpl(RelocationP)
453 , OwningObject(Owner) {}
455 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
456 return RelocationPimpl == Other.RelocationPimpl;
459 inline void RelocationRef::moveNext() {
460 return OwningObject->moveRelocationNext(RelocationPimpl);
463 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
464 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
467 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
468 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
471 inline symbol_iterator RelocationRef::getSymbol() const {
472 return OwningObject->getRelocationSymbol(RelocationPimpl);
475 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
476 return OwningObject->getRelocationType(RelocationPimpl, Result);
479 inline std::error_code
480 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
481 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
484 inline std::error_code RelocationRef::getHidden(bool &Result) const {
485 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
488 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
489 return RelocationPimpl;
492 inline const ObjectFile *RelocationRef::getObjectFile() const {
497 } // end namespace object
498 } // end namespace llvm