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);
138 std::error_code getName(StringRef &Result) const;
139 /// Returns the symbol virtual address (i.e. address at which it will be
141 std::error_code getAddress(uint64_t &Result) const;
142 /// @brief Get the alignment of this symbol as the actual value (not log 2).
143 uint32_t getAlignment() const;
144 uint64_t getCommonSize() const;
145 std::error_code getType(SymbolRef::Type &Result) const;
146 std::error_code getOther(uint8_t &Result) 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 std::error_code getSection(section_iterator &Result) 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 std::error_code getSymbolName(DataRefImpl Symb,
198 StringRef &Res) const = 0;
199 std::error_code printSymbolName(raw_ostream &OS,
200 DataRefImpl Symb) const override;
201 virtual std::error_code getSymbolAddress(DataRefImpl Symb,
202 uint64_t &Res) const = 0;
203 virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
204 virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
205 virtual std::error_code getSymbolType(DataRefImpl Symb,
206 SymbolRef::Type &Res) const = 0;
207 virtual std::error_code getSymbolSection(DataRefImpl Symb,
208 section_iterator &Res) const = 0;
209 virtual std::error_code getSymbolOther(DataRefImpl Symb,
210 uint8_t &Res) const {
211 return object_error::invalid_file_type;
214 // Same as above for SectionRef.
215 friend class SectionRef;
216 virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
217 virtual std::error_code getSectionName(DataRefImpl Sec,
218 StringRef &Res) const = 0;
219 virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
220 virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
221 virtual std::error_code getSectionContents(DataRefImpl Sec,
222 StringRef &Res) const = 0;
223 virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
224 virtual bool isSectionText(DataRefImpl Sec) const = 0;
225 virtual bool isSectionData(DataRefImpl Sec) const = 0;
226 virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
227 // A section is 'virtual' if its contents aren't present in the object image.
228 virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
229 virtual bool sectionContainsSymbol(DataRefImpl Sec,
230 DataRefImpl Symb) const = 0;
231 virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
232 virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
233 virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
235 // Same as above for RelocationRef.
236 friend class RelocationRef;
237 virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
238 virtual std::error_code getRelocationAddress(DataRefImpl Rel,
239 uint64_t &Res) const = 0;
240 virtual std::error_code getRelocationOffset(DataRefImpl Rel,
241 uint64_t &Res) const = 0;
242 virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
243 virtual std::error_code getRelocationType(DataRefImpl Rel,
244 uint64_t &Res) const = 0;
245 virtual std::error_code
246 getRelocationTypeName(DataRefImpl Rel,
247 SmallVectorImpl<char> &Result) const = 0;
248 virtual std::error_code getRelocationHidden(DataRefImpl Rel,
249 bool &Result) const {
251 return std::error_code();
255 uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
256 assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
257 return getCommonSymbolSizeImpl(Symb);
260 typedef iterator_range<symbol_iterator> symbol_iterator_range;
261 symbol_iterator_range symbols() const {
262 return symbol_iterator_range(symbol_begin(), symbol_end());
265 virtual section_iterator section_begin() const = 0;
266 virtual section_iterator section_end() const = 0;
268 typedef iterator_range<section_iterator> section_iterator_range;
269 section_iterator_range sections() const {
270 return section_iterator_range(section_begin(), section_end());
273 /// @brief The number of bytes used to represent an address in this object
275 virtual uint8_t getBytesInAddress() const = 0;
277 virtual StringRef getFileFormatName() const = 0;
278 virtual /* Triple::ArchType */ unsigned getArch() const = 0;
280 /// Returns platform-specific object flags, if any.
281 virtual std::error_code getPlatformFlags(unsigned &Result) const {
283 return object_error::invalid_file_type;
286 /// True if this is a relocatable object (.o/.obj).
287 virtual bool isRelocatableObject() const = 0;
289 /// @returns Pointer to ObjectFile subclass to handle this type of object.
290 /// @param ObjectPath The path to the object file. ObjectPath.isObject must
292 /// @brief Create ObjectFile from path.
293 static ErrorOr<OwningBinary<ObjectFile>>
294 createObjectFile(StringRef ObjectPath);
296 static ErrorOr<std::unique_ptr<ObjectFile>>
297 createObjectFile(MemoryBufferRef Object, sys::fs::file_magic Type);
298 static ErrorOr<std::unique_ptr<ObjectFile>>
299 createObjectFile(MemoryBufferRef Object) {
300 return createObjectFile(Object, sys::fs::file_magic::unknown);
304 static inline bool classof(const Binary *v) {
305 return v->isObject();
308 static ErrorOr<std::unique_ptr<COFFObjectFile>>
309 createCOFFObjectFile(MemoryBufferRef Object);
311 static ErrorOr<std::unique_ptr<ObjectFile>>
312 createELFObjectFile(MemoryBufferRef Object);
314 static ErrorOr<std::unique_ptr<MachOObjectFile>>
315 createMachOObjectFile(MemoryBufferRef Object);
318 // Inline function definitions.
319 inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
320 : BasicSymbolRef(SymbolP, Owner) {}
322 inline std::error_code SymbolRef::getName(StringRef &Result) const {
323 return getObject()->getSymbolName(getRawDataRefImpl(), Result);
326 inline std::error_code SymbolRef::getAddress(uint64_t &Result) const {
327 return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
330 inline uint32_t SymbolRef::getAlignment() const {
331 return getObject()->getSymbolAlignment(getRawDataRefImpl());
334 inline uint64_t SymbolRef::getCommonSize() const {
335 return getObject()->getCommonSymbolSize(getRawDataRefImpl());
338 inline std::error_code SymbolRef::getSection(section_iterator &Result) const {
339 return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
342 inline std::error_code SymbolRef::getType(SymbolRef::Type &Result) const {
343 return getObject()->getSymbolType(getRawDataRefImpl(), Result);
346 inline std::error_code SymbolRef::getOther(uint8_t &Result) const {
347 return getObject()->getSymbolOther(getRawDataRefImpl(), Result);
350 inline const ObjectFile *SymbolRef::getObject() const {
351 const SymbolicFile *O = BasicSymbolRef::getObject();
352 return cast<ObjectFile>(O);
357 inline SectionRef::SectionRef(DataRefImpl SectionP,
358 const ObjectFile *Owner)
359 : SectionPimpl(SectionP)
360 , OwningObject(Owner) {}
362 inline bool SectionRef::operator==(const SectionRef &Other) const {
363 return SectionPimpl == Other.SectionPimpl;
366 inline bool SectionRef::operator!=(const SectionRef &Other) const {
367 return SectionPimpl != Other.SectionPimpl;
370 inline bool SectionRef::operator<(const SectionRef &Other) const {
371 return SectionPimpl < Other.SectionPimpl;
374 inline void SectionRef::moveNext() {
375 return OwningObject->moveSectionNext(SectionPimpl);
378 inline std::error_code SectionRef::getName(StringRef &Result) const {
379 return OwningObject->getSectionName(SectionPimpl, Result);
382 inline uint64_t SectionRef::getAddress() const {
383 return OwningObject->getSectionAddress(SectionPimpl);
386 inline uint64_t SectionRef::getSize() const {
387 return OwningObject->getSectionSize(SectionPimpl);
390 inline std::error_code SectionRef::getContents(StringRef &Result) const {
391 return OwningObject->getSectionContents(SectionPimpl, Result);
394 inline uint64_t SectionRef::getAlignment() const {
395 return OwningObject->getSectionAlignment(SectionPimpl);
398 inline bool SectionRef::isText() const {
399 return OwningObject->isSectionText(SectionPimpl);
402 inline bool SectionRef::isData() const {
403 return OwningObject->isSectionData(SectionPimpl);
406 inline bool SectionRef::isBSS() const {
407 return OwningObject->isSectionBSS(SectionPimpl);
410 inline bool SectionRef::isVirtual() const {
411 return OwningObject->isSectionVirtual(SectionPimpl);
414 inline bool SectionRef::containsSymbol(SymbolRef S) const {
415 return OwningObject->sectionContainsSymbol(SectionPimpl,
416 S.getRawDataRefImpl());
419 inline relocation_iterator SectionRef::relocation_begin() const {
420 return OwningObject->section_rel_begin(SectionPimpl);
423 inline relocation_iterator SectionRef::relocation_end() const {
424 return OwningObject->section_rel_end(SectionPimpl);
427 inline section_iterator SectionRef::getRelocatedSection() const {
428 return OwningObject->getRelocatedSection(SectionPimpl);
431 inline DataRefImpl SectionRef::getRawDataRefImpl() const {
435 inline const ObjectFile *SectionRef::getObject() const {
440 inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
441 const ObjectFile *Owner)
442 : RelocationPimpl(RelocationP)
443 , OwningObject(Owner) {}
445 inline bool RelocationRef::operator==(const RelocationRef &Other) const {
446 return RelocationPimpl == Other.RelocationPimpl;
449 inline void RelocationRef::moveNext() {
450 return OwningObject->moveRelocationNext(RelocationPimpl);
453 inline std::error_code RelocationRef::getAddress(uint64_t &Result) const {
454 return OwningObject->getRelocationAddress(RelocationPimpl, Result);
457 inline std::error_code RelocationRef::getOffset(uint64_t &Result) const {
458 return OwningObject->getRelocationOffset(RelocationPimpl, Result);
461 inline symbol_iterator RelocationRef::getSymbol() const {
462 return OwningObject->getRelocationSymbol(RelocationPimpl);
465 inline std::error_code RelocationRef::getType(uint64_t &Result) const {
466 return OwningObject->getRelocationType(RelocationPimpl, Result);
469 inline std::error_code
470 RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
471 return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
474 inline std::error_code RelocationRef::getHidden(bool &Result) const {
475 return OwningObject->getRelocationHidden(RelocationPimpl, Result);
478 inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
479 return RelocationPimpl;
482 inline const ObjectFile *RelocationRef::getObjectFile() const {
487 } // end namespace object
488 } // end namespace llvm