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.

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

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

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	getFuncName (uint64_t FuncMD5Hash)
	Return function's PGO name from the name's md5 hash value.

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.

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

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

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

Member Typedef Documentation

◆ AddrHashMap

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

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

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

Referenced by create(), llvm::readPGOFuncNameStrings(), 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 577 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 384 of file InstrProf.cpp.

References addFuncName(), E, F, llvm::GlobalValue::getGUID(), 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 448 of file CoverageMappingReader.cpp.

References llvm::Address, llvm::Data, 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 566 of file InstrProf.h.

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

◆ create() [5/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 572 of file InstrProf.h.

References llvm::readPGOFuncNameStrings().

◆ dumpNames()

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

inline

Dump the symbols in this table.

Definition at line 560 of file InstrProf.h.

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

◆ getFuncName() [1/2]

StringRef llvm::InstrProfSymtab::getFuncName ( uint64_t FuncMD5Hash )

inline

Return function's PGO name from the name's md5 hash value.

If not found, return an empty string.

Definition at line 604 of file InstrProf.h.

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

◆ getFuncName() [2/2]

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 464 of file CoverageMappingReader.cpp.

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

Referenced by llvm::coverage::CovMapFunctionRecordV1< IntPtrT >::getFuncName(), getFuncNameOrExternalSymbol(), llvm::coverage::accessors::getFuncNameViaRef(), and getOrigFuncName().

◆ getFuncNameOrExternalSymbol()

StringRef llvm::InstrProfSymtab::getFuncNameOrExternalSymbol ( uint64_t FuncMD5Hash )

inline

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

All such cases will be represented using the same StringRef value.

Definition at line 597 of file InstrProf.h.

References llvm::StringRef::empty(), and getFuncName().

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 614 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 425 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 557 of file InstrProf.h.

References llvm::Data.

◆ getOrigFuncName()

StringRef llvm::InstrProfSymtab::getOrigFuncName ( uint64_t FuncMD5Hash )

inline

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

For global functions, it returns the same string as getFuncName.

Definition at line 626 of file InstrProf.h.

References llvm::StringRef::drop_front(), llvm::StringRef::find_first_of(), getFuncName(), and llvm::StringRef::npos.

◆ isExternalSymbol()

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

inlinestatic

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

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

References Addr.

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

include/llvm/ProfileData/InstrProf.h
lib/ProfileData/Coverage/CoverageMappingReader.cpp
lib/ProfileData/InstrProf.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ AddrHashMap

Constructor & Destructor Documentation

◆ InstrProfSymtab()

Member Function Documentation

◆ addFuncName()

◆ create() [1/5]

◆ create() [2/5]

◆ create() [3/5]

◆ create() [4/5]

◆ create() [5/5]

◆ dumpNames()

◆ getFuncName() [1/2]

◆ getFuncName() [2/2]

◆ getFuncNameOrExternalSymbol()

◆ getFunction()

◆ getFunctionHashFromAddress()

◆ getNameData()

◆ getOrigFuncName()

◆ isExternalSymbol()

◆ mapAddress()