A symbol table used for function 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. More...

Error	create (StringRef D, uint64_t BaseAddr)
	This interface is used by reader of CoverageMapping test format. More...

Error	create (StringRef NameStrings)
	`NameStrings` is a string composed of one of more sub-strings encoded in the format described in `collectPGOFuncNameStrings`. More...

Error	create (Module &M, bool InLTO=false)
	A wrapper interface to populate the PGO symtab with functions decls from module `M`. More...

template<typename NameIterRange >
Error	create (const NameIterRange &IterRange)
	Create InstrProfSymtab from a set of names iteratable from `IterRange`. More...

Error	addFuncName (StringRef FuncName)
	Update the symtab by adding `FuncName` to the table. More...

void	mapAddress (uint64_t Addr, uint64_t MD5Val)
	Map a function address to its name's MD5 hash. More...

uint64_t	getFunctionHashFromAddress (uint64_t Address)
	Return a function's hash, or 0, if the function isn't in this SymTab. More...

StringRef	getFuncName (uint64_t FuncNameAddress, size_t NameSize)
	Return function's PGO name from the function name's symbol address in the object file. More...

StringRef	getFuncName (uint64_t FuncMD5Hash)
	Return function's PGO name from the name's md5 hash value. More...

StringRef	getFuncNameOrExternalSymbol (uint64_t FuncMD5Hash)
	Just like getFuncName, except that it will return a non-empty StringRef if the function is external to this symbol table. More...

Function *	getFunction (uint64_t FuncMD5Hash)
	Return function from the name's md5 hash. Return nullptr if not found. More...

StringRef	getOrigFuncName (uint64_t FuncMD5Hash)
	Return the function's original assembly name by stripping off the prefix attached (to symbols with priviate linkage). More...

StringRef	getNameData () const
	Return the name section data. More...

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

Detailed Description

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

A function's PGO name or name's md5hash are used in retrieving the profile data of the function. See getPGOFuncName() method for details on how PGO name is formed.

Definition at line 411 of file InstrProf.h.

Member Typedef Documentation

◆ AddrHashMap

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

Definition at line 413 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 472 of file InstrProf.h.

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

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

◆ create() [1/5]

Error llvm::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.

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

◆ create() [2/5]

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

inline

This interface is used by reader of CoverageMapping test format.

Definition at line 524 of file InstrProf.h.

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

◆ create() [3/5]

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

inline

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 530 of file InstrProf.h.

References llvm::readPGOFuncNameStrings().

◆ create() [4/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 336 of file InstrProf.cpp.

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