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 uint64_t getOffset() const;
54 symbol_iterator getSymbol() const;
55 uint64_t getType() const;
57 /// @brief Get a string that represents the type of this relocation.
59 /// This is for display purposes only.
60 void getTypeName(SmallVectorImpl<char> &Result) const;
62 DataRefImpl getRawDataRefImpl() const;
63 const ObjectFile *getObject() const;
65 typedef content_iterator<RelocationRef> relocation_iterator;
67 /// This is a value type class that represents a single section in the list of
68 /// sections in the object file.
70 friend class SymbolRef;
71 DataRefImpl SectionPimpl;
72 const ObjectFile *OwningObject;
75 SectionRef() : OwningObject(nullptr) { }
77 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
79 bool operator==(const SectionRef &Other) const;
80 bool operator!=(const SectionRef &Other) const;
81 bool operator<(const SectionRef &Other) const;
85 std::error_code getName(StringRef &Result) const;
86 uint64_t getAddress() const;
87 uint64_t getSize() const;
88 std::error_code getContents(StringRef &Result) const;
90 /// @brief Get the alignment of this section as the actual value (not log 2).
91 uint64_t getAlignment() const;
96 bool isVirtual() const;
98 bool containsSymbol(SymbolRef S) const;
100 relocation_iterator relocation_begin() const;
101 relocation_iterator relocation_end() const;
102 iterator_range<relocation_iterator> relocations() const {
103 return iterator_range<relocation_iterator>(relocation_begin(),
106 section_iterator getRelocatedSection() const;
108 DataRefImpl getRawDataRefImpl() const;
109 const ObjectFile *getObject() const;
112 /// This is a value type class that represents a single symbol in the list of
113 /// symbols in the object file.
114 class SymbolRef : public BasicSymbolRef {
115 friend class SectionRef;
118 SymbolRef() : BasicSymbolRef() {}
121 ST_Unknown, // Type not specified
129 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
130 SymbolRef(const BasicSymbolRef &B) : BasicSymbolRef(B) {
131 assert(isa<ObjectFile>(BasicSymbolRef::getObject()));
134 ErrorOr<StringRef> getName() const;
135 /// Returns the symbol virtual address (i.e. address at which it will be
137 ErrorOr<uint64_t> getAddress() const;
139 /// Return the value of the symbol depending on the object this can be an
140 /// offset or a virtual address.
141 uint64_t getValue() const;
143 /// @brief Get the alignment of this symbol as the actual value (not log 2).
144 uint32_t getAlignment() const;
145 uint64_t getCommonSize() const;
146 SymbolRef::Type getType() const;
148 /// @brief Get section this symbol is defined in reference to. Result is
149 /// end_sections() if it is undefined or is an absolute symbol.
150 ErrorOr<section_iterator> getSection() const;
152 const ObjectFile *getObject() const;
155 class symbol_iterator : public basic_symbol_iterator {
157 symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
158 symbol_iterator(const basic_symbol_iterator &B)
159 : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
160 cast<ObjectFile>(B->getObject()))) {}
162 const SymbolRef *operator->() const {
163 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
164 return static_cast<const SymbolRef*>(&P);
167 const SymbolRef &operator*() const {
168 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
169 return static_cast<const SymbolRef&>(P);
173 /// This class is the base class for all object file types. Concrete instances
174 /// of this object are created by createObjectFile, which figures out which type
176 class ObjectFile : public SymbolicFile {
177 virtual void anchor();
178 ObjectFile() = delete;
179 ObjectFile(const ObjectFile &other) = delete;
182 ObjectFile(unsigned int Type, MemoryBufferRef Source);
184 const uint8_t *base() const {
185 return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
188 // These functions are for SymbolRef to call internally. The main goal of
189 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
190 // entry in the memory mapped object file. SymbolPimpl cannot contain any
191 // virtual functions because then it could not point into the memory mapped
194 // Implementations assume that the DataRefImpl is valid and has not been
195 // modified externally. It's UB otherwise.
196 friend class SymbolRef;
197 virtual ErrorOr<StringRef> getSymbolName(DataRefImpl Symb) const = 0;
198 std::error_code printSymbolName(raw_ostream &OS,
199 DataRefImpl Symb) const override;
200 virtual ErrorOr<uint64_t> getSymbolAddress(DataRefImpl Symb) const = 0;
201 virtual uint64_t getSymbolValueImpl(DataRefImpl Symb) const = 0;
202 virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
203 virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
204 virtual SymbolRef::Type getSymbolType(DataRefImpl Symb) const = 0;
205 virtual ErrorOr<section_iterator>
206 getSymbolSection(DataRefImpl Symb) const = 0;
208 // Same as above for SectionRef.
209 friend class SectionRef;
210 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
211 virtual std::error_code getSectionName(DataRefImpl Sec,
212 StringRef &Res) const = 0;
213 virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
214 virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
215 virtual std::error_code getSectionContents(DataRefImpl Sec,
216 StringRef &Res) const = 0;
217 virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
218 virtual bool isSectionText(DataRefImpl Sec) const = 0;
219 virtual bool isSectionData(DataRefImpl Sec) const = 0;
220 virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
221 // A section is 'virtual' if its contents aren't present in the object image.
222 virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
223 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
224 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
225 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
227 // Same as above for RelocationRef.
228 friend class RelocationRef;
229 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
230 virtual uint64_t getRelocationOffset(DataRefImpl Rel) const = 0;
231 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
232 virtual uint64_t getRelocationType(DataRefImpl Rel) const = 0;
233 virtual void getRelocationTypeName(DataRefImpl Rel,
234 SmallVectorImpl<char> &Result) const = 0;
236 uint64_t getSymbolValue(DataRefImpl Symb) const;
239 uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
240 assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
241 return getCommonSymbolSizeImpl(Symb);
244 typedef iterator_range<symbol_iterator> symbol_iterator_range;
245 symbol_iterator_range symbols() const {
246 return symbol_iterator_range(symbol_begin(), symbol_end());
249 virtual section_iterator section_begin() const = 0;
250 virtual section_iterator section_end() const = 0;
252 typedef iterator_range<section_iterator> section_iterator_range;
253 section_iterator_range sections() const {
254 return section_iterator_range(section_begin(), section_end());
257 /// @brief The number of bytes used to represent an address in this object
259 virtual uint8_t getBytesInAddress() const = 0;
261 virtual StringRef getFileFormatName() const = 0;
262 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
264 /// Returns platform-specific object flags, if any.
265 virtual std::error_code getPlatformFlags(unsigned &Result) const {
267 return object_error::invalid_file_type;
270 /// True if this is a relocatable object (.o/.obj).
271 virtual bool isRelocatableObject() const = 0;
273 /// @returns Pointer to ObjectFile subclass to handle this type of object.
274 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
276 /// @brief Create ObjectFile from path.
277 static ErrorOr<OwningBinary<ObjectFile>>
278 createObjectFile(StringRef ObjectPath);
280 static ErrorOr<std::unique_ptr<ObjectFile>>
281 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
282 static ErrorOr<std::unique_ptr<ObjectFile>>
283 createObjectFile(MemoryBufferRef Object) {
284 return createObjectFile(Object, sys::fs::file_magic::unknown);
288 static inline bool classof(const Binary *v) {
289 return v->isObject();
292 static ErrorOr<std::unique_ptr<COFFObjectFile>>
293 createCOFFObjectFile(MemoryBufferRef Object);
295 static ErrorOr<std::unique_ptr<ObjectFile>>
296 createELFObjectFile(MemoryBufferRef Object);
298 static ErrorOr<std::unique_ptr<MachOObjectFile>>
299 createMachOObjectFile(MemoryBufferRef Object);
302 // Inline function definitions.
303 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
304 : BasicSymbolRef(SymbolP, Owner) {}
306 inline ErrorOr<StringRef> SymbolRef::getName() const {
307 return getObject()->getSymbolName(getRawDataRefImpl());
310 inline ErrorOr<uint64_t> SymbolRef::getAddress() const {
311 return getObject()->getSymbolAddress(getRawDataRefImpl());
314 inline uint64_t SymbolRef::getValue() const {
315 return getObject()->getSymbolValue(getRawDataRefImpl());
318 inline uint32_t SymbolRef::getAlignment() const {
319 return getObject()->getSymbolAlignment(getRawDataRefImpl());
322 inline uint64_t SymbolRef::getCommonSize() const {
323 return getObject()->getCommonSymbolSize(getRawDataRefImpl());
326 inline ErrorOr<section_iterator> SymbolRef::getSection() const {
327 return getObject()->getSymbolSection(getRawDataRefImpl());
330 inline SymbolRef::Type SymbolRef::getType() const {
331 return getObject()->getSymbolType(getRawDataRefImpl());
334 inline const ObjectFile *SymbolRef::getObject() const {
335 const SymbolicFile *O = BasicSymbolRef::getObject();
336 return cast<ObjectFile>(O);
341 inline SectionRef::SectionRef(DataRefImpl SectionP,
342 const ObjectFile *Owner)
343 : SectionPimpl(SectionP)
344 , OwningObject(Owner) {}
346 inline bool SectionRef::operator==(const SectionRef &Other) const {
347 return SectionPimpl == Other.SectionPimpl;
350 inline bool SectionRef::operator!=(const SectionRef &Other) const {
351 return SectionPimpl != Other.SectionPimpl;
354 inline bool SectionRef::operator<(const SectionRef &Other) const {
355 return SectionPimpl < Other.SectionPimpl;
358 inline void SectionRef::moveNext() {
359 return OwningObject->moveSectionNext(SectionPimpl);
362 inline std::error_code SectionRef::getName(StringRef &Result) const {
363 return OwningObject->getSectionName(SectionPimpl, Result);
366 inline uint64_t SectionRef::getAddress() const {
367 return OwningObject->getSectionAddress(SectionPimpl);
370 inline uint64_t SectionRef::getSize() const {
371 return OwningObject->getSectionSize(SectionPimpl);
374 inline std::error_code SectionRef::getContents(StringRef &Result) const {
375 return OwningObject->getSectionContents(SectionPimpl, Result);
378 inline uint64_t SectionRef::getAlignment() const {
379 return OwningObject->getSectionAlignment(SectionPimpl);
382 inline bool SectionRef::isText() const {
383 return OwningObject->isSectionText(SectionPimpl);
386 inline bool SectionRef::isData() const {
387 return OwningObject->isSectionData(SectionPimpl);
390 inline bool SectionRef::isBSS() const {
391 return OwningObject->isSectionBSS(SectionPimpl);
394 inline bool SectionRef::isVirtual() const {
395 return OwningObject->isSectionVirtual(SectionPimpl);
398 inline relocation_iterator SectionRef::relocation_begin() const {
399 return OwningObject->section_rel_begin(SectionPimpl);
402 inline relocation_iterator SectionRef::relocation_end() const {
403 return OwningObject->section_rel_end(SectionPimpl);
406 inline section_iterator SectionRef::getRelocatedSection() const {
407 return OwningObject->getRelocatedSection(SectionPimpl);
410 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
414 inline const ObjectFile *SectionRef::getObject() const {
419 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
420 const ObjectFile *Owner)
421 : RelocationPimpl(RelocationP)
422 , OwningObject(Owner) {}
424 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
425 return RelocationPimpl == Other.RelocationPimpl;
428 inline void RelocationRef::moveNext() {
429 return OwningObject->moveRelocationNext(RelocationPimpl);
432 inline uint64_t RelocationRef::getOffset() const {
433 return OwningObject->getRelocationOffset(RelocationPimpl);
436 inline symbol_iterator RelocationRef::getSymbol() const {
437 return OwningObject->getRelocationSymbol(RelocationPimpl);
440 inline uint64_t RelocationRef::getType() const {
441 return OwningObject->getRelocationType(RelocationPimpl);
444 inline void RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
445 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
448 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
449 return RelocationPimpl;
452 inline const ObjectFile *RelocationRef::getObject() const {
457 } // end namespace object
458 } // end namespace llvm