CIRCT  20.0.0git
Public Member Functions | Public Attributes | List of all members
ExtmoduleInstanceRemover Struct Reference

A sample reduction pattern that replaces instances of firrtl.extmodule with wires. More...

Inheritance diagram for ExtmoduleInstanceRemover:
Inheritance graph
[legend]
Collaboration diagram for ExtmoduleInstanceRemover:
Collaboration graph
[legend]

Public Member Functions

void beforeReduction (mlir::ModuleOp op) override
 Called before the reduction is applied to a new subset of operations. More...
 
void afterReduction (mlir::ModuleOp op) override
 Called after the reduction has been applied to a subset of operations. More...
 
uint64_t match (firrtl::InstanceOp instOp) override
 
LogicalResult rewrite (firrtl::InstanceOp instOp) override
 
std::string getName () const override
 Return a human-readable name for this reduction pattern. More...
 
bool acceptSizeIncrease () const override
 Return true if the tool should accept the transformation this reduction performs on the module even if the overall size of the output increases. More...
 
- Public Member Functions inherited from circt::OpReduction< firrtl::InstanceOp >
uint64_t match (Operation *op) override
 Check if the reduction can apply to a specific operation. More...
 
LogicalResult rewrite (Operation *op) override
 Apply the reduction to a specific operation. More...
 
- Public Member Functions inherited from circt::Reduction
virtual ~Reduction ()
 
virtual bool isOneShot () const
 Return true if the tool should not try to reapply this reduction after it has been successful. More...
 
void notifyOpErased (Operation *op)
 

Public Attributes

::detail::SymbolCache symbols
 
NLARemover nlaRemover
 
- Public Attributes inherited from circt::Reduction
std::function< void(Operation *)> notifyOpErasedCallback = nullptr
 An optional callback for reductions to communicate removal of operations. More...
 

Detailed Description

A sample reduction pattern that replaces instances of firrtl.extmodule with wires.

Definition at line 652 of file FIRRTLReductions.cpp.

Member Function Documentation

◆ acceptSizeIncrease()

bool ExtmoduleInstanceRemover::acceptSizeIncrease ( ) const
inlineoverridevirtual

Return true if the tool should accept the transformation this reduction performs on the module even if the overall size of the output increases.

This can be handy for patterns that reduce the complexity of the IR at the cost of some verbosity.

Reimplemented from circt::Reduction.

Definition at line 689 of file FIRRTLReductions.cpp.

◆ afterReduction()

void ExtmoduleInstanceRemover::afterReduction ( mlir::ModuleOp  )
inlineoverridevirtual

Called after the reduction has been applied to a subset of operations.

Reductions may use this callback to perform post-processing of the reductions before the resulting module is tried for interestingness.

Reimplemented from circt::Reduction.

Definition at line 657 of file FIRRTLReductions.cpp.

◆ beforeReduction()

void ExtmoduleInstanceRemover::beforeReduction ( mlir::ModuleOp  )
inlineoverridevirtual

Called before the reduction is applied to a new subset of operations.

Reductions may use this callback to collect information such as symbol tables about the module upfront.

Reimplemented from circt::Reduction.

Definition at line 653 of file FIRRTLReductions.cpp.

◆ getName()

std::string ExtmoduleInstanceRemover::getName ( ) const
inlineoverridevirtual

Return a human-readable name for this reduction pattern.

Implements circt::Reduction.

Definition at line 688 of file FIRRTLReductions.cpp.

◆ match()

uint64_t ExtmoduleInstanceRemover::match ( firrtl::InstanceOp  instOp)
inlineoverridevirtual

Reimplemented from circt::OpReduction< firrtl::InstanceOp >.

Definition at line 659 of file FIRRTLReductions.cpp.

◆ rewrite()

LogicalResult ExtmoduleInstanceRemover::rewrite ( firrtl::InstanceOp  instOp)
inlineoverridevirtual

Implements circt::OpReduction< firrtl::InstanceOp >.

Definition at line 663 of file FIRRTLReductions.cpp.

Member Data Documentation

◆ nlaRemover

NLARemover ExtmoduleInstanceRemover::nlaRemover

Definition at line 692 of file FIRRTLReductions.cpp.

◆ symbols

::detail::SymbolCache ExtmoduleInstanceRemover::symbols

Definition at line 691 of file FIRRTLReductions.cpp.


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