llzk::StructAnalysis< Result, Context > Class Template Reference

This is the base class for a dataflow analysis designed to run on a single struct (i.e., a single component). More...

#include <AnalysisWrappers.h>

Public Member Functions
	StructAnalysis (mlir::Operation *op)
	Assert that this analysis is being run on a StructDefOp and initializes the analysis with the current StructDefOp and its parent ModuleOp.
virtual	~StructAnalysis ()=default
virtual mlir::LogicalResult	runAnalysis (mlir::DataFlowSolver &solver, mlir::AnalysisManager &moduleAnalysisManager, const Context &ctx)=0
	Perform the analysis and construct the Result output.
bool	constructed (const Context &ctx) const
	Query if the analysis has constructed a Result object for the given Context.
const Result &	getResult (const Context &ctx) const
	Access the result iff it has been created for the given Context object ctx.

Protected Member Functions
mlir::ModuleOp	getModule () const
	Get the ModuleOp that is the parent of the StructDefOp that is under analysis.
component::StructDefOp	getStruct () const
	Get the current StructDefOp that is under analysis.
void	setResult (const Context &ctx, Result &&r)
	Initialize the final Result object.

Detailed Description

template<typename Result, typename Context>
class llzk::StructAnalysis< Result, Context >

This is the base class for a dataflow analysis designed to run on a single struct (i.e., a single component).

Template Parameters

Result	The output of the analysis.
Context	Any module-level information or configuration needed to run this analysis.

Definition at line 42 of file AnalysisWrappers.h.

Constructor & Destructor Documentation

StructAnalysis()

template<typename Result, typename Context>

llzk::StructAnalysis< Result, Context >::StructAnalysis ( mlir::Operation * op )

inline

Assert that this analysis is being run on a StructDefOp and initializes the analysis with the current StructDefOp and its parent ModuleOp.

Parameters

op	The presumed StructDefOp.

Definition at line 47 of file AnalysisWrappers.h.

~StructAnalysis()

template<typename Result, typename Context>

virtual llzk::StructAnalysis< Result, Context >::~StructAnalysis ( )

virtualdefault

Member Function Documentation

constructed()

template<typename Result, typename Context>

bool llzk::StructAnalysis< Result, Context >::constructed ( const Context & ctx ) const

inline

Query if the analysis has constructed a Result object for the given Context.

Definition at line 80 of file AnalysisWrappers.h.

getModule()

template<typename Result, typename Context>

mlir::ModuleOp llzk::StructAnalysis< Result, Context >::getModule ( ) const

inlineprotected

Get the ModuleOp that is the parent of the StructDefOp that is under analysis.

Definition at line 94 of file AnalysisWrappers.h.

getResult()

template<typename Result, typename Context>

const Result & llzk::StructAnalysis< Result, Context >::getResult ( const Context & ctx ) const

inline

Access the result iff it has been created for the given Context object ctx.

Definition at line 83 of file AnalysisWrappers.h.

getStruct()

template<typename Result, typename Context>

component::StructDefOp llzk::StructAnalysis< Result, Context >::getStruct ( ) const

inlineprotected

Get the current StructDefOp that is under analysis.

Definition at line 97 of file AnalysisWrappers.h.

runAnalysis()

template<typename Result, typename Context>

virtual mlir::LogicalResult llzk::StructAnalysis< Result, Context >::runAnalysis ( mlir::DataFlowSolver & solver, mlir::AnalysisManager & moduleAnalysisManager, const Context & ctx )

pure virtual

Perform the analysis and construct the Result output.

Parameters

solver	The pre-configured dataflow solver. This solver should already have a liveness analysis run, otherwise this analysis may be a no-op.
moduleAnalysisManager	The analysis manager of the top-level module. By giving the struct analysis a reference to the module's analysis manager, we can query analyses of other structs by querying for a child analysis. Otherwise, a struct's analysis manager cannot query for the analyses of other operations unless they are nested within the struct.
ctx	The Context given to the analysis. This is presumed to have been created by the StructAnalysis's parent ModuleAnalysis.

Returns

mlir::success() if the analysis ran without errors, and a mlir::failure() otherwise.

Implemented in llzk::ConstraintDependencyGraphStructAnalysis, and llzk::StructIntervalAnalysis.

setResult()

template<typename Result, typename Context>

void llzk::StructAnalysis< Result, Context >::setResult ( const Context & ctx, Result && r )

inlineprotected

Initialize the final Result object.

Definition at line 100 of file AnalysisWrappers.h.

---

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

• include/llzk/Analysis/AnalysisWrappers.h