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"
31 class MachOObjectFile;
34 class symbol_iterator;
36 typedef content_iterator<SectionRef> section_iterator;
38 /// This is a value type class that represents a single relocation in the list
39 /// of relocations in the object file.
41 DataRefImpl RelocationPimpl;
42 const ObjectFile *OwningObject;
45 RelocationRef() : OwningObject(nullptr) { }
47 RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
49 bool operator==(const RelocationRef &Other) const;
53 std::error_code getAddress(uint64_t &Result) const;
54 std::error_code getOffset(uint64_t &Result) const;
55 symbol_iterator getSymbol() const;
56 std::error_code getType(uint64_t &Result) const;
58 /// @brief Indicates whether this relocation should hidden when listing
59 /// relocations, usually because it is the trailing part of a multipart
60 /// relocation that will be printed as part of the leading relocation.
61 std::error_code getHidden(bool &Result) const;
63 /// @brief Get a string that represents the type of this relocation.
65 /// This is for display purposes only.
66 std::error_code getTypeName(SmallVectorImpl<char> &Result) const;
69 DataRefImpl getRawDataRefImpl() const;
70 const ObjectFile *getObjectFile() const;
72 typedef content_iterator<RelocationRef> relocation_iterator;
74 /// This is a value type class that represents a single section in the list of
75 /// sections in the object file.
77 friend class SymbolRef;
78 DataRefImpl SectionPimpl;
79 const ObjectFile *OwningObject;
82 SectionRef() : OwningObject(nullptr) { }
84 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
86 bool operator==(const SectionRef &Other) const;
87 bool operator!=(const SectionRef &Other) const;
88 bool operator<(const SectionRef &Other) const;
92 std::error_code getName(StringRef &Result) const;
93 uint64_t getAddress() const;
94 uint64_t getSize() const;
95 std::error_code getContents(StringRef &Result) const;
97 /// @brief Get the alignment of this section as the actual value (not log 2).
98 uint64_t getAlignment() const;
103 bool isVirtual() const;
105 bool containsSymbol(SymbolRef S) const;
107 relocation_iterator relocation_begin() const;
108 relocation_iterator relocation_end() const;
109 iterator_range<relocation_iterator> relocations() const {
110 return iterator_range<relocation_iterator>(relocation_begin(),
113 section_iterator getRelocatedSection() const;
115 DataRefImpl getRawDataRefImpl() const;
116 const ObjectFile *getObject() const;
119 /// This is a value type class that represents a single symbol in the list of
120 /// symbols in the object file.
121 class SymbolRef : public BasicSymbolRef {
122 friend class SectionRef;
125 SymbolRef() : BasicSymbolRef() {}
128 ST_Unknown, // Type not specified
136 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
137 SymbolRef(const BasicSymbolRef &B) : BasicSymbolRef(B) {
138 assert(isa<ObjectFile>(BasicSymbolRef::getObject()));
141 std::error_code getName(StringRef &Result) const;
142 /// Returns the symbol virtual address (i.e. address at which it will be
144 std::error_code getAddress(uint64_t &Result) const;
146 /// Return the value of the symbol depending on the object this can be an
147 /// offset or a virtual address.
148 uint64_t getValue() const;
150 /// @brief Get the alignment of this symbol as the actual value (not log 2).
151 uint32_t getAlignment() const;
152 uint64_t getCommonSize() const;
153 SymbolRef::Type getType() 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 std::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 /// This class is the base class for all object file types. Concrete instances
181 /// of this object are created by createObjectFile, which figures out which type
183 class ObjectFile : public SymbolicFile {
184 virtual void anchor();
185 ObjectFile() = delete;
186 ObjectFile(const ObjectFile &other) = delete;
189 ObjectFile(unsigned int Type, MemoryBufferRef Source);
191 const uint8_t *base() const {
192 return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
195 // These functions are for SymbolRef to call internally. The main goal of
196 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
197 // entry in the memory mapped object file. SymbolPimpl cannot contain any
198 // virtual functions because then it could not point into the memory mapped
201 // Implementations assume that the DataRefImpl is valid and has not been
202 // modified externally. It's UB otherwise.
203 friend class SymbolRef;
204 virtual std::error_code getSymbolName(DataRefImpl Symb,
205 StringRef &Res) const = 0;
206 std::error_code printSymbolName(raw_ostream &OS,
207 DataRefImpl Symb) const override;
208 virtual std::error_code getSymbolAddress(DataRefImpl Symb,
209 uint64_t &Res) const = 0;
210 virtual uint64_t getSymbolValue(DataRefImpl Symb) const = 0;
211 virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
212 virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
213 virtual SymbolRef::Type getSymbolType(DataRefImpl Symb) const = 0;
214 virtual std::error_code getSymbolSection(DataRefImpl Symb,
215 section_iterator &Res) const = 0;
217 // Same as above for SectionRef.
218 friend class SectionRef;
219 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
220 virtual std::error_code getSectionName(DataRefImpl Sec,
221 StringRef &Res) const = 0;
222 virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
223 virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
224 virtual std::error_code getSectionContents(DataRefImpl Sec,
225 StringRef &Res) const = 0;
226 virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
227 virtual bool isSectionText(DataRefImpl Sec) const = 0;
228 virtual bool isSectionData(DataRefImpl Sec) const = 0;
229 virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
230 // A section is 'virtual' if its contents aren't present in the object image.
231 virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
232 virtual bool sectionContainsSymbol(DataRefImpl Sec,
233 DataRefImpl Symb) const = 0;
234 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
235 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
236 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
238 // Same as above for RelocationRef.
239 friend class RelocationRef;
240 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
241 virtual std::error_code getRelocationAddress(DataRefImpl Rel,
242 uint64_t &Res) const = 0;
243 virtual std::error_code getRelocationOffset(DataRefImpl Rel,
244 uint64_t &Res) const = 0;
245 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
246 virtual std::error_code getRelocationType(DataRefImpl Rel,
247 uint64_t &Res) const = 0;
248 virtual std::error_code
249 getRelocationTypeName(DataRefImpl Rel,
250 SmallVectorImpl<char> &Result) const = 0;
251 virtual std::error_code getRelocationHidden(DataRefImpl Rel,
252 bool &Result) const {
254 return std::error_code();
258 uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
259 assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
260 return getCommonSymbolSizeImpl(Symb);
263 typedef iterator_range<symbol_iterator> symbol_iterator_range;
264 symbol_iterator_range symbols() const {
265 return symbol_iterator_range(symbol_begin(), symbol_end());
268 virtual section_iterator section_begin() const = 0;
269 virtual section_iterator section_end() const = 0;
271 typedef iterator_range<section_iterator> section_iterator_range;
272 section_iterator_range sections() const {
273 return section_iterator_range(section_begin(), section_end());
276 /// @brief The number of bytes used to represent an address in this object
278 virtual uint8_t getBytesInAddress() const = 0;
280 virtual StringRef getFileFormatName() const = 0;
281 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
283 /// Returns platform-specific object flags, if any.
284 virtual std::error_code getPlatformFlags(unsigned &Result) const {
286 return object_error::invalid_file_type;
289 /// True if this is a relocatable object (.o/.obj).
290 virtual bool isRelocatableObject() const = 0;
292 /// @returns Pointer to ObjectFile subclass to handle this type of object.
293 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
295 /// @brief Create ObjectFile from path.
296 static ErrorOr<OwningBinary<ObjectFile>>
297 createObjectFile(StringRef ObjectPath);
299 static ErrorOr<std::unique_ptr<ObjectFile>>
300 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
301 static ErrorOr<std::unique_ptr<ObjectFile>>
302 createObjectFile(MemoryBufferRef Object) {
303 return createObjectFile(Object, sys::fs::file_magic::unknown);
307 static inline bool classof(const Binary *v) {
308 return v->isObject();
311 static ErrorOr<std::unique_ptr<COFFObjectFile>>
312 createCOFFObjectFile(MemoryBufferRef Object);
314 static ErrorOr<std::unique_ptr<ObjectFile>>
315 createELFObjectFile(MemoryBufferRef Object);
317 static ErrorOr<std::unique_ptr<MachOObjectFile>>
318 createMachOObjectFile(MemoryBufferRef Object);
321 // Inline function definitions.
322 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
323 : BasicSymbolRef(SymbolP, Owner) {}
325 inline std::error_code SymbolRef::getName(StringRef &Result) const {
326 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
329 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
330 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
333 inline uint64_t SymbolRef::getValue() const {
334 return getObject()->getSymbolValue(getRawDataRefImpl());
337 inline uint32_t SymbolRef::getAlignment() const {
338 return getObject()->getSymbolAlignment(getRawDataRefImpl());
341 inline uint64_t SymbolRef::getCommonSize() const {
342 return getObject()->getCommonSymbolSize(getRawDataRefImpl());
345 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
346 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
349 inline SymbolRef::Type SymbolRef::getType() const {
350 return getObject()->getSymbolType(getRawDataRefImpl());
353 inline const ObjectFile *SymbolRef::getObject() const {
354 const SymbolicFile *O = BasicSymbolRef::getObject();
355 return cast<ObjectFile>(O);
360 inline SectionRef::SectionRef(DataRefImpl SectionP,
361 const ObjectFile *Owner)
362 : SectionPimpl(SectionP)
363 , OwningObject(Owner) {}
365 inline bool SectionRef::operator==(const SectionRef &Other) const {
366 return SectionPimpl == Other.SectionPimpl;
369 inline bool SectionRef::operator!=(const SectionRef &Other) const {
370 return SectionPimpl != Other.SectionPimpl;
373 inline bool SectionRef::operator<(const SectionRef &Other) const {
374 return SectionPimpl < Other.SectionPimpl;
377 inline void SectionRef::moveNext() {
378 return OwningObject->moveSectionNext(SectionPimpl);
381 inline std::error_code SectionRef::getName(StringRef &Result) const {
382 return OwningObject->getSectionName(SectionPimpl, Result);
385 inline uint64_t SectionRef::getAddress() const {
386 return OwningObject->getSectionAddress(SectionPimpl);
389 inline uint64_t SectionRef::getSize() const {
390 return OwningObject->getSectionSize(SectionPimpl);
393 inline std::error_code SectionRef::getContents(StringRef &Result) const {
394 return OwningObject->getSectionContents(SectionPimpl, Result);
397 inline uint64_t SectionRef::getAlignment() const {
398 return OwningObject->getSectionAlignment(SectionPimpl);
401 inline bool SectionRef::isText() const {
402 return OwningObject->isSectionText(SectionPimpl);
405 inline bool SectionRef::isData() const {
406 return OwningObject->isSectionData(SectionPimpl);
409 inline bool SectionRef::isBSS() const {
410 return OwningObject->isSectionBSS(SectionPimpl);
413 inline bool SectionRef::isVirtual() const {
414 return OwningObject->isSectionVirtual(SectionPimpl);
417 inline bool SectionRef::containsSymbol(SymbolRef S) const {
418 return OwningObject->sectionContainsSymbol(SectionPimpl,
419 S.getRawDataRefImpl());
422 inline relocation_iterator SectionRef::relocation_begin() const {
423 return OwningObject->section_rel_begin(SectionPimpl);
426 inline relocation_iterator SectionRef::relocation_end() const {
427 return OwningObject->section_rel_end(SectionPimpl);
430 inline section_iterator SectionRef::getRelocatedSection() const {
431 return OwningObject->getRelocatedSection(SectionPimpl);
434 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
438 inline const ObjectFile *SectionRef::getObject() const {
443 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
444 const ObjectFile *Owner)
445 : RelocationPimpl(RelocationP)
446 , OwningObject(Owner) {}
448 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
449 return RelocationPimpl == Other.RelocationPimpl;
452 inline void RelocationRef::moveNext() {
453 return OwningObject->moveRelocationNext(RelocationPimpl);
456 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
457 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
460 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
461 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
464 inline symbol_iterator RelocationRef::getSymbol() const {
465 return OwningObject->getRelocationSymbol(RelocationPimpl);
468 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
469 return OwningObject->getRelocationType(RelocationPimpl, Result);
472 inline std::error_code
473 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
474 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
477 inline std::error_code RelocationRef::getHidden(bool &Result) const {
478 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
481 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
482 return RelocationPimpl;
485 inline const ObjectFile *RelocationRef::getObjectFile() const {
490 } // end namespace object
491 } // end namespace llvm