aboutsummaryrefslogtreecommitdiffstats
path: root/include/llvm/Object/ObjectFile.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/llvm/Object/ObjectFile.h')
-rw-r--r--include/llvm/Object/ObjectFile.h279
1 files changed, 124 insertions, 155 deletions
diff --git a/include/llvm/Object/ObjectFile.h b/include/llvm/Object/ObjectFile.h
index 9aea639..8298b63 100644
--- a/include/llvm/Object/ObjectFile.h
+++ b/include/llvm/Object/ObjectFile.h
@@ -15,9 +15,10 @@
#define LLVM_OBJECT_OBJECTFILE_H
#include "llvm/ADT/StringRef.h"
-#include "llvm/Object/Binary.h"
+#include "llvm/Object/SymbolicFile.h"
#include "llvm/Support/DataTypes.h"
#include "llvm/Support/ErrorHandling.h"
+#include "llvm/Support/FileSystem.h"
#include "llvm/Support/MemoryBuffer.h"
#include <cstring>
#include <vector>
@@ -27,65 +28,8 @@ namespace object {
class ObjectFile;
-union DataRefImpl {
- // This entire union should probably be a
- // char[max(8, sizeof(uintptr_t))] and require the impl to cast.
- struct {
- uint32_t a, b;
- } d;
- uintptr_t p;
- DataRefImpl() {
- std::memset(this, 0, sizeof(DataRefImpl));
- }
-};
-
-template<class content_type>
-class content_iterator {
- content_type Current;
-public:
- content_iterator(content_type symb)
- : Current(symb) {}
-
- const content_type* operator->() const {
- return &Current;
- }
-
- const content_type &operator*() const {
- return Current;
- }
-
- bool operator==(const content_iterator &other) const {
- return Current == other.Current;
- }
-
- bool operator!=(const content_iterator &other) const {
- return !(*this == other);
- }
-
- content_iterator& increment(error_code &err) {
- content_type next;
- if (error_code ec = Current.getNext(next))
- err = ec;
- else
- Current = next;
- return *this;
- }
-};
-
-inline bool operator==(const DataRefImpl &a, const DataRefImpl &b) {
- // Check bitwise identical. This is the only legal way to compare a union w/o
- // knowing which member is in use.
- return std::memcmp(&a, &b, sizeof(DataRefImpl)) == 0;
-}
-
-inline bool operator<(const DataRefImpl &a, const DataRefImpl &b) {
- // Check bitwise identical. This is the only legal way to compare a union w/o
- // knowing which member is in use.
- return std::memcmp(&a, &b, sizeof(DataRefImpl)) < 0;
-}
-
class SymbolRef;
-typedef content_iterator<SymbolRef> symbol_iterator;
+class symbol_iterator;
/// RelocationRef - This is a value type class that represents a single
/// relocation in the list of relocations in the object file.
@@ -100,7 +44,7 @@ public:
bool operator==(const RelocationRef &Other) const;
- error_code getNext(RelocationRef &Result) const;
+ void moveNext();
error_code getAddress(uint64_t &Result) const;
error_code getOffset(uint64_t &Result) const;
@@ -143,9 +87,10 @@ public:
SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
bool operator==(const SectionRef &Other) const;
+ bool operator!=(const SectionRef &Other) const;
bool operator<(const SectionRef &Other) const;
- error_code getNext(SectionRef &Result) const;
+ void moveNext();
error_code getName(StringRef &Result) const;
error_code getAddress(uint64_t &Result) const;
@@ -166,8 +111,13 @@ public:
error_code containsSymbol(SymbolRef S, bool &Result) const;
- relocation_iterator begin_relocations() const;
- relocation_iterator end_relocations() const;
+ relocation_iterator relocation_begin() const;
+ relocation_iterator relocation_end() const;
+ typedef iterator_range<relocation_iterator> relocation_iterator_range;
+ relocation_iterator_range relocations() const {
+ return relocation_iterator_range(relocation_begin(), relocation_end());
+ }
+ bool relocation_empty() const;
section_iterator getRelocatedSection() const;
DataRefImpl getRawDataRefImpl() const;
@@ -175,13 +125,11 @@ public:
/// SymbolRef - This is a value type class that represents a single symbol in
/// the list of symbols in the object file.
-class SymbolRef {
+class SymbolRef : public BasicSymbolRef {
friend class SectionRef;
- DataRefImpl SymbolPimpl;
- const ObjectFile *OwningObject;
public:
- SymbolRef() : OwningObject(NULL) { }
+ SymbolRef() : BasicSymbolRef() {}
enum Type {
ST_Unknown, // Type not specified
@@ -192,25 +140,8 @@ public:
ST_Other
};
- enum Flags LLVM_ENUM_INT_TYPE(unsigned) {
- SF_None = 0,
- SF_Undefined = 1U << 0, // Symbol is defined in another object file
- SF_Global = 1U << 1, // Global symbol
- SF_Weak = 1U << 2, // Weak symbol
- SF_Absolute = 1U << 3, // Absolute symbol
- SF_ThreadLocal = 1U << 4, // Thread local symbol
- SF_Common = 1U << 5, // Symbol has common linkage
- SF_FormatSpecific = 1U << 31 // Specific to the object file format
- // (e.g. section symbols)
- };
-
SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
- bool operator==(const SymbolRef &Other) const;
- bool operator<(const SymbolRef &Other) const;
-
- error_code getNext(SymbolRef &Result) const;
-
error_code getName(StringRef &Result) const;
/// Returns the symbol virtual address (i.e. address at which it will be
/// mapped).
@@ -221,17 +152,29 @@ public:
error_code getSize(uint64_t &Result) const;
error_code getType(SymbolRef::Type &Result) const;
- /// Get symbol flags (bitwise OR of SymbolRef::Flags)
- error_code getFlags(uint32_t &Result) const;
-
/// @brief Get section this symbol is defined in reference to. Result is
/// end_sections() if it is undefined or is an absolute symbol.
error_code getSection(section_iterator &Result) const;
- /// @brief Get value of the symbol in the symbol table.
- error_code getValue(uint64_t &Val) const;
+ const ObjectFile *getObject() const;
+};
- DataRefImpl getRawDataRefImpl() const;
+class symbol_iterator : public basic_symbol_iterator {
+public:
+ symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
+ symbol_iterator(const basic_symbol_iterator &B)
+ : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
+ cast<ObjectFile>(B->getObject()))) {}
+
+ const SymbolRef *operator->() const {
+ const BasicSymbolRef &P = basic_symbol_iterator::operator *();
+ return static_cast<const SymbolRef*>(&P);
+ }
+
+ const SymbolRef &operator*() const {
+ const BasicSymbolRef &P = basic_symbol_iterator::operator *();
+ return static_cast<const SymbolRef&>(P);
+ }
};
/// LibraryRef - This is a value type class that represents a single library in
@@ -258,18 +201,16 @@ public:
};
typedef content_iterator<LibraryRef> library_iterator;
-const uint64_t UnknownAddressOrSize = ~0ULL;
-
/// ObjectFile - This class is the base class for all object file types.
/// Concrete instances of this object are created by createObjectFile, which
/// figures out which type to create.
-class ObjectFile : public Binary {
+class ObjectFile : public SymbolicFile {
virtual void anchor();
ObjectFile() LLVM_DELETED_FUNCTION;
ObjectFile(const ObjectFile &other) LLVM_DELETED_FUNCTION;
protected:
- ObjectFile(unsigned int Type, MemoryBuffer *source);
+ ObjectFile(unsigned int Type, MemoryBuffer *Source, bool BufferOwned = true);
const uint8_t *base() const {
return reinterpret_cast<const uint8_t *>(Data->getBufferStart());
@@ -284,23 +225,19 @@ protected:
// Implementations assume that the DataRefImpl is valid and has not been
// modified externally. It's UB otherwise.
friend class SymbolRef;
- virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;
virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;
+ error_code printSymbolName(raw_ostream &OS, DataRefImpl Symb) const override;
virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const = 0;
- virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res)const=0;
virtual error_code getSymbolAlignment(DataRefImpl Symb, uint32_t &Res) const;
virtual error_code getSymbolSize(DataRefImpl Symb, uint64_t &Res) const = 0;
virtual error_code getSymbolType(DataRefImpl Symb,
SymbolRef::Type &Res) const = 0;
- virtual error_code getSymbolFlags(DataRefImpl Symb,
- uint32_t &Res) const = 0;
virtual error_code getSymbolSection(DataRefImpl Symb,
section_iterator &Res) const = 0;
- virtual error_code getSymbolValue(DataRefImpl Symb, uint64_t &Val) const = 0;
// Same as above for SectionRef.
friend class SectionRef;
- virtual error_code getSectionNext(DataRefImpl Sec, SectionRef &Res) const = 0;
+ virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
virtual error_code getSectionName(DataRefImpl Sec, StringRef &Res) const = 0;
virtual error_code getSectionAddress(DataRefImpl Sec, uint64_t &Res) const =0;
virtual error_code getSectionSize(DataRefImpl Sec, uint64_t &Res) const = 0;
@@ -319,12 +256,12 @@ protected:
bool &Result) const = 0;
virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
+ virtual bool section_rel_empty(DataRefImpl Sec) const = 0;
virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
// Same as above for RelocationRef.
friend class RelocationRef;
- virtual error_code getRelocationNext(DataRefImpl Rel,
- RelocationRef &Res) const = 0;
+ virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
virtual error_code getRelocationAddress(DataRefImpl Rel,
uint64_t &Res) const =0;
virtual error_code getRelocationOffset(DataRefImpl Rel,
@@ -347,18 +284,21 @@ protected:
virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;
public:
+ typedef iterator_range<symbol_iterator> symbol_iterator_range;
+ symbol_iterator_range symbols() const {
+ return symbol_iterator_range(symbol_begin(), symbol_end());
+ }
- virtual symbol_iterator begin_symbols() const = 0;
- virtual symbol_iterator end_symbols() const = 0;
-
- virtual symbol_iterator begin_dynamic_symbols() const = 0;
- virtual symbol_iterator end_dynamic_symbols() const = 0;
+ virtual section_iterator section_begin() const = 0;
+ virtual section_iterator section_end() const = 0;
- virtual section_iterator begin_sections() const = 0;
- virtual section_iterator end_sections() const = 0;
+ typedef iterator_range<section_iterator> section_iterator_range;
+ section_iterator_range sections() const {
+ return section_iterator_range(section_begin(), section_end());
+ }
- virtual library_iterator begin_libraries_needed() const = 0;
- virtual library_iterator end_libraries_needed() const = 0;
+ virtual library_iterator needed_library_begin() const = 0;
+ virtual library_iterator needed_library_end() const = 0;
/// @brief The number of bytes used to represent an address in this object
/// file format.
@@ -376,74 +316,95 @@ public:
/// @param ObjectPath The path to the object file. ObjectPath.isObject must
/// return true.
/// @brief Create ObjectFile from path.
- static ObjectFile *createObjectFile(StringRef ObjectPath);
- static ObjectFile *createObjectFile(MemoryBuffer *Object);
+ static ErrorOr<ObjectFile *> createObjectFile(StringRef ObjectPath);
+ static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object,
+ bool BufferOwned,
+ sys::fs::file_magic Type);
+ static ErrorOr<ObjectFile *> createObjectFile(MemoryBuffer *Object) {
+ return createObjectFile(Object, true, sys::fs::file_magic::unknown);
+ }
+
static inline bool classof(const Binary *v) {
return v->isObject();
}
public:
- static ObjectFile *createCOFFObjectFile(MemoryBuffer *Object);
- static ObjectFile *createELFObjectFile(MemoryBuffer *Object);
- static ObjectFile *createMachOObjectFile(MemoryBuffer *Object);
+ static ErrorOr<ObjectFile *> createCOFFObjectFile(MemoryBuffer *Object,
+ bool BufferOwned = true);
+ static ErrorOr<ObjectFile *> createELFObjectFile(MemoryBuffer *Object,
+ bool BufferOwned = true);
+ static ErrorOr<ObjectFile *> createMachOObjectFile(MemoryBuffer *Object,
+ bool BufferOwned = true);
};
// Inline function definitions.
inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
- : SymbolPimpl(SymbolP)
- , OwningObject(Owner) {}
-
-inline bool SymbolRef::operator==(const SymbolRef &Other) const {
- return SymbolPimpl == Other.SymbolPimpl;
-}
-
-inline bool SymbolRef::operator<(const SymbolRef &Other) const {
- return SymbolPimpl < Other.SymbolPimpl;
-}
-
-inline error_code SymbolRef::getNext(SymbolRef &Result) const {
- return OwningObject->getSymbolNext(SymbolPimpl, Result);
-}
+ : BasicSymbolRef(SymbolP, Owner) {}
inline error_code SymbolRef::getName(StringRef &Result) const {
- return OwningObject->getSymbolName(SymbolPimpl, Result);
+ return getObject()->getSymbolName(getRawDataRefImpl(), Result);
}
inline error_code SymbolRef::getAddress(uint64_t &Result) const {
- return OwningObject->getSymbolAddress(SymbolPimpl, Result);
+ return getObject()->getSymbolAddress(getRawDataRefImpl(), Result);
}
inline error_code SymbolRef::getFileOffset(uint64_t &Result) const {
- return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);
+ uint64_t Address;
+ if (error_code EC = getAddress(Address))
+ return EC;
+ if (Address == UnknownAddressOrSize) {
+ Result = UnknownAddressOrSize;
+ return object_error::success;
+ }
+
+ const ObjectFile *Obj = getObject();
+ section_iterator SecI(Obj->section_begin());
+ if (error_code EC = getSection(SecI))
+ return EC;
+
+ if (SecI == Obj->section_end()) {
+ Result = UnknownAddressOrSize;
+ return object_error::success;
+ }
+
+ uint64_t SectionAddress;
+ if (error_code EC = SecI->getAddress(SectionAddress))
+ return EC;
+
+ uint64_t OffsetInSection = Address - SectionAddress;
+
+ StringRef SecContents;
+ if (error_code EC = SecI->getContents(SecContents))
+ return EC;
+
+ // FIXME: this is a hack.
+ uint64_t SectionOffset = (uint64_t)SecContents.data() - (uint64_t)Obj->base();
+
+ Result = SectionOffset + OffsetInSection;
+ return object_error::success;
}
inline error_code SymbolRef::getAlignment(uint32_t &Result) const {
- return OwningObject->getSymbolAlignment(SymbolPimpl, Result);
+ return getObject()->getSymbolAlignment(getRawDataRefImpl(), Result);
}
inline error_code SymbolRef::getSize(uint64_t &Result) const {
- return OwningObject->getSymbolSize(SymbolPimpl, Result);
-}
-
-inline error_code SymbolRef::getFlags(uint32_t &Result) const {
- return OwningObject->getSymbolFlags(SymbolPimpl, Result);
+ return getObject()->getSymbolSize(getRawDataRefImpl(), Result);
}
inline error_code SymbolRef::getSection(section_iterator &Result) const {
- return OwningObject->getSymbolSection(SymbolPimpl, Result);
+ return getObject()->getSymbolSection(getRawDataRefImpl(), Result);
}
inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {
- return OwningObject->getSymbolType(SymbolPimpl, Result);
-}
-
-inline error_code SymbolRef::getValue(uint64_t &Val) const {
- return OwningObject->getSymbolValue(SymbolPimpl, Val);
+ return getObject()->getSymbolType(getRawDataRefImpl(), Result);
}
-inline DataRefImpl SymbolRef::getRawDataRefImpl() const {
- return SymbolPimpl;
+inline const ObjectFile *SymbolRef::getObject() const {
+ const SymbolicFile *O = BasicSymbolRef::getObject();
+ return cast<ObjectFile>(O);
}
@@ -457,12 +418,16 @@ inline bool SectionRef::operator==(const SectionRef &Other) const {
return SectionPimpl == Other.SectionPimpl;
}
+inline bool SectionRef::operator!=(const SectionRef &Other) const {
+ return SectionPimpl != Other.SectionPimpl;
+}
+
inline bool SectionRef::operator<(const SectionRef &Other) const {
return SectionPimpl < Other.SectionPimpl;
}
-inline error_code SectionRef::getNext(SectionRef &Result) const {
- return OwningObject->getSectionNext(SectionPimpl, Result);
+inline void SectionRef::moveNext() {
+ return OwningObject->moveSectionNext(SectionPimpl);
}
inline error_code SectionRef::getName(StringRef &Result) const {
@@ -514,18 +479,22 @@ inline error_code SectionRef::isReadOnlyData(bool &Result) const {
}
inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {
- return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,
- Result);
+ return OwningObject->sectionContainsSymbol(SectionPimpl,
+ S.getRawDataRefImpl(), Result);
}
-inline relocation_iterator SectionRef::begin_relocations() const {
+inline relocation_iterator SectionRef::relocation_begin() const {
return OwningObject->section_rel_begin(SectionPimpl);
}
-inline relocation_iterator SectionRef::end_relocations() const {
+inline relocation_iterator SectionRef::relocation_end() const {
return OwningObject->section_rel_end(SectionPimpl);
}
+inline bool SectionRef::relocation_empty() const {
+ return OwningObject->section_rel_empty(SectionPimpl);
+}
+
inline section_iterator SectionRef::getRelocatedSection() const {
return OwningObject->getRelocatedSection(SectionPimpl);
}
@@ -544,8 +513,8 @@ inline bool RelocationRef::operator==(const RelocationRef &Other) const {
return RelocationPimpl == Other.RelocationPimpl;
}
-inline error_code RelocationRef::getNext(RelocationRef &Result) const {
- return OwningObject->getRelocationNext(RelocationPimpl, Result);
+inline void RelocationRef::moveNext() {
+ return OwningObject->moveRelocationNext(RelocationPimpl);
}
inline error_code RelocationRef::getAddress(uint64_t &Result) const {
generated by cgit v1.1 at 2024-06-03 09:08:56 +0000