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/FileSystem.h"
22 #include "llvm/Support/MemoryBuffer.h"
32 // This entire union should probably be a
33 // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
39 std::memset(this, 0, sizeof(DataRefImpl));
43 template<class content_type>
44 class content_iterator {
47 content_iterator(content_type symb)
50 const content_type* operator->() const {
54 const content_type &operator*() const {
58 bool operator==(const content_iterator &other) const {
59 return Current == other.Current;
62 bool operator!=(const content_iterator &other) const {
63 return !(*this == other);
66 content_iterator& increment(error_code &err) {
68 if (error_code ec = Current.getNext(next))
76 inline bool operator==(const DataRefImpl &a, const DataRefImpl &b) {
77 // Check bitwise identical. This is the only legal way to compare a union w/o
78 // knowing which member is in use.
79 return std::memcmp(&a, &b, sizeof(DataRefImpl)) == 0;
82 inline bool operator<(const DataRefImpl &a, const DataRefImpl &b) {
83 // Check bitwise identical. This is the only legal way to compare a union w/o
84 // knowing which member is in use.
85 return std::memcmp(&a, &b, sizeof(DataRefImpl)) < 0;
89 typedef content_iterator<SymbolRef> symbol_iterator;
91 /// RelocationRef - This is a value type class that represents a single
92 /// relocation in the list of relocations in the object file.
94 DataRefImpl RelocationPimpl;
95 const ObjectFile *OwningObject;
98 RelocationRef() : OwningObject(NULL) { }
100 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
102 bool operator==(const RelocationRef &Other) const;
104 error_code getNext(RelocationRef &Result) const;
106 error_code getAddress(uint64_t &Result) const;
107 error_code getOffset(uint64_t &Result) const;
108 symbol_iterator getSymbol() const;
109 error_code getType(uint64_t &Result) const;
111 /// @brief Indicates whether this relocation should hidden when listing
112 /// relocations, usually because it is the trailing part of a multipart
113 /// relocation that will be printed as part of the leading relocation.
114 error_code getHidden(bool &Result) const;
116 /// @brief Get a string that represents the type of this relocation.
118 /// This is for display purposes only.
119 error_code getTypeName(SmallVectorImpl<char> &Result) const;
121 /// @brief Get a string that represents the calculation of the value of this
124 /// This is for display purposes only.
125 error_code getValueString(SmallVectorImpl<char> &Result) const;
127 DataRefImpl getRawDataRefImpl() const;
128 const ObjectFile *getObjectFile() const;
130 typedef content_iterator<RelocationRef> relocation_iterator;
132 /// SectionRef - This is a value type class that represents a single section in
133 /// the list of sections in the object file.
135 typedef content_iterator<SectionRef> section_iterator;
137 friend class SymbolRef;
138 DataRefImpl SectionPimpl;
139 const ObjectFile *OwningObject;
142 SectionRef() : OwningObject(NULL) { }
144 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
146 bool operator==(const SectionRef &Other) const;
147 bool operator<(const SectionRef &Other) const;
149 error_code getNext(SectionRef &Result) const;
151 error_code getName(StringRef &Result) const;
152 error_code getAddress(uint64_t &Result) const;
153 error_code getSize(uint64_t &Result) const;
154 error_code getContents(StringRef &Result) const;
156 /// @brief Get the alignment of this section as the actual value (not log 2).
157 error_code getAlignment(uint64_t &Result) const;
159 // FIXME: Move to the normalization layer when it's created.
160 error_code isText(bool &Result) const;
161 error_code isData(bool &Result) const;
162 error_code isBSS(bool &Result) const;
163 error_code isRequiredForExecution(bool &Result) const;
164 error_code isVirtual(bool &Result) const;
165 error_code isZeroInit(bool &Result) const;
166 error_code isReadOnlyData(bool &Result) const;
168 error_code containsSymbol(SymbolRef S, bool &Result) const;
170 relocation_iterator begin_relocations() const;
171 relocation_iterator end_relocations() const;
172 section_iterator getRelocatedSection() const;
174 DataRefImpl getRawDataRefImpl() const;
177 /// SymbolRef - This is a value type class that represents a single symbol in
178 /// the list of symbols in the object file.
180 friend class SectionRef;
181 DataRefImpl SymbolPimpl;
182 const ObjectFile *OwningObject;
185 SymbolRef() : OwningObject(NULL) { }
188 ST_Unknown, // Type not specified
196 enum Flags LLVM_ENUM_INT_TYPE(unsigned) {
198 SF_Undefined = 1U << 0, // Symbol is defined in another object file
199 SF_Global = 1U << 1, // Global symbol
200 SF_Weak = 1U << 2, // Weak symbol
201 SF_Absolute = 1U << 3, // Absolute symbol
202 SF_ThreadLocal = 1U << 4, // Thread local symbol
203 SF_Common = 1U << 5, // Symbol has common linkage
204 SF_FormatSpecific = 1U << 31 // Specific to the object file format
205 // (e.g. section symbols)
208 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
210 bool operator==(const SymbolRef &Other) const;
211 bool operator<(const SymbolRef &Other) const;
213 error_code getNext(SymbolRef &Result) const;
215 error_code getName(StringRef &Result) const;
216 /// Returns the symbol virtual address (i.e. address at which it will be
218 error_code getAddress(uint64_t &Result) const;
219 error_code getFileOffset(uint64_t &Result) const;
220 /// @brief Get the alignment of this symbol as the actual value (not log 2).
221 error_code getAlignment(uint32_t &Result) const;
222 error_code getSize(uint64_t &Result) const;
223 error_code getType(SymbolRef::Type &Result) const;
225 /// Get symbol flags (bitwise OR of SymbolRef::Flags)
226 error_code getFlags(uint32_t &Result) const;
228 /// @brief Get section this symbol is defined in reference to. Result is
229 /// end_sections() if it is undefined or is an absolute symbol.
230 error_code getSection(section_iterator &Result) const;
232 /// @brief Get value of the symbol in the symbol table.
233 error_code getValue(uint64_t &Val) const;
235 DataRefImpl getRawDataRefImpl() const;
238 /// LibraryRef - This is a value type class that represents a single library in
239 /// the list of libraries needed by a shared or dynamic object.
241 friend class SectionRef;
242 DataRefImpl LibraryPimpl;
243 const ObjectFile *OwningObject;
246 LibraryRef() : OwningObject(NULL) { }
248 LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
250 bool operator==(const LibraryRef &Other) const;
251 bool operator<(const LibraryRef &Other) const;
253 error_code getNext(LibraryRef &Result) const;
255 // Get the path to this library, as stored in the object file.
256 error_code getPath(StringRef &Result) const;
258 DataRefImpl getRawDataRefImpl() const;
260 typedef content_iterator<LibraryRef> library_iterator;
262 const uint64_t UnknownAddressOrSize = ~0ULL;
264 /// ObjectFile - This class is the base class for all object file types.
265 /// Concrete instances of this object are created by createObjectFile, which
266 /// figures out which type to create.
267 class ObjectFile : public Binary {
268 virtual void anchor();
269 ObjectFile() LLVM_DELETED_FUNCTION;
270 ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
273 ObjectFile(unsigned int Type, MemoryBuffer *source);
275 const uint8_t *base() const {
276 return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
279 // These functions are for SymbolRef to call internally. The main goal of
280 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
281 // entry in the memory mapped object file. SymbolPimpl cannot contain any
282 // virtual functions because then it could not point into the memory mapped
285 // Implementations assume that the DataRefImpl is valid and has not been
286 // modified externally. It's UB otherwise.
287 friend class SymbolRef;
288 virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;
289 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
290 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
291 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res)const=0;
292 virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
293 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
294 virtual error_code getSymbolType(DataRefImpl Symb,
295 SymbolRef::Type &Res) const = 0;
296 virtual error_code getSymbolFlags(DataRefImpl Symb,
297 uint32_t &Res) const = 0;
298 virtual error_code getSymbolSection(DataRefImpl Symb,
299 section_iterator &Res) const = 0;
300 virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const = 0;
302 // Same as above for SectionRef.
303 friend class SectionRef;
304 virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const = 0;
305 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
306 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
307 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
308 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
309 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
310 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
311 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
312 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
313 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
314 bool &Res) const = 0;
315 // A section is 'virtual' if its contents aren't present in the object image.
316 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0;
317 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;
318 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const =0;
319 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
320 bool &Result) const = 0;
321 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
322 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
323 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
325 // Same as above for RelocationRef.
326 friend class RelocationRef;
327 virtual error_code getRelocationNext(DataRefImpl Rel,
328 RelocationRef &Res) const = 0;
329 virtual error_code getRelocationAddress(DataRefImpl Rel,
330 uint64_t &Res) const =0;
331 virtual error_code getRelocationOffset(DataRefImpl Rel,
332 uint64_t &Res) const =0;
333 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
334 virtual error_code getRelocationType(DataRefImpl Rel,
335 uint64_t &Res) const = 0;
336 virtual error_code getRelocationTypeName(DataRefImpl Rel,
337 SmallVectorImpl<char> &Result) const = 0;
338 virtual error_code getRelocationValueString(DataRefImpl Rel,
339 SmallVectorImpl<char> &Result) const = 0;
340 virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
342 return object_error::success;
345 // Same for LibraryRef
346 friend class LibraryRef;
347 virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
348 virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
352 virtual symbol_iterator begin_symbols() const = 0;
353 virtual symbol_iterator end_symbols() const = 0;
355 virtual symbol_iterator begin_dynamic_symbols() const = 0;
356 virtual symbol_iterator end_dynamic_symbols() const = 0;
358 virtual section_iterator begin_sections() const = 0;
359 virtual section_iterator end_sections() const = 0;
361 virtual library_iterator begin_libraries_needed() const = 0;
362 virtual library_iterator end_libraries_needed() const = 0;
364 /// @brief The number of bytes used to represent an address in this object
366 virtual uint8_t getBytesInAddress() const = 0;
368 virtual StringRef getFileFormatName() const = 0;
369 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
371 /// For shared objects, returns the name which this object should be
372 /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
373 /// LC_ID_DYLIB (install name) on MachO.
374 virtual StringRef getLoadName() const = 0;
376 /// @returns Pointer to ObjectFile subclass to handle this type of object.
377 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
379 /// @brief Create ObjectFile from path.
380 static ErrorOr<ObjectFile *> createObjectFile(StringRef ObjectPath);
381 static ErrorOr<ObjectFile *>
382 createObjectFile(MemoryBuffer *Object,
383 sys::fs::file_magic Type = sys::fs::file_magic::unknown);
385 static inline bool classof(const Binary *v) {
386 return v->isObject();
390 static ErrorOr<ObjectFile *> createCOFFObjectFile(MemoryBuffer *Object);
391 static ErrorOr<ObjectFile *> createELFObjectFile(MemoryBuffer *Object);
392 static ErrorOr<ObjectFile *> createMachOObjectFile(MemoryBuffer *Object);
395 // Inline function definitions.
396 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
397 : SymbolPimpl(SymbolP)
398 , OwningObject(Owner) {}
400 inline bool SymbolRef::operator==(const SymbolRef &Other) const {
401 return SymbolPimpl == Other.SymbolPimpl;
404 inline bool SymbolRef::operator<(const SymbolRef &Other) const {
405 return SymbolPimpl < Other.SymbolPimpl;
408 inline error_code SymbolRef::getNext(SymbolRef &Result) const {
409 return OwningObject->getSymbolNext(SymbolPimpl, Result);
412 inline error_code SymbolRef::getName(StringRef &Result) const {
413 return OwningObject->getSymbolName(SymbolPimpl, Result);
416 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
417 return OwningObject->getSymbolAddress(SymbolPimpl, Result);
420 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
421 return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);
424 inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
425 return OwningObject->getSymbolAlignment(SymbolPimpl, Result);
428 inline error_code SymbolRef::getSize(uint64_t &Result) const {
429 return OwningObject->getSymbolSize(SymbolPimpl, Result);
432 inline error_code SymbolRef::getFlags(uint32_t &Result) const {
433 return OwningObject->getSymbolFlags(SymbolPimpl, Result);
436 inline error_code SymbolRef::getSection(section_iterator &Result) const {
437 return OwningObject->getSymbolSection(SymbolPimpl, Result);
440 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
441 return OwningObject->getSymbolType(SymbolPimpl, Result);
444 inline error_code SymbolRef::getValue(uint64_t &Val) const {
445 return OwningObject->getSymbolValue(SymbolPimpl, Val);
448 inline DataRefImpl SymbolRef::getRawDataRefImpl() const {
454 inline SectionRef::SectionRef(DataRefImpl SectionP,
455 const ObjectFile *Owner)
456 : SectionPimpl(SectionP)
457 , OwningObject(Owner) {}
459 inline bool SectionRef::operator==(const SectionRef &Other) const {
460 return SectionPimpl == Other.SectionPimpl;
463 inline bool SectionRef::operator<(const SectionRef &Other) const {
464 return SectionPimpl < Other.SectionPimpl;
467 inline error_code SectionRef::getNext(SectionRef &Result) const {
468 return OwningObject->getSectionNext(SectionPimpl, Result);
471 inline error_code SectionRef::getName(StringRef &Result) const {
472 return OwningObject->getSectionName(SectionPimpl, Result);
475 inline error_code SectionRef::getAddress(uint64_t &Result) const {
476 return OwningObject->getSectionAddress(SectionPimpl, Result);
479 inline error_code SectionRef::getSize(uint64_t &Result) const {
480 return OwningObject->getSectionSize(SectionPimpl, Result);
483 inline error_code SectionRef::getContents(StringRef &Result) const {
484 return OwningObject->getSectionContents(SectionPimpl, Result);
487 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
488 return OwningObject->getSectionAlignment(SectionPimpl, Result);
491 inline error_code SectionRef::isText(bool &Result) const {
492 return OwningObject->isSectionText(SectionPimpl, Result);
495 inline error_code SectionRef::isData(bool &Result) const {
496 return OwningObject->isSectionData(SectionPimpl, Result);
499 inline error_code SectionRef::isBSS(bool &Result) const {
500 return OwningObject->isSectionBSS(SectionPimpl, Result);
503 inline error_code SectionRef::isRequiredForExecution(bool &Result) const {
504 return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
507 inline error_code SectionRef::isVirtual(bool &Result) const {
508 return OwningObject->isSectionVirtual(SectionPimpl, Result);
511 inline error_code SectionRef::isZeroInit(bool &Result) const {
512 return OwningObject->isSectionZeroInit(SectionPimpl, Result);
515 inline error_code SectionRef::isReadOnlyData(bool &Result) const {
516 return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
519 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
520 return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,
524 inline relocation_iterator SectionRef::begin_relocations() const {
525 return OwningObject->section_rel_begin(SectionPimpl);
528 inline relocation_iterator SectionRef::end_relocations() const {
529 return OwningObject->section_rel_end(SectionPimpl);
532 inline section_iterator SectionRef::getRelocatedSection() const {
533 return OwningObject->getRelocatedSection(SectionPimpl);
536 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
541 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
542 const ObjectFile *Owner)
543 : RelocationPimpl(RelocationP)
544 , OwningObject(Owner) {}
546 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
547 return RelocationPimpl == Other.RelocationPimpl;
550 inline error_code RelocationRef::getNext(RelocationRef &Result) const {
551 return OwningObject->getRelocationNext(RelocationPimpl, Result);
554 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
555 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
558 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
559 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
562 inline symbol_iterator RelocationRef::getSymbol() const {
563 return OwningObject->getRelocationSymbol(RelocationPimpl);
566 inline error_code RelocationRef::getType(uint64_t &Result) const {
567 return OwningObject->getRelocationType(RelocationPimpl, Result);
570 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
572 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
575 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
577 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
580 inline error_code RelocationRef::getHidden(bool &Result) const {
581 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
584 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
585 return RelocationPimpl;
588 inline const ObjectFile *RelocationRef::getObjectFile() const {
592 // Inline function definitions.
593 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
594 : LibraryPimpl(LibraryP)
595 , OwningObject(Owner) {}
597 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
598 return LibraryPimpl == Other.LibraryPimpl;
601 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
602 return LibraryPimpl < Other.LibraryPimpl;
605 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
606 return OwningObject->getLibraryNext(LibraryPimpl, Result);
609 inline error_code LibraryRef::getPath(StringRef &Result) const {
610 return OwningObject->getLibraryPath(LibraryPimpl, Result);
613 } // end namespace object
614 } // end namespace llvm