llvm::object::ObjectFile Class Reference

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

#include "llvm/Object/ObjectFile.h"

Inheritance diagram for llvm::object::ObjectFile:

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
uint64_t	getCommonSymbolSize (DataRefImpl Symb) const
virtual std::vector< SectionRef >	dynamic_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 Expected< SubtargetFeatures >	getFeatures () const =0
virtual std::optional< StringRef >	tryGetCPUName () const
virtual void	setARMSubArch (Triple &TheTriple) const
virtual Expected< uint64_t >	getStartAddress () 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 Error	printSymbolName (raw_ostream &OS, DataRefImpl Symb) const =0
virtual Expected< uint32_t >	getSymbolFlags (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
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 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_t *	base () const
virtual Expected< StringRef >	getSymbolName (DataRefImpl Symb) const =0
Error	printSymbolName (raw_ostream &OS, DataRefImpl Symb) const override
virtual Expected< uint64_t >	getSymbolAddress (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::Type >	getSymbolType (DataRefImpl Symb) const =0
virtual Expected< section_iterator >	getSymbolSection (DataRefImpl Symb) const =0
virtual void	moveSectionNext (DataRefImpl &Sec) const =0
virtual Expected< StringRef >	getSectionName (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_iterator >	getRelocatedSection (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_t >	getSymbolValue (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_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 229 of file ObjectFile.h.

Member Typedef Documentation

section_iterator_range

using llvm::object::ObjectFile::section_iterator_range = iterator_range<section_iterator>

Definition at line 327 of file ObjectFile.h.

symbol_iterator_range

using llvm::object::ObjectFile::symbol_iterator_range = iterator_range<symbol_iterator>

Definition at line 319 of file ObjectFile.h.

Constructor & Destructor Documentation

ObjectFile() [1/3]

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

protected

Definition at line 43 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 235 of file ObjectFile.h.

References llvm::object::Binary::Data, and llvm::MemoryBufferRef::getBufferStart().

Referenced by llvm::object::COFFObjectFile::getDOSHeader(), llvm::object::COFFObjectFile::getRelocations(), llvm::object::COFFObjectFile::getRvaAndSizeAsBytes(), llvm::object::COFFObjectFile::getRvaPtr(), llvm::object::COFFObjectFile::getSectionContents(), llvm::object::XCOFFObjectFile::getSectionContents(), llvm::object::XCOFFObjectFile::getSectionFileOffsetToRawData(), llvm::object::COFFObjectFile::getSymbolAuxData(), llvm::object::GOFFObjectFile::GOFFObjectFile(), llvm::object::COFFObjectFile::section_rel_begin(), and llvm::object::COFFObjectFile::section_rel_end().

classof()

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

inlinestatic

Definition at line 378 of file ObjectFile.h.

createCOFFObjectFile()

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

static

Definition at line 1770 of file COFFObjectFile.cpp.

References llvm::object::COFFObjectFile::create().

Referenced by llvm::jitlink::createLinkGraphFromCOFFObject_x86_64(), and createObjectFile().

createELFObjectFile()

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

static

Definition at line 72 of file ELFObjectFile.cpp.

References llvm::countr_zero(), llvm::object::createError(), llvm::ELF::ELFCLASS32, llvm::ELF::ELFCLASS64, llvm::ELF::ELFDATA2LSB, llvm::ELF::ELFDATA2MSB, llvm::MemoryBufferRef::getBuffer(), llvm::MemoryBufferRef::getBufferStart(), and llvm::object::getElfArchType().

Referenced by llvm::jitlink::createLinkGraphFromELFObject_aarch32(), llvm::jitlink::createLinkGraphFromELFObject_aarch64(), llvm::jitlink::createLinkGraphFromELFObject_i386(), llvm::jitlink::createLinkGraphFromELFObject_loongarch(), llvm::jitlink::createLinkGraphFromELFObject_ppc64(), llvm::jitlink::createLinkGraphFromELFObject_riscv(), llvm::jitlink::createLinkGraphFromELFObject_x86_64(), and createObjectFile().

createGOFFObjectFile()

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

static

Definition at line 28 of file GOFFObjectFile.cpp.

References llvm::Error::success().

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

Buffer	Memory buffer containing the MachO binary data.
UniversalCputype	CPU type when the MachO part of a universal binary.
UniversalIndex	Index of the MachO within a universal binary.
MachOFilesetEntryOffset	Offset of the MachO entry in a fileset MachO.

Returns

A std::unique_ptr to a MachOObjectFile instance on success.

Definition at line 5322 of file MachOObjectFile.cpp.

References llvm::object::MachOObjectFile::create(), llvm::MemoryBufferRef::getBuffer(), llvm::object::invalid_file_type, and llvm::StringRef::slice().

Referenced by llvm::jitlink::createLinkGraphFromMachOObject_arm64(), llvm::jitlink::createLinkGraphFromMachOObject_x86_64(), createObjectFile(), and llvm::object::MachOUniversalBinary::ObjectForArch::getAsObjectFile().

createObjectFile() [1/3]

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

inlinestatic

Definition at line 374 of file ObjectFile.h.

References createObjectFile(), and llvm::file_magic::unknown.

createObjectFile() [2/3]

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

static

Definition at line 142 of file ObjectFile.cpp.

References llvm::file_magic::archive, llvm::file_magic::bitcode, llvm::file_magic::coff_cl_gl_object, llvm::file_magic::coff_import_library, llvm::file_magic::coff_object, createCOFFObjectFile(), createELFObjectFile(), createMachOObjectFile(), createWasmObjectFile(), createXCOFFObjectFile(), llvm::file_magic::cuda_fatbinary, llvm::object::Binary::Data, llvm::file_magic::dxcontainer_object, llvm::file_magic::elf, llvm::file_magic::elf_core, llvm::file_magic::elf_executable, llvm::file_magic::elf_relocatable, llvm::file_magic::elf_shared_object, llvm::errorCodeToError(), llvm::file_magic::goff_object, llvm::object::Binary::ID_XCOFF32, llvm::object::Binary::ID_XCOFF64, llvm::identify_magic(), llvm::object::invalid_file_type, llvm_unreachable, llvm::file_magic::macho_bundle, llvm::file_magic::macho_core, llvm::file_magic::macho_dsym_companion, llvm::file_magic::macho_dynamic_linker, llvm::file_magic::macho_dynamically_linked_shared_lib, llvm::file_magic::macho_dynamically_linked_shared_lib_stub, llvm::file_magic::macho_executable, llvm::file_magic::macho_file_set, llvm::file_magic::macho_fixed_virtual_memory_shared_lib, llvm::file_magic::macho_kext_bundle, llvm::file_magic::macho_object, llvm::file_magic::macho_preload_executable, llvm::file_magic::macho_universal_binary, llvm::file_magic::minidump, llvm::file_magic::offload_binary, llvm::file_magic::offload_bundle, llvm::file_magic::offload_bundle_compressed, llvm::file_magic::pdb, llvm::file_magic::pecoff_executable, llvm::file_magic::tapi_file, llvm::file_magic::unknown, llvm::file_magic::wasm_object, llvm::file_magic::windows_resource, llvm::file_magic::xcoff_object_32, and llvm::file_magic::xcoff_object_64.

createObjectFile() [3/3]

Expected< OwningBinary< ObjectFile > > ObjectFile::createObjectFile ( StringRef  ObjectPath )

static

Returns

Pointer to ObjectFile subclass to handle this type of object.

Parameters

ObjectPath

The path to the object file. ObjectPath.isObject must return true. Create ObjectFile from path.

Definition at line 200 of file ObjectFile.cpp.

References createObjectFile(), llvm::errorCodeToError(), llvm::Expected< T >::get(), llvm::ErrorOr< T >::get(), llvm::ErrorOr< T >::getError(), llvm::MemoryBuffer::getFile(), and llvm::Expected< T >::takeError().

Referenced by createObjectFile(), llvm::object::SymbolicFile::createSymbolicFile(), llvm::NewArchiveMember::detectKindFromObject(), llvm::orc::RTDyldObjectLinkingLayer::emit(), llvm::object::extractOffloadBinaries(), llvm::object::IRObjectFile::findBitcodeInMemBuffer(), llvm::MCJIT::generateCodeForModule(), ThreadUnsafeDWARFContextState::getDWOContext(), llvm::orc::getObjectFileInterface(), LLVMCreateObjectFile(), llvm::xray::loadInstrumentationMap(), llvm::orc::SimpleCompiler::operator()(), llvm::dwarflinker_parallel::SectionDescriptor::setSizesForSectionCreatedByAsmPrinter(), llvm::write(), and llvm::yaml::yaml2ObjectFile().

createWasmObjectFile()

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

static

Definition at line 67 of file WasmObjectFile.cpp.

References llvm::Error::success().

Referenced by createObjectFile().

createXCOFFObjectFile()

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

static

Definition at line 1223 of file XCOFFObjectFile.cpp.

Referenced by createObjectFile().

dynamic_relocation_sections()

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

inlinevirtual

Reimplemented in llvm::object::ELFObjectFile< ELFT >.

Definition at line 315 of file ObjectFile.h.

getArch()

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

pure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::symbolize::SymbolizableObjectFile::create(), llvm::DWARFContext::getArch(), llvm::object::getRelocationResolver(), llvm::RuntimeDyld::loadObject(), llvm::RuntimeDyldImpl::loadObjectImpl(), and makeTriple().

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.

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::symbolize::SymbolizableObjectFile::create(), llvm::object::getRelocationResolver(), and llvm::BTFParser::ParseContext::makeExtractor().

getCommonSymbolSize()

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

inline

Definition at line 306 of file ObjectFile.h.

References assert(), getCommonSymbolSizeImpl(), llvm::object::SymbolicFile::getSymbolFlags(), llvm::report_fatal_error(), llvm::object::BasicSymbolRef::SF_Common, and llvm::Expected< T >::takeError().

Referenced by llvm::object::SymbolRef::getCommonSize(), and getSymbolValue().

getCommonSymbolSizeImpl()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by getCommonSymbolSize().

getFeatures()

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

pure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFileBase, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

getFileFormatName()

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

pure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

getRelocatedSection()

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

protectedvirtual

Reimplemented in llvm::object::ELFObjectFile< ELFT >.

Definition at line 105 of file ObjectFile.cpp.

References SectionRef.

Referenced by llvm::object::SectionRef::getRelocatedSection().

getRelocationOffset()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::RelocationRef::getOffset().

getRelocationSymbol()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::RelocationRef::getSymbol().

getRelocationType()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::RelocationRef::getType().

getRelocationTypeName()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::RelocationRef::getTypeName().

getSectionAddress()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::getAddress().

getSectionAlignment()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::getAlignment().

getSectionContents()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::getContents().

getSectionIndex()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::getIndex().

getSectionName()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::getName(), and isSectionBitcode().

getSectionSize()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::getSize().

getStartAddress()

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

inlinevirtual

Reimplemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, and llvm::object::XCOFFObjectFile.

Definition at line 345 of file ObjectFile.h.

References llvm::errorCodeToError(), and llvm::object::parse_failed.

getSymbolAddress()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SymbolRef::getAddress().

getSymbolAlignment()

uint32_t ObjectFile::getSymbolAlignment ( DataRefImpl  Symb ) const

protectedvirtual

Reimplemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Definition at line 77 of file ObjectFile.cpp.

Referenced by llvm::object::SymbolRef::getAlignment().

getSymbolName()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SymbolRef::getName(), and printSymbolName().

getSymbolSection()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SymbolRef::getSection().

getSymbolType()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SymbolRef::getType().

getSymbolValue()

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

protected

Definition at line 56 of file ObjectFile.cpp.

References E, getCommonSymbolSize(), llvm::object::SymbolicFile::getSymbolFlags(), getSymbolValueImpl(), llvm::Ref, llvm::object::BasicSymbolRef::SF_Common, and llvm::object::BasicSymbolRef::SF_Undefined.

Referenced by llvm::object::COFFObjectFile::getSymbolAddress(), llvm::object::MachOObjectFile::getSymbolAddress(), llvm::object::WasmObjectFile::getSymbolAddress(), and llvm::object::SymbolRef::getValue().

getSymbolValueImpl()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by getSymbolValue().

hasDebugInfo()

bool ObjectFile::hasDebugInfo ( ) const

virtual

Definition at line 99 of file ObjectFile.cpp.

References llvm::any_of(), llvm::object::SectionRef::isDebugSection(), and sections().

Referenced by llvm::symbolize::useBTFContext().

isBerkeleyData()

bool ObjectFile::isBerkeleyData ( DataRefImpl  Sec ) const

protectedvirtual

Reimplemented in llvm::object::ELFObjectFile< ELFT >.

Definition at line 93 of file ObjectFile.cpp.

References isSectionData().

Referenced by llvm::object::SectionRef::isBerkeleyData().

isBerkeleyText()

bool ObjectFile::isBerkeleyText ( DataRefImpl  Sec ) const

protectedvirtual

Reimplemented in llvm::object::ELFObjectFile< ELFT >.

Definition at line 89 of file ObjectFile.cpp.

References isSectionText().

Referenced by llvm::object::SectionRef::isBerkeleyText().

isDebugSection()

bool ObjectFile::isDebugSection ( DataRefImpl  Sec ) const

protectedvirtual

Reimplemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, and llvm::object::XCOFFObjectFile.

Definition at line 97 of file ObjectFile.cpp.

Referenced by llvm::object::SectionRef::isDebugSection().

isReflectionSectionStrippable()

bool ObjectFile::isReflectionSectionStrippable

(

llvm::binaryformat::Swift5ReflectionSectionKind

ReflectionSectionKind

)

const

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

Definition at line 216 of file ObjectFile.cpp.

isRelocatableObject()

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

pure virtual

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

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::InstrProfSymtab::create().

isSectionBitcode()

bool ObjectFile::isSectionBitcode ( DataRefImpl  Sec ) const

protectedvirtual

Reimplemented in llvm::object::MachOObjectFile.

Definition at line 79 of file ObjectFile.cpp.

References llvm::consumeError(), getSectionName(), and llvm::Expected< T >::takeError().

Referenced by llvm::object::SectionRef::isBitcode().

isSectionBSS()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::isBSS().

isSectionCompressed()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::isCompressed().

isSectionData()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by isBerkeleyData(), and llvm::object::SectionRef::isData().

isSectionStripped()

bool ObjectFile::isSectionStripped ( DataRefImpl  Sec ) const

protectedvirtual

Reimplemented in llvm::object::MachOObjectFile.

Definition at line 87 of file ObjectFile.cpp.

Referenced by llvm::object::SectionRef::isStripped().

isSectionText()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by isBerkeleyText(), and llvm::object::SectionRef::isText().

isSectionVirtual()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::isVirtual().

makeTriple()

Triple ObjectFile::makeTriple

(

)

const

Create a triple from the data in this object file.

Definition at line 109 of file ObjectFile.cpp.

References llvm::Triple::AIX, llvm::Triple::arm, llvm::Triple::armeb, getArch(), llvm::Triple::GOFF, llvm::object::Binary::isCOFF(), llvm::object::Binary::isGOFF(), llvm::object::Binary::isMachO(), llvm::object::Binary::isXCOFF(), llvm::Triple::MachO, llvm::Triple::setArch(), setARMSubArch(), llvm::Triple::setObjectFormat(), llvm::Triple::setOS(), llvm::Triple::setTriple(), llvm::Triple::thumb, llvm::Triple::XCOFF, and llvm::Triple::ZOS.

Referenced by llvm::object::ELFObjectFileBase::getPltEntries(), getUUID(), and llvm::symbolize::useBTFContext().

mapDebugSectionName()

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

inlinevirtual

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

Reimplemented in llvm::object::COFFObjectFile, llvm::object::MachOObjectFile, and llvm::object::XCOFFObjectFile.

Definition at line 353 of file ObjectFile.h.

References Name.

mapReflectionSectionNameToEnumValue()

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

inlineprotectedvirtual

Reimplemented in llvm::object::MachOObjectFile.

Definition at line 296 of file ObjectFile.h.

References llvm::binaryformat::unknown.

moveRelocationNext()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::RelocationRef::moveNext().

moveSectionNext()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::moveNext().

printSymbolName()

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

overrideprotectedvirtual

Implements llvm::object::SymbolicFile.

Definition at line 69 of file ObjectFile.cpp.

References getSymbolName(), Name, OS, and llvm::Error::success().

section_begin()

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

pure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionFilter::begin(), llvm::RuntimeDyldImpl::computeGOTSize(), llvm::RuntimeDyldImpl::computeSectionStubBufSize(), llvm::RuntimeDyldImpl::computeTotalAllocSize(), llvm::RuntimeDyldELF::finalizeLoad(), llvm::RuntimeDyldImpl::loadObjectImpl(), and sections().

section_end()

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

pure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::GOFFObjectFile, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionFilter::begin(), llvm::RuntimeDyldImpl::computeGOTSize(), llvm::RuntimeDyldImpl::computeSectionStubBufSize(), llvm::RuntimeDyldImpl::computeTotalAllocSize(), llvm::object::SectionFilter::end(), llvm::RuntimeDyldELF::finalizeLoad(), getSymbolInfo(), llvm::RuntimeDyldImpl::loadObjectImpl(), llvm::RuntimeDyldCOFFAArch64::processRelocationRef(), llvm::RuntimeDyldCOFFI386::processRelocationRef(), llvm::RuntimeDyldCOFFThumb::processRelocationRef(), llvm::RuntimeDyldCOFFX86_64::processRelocationRef(), llvm::RuntimeDyldELF::processRelocationRef(), and sections().

section_rel_begin()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::relocation_begin().

section_rel_end()

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

protectedpure virtual

Implemented in llvm::object::COFFObjectFile, llvm::object::ELFObjectFile< ELFT >, llvm::object::MachOObjectFile, llvm::object::WasmObjectFile, and llvm::object::XCOFFObjectFile.

Referenced by llvm::object::SectionRef::relocation_end().

sections()

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

inline

Definition at line 328 of file ObjectFile.h.

References section_begin(), and section_end().

Referenced by llvm::object::BindRebaseSegInfo::BindRebaseSegInfo(), llvm::objcopy::wasm::Reader::create(), llvm::symbolize::SymbolizableObjectFile::create(), llvm::RuntimeDyldMachOCRTPBase< Impl >::finalizeLoad(), llvm::object::IRObjectFile::findBitcodeInObject(), llvm::orc::getCOFFObjectFileSymbolInfo(), llvm::orc::getELFObjectFileSymbolInfo(), getInstrProfSection(), llvm::orc::getMachOObjectFileSymbolInfo(), llvm::object::ELFObjectFileBase::getPltEntries(), llvm::remarks::getRemarksSectionContents(), llvm::object::COFFObjectFile::getRvaAndSizeAsBytes(), llvm::object::COFFObjectFile::getRvaPtr(), llvm::object::MachOObjectFile::getSection(), getUUID(), llvm::BTFParser::hasBTFSections(), hasDebugInfo(), lookupSections(), llvm::logicalview::LVBinaryReader::mapVirtualAddress(), llvm::BTFParser::parse(), and llvm::jitlink::COFFLinkGraphBuilder::sections().

setARMSubArch()

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

inlinevirtual

Reimplemented in llvm::object::ELFObjectFileBase.

Definition at line 344 of file ObjectFile.h.

Referenced by makeTriple().

symbols()

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

inline

Definition at line 320 of file ObjectFile.h.

References llvm::object::SymbolicFile::symbol_begin(), and llvm::object::SymbolicFile::symbol_end().

Referenced by llvm::object::MachOObjectFile::checkSymbolTable(), llvm::gsym::ObjectFileTransformer::convert(), llvm::orc::getCOFFObjectFileSymbolInfo(), llvm::orc::getGenericObjectFileSymbolInfo(), llvm::orc::getMachOObjectFileSymbolInfo(), and llvm::RuntimeDyldImpl::loadObjectImpl().

tryGetCPUName()

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

inlinevirtual

Reimplemented in llvm::object::ELFObjectFileBase, and llvm::object::XCOFFObjectFile.

Definition at line 341 of file ObjectFile.h.

Friends And Related Function Documentation

RelocationRef

friend class RelocationRef

friend

Definition at line 287 of file ObjectFile.h.

Referenced by llvm::object::MachOObjectFile::extrel_begin(), llvm::object::MachOObjectFile::extrel_end(), llvm::object::XCOFFRelocation< llvm::support::ubig32_t >::getRelocatedLength(), llvm::object::MachOObjectFile::locrel_begin(), llvm::object::MachOObjectFile::locrel_end(), llvm::object::COFFObjectFile::section_rel_begin(), llvm::object::MachOObjectFile::section_rel_begin(), llvm::object::WasmObjectFile::section_rel_begin(), llvm::object::COFFObjectFile::section_rel_end(), llvm::object::MachOObjectFile::section_rel_end(), llvm::object::WasmObjectFile::section_rel_end(), and llvm::object::XCOFFObjectFile::section_rel_end().

SectionRef

friend class SectionRef

friend

Definition at line 261 of file ObjectFile.h.

Referenced by llvm::object::MachOObjectFile::getAnyRelocationSection(), getRelocatedSection(), llvm::object::MachOObjectFile::getRelocationRelocatedSection(), llvm::object::MachOObjectFile::getSection(), llvm::object::COFFObjectFile::getSymbolSection(), llvm::object::MachOObjectFile::getSymbolSection(), llvm::object::WasmObjectFile::getSymbolSection(), llvm::object::XCOFFObjectFile::getSymbolSection(), llvm::object::COFFObjectFile::section_begin(), llvm::object::GOFFObjectFile::section_begin(), llvm::object::MachOObjectFile::section_begin(), llvm::object::WasmObjectFile::section_begin(), llvm::object::XCOFFObjectFile::section_begin(), llvm::object::COFFObjectFile::section_end(), llvm::object::GOFFObjectFile::section_end(), llvm::object::MachOObjectFile::section_end(), llvm::object::WasmObjectFile::section_end(), and llvm::object::XCOFFObjectFile::section_end().

SymbolRef

friend class SymbolRef

friend

Definition at line 247 of file ObjectFile.h.

Referenced by llvm::object::COFFObjectFile::getRelocationSymbol(), llvm::object::MachOObjectFile::getRelocationSymbol(), llvm::object::WasmObjectFile::getRelocationSymbol(), llvm::object::XCOFFObjectFile::getRelocationSymbol(), llvm::object::MachOObjectFile::getSymbolByIndex(), llvm::object::COFFObjectFile::symbol_begin(), llvm::object::GOFFObjectFile::symbol_begin(), llvm::object::MachOObjectFile::symbol_begin(), llvm::object::XCOFFObjectFile::symbol_begin(), llvm::object::COFFObjectFile::symbol_end(), llvm::object::GOFFObjectFile::symbol_end(), llvm::object::MachOObjectFile::symbol_end(), and llvm::object::XCOFFObjectFile::symbol_end().

---

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

• include/llvm/Object/ObjectFile.h
• lib/Object/COFFObjectFile.cpp
• lib/Object/ELFObjectFile.cpp
• lib/Object/GOFFObjectFile.cpp
• lib/Object/MachOObjectFile.cpp
• lib/Object/ObjectFile.cpp
• lib/Object/WasmObjectFile.cpp
• lib/Object/XCOFFObjectFile.cpp