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

A sample reduction pattern that removes FIRRTL annotations from ports and operations. More...

Inheritance diagram for AnnotationRemover:
Inheritance graph
[legend]
Collaboration diagram for AnnotationRemover:
Collaboration graph
[legend]

Public Member Functions

void beforeReduction (mlir::ModuleOp op) override
 Called before the reduction is applied to a new subset of operations. More...
 
void afterReduction (mlir::ModuleOp op) override
 Called after the reduction has been applied to a subset of operations. More...
 
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 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

NLARemover nlaRemover
 
- 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

A sample reduction pattern that removes FIRRTL annotations from ports and operations.

Definition at line 596 of file FIRRTLReductions.cpp.

Member Function Documentation

◆ afterReduction()

void AnnotationRemover::afterReduction ( mlir::ModuleOp  )
inlineoverridevirtual

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 from circt::Reduction.

Definition at line 598 of file FIRRTLReductions.cpp.

◆ beforeReduction()

void AnnotationRemover::beforeReduction ( mlir::ModuleOp  )
inlineoverridevirtual

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 from circt::Reduction.

Definition at line 597 of file FIRRTLReductions.cpp.

◆ getName()

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

Return a human-readable name for this reduction pattern.

Implements circt::Reduction.

Definition at line 619 of file FIRRTLReductions.cpp.

◆ match()

uint64_t AnnotationRemover::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 599 of file FIRRTLReductions.cpp.

◆ rewrite()

LogicalResult AnnotationRemover::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 602 of file FIRRTLReductions.cpp.

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

Member Data Documentation

◆ nlaRemover

NLARemover AnnotationRemover::nlaRemover

Definition at line 620 of file FIRRTLReductions.cpp.


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