CIRCT  20.0.0git
Public Member Functions | List of all members
FIRRTLOperandForwarder< OpNum > Struct Template Reference

A sample reduction pattern that replaces all uses of an operation with one of its operands. More...

Inheritance diagram for FIRRTLOperandForwarder< OpNum >:
Inheritance graph
[legend]
Collaboration diagram for FIRRTLOperandForwarder< OpNum >:
Collaboration graph
[legend]

Public Member Functions

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...
 
std::string getName () const override
 Return a human-readable name for this reduction pattern. More...
 
- 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. More...
 
virtual void afterReduction (mlir::ModuleOp)
 Called after the reduction has been applied to a subset of operations. More...
 
virtual bool acceptSizeIncrease () const
 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...
 
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)
 

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. More...
 

Detailed Description

template<unsigned OpNum>
struct FIRRTLOperandForwarder< OpNum >

A sample reduction pattern that replaces all uses of an operation with one of its operands.

This can help pruning large parts of the expression tree rapidly.

Definition at line 496 of file FIRRTLReductions.cpp.

Member Function Documentation

◆ getName()

template<unsigned OpNum>
std::string FIRRTLOperandForwarder< OpNum >::getName ( ) const
inlineoverridevirtual

Return a human-readable name for this reduction pattern.

Implements circt::Reduction.

Definition at line 534 of file FIRRTLReductions.cpp.

◆ match()

template<unsigned OpNum>
uint64_t FIRRTLOperandForwarder< OpNum >::match ( Operation *  op)
inlineoverridevirtual

Check if the reduction can apply to a specific operation.

Returns a benefit measure where a higher number means that applying the pattern leads to a bigger reduction and zero means that the patten does not match and thus cannot be applied at all.

Implements circt::Reduction.

Definition at line 497 of file FIRRTLReductions.cpp.

References isFlowSensitiveOp().

◆ rewrite()

template<unsigned OpNum>
LogicalResult FIRRTLOperandForwarder< OpNum >::rewrite ( Operation *  op)
inlineoverridevirtual

Apply the reduction to a specific operation.

If the returned result indicates that the application failed, the resulting module is treated the same as if the tester marked it as uninteresting.

Implements circt::Reduction.

Definition at line 512 of file FIRRTLReductions.cpp.

References assert(), and circt::reduce::pruneUnusedOps().


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