MLIR  16.0.0git
Public Types | Public Member Functions | List of all members
mlir::OpConversionPattern< SourceOp > Class Template Reference

OpConversionPattern is a wrapper around ConversionPattern that allows for matching and rewriting against an instance of a derived operation class as opposed to a raw Operation. More...

#include "mlir/Transforms/DialectConversion.h"

+ Inheritance diagram for mlir::OpConversionPattern< SourceOp >:
+ Collaboration diagram for mlir::OpConversionPattern< SourceOp >:

Public Types

using OpAdaptor = typename SourceOp::Adaptor
 

Public Member Functions

 OpConversionPattern (MLIRContext *context, PatternBenefit benefit=1)
 
 OpConversionPattern (TypeConverter &typeConverter, MLIRContext *context, PatternBenefit benefit=1)
 
LogicalResult match (Operation *op) const final
 Wrappers around the ConversionPattern methods that pass the derived op type. More...
 
void rewrite (Operation *op, ArrayRef< Value > operands, ConversionPatternRewriter &rewriter) const final
 Hook for derived classes to implement rewriting. More...
 
LogicalResult matchAndRewrite (Operation *op, ArrayRef< Value > operands, ConversionPatternRewriter &rewriter) const final
 Hook for derived classes to implement combined matching and rewriting. More...
 
virtual LogicalResult match (SourceOp op) const
 Rewrite and Match methods that operate on the SourceOp type. More...
 
virtual void rewrite (SourceOp op, OpAdaptor adaptor, ConversionPatternRewriter &rewriter) const
 
virtual LogicalResult matchAndRewrite (SourceOp op, OpAdaptor adaptor, ConversionPatternRewriter &rewriter) const
 
- Public Member Functions inherited from mlir::ConversionPattern
LogicalResult matchAndRewrite (Operation *op, PatternRewriter &rewriter) const final
 Attempt to match and rewrite the IR root at the specified operation. More...
 
TypeConvertergetTypeConverter () const
 Return the type converter held by this pattern, or nullptr if the pattern does not require type conversion. More...
 
template<typename ConverterTy >
std::enable_if_t< std::is_base_of< TypeConverter, ConverterTy >::value, ConverterTy * > getTypeConverter () const
 
- Public Member Functions inherited from mlir::RewritePattern
virtual ~RewritePattern ()=default
 
virtual void rewrite (Operation *op, PatternRewriter &rewriter) const
 Rewrite the IR rooted at the specified operation with the result of this pattern, generating any new operations with the specified builder. More...
 
- 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)
 

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::ConversionPattern
template<typename... Args>
 ConversionPattern (TypeConverter &typeConverter, Args &&...args)
 Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern. 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...
 
- Protected Attributes inherited from mlir::ConversionPattern
TypeConvertertypeConverter = nullptr
 An optional type converter for use by this pattern. More...
 

Detailed Description

template<typename SourceOp>
class mlir::OpConversionPattern< SourceOp >

OpConversionPattern is a wrapper around ConversionPattern that allows for matching and rewriting against an instance of a derived operation class as opposed to a raw Operation.

Definition at line 400 of file DialectConversion.h.

Member Typedef Documentation

◆ OpAdaptor

template<typename SourceOp>
using mlir::OpConversionPattern< SourceOp >::OpAdaptor = typename SourceOp::Adaptor

Definition at line 402 of file DialectConversion.h.

Constructor & Destructor Documentation

◆ OpConversionPattern() [1/2]

template<typename SourceOp>
mlir::OpConversionPattern< SourceOp >::OpConversionPattern ( MLIRContext context,
PatternBenefit  benefit = 1 
)
inline

◆ OpConversionPattern() [2/2]

template<typename SourceOp>
mlir::OpConversionPattern< SourceOp >::OpConversionPattern ( TypeConverter typeConverter,
MLIRContext context,
PatternBenefit  benefit = 1 
)
inline

Definition at line 406 of file DialectConversion.h.

Member Function Documentation

◆ match() [1/2]

template<typename SourceOp>
LogicalResult mlir::OpConversionPattern< SourceOp >::match ( Operation op) const
inlinefinalvirtual

Wrappers around the ConversionPattern methods that pass the derived op type.

Reimplemented from mlir::RewritePattern.

Definition at line 413 of file DialectConversion.h.

◆ match() [2/2]

template<typename SourceOp>
virtual LogicalResult mlir::OpConversionPattern< SourceOp >::match ( SourceOp  op) const
inlinevirtual

Rewrite and Match methods that operate on the SourceOp type.

These must be overridden by the derived pattern class.

Definition at line 431 of file DialectConversion.h.

◆ matchAndRewrite() [1/2]

template<typename SourceOp>
LogicalResult mlir::OpConversionPattern< SourceOp >::matchAndRewrite ( Operation op,
ArrayRef< Value operands,
ConversionPatternRewriter rewriter 
) const
inlinefinalvirtual

Hook for derived classes to implement combined matching and rewriting.

Reimplemented from mlir::ConversionPattern.

Definition at line 422 of file DialectConversion.h.

◆ matchAndRewrite() [2/2]

template<typename SourceOp>
virtual LogicalResult mlir::OpConversionPattern< SourceOp >::matchAndRewrite ( SourceOp  op,
OpAdaptor  adaptor,
ConversionPatternRewriter rewriter 
) const
inlinevirtual

Reimplemented in AssertOpLowering, and YieldOpLowering.

Definition at line 439 of file DialectConversion.h.

◆ rewrite() [1/2]

template<typename SourceOp>
void mlir::OpConversionPattern< SourceOp >::rewrite ( Operation op,
ArrayRef< Value operands,
ConversionPatternRewriter rewriter 
) const
inlinefinalvirtual

Hook for derived classes to implement rewriting.

op is the (first) operation matched by the pattern, operands is a list of the rewritten operand values that are passed to op, rewriter can be used to emit the new operations. This function should not fail. If some specific cases of the operation are not supported, these cases should not be matched.

Reimplemented from mlir::ConversionPattern.

Definition at line 416 of file DialectConversion.h.

◆ rewrite() [2/2]

template<typename SourceOp>
virtual void mlir::OpConversionPattern< SourceOp >::rewrite ( SourceOp  op,
OpAdaptor  adaptor,
ConversionPatternRewriter rewriter 
) const
inlinevirtual

Definition at line 434 of file DialectConversion.h.


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