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

Psuedo-reduction that sanitizes the names of things inside modules. More...

Inheritance diagram for ModuleInternalNameSanitizer:
Inheritance graph
[legend]
Collaboration diagram for ModuleInternalNameSanitizer:
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...
 
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...
 
bool isOneShot () const override
 Return true if the tool should not try to reapply this reduction after it has been successful. 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...
 
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

Psuedo-reduction that sanitizes the names of things inside modules.

This is not an actual reduction, but often removes extraneous information that has no bearing on the actual reduction (and would likely be removed before sharing the reduction). This makes the following changes:

Definition at line 957 of file FIRRTLReductions.cpp.

Member Function Documentation

◆ acceptSizeIncrease()

bool ModuleInternalNameSanitizer::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 984 of file FIRRTLReductions.cpp.

◆ getName()

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

Return a human-readable name for this reduction pattern.

Implements circt::Reduction.

Definition at line 980 of file FIRRTLReductions.cpp.

◆ isOneShot()

bool ModuleInternalNameSanitizer::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 986 of file FIRRTLReductions.cpp.

◆ match()

uint64_t ModuleInternalNameSanitizer::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 958 of file FIRRTLReductions.cpp.

◆ rewrite()

LogicalResult ModuleInternalNameSanitizer::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 965 of file FIRRTLReductions.cpp.

References circt::calyx::direction::get().


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