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"
32 class symbol_iterator;
34 /// RelocationRef - This is a value type class that represents a single
35 /// relocation in the list of relocations in the object file.
37 DataRefImpl RelocationPimpl;
38 const ObjectFile *OwningObject;
41 RelocationRef() : OwningObject(NULL) { }
43 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
45 bool operator==(const RelocationRef &Other) const;
49 error_code getAddress(uint64_t &Result) const;
50 error_code getOffset(uint64_t &Result) const;
51 symbol_iterator getSymbol() const;
52 error_code getType(uint64_t &Result) const;
54 /// @brief Indicates whether this relocation should hidden when listing
55 /// relocations, usually because it is the trailing part of a multipart
56 /// relocation that will be printed as part of the leading relocation.
57 error_code getHidden(bool &Result) const;
59 /// @brief Get a string that represents the type of this relocation.
61 /// This is for display purposes only.
62 error_code getTypeName(SmallVectorImpl<char> &Result) const;
64 /// @brief Get a string that represents the calculation of the value of this
67 /// This is for display purposes only.
68 error_code getValueString(SmallVectorImpl<char> &Result) const;
70 DataRefImpl getRawDataRefImpl() const;
71 const ObjectFile *getObjectFile() const;
73 typedef content_iterator<RelocationRef> relocation_iterator;
75 /// SectionRef - This is a value type class that represents a single section in
76 /// the list of sections in the object file.
78 typedef content_iterator<SectionRef> section_iterator;
80 friend class SymbolRef;
81 DataRefImpl SectionPimpl;
82 const ObjectFile *OwningObject;
85 SectionRef() : OwningObject(NULL) { }
87 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
89 bool operator==(const SectionRef &Other) const;
90 bool operator!=(const SectionRef &Other) const;
91 bool operator<(const SectionRef &Other) const;
95 error_code getName(StringRef &Result) const;
96 error_code getAddress(uint64_t &Result) const;
97 error_code getSize(uint64_t &Result) const;
98 error_code getContents(StringRef &Result) const;
100 /// @brief Get the alignment of this section as the actual value (not log 2).
101 error_code getAlignment(uint64_t &Result) const;
103 // FIXME: Move to the normalization layer when it's created.
104 error_code isText(bool &Result) const;
105 error_code isData(bool &Result) const;
106 error_code isBSS(bool &Result) const;
107 error_code isRequiredForExecution(bool &Result) const;
108 error_code isVirtual(bool &Result) const;
109 error_code isZeroInit(bool &Result) const;
110 error_code isReadOnlyData(bool &Result) const;
112 error_code containsSymbol(SymbolRef S, bool &Result) const;
114 relocation_iterator relocation_begin() const;
115 relocation_iterator relocation_end() const;
116 typedef iterator_range<relocation_iterator> relocation_iterator_range;
117 relocation_iterator_range relocations() const {
118 return relocation_iterator_range(relocation_begin(), relocation_end());
120 bool relocation_empty() const;
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 error_code getName(StringRef &Result) const;
146 /// Returns the symbol virtual address (i.e. address at which it will be
148 error_code getAddress(uint64_t &Result) const;
149 error_code getFileOffset(uint64_t &Result) const;
150 /// @brief Get the alignment of this symbol as the actual value (not log 2).
151 error_code getAlignment(uint32_t &Result) const;
152 error_code getSize(uint64_t &Result) const;
153 error_code getType(SymbolRef::Type &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 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 /// LibraryRef - This is a value type class that represents a single library in
181 /// the list of libraries needed by a shared or dynamic object.
183 friend class SectionRef;
184 DataRefImpl LibraryPimpl;
185 const ObjectFile *OwningObject;
188 LibraryRef() : OwningObject(NULL) { }
190 LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
192 bool operator==(const LibraryRef &Other) const;
193 bool operator<(const LibraryRef &Other) const;
195 error_code getNext(LibraryRef &Result) const;
197 // Get the path to this library, as stored in the object file.
198 error_code getPath(StringRef &Result) const;
200 DataRefImpl getRawDataRefImpl() const;
202 typedef content_iterator<LibraryRef> library_iterator;
204 /// ObjectFile - This class is the base class for all object file types.
205 /// Concrete instances of this object are created by createObjectFile, which
206 /// figures out which type to create.
207 class ObjectFile : public SymbolicFile {
208 virtual void anchor();
209 ObjectFile() LLVM_DELETED_FUNCTION;
210 ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
213 ObjectFile(unsigned int Type, MemoryBuffer *Source, bool BufferOwned = true);
215 const uint8_t *base() const {
216 return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
219 // These functions are for SymbolRef to call internally. The main goal of
220 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
221 // entry in the memory mapped object file. SymbolPimpl cannot contain any
222 // virtual functions because then it could not point into the memory mapped
225 // Implementations assume that the DataRefImpl is valid and has not been
226 // modified externally. It's UB otherwise.
227 friend class SymbolRef;
228 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
229 error_code printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override;
230 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
231 virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
232 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
233 virtual error_code getSymbolType(DataRefImpl Symb,
234 SymbolRef::Type &Res) const = 0;
235 virtual error_code getSymbolSection(DataRefImpl Symb,
236 section_iterator &Res) const = 0;
238 // Same as above for SectionRef.
239 friend class SectionRef;
240 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
241 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
242 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
243 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
244 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
245 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
246 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
247 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
248 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
249 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
250 bool &Res) const = 0;
251 // A section is 'virtual' if its contents aren't present in the object image.
252 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0;
253 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;
254 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const =0;
255 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
256 bool &Result) const = 0;
257 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
258 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
259 virtual bool section_rel_empty(DataRefImpl Sec) const = 0;
260 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
262 // Same as above for RelocationRef.
263 friend class RelocationRef;
264 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
265 virtual error_code getRelocationAddress(DataRefImpl Rel,
266 uint64_t &Res) const =0;
267 virtual error_code getRelocationOffset(DataRefImpl Rel,
268 uint64_t &Res) const =0;
269 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
270 virtual error_code getRelocationType(DataRefImpl Rel,
271 uint64_t &Res) const = 0;
272 virtual error_code getRelocationTypeName(DataRefImpl Rel,
273 SmallVectorImpl<char> &Result) const = 0;
274 virtual error_code getRelocationValueString(DataRefImpl Rel,
275 SmallVectorImpl<char> &Result) const = 0;
276 virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
278 return object_error::success;
281 // Same for LibraryRef
282 friend class LibraryRef;
283 virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
284 virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
287 typedef iterator_range<symbol_iterator> symbol_iterator_range;
288 symbol_iterator_range symbols() const {
289 return symbol_iterator_range(symbol_begin(), symbol_end());
292 virtual section_iterator section_begin() const = 0;
293 virtual section_iterator section_end() const = 0;
295 typedef iterator_range<section_iterator> section_iterator_range;
296 section_iterator_range sections() const {
297 return section_iterator_range(section_begin(), section_end());
300 virtual library_iterator needed_library_begin() const = 0;
301 virtual library_iterator needed_library_end() const = 0;
303 /// @brief The number of bytes used to represent an address in this object
305 virtual uint8_t getBytesInAddress() const = 0;
307 virtual StringRef getFileFormatName() const = 0;
308 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
310 /// For shared objects, returns the name which this object should be
311 /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
312 /// LC_ID_DYLIB (install name) on MachO.
313 virtual StringRef getLoadName() const = 0;
315 /// @returns Pointer to ObjectFile subclass to handle this type of object.
316 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
318 /// @brief Create ObjectFile from path.
319 static ErrorOr<ObjectFile *> createObjectFile(StringRef ObjectPath);
320 static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object,
322 sys::fs::file_magic Type);
323 static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object) {
324 return createObjectFile(Object, true, sys::fs::file_magic::unknown);
328 static inline bool classof(const Binary *v) {
329 return v->isObject();
333 static ErrorOr<ObjectFile *> createCOFFObjectFile(MemoryBuffer *Object,
334 bool BufferOwned = true);
335 static ErrorOr<ObjectFile *> createELFObjectFile(MemoryBuffer *Object,
336 bool BufferOwned = true);
337 static ErrorOr<ObjectFile *> createMachOObjectFile(MemoryBuffer *Object,
338 bool BufferOwned = true);
341 // Inline function definitions.
342 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
343 : BasicSymbolRef(SymbolP, Owner) {}
345 inline error_code SymbolRef::getName(StringRef &Result) const {
346 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
349 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
350 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
353 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
355 if (error_code EC = getAddress(Address))
358 const ObjectFile *Obj = getObject();
359 section_iterator SecI(Obj->section_begin());
360 if (error_code EC = getSection(SecI))
363 uint64_t SectionAddress;
364 if (error_code EC = SecI->getAddress(SectionAddress))
367 uint64_t OffsetInSection = Address - SectionAddress;
369 StringRef SecContents;
370 if (error_code EC = SecI->getContents(SecContents))
373 // FIXME: this is a hack.
374 uint64_t SectionOffset = (uint64_t)SecContents.data() - (uint64_t)Obj->base();
376 Result = SectionOffset + OffsetInSection;
377 return object_error::success;
380 inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
381 return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
384 inline error_code SymbolRef::getSize(uint64_t &Result) const {
385 return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
388 inline error_code SymbolRef::getSection(section_iterator &Result) const {
389 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
392 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
393 return getObject()->getSymbolType(getRawDataRefImpl(), Result);
396 inline const ObjectFile *SymbolRef::getObject() const {
397 const SymbolicFile *O = BasicSymbolRef::getObject();
398 return cast<ObjectFile>(O);
403 inline SectionRef::SectionRef(DataRefImpl SectionP,
404 const ObjectFile *Owner)
405 : SectionPimpl(SectionP)
406 , OwningObject(Owner) {}
408 inline bool SectionRef::operator==(const SectionRef &Other) const {
409 return SectionPimpl == Other.SectionPimpl;
412 inline bool SectionRef::operator!=(const SectionRef &Other) const {
413 return SectionPimpl != Other.SectionPimpl;
416 inline bool SectionRef::operator<(const SectionRef &Other) const {
417 return SectionPimpl < Other.SectionPimpl;
420 inline void SectionRef::moveNext() {
421 return OwningObject->moveSectionNext(SectionPimpl);
424 inline error_code SectionRef::getName(StringRef &Result) const {
425 return OwningObject->getSectionName(SectionPimpl, Result);
428 inline error_code SectionRef::getAddress(uint64_t &Result) const {
429 return OwningObject->getSectionAddress(SectionPimpl, Result);
432 inline error_code SectionRef::getSize(uint64_t &Result) const {
433 return OwningObject->getSectionSize(SectionPimpl, Result);
436 inline error_code SectionRef::getContents(StringRef &Result) const {
437 return OwningObject->getSectionContents(SectionPimpl, Result);
440 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
441 return OwningObject->getSectionAlignment(SectionPimpl, Result);
444 inline error_code SectionRef::isText(bool &Result) const {
445 return OwningObject->isSectionText(SectionPimpl, Result);
448 inline error_code SectionRef::isData(bool &Result) const {
449 return OwningObject->isSectionData(SectionPimpl, Result);
452 inline error_code SectionRef::isBSS(bool &Result) const {
453 return OwningObject->isSectionBSS(SectionPimpl, Result);
456 inline error_code SectionRef::isRequiredForExecution(bool &Result) const {
457 return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
460 inline error_code SectionRef::isVirtual(bool &Result) const {
461 return OwningObject->isSectionVirtual(SectionPimpl, Result);
464 inline error_code SectionRef::isZeroInit(bool &Result) const {
465 return OwningObject->isSectionZeroInit(SectionPimpl, Result);
468 inline error_code SectionRef::isReadOnlyData(bool &Result) const {
469 return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
472 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
473 return OwningObject->sectionContainsSymbol(SectionPimpl,
474 S.getRawDataRefImpl(), Result);
477 inline relocation_iterator SectionRef::relocation_begin() const {
478 return OwningObject->section_rel_begin(SectionPimpl);
481 inline relocation_iterator SectionRef::relocation_end() const {
482 return OwningObject->section_rel_end(SectionPimpl);
485 inline bool SectionRef::relocation_empty() const {
486 return OwningObject->section_rel_empty(SectionPimpl);
489 inline section_iterator SectionRef::getRelocatedSection() const {
490 return OwningObject->getRelocatedSection(SectionPimpl);
493 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
498 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
499 const ObjectFile *Owner)
500 : RelocationPimpl(RelocationP)
501 , OwningObject(Owner) {}
503 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
504 return RelocationPimpl == Other.RelocationPimpl;
507 inline void RelocationRef::moveNext() {
508 return OwningObject->moveRelocationNext(RelocationPimpl);
511 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
512 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
515 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
516 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
519 inline symbol_iterator RelocationRef::getSymbol() const {
520 return OwningObject->getRelocationSymbol(RelocationPimpl);
523 inline error_code RelocationRef::getType(uint64_t &Result) const {
524 return OwningObject->getRelocationType(RelocationPimpl, Result);
527 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
529 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
532 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
534 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
537 inline error_code RelocationRef::getHidden(bool &Result) const {
538 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
541 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
542 return RelocationPimpl;
545 inline const ObjectFile *RelocationRef::getObjectFile() const {
549 // Inline function definitions.
550 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
551 : LibraryPimpl(LibraryP)
552 , OwningObject(Owner) {}
554 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
555 return LibraryPimpl == Other.LibraryPimpl;
558 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
559 return LibraryPimpl < Other.LibraryPimpl;
562 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
563 return OwningObject->getLibraryNext(LibraryPimpl, Result);
566 inline error_code LibraryRef::getPath(StringRef &Result) const {
567 return OwningObject->getLibraryPath(LibraryPimpl, Result);
570 } // end namespace object
571 } // end namespace llvm