A data structure that caches and provides absolute paths to module instances in the IR. More...

#include <InstanceGraph.h>

Collaboration diagram for circt::igraph::InstancePathCache:

[legend]

Public Member Functions
	InstancePathCache (InstanceGraph &instanceGraph)

ArrayRef< InstancePath >	getAbsolutePaths (ModuleOpInterface op)

ArrayRef< InstancePath >	getAbsolutePaths (ModuleOpInterface op, InstanceGraphNode *top)

void	replaceInstance (InstanceOpInterface oldOp, InstanceOpInterface newOp)
	Replace an InstanceOp. This is required to keep the cache updated.

InstancePath	appendInstance (InstancePath path, InstanceOpInterface inst)
	Append an instance to a path.

InstancePath	prependInstance (InstanceOpInterface inst, InstancePath path)
	Prepend an instance to a path.

Public Attributes
InstanceGraph &	instanceGraph
	The instance graph of the IR.

Private Attributes
llvm::BumpPtrAllocator	allocator
	An allocator for individual instance paths and entire path lists.

DenseMap< Operation *, ArrayRef< InstancePath > >	absolutePathsCache
	Cached absolute instance paths.

Detailed Description

A data structure that caches and provides absolute paths to module instances in the IR.

Definition at line 348 of file InstanceGraph.h.

Constructor & Destructor Documentation

◆ InstancePathCache()

circt::igraph::InstancePathCache::InstancePathCache ( InstanceGraph & instanceGraph )

inlineexplicit

Definition at line 352 of file InstanceGraph.h.

Member Function Documentation

◆ appendInstance()

InstancePath InstancePathCache::appendInstance	(	InstancePath	path,
		InstanceOpInterface	inst
	)

Append an instance to a path.

Definition at line 304 of file InstanceGraph.cpp.

References allocator, circt::igraph::InstancePath::begin(), circt::igraph::InstancePath::end(), and circt::igraph::InstancePath::size().

Referenced by getAbsolutePaths().

◆ getAbsolutePaths() [1/2]

ArrayRef< InstancePath > InstancePathCache::getAbsolutePaths ( ModuleOpInterface op )

Definition at line 228 of file InstanceGraph.cpp.

References getAbsolutePaths(), circt::igraph::InstanceGraph::getTopLevelNode(), and instanceGraph.

Referenced by circt::firrtl::applyGCTMemTaps(), circt::firrtl::applyWiring(), getAbsolutePaths(), getAbsolutePaths(), and lowerInternalPathAnno().

◆ getAbsolutePaths() [2/2]

ArrayRef< InstancePath > InstancePathCache::getAbsolutePaths	(	ModuleOpInterface	op,
		InstanceGraphNode *	top
	)

Definition at line 234 of file InstanceGraph.cpp.

References absolutePathsCache, allocator, appendInstance(), empty, getAbsolutePaths(), instanceGraph, and circt::igraph::InstanceGraphNode::uses().

◆ prependInstance()

InstancePath InstancePathCache::prependInstance	(	InstanceOpInterface	inst,
		InstancePath	path
	)

Prepend an instance to a path.

Definition at line 313 of file InstanceGraph.cpp.

References allocator, circt::igraph::InstancePath::begin(), circt::igraph::InstancePath::end(), and circt::igraph::InstancePath::size().

◆ replaceInstance()

void InstancePathCache::replaceInstance	(	InstanceOpInterface	oldOp,
		InstanceOpInterface	newOp
	)

Replace an InstanceOp. This is required to keep the cache updated.

Definition at line 322 of file InstanceGraph.cpp.

References absolutePathsCache, allocator, instanceGraph, and circt::igraph::InstanceGraph::replaceInstance().

Referenced by circt::firrtl::addPortsToModule().

Member Data Documentation

◆ absolutePathsCache

DenseMap<Operation *, ArrayRef<InstancePath> > circt::igraph::InstancePathCache::absolutePathsCache

private

Cached absolute instance paths.

Definition at line 372 of file InstanceGraph.h.

Referenced by getAbsolutePaths(), and replaceInstance().

◆ allocator

llvm::BumpPtrAllocator circt::igraph::InstancePathCache::allocator

private

An allocator for individual instance paths and entire path lists.

Definition at line 369 of file InstanceGraph.h.

Referenced by appendInstance(), getAbsolutePaths(), prependInstance(), and replaceInstance().

◆ instanceGraph

InstanceGraph& circt::igraph::InstancePathCache::instanceGraph

The instance graph of the IR.

Definition at line 350 of file InstanceGraph.h.

Referenced by circt::firrtl::addPortsToModule(), applyBodyTypeLoweringAnno(), getAbsolutePaths(), getAbsolutePaths(), lowerInternalPathAnno(), and replaceInstance().

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

/home/runner/work/circt-www/circt-www/circt_src/include/circt/Support/InstanceGraph.h
/home/runner/work/circt-www/circt-www/circt_src/lib/Support/InstanceGraph.cpp

Public Member Functions

Public Attributes

Private Attributes