LLVM 22.0.0git
llvm::ObjectFile Class Referenceabstract

This class is the base class for all object file types. More...

#include "llvm/Object/ObjectFile.h"

Inheritance diagram for llvm::ObjectFile:
[legend]

Public Types

using symbol_iterator_range = iterator_range<symbol_iterator>
using section_iterator_range = iterator_range<section_iterator>
Public Types inherited from llvm::object::SymbolicFile
using basic_symbol_iterator_range = iterator_range<basic_symbol_iterator>

Public Member Functions

 ObjectFile ()=delete
 ObjectFile (const ObjectFile &other)=delete
ObjectFileoperator= (const ObjectFile &other)=delete
uint64_t getCommonSymbolSize (DataRefImpl Symb) const
virtual std::vector< SectionRefdynamic_relocation_sections () const
symbol_iterator_range symbols () const
virtual section_iterator section_begin () const=0
virtual section_iterator section_end () const=0
section_iterator_range sections () const
virtual bool hasDebugInfo () const
virtual uint8_t getBytesInAddress () const=0
 The number of bytes used to represent an address in this object file format.
virtual StringRef getFileFormatName () const=0
virtual Triple::ArchType getArch () const=0
virtual Triple::OSType getOS () const
virtual Expected< SubtargetFeaturesgetFeatures () const=0
virtual std::optional< StringReftryGetCPUName () const
virtual void setARMSubArch (Triple &TheTriple) const
virtual Expected< uint64_tgetStartAddress () const
Triple makeTriple () const
 Create a triple from the data in this object file.
virtual StringRef mapDebugSectionName (StringRef Name) const
 Maps a debug section name to a standard DWARF section name.
virtual bool isRelocatableObject () const=0
 True if this is a relocatable object (.o/.obj).
bool isReflectionSectionStrippable (llvm::binaryformat::Swift5ReflectionSectionKind ReflectionSectionKind) const
 True if the reflection section can be stripped by the linker.
Public Member Functions inherited from llvm::object::SymbolicFile
 SymbolicFile (unsigned int Type, MemoryBufferRef Source)
 ~SymbolicFile () override
virtual void moveSymbolNext (DataRefImpl &Symb) const =0
virtual Expected< uint32_tgetSymbolFlags (DataRefImpl Symb) const =0
virtual basic_symbol_iterator symbol_begin () const =0
virtual basic_symbol_iterator symbol_end () const =0
virtual bool is64Bit () const =0
basic_symbol_iterator_range symbols () const
Public Member Functions inherited from llvm::object::Binary
 Binary ()=delete
 Binary (const Binary &other)=delete
virtual ~Binary ()
virtual Error initContent ()
StringRef getData () const
StringRef getFileName () const
MemoryBufferRef getMemoryBufferRef () const
unsigned int getType () const
bool isObject () const
bool isSymbolic () const
bool isArchive () const
bool isMachOUniversalBinary () const
bool isTapiUniversal () const
bool isELF () const
bool isMachO () const
bool isCOFF () const
bool isXCOFF () const
bool isWasm () const
bool isOffloadFile () const
bool isCOFFImportFile () const
bool isIR () const
bool isGOFF () const
bool isMinidump () const
bool isTapiFile () const
bool isLittleEndian () const
bool isWinRes () const
bool isDXContainer () const
Triple::ObjectFormatType getTripleObjectFormat () const

Static Public Member Functions

static Expected< OwningBinary< ObjectFile > > createObjectFile (StringRef ObjectPath)
static Expected< std::unique_ptr< ObjectFile > > createObjectFile (MemoryBufferRef Object, llvm::file_magic Type, bool InitContent=true)
static Expected< std::unique_ptr< ObjectFile > > createObjectFile (MemoryBufferRef Object)
static bool classof (const Binary *v)
static Expected< std::unique_ptr< COFFObjectFile > > createCOFFObjectFile (MemoryBufferRef Object)
static Expected< std::unique_ptr< ObjectFile > > createXCOFFObjectFile (MemoryBufferRef Object, unsigned FileType)
static Expected< std::unique_ptr< ObjectFile > > createELFObjectFile (MemoryBufferRef Object, bool InitContent=true)
static Expected< std::unique_ptr< MachOObjectFile > > createMachOObjectFile (MemoryBufferRef Object, uint32_t UniversalCputype=0, uint32_t UniversalIndex=0, size_t MachOFilesetEntryOffset=0)
 Create a MachOObjectFile instance from a given buffer.
static Expected< std::unique_ptr< ObjectFile > > createGOFFObjectFile (MemoryBufferRef Object)
static Expected< std::unique_ptr< WasmObjectFile > > createWasmObjectFile (MemoryBufferRef Object)
static Expected< std::unique_ptr< DXContainerObjectFile > > createDXContainerObjectFile (MemoryBufferRef Object)
Static Public Member Functions inherited from llvm::object::SymbolicFile
static Expected< std::unique_ptr< SymbolicFile > > createSymbolicFile (MemoryBufferRef Object, llvm::file_magic Type, LLVMContext *Context, bool InitContent=true)
static Expected< std::unique_ptr< SymbolicFile > > createSymbolicFile (MemoryBufferRef Object)
static bool classof (const Binary *v)
static bool isSymbolicFile (file_magic Type, const LLVMContext *Context)
Static Public Member Functions inherited from llvm::object::Binary
static Error checkOffset (MemoryBufferRef M, uintptr_t Addr, const uint64_t Size)

Protected Member Functions

 ObjectFile (unsigned int Type, MemoryBufferRef Source)
const uint8_tbase () const
virtual Expected< StringRefgetSymbolName (DataRefImpl Symb) const=0
Error printSymbolName (raw_ostream &OS, DataRefImpl Symb) const override
virtual Expected< uint64_tgetSymbolAddress (DataRefImpl Symb) const=0
virtual uint64_t getSymbolValueImpl (DataRefImpl Symb) const=0
virtual uint32_t getSymbolAlignment (DataRefImpl Symb) const
virtual uint64_t getCommonSymbolSizeImpl (DataRefImpl Symb) const=0
virtual Expected< SymbolRef::TypegetSymbolType (DataRefImpl Symb) const=0
virtual Expected< section_iteratorgetSymbolSection (DataRefImpl Symb) const=0
virtual void moveSectionNext (DataRefImpl &Sec) const=0
virtual Expected< StringRefgetSectionName (DataRefImpl Sec) const=0
virtual uint64_t getSectionAddress (DataRefImpl Sec) const=0
virtual uint64_t getSectionIndex (DataRefImpl Sec) const=0
virtual uint64_t getSectionSize (DataRefImpl Sec) const=0
virtual Expected< ArrayRef< uint8_t > > getSectionContents (DataRefImpl Sec) const=0
virtual uint64_t getSectionAlignment (DataRefImpl Sec) const=0
virtual bool isSectionCompressed (DataRefImpl Sec) const=0
virtual bool isSectionText (DataRefImpl Sec) const=0
virtual bool isSectionData (DataRefImpl Sec) const=0
virtual bool isSectionBSS (DataRefImpl Sec) const=0
virtual bool isSectionVirtual (DataRefImpl Sec) const=0
virtual bool isSectionBitcode (DataRefImpl Sec) const
virtual bool isSectionStripped (DataRefImpl Sec) const
virtual bool isBerkeleyText (DataRefImpl Sec) const
virtual bool isBerkeleyData (DataRefImpl Sec) const
virtual bool isDebugSection (DataRefImpl Sec) const
virtual relocation_iterator section_rel_begin (DataRefImpl Sec) const=0
virtual relocation_iterator section_rel_end (DataRefImpl Sec) const=0
virtual Expected< section_iteratorgetRelocatedSection (DataRefImpl Sec) const
virtual void moveRelocationNext (DataRefImpl &Rel) const=0
virtual uint64_t getRelocationOffset (DataRefImpl Rel) const=0
virtual symbol_iterator getRelocationSymbol (DataRefImpl Rel) const=0
virtual uint64_t getRelocationType (DataRefImpl Rel) const=0
virtual void getRelocationTypeName (DataRefImpl Rel, SmallVectorImpl< char > &Result) const=0
virtual llvm::binaryformat::Swift5ReflectionSectionKind mapReflectionSectionNameToEnumValue (StringRef SectionName) const
Expected< uint64_tgetSymbolValue (DataRefImpl Symb) const
Protected Member Functions inherited from llvm::object::Binary
 Binary (unsigned int Type, MemoryBufferRef Source)

Friends

class SymbolRef
class SectionRef
class RelocationRef

Additional Inherited Members

Protected Types inherited from llvm::object::Binary
enum  {
  ID_Archive , ID_MachOUniversalBinary , ID_COFFImportFile , ID_IR ,
  ID_TapiUniversal , ID_TapiFile , ID_Minidump , ID_WinRes ,
  ID_Offload , ID_StartObjects , ID_COFF , ID_XCOFF32 ,
  ID_XCOFF64 , ID_ELF32L , ID_ELF32B , ID_ELF64L ,
  ID_ELF64B , ID_MachO32L , ID_MachO32B , ID_MachO64L ,
  ID_MachO64B , ID_GOFF , ID_Wasm , ID_DXContainer ,
  ID_EndObjects
}
Static Protected Member Functions inherited from llvm::object::Binary
static unsigned int getELFType (bool isLE, bool is64Bits)
static unsigned int getMachOType (bool isLE, bool is64Bits)
Protected Attributes inherited from llvm::object::Binary
MemoryBufferRef Data

Detailed Description

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.

Definition at line 231 of file ObjectFile.h.

Member Typedef Documentation

◆ section_iterator_range

◆ symbol_iterator_range

Definition at line 322 of file ObjectFile.h.

Constructor & Destructor Documentation

◆ ObjectFile() [1/3]

ObjectFile::ObjectFile ( unsigned int Type,
MemoryBufferRef Source )
protected

Definition at line 44 of file ObjectFile.cpp.

◆ ObjectFile() [2/3]

llvm::object::ObjectFile::ObjectFile ( )
delete

◆ ObjectFile() [3/3]

llvm::object::ObjectFile::ObjectFile ( const ObjectFile & other)
delete

Member Function Documentation

◆ base()

const uint8_t * llvm::object::ObjectFile::base ( ) const
inlineprotected

Definition at line 237 of file ObjectFile.h.

◆ classof()

bool llvm::object::ObjectFile::classof ( const Binary * v)
inlinestatic

Definition at line 382 of file ObjectFile.h.

◆ createCOFFObjectFile()

Expected< std::unique_ptr< COFFObjectFile > > ObjectFile::createCOFFObjectFile ( MemoryBufferRef Object)
static

Definition at line 1896 of file COFFObjectFile.cpp.

◆ createDXContainerObjectFile()

Expected< std::unique_ptr< DXContainerObjectFile > > ObjectFile::createDXContainerObjectFile ( MemoryBufferRef Object)
static

Definition at line 692 of file DXContainer.cpp.

◆ createELFObjectFile()

Expected< std::unique_ptr< ObjectFile > > ObjectFile::createELFObjectFile ( MemoryBufferRef Object,
bool InitContent = true )
static

◆ createGOFFObjectFile()

Expected< std::unique_ptr< ObjectFile > > ObjectFile::createGOFFObjectFile ( MemoryBufferRef Object)
static

Definition at line 28 of file GOFFObjectFile.cpp.

◆ createMachOObjectFile()

Expected< std::unique_ptr< MachOObjectFile > > ObjectFile::createMachOObjectFile ( MemoryBufferRef Buffer,
uint32_t UniversalCputype = 0,
uint32_t UniversalIndex = 0,
size_t MachOFilesetEntryOffset = 0 )
static

Create a MachOObjectFile instance from a given buffer.

Parameters
BufferMemory buffer containing the MachO binary data.
UniversalCputypeCPU type when the MachO part of a universal binary.
UniversalIndexIndex of the MachO within a universal binary.
MachOFilesetEntryOffsetOffset of the MachO entry in a fileset MachO.
Returns
A std::unique_ptr to a MachOObjectFile instance on success.

Definition at line 5320 of file MachOObjectFile.cpp.

◆ createObjectFile() [1/3]

Expected< std::unique_ptr< ObjectFile > > llvm::object::ObjectFile::createObjectFile ( MemoryBufferRef Object)
inlinestatic

Definition at line 378 of file ObjectFile.h.

◆ createObjectFile() [2/3]

Expected< std::unique_ptr< ObjectFile > > ObjectFile::createObjectFile ( MemoryBufferRef Object,
llvm::file_magic Type,
bool InitContent = true )
static

Definition at line 150 of file ObjectFile.cpp.

◆ createObjectFile() [3/3]

Expected< OwningBinary< ObjectFile > > ObjectFile::createObjectFile ( StringRef ObjectPath)
static
Returns
Pointer to ObjectFile subclass to handle this type of object.
Parameters
ObjectPathThe path to the object file. ObjectPath.isObject must return true. Create ObjectFile from path.

Definition at line 211 of file ObjectFile.cpp.

◆ createWasmObjectFile()

Expected< std::unique_ptr< WasmObjectFile > > ObjectFile::createWasmObjectFile ( MemoryBufferRef Object)
static

Definition at line 66 of file WasmObjectFile.cpp.

◆ createXCOFFObjectFile()

Expected< std::unique_ptr< ObjectFile > > llvm::object::ObjectFile::createXCOFFObjectFile ( MemoryBufferRef Object,
unsigned FileType )
static

Definition at line 1236 of file XCOFFObjectFile.cpp.

◆ dynamic_relocation_sections()

virtual std::vector< SectionRef > llvm::object::ObjectFile::dynamic_relocation_sections ( ) const
inlinevirtual

Definition at line 318 of file ObjectFile.h.

◆ getArch()

virtual Triple::ArchType llvm::object::ObjectFile::getArch ( ) const
pure virtual

◆ getBytesInAddress()

virtual uint8_t llvm::object::ObjectFile::getBytesInAddress ( ) const
pure virtual

The number of bytes used to represent an address in this object file format.

◆ getCommonSymbolSize()

uint64_t llvm::object::ObjectFile::getCommonSymbolSize ( DataRefImpl Symb) const
inline

Definition at line 309 of file ObjectFile.h.

◆ getCommonSymbolSizeImpl()

virtual uint64_t llvm::object::ObjectFile::getCommonSymbolSizeImpl ( DataRefImpl Symb) const
protectedpure virtual

◆ getFeatures()

virtual Expected< SubtargetFeatures > llvm::object::ObjectFile::getFeatures ( ) const
pure virtual

◆ getFileFormatName()

virtual StringRef llvm::object::ObjectFile::getFileFormatName ( ) const
pure virtual

◆ getOS()

virtual Triple::OSType llvm::object::ObjectFile::getOS ( ) const
inlinevirtual

Definition at line 343 of file ObjectFile.h.

◆ getRelocatedSection()

Expected< section_iterator > ObjectFile::getRelocatedSection ( DataRefImpl Sec) const
protectedvirtual

Definition at line 106 of file ObjectFile.cpp.

◆ getRelocationOffset()

virtual uint64_t llvm::object::ObjectFile::getRelocationOffset ( DataRefImpl Rel) const
protectedpure virtual

◆ getRelocationSymbol()

virtual symbol_iterator llvm::object::ObjectFile::getRelocationSymbol ( DataRefImpl Rel) const
protectedpure virtual

◆ getRelocationType()

virtual uint64_t llvm::object::ObjectFile::getRelocationType ( DataRefImpl Rel) const
protectedpure virtual

◆ getRelocationTypeName()

virtual void llvm::object::ObjectFile::getRelocationTypeName ( DataRefImpl Rel,
SmallVectorImpl< char > & Result ) const
protectedpure virtual

◆ getSectionAddress()

virtual uint64_t llvm::object::ObjectFile::getSectionAddress ( DataRefImpl Sec) const
protectedpure virtual

◆ getSectionAlignment()

virtual uint64_t llvm::object::ObjectFile::getSectionAlignment ( DataRefImpl Sec) const
protectedpure virtual

◆ getSectionContents()

virtual Expected< ArrayRef< uint8_t > > llvm::object::ObjectFile::getSectionContents ( DataRefImpl Sec) const
protectedpure virtual

◆ getSectionIndex()

virtual uint64_t llvm::object::ObjectFile::getSectionIndex ( DataRefImpl Sec) const
protectedpure virtual

◆ getSectionName()

virtual Expected< StringRef > llvm::object::ObjectFile::getSectionName ( DataRefImpl Sec) const
protectedpure virtual

◆ getSectionSize()

virtual uint64_t llvm::object::ObjectFile::getSectionSize ( DataRefImpl Sec) const
protectedpure virtual

◆ getStartAddress()

virtual Expected< uint64_t > llvm::object::ObjectFile::getStartAddress ( ) const
inlinevirtual

Definition at line 349 of file ObjectFile.h.

◆ getSymbolAddress()

virtual Expected< uint64_t > llvm::object::ObjectFile::getSymbolAddress ( DataRefImpl Symb) const
protectedpure virtual

◆ getSymbolAlignment()

uint32_t ObjectFile::getSymbolAlignment ( DataRefImpl Symb) const
protectedvirtual

Definition at line 78 of file ObjectFile.cpp.

◆ getSymbolName()

virtual Expected< StringRef > llvm::object::ObjectFile::getSymbolName ( DataRefImpl Symb) const
protectedpure virtual

◆ getSymbolSection()

virtual Expected< section_iterator > llvm::object::ObjectFile::getSymbolSection ( DataRefImpl Symb) const
protectedpure virtual

◆ getSymbolType()

virtual Expected< SymbolRef::Type > llvm::object::ObjectFile::getSymbolType ( DataRefImpl Symb) const
protectedpure virtual

◆ getSymbolValue()

Expected< uint64_t > ObjectFile::getSymbolValue ( DataRefImpl Symb) const
protected

Definition at line 57 of file ObjectFile.cpp.

◆ getSymbolValueImpl()

virtual uint64_t llvm::object::ObjectFile::getSymbolValueImpl ( DataRefImpl Symb) const
protectedpure virtual

◆ hasDebugInfo()

bool ObjectFile::hasDebugInfo ( ) const
virtual

Definition at line 100 of file ObjectFile.cpp.

◆ isBerkeleyData()

bool ObjectFile::isBerkeleyData ( DataRefImpl Sec) const
protectedvirtual

Definition at line 94 of file ObjectFile.cpp.

◆ isBerkeleyText()

bool ObjectFile::isBerkeleyText ( DataRefImpl Sec) const
protectedvirtual

Definition at line 90 of file ObjectFile.cpp.

◆ isDebugSection()

bool ObjectFile::isDebugSection ( DataRefImpl Sec) const
protectedvirtual

Definition at line 98 of file ObjectFile.cpp.

◆ isReflectionSectionStrippable()

bool ObjectFile::isReflectionSectionStrippable ( llvm::binaryformat::Swift5ReflectionSectionKind ReflectionSectionKind) const

True if the reflection section can be stripped by the linker.

Definition at line 227 of file ObjectFile.cpp.

◆ isRelocatableObject()

virtual bool llvm::object::ObjectFile::isRelocatableObject ( ) const
pure virtual

True if this is a relocatable object (.o/.obj).

◆ isSectionBitcode()

bool ObjectFile::isSectionBitcode ( DataRefImpl Sec) const
protectedvirtual

Definition at line 80 of file ObjectFile.cpp.

◆ isSectionBSS()

virtual bool llvm::object::ObjectFile::isSectionBSS ( DataRefImpl Sec) const
protectedpure virtual

◆ isSectionCompressed()

virtual bool llvm::object::ObjectFile::isSectionCompressed ( DataRefImpl Sec) const
protectedpure virtual

◆ isSectionData()

virtual bool llvm::object::ObjectFile::isSectionData ( DataRefImpl Sec) const
protectedpure virtual

◆ isSectionStripped()

bool ObjectFile::isSectionStripped ( DataRefImpl Sec) const
protectedvirtual

Definition at line 88 of file ObjectFile.cpp.

◆ isSectionText()

virtual bool llvm::object::ObjectFile::isSectionText ( DataRefImpl Sec) const
protectedpure virtual

◆ isSectionVirtual()

virtual bool llvm::object::ObjectFile::isSectionVirtual ( DataRefImpl Sec) const
protectedpure virtual

◆ makeTriple()

Triple ObjectFile::makeTriple ( ) const

Create a triple from the data in this object file.

Definition at line 110 of file ObjectFile.cpp.

◆ mapDebugSectionName()

virtual StringRef llvm::object::ObjectFile::mapDebugSectionName ( StringRef Name) const
inlinevirtual

Maps a debug section name to a standard DWARF section name.

Definition at line 357 of file ObjectFile.h.

◆ mapReflectionSectionNameToEnumValue()

virtual llvm::binaryformat::Swift5ReflectionSectionKind llvm::object::ObjectFile::mapReflectionSectionNameToEnumValue ( StringRef SectionName) const
inlineprotectedvirtual

Definition at line 298 of file ObjectFile.h.

◆ moveRelocationNext()

virtual void llvm::object::ObjectFile::moveRelocationNext ( DataRefImpl & Rel) const
protectedpure virtual

◆ moveSectionNext()

virtual void llvm::object::ObjectFile::moveSectionNext ( DataRefImpl & Sec) const
protectedpure virtual

◆ operator=()

ObjectFile & llvm::object::ObjectFile::operator= ( const ObjectFile & other)
delete

◆ printSymbolName()

Error ObjectFile::printSymbolName ( raw_ostream & OS,
DataRefImpl Symb ) const
overrideprotectedvirtual

Implements llvm::object::SymbolicFile.

Definition at line 70 of file ObjectFile.cpp.

◆ section_begin()

virtual section_iterator llvm::object::ObjectFile::section_begin ( ) const
pure virtual

◆ section_end()

virtual section_iterator llvm::object::ObjectFile::section_end ( ) const
pure virtual

◆ section_rel_begin()

virtual relocation_iterator llvm::object::ObjectFile::section_rel_begin ( DataRefImpl Sec) const
protectedpure virtual

◆ section_rel_end()

virtual relocation_iterator llvm::object::ObjectFile::section_rel_end ( DataRefImpl Sec) const
protectedpure virtual

◆ sections()

section_iterator_range llvm::object::ObjectFile::sections ( ) const
inline

Definition at line 331 of file ObjectFile.h.

◆ setARMSubArch()

virtual void llvm::object::ObjectFile::setARMSubArch ( Triple & TheTriple) const
inlinevirtual

Definition at line 348 of file ObjectFile.h.

◆ symbols()

symbol_iterator_range llvm::object::ObjectFile::symbols ( ) const
inline

Definition at line 323 of file ObjectFile.h.

◆ tryGetCPUName()

virtual std::optional< StringRef > llvm::object::ObjectFile::tryGetCPUName ( ) const
inlinevirtual

Definition at line 345 of file ObjectFile.h.

◆ RelocationRef

friend class RelocationRef
friend

Definition at line 289 of file ObjectFile.h.

◆ SectionRef

friend class SectionRef
friend

Definition at line 263 of file ObjectFile.h.

◆ SymbolRef

friend class SymbolRef
friend

Definition at line 249 of file ObjectFile.h.


The documentation for this class was generated from the following files: