LLVM 19.0.0git
Public Types | Public Member Functions | Static Public Member Functions | List of all members
llvm::InstrProfSymtab Class Reference

A symbol table used for function [IR]PGO name look-up with keys (such as pointers, md5hash values) to the function. More...

#include "llvm/ProfileData/InstrProf.h"

Public Types

using AddrHashMap = std::vector< std::pair< uint64_t, uint64_t > >
 

Public Member Functions

 InstrProfSymtab ()=default
 
Error create (object::SectionRef &Section)
 Create InstrProfSymtab from an object file section which contains function PGO names.
 
Error create (StringRef NameStrings)
 NameStrings is a string composed of one of more sub-strings encoded in the format described in collectPGOFuncNameStrings.
 
Error create (StringRef D, uint64_t BaseAddr)
 This interface is used by reader of CoverageMapping test format.
 
Error create (Module &M, bool InLTO=false)
 A wrapper interface to populate the PGO symtab with functions decls from module M.
 
template<typename NameIterRange >
Error create (const NameIterRange &IterRange)
 Create InstrProfSymtab from a set of names iteratable from IterRange.
 
Error addFuncName (StringRef FuncName)
 Update the symtab by adding FuncName to the table.
 
void mapAddress (uint64_t Addr, uint64_t MD5Val)
 Map a function address to its name's MD5 hash.
 
uint64_t getFunctionHashFromAddress (uint64_t Address)
 Return a function's hash, or 0, if the function isn't in this SymTab.
 
StringRef getFuncName (uint64_t FuncNameAddress, size_t NameSize)
 Return function's PGO name from the function name's symbol address in the object file.
 
StringRef getFuncOrVarName (uint64_t ValMD5Hash)
 Return name of functions or global variables from the name's md5 hash value.
 
StringRef getFuncOrVarNameIfDefined (uint64_t ValMD5Hash)
 Just like getFuncOrVarName, except that it will return literal string 'External Symbol' if the function or global variable is external to this symbol table.
 
FunctiongetFunction (uint64_t FuncMD5Hash)
 Return function from the name's md5 hash. Return nullptr if not found.
 
StringRef getNameData () const
 Return the name section data.
 
void dumpNames (raw_ostream &OS) const
 Dump the symbols in this table.
 

Static Public Member Functions

static bool isExternalSymbol (const StringRef &Symbol)
 True if Symbol is the value used to represent external symbols.
 

Detailed Description

A symbol table used for function [IR]PGO name look-up with keys (such as pointers, md5hash values) to the function.

A function's [IR]PGO name or name's md5hash are used in retrieving the profile data of the function. See getIRPGOFuncName() and getPGOFuncName methods for details how [IR]PGO name is formed.

Definition at line 429 of file InstrProf.h.

Member Typedef Documentation

◆ AddrHashMap

using llvm::InstrProfSymtab::AddrHashMap = std::vector<std::pair<uint64_t, uint64_t> >

Definition at line 431 of file InstrProf.h.

Constructor & Destructor Documentation

◆ InstrProfSymtab()

llvm::InstrProfSymtab::InstrProfSymtab ( )
default

Member Function Documentation

◆ addFuncName()

Error llvm::InstrProfSymtab::addFuncName ( StringRef  FuncName)
inline

Update the symtab by adding FuncName to the table.

This interface is used by the raw and text profile readers.

Definition at line 503 of file InstrProf.h.

References llvm::IndexedInstrProf::ComputeHash(), llvm::StringRef::empty(), llvm::StringSet< AllocatorTy >::insert(), llvm::malformed, and llvm::Error::success().

Referenced by create(), and llvm::InstrProfWriter::writeText().

◆ create() [1/5]

template<typename NameIterRange >
Error llvm::InstrProfSymtab::create ( const NameIterRange &  IterRange)

Create InstrProfSymtab from a set of names iteratable from IterRange.

This interface is used by IndexedProfReader.

Definition at line 561 of file InstrProf.h.

References addFuncName(), E, Name, and llvm::Error::success().

◆ create() [2/5]

Error llvm::InstrProfSymtab::create ( Module M,
bool  InLTO = false 
)

A wrapper interface to populate the PGO symtab with functions decls from module M.

This interface is used by transformation passes such as indirect function call promotion. Variable InLTO indicates if this is called from LTO optimization passes.

Definition at line 450 of file InstrProf.cpp.

References E, F, llvm::getIRPGOFuncName(), llvm::getPGOFuncName(), and llvm::Error::success().

◆ create() [3/5]

Error InstrProfSymtab::create ( object::SectionRef Section)

Create InstrProfSymtab from an object file section which contains function PGO names.

When section may contain raw string data or string data in compressed form. This method only initialize the symtab with reference to the data and the section base address. The decompression will be delayed until before it is used. See also create(StringRef) method.

Definition at line 495 of file CoverageMappingReader.cpp.

References llvm::Address, llvm::Triple::COFF, llvm::Data, llvm::getInstrProfSectionName(), llvm::object::ObjectFile::isRelocatableObject(), llvm::Error::success(), and llvm::Expected< T >::takeError().

Referenced by loadBinaryFormat(), loadTestingFormat(), llvm::InstrProfReaderIndex< HashTableImpl >::populateSymtab(), promoteIndirectCalls(), and runCGProfilePass().

◆ create() [4/5]

Error llvm::InstrProfSymtab::create ( StringRef  D,
uint64_t  BaseAddr 
)
inline

This interface is used by reader of CoverageMapping test format.

Definition at line 554 of file InstrProf.h.

References D, and llvm::Error::success().

◆ create() [5/5]

Error llvm::InstrProfSymtab::create ( StringRef  NameStrings)

NameStrings is a string composed of one of more sub-strings encoded in the format described in collectPGOFuncNameStrings.

This method is a wrapper to readPGOFuncNameStrings method.

Definition at line 514 of file InstrProf.cpp.

References addFuncName(), and llvm::readAndDecodeStrings().

◆ dumpNames()

void llvm::InstrProfSymtab::dumpNames ( raw_ostream OS) const

Dump the symbols in this table.

Definition at line 577 of file InstrProf.cpp.

References llvm::StringMap< ValueTy, AllocatorTy >::keys(), OS, and llvm::sort().

◆ getFuncName()

StringRef InstrProfSymtab::getFuncName ( uint64_t  FuncNameAddress,
size_t  NameSize 
)

Return function's PGO name from the function name's symbol address in the object file.

If an error occurs, return an empty string.

Definition at line 515 of file CoverageMappingReader.cpp.

References llvm::Address, llvm::Data, llvm::Offset, and Size.

Referenced by llvm::coverage::CovMapFunctionRecordV1< IntPtrT >::getFuncName().

◆ getFuncOrVarName()

StringRef llvm::InstrProfSymtab::getFuncOrVarName ( uint64_t  ValMD5Hash)
inline

Return name of functions or global variables from the name's md5 hash value.

If not found, return an empty string.

Definition at line 588 of file InstrProf.h.

References LHS, llvm::lower_bound(), llvm::sampleprof::MD5Hash(), and RHS.

Referenced by llvm::coverage::accessors::getFuncNameViaRef(), getFuncOrVarNameIfDefined(), and llvm::InstrProfWriter::writeTextTemporalProfTraceData().

◆ getFuncOrVarNameIfDefined()

StringRef llvm::InstrProfSymtab::getFuncOrVarNameIfDefined ( uint64_t  ValMD5Hash)
inline

Just like getFuncOrVarName, except that it will return literal string 'External Symbol' if the function or global variable is external to this symbol table.

Definition at line 581 of file InstrProf.h.

References llvm::StringRef::empty(), getFuncOrVarName(), and llvm::sampleprof::MD5Hash().

Referenced by llvm::InstrProfWriter::writeRecordInText().

◆ getFunction()

Function * llvm::InstrProfSymtab::getFunction ( uint64_t  FuncMD5Hash)
inline

Return function from the name's md5 hash. Return nullptr if not found.

Definition at line 598 of file InstrProf.h.

References LHS, llvm::lower_bound(), and RHS.

Referenced by runCGProfilePass().

◆ getFunctionHashFromAddress()

uint64_t llvm::InstrProfSymtab::getFunctionHashFromAddress ( uint64_t  Address)

Return a function's hash, or 0, if the function isn't in this SymTab.

Definition at line 563 of file InstrProf.cpp.

References A, and llvm::partition_point().

◆ getNameData()

StringRef llvm::InstrProfSymtab::getNameData ( ) const
inline

Return the name section data.

Definition at line 548 of file InstrProf.h.

◆ isExternalSymbol()

static bool llvm::InstrProfSymtab::isExternalSymbol ( const StringRef Symbol)
inlinestatic

True if Symbol is the value used to represent external symbols.

Definition at line 540 of file InstrProf.h.

◆ mapAddress()

void llvm::InstrProfSymtab::mapAddress ( uint64_t  Addr,
uint64_t  MD5Val 
)
inline

Map a function address to its name's MD5 hash.

This interface is only used by the raw profiler reader.

Definition at line 518 of file InstrProf.h.

References Addr.


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