LLVM 22.0.0git
llvm::object::ELFFile< ELFT > Class Template Reference

#include "llvm/Object/ELF.h"

Inheritance diagram for llvm::object::ELFFile< ELFT >:
[legend]

Public Types

using WarningHandler = llvm::function_ref<Error(const Twine &Msg)>
using RelsOrRelas = std::pair<std::vector<Elf_Rel>, std::vector<Elf_Rela>>

Public Member Functions

 ELFFile (const ELFFile &)=default
ELFFileoperator= (const ELFFile &)=default
const uint8_tbase () const
const uint8_tend () const
size_t getBufSize () const
const Elf_Ehdr & getHeader () const
template<typename T>
Expected< const T * > getEntry (uint32_t Section, uint32_t Entry) const
template<typename T>
Expected< const T * > getEntry (const Elf_Shdr &Section, uint32_t Entry) const
Expected< std::vector< VerDef > > getVersionDefinitions (const Elf_Shdr &Sec) const
Expected< std::vector< VerNeed > > getVersionDependencies (const Elf_Shdr &Sec, WarningHandler WarnHandler=&defaultWarningHandler) const
Expected< StringRefgetSymbolVersionByIndex (uint32_t SymbolVersionIndex, bool &IsDefault, SmallVector< std::optional< VersionEntry >, 0 > &VersionMap, std::optional< bool > IsSymHidden) const
Expected< StringRefgetStringTable (const Elf_Shdr &Section, WarningHandler WarnHandler=&defaultWarningHandler) const
Expected< StringRefgetStringTableForSymtab (const Elf_Shdr &Section) const
Expected< StringRefgetStringTableForSymtab (const Elf_Shdr &Section, Elf_Shdr_Range Sections) const
Expected< StringRefgetLinkAsStrtab (const typename ELFT::Shdr &Sec) const
Expected< ArrayRef< Elf_Word > > getSHNDXTable (const Elf_Shdr &Section) const
Expected< ArrayRef< Elf_Word > > getSHNDXTable (const Elf_Shdr &Section, Elf_Shdr_Range Sections) const
Expected< uint64_tgetDynSymtabSize () const
 This function determines the number of dynamic symbols.
StringRef getRelocationTypeName (uint32_t Type) const
void getRelocationTypeName (uint32_t Type, SmallVectorImpl< char > &Result) const
uint32_t getRelativeRelocationType () const
std::string getDynamicTagAsString (unsigned Arch, uint64_t Type) const
std::string getDynamicTagAsString (uint64_t Type) const
Expected< const Elf_Sym * > getRelocationSymbol (const Elf_Rel &Rel, const Elf_Shdr *SymTab) const
 Get the symbol for a given relocation.
Expected< SmallVector< std::optional< VersionEntry >, 0 > > loadVersionMap (const Elf_Shdr *VerNeedSec, const Elf_Shdr *VerDefSec) const
bool isLE () const
bool isMipsELF64 () const
bool isMips64EL () const
Expected< Elf_Shdr_Range > sections () const
Expected< Elf_Dyn_Range > dynamicEntries () const
Expected< const uint8_t * > toMappedAddr (uint64_t VAddr, WarningHandler WarnHandler=&defaultWarningHandler) const
Expected< Elf_Sym_Range > symbols (const Elf_Shdr *Sec) const
Expected< Elf_Rela_Range > relas (const Elf_Shdr &Sec) const
Expected< Elf_Rel_Range > rels (const Elf_Shdr &Sec) const
Expected< Elf_Relr_Range > relrs (const Elf_Shdr &Sec) const
std::vector< Elf_Rel > decode_relrs (Elf_Relr_Range relrs) const
Expected< uint64_tgetCrelHeader (ArrayRef< uint8_t > Content) const
Expected< RelsOrRelasdecodeCrel (ArrayRef< uint8_t > Content) const
Expected< RelsOrRelascrels (const Elf_Shdr &Sec) const
Expected< std::vector< Elf_Rela > > android_relas (const Elf_Shdr &Sec) const
Expected< Elf_Phdr_Range > program_headers () const
 Iterate over program header table.
Elf_Note_Iterator notes_begin (const Elf_Phdr &Phdr, Error &Err) const
 Get an iterator over notes in a program header.
Elf_Note_Iterator notes_begin (const Elf_Shdr &Shdr, Error &Err) const
 Get an iterator over notes in a section.
Elf_Note_Iterator notes_end () const
 Get the end iterator for notes.
iterator_range< Elf_Note_Iterator > notes (const Elf_Phdr &Phdr, Error &Err) const
 Get an iterator range over notes of a program header.
iterator_range< Elf_Note_Iterator > notes (const Elf_Shdr &Shdr, Error &Err) const
 Get an iterator range over notes of a section.
Expected< StringRefgetSectionStringTable (Elf_Shdr_Range Sections, WarningHandler WarnHandler=&defaultWarningHandler) const
Expected< uint32_tgetSectionIndex (const Elf_Sym &Sym, Elf_Sym_Range Syms, DataRegion< Elf_Word > ShndxTable) const
Expected< const Elf_Shdr * > getSection (const Elf_Sym &Sym, const Elf_Shdr *SymTab, DataRegion< Elf_Word > ShndxTable) const
Expected< const Elf_Shdr * > getSection (const Elf_Sym &Sym, Elf_Sym_Range Symtab, DataRegion< Elf_Word > ShndxTable) const
Expected< const Elf_Shdr * > getSection (uint32_t Index) const
Expected< const Elf_Sym * > getSymbol (const Elf_Shdr *Sec, uint32_t Index) const
Expected< StringRefgetSectionName (const Elf_Shdr &Section, WarningHandler WarnHandler=&defaultWarningHandler) const
Expected< StringRefgetSectionName (const Elf_Shdr &Section, StringRef DotShstrtab) const
template<typename T>
Expected< ArrayRef< T > > getSectionContentsAsArray (const Elf_Shdr &Sec) const
Expected< ArrayRef< uint8_t > > getSectionContents (const Elf_Shdr &Sec) const
Expected< ArrayRef< uint8_t > > getSegmentContents (const Elf_Phdr &Phdr) const
Expected< std::vector< BBAddrMap > > decodeBBAddrMap (const Elf_Shdr &Sec, const Elf_Shdr *RelaSec=nullptr, std::vector< PGOAnalysisMap > *PGOAnalyses=nullptr) const
 Returns a vector of BBAddrMap structs corresponding to each function within the text section that the SHT_LLVM_BB_ADDR_MAP section Sec is associated with.
Expected< MapVector< const Elf_Shdr *, const Elf_Shdr * > > getSectionAndRelocations (std::function< Expected< bool >(const Elf_Shdr &)> IsMatch) const
 Returns a map from every section matching IsMatch to its relocation section, or nullptr if it has no relocation section.
void createFakeSections ()
 Used by llvm-objdump -d (which needs sections for disassembly) to disassemble objects without a section header table (e.g.

Static Public Member Functions

static Expected< ELFFilecreate (StringRef Object)

Detailed Description

template<class ELFT>
class llvm::object::ELFFile< ELFT >

Definition at line 255 of file ELF.h.

Member Typedef Documentation

◆ RelsOrRelas

template<class ELFT>
using llvm::object::ELFFile< ELFT >::RelsOrRelas = std::pair<std::vector<Elf_Rel>, std::vector<Elf_Rela>>

Definition at line 374 of file ELF.h.

◆ WarningHandler

template<class ELFT>
using llvm::object::ELFFile< ELFT >::WarningHandler = llvm::function_ref<Error(const Twine &Msg)>

Definition at line 269 of file ELF.h.

Constructor & Destructor Documentation

◆ ELFFile()

template<class ELFT>
llvm::object::ELFFile< ELFT >::ELFFile ( const ELFFile< ELFT > & )
default

Referenced by create().

Member Function Documentation

◆ android_relas()

◆ base()

◆ create()

template<class ELFT>
Expected< ELFFile< ELFT > > llvm::object::ELFFile< ELFT >::create ( StringRef Object)
static

Definition at line 893 of file ELF.h.

References llvm::object::createError(), and ELFFile().

Referenced by llvm::object::ELFObjectFile< ELFT >::create().

◆ createFakeSections()

template<class ELFT>
void llvm::object::ELFFile< ELFT >::createFakeSections ( )

Used by llvm-objdump -d (which needs sections for disassembly) to disassemble objects without a section header table (e.g.

ET_CORE objects analyzed by linux perf or ET_EXEC with llvm-strip –strip-sections).

Definition at line 904 of file ELF.h.

References llvm::enumerate(), llvm::ELF::PF_X, program_headers(), llvm::ELF::PT_LOAD, llvm::ELF::SHF_ALLOC, llvm::ELF::SHF_EXECINSTR, and llvm::ELF::SHT_PROGBITS.

◆ crels()

template<class ELFT>
Expected< typename ELFFile< ELFT >::RelsOrRelas > ELFFile::crels ( const Elf_Shdr & Sec) const

◆ decode_relrs()

template<class ELFT>
std::vector< typename ELFT::Rel > ELFFile::decode_relrs ( Elf_Relr_Range relrs) const

Definition at line 338 of file ELF.cpp.

References relrs().

◆ decodeBBAddrMap()

template<class ELFT>
Expected< std::vector< BBAddrMap > > ELFFile::decodeBBAddrMap ( const Elf_Shdr & Sec,
const Elf_Shdr * RelaSec = nullptr,
std::vector< PGOAnalysisMap > * PGOAnalyses = nullptr ) const

Returns a vector of BBAddrMap structs corresponding to each function within the text section that the SHT_LLVM_BB_ADDR_MAP section Sec is associated with.

If the current ELFFile is relocatable, a corresponding RelaSec must be passed in as an argument. Optional out variable to collect all PGO Analyses. New elements are only added if no error occurs. If not provided, the PGO Analyses are decoded then ignored.

Definition at line 975 of file ELF.cpp.

References decodeBBAddrMapImpl().

Referenced by readBBAddrMapImpl().

◆ decodeCrel()

template<class ELFT>
Expected< typename ELFFile< ELFT >::RelsOrRelas > ELFFile::decodeCrel ( ArrayRef< uint8_t > Content) const

Definition at line 414 of file ELF.cpp.

References llvm::Count, llvm::object::decodeCrel(), and I.

◆ dynamicEntries()

◆ end()

template<class ELFT>
const uint8_t * llvm::object::ELFFile< ELFT >::end ( ) const
inline

Definition at line 272 of file ELF.h.

Referenced by dynamicEntries().

◆ getBufSize()

template<class ELFT>
size_t llvm::object::ELFFile< ELFT >::getBufSize ( ) const
inline

◆ getCrelHeader()

template<class ELFT>
Expected< uint64_t > ELFFile::getCrelHeader ( ArrayRef< uint8_t > Content) const

Definition at line 402 of file ELF.cpp.

References llvm::Data, isLE(), and llvm::Error::success().

◆ getDynamicTagAsString() [1/2]

template<class ELFT>
std::string ELFFile::getDynamicTagAsString ( uint64_t Type) const

Definition at line 606 of file ELF.cpp.

References getDynamicTagAsString(), and getHeader().

◆ getDynamicTagAsString() [2/2]

template<class ELFT>
std::string ELFFile::getDynamicTagAsString ( unsigned Arch,
uint64_t Type ) const

Definition at line 522 of file ELF.cpp.

Referenced by getDynamicTagAsString().

◆ getDynSymtabSize()

template<class ELFT>
Expected< uint64_t > llvm::object::ELFFile< ELFT >::getDynSymtabSize ( ) const

This function determines the number of dynamic symbols.

It reads section headers first. If section headers are not available, the number of symbols will be inferred by parsing dynamic hash tables.

Definition at line 830 of file ELF.h.

References llvm::StringRef::bytes_end(), llvm::createStringError(), dynamicEntries(), llvm::Expected< T >::get(), llvm::object::getDynSymtabSizeFromGnuHash(), llvm::object::parse_failed, sections, llvm::ELF::SHT_DYNSYM, llvm::Expected< T >::takeError(), and toMappedAddr().

Referenced by llvm::ifs::buildStub().

◆ getEntry() [1/2]

template<class ELFT>
template<typename T>
Expected< const T * > llvm::object::ELFFile< ELFT >::getEntry ( const Elf_Shdr & Section,
uint32_t Entry ) const

◆ getEntry() [2/2]

template<class ELFT>
template<typename T>
Expected< const T * > llvm::object::ELFFile< ELFT >::getEntry ( uint32_t Section,
uint32_t Entry ) const

Definition at line 983 of file ELF.h.

References getEntry(), and llvm::object::getSection().

Referenced by getEntry(), and getRelocationSymbol().

◆ getHeader()

◆ getLinkAsStrtab()

template<class ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getLinkAsStrtab ( const typename ELFT::Shdr & Sec) const

◆ getRelativeRelocationType()

template<class ELFT>
uint32_t llvm::object::ELFFile< ELFT >::getRelativeRelocationType ( ) const

Definition at line 718 of file ELF.h.

References llvm::object::getELFRelativeRelocationType(), and getHeader().

◆ getRelocationSymbol()

template<class ELFT>
Expected< const typename ELFT::Sym * > llvm::object::ELFFile< ELFT >::getRelocationSymbol ( const Elf_Rel & Rel,
const Elf_Shdr * SymTab ) const

Get the symbol for a given relocation.

Definition at line 761 of file ELF.h.

References getEntry(), and isMips64EL().

◆ getRelocationTypeName() [1/2]

template<class ELFT>
StringRef llvm::object::ELFFile< ELFT >::getRelocationTypeName ( uint32_t Type) const

Definition at line 682 of file ELF.h.

References llvm::object::getELFRelocationTypeName(), and getHeader().

Referenced by getRelocationTypeName().

◆ getRelocationTypeName() [2/2]

template<class ELFT>
void llvm::object::ELFFile< ELFT >::getRelocationTypeName ( uint32_t Type,
SmallVectorImpl< char > & Result ) const

Definition at line 687 of file ELF.h.

References getRelocationTypeName(), and isMipsELF64().

◆ getSection() [1/3]

template<class ELFT>
Expected< const typename ELFT::Shdr * > llvm::object::ELFFile< ELFT >::getSection ( const Elf_Sym & Sym,
const Elf_Shdr * SymTab,
DataRegion< Elf_Word > ShndxTable ) const

Definition at line 582 of file ELF.h.

References llvm::object::getSection(), and symbols().

Referenced by readBBAddrMapImpl().

◆ getSection() [2/3]

template<class ELFT>
Expected< const typename ELFT::Shdr * > llvm::object::ELFFile< ELFT >::getSection ( const Elf_Sym & Sym,
Elf_Sym_Range Symtab,
DataRegion< Elf_Word > ShndxTable ) const

Definition at line 592 of file ELF.h.

References llvm::object::getSection(), and getSectionIndex().

◆ getSection() [3/3]

template<class ELFT>
Expected< const typename ELFT::Shdr * > llvm::object::ELFFile< ELFT >::getSection ( uint32_t Index) const

Definition at line 1214 of file ELF.h.

References llvm::object::getSection(), and sections.

◆ getSectionAndRelocations()

template<class ELFT>
Expected< MapVector< const typename ELFT::Shdr *, const typename ELFT::Shdr * > > ELFFile::getSectionAndRelocations ( std::function< Expected< bool >(const Elf_Shdr &)> IsMatch) const

Returns a map from every section matching IsMatch to its relocation section, or nullptr if it has no relocation section.

This function returns an error if any of the IsMatch calls fail or if it fails to retrieve the content section of any relocation section.

Definition at line 988 of file ELF.cpp.

References llvm::cantFail(), llvm::object::createError(), llvm::object::describe(), llvm::object::getSection(), llvm::joinErrors(), sections, llvm::ELF::SHT_CREL, llvm::ELF::SHT_REL, llvm::ELF::SHT_RELA, llvm::Error::success(), llvm::Expected< T >::takeError(), llvm::toString(), and llvm::MapVector< KeyT, ValueT, MapType, VectorType >::try_emplace().

Referenced by readBBAddrMapImpl().

◆ getSectionContents()

template<class ELFT>
Expected< ArrayRef< uint8_t > > llvm::object::ELFFile< ELFT >::getSectionContents ( const Elf_Shdr & Sec) const

◆ getSectionContentsAsArray()

◆ getSectionIndex()

template<class ELFT>
Expected< uint32_t > llvm::object::ELFFile< ELFT >::getSectionIndex ( const Elf_Sym & Sym,
Elf_Sym_Range Syms,
DataRegion< Elf_Word > ShndxTable ) const

◆ getSectionName() [1/2]

template<class ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getSectionName ( const Elf_Shdr & Section,
StringRef DotShstrtab ) const

◆ getSectionName() [2/2]

template<class ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getSectionName ( const Elf_Shdr & Section,
WarningHandler WarnHandler = &defaultWarningHandler ) const

Definition at line 1328 of file ELF.h.

References llvm::dwarf_linker::getSectionName(), getSectionStringTable(), and sections.

Referenced by decodeBBAddrMapImpl().

◆ getSectionStringTable()

template<class ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getSectionStringTable ( Elf_Shdr_Range Sections,
WarningHandler WarnHandler = &defaultWarningHandler ) const

Definition at line 771 of file ELF.h.

References llvm::object::createError(), getHeader(), getStringTable(), and llvm::ELF::SHN_XINDEX.

Referenced by getSectionName().

◆ getSegmentContents()

template<class ELFT>
Expected< ArrayRef< uint8_t > > llvm::object::ELFFile< ELFT >::getSegmentContents ( const Elf_Phdr & Phdr) const

◆ getSHNDXTable() [1/2]

template<class ELFT>
Expected< ArrayRef< typename ELFT::Word > > llvm::object::ELFFile< ELFT >::getSHNDXTable ( const Elf_Shdr & Section) const

Definition at line 1249 of file ELF.h.

References getSHNDXTable(), and sections.

Referenced by getSHNDXTable().

◆ getSHNDXTable() [2/2]

template<class ELFT>
Expected< ArrayRef< typename ELFT::Word > > llvm::object::ELFFile< ELFT >::getSHNDXTable ( const Elf_Shdr & Section,
Elf_Shdr_Range Sections ) const

◆ getStringTable()

◆ getStringTableForSymtab() [1/2]

template<class ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getStringTableForSymtab ( const Elf_Shdr & Section) const

Definition at line 1287 of file ELF.h.

References getStringTableForSymtab(), and sections.

Referenced by getStringTableForSymtab().

◆ getStringTableForSymtab() [2/2]

template<class ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getStringTableForSymtab ( const Elf_Shdr & Section,
Elf_Shdr_Range Sections ) const

◆ getSymbol()

template<class ELFT>
Expected< const typename ELFT::Sym * > llvm::object::ELFFile< ELFT >::getSymbol ( const Elf_Shdr * Sec,
uint32_t Index ) const

◆ getSymbolVersionByIndex()

template<typename ELFT>
Expected< StringRef > llvm::object::ELFFile< ELFT >::getSymbolVersionByIndex ( uint32_t SymbolVersionIndex,
bool & IsDefault,
SmallVector< std::optional< VersionEntry >, 0 > & VersionMap,
std::optional< bool > IsSymHidden ) const

◆ getVersionDefinitions()

◆ getVersionDependencies()

◆ isLE()

template<class ELFT>
bool llvm::object::ELFFile< ELFT >::isLE ( ) const
inline

◆ isMips64EL()

template<class ELFT>
bool llvm::object::ELFFile< ELFT >::isMips64EL ( ) const
inline

Definition at line 343 of file ELF.h.

◆ isMipsELF64()

template<class ELFT>
bool llvm::object::ELFFile< ELFT >::isMipsELF64 ( ) const
inline

Definition at line 338 of file ELF.h.

Referenced by getRelocationTypeName(), and llvm::object::ELFFile< ELF32LE >::isMips64EL().

◆ loadVersionMap()

◆ notes() [1/2]

template<class ELFT>
iterator_range< Elf_Note_Iterator > llvm::object::ELFFile< ELFT >::notes ( const Elf_Phdr & Phdr,
Error & Err ) const
inline

Get an iterator range over notes of a program header.

The program header must be of type PT_NOTE.

Parameters
Phdrthe program header to iterate over.
Err[out] an error to support fallible iteration, which should be checked after iteration ends.

Definition at line 467 of file ELF.h.

Referenced by llvm::offloading::amdgpu::getAMDGPUMetaDataFromImage().

◆ notes() [2/2]

template<class ELFT>
iterator_range< Elf_Note_Iterator > llvm::object::ELFFile< ELFT >::notes ( const Elf_Shdr & Shdr,
Error & Err ) const
inline

Get an iterator range over notes of a section.

The section must be of type SHT_NOTE.

Parameters
Shdrthe section to iterate over.
Err[out] an error to support fallible iteration, which should be checked after iteration ends.

Definition at line 479 of file ELF.h.

◆ notes_begin() [1/2]

template<class ELFT>
Elf_Note_Iterator llvm::object::ELFFile< ELFT >::notes_begin ( const Elf_Phdr & Phdr,
Error & Err ) const
inline

Get an iterator over notes in a program header.

The program header must be of type PT_NOTE.

Parameters
Phdrthe program header to iterate over.
Err[out] an error to support fallible iteration, which should be checked after iteration ends.

Definition at line 407 of file ELF.h.

Referenced by llvm::object::ELFFile< ELF32LE >::notes(), and llvm::object::ELFFile< ELF32LE >::notes().

◆ notes_begin() [2/2]

template<class ELFT>
Elf_Note_Iterator llvm::object::ELFFile< ELFT >::notes_begin ( const Elf_Shdr & Shdr,
Error & Err ) const
inline

Get an iterator over notes in a section.

The section must be of type SHT_NOTE.

Parameters
Shdrthe section to iterate over.
Err[out] an error to support fallible iteration, which should be checked after iteration ends.

Definition at line 435 of file ELF.h.

◆ notes_end()

template<class ELFT>
Elf_Note_Iterator llvm::object::ELFFile< ELFT >::notes_end ( ) const
inline

Get the end iterator for notes.

Definition at line 456 of file ELF.h.

Referenced by llvm::object::ELFFile< ELF32LE >::notes(), and llvm::object::ELFFile< ELF32LE >::notes().

◆ operator=()

template<class ELFT>
ELFFile & llvm::object::ELFFile< ELFT >::operator= ( const ELFFile< ELFT > & )
default

◆ program_headers()

template<class ELFT>
Expected< Elf_Phdr_Range > llvm::object::ELFFile< ELFT >::program_headers ( ) const
inline

Iterate over program header table.

Definition at line 381 of file ELF.h.

Referenced by createFakeSections(), dynamicEntries(), llvm::object::getPhdrIndexForError(), and toMappedAddr().

◆ relas()

template<class ELFT>
Expected< Elf_Rela_Range > llvm::object::ELFFile< ELFT >::relas ( const Elf_Shdr & Sec) const
inline

Definition at line 359 of file ELF.h.

Referenced by decodeBBAddrMapImpl().

◆ relrs()

template<class ELFT>
Expected< Elf_Relr_Range > llvm::object::ELFFile< ELFT >::relrs ( const Elf_Shdr & Sec) const
inline

Definition at line 367 of file ELF.h.

Referenced by decode_relrs().

◆ rels()

template<class ELFT>
Expected< Elf_Rel_Range > llvm::object::ELFFile< ELFT >::rels ( const Elf_Shdr & Sec) const
inline

Definition at line 363 of file ELF.h.

◆ sections()

◆ symbols()

template<class ELFT>
Expected< Elf_Sym_Range > llvm::object::ELFFile< ELFT >::symbols ( const Elf_Shdr * Sec) const
inline

Definition at line 353 of file ELF.h.

Referenced by getSection(), and getSymbol().

◆ toMappedAddr()


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