MLIR  16.0.0git
Public Member Functions | Protected Attributes | List of all members
mlir::scf::ForLoopPipeliningPattern Class Reference

Generate a pipelined version of the scf.for loop based on the schedule given as option. More...

#include "mlir/Dialect/SCF/Transforms/Patterns.h"

+ Inheritance diagram for mlir::scf::ForLoopPipeliningPattern:
+ Collaboration diagram for mlir::scf::ForLoopPipeliningPattern:

Public Member Functions

 ForLoopPipeliningPattern (const PipeliningOption &options, MLIRContext *context)
 
LogicalResult matchAndRewrite (ForOp forOp, PatternRewriter &rewriter) const override
 
FailureOr< ForOp > returningMatchAndRewrite (ForOp forOp, PatternRewriter &rewriter) const
 
- Public Member Functions inherited from mlir::OpRewritePattern< ForOp >
 OpRewritePattern (MLIRContext *context, PatternBenefit benefit=1, ArrayRef< StringRef > generatedNames={})
 Patterns must specify the root operation name they match against, and can also specify the benefit of the pattern matching and a list of generated ops. More...
 
- Public Member Functions inherited from mlir::detail::OpOrInterfaceRewritePatternBase< ForOp >
void rewrite (Operation *op, PatternRewriter &rewriter) const final
 Wrappers around the RewritePattern methods that pass the derived op type. More...
 
virtual void rewrite (ForOp op, PatternRewriter &rewriter) const
 Rewrite and Match methods that operate on the SourceOp type. More...
 
LogicalResult match (Operation *op) const final
 Attempt to match against code rooted at the specified operation, which is the same operation code as getRootKind(). More...
 
virtual LogicalResult match (ForOp op) const
 
LogicalResult matchAndRewrite (Operation *op, PatternRewriter &rewriter) const final
 Attempt to match against code rooted at the specified operation, which is the same operation code as getRootKind(). More...
 
- Public Member Functions inherited from mlir::RewritePattern
virtual ~RewritePattern ()=default
 
- Public Member Functions inherited from mlir::Pattern
ArrayRef< OperationNamegetGeneratedOps () const
 Return a list of operations that may be generated when rewriting an operation instance with this pattern. More...
 
Optional< OperationNamegetRootKind () const
 Return the root node that this pattern matches. More...
 
Optional< TypeIDgetRootInterfaceID () const
 Return the interface ID used to match the root operation of this pattern. More...
 
Optional< TypeIDgetRootTraitID () const
 Return the trait ID used to match the root operation of this pattern. More...
 
PatternBenefit getBenefit () const
 Return the benefit (the inverse of "cost") of matching this pattern. More...
 
bool hasBoundedRewriteRecursion () const
 Returns true if this pattern is known to result in recursive application, i.e. More...
 
MLIRContextgetContext () const
 Return the MLIRContext used to create this pattern. More...
 
StringRef getDebugName () const
 Return a readable name for this pattern. More...
 
void setDebugName (StringRef name)
 Set the human readable debug name used for this pattern. More...
 
ArrayRef< StringRef > getDebugLabels () const
 Return the set of debug labels attached to this pattern. More...
 
void addDebugLabels (ArrayRef< StringRef > labels)
 Add the provided debug labels to this pattern. More...
 
void addDebugLabels (StringRef label)
 

Protected Attributes

PipeliningOption options
 

Additional Inherited Members

- Static Public Member Functions inherited from mlir::RewritePattern
template<typename T , typename... Args>
static std::unique_ptr< T > create (Args &&...args)
 This method provides a convenient interface for creating and initializing derived rewrite patterns of the given type T. More...
 
- Protected Member Functions inherited from mlir::Pattern
 Pattern (StringRef rootName, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern with a certain benefit that matches the operation with the given root name. More...
 
 Pattern (MatchAnyOpTypeTag tag, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern that may match any operation type. More...
 
 Pattern (MatchInterfaceOpTypeTag tag, TypeID interfaceID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern that may match any operation that implements the interface defined by the provided interfaceID. More...
 
 Pattern (MatchTraitOpTypeTag tag, TypeID traitID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
 Construct a pattern that may match any operation that implements the trait defined by the provided traitID. More...
 
void setHasBoundedRewriteRecursion (bool hasBoundedRecursionArg=true)
 Set the flag detailing if this pattern has bounded rewrite recursion or not. More...
 

Detailed Description

Generate a pipelined version of the scf.for loop based on the schedule given as option.

This applies the mechanical transformation of changing the loop and generating the prologue/epilogue for the pipelining and doesn't make any decision regarding the schedule. Based on the options the loop is split into several stages. The transformation assumes that the scheduling given by user is valid. For example if we break a loop into 3 stages named S0, S1, S2 we would generate the following code with the number in parenthesis as the iteration index: S0(0) // Prologue S0(1) S1(0) // Prologue scf.for I = C0 to N - 2 { S0(I+2) S1(I+1) S2(I) // Pipelined kernel } S1(N) S2(N-1) // Epilogue S2(N) // Epilogue

Definition at line 34 of file Patterns.h.

Constructor & Destructor Documentation

◆ ForLoopPipeliningPattern()

mlir::scf::ForLoopPipeliningPattern::ForLoopPipeliningPattern ( const PipeliningOption options,
MLIRContext context 
)
inline

Definition at line 36 of file Patterns.h.

Member Function Documentation

◆ matchAndRewrite()

LogicalResult mlir::scf::ForLoopPipeliningPattern::matchAndRewrite ( ForOp  forOp,
PatternRewriter rewriter 
) const
inlineoverridevirtual

Reimplemented from mlir::detail::OpOrInterfaceRewritePatternBase< ForOp >.

Definition at line 39 of file Patterns.h.

References returningMatchAndRewrite().

◆ returningMatchAndRewrite()

FailureOr< ForOp > ForLoopPipeliningPattern::returningMatchAndRewrite ( ForOp  forOp,
PatternRewriter rewriter 
) const

Member Data Documentation

◆ options

PipeliningOption mlir::scf::ForLoopPipeliningPattern::options
protected

Definition at line 48 of file Patterns.h.


The documentation for this class was generated from the following files: