Loading [MathJax]/jax/output/HTML-CSS/config.js
CIRCT 22.0.0git
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
ModuleOutputPruner Struct Reference

Remove unused module output ports. More...

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

Public Member Functions

void beforeReduction (mlir::ModuleOp op) override
 Called before the reduction is applied to a new subset of operations.
 
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.
 
LogicalResult rewriteMatches (Operation *op, ArrayRef< uint64_t > matches) override
 Apply a set of matches of this reduction to a specific operation.
 
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.
 
- Public Member Functions inherited from circt::Reduction
virtual ~Reduction ()
 
virtual void afterReduction (mlir::ModuleOp)
 Called after the reduction has been applied to a subset of operations.
 
virtual uint64_t match (Operation *op)
 Check if the reduction can apply to a specific operation.
 
virtual LogicalResult rewrite (Operation *op)
 Apply the reduction to a specific operation.
 
virtual bool isOneShot () const
 Return true if the tool should not try to reapply this reduction after it has been successful.
 
void notifyOpErased (Operation *op)
 

Public Attributes

std::unique_ptr< SymbolTableCollection > symbolTables
 
std::unique_ptr< SymbolUserMap > symbolUsers
 
- Public Attributes inherited from circt::Reduction
std::function< void(Operation *)> notifyOpErasedCallback = nullptr
 An optional callback for reductions to communicate removal of operations.
 

Detailed Description

Remove unused module output ports.

Definition at line 210 of file HWReductions.cpp.

Member Function Documentation

◆ acceptSizeIncrease()

bool ModuleOutputPruner::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 290 of file HWReductions.cpp.

◆ beforeReduction()

void ModuleOutputPruner::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 211 of file HWReductions.cpp.

References symbolTables, and symbolUsers.

◆ getName()

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

Return a human-readable name for this reduction pattern.

Implements circt::Reduction.

Definition at line 289 of file HWReductions.cpp.

◆ matches()

void ModuleOutputPruner::matches ( Operation *  op,
llvm::function_ref< void(uint64_t, uint64_t)>  addMatch 
)
inlineoverridevirtual

Collect all ways how this reduction can apply to a specific operation.

If a reduction can apply to an operation in different ways, for example deleting different operands, it should call addMatch multiple times with the expected benefit of the match, as well as an integer identifying one of the different ways it can match.

Calls match(op) by default.

Reimplemented from circt::Reduction.

Definition at line 216 of file HWReductions.cpp.

References symbolUsers.

Referenced by rewriteMatches().

◆ rewriteMatches()

LogicalResult ModuleOutputPruner::rewriteMatches ( Operation *  op,
ArrayRef< uint64_t >  matches 
)
inlineoverridevirtual

Apply a set of matches of this reduction to a specific operation.

If the reduction registered multiple matches for an operation, a subset of the integer identifiers of those matches will be passed to this function again. If the returned result indicates that the application failed, the resulting module is treated the same as if the tester marked it as uninteresting.

Reimplemented from circt::Reduction.

Definition at line 234 of file HWReductions.cpp.

References matches(), and symbolUsers.

Member Data Documentation

◆ symbolTables

std::unique_ptr<SymbolTableCollection> ModuleOutputPruner::symbolTables

Definition at line 292 of file HWReductions.cpp.

Referenced by beforeReduction().

◆ symbolUsers

std::unique_ptr<SymbolUserMap> ModuleOutputPruner::symbolUsers

Definition at line 293 of file HWReductions.cpp.

Referenced by beforeReduction(), matches(), and rewriteMatches().


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