Inheritance diagram for LowerXMRPass:

Collaboration diagram for LowerXMRPass:

[legend]

Classes
struct	ValueComparator
	llvm::EquivalenceClasses wants comparable elements. More...

Private Member Functions
void	runOnOperation () override

void	getRefABIPrefix (FModuleLike mod, SmallVectorImpl< char > &prefix)
	Generate the ABI ref_<module> prefix string into `prefix`.

StringAttr	getRefABIMacroForPort (FModuleLike mod, size_t portIndex, const Twine &prefix, bool backTick=false)
	Get full macro name as StringAttr for the specified ref port.

LogicalResult	resolveReferencePath (mlir::TypedValue< RefType > refVal, ImplicitLocOpBuilder builder, mlir::FlatSymbolRefAttr &ref, SmallString< 128 > &stringLeaf)

LogicalResult	resolveReference (mlir::TypedValue< RefType > refVal, ImplicitLocOpBuilder &builder, FlatSymbolRefAttr &ref, StringAttr &xmrAttr)

LogicalResult	handleForceReleaseOp (Operation *op)

LogicalResult	handleRefResolve (RefResolveOp resolve)

void	setPortToRemove (Operation *op, size_t index, size_t numPorts)

LogicalResult	handleInstanceOp (InstanceOp inst, InstanceGraph &instanceGraph)

LogicalResult	handlePublicModuleRefPorts (FModuleOp module)

hw::InnerSymbolNamespace &	getModuleNamespace (FModuleLike module)
	Get the cached namespace for a module.

InnerRefAttr	getInnerRefTo (Value val)

InnerRefAttr	getInnerRefTo (Operation *op)

void	markForRemoval (Operation *op)

std::optional< size_t >	getRemoteRefSend (Value val, bool errorIfNotFound=true)

size_t	addReachingSendsEntry (Value atRefVal, XMRNode::SymOrIndexOp info, std::optional< size_t > continueFrom=std::nullopt)

void	garbageCollect ()

bool	isZeroWidth (FIRRTLBaseType t)

hw::HierPathOp	getOrCreatePath (ArrayAttr pathArray, ImplicitLocOpBuilder &builder)
	Return a HierPathOp for the provided pathArray.

Private Attributes
DenseMap< Operation *, hw::InnerSymbolNamespace >	moduleNamespaces
	Cached module namespaces.

DenseSet< Operation * >	visitedModules

DenseMap< Value, size_t >	dataflowAt
	Map of a reference value to an entry into refSendPathList.

SmallVector< XMRNode >	refSendPathList
	refSendPathList is used to construct a path to the RefSendOp.

llvm::EquivalenceClasses< Value, ValueComparator > *	dataFlowClasses

DenseMap< Operation *, llvm::BitVector >	refPortsToRemoveMap

SmallVector< Operation * >	opsToRemove
	RefResolve, RefSend, and Connects involving them that will be removed.

DenseMap< size_t, SmallString< 128 > >	xmrPathSuffix
	Record the internal path to an external module or a memory.

CircuitNamespace *	circuitNamespace

DenseMap< Attribute, hw::HierPathOp >	pathCache
	A cache of already created HierPathOps.

OpBuilder::InsertPoint	pathInsertPoint = {}
	The insertion point where the pass inserts HierPathOps.

DenseMap< FModuleOp, ModuleState >	moduleStates
	Per-module helpers for creating operations within modules.

Detailed Description

Definition at line 125 of file LowerXMR.cpp.

Member Function Documentation

◆ addReachingSendsEntry()

size_t LowerXMRPass::addReachingSendsEntry	(	Value	atRefVal,
		XMRNode::SymOrIndexOp	info,
		std::optional< size_t >	continueFrom = `std::nullopt`
	)

inlineprivate

Definition at line 770 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ garbageCollect()

void LowerXMRPass::garbageCollect ( )

inlineprivate

Definition at line 779 of file LowerXMR.cpp.

◆ getInnerRefTo() [1/2]

InnerRefAttr LowerXMRPass::getInnerRefTo ( Operation * op )

inlineprivate

Definition at line 737 of file LowerXMR.cpp.

◆ getInnerRefTo() [2/2]

InnerRefAttr LowerXMRPass::getInnerRefTo ( Value val )

inlineprivate

Definition at line 726 of file LowerXMR.cpp.

References circt::firrtl::getInnerRefTo().

Referenced by runOnOperation().

◆ getModuleNamespace()

hw::InnerSymbolNamespace & LowerXMRPass::getModuleNamespace ( FModuleLike module )

inlineprivate

Get the cached namespace for a module.

Definition at line 722 of file LowerXMR.cpp.

◆ getOrCreatePath()

hw::HierPathOp LowerXMRPass::getOrCreatePath	(	ArrayAttr	pathArray,
		ImplicitLocOpBuilder &	builder
	)

inlineprivate

Return a HierPathOp for the provided pathArray.

This will either return an existing HierPathOp or it will create and return a new one.

Definition at line 831 of file LowerXMR.cpp.

References assert(), and getBodyBlock().

◆ getRefABIMacroForPort()

StringAttr LowerXMRPass::getRefABIMacroForPort	(	FModuleLike	mod,
		size_t	portIndex,
		const Twine &	prefix,
		bool	backTick = `false`
	)

inlineprivate

Get full macro name as StringAttr for the specified ref port.

Uses existing 'prefix', optionally preprends the backtick character.

Definition at line 426 of file LowerXMR.cpp.

◆ getRefABIPrefix()

void LowerXMRPass::getRefABIPrefix	(	FModuleLike	mod,
		SmallVectorImpl< char > &	prefix
	)

inlineprivate

Generate the ABI ref_<module> prefix string into prefix.

Definition at line 414 of file LowerXMR.cpp.

References toVector().

◆ getRemoteRefSend()

std::optional< size_t > LowerXMRPass::getRemoteRefSend	(	Value	val,
		bool	errorIfNotFound = `true`
	)

inlineprivate

Definition at line 746 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ handleForceReleaseOp()

LogicalResult LowerXMRPass::handleForceReleaseOp ( Operation * op )

inlineprivate

Definition at line 520 of file LowerXMR.cpp.

◆ handleInstanceOp()

LogicalResult LowerXMRPass::handleInstanceOp	(	InstanceOp	inst,
		InstanceGraph &	instanceGraph
	)

inlineprivate

Get the resolution string for this ref-type port.

Definition at line 581 of file LowerXMR.cpp.

References circt::firrtl::getInnerRefTo().

Referenced by runOnOperation().

◆ handlePublicModuleRefPorts()

LogicalResult LowerXMRPass::handlePublicModuleRefPorts ( FModuleOp module )

inlineprivate

Definition at line 667 of file LowerXMR.cpp.

◆ handleRefResolve()

LogicalResult LowerXMRPass::handleRefResolve ( RefResolveOp resolve )

inlineprivate

Definition at line 550 of file LowerXMR.cpp.

References circt::firrtl::getBitWidth(), and circt::firrtl::getIntZerosAttr().

◆ isZeroWidth()

bool LowerXMRPass::isZeroWidth ( FIRRTLBaseType t )

inlineprivate

Definition at line 827 of file LowerXMR.cpp.

References circt::firrtl::FIRRTLBaseType::getBitWidthOrSentinel().

Referenced by runOnOperation().

◆ markForRemoval()

void LowerXMRPass::markForRemoval ( Operation * op )

inlineprivate

Definition at line 744 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ resolveReference()

LogicalResult LowerXMRPass::resolveReference	(	mlir::TypedValue< RefType >	refVal,
		ImplicitLocOpBuilder &	builder,
		FlatSymbolRefAttr &	ref,
		StringAttr &	xmrAttr
	)

inlineprivate

Definition at line 503 of file LowerXMR.cpp.

◆ resolveReferencePath()

LogicalResult LowerXMRPass::resolveReferencePath	(	mlir::TypedValue< RefType >	refVal,
		ImplicitLocOpBuilder	builder,
		mlir::FlatSymbolRefAttr &	ref,
		SmallString< 128 > &	stringLeaf
	)

inlineprivate

Definition at line 432 of file LowerXMR.cpp.

References assert(), and toVector().

◆ runOnOperation()

void LowerXMRPass::runOnOperation ( )

inlineoverrideprivate

Definition at line 127 of file LowerXMR.cpp.

References addReachingSendsEntry(), circuitNamespace, dataFlowClasses, circt::firrtl::getFieldName(), circt::firrtl::getFieldRefFromValue(), getInnerRefTo(), getRemoteRefSend(), handleInstanceOp(), isZeroWidth(), markForRemoval(), moduleStates, refPortsToRemoveMap, setPortToRemove(), toVector(), and xmrPathSuffix.

◆ setPortToRemove()

void LowerXMRPass::setPortToRemove	(	Operation *	op,
		size_t	index,
		size_t	numPorts
	)

inlineprivate

Definition at line 574 of file LowerXMR.cpp.

Referenced by runOnOperation().

Member Data Documentation

◆ circuitNamespace

CircuitNamespace* LowerXMRPass::circuitNamespace

private

Definition at line 904 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ dataflowAt

DenseMap<Value, size_t> LowerXMRPass::dataflowAt

private

Map of a reference value to an entry into refSendPathList.

Each entry in refSendPathList represents the path to RefSend. The path is required since there can be multiple paths to the RefSend and we need to identify a unique path.

Definition at line 875 of file LowerXMR.cpp.

◆ dataFlowClasses

llvm::EquivalenceClasses<Value, ValueComparator>* LowerXMRPass::dataFlowClasses

private

Definition at line 894 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ moduleNamespaces

DenseMap<Operation *, hw::InnerSymbolNamespace> LowerXMRPass::moduleNamespaces

private

Cached module namespaces.

Definition at line 868 of file LowerXMR.cpp.

◆ moduleStates

DenseMap<FModuleOp, ModuleState> LowerXMRPass::moduleStates

private

Per-module helpers for creating operations within modules.

Definition at line 914 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ opsToRemove

SmallVector<Operation *> LowerXMRPass::opsToRemove

private

RefResolve, RefSend, and Connects involving them that will be removed.

Definition at line 899 of file LowerXMR.cpp.

◆ pathCache

DenseMap<Attribute, hw::HierPathOp> LowerXMRPass::pathCache

private

A cache of already created HierPathOps.

This is used to avoid repeatedly creating the same HierPathOp.

Definition at line 908 of file LowerXMR.cpp.

◆ pathInsertPoint

OpBuilder::InsertPoint LowerXMRPass::pathInsertPoint = {}

private

The insertion point where the pass inserts HierPathOps.

Definition at line 911 of file LowerXMR.cpp.

◆ refPortsToRemoveMap

DenseMap<Operation *, llvm::BitVector> LowerXMRPass::refPortsToRemoveMap

private

Definition at line 896 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ refSendPathList

SmallVector<XMRNode> LowerXMRPass::refSendPathList

private

refSendPathList is used to construct a path to the RefSendOp.

Each entry is an XMRNode, with an InnerRefAttr or indexing op, and a pointer to the next node in the path. The InnerRefAttr can be to an InstanceOp or to the XMR defining op, the index op records narrowing along path. All the nodes representing an InstanceOp or indexing operation must have a valid NextNodeOnPath. Only the node representing the final XMR defining op has no NextNodeOnPath, which denotes a leaf node on the path.

Definition at line 884 of file LowerXMR.cpp.

◆ visitedModules

DenseSet<Operation *> LowerXMRPass::visitedModules

private

Definition at line 870 of file LowerXMR.cpp.

◆ xmrPathSuffix

DenseMap<size_t, SmallString<128> > LowerXMRPass::xmrPathSuffix

private

Record the internal path to an external module or a memory.

Definition at line 902 of file LowerXMR.cpp.

Referenced by runOnOperation().

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

/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/FIRRTL/Transforms/LowerXMR.cpp

Classes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addReachingSendsEntry()

◆ garbageCollect()

◆ getInnerRefTo() [1/2]

◆ getInnerRefTo() [2/2]

◆ getModuleNamespace()

◆ getOrCreatePath()

◆ getRefABIMacroForPort()

◆ getRefABIPrefix()

◆ getRemoteRefSend()

◆ handleForceReleaseOp()

◆ handleInstanceOp()

◆ handlePublicModuleRefPorts()

◆ handleRefResolve()

◆ isZeroWidth()

◆ markForRemoval()

◆ resolveReference()

◆ resolveReferencePath()

◆ runOnOperation()

◆ setPortToRemove()

Member Data Documentation

◆ circuitNamespace

◆ dataflowAt

◆ dataFlowClasses

◆ moduleNamespaces

◆ moduleStates

◆ opsToRemove

◆ pathCache

◆ pathInsertPoint

◆ refPortsToRemoveMap

◆ refSendPathList

◆ visitedModules

◆ xmrPathSuffix