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 /// RelocationRef - This is a value type class that represents a single
39 /// relocation in the list 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 section_iterator getSection() const;
57 std::error_code getType(uint64_t &Result) const;
59 /// @brief Indicates whether this relocation should hidden when listing
60 /// relocations, usually because it is the trailing part of a multipart
61 /// relocation that will be printed as part of the leading relocation.
62 std::error_code getHidden(bool &Result) const;
64 /// @brief Get a string that represents the type of this relocation.
66 /// This is for display purposes only.
67 std::error_code getTypeName(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 friend class SymbolRef;
79 DataRefImpl SectionPimpl;
80 const ObjectFile *OwningObject;
83 SectionRef() : OwningObject(nullptr) { }
85 SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
87 bool operator==(const SectionRef &Other) const;
88 bool operator!=(const SectionRef &Other) const;
89 bool operator<(const SectionRef &Other) const;
93 std::error_code getName(StringRef &Result) const;
94 uint64_t getAddress() const;
95 uint64_t getSize() const;
96 std::error_code getContents(StringRef &Result) const;
98 /// @brief Get the alignment of this section as the actual value (not log 2).
99 uint64_t getAlignment() const;
104 bool isVirtual() const;
106 bool containsSymbol(SymbolRef S) const;
108 relocation_iterator relocation_begin() const;
109 relocation_iterator relocation_end() const;
110 iterator_range<relocation_iterator> relocations() const {
111 return iterator_range<relocation_iterator>(relocation_begin(),
114 section_iterator getRelocatedSection() const;
116 DataRefImpl getRawDataRefImpl() const;
117 const ObjectFile *getObject() const;
120 /// SymbolRef - This is a value type class that represents a single symbol in
121 /// the list of symbols in the object file.
122 class SymbolRef : public BasicSymbolRef {
123 friend class SectionRef;
126 SymbolRef() : BasicSymbolRef() {}
129 ST_Unknown, // Type not specified
137 SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
139 std::error_code getName(StringRef &Result) const;
140 /// Returns the symbol virtual address (i.e. address at which it will be
142 std::error_code getAddress(uint64_t &Result) const;
143 /// @brief Get the alignment of this symbol as the actual value (not log 2).
144 uint32_t getAlignment() const;
145 uint64_t getSize() const;
146 std::error_code getType(SymbolRef::Type &Result) const;
147 std::error_code getOther(uint8_t &Result) const;
149 /// @brief Get section this symbol is defined in reference to. Result is
150 /// end_sections() if it is undefined or is an absolute symbol.
151 std::error_code getSection(section_iterator &Result) const;
153 const ObjectFile *getObject() const;
156 class symbol_iterator : public basic_symbol_iterator {
158 symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
159 symbol_iterator(const basic_symbol_iterator &B)
160 : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
161 cast<ObjectFile>(B->getObject()))) {}
163 const SymbolRef *operator->() const {
164 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
165 return static_cast<const SymbolRef*>(&P);
168 const SymbolRef &operator*() const {
169 const BasicSymbolRef &P = basic_symbol_iterator::operator *();
170 return static_cast<const SymbolRef&>(P);
174 /// ObjectFile - This class is the base class for all object file types.
175 /// Concrete instances of this object are created by createObjectFile, which
176 /// figures out which type to create.
177 class ObjectFile : public SymbolicFile {
178 virtual void anchor();
179 ObjectFile() = delete;
180 ObjectFile(const ObjectFile &other) = delete;
183 ObjectFile(unsigned int Type, MemoryBufferRef Source);
185 const uint8_t *base() const {
186 return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
189 // These functions are for SymbolRef to call internally. The main goal of
190 // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
191 // entry in the memory mapped object file. SymbolPimpl cannot contain any
192 // virtual functions because then it could not point into the memory mapped
195 // Implementations assume that the DataRefImpl is valid and has not been
196 // modified externally. It's UB otherwise.
197 friend class SymbolRef;
198 virtual std::error_code getSymbolName(DataRefImpl Symb,
199 StringRef &Res) const = 0;
200 std::error_code printSymbolName(raw_ostream &OS,
201 DataRefImpl Symb) const override;
202 virtual std::error_code getSymbolAddress(DataRefImpl Symb,
203 uint64_t &Res) const = 0;
204 virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
205 virtual uint64_t getSymbolSize(DataRefImpl Symb) const = 0;
206 virtual std::error_code getSymbolType(DataRefImpl Symb,
207 SymbolRef::Type &Res) const = 0;
208 virtual std::error_code getSymbolSection(DataRefImpl Symb,
209 section_iterator &Res) const = 0;
210 virtual std::error_code getSymbolOther(DataRefImpl Symb,
211 uint8_t &Res) const {
212 return object_error::invalid_file_type;
215 // Same as above for SectionRef.
216 friend class SectionRef;
217 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
218 virtual std::error_code getSectionName(DataRefImpl Sec,
219 StringRef &Res) const = 0;
220 virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
221 virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
222 virtual std::error_code getSectionContents(DataRefImpl Sec,
223 StringRef &Res) const = 0;
224 virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
225 virtual bool isSectionText(DataRefImpl Sec) const = 0;
226 virtual bool isSectionData(DataRefImpl Sec) const = 0;
227 virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
228 // A section is 'virtual' if its contents aren't present in the object image.
229 virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
230 virtual bool sectionContainsSymbol(DataRefImpl Sec,
231 DataRefImpl Symb) const = 0;
232 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
233 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
234 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
236 // Same as above for RelocationRef.
237 friend class RelocationRef;
238 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
239 virtual std::error_code getRelocationAddress(DataRefImpl Rel,
240 uint64_t &Res) const = 0;
241 virtual std::error_code getRelocationOffset(DataRefImpl Rel,
242 uint64_t &Res) const = 0;
243 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
244 virtual section_iterator getRelocationSection(DataRefImpl Rel) const = 0;
245 virtual std::error_code getRelocationType(DataRefImpl Rel,
246 uint64_t &Res) const = 0;
247 virtual std::error_code
248 getRelocationTypeName(DataRefImpl Rel,
249 SmallVectorImpl<char> &Result) const = 0;
250 virtual std::error_code getRelocationHidden(DataRefImpl Rel,
251 bool &Result) const {
253 return object_error::success;
257 typedef iterator_range<symbol_iterator> symbol_iterator_range;
258 symbol_iterator_range symbols() const {
259 return symbol_iterator_range(symbol_begin(), symbol_end());
262 virtual section_iterator section_begin() const = 0;
263 virtual section_iterator section_end() const = 0;
265 typedef iterator_range<section_iterator> section_iterator_range;
266 section_iterator_range sections() const {
267 return section_iterator_range(section_begin(), section_end());
270 /// @brief The number of bytes used to represent an address in this object
272 virtual uint8_t getBytesInAddress() const = 0;
274 virtual StringRef getFileFormatName() const = 0;
275 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
277 /// Returns platform-specific object flags, if any.
278 virtual std::error_code getPlatformFlags(unsigned &Result) const {
280 return object_error::invalid_file_type;
283 /// True if this is a relocatable object (.o/.obj).
284 virtual bool isRelocatableObject() const = 0;
286 /// @returns Pointer to ObjectFile subclass to handle this type of object.
287 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
289 /// @brief Create ObjectFile from path.
290 static ErrorOr<OwningBinary<ObjectFile>>
291 createObjectFile(StringRef ObjectPath);
293 static ErrorOr<std::unique_ptr<ObjectFile>>
294 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
295 static ErrorOr<std::unique_ptr<ObjectFile>>
296 createObjectFile(MemoryBufferRef Object) {
297 return createObjectFile(Object, sys::fs::file_magic::unknown);
301 static inline bool classof(const Binary *v) {
302 return v->isObject();
305 static ErrorOr<std::unique_ptr<COFFObjectFile>>
306 createCOFFObjectFile(MemoryBufferRef Object);
308 static ErrorOr<std::unique_ptr<ObjectFile>>
309 createELFObjectFile(MemoryBufferRef Object);
311 static ErrorOr<std::unique_ptr<MachOObjectFile>>
312 createMachOObjectFile(MemoryBufferRef Object);
315 // Inline function definitions.
316 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
317 : BasicSymbolRef(SymbolP, Owner) {}
319 inline std::error_code SymbolRef::getName(StringRef &Result) const {
320 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
323 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
324 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
327 inline uint32_t SymbolRef::getAlignment() const {
328 return getObject()->getSymbolAlignment(getRawDataRefImpl());
331 inline uint64_t SymbolRef::getSize() const {
332 return getObject()->getSymbolSize(getRawDataRefImpl());
335 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
336 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
339 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
340 return getObject()->getSymbolType(getRawDataRefImpl(), Result);
343 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
344 return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
347 inline const ObjectFile *SymbolRef::getObject() const {
348 const SymbolicFile *O = BasicSymbolRef::getObject();
349 return cast<ObjectFile>(O);
354 inline SectionRef::SectionRef(DataRefImpl SectionP,
355 const ObjectFile *Owner)
356 : SectionPimpl(SectionP)
357 , OwningObject(Owner) {}
359 inline bool SectionRef::operator==(const SectionRef &Other) const {
360 return SectionPimpl == Other.SectionPimpl;
363 inline bool SectionRef::operator!=(const SectionRef &Other) const {
364 return SectionPimpl != Other.SectionPimpl;
367 inline bool SectionRef::operator<(const SectionRef &Other) const {
368 return SectionPimpl < Other.SectionPimpl;
371 inline void SectionRef::moveNext() {
372 return OwningObject->moveSectionNext(SectionPimpl);
375 inline std::error_code SectionRef::getName(StringRef &Result) const {
376 return OwningObject->getSectionName(SectionPimpl, Result);
379 inline uint64_t SectionRef::getAddress() const {
380 return OwningObject->getSectionAddress(SectionPimpl);
383 inline uint64_t SectionRef::getSize() const {
384 return OwningObject->getSectionSize(SectionPimpl);
387 inline std::error_code SectionRef::getContents(StringRef &Result) const {
388 return OwningObject->getSectionContents(SectionPimpl, Result);
391 inline uint64_t SectionRef::getAlignment() const {
392 return OwningObject->getSectionAlignment(SectionPimpl);
395 inline bool SectionRef::isText() const {
396 return OwningObject->isSectionText(SectionPimpl);
399 inline bool SectionRef::isData() const {
400 return OwningObject->isSectionData(SectionPimpl);
403 inline bool SectionRef::isBSS() const {
404 return OwningObject->isSectionBSS(SectionPimpl);
407 inline bool SectionRef::isVirtual() const {
408 return OwningObject->isSectionVirtual(SectionPimpl);
411 inline bool SectionRef::containsSymbol(SymbolRef S) const {
412 return OwningObject->sectionContainsSymbol(SectionPimpl,
413 S.getRawDataRefImpl());
416 inline relocation_iterator SectionRef::relocation_begin() const {
417 return OwningObject->section_rel_begin(SectionPimpl);
420 inline relocation_iterator SectionRef::relocation_end() const {
421 return OwningObject->section_rel_end(SectionPimpl);
424 inline section_iterator SectionRef::getRelocatedSection() const {
425 return OwningObject->getRelocatedSection(SectionPimpl);
428 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
432 inline const ObjectFile *SectionRef::getObject() const {
437 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
438 const ObjectFile *Owner)
439 : RelocationPimpl(RelocationP)
440 , OwningObject(Owner) {}
442 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
443 return RelocationPimpl == Other.RelocationPimpl;
446 inline void RelocationRef::moveNext() {
447 return OwningObject->moveRelocationNext(RelocationPimpl);
450 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
451 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
454 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
455 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
458 inline symbol_iterator RelocationRef::getSymbol() const {
459 return OwningObject->getRelocationSymbol(RelocationPimpl);
462 inline section_iterator RelocationRef::getSection() const {
463 return OwningObject->getRelocationSection(RelocationPimpl);
466 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
467 return OwningObject->getRelocationType(RelocationPimpl, Result);
470 inline std::error_code
471 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
472 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
475 inline std::error_code RelocationRef::getHidden(bool &Result) const {
476 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
479 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
480 return RelocationPimpl;
483 inline const ObjectFile *RelocationRef::getObjectFile() const {
488 } // end namespace object
489 } // end namespace llvm