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/Binary.h"
19 #include "llvm/Support/DataTypes.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/MemoryBuffer.h"
31 // This entire union should probably be a
32 // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
38 std::memset(this, 0, sizeof(DataRefImpl));
42 template<class content_type>
43 class content_iterator {
46 content_iterator(content_type symb)
49 const content_type* operator->() const {
53 const content_type &operator*() const {
57 bool operator==(const content_iterator &other) const {
58 return Current == other.Current;
61 bool operator!=(const content_iterator &other) const {
62 return !(*this == other);
65 content_iterator& increment(error_code &err) {
67 if (error_code ec = Current.getNext(next))
75 inline bool operator==(const DataRefImpl &a, const DataRefImpl &b) {
76 // Check bitwise identical. This is the only legal way to compare a union w/o
77 // knowing which member is in use.
78 return std::memcmp(&a, &b, sizeof(DataRefImpl)) == 0;
81 inline bool operator<(const DataRefImpl &a, const DataRefImpl &b) {
82 // Check bitwise identical. This is the only legal way to compare a union w/o
83 // knowing which member is in use.
84 return std::memcmp(&a, &b, sizeof(DataRefImpl)) < 0;
88 typedef content_iterator<SymbolRef> symbol_iterator;
90 /// RelocationRef - This is a value type class that represents a single
91 /// relocation in the list of relocations in the object file.
93 DataRefImpl RelocationPimpl;
94 const ObjectFile *OwningObject;
97 RelocationRef() : OwningObject(NULL) { }
99 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
101 bool operator==(const RelocationRef &Other) const;
103 error_code getNext(RelocationRef &Result) const;
105 error_code getAddress(uint64_t &Result) const;
106 error_code getOffset(uint64_t &Result) const;
107 symbol_iterator getSymbol() const;
108 error_code getType(uint64_t &Result) const;
110 /// @brief Indicates whether this relocation should hidden when listing
111 /// relocations, usually because it is the trailing part of a multipart
112 /// relocation that will be printed as part of the leading relocation.
113 error_code getHidden(bool &Result) const;
115 /// @brief Get a string that represents the type of this relocation.
117 /// This is for display purposes only.
118 error_code getTypeName(SmallVectorImpl<char> &Result) const;
120 /// @brief Get a string that represents the calculation of the value of this
123 /// This is for display purposes only.
124 error_code getValueString(SmallVectorImpl<char> &Result) const;
126 DataRefImpl getRawDataRefImpl() const;
127 const ObjectFile *getObjectFile() const;
129 typedef content_iterator<RelocationRef> relocation_iterator;
131 /// SectionRef - This is a value type class that represents a single section in
132 /// the list of sections in the object file.
134 typedef content_iterator<SectionRef> section_iterator;
136 friend class SymbolRef;
137 DataRefImpl SectionPimpl;
138 const ObjectFile *OwningObject;
141 SectionRef() : OwningObject(NULL) { }
143 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
145 bool operator==(const SectionRef &Other) const;
146 bool operator<(const SectionRef &Other) const;
148 error_code getNext(SectionRef &Result) const;
150 error_code getName(StringRef &Result) const;
151 error_code getAddress(uint64_t &Result) const;
152 error_code getSize(uint64_t &Result) const;
153 error_code getContents(StringRef &Result) const;
155 /// @brief Get the alignment of this section as the actual value (not log 2).
156 error_code getAlignment(uint64_t &Result) const;
158 // FIXME: Move to the normalization layer when it's created.
159 error_code isText(bool &Result) const;
160 error_code isData(bool &Result) const;
161 error_code isBSS(bool &Result) const;
162 error_code isRequiredForExecution(bool &Result) const;
163 error_code isVirtual(bool &Result) const;
164 error_code isZeroInit(bool &Result) const;
165 error_code isReadOnlyData(bool &Result) const;
167 error_code containsSymbol(SymbolRef S, bool &Result) const;
169 relocation_iterator begin_relocations() const;
170 relocation_iterator end_relocations() const;
171 section_iterator getRelocatedSection() const;
173 DataRefImpl getRawDataRefImpl() const;
176 /// SymbolRef - This is a value type class that represents a single symbol in
177 /// the list of symbols in the object file.
179 friend class SectionRef;
180 DataRefImpl SymbolPimpl;
181 const ObjectFile *OwningObject;
184 SymbolRef() : OwningObject(NULL) { }
187 ST_Unknown, // Type not specified
195 enum Flags LLVM_ENUM_INT_TYPE(unsigned) {
197 SF_Undefined = 1U << 0, // Symbol is defined in another object file
198 SF_Global = 1U << 1, // Global symbol
199 SF_Weak = 1U << 2, // Weak symbol
200 SF_Absolute = 1U << 3, // Absolute symbol
201 SF_ThreadLocal = 1U << 4, // Thread local symbol
202 SF_Common = 1U << 5, // Symbol has common linkage
203 SF_FormatSpecific = 1U << 31 // Specific to the object file format
204 // (e.g. section symbols)
207 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
209 bool operator==(const SymbolRef &Other) const;
210 bool operator<(const SymbolRef &Other) const;
212 error_code getNext(SymbolRef &Result) const;
214 error_code getName(StringRef &Result) const;
215 /// Returns the symbol virtual address (i.e. address at which it will be
217 error_code getAddress(uint64_t &Result) const;
218 error_code getFileOffset(uint64_t &Result) const;
219 /// @brief Get the alignment of this symbol as the actual value (not log 2).
220 error_code getAlignment(uint32_t &Result) const;
221 error_code getSize(uint64_t &Result) const;
222 error_code getType(SymbolRef::Type &Result) const;
224 /// Get symbol flags (bitwise OR of SymbolRef::Flags)
225 error_code getFlags(uint32_t &Result) const;
227 /// @brief Get section this symbol is defined in reference to. Result is
228 /// end_sections() if it is undefined or is an absolute symbol.
229 error_code getSection(section_iterator &Result) const;
231 /// @brief Get value of the symbol in the symbol table.
232 error_code getValue(uint64_t &Val) const;
234 DataRefImpl getRawDataRefImpl() const;
237 /// LibraryRef - This is a value type class that represents a single library in
238 /// the list of libraries needed by a shared or dynamic object.
240 friend class SectionRef;
241 DataRefImpl LibraryPimpl;
242 const ObjectFile *OwningObject;
245 LibraryRef() : OwningObject(NULL) { }
247 LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
249 bool operator==(const LibraryRef &Other) const;
250 bool operator<(const LibraryRef &Other) const;
252 error_code getNext(LibraryRef &Result) const;
254 // Get the path to this library, as stored in the object file.
255 error_code getPath(StringRef &Result) const;
257 DataRefImpl getRawDataRefImpl() const;
259 typedef content_iterator<LibraryRef> library_iterator;
261 const uint64_t UnknownAddressOrSize = ~0ULL;
263 /// ObjectFile - This class is the base class for all object file types.
264 /// Concrete instances of this object are created by createObjectFile, which
265 /// figures out which type to create.
266 class ObjectFile : public Binary {
267 virtual void anchor();
268 ObjectFile() LLVM_DELETED_FUNCTION;
269 ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
272 ObjectFile(unsigned int Type, MemoryBuffer *source);
274 const uint8_t *base() const {
275 return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
278 // These functions are for SymbolRef to call internally. The main goal of
279 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
280 // entry in the memory mapped object file. SymbolPimpl cannot contain any
281 // virtual functions because then it could not point into the memory mapped
284 // Implementations assume that the DataRefImpl is valid and has not been
285 // modified externally. It's UB otherwise.
286 friend class SymbolRef;
287 virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;
288 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
289 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
290 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res)const=0;
291 virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
292 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
293 virtual error_code getSymbolType(DataRefImpl Symb,
294 SymbolRef::Type &Res) const = 0;
295 virtual error_code getSymbolFlags(DataRefImpl Symb,
296 uint32_t &Res) const = 0;
297 virtual error_code getSymbolSection(DataRefImpl Symb,
298 section_iterator &Res) const = 0;
299 virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const = 0;
301 // Same as above for SectionRef.
302 friend class SectionRef;
303 virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const = 0;
304 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
305 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
306 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
307 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
308 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
309 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
310 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
311 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
312 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
313 bool &Res) const = 0;
314 // A section is 'virtual' if its contents aren't present in the object image.
315 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0;
316 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;
317 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const =0;
318 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
319 bool &Result) const = 0;
320 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
321 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
322 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
324 // Same as above for RelocationRef.
325 friend class RelocationRef;
326 virtual error_code getRelocationNext(DataRefImpl Rel,
327 RelocationRef &Res) const = 0;
328 virtual error_code getRelocationAddress(DataRefImpl Rel,
329 uint64_t &Res) const =0;
330 virtual error_code getRelocationOffset(DataRefImpl Rel,
331 uint64_t &Res) const =0;
332 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
333 virtual error_code getRelocationType(DataRefImpl Rel,
334 uint64_t &Res) const = 0;
335 virtual error_code getRelocationTypeName(DataRefImpl Rel,
336 SmallVectorImpl<char> &Result) const = 0;
337 virtual error_code getRelocationValueString(DataRefImpl Rel,
338 SmallVectorImpl<char> &Result) const = 0;
339 virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
341 return object_error::success;
344 // Same for LibraryRef
345 friend class LibraryRef;
346 virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
347 virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
351 virtual symbol_iterator begin_symbols() const = 0;
352 virtual symbol_iterator end_symbols() const = 0;
354 virtual symbol_iterator begin_dynamic_symbols() const = 0;
355 virtual symbol_iterator end_dynamic_symbols() const = 0;
357 virtual section_iterator begin_sections() const = 0;
358 virtual section_iterator end_sections() const = 0;
360 virtual library_iterator begin_libraries_needed() const = 0;
361 virtual library_iterator end_libraries_needed() const = 0;
363 /// @brief The number of bytes used to represent an address in this object
365 virtual uint8_t getBytesInAddress() const = 0;
367 virtual StringRef getFileFormatName() const = 0;
368 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
370 /// For shared objects, returns the name which this object should be
371 /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
372 /// LC_ID_DYLIB (install name) on MachO.
373 virtual StringRef getLoadName() const = 0;
375 /// @returns Pointer to ObjectFile subclass to handle this type of object.
376 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
378 /// @brief Create ObjectFile from path.
379 static ObjectFile *createObjectFile(StringRef ObjectPath);
380 static ObjectFile *createObjectFile(MemoryBuffer *Object);
382 static inline bool classof(const Binary *v) {
383 return v->isObject();
387 static ObjectFile *createCOFFObjectFile(MemoryBuffer *Object);
388 static ObjectFile *createELFObjectFile(MemoryBuffer *Object);
389 static ObjectFile *createMachOObjectFile(MemoryBuffer *Object);
392 // Inline function definitions.
393 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
394 : SymbolPimpl(SymbolP)
395 , OwningObject(Owner) {}
397 inline bool SymbolRef::operator==(const SymbolRef &Other) const {
398 return SymbolPimpl == Other.SymbolPimpl;
401 inline bool SymbolRef::operator<(const SymbolRef &Other) const {
402 return SymbolPimpl < Other.SymbolPimpl;
405 inline error_code SymbolRef::getNext(SymbolRef &Result) const {
406 return OwningObject->getSymbolNext(SymbolPimpl, Result);
409 inline error_code SymbolRef::getName(StringRef &Result) const {
410 return OwningObject->getSymbolName(SymbolPimpl, Result);
413 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
414 return OwningObject->getSymbolAddress(SymbolPimpl, Result);
417 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
418 return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);
421 inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
422 return OwningObject->getSymbolAlignment(SymbolPimpl, Result);
425 inline error_code SymbolRef::getSize(uint64_t &Result) const {
426 return OwningObject->getSymbolSize(SymbolPimpl, Result);
429 inline error_code SymbolRef::getFlags(uint32_t &Result) const {
430 return OwningObject->getSymbolFlags(SymbolPimpl, Result);
433 inline error_code SymbolRef::getSection(section_iterator &Result) const {
434 return OwningObject->getSymbolSection(SymbolPimpl, Result);
437 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
438 return OwningObject->getSymbolType(SymbolPimpl, Result);
441 inline error_code SymbolRef::getValue(uint64_t &Val) const {
442 return OwningObject->getSymbolValue(SymbolPimpl, Val);
445 inline DataRefImpl SymbolRef::getRawDataRefImpl() const {
451 inline SectionRef::SectionRef(DataRefImpl SectionP,
452 const ObjectFile *Owner)
453 : SectionPimpl(SectionP)
454 , OwningObject(Owner) {}
456 inline bool SectionRef::operator==(const SectionRef &Other) const {
457 return SectionPimpl == Other.SectionPimpl;
460 inline bool SectionRef::operator<(const SectionRef &Other) const {
461 return SectionPimpl < Other.SectionPimpl;
464 inline error_code SectionRef::getNext(SectionRef &Result) const {
465 return OwningObject->getSectionNext(SectionPimpl, Result);
468 inline error_code SectionRef::getName(StringRef &Result) const {
469 return OwningObject->getSectionName(SectionPimpl, Result);
472 inline error_code SectionRef::getAddress(uint64_t &Result) const {
473 return OwningObject->getSectionAddress(SectionPimpl, Result);
476 inline error_code SectionRef::getSize(uint64_t &Result) const {
477 return OwningObject->getSectionSize(SectionPimpl, Result);
480 inline error_code SectionRef::getContents(StringRef &Result) const {
481 return OwningObject->getSectionContents(SectionPimpl, Result);
484 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
485 return OwningObject->getSectionAlignment(SectionPimpl, Result);
488 inline error_code SectionRef::isText(bool &Result) const {
489 return OwningObject->isSectionText(SectionPimpl, Result);
492 inline error_code SectionRef::isData(bool &Result) const {
493 return OwningObject->isSectionData(SectionPimpl, Result);
496 inline error_code SectionRef::isBSS(bool &Result) const {
497 return OwningObject->isSectionBSS(SectionPimpl, Result);
500 inline error_code SectionRef::isRequiredForExecution(bool &Result) const {
501 return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
504 inline error_code SectionRef::isVirtual(bool &Result) const {
505 return OwningObject->isSectionVirtual(SectionPimpl, Result);
508 inline error_code SectionRef::isZeroInit(bool &Result) const {
509 return OwningObject->isSectionZeroInit(SectionPimpl, Result);
512 inline error_code SectionRef::isReadOnlyData(bool &Result) const {
513 return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
516 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
517 return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,
521 inline relocation_iterator SectionRef::begin_relocations() const {
522 return OwningObject->section_rel_begin(SectionPimpl);
525 inline relocation_iterator SectionRef::end_relocations() const {
526 return OwningObject->section_rel_end(SectionPimpl);
529 inline section_iterator SectionRef::getRelocatedSection() const {
530 return OwningObject->getRelocatedSection(SectionPimpl);
533 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
538 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
539 const ObjectFile *Owner)
540 : RelocationPimpl(RelocationP)
541 , OwningObject(Owner) {}
543 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
544 return RelocationPimpl == Other.RelocationPimpl;
547 inline error_code RelocationRef::getNext(RelocationRef &Result) const {
548 return OwningObject->getRelocationNext(RelocationPimpl, Result);
551 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
552 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
555 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
556 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
559 inline symbol_iterator RelocationRef::getSymbol() const {
560 return OwningObject->getRelocationSymbol(RelocationPimpl);
563 inline error_code RelocationRef::getType(uint64_t &Result) const {
564 return OwningObject->getRelocationType(RelocationPimpl, Result);
567 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
569 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
572 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
574 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
577 inline error_code RelocationRef::getHidden(bool &Result) const {
578 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
581 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
582 return RelocationPimpl;
585 inline const ObjectFile *RelocationRef::getObjectFile() const {
589 // Inline function definitions.
590 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
591 : LibraryPimpl(LibraryP)
592 , OwningObject(Owner) {}
594 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
595 return LibraryPimpl == Other.LibraryPimpl;
598 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
599 return LibraryPimpl < Other.LibraryPimpl;
602 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
603 return OwningObject->getLibraryNext(LibraryPimpl, Result);
606 inline error_code LibraryRef::getPath(StringRef &Result) const {
607 return OwningObject->getLibraryPath(LibraryPimpl, Result);
610 } // end namespace object
611 } // end namespace llvm