LCOV - code coverage report
Current view: top level - include/llvm/Object - ObjectFile.h (source / functions) Hit Total Coverage
Test: llvm-toolchain.info Lines: 56 59 94.9 %
Date: 2018-05-20 00:06:23 Functions: 7 8 87.5 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : //===- ObjectFile.h - File format independent object file -------*- C++ -*-===//
       2             : //
       3             : //                     The LLVM Compiler Infrastructure
       4             : //
       5             : // This file is distributed under the University of Illinois Open Source
       6             : // License. See LICENSE.TXT for details.
       7             : //
       8             : //===----------------------------------------------------------------------===//
       9             : //
      10             : // This file declares a file format independent ObjectFile class.
      11             : //
      12             : //===----------------------------------------------------------------------===//
      13             : 
      14             : #ifndef LLVM_OBJECT_OBJECTFILE_H
      15             : #define LLVM_OBJECT_OBJECTFILE_H
      16             : 
      17             : #include "llvm/ADT/StringRef.h"
      18             : #include "llvm/ADT/Triple.h"
      19             : #include "llvm/ADT/iterator_range.h"
      20             : #include "llvm/BinaryFormat/Magic.h"
      21             : #include "llvm/MC/SubtargetFeature.h"
      22             : #include "llvm/Object/Binary.h"
      23             : #include "llvm/Object/Error.h"
      24             : #include "llvm/Object/SymbolicFile.h"
      25             : #include "llvm/Support/Casting.h"
      26             : #include "llvm/Support/Error.h"
      27             : #include "llvm/Support/FileSystem.h"
      28             : #include "llvm/Support/MemoryBuffer.h"
      29             : #include <cassert>
      30             : #include <cstdint>
      31             : #include <memory>
      32             : #include <system_error>
      33             : 
      34             : namespace llvm {
      35             : 
      36             : class ARMAttributeParser;
      37             : 
      38             : namespace object {
      39             : 
      40             : class COFFObjectFile;
      41             : class MachOObjectFile;
      42             : class ObjectFile;
      43             : class SectionRef;
      44             : class SymbolRef;
      45             : class symbol_iterator;
      46             : class WasmObjectFile;
      47             : 
      48             : using section_iterator = content_iterator<SectionRef>;
      49             : 
      50             : /// This is a value type class that represents a single relocation in the list
      51             : /// of relocations in the object file.
      52             : class RelocationRef {
      53             :   DataRefImpl RelocationPimpl;
      54             :   const ObjectFile *OwningObject = nullptr;
      55             : 
      56             : public:
      57         116 :   RelocationRef() = default;
      58             :   RelocationRef(DataRefImpl RelocationP, const ObjectFile *Owner);
      59             : 
      60             :   bool operator==(const RelocationRef &Other) const;
      61             : 
      62             :   void moveNext();
      63             : 
      64             :   uint64_t getOffset() const;
      65             :   symbol_iterator getSymbol() const;
      66             :   uint64_t getType() const;
      67             : 
      68             :   /// Get a string that represents the type of this relocation.
      69             :   ///
      70             :   /// This is for display purposes only.
      71             :   void getTypeName(SmallVectorImpl<char> &Result) const;
      72             : 
      73             :   DataRefImpl getRawDataRefImpl() const;
      74             :   const ObjectFile *getObject() const;
      75             : };
      76             : 
      77             : using relocation_iterator = content_iterator<RelocationRef>;
      78             : 
      79             : /// This is a value type class that represents a single section in the list of
      80             : /// sections in the object file.
      81             : class SectionRef {
      82             :   friend class SymbolRef;
      83             : 
      84             :   DataRefImpl SectionPimpl;
      85             :   const ObjectFile *OwningObject = nullptr;
      86             : 
      87             : public:
      88        3432 :   SectionRef() = default;
      89             :   SectionRef(DataRefImpl SectionP, const ObjectFile *Owner);
      90             : 
      91             :   bool operator==(const SectionRef &Other) const;
      92             :   bool operator!=(const SectionRef &Other) const;
      93             :   bool operator<(const SectionRef &Other) const;
      94             : 
      95             :   void moveNext();
      96             : 
      97             :   std::error_code getName(StringRef &Result) const;
      98             :   uint64_t getAddress() const;
      99             :   uint64_t getIndex() const;
     100             :   uint64_t getSize() const;
     101             :   std::error_code getContents(StringRef &Result) const;
     102             : 
     103             :   /// Get the alignment of this section as the actual value (not log 2).
     104             :   uint64_t getAlignment() const;
     105             : 
     106             :   bool isCompressed() const;
     107             :   bool isText() const;
     108             :   bool isData() const;
     109             :   bool isBSS() const;
     110             :   bool isVirtual() const;
     111             :   bool isBitcode() const;
     112             :   bool isStripped() const;
     113             : 
     114             :   bool containsSymbol(SymbolRef S) const;
     115             : 
     116             :   relocation_iterator relocation_begin() const;
     117             :   relocation_iterator relocation_end() const;
     118        3872 :   iterator_range<relocation_iterator> relocations() const {
     119        3871 :     return make_range(relocation_begin(), relocation_end());
     120             :   }
     121             :   section_iterator getRelocatedSection() const;
     122             : 
     123             :   DataRefImpl getRawDataRefImpl() const;
     124             :   const ObjectFile *getObject() const;
     125             : };
     126             : 
     127             : /// This is a value type class that represents a single symbol in the list of
     128             : /// symbols in the object file.
     129             : class SymbolRef : public BasicSymbolRef {
     130             :   friend class SectionRef;
     131             : 
     132             : public:
     133             :   enum Type {
     134             :     ST_Unknown, // Type not specified
     135             :     ST_Data,
     136             :     ST_Debug,
     137             :     ST_File,
     138             :     ST_Function,
     139             :     ST_Other
     140             :   };
     141             : 
     142             :   SymbolRef() = default;
     143             :   SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner);
     144        2139 :   SymbolRef(const BasicSymbolRef &B) : BasicSymbolRef(B) {
     145             :     assert(isa<ObjectFile>(BasicSymbolRef::getObject()));
     146             :   }
     147             : 
     148             :   Expected<StringRef> getName() const;
     149             :   /// Returns the symbol virtual address (i.e. address at which it will be
     150             :   /// mapped).
     151             :   Expected<uint64_t> getAddress() const;
     152             : 
     153             :   /// Return the value of the symbol depending on the object this can be an
     154             :   /// offset or a virtual address.
     155             :   uint64_t getValue() const;
     156             : 
     157             :   /// Get the alignment of this symbol as the actual value (not log 2).
     158             :   uint32_t getAlignment() const;
     159             :   uint64_t getCommonSize() const;
     160             :   Expected<SymbolRef::Type> getType() const;
     161             : 
     162             :   /// Get section this symbol is defined in reference to. Result is
     163             :   /// end_sections() if it is undefined or is an absolute symbol.
     164             :   Expected<section_iterator> getSection() const;
     165             : 
     166             :   const ObjectFile *getObject() const;
     167             : };
     168             : 
     169             : class symbol_iterator : public basic_symbol_iterator {
     170             : public:
     171             :   symbol_iterator(SymbolRef Sym) : basic_symbol_iterator(Sym) {}
     172        7280 :   symbol_iterator(const basic_symbol_iterator &B)
     173       14560 :       : basic_symbol_iterator(SymbolRef(B->getRawDataRefImpl(),
     174        7280 :                                         cast<ObjectFile>(B->getObject()))) {}
     175             : 
     176             :   const SymbolRef *operator->() const {
     177             :     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
     178             :     return static_cast<const SymbolRef*>(&P);
     179             :   }
     180             : 
     181             :   const SymbolRef &operator*() const {
     182             :     const BasicSymbolRef &P = basic_symbol_iterator::operator *();
     183             :     return static_cast<const SymbolRef&>(P);
     184             :   }
     185             : };
     186             : 
     187             : /// This class is the base class for all object file types. Concrete instances
     188             : /// of this object are created by createObjectFile, which figures out which type
     189             : /// to create.
     190       19887 : class ObjectFile : public SymbolicFile {
     191             :   virtual void anchor();
     192             : 
     193             : protected:
     194             :   ObjectFile(unsigned int Type, MemoryBufferRef Source);
     195             : 
     196             :   const uint8_t *base() const {
     197             :     return reinterpret_cast<const uint8_t *>(Data.getBufferStart());
     198             :   }
     199             : 
     200             :   // These functions are for SymbolRef to call internally. The main goal of
     201             :   // this is to allow SymbolRef::SymbolPimpl to point directly to the symbol
     202             :   // entry in the memory mapped object file. SymbolPimpl cannot contain any
     203             :   // virtual functions because then it could not point into the memory mapped
     204             :   // file.
     205             :   //
     206             :   // Implementations assume that the DataRefImpl is valid and has not been
     207             :   // modified externally. It's UB otherwise.
     208             :   friend class SymbolRef;
     209             : 
     210             :   virtual Expected<StringRef> getSymbolName(DataRefImpl Symb) const = 0;
     211             :   std::error_code printSymbolName(raw_ostream &OS,
     212             :                                   DataRefImpl Symb) const override;
     213             :   virtual Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const = 0;
     214             :   virtual uint64_t getSymbolValueImpl(DataRefImpl Symb) const = 0;
     215             :   virtual uint32_t getSymbolAlignment(DataRefImpl Symb) const;
     216             :   virtual uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const = 0;
     217             :   virtual Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const = 0;
     218             :   virtual Expected<section_iterator>
     219             :   getSymbolSection(DataRefImpl Symb) const = 0;
     220             : 
     221             :   // Same as above for SectionRef.
     222             :   friend class SectionRef;
     223             : 
     224             :   virtual void moveSectionNext(DataRefImpl &Sec) const = 0;
     225             :   virtual std::error_code getSectionName(DataRefImpl Sec,
     226             :                                          StringRef &Res) const = 0;
     227             :   virtual uint64_t getSectionAddress(DataRefImpl Sec) const = 0;
     228             :   virtual uint64_t getSectionIndex(DataRefImpl Sec) const = 0;
     229             :   virtual uint64_t getSectionSize(DataRefImpl Sec) const = 0;
     230             :   virtual std::error_code getSectionContents(DataRefImpl Sec,
     231             :                                              StringRef &Res) const = 0;
     232             :   virtual uint64_t getSectionAlignment(DataRefImpl Sec) const = 0;
     233             :   virtual bool isSectionCompressed(DataRefImpl Sec) const = 0;
     234             :   virtual bool isSectionText(DataRefImpl Sec) const = 0;
     235             :   virtual bool isSectionData(DataRefImpl Sec) const = 0;
     236             :   virtual bool isSectionBSS(DataRefImpl Sec) const = 0;
     237             :   // A section is 'virtual' if its contents aren't present in the object image.
     238             :   virtual bool isSectionVirtual(DataRefImpl Sec) const = 0;
     239             :   virtual bool isSectionBitcode(DataRefImpl Sec) const;
     240             :   virtual bool isSectionStripped(DataRefImpl Sec) const;
     241             :   virtual relocation_iterator section_rel_begin(DataRefImpl Sec) const = 0;
     242             :   virtual relocation_iterator section_rel_end(DataRefImpl Sec) const = 0;
     243             :   virtual section_iterator getRelocatedSection(DataRefImpl Sec) const;
     244             : 
     245             :   // Same as above for RelocationRef.
     246             :   friend class RelocationRef;
     247             :   virtual void moveRelocationNext(DataRefImpl &Rel) const = 0;
     248             :   virtual uint64_t getRelocationOffset(DataRefImpl Rel) const = 0;
     249             :   virtual symbol_iterator getRelocationSymbol(DataRefImpl Rel) const = 0;
     250             :   virtual uint64_t getRelocationType(DataRefImpl Rel) const = 0;
     251             :   virtual void getRelocationTypeName(DataRefImpl Rel,
     252             :                                      SmallVectorImpl<char> &Result) const = 0;
     253             : 
     254             :   uint64_t getSymbolValue(DataRefImpl Symb) const;
     255             : 
     256             : public:
     257             :   ObjectFile() = delete;
     258             :   ObjectFile(const ObjectFile &other) = delete;
     259             : 
     260             :   uint64_t getCommonSymbolSize(DataRefImpl Symb) const {
     261             :     assert(getSymbolFlags(Symb) & SymbolRef::SF_Common);
     262         747 :     return getCommonSymbolSizeImpl(Symb);
     263             :   }
     264             : 
     265             :   using symbol_iterator_range = iterator_range<symbol_iterator>;
     266        2516 :   symbol_iterator_range symbols() const {
     267        5032 :     return symbol_iterator_range(symbol_begin(), symbol_end());
     268             :   }
     269             : 
     270             :   virtual section_iterator section_begin() const = 0;
     271             :   virtual section_iterator section_end() const = 0;
     272             : 
     273             :   using section_iterator_range = iterator_range<section_iterator>;
     274        8229 :   section_iterator_range sections() const {
     275       16458 :     return section_iterator_range(section_begin(), section_end());
     276             :   }
     277             : 
     278             :   /// The number of bytes used to represent an address in this object
     279             :   ///        file format.
     280             :   virtual uint8_t getBytesInAddress() const = 0;
     281             : 
     282             :   virtual StringRef getFileFormatName() const = 0;
     283             :   virtual Triple::ArchType getArch() const = 0;
     284             :   virtual SubtargetFeatures getFeatures() const = 0;
     285           9 :   virtual void setARMSubArch(Triple &TheTriple) const { }
     286             : 
     287             :   /// Create a triple from the data in this object file.
     288             :   Triple makeTriple() const;
     289             : 
     290             :   virtual std::error_code
     291           0 :     getBuildAttributes(ARMAttributeParser &Attributes) const {
     292           0 :       return std::error_code();
     293             :     }
     294             : 
     295             :   /// Maps a debug section name to a standard DWARF section name.
     296       14111 :   virtual StringRef mapDebugSectionName(StringRef Name) const { return Name; }
     297             : 
     298             :   /// True if this is a relocatable object (.o/.obj).
     299             :   virtual bool isRelocatableObject() const = 0;
     300             : 
     301             :   /// @returns Pointer to ObjectFile subclass to handle this type of object.
     302             :   /// @param ObjectPath The path to the object file. ObjectPath.isObject must
     303             :   ///        return true.
     304             :   /// Create ObjectFile from path.
     305             :   static Expected<OwningBinary<ObjectFile>>
     306             :   createObjectFile(StringRef ObjectPath);
     307             : 
     308             :   static Expected<std::unique_ptr<ObjectFile>>
     309             :   createObjectFile(MemoryBufferRef Object, llvm::file_magic Type);
     310             :   static Expected<std::unique_ptr<ObjectFile>>
     311             :   createObjectFile(MemoryBufferRef Object) {
     312        1886 :     return createObjectFile(Object, llvm::file_magic::unknown);
     313             :   }
     314             : 
     315             :   static bool classof(const Binary *v) {
     316        2391 :     return v->isObject();
     317             :   }
     318             : 
     319             :   static Expected<std::unique_ptr<COFFObjectFile>>
     320             :   createCOFFObjectFile(MemoryBufferRef Object);
     321             : 
     322             :   static Expected<std::unique_ptr<ObjectFile>>
     323             :   createELFObjectFile(MemoryBufferRef Object);
     324             : 
     325             :   static Expected<std::unique_ptr<MachOObjectFile>>
     326             :   createMachOObjectFile(MemoryBufferRef Object,
     327             :                         uint32_t UniversalCputype = 0,
     328             :                         uint32_t UniversalIndex = 0);
     329             : 
     330             :   static Expected<std::unique_ptr<WasmObjectFile>>
     331             :   createWasmObjectFile(MemoryBufferRef Object);
     332             : };
     333             : 
     334             : // Inline function definitions.
     335             : inline SymbolRef::SymbolRef(DataRefImpl SymbolP, const ObjectFile *Owner)
     336             :     : BasicSymbolRef(SymbolP, Owner) {}
     337             : 
     338             : inline Expected<StringRef> SymbolRef::getName() const {
     339    21417480 :   return getObject()->getSymbolName(getRawDataRefImpl());
     340             : }
     341             : 
     342             : inline Expected<uint64_t> SymbolRef::getAddress() const {
     343    21412934 :   return getObject()->getSymbolAddress(getRawDataRefImpl());
     344             : }
     345             : 
     346        2217 : inline uint64_t SymbolRef::getValue() const {
     347        2217 :   return getObject()->getSymbolValue(getRawDataRefImpl());
     348             : }
     349             : 
     350             : inline uint32_t SymbolRef::getAlignment() const {
     351         194 :   return getObject()->getSymbolAlignment(getRawDataRefImpl());
     352             : }
     353             : 
     354             : inline uint64_t SymbolRef::getCommonSize() const {
     355             :   return getObject()->getCommonSymbolSize(getRawDataRefImpl());
     356             : }
     357             : 
     358             : inline Expected<section_iterator> SymbolRef::getSection() const {
     359       35410 :   return getObject()->getSymbolSection(getRawDataRefImpl());
     360             : }
     361             : 
     362             : inline Expected<SymbolRef::Type> SymbolRef::getType() const {
     363    21257636 :   return getObject()->getSymbolType(getRawDataRefImpl());
     364             : }
     365             : 
     366             : inline const ObjectFile *SymbolRef::getObject() const {
     367    32058325 :   const SymbolicFile *O = BasicSymbolRef::getObject();
     368             :   return cast<ObjectFile>(O);
     369             : }
     370             : 
     371             : /// SectionRef
     372             : inline SectionRef::SectionRef(DataRefImpl SectionP,
     373      144971 :                               const ObjectFile *Owner)
     374             :   : SectionPimpl(SectionP)
     375      144971 :   , OwningObject(Owner) {}
     376             : 
     377             : inline bool SectionRef::operator==(const SectionRef &Other) const {
     378       23821 :   return SectionPimpl == Other.SectionPimpl;
     379             : }
     380             : 
     381             : inline bool SectionRef::operator!=(const SectionRef &Other) const {
     382             :   return SectionPimpl != Other.SectionPimpl;
     383             : }
     384             : 
     385             : inline bool SectionRef::operator<(const SectionRef &Other) const {
     386      105928 :   return SectionPimpl < Other.SectionPimpl;
     387             : }
     388             : 
     389             : inline void SectionRef::moveNext() {
     390      149559 :   return OwningObject->moveSectionNext(SectionPimpl);
     391             : }
     392             : 
     393             : inline std::error_code SectionRef::getName(StringRef &Result) const {
     394       76067 :   return OwningObject->getSectionName(SectionPimpl, Result);
     395             : }
     396             : 
     397             : inline uint64_t SectionRef::getAddress() const {
     398       19653 :   return OwningObject->getSectionAddress(SectionPimpl);
     399             : }
     400             : 
     401             : inline uint64_t SectionRef::getIndex() const {
     402        2371 :   return OwningObject->getSectionIndex(SectionPimpl);
     403             : }
     404             : 
     405             : inline uint64_t SectionRef::getSize() const {
     406     2823110 :   return OwningObject->getSectionSize(SectionPimpl);
     407             : }
     408             : 
     409             : inline std::error_code SectionRef::getContents(StringRef &Result) const {
     410       26548 :   return OwningObject->getSectionContents(SectionPimpl, Result);
     411             : }
     412             : 
     413             : inline uint64_t SectionRef::getAlignment() const {
     414        1925 :   return OwningObject->getSectionAlignment(SectionPimpl);
     415             : }
     416             : 
     417             : inline bool SectionRef::isCompressed() const {
     418       20287 :   return OwningObject->isSectionCompressed(SectionPimpl);
     419             : }
     420             : 
     421             : inline bool SectionRef::isText() const {
     422       12068 :   return OwningObject->isSectionText(SectionPimpl);
     423             : }
     424             : 
     425             : inline bool SectionRef::isData() const {
     426        2919 :   return OwningObject->isSectionData(SectionPimpl);
     427             : }
     428             : 
     429             : inline bool SectionRef::isBSS() const {
     430       26080 :   return OwningObject->isSectionBSS(SectionPimpl);
     431             : }
     432             : 
     433             : inline bool SectionRef::isVirtual() const {
     434       27311 :   return OwningObject->isSectionVirtual(SectionPimpl);
     435             : }
     436             : 
     437             : inline bool SectionRef::isBitcode() const {
     438       68456 :   return OwningObject->isSectionBitcode(SectionPimpl);
     439             : }
     440             : 
     441             : inline bool SectionRef::isStripped() const {
     442       20612 :   return OwningObject->isSectionStripped(SectionPimpl);
     443             : }
     444             : 
     445             : inline relocation_iterator SectionRef::relocation_begin() const {
     446        5879 :   return OwningObject->section_rel_begin(SectionPimpl);
     447             : }
     448             : 
     449             : inline relocation_iterator SectionRef::relocation_end() const {
     450        5879 :   return OwningObject->section_rel_end(SectionPimpl);
     451             : }
     452             : 
     453             : inline section_iterator SectionRef::getRelocatedSection() const {
     454       40272 :   return OwningObject->getRelocatedSection(SectionPimpl);
     455             : }
     456             : 
     457             : inline DataRefImpl SectionRef::getRawDataRefImpl() const {
     458       21176 :   return SectionPimpl;
     459             : }
     460             : 
     461             : inline const ObjectFile *SectionRef::getObject() const {
     462             :   return OwningObject;
     463             : }
     464             : 
     465             : /// RelocationRef
     466             : inline RelocationRef::RelocationRef(DataRefImpl RelocationP,
     467       16298 :                               const ObjectFile *Owner)
     468             :   : RelocationPimpl(RelocationP)
     469       16298 :   , OwningObject(Owner) {}
     470             : 
     471             : inline bool RelocationRef::operator==(const RelocationRef &Other) const {
     472           0 :   return RelocationPimpl == Other.RelocationPimpl;
     473             : }
     474             : 
     475             : inline void RelocationRef::moveNext() {
     476       21320 :   return OwningObject->moveRelocationNext(RelocationPimpl);
     477             : }
     478             : 
     479             : inline uint64_t RelocationRef::getOffset() const {
     480       28074 :   return OwningObject->getRelocationOffset(RelocationPimpl);
     481             : }
     482             : 
     483             : inline symbol_iterator RelocationRef::getSymbol() const {
     484       16038 :   return OwningObject->getRelocationSymbol(RelocationPimpl);
     485             : }
     486             : 
     487             : inline uint64_t RelocationRef::getType() const {
     488       15343 :   return OwningObject->getRelocationType(RelocationPimpl);
     489             : }
     490             : 
     491             : inline void RelocationRef::getTypeName(SmallVectorImpl<char> &Result) const {
     492        1595 :   return OwningObject->getRelocationTypeName(RelocationPimpl, Result);
     493             : }
     494             : 
     495             : inline DataRefImpl RelocationRef::getRawDataRefImpl() const {
     496       17737 :   return RelocationPimpl;
     497             : }
     498             : 
     499             : inline const ObjectFile *RelocationRef::getObject() const {
     500             :   return OwningObject;
     501             : }
     502             : 
     503             : } // end namespace object
     504             : 
     505             : } // end namespace llvm
     506             : 
     507             : #endif // LLVM_OBJECT_OBJECTFILE_H

Generated by: LCOV version 1.13