A base class to collect and print dropped debug information variable statistics. More...

#include "llvm/IR/DroppedVariableStats.h"

Inheritance diagram for llvm::DroppedVariableStats:

Classes
struct	DebugVariables

Public Member Functions
LLVM_ABI	DroppedVariableStats (bool DroppedVarStatsEnabled)

virtual	~DroppedVariableStats ()

	DroppedVariableStats (const DroppedVariableStats &)=delete

void	operator= (const DroppedVariableStats &)=delete

bool	getPassDroppedVariables ()

Protected Member Functions
LLVM_ABI void	setup ()

LLVM_ABI void	cleanup ()

LLVM_ABI void	calculateDroppedStatsAndPrint (DebugVariables &DbgVariables, StringRef FuncName, StringRef PassID, StringRef FuncOrModName, StringRef PassLevel, const Function *Func)
	Calculate the number of dropped variables in an llvm::Function or llvm::MachineFunction and print the relevant information to stdout.

LLVM_ABI bool	updateDroppedCount (DILocation DbgLoc, const DIScope Scope, const DIScope DbgValScope, DenseMap< VarID, DILocation > &InlinedAtsMap, VarID Var, unsigned &DroppedCount)
	Check if a `Var` has been dropped or is a false positive.

LLVM_ABI void	run (DebugVariables &DbgVariables, StringRef FuncName, bool Before)
	Run code to populate relevant data structures over an llvm::Function or llvm::MachineFunction.

LLVM_ABI void	populateVarIDSetAndInlinedMap (const DILocalVariable DbgVar, DebugLoc DbgLoc, DenseSet< VarID > &VarIDSet, DenseMap< StringRef, DenseMap< VarID, DILocation > > &InlinedAtsMap, StringRef FuncName, bool Before)
	Populate the VarIDSet and InlinedAtMap with the relevant information needed for before and after pass analysis to determine dropped variable status.

virtual void	visitEveryInstruction (unsigned &DroppedCount, DenseMap< VarID, DILocation * > &InlinedAtsMap, VarID Var)=0
	Visit every llvm::Instruction or llvm::MachineInstruction and check if the debug variable denoted by its ID `Var` may have been dropped by an optimization pass.

virtual void	visitEveryDebugRecord (DenseSet< VarID > &VarIDSet, DenseMap< StringRef, DenseMap< VarID, DILocation * > > &InlinedAtsMap, StringRef FuncName, bool Before)=0
	Visit every debug record in an llvm::Function or llvm::MachineFunction and call populateVarIDSetAndInlinedMap on it.

Protected Attributes
bool	DroppedVariableStatsEnabled = false

SmallVector< DenseMap< const Function *, DebugVariables > >	DebugVariablesStack
	A stack of a DenseMap, that maps DebugVariables for every pass to an llvm::Function.

DenseSet< const DIScope * >	VisitedScope
	A DenseSet tracking whether a scope was visited before.

SmallVector< DenseMap< StringRef, DenseMap< VarID, DILocation * > > >	InlinedAts
	A stack of DenseMaps, which map the name of an llvm::Function to a DenseMap of VarIDs and their inlinedAt locations before an optimization pass has run.

Detailed Description

A base class to collect and print dropped debug information variable statistics.

Definition at line 41 of file DroppedVariableStats.h.

Constructor & Destructor Documentation

◆ DroppedVariableStats() [1/2]

DroppedVariableStats::DroppedVariableStats ( bool DroppedVarStatsEnabled )

Definition at line 21 of file DroppedVariableStats.cpp.

References llvm::outs().

◆ ~DroppedVariableStats()

virtual llvm::DroppedVariableStats::~DroppedVariableStats ( )

inlinevirtual

Definition at line 45 of file DroppedVariableStats.h.

◆ DroppedVariableStats() [2/2]

llvm::DroppedVariableStats::DroppedVariableStats ( const DroppedVariableStats & )

delete

Member Function Documentation

◆ calculateDroppedStatsAndPrint()

void DroppedVariableStats::calculateDroppedStatsAndPrint	(	DebugVariables &	DbgVariables,
		StringRef	FuncName,
		StringRef	PassID,
		StringRef	FuncOrModName,
		StringRef	PassLevel,
		const Function *	Func
	)

protected

Calculate the number of dropped variables in an llvm::Function or llvm::MachineFunction and print the relevant information to stdout.

Definition at line 41 of file DroppedVariableStats.cpp.

References llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::contains(), llvm::DroppedVariableStats::DebugVariables::DebugVariablesAfter, llvm::DroppedVariableStats::DebugVariables::DebugVariablesBefore, InlinedAts, llvm::outs(), and visitEveryInstruction().

◆ cleanup()

void DroppedVariableStats::cleanup ( )

protected

Definition at line 33 of file DroppedVariableStats.cpp.

References assert(), DebugVariablesStack, and InlinedAts.

Referenced by llvm::DroppedVariableStatsIR::registerCallbacks(), llvm::DroppedVariableStatsIR::runAfterPass(), and llvm::DroppedVariableStatsMIR::runAfterPass().

◆ getPassDroppedVariables()

bool llvm::DroppedVariableStats::getPassDroppedVariables ( )

inline

Definition at line 51 of file DroppedVariableStats.h.

◆ operator=()

void llvm::DroppedVariableStats::operator= ( const DroppedVariableStats & )

delete

◆ populateVarIDSetAndInlinedMap()

void DroppedVariableStats::populateVarIDSetAndInlinedMap	(	const DILocalVariable *	DbgVar,
		DebugLoc	DbgLoc,
		DenseSet< VarID > &	VarIDSet,
		DenseMap< StringRef, DenseMap< VarID, DILocation * > > &	InlinedAtsMap,
		StringRef	FuncName,
		bool	Before
	)

protected

Populate the VarIDSet and InlinedAtMap with the relevant information needed for before and after pass analysis to determine dropped variable status.

Definition at line 100 of file DroppedVariableStats.cpp.

References llvm::DebugLoc::getInlinedAt(), llvm::DILocalVariable::getScope(), and llvm::detail::DenseSetImpl< ValueT, MapTy, ValueInfoT >::insert().

◆ run()

void DroppedVariableStats::run	(	DebugVariables &	DbgVariables,
		StringRef	FuncName,
		bool	Before
	)

protected

Run code to populate relevant data structures over an llvm::Function or llvm::MachineFunction.

Definition at line 89 of file DroppedVariableStats.cpp.

References llvm::DroppedVariableStats::DebugVariables::DebugVariablesAfter, llvm::DroppedVariableStats::DebugVariables::DebugVariablesBefore, InlinedAts, and visitEveryDebugRecord().

◆ setup()

void DroppedVariableStats::setup ( )

protected

Definition at line 28 of file DroppedVariableStats.cpp.

References DebugVariablesStack, and InlinedAts.

Referenced by llvm::DroppedVariableStatsIR::runBeforePass(), and llvm::DroppedVariableStatsMIR::runBeforePass().

◆ updateDroppedCount()

bool DroppedVariableStats::updateDroppedCount	(	DILocation *	DbgLoc,
		const DIScope *	Scope,
		const DIScope *	DbgValScope,
		DenseMap< VarID, DILocation * > &	InlinedAtsMap,
		VarID	Var,
		unsigned &	DroppedCount
	)

protected

Check if a Var has been dropped or is a false positive.

Also update the DroppedCount if a debug variable is dropped.

Definition at line 70 of file DroppedVariableStats.cpp.

◆ visitEveryDebugRecord()

virtual void llvm::DroppedVariableStats::visitEveryDebugRecord	(	DenseSet< VarID > &	VarIDSet,
		DenseMap< StringRef, DenseMap< VarID, DILocation * > > &	InlinedAtsMap,
		StringRef	FuncName,
		bool	Before
	)

protectedpure virtual

Visit every debug record in an llvm::Function or llvm::MachineFunction and call populateVarIDSetAndInlinedMap on it.

Referenced by run().

◆ visitEveryInstruction()

virtual void llvm::DroppedVariableStats::visitEveryInstruction	(	unsigned &	DroppedCount,
		DenseMap< VarID, DILocation * > &	InlinedAtsMap,
		VarID	Var
	)

protectedpure virtual

Visit every llvm::Instruction or llvm::MachineInstruction and check if the debug variable denoted by its ID Var may have been dropped by an optimization pass.

Referenced by calculateDroppedStatsAndPrint().

Member Data Documentation

◆ DebugVariablesStack

SmallVector<DenseMap<const Function *, DebugVariables> > llvm::DroppedVariableStats::DebugVariablesStack

protected

A stack of a DenseMap, that maps DebugVariables for every pass to an llvm::Function.

A stack is used because an optimization pass can call other passes.

Definition at line 69 of file DroppedVariableStats.h.

Referenced by cleanup(), and setup().

◆ DroppedVariableStatsEnabled

bool llvm::DroppedVariableStats::DroppedVariableStatsEnabled = false

protected

Definition at line 58 of file DroppedVariableStats.h.

Referenced by llvm::DroppedVariableStatsIR::registerCallbacks().

◆ InlinedAts

SmallVector<DenseMap<StringRef, DenseMap<VarID, DILocation *> > > llvm::DroppedVariableStats::InlinedAts

protected

A stack of DenseMaps, which map the name of an llvm::Function to a DenseMap of VarIDs and their inlinedAt locations before an optimization pass has run.

Definition at line 76 of file DroppedVariableStats.h.

Referenced by calculateDroppedStatsAndPrint(), cleanup(), run(), and setup().

◆ VisitedScope

DenseSet<const DIScope *> llvm::DroppedVariableStats::VisitedScope

protected

A DenseSet tracking whether a scope was visited before.

Definition at line 72 of file DroppedVariableStats.h.

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

include/llvm/IR/DroppedVariableStats.h
lib/IR/DroppedVariableStats.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DroppedVariableStats() [1/2]

◆ ~DroppedVariableStats()

◆ DroppedVariableStats() [2/2]

Member Function Documentation

◆ calculateDroppedStatsAndPrint()

◆ cleanup()

◆ getPassDroppedVariables()

◆ operator=()

◆ populateVarIDSetAndInlinedMap()

◆ run()

◆ setup()

◆ updateDroppedCount()

◆ visitEveryDebugRecord()

◆ visitEveryInstruction()

Member Data Documentation

◆ DebugVariablesStack

◆ DroppedVariableStatsEnabled

◆ InlinedAts

◆ VisitedScope