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 /// @brief Get value of the symbol in the symbol table.
160 error_code getValue(uint64_t &Val) const;
162 const ObjectFile *getObject() const;
165 class symbol_iterator : public basic_symbol_iterator {
167 symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
168 symbol_iterator(const basic_symbol_iterator &B)
169 : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
170 cast<ObjectFile>(B->getObject()))) {}
172 const SymbolRef *operator->() const {
173 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
174 return static_cast<const SymbolRef*>(&P);
177 const SymbolRef &operator*() const {
178 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
179 return static_cast<const SymbolRef&>(P);
183 /// LibraryRef - This is a value type class that represents a single library in
184 /// the list of libraries needed by a shared or dynamic object.
186 friend class SectionRef;
187 DataRefImpl LibraryPimpl;
188 const ObjectFile *OwningObject;
191 LibraryRef() : OwningObject(NULL) { }
193 LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner);
195 bool operator==(const LibraryRef &Other) const;
196 bool operator<(const LibraryRef &Other) const;
198 error_code getNext(LibraryRef &Result) const;
200 // Get the path to this library, as stored in the object file.
201 error_code getPath(StringRef &Result) const;
203 DataRefImpl getRawDataRefImpl() const;
205 typedef content_iterator<LibraryRef> library_iterator;
207 /// ObjectFile - This class is the base class for all object file types.
208 /// Concrete instances of this object are created by createObjectFile, which
209 /// figures out which type to create.
210 class ObjectFile : public SymbolicFile {
211 virtual void anchor();
212 ObjectFile() LLVM_DELETED_FUNCTION;
213 ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
216 ObjectFile(unsigned int Type, MemoryBuffer *Source, bool BufferOwned = true);
218 const uint8_t *base() const {
219 return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
222 // These functions are for SymbolRef to call internally. The main goal of
223 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
224 // entry in the memory mapped object file. SymbolPimpl cannot contain any
225 // virtual functions because then it could not point into the memory mapped
228 // Implementations assume that the DataRefImpl is valid and has not been
229 // modified externally. It's UB otherwise.
230 friend class SymbolRef;
231 virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
232 error_code printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override;
233 virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
234 virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res)const=0;
235 virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
236 virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
237 virtual error_code getSymbolType(DataRefImpl Symb,
238 SymbolRef::Type &Res) const = 0;
239 virtual error_code getSymbolSection(DataRefImpl Symb,
240 section_iterator &Res) const = 0;
241 virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const = 0;
243 // Same as above for SectionRef.
244 friend class SectionRef;
245 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
246 virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
247 virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
248 virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
249 virtual error_code getSectionContents(DataRefImpl Sec, StringRef &Res)const=0;
250 virtual error_code getSectionAlignment(DataRefImpl Sec, uint64_t &Res)const=0;
251 virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;
252 virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;
253 virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0;
254 virtual error_code isSectionRequiredForExecution(DataRefImpl Sec,
255 bool &Res) const = 0;
256 // A section is 'virtual' if its contents aren't present in the object image.
257 virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0;
258 virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;
259 virtual error_code isSectionReadOnlyData(DataRefImpl Sec, bool &Res) const =0;
260 virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,
261 bool &Result) const = 0;
262 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
263 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
264 virtual bool section_rel_empty(DataRefImpl Sec) const = 0;
265 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
267 // Same as above for RelocationRef.
268 friend class RelocationRef;
269 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
270 virtual error_code getRelocationAddress(DataRefImpl Rel,
271 uint64_t &Res) const =0;
272 virtual error_code getRelocationOffset(DataRefImpl Rel,
273 uint64_t &Res) const =0;
274 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
275 virtual error_code getRelocationType(DataRefImpl Rel,
276 uint64_t &Res) const = 0;
277 virtual error_code getRelocationTypeName(DataRefImpl Rel,
278 SmallVectorImpl<char> &Result) const = 0;
279 virtual error_code getRelocationValueString(DataRefImpl Rel,
280 SmallVectorImpl<char> &Result) const = 0;
281 virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const {
283 return object_error::success;
286 // Same for LibraryRef
287 friend class LibraryRef;
288 virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0;
289 virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
292 typedef iterator_range<symbol_iterator> symbol_iterator_range;
293 symbol_iterator_range symbols() const {
294 return symbol_iterator_range(symbol_begin(), symbol_end());
297 virtual section_iterator section_begin() const = 0;
298 virtual section_iterator section_end() const = 0;
300 typedef iterator_range<section_iterator> section_iterator_range;
301 section_iterator_range sections() const {
302 return section_iterator_range(section_begin(), section_end());
305 virtual library_iterator needed_library_begin() const = 0;
306 virtual library_iterator needed_library_end() const = 0;
308 /// @brief The number of bytes used to represent an address in this object
310 virtual uint8_t getBytesInAddress() const = 0;
312 virtual StringRef getFileFormatName() const = 0;
313 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
315 /// For shared objects, returns the name which this object should be
316 /// loaded from at runtime. This corresponds to DT_SONAME on ELF and
317 /// LC_ID_DYLIB (install name) on MachO.
318 virtual StringRef getLoadName() const = 0;
320 /// @returns Pointer to ObjectFile subclass to handle this type of object.
321 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
323 /// @brief Create ObjectFile from path.
324 static ErrorOr<ObjectFile *> createObjectFile(StringRef ObjectPath);
325 static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object,
327 sys::fs::file_magic Type);
328 static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object) {
329 return createObjectFile(Object, true, sys::fs::file_magic::unknown);
333 static inline bool classof(const Binary *v) {
334 return v->isObject();
338 static ErrorOr<ObjectFile *> createCOFFObjectFile(MemoryBuffer *Object,
339 bool BufferOwned = true);
340 static ErrorOr<ObjectFile *> createELFObjectFile(MemoryBuffer *Object,
341 bool BufferOwned = true);
342 static ErrorOr<ObjectFile *> createMachOObjectFile(MemoryBuffer *Object,
343 bool BufferOwned = true);
346 // Inline function definitions.
347 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
348 : BasicSymbolRef(SymbolP, Owner) {}
350 inline error_code SymbolRef::getName(StringRef &Result) const {
351 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
354 inline error_code SymbolRef::getAddress(uint64_t &Result) const {
355 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
358 inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
359 return getObject()->getSymbolFileOffset(getRawDataRefImpl(), Result);
362 inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
363 return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
366 inline error_code SymbolRef::getSize(uint64_t &Result) const {
367 return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
370 inline error_code SymbolRef::getSection(section_iterator &Result) const {
371 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
374 inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
375 return getObject()->getSymbolType(getRawDataRefImpl(), Result);
378 inline error_code SymbolRef::getValue(uint64_t &Val) const {
379 return getObject()->getSymbolValue(getRawDataRefImpl(), Val);
382 inline const ObjectFile *SymbolRef::getObject() const {
383 const SymbolicFile *O = BasicSymbolRef::getObject();
384 return cast<ObjectFile>(O);
389 inline SectionRef::SectionRef(DataRefImpl SectionP,
390 const ObjectFile *Owner)
391 : SectionPimpl(SectionP)
392 , OwningObject(Owner) {}
394 inline bool SectionRef::operator==(const SectionRef &Other) const {
395 return SectionPimpl == Other.SectionPimpl;
398 inline bool SectionRef::operator!=(const SectionRef &Other) const {
399 return SectionPimpl != Other.SectionPimpl;
402 inline bool SectionRef::operator<(const SectionRef &Other) const {
403 return SectionPimpl < Other.SectionPimpl;
406 inline void SectionRef::moveNext() {
407 return OwningObject->moveSectionNext(SectionPimpl);
410 inline error_code SectionRef::getName(StringRef &Result) const {
411 return OwningObject->getSectionName(SectionPimpl, Result);
414 inline error_code SectionRef::getAddress(uint64_t &Result) const {
415 return OwningObject->getSectionAddress(SectionPimpl, Result);
418 inline error_code SectionRef::getSize(uint64_t &Result) const {
419 return OwningObject->getSectionSize(SectionPimpl, Result);
422 inline error_code SectionRef::getContents(StringRef &Result) const {
423 return OwningObject->getSectionContents(SectionPimpl, Result);
426 inline error_code SectionRef::getAlignment(uint64_t &Result) const {
427 return OwningObject->getSectionAlignment(SectionPimpl, Result);
430 inline error_code SectionRef::isText(bool &Result) const {
431 return OwningObject->isSectionText(SectionPimpl, Result);
434 inline error_code SectionRef::isData(bool &Result) const {
435 return OwningObject->isSectionData(SectionPimpl, Result);
438 inline error_code SectionRef::isBSS(bool &Result) const {
439 return OwningObject->isSectionBSS(SectionPimpl, Result);
442 inline error_code SectionRef::isRequiredForExecution(bool &Result) const {
443 return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result);
446 inline error_code SectionRef::isVirtual(bool &Result) const {
447 return OwningObject->isSectionVirtual(SectionPimpl, Result);
450 inline error_code SectionRef::isZeroInit(bool &Result) const {
451 return OwningObject->isSectionZeroInit(SectionPimpl, Result);
454 inline error_code SectionRef::isReadOnlyData(bool &Result) const {
455 return OwningObject->isSectionReadOnlyData(SectionPimpl, Result);
458 inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
459 return OwningObject->sectionContainsSymbol(SectionPimpl,
460 S.getRawDataRefImpl(), Result);
463 inline relocation_iterator SectionRef::relocation_begin() const {
464 return OwningObject->section_rel_begin(SectionPimpl);
467 inline relocation_iterator SectionRef::relocation_end() const {
468 return OwningObject->section_rel_end(SectionPimpl);
471 inline bool SectionRef::relocation_empty() const {
472 return OwningObject->section_rel_empty(SectionPimpl);
475 inline section_iterator SectionRef::getRelocatedSection() const {
476 return OwningObject->getRelocatedSection(SectionPimpl);
479 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
484 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
485 const ObjectFile *Owner)
486 : RelocationPimpl(RelocationP)
487 , OwningObject(Owner) {}
489 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
490 return RelocationPimpl == Other.RelocationPimpl;
493 inline void RelocationRef::moveNext() {
494 return OwningObject->moveRelocationNext(RelocationPimpl);
497 inline error_code RelocationRef::getAddress(uint64_t &Result) const {
498 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
501 inline error_code RelocationRef::getOffset(uint64_t &Result) const {
502 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
505 inline symbol_iterator RelocationRef::getSymbol() const {
506 return OwningObject->getRelocationSymbol(RelocationPimpl);
509 inline error_code RelocationRef::getType(uint64_t &Result) const {
510 return OwningObject->getRelocationType(RelocationPimpl, Result);
513 inline error_code RelocationRef::getTypeName(SmallVectorImpl<char> &Result)
515 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
518 inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)
520 return OwningObject->getRelocationValueString(RelocationPimpl, Result);
523 inline error_code RelocationRef::getHidden(bool &Result) const {
524 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
527 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
528 return RelocationPimpl;
531 inline const ObjectFile *RelocationRef::getObjectFile() const {
535 // Inline function definitions.
536 inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner)
537 : LibraryPimpl(LibraryP)
538 , OwningObject(Owner) {}
540 inline bool LibraryRef::operator==(const LibraryRef &Other) const {
541 return LibraryPimpl == Other.LibraryPimpl;
544 inline bool LibraryRef::operator<(const LibraryRef &Other) const {
545 return LibraryPimpl < Other.LibraryPimpl;
548 inline error_code LibraryRef::getNext(LibraryRef &Result) const {
549 return OwningObject->getLibraryNext(LibraryPimpl, Result);
552 inline error_code LibraryRef::getPath(StringRef &Result) const {
553 return OwningObject->getLibraryPath(LibraryPimpl, Result);
556 } // end namespace object
557 } // end namespace llvm