An abstract reduction pattern. More...
#include <Reduction.h>
Public Member Functions | |
| 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 uint64_t | match (Operation *op)=0 |
| Check if the reduction can apply to a specific operation. More... | |
| virtual LogicalResult | rewrite (Operation *op)=0 |
| Apply the reduction to a specific operation. More... | |
| virtual std::string | getName () const =0 |
| Return a human-readable name for this reduction pattern. 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) |
Public Attributes | |
| std::function< void(Operation *)> | notifyOpErasedCallback = nullptr |
| An optional callback for reductions to communicate removal of operations. More... | |
Detailed Description
An abstract reduction pattern.
Definition at line 24 of file Reduction.h.
Constructor & Destructor Documentation
◆ ~Reduction()
|
virtualdefault |
Member Function Documentation
◆ acceptSizeIncrease()
|
inlinevirtual |
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 in ModuleNameSanitizer, ModuleInternalNameSanitizer, EagerInliner, ExtmoduleInstanceRemover, ConnectInvalidator, MemoryStubber, InstanceStubber, and circt::PassReduction.
Definition at line 55 of file Reduction.h.
◆ afterReduction()
|
inlinevirtual |
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 in EagerInliner, DetachSubaccesses, ConnectForwarder, ExtmoduleInstanceRemover, AnnotationRemover, MemoryStubber, InstanceStubber, and FIRRTLModuleExternalizer.
Definition at line 35 of file Reduction.h.
◆ beforeReduction()
|
inlinevirtual |
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 in ModuleInputPruner, ModuleOutputPruner< Front >, ModuleExternalizer, ModuleNameSanitizer, EagerInliner, DetachSubaccesses, ConnectForwarder, ExtmoduleInstanceRemover, AnnotationRemover, MemoryStubber, InstanceStubber, FIRRTLModuleExternalizer, and OperationPruner.
Definition at line 30 of file Reduction.h.
◆ getName()
|
pure virtual |
Return a human-readable name for this reduction pattern.
Implemented in OperationPruner, ModuleInputPruner, ModuleOutputPruner< Front >, HWConstantifier, HWOperandForwarder< OpNum >, ModuleExternalizer, ModuleNameSanitizer, ModuleInternalNameSanitizer, EagerInliner, NodeSymbolRemover, DetachSubaccesses, ConnectSourceOperandForwarder< OpNum >, ConnectForwarder, ExtmoduleInstanceRemover, RootPortPruner, AnnotationRemover, ConnectInvalidator, FIRRTLConstantifier, FIRRTLOperandForwarder< OpNum >, MemoryStubber, InstanceStubber, FIRRTLModuleExternalizer, StateElimination, and circt::PassReduction.
◆ isOneShot()
|
inlinevirtual |
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 in ModuleNameSanitizer, ModuleInternalNameSanitizer, and circt::PassReduction.
Definition at line 72 of file Reduction.h.
◆ match()
|
pure virtual |
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.
Implemented in OperationPruner, HWConstantifier, HWOperandForwarder< OpNum >, ModuleInternalNameSanitizer, DetachSubaccesses, ConnectSourceOperandForwarder< OpNum >, ConnectForwarder, AnnotationRemover, ConnectInvalidator, FIRRTLConstantifier, FIRRTLOperandForwarder< OpNum >, circt::PassReduction, circt::OpReduction< OpTy >, circt::OpReduction< StateOp >, circt::OpReduction< firrtl::FModuleOp >, circt::OpReduction< HWModuleOp >, circt::OpReduction< firrtl::MemOp >, circt::OpReduction< firrtl::CircuitOp >, circt::OpReduction< firrtl::NodeOp >, and circt::OpReduction< firrtl::InstanceOp >.
◆ notifyOpErased()
|
inline |
Definition at line 77 of file Reduction.h.
References notifyOpErasedCallback.
Referenced by circt::reduce::pruneUnusedOps().
◆ rewrite()
|
pure virtual |
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.
Implemented in OperationPruner, HWConstantifier, HWOperandForwarder< OpNum >, ModuleInternalNameSanitizer, DetachSubaccesses, ConnectSourceOperandForwarder< OpNum >, ConnectForwarder, AnnotationRemover, ConnectInvalidator, FIRRTLConstantifier, FIRRTLOperandForwarder< OpNum >, circt::PassReduction, circt::OpReduction< OpTy >, circt::OpReduction< StateOp >, circt::OpReduction< firrtl::FModuleOp >, circt::OpReduction< HWModuleOp >, circt::OpReduction< firrtl::MemOp >, circt::OpReduction< firrtl::CircuitOp >, circt::OpReduction< firrtl::NodeOp >, and circt::OpReduction< firrtl::InstanceOp >.
Member Data Documentation
◆ notifyOpErasedCallback
| std::function<void(Operation *)> circt::Reduction::notifyOpErasedCallback = nullptr |
An optional callback for reductions to communicate removal of operations.
Definition at line 75 of file Reduction.h.
Referenced by notifyOpErased().
The documentation for this struct was generated from the following files:
- /home/runner/work/circt-www/circt-www/circt_src/include/circt/Reduce/Reduction.h
- /home/runner/work/circt-www/circt-www/circt_src/lib/Reduce/Reduction.cpp
