InstrProf.cpp File Reference (original) (raw)

Go to the source code of this file.

Namespaces
namespace	llvm
	This is an optimization pass for GlobalISel generic memory operations.

namespace	llvm::IndexedInstrProf

Macros
#define	DEBUG_TYPE "instrprof"

#define	INSTR_PROF_SECT_ENTRY(Kind, SectNameCommon, SectNameCoff, Prefix) SectNameCommon,

#define	INSTR_PROF_SECT_ENTRY(Kind, SectNameCommon, SectNameCoff, Prefix) SectNameCoff,

#define	INSTR_PROF_SECT_ENTRY(Kind, SectNameCommon, SectNameCoff, Prefix) Prefix,

#define	INSTR_PROF_COMMON_API_IMPL

Functions
static std::string	getInstrProfErrString (instrprof_error Err, const std::string &ErrMsg="")

cl::opt< bool >	llvm::DoInstrProfNameCompression ("enable-name-compression", cl::desc("Enable name/filename string compression"), cl::init(true))

std::string	llvm::getInstrProfSectionName (InstrProfSectKind IPSK, Triple::ObjectFormatType OF, bool AddSegmentInfo=true)
	Return the name of the profile section corresponding to IPSK.

std::string	llvm::getPGOFuncName (StringRef RawFuncName, GlobalValue::LinkageTypes Linkage, StringRef FileName, uint64_t Version=INSTR_PROF_INDEX_VERSION)
	Return the modified name for a function suitable to be used the key for profile lookup.

static StringRef	llvm::stripDirPrefix (StringRef PathNameStr, uint32_t NumPrefix)

static StringRef	llvm::getStrippedSourceFileName (const GlobalObject &GO)

static std::string	llvm::getIRPGONameForGlobalObject (const GlobalObject &GO, GlobalValue::LinkageTypes Linkage, StringRef FileName)

static std::optional< std::string >	llvm::lookupPGONameFromMetadata (MDNode *MD)

static std::string	llvm::getIRPGOObjectName (const GlobalObject &GO, bool InLTO, MDNode *PGONameMetadata)

std::string	llvm::getIRPGOFuncName (const Function &F, bool InLTO=false)

std::string	llvm::getPGOFuncName (const Function &F, bool InLTO=false, uint64_t Version=INSTR_PROF_INDEX_VERSION)
	Please use getIRPGOFuncName for LLVM IR instrumentation.

std::string	llvm::getPGOName (const GlobalVariable &V, bool InLTO=false)

std::pair< StringRef, StringRef >	llvm::getParsedIRPGOName (StringRef IRPGOName)

StringRef	llvm::getFuncNameWithoutPrefix (StringRef PGOFuncName, StringRef FileName="")
	Given a PGO function name, remove the filename prefix and return the original (static) function name.

std::string	llvm::getPGOFuncNameVarName (StringRef FuncName, GlobalValue::LinkageTypes Linkage)
	Return the name of the global variable used to store a function name in PGO instrumentation.

bool	llvm::isGPUProfTarget (const Module &M)
	Determines whether module targets a GPU eligable for PGO instrumentation.

void	llvm::setPGOFuncVisibility (Module &M, GlobalVariable *FuncNameVar)

GlobalVariable *	llvm::createPGOFuncNameVar (Module &M, GlobalValue::LinkageTypes Linkage, StringRef PGOFuncName)
	Create and return the global variable for function name used in PGO instrumentation.

GlobalVariable *	llvm::createPGOFuncNameVar (Function &F, StringRef PGOFuncName)
	Create and return the global variable for function name used in PGO instrumentation.

static Error	llvm::readAndDecodeStrings (StringRef NameStrings, std::function< Error(StringRef)> NameCallback)
	NameStrings is a string composed of one of more possibly encoded sub-strings.

Error	llvm::collectGlobalObjectNameStrings (ArrayRef< std::string > NameStrs, bool doCompression, std::string &Result)
	Given a vector of strings (names of global objects like functions or, virtual tables) NameStrs, the method generates a combined string Result that is ready to be serialized.

StringRef	llvm::getPGOFuncNameVarInitializer (GlobalVariable *NameVar)
	Return the initializer in string of the PGO name var NameVar.

Error	llvm::collectPGOFuncNameStrings (ArrayRef< GlobalVariable * > NameVars, std::string &Result, bool doCompression=true)
	Produce Result string with the same format described above.

Error	llvm::collectVTableStrings (ArrayRef< GlobalVariable * > VTables, std::string &Result, bool doCompression)

uint32_t	llvm::getNumValueKindsInstrProf (const void *Record)
	ValueProfRecordClosure Interface implementation for InstrProfRecord class.

uint32_t	llvm::getNumValueSitesInstrProf (const void *Record, uint32_t VKind)

uint32_t	llvm::getNumValueDataInstrProf (const void *Record, uint32_t VKind)

uint32_t	llvm::getNumValueDataForSiteInstrProf (const void *R, uint32_t VK, uint32_t S)

void	llvm::getValueForSiteInstrProf (const void R, InstrProfValueData Dst, uint32_t K, uint32_t S)

ValueProfData *	llvm::allocValueProfDataInstrProf (size_t TotalSizeInBytes)

static std::unique_ptr< ValueProfData >	llvm::allocValueProfData (uint32_t TotalSize)

void	llvm::annotateValueSite (Module &M, Instruction &Inst, const InstrProfRecord &InstrProfR, InstrProfValueKind ValueKind, uint32_t SiteIndx, uint32_t MaxMDCount=3)
	Get the value profile data for value site SiteIdx from InstrProfR and annotate the instruction Inst with the value profile meta data.

void	llvm::annotateValueSite (Module &M, Instruction &Inst, ArrayRef< InstrProfValueData > VDs, uint64_t Sum, InstrProfValueKind ValueKind, uint32_t MaxMDCount)
	Same as the above interface but using an ArrayRef, as well as Sum.

MDNode *	llvm::mayHaveValueProfileOfKind (const Instruction &Inst, InstrProfValueKind ValueKind)

SmallVector< InstrProfValueData, 4 >	llvm::getValueProfDataFromInst (const Instruction &Inst, InstrProfValueKind ValueKind, uint32_t MaxNumValueData, uint64_t &TotalC, bool GetNoICPValue=false)
	Extract the value profile data from Inst and returns them if Inst is annotated with value profile data.

MDNode *	llvm::getPGOFuncNameMetadata (const Function &F)
	Return the PGOFuncName meta data associated with a function.

static void	llvm::createPGONameMetadata (GlobalObject &GO, StringRef MetadataName, StringRef PGOName)

void	llvm::createPGOFuncNameMetadata (Function &F, StringRef PGOFuncName)
	Create the PGOFuncName meta data if PGOFuncName is different from function's raw name.

void	llvm::createPGONameMetadata (GlobalObject &GO, StringRef PGOName)
	Create the PGOName metadata if a global object's PGO name is different from its mangled name.

bool	llvm::needsComdatForCounter (const GlobalObject &GV, const Module &M)
	Check if we can use Comdat for profile variables.

bool	llvm::isIRPGOFlagSet (const Module *M)
	Check if INSTR_PROF_RAW_VERSION_VAR is defined.

bool	llvm::canRenameComdatFunc (const Function &F, bool CheckAddressTaken=false)
	Check if we can safely rename this Comdat function.

void	llvm::createProfileFileNameVar (Module &M, StringRef InstrProfileOutput)

Variables
static cl::opt< bool >	StaticFuncFullModulePrefix ("static-func-full-module-prefix", cl::init(true), cl::Hidden, cl::desc("Use full module build paths in the profile counter names for " "static functions."))

static cl::opt< unsigned >	StaticFuncStripDirNamePrefix ("static-func-strip-dirname-prefix", cl::init(0), cl::Hidden, cl::desc("Strip specified level of directory name from source path in " "the profile counter name for static functions."))

cl::opt< bool >	llvm::EnableVTableValueProfiling ("enable-vtable-value-profiling", cl::init(false), cl::desc("If true, the virtual table address will be instrumented to know " "the types of a C++ pointer. The information is used in indirect " "call promotion to do selective vtable-based comparison."))

cl::opt< bool >	llvm::EnableVTableProfileUse ("enable-vtable-profile-use", cl::init(false), cl::desc("If ThinLTO and WPD is enabled and this option is true, vtable " "profiles will be used by ICP pass for more efficient indirect " "call sequence. If false, type profiles won't be used."))

static ValueProfRecordClosure	llvm::InstrProfRecordClosure

◆ DEBUG_TYPE

#define DEBUG_TYPE "instrprof"

◆ INSTR_PROF_COMMON_API_IMPL

#define INSTR_PROF_COMMON_API_IMPL

◆ INSTR_PROF_SECT_ENTRY [1/3]

| #define INSTR_PROF_SECT_ENTRY | ( | | Kind, | | -------------------------------- | --------------- | | ----- | | | SectNameCommon, | | | | | | SectNameCoff, | | | | | | Prefix | | | | | ) | SectNameCommon, | | |

◆ INSTR_PROF_SECT_ENTRY [2/3]

| #define INSTR_PROF_SECT_ENTRY | ( | | Kind, | | -------------------------------- | ------------- | | ----- | | | SectNameCommon, | | | | | | SectNameCoff, | | | | | | Prefix | | | | | ) | SectNameCoff, | | |

◆ INSTR_PROF_SECT_ENTRY [3/3]

| #define INSTR_PROF_SECT_ENTRY | ( | | Kind, | | -------------------------------- | ------- | | ----- | | | SectNameCommon, | | | | | | SectNameCoff, | | | | | | Prefix | | | | | ) | Prefix, | | |

◆ getInstrProfErrString()

static std::string getInstrProfErrString ( instrprof_error Err, const std::string & ErrMsg = "" )	static

◆ StaticFuncFullModulePrefix

cl::opt< bool > StaticFuncFullModulePrefix("static-func-full-module-prefix", cl::init(true), cl::Hidden, cl::desc("Use full module build paths in the profile counter names for " "static functions.")) ( "static-func-full-module-prefix" , cl::init(true) , cl::Hidden , cl::desc("Use full module build paths in the profile counter names for " "static functions.") )	static

◆ StaticFuncStripDirNamePrefix

cl::opt< unsigned > StaticFuncStripDirNamePrefix("static-func-strip-dirname-prefix", cl::init(0), cl::Hidden, cl::desc("Strip specified level of directory name from source path in " "the profile counter name for static functions.")) ( "static-func-strip-dirname-prefix" , cl::init(0) , cl::Hidden , cl::desc("Strip specified level of directory name from source path in " "the profile counter name for static functions.") )

static