Per-function PGO state. More...

#include "/home/buildbot/as-worker-4/publish-doxygen-docs/llvm-project/clang/lib/CodeGen/CodeGenPGO.h"

Public Member Functions
	CodeGenPGO (CodeGenModule &CGModule)

bool	haveRegionCounts () const
	Whether or not we have PGO region data for the current function.

uint64_t	getCurrentRegionCount () const
	Return the counter value of the current region.

void	setCurrentRegionCount (uint64_t Count)
	Set the counter value for the current region.

std::optional< uint64_t >	getStmtCount (const Stmt *S) const
	Check if an execution count is known for a given statement.

void	setCurrentStmt (const Stmt *S)
	If the execution count for the current statement is known, record that as the current count.

void	assignRegionCounters (GlobalDecl GD, llvm::Function *Fn)
	Assign counters to regions and configure them for PGO of a given function.

void	emitEmptyCounterMapping (const Decl *D, StringRef FuncName, llvm::GlobalValue::LinkageTypes Linkage)
	Emit a coverage mapping range with a counter zero for an unused declaration.

void	valueProfile (CGBuilderTy &Builder, uint32_t ValueKind, llvm::Instruction ValueSite, llvm::Value ValuePtr)

void	setValueProfilingFlag (llvm::Module &M)

void	setProfileVersion (llvm::Module &M)

std::pair< bool, bool >	getIsCounterPair (const Stmt *S) const

void	emitCounterSetOrIncrement (CGBuilderTy &Builder, const Stmt S, llvm::Value StepV)

void	emitMCDCTestVectorBitmapUpdate (CGBuilderTy &Builder, const Expr *S, Address MCDCCondBitmapAddr, CodeGenFunction &CGF)

void	emitMCDCParameters (CGBuilderTy &Builder)

void	emitMCDCCondBitmapReset (CGBuilderTy &Builder, const Expr *S, Address MCDCCondBitmapAddr)

void	emitMCDCCondBitmapUpdate (CGBuilderTy &Builder, const Expr S, Address MCDCCondBitmapAddr, llvm::Value Val, CodeGenFunction &CGF)

void	markStmtAsUsed (bool Skipped, const Stmt *S)

void	markStmtMaybeUsed (const Stmt *S)

void	verifyCounterMap () const

uint64_t	getRegionCount (const Stmt *S)
	Return the region count for the counter at the given index.

Detailed Description

Per-function PGO state.

Definition at line 29 of file CodeGenPGO.h.

Constructor & Destructor Documentation

◆ CodeGenPGO()

clang::CodeGen::CodeGenPGO::CodeGenPGO ( CodeGenModule & CGModule )

inline

Definition at line 46 of file CodeGenPGO.h.

Member Function Documentation

◆ assignRegionCounters()

void CodeGenPGO::assignRegionCounters	(	GlobalDecl	GD,
		llvm::Function *	Fn
	)

Assign counters to regions and configure them for PGO of a given function.

Does nothing if instrumentation is not enabled and either generates global variables or associates PGO data with each of the counters depending on whether we are generating or using instrumentation.

Definition at line 1012 of file CodeGenPGO.cpp.

References clang::CodeGen::CodeGenModule::ClearUnusedCoverageMapping(), clang::Ctor_Base, D, clang::Dtor_Base, clang::CodeGen::CodeGenModule::getCodeGenOpts(), clang::CodeGen::CodeGenModule::getContext(), clang::GlobalDecl::getCtorType(), clang::TargetInfo::getCXXABI(), clang::GlobalDecl::getDecl(), clang::GlobalDecl::getDtorType(), clang::CodeGen::CodeGenModule::getLangOpts(), clang::Decl::getLocation(), clang::CodeGen::CodeGenModule::getPGOReader(), clang::ASTContext::getSourceManager(), clang::CodeGen::CodeGenModule::getTarget(), clang::Decl::hasAttr(), clang::Decl::hasBody(), clang::TargetCXXABI::hasConstructorVariants(), clang::CodeGenOptions::hasProfileClangInstr(), clang::CodeGen::CodeGenFunction::IsConstructorDelegationValid(), clang::Decl::isImplicit(), SM, and llvm::coverage::SystemHeadersCoverage.

◆ emitCounterSetOrIncrement()

void CodeGenPGO::emitCounterSetOrIncrement	(	CGBuilderTy &	Builder,
		const Stmt *	S,
		llvm::Value *	StepV
	)

Definition at line 1199 of file CodeGenPGO.cpp.

References llvm::EnableSingleByteCoverage, clang::CodeGen::CodeGenModule::getIntrinsic(), and clang::CodeGen::CodeGenModule::getLLVMContext().

◆ emitEmptyCounterMapping()

void CodeGenPGO::emitEmptyCounterMapping	(	const Decl *	D,
		StringRef	FuncName,
		llvm::GlobalValue::LinkageTypes	Linkage
	)

Emit a coverage mapping range with a counter zero for an unused declaration.

Definition at line 1145 of file CodeGenPGO.cpp.

References clang::CodeGen::CoverageMappingModuleGen::addFunctionMappingRecord(), D, clang::CodeGen::CoverageMappingGen::emitEmptyMapping(), clang::CodeGen::CodeGenModule::getContext(), clang::CodeGen::CodeGenModule::getCoverageMapping(), clang::CodeGen::CodeGenModule::getLangOpts(), and clang::ASTContext::getSourceManager().

Referenced by clang::CodeGen::CodeGenModule::EmitDeferredUnusedCoverageMappings().

◆ emitMCDCCondBitmapReset()

void CodeGenPGO::emitMCDCCondBitmapReset	(	CGBuilderTy &	Builder,
		const Expr *	S,
		Address	MCDCCondBitmapAddr
	)

Definition at line 1283 of file CodeGenPGO.cpp.

◆ emitMCDCCondBitmapUpdate()

void CodeGenPGO::emitMCDCCondBitmapUpdate	(	CGBuilderTy &	Builder,
		const Expr *	S,
		Address	MCDCCondBitmapAddr,
		llvm::Value *	Val,
		CodeGenFunction &	CGF
	)

Definition at line 1297 of file CodeGenPGO.cpp.

References clang::CodeGen::CodeGenFunction::stripCond().

◆ emitMCDCParameters()

void CodeGenPGO::emitMCDCParameters ( CGBuilderTy & Builder )

Definition at line 1232 of file CodeGenPGO.cpp.

References clang::CodeGen::CodeGenModule::getIntrinsic(), and clang::CodeGen::CodeGenModule::getLLVMContext().

◆ emitMCDCTestVectorBitmapUpdate()

void CodeGenPGO::emitMCDCTestVectorBitmapUpdate	(	CGBuilderTy &	Builder,
		const Expr *	S,
		Address	MCDCCondBitmapAddr,
		CodeGenFunction &	CGF
	)

Definition at line 1248 of file CodeGenPGO.cpp.

References clang::CodeGen::Address::emitRawPointer(), clang::CodeGen::CodeGenModule::getIntrinsic(), and clang::CodeGen::CodeGenModule::getLLVMContext().

◆ getCurrentRegionCount()

uint64_t clang::CodeGen::CodeGenPGO::getCurrentRegionCount ( ) const

inline

Return the counter value of the current region.

Definition at line 56 of file CodeGenPGO.h.

◆ getIsCounterPair()

std::pair< bool, bool > CodeGenPGO::getIsCounterPair ( const Stmt * S ) const

Definition at line 1188 of file CodeGenPGO.cpp.

◆ getRegionCount()

uint64_t clang::CodeGen::CodeGenPGO::getRegionCount ( const Stmt * S )

inline

Return the region count for the counter at the given index.

Definition at line 139 of file CodeGenPGO.h.

References haveRegionCounts().

◆ getStmtCount()

std::optional< uint64_t > clang::CodeGen::CodeGenPGO::getStmtCount ( const Stmt * S ) const

inline

Check if an execution count is known for a given statement.

If so, return true and put the value in Count; else return false.

Definition at line 65 of file CodeGenPGO.h.

Referenced by setCurrentStmt().

◆ haveRegionCounts()

bool clang::CodeGen::CodeGenPGO::haveRegionCounts ( ) const

inline

Whether or not we have PGO region data for the current function.

This is false both when we have no data at all and when our data has been discarded.

Definition at line 53 of file CodeGenPGO.h.

Referenced by getRegionCount(), and valueProfile().

◆ markStmtAsUsed()

void clang::CodeGen::CodeGenPGO::markStmtAsUsed	(	bool	Skipped,
		const Stmt *	S
	)

inline

Definition at line 126 of file CodeGenPGO.h.

◆ markStmtMaybeUsed()

void clang::CodeGen::CodeGenPGO::markStmtMaybeUsed ( const Stmt * S )

inline

Definition at line 130 of file CodeGenPGO.h.

◆ setCurrentRegionCount()

void clang::CodeGen::CodeGenPGO::setCurrentRegionCount ( uint64_t Count )

inline

Set the counter value for the current region.

This is used to keep track of changes to the most recent counter from control flow and non-local exits.

Definition at line 61 of file CodeGenPGO.h.

Referenced by setCurrentStmt().

◆ setCurrentStmt()

void clang::CodeGen::CodeGenPGO::setCurrentStmt ( const Stmt * S )

inline

If the execution count for the current statement is known, record that as the current count.

Definition at line 76 of file CodeGenPGO.h.

References getStmtCount(), and setCurrentRegionCount().

◆ setProfileVersion()

void CodeGenPGO::setProfileVersion ( llvm::Module & M )

Definition at line 1344 of file CodeGenPGO.cpp.

References llvm::EnableSingleByteCoverage, clang::CodeGen::CodeGenModule::getCodeGenOpts(), and clang::CodeGenOptions::hasProfileClangInstr().

Referenced by clang::CodeGen::CodeGenModule::Release().

◆ setValueProfilingFlag()

void CodeGenPGO::setValueProfilingFlag ( llvm::Module & M )

Definition at line 1338 of file CodeGenPGO.cpp.

References EnableValueProfiling(), clang::CodeGen::CodeGenModule::getCodeGenOpts(), and clang::CodeGenOptions::hasProfileClangInstr().

Referenced by clang::CodeGen::CodeGenModule::Release().

◆ valueProfile()

void CodeGenPGO::valueProfile	(	CGBuilderTy &	Builder,
		uint32_t	ValueKind,
		llvm::Instruction *	ValueSite,
		llvm::Value *	ValuePtr
	)

Definition at line 1370 of file CodeGenPGO.cpp.

References EnableValueProfiling(), clang::CodeGen::CodeGenModule::getCodeGenOpts(), clang::CodeGen::CodeGenModule::getIntrinsic(), clang::CodeGen::CodeGenModule::getModule(), clang::CodeGen::CodeGenModule::getPGOReader(), clang::CodeGenOptions::hasProfileClangInstr(), and haveRegionCounts().

◆ verifyCounterMap()

void clang::CodeGen::CodeGenPGO::verifyCounterMap ( ) const

inline

Definition at line 134 of file CodeGenPGO.h.

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

lib/CodeGen/CodeGenPGO.h
lib/CodeGen/CodeGenPGO.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CodeGenPGO()

Member Function Documentation

◆ assignRegionCounters()

◆ emitCounterSetOrIncrement()

◆ emitEmptyCounterMapping()

◆ emitMCDCCondBitmapReset()

◆ emitMCDCCondBitmapUpdate()

◆ emitMCDCParameters()

◆ emitMCDCTestVectorBitmapUpdate()

◆ getCurrentRegionCount()

◆ getIsCounterPair()

◆ getRegionCount()

◆ getStmtCount()

◆ haveRegionCounts()

◆ markStmtAsUsed()

◆ markStmtMaybeUsed()

◆ setCurrentRegionCount()

◆ setCurrentStmt()

◆ setProfileVersion()

◆ setValueProfilingFlag()

◆ valueProfile()

◆ verifyCounterMap()