CIRCT 24.0.0git
Loading...
Searching...
No Matches
ModuleConventionRemover Struct Reference

Reduction that removes the convention attribute from regular modules. More...

Inheritance diagram for ModuleConventionRemover:
Collaboration diagram for ModuleConventionRemover:

Public Member Functions

uint64_t match (FModuleOp module) override
LogicalResult rewrite (FModuleOp module) override
std::string getName () const override
 Return a human-readable name for this reduction pattern.
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.
bool isOneShot () const override
 Return true if the tool should not try to reapply this reduction after it has been successful.
Public Member Functions inherited from circt::OpReduction< FModuleOp >
void matches (Operation *op, llvm::function_ref< void(uint64_t, uint64_t)> addMatch) override
 Collect all ways how this reduction can apply to a specific operation.
LogicalResult rewriteMatches (Operation *op, ArrayRef< uint64_t > matches) override
 Apply a set of matches of this reduction to a specific operation.
Public Member Functions inherited from circt::Reduction
virtual ~Reduction ()
virtual void beforeReduction (mlir::ModuleOp)
 Called before the reduction is applied to a new subset of operations.
virtual void afterReduction (mlir::ModuleOp)
 Called after the reduction has been applied to a subset of operations.
void notifyOpErased (Operation *op)

Additional Inherited Members

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

Detailed Description

Reduction that removes the convention attribute from regular modules.

Definition at line 2631 of file FIRRTLReductions.cpp.

Member Function Documentation

◆ acceptSizeIncrease()

bool ModuleConventionRemover::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 2642 of file FIRRTLReductions.cpp.

◆ getName()

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

Return a human-readable name for this reduction pattern.

Implements circt::Reduction.

Definition at line 2641 of file FIRRTLReductions.cpp.

◆ isOneShot()

bool ModuleConventionRemover::isOneShot ( ) const
inlineoverridevirtual

Return true if the tool should not try to reapply this reduction after it has been successful.

This is useful for reductions whose match() function keeps returning true even after the reduction has reached a fixed-point and no longer performs any change. An example of this are reductions that apply a lowering pass which always applies but may leave the input unmodified.

This is mainly useful in conjunction with returning true from acceptSizeIncrease(). For reductions that don't accept an increase, the module size has to decrease for them to be considered useful, which prevents the tool from getting stuck at a local point where the reduction applies but produces no change in the input. However, reductions that do accept a size increase can get stuck in this local fixed-point as they keep applying to the same operations and the tool keeps accepting the unmodified input as an improvement.

Reimplemented from circt::Reduction.

Definition at line 2643 of file FIRRTLReductions.cpp.

◆ match()

uint64_t ModuleConventionRemover::match ( FModuleOp module)
inlineoverride

Definition at line 2632 of file FIRRTLReductions.cpp.

◆ rewrite()

LogicalResult ModuleConventionRemover::rewrite ( FModuleOp module)
inlineoverride

Definition at line 2636 of file FIRRTLReductions.cpp.

References success().


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