diff options
| author | Dimitry Andric <dim@FreeBSD.org> | 2012-04-14 13:54:10 +0000 | 
|---|---|---|
| committer | Dimitry Andric <dim@FreeBSD.org> | 2012-04-14 13:54:10 +0000 | 
| commit | 63faed5b8e4f2755f127fcb8aa440480c0649327 (patch) | |
| tree | 19c69a04768629f2d440944b71cbe90adae0b615 /include/llvm/Object/ObjectFile.h | |
| parent | d4c8b5d2e851b0e8a063c6bf8543a4823a26c15a (diff) | |
Notes
Diffstat (limited to 'include/llvm/Object/ObjectFile.h')
| -rw-r--r-- | include/llvm/Object/ObjectFile.h | 275 | 
1 files changed, 207 insertions, 68 deletions
diff --git a/include/llvm/Object/ObjectFile.h b/include/llvm/Object/ObjectFile.h index 83854a0d6c28..4dd7fb581308 100644 --- a/include/llvm/Object/ObjectFile.h +++ b/include/llvm/Object/ObjectFile.h @@ -20,6 +20,7 @@  #include "llvm/Support/ErrorHandling.h"  #include "llvm/Support/MemoryBuffer.h"  #include <cstring> +#include <vector>  namespace llvm {  namespace object { @@ -37,6 +38,9 @@ union DataRefImpl {      uint32_t a, b;    } d;    uintptr_t p; +  DataRefImpl() { +    std::memset(this, 0, sizeof(DataRefImpl)); +  }  };  template<class content_type> @@ -78,52 +82,13 @@ static bool operator ==(const DataRefImpl &a, const DataRefImpl &b) {    return std::memcmp(&a, &b, sizeof(DataRefImpl)) == 0;  } -/// SymbolRef - This is a value type class that represents a single symbol in -/// the list of symbols in the object file. -class SymbolRef { -  friend class SectionRef; -  DataRefImpl SymbolPimpl; -  const ObjectFile *OwningObject; - -public: -  SymbolRef() : OwningObject(NULL) { -    std::memset(&SymbolPimpl, 0, sizeof(SymbolPimpl)); -  } - -  enum SymbolType { -    ST_Function, -    ST_Data, -    ST_External,    // Defined in another object file -    ST_Other -  }; - -  SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner); - -  bool operator==(const SymbolRef &Other) const; - -  error_code getNext(SymbolRef &Result) const; - -  error_code getName(StringRef &Result) const; -  error_code getAddress(uint64_t &Result) const; -  error_code getOffset(uint64_t &Result) const; -  error_code getSize(uint64_t &Result) const; -  error_code getSymbolType(SymbolRef::SymbolType &Result) const; - -  /// Returns the ascii char that should be displayed in a symbol table dump via -  /// nm for this symbol. -  error_code getNMTypeChar(char &Result) const; - -  /// Returns true for symbols that are internal to the object file format such -  /// as section symbols. -  error_code isInternal(bool &Result) const; - -  /// Returns true for symbols that can be used in another objects, -  /// such as library functions -  error_code isGlobal(bool &Result) const; +static 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; +} -  DataRefImpl getRawDataRefImpl() const; -}; -typedef content_iterator<SymbolRef> symbol_iterator; +class SymbolRef;  /// RelocationRef - This is a value type class that represents a single  /// relocation in the list of relocations in the object file. @@ -132,9 +97,7 @@ class RelocationRef {    const ObjectFile *OwningObject;  public: -  RelocationRef() : OwningObject(NULL) { -    std::memset(&RelocationPimpl, 0, sizeof(RelocationPimpl)); -  } +  RelocationRef() : OwningObject(NULL) { }    RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner); @@ -143,8 +106,14 @@ public:    error_code getNext(RelocationRef &Result) const;    error_code getAddress(uint64_t &Result) const; +  error_code getOffset(uint64_t &Result) const;    error_code getSymbol(SymbolRef &Result) const; -  error_code getType(uint32_t &Result) const; +  error_code getType(uint64_t &Result) const; + +  /// @brief Indicates whether this relocation should hidden when listing +  /// relocations, usually because it is the trailing part of a multipart +  /// relocation that will be printed as part of the leading relocation. +  error_code getHidden(bool &Result) const;    /// @brief Get a string that represents the type of this relocation.    /// @@ -168,13 +137,12 @@ class SectionRef {    const ObjectFile *OwningObject;  public: -  SectionRef() : OwningObject(NULL) { -    std::memset(&SectionPimpl, 0, sizeof(SectionPimpl)); -  } +  SectionRef() : OwningObject(NULL) { }    SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);    bool operator==(const SectionRef &Other) const; +  bool operator <(const SectionRef &Other) const;    error_code getNext(SectionRef &Result) const; @@ -190,21 +158,112 @@ public:    error_code isText(bool &Result) const;    error_code isData(bool &Result) const;    error_code isBSS(bool &Result) const; +  error_code isRequiredForExecution(bool &Result) const; +  error_code isVirtual(bool &Result) const; +  error_code isZeroInit(bool &Result) const;    error_code containsSymbol(SymbolRef S, bool &Result) const;    relocation_iterator begin_relocations() const;    relocation_iterator end_relocations() const; + +  DataRefImpl getRawDataRefImpl() const;  };  typedef content_iterator<SectionRef> section_iterator; +/// SymbolRef - This is a value type class that represents a single symbol in +/// the list of symbols in the object file. +class SymbolRef { +  friend class SectionRef; +  DataRefImpl SymbolPimpl; +  const ObjectFile *OwningObject; + +public: +  SymbolRef() : OwningObject(NULL) { } + +  enum Type { +    ST_Unknown, // Type not specified +    ST_Data, +    ST_Debug, +    ST_File, +    ST_Function, +    ST_Other +  }; + +  enum Flags { +    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; +  error_code getAddress(uint64_t &Result) const; +  error_code getFileOffset(uint64_t &Result) const; +  error_code getSize(uint64_t &Result) const; +  error_code getType(SymbolRef::Type &Result) const; + +  /// Returns the ascii char that should be displayed in a symbol table dump via +  /// nm for this symbol. +  error_code getNMTypeChar(char &Result) const; + +  /// Get symbol flags (bitwise OR of SymbolRef::Flags) +  error_code getFlags(uint32_t &Result) const; + +  /// @brief Return true for common symbols such as uninitialized globals +  error_code isCommon(bool &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; + +  DataRefImpl getRawDataRefImpl() const; +}; +typedef content_iterator<SymbolRef> symbol_iterator; + +/// LibraryRef - This is a value type class that represents a single library in +/// the list of libraries needed by a shared or dynamic object. +class LibraryRef { +  friend class SectionRef; +  DataRefImpl LibraryPimpl; +  const ObjectFile *OwningObject; + +public: +  LibraryRef() : OwningObject(NULL) { } + +  LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner); + +  bool operator==(const LibraryRef &Other) const; +  bool operator <(const LibraryRef &Other) const; + +  error_code getNext(LibraryRef &Result) const; + +  // Get the path to this library, as stored in the object file. +  error_code getPath(StringRef &Result) const; + +  DataRefImpl getRawDataRefImpl() const; +}; +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  /// figure out which type to create.  class ObjectFile : public Binary { -private: +  virtual void anchor();    ObjectFile(); // = delete    ObjectFile(const ObjectFile &other); // = delete @@ -227,12 +286,15 @@ protected:    virtual error_code getSymbolNext(DataRefImpl Symb, SymbolRef &Res) const = 0;    virtual error_code getSymbolName(DataRefImpl Symb, StringRef &Res) const = 0;    virtual error_code getSymbolAddress(DataRefImpl Symb, uint64_t &Res) const =0; -  virtual error_code getSymbolOffset(DataRefImpl Symb, uint64_t &Res) const =0; +  virtual error_code getSymbolFileOffset(DataRefImpl Symb, uint64_t &Res) const =0;    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 getSymbolNMTypeChar(DataRefImpl Symb, char &Res) const = 0; -  virtual error_code isSymbolInternal(DataRefImpl Symb, bool &Res) const = 0; -  virtual error_code isSymbolGlobal(DataRefImpl Symb, bool &Res) const = 0; -  virtual error_code getSymbolType(DataRefImpl Symb, SymbolRef::SymbolType &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;    // Same as above for SectionRef.    friend class SectionRef; @@ -245,6 +307,11 @@ protected:    virtual error_code isSectionText(DataRefImpl Sec, bool &Res) const = 0;    virtual error_code isSectionData(DataRefImpl Sec, bool &Res) const = 0;    virtual error_code isSectionBSS(DataRefImpl Sec, bool &Res) const = 0; +  virtual error_code isSectionRequiredForExecution(DataRefImpl Sec, +                                                   bool &Res) const = 0; +  // A section is 'virtual' if its contents aren't present in the object image. +  virtual error_code isSectionVirtual(DataRefImpl Sec, bool &Res) const = 0; +  virtual error_code isSectionZeroInit(DataRefImpl Sec, bool &Res) const = 0;    virtual error_code sectionContainsSymbol(DataRefImpl Sec, DataRefImpl Symb,                                             bool &Result) const = 0;    virtual relocation_iterator getSectionRelBegin(DataRefImpl Sec) const = 0; @@ -257,25 +324,42 @@ protected:                                         RelocationRef &Res) const = 0;    virtual error_code getRelocationAddress(DataRefImpl Rel,                                            uint64_t &Res) const =0; +  virtual error_code getRelocationOffset(DataRefImpl Rel, +                                         uint64_t &Res) const =0;    virtual error_code getRelocationSymbol(DataRefImpl Rel,                                           SymbolRef &Res) const = 0;    virtual error_code getRelocationType(DataRefImpl Rel, -                                       uint32_t &Res) const = 0; +                                       uint64_t &Res) const = 0;    virtual error_code getRelocationTypeName(DataRefImpl Rel,                                         SmallVectorImpl<char> &Result) const = 0;    virtual error_code getRelocationAdditionalInfo(DataRefImpl Rel,                                                   int64_t &Res) const = 0;    virtual error_code getRelocationValueString(DataRefImpl Rel,                                         SmallVectorImpl<char> &Result) const = 0; +  virtual error_code getRelocationHidden(DataRefImpl Rel, bool &Result) const { +    Result = false; +    return object_error::success; +  } + +  // Same for LibraryRef +  friend class LibraryRef; +  virtual error_code getLibraryNext(DataRefImpl Lib, LibraryRef &Res) const = 0; +  virtual error_code getLibraryPath(DataRefImpl Lib, StringRef &Res) const = 0;  public:    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 begin_sections() const = 0;    virtual section_iterator end_sections() const = 0; +  virtual library_iterator begin_libraries_needed() const = 0; +  virtual library_iterator end_libraries_needed() const = 0; +    /// @brief The number of bytes used to represent an address in this object    ///        file format.    virtual uint8_t getBytesInAddress() const = 0; @@ -283,6 +367,11 @@ public:    virtual StringRef getFileFormatName() const = 0;    virtual /* Triple::ArchType */ unsigned getArch() const = 0; +  /// For shared objects, returns the name which this object should be +  /// loaded from at runtime. This corresponds to DT_SONAME on ELF and +  /// LC_ID_DYLIB (install name) on MachO. +  virtual StringRef getLoadName() const = 0; +    /// @returns Pointer to ObjectFile subclass to handle this type of object.    /// @param ObjectPath The path to the object file. ObjectPath.isObject must    ///        return true. @@ -291,8 +380,7 @@ public:    static ObjectFile *createObjectFile(MemoryBuffer *Object);    static inline bool classof(const Binary *v) { -    return v->getType() >= isObject && -           v->getType() < lastObject; +    return v->isObject();    }    static inline bool classof(const ObjectFile *v) { return true; } @@ -311,6 +399,10 @@ 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);  } @@ -323,8 +415,8 @@ inline error_code SymbolRef::getAddress(uint64_t &Result) const {    return OwningObject->getSymbolAddress(SymbolPimpl, Result);  } -inline error_code SymbolRef::getOffset(uint64_t &Result) const { -  return OwningObject->getSymbolOffset(SymbolPimpl, Result); +inline error_code SymbolRef::getFileOffset(uint64_t &Result) const { +  return OwningObject->getSymbolFileOffset(SymbolPimpl, Result);  }  inline error_code SymbolRef::getSize(uint64_t &Result) const { @@ -335,15 +427,15 @@ inline error_code SymbolRef::getNMTypeChar(char &Result) const {    return OwningObject->getSymbolNMTypeChar(SymbolPimpl, Result);  } -inline error_code SymbolRef::isInternal(bool &Result) const { -  return OwningObject->isSymbolInternal(SymbolPimpl, Result); +inline error_code SymbolRef::getFlags(uint32_t &Result) const { +  return OwningObject->getSymbolFlags(SymbolPimpl, Result);  } -inline error_code SymbolRef::isGlobal(bool &Result) const { -  return OwningObject->isSymbolGlobal(SymbolPimpl, Result); +inline error_code SymbolRef::getSection(section_iterator &Result) const { +  return OwningObject->getSymbolSection(SymbolPimpl, Result);  } -inline error_code SymbolRef::getSymbolType(SymbolRef::SymbolType &Result) const { +inline error_code SymbolRef::getType(SymbolRef::Type &Result) const {    return OwningObject->getSymbolType(SymbolPimpl, Result);  } @@ -362,6 +454,10 @@ 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);  } @@ -398,6 +494,18 @@ inline error_code SectionRef::isBSS(bool &Result) const {    return OwningObject->isSectionBSS(SectionPimpl, Result);  } +inline error_code SectionRef::isRequiredForExecution(bool &Result) const { +  return OwningObject->isSectionRequiredForExecution(SectionPimpl, Result); +} + +inline error_code SectionRef::isVirtual(bool &Result) const { +  return OwningObject->isSectionVirtual(SectionPimpl, Result); +} + +inline error_code SectionRef::isZeroInit(bool &Result) const { +  return OwningObject->isSectionZeroInit(SectionPimpl, Result); +} +  inline error_code SectionRef::containsSymbol(SymbolRef S, bool &Result) const {    return OwningObject->sectionContainsSymbol(SectionPimpl, S.SymbolPimpl,                                               Result); @@ -411,6 +519,9 @@ inline relocation_iterator SectionRef::end_relocations() const {    return OwningObject->getSectionRelEnd(SectionPimpl);  } +inline DataRefImpl SectionRef::getRawDataRefImpl() const { +  return SectionPimpl; +}  /// RelocationRef  inline RelocationRef::RelocationRef(DataRefImpl RelocationP, @@ -430,11 +541,15 @@ inline error_code RelocationRef::getAddress(uint64_t &Result) const {    return OwningObject->getRelocationAddress(RelocationPimpl, Result);  } +inline error_code RelocationRef::getOffset(uint64_t &Result) const { +  return OwningObject->getRelocationOffset(RelocationPimpl, Result); +} +  inline error_code RelocationRef::getSymbol(SymbolRef &Result) const {    return OwningObject->getRelocationSymbol(RelocationPimpl, Result);  } -inline error_code RelocationRef::getType(uint32_t &Result) const { +inline error_code RelocationRef::getType(uint64_t &Result) const {    return OwningObject->getRelocationType(RelocationPimpl, Result);  } @@ -452,6 +567,30 @@ inline error_code RelocationRef::getValueString(SmallVectorImpl<char> &Result)    return OwningObject->getRelocationValueString(RelocationPimpl, Result);  } +inline error_code RelocationRef::getHidden(bool &Result) const { +  return OwningObject->getRelocationHidden(RelocationPimpl, Result); +} +// Inline function definitions. +inline LibraryRef::LibraryRef(DataRefImpl LibraryP, const ObjectFile *Owner) +  : LibraryPimpl(LibraryP) +  , OwningObject(Owner) {} + +inline bool LibraryRef::operator==(const LibraryRef &Other) const { +  return LibraryPimpl == Other.LibraryPimpl; +} + +inline bool LibraryRef::operator <(const LibraryRef &Other) const { +  return LibraryPimpl < Other.LibraryPimpl; +} + +inline error_code LibraryRef::getNext(LibraryRef &Result) const { +  return OwningObject->getLibraryNext(LibraryPimpl, Result); +} + +inline error_code LibraryRef::getPath(StringRef &Result) const { +  return OwningObject->getLibraryPath(LibraryPimpl, Result); +} +  } // end namespace object  } // end namespace llvm  | 
