Helper class to produce LLVM dialect operations extracting or inserting elements of a MemRef descriptor. More...

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

Inheritance diagram for mlir::MemRefDescriptor:

Public Member Functions
	MemRefDescriptor (Value descriptor)
	Construct a helper for the given descriptor value.
Value	allocatedPtr (OpBuilder &builder, Location loc)
	Builds IR extracting the allocated pointer from the descriptor.
void	setAllocatedPtr (OpBuilder &builder, Location loc, Value ptr)
	Builds IR inserting the allocated pointer into the descriptor.
Value	alignedPtr (OpBuilder &builder, Location loc)
	Builds IR extracting the aligned pointer from the descriptor.
void	setAlignedPtr (OpBuilder &builder, Location loc, Value ptr)
	Builds IR inserting the aligned pointer into the descriptor.
Value	offset (OpBuilder &builder, Location loc)
	Builds IR extracting the offset from the descriptor.
void	setOffset (OpBuilder &builder, Location loc, Value offset)
	Builds IR inserting the offset into the descriptor.
void	setConstantOffset (OpBuilder &builder, Location loc, uint64_t offset)
	Builds IR inserting the offset into the descriptor.
Value	size (OpBuilder &builder, Location loc, unsigned pos)
	Builds IR extracting the pos-th size from the descriptor.
Value	size (OpBuilder &builder, Location loc, Value pos, int64_t rank)
void	setSize (OpBuilder &builder, Location loc, unsigned pos, Value size)
	Builds IR inserting the pos-th size into the descriptor.
void	setConstantSize (OpBuilder &builder, Location loc, unsigned pos, uint64_t size)
Value	stride (OpBuilder &builder, Location loc, unsigned pos)
	Builds IR extracting the pos-th size from the descriptor.
void	setStride (OpBuilder &builder, Location loc, unsigned pos, Value stride)
	Builds IR inserting the pos-th stride into the descriptor.
void	setConstantStride (OpBuilder &builder, Location loc, unsigned pos, uint64_t stride)
Type	getIndexType ()
	Returns the type of array element in this descriptor.
LLVM::LLVMPointerType	getElementPtrType ()
	Returns the (LLVM) pointer type this descriptor contains.
Value	bufferPtr (OpBuilder &builder, Location loc, const LLVMTypeConverter &converter, MemRefType type)
	Builds IR for getting the start address of the buffer represented by this memref: memref.alignedPtr + memref.offset * sizeof(type.getElementType()).
Public Member Functions inherited from mlir::StructBuilder
	StructBuilder (Value v)
	Construct a helper for the given value.
	operator Value ()

Static Public Member Functions
static MemRefDescriptor	poison (OpBuilder &builder, Location loc, Type descriptorType)
	Builds IR creating a poison value of the descriptor type.
static MemRefDescriptor	fromStaticShape (OpBuilder &builder, Location loc, const LLVMTypeConverter &typeConverter, MemRefType type, Value memory)
	Builds IR creating a MemRef descriptor that represents type and populates it with static shape and stride information extracted from the type.
static MemRefDescriptor	fromStaticShape (OpBuilder &builder, Location loc, const LLVMTypeConverter &typeConverter, MemRefType type, Value memory, Value alignedMemory)
static Value	pack (OpBuilder &builder, Location loc, const LLVMTypeConverter &converter, MemRefType type, ValueRange values)
	Builds IR populating a MemRef descriptor structure from a list of individual values composing that descriptor, in the following order:
static void	unpack (OpBuilder &builder, Location loc, Value packed, MemRefType type, SmallVectorImpl< Value > &results)
	Builds IR extracting individual elements of a MemRef descriptor structure and returning them as results list.
static unsigned	getNumUnpackedValues (MemRefType type)
	Returns the number of non-aggregate values that would be produced by unpack.
Static Public Member Functions inherited from mlir::StructBuilder
static StructBuilder	poison (OpBuilder &builder, Location loc, Type descriptorType)
	Builds IR creating a poison value of the descriptor type.

Additional Inherited Members
Protected Member Functions inherited from mlir::StructBuilder
Value	extractPtr (OpBuilder &builder, Location loc, unsigned pos) const
	Builds IR to extract a value from the struct at position pos.
void	setPtr (OpBuilder &builder, Location loc, unsigned pos, Value ptr)
	Builds IR to set a value in the struct at position pos.
Protected Attributes inherited from mlir::StructBuilder
Value	value
Type	structType

Detailed Description

Helper class to produce LLVM dialect operations extracting or inserting elements of a MemRef descriptor.

Wraps a Value pointing to the descriptor. The Value may be null, in which case none of the operations are valid.

Definition at line 33 of file MemRefBuilder.h.

Constructor & Destructor Documentation

◆ MemRefDescriptor()

MemRefDescriptor< T, N >::MemRefDescriptor ( Value descriptor )

explicit

Construct a helper for the given descriptor value.

Definition at line 24 of file MemRefBuilder.cpp.

References kOffsetPosInMemRefDescriptor, MemRefDescriptor(), mlir::StructBuilder::StructBuilder(), and mlir::StructBuilder::value.

Referenced by fromStaticShape(), MemRefDescriptor(), poison(), and unpack().

Member Function Documentation

◆ alignedPtr()

Value MemRefDescriptor< T, N >::alignedPtr	(	OpBuilder &	builder,
		Location	loc )

Builds IR extracting the aligned pointer from the descriptor.

Definition at line 88 of file MemRefBuilder.cpp.

References mlir::StructBuilder::extractPtr(), and kAlignedPtrPosInMemRefDescriptor.

Referenced by bufferPtr(), mlir::LLVMTypeConverter::promoteOperands(), and unpack().

◆ allocatedPtr()

Value MemRefDescriptor< T, N >::allocatedPtr	(	OpBuilder &	builder,
		Location	loc )

Builds IR extracting the allocated pointer from the descriptor.

Definition at line 77 of file MemRefBuilder.cpp.

References mlir::StructBuilder::extractPtr(), and kAllocatedPtrPosInMemRefDescriptor.

Referenced by mlir::GPUReturnOpLowering::matchAndRewrite(), and unpack().

◆ bufferPtr()

Value MemRefDescriptor< T, N >::bufferPtr	(	OpBuilder &	builder,
		Location	loc,
		const LLVMTypeConverter &	converter,
		MemRefType	type )

Builds IR for getting the start address of the buffer represented by this memref: memref.alignedPtr + memref.offset * sizeof(type.getElementType()).

Note: there is no setter for this one since it is derived from alignedPtr and offset.

Definition at line 195 of file MemRefBuilder.cpp.

References alignedPtr(), createIndexAttrConstant(), mlir::LLVMTypeConverter::getIndexType(), and offset().

Referenced by getMemrefBuffPtr(), and mlir::LLVM::getStridedElementPtr().

◆ fromStaticShape() [1/2]

MemRefDescriptor MemRefDescriptor< T, N >::fromStaticShape	(	OpBuilder &	builder,
		Location	loc,
		const LLVMTypeConverter &	typeConverter,
		MemRefType	type,
		Value	memory )

static

Builds IR creating a MemRef descriptor that represents type and populates it with static shape and stride information extracted from the type.

Definition at line 43 of file MemRefBuilder.cpp.

References fromStaticShape().

Referenced by fromStaticShape(), mlir::GPUFuncOpLowering::matchAndRewrite(), and packRankedMemRefDesc().

◆ fromStaticShape() [2/2]

MemRefDescriptor MemRefDescriptor< T, N >::fromStaticShape	(	OpBuilder &	builder,
		Location	loc,
		const LLVMTypeConverter &	typeConverter,
		MemRefType	type,
		Value	memory,
		Value	alignedMemory )