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_OBJECT_FILE_H
15 #define LLVM_OBJECT_OBJECT_FILE_H
17 #include "llvm/Object/Binary.h"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/DataTypes.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/MemoryBuffer.h"
32 // ELF needs this for relocations. This entire union should probably be a
33 // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
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 static 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 static 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;
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) {
98 std::memset(&RelocationPimpl, 0, sizeof(RelocationPimpl));
101 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
103 bool operator==(const RelocationRef &Other) const;
105 error_code getNext(RelocationRef &Result) const;
107 error_code getAddress(uint64_t &Result) const;
108 error_code getOffset(uint64_t &Result) const;
109 error_code getSymbol(SymbolRef &Result) const;
110 error_code getType(uint64_t &Result) const;
112 /// @brief Indicates whether this relocation should hidden when listing
113 /// relocations, usually because it is the trailing part of a multipart
114 /// relocation that will be printed as part of the leading relocation.
115 error_code getHidden(bool &Result) const;
117 /// @brief Get a string that represents the type of this relocation.
119 /// This is for display purposes only.
120 error_code getTypeName(SmallVectorImpl<char> &Result) const;
121 error_code getAdditionalInfo(int64_t &Result) const;
123 /// @brief Get a string that represents the calculation of the value of this
126 /// This is for display purposes only.
127 error_code getValueString(SmallVectorImpl<char> &Result) 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 friend class SymbolRef;
135 DataRefImpl SectionPimpl;
136 const ObjectFile *OwningObject;
139 SectionRef() : OwningObject(NULL) {
140 std::memset(&SectionPimpl, 0, sizeof(SectionPimpl));
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;
163 error_code containsSymbol(SymbolRef S, bool &Result) const;
165 relocation_iterator begin_relocations() const;
166 relocation_iterator end_relocations() const;
168 typedef content_iterator<SectionRef> section_iterator;
170 /// SymbolRef - This is a value type class that represents a single symbol in
171 /// the list of symbols in the object file.
173 friend class SectionRef;
174 DataRefImpl SymbolPimpl;
175 const ObjectFile *OwningObject;
178 SymbolRef() : OwningObject(NULL) {
179 std::memset(&SymbolPimpl, 0, sizeof(SymbolPimpl));
183 ST_Unknown, // Type not specified
193 SF_Undefined = 1U << 0, // Symbol is defined in another object file
194 SF_Global = 1U << 1, // Global symbol
195 SF_Weak = 1U << 2, // Weak symbol
196 SF_Absolute = 1U << 3, // Absolute symbol
197 SF_ThreadLocal = 1U << 4, // Thread local symbol
198 SF_Common = 1U << 5, // Symbol has common linkage
199 SF_FormatSpecific = 1U << 31 // Specific to the object file format
200 // (e.g. section symbols)
203 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
205 bool operator==(const SymbolRef &Other) const;
206 bool operator <(const SymbolRef &Other) const;
208 error_code getNext(SymbolRef &Result) const;
210 error_code getName(StringRef &Result) const;
211 error_code getAddress(uint64_t &Result) const;
212 error_code getFileOffset(uint64_t &Result) const;
213 error_code getSize(uint64_t &Result) const;
214 error_code getType(SymbolRef::Type &Result) const;
216 /// Returns the ascii char that should be displayed in a symbol table dump via
217 /// nm for this symbol.
218 error_code getNMTypeChar(char &Result) const;
220 /// Get symbol flags (bitwise OR of SymbolRef::Flags)
221 error_code getFlags(uint32_t &Result) const;
223 /// @brief Get section this symbol is defined in reference to. Result is
224 /// end_sections() if it is undefined or is an absolute symbol.
225 error_code getSection(section_iterator &Result) const;
227 DataRefImpl getRawDataRefImpl() const;
229 typedef content_iterator<SymbolRef> symbol_iterator;
231 /// LibraryRef - This is a value type class that represents a single library in
232 /// the list of libraries needed by a shared or dynamic object.
234 friend class SectionRef;
235 DataRefImpl LibraryPimpl;
236 const ObjectFile *OwningObject;
239 LibraryRef() : OwningObject(NULL) {
240 std::memset(&LibraryPimpl, 0, sizeof(LibraryPimpl));
243 LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
245 bool operator==(const LibraryRef &Other) const;
246 bool operator <(const LibraryRef &Other) const;
248 error_code getNext(LibraryRef &Result) const;
250 // Get the path to this library, as stored in the object file.
251 error_code getPath(StringRef &Result) const;
253 DataRefImpl getRawDataRefImpl() const;
255 typedef content_iterator<LibraryRef> library_iterator;
257 const uint64_t UnknownAddressOrSize = ~0ULL;
259 /// ObjectFile - This class is the base class for all object file types.
260 /// Concrete instances of this object are created by createObjectFile, which
261 /// figure out which type to create.
262 class ObjectFile : public Binary {
263 virtual void anchor();
264 ObjectFile(); // = delete
265 ObjectFile(const ObjectFile &other); // = delete
268 ObjectFile(unsigned int Type, MemoryBuffer *source, error_code &ec);
270 const uint8_t *base() const {
271 return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
274 // These functions are for SymbolRef to call internally. The main goal of
275 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
276 // entry in the memory mapped object file. SymbolPimpl cannot contain any
277 // virtual functions because then it could not point into the memory mapped
280 // Implementations assume that the DataRefImpl is valid and has not been
281 // modified externally. It's UB otherwise.
282 friend class SymbolRef;
283 virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;
284 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
285 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const =0;
286 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const =0;
287 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
288 virtual error_code getSymbolType(DataRefImpl Symb,
289 SymbolRef::Type &Res) const = 0;
290 virtual error_code getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const = 0;
291 virtual error_code getSymbolFlags(DataRefImpl Symb,
292 uint32_t &Res) const = 0;
293 virtual error_code getSymbolSection(DataRefImpl Symb,
294 section_iterator &Res) const = 0;
296 // Same as above for SectionRef.
297 friend class SectionRef;
298 virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const = 0;
299 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
300 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
301 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
302 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
303 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
304 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
305 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
306 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
307 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
308 bool &Result) const = 0;
309 virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const = 0;
310 virtual relocation_iterator getSectionRelEnd(DataRefImpl Sec) const = 0;
313 // Same as above for RelocationRef.
314 friend class RelocationRef;
315 virtual error_code getRelocationNext(DataRefImpl Rel,
316 RelocationRef &Res) const = 0;
317 virtual error_code getRelocationAddress(DataRefImpl Rel,
318 uint64_t &Res) const =0;
319 virtual error_code getRelocationOffset(DataRefImpl Rel,
320 uint64_t &Res) const =0;
321 virtual error_code getRelocationSymbol(DataRefImpl Rel,
322 SymbolRef &Res) const = 0;
323 virtual error_code getRelocationType(DataRefImpl Rel,
324 uint64_t &Res) const = 0;
325 virtual error_code getRelocationTypeName(DataRefImpl Rel,
326 SmallVectorImpl<char> &Result) const = 0;
327 virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,
328 int64_t &Res) const = 0;
329 virtual error_code getRelocationValueString(DataRefImpl Rel,
330 SmallVectorImpl<char> &Result) const = 0;
331 virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
333 return object_error::success;
336 // Same for LibraryRef
337 friend class LibraryRef;
338 virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
339 virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
343 virtual symbol_iterator begin_symbols() const = 0;
344 virtual symbol_iterator end_symbols() const = 0;
346 virtual symbol_iterator begin_dynamic_symbols() const = 0;
347 virtual symbol_iterator end_dynamic_symbols() const = 0;
349 virtual section_iterator begin_sections() const = 0;
350 virtual section_iterator end_sections() const = 0;
352 virtual library_iterator begin_libraries_needed() const = 0;
353 virtual library_iterator end_libraries_needed() const = 0;
355 /// @brief The number of bytes used to represent an address in this object
357 virtual uint8_t getBytesInAddress() const = 0;
359 virtual StringRef getFileFormatName() const = 0;
360 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
362 /// @returns Pointer to ObjectFile subclass to handle this type of object.
363 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
365 /// @brief Create ObjectFile from path.
366 static ObjectFile *createObjectFile(StringRef ObjectPath);
367 static ObjectFile *createObjectFile(MemoryBuffer *Object);
369 static inline bool classof(const Binary *v) {
370 return v->getType() >= isObject &&
371 v->getType() < lastObject;
373 static inline bool classof(const ObjectFile *v) { return true; }
376 static ObjectFile *createCOFFObjectFile(MemoryBuffer *Object);
377 static ObjectFile *createELFObjectFile(MemoryBuffer *Object);
378 static ObjectFile *createMachOObjectFile(MemoryBuffer *Object);
381 // Inline function definitions.
382 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
383 : SymbolPimpl(SymbolP)
384 , OwningObject(Owner) {}
386 inline bool SymbolRef::operator==(const SymbolRef &Other) const {
387 return SymbolPimpl == Other.SymbolPimpl;
390 inline bool SymbolRef::operator <(const SymbolRef &Other) const {
391 return SymbolPimpl < Other.SymbolPimpl;
394 inline error_code SymbolRef::getNext(SymbolRef &Result) const {
395 return OwningObject->getSymbolNext(SymbolPimpl, Result);
398 inline error_code SymbolRef::getName(StringRef &Result) const {
399 return OwningObject->getSymbolName(SymbolPimpl, Result);
402 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
403 return OwningObject->getSymbolAddress(SymbolPimpl, Result);
406 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
407 return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);
410 inline error_code SymbolRef::getSize(uint64_t &Result) const {
411 return OwningObject->getSymbolSize(SymbolPimpl, Result);
414 inline error_code SymbolRef::getNMTypeChar(char &Result) const {
415 return OwningObject->getSymbolNMTypeChar(SymbolPimpl, Result);
418 inline error_code SymbolRef::getFlags(uint32_t &Result) const {
419 return OwningObject->getSymbolFlags(SymbolPimpl, Result);
422 inline error_code SymbolRef::getSection(section_iterator &Result) const {
423 return OwningObject->getSymbolSection(SymbolPimpl, Result);
426 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
427 return OwningObject->getSymbolType(SymbolPimpl, Result);
430 inline DataRefImpl SymbolRef::getRawDataRefImpl() const {
436 inline SectionRef::SectionRef(DataRefImpl SectionP,
437 const ObjectFile *Owner)
438 : SectionPimpl(SectionP)
439 , OwningObject(Owner) {}
441 inline bool SectionRef::operator==(const SectionRef &Other) const {
442 return SectionPimpl == Other.SectionPimpl;
445 inline bool SectionRef::operator <(const SectionRef &Other) const {
446 return SectionPimpl < Other.SectionPimpl;
449 inline error_code SectionRef::getNext(SectionRef &Result) const {
450 return OwningObject->getSectionNext(SectionPimpl, Result);
453 inline error_code SectionRef::getName(StringRef &Result) const {
454 return OwningObject->getSectionName(SectionPimpl, Result);
457 inline error_code SectionRef::getAddress(uint64_t &Result) const {
458 return OwningObject->getSectionAddress(SectionPimpl, Result);
461 inline error_code SectionRef::getSize(uint64_t &Result) const {
462 return OwningObject->getSectionSize(SectionPimpl, Result);
465 inline error_code SectionRef::getContents(StringRef &Result) const {
466 return OwningObject->getSectionContents(SectionPimpl, Result);
469 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
470 return OwningObject->getSectionAlignment(SectionPimpl, Result);
473 inline error_code SectionRef::isText(bool &Result) const {
474 return OwningObject->isSectionText(SectionPimpl, Result);
477 inline error_code SectionRef::isData(bool &Result) const {
478 return OwningObject->isSectionData(SectionPimpl, Result);
481 inline error_code SectionRef::isBSS(bool &Result) const {
482 return OwningObject->isSectionBSS(SectionPimpl, Result);
485 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
486 return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,
490 inline relocation_iterator SectionRef::begin_relocations() const {
491 return OwningObject->getSectionRelBegin(SectionPimpl);
494 inline relocation_iterator SectionRef::end_relocations() const {
495 return OwningObject->getSectionRelEnd(SectionPimpl);
500 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
501 const ObjectFile *Owner)
502 : RelocationPimpl(RelocationP)
503 , OwningObject(Owner) {}
505 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
506 return RelocationPimpl == Other.RelocationPimpl;
509 inline error_code RelocationRef::getNext(RelocationRef &Result) const {
510 return OwningObject->getRelocationNext(RelocationPimpl, Result);
513 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
514 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
517 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
518 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
521 inline error_code RelocationRef::getSymbol(SymbolRef &Result) const {
522 return OwningObject->getRelocationSymbol(RelocationPimpl, Result);
525 inline error_code RelocationRef::getType(uint64_t &Result) const {
526 return OwningObject->getRelocationType(RelocationPimpl, Result);
529 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
531 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
534 inline error_code RelocationRef::getAdditionalInfo(int64_t &Result) const {
535 return OwningObject->getRelocationAdditionalInfo(RelocationPimpl, Result);
538 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
540 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
543 inline error_code RelocationRef::getHidden(bool &Result) const {
544 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
546 // Inline function definitions.
547 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
548 : LibraryPimpl(LibraryP)
549 , OwningObject(Owner) {}
551 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
552 return LibraryPimpl == Other.LibraryPimpl;
555 inline bool LibraryRef::operator <(const LibraryRef &Other) const {
556 return LibraryPimpl < Other.LibraryPimpl;
559 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
560 return OwningObject->getLibraryNext(LibraryPimpl, Result);
563 inline error_code LibraryRef::getPath(StringRef &Result) const {
564 return OwningObject->getLibraryPath(LibraryPimpl, Result);
567 } // end namespace object
568 } // end namespace llvm