Conversion from types to the LLVM IR dialect. More...

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

Inheritance diagram for mlir::LLVMTypeConverter:

Collaboration diagram for mlir::LLVMTypeConverter:

Public Member Functions
	LLVMTypeConverter (MLIRContext ctx, const DataLayoutAnalysis analysis=nullptr)
	Create an LLVMTypeConverter using the default LowerToLLVMOptions. More...

	LLVMTypeConverter (MLIRContext ctx, const LowerToLLVMOptions &options, const DataLayoutAnalysis analysis=nullptr)
	Create an LLVMTypeConverter using custom LowerToLLVMOptions. More...

Type	convertFunctionSignature (FunctionType funcTy, bool isVariadic, SignatureConversion &result)
	Convert a function type. More...

Type	packFunctionResults (TypeRange types)
	Convert a non-empty list of types to be returned from a function into a supported LLVM IR type. More...

Type	convertCallingConventionType (Type type)
	Convert a type in the context of the default or bare pointer calling convention. More...

void	promoteBarePtrsToDescriptors (ConversionPatternRewriter &rewriter, Location loc, ArrayRef< Type > stdTypes, SmallVectorImpl< Value > &values)
	Promote the bare pointers in 'values' that resulted from memrefs to descriptors. More...

MLIRContext &	getContext ()
	Returns the MLIR context. More...

LLVM::LLVMDialect *	getDialect ()
	Returns the LLVM dialect. More...

const LowerToLLVMOptions &	getOptions () const

void	dangerousSetOptions (LowerToLLVMOptions newOptions)
	Set the lowering options to `newOptions`. More...

SmallVector< Value, 4 >	promoteOperands (Location loc, ValueRange opOperands, ValueRange operands, OpBuilder &builder)
	Promote the LLVM representation of all operands including promoting MemRef descriptors to stack and use pointers to struct to avoid the complexity of the platform-specific C/C++ ABI lowering related to struct argument passing. More...

Value	promoteOneMemRefDescriptor (Location loc, Value operand, OpBuilder &builder)
	Promote the LLVM struct representation of one MemRef descriptor to stack and use pointer to struct to avoid the complexity of the platform-specific C/C++ ABI lowering related to struct argument passing. More...

std::pair< Type, bool >	convertFunctionTypeCWrapper (FunctionType type)
	Converts the function type to a C-compatible format, in particular using pointers to memref descriptors for arguments. More...

const llvm::DataLayout &	getDataLayout ()
	Returns the data layout to use during and after conversion. More...

const DataLayoutAnalysis *	getDataLayoutAnalysis () const
	Returns the data layout analysis to query during conversion. More...

Type	getIndexType ()
	Gets the LLVM representation of the index type. More...

unsigned	getIndexTypeBitwidth ()
	Gets the bitwidth of the index type when converted to LLVM. More...

unsigned	getPointerBitwidth (unsigned addressSpace=0)
	Gets the pointer bitwidth. More...

unsigned	getMemRefDescriptorSize (MemRefType type, const DataLayout &layout)
	Returns the size of the memref descriptor object in bytes. More...

unsigned	getUnrankedMemRefDescriptorSize (UnrankedMemRefType type, const DataLayout &layout)
	Returns the size of the unranked memref descriptor object in bytes. More...

LogicalResult	convertType (Type t, SmallVectorImpl< Type > &results)
	Convert the given type. More...

Type	convertType (Type t)
	This hook simplifies defining 1-1 type conversions. More...

Public Member Functions inherited from mlir::TypeConverter
template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<0>>
void	addConversion (FnT &&callback)
	Register a conversion function. More...

template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<1>>
void	addArgumentMaterialization (FnT &&callback)
	Register a materialization function, which must be convertible to the following form: `std::optional<Value>(OpBuilder &, T, ValueRange, Location)`, where `T` is any subclass of `Type`. More...

template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<1>>
void	addSourceMaterialization (FnT &&callback)
	This method registers a materialization that will be called when converting a legal type to an illegal source type. More...

template<typename FnT , typename T = typename llvm::function_traits< std::decay_t<FnT>>::template arg_t<1>>
void	addTargetMaterialization (FnT &&callback)
	This method registers a materialization that will be called when converting type from an illegal, or source, type to a legal type. More...

LogicalResult	convertType (Type t, SmallVectorImpl< Type > &results)
	Convert the given type. More...

Type	convertType (Type t)
	This hook simplifies defining 1-1 type conversions. More...

LogicalResult	convertTypes (TypeRange types, SmallVectorImpl< Type > &results)
	Convert the given set of types, filling 'results' as necessary. More...

bool	isLegal (Type type)
	Return true if the given type is legal for this type converter, i.e. More...

template<typename RangeT >
std::enable_if_t<!std::is_convertible< RangeT, Type >::value &&!std::is_convertible< RangeT, Operation * >::value, bool >	isLegal (RangeT &&range)
	Return true if all of the given types are legal for this type converter. More...

bool	isLegal (Operation *op)
	Return true if the given operation has legal operand and result types. More...

bool	isLegal (Region *region)
	Return true if the types of block arguments within the region are legal. More...

bool	isSignatureLegal (FunctionType ty)
	Return true if the inputs and outputs of the given function type are legal. More...

LogicalResult	convertSignatureArg (unsigned inputNo, Type type, SignatureConversion &result)
	This method allows for converting a specific argument of a signature. More...

LogicalResult	convertSignatureArgs (TypeRange types, SignatureConversion &result, unsigned origInputOffset=0)

std::optional< SignatureConversion >	convertBlockSignature (Block *block)
	This function converts the type signature of the given block, by invoking 'convertSignatureArg' for each argument. More...

Value	materializeArgumentConversion (OpBuilder &builder, Location loc, Type resultType, ValueRange inputs)
	Materialize a conversion from a set of types into one result type by generating a cast sequence of some kind. More...

Value	materializeSourceConversion (OpBuilder &builder, Location loc, Type resultType, ValueRange inputs)

Value	materializeTargetConversion (OpBuilder &builder, Location loc, Type resultType, ValueRange inputs)

Static Public Member Functions
static bool	canConvertToBarePtr (BaseMemRefType type)
	Check if a memref type can be converted to a bare pointer. More...

Protected Attributes
LLVM::LLVMDialect *	llvmDialect
	Pointer to the LLVM dialect. More...

Friends
LogicalResult	structFuncArgTypeConverter (LLVMTypeConverter &converter, Type type, SmallVectorImpl< Type > &result)
	Give structFuncArgTypeConverter access to memref-specific functions. More...

Detailed Description

Conversion from types to the LLVM IR dialect.

Definition at line 30 of file TypeConverter.h.

Constructor & Destructor Documentation

◆ LLVMTypeConverter() [1/2]

LLVMTypeConverter::LLVMTypeConverter	(	MLIRContext *	ctx,
		const DataLayoutAnalysis *	analysis = `nullptr`
	)

Create an LLVMTypeConverter using the default LowerToLLVMOptions.

Create an LLVMTypeConverter using default LowerToLLVMOptions.

Optionally takes a data layout analysis to use in conversions.

Definition at line 18 of file TypeConverter.cpp.

◆ LLVMTypeConverter() [2/2]

LLVMTypeConverter::LLVMTypeConverter	(	MLIRContext *	ctx,
		const LowerToLLVMOptions &	options,
		const DataLayoutAnalysis *	analysis = `nullptr`
	)

Create an LLVMTypeConverter using custom LowerToLLVMOptions.

Optionally takes a data layout analysis to use in conversions.

Definition at line 23 of file TypeConverter.cpp.

References mlir::TypeConverter::addArgumentMaterialization(), mlir::TypeConverter::addConversion(), mlir::TypeConverter::addSourceMaterialization(), mlir::TypeConverter::addTargetMaterialization(), convertType(), mlir::TypeConverter::convertTypes(), mlir::OpBuilder::create(), mlir::failed(), mlir::failure(), mlir::LLVM::LLVMStructType::getIdentified(), mlir::LLVM::LLVMStructType::getLiteral(), mlir::Operation::getResult(), mlir::LLVM::isCompatibleType(), llvmDialect, mlir::MemRefDescriptor::pack(), mlir::UnrankedMemRefDescriptor::pack(), and mlir::success().

Member Function Documentation

◆ canConvertToBarePtr()

bool LLVMTypeConverter::canConvertToBarePtr ( BaseMemRefType type )

static

Check if a memref type can be converted to a bare pointer.

Definition at line 379 of file TypeConverter.cpp.

References mlir::Type::cast(), mlir::failed(), mlir::getStridesAndOffset(), and mlir::Type::isa().

Referenced by canBeCalledWithBarePointers().

◆ convertCallingConventionType()

Type LLVMTypeConverter::convertCallingConventionType ( Type type )

Convert a type in the context of the default or bare pointer calling convention.

Calling convention sensitive types, such as MemRefType and UnrankedMemRefType, are converted following the specific rules for the calling convention. Calling convention independent types are converted following the default LLVM type conversions.

Definition at line 438 of file TypeConverter.cpp.

References convertType(), mlir::Type::dyn_cast(), and mlir::LowerToLLVMOptions::useBarePtrCallConv.

Referenced by mlir::barePtrFuncArgTypeConverter(), and packFunctionResults().

◆ convertFunctionSignature()

Type LLVMTypeConverter::convertFunctionSignature	(	FunctionType	funcTy,
		bool	isVariadic,
		LLVMTypeConverter::SignatureConversion &	result
	)

Convert a function type.

The arguments and results are converted one by one and results are packed into a wrapped LLVM IR structure type. result is populated with argument mapping.

Definition at line 211 of file TypeConverter.cpp.

References mlir::TypeConverter::SignatureConversion::addInputs(), mlir::barePtrFuncArgTypeConverter(), mlir::detail::enumerate(), mlir::failed(), getContext(), mlir::TypeConverter::SignatureConversion::getConvertedTypes(), packFunctionResults(), structFuncArgTypeConverter, and mlir::LowerToLLVMOptions::useBarePtrCallConv.

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

◆ convertFunctionTypeCWrapper()

std::pair< Type, bool > LLVMTypeConverter::convertFunctionTypeCWrapper ( FunctionType type )

Converts the function type to a C-compatible format, in particular using pointers to memref descriptors for arguments.

Also converts the return type to a pointer argument if it is a struct. Returns true if this was the case.

Definition at line 242 of file TypeConverter.cpp.

References convertType(), mlir::Type::dyn_cast(), getContext(), mlir::LLVM::isCompatibleType(), and packFunctionResults().

Referenced by wrapExternalFunction(), and wrapForExternalCallers().

◆ convertType() [1/2]

Type TypeConverter::convertType

This hook simplifies defining 1-1 type conversions.

This function returns the type to convert to on success, and a null type on failure.

Definition at line 167 of file DialectConversion.cpp.

◆ convertType() [2/2]

LogicalResult TypeConverter::convertType

Convert the given type.

This function should return failure if no valid conversion exists, success otherwise. If the new set of types is empty, the type is removed and any usages of the existing value are expected to be removed during conversion.

Definition at line 163 of file DialectConversion.cpp.

References mlir::Value::getType().

Referenced by broadcast(), convertCallingConventionType(), convertFunctionTypeCWrapper(), mlir::ConvertToLLVMPattern::copyUnrankedDescriptors(), mlir::LLVM::detail::extractNDVectorTypeInfo(), extractOne(), mlir::MemRefDescriptor::fromStaticShape(), getMemRefAlignment(), getPtrToElementType(), insertOne(), LLVMTypeConverter(), mlir::GPUFuncOpLowering::matchAndRewrite(), mlir::MemRefDescriptor::pack(), mlir::UnrankedMemRefDescriptor::pack(), replaceWithLoadOrStore(), mlir::impl::scalarizeVectorOp(), mlir::structFuncArgTypeConverter(), and wrapExternalFunction().

◆ dangerousSetOptions()

void mlir::LLVMTypeConverter::dangerousSetOptions ( LowerToLLVMOptions newOptions )

inline

Set the lowering options to newOptions.

Note: using this after some some conversions have been performed can lead to inconsistencies in the IR.

Definition at line 86 of file TypeConverter.h.

◆ getContext()

MLIRContext & LLVMTypeConverter::getContext ( )

Returns the MLIR context.

Definition at line 164 of file TypeConverter.cpp.

References getDialect().

Referenced by convertFunctionSignature(), convertFunctionTypeCWrapper(), getIndexType(), packFunctionResults(), mlir::populateArmSVELegalizeForLLVMExportPatterns(), mlir::populateGpuToLLVMConversionPatterns(), mlir::populateGpuToNVVMConversionPatterns(), and mlir::populateGpuToROCDLConversionPatterns().

◆ getDataLayout()

const llvm::DataLayout& mlir::LLVMTypeConverter::getDataLayout ( )

inline

Returns the data layout to use during and after conversion.

Definition at line 111 of file TypeConverter.h.

References mlir::LowerToLLVMOptions::dataLayout.

Referenced by getMemRefAlignment().

◆ getDataLayoutAnalysis()

const DataLayoutAnalysis* mlir::LLVMTypeConverter::getDataLayoutAnalysis ( ) const

inline

Returns the data layout analysis to query during conversion.

Definition at line 114 of file TypeConverter.h.

◆ getDialect()

LLVM::LLVMDialect* mlir::LLVMTypeConverter::getDialect ( )

inline

Returns the LLVM dialect.

Definition at line 79 of file TypeConverter.h.

References llvmDialect.

Referenced by getContext(), mlir::ConvertToLLVMPattern::getDialect(), and mlir::populateVectorToLLVMConversionPatterns().

◆ getIndexType()

Type LLVMTypeConverter::getIndexType ( )

Gets the LLVM representation of the index type.

The returned type is an integer type with the size configured for this type converter.

Definition at line 168 of file TypeConverter.cpp.

References getContext(), and getIndexTypeBitwidth().

Referenced by mlir::UnrankedMemRefDescriptor::computeSizes(), mlir::ConvertToLLVMPattern::copyUnrankedDescriptors(), mlir::ConvertToLLVMPattern::getIndexType(), getMemRefDescriptorSize(), getUnrankedMemRefDescriptorSize(), mlir::UnrankedMemRefDescriptor::offset(), mlir::UnrankedMemRefDescriptor::setOffset(), mlir::UnrankedMemRefDescriptor::setSize(), mlir::UnrankedMemRefDescriptor::setStride(), mlir::UnrankedMemRefDescriptor::size(), mlir::UnrankedMemRefDescriptor::sizeBasePtr(), mlir::UnrankedMemRefDescriptor::stride(), and mlir::UnrankedMemRefDescriptor::strideBasePtr().

◆ getIndexTypeBitwidth()

unsigned mlir::LLVMTypeConverter::getIndexTypeBitwidth ( )

inline

Gets the bitwidth of the index type when converted to LLVM.

Definition at line 123 of file TypeConverter.h.

References mlir::LowerToLLVMOptions::getIndexBitwidth().

Referenced by mlir::UnrankedMemRefDescriptor::computeSizes(), and getIndexType().

◆ getMemRefDescriptorSize()

unsigned LLVMTypeConverter::getMemRefDescriptorSize	(	MemRefType	type,
		const DataLayout &	layout
	)

Returns the size of the memref descriptor object in bytes.

Definition at line 330 of file TypeConverter.cpp.

References getIndexType(), getPointerBitwidth(), and mlir::DataLayout::getTypeSize().

◆ getOptions()

const LowerToLLVMOptions& mlir::LLVMTypeConverter::getOptions ( ) const

inline

Definition at line 81 of file TypeConverter.h.

Referenced by mlir::populateFinalizeMemRefToLLVMConversionPatterns(), and mlir::populateFuncToLLVMFuncOpConversionPattern().

◆ getPointerBitwidth()

unsigned LLVMTypeConverter::getPointerBitwidth ( unsigned addressSpace = 0 )

Gets the pointer bitwidth.

Definition at line 172 of file TypeConverter.cpp.

References mlir::LowerToLLVMOptions::dataLayout.

Referenced by mlir::UnrankedMemRefDescriptor::computeSizes(), getMemRefDescriptorSize(), and getUnrankedMemRefDescriptorSize().

◆ getUnrankedMemRefDescriptorSize()

unsigned LLVMTypeConverter::getUnrankedMemRefDescriptorSize	(	UnrankedMemRefType	type,
		const DataLayout &	layout
	)

Returns the size of the unranked memref descriptor object in bytes.

Definition at line 363 of file TypeConverter.cpp.

References getIndexType(), getPointerBitwidth(), and mlir::DataLayout::getTypeSize().

◆ packFunctionResults()

Type LLVMTypeConverter::packFunctionResults ( TypeRange types )

Convert a non-empty list of types to be returned from a function into a supported LLVM IR type.

In particular, if more than one value is returned, create an LLVM IR structure type with elements that correspond to each of the MLIR types converted with convertType.

Definition at line 464 of file TypeConverter.cpp.

References convertCallingConventionType(), getContext(), mlir::LLVM::LLVMStructType::getLiteral(), and mlir::LLVM::isCompatibleType().

Referenced by convertFunctionSignature(), convertFunctionTypeCWrapper(), and mlir::LLVM::detail::oneToOneRewrite().

◆ promoteBarePtrsToDescriptors()

void LLVMTypeConverter::promoteBarePtrsToDescriptors	(	ConversionPatternRewriter &	rewriter,
		Location	loc,
		ArrayRef< Type >	stdTypes,
		SmallVectorImpl< Value > &	values
	)

Promote the bare pointers in 'values' that resulted from memrefs to descriptors.

'stdTypes' holds the types of 'values' before the conversion to the LLVM-IR dialect (i.e., MemRefType, or any other builtin type).

'stdTypes' holds they types of 'values' before the conversion to the LLVM-IR dialect (i.e., MemRefType, or any other builtin type).

Definition at line 449 of file TypeConverter.cpp.

References mlir::MemRefDescriptor::fromStaticShape().

◆ promoteOneMemRefDescriptor()

Value LLVMTypeConverter::promoteOneMemRefDescriptor	(	Location	loc,
		Value	operand,
		OpBuilder &	builder
	)

Promote the LLVM struct representation of one MemRef descriptor to stack and use pointer to struct to avoid the complexity of the platform-specific C/C++ ABI lowering related to struct argument passing.

Definition at line 482 of file TypeConverter.cpp.

References mlir::OpBuilder::create(), mlir::Builder::getI64Type(), mlir::Builder::getIndexAttr(), and mlir::Value::getType().

◆ promoteOperands()

SmallVector< Value, 4 > LLVMTypeConverter::promoteOperands	(	Location	loc,
		ValueRange	opOperands,
		ValueRange	operands,
		OpBuilder &	builder
	)

Promote the LLVM representation of all operands including promoting MemRef descriptors to stack and use pointers to struct to avoid the complexity of the platform-specific C/C++ ABI lowering related to struct argument passing.

Definition at line 496 of file TypeConverter.cpp.

References mlir::MemRefDescriptor::alignedPtr(), mlir::MemRefDescriptor::unpack(), mlir::UnrankedMemRefDescriptor::unpack(), and mlir::LowerToLLVMOptions::useBarePtrCallConv.

Friends And Related Function Documentation

◆ structFuncArgTypeConverter

LogicalResult structFuncArgTypeConverter	(	LLVMTypeConverter &	converter,
		Type	type,
		SmallVectorImpl< Type > &	result
	)

friend

Give structFuncArgTypeConverter access to memref-specific functions.

It converts a MemRef function argument to a list of non-aggregate types containing descriptor information, and an UnrankedmemRef function argument to a list containing the rank and a pointer to a descriptor struct.

Referenced by convertFunctionSignature().

Member Data Documentation

◆ llvmDialect

LLVM::LLVMDialect* mlir::LLVMTypeConverter::llvmDialect

protected

Pointer to the LLVM dialect.

Definition at line 140 of file TypeConverter.h.

Referenced by getDialect(), and LLVMTypeConverter().

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LLVMTypeConverter() [1/2]

◆ LLVMTypeConverter() [2/2]

Member Function Documentation

◆ canConvertToBarePtr()

◆ convertCallingConventionType()

◆ convertFunctionSignature()

◆ convertFunctionTypeCWrapper()

◆ convertType() [1/2]

◆ convertType() [2/2]

◆ dangerousSetOptions()

◆ getContext()

◆ getDataLayout()

◆ getDataLayoutAnalysis()

◆ getDialect()

◆ getIndexType()

◆ getIndexTypeBitwidth()

◆ getMemRefDescriptorSize()

◆ getOptions()

◆ getPointerBitwidth()

◆ getUnrankedMemRefDescriptorSize()

◆ packFunctionResults()

◆ promoteBarePtrsToDescriptors()

◆ promoteOneMemRefDescriptor()

◆ promoteOperands()

Friends And Related Function Documentation

◆ structFuncArgTypeConverter

Member Data Documentation

◆ llvmDialect