Base class for the conversion patterns. More...

#include "mlir/Transforms/DialectConversion.h"

Inheritance diagram for mlir::ConversionPattern:

Public Types
using	OpAdaptor = ArrayRef< Value >

using	OneToNOpAdaptor = ArrayRef< ValueRange >

Public Member Functions
virtual LogicalResult	matchAndRewrite (Operation *op, ArrayRef< Value > operands, ConversionPatternRewriter &rewriter) const
	Hook for derived classes to implement combined matching and rewriting. More...

virtual LogicalResult	matchAndRewrite (Operation *op, ArrayRef< ValueRange > 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...

const 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, const ConverterTy * >	getTypeConverter () const

Public Member Functions inherited from mlir::RewritePattern
virtual	~RewritePattern ()=default

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...

std::optional< OperationName >	getRootKind () const
	Return the root node that this pattern matches. More...

std::optional< TypeID >	getRootInterfaceID () const
	Return the interface ID used to match the root operation of this pattern. More...

std::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 (const TypeConverter &typeConverter, Args &&...args)
	Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern. More...

FailureOr< SmallVector< Value > >	getOneToOneAdaptorOperands (ArrayRef< ValueRange > operands) const
	Given an array of value ranges, which are the inputs to a 1:N adaptor, try to extract the single value of each range to construct a the inputs for a 1:1 adaptor. More...

Protected Member Functions inherited from mlir::RewritePattern
	Pattern (StringRef rootName, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
	Inherit the base constructors from `Pattern`. More...

	Pattern (MatchAnyOpTypeTag tag, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
	Inherit the base constructors from `Pattern`. More...

	Pattern (MatchInterfaceOpTypeTag tag, TypeID interfaceID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
	Inherit the base constructors from `Pattern`. More...

	Pattern (MatchTraitOpTypeTag tag, TypeID traitID, PatternBenefit benefit, MLIRContext *context, ArrayRef< StringRef > generatedNames={})
	Inherit the base constructors from `Pattern`. 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...

Static Protected Member Functions
template<typename SelfPattern , typename SourceOp >
static LogicalResult	dispatchTo1To1 (const SelfPattern &self, SourceOp op, ArrayRef< ValueRange > operands, ConversionPatternRewriter &rewriter)
	Overloaded method used to dispatch to the 1:1 'matchAndRewrite' method if possible and emit diagnostic with a failure return value otherwise. More...

template<typename SelfPattern , typename SourceOp >
static LogicalResult	dispatchTo1To1 (const SelfPattern &self, SourceOp op, typename SourceOp::template GenericAdaptor< ArrayRef< ValueRange >> adaptor, ConversionPatternRewriter &rewriter)
	Same as above, but accepts an adaptor as operand. More...

Protected Attributes
const 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 591 of file DialectConversion.h.

Member Typedef Documentation

◆ OneToNOpAdaptor

using mlir::ConversionPattern::OneToNOpAdaptor = ArrayRef<ValueRange>

Definition at line 594 of file DialectConversion.h.

◆ OpAdaptor

using mlir::ConversionPattern::OpAdaptor = ArrayRef<Value>

Definition at line 593 of file DialectConversion.h.

Constructor & Destructor Documentation

◆ ConversionPattern()

template<typename... Args>

mlir::ConversionPattern::ConversionPattern	(	const TypeConverter &	typeConverter,
		Args &&...	args
	)

inlineprotected

Construct a conversion pattern with the given converter, and forward the remaining arguments to RewritePattern.

Definition at line 636 of file DialectConversion.h.

Member Function Documentation

◆ dispatchTo1To1() [1/2]

template<typename SelfPattern , typename SourceOp >

LogicalResult mlir::ConversionPattern::dispatchTo1To1	(	const SelfPattern &	self,
		SourceOp	op,
		ArrayRef< ValueRange >	operands,
		ConversionPatternRewriter &	rewriter
	)

staticprotected

Overloaded method used to dispatch to the 1:1 'matchAndRewrite' method if possible and emit diagnostic with a failure return value otherwise.

'self' should be '*this' of the derived-pattern and is used to dispatch to the correct 'matchAndRewrite' method in the derived pattern.

Definition at line 963 of file DialectConversion.h.

References mlir::remark::failed(), mlir::Pattern::getDebugName(), and mlir::RewriterBase::notifyMatchFailure().

Referenced by matchAndRewrite(), mlir::ConvertOpInterfaceToLLVMPattern< SourceOp >::matchAndRewrite(), mlir::OpInterfaceConversionPattern< SourceOp >::matchAndRewrite(), mlir::ConvertOpToLLVMPattern< SourceOp >::matchAndRewrite(), and mlir::OpConversionPattern< SourceOp >::matchAndRewrite().

◆ dispatchTo1To1() [2/2]

template<typename SelfPattern , typename SourceOp >

LogicalResult mlir::ConversionPattern::dispatchTo1To1	(	const SelfPattern &	self,
		SourceOp	op,
		typename SourceOp::template GenericAdaptor< ArrayRef< ValueRange >>	adaptor,
		ConversionPatternRewriter &	rewriter
	)

staticprotected

Same as above, but accepts an adaptor as operand.

Definition at line 976 of file DialectConversion.h.

References mlir::remark::failed(), mlir::Pattern::getDebugName(), and mlir::RewriterBase::notifyMatchFailure().

◆ getOneToOneAdaptorOperands()

FailureOr< SmallVector< Value > > ConversionPattern::getOneToOneAdaptorOperands ( ArrayRef< ValueRange > operands ) const

protected

Given an array of value ranges, which are the inputs to a 1:N adaptor, try to extract the single value of each range to construct a the inputs for a 1:1 adaptor.

Returns failure if at least one range has 0 or more than 1 value.

Definition at line 2261 of file DialectConversion.cpp.

◆ getTypeConverter() [1/2]

const TypeConverter* mlir::ConversionPattern::getTypeConverter ( ) const

inline

Return the type converter held by this pattern, or nullptr if the pattern does not require type conversion.

Definition at line 620 of file DialectConversion.h.

References typeConverter.

Referenced by mlir::ConvertToLLVMPattern::getTypeConverter(), and mlir::spirv::ElementwiseOpPattern< Op, SPIRVOp >::matchAndRewrite().

◆ getTypeConverter() [2/2]

template<typename ConverterTy >

std::enable_if_t<std::is_base_of<TypeConverter, ConverterTy>::value, const ConverterTy *> mlir::ConversionPattern::getTypeConverter ( ) const

inline

Definition at line 625 of file DialectConversion.h.

References typeConverter.

◆ matchAndRewrite() [1/3]

virtual LogicalResult mlir::ConversionPattern::matchAndRewrite	(	Operation *	op,
		ArrayRef< Value >	operands,
		ConversionPatternRewriter &	rewriter
	)		const

inlinevirtual

Hook for derived classes to implement combined matching and rewriting.

This overload supports only 1:1 replacements. The 1:N overload is called by the driver. By default, it calls this 1:1 overload or fails to match if 1:N replacements were found.

Definition at line 601 of file DialectConversion.h.

◆ matchAndRewrite() [2/3]

virtual LogicalResult mlir::ConversionPattern::matchAndRewrite	(	Operation *	op,
		ArrayRef< ValueRange >	operands,
		ConversionPatternRewriter &	rewriter
	)		const

inlinevirtual

Hook for derived classes to implement combined matching and rewriting.

This overload supports 1:N replacements.

Definition at line 609 of file DialectConversion.h.

References dispatchTo1To1().

◆ matchAndRewrite() [3/3]

LogicalResult ConversionPattern::matchAndRewrite	(	Operation *	op,
		PatternRewriter &	rewriter
	)		const

finalvirtual

Attempt to match and rewrite the IR root at the specified operation.

Implements mlir::RewritePattern.

Definition at line 2275 of file DialectConversion.cpp.

References mlir::detail::ConversionPatternRewriterImpl::currentTypeConverter, mlir::remark::failed(), mlir::Operation::getLoc(), mlir::Operation::getOperands(), and mlir::detail::ConversionPatternRewriterImpl::remapValues().

Member Data Documentation

◆ typeConverter

const TypeConverter* mlir::ConversionPattern::typeConverter = nullptr

protected

An optional type converter for use by this pattern.

Definition at line 666 of file DialectConversion.h.

Referenced by mlir::ConvertToLLVMPattern::createMemRefDescriptor(), mlir::ConvertToLLVMPattern::getMemRefDescriptorSizes(), mlir::ConvertToLLVMPattern::getSizeInBytes(), getTypeConverter(), mlir::ConvertToLLVMPattern::isConvertibleAndHasIdentityMaps(), mlir::GPUDynamicSharedMemoryOpLowering::matchAndRewrite(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlir::GPUPrintfOpToHIPLowering::matchAndRewrite(), mlir::GPUPrintfOpToLLVMCallLowering::matchAndRewrite(), and mlir::GPUPrintfOpToVPrintfLowering::matchAndRewrite().

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

include/mlir/Transforms/DialectConversion.h
lib/Transforms/Utils/DialectConversion.cpp

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members