MLIR  19.0.0git
Public Member Functions | Protected Member Functions | List of all members
mlir::AllocLikeOpLLVMLowering Struct Referenceabstract

Lowering for AllocOp and AllocaOp. More...

#include "mlir/Conversion/MemRefToLLVM/AllocLikeConversion.h"

+ Inheritance diagram for mlir::AllocLikeOpLLVMLowering:

Public Member Functions

 AllocLikeOpLLVMLowering (StringRef opName, const LLVMTypeConverter &converter, PatternBenefit benefit=1)
 
- Public Member Functions inherited from mlir::AllocationOpLLVMLowering
 AllocationOpLLVMLowering (StringRef opName, const LLVMTypeConverter &converter, PatternBenefit benefit=1)
 
Type getIndexType () const
 Gets the MLIR type wrapping the LLVM integer type whose bit width is defined by the used type converter. More...
 
Type getVoidPtrType () const
 Get the MLIR type wrapping the LLVM i8* type. More...
 
- Public Member Functions inherited from mlir::ConvertToLLVMPattern
 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...
 
LogicalResult matchAndRewrite (Operation *op, PatternRewriter &rewriter) const final
 Attempt to match and rewrite the IR root at the specified operation. More...
 
const 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, 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< OperationNamegetGeneratedOps () const
 Return a list of operations that may be generated when rewriting an operation instance with this pattern. More...
 
std::optional< OperationNamegetRootKind () const
 Return the root node that this pattern matches. More...
 
std::optional< TypeIDgetRootInterfaceID () const
 Return the interface ID used to match the root operation of this pattern. More...
 
std::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

virtual std::tuple< Value, ValueallocateBuffer (ConversionPatternRewriter &rewriter, Location loc, Value size, Operation *op) const =0
 Allocates the underlying buffer. More...
 
void setRequiresNumElements ()
 Sets the flag 'requiresNumElements', specifying the Op requires the number of elements instead of the size in bytes. More...
 
- Protected Member Functions inherited from mlir::AllocationOpLLVMLowering
template<typename OpType >
Value getAlignment (ConversionPatternRewriter &rewriter, Location loc, OpType op) const
 Computes the alignment for the given memory allocation op. More...
 
template<typename OpType >
int64_t alignedAllocationGetAlignment (ConversionPatternRewriter &rewriter, Location loc, OpType op, const DataLayout *defaultLayout) const
 Computes the alignment for aligned_alloc used to allocate the buffer for the memory allocation op. More...
 
std::tuple< Value, ValueallocateBufferManuallyAlign (ConversionPatternRewriter &rewriter, Location loc, Value sizeBytes, Operation *op, Value alignment) const
 Allocates a memory buffer using an allocation method that doesn't guarantee alignment. More...
 
Value allocateBufferAutoAlign (ConversionPatternRewriter &rewriter, Location loc, Value sizeBytes, Operation *op, const DataLayout *defaultLayout, int64_t alignment) const
 Allocates a memory buffer using an aligned allocation method. More...
 
- Protected Member Functions inherited from mlir::ConvertToLLVMPattern
LLVM::LLVMDialect & getDialect () const
 Returns the LLVM dialect. More...
 
const 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 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...
 
- 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from mlir::AllocationOpLLVMLowering
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...
 
- 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...
 
- Static Protected Member Functions inherited from mlir::AllocationOpLLVMLowering
static Value createAligned (ConversionPatternRewriter &rewriter, Location loc, Value input, Value alignment)
 Computes the aligned value for 'input' as follows: bumped = input + alignement - 1 aligned = bumped - bumped % alignment. More...
 
static MemRefType getMemRefResultType (Operation *op)
 
- Static Protected Member Functions inherited from mlir::ConvertToLLVMPattern
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...
 
- Protected Attributes inherited from mlir::ConversionPattern
const TypeConvertertypeConverter = nullptr
 An optional type converter for use by this pattern. More...
 

Detailed Description

Lowering for AllocOp and AllocaOp.

Definition at line 108 of file AllocLikeConversion.h.

Constructor & Destructor Documentation

◆ AllocLikeOpLLVMLowering()

mlir::AllocLikeOpLLVMLowering::AllocLikeOpLLVMLowering ( StringRef  opName,
const LLVMTypeConverter converter,
PatternBenefit  benefit = 1 
)
inlineexplicit

Definition at line 109 of file AllocLikeConversion.h.

Member Function Documentation

◆ allocateBuffer()

virtual std::tuple<Value, Value> mlir::AllocLikeOpLLVMLowering::allocateBuffer ( ConversionPatternRewriter rewriter,
Location  loc,
Value  size,
Operation op 
) const
protectedpure virtual

Allocates the underlying buffer.

Returns the allocated pointer and the aligned pointer.

◆ setRequiresNumElements()

void AllocLikeOpLLVMLowering::setRequiresNumElements ( )
protected

Sets the flag 'requiresNumElements', specifying the Op requires the number of elements instead of the size in bytes.

Definition at line 155 of file AllocLikeConversion.cpp.


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