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 ()

	InstrProfSymtab (const InstrProfSymtab &)=delete

InstrProfSymtab &	operator= (const InstrProfSymtab &)=delete

	InstrProfSymtab (InstrProfSymtab &&)=delete

InstrProfSymtab &	operator= (InstrProfSymtab &&)=delete

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 FuncNameStrings, StringRef VTableNameStrings)
	Initialize symtab states with function names and vtable names.

Error	initVTableNamesFromCompressedStrings (StringRef CompressedVTableNames)
	Initialize 'this' with the set of vtable names encoded in `CompressedVTableNames`.

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

Error	create (Module &M, bool InLTO=false, bool AddCanonical=true)
	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`.

template<typename FuncNameIterRange , typename VTableNameIterRange >
Error	create (const FuncNameIterRange &FuncIterRange, const VTableNameIterRange &VTableIterRange)
	Create InstrProfSymtab from a set of function names and vtable names iteratable from `IterRange`.

Error	addSymbolName (StringRef SymbolName)

Error	addFuncName (StringRef FuncName)
	The method name is kept since there are many callers.

Error	addVTableName (StringRef VTableName)
	Adds VTableName as a known symbol, and inserts it to a map that tracks all vtable names.

const StringSet &	getVTableNames () const

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

void	mapVTableAddress (uint64_t StartAddr, uint64_t EndAddr, uint64_t MD5Val)
	Map the address range (i.e., [start_address, end_address)) of a variable to its names' MD5 hash.

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

uint64_t	getVTableHashFromAddress (uint64_t Address)
	Return a vtable's hash, or 0 if the vtable doesn't exist 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.

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

GlobalVariable *	getGlobalVariable (uint64_t MD5Hash)
	Return the global variable corresponding to md5 hash.

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

Member Typedef Documentation

◆ AddrHashMap

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

Definition at line 462 of file InstrProf.h.

Constructor & Destructor Documentation

◆ InstrProfSymtab() [1/3]

llvm::InstrProfSymtab::InstrProfSymtab ( )

inline

Definition at line 526 of file InstrProf.h.

◆ InstrProfSymtab() [2/3]

llvm::InstrProfSymtab::InstrProfSymtab ( const InstrProfSymtab & )

delete

◆ InstrProfSymtab() [3/3]

llvm::InstrProfSymtab::InstrProfSymtab ( InstrProfSymtab && )

delete

Member Function Documentation

◆ addFuncName()

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

inline

The method name is kept since there are many callers.

It just forwards to 'addSymbolName'.

Definition at line 601 of file InstrProf.h.

References addSymbolName().

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

◆ addSymbolName()

Error llvm::InstrProfSymtab::addSymbolName ( StringRef SymbolName )

inline

Definition at line 583 of file InstrProf.h.

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

Referenced by addFuncName(), and addVTableName().

◆ addVTableName()

Error llvm::InstrProfSymtab::addVTableName ( StringRef VTableName )

inline

Adds VTableName as a known symbol, and inserts it to a map that tracks all vtable names.

Definition at line 605 of file InstrProf.h.

References addSymbolName(), E, llvm::StringSet< AllocatorTy >::insert(), and llvm::Error::success().

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

◆ create() [1/7]

template<typename FuncNameIterRange , typename VTableNameIterRange >

Error llvm::InstrProfSymtab::create	(	const FuncNameIterRange &	FuncIterRange,
		const VTableNameIterRange &	VTableIterRange
	)

Create InstrProfSymtab from a set of function names and vtable names iteratable from IterRange.

This interface is used by IndexedProfReader.

Definition at line 686 of file InstrProf.h.

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

◆ create() [2/7]

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

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

◆ create() [3/7]

Error llvm::InstrProfSymtab::create	(	Module &	M,
		bool	InLTO = `false`,
		bool	AddCanonical = `true`
	)

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. A canonical name, removing non-__uniq suffixes, is added if AddCanonical is true.

Definition at line 486 of file InstrProf.cpp.

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

◆ create() [4/7]

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

References llvm::Address, llvm::Data, shouldSkipSectionFirstByte(), llvm::Error::success(), and llvm::Expected< T >::takeError().

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

◆ create() [5/7]

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

inline

This interface is used by reader of CoverageMapping test format.

Definition at line 669 of file InstrProf.h.

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

◆ create() [6/7]

Error llvm::InstrProfSymtab::create	(	StringRef	FuncNameStrings,
		StringRef	VTableNameStrings
	)

Initialize symtab states with function names and vtable names.

FuncNameStrings is a string composed of one or more encoded function name strings, and VTableNameStrings composes of one or more encoded vtable names. This interface is solely used by raw profile reader.

Definition at line 588 of file InstrProf.cpp.

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

◆ create() [7/7]

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 readAndDecodeStrings method.

Definition at line 582 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 674 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 522 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 720 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 713 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 730 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 660 of file InstrProf.cpp.

References A, Address, and llvm::partition_point().

◆ getGlobalVariable()

GlobalVariable * llvm::InstrProfSymtab::getGlobalVariable ( uint64_t MD5Hash )

inline

Return the global variable corresponding to md5 hash.

Return nullptr if not found.

Definition at line 740 of file InstrProf.h.

References llvm::sampleprof::MD5Hash().

◆ getNameData()

StringRef llvm::InstrProfSymtab::getNameData ( ) const

inline

Return the name section data.

Definition at line 663 of file InstrProf.h.

◆ getVTableHashFromAddress()

uint64_t llvm::InstrProfSymtab::getVTableHashFromAddress ( uint64_t Address )

Return a vtable's hash, or 0 if the vtable doesn't exist in this SymTab.

Definition at line 654 of file InstrProf.cpp.

References Address, and llvm::IntervalMap< KeyT, ValT, N, Traits >::lookup().

◆ getVTableNames()

const StringSet & llvm::InstrProfSymtab::getVTableNames ( ) const

inline

Definition at line 615 of file InstrProf.h.

◆ initVTableNamesFromCompressedStrings()

Error llvm::InstrProfSymtab::initVTableNamesFromCompressedStrings ( StringRef CompressedVTableNames )

Initialize 'this' with the set of vtable names encoded in CompressedVTableNames.

Definition at line 600 of file InstrProf.cpp.

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

◆ isExternalSymbol()

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

inlinestatic

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

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

References Addr.

◆ mapVTableAddress()

void llvm::InstrProfSymtab::mapVTableAddress	(	uint64_t	StartAddr,
		uint64_t	EndAddr,
		uint64_t	MD5Val
	)

inline

Map the address range (i.e., [start_address, end_address)) of a variable to its names' MD5 hash.

This interface is only used by the raw profile reader.

Definition at line 626 of file InstrProf.h.

References llvm::IntervalMap< KeyT, ValT, N, Traits >::insert().

◆ operator=() [1/2]

InstrProfSymtab & llvm::InstrProfSymtab::operator= ( const InstrProfSymtab & )

delete

◆ operator=() [2/2]

InstrProfSymtab & llvm::InstrProfSymtab::operator= ( InstrProfSymtab && )

delete

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() [1/3]

◆ InstrProfSymtab() [2/3]

◆ InstrProfSymtab() [3/3]

Member Function Documentation

◆ addFuncName()

◆ addSymbolName()

◆ addVTableName()

◆ create() [1/7]

◆ create() [2/7]

◆ create() [3/7]

◆ create() [4/7]

◆ create() [5/7]

◆ create() [6/7]

◆ create() [7/7]

◆ dumpNames()

◆ getFuncName()

◆ getFuncOrVarName()

◆ getFuncOrVarNameIfDefined()

◆ getFunction()

◆ getFunctionHashFromAddress()

◆ getGlobalVariable()

◆ getNameData()

◆ getVTableHashFromAddress()

◆ getVTableNames()

◆ initVTableNamesFromCompressedStrings()

◆ isExternalSymbol()

◆ mapAddress()

◆ mapVTableAddress()

◆ operator=() [1/2]

◆ operator=() [2/2]