Base class for BlockFrequencyInfoImpl. More...

#include "llvm/Analysis/BlockFrequencyInfoImpl.h"

Inheritance diagram for llvm::BlockFrequencyInfoImplBase:

Classes
struct	BlockNode
	Representative of a block. More...
struct	Distribution
	Distribution of unscaled probability weight. More...
struct	FrequencyData
	Stats about a block itself. More...
struct	LoopData
	Data about a loop. More...
struct	Weight
	Unscaled probability weight. More...
struct	WorkingData
	Index of loop information. More...

Public Types
using	Scaled64 = ScaledNumber<uint64_t>
using	BlockMass = bfi_detail::BlockMass

Public Member Functions
virtual	~BlockFrequencyInfoImplBase ()=default
	Virtual destructor.
void	addLoopSuccessorsToDist (const LoopData *OuterLoop, LoopData &Loop, Distribution &Dist)
	Add all edges out of a packaged loop to the distribution.
void	addToDist (Distribution &Dist, const LoopData *OuterLoop, const BlockNode &Pred, const BlockNode &Succ, uint64_t Weight)
	Add an edge to the distribution.
iterator_range< std::list< LoopData >::iterator >	analyzeIrreducible (const bfi_detail::IrreducibleGraph &G, LoopData *OuterLoop, std::list< LoopData >::iterator Insert)
	Analyze irreducible SCCs.
void	distributeMass (const BlockNode &Source, LoopData *OuterLoop, Distribution &Dist)
	Distribute mass according to a distribution.
void	computeLoopScale (LoopData &Loop)
	Compute the loop scale for a loop.
void	adjustLoopHeaderMass (LoopData &Loop)
	Adjust the mass of all headers in an irreducible loop.
void	distributeIrrLoopHeaderMass (Distribution &Dist)
void	packageLoop (LoopData &Loop)
	Package up a loop.
void	unwrapLoops ()
	Unwrap loops.
void	finalizeMetrics ()
	Finalize frequency metrics.
void	clear ()
	Clear all memory.
virtual std::string	getBlockName (const BlockNode &Node) const
std::string	getLoopName (const LoopData &Loop) const
virtual raw_ostream &	print (raw_ostream &OS) const
void	dump () const
Scaled64	getFloatingBlockFreq (const BlockNode &Node) const
BlockFrequency	getBlockFreq (const BlockNode &Node) const
std::optional< uint64_t >	getBlockProfileCount (const Function &F, const BlockNode &Node) const
std::optional< uint64_t >	getProfileCountFromFreq (const Function &F, BlockFrequency Freq) const
bool	isIrrLoopHeader (const BlockNode &Node)
void	setBlockFreq (const BlockNode &Node, BlockFrequency Freq)
BlockFrequency	getEntryFreq () const

Public Attributes
std::vector< FrequencyData >	Freqs
	Data about each block. This is used downstream.
SparseBitVector	IsIrrLoopHeader
	Whether each block is an irreducible loop header.
std::vector< WorkingData >	Working
	Loop data: see initializeLoops().
std::list< LoopData >	Loops
	Indexed information about loops.
bool	TopContainsIrreducible = false
	Has an irreducible SCC outside every loop.

Detailed Description

Base class for BlockFrequencyInfoImpl.

BlockFrequencyInfoImplBase has supporting data structures and some algorithms for BlockFrequencyInfoImplBase. Only algorithms that depend on the block type (or that call such algorithms) are skipped here.

Nevertheless, the majority of the overall algorithm documentation lives with BlockFrequencyInfoImpl. See there for details.

Definition at line 177 of file BlockFrequencyInfoImpl.h.

Member Typedef Documentation

◆ BlockMass

using llvm::BlockFrequencyInfoImplBase::BlockMass = bfi_detail::BlockMass

Definition at line 180 of file BlockFrequencyInfoImpl.h.

◆ Scaled64

using llvm::BlockFrequencyInfoImplBase::Scaled64 = ScaledNumber<uint64_t>

Definition at line 179 of file BlockFrequencyInfoImpl.h.

Constructor & Destructor Documentation

◆ ~BlockFrequencyInfoImplBase()

virtual llvm::BlockFrequencyInfoImplBase::~BlockFrequencyInfoImplBase ( )

virtualdefault

Virtual destructor.

Need a virtual destructor to mask the compiler warning about getBlockName().

References addLoopSuccessorsToDist(), addToDist(), adjustLoopHeaderMass(), analyzeIrreducible(), clear(), computeLoopScale(), distributeIrrLoopHeaderMass(), distributeMass(), finalizeMetrics(), G, getLoopName(), packageLoop(), and unwrapLoops().

Member Function Documentation

◆ addLoopSuccessorsToDist()

void BlockFrequencyInfoImplBase::addLoopSuccessorsToDist	(	const LoopData *	OuterLoop,
		LoopData &	Loop,
		Distribution &	Dist )

Add all edges out of a packaged loop to the distribution.

Adds all edges from LocalLoopHead to Dist. Calls addToDist() to add each successor edge.

Definition at line 364 of file BlockFrequencyInfoImpl.cpp.

References addToDist(), llvm::LoopBase< BlockT, LoopT >::getHeader(), and I.

Referenced by ~BlockFrequencyInfoImplBase().

◆ addToDist()

void BlockFrequencyInfoImplBase::addToDist	(	Distribution &	Dist,
		const LoopData *	OuterLoop,
		const BlockNode &	Pred,
		const BlockNode &	Succ,
		uint64_t	Weight )

Add an edge to the distribution.

Adds an edge to Succ to Dist. If LoopHead.isValid(), then whether the edge is local/exit/backedge is in the context of LoopHead. Otherwise, every edge should be a local edge (since all the loops are packaged up).

Definition at line 313 of file BlockFrequencyInfoImpl.cpp.

References llvm::BlockFrequencyInfoImplBase::Distribution::addBackedge(), llvm::BlockFrequencyInfoImplBase::Distribution::addExit(), llvm::BlockFrequencyInfoImplBase::Distribution::addLocal(), assert(), llvm::dbgs(), llvm::bfi_detail::getBlockName(), llvm::BlockFrequencyInfoImplBase::BlockNode::Index, llvm::BlockFrequencyInfoImplBase::LoopData::isHeader(), llvm::BlockFrequencyInfoImplBase::LoopData::isIrreducible(), LLVM_DEBUG, and Working.

Referenced by addLoopSuccessorsToDist(), and ~BlockFrequencyInfoImplBase().

◆ adjustLoopHeaderMass()

void BlockFrequencyInfoImplBase::adjustLoopHeaderMass ( LoopData & Loop )

Adjust the mass of all headers in an irreducible loop.

Initially, irreducible loops are assumed to distribute their mass equally among its headers. This can lead to wrong frequency estimates since some headers may be executed more frequently than others.

This adjusts header mass distribution so it matches the weights of the backedges going into each of the loop headers.

Definition at line 757 of file BlockFrequencyInfoImpl.cpp.

References llvm::BlockFrequencyInfoImplBase::Distribution::addLocal(), assert(), D(), llvm::dbgs(), debugAssign(), llvm::bfi_detail::getBlockName(), llvm::bfi_detail::BlockMass::getFull(), H, LLVM_DEBUG, llvm::BlockFrequencyInfoImplBase::Weight::Local, llvm::BlockFrequencyInfoImplBase::Distribution::Weights, and Working.

Referenced by ~BlockFrequencyInfoImplBase().

◆ analyzeIrreducible()

iterator_range< std::list< LoopData >::iterator > BlockFrequencyInfoImplBase::analyzeIrreducible	(	const bfi_detail::IrreducibleGraph &	G,
		LoopData *	OuterLoop,
		std::list< LoopData >::iterator	Insert )

Analyze irreducible SCCs.

Separate irreducible SCCs from G, which is an explicit graph of OuterLoop (or the top-level function, if OuterLoop is nullptr). Insert them into Loops before Insert.