Pseudo-reduction that sanitizes module and port names. More...
Public Member Functions | |
| char | getPortName () |
| LogicalResult | rewrite (mlir::ModuleOp moduleOp) 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< firrtl::CircuitOp > | |
| 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. | |
| virtual void | matches (firrtl::CircuitOp op, llvm::function_ref< void(uint64_t, uint64_t)> addMatch) |
| LogicalResult | rewriteMatches (Operation *op, ArrayRef< uint64_t > matches) override |
| Apply a set of matches of this reduction to a specific operation. | |
| virtual LogicalResult | rewriteMatches (firrtl::CircuitOp op, ArrayRef< uint64_t > matches) |
| virtual uint64_t | match (firrtl::CircuitOp op) |
| virtual LogicalResult | rewrite (firrtl::CircuitOp op) |
| 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) |
| Public Member Functions inherited from circt::OpReduction< mlir::ModuleOp > | |
| 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. | |
| virtual void | matches (mlir::ModuleOp op, llvm::function_ref< void(uint64_t, uint64_t)> addMatch) |
| LogicalResult | rewriteMatches (Operation *op, ArrayRef< uint64_t > matches) override |
| Apply a set of matches of this reduction to a specific operation. | |
| virtual LogicalResult | rewriteMatches (mlir::ModuleOp op, ArrayRef< uint64_t > matches) |
| virtual uint64_t | match (mlir::ModuleOp op) |
Public Attributes | |
| size_t | portNameIndex = 0 |
| Public Attributes inherited from circt::Reduction | |
| std::function< void(Operation *)> | notifyOpErasedCallback = nullptr |
| An optional callback for reductions to communicate removal of operations. | |
Detailed Description
Pseudo-reduction that sanitizes module and port names.
This makes the following changes:
- All modules are given metasyntactic names ("Foo", "Bar", etc.)
- All instances are renamed to match the new module name
- All module ports are renamed to simple names ("a", "b", "c", etc.)
Definition at line 343 of file HWReductions.cpp.
Member Function Documentation
◆ acceptSizeIncrease()
|
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 409 of file HWReductions.cpp.
◆ getName()
|
inlineoverridevirtual |
Return a human-readable name for this reduction pattern.
Implements circt::Reduction.
Definition at line 407 of file HWReductions.cpp.
◆ getPortName()
|
inline |
Definition at line 347 of file HWReductions.cpp.
Referenced by rewrite().
◆ isOneShot()
|
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 411 of file HWReductions.cpp.
◆ rewrite()
|
inlineoverridevirtual |
Reimplemented from circt::OpReduction< mlir::ModuleOp >.
Definition at line 353 of file HWReductions.cpp.
References context, circt::reduce::MetasyntacticNameGenerator::getNextName(), and getPortName().
Member Data Documentation
◆ portNameIndex
| size_t ModuleNameSanitizer::portNameIndex = 0 |
Definition at line 345 of file HWReductions.cpp.
The documentation for this struct was generated from the following file:
- /home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/HW/HWReductions.cpp
