Base class for the conversion patterns. More...
#include "mlir/Transforms/DialectConversion.h"
Inheritance diagram for mlir::ConversionPattern:
Collaboration diagram for mlir::ConversionPattern:
Public Member Functions | |
| virtual void | rewrite (Operation *op, ArrayRef< Value > operands, ConversionPatternRewriter &rewriter) const |
| Hook for derived classes to implement rewriting. More... | |
| virtual LogicalResult | matchAndRewrite (Operation *op, ArrayRef< Value > operands, ConversionPatternRewriter &rewriter) const |
| Hook for derived classes to implement combined matching and rewriting. More... | |
| LogicalResult | matchAndRewrite (Operation *op, PatternRewriter &rewriter) const final |
| Attempt to match and rewrite the IR root at the specified operation. More... | |
| TypeConverter * | getTypeConverter () 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... | |
| virtual LogicalResult | match (Operation *op) const |
| 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::Pattern | |
| ArrayRef< OperationName > | getGeneratedOps () const |
| Return a list of operations that may be generated when rewriting an operation instance with this pattern. More... | |
| Optional< OperationName > | getRootKind () const |
| Return the root node that this pattern matches. More... | |
| Optional< TypeID > | getRootInterfaceID () const |
| Return the interface ID used to match the root operation of this pattern. More... | |
| Optional< TypeID > | getRootTraitID () 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... | |
| MLIRContext * | getContext () 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 Member Functions | |
| 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 | |
| TypeConverter * | typeConverter = nullptr |
| An optional type converter for use by this pattern. More... | |
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... | |
Detailed Description
Base class for the conversion patterns.
This pattern class enables type conversions, and other uses specific to the conversion framework. As such, patterns of this type can only be used with the 'apply*' methods below.
Definition at line 339 of file DialectConversion.h.
Constructor & Destructor Documentation
◆ ConversionPattern()
|
inlineprotected |
Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern.
Definition at line 383 of file DialectConversion.h.
Member Function Documentation
◆ getTypeConverter() [1/2]
|
inline |
Return the type converter held by this pattern, or nullptr if the pattern does not require type conversion.
Definition at line 367 of file DialectConversion.h.
References value.
Referenced by getSrcVectorElementType(), mlir::ConvertToLLVMPattern::getTypeConverter(), and mlir::spirv::ElementwiseOpPattern< Op, SPIRVOp >::matchAndRewrite().
◆ getTypeConverter() [2/2]
|
inline |
Definition at line 372 of file DialectConversion.h.
◆ matchAndRewrite() [1/2]
|
inlinevirtual |
Hook for derived classes to implement combined matching and rewriting.
Reimplemented in mlir::OpInterfaceConversionPattern< SourceOp >, mlir::OpConversionPattern< SourceOp >, mlir::OpConversionPattern< Op >, mlir::OpConversionPattern< OpTy >, mlir::OpConversionPattern< SPIRVOp >, mlir::OpConversionPattern< async::YieldOp >, mlir::OpConversionPattern< cf::AssertOp >, mlir::ConvertOpToLLVMPattern< SourceOp >, mlir::ConvertOpToLLVMPattern< Op >, mlir::ConvertOpToLLVMPattern< gpu::PrintfOp >, mlir::ConvertOpToLLVMPattern< gpu::GPUFuncOp >, mlir::ConvertOpToLLVMPattern< gpu::ReturnOp >, mlir::ConvertOpToLLVMPattern< memref::TransposeOp >, and mlir::ConvertOpToLLVMPattern< cf::AssertOp >.
Definition at line 353 of file DialectConversion.h.
References mlir::failed(), mlir::failure(), rewrite(), and mlir::success().
Referenced by mlir::ConvertOpToLLVMPattern< cf::AssertOp >::matchAndRewrite(), mlir::OpConversionPattern< cf::AssertOp >::matchAndRewrite(), and mlir::OpInterfaceConversionPattern< SourceOp >::matchAndRewrite().
◆ matchAndRewrite() [2/2]
|
finalvirtual |
Attempt to match and rewrite the IR root at the specified operation.
Reimplemented from mlir::RewritePattern.
Definition at line 1689 of file DialectConversion.cpp.
References mlir::detail::ConversionPatternRewriterImpl::argConverter, mlir::detail::ConversionPatternRewriterImpl::blockActions, mlir::detail::ConversionPatternRewriterImpl::convertBlockSignature(), mlir::detail::ConversionPatternRewriterImpl::createdOps, diag(), mlir::failed(), mlir::failure(), mlir::detail::ConversionPatternRewriterImpl::getCurrentState(), mlir::Pattern::getGeneratedOps(), mlir::ConversionPatternRewriter::getImpl(), mlir::Operation::getLoc(), mlir::Operation::getName(), mlir::Block::getNumArguments(), mlir::Operation::getNumRegions(), mlir::Operation::getOperands(), mlir::Block::getParentOp(), mlir::Pattern::getRootKind(), mlir::Pattern::hasBoundedRewriteRecursion(), mlir::PatternBenefit::impossibleToMatch(), mlir::OpBuilder::insert(), mlir::detail::ConversionPatternRewriterImpl::isOpIgnored(), logFailure(), mlir::detail::ConversionPatternRewriterImpl::logger, logSuccess(), mlir::detail::ConversionPatternRewriterImpl::markNestedOpsIgnored(), max(), min(), mlir::Operation::print(), mlir::OpPrintingFlags::printGenericOpForm(), mlir::Remark, mlir::ConversionPatternRewriter::replaceOp(), mlir::detail::ConversionPatternRewriterImpl::rootUpdates, mlir::OpBuilder::setInsertionPoint(), mlir::succeeded(), mlir::success(), and mlir::OpBuilder::tryFold().
◆ rewrite()
|
inlinevirtual |
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 in mlir::OpInterfaceConversionPattern< SourceOp >, mlir::OpConversionPattern< SourceOp >, mlir::OpConversionPattern< Op >, mlir::OpConversionPattern< OpTy >, mlir::OpConversionPattern< SPIRVOp >, mlir::OpConversionPattern< async::YieldOp >, mlir::OpConversionPattern< cf::AssertOp >, mlir::ConvertOpToLLVMPattern< SourceOp >, mlir::ConvertOpToLLVMPattern< Op >, mlir::ConvertOpToLLVMPattern< gpu::PrintfOp >, mlir::ConvertOpToLLVMPattern< gpu::GPUFuncOp >, mlir::ConvertOpToLLVMPattern< gpu::ReturnOp >, mlir::ConvertOpToLLVMPattern< memref::TransposeOp >, and mlir::ConvertOpToLLVMPattern< cf::AssertOp >.
Definition at line 346 of file DialectConversion.h.
Member Data Documentation
◆ typeConverter
|
protected |
An optional type converter for use by this pattern.
Definition at line 389 of file DialectConversion.h.
Referenced by mlir::ConvertToLLVMPattern::createMemRefDescriptor(), mlir::ConvertToLLVMPattern::getElementPtrType(), mlir::ConvertToLLVMPattern::getSizeInBytes(), mlir::ConvertToLLVMPattern::isConvertibleAndHasIdentityMaps(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlir::GPUPrintfOpToHIPLowering::matchAndRewrite(), and mlir::GPUPrintfOpToLLVMCallLowering::matchAndRewrite().
The documentation for this class was generated from the following files:
- include/mlir/Transforms/DialectConversion.h
- lib/Transforms/Utils/DialectConversion.cpp
