Base class for generic analysis states. More...

#include "mlir/Analysis/DataFlowFramework.h"

Inheritance diagram for mlir::AnalysisState:

Public Member Functions
virtual	~AnalysisState ()

	AnalysisState (ProgramPoint point)
	Create the analysis state at the given program point. More...

ProgramPoint	getPoint () const
	Returns the program point this state is located at. More...

virtual void	print (raw_ostream &os) const =0
	Print the contents of the analysis state. More...

LLVM_DUMP_METHOD void	dump () const

void	addDependency (ProgramPoint dependent, DataFlowAnalysis *analysis)
	Add a dependency to this analysis state on a program point and an analysis. More...

Protected Member Functions
virtual void	onUpdate (DataFlowSolver *solver) const
	This function is called by the solver when the analysis state is updated to enqueue more work items. More...

Protected Attributes
ProgramPoint	point
	The program point to which the state belongs. More...

Friends
class	DataFlowSolver
	Allow the framework to access the dependents. More...

Detailed Description

Base class for generic analysis states.

Analysis states contain data-flow information that are attached to program points and which evolve as the analysis iterates.

This class places no restrictions on the semantics of analysis states beyond these requirements.

Querying the state of a program point prior to visiting that point results in uninitialized state. Analyses must be aware of unintialized states.
Analysis states can reach fixpoints, where subsequent updates will never trigger a change in the state.
Analysis states that are uninitialized can be forcefully initialized to a default value.

Definition at line 314 of file DataFlowFramework.h.

Constructor & Destructor Documentation

◆ ~AnalysisState()

AnalysisState::~AnalysisState ( )

virtualdefault

◆ AnalysisState()

mlir::AnalysisState::AnalysisState ( ProgramPoint point )

inline

Create the analysis state at the given program point.

Definition at line 319 of file DataFlowFramework.h.

Member Function Documentation

◆ addDependency()

void AnalysisState::addDependency	(	ProgramPoint	dependent,
		DataFlowAnalysis *	analysis
	)

Add a dependency to this analysis state on a program point and an analysis.

If this state is updated, the analysis will be invoked on the given program point again (in onUpdate()).

Definition at line 41 of file DataFlowFramework.cpp.

References DATAFLOW_DEBUG, and point.

◆ dump()

void AnalysisState::dump ( ) const

Definition at line 54 of file DataFlowFramework.cpp.

References print().

◆ getPoint()

ProgramPoint mlir::AnalysisState::getPoint ( ) const

inline

Returns the program point this state is located at.

Definition at line 322 of file DataFlowFramework.h.

References point.

Referenced by mlir::dataflow::AbstractSparseLattice::getPoint().

◆ onUpdate()

virtual void mlir::AnalysisState::onUpdate ( DataFlowSolver * solver ) const

inlineprotectedvirtual

This function is called by the solver when the analysis state is updated to enqueue more work items.

For example, if a state tracks dependents through the IR (e.g. use-def chains), this function can be implemented to push those dependents on the worklist.

Reimplemented in mlir::dataflow::AbstractSparseLattice, mlir::dataflow::IntegerValueRangeLattice, and mlir::dataflow::Executable.

Definition at line 338 of file DataFlowFramework.h.

References mlir::DataFlowSolver::enqueue().

Referenced by mlir::dataflow::Executable::onUpdate(), and mlir::dataflow::AbstractSparseLattice::onUpdate().