FuncOpPartialLoweringPatterns are patterns which intend to match on FuncOps and then perform their own walking of the IR. More...

#include <CalyxLoweringUtils.h>

Inheritance diagram for circt::calyx::FuncOpPartialLoweringPattern:

[legend]

Collaboration diagram for circt::calyx::FuncOpPartialLoweringPattern:

[legend]

Public Member Functions
	FuncOpPartialLoweringPattern (MLIRContext *context, LogicalResult &resRef, PatternApplicationState &patternState, DenseMap< mlir::func::FuncOp, calyx::ComponentOp > &map, calyx::CalyxLoweringState &state)
LogicalResult	partiallyLower (mlir::func::FuncOp funcOp, PatternRewriter &rewriter) const override final
	Entry point to initialize the state of this class and conduct the partial lowering.
calyx::ComponentOp	getComponent () const
	Returns the component operation associated with the currently executing partial lowering.
template<typename T = ComponentLoweringStateInterface>
T &	getState () const
CalyxLoweringState &	loweringState () const
	Return the calyx lowering state for this pattern.
virtual LogicalResult	partiallyLowerFuncToComp (mlir::func::FuncOp funcOp, PatternRewriter &rewriter) const =0
Public Member Functions inherited from circt::calyx::PartialLoweringPattern< mlir::func::FuncOp >
	PartialLoweringPattern (MLIRContext *ctx, LogicalResult &resRef, PatternApplicationState &patternState)
LogicalResult	matchAndRewrite (mlir::func::FuncOp op, PatternRewriter &rewriter) const override

Protected Attributes
DenseMap< mlir::func::FuncOp, calyx::ComponentOp > &	functionMapping

Private Attributes
ComponentOp	componentOp
ComponentLoweringStateInterface *	componentLoweringState = nullptr
CalyxLoweringState &	calyxLoweringState

Detailed Description

FuncOpPartialLoweringPatterns are patterns which intend to match on FuncOps and then perform their own walking of the IR.

Definition at line 668 of file CalyxLoweringUtils.h.

Constructor & Destructor Documentation

◆ FuncOpPartialLoweringPattern()

circt::calyx::FuncOpPartialLoweringPattern::FuncOpPartialLoweringPattern	(	MLIRContext *	context,
		LogicalResult &	resRef,
		PatternApplicationState &	patternState,
		DenseMap< mlir::func::FuncOp, calyx::ComponentOp > &	map,
		calyx::CalyxLoweringState &	state )

Definition at line 511 of file CalyxLoweringUtils.cpp.

References calyxLoweringState, context, functionMapping, circt::calyx::PartialLoweringPattern< mlir::func::FuncOp >::PartialLoweringPattern(), and circt::calyx::PartialLoweringPattern< mlir::func::FuncOp >::patternState.

Referenced by circt::scftocalyx::BuildOpGroups::BuildOpGroups().

Member Function Documentation

◆ getComponent()

calyx::ComponentOp circt::calyx::FuncOpPartialLoweringPattern::getComponent ( ) const

Returns the component operation associated with the currently executing partial lowering.

Definition at line 534 of file CalyxLoweringUtils.cpp.

References assert(), and componentOp.

◆ getState()

template<typename T = ComponentLoweringStateInterface>

T & circt::calyx::FuncOpPartialLoweringPattern::getState ( ) const

inline

Definition at line 690 of file CalyxLoweringUtils.h.

References assert(), and componentLoweringState.

◆ loweringState()

CalyxLoweringState & circt::calyx::FuncOpPartialLoweringPattern::loweringState ( ) const

Return the calyx lowering state for this pattern.

Definition at line 540 of file CalyxLoweringUtils.cpp.

References calyxLoweringState.

Referenced by circt::pipelinetocalyx::BuildOpGroups::buildOp(), circt::scftocalyx::BuildOpGroups::buildOp(), circt::pipelinetocalyx::BuildPipelineGroups::buildStageGroups(), circt::pipelinetocalyx::BuildOpGroups::createGroupForOp(), circt::scftocalyx::BuildOpGroups::createGroupForOp(), circt::calyx::BuildBasicBlockRegs::partiallyLowerFuncToComp(), circt::pipelinetocalyx::FuncOpConversion::partiallyLowerFuncToComp(), circt::scftocalyx::BuildWhileGroups::partiallyLowerFuncToComp(), circt::scftocalyx::FuncOpConversion::partiallyLowerFuncToComp(), and circt::scftocalyx::BuildControl::scheduleBasicBlock().

◆ partiallyLower()

LogicalResult circt::calyx::FuncOpPartialLoweringPattern::partiallyLower	(	mlir::func::FuncOp	funcOp,
		PatternRewriter &	rewriter ) const

finaloverridevirtual

Entry point to initialize the state of this class and conduct the partial lowering.

Implements circt::calyx::PartialLoweringPattern< mlir::func::FuncOp >.

Definition at line 520 of file CalyxLoweringUtils.cpp.

References calyxLoweringState, componentLoweringState, componentOp, functionMapping, and partiallyLowerFuncToComp().

◆ partiallyLowerFuncToComp()

virtual LogicalResult circt::calyx::FuncOpPartialLoweringPattern::partiallyLowerFuncToComp	(	mlir::func::FuncOp	funcOp,
		PatternRewriter &	rewriter ) const

pure virtual

Implemented in circt::calyx::BuildBasicBlockRegs, circt::calyx::BuildCallInstance, circt::calyx::BuildReturnRegs, and circt::calyx::ConvertIndexTypes.

Referenced by partiallyLower().

Member Data Documentation

◆ calyxLoweringState

CalyxLoweringState& circt::calyx::FuncOpPartialLoweringPattern::calyxLoweringState

private

Definition at line 723 of file CalyxLoweringUtils.h.

Referenced by FuncOpPartialLoweringPattern(), loweringState(), and partiallyLower().

◆ componentLoweringState

ComponentLoweringStateInterface* circt::calyx::FuncOpPartialLoweringPattern::componentLoweringState = nullptr

mutableprivate

Definition at line 722 of file CalyxLoweringUtils.h.

Referenced by getState(), and partiallyLower().

◆ componentOp

ComponentOp circt::calyx::FuncOpPartialLoweringPattern::componentOp

mutableprivate

Definition at line 721 of file CalyxLoweringUtils.h.

Referenced by circt::scftocalyx::BuildOpGroups::buildOp(), circt::calyx::BuildCallInstance::getCallComponent(), getComponent(), partiallyLower(), circt::calyx::BuildCallInstance::partiallyLowerFuncToComp(), circt::scftocalyx::BuildForGroups::partiallyLowerFuncToComp(), and circt::scftocalyx::BuildIfGroups::partiallyLowerFuncToComp().

◆ functionMapping

DenseMap<mlir::func::FuncOp, calyx::ComponentOp>& circt::calyx::FuncOpPartialLoweringPattern::functionMapping

protected

Definition at line 718 of file CalyxLoweringUtils.h.

Referenced by FuncOpPartialLoweringPattern(), circt::calyx::BuildCallInstance::getCallComponent(), partiallyLower(), circt::pipelinetocalyx::FuncOpConversion::partiallyLowerFuncToComp(), and circt::scftocalyx::FuncOpConversion::partiallyLowerFuncToComp().

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

/home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/Calyx/CalyxLoweringUtils.h
/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/Calyx/Transforms/CalyxLoweringUtils.cpp

Public Member Functions

Protected Attributes

Private Attributes