MLIR  16.0.0git
Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
mlir::ConvertToLLVMPattern Class Reference

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

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

+ Inheritance diagram for mlir::ConvertToLLVMPattern:
+ Collaboration diagram for mlir::ConvertToLLVMPattern:

Public Member Functions

 ConvertToLLVMPattern (StringRef rootOpName, MLIRContext *context, 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 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...
 
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...
 
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< 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 Member Functions

LLVM::LLVMDialect & getDialect () const
 Returns the LLVM dialect. More...
 
LLVMTypeConvertergetTypeConverter () 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 createIndexConstant (ConversionPatternRewriter &builder, Location loc, uint64_t value) const
 Create an LLVM dialect operation defining the given index constant. 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 &sizeBytes) const
 Computes sizes, strides and buffer size in bytes 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, ArrayRef< Value > shape, ConversionPatternRewriter &rewriter) const
 Computes total number of elements for the given shape. 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 (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::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
TypeConvertertypeConverter = 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 37 of file Pattern.h.

Constructor & Destructor Documentation

◆ ConvertToLLVMPattern()

ConvertToLLVMPattern::ConvertToLLVMPattern ( StringRef  rootOpName,
MLIRContext context,
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 226 of file Pattern.cpp.

References mlir::UnrankedMemRefDescriptor::computeSizes(), mlir::LLVMTypeConverter::convertType(), mlir::OpBuilder::create(), mlir::failure(), mlir::Builder::getBoolAttr(), mlir::Builder::getContext(), mlir::LLVMTypeConverter::getIndexType(), mlir::OpBuilder::getInsertionPoint(), getTypeConverter(), mlir::Type::isa(), mlir::LLVM::lookupOrCreateFreeFn(), mlir::LLVM::lookupOrCreateMallocFn(), mlir::UnrankedMemRefDescriptor::memRefDescPtr(), mlir::UnrankedMemRefDescriptor::rank(), mlir::success(), and mlir::UnrankedMemRefDescriptor::undef().

◆ 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 55 of file Pattern.cpp.

References mlir::OpBuilder::create(), mlir::Builder::getIndexAttr(), and value.

Referenced by mlir::AllocationOpLLVMLowering::createAligned(), and createIndexConstant().

◆ createIndexConstant()

Value ConvertToLLVMPattern::createIndexConstant ( ConversionPatternRewriter builder,
Location  loc,
uint64_t  value 
) const
protected

Create an LLVM dialect operation defining the given index constant.

Definition at line 63 of file Pattern.cpp.

References createIndexAttrConstant(), getIndexType(), and value.

Referenced by mlir::AllocationOpLLVMLowering::createIndexConstant(), 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 198 of file Pattern.cpp.

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

◆ getDialect()

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

Returns the LLVM dialect.

Definition at line 33 of file Pattern.cpp.

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

◆ getElementPtrType()

Type ConvertToLLVMPattern::getElementPtrType ( MemRefType  type) const
protected

◆ 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 37 of file Pattern.cpp.

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

Referenced by createIndexConstant(), getMemRefDescriptorSizes(), 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 41 of file Pattern.cpp.

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

◆ getMemRefDescriptorSizes()

void ConvertToLLVMPattern::getMemRefDescriptorSizes ( Location  loc,
MemRefType  memRefType,
ValueRange  dynamicSizes,
ConversionPatternRewriter rewriter,
SmallVectorImpl< Value > &  sizes,
SmallVectorImpl< Value > &  strides,
Value sizeBytes 
) const
protected

Computes sizes, strides and buffer size in bytes 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> 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.null : !llvm.ptr<f32> gep = llvm.getelementptr nullptr[size] : (!llvm.ptr<f32>, i64) -> !llvm.ptr<f32> sizeBytes = llvm.ptrtoint gep : !llvm.ptr<f32> to i64

Definition at line 120 of file Pattern.cpp.

References mlir::OpBuilder::create(), createIndexConstant(), getElementPtrType(), getIndexType(), and isConvertibleAndHasIdentityMaps().

◆ getNumElements()

Value ConvertToLLVMPattern::getNumElements ( Location  loc,
ArrayRef< Value shape,
ConversionPatternRewriter rewriter 
) const
protected

Computes total number of elements for the given shape.

Definition at line 186 of file Pattern.cpp.

References mlir::OpBuilder::create(), and createIndexConstant().

◆ getSizeInBytes()

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

◆ getStridedElementPtr()

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

Definition at line 68 of file Pattern.cpp.

◆ getTypeConverter()

LLVMTypeConverter * ConvertToLLVMPattern::getTypeConverter ( ) const
protected

◆ getVoidPtrType()

Type ConvertToLLVMPattern::getVoidPtrType ( ) const
protected

Get the MLIR type wrapping the LLVM i8* type.

Definition at line 50 of file Pattern.cpp.

◆ getVoidType()

Type ConvertToLLVMPattern::getVoidType ( ) const
protected

Gets the MLIR type wrapping the LLVM void type.

Definition at line 46 of file Pattern.cpp.

References 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 106 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: