Inheritance diagram for LowerXMRPass:

Collaboration diagram for LowerXMRPass:

[legend]

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)

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 > *	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

hw::HierPathCache *	hierPathCache
	Utility to create HerPathOps at a predefined location in the circuit.

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

Detailed Description

Definition at line 126 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 777 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ garbageCollect()

void LowerXMRPass::garbageCollect ( )

inlineprivate

Definition at line 786 of file LowerXMR.cpp.

◆ getInnerRefTo() [1/2]

InnerRefAttr LowerXMRPass::getInnerRefTo ( Operation * op )

inlineprivate

Definition at line 744 of file LowerXMR.cpp.

◆ getInnerRefTo() [2/2]

InnerRefAttr LowerXMRPass::getInnerRefTo ( Value val )

inlineprivate

Definition at line 733 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 729 of file LowerXMR.cpp.

◆ 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 430 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 418 of file LowerXMR.cpp.

References toVector().

◆ getRemoteRefSend()

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

inlineprivate

Definition at line 753 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ handleForceReleaseOp()

LogicalResult LowerXMRPass::handleForceReleaseOp ( Operation * op )

inlineprivate

Definition at line 526 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 587 of file LowerXMR.cpp.

References circt::firrtl::getInnerRefTo().

Referenced by runOnOperation().

◆ handlePublicModuleRefPorts()

LogicalResult LowerXMRPass::handlePublicModuleRefPorts ( FModuleOp module )

inlineprivate

Definition at line 673 of file LowerXMR.cpp.

◆ handleRefResolve()

LogicalResult LowerXMRPass::handleRefResolve ( RefResolveOp resolve )

inlineprivate

Definition at line 556 of file LowerXMR.cpp.

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

◆ isZeroWidth()

bool LowerXMRPass::isZeroWidth ( FIRRTLBaseType t )

inlineprivate

Definition at line 834 of file LowerXMR.cpp.

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

Referenced by runOnOperation().

◆ markForRemoval()

void LowerXMRPass::markForRemoval ( Operation * op )

inlineprivate

Definition at line 751 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 509 of file LowerXMR.cpp.

◆ resolveReferencePath()

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

inlineprivate

Definition at line 436 of file LowerXMR.cpp.

References assert(), and toVector().

◆ runOnOperation()

void LowerXMRPass::runOnOperation ( )

inlineoverrideprivate

Definition at line 128 of file LowerXMR.cpp.

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

◆ setPortToRemove()

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

inlineprivate

Definition at line 580 of file LowerXMR.cpp.

Referenced by runOnOperation().

Member Data Documentation

◆ circuitNamespace

CircuitNamespace* LowerXMRPass::circuitNamespace

private

Definition at line 866 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 845 of file LowerXMR.cpp.

◆ dataFlowClasses

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

private

Definition at line 856 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ hierPathCache

hw::HierPathCache* LowerXMRPass::hierPathCache

private

Utility to create HerPathOps at a predefined location in the circuit.

This handles caching and keeps the order consistent.

Definition at line 870 of file LowerXMR.cpp.

Referenced by runOnOperation().

◆ moduleNamespaces

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

private

Cached module namespaces.

Definition at line 838 of file LowerXMR.cpp.

◆ moduleStates

DenseMap<FModuleOp, ModuleState> LowerXMRPass::moduleStates

private

Per-module helpers for creating operations within modules.

Definition at line 873 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 861 of file LowerXMR.cpp.

◆ refPortsToRemoveMap

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

private

Definition at line 858 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 854 of file LowerXMR.cpp.

◆ visitedModules

DenseSet<Operation *> LowerXMRPass::visitedModules

private

Definition at line 840 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 864 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

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addReachingSendsEntry()

◆ garbageCollect()

◆ getInnerRefTo() [1/2]

◆ getInnerRefTo() [2/2]

◆ getModuleNamespace()

◆ getRefABIMacroForPort()

◆ getRefABIPrefix()

◆ getRemoteRefSend()

◆ handleForceReleaseOp()

◆ handleInstanceOp()

◆ handlePublicModuleRefPorts()

◆ handleRefResolve()

◆ isZeroWidth()

◆ markForRemoval()

◆ resolveReference()

◆ resolveReferencePath()

◆ runOnOperation()

◆ setPortToRemove()

Member Data Documentation

◆ circuitNamespace

◆ dataflowAt

◆ dataFlowClasses

◆ hierPathCache

◆ moduleNamespaces

◆ moduleStates

◆ opsToRemove

◆ refPortsToRemoveMap

◆ refSendPathList

◆ visitedModules

◆ xmrPathSuffix