Base class for operation conversions targeting the LLVM IR dialect. More...

#include "mlir/Conversion/LLVMCommon/Pattern.h"

Inheritance diagram for mlir::ConvertToLLVMPattern:

Public Member Functions
	ConvertToLLVMPattern (StringRef rootOpName, MLIRContext *context, const LLVMTypeConverter &typeConverter, PatternBenefit benefit=1)

Public Member Functions inherited from mlir::ConversionPattern
virtual void	rewrite (Operation *op, ArrayRef< Value > operands, ConversionPatternRewriter &rewriter) const
	Hook for derived classes to implement rewriting. More...

virtual void	rewrite (Operation *op, ArrayRef< ValueRange > operands, ConversionPatternRewriter &rewriter) const

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

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

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
LLVM::LLVMDialect &	getDialect () const
	Returns the LLVM dialect. More...

const LLVMTypeConverter *	getTypeConverter () const

Type	getIndexType () const
	Gets the MLIR type wrapping the LLVM integer type whose bit width is defined by the used type converter. More...

Type	getIntPtrType (unsigned addressSpace=0) const
	Gets the MLIR type wrapping the LLVM integer type whose bit width corresponds to that of a LLVM pointer type. More...

Type	getVoidType () const
	Gets the MLIR type wrapping the LLVM void type. More...

Type	getVoidPtrType () const
	Get the MLIR type wrapping the LLVM i8* type. More...

Value	getStridedElementPtr (Location loc, MemRefType type, Value memRefDesc, ValueRange indices, ConversionPatternRewriter &rewriter) const

bool	isConvertibleAndHasIdentityMaps (MemRefType type) const
	Returns if the given memref has identity maps and the element type is convertible to LLVM. More...

Type	getElementPtrType (MemRefType type) const
	Returns the type of a pointer to an element of the memref. More...

void	getMemRefDescriptorSizes (Location loc, MemRefType memRefType, ValueRange dynamicSizes, ConversionPatternRewriter &rewriter, SmallVectorImpl< Value > &sizes, SmallVectorImpl< Value > &strides, Value &size, bool sizeInBytes=true) const
	Computes sizes, strides and buffer size of `memRefType` with identity layout. More...

Value	getSizeInBytes (Location loc, Type type, ConversionPatternRewriter &rewriter) const
	Computes the size of type in bytes. More...

Value	getNumElements (Location loc, MemRefType memRefType, ValueRange dynamicSizes, ConversionPatternRewriter &rewriter) const
	Computes total number of elements for the given MemRef and dynamicSizes. More...

MemRefDescriptor	createMemRefDescriptor (Location loc, MemRefType memRefType, Value allocatedPtr, Value alignedPtr, ArrayRef< Value > sizes, ArrayRef< Value > strides, ConversionPatternRewriter &rewriter) const
	Creates and populates a canonical memref descriptor struct. More...

LogicalResult	copyUnrankedDescriptors (OpBuilder &builder, Location loc, TypeRange origTypes, SmallVectorImpl< Value > &operands, bool toDynamic) const
	Copies the memory descriptor for any operands that were unranked descriptors originally to heap-allocated memory (if toDynamic is true) or to stack-allocated memory (otherwise). More...

Protected Member Functions inherited from mlir::ConversionPattern
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...

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
static Value	createIndexAttrConstant (OpBuilder &builder, Location loc, Type resultType, int64_t value)
	Create a constant Op producing a value of `resultType` from an index-typed integer attribute. 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...

Protected Attributes inherited from mlir::ConversionPattern
const TypeConverter *	typeConverter = nullptr
	An optional type converter for use by this pattern. More...

Detailed Description

Base class for operation conversions targeting the LLVM IR dialect.

It provides the conversion patterns with access to the LLVMTypeConverter and the LowerToLLVMOptions. The class captures the LLVMTypeConverter and the LowerToLLVMOptions by reference meaning the references have to remain alive during the entire pattern lifetime.

Definition at line 41 of file Pattern.h.

Constructor & Destructor Documentation

◆ ConvertToLLVMPattern()

ConvertToLLVMPattern::ConvertToLLVMPattern	(	StringRef	rootOpName,
		MLIRContext *	context,
		const LLVMTypeConverter &	typeConverter,
		PatternBenefit	benefit = `1`
	)

Definition at line 22 of file Pattern.cpp.

Member Function Documentation

◆ copyUnrankedDescriptors()

LogicalResult ConvertToLLVMPattern::copyUnrankedDescriptors	(	OpBuilder &	builder,
		Location	loc,
		TypeRange	origTypes,
		SmallVectorImpl< Value > &	operands,
		bool	toDynamic
	)		const

protected

Copies the memory descriptor for any operands that were unranked descriptors originally to heap-allocated memory (if toDynamic is true) or to stack-allocated memory (otherwise).

Also frees the previously used memory (that is assumed to be heap-allocated) if toDynamic is false.

Definition at line 245 of file Pattern.cpp.

References mlir::UnrankedMemRefDescriptor::computeSizes(), mlir::LLVMTypeConverter::convertType(), mlir::OpBuilder::create(), mlir::get(), mlir::Pattern::getContext(), mlir::LLVMTypeConverter::getIndexType(), mlir::OpBuilder::getInsertionPoint(), mlir::LLVMTypeConverter::getMemRefAddressSpace(), getTypeConverter(), getVoidPtrType(), mlir::LLVM::lookupOrCreateFreeFn(), mlir::LLVM::lookupOrCreateMallocFn(), mlir::UnrankedMemRefDescriptor::memRefDescPtr(), mlir::UnrankedMemRefDescriptor::rank(), and mlir::UnrankedMemRefDescriptor::undef().

Referenced by mlir::GPUReturnOpLowering::matchAndRewrite().

◆ createIndexAttrConstant()

Value ConvertToLLVMPattern::createIndexAttrConstant	(	OpBuilder &	builder,
		Location	loc,
		Type	resultType,
		int64_t	value
	)

staticprotected

Create a constant Op producing a value of resultType from an index-typed integer attribute.

Definition at line 53 of file Pattern.cpp.

Referenced by createMemRefDescriptor(), getMemRefDescriptorSizes(), and getNumElements().

◆ createMemRefDescriptor()

MemRefDescriptor ConvertToLLVMPattern::createMemRefDescriptor	(	Location	loc,
		MemRefType	memRefType,
		Value	allocatedPtr,
		Value	alignedPtr,
		ArrayRef< Value >	sizes,
		ArrayRef< Value >	strides,
		ConversionPatternRewriter &	rewriter
	)		const

protected

Creates and populates a canonical memref descriptor struct.

Creates and populates the memref descriptor struct given all its fields.

Definition at line 216 of file Pattern.cpp.

References mlir::TypeConverter::convertType(), createIndexAttrConstant(), mlir::detail::enumerate(), getIndexType(), mlir::ConversionPattern::typeConverter, and mlir::MemRefDescriptor::undef().

Referenced by mlir::GPUDynamicSharedMemoryOpLowering::matchAndRewrite().

◆ getDialect()

LLVM::LLVMDialect & ConvertToLLVMPattern::getDialect ( ) const

protected

Returns the LLVM dialect.

Definition at line 32 of file Pattern.cpp.

References mlir::LLVMTypeConverter::getDialect(), and getTypeConverter().

Referenced by mlir::GPUFuncOpLowering::matchAndRewrite().

◆ getElementPtrType()

Type ConvertToLLVMPattern::getElementPtrType ( MemRefType type ) const

protected

Returns the type of a pointer to an element of the memref.

Definition at line 107 of file Pattern.cpp.

References mlir::get(), mlir::LLVMTypeConverter::getMemRefAddressSpace(), and getTypeConverter().

Referenced by mlir::AllocationOpLLVMLowering::allocateBufferAutoAlign(), and mlir::AllocationOpLLVMLowering::allocateBufferManuallyAlign().

◆ getIndexType()

Type ConvertToLLVMPattern::getIndexType ( ) const

protected

Gets the MLIR type wrapping the LLVM integer type whose bit width is defined by the used type converter.

Definition at line 36 of file Pattern.cpp.

References mlir::LLVMTypeConverter::getIndexType(), and getTypeConverter().

Referenced by createMemRefDescriptor(), getMemRefDescriptorSizes(), getNumElements(), and getSizeInBytes().

◆ getIntPtrType()

Type ConvertToLLVMPattern::getIntPtrType ( unsigned addressSpace = 0 ) const

protected

Gets the MLIR type wrapping the LLVM integer type whose bit width corresponds to that of a LLVM pointer type.

Definition at line 40 of file Pattern.cpp.

References mlir::get(), mlir::Pattern::getContext(), and getTypeConverter().

◆ getMemRefDescriptorSizes()

void ConvertToLLVMPattern::getMemRefDescriptorSizes	(	Location	loc,
		MemRefType	memRefType,
		ValueRange	dynamicSizes,
		ConversionPatternRewriter &	rewriter,
		SmallVectorImpl< Value > &	sizes,
		SmallVectorImpl< Value > &	strides,
		Value &	size,
		bool	sizeInBytes = `true`
	)		const

protected

Computes sizes, strides and buffer size of memRefType with identity layout.

Emits constant ops for the static sizes of memRefType, and uses dynamicSizes for the others. Emits instructions to compute strides and buffer size from these sizes.

For example, memref<4x?xf32> with sizeInBytes = true emits: sizes[0] = llvm.mlir.constant(4 : index) : i64 sizes[1] = dynamicSizes[0] strides[1] = llvm.mlir.constant(1 : index) : i64 strides[0] = sizes[0] size = llvm.mul sizes[0], sizes[1] : i64 nullptr = llvm.mlir.zero : !llvm.ptr gep = llvm.getelementptr nullptr[size] : (!llvm.ptr, i64) -> !llvm.ptr, f32 sizeBytes = llvm.ptrtoint gep : !llvm.ptr to i64

If sizeInBytes = false, memref<4x?xf32> emits: sizes[0] = llvm.mlir.constant(4 : index) : i64 sizes[1] = dynamicSizes[0] strides[1] = llvm.mlir.constant(1 : index) : i64 strides[0] = sizes[0] size = llvm.mul sizes[0], sizes[1] : i64

Definition at line 114 of file Pattern.cpp.

References mlir::TypeConverter::convertType(), mlir::OpBuilder::create(), createIndexAttrConstant(), mlir::get(), mlir::Builder::getContext(), getIndexType(), isConvertibleAndHasIdentityMaps(), and mlir::ConversionPattern::typeConverter.

Referenced by mlir::GPUDynamicSharedMemoryOpLowering::matchAndRewrite().

◆ getNumElements()

Value ConvertToLLVMPattern::getNumElements	(	Location	loc,
		MemRefType	memRefType,
		ValueRange	dynamicSizes,
		ConversionPatternRewriter &	rewriter
	)		const

protected

Computes total number of elements for the given MemRef and dynamicSizes.

Definition at line 184 of file Pattern.cpp.

References mlir::OpBuilder::create(), createIndexAttrConstant(), and getIndexType().

◆ getSizeInBytes()

Value ConvertToLLVMPattern::getSizeInBytes	(	Location	loc,
		Type	type,
		ConversionPatternRewriter &	rewriter
	)		const

protected

Computes the size of type in bytes.

Definition at line 169 of file Pattern.cpp.

References mlir::TypeConverter::convertType(), mlir::OpBuilder::create(), mlir::get(), mlir::Builder::getContext(), getIndexType(), and mlir::ConversionPattern::typeConverter.

Referenced by mlir::AllocationOpLLVMLowering::getAlignment().

◆ getStridedElementPtr()

Value ConvertToLLVMPattern::getStridedElementPtr	(	Location	loc,
		MemRefType	type,
		Value	memRefDesc,
		ValueRange	indices,
		ConversionPatternRewriter &	rewriter
	)		const

protected

Definition at line 61 of file Pattern.cpp.

◆ getTypeConverter()

const LLVMTypeConverter * ConvertToLLVMPattern::getTypeConverter ( ) const

protected

Definition at line 27 of file Pattern.cpp.

References mlir::ConversionPattern::getTypeConverter().

Referenced by mlir::AllocationOpLLVMLowering::allocateBufferAutoAlign(), mlir::AllocationOpLLVMLowering::allocateBufferManuallyAlign(), copyUnrankedDescriptors(), getDialect(), getElementPtrType(), getIndexType(), getIntPtrType(), getVoidPtrType(), getVoidType(), mlir::GPUDynamicSharedMemoryOpLowering::matchAndRewrite(), mlir::GPUFuncOpLowering::matchAndRewrite(), and mlir::GPUReturnOpLowering::matchAndRewrite().

◆ getVoidPtrType()

Type ConvertToLLVMPattern::getVoidPtrType ( ) const

protected

Get the MLIR type wrapping the LLVM i8* type.

Definition at line 49 of file Pattern.cpp.

References mlir::get(), mlir::Pattern::getContext(), and getTypeConverter().

Referenced by copyUnrankedDescriptors().

◆ getVoidType()

Type ConvertToLLVMPattern::getVoidType ( ) const

protected

Gets the MLIR type wrapping the LLVM void type.

Definition at line 45 of file Pattern.cpp.

References mlir::get(), mlir::Pattern::getContext(), and getTypeConverter().

◆ isConvertibleAndHasIdentityMaps()

bool ConvertToLLVMPattern::isConvertibleAndHasIdentityMaps ( MemRefType type ) const

protected

Returns if the given memref has identity maps and the element type is convertible to LLVM.

Definition at line 100 of file Pattern.cpp.

References mlir::TypeConverter::convertType(), and mlir::ConversionPattern::typeConverter.

Referenced by getMemRefDescriptorSizes().

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

include/mlir/Conversion/LLVMCommon/Pattern.h
lib/Conversion/LLVMCommon/Pattern.cpp

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConvertToLLVMPattern()

Member Function Documentation

◆ copyUnrankedDescriptors()

◆ createIndexAttrConstant()

◆ createMemRefDescriptor()

◆ getDialect()

◆ getElementPtrType()

◆ getIndexType()

◆ getIntPtrType()

◆ getMemRefDescriptorSizes()

◆ getNumElements()

◆ getSizeInBytes()

◆ getStridedElementPtr()

◆ getTypeConverter()

◆ getVoidPtrType()

◆ getVoidType()

◆ isConvertibleAndHasIdentityMaps()